@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,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,qCAArB,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,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,qCAArB,qBAAqB,QAMhC;AAkRD,IAAY,mBAOX;AAPD,WAAY,mBAAmB;IAC7B,yBAAyB;IACzB,oDAA6B,CAAA;IAC7B,uBAAuB;IACvB,gDAAyB,CAAA;IACzB,kBAAkB;IAClB,sCAAe,CAAA;AACjB,CAAC,EAPW,mBAAmB,mCAAnB,mBAAmB,QAO9B;AAuED,IAAY,gBAMX;AAND,WAAY,gBAAgB;IAC1B,iDAA6B,CAAA;IAC7B,yCAAqB,CAAA;IACrB,uCAAmB,CAAA;IACnB,2CAAuB,CAAA;IACvB,uCAAmB,CAAA;AACrB,CAAC,EANW,gBAAgB,gCAAhB,gBAAgB,QAM3B;AAWD,uDAAuD;AACvD,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,iCAAjB,iBAAiB,QAW5B;AAqFD,0IAA0I;AAC1I,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,gCAAhB,gBAAgB,QAO3B;AA4HD,0CAA0C;AAC1C,IAAY,uBAMX;AAND,WAAY,uBAAuB;IACjC,kDAAuB,CAAA;IACvB,sCAAW,CAAA;IACX,wCAAa,CAAA;IACb,0CAAe,CAAA;IACf,wCAAa,CAAA;AACf,CAAC,EANW,uBAAuB,uCAAvB,uBAAuB,QAMlC;AA6BD,IAAY,cAMX;AAND,WAAY,cAAc;IACxB,qEAAmD,CAAA;IACnD,qIAAqI;IACrI,+CAA6B,CAAA;IAC7B,sIAAsI;IACtI,mCAAiB,CAAA;AACnB,CAAC,EANW,cAAc,8BAAd,cAAc,QAMzB;AAyED,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,yEAAmD,CAAA;IACnD,2CAAqB,CAAA;IACrB,yCAAmB,CAAA;IACnB,2CAAqB,CAAA;AACvB,CAAC,EALW,kBAAkB,kCAAlB,kBAAkB,QAK7B;AAwHD,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,uDAAuD;IACvD,iEAAmD,CAAA;IACnD,iBAAiB;IACjB,uBAAS,CAAA;IACT,cAAc;IACd,uBAAS,CAAA;AACX,CAAC,EAPW,UAAU,0BAAV,UAAU,QAOrB;AAsJD,qBAAqB;AACrB,IAAY,OAMX;AAND,WAAY,OAAO;IACjB,sCAA2B,CAAA;IAC3B,uCAAuC;IACvC,sBAAW,CAAA;IACX,8BAA8B;IAC9B,wBAAa,CAAA;AACf,CAAC,EANW,OAAO,uBAAP,OAAO,QAMlB;AAqHD,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,6CAA6B,CAAA;AAC/B,CAAC,EAJW,YAAY,4BAAZ,YAAY,QAIvB;AA0ID,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,iCAAiB,CAAA;IACjB,iDAAiC,CAAA;IACjC,qCAAqB,CAAA;AACvB,CAAC,EAJW,YAAY,4BAAZ,YAAY,QAIvB;AAmDD,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,6CAA2B,CAAA;IAC3B,qDAAmC,CAAA;IACnC,2DAAyC,CAAA;AAC3C,CAAC,EAJW,cAAc,8BAAd,cAAc,QAIzB;AA6DD,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,2BAAX,WAAW,QAiCtB;AA4LD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAkMD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
|
|
@@ -58,7 +58,7 @@ export interface SubscriptionContract {
|
|
|
58
58
|
*/
|
|
59
59
|
buyerLanguage?: string | null;
|
|
60
60
|
/** Weight measurement unit - defaults to site's weight unit. */
|
|
61
|
-
weightUnit?:
|
|
61
|
+
weightUnit?: WeightUnitWithLiterals;
|
|
62
62
|
/**
|
|
63
63
|
* 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.
|
|
64
64
|
* @format CURRENCY
|
|
@@ -131,7 +131,7 @@ export interface V1SubscriptionDescription {
|
|
|
131
131
|
}
|
|
132
132
|
export interface V1SubscriptionSettings {
|
|
133
133
|
/** Frequency of recurring payment. */
|
|
134
|
-
frequency?:
|
|
134
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
135
135
|
/**
|
|
136
136
|
* Interval of recurring payment.
|
|
137
137
|
* @min 1
|
|
@@ -157,9 +157,11 @@ export declare enum SubscriptionFrequency {
|
|
|
157
157
|
MONTH = "MONTH",
|
|
158
158
|
YEAR = "YEAR"
|
|
159
159
|
}
|
|
160
|
+
/** @enumType */
|
|
161
|
+
export type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
160
162
|
export interface V1FreeTrialPeriod {
|
|
161
163
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
162
|
-
frequency?:
|
|
164
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
163
165
|
/**
|
|
164
166
|
* interval of period
|
|
165
167
|
* @min 1
|
|
@@ -245,7 +247,7 @@ export interface OrderLineItem {
|
|
|
245
247
|
*
|
|
246
248
|
* Default: `FULL_PAYMENT_ONLINE`
|
|
247
249
|
*/
|
|
248
|
-
paymentOption?:
|
|
250
|
+
paymentOption?: PaymentOptionTypeWithLiterals;
|
|
249
251
|
/**
|
|
250
252
|
* Deprecated. Use `taxInfo` instead.
|
|
251
253
|
* This field will be removed on September 30, 2024.
|
|
@@ -416,6 +418,8 @@ export declare enum DescriptionLineType {
|
|
|
416
418
|
/** Color type. */
|
|
417
419
|
COLOR = "COLOR"
|
|
418
420
|
}
|
|
421
|
+
/** @enumType */
|
|
422
|
+
export type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
|
|
419
423
|
export interface FocalPoint {
|
|
420
424
|
/** X-coordinate of the focal point. */
|
|
421
425
|
x?: number;
|
|
@@ -439,14 +443,14 @@ export interface PhysicalProperties {
|
|
|
439
443
|
}
|
|
440
444
|
export interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
441
445
|
/** Preset item type. */
|
|
442
|
-
preset?:
|
|
446
|
+
preset?: ItemTypeItemTypeWithLiterals;
|
|
443
447
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
444
448
|
custom?: string;
|
|
445
449
|
}
|
|
446
450
|
/** @oneof */
|
|
447
451
|
export interface ItemTypeItemTypeDataOneOf {
|
|
448
452
|
/** Preset item type. */
|
|
449
|
-
preset?:
|
|
453
|
+
preset?: ItemTypeItemTypeWithLiterals;
|
|
450
454
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
451
455
|
custom?: string;
|
|
452
456
|
}
|
|
@@ -457,6 +461,8 @@ export declare enum ItemTypeItemType {
|
|
|
457
461
|
GIFT_CARD = "GIFT_CARD",
|
|
458
462
|
SERVICE = "SERVICE"
|
|
459
463
|
}
|
|
464
|
+
/** @enumType */
|
|
465
|
+
export type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
|
|
460
466
|
/** Type of selected payment option for catalog item */
|
|
461
467
|
export declare enum PaymentOptionType {
|
|
462
468
|
/** The entire payment for this item happens as part of the checkout. */
|
|
@@ -470,6 +476,8 @@ export declare enum PaymentOptionType {
|
|
|
470
476
|
/** 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`. */
|
|
471
477
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
472
478
|
}
|
|
479
|
+
/** @enumType */
|
|
480
|
+
export type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
|
|
473
481
|
export interface ItemTaxFullDetails {
|
|
474
482
|
/** Taxable amount of this line item. */
|
|
475
483
|
taxableAmount?: Price;
|
|
@@ -535,7 +543,7 @@ export interface LineItemTaxBreakdown {
|
|
|
535
543
|
*/
|
|
536
544
|
taxName?: string | null;
|
|
537
545
|
/** Type of jurisdiction that taxes were calculated for. */
|
|
538
|
-
jurisdictionType?:
|
|
546
|
+
jurisdictionType?: JurisdictionTypeWithLiterals;
|
|
539
547
|
/** Non-taxable amount of the line item price. */
|
|
540
548
|
nonTaxableAmount?: Price;
|
|
541
549
|
/** Taxable amount of the line item price. */
|
|
@@ -550,6 +558,8 @@ export declare enum JurisdictionType {
|
|
|
550
558
|
CITY = "CITY",
|
|
551
559
|
SPECIAL = "SPECIAL"
|
|
552
560
|
}
|
|
561
|
+
/** @enumType */
|
|
562
|
+
export type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
|
|
553
563
|
export interface DigitalFile {
|
|
554
564
|
/**
|
|
555
565
|
* ID of the secure file in media.
|
|
@@ -638,7 +648,7 @@ export interface SubscriptionDescription {
|
|
|
638
648
|
}
|
|
639
649
|
export interface SubscriptionSettings {
|
|
640
650
|
/** Frequency of recurring payment. */
|
|
641
|
-
frequency?:
|
|
651
|
+
frequency?: V2SubscriptionFrequencyWithLiterals;
|
|
642
652
|
/**
|
|
643
653
|
* Interval of recurring payment.
|
|
644
654
|
* @min 1
|
|
@@ -665,9 +675,11 @@ export declare enum V2SubscriptionFrequency {
|
|
|
665
675
|
MONTH = "MONTH",
|
|
666
676
|
YEAR = "YEAR"
|
|
667
677
|
}
|
|
678
|
+
/** @enumType */
|
|
679
|
+
export type V2SubscriptionFrequencyWithLiterals = V2SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
668
680
|
export interface FreeTrialPeriod {
|
|
669
681
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
670
|
-
frequency?:
|
|
682
|
+
frequency?: V2SubscriptionFrequencyWithLiterals;
|
|
671
683
|
/**
|
|
672
684
|
* interval of period
|
|
673
685
|
* @min 1
|
|
@@ -677,7 +689,7 @@ export interface FreeTrialPeriod {
|
|
|
677
689
|
}
|
|
678
690
|
export interface BillingAdjustment {
|
|
679
691
|
/** The type of adjustment. */
|
|
680
|
-
type?:
|
|
692
|
+
type?: AdjustmentTypeWithLiterals;
|
|
681
693
|
/** Summary of the prorated adjustment amount. */
|
|
682
694
|
priceSummary?: BillingAdjustmentPriceSummary;
|
|
683
695
|
}
|
|
@@ -688,6 +700,8 @@ export declare enum AdjustmentType {
|
|
|
688
700
|
/** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
|
|
689
701
|
CREDIT = "CREDIT"
|
|
690
702
|
}
|
|
703
|
+
/** @enumType */
|
|
704
|
+
export type AdjustmentTypeWithLiterals = AdjustmentType | 'UNKNOWN_ADJUSTMENT_TYPE' | 'EXTRA_CHARGE' | 'CREDIT';
|
|
691
705
|
export interface BillingAdjustmentPriceSummary {
|
|
692
706
|
/** Subtotal of adjustment, before tax. */
|
|
693
707
|
subtotal?: Price;
|
|
@@ -740,12 +754,12 @@ export interface LocationAndQuantity {
|
|
|
740
754
|
}
|
|
741
755
|
export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
742
756
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
743
|
-
addressType?:
|
|
757
|
+
addressType?: TaxableAddressTypeWithLiterals;
|
|
744
758
|
}
|
|
745
759
|
/** @oneof */
|
|
746
760
|
export interface TaxableAddressTaxableAddressDataOneOf {
|
|
747
761
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
748
|
-
addressType?:
|
|
762
|
+
addressType?: TaxableAddressTypeWithLiterals;
|
|
749
763
|
}
|
|
750
764
|
export declare enum TaxableAddressType {
|
|
751
765
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
@@ -753,6 +767,8 @@ export declare enum TaxableAddressType {
|
|
|
753
767
|
BILLING = "BILLING",
|
|
754
768
|
SHIPPING = "SHIPPING"
|
|
755
769
|
}
|
|
770
|
+
/** @enumType */
|
|
771
|
+
export type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
|
|
756
772
|
export interface ExtendedFields {
|
|
757
773
|
/**
|
|
758
774
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
@@ -865,6 +881,8 @@ export declare enum WeightUnit {
|
|
|
865
881
|
/** Pounds. */
|
|
866
882
|
LB = "LB"
|
|
867
883
|
}
|
|
884
|
+
/** @enumType */
|
|
885
|
+
export type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
|
|
868
886
|
export interface CurrencyConversionDetails {
|
|
869
887
|
/**
|
|
870
888
|
* 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.
|
|
@@ -996,7 +1014,7 @@ export interface VatId {
|
|
|
996
1014
|
* + `CPF`: for individual tax payers
|
|
997
1015
|
* + `CNPJ`: for corporations
|
|
998
1016
|
*/
|
|
999
|
-
type?:
|
|
1017
|
+
type?: VatTypeWithLiterals;
|
|
1000
1018
|
}
|
|
1001
1019
|
/** tax info types */
|
|
1002
1020
|
export declare enum VatType {
|
|
@@ -1006,6 +1024,8 @@ export declare enum VatType {
|
|
|
1006
1024
|
/** CNPJ - for corporations */
|
|
1007
1025
|
CNPJ = "CNPJ"
|
|
1008
1026
|
}
|
|
1027
|
+
/** @enumType */
|
|
1028
|
+
export type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
|
|
1009
1029
|
export interface ShippingInformation {
|
|
1010
1030
|
/**
|
|
1011
1031
|
* App Def Id of external provider which was a source of shipping info
|
|
@@ -1066,7 +1086,7 @@ export interface PickupDetails {
|
|
|
1066
1086
|
/** Pickup address. */
|
|
1067
1087
|
address?: PickupAddress;
|
|
1068
1088
|
/** Pickup method */
|
|
1069
|
-
pickupMethod?:
|
|
1089
|
+
pickupMethod?: PickupMethodWithLiterals;
|
|
1070
1090
|
}
|
|
1071
1091
|
/** Physical address */
|
|
1072
1092
|
export interface PickupAddress {
|
|
@@ -1118,6 +1138,8 @@ export declare enum PickupMethod {
|
|
|
1118
1138
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1119
1139
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1120
1140
|
}
|
|
1141
|
+
/** @enumType */
|
|
1142
|
+
export type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
|
|
1121
1143
|
export interface DeliveryTimeSlot {
|
|
1122
1144
|
/** Delivery slot starting time. */
|
|
1123
1145
|
from?: Date | null;
|
|
@@ -1189,7 +1211,7 @@ export interface OrderTaxBreakdown {
|
|
|
1189
1211
|
*/
|
|
1190
1212
|
jurisdiction?: string;
|
|
1191
1213
|
/** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
1192
|
-
jurisdictionType?:
|
|
1214
|
+
jurisdictionType?: JurisdictionTypeWithLiterals;
|
|
1193
1215
|
/**
|
|
1194
1216
|
* The rate at which this tax detail was calculated.
|
|
1195
1217
|
* @format DECIMAL_VALUE
|
|
@@ -1212,7 +1234,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1212
1234
|
* * `"SPECIFIC-ITEMS"` - discount applies to specific items.
|
|
1213
1235
|
* * `"SHIPPING"` - discount applies to shipping. For example, free shipping.
|
|
1214
1236
|
*/
|
|
1215
|
-
discountType?:
|
|
1237
|
+
discountType?: DiscountTypeWithLiterals;
|
|
1216
1238
|
/**
|
|
1217
1239
|
* IDs of line items discount applies to.
|
|
1218
1240
|
* Deprecated. Use `line_item_discounts` instead.
|
|
@@ -1245,6 +1267,8 @@ export declare enum DiscountType {
|
|
|
1245
1267
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1246
1268
|
SHIPPING = "SHIPPING"
|
|
1247
1269
|
}
|
|
1270
|
+
/** @enumType */
|
|
1271
|
+
export type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
1248
1272
|
/** Coupon */
|
|
1249
1273
|
export interface Coupon {
|
|
1250
1274
|
/** Coupon ID. */
|
|
@@ -1261,7 +1285,7 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
|
|
|
1261
1285
|
* Pre-defined discount reason (optional).
|
|
1262
1286
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
1263
1287
|
*/
|
|
1264
|
-
discountReason?:
|
|
1288
|
+
discountReason?: DiscountReasonWithLiterals;
|
|
1265
1289
|
/**
|
|
1266
1290
|
* Discount description as free text (optional).
|
|
1267
1291
|
* @maxLength 200
|
|
@@ -1276,7 +1300,7 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1276
1300
|
* Pre-defined discount reason (optional).
|
|
1277
1301
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
1278
1302
|
*/
|
|
1279
|
-
discountReason?:
|
|
1303
|
+
discountReason?: DiscountReasonWithLiterals;
|
|
1280
1304
|
/**
|
|
1281
1305
|
* Discount description as free text (optional).
|
|
1282
1306
|
* @maxLength 200
|
|
@@ -1288,6 +1312,8 @@ export declare enum DiscountReason {
|
|
|
1288
1312
|
EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
|
|
1289
1313
|
BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
|
|
1290
1314
|
}
|
|
1315
|
+
/** @enumType */
|
|
1316
|
+
export type DiscountReasonWithLiterals = DiscountReason | 'UNSPECIFIED' | 'EXCHANGED_ITEMS' | 'BILLING_ADJUSTMENT';
|
|
1291
1317
|
export interface DiscountRule {
|
|
1292
1318
|
/**
|
|
1293
1319
|
* Discount rule ID
|
|
@@ -1324,7 +1350,7 @@ export interface LineItemDiscount {
|
|
|
1324
1350
|
}
|
|
1325
1351
|
export interface ChannelInfo {
|
|
1326
1352
|
/** Sales channel that submitted the order. */
|
|
1327
|
-
type?:
|
|
1353
|
+
type?: ChannelTypeWithLiterals;
|
|
1328
1354
|
/**
|
|
1329
1355
|
* Reference to an order ID from an external system.
|
|
1330
1356
|
* @maxLength 100
|
|
@@ -1370,6 +1396,8 @@ export declare enum ChannelType {
|
|
|
1370
1396
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
1371
1397
|
FAIRE_COM = "FAIRE_COM"
|
|
1372
1398
|
}
|
|
1399
|
+
/** @enumType */
|
|
1400
|
+
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';
|
|
1373
1401
|
export interface CustomField {
|
|
1374
1402
|
/** Custom field value. */
|
|
1375
1403
|
value?: any;
|
|
@@ -1520,12 +1548,14 @@ export interface Sorting {
|
|
|
1520
1548
|
*/
|
|
1521
1549
|
fieldName?: string;
|
|
1522
1550
|
/** Sort order. */
|
|
1523
|
-
order?:
|
|
1551
|
+
order?: SortOrderWithLiterals;
|
|
1524
1552
|
}
|
|
1525
1553
|
export declare enum SortOrder {
|
|
1526
1554
|
ASC = "ASC",
|
|
1527
1555
|
DESC = "DESC"
|
|
1528
1556
|
}
|
|
1557
|
+
/** @enumType */
|
|
1558
|
+
export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1529
1559
|
export interface CursorPaging {
|
|
1530
1560
|
/**
|
|
1531
1561
|
* Maximum number of items to return in the results.
|
|
@@ -1674,7 +1704,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1674
1704
|
*/
|
|
1675
1705
|
appId?: string;
|
|
1676
1706
|
/** @readonly */
|
|
1677
|
-
identityType?:
|
|
1707
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1678
1708
|
}
|
|
1679
1709
|
/** @oneof */
|
|
1680
1710
|
export interface IdentificationDataIdOneOf {
|
|
@@ -1706,6 +1736,8 @@ export declare enum WebhookIdentityType {
|
|
|
1706
1736
|
WIX_USER = "WIX_USER",
|
|
1707
1737
|
APP = "APP"
|
|
1708
1738
|
}
|
|
1739
|
+
/** @enumType */
|
|
1740
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1709
1741
|
export interface BaseEventMetadata {
|
|
1710
1742
|
/**
|
|
1711
1743
|
* App instance ID.
|
|
@@ -1875,6 +1907,26 @@ export interface SubscriptionContractsQueryBuilder {
|
|
|
1875
1907
|
* @documentationMaturity preview
|
|
1876
1908
|
*/
|
|
1877
1909
|
ne: (propertyName: '_id' | 'buyerInfo.contactId', value: any) => SubscriptionContractsQueryBuilder;
|
|
1910
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1911
|
+
* @param value - Value to compare against.
|
|
1912
|
+
* @documentationMaturity preview
|
|
1913
|
+
*/
|
|
1914
|
+
ge: (propertyName: '_id' | 'buyerInfo.contactId', value: any) => SubscriptionContractsQueryBuilder;
|
|
1915
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1916
|
+
* @param value - Value to compare against.
|
|
1917
|
+
* @documentationMaturity preview
|
|
1918
|
+
*/
|
|
1919
|
+
gt: (propertyName: '_id' | 'buyerInfo.contactId', value: any) => SubscriptionContractsQueryBuilder;
|
|
1920
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1921
|
+
* @param value - Value to compare against.
|
|
1922
|
+
* @documentationMaturity preview
|
|
1923
|
+
*/
|
|
1924
|
+
le: (propertyName: '_id' | 'buyerInfo.contactId', value: any) => SubscriptionContractsQueryBuilder;
|
|
1925
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1926
|
+
* @param value - Value to compare against.
|
|
1927
|
+
* @documentationMaturity preview
|
|
1928
|
+
*/
|
|
1929
|
+
lt: (propertyName: '_id' | 'buyerInfo.contactId', value: any) => SubscriptionContractsQueryBuilder;
|
|
1878
1930
|
/** @param propertyName - Property whose value is compared with `string`.
|
|
1879
1931
|
* @param string - String to compare against. Case-insensitive.
|
|
1880
1932
|
* @documentationMaturity preview
|