@wix/auto_sdk_ecom_draft-orders 1.0.31 → 1.0.33
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-v1-draft-order-draft-orders.types.d.ts +90 -34
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +94 -38
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.d.ts +90 -34
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +94 -38
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts +90 -34
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +99 -38
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.d.ts +90 -34
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +99 -38
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -74,9 +74,9 @@ export interface DraftOrder {
|
|
|
74
74
|
* Draft order status.
|
|
75
75
|
* @readonly
|
|
76
76
|
*/
|
|
77
|
-
status?:
|
|
77
|
+
status?: EditingStatusWithLiterals;
|
|
78
78
|
/** Weight measurement unit. Defaults to the site's weight unit. */
|
|
79
|
-
weightUnit?:
|
|
79
|
+
weightUnit?: WeightUnitWithLiterals;
|
|
80
80
|
/**
|
|
81
81
|
* Currency used for pricing.
|
|
82
82
|
* @format CURRENCY
|
|
@@ -275,7 +275,7 @@ export interface OrderLineItem {
|
|
|
275
275
|
*
|
|
276
276
|
* Default: `FULL_PAYMENT_ONLINE`
|
|
277
277
|
*/
|
|
278
|
-
paymentOption?:
|
|
278
|
+
paymentOption?: PaymentOptionTypeWithLiterals;
|
|
279
279
|
/**
|
|
280
280
|
* Deprecated. Use `taxInfo` instead.
|
|
281
281
|
* This field will be removed on September 30, 2024.
|
|
@@ -434,6 +434,8 @@ export declare enum DescriptionLineType {
|
|
|
434
434
|
/** Color type. */
|
|
435
435
|
COLOR = "COLOR"
|
|
436
436
|
}
|
|
437
|
+
/** @enumType */
|
|
438
|
+
export type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
|
|
437
439
|
export interface FocalPoint {
|
|
438
440
|
/** X-coordinate of the focal point. */
|
|
439
441
|
x?: number;
|
|
@@ -457,14 +459,14 @@ export interface PhysicalProperties {
|
|
|
457
459
|
}
|
|
458
460
|
export interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
459
461
|
/** Preset item type. */
|
|
460
|
-
preset?:
|
|
462
|
+
preset?: ItemTypeItemTypeWithLiterals;
|
|
461
463
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
462
464
|
custom?: string;
|
|
463
465
|
}
|
|
464
466
|
/** @oneof */
|
|
465
467
|
export interface ItemTypeItemTypeDataOneOf {
|
|
466
468
|
/** Preset item type. */
|
|
467
|
-
preset?:
|
|
469
|
+
preset?: ItemTypeItemTypeWithLiterals;
|
|
468
470
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
469
471
|
custom?: string;
|
|
470
472
|
}
|
|
@@ -475,6 +477,8 @@ export declare enum ItemTypeItemType {
|
|
|
475
477
|
GIFT_CARD = "GIFT_CARD",
|
|
476
478
|
SERVICE = "SERVICE"
|
|
477
479
|
}
|
|
480
|
+
/** @enumType */
|
|
481
|
+
export type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
|
|
478
482
|
/** Type of selected payment option for catalog item */
|
|
479
483
|
export declare enum PaymentOptionType {
|
|
480
484
|
/** The entire payment for this item happens as part of the checkout. */
|
|
@@ -488,6 +492,8 @@ export declare enum PaymentOptionType {
|
|
|
488
492
|
/** 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`. */
|
|
489
493
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
490
494
|
}
|
|
495
|
+
/** @enumType */
|
|
496
|
+
export type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
|
|
491
497
|
export interface ItemTaxFullDetails {
|
|
492
498
|
/** Taxable amount of this line item. */
|
|
493
499
|
taxableAmount?: Price;
|
|
@@ -553,7 +559,7 @@ export interface LineItemTaxBreakdown {
|
|
|
553
559
|
*/
|
|
554
560
|
taxName?: string | null;
|
|
555
561
|
/** Type of jurisdiction that taxes were calculated for. */
|
|
556
|
-
jurisdictionType?:
|
|
562
|
+
jurisdictionType?: JurisdictionTypeWithLiterals;
|
|
557
563
|
/** Non-taxable amount of the line item price. */
|
|
558
564
|
nonTaxableAmount?: Price;
|
|
559
565
|
/** Taxable amount of the line item price. */
|
|
@@ -568,6 +574,8 @@ export declare enum JurisdictionType {
|
|
|
568
574
|
CITY = "CITY",
|
|
569
575
|
SPECIAL = "SPECIAL"
|
|
570
576
|
}
|
|
577
|
+
/** @enumType */
|
|
578
|
+
export type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
|
|
571
579
|
export interface DigitalFile {
|
|
572
580
|
/**
|
|
573
581
|
* ID of the secure file in media.
|
|
@@ -656,7 +664,7 @@ export interface SubscriptionDescription {
|
|
|
656
664
|
}
|
|
657
665
|
export interface SubscriptionSettings {
|
|
658
666
|
/** Frequency of recurring payment. */
|
|
659
|
-
frequency?:
|
|
667
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
660
668
|
/**
|
|
661
669
|
* Interval of recurring payment.
|
|
662
670
|
* @min 1
|
|
@@ -683,9 +691,11 @@ export declare enum SubscriptionFrequency {
|
|
|
683
691
|
MONTH = "MONTH",
|
|
684
692
|
YEAR = "YEAR"
|
|
685
693
|
}
|
|
694
|
+
/** @enumType */
|
|
695
|
+
export type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
686
696
|
export interface FreeTrialPeriod {
|
|
687
697
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
688
|
-
frequency?:
|
|
698
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
689
699
|
/**
|
|
690
700
|
* interval of period
|
|
691
701
|
* @min 1
|
|
@@ -695,7 +705,7 @@ export interface FreeTrialPeriod {
|
|
|
695
705
|
}
|
|
696
706
|
export interface BillingAdjustment {
|
|
697
707
|
/** The type of adjustment. */
|
|
698
|
-
type?:
|
|
708
|
+
type?: AdjustmentTypeWithLiterals;
|
|
699
709
|
/** Summary of the prorated adjustment amount. */
|
|
700
710
|
priceSummary?: BillingAdjustmentPriceSummary;
|
|
701
711
|
}
|
|
@@ -706,6 +716,8 @@ export declare enum AdjustmentType {
|
|
|
706
716
|
/** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
|
|
707
717
|
CREDIT = "CREDIT"
|
|
708
718
|
}
|
|
719
|
+
/** @enumType */
|
|
720
|
+
export type AdjustmentTypeWithLiterals = AdjustmentType | 'UNKNOWN_ADJUSTMENT_TYPE' | 'EXTRA_CHARGE' | 'CREDIT';
|
|
709
721
|
export interface BillingAdjustmentPriceSummary {
|
|
710
722
|
/** Subtotal of adjustment, before tax. */
|
|
711
723
|
subtotal?: Price;
|
|
@@ -742,12 +754,12 @@ export interface LocationAndQuantity {
|
|
|
742
754
|
}
|
|
743
755
|
export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
744
756
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
745
|
-
addressType?:
|
|
757
|
+
addressType?: TaxableAddressTypeWithLiterals;
|
|
746
758
|
}
|
|
747
759
|
/** @oneof */
|
|
748
760
|
export interface TaxableAddressTaxableAddressDataOneOf {
|
|
749
761
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
750
|
-
addressType?:
|
|
762
|
+
addressType?: TaxableAddressTypeWithLiterals;
|
|
751
763
|
}
|
|
752
764
|
export declare enum TaxableAddressType {
|
|
753
765
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
@@ -755,6 +767,8 @@ export declare enum TaxableAddressType {
|
|
|
755
767
|
BILLING = "BILLING",
|
|
756
768
|
SHIPPING = "SHIPPING"
|
|
757
769
|
}
|
|
770
|
+
/** @enumType */
|
|
771
|
+
export type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
|
|
758
772
|
export interface ExtendedFields {
|
|
759
773
|
/**
|
|
760
774
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
@@ -1009,7 +1023,7 @@ export interface VatId {
|
|
|
1009
1023
|
* + `CPF`: for individual tax payers
|
|
1010
1024
|
* + `CNPJ`: for corporations
|
|
1011
1025
|
*/
|
|
1012
|
-
type?:
|
|
1026
|
+
type?: VatTypeWithLiterals;
|
|
1013
1027
|
}
|
|
1014
1028
|
/** tax info types */
|
|
1015
1029
|
export declare enum VatType {
|
|
@@ -1019,11 +1033,13 @@ export declare enum VatType {
|
|
|
1019
1033
|
/** CNPJ - for corporations */
|
|
1020
1034
|
CNPJ = "CNPJ"
|
|
1021
1035
|
}
|
|
1036
|
+
/** @enumType */
|
|
1037
|
+
export type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
|
|
1022
1038
|
export interface V1PickupDetails {
|
|
1023
1039
|
/** Pickup address. */
|
|
1024
1040
|
address?: PickupAddress;
|
|
1025
1041
|
/** Pickup method */
|
|
1026
|
-
pickupMethod?:
|
|
1042
|
+
pickupMethod?: PickupDetailsPickupMethodWithLiterals;
|
|
1027
1043
|
}
|
|
1028
1044
|
/** Physical address */
|
|
1029
1045
|
export interface PickupAddress {
|
|
@@ -1075,6 +1091,8 @@ export declare enum PickupDetailsPickupMethod {
|
|
|
1075
1091
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1076
1092
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1077
1093
|
}
|
|
1094
|
+
/** @enumType */
|
|
1095
|
+
export type PickupDetailsPickupMethodWithLiterals = PickupDetailsPickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
|
|
1078
1096
|
export interface V1DeliveryTimeSlot {
|
|
1079
1097
|
/** Delivery slot starting time. */
|
|
1080
1098
|
from?: Date | null;
|
|
@@ -1162,7 +1180,7 @@ export interface AdditionalFeeDetails {
|
|
|
1162
1180
|
* + `AUTOMATIC`: User added a catalog item which is configured to have an additional fee.
|
|
1163
1181
|
* + `CUSTOM`: This additional fee was created by the Create Custom Additional Fees method.
|
|
1164
1182
|
*/
|
|
1165
|
-
source?:
|
|
1183
|
+
source?: SourceTypeWithLiterals;
|
|
1166
1184
|
/** Whether this additional fee is applied to the order. */
|
|
1167
1185
|
applied?: boolean;
|
|
1168
1186
|
}
|
|
@@ -1222,6 +1240,8 @@ export declare enum SourceType {
|
|
|
1222
1240
|
/** Added manually to draft order. */
|
|
1223
1241
|
CUSTOM = "CUSTOM"
|
|
1224
1242
|
}
|
|
1243
|
+
/** @enumType */
|
|
1244
|
+
export type SourceTypeWithLiterals = SourceType | 'ORIGINAL_ORDER' | 'AUTOMATIC' | 'CUSTOM';
|
|
1225
1245
|
export interface DiscountDetails {
|
|
1226
1246
|
/** Discount details. */
|
|
1227
1247
|
discount?: AppliedDiscount;
|
|
@@ -1232,7 +1252,7 @@ export interface DiscountDetails {
|
|
|
1232
1252
|
* + `ORIGINAL_ORDER`: This discount is part of the original order.
|
|
1233
1253
|
* + `CUSTOM`: This discount was created by the Create Custom Discounts method.
|
|
1234
1254
|
*/
|
|
1235
|
-
source?:
|
|
1255
|
+
source?: SourceTypeWithLiterals;
|
|
1236
1256
|
/** Whether this discount is applied to the order. */
|
|
1237
1257
|
applied?: boolean;
|
|
1238
1258
|
}
|
|
@@ -1249,7 +1269,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1249
1269
|
* * `"SPECIFIC-ITEMS"` - discount applies to specific items.
|
|
1250
1270
|
* * `"SHIPPING"` - discount applies to shipping. For example, free shipping.
|
|
1251
1271
|
*/
|
|
1252
|
-
discountType?:
|
|
1272
|
+
discountType?: AppliedDiscountDiscountTypeWithLiterals;
|
|
1253
1273
|
/**
|
|
1254
1274
|
* IDs of line items discount applies to.
|
|
1255
1275
|
* Deprecated. Use `line_item_discounts` instead.
|
|
@@ -1282,6 +1302,8 @@ export declare enum AppliedDiscountDiscountType {
|
|
|
1282
1302
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1283
1303
|
SHIPPING = "SHIPPING"
|
|
1284
1304
|
}
|
|
1305
|
+
/** @enumType */
|
|
1306
|
+
export type AppliedDiscountDiscountTypeWithLiterals = AppliedDiscountDiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
1285
1307
|
/** Coupon */
|
|
1286
1308
|
export interface Coupon {
|
|
1287
1309
|
/** Coupon ID. */
|
|
@@ -1298,7 +1320,7 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
|
|
|
1298
1320
|
* Pre-defined discount reason (optional).
|
|
1299
1321
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
1300
1322
|
*/
|
|
1301
|
-
discountReason?:
|
|
1323
|
+
discountReason?: DiscountReasonWithLiterals;
|
|
1302
1324
|
/**
|
|
1303
1325
|
* Discount description as free text (optional).
|
|
1304
1326
|
* @maxLength 200
|
|
@@ -1313,7 +1335,7 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1313
1335
|
* Pre-defined discount reason (optional).
|
|
1314
1336
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
1315
1337
|
*/
|
|
1316
|
-
discountReason?:
|
|
1338
|
+
discountReason?: DiscountReasonWithLiterals;
|
|
1317
1339
|
/**
|
|
1318
1340
|
* Discount description as free text (optional).
|
|
1319
1341
|
* @maxLength 200
|
|
@@ -1325,6 +1347,8 @@ export declare enum DiscountReason {
|
|
|
1325
1347
|
EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
|
|
1326
1348
|
BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
|
|
1327
1349
|
}
|
|
1350
|
+
/** @enumType */
|
|
1351
|
+
export type DiscountReasonWithLiterals = DiscountReason | 'UNSPECIFIED' | 'EXCHANGED_ITEMS' | 'BILLING_ADJUSTMENT';
|
|
1328
1352
|
export interface DiscountRule {
|
|
1329
1353
|
/**
|
|
1330
1354
|
* Discount rule ID
|
|
@@ -1394,6 +1418,8 @@ export declare enum EditingStatus {
|
|
|
1394
1418
|
*/
|
|
1395
1419
|
COMMITTED = "COMMITTED"
|
|
1396
1420
|
}
|
|
1421
|
+
/** @enumType */
|
|
1422
|
+
export type EditingStatusWithLiterals = EditingStatus | 'DRAFT' | 'COMMITTED';
|
|
1397
1423
|
export declare enum WeightUnit {
|
|
1398
1424
|
/** Weight unit can't be classified due to an error. */
|
|
1399
1425
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
@@ -1402,6 +1428,8 @@ export declare enum WeightUnit {
|
|
|
1402
1428
|
/** Pounds. */
|
|
1403
1429
|
LB = "LB"
|
|
1404
1430
|
}
|
|
1431
|
+
/** @enumType */
|
|
1432
|
+
export type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
|
|
1405
1433
|
export interface PriceSummary {
|
|
1406
1434
|
/** Subtotal of all the line items, before discounts and before tax. */
|
|
1407
1435
|
subtotal?: Price;
|
|
@@ -1569,7 +1597,7 @@ export interface OrderTaxBreakdown {
|
|
|
1569
1597
|
*/
|
|
1570
1598
|
jurisdiction?: string;
|
|
1571
1599
|
/** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
1572
|
-
jurisdictionType?:
|
|
1600
|
+
jurisdictionType?: JurisdictionTypeWithLiterals;
|
|
1573
1601
|
/**
|
|
1574
1602
|
* The rate at which this tax detail was calculated.
|
|
1575
1603
|
* @format DECIMAL_VALUE
|
|
@@ -1722,7 +1750,7 @@ export interface PickupDetails {
|
|
|
1722
1750
|
/** Pickup address. */
|
|
1723
1751
|
address?: Address;
|
|
1724
1752
|
/** Pickup method. */
|
|
1725
|
-
pickupMethod?:
|
|
1753
|
+
pickupMethod?: PickupMethodWithLiterals;
|
|
1726
1754
|
}
|
|
1727
1755
|
export declare enum PickupMethod {
|
|
1728
1756
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
@@ -1731,6 +1759,8 @@ export declare enum PickupMethod {
|
|
|
1731
1759
|
/** Pickup point. */
|
|
1732
1760
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1733
1761
|
}
|
|
1762
|
+
/** @enumType */
|
|
1763
|
+
export type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
|
|
1734
1764
|
export interface DeliveryTimeSlot {
|
|
1735
1765
|
/** Delivery time slot start time. */
|
|
1736
1766
|
from?: Date | null;
|
|
@@ -1845,10 +1875,12 @@ export declare enum RuleType {
|
|
|
1845
1875
|
EXACT_SIZE = "EXACT_SIZE",
|
|
1846
1876
|
REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
|
|
1847
1877
|
}
|
|
1878
|
+
/** @enumType */
|
|
1879
|
+
export type RuleTypeWithLiterals = RuleType | 'VALIDATION' | 'OTHER' | 'MAX' | 'MIN' | 'MAX_LENGTH' | 'MIN_LENGTH' | 'MAX_SIZE' | 'MIN_SIZE' | 'FORMAT' | 'DECIMAL_LTE' | 'DECIMAL_GTE' | 'DECIMAL_LT' | 'DECIMAL_GT' | 'DECIMAL_MAX_SCALE' | 'INVALID_ENUM_VALUE' | 'REQUIRED_FIELD' | 'FIELD_NOT_ALLOWED' | 'ONE_OF_ALIGNMENT' | 'EXACT_LENGTH' | 'EXACT_SIZE' | 'REQUIRED_ONE_OF_FIELD';
|
|
1848
1880
|
export interface FieldViolation {
|
|
1849
1881
|
field?: string;
|
|
1850
1882
|
description?: string;
|
|
1851
|
-
violatedRule?:
|
|
1883
|
+
violatedRule?: RuleTypeWithLiterals;
|
|
1852
1884
|
/** applicable when violated_rule=OTHER */
|
|
1853
1885
|
ruleName?: string | null;
|
|
1854
1886
|
data?: Record<string, any> | null;
|
|
@@ -1996,7 +2028,7 @@ export interface SecuredMedia {
|
|
|
1996
2028
|
*/
|
|
1997
2029
|
fileName?: string;
|
|
1998
2030
|
/** File type. */
|
|
1999
|
-
fileType?:
|
|
2031
|
+
fileType?: FileTypeWithLiterals;
|
|
2000
2032
|
}
|
|
2001
2033
|
export declare enum FileType {
|
|
2002
2034
|
UNSPECIFIED = "UNSPECIFIED",
|
|
@@ -2006,6 +2038,8 @@ export declare enum FileType {
|
|
|
2006
2038
|
SECURE_MUSIC = "SECURE_MUSIC",
|
|
2007
2039
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
2008
2040
|
}
|
|
2041
|
+
/** @enumType */
|
|
2042
|
+
export type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
|
|
2009
2043
|
export interface AddLineItemsToDraftOrderResponse {
|
|
2010
2044
|
/** Draft order calculated with the latest changes. */
|
|
2011
2045
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
@@ -2107,7 +2141,7 @@ export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
|
2107
2141
|
*/
|
|
2108
2142
|
percentage?: string | null;
|
|
2109
2143
|
/** Discount type. */
|
|
2110
|
-
discountType?:
|
|
2144
|
+
discountType?: DiscountTypeWithLiterals;
|
|
2111
2145
|
/**
|
|
2112
2146
|
* ID of line item discount applies to.
|
|
2113
2147
|
* @format GUID
|
|
@@ -2160,6 +2194,8 @@ export declare enum DiscountType {
|
|
|
2160
2194
|
/** Discount applies to shipping fee. */
|
|
2161
2195
|
SHIPPING = "SHIPPING"
|
|
2162
2196
|
}
|
|
2197
|
+
/** @enumType */
|
|
2198
|
+
export type DiscountTypeWithLiterals = DiscountType | 'UNKNOWN_TYPE' | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
2163
2199
|
export interface CreateCustomDiscountsResponse {
|
|
2164
2200
|
/** Draft order calculated with the latest changes. */
|
|
2165
2201
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
@@ -2383,7 +2419,7 @@ export interface GetOrderDraftabilityStatusResponse {
|
|
|
2383
2419
|
* Reasons why a draft order cannot be created from the order.
|
|
2384
2420
|
* @maxSize 5
|
|
2385
2421
|
*/
|
|
2386
|
-
nonDraftableReasons?:
|
|
2422
|
+
nonDraftableReasons?: NonDraftableReasonWithLiterals[];
|
|
2387
2423
|
}
|
|
2388
2424
|
export declare enum NonDraftableReason {
|
|
2389
2425
|
UNSPECIFIED = "UNSPECIFIED",
|
|
@@ -2408,6 +2444,8 @@ export declare enum NonDraftableReason {
|
|
|
2408
2444
|
/** Modifications of orders with subscription items are not supported. */
|
|
2409
2445
|
SUBSCRIPTION_LINE_ITEM_EXISTS = "SUBSCRIPTION_LINE_ITEM_EXISTS"
|
|
2410
2446
|
}
|
|
2447
|
+
/** @enumType */
|
|
2448
|
+
export type NonDraftableReasonWithLiterals = NonDraftableReason | 'UNSPECIFIED' | 'PARTIALLY_OR_FULLY_REFUNDED' | 'UNSUPPORTED_CHANNEL_TYPE' | 'ORDER_STATUS_IS_NOT_SUPPORTED' | 'ORDER_AND_SITE_CURRENCIES_ARE_INCONSISTENT' | 'ORDER_AND_SITE_WEIGHT_UNITS_ARE_INCONSISTENT' | 'ORDER_NOT_FOUND' | 'SUBSCRIPTION_LINE_ITEM_EXISTS';
|
|
2411
2449
|
export interface CommitDraftOrderRequest {
|
|
2412
2450
|
/**
|
|
2413
2451
|
* Draft order ID.
|
|
@@ -2461,19 +2499,19 @@ export interface Order {
|
|
|
2461
2499
|
/** Buyer information. */
|
|
2462
2500
|
buyerInfo?: BuyerInfo;
|
|
2463
2501
|
/** Order payment status. */
|
|
2464
|
-
paymentStatus?:
|
|
2502
|
+
paymentStatus?: PaymentStatusWithLiterals;
|
|
2465
2503
|
/**
|
|
2466
2504
|
* Order fulfillment status.
|
|
2467
2505
|
* @readonly
|
|
2468
2506
|
*/
|
|
2469
|
-
fulfillmentStatus?:
|
|
2507
|
+
fulfillmentStatus?: FulfillmentStatusWithLiterals;
|
|
2470
2508
|
/**
|
|
2471
2509
|
* Language for communication with the buyer. Defaults to the site language.
|
|
2472
2510
|
* For a site that supports multiple languages, this is the language the buyer selected.
|
|
2473
2511
|
*/
|
|
2474
2512
|
buyerLanguage?: string | null;
|
|
2475
2513
|
/** Weight measurement unit - defaults to site's weight unit. */
|
|
2476
|
-
weightUnit?:
|
|
2514
|
+
weightUnit?: WeightUnitWithLiterals;
|
|
2477
2515
|
/**
|
|
2478
2516
|
* 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.
|
|
2479
2517
|
* @format CURRENCY
|
|
@@ -2507,7 +2545,7 @@ export interface Order {
|
|
|
2507
2545
|
*/
|
|
2508
2546
|
buyerNote?: string | null;
|
|
2509
2547
|
/** Order status. */
|
|
2510
|
-
status?:
|
|
2548
|
+
status?: OrderStatusWithLiterals;
|
|
2511
2549
|
/** Whether order is archived. */
|
|
2512
2550
|
archived?: boolean | null;
|
|
2513
2551
|
/**
|
|
@@ -2535,7 +2573,7 @@ export interface Order {
|
|
|
2535
2573
|
*/
|
|
2536
2574
|
activities?: Activity[];
|
|
2537
2575
|
/** Order attribution source. */
|
|
2538
|
-
attributionSource?:
|
|
2576
|
+
attributionSource?: AttributionSourceWithLiterals;
|
|
2539
2577
|
/**
|
|
2540
2578
|
* ID of the order's initiator.
|
|
2541
2579
|
* @readonly
|
|
@@ -2642,6 +2680,8 @@ export declare enum PaymentStatus {
|
|
|
2642
2680
|
*/
|
|
2643
2681
|
DECLINED = "DECLINED"
|
|
2644
2682
|
}
|
|
2683
|
+
/** @enumType */
|
|
2684
|
+
export type PaymentStatusWithLiterals = PaymentStatus | 'UNSPECIFIED' | 'NOT_PAID' | 'PAID' | 'PARTIALLY_REFUNDED' | 'FULLY_REFUNDED' | 'PENDING' | 'PARTIALLY_PAID' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED';
|
|
2645
2685
|
export declare enum FulfillmentStatus {
|
|
2646
2686
|
/** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
|
|
2647
2687
|
NOT_FULFILLED = "NOT_FULFILLED",
|
|
@@ -2653,6 +2693,8 @@ export declare enum FulfillmentStatus {
|
|
|
2653
2693
|
/** Some, but not all, of the order items are fulfilled. */
|
|
2654
2694
|
PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
|
|
2655
2695
|
}
|
|
2696
|
+
/** @enumType */
|
|
2697
|
+
export type FulfillmentStatusWithLiterals = FulfillmentStatus | 'NOT_FULFILLED' | 'FULFILLED' | 'PARTIALLY_FULFILLED';
|
|
2656
2698
|
export interface CurrencyConversionDetails {
|
|
2657
2699
|
/**
|
|
2658
2700
|
* 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.
|
|
@@ -2696,6 +2738,8 @@ export declare enum OrderStatus {
|
|
|
2696
2738
|
*/
|
|
2697
2739
|
REJECTED = "REJECTED"
|
|
2698
2740
|
}
|
|
2741
|
+
/** @enumType */
|
|
2742
|
+
export type OrderStatusWithLiterals = OrderStatus | 'INITIALIZED' | 'APPROVED' | 'CANCELED' | 'PENDING' | 'REJECTED';
|
|
2699
2743
|
export interface Activity extends ActivityContentOneOf {
|
|
2700
2744
|
/** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
|
|
2701
2745
|
customActivity?: CustomActivity;
|
|
@@ -2721,7 +2765,7 @@ export interface Activity extends ActivityContentOneOf {
|
|
|
2721
2765
|
*/
|
|
2722
2766
|
_createdDate?: Date | null;
|
|
2723
2767
|
/** Activity type. */
|
|
2724
|
-
type?:
|
|
2768
|
+
type?: ActivityTypeWithLiterals;
|
|
2725
2769
|
}
|
|
2726
2770
|
/** @oneof */
|
|
2727
2771
|
export interface ActivityContentOneOf {
|
|
@@ -2864,7 +2908,7 @@ export interface LineItemQuantityChange {
|
|
|
2864
2908
|
*/
|
|
2865
2909
|
diff?: number;
|
|
2866
2910
|
/** Type of quantity change: increase or decrease. */
|
|
2867
|
-
deltaType?:
|
|
2911
|
+
deltaType?: LineItemQuantityChangeTypeWithLiterals;
|
|
2868
2912
|
}
|
|
2869
2913
|
export declare enum LineItemQuantityChangeType {
|
|
2870
2914
|
/** Quantity increased. */
|
|
@@ -2872,6 +2916,8 @@ export declare enum LineItemQuantityChangeType {
|
|
|
2872
2916
|
/** Quantity decreased. */
|
|
2873
2917
|
QUANTITY_DECREASED = "QUANTITY_DECREASED"
|
|
2874
2918
|
}
|
|
2919
|
+
/** @enumType */
|
|
2920
|
+
export type LineItemQuantityChangeTypeWithLiterals = LineItemQuantityChangeType | 'QUANTITY_INCREASED' | 'QUANTITY_DECREASED';
|
|
2875
2921
|
export interface LineItemPriceChange {
|
|
2876
2922
|
/** Item price before update. */
|
|
2877
2923
|
originalPrice?: Price;
|
|
@@ -3302,10 +3348,14 @@ export declare enum ActivityType {
|
|
|
3302
3348
|
/** @documentationMaturity preview */
|
|
3303
3349
|
ORDER_REJECTED = "ORDER_REJECTED"
|
|
3304
3350
|
}
|
|
3351
|
+
/** @enumType */
|
|
3352
|
+
export type ActivityTypeWithLiterals = ActivityType | 'ORDER_REFUNDED' | 'ORDER_PLACED' | 'ORDER_PAID' | 'ORDER_FULFILLED' | 'ORDER_NOT_FULFILLED' | 'ORDER_CANCELED' | 'DOWNLOAD_LINK_SENT' | 'TRACKING_NUMBER_ADDED' | 'TRACKING_NUMBER_EDITED' | 'TRACKING_LINK_ADDED' | 'SHIPPING_CONFIRMATION_EMAIL_SENT' | 'INVOICE_ADDED' | 'INVOICE_REMOVED' | 'INVOICE_SENT' | 'FULFILLER_EMAIL_SENT' | 'SHIPPING_ADDRESS_EDITED' | 'EMAIL_EDITED' | 'PICKUP_READY_EMAIL_SENT' | 'CUSTOM_ACTIVITY' | 'MERCHANT_COMMENT' | 'ORDER_CREATED_FROM_EXCHANGE' | 'NEW_EXCHANGE_ORDER_CREATED' | 'ORDER_PARTIALLY_PAID' | 'DRAFT_ORDER_CHANGES_APPLIED' | 'SAVED_PAYMENT_METHOD' | 'PAYMENT_PENDING' | 'PAYMENT_CANCELED' | 'PAYMENT_DECLINED' | 'ORDER_PENDING' | 'ORDER_REJECTED';
|
|
3305
3353
|
export declare enum AttributionSource {
|
|
3306
3354
|
UNSPECIFIED = "UNSPECIFIED",
|
|
3307
3355
|
FACEBOOK_ADS = "FACEBOOK_ADS"
|
|
3308
3356
|
}
|
|
3357
|
+
/** @enumType */
|
|
3358
|
+
export type AttributionSourceWithLiterals = AttributionSource | 'UNSPECIFIED' | 'FACEBOOK_ADS';
|
|
3309
3359
|
export interface V1CreatedBy extends V1CreatedByStringOneOf {
|
|
3310
3360
|
/**
|
|
3311
3361
|
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
@@ -3355,7 +3405,7 @@ export interface V1CreatedByStringOneOf {
|
|
|
3355
3405
|
}
|
|
3356
3406
|
export interface ChannelInfo {
|
|
3357
3407
|
/** Sales channel that submitted the order. */
|
|
3358
|
-
type?:
|
|
3408
|
+
type?: ChannelTypeWithLiterals;
|
|
3359
3409
|
/**
|
|
3360
3410
|
* Reference to an order ID from an external system.
|
|
3361
3411
|
* @maxLength 100
|
|
@@ -3401,6 +3451,8 @@ export declare enum ChannelType {
|
|
|
3401
3451
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
3402
3452
|
FAIRE_COM = "FAIRE_COM"
|
|
3403
3453
|
}
|
|
3454
|
+
/** @enumType */
|
|
3455
|
+
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';
|
|
3404
3456
|
export interface CustomField {
|
|
3405
3457
|
/** Custom field value. */
|
|
3406
3458
|
value?: any;
|
|
@@ -3576,12 +3628,14 @@ export interface Sorting {
|
|
|
3576
3628
|
*/
|
|
3577
3629
|
fieldName?: string;
|
|
3578
3630
|
/** Sort order. */
|
|
3579
|
-
order?:
|
|
3631
|
+
order?: SortOrderWithLiterals;
|
|
3580
3632
|
}
|
|
3581
3633
|
export declare enum SortOrder {
|
|
3582
3634
|
ASC = "ASC",
|
|
3583
3635
|
DESC = "DESC"
|
|
3584
3636
|
}
|
|
3637
|
+
/** @enumType */
|
|
3638
|
+
export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
3585
3639
|
export interface CursorPaging {
|
|
3586
3640
|
/**
|
|
3587
3641
|
* Maximum number of items to return in the results.
|
|
@@ -3770,7 +3824,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3770
3824
|
*/
|
|
3771
3825
|
appId?: string;
|
|
3772
3826
|
/** @readonly */
|
|
3773
|
-
identityType?:
|
|
3827
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3774
3828
|
}
|
|
3775
3829
|
/** @oneof */
|
|
3776
3830
|
export interface IdentificationDataIdOneOf {
|
|
@@ -3802,6 +3856,8 @@ export declare enum WebhookIdentityType {
|
|
|
3802
3856
|
WIX_USER = "WIX_USER",
|
|
3803
3857
|
APP = "APP"
|
|
3804
3858
|
}
|
|
3859
|
+
/** @enumType */
|
|
3860
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
3805
3861
|
export interface BaseEventMetadata {
|
|
3806
3862
|
/**
|
|
3807
3863
|
* App instance ID.
|
|
@@ -4517,22 +4573,22 @@ export interface DraftOrdersQueryBuilder {
|
|
|
4517
4573
|
* @param value - Value to compare against.
|
|
4518
4574
|
* @documentationMaturity preview
|
|
4519
4575
|
*/
|
|
4520
|
-
ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4576
|
+
ge: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4521
4577
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
4522
4578
|
* @param value - Value to compare against.
|
|
4523
4579
|
* @documentationMaturity preview
|
|
4524
4580
|
*/
|
|
4525
|
-
gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4581
|
+
gt: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4526
4582
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
4527
4583
|
* @param value - Value to compare against.
|
|
4528
4584
|
* @documentationMaturity preview
|
|
4529
4585
|
*/
|
|
4530
|
-
le: (propertyName: '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4586
|
+
le: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4531
4587
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
4532
4588
|
* @param value - Value to compare against.
|
|
4533
4589
|
* @documentationMaturity preview
|
|
4534
4590
|
*/
|
|
4535
|
-
lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4591
|
+
lt: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
|
|
4536
4592
|
/** @param propertyName - Property whose value is compared with `string`.
|
|
4537
4593
|
* @param string - String to compare against. Case-insensitive.
|
|
4538
4594
|
* @documentationMaturity preview
|