@wix/auto_sdk_ecom_subscription-contracts 1.0.30 → 1.0.32
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts +53 -21
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js.map +1 -1
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts +73 -21
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js.map +1 -1
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts +53 -21
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js.map +1 -1
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts +73 -21
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js.map +1 -1
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts +53 -21
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js.map +1 -1
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts +78 -21
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js.map +1 -1
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts +53 -21
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js.map +1 -1
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts +78 -21
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -57,7 +57,7 @@ export interface SubscriptionContract {
|
|
|
57
57
|
*/
|
|
58
58
|
buyerLanguage?: string | null;
|
|
59
59
|
/** Weight measurement unit - defaults to site's weight unit. */
|
|
60
|
-
weightUnit?:
|
|
60
|
+
weightUnit?: WeightUnitWithLiterals;
|
|
61
61
|
/**
|
|
62
62
|
* Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
|
|
63
63
|
* @format CURRENCY
|
|
@@ -130,7 +130,7 @@ export interface V1SubscriptionDescription {
|
|
|
130
130
|
}
|
|
131
131
|
export interface V1SubscriptionSettings {
|
|
132
132
|
/** Frequency of recurring payment. */
|
|
133
|
-
frequency?:
|
|
133
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
134
134
|
/**
|
|
135
135
|
* Interval of recurring payment.
|
|
136
136
|
* @min 1
|
|
@@ -156,9 +156,11 @@ export declare enum SubscriptionFrequency {
|
|
|
156
156
|
MONTH = "MONTH",
|
|
157
157
|
YEAR = "YEAR"
|
|
158
158
|
}
|
|
159
|
+
/** @enumType */
|
|
160
|
+
export type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
159
161
|
export interface V1FreeTrialPeriod {
|
|
160
162
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
161
|
-
frequency?:
|
|
163
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
162
164
|
/**
|
|
163
165
|
* interval of period
|
|
164
166
|
* @min 1
|
|
@@ -244,7 +246,7 @@ export interface OrderLineItem {
|
|
|
244
246
|
*
|
|
245
247
|
* Default: `FULL_PAYMENT_ONLINE`
|
|
246
248
|
*/
|
|
247
|
-
paymentOption?:
|
|
249
|
+
paymentOption?: PaymentOptionTypeWithLiterals;
|
|
248
250
|
/**
|
|
249
251
|
* Deprecated. Use `taxInfo` instead.
|
|
250
252
|
* This field will be removed on September 30, 2024.
|
|
@@ -415,6 +417,8 @@ export declare enum DescriptionLineType {
|
|
|
415
417
|
/** Color type. */
|
|
416
418
|
COLOR = "COLOR"
|
|
417
419
|
}
|
|
420
|
+
/** @enumType */
|
|
421
|
+
export type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
|
|
418
422
|
export interface Image {
|
|
419
423
|
/** WixMedia image ID. */
|
|
420
424
|
id?: string;
|
|
@@ -461,14 +465,14 @@ export interface PhysicalProperties {
|
|
|
461
465
|
}
|
|
462
466
|
export interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
463
467
|
/** Preset item type. */
|
|
464
|
-
preset?:
|
|
468
|
+
preset?: ItemTypeItemTypeWithLiterals;
|
|
465
469
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
466
470
|
custom?: string;
|
|
467
471
|
}
|
|
468
472
|
/** @oneof */
|
|
469
473
|
export interface ItemTypeItemTypeDataOneOf {
|
|
470
474
|
/** Preset item type. */
|
|
471
|
-
preset?:
|
|
475
|
+
preset?: ItemTypeItemTypeWithLiterals;
|
|
472
476
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
473
477
|
custom?: string;
|
|
474
478
|
}
|
|
@@ -479,6 +483,8 @@ export declare enum ItemTypeItemType {
|
|
|
479
483
|
GIFT_CARD = "GIFT_CARD",
|
|
480
484
|
SERVICE = "SERVICE"
|
|
481
485
|
}
|
|
486
|
+
/** @enumType */
|
|
487
|
+
export type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
|
|
482
488
|
/** Type of selected payment option for catalog item */
|
|
483
489
|
export declare enum PaymentOptionType {
|
|
484
490
|
/** The entire payment for this item happens as part of the checkout. */
|
|
@@ -492,6 +498,8 @@ export declare enum PaymentOptionType {
|
|
|
492
498
|
/** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
|
|
493
499
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
494
500
|
}
|
|
501
|
+
/** @enumType */
|
|
502
|
+
export type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
|
|
495
503
|
export interface ItemTaxFullDetails {
|
|
496
504
|
/** Taxable amount of this line item. */
|
|
497
505
|
taxableAmount?: Price;
|
|
@@ -557,7 +565,7 @@ export interface LineItemTaxBreakdown {
|
|
|
557
565
|
*/
|
|
558
566
|
taxName?: string | null;
|
|
559
567
|
/** Type of jurisdiction that taxes were calculated for. */
|
|
560
|
-
jurisdictionType?:
|
|
568
|
+
jurisdictionType?: JurisdictionTypeWithLiterals;
|
|
561
569
|
/** Non-taxable amount of the line item price. */
|
|
562
570
|
nonTaxableAmount?: Price;
|
|
563
571
|
/** Taxable amount of the line item price. */
|
|
@@ -572,6 +580,8 @@ export declare enum JurisdictionType {
|
|
|
572
580
|
CITY = "CITY",
|
|
573
581
|
SPECIAL = "SPECIAL"
|
|
574
582
|
}
|
|
583
|
+
/** @enumType */
|
|
584
|
+
export type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
|
|
575
585
|
export interface DigitalFile {
|
|
576
586
|
/**
|
|
577
587
|
* ID of the secure file in media.
|
|
@@ -660,7 +670,7 @@ export interface SubscriptionDescription {
|
|
|
660
670
|
}
|
|
661
671
|
export interface SubscriptionSettings {
|
|
662
672
|
/** Frequency of recurring payment. */
|
|
663
|
-
frequency?:
|
|
673
|
+
frequency?: V2SubscriptionFrequencyWithLiterals;
|
|
664
674
|
/**
|
|
665
675
|
* Interval of recurring payment.
|
|
666
676
|
* @min 1
|
|
@@ -687,9 +697,11 @@ export declare enum V2SubscriptionFrequency {
|
|
|
687
697
|
MONTH = "MONTH",
|
|
688
698
|
YEAR = "YEAR"
|
|
689
699
|
}
|
|
700
|
+
/** @enumType */
|
|
701
|
+
export type V2SubscriptionFrequencyWithLiterals = V2SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
690
702
|
export interface FreeTrialPeriod {
|
|
691
703
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
692
|
-
frequency?:
|
|
704
|
+
frequency?: V2SubscriptionFrequencyWithLiterals;
|
|
693
705
|
/**
|
|
694
706
|
* interval of period
|
|
695
707
|
* @min 1
|
|
@@ -699,7 +711,7 @@ export interface FreeTrialPeriod {
|
|
|
699
711
|
}
|
|
700
712
|
export interface BillingAdjustment {
|
|
701
713
|
/** The type of adjustment. */
|
|
702
|
-
type?:
|
|
714
|
+
type?: AdjustmentTypeWithLiterals;
|
|
703
715
|
/** Summary of the prorated adjustment amount. */
|
|
704
716
|
priceSummary?: BillingAdjustmentPriceSummary;
|
|
705
717
|
}
|
|
@@ -710,6 +722,8 @@ export declare enum AdjustmentType {
|
|
|
710
722
|
/** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
|
|
711
723
|
CREDIT = "CREDIT"
|
|
712
724
|
}
|
|
725
|
+
/** @enumType */
|
|
726
|
+
export type AdjustmentTypeWithLiterals = AdjustmentType | 'UNKNOWN_ADJUSTMENT_TYPE' | 'EXTRA_CHARGE' | 'CREDIT';
|
|
713
727
|
export interface BillingAdjustmentPriceSummary {
|
|
714
728
|
/** Subtotal of adjustment, before tax. */
|
|
715
729
|
subtotal?: Price;
|
|
@@ -762,12 +776,12 @@ export interface LocationAndQuantity {
|
|
|
762
776
|
}
|
|
763
777
|
export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
764
778
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
765
|
-
addressType?:
|
|
779
|
+
addressType?: TaxableAddressTypeWithLiterals;
|
|
766
780
|
}
|
|
767
781
|
/** @oneof */
|
|
768
782
|
export interface TaxableAddressTaxableAddressDataOneOf {
|
|
769
783
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
770
|
-
addressType?:
|
|
784
|
+
addressType?: TaxableAddressTypeWithLiterals;
|
|
771
785
|
}
|
|
772
786
|
export declare enum TaxableAddressType {
|
|
773
787
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
@@ -775,6 +789,8 @@ export declare enum TaxableAddressType {
|
|
|
775
789
|
BILLING = "BILLING",
|
|
776
790
|
SHIPPING = "SHIPPING"
|
|
777
791
|
}
|
|
792
|
+
/** @enumType */
|
|
793
|
+
export type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
|
|
778
794
|
export interface ExtendedFields {
|
|
779
795
|
/**
|
|
780
796
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
@@ -887,6 +903,8 @@ export declare enum WeightUnit {
|
|
|
887
903
|
/** Pounds. */
|
|
888
904
|
LB = "LB"
|
|
889
905
|
}
|
|
906
|
+
/** @enumType */
|
|
907
|
+
export type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
|
|
890
908
|
export interface CurrencyConversionDetails {
|
|
891
909
|
/**
|
|
892
910
|
* Currency used for the pricing of this order, in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
|
|
@@ -1018,7 +1036,7 @@ export interface VatId {
|
|
|
1018
1036
|
* + `CPF`: for individual tax payers
|
|
1019
1037
|
* + `CNPJ`: for corporations
|
|
1020
1038
|
*/
|
|
1021
|
-
type?:
|
|
1039
|
+
type?: VatTypeWithLiterals;
|
|
1022
1040
|
}
|
|
1023
1041
|
/** tax info types */
|
|
1024
1042
|
export declare enum VatType {
|
|
@@ -1028,6 +1046,8 @@ export declare enum VatType {
|
|
|
1028
1046
|
/** CNPJ - for corporations */
|
|
1029
1047
|
CNPJ = "CNPJ"
|
|
1030
1048
|
}
|
|
1049
|
+
/** @enumType */
|
|
1050
|
+
export type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
|
|
1031
1051
|
export interface ShippingInformation {
|
|
1032
1052
|
/**
|
|
1033
1053
|
* App Def Id of external provider which was a source of shipping info
|
|
@@ -1088,7 +1108,7 @@ export interface PickupDetails {
|
|
|
1088
1108
|
/** Pickup address. */
|
|
1089
1109
|
address?: PickupAddress;
|
|
1090
1110
|
/** Pickup method */
|
|
1091
|
-
pickupMethod?:
|
|
1111
|
+
pickupMethod?: PickupMethodWithLiterals;
|
|
1092
1112
|
}
|
|
1093
1113
|
/** Physical address */
|
|
1094
1114
|
export interface PickupAddress {
|
|
@@ -1140,6 +1160,8 @@ export declare enum PickupMethod {
|
|
|
1140
1160
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1141
1161
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1142
1162
|
}
|
|
1163
|
+
/** @enumType */
|
|
1164
|
+
export type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
|
|
1143
1165
|
export interface DeliveryTimeSlot {
|
|
1144
1166
|
/** Delivery slot starting time. */
|
|
1145
1167
|
from?: Date | null;
|
|
@@ -1211,7 +1233,7 @@ export interface OrderTaxBreakdown {
|
|
|
1211
1233
|
*/
|
|
1212
1234
|
jurisdiction?: string;
|
|
1213
1235
|
/** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
1214
|
-
jurisdictionType?:
|
|
1236
|
+
jurisdictionType?: JurisdictionTypeWithLiterals;
|
|
1215
1237
|
/**
|
|
1216
1238
|
* The rate at which this tax detail was calculated.
|
|
1217
1239
|
* @format DECIMAL_VALUE
|
|
@@ -1234,7 +1256,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1234
1256
|
* * `"SPECIFIC-ITEMS"` - discount applies to specific items.
|
|
1235
1257
|
* * `"SHIPPING"` - discount applies to shipping. For example, free shipping.
|
|
1236
1258
|
*/
|
|
1237
|
-
discountType?:
|
|
1259
|
+
discountType?: DiscountTypeWithLiterals;
|
|
1238
1260
|
/**
|
|
1239
1261
|
* IDs of line items discount applies to.
|
|
1240
1262
|
* Deprecated. Use `line_item_discounts` instead.
|
|
@@ -1267,6 +1289,8 @@ export declare enum DiscountType {
|
|
|
1267
1289
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1268
1290
|
SHIPPING = "SHIPPING"
|
|
1269
1291
|
}
|
|
1292
|
+
/** @enumType */
|
|
1293
|
+
export type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
1270
1294
|
/** Coupon */
|
|
1271
1295
|
export interface Coupon {
|
|
1272
1296
|
/** Coupon ID. */
|
|
@@ -1283,7 +1307,7 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
|
|
|
1283
1307
|
* Pre-defined discount reason (optional).
|
|
1284
1308
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
1285
1309
|
*/
|
|
1286
|
-
discountReason?:
|
|
1310
|
+
discountReason?: DiscountReasonWithLiterals;
|
|
1287
1311
|
/**
|
|
1288
1312
|
* Discount description as free text (optional).
|
|
1289
1313
|
* @maxLength 200
|
|
@@ -1298,7 +1322,7 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1298
1322
|
* Pre-defined discount reason (optional).
|
|
1299
1323
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
1300
1324
|
*/
|
|
1301
|
-
discountReason?:
|
|
1325
|
+
discountReason?: DiscountReasonWithLiterals;
|
|
1302
1326
|
/**
|
|
1303
1327
|
* Discount description as free text (optional).
|
|
1304
1328
|
* @maxLength 200
|
|
@@ -1310,6 +1334,8 @@ export declare enum DiscountReason {
|
|
|
1310
1334
|
EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
|
|
1311
1335
|
BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
|
|
1312
1336
|
}
|
|
1337
|
+
/** @enumType */
|
|
1338
|
+
export type DiscountReasonWithLiterals = DiscountReason | 'UNSPECIFIED' | 'EXCHANGED_ITEMS' | 'BILLING_ADJUSTMENT';
|
|
1313
1339
|
export interface DiscountRule {
|
|
1314
1340
|
/**
|
|
1315
1341
|
* Discount rule ID
|
|
@@ -1346,7 +1372,7 @@ export interface LineItemDiscount {
|
|
|
1346
1372
|
}
|
|
1347
1373
|
export interface ChannelInfo {
|
|
1348
1374
|
/** Sales channel that submitted the order. */
|
|
1349
|
-
type?:
|
|
1375
|
+
type?: ChannelTypeWithLiterals;
|
|
1350
1376
|
/**
|
|
1351
1377
|
* Reference to an order ID from an external system.
|
|
1352
1378
|
* @maxLength 100
|
|
@@ -1392,6 +1418,8 @@ export declare enum ChannelType {
|
|
|
1392
1418
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
1393
1419
|
FAIRE_COM = "FAIRE_COM"
|
|
1394
1420
|
}
|
|
1421
|
+
/** @enumType */
|
|
1422
|
+
export type ChannelTypeWithLiterals = ChannelType | 'UNSPECIFIED' | 'WEB' | 'POS' | 'EBAY' | 'AMAZON' | 'OTHER_PLATFORM' | 'WIX_APP_STORE' | 'WIX_INVOICES' | 'BACKOFFICE_MERCHANT' | 'WISH' | 'CLASS_PASS' | 'GLOBAL_E' | 'FACEBOOK' | 'ETSY' | 'TIKTOK' | 'FAIRE_COM';
|
|
1395
1423
|
export interface CustomField {
|
|
1396
1424
|
/** Custom field value. */
|
|
1397
1425
|
value?: any;
|
|
@@ -1542,12 +1570,14 @@ export interface Sorting {
|
|
|
1542
1570
|
*/
|
|
1543
1571
|
fieldName?: string;
|
|
1544
1572
|
/** Sort order. */
|
|
1545
|
-
order?:
|
|
1573
|
+
order?: SortOrderWithLiterals;
|
|
1546
1574
|
}
|
|
1547
1575
|
export declare enum SortOrder {
|
|
1548
1576
|
ASC = "ASC",
|
|
1549
1577
|
DESC = "DESC"
|
|
1550
1578
|
}
|
|
1579
|
+
/** @enumType */
|
|
1580
|
+
export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1551
1581
|
export interface CursorPaging {
|
|
1552
1582
|
/**
|
|
1553
1583
|
* Maximum number of items to return in the results.
|
|
@@ -1698,7 +1728,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1698
1728
|
*/
|
|
1699
1729
|
appId?: string;
|
|
1700
1730
|
/** @readonly */
|
|
1701
|
-
identityType?:
|
|
1731
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1702
1732
|
}
|
|
1703
1733
|
/** @oneof */
|
|
1704
1734
|
export interface IdentificationDataIdOneOf {
|
|
@@ -1730,3 +1760,5 @@ export declare enum WebhookIdentityType {
|
|
|
1730
1760
|
WIX_USER = "WIX_USER",
|
|
1731
1761
|
APP = "APP"
|
|
1732
1762
|
}
|
|
1763
|
+
/** @enumType */
|
|
1764
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js","sourceRoot":"","sources":["../../../../src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.ts"],"names":[],"mappings":"AA0JA,MAAM,CAAN,IAAY,qBAMX;AAND,WAAY,qBAAqB;IAC/B,gDAAuB,CAAA;IACvB,oCAAW,CAAA;IACX,sCAAa,CAAA;IACb,wCAAe,CAAA;IACf,sCAAa,CAAA;AACf,CAAC,EANW,qBAAqB,KAArB,qBAAqB,QAMhC;
|
|
1
|
+
{"version":3,"file":"ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js","sourceRoot":"","sources":["../../../../src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.ts"],"names":[],"mappings":"AA0JA,MAAM,CAAN,IAAY,qBAMX;AAND,WAAY,qBAAqB;IAC/B,gDAAuB,CAAA;IACvB,oCAAW,CAAA;IACX,sCAAa,CAAA;IACb,wCAAe,CAAA;IACf,sCAAa,CAAA;AACf,CAAC,EANW,qBAAqB,KAArB,qBAAqB,QAMhC;AAkRD,MAAM,CAAN,IAAY,mBAOX;AAPD,WAAY,mBAAmB;IAC7B,yBAAyB;IACzB,oDAA6B,CAAA;IAC7B,uBAAuB;IACvB,gDAAyB,CAAA;IACzB,kBAAkB;IAClB,sCAAe,CAAA;AACjB,CAAC,EAPW,mBAAmB,KAAnB,mBAAmB,QAO9B;AAuED,MAAM,CAAN,IAAY,gBAMX;AAND,WAAY,gBAAgB;IAC1B,iDAA6B,CAAA;IAC7B,yCAAqB,CAAA;IACrB,uCAAmB,CAAA;IACnB,2CAAuB,CAAA;IACvB,uCAAmB,CAAA;AACrB,CAAC,EANW,gBAAgB,KAAhB,gBAAgB,QAM3B;AAWD,uDAAuD;AACvD,MAAM,CAAN,IAAY,iBAWX;AAXD,WAAY,iBAAiB;IAC3B,wEAAwE;IACxE,gEAA2C,CAAA;IAC3C,sIAAsI;IACtI,kEAA6C,CAAA;IAC7C,6FAA6F;IAC7F,8CAAyB,CAAA;IACzB,4IAA4I;IAC5I,sDAAiC,CAAA;IACjC,uKAAuK;IACvK,8DAAyC,CAAA;AAC3C,CAAC,EAXW,iBAAiB,KAAjB,iBAAiB,QAW5B;AAqFD,0IAA0I;AAC1I,MAAM,CAAN,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,2CAAuB,CAAA;IACvB,uCAAmB,CAAA;IACnB,mCAAe,CAAA;IACf,qCAAiB,CAAA;IACjB,iCAAa,CAAA;IACb,uCAAmB,CAAA;AACrB,CAAC,EAPW,gBAAgB,KAAhB,gBAAgB,QAO3B;AA4HD,0CAA0C;AAC1C,MAAM,CAAN,IAAY,uBAMX;AAND,WAAY,uBAAuB;IACjC,kDAAuB,CAAA;IACvB,sCAAW,CAAA;IACX,wCAAa,CAAA;IACb,0CAAe,CAAA;IACf,wCAAa,CAAA;AACf,CAAC,EANW,uBAAuB,KAAvB,uBAAuB,QAMlC;AA6BD,MAAM,CAAN,IAAY,cAMX;AAND,WAAY,cAAc;IACxB,qEAAmD,CAAA;IACnD,qIAAqI;IACrI,+CAA6B,CAAA;IAC7B,sIAAsI;IACtI,mCAAiB,CAAA;AACnB,CAAC,EANW,cAAc,KAAd,cAAc,QAMzB;AAyED,MAAM,CAAN,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,yEAAmD,CAAA;IACnD,2CAAqB,CAAA;IACrB,yCAAmB,CAAA;IACnB,2CAAqB,CAAA;AACvB,CAAC,EALW,kBAAkB,KAAlB,kBAAkB,QAK7B;AAwHD,MAAM,CAAN,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,uDAAuD;IACvD,iEAAmD,CAAA;IACnD,iBAAiB;IACjB,uBAAS,CAAA;IACT,cAAc;IACd,uBAAS,CAAA;AACX,CAAC,EAPW,UAAU,KAAV,UAAU,QAOrB;AAsJD,qBAAqB;AACrB,MAAM,CAAN,IAAY,OAMX;AAND,WAAY,OAAO;IACjB,sCAA2B,CAAA;IAC3B,uCAAuC;IACvC,sBAAW,CAAA;IACX,8BAA8B;IAC9B,wBAAa,CAAA;AACf,CAAC,EANW,OAAO,KAAP,OAAO,QAMlB;AAqHD,MAAM,CAAN,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,6CAA6B,CAAA;AAC/B,CAAC,EAJW,YAAY,KAAZ,YAAY,QAIvB;AA0ID,MAAM,CAAN,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,iCAAiB,CAAA;IACjB,iDAAiC,CAAA;IACjC,qCAAqB,CAAA;AACvB,CAAC,EAJW,YAAY,KAAZ,YAAY,QAIvB;AAmDD,MAAM,CAAN,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,6CAA2B,CAAA;IAC3B,qDAAmC,CAAA;IACnC,2DAAyC,CAAA;AAC3C,CAAC,EAJW,cAAc,KAAd,cAAc,QAIzB;AA6DD,MAAM,CAAN,IAAY,WAiCX;AAjCD,WAAY,WAAW;IACrB,8DAA8D;IAC9D,0CAA2B,CAAA;IAC3B,oBAAoB;IACpB,0BAAW,CAAA;IACX,oFAAoF;IACpF,0BAAW,CAAA;IACX,yGAAyG;IACzG,4BAAa,CAAA;IACb,6GAA6G;IAC7G,gCAAiB,CAAA;IACjB,4BAA4B;IAC5B,gDAAiC,CAAA;IACjC,kFAAkF;IAClF,8CAA+B,CAAA;IAC/B,mRAAmR;IACnR,4CAA6B,CAAA;IAC7B,+BAA+B;IAC/B,0DAA2C,CAAA;IAC3C,0BAA0B;IAC1B,4BAAa,CAAA;IACb,oIAAoI;IACpI,wCAAyB,CAAA;IACzB,8BAA8B;IAC9B,oCAAqB,CAAA;IACrB,gGAAgG;IAChG,oCAAqB,CAAA;IACrB,kHAAkH;IAClH,4BAAa,CAAA;IACb,sHAAsH;IACtH,gCAAiB,CAAA;IACjB,6IAA6I;IAC7I,sCAAuB,CAAA;AACzB,CAAC,EAjCW,WAAW,KAAX,WAAW,QAiCtB;AA4LD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAkMD,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B"}
|
|
@@ -63,7 +63,7 @@ export interface SubscriptionContract {
|
|
|
63
63
|
*/
|
|
64
64
|
buyerLanguage?: string | null;
|
|
65
65
|
/** Weight measurement unit - defaults to site's weight unit. */
|
|
66
|
-
weightUnit?:
|
|
66
|
+
weightUnit?: WeightUnitWithLiterals;
|
|
67
67
|
/**
|
|
68
68
|
* Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
|
|
69
69
|
* @format CURRENCY
|
|
@@ -141,7 +141,7 @@ export interface V1SubscriptionDescription {
|
|
|
141
141
|
}
|
|
142
142
|
export interface V1SubscriptionSettings {
|
|
143
143
|
/** Frequency of recurring payment. */
|
|
144
|
-
frequency?:
|
|
144
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
145
145
|
/**
|
|
146
146
|
* Interval of recurring payment.
|
|
147
147
|
* @min 1
|
|
@@ -172,9 +172,11 @@ export declare enum SubscriptionFrequency {
|
|
|
172
172
|
MONTH = "MONTH",
|
|
173
173
|
YEAR = "YEAR"
|
|
174
174
|
}
|
|
175
|
+
/** @enumType */
|
|
176
|
+
export type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
175
177
|
export interface V1FreeTrialPeriod {
|
|
176
178
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
177
|
-
frequency?:
|
|
179
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
178
180
|
/**
|
|
179
181
|
* interval of period
|
|
180
182
|
* @min 1
|
|
@@ -260,7 +262,7 @@ export interface OrderLineItem {
|
|
|
260
262
|
*
|
|
261
263
|
* Default: `FULL_PAYMENT_ONLINE`
|
|
262
264
|
*/
|
|
263
|
-
paymentOption?:
|
|
265
|
+
paymentOption?: PaymentOptionTypeWithLiterals;
|
|
264
266
|
/**
|
|
265
267
|
* Deprecated. Use `taxInfo` instead.
|
|
266
268
|
* This field will be removed on September 30, 2024.
|
|
@@ -381,6 +383,11 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
|
|
|
381
383
|
colorInfo?: Color;
|
|
382
384
|
/** Description line name. */
|
|
383
385
|
name?: DescriptionLineName;
|
|
386
|
+
/**
|
|
387
|
+
* Whether the description line originates from a modifier.
|
|
388
|
+
* @internal
|
|
389
|
+
*/
|
|
390
|
+
modifierDescriptionLine?: boolean;
|
|
384
391
|
}
|
|
385
392
|
/** @oneof */
|
|
386
393
|
export interface DescriptionLineValueOneOf {
|
|
@@ -444,6 +451,8 @@ export declare enum DescriptionLineType {
|
|
|
444
451
|
/** Color type. */
|
|
445
452
|
COLOR = "COLOR"
|
|
446
453
|
}
|
|
454
|
+
/** @enumType */
|
|
455
|
+
export type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
|
|
447
456
|
export interface FocalPoint {
|
|
448
457
|
/** X-coordinate of the focal point. */
|
|
449
458
|
x?: number;
|
|
@@ -467,14 +476,14 @@ export interface PhysicalProperties {
|
|
|
467
476
|
}
|
|
468
477
|
export interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
469
478
|
/** Preset item type. */
|
|
470
|
-
preset?:
|
|
479
|
+
preset?: ItemTypeItemTypeWithLiterals;
|
|
471
480
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
472
481
|
custom?: string;
|
|
473
482
|
}
|
|
474
483
|
/** @oneof */
|
|
475
484
|
export interface ItemTypeItemTypeDataOneOf {
|
|
476
485
|
/** Preset item type. */
|
|
477
|
-
preset?:
|
|
486
|
+
preset?: ItemTypeItemTypeWithLiterals;
|
|
478
487
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
479
488
|
custom?: string;
|
|
480
489
|
}
|
|
@@ -485,6 +494,8 @@ export declare enum ItemTypeItemType {
|
|
|
485
494
|
GIFT_CARD = "GIFT_CARD",
|
|
486
495
|
SERVICE = "SERVICE"
|
|
487
496
|
}
|
|
497
|
+
/** @enumType */
|
|
498
|
+
export type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
|
|
488
499
|
/** Type of selected payment option for catalog item */
|
|
489
500
|
export declare enum PaymentOptionType {
|
|
490
501
|
/** The entire payment for this item happens as part of the checkout. */
|
|
@@ -498,6 +509,8 @@ export declare enum PaymentOptionType {
|
|
|
498
509
|
/** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
|
|
499
510
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
500
511
|
}
|
|
512
|
+
/** @enumType */
|
|
513
|
+
export type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
|
|
501
514
|
export interface ItemTaxFullDetails {
|
|
502
515
|
/** Taxable amount of this line item. */
|
|
503
516
|
taxableAmount?: Price;
|
|
@@ -563,7 +576,7 @@ export interface LineItemTaxBreakdown {
|
|
|
563
576
|
*/
|
|
564
577
|
taxName?: string | null;
|
|
565
578
|
/** Type of jurisdiction that taxes were calculated for. */
|
|
566
|
-
jurisdictionType?:
|
|
579
|
+
jurisdictionType?: JurisdictionTypeWithLiterals;
|
|
567
580
|
/** Non-taxable amount of the line item price. */
|
|
568
581
|
nonTaxableAmount?: Price;
|
|
569
582
|
/** Taxable amount of the line item price. */
|
|
@@ -578,6 +591,8 @@ export declare enum JurisdictionType {
|
|
|
578
591
|
CITY = "CITY",
|
|
579
592
|
SPECIAL = "SPECIAL"
|
|
580
593
|
}
|
|
594
|
+
/** @enumType */
|
|
595
|
+
export type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
|
|
581
596
|
export interface DigitalFile {
|
|
582
597
|
/**
|
|
583
598
|
* ID of the secure file in media.
|
|
@@ -681,7 +696,7 @@ export interface SubscriptionDescription {
|
|
|
681
696
|
}
|
|
682
697
|
export interface SubscriptionSettings {
|
|
683
698
|
/** Frequency of recurring payment. */
|
|
684
|
-
frequency?:
|
|
699
|
+
frequency?: V2SubscriptionFrequencyWithLiterals;
|
|
685
700
|
/**
|
|
686
701
|
* Interval of recurring payment.
|
|
687
702
|
* @min 1
|
|
@@ -713,9 +728,11 @@ export declare enum V2SubscriptionFrequency {
|
|
|
713
728
|
MONTH = "MONTH",
|
|
714
729
|
YEAR = "YEAR"
|
|
715
730
|
}
|
|
731
|
+
/** @enumType */
|
|
732
|
+
export type V2SubscriptionFrequencyWithLiterals = V2SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
716
733
|
export interface FreeTrialPeriod {
|
|
717
734
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
718
|
-
frequency?:
|
|
735
|
+
frequency?: V2SubscriptionFrequencyWithLiterals;
|
|
719
736
|
/**
|
|
720
737
|
* interval of period
|
|
721
738
|
* @min 1
|
|
@@ -725,7 +742,7 @@ export interface FreeTrialPeriod {
|
|
|
725
742
|
}
|
|
726
743
|
export interface BillingAdjustment {
|
|
727
744
|
/** The type of adjustment. */
|
|
728
|
-
type?:
|
|
745
|
+
type?: AdjustmentTypeWithLiterals;
|
|
729
746
|
/** Summary of the prorated adjustment amount. */
|
|
730
747
|
priceSummary?: BillingAdjustmentPriceSummary;
|
|
731
748
|
}
|
|
@@ -736,6 +753,8 @@ export declare enum AdjustmentType {
|
|
|
736
753
|
/** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
|
|
737
754
|
CREDIT = "CREDIT"
|
|
738
755
|
}
|
|
756
|
+
/** @enumType */
|
|
757
|
+
export type AdjustmentTypeWithLiterals = AdjustmentType | 'UNKNOWN_ADJUSTMENT_TYPE' | 'EXTRA_CHARGE' | 'CREDIT';
|
|
739
758
|
export interface BillingAdjustmentPriceSummary {
|
|
740
759
|
/** Subtotal of adjustment, before tax. */
|
|
741
760
|
subtotal?: Price;
|
|
@@ -788,12 +807,12 @@ export interface LocationAndQuantity {
|
|
|
788
807
|
}
|
|
789
808
|
export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
790
809
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
791
|
-
addressType?:
|
|
810
|
+
addressType?: TaxableAddressTypeWithLiterals;
|
|
792
811
|
}
|
|
793
812
|
/** @oneof */
|
|
794
813
|
export interface TaxableAddressTaxableAddressDataOneOf {
|
|
795
814
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
796
|
-
addressType?:
|
|
815
|
+
addressType?: TaxableAddressTypeWithLiterals;
|
|
797
816
|
}
|
|
798
817
|
export declare enum TaxableAddressType {
|
|
799
818
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
@@ -801,6 +820,8 @@ export declare enum TaxableAddressType {
|
|
|
801
820
|
BILLING = "BILLING",
|
|
802
821
|
SHIPPING = "SHIPPING"
|
|
803
822
|
}
|
|
823
|
+
/** @enumType */
|
|
824
|
+
export type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
|
|
804
825
|
export interface ExtendedFields {
|
|
805
826
|
/**
|
|
806
827
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
@@ -913,6 +934,8 @@ export declare enum WeightUnit {
|
|
|
913
934
|
/** Pounds. */
|
|
914
935
|
LB = "LB"
|
|
915
936
|
}
|
|
937
|
+
/** @enumType */
|
|
938
|
+
export type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
|
|
916
939
|
export interface CurrencyConversionDetails {
|
|
917
940
|
/**
|
|
918
941
|
* Currency used for the pricing of this order, in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
|
|
@@ -1044,7 +1067,7 @@ export interface VatId {
|
|
|
1044
1067
|
* + `CPF`: for individual tax payers
|
|
1045
1068
|
* + `CNPJ`: for corporations
|
|
1046
1069
|
*/
|
|
1047
|
-
type?:
|
|
1070
|
+
type?: VatTypeWithLiterals;
|
|
1048
1071
|
}
|
|
1049
1072
|
/** tax info types */
|
|
1050
1073
|
export declare enum VatType {
|
|
@@ -1054,6 +1077,8 @@ export declare enum VatType {
|
|
|
1054
1077
|
/** CNPJ - for corporations */
|
|
1055
1078
|
CNPJ = "CNPJ"
|
|
1056
1079
|
}
|
|
1080
|
+
/** @enumType */
|
|
1081
|
+
export type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
|
|
1057
1082
|
export interface ShippingInformation {
|
|
1058
1083
|
/**
|
|
1059
1084
|
* App Def Id of external provider which was a source of shipping info
|
|
@@ -1114,7 +1139,7 @@ export interface PickupDetails {
|
|
|
1114
1139
|
/** Pickup address. */
|
|
1115
1140
|
address?: PickupAddress;
|
|
1116
1141
|
/** Pickup method */
|
|
1117
|
-
pickupMethod?:
|
|
1142
|
+
pickupMethod?: PickupMethodWithLiterals;
|
|
1118
1143
|
}
|
|
1119
1144
|
/** Physical address */
|
|
1120
1145
|
export interface PickupAddress {
|
|
@@ -1166,6 +1191,8 @@ export declare enum PickupMethod {
|
|
|
1166
1191
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1167
1192
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1168
1193
|
}
|
|
1194
|
+
/** @enumType */
|
|
1195
|
+
export type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
|
|
1169
1196
|
export interface DeliveryTimeSlot {
|
|
1170
1197
|
/** Delivery slot starting time. */
|
|
1171
1198
|
from?: Date | null;
|
|
@@ -1237,7 +1264,7 @@ export interface OrderTaxBreakdown {
|
|
|
1237
1264
|
*/
|
|
1238
1265
|
jurisdiction?: string;
|
|
1239
1266
|
/** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
1240
|
-
jurisdictionType?:
|
|
1267
|
+
jurisdictionType?: JurisdictionTypeWithLiterals;
|
|
1241
1268
|
/**
|
|
1242
1269
|
* The rate at which this tax detail was calculated.
|
|
1243
1270
|
* @format DECIMAL_VALUE
|
|
@@ -1260,7 +1287,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1260
1287
|
* * `"SPECIFIC-ITEMS"` - discount applies to specific items.
|
|
1261
1288
|
* * `"SHIPPING"` - discount applies to shipping. For example, free shipping.
|
|
1262
1289
|
*/
|
|
1263
|
-
discountType?:
|
|
1290
|
+
discountType?: DiscountTypeWithLiterals;
|
|
1264
1291
|
/**
|
|
1265
1292
|
* IDs of line items discount applies to.
|
|
1266
1293
|
* Deprecated. Use `line_item_discounts` instead.
|
|
@@ -1301,6 +1328,8 @@ export declare enum DiscountType {
|
|
|
1301
1328
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1302
1329
|
SHIPPING = "SHIPPING"
|
|
1303
1330
|
}
|
|
1331
|
+
/** @enumType */
|
|
1332
|
+
export type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
1304
1333
|
/** Coupon */
|
|
1305
1334
|
export interface Coupon {
|
|
1306
1335
|
/** Coupon ID. */
|
|
@@ -1317,7 +1346,7 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
|
|
|
1317
1346
|
* Pre-defined discount reason (optional).
|
|
1318
1347
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
1319
1348
|
*/
|
|
1320
|
-
discountReason?:
|
|
1349
|
+
discountReason?: DiscountReasonWithLiterals;
|
|
1321
1350
|
/**
|
|
1322
1351
|
* Discount description as free text (optional).
|
|
1323
1352
|
* @maxLength 200
|
|
@@ -1339,7 +1368,7 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1339
1368
|
* Pre-defined discount reason (optional).
|
|
1340
1369
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
1341
1370
|
*/
|
|
1342
|
-
discountReason?:
|
|
1371
|
+
discountReason?: DiscountReasonWithLiterals;
|
|
1343
1372
|
/**
|
|
1344
1373
|
* Discount description as free text (optional).
|
|
1345
1374
|
* @maxLength 200
|
|
@@ -1351,6 +1380,8 @@ export declare enum DiscountReason {
|
|
|
1351
1380
|
EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
|
|
1352
1381
|
BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
|
|
1353
1382
|
}
|
|
1383
|
+
/** @enumType */
|
|
1384
|
+
export type DiscountReasonWithLiterals = DiscountReason | 'UNSPECIFIED' | 'EXCHANGED_ITEMS' | 'BILLING_ADJUSTMENT';
|
|
1354
1385
|
export interface DiscountRule {
|
|
1355
1386
|
/**
|
|
1356
1387
|
* Discount rule ID
|
|
@@ -1387,7 +1418,7 @@ export interface LineItemDiscount {
|
|
|
1387
1418
|
}
|
|
1388
1419
|
export interface ChannelInfo {
|
|
1389
1420
|
/** Sales channel that submitted the order. */
|
|
1390
|
-
type?:
|
|
1421
|
+
type?: ChannelTypeWithLiterals;
|
|
1391
1422
|
/**
|
|
1392
1423
|
* Reference to an order ID from an external system.
|
|
1393
1424
|
* @maxLength 100
|
|
@@ -1433,6 +1464,8 @@ export declare enum ChannelType {
|
|
|
1433
1464
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
1434
1465
|
FAIRE_COM = "FAIRE_COM"
|
|
1435
1466
|
}
|
|
1467
|
+
/** @enumType */
|
|
1468
|
+
export type ChannelTypeWithLiterals = ChannelType | 'UNSPECIFIED' | 'WEB' | 'POS' | 'EBAY' | 'AMAZON' | 'OTHER_PLATFORM' | 'WIX_APP_STORE' | 'WIX_INVOICES' | 'BACKOFFICE_MERCHANT' | 'WISH' | 'CLASS_PASS' | 'GLOBAL_E' | 'FACEBOOK' | 'ETSY' | 'TIKTOK' | 'FAIRE_COM';
|
|
1436
1469
|
export interface CustomField {
|
|
1437
1470
|
/** Custom field value. */
|
|
1438
1471
|
value?: any;
|
|
@@ -1591,12 +1624,14 @@ export interface Sorting {
|
|
|
1591
1624
|
*/
|
|
1592
1625
|
fieldName?: string;
|
|
1593
1626
|
/** Sort order. */
|
|
1594
|
-
order?:
|
|
1627
|
+
order?: SortOrderWithLiterals;
|
|
1595
1628
|
}
|
|
1596
1629
|
export declare enum SortOrder {
|
|
1597
1630
|
ASC = "ASC",
|
|
1598
1631
|
DESC = "DESC"
|
|
1599
1632
|
}
|
|
1633
|
+
/** @enumType */
|
|
1634
|
+
export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1600
1635
|
export interface CursorPaging {
|
|
1601
1636
|
/**
|
|
1602
1637
|
* Maximum number of items to return in the results.
|
|
@@ -1745,7 +1780,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1745
1780
|
*/
|
|
1746
1781
|
appId?: string;
|
|
1747
1782
|
/** @readonly */
|
|
1748
|
-
identityType?:
|
|
1783
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1749
1784
|
}
|
|
1750
1785
|
/** @oneof */
|
|
1751
1786
|
export interface IdentificationDataIdOneOf {
|
|
@@ -1777,6 +1812,8 @@ export declare enum WebhookIdentityType {
|
|
|
1777
1812
|
WIX_USER = "WIX_USER",
|
|
1778
1813
|
APP = "APP"
|
|
1779
1814
|
}
|
|
1815
|
+
/** @enumType */
|
|
1816
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1780
1817
|
export interface BaseEventMetadata {
|
|
1781
1818
|
/**
|
|
1782
1819
|
* App instance ID.
|
|
@@ -1946,6 +1983,26 @@ export interface SubscriptionContractsQueryBuilder {
|
|
|
1946
1983
|
* @documentationMaturity preview
|
|
1947
1984
|
*/
|
|
1948
1985
|
ne: (propertyName: '_id' | 'buyerInfo.contactId', value: any) => SubscriptionContractsQueryBuilder;
|
|
1986
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1987
|
+
* @param value - Value to compare against.
|
|
1988
|
+
* @documentationMaturity preview
|
|
1989
|
+
*/
|
|
1990
|
+
ge: (propertyName: '_id' | 'buyerInfo.contactId', value: any) => SubscriptionContractsQueryBuilder;
|
|
1991
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1992
|
+
* @param value - Value to compare against.
|
|
1993
|
+
* @documentationMaturity preview
|
|
1994
|
+
*/
|
|
1995
|
+
gt: (propertyName: '_id' | 'buyerInfo.contactId', value: any) => SubscriptionContractsQueryBuilder;
|
|
1996
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1997
|
+
* @param value - Value to compare against.
|
|
1998
|
+
* @documentationMaturity preview
|
|
1999
|
+
*/
|
|
2000
|
+
le: (propertyName: '_id' | 'buyerInfo.contactId', value: any) => SubscriptionContractsQueryBuilder;
|
|
2001
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
2002
|
+
* @param value - Value to compare against.
|
|
2003
|
+
* @documentationMaturity preview
|
|
2004
|
+
*/
|
|
2005
|
+
lt: (propertyName: '_id' | 'buyerInfo.contactId', value: any) => SubscriptionContractsQueryBuilder;
|
|
1949
2006
|
/** @param propertyName - Property whose value is compared with `string`.
|
|
1950
2007
|
* @param string - String to compare against. Case-insensitive.
|
|
1951
2008
|
* @documentationMaturity preview
|