@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.
@@ -74,9 +74,9 @@ export interface DraftOrder {
74
74
  * Draft order status.
75
75
  * @readonly
76
76
  */
77
- status?: EditingStatus;
77
+ status?: EditingStatusWithLiterals;
78
78
  /** Weight measurement unit. Defaults to the site's weight unit. */
79
- weightUnit?: 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?: PaymentOptionType;
278
+ paymentOption?: PaymentOptionTypeWithLiterals;
279
279
  /**
280
280
  * Deprecated. Use `taxInfo` instead.
281
281
  * This field will be removed on September 30, 2024.
@@ -384,6 +384,11 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
384
384
  colorInfo?: Color;
385
385
  /** Description line name. */
386
386
  name?: DescriptionLineName;
387
+ /**
388
+ * Whether the description line originates from a modifier.
389
+ * @internal
390
+ */
391
+ modifierDescriptionLine?: boolean;
387
392
  }
388
393
  /** @oneof */
389
394
  export interface DescriptionLineValueOneOf {
@@ -447,6 +452,8 @@ export declare enum DescriptionLineType {
447
452
  /** Color type. */
448
453
  COLOR = "COLOR"
449
454
  }
455
+ /** @enumType */
456
+ export type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
450
457
  export interface FocalPoint {
451
458
  /** X-coordinate of the focal point. */
452
459
  x?: number;
@@ -470,14 +477,14 @@ export interface PhysicalProperties {
470
477
  }
471
478
  export interface ItemType extends ItemTypeItemTypeDataOneOf {
472
479
  /** Preset item type. */
473
- preset?: ItemTypeItemType;
480
+ preset?: ItemTypeItemTypeWithLiterals;
474
481
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
475
482
  custom?: string;
476
483
  }
477
484
  /** @oneof */
478
485
  export interface ItemTypeItemTypeDataOneOf {
479
486
  /** Preset item type. */
480
- preset?: ItemTypeItemType;
487
+ preset?: ItemTypeItemTypeWithLiterals;
481
488
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
482
489
  custom?: string;
483
490
  }
@@ -488,6 +495,8 @@ export declare enum ItemTypeItemType {
488
495
  GIFT_CARD = "GIFT_CARD",
489
496
  SERVICE = "SERVICE"
490
497
  }
498
+ /** @enumType */
499
+ export type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
491
500
  /** Type of selected payment option for catalog item */
492
501
  export declare enum PaymentOptionType {
493
502
  /** The entire payment for this item happens as part of the checkout. */
@@ -501,6 +510,8 @@ export declare enum PaymentOptionType {
501
510
  /** 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`. */
502
511
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
503
512
  }
513
+ /** @enumType */
514
+ export type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
504
515
  export interface ItemTaxFullDetails {
505
516
  /** Taxable amount of this line item. */
506
517
  taxableAmount?: Price;
@@ -566,7 +577,7 @@ export interface LineItemTaxBreakdown {
566
577
  */
567
578
  taxName?: string | null;
568
579
  /** Type of jurisdiction that taxes were calculated for. */
569
- jurisdictionType?: JurisdictionType;
580
+ jurisdictionType?: JurisdictionTypeWithLiterals;
570
581
  /** Non-taxable amount of the line item price. */
571
582
  nonTaxableAmount?: Price;
572
583
  /** Taxable amount of the line item price. */
@@ -581,6 +592,8 @@ export declare enum JurisdictionType {
581
592
  CITY = "CITY",
582
593
  SPECIAL = "SPECIAL"
583
594
  }
595
+ /** @enumType */
596
+ export type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
584
597
  export interface DigitalFile {
585
598
  /**
586
599
  * ID of the secure file in media.
@@ -684,7 +697,7 @@ export interface SubscriptionDescription {
684
697
  }
685
698
  export interface SubscriptionSettings {
686
699
  /** Frequency of recurring payment. */
687
- frequency?: SubscriptionFrequency;
700
+ frequency?: SubscriptionFrequencyWithLiterals;
688
701
  /**
689
702
  * Interval of recurring payment.
690
703
  * @min 1
@@ -716,9 +729,11 @@ export declare enum SubscriptionFrequency {
716
729
  MONTH = "MONTH",
717
730
  YEAR = "YEAR"
718
731
  }
732
+ /** @enumType */
733
+ export type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
719
734
  export interface FreeTrialPeriod {
720
735
  /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
721
- frequency?: SubscriptionFrequency;
736
+ frequency?: SubscriptionFrequencyWithLiterals;
722
737
  /**
723
738
  * interval of period
724
739
  * @min 1
@@ -728,7 +743,7 @@ export interface FreeTrialPeriod {
728
743
  }
729
744
  export interface BillingAdjustment {
730
745
  /** The type of adjustment. */
731
- type?: AdjustmentType;
746
+ type?: AdjustmentTypeWithLiterals;
732
747
  /** Summary of the prorated adjustment amount. */
733
748
  priceSummary?: BillingAdjustmentPriceSummary;
734
749
  }
@@ -739,6 +754,8 @@ export declare enum AdjustmentType {
739
754
  /** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
740
755
  CREDIT = "CREDIT"
741
756
  }
757
+ /** @enumType */
758
+ export type AdjustmentTypeWithLiterals = AdjustmentType | 'UNKNOWN_ADJUSTMENT_TYPE' | 'EXTRA_CHARGE' | 'CREDIT';
742
759
  export interface BillingAdjustmentPriceSummary {
743
760
  /** Subtotal of adjustment, before tax. */
744
761
  subtotal?: Price;
@@ -775,12 +792,12 @@ export interface LocationAndQuantity {
775
792
  }
776
793
  export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
777
794
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
778
- addressType?: TaxableAddressType;
795
+ addressType?: TaxableAddressTypeWithLiterals;
779
796
  }
780
797
  /** @oneof */
781
798
  export interface TaxableAddressTaxableAddressDataOneOf {
782
799
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
783
- addressType?: TaxableAddressType;
800
+ addressType?: TaxableAddressTypeWithLiterals;
784
801
  }
785
802
  export declare enum TaxableAddressType {
786
803
  UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
@@ -788,6 +805,8 @@ export declare enum TaxableAddressType {
788
805
  BILLING = "BILLING",
789
806
  SHIPPING = "SHIPPING"
790
807
  }
808
+ /** @enumType */
809
+ export type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
791
810
  export interface ExtendedFields {
792
811
  /**
793
812
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
@@ -1042,7 +1061,7 @@ export interface VatId {
1042
1061
  * + `CPF`: for individual tax payers
1043
1062
  * + `CNPJ`: for corporations
1044
1063
  */
1045
- type?: VatType;
1064
+ type?: VatTypeWithLiterals;
1046
1065
  }
1047
1066
  /** tax info types */
1048
1067
  export declare enum VatType {
@@ -1052,11 +1071,13 @@ export declare enum VatType {
1052
1071
  /** CNPJ - for corporations */
1053
1072
  CNPJ = "CNPJ"
1054
1073
  }
1074
+ /** @enumType */
1075
+ export type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
1055
1076
  export interface V1PickupDetails {
1056
1077
  /** Pickup address. */
1057
1078
  address?: PickupAddress;
1058
1079
  /** Pickup method */
1059
- pickupMethod?: PickupDetailsPickupMethod;
1080
+ pickupMethod?: PickupDetailsPickupMethodWithLiterals;
1060
1081
  }
1061
1082
  /** Physical address */
1062
1083
  export interface PickupAddress {
@@ -1108,6 +1129,8 @@ export declare enum PickupDetailsPickupMethod {
1108
1129
  STORE_PICKUP = "STORE_PICKUP",
1109
1130
  PICKUP_POINT = "PICKUP_POINT"
1110
1131
  }
1132
+ /** @enumType */
1133
+ export type PickupDetailsPickupMethodWithLiterals = PickupDetailsPickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
1111
1134
  export interface V1DeliveryTimeSlot {
1112
1135
  /** Delivery slot starting time. */
1113
1136
  from?: Date | null;
@@ -1195,7 +1218,7 @@ export interface AdditionalFeeDetails {
1195
1218
  * + `AUTOMATIC`: User added a catalog item which is configured to have an additional fee.
1196
1219
  * + `CUSTOM`: This additional fee was created by the Create Custom Additional Fees method.
1197
1220
  */
1198
- source?: SourceType;
1221
+ source?: SourceTypeWithLiterals;
1199
1222
  /** Whether this additional fee is applied to the order. */
1200
1223
  applied?: boolean;
1201
1224
  }
@@ -1263,6 +1286,8 @@ export declare enum SourceType {
1263
1286
  /** Added manually to draft order. */
1264
1287
  CUSTOM = "CUSTOM"
1265
1288
  }
1289
+ /** @enumType */
1290
+ export type SourceTypeWithLiterals = SourceType | 'ORIGINAL_ORDER' | 'AUTOMATIC' | 'CUSTOM';
1266
1291
  export interface DiscountDetails {
1267
1292
  /** Discount details. */
1268
1293
  discount?: AppliedDiscount;
@@ -1273,7 +1298,7 @@ export interface DiscountDetails {
1273
1298
  * + `ORIGINAL_ORDER`: This discount is part of the original order.
1274
1299
  * + `CUSTOM`: This discount was created by the Create Custom Discounts method.
1275
1300
  */
1276
- source?: SourceType;
1301
+ source?: SourceTypeWithLiterals;
1277
1302
  /** Whether this discount is applied to the order. */
1278
1303
  applied?: boolean;
1279
1304
  }
@@ -1290,7 +1315,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1290
1315
  * * `"SPECIFIC-ITEMS"` - discount applies to specific items.
1291
1316
  * * `"SHIPPING"` - discount applies to shipping. For example, free shipping.
1292
1317
  */
1293
- discountType?: AppliedDiscountDiscountType;
1318
+ discountType?: AppliedDiscountDiscountTypeWithLiterals;
1294
1319
  /**
1295
1320
  * IDs of line items discount applies to.
1296
1321
  * Deprecated. Use `line_item_discounts` instead.
@@ -1331,6 +1356,8 @@ export declare enum AppliedDiscountDiscountType {
1331
1356
  SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
1332
1357
  SHIPPING = "SHIPPING"
1333
1358
  }
1359
+ /** @enumType */
1360
+ export type AppliedDiscountDiscountTypeWithLiterals = AppliedDiscountDiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
1334
1361
  /** Coupon */
1335
1362
  export interface Coupon {
1336
1363
  /** Coupon ID. */
@@ -1347,7 +1374,7 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
1347
1374
  * Pre-defined discount reason (optional).
1348
1375
  * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
1349
1376
  */
1350
- discountReason?: DiscountReason;
1377
+ discountReason?: DiscountReasonWithLiterals;
1351
1378
  /**
1352
1379
  * Discount description as free text (optional).
1353
1380
  * @maxLength 200
@@ -1369,7 +1396,7 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
1369
1396
  * Pre-defined discount reason (optional).
1370
1397
  * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
1371
1398
  */
1372
- discountReason?: DiscountReason;
1399
+ discountReason?: DiscountReasonWithLiterals;
1373
1400
  /**
1374
1401
  * Discount description as free text (optional).
1375
1402
  * @maxLength 200
@@ -1381,6 +1408,8 @@ export declare enum DiscountReason {
1381
1408
  EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
1382
1409
  BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
1383
1410
  }
1411
+ /** @enumType */
1412
+ export type DiscountReasonWithLiterals = DiscountReason | 'UNSPECIFIED' | 'EXCHANGED_ITEMS' | 'BILLING_ADJUSTMENT';
1384
1413
  export interface DiscountRule {
1385
1414
  /**
1386
1415
  * Discount rule ID
@@ -1450,6 +1479,8 @@ export declare enum EditingStatus {
1450
1479
  */
1451
1480
  COMMITTED = "COMMITTED"
1452
1481
  }
1482
+ /** @enumType */
1483
+ export type EditingStatusWithLiterals = EditingStatus | 'DRAFT' | 'COMMITTED';
1453
1484
  export declare enum WeightUnit {
1454
1485
  /** Weight unit can't be classified due to an error. */
1455
1486
  UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
@@ -1458,6 +1489,8 @@ export declare enum WeightUnit {
1458
1489
  /** Pounds. */
1459
1490
  LB = "LB"
1460
1491
  }
1492
+ /** @enumType */
1493
+ export type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
1461
1494
  export interface PriceSummary {
1462
1495
  /** Subtotal of all the line items, before discounts and before tax. */
1463
1496
  subtotal?: Price;
@@ -1625,7 +1658,7 @@ export interface OrderTaxBreakdown {
1625
1658
  */
1626
1659
  jurisdiction?: string;
1627
1660
  /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
1628
- jurisdictionType?: JurisdictionType;
1661
+ jurisdictionType?: JurisdictionTypeWithLiterals;
1629
1662
  /**
1630
1663
  * The rate at which this tax detail was calculated.
1631
1664
  * @format DECIMAL_VALUE
@@ -1778,7 +1811,7 @@ export interface PickupDetails {
1778
1811
  /** Pickup address. */
1779
1812
  address?: Address;
1780
1813
  /** Pickup method. */
1781
- pickupMethod?: PickupMethod;
1814
+ pickupMethod?: PickupMethodWithLiterals;
1782
1815
  }
1783
1816
  export declare enum PickupMethod {
1784
1817
  UNKNOWN_METHOD = "UNKNOWN_METHOD",
@@ -1787,6 +1820,8 @@ export declare enum PickupMethod {
1787
1820
  /** Pickup point. */
1788
1821
  PICKUP_POINT = "PICKUP_POINT"
1789
1822
  }
1823
+ /** @enumType */
1824
+ export type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
1790
1825
  export interface DeliveryTimeSlot {
1791
1826
  /** Delivery time slot start time. */
1792
1827
  from?: Date | null;
@@ -1901,10 +1936,12 @@ export declare enum RuleType {
1901
1936
  EXACT_SIZE = "EXACT_SIZE",
1902
1937
  REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
1903
1938
  }
1939
+ /** @enumType */
1940
+ 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';
1904
1941
  export interface FieldViolation {
1905
1942
  field?: string;
1906
1943
  description?: string;
1907
- violatedRule?: RuleType;
1944
+ violatedRule?: RuleTypeWithLiterals;
1908
1945
  /** applicable when violated_rule=OTHER */
1909
1946
  ruleName?: string | null;
1910
1947
  data?: Record<string, any> | null;
@@ -2052,7 +2089,7 @@ export interface SecuredMedia {
2052
2089
  */
2053
2090
  fileName?: string;
2054
2091
  /** File type. */
2055
- fileType?: FileType;
2092
+ fileType?: FileTypeWithLiterals;
2056
2093
  }
2057
2094
  export declare enum FileType {
2058
2095
  UNSPECIFIED = "UNSPECIFIED",
@@ -2062,6 +2099,8 @@ export declare enum FileType {
2062
2099
  SECURE_MUSIC = "SECURE_MUSIC",
2063
2100
  SECURE_ARCHIVE = "SECURE_ARCHIVE"
2064
2101
  }
2102
+ /** @enumType */
2103
+ export type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
2065
2104
  export interface AddLineItemsToDraftOrderResponse {
2066
2105
  /** Draft order calculated with the latest changes. */
2067
2106
  calculatedDraftOrder?: CalculatedDraftOrder;
@@ -2163,7 +2202,7 @@ export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
2163
2202
  */
2164
2203
  percentage?: string | null;
2165
2204
  /** Discount type. */
2166
- discountType?: DiscountType;
2205
+ discountType?: DiscountTypeWithLiterals;
2167
2206
  /**
2168
2207
  * ID of line item discount applies to.
2169
2208
  * @format GUID
@@ -2216,6 +2255,8 @@ export declare enum DiscountType {
2216
2255
  /** Discount applies to shipping fee. */
2217
2256
  SHIPPING = "SHIPPING"
2218
2257
  }
2258
+ /** @enumType */
2259
+ export type DiscountTypeWithLiterals = DiscountType | 'UNKNOWN_TYPE' | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
2219
2260
  export interface CreateCustomDiscountsResponse {
2220
2261
  /** Draft order calculated with the latest changes. */
2221
2262
  calculatedDraftOrder?: CalculatedDraftOrder;
@@ -2439,7 +2480,7 @@ export interface GetOrderDraftabilityStatusResponse {
2439
2480
  * Reasons why a draft order cannot be created from the order.
2440
2481
  * @maxSize 5
2441
2482
  */
2442
- nonDraftableReasons?: NonDraftableReason[];
2483
+ nonDraftableReasons?: NonDraftableReasonWithLiterals[];
2443
2484
  }
2444
2485
  export declare enum NonDraftableReason {
2445
2486
  UNSPECIFIED = "UNSPECIFIED",
@@ -2464,6 +2505,8 @@ export declare enum NonDraftableReason {
2464
2505
  /** Modifications of orders with subscription items are not supported. */
2465
2506
  SUBSCRIPTION_LINE_ITEM_EXISTS = "SUBSCRIPTION_LINE_ITEM_EXISTS"
2466
2507
  }
2508
+ /** @enumType */
2509
+ 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';
2467
2510
  export interface CommitDraftOrderRequest {
2468
2511
  /**
2469
2512
  * Draft order ID.
@@ -2517,19 +2560,19 @@ export interface Order {
2517
2560
  /** Buyer information. */
2518
2561
  buyerInfo?: BuyerInfo;
2519
2562
  /** Order payment status. */
2520
- paymentStatus?: PaymentStatus;
2563
+ paymentStatus?: PaymentStatusWithLiterals;
2521
2564
  /**
2522
2565
  * Order fulfillment status.
2523
2566
  * @readonly
2524
2567
  */
2525
- fulfillmentStatus?: FulfillmentStatus;
2568
+ fulfillmentStatus?: FulfillmentStatusWithLiterals;
2526
2569
  /**
2527
2570
  * Language for communication with the buyer. Defaults to the site language.
2528
2571
  * For a site that supports multiple languages, this is the language the buyer selected.
2529
2572
  */
2530
2573
  buyerLanguage?: string | null;
2531
2574
  /** Weight measurement unit - defaults to site's weight unit. */
2532
- weightUnit?: WeightUnit;
2575
+ weightUnit?: WeightUnitWithLiterals;
2533
2576
  /**
2534
2577
  * 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.
2535
2578
  * @format CURRENCY
@@ -2563,7 +2606,7 @@ export interface Order {
2563
2606
  */
2564
2607
  buyerNote?: string | null;
2565
2608
  /** Order status. */
2566
- status?: OrderStatus;
2609
+ status?: OrderStatusWithLiterals;
2567
2610
  /** Whether order is archived. */
2568
2611
  archived?: boolean | null;
2569
2612
  /**
@@ -2591,7 +2634,7 @@ export interface Order {
2591
2634
  */
2592
2635
  activities?: Activity[];
2593
2636
  /** Order attribution source. */
2594
- attributionSource?: AttributionSource;
2637
+ attributionSource?: AttributionSourceWithLiterals;
2595
2638
  /**
2596
2639
  * ID of the order's initiator.
2597
2640
  * @readonly
@@ -2698,6 +2741,8 @@ export declare enum PaymentStatus {
2698
2741
  */
2699
2742
  DECLINED = "DECLINED"
2700
2743
  }
2744
+ /** @enumType */
2745
+ export type PaymentStatusWithLiterals = PaymentStatus | 'UNSPECIFIED' | 'NOT_PAID' | 'PAID' | 'PARTIALLY_REFUNDED' | 'FULLY_REFUNDED' | 'PENDING' | 'PARTIALLY_PAID' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED';
2701
2746
  export declare enum FulfillmentStatus {
2702
2747
  /** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
2703
2748
  NOT_FULFILLED = "NOT_FULFILLED",
@@ -2709,6 +2754,8 @@ export declare enum FulfillmentStatus {
2709
2754
  /** Some, but not all, of the order items are fulfilled. */
2710
2755
  PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
2711
2756
  }
2757
+ /** @enumType */
2758
+ export type FulfillmentStatusWithLiterals = FulfillmentStatus | 'NOT_FULFILLED' | 'FULFILLED' | 'PARTIALLY_FULFILLED';
2712
2759
  export interface CurrencyConversionDetails {
2713
2760
  /**
2714
2761
  * 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.
@@ -2752,6 +2799,8 @@ export declare enum OrderStatus {
2752
2799
  */
2753
2800
  REJECTED = "REJECTED"
2754
2801
  }
2802
+ /** @enumType */
2803
+ export type OrderStatusWithLiterals = OrderStatus | 'INITIALIZED' | 'APPROVED' | 'CANCELED' | 'PENDING' | 'REJECTED';
2755
2804
  export interface Activity extends ActivityContentOneOf {
2756
2805
  /** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
2757
2806
  customActivity?: CustomActivity;
@@ -2831,7 +2880,7 @@ export interface Activity extends ActivityContentOneOf {
2831
2880
  */
2832
2881
  _createdDate?: Date | null;
2833
2882
  /** Activity type. */
2834
- type?: ActivityType;
2883
+ type?: ActivityTypeWithLiterals;
2835
2884
  }
2836
2885
  /** @oneof */
2837
2886
  export interface ActivityContentOneOf {
@@ -3028,7 +3077,7 @@ export interface LineItemQuantityChange {
3028
3077
  */
3029
3078
  diff?: number;
3030
3079
  /** Type of quantity change: increase or decrease. */
3031
- deltaType?: LineItemQuantityChangeType;
3080
+ deltaType?: LineItemQuantityChangeTypeWithLiterals;
3032
3081
  }
3033
3082
  export declare enum LineItemQuantityChangeType {
3034
3083
  /** Quantity increased. */
@@ -3036,6 +3085,8 @@ export declare enum LineItemQuantityChangeType {
3036
3085
  /** Quantity decreased. */
3037
3086
  QUANTITY_DECREASED = "QUANTITY_DECREASED"
3038
3087
  }
3088
+ /** @enumType */
3089
+ export type LineItemQuantityChangeTypeWithLiterals = LineItemQuantityChangeType | 'QUANTITY_INCREASED' | 'QUANTITY_DECREASED';
3039
3090
  export interface LineItemPriceChange {
3040
3091
  /** Item price before update. */
3041
3092
  originalPrice?: Price;
@@ -3466,10 +3517,14 @@ export declare enum ActivityType {
3466
3517
  /** @documentationMaturity preview */
3467
3518
  ORDER_REJECTED = "ORDER_REJECTED"
3468
3519
  }
3520
+ /** @enumType */
3521
+ 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';
3469
3522
  export declare enum AttributionSource {
3470
3523
  UNSPECIFIED = "UNSPECIFIED",
3471
3524
  FACEBOOK_ADS = "FACEBOOK_ADS"
3472
3525
  }
3526
+ /** @enumType */
3527
+ export type AttributionSourceWithLiterals = AttributionSource | 'UNSPECIFIED' | 'FACEBOOK_ADS';
3473
3528
  export interface V1CreatedBy extends V1CreatedByStringOneOf {
3474
3529
  /**
3475
3530
  * User ID - when the order was created by a Wix user on behalf of a buyer.
@@ -3519,7 +3574,7 @@ export interface V1CreatedByStringOneOf {
3519
3574
  }
3520
3575
  export interface ChannelInfo {
3521
3576
  /** Sales channel that submitted the order. */
3522
- type?: ChannelType;
3577
+ type?: ChannelTypeWithLiterals;
3523
3578
  /**
3524
3579
  * Reference to an order ID from an external system.
3525
3580
  * @maxLength 100
@@ -3565,6 +3620,8 @@ export declare enum ChannelType {
3565
3620
  /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
3566
3621
  FAIRE_COM = "FAIRE_COM"
3567
3622
  }
3623
+ /** @enumType */
3624
+ 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';
3568
3625
  export interface CustomField {
3569
3626
  /** Custom field value. */
3570
3627
  value?: any;
@@ -3746,12 +3803,14 @@ export interface Sorting {
3746
3803
  */
3747
3804
  fieldName?: string;
3748
3805
  /** Sort order. */
3749
- order?: SortOrder;
3806
+ order?: SortOrderWithLiterals;
3750
3807
  }
3751
3808
  export declare enum SortOrder {
3752
3809
  ASC = "ASC",
3753
3810
  DESC = "DESC"
3754
3811
  }
3812
+ /** @enumType */
3813
+ export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
3755
3814
  export interface CursorPaging {
3756
3815
  /**
3757
3816
  * Maximum number of items to return in the results.
@@ -3940,7 +3999,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
3940
3999
  */
3941
4000
  appId?: string;
3942
4001
  /** @readonly */
3943
- identityType?: WebhookIdentityType;
4002
+ identityType?: WebhookIdentityTypeWithLiterals;
3944
4003
  }
3945
4004
  /** @oneof */
3946
4005
  export interface IdentificationDataIdOneOf {
@@ -3972,6 +4031,8 @@ export declare enum WebhookIdentityType {
3972
4031
  WIX_USER = "WIX_USER",
3973
4032
  APP = "APP"
3974
4033
  }
4034
+ /** @enumType */
4035
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
3975
4036
  export interface BaseEventMetadata {
3976
4037
  /**
3977
4038
  * App instance ID.
@@ -4687,22 +4748,22 @@ export interface DraftOrdersQueryBuilder {
4687
4748
  * @param value - Value to compare against.
4688
4749
  * @documentationMaturity preview
4689
4750
  */
4690
- ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
4751
+ ge: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
4691
4752
  /** @param propertyName - Property whose value is compared with `value`.
4692
4753
  * @param value - Value to compare against.
4693
4754
  * @documentationMaturity preview
4694
4755
  */
4695
- gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
4756
+ gt: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
4696
4757
  /** @param propertyName - Property whose value is compared with `value`.
4697
4758
  * @param value - Value to compare against.
4698
4759
  * @documentationMaturity preview
4699
4760
  */
4700
- le: (propertyName: '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
4761
+ le: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
4701
4762
  /** @param propertyName - Property whose value is compared with `value`.
4702
4763
  * @param value - Value to compare against.
4703
4764
  * @documentationMaturity preview
4704
4765
  */
4705
- lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
4766
+ lt: (propertyName: 'orderId' | '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
4706
4767
  /** @param propertyName - Property whose value is compared with `string`.
4707
4768
  * @param string - String to compare against. Case-insensitive.
4708
4769
  * @documentationMaturity preview