@wix/auto_sdk_ecom_orders 1.0.48 → 1.0.49

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.
Files changed (45) hide show
  1. package/build/cjs/index.typings.d.ts +42 -0
  2. package/build/cjs/index.typings.js.map +1 -1
  3. package/build/cjs/src/ecom-v1-order-orders.context.d.ts +1 -1
  4. package/build/cjs/src/ecom-v1-order-orders.public.d.ts +4 -3
  5. package/build/cjs/src/ecom-v1-order-orders.public.js +1 -1
  6. package/build/cjs/src/ecom-v1-order-orders.public.js.map +1 -1
  7. package/build/cjs/src/ecom-v1-order-orders.types.d.ts +163 -61
  8. package/build/cjs/src/ecom-v1-order-orders.types.js.map +1 -1
  9. package/build/cjs/src/ecom-v1-order-orders.universal.d.ts +335 -73
  10. package/build/cjs/src/ecom-v1-order-orders.universal.js +6 -6
  11. package/build/cjs/src/ecom-v1-order-orders.universal.js.map +1 -1
  12. package/build/es/index.typings.d.ts +42 -0
  13. package/build/es/index.typings.js.map +1 -1
  14. package/build/es/src/ecom-v1-order-orders.context.d.ts +1 -1
  15. package/build/es/src/ecom-v1-order-orders.public.d.ts +4 -3
  16. package/build/es/src/ecom-v1-order-orders.public.js +1 -1
  17. package/build/es/src/ecom-v1-order-orders.public.js.map +1 -1
  18. package/build/es/src/ecom-v1-order-orders.types.d.ts +163 -61
  19. package/build/es/src/ecom-v1-order-orders.types.js.map +1 -1
  20. package/build/es/src/ecom-v1-order-orders.universal.d.ts +335 -73
  21. package/build/es/src/ecom-v1-order-orders.universal.js +6 -6
  22. package/build/es/src/ecom-v1-order-orders.universal.js.map +1 -1
  23. package/build/internal/cjs/index.typings.d.ts +42 -0
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/src/ecom-v1-order-orders.context.d.ts +1 -1
  26. package/build/internal/cjs/src/ecom-v1-order-orders.public.d.ts +5 -4
  27. package/build/internal/cjs/src/ecom-v1-order-orders.public.js +1 -1
  28. package/build/internal/cjs/src/ecom-v1-order-orders.public.js.map +1 -1
  29. package/build/internal/cjs/src/ecom-v1-order-orders.types.d.ts +163 -61
  30. package/build/internal/cjs/src/ecom-v1-order-orders.types.js.map +1 -1
  31. package/build/internal/cjs/src/ecom-v1-order-orders.universal.d.ts +336 -74
  32. package/build/internal/cjs/src/ecom-v1-order-orders.universal.js +6 -6
  33. package/build/internal/cjs/src/ecom-v1-order-orders.universal.js.map +1 -1
  34. package/build/internal/es/index.typings.d.ts +42 -0
  35. package/build/internal/es/index.typings.js.map +1 -1
  36. package/build/internal/es/src/ecom-v1-order-orders.context.d.ts +1 -1
  37. package/build/internal/es/src/ecom-v1-order-orders.public.d.ts +5 -4
  38. package/build/internal/es/src/ecom-v1-order-orders.public.js +1 -1
  39. package/build/internal/es/src/ecom-v1-order-orders.public.js.map +1 -1
  40. package/build/internal/es/src/ecom-v1-order-orders.types.d.ts +163 -61
  41. package/build/internal/es/src/ecom-v1-order-orders.types.js.map +1 -1
  42. package/build/internal/es/src/ecom-v1-order-orders.universal.d.ts +336 -74
  43. package/build/internal/es/src/ecom-v1-order-orders.universal.js +6 -6
  44. package/build/internal/es/src/ecom-v1-order-orders.universal.js.map +1 -1
  45. package/package.json +2 -2
@@ -31,19 +31,19 @@ export interface Order {
31
31
  /** Buyer information. */
32
32
  buyerInfo?: BuyerInfo;
33
33
  /** Order payment status. */
34
- paymentStatus?: PaymentStatus;
34
+ paymentStatus?: PaymentStatusWithLiterals;
35
35
  /**
36
36
  * Order fulfillment status.
37
37
  * @readonly
38
38
  */
39
- fulfillmentStatus?: FulfillmentStatus;
39
+ fulfillmentStatus?: FulfillmentStatusWithLiterals;
40
40
  /**
41
41
  * Language for communication with the buyer. Defaults to the site language.
42
42
  * For a site that supports multiple languages, this is the language the buyer selected.
43
43
  */
44
44
  buyerLanguage?: string | null;
45
45
  /** Weight measurement unit - defaults to site's weight unit. */
46
- weightUnit?: WeightUnit;
46
+ weightUnit?: WeightUnitWithLiterals;
47
47
  /**
48
48
  * 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.
49
49
  * @format CURRENCY
@@ -77,7 +77,7 @@ export interface Order {
77
77
  */
78
78
  buyerNote?: string | null;
79
79
  /** Order status. */
80
- status?: OrderStatus;
80
+ status?: OrderStatusWithLiterals;
81
81
  /** Whether order is archived. */
82
82
  archived?: boolean | null;
83
83
  /**
@@ -105,7 +105,7 @@ export interface Order {
105
105
  */
106
106
  activities?: Activity[];
107
107
  /** Order attribution source. */
108
- attributionSource?: AttributionSource;
108
+ attributionSource?: AttributionSourceWithLiterals;
109
109
  /**
110
110
  * ID of the order's initiator.
111
111
  * @readonly
@@ -249,7 +249,7 @@ export interface OrderLineItem {
249
249
  *
250
250
  * Default: `FULL_PAYMENT_ONLINE`
251
251
  */
252
- paymentOption?: PaymentOptionType;
252
+ paymentOption?: PaymentOptionTypeWithLiterals;
253
253
  /**
254
254
  * Deprecated. Use `taxInfo` instead.
255
255
  * This field will be removed on September 30, 2024.
@@ -420,6 +420,8 @@ export declare enum DescriptionLineType {
420
420
  /** Color type. */
421
421
  COLOR = "COLOR"
422
422
  }
423
+ /** @enumType */
424
+ export type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
423
425
  export interface Image {
424
426
  /** WixMedia image ID. */
425
427
  id?: string;
@@ -466,14 +468,14 @@ export interface PhysicalProperties {
466
468
  }
467
469
  export interface ItemType extends ItemTypeItemTypeDataOneOf {
468
470
  /** Preset item type. */
469
- preset?: ItemTypeItemType;
471
+ preset?: ItemTypeItemTypeWithLiterals;
470
472
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
471
473
  custom?: string;
472
474
  }
473
475
  /** @oneof */
474
476
  export interface ItemTypeItemTypeDataOneOf {
475
477
  /** Preset item type. */
476
- preset?: ItemTypeItemType;
478
+ preset?: ItemTypeItemTypeWithLiterals;
477
479
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
478
480
  custom?: string;
479
481
  }
@@ -484,6 +486,8 @@ export declare enum ItemTypeItemType {
484
486
  GIFT_CARD = "GIFT_CARD",
485
487
  SERVICE = "SERVICE"
486
488
  }
489
+ /** @enumType */
490
+ export type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
487
491
  /** Type of selected payment option for catalog item */
488
492
  export declare enum PaymentOptionType {
489
493
  /** The entire payment for this item happens as part of the checkout. */
@@ -497,6 +501,8 @@ export declare enum PaymentOptionType {
497
501
  /** 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`. */
498
502
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
499
503
  }
504
+ /** @enumType */
505
+ export type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
500
506
  export interface ItemTaxFullDetails {
501
507
  /** Taxable amount of this line item. */
502
508
  taxableAmount?: Price;
@@ -562,7 +568,7 @@ export interface LineItemTaxBreakdown {
562
568
  */
563
569
  taxName?: string | null;
564
570
  /** Type of jurisdiction that taxes were calculated for. */
565
- jurisdictionType?: JurisdictionType;
571
+ jurisdictionType?: JurisdictionTypeWithLiterals;
566
572
  /** Non-taxable amount of the line item price. */
567
573
  nonTaxableAmount?: Price;
568
574
  /** Taxable amount of the line item price. */
@@ -577,6 +583,8 @@ export declare enum JurisdictionType {
577
583
  CITY = "CITY",
578
584
  SPECIAL = "SPECIAL"
579
585
  }
586
+ /** @enumType */
587
+ export type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
580
588
  export interface DigitalFile {
581
589
  /**
582
590
  * ID of the secure file in media.
@@ -665,7 +673,7 @@ export interface SubscriptionDescription {
665
673
  }
666
674
  export interface SubscriptionSettings {
667
675
  /** Frequency of recurring payment. */
668
- frequency?: SubscriptionFrequency;
676
+ frequency?: SubscriptionFrequencyWithLiterals;
669
677
  /**
670
678
  * Interval of recurring payment.
671
679
  * @min 1
@@ -692,9 +700,11 @@ export declare enum SubscriptionFrequency {
692
700
  MONTH = "MONTH",
693
701
  YEAR = "YEAR"
694
702
  }
703
+ /** @enumType */
704
+ export type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
695
705
  export interface FreeTrialPeriod {
696
706
  /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
697
- frequency?: SubscriptionFrequency;
707
+ frequency?: SubscriptionFrequencyWithLiterals;
698
708
  /**
699
709
  * interval of period
700
710
  * @min 1
@@ -704,7 +714,7 @@ export interface FreeTrialPeriod {
704
714
  }
705
715
  export interface BillingAdjustment {
706
716
  /** The type of adjustment. */
707
- type?: AdjustmentType;
717
+ type?: AdjustmentTypeWithLiterals;
708
718
  /** Summary of the prorated adjustment amount. */
709
719
  priceSummary?: BillingAdjustmentPriceSummary;
710
720
  }
@@ -715,6 +725,8 @@ export declare enum AdjustmentType {
715
725
  /** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
716
726
  CREDIT = "CREDIT"
717
727
  }
728
+ /** @enumType */
729
+ export type AdjustmentTypeWithLiterals = AdjustmentType | 'UNKNOWN_ADJUSTMENT_TYPE' | 'EXTRA_CHARGE' | 'CREDIT';
718
730
  export interface BillingAdjustmentPriceSummary {
719
731
  /** Subtotal of adjustment, before tax. */
720
732
  subtotal?: Price;
@@ -767,12 +779,12 @@ export interface LocationAndQuantity {
767
779
  }
768
780
  export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
769
781
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
770
- addressType?: TaxableAddressType;
782
+ addressType?: TaxableAddressTypeWithLiterals;
771
783
  }
772
784
  /** @oneof */
773
785
  export interface TaxableAddressTaxableAddressDataOneOf {
774
786
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
775
- addressType?: TaxableAddressType;
787
+ addressType?: TaxableAddressTypeWithLiterals;
776
788
  }
777
789
  export declare enum TaxableAddressType {
778
790
  UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
@@ -780,6 +792,8 @@ export declare enum TaxableAddressType {
780
792
  BILLING = "BILLING",
781
793
  SHIPPING = "SHIPPING"
782
794
  }
795
+ /** @enumType */
796
+ export type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
783
797
  export interface ExtendedFields {
784
798
  /**
785
799
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
@@ -925,6 +939,8 @@ export declare enum PaymentStatus {
925
939
  */
926
940
  DECLINED = "DECLINED"
927
941
  }
942
+ /** @enumType */
943
+ export type PaymentStatusWithLiterals = PaymentStatus | 'UNSPECIFIED' | 'NOT_PAID' | 'PAID' | 'PARTIALLY_REFUNDED' | 'FULLY_REFUNDED' | 'PENDING' | 'PARTIALLY_PAID' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED';
928
944
  export declare enum FulfillmentStatus {
929
945
  /** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
930
946
  NOT_FULFILLED = "NOT_FULFILLED",
@@ -936,6 +952,8 @@ export declare enum FulfillmentStatus {
936
952
  /** Some, but not all, of the order items are fulfilled. */
937
953
  PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
938
954
  }
955
+ /** @enumType */
956
+ export type FulfillmentStatusWithLiterals = FulfillmentStatus | 'NOT_FULFILLED' | 'FULFILLED' | 'PARTIALLY_FULFILLED';
939
957
  export declare enum WeightUnit {
940
958
  /** Weight unit can't be classified due to an error. */
941
959
  UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
@@ -944,6 +962,8 @@ export declare enum WeightUnit {
944
962
  /** Pounds. */
945
963
  LB = "LB"
946
964
  }
965
+ /** @enumType */
966
+ export type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
947
967
  export interface CurrencyConversionDetails {
948
968
  /**
949
969
  * 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.
@@ -1075,7 +1095,7 @@ export interface VatId {
1075
1095
  * + `CPF`: for individual tax payers
1076
1096
  * + `CNPJ`: for corporations
1077
1097
  */
1078
- type?: VatType;
1098
+ type?: VatTypeWithLiterals;
1079
1099
  }
1080
1100
  /** tax info types */
1081
1101
  export declare enum VatType {
@@ -1085,6 +1105,8 @@ export declare enum VatType {
1085
1105
  /** CNPJ - for corporations */
1086
1106
  CNPJ = "CNPJ"
1087
1107
  }
1108
+ /** @enumType */
1109
+ export type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
1088
1110
  export interface V1ShippingInformation {
1089
1111
  /**
1090
1112
  * App Def Id of external provider which was a source of shipping info
@@ -1145,7 +1167,7 @@ export interface PickupDetails {
1145
1167
  /** Pickup address. */
1146
1168
  address?: PickupAddress;
1147
1169
  /** Pickup method */
1148
- pickupMethod?: PickupMethod;
1170
+ pickupMethod?: PickupMethodWithLiterals;
1149
1171
  }
1150
1172
  /** Physical address */
1151
1173
  export interface PickupAddress {
@@ -1197,6 +1219,8 @@ export declare enum PickupMethod {
1197
1219
  STORE_PICKUP = "STORE_PICKUP",
1198
1220
  PICKUP_POINT = "PICKUP_POINT"
1199
1221
  }
1222
+ /** @enumType */
1223
+ export type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
1200
1224
  export interface DeliveryTimeSlot {
1201
1225
  /** Delivery slot starting time. */
1202
1226
  from?: Date | null;
@@ -1256,6 +1280,8 @@ export declare enum OrderStatus {
1256
1280
  */
1257
1281
  REJECTED = "REJECTED"
1258
1282
  }
1283
+ /** @enumType */
1284
+ export type OrderStatusWithLiterals = OrderStatus | 'INITIALIZED' | 'APPROVED' | 'CANCELED' | 'PENDING' | 'REJECTED';
1259
1285
  export interface TaxSummary {
1260
1286
  /**
1261
1287
  * Total tax.
@@ -1300,7 +1326,7 @@ export interface OrderTaxBreakdown {
1300
1326
  */
1301
1327
  jurisdiction?: string;
1302
1328
  /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
1303
- jurisdictionType?: JurisdictionType;
1329
+ jurisdictionType?: JurisdictionTypeWithLiterals;
1304
1330
  /**
1305
1331
  * The rate at which this tax detail was calculated.
1306
1332
  * @format DECIMAL_VALUE
@@ -1323,7 +1349,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1323
1349
  * * `"SPECIFIC-ITEMS"` - discount applies to specific items.
1324
1350
  * * `"SHIPPING"` - discount applies to shipping. For example, free shipping.
1325
1351
  */
1326
- discountType?: DiscountType;
1352
+ discountType?: DiscountTypeWithLiterals;
1327
1353
  /**
1328
1354
  * IDs of line items discount applies to.
1329
1355
  * Deprecated. Use `line_item_discounts` instead.
@@ -1356,6 +1382,8 @@ export declare enum DiscountType {
1356
1382
  SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
1357
1383
  SHIPPING = "SHIPPING"
1358
1384
  }
1385
+ /** @enumType */
1386
+ export type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
1359
1387
  /** Coupon */
1360
1388
  export interface Coupon {
1361
1389
  /** Coupon ID. */
@@ -1372,7 +1400,7 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
1372
1400
  * Pre-defined discount reason (optional).
1373
1401
  * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
1374
1402
  */
1375
- discountReason?: DiscountReason;
1403
+ discountReason?: DiscountReasonWithLiterals;
1376
1404
  /**
1377
1405
  * Discount description as free text (optional).
1378
1406
  * @maxLength 200
@@ -1387,7 +1415,7 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
1387
1415
  * Pre-defined discount reason (optional).
1388
1416
  * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
1389
1417
  */
1390
- discountReason?: DiscountReason;
1418
+ discountReason?: DiscountReasonWithLiterals;
1391
1419
  /**
1392
1420
  * Discount description as free text (optional).
1393
1421
  * @maxLength 200
@@ -1399,6 +1427,8 @@ export declare enum DiscountReason {
1399
1427
  EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
1400
1428
  BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
1401
1429
  }
1430
+ /** @enumType */
1431
+ export type DiscountReasonWithLiterals = DiscountReason | 'UNSPECIFIED' | 'EXCHANGED_ITEMS' | 'BILLING_ADJUSTMENT';
1402
1432
  export interface DiscountRule {
1403
1433
  /**
1404
1434
  * Discount rule ID
@@ -1458,7 +1488,7 @@ export interface Activity extends ActivityContentOneOf {
1458
1488
  */
1459
1489
  createdDate?: Date | null;
1460
1490
  /** Activity type. */
1461
- type?: ActivityType;
1491
+ type?: ActivityTypeWithLiterals;
1462
1492
  }
1463
1493
  /** @oneof */
1464
1494
  export interface ActivityContentOneOf {
@@ -1601,7 +1631,7 @@ export interface LineItemQuantityChange {
1601
1631
  */
1602
1632
  diff?: number;
1603
1633
  /** Type of quantity change: increase or decrease. */
1604
- deltaType?: LineItemQuantityChangeType;
1634
+ deltaType?: LineItemQuantityChangeTypeWithLiterals;
1605
1635
  }
1606
1636
  export declare enum LineItemQuantityChangeType {
1607
1637
  /** Quantity increased. */
@@ -1609,6 +1639,8 @@ export declare enum LineItemQuantityChangeType {
1609
1639
  /** Quantity decreased. */
1610
1640
  QUANTITY_DECREASED = "QUANTITY_DECREASED"
1611
1641
  }
1642
+ /** @enumType */
1643
+ export type LineItemQuantityChangeTypeWithLiterals = LineItemQuantityChangeType | 'QUANTITY_INCREASED' | 'QUANTITY_DECREASED';
1612
1644
  export interface LineItemPriceChange {
1613
1645
  /** Item price before update. */
1614
1646
  originalPrice?: Price;
@@ -2039,10 +2071,14 @@ export declare enum ActivityType {
2039
2071
  /** @documentationMaturity preview */
2040
2072
  ORDER_REJECTED = "ORDER_REJECTED"
2041
2073
  }
2074
+ /** @enumType */
2075
+ 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';
2042
2076
  export declare enum AttributionSource {
2043
2077
  UNSPECIFIED = "UNSPECIFIED",
2044
2078
  FACEBOOK_ADS = "FACEBOOK_ADS"
2045
2079
  }
2080
+ /** @enumType */
2081
+ export type AttributionSourceWithLiterals = AttributionSource | 'UNSPECIFIED' | 'FACEBOOK_ADS';
2046
2082
  export interface CreatedBy extends CreatedByStringOneOf {
2047
2083
  /**
2048
2084
  * User ID - when the order was created by a Wix user on behalf of a buyer.
@@ -2092,7 +2128,7 @@ export interface CreatedByStringOneOf {
2092
2128
  }
2093
2129
  export interface ChannelInfo {
2094
2130
  /** Sales channel that submitted the order. */
2095
- type?: ChannelType;
2131
+ type?: ChannelTypeWithLiterals;
2096
2132
  /**
2097
2133
  * Reference to an order ID from an external system.
2098
2134
  * @maxLength 100
@@ -2138,6 +2174,8 @@ export declare enum ChannelType {
2138
2174
  /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
2139
2175
  FAIRE_COM = "FAIRE_COM"
2140
2176
  }
2177
+ /** @enumType */
2178
+ 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';
2141
2179
  export interface CustomField {
2142
2180
  /** Custom field value. */
2143
2181
  value?: any;
@@ -2386,7 +2424,7 @@ export interface RedirectUrls {
2386
2424
  }
2387
2425
  export interface DelayedCaptureSettings {
2388
2426
  /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
2389
- scheduledAction?: ScheduledAction;
2427
+ scheduledAction?: ScheduledActionWithLiterals;
2390
2428
  /** Delay duration before execution. Optional - if not set, providers default period will be used */
2391
2429
  delayDuration?: Duration;
2392
2430
  }
@@ -2397,6 +2435,8 @@ export declare enum ScheduledAction {
2397
2435
  /** Whether payment will be auto-captured when duration passes */
2398
2436
  CAPTURE = "CAPTURE"
2399
2437
  }
2438
+ /** @enumType */
2439
+ export type ScheduledActionWithLiterals = ScheduledAction | 'UNSPECIFIED' | 'VOID' | 'CAPTURE';
2400
2440
  export interface Duration {
2401
2441
  /**
2402
2442
  * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
@@ -2404,7 +2444,7 @@ export interface Duration {
2404
2444
  */
2405
2445
  count?: number;
2406
2446
  /** Duration unit: MINUTES, HOURS and DAYS */
2407
- unit?: DurationUnit;
2447
+ unit?: DurationUnitWithLiterals;
2408
2448
  }
2409
2449
  export declare enum DurationUnit {
2410
2450
  UNKNOWN_DURATION_UNIT = "UNKNOWN_DURATION_UNIT",
@@ -2412,6 +2452,8 @@ export declare enum DurationUnit {
2412
2452
  HOURS = "HOURS",
2413
2453
  DAYS = "DAYS"
2414
2454
  }
2455
+ /** @enumType */
2456
+ export type DurationUnitWithLiterals = DurationUnit | 'UNKNOWN_DURATION_UNIT' | 'MINUTES' | 'HOURS' | 'DAYS';
2415
2457
  export interface PreparePaymentCollectionResponse {
2416
2458
  /** Payment gateway order id which is associated with given payment */
2417
2459
  paymentGatewayOrderId?: string;
@@ -2426,7 +2468,7 @@ export interface GetPaymentCollectabilityStatusRequest {
2426
2468
  }
2427
2469
  export interface GetPaymentCollectabilityStatusResponse {
2428
2470
  /** Payment collectability status */
2429
- status?: PaymentCollectabilityStatus;
2471
+ status?: PaymentCollectabilityStatusWithLiterals;
2430
2472
  /** Collectable order amount */
2431
2473
  amount?: Price;
2432
2474
  }
@@ -2440,6 +2482,8 @@ export declare enum PaymentCollectabilityStatus {
2440
2482
  NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
2441
2483
  NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS"
2442
2484
  }
2485
+ /** @enumType */
2486
+ export type PaymentCollectabilityStatusWithLiterals = PaymentCollectabilityStatus | 'UNKNOWN' | 'COLLECTABLE' | 'NONCOLLECTABLE_ORDER_IS_CANCELLED' | 'NONCOLLECTABLE_ORDER_IS_PAID' | 'NONCOLLECTABLE_MISSING_PAYMENT_METHOD' | 'NONCOLLECTABLE_ORDER_IS_PENDING' | 'NONCOLLECTABLE_ORDER_IS_REJECTED' | 'NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS';
2443
2487
  export interface RecordManuallyCollectedPaymentRequest {
2444
2488
  /**
2445
2489
  * Order ID.
@@ -2469,7 +2513,7 @@ export interface PaymentStatusUpdated {
2469
2513
  /** The order that was updated */
2470
2514
  order?: Order;
2471
2515
  /** The previous status (before the update) */
2472
- previousPaymentStatus?: PaymentStatus;
2516
+ previousPaymentStatus?: PaymentStatusWithLiterals;
2473
2517
  }
2474
2518
  export interface BulkMarkOrdersAsPaidRequest {
2475
2519
  /**
@@ -2548,28 +2592,30 @@ export interface GetRefundabilityStatusResponse {
2548
2592
  }
2549
2593
  export interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
2550
2594
  /** Reason why payment is not refundable. */
2551
- nonRefundableReason?: NonRefundableReason;
2595
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
2552
2596
  /** Reason why payment is only refundable manually. */
2553
- manuallyRefundableReason?: ManuallyRefundableReason;
2597
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
2554
2598
  /** Payment ID. */
2555
2599
  paymentId?: string;
2556
2600
  /** Payment refundability status. */
2557
- refundabilityStatus?: RefundableStatus;
2601
+ refundabilityStatus?: RefundableStatusWithLiterals;
2558
2602
  /** Link to payment provider dashboard. */
2559
2603
  providerLink?: string | null;
2560
2604
  }
2561
2605
  /** @oneof */
2562
2606
  export interface RefundabilityAdditionalRefundabilityInfoOneOf {
2563
2607
  /** Reason why payment is not refundable. */
2564
- nonRefundableReason?: NonRefundableReason;
2608
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
2565
2609
  /** Reason why payment is only refundable manually. */
2566
- manuallyRefundableReason?: ManuallyRefundableReason;
2610
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
2567
2611
  }
2568
2612
  export declare enum RefundableStatus {
2569
2613
  NOT_REFUNDABLE = "NOT_REFUNDABLE",
2570
2614
  MANUAL = "MANUAL",
2571
2615
  REFUNDABLE = "REFUNDABLE"
2572
2616
  }
2617
+ /** @enumType */
2618
+ export type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
2573
2619
  export declare enum NonRefundableReason {
2574
2620
  NONE = "NONE",
2575
2621
  ALREADY_REFUNDED = "ALREADY_REFUNDED",
@@ -2585,12 +2631,16 @@ export declare enum NonRefundableReason {
2585
2631
  ORDER_IS_PENDING = "ORDER_IS_PENDING",
2586
2632
  ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
2587
2633
  }
2634
+ /** @enumType */
2635
+ export type NonRefundableReasonWithLiterals = NonRefundableReason | 'NONE' | 'ALREADY_REFUNDED' | 'PROVIDER_IS_DOWN' | 'INTERNAL_ERROR' | 'NOT_PAID' | 'ACCESS_DENIED' | 'ZERO_PRICE' | 'DISABLED_BY_PROVIDER' | 'PENDING_REFUND' | 'FORBIDDEN' | 'TRANSACTION_NOT_FOUND' | 'ORDER_IS_PENDING' | 'ORDER_IS_REJECTED';
2588
2636
  export declare enum ManuallyRefundableReason {
2589
2637
  EXPIRED = "EXPIRED",
2590
2638
  NOT_SUPPORTED = "NOT_SUPPORTED",
2591
2639
  OFFLINE = "OFFLINE",
2592
2640
  REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
2593
2641
  }
2642
+ /** @enumType */
2643
+ export type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
2594
2644
  export interface CreatePaymentGatewayOrderRequest {
2595
2645
  /**
2596
2646
  * Ecom order ID.
@@ -2822,7 +2872,7 @@ export interface RefundSideEffects {
2822
2872
  }
2823
2873
  export interface RestockInfo {
2824
2874
  /** Restock type. */
2825
- type?: RestockType;
2875
+ type?: RestockTypeWithLiterals;
2826
2876
  /**
2827
2877
  * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
2828
2878
  * @maxSize 300
@@ -2834,6 +2884,8 @@ export declare enum RestockType {
2834
2884
  ALL_ITEMS = "ALL_ITEMS",
2835
2885
  SOME_ITEMS = "SOME_ITEMS"
2836
2886
  }
2887
+ /** @enumType */
2888
+ export type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
2837
2889
  export interface RestockItem {
2838
2890
  /**
2839
2891
  * ID of the line item being restocked.
@@ -2937,7 +2989,7 @@ export interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMetho
2937
2989
  /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
2938
2990
  offlinePayment?: boolean;
2939
2991
  /** Payment status. */
2940
- status?: TransactionStatus;
2992
+ status?: TransactionStatusWithLiterals;
2941
2993
  /**
2942
2994
  * Whether there is a payment agreement that allows for future charges.
2943
2995
  * @immutable
@@ -2963,6 +3015,8 @@ export declare enum TransactionStatus {
2963
3015
  AUTHORIZED = "AUTHORIZED",
2964
3016
  VOIDED = "VOIDED"
2965
3017
  }
3018
+ /** @enumType */
3019
+ export type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
2966
3020
  export interface CreditCardPaymentMethodDetails {
2967
3021
  /**
2968
3022
  * The last 4 digits of the card number.
@@ -3002,7 +3056,7 @@ export interface AuthorizationCapture {
3002
3056
  */
3003
3057
  id?: string | null;
3004
3058
  /** Status of this capture action */
3005
- status?: AuthorizationCaptureStatus;
3059
+ status?: AuthorizationCaptureStatusWithLiterals;
3006
3060
  /**
3007
3061
  * Amount of this capture
3008
3062
  * @immutable
@@ -3022,19 +3076,21 @@ export declare enum AuthorizationCaptureStatus {
3022
3076
  /** Capture operation failed. */
3023
3077
  FAILED = "FAILED"
3024
3078
  }
3079
+ /** @enumType */
3080
+ export type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
3025
3081
  export interface AuthorizationActionFailureDetails {
3026
3082
  /** @maxLength 100 */
3027
3083
  failureCode?: string;
3028
3084
  }
3029
3085
  export interface AuthorizationVoid {
3030
3086
  /** Status of this void action */
3031
- status?: AuthorizationVoidStatus;
3087
+ status?: AuthorizationVoidStatusWithLiterals;
3032
3088
  /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
3033
3089
  voidedDate?: Date | null;
3034
3090
  /** In case of status is FAILED may contain failure details */
3035
3091
  failureDetails?: AuthorizationActionFailureDetails;
3036
3092
  /** Reason of void action */
3037
- reason?: Reason;
3093
+ reason?: ReasonWithLiterals;
3038
3094
  }
3039
3095
  export declare enum AuthorizationVoidStatus {
3040
3096
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
@@ -3045,6 +3101,8 @@ export declare enum AuthorizationVoidStatus {
3045
3101
  /** Void operation failed. */
3046
3102
  FAILED = "FAILED"
3047
3103
  }
3104
+ /** @enumType */
3105
+ export type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
3048
3106
  /** Reason the authorization was voided. */
3049
3107
  export declare enum Reason {
3050
3108
  UNKNOWN_REASON = "UNKNOWN_REASON",
@@ -3053,9 +3111,11 @@ export declare enum Reason {
3053
3111
  /** Authorization passed execution date. */
3054
3112
  SCHEDULED = "SCHEDULED"
3055
3113
  }
3114
+ /** @enumType */
3115
+ export type ReasonWithLiterals = Reason | 'UNKNOWN_REASON' | 'MANUAL' | 'SCHEDULED';
3056
3116
  export interface V1ScheduledAction {
3057
3117
  /** Type of the action. */
3058
- actionType?: ActionType;
3118
+ actionType?: ActionTypeWithLiterals;
3059
3119
  /** The date and time of the action. */
3060
3120
  executionDate?: Date | null;
3061
3121
  }
@@ -3064,6 +3124,8 @@ export declare enum ActionType {
3064
3124
  VOID = "VOID",
3065
3125
  CAPTURE = "CAPTURE"
3066
3126
  }
3127
+ /** @enumType */
3128
+ export type ActionTypeWithLiterals = ActionType | 'UNKNOWN_ACTION_TYPE' | 'VOID' | 'CAPTURE';
3067
3129
  export interface GiftCardPaymentDetails {
3068
3130
  /**
3069
3131
  * Gift card payment ID.
@@ -3096,7 +3158,7 @@ export interface MembershipPaymentDetails {
3096
3158
  */
3097
3159
  lineItemId?: string;
3098
3160
  /** Payment status. */
3099
- status?: MembershipPaymentStatus;
3161
+ status?: MembershipPaymentStatusWithLiterals;
3100
3162
  /** Membership name. */
3101
3163
  name?: MembershipName;
3102
3164
  /**
@@ -3122,6 +3184,8 @@ export declare enum MembershipPaymentStatus {
3122
3184
  /** The attempt to charge the payment failed, for example, due to lack of credits. */
3123
3185
  CHARGE_FAILED = "CHARGE_FAILED"
3124
3186
  }
3187
+ /** @enumType */
3188
+ export type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED';
3125
3189
  export interface WixReceiptInfo {
3126
3190
  /**
3127
3191
  * Receipt ID
@@ -3199,7 +3263,7 @@ export interface RefundTransaction {
3199
3263
  */
3200
3264
  amount?: Price;
3201
3265
  /** Refund status. */
3202
- refundStatus?: RefundStatus;
3266
+ refundStatus?: RefundStatusWithLiterals;
3203
3267
  /** Optional details of current refund status. */
3204
3268
  refundStatusInfo?: RefundStatusInfo;
3205
3269
  /**
@@ -3229,6 +3293,8 @@ export declare enum RefundStatus {
3229
3293
  /** Refund was initiated on payment provider side. */
3230
3294
  STARTED = "STARTED"
3231
3295
  }
3296
+ /** @enumType */
3297
+ export type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
3232
3298
  export interface RefundStatusInfo {
3233
3299
  /**
3234
3300
  * Reason code for the refund's current status.
@@ -3498,7 +3564,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
3498
3564
  */
3499
3565
  appId?: string;
3500
3566
  /** @readonly */
3501
- identityType?: WebhookIdentityType;
3567
+ identityType?: WebhookIdentityTypeWithLiterals;
3502
3568
  }
3503
3569
  /** @oneof */
3504
3570
  export interface IdentificationDataIdOneOf {
@@ -3530,6 +3596,8 @@ export declare enum WebhookIdentityType {
3530
3596
  WIX_USER = "WIX_USER",
3531
3597
  APP = "APP"
3532
3598
  }
3599
+ /** @enumType */
3600
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
3533
3601
  export declare enum TextDetection {
3534
3602
  /** No detection was made */
3535
3603
  UNKNOWN_TEXT_DETECTION = "UNKNOWN_TEXT_DETECTION",
@@ -3538,6 +3606,8 @@ export declare enum TextDetection {
3538
3606
  /** The image does not contain text */
3539
3607
  NO_TEXT = "NO_TEXT"
3540
3608
  }
3609
+ /** @enumType */
3610
+ export type TextDetectionWithLiterals = TextDetection | 'UNKNOWN_TEXT_DETECTION' | 'CONTAINS_TEXT' | 'NO_TEXT';
3541
3611
  export declare enum AnimationDetection {
3542
3612
  /** No detection was made */
3543
3613
  UNKNOWN_ANIMATION_DETECTION = "UNKNOWN_ANIMATION_DETECTION",
@@ -3546,11 +3616,13 @@ export declare enum AnimationDetection {
3546
3616
  /** The image does not contain animation */
3547
3617
  NO_ANIMATION = "NO_ANIMATION"
3548
3618
  }
3619
+ /** @enumType */
3620
+ export type AnimationDetectionWithLiterals = AnimationDetection | 'UNKNOWN_ANIMATION_DETECTION' | 'CONTAINS_ANIMATION' | 'NO_ANIMATION';
3549
3621
  export interface ImageContent {
3550
3622
  /** Text detection */
3551
- text?: TextDetection;
3623
+ text?: TextDetectionWithLiterals;
3552
3624
  /** Animation detection */
3553
- animation?: AnimationDetection;
3625
+ animation?: AnimationDetectionWithLiterals;
3554
3626
  }
3555
3627
  export interface SendBuyerConfirmationEmailRequest {
3556
3628
  /** @format GUID */
@@ -3667,7 +3739,7 @@ export interface SendMerchantOrderReceivedPushRequest {
3667
3739
  export interface SendMerchantOrderReceivedPushResponse {
3668
3740
  }
3669
3741
  export interface PreviewEmailByTypeRequest {
3670
- emailType?: PreviewEmailType;
3742
+ emailType?: PreviewEmailTypeWithLiterals;
3671
3743
  }
3672
3744
  export declare enum PreviewEmailType {
3673
3745
  ORDER_PLACED = "ORDER_PLACED",
@@ -3675,6 +3747,8 @@ export declare enum PreviewEmailType {
3675
3747
  ORDER_SHIPPED = "ORDER_SHIPPED",
3676
3748
  ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
3677
3749
  }
3750
+ /** @enumType */
3751
+ export type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
3678
3752
  export interface PreviewEmailByTypeResponse {
3679
3753
  emailPreview?: string;
3680
3754
  }
@@ -3844,7 +3918,7 @@ export interface MetaSite {
3844
3918
  */
3845
3919
  apps?: App[];
3846
3920
  /** Namespace of meta site. */
3847
- namespace?: Namespace;
3921
+ namespace?: NamespaceWithLiterals;
3848
3922
  /**
3849
3923
  * Indicates whether https should be used for viewing a site.
3850
3924
  *
@@ -3945,7 +4019,7 @@ export interface App {
3945
4019
  * State of this app (see docs for state).
3946
4020
  * @readonly
3947
4021
  */
3948
- state?: State;
4022
+ state?: StateWithLiterals;
3949
4023
  /**
3950
4024
  * Identifier of the originating application. For example, if this app was part of a template,
3951
4025
  * then an app will get instance_id of that app as origin instance id.
@@ -3972,6 +4046,8 @@ export declare enum State {
3972
4046
  /** App is not installed, there is a user intention for it only (user will see the pimpl in the editor). */
3973
4047
  PENDING = "PENDING"
3974
4048
  }
4049
+ /** @enumType */
4050
+ export type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'TEMPLATE' | 'PENDING';
3975
4051
  export declare enum Namespace {
3976
4052
  UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
3977
4053
  /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
@@ -4054,6 +4130,8 @@ export declare enum Namespace {
4054
4130
  /** MIMIR - Siteless account for MIMIR Ai Job runner. */
4055
4131
  MIMIR = "MIMIR"
4056
4132
  }
4133
+ /** @enumType */
4134
+ export type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR';
4057
4135
  export interface SeoData {
4058
4136
  /**
4059
4137
  * A title.
@@ -4179,12 +4257,14 @@ export interface Sorting {
4179
4257
  */
4180
4258
  fieldName?: string;
4181
4259
  /** Sort order. */
4182
- order?: SortOrder;
4260
+ order?: SortOrderWithLiterals;
4183
4261
  }
4184
4262
  export declare enum SortOrder {
4185
4263
  ASC = "ASC",
4186
4264
  DESC = "DESC"
4187
4265
  }
4266
+ /** @enumType */
4267
+ export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
4188
4268
  export interface PlatformPaging {
4189
4269
  /**
4190
4270
  * Number of items to load.
@@ -4405,7 +4485,7 @@ export interface VersionedDocumentUpdateOperation {
4405
4485
  /** documents to create or overwrite */
4406
4486
  documents?: InternalDocument[];
4407
4487
  /** versioning mode to use instead of default */
4408
- versioningMode?: VersioningMode;
4488
+ versioningMode?: VersioningModeWithLiterals;
4409
4489
  }
4410
4490
  export declare enum VersioningMode {
4411
4491
  /** use default versioning mode agreed with search team */
@@ -4415,6 +4495,8 @@ export declare enum VersioningMode {
4415
4495
  /** execute only if version is greater or equal to existing */
4416
4496
  GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
4417
4497
  }
4498
+ /** @enumType */
4499
+ export type VersioningModeWithLiterals = VersioningMode | 'DEFAULT' | 'GREATER_THAN' | 'GREATER_OR_EQUAL';
4418
4500
  export interface VersionedDeleteByIdsOperation {
4419
4501
  /** ids with version of the documents to delete */
4420
4502
  documentIds?: VersionedDocumentId[];
@@ -4425,7 +4507,7 @@ export interface VersionedDocumentId {
4425
4507
  /** document version */
4426
4508
  version?: string;
4427
4509
  /** versioning mode to use instead of default */
4428
- versioningMode?: VersioningMode;
4510
+ versioningMode?: VersioningModeWithLiterals;
4429
4511
  }
4430
4512
  export interface TriggerReindexRequest {
4431
4513
  /** @format GUID */
@@ -4562,7 +4644,7 @@ export interface OrderCreationSettings {
4562
4644
  * Condition for the order to be approved.
4563
4645
  * Default: `DEFAULT`
4564
4646
  */
4565
- orderApprovalStrategy?: OrderApprovalStrategy;
4647
+ orderApprovalStrategy?: OrderApprovalStrategyWithLiterals;
4566
4648
  /** Notification settings to be applied on order creation */
4567
4649
  notifications?: OrderCreateNotifications;
4568
4650
  }
@@ -4574,6 +4656,8 @@ export declare enum OrderApprovalStrategy {
4574
4656
  /** Order is automatically approved when payment method is saved for it. */
4575
4657
  PAYMENT_METHOD_SAVED = "PAYMENT_METHOD_SAVED"
4576
4658
  }
4659
+ /** @enumType */
4660
+ export type OrderApprovalStrategyWithLiterals = OrderApprovalStrategy | 'DEFAULT' | 'PAYMENT_RECEIVED' | 'PAYMENT_METHOD_SAVED';
4577
4661
  export interface OrderCreateNotifications {
4578
4662
  /**
4579
4663
  * Whether to send notification to the buyer.
@@ -4772,7 +4856,7 @@ export interface OrderLineItemChangedDetails {
4772
4856
  * + `FULL_PAYMENT_OFFLINE` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
4773
4857
  * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
4774
4858
  */
4775
- paymentOption?: DeltaPaymentOptionType;
4859
+ paymentOption?: DeltaPaymentOptionTypeWithLiterals;
4776
4860
  /**
4777
4861
  * Deprecated. Use `taxInfo` instead.
4778
4862
  * This field will be removed on September 30, 2024.
@@ -4812,6 +4896,8 @@ export declare enum DeltaPaymentOptionType {
4812
4896
  */
4813
4897
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
4814
4898
  }
4899
+ /** @enumType */
4900
+ export type DeltaPaymentOptionTypeWithLiterals = DeltaPaymentOptionType | 'UNKNOWN_PAYMENT_OPTION' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP_OFFLINE';
4815
4901
  export interface ItemChangedDetails {
4816
4902
  /**
4817
4903
  * The quantity before the change.
@@ -4869,7 +4955,7 @@ export interface DraftOrderCommitSettings {
4869
4955
  }
4870
4956
  export interface InventoryUpdateDetails {
4871
4957
  /** Action to be applied - decrease or restock */
4872
- actionType?: InventoryAction;
4958
+ actionType?: InventoryActionWithLiterals;
4873
4959
  /** Order line item id */
4874
4960
  lineItemId?: string;
4875
4961
  /** The amount to be increased or restocked */
@@ -4881,6 +4967,8 @@ export declare enum InventoryAction {
4881
4967
  /** Decrease inventory. Without failing on negative inventory. */
4882
4968
  DECREASE = "DECREASE"
4883
4969
  }
4970
+ /** @enumType */
4971
+ export type InventoryActionWithLiterals = InventoryAction | 'RESTOCK' | 'DECREASE';
4884
4972
  export interface CommitDeltasResponse {
4885
4973
  /** Order after deltas are applied */
4886
4974
  order?: Order;
@@ -5508,7 +5596,7 @@ export interface UpdateOrderStatusRequest {
5508
5596
  */
5509
5597
  orderId: string;
5510
5598
  /** New order status. */
5511
- status: OrderStatus;
5599
+ status: OrderStatusWithLiterals;
5512
5600
  }
5513
5601
  export interface UpdateOrderStatusResponse {
5514
5602
  /** Updated order. */
@@ -5531,9 +5619,9 @@ export interface FulfillmentStatusUpdated {
5531
5619
  /** The order that was updated */
5532
5620
  order?: Order;
5533
5621
  /** The previous status (before the update) */
5534
- previousFulfillmentStatus?: FulfillmentStatus;
5622
+ previousFulfillmentStatus?: FulfillmentStatusWithLiterals;
5535
5623
  /** the new status (after the update) */
5536
- newFulfillmentStatus?: FulfillmentStatus;
5624
+ newFulfillmentStatus?: FulfillmentStatusWithLiterals;
5537
5625
  /** the action that caused this update */
5538
5626
  action?: string;
5539
5627
  }
@@ -5788,7 +5876,7 @@ export interface InvoiceSentEvent {
5788
5876
  /** @readonly */
5789
5877
  data?: InvoiceFields;
5790
5878
  /** @readonly */
5791
- status?: InvoiceStatus;
5879
+ status?: InvoiceStatusWithLiterals;
5792
5880
  }
5793
5881
  export interface IdAndVersion {
5794
5882
  /** @format GUID */
@@ -5892,7 +5980,7 @@ export interface QuotesAddress {
5892
5980
  }
5893
5981
  export interface AddressDescription {
5894
5982
  content?: string;
5895
- placement?: Placement;
5983
+ placement?: PlacementWithLiterals;
5896
5984
  }
5897
5985
  export declare enum Placement {
5898
5986
  Unknown = "Unknown",
@@ -5900,6 +5988,8 @@ export declare enum Placement {
5900
5988
  Before = "Before",
5901
5989
  After = "After"
5902
5990
  }
5991
+ /** @enumType */
5992
+ export type PlacementWithLiterals = Placement | 'Unknown' | 'Replace' | 'Before' | 'After';
5903
5993
  export interface Phone {
5904
5994
  number?: string;
5905
5995
  }
@@ -5955,6 +6045,8 @@ export declare enum SubdivisionType {
5955
6045
  /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
5956
6046
  COUNTRY = "COUNTRY"
5957
6047
  }
6048
+ /** @enumType */
6049
+ export type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
5958
6050
  /** Subdivision Concordance values */
5959
6051
  export interface StandardDetails {
5960
6052
  /**
@@ -6011,7 +6103,7 @@ export interface Source {
6011
6103
  * App or service type.
6012
6104
  * @readonly
6013
6105
  */
6014
- sourceType?: SourceType;
6106
+ sourceType?: SourceTypeWithLiterals;
6015
6107
  }
6016
6108
  export declare enum SourceType {
6017
6109
  UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
@@ -6020,6 +6112,8 @@ export declare enum SourceType {
6020
6112
  ADMIN = "ADMIN",
6021
6113
  OTHER = "OTHER"
6022
6114
  }
6115
+ /** @enumType */
6116
+ export type SourceTypeWithLiterals = SourceType | 'UNKNOWN_SOURCE_TYPE' | 'WIX_APP' | 'EXTERNAL' | 'ADMIN' | 'OTHER';
6023
6117
  export interface LineItemMetaData {
6024
6118
  metadata?: Record<string, string>;
6025
6119
  }
@@ -6118,7 +6212,7 @@ export interface CustomFieldValue {
6118
6212
  /** The optional namespace of the custom field value. This field may be used to indicate intended usage or source. */
6119
6213
  namespace?: string | null;
6120
6214
  /** The group of the custom field indicates its intended placement in the financial document */
6121
- group?: CustomFieldGroup;
6215
+ group?: CustomFieldGroupWithLiterals;
6122
6216
  /** The value of the custom field */
6123
6217
  value?: Value;
6124
6218
  /**
@@ -6135,9 +6229,11 @@ export declare enum CustomFieldGroup {
6135
6229
  FOOTER = "FOOTER",
6136
6230
  OTHER = "OTHER"
6137
6231
  }
6232
+ /** @enumType */
6233
+ export type CustomFieldGroupWithLiterals = CustomFieldGroup | 'UNKNOWN_CUSTOM_FIELD_GROUP' | 'BUSINESS_DETAILS' | 'CUSTOMER_DETAILS' | 'DOCUMENT' | 'FOOTER' | 'OTHER';
6138
6234
  export interface Value {
6139
6235
  value?: string;
6140
- valueType?: ValueType;
6236
+ valueType?: ValueTypeWithLiterals;
6141
6237
  }
6142
6238
  export declare enum ValueType {
6143
6239
  UNKNOWN_VALUE_TYPE = "UNKNOWN_VALUE_TYPE",
@@ -6146,6 +6242,8 @@ export declare enum ValueType {
6146
6242
  BOOLEAN = "BOOLEAN",
6147
6243
  NUMBER = "NUMBER"
6148
6244
  }
6245
+ /** @enumType */
6246
+ export type ValueTypeWithLiterals = ValueType | 'UNKNOWN_VALUE_TYPE' | 'STRING' | 'DATE' | 'BOOLEAN' | 'NUMBER';
6149
6247
  export interface Deposit {
6150
6248
  /**
6151
6249
  * The flat amount of the deposit. The flat amount of the deposit must be less than the invoice total.
@@ -6162,13 +6260,15 @@ export interface Deposit {
6162
6260
  */
6163
6261
  percentage?: string;
6164
6262
  /** The type of the deposit. The default is FLAT. */
6165
- type?: DepositType;
6263
+ type?: DepositTypeWithLiterals;
6166
6264
  }
6167
6265
  export declare enum DepositType {
6168
6266
  UNKNOWN = "UNKNOWN",
6169
6267
  FLAT = "FLAT",
6170
6268
  PERCENTAGE = "PERCENTAGE"
6171
6269
  }
6270
+ /** @enumType */
6271
+ export type DepositTypeWithLiterals = DepositType | 'UNKNOWN' | 'FLAT' | 'PERCENTAGE';
6172
6272
  /**
6173
6273
  * InvoiceStatus allowed transitions based on current status:
6174
6274
  * Draft -> Deleted, Paid, Partially Paid, Sent
@@ -6190,6 +6290,8 @@ export declare enum InvoiceStatus {
6190
6290
  PartiallyPaid = "PartiallyPaid",
6191
6291
  PartialAndOverdue = "PartialAndOverdue"
6192
6292
  }
6293
+ /** @enumType */
6294
+ export type InvoiceStatusWithLiterals = InvoiceStatus | 'Draft' | 'Sent' | 'Processing' | 'Paid' | 'Overdue' | 'Void' | 'Deleted' | 'PartiallyPaid' | 'PartialAndOverdue';
6193
6295
  export interface TriggerSideEffectsFromLegacyData {
6194
6296
  storeId?: string;
6195
6297
  orderId?: string;