@wix/auto_sdk_ecom_orders 1.0.48 → 1.0.50

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 +181 -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 +353 -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 +181 -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 +353 -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 +181 -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 +359 -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 +181 -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 +359 -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
@@ -1,4 +1,4 @@
1
- import { NonNullablePaths } from '@wix/sdk-types';
1
+ import { Search as SearchSdkType, NonNullablePaths, SearchSpec } from '@wix/sdk-types';
2
2
  export interface Order {
3
3
  /**
4
4
  * Order ID.
@@ -32,19 +32,19 @@ export interface Order {
32
32
  /** Buyer information. */
33
33
  buyerInfo?: BuyerInfo;
34
34
  /** Order payment status. */
35
- paymentStatus?: PaymentStatus;
35
+ paymentStatus?: PaymentStatusWithLiterals;
36
36
  /**
37
37
  * Order fulfillment status.
38
38
  * @readonly
39
39
  */
40
- fulfillmentStatus?: FulfillmentStatus;
40
+ fulfillmentStatus?: FulfillmentStatusWithLiterals;
41
41
  /**
42
42
  * Language for communication with the buyer. Defaults to the site language.
43
43
  * For a site that supports multiple languages, this is the language the buyer selected.
44
44
  */
45
45
  buyerLanguage?: string | null;
46
46
  /** Weight measurement unit - defaults to site's weight unit. */
47
- weightUnit?: WeightUnit;
47
+ weightUnit?: WeightUnitWithLiterals;
48
48
  /**
49
49
  * 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.
50
50
  * @format CURRENCY
@@ -78,7 +78,7 @@ export interface Order {
78
78
  */
79
79
  buyerNote?: string | null;
80
80
  /** Order status. */
81
- status?: OrderStatus;
81
+ status?: OrderStatusWithLiterals;
82
82
  /** Whether order is archived. */
83
83
  archived?: boolean | null;
84
84
  /**
@@ -106,7 +106,7 @@ export interface Order {
106
106
  */
107
107
  activities?: Activity[];
108
108
  /** Order attribution source. */
109
- attributionSource?: AttributionSource;
109
+ attributionSource?: AttributionSourceWithLiterals;
110
110
  /**
111
111
  * ID of the order's initiator.
112
112
  * @readonly
@@ -248,7 +248,7 @@ export interface OrderLineItem {
248
248
  *
249
249
  * Default: `FULL_PAYMENT_ONLINE`
250
250
  */
251
- paymentOption?: PaymentOptionType;
251
+ paymentOption?: PaymentOptionTypeWithLiterals;
252
252
  /**
253
253
  * Deprecated. Use `taxInfo` instead.
254
254
  * This field will be removed on September 30, 2024.
@@ -421,6 +421,8 @@ export declare enum DescriptionLineType {
421
421
  /** Color type. */
422
422
  COLOR = "COLOR"
423
423
  }
424
+ /** @enumType */
425
+ export type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
424
426
  export interface FocalPoint {
425
427
  /** X-coordinate of the focal point. */
426
428
  x?: number;
@@ -444,14 +446,14 @@ export interface PhysicalProperties {
444
446
  }
445
447
  export interface ItemType extends ItemTypeItemTypeDataOneOf {
446
448
  /** Preset item type. */
447
- preset?: ItemTypeItemType;
449
+ preset?: ItemTypeItemTypeWithLiterals;
448
450
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
449
451
  custom?: string;
450
452
  }
451
453
  /** @oneof */
452
454
  export interface ItemTypeItemTypeDataOneOf {
453
455
  /** Preset item type. */
454
- preset?: ItemTypeItemType;
456
+ preset?: ItemTypeItemTypeWithLiterals;
455
457
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
456
458
  custom?: string;
457
459
  }
@@ -462,6 +464,8 @@ export declare enum ItemTypeItemType {
462
464
  GIFT_CARD = "GIFT_CARD",
463
465
  SERVICE = "SERVICE"
464
466
  }
467
+ /** @enumType */
468
+ export type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
465
469
  /** Type of selected payment option for catalog item */
466
470
  export declare enum PaymentOptionType {
467
471
  /** The entire payment for this item happens as part of the checkout. */
@@ -475,6 +479,8 @@ export declare enum PaymentOptionType {
475
479
  /** 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`. */
476
480
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
477
481
  }
482
+ /** @enumType */
483
+ export type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
478
484
  export interface ItemTaxFullDetails {
479
485
  /** Taxable amount of this line item. */
480
486
  taxableAmount?: Price;
@@ -540,7 +546,7 @@ export interface LineItemTaxBreakdown {
540
546
  */
541
547
  taxName?: string | null;
542
548
  /** Type of jurisdiction that taxes were calculated for. */
543
- jurisdictionType?: JurisdictionType;
549
+ jurisdictionType?: JurisdictionTypeWithLiterals;
544
550
  /** Non-taxable amount of the line item price. */
545
551
  nonTaxableAmount?: Price;
546
552
  /** Taxable amount of the line item price. */
@@ -555,6 +561,8 @@ export declare enum JurisdictionType {
555
561
  CITY = "CITY",
556
562
  SPECIAL = "SPECIAL"
557
563
  }
564
+ /** @enumType */
565
+ export type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
558
566
  export interface DigitalFile {
559
567
  /**
560
568
  * ID of the secure file in media.
@@ -643,7 +651,7 @@ export interface SubscriptionDescription {
643
651
  }
644
652
  export interface SubscriptionSettings {
645
653
  /** Frequency of recurring payment. */
646
- frequency?: SubscriptionFrequency;
654
+ frequency?: SubscriptionFrequencyWithLiterals;
647
655
  /**
648
656
  * Interval of recurring payment.
649
657
  * @min 1
@@ -670,9 +678,11 @@ export declare enum SubscriptionFrequency {
670
678
  MONTH = "MONTH",
671
679
  YEAR = "YEAR"
672
680
  }
681
+ /** @enumType */
682
+ export type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
673
683
  export interface FreeTrialPeriod {
674
684
  /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
675
- frequency?: SubscriptionFrequency;
685
+ frequency?: SubscriptionFrequencyWithLiterals;
676
686
  /**
677
687
  * interval of period
678
688
  * @min 1
@@ -682,7 +692,7 @@ export interface FreeTrialPeriod {
682
692
  }
683
693
  export interface BillingAdjustment {
684
694
  /** The type of adjustment. */
685
- type?: AdjustmentType;
695
+ type?: AdjustmentTypeWithLiterals;
686
696
  /** Summary of the prorated adjustment amount. */
687
697
  priceSummary?: BillingAdjustmentPriceSummary;
688
698
  }
@@ -693,6 +703,8 @@ export declare enum AdjustmentType {
693
703
  /** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
694
704
  CREDIT = "CREDIT"
695
705
  }
706
+ /** @enumType */
707
+ export type AdjustmentTypeWithLiterals = AdjustmentType | 'UNKNOWN_ADJUSTMENT_TYPE' | 'EXTRA_CHARGE' | 'CREDIT';
696
708
  export interface BillingAdjustmentPriceSummary {
697
709
  /** Subtotal of adjustment, before tax. */
698
710
  subtotal?: Price;
@@ -745,12 +757,12 @@ export interface LocationAndQuantity {
745
757
  }
746
758
  export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
747
759
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
748
- addressType?: TaxableAddressType;
760
+ addressType?: TaxableAddressTypeWithLiterals;
749
761
  }
750
762
  /** @oneof */
751
763
  export interface TaxableAddressTaxableAddressDataOneOf {
752
764
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
753
- addressType?: TaxableAddressType;
765
+ addressType?: TaxableAddressTypeWithLiterals;
754
766
  }
755
767
  export declare enum TaxableAddressType {
756
768
  UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
@@ -758,6 +770,8 @@ export declare enum TaxableAddressType {
758
770
  BILLING = "BILLING",
759
771
  SHIPPING = "SHIPPING"
760
772
  }
773
+ /** @enumType */
774
+ export type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
761
775
  export interface ExtendedFields {
762
776
  /**
763
777
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
@@ -903,6 +917,8 @@ export declare enum PaymentStatus {
903
917
  */
904
918
  DECLINED = "DECLINED"
905
919
  }
920
+ /** @enumType */
921
+ export type PaymentStatusWithLiterals = PaymentStatus | 'UNSPECIFIED' | 'NOT_PAID' | 'PAID' | 'PARTIALLY_REFUNDED' | 'FULLY_REFUNDED' | 'PENDING' | 'PARTIALLY_PAID' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED';
906
922
  export declare enum FulfillmentStatus {
907
923
  /** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
908
924
  NOT_FULFILLED = "NOT_FULFILLED",
@@ -914,6 +930,8 @@ export declare enum FulfillmentStatus {
914
930
  /** Some, but not all, of the order items are fulfilled. */
915
931
  PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
916
932
  }
933
+ /** @enumType */
934
+ export type FulfillmentStatusWithLiterals = FulfillmentStatus | 'NOT_FULFILLED' | 'FULFILLED' | 'PARTIALLY_FULFILLED';
917
935
  export declare enum WeightUnit {
918
936
  /** Weight unit can't be classified due to an error. */
919
937
  UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
@@ -922,6 +940,8 @@ export declare enum WeightUnit {
922
940
  /** Pounds. */
923
941
  LB = "LB"
924
942
  }
943
+ /** @enumType */
944
+ export type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
925
945
  export interface CurrencyConversionDetails {
926
946
  /**
927
947
  * 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.
@@ -1053,7 +1073,7 @@ export interface VatId {
1053
1073
  * + `CPF`: for individual tax payers
1054
1074
  * + `CNPJ`: for corporations
1055
1075
  */
1056
- type?: VatType;
1076
+ type?: VatTypeWithLiterals;
1057
1077
  }
1058
1078
  /** tax info types */
1059
1079
  export declare enum VatType {
@@ -1063,6 +1083,8 @@ export declare enum VatType {
1063
1083
  /** CNPJ - for corporations */
1064
1084
  CNPJ = "CNPJ"
1065
1085
  }
1086
+ /** @enumType */
1087
+ export type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
1066
1088
  export interface V1ShippingInformation {
1067
1089
  /**
1068
1090
  * App Def Id of external provider which was a source of shipping info
@@ -1123,7 +1145,7 @@ export interface PickupDetails {
1123
1145
  /** Pickup address. */
1124
1146
  address?: PickupAddress;
1125
1147
  /** Pickup method */
1126
- pickupMethod?: PickupMethod;
1148
+ pickupMethod?: PickupMethodWithLiterals;
1127
1149
  }
1128
1150
  /** Physical address */
1129
1151
  export interface PickupAddress {
@@ -1175,6 +1197,8 @@ export declare enum PickupMethod {
1175
1197
  STORE_PICKUP = "STORE_PICKUP",
1176
1198
  PICKUP_POINT = "PICKUP_POINT"
1177
1199
  }
1200
+ /** @enumType */
1201
+ export type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
1178
1202
  export interface DeliveryTimeSlot {
1179
1203
  /** Delivery slot starting time. */
1180
1204
  from?: Date | null;
@@ -1234,6 +1258,8 @@ export declare enum OrderStatus {
1234
1258
  */
1235
1259
  REJECTED = "REJECTED"
1236
1260
  }
1261
+ /** @enumType */
1262
+ export type OrderStatusWithLiterals = OrderStatus | 'INITIALIZED' | 'APPROVED' | 'CANCELED' | 'PENDING' | 'REJECTED';
1237
1263
  export interface TaxSummary {
1238
1264
  /**
1239
1265
  * Total tax.
@@ -1278,7 +1304,7 @@ export interface OrderTaxBreakdown {
1278
1304
  */
1279
1305
  jurisdiction?: string;
1280
1306
  /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
1281
- jurisdictionType?: JurisdictionType;
1307
+ jurisdictionType?: JurisdictionTypeWithLiterals;
1282
1308
  /**
1283
1309
  * The rate at which this tax detail was calculated.
1284
1310
  * @format DECIMAL_VALUE
@@ -1301,7 +1327,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1301
1327
  * * `"SPECIFIC-ITEMS"` - discount applies to specific items.
1302
1328
  * * `"SHIPPING"` - discount applies to shipping. For example, free shipping.
1303
1329
  */
1304
- discountType?: DiscountType;
1330
+ discountType?: DiscountTypeWithLiterals;
1305
1331
  /**
1306
1332
  * IDs of line items discount applies to.
1307
1333
  * Deprecated. Use `line_item_discounts` instead.
@@ -1334,6 +1360,8 @@ export declare enum DiscountType {
1334
1360
  SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
1335
1361
  SHIPPING = "SHIPPING"
1336
1362
  }
1363
+ /** @enumType */
1364
+ export type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
1337
1365
  /** Coupon */
1338
1366
  export interface Coupon {
1339
1367
  /** Coupon ID. */
@@ -1350,7 +1378,7 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
1350
1378
  * Pre-defined discount reason (optional).
1351
1379
  * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
1352
1380
  */
1353
- discountReason?: DiscountReason;
1381
+ discountReason?: DiscountReasonWithLiterals;
1354
1382
  /**
1355
1383
  * Discount description as free text (optional).
1356
1384
  * @maxLength 200
@@ -1365,7 +1393,7 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
1365
1393
  * Pre-defined discount reason (optional).
1366
1394
  * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
1367
1395
  */
1368
- discountReason?: DiscountReason;
1396
+ discountReason?: DiscountReasonWithLiterals;
1369
1397
  /**
1370
1398
  * Discount description as free text (optional).
1371
1399
  * @maxLength 200
@@ -1377,6 +1405,8 @@ export declare enum DiscountReason {
1377
1405
  EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
1378
1406
  BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
1379
1407
  }
1408
+ /** @enumType */
1409
+ export type DiscountReasonWithLiterals = DiscountReason | 'UNSPECIFIED' | 'EXCHANGED_ITEMS' | 'BILLING_ADJUSTMENT';
1380
1410
  export interface DiscountRule {
1381
1411
  /**
1382
1412
  * Discount rule ID
@@ -1436,7 +1466,7 @@ export interface Activity extends ActivityContentOneOf {
1436
1466
  */
1437
1467
  _createdDate?: Date | null;
1438
1468
  /** Activity type. */
1439
- type?: ActivityType;
1469
+ type?: ActivityTypeWithLiterals;
1440
1470
  }
1441
1471
  /** @oneof */
1442
1472
  export interface ActivityContentOneOf {
@@ -1579,7 +1609,7 @@ export interface LineItemQuantityChange {
1579
1609
  */
1580
1610
  diff?: number;
1581
1611
  /** Type of quantity change: increase or decrease. */
1582
- deltaType?: LineItemQuantityChangeType;
1612
+ deltaType?: LineItemQuantityChangeTypeWithLiterals;
1583
1613
  }
1584
1614
  export declare enum LineItemQuantityChangeType {
1585
1615
  /** Quantity increased. */
@@ -1587,6 +1617,8 @@ export declare enum LineItemQuantityChangeType {
1587
1617
  /** Quantity decreased. */
1588
1618
  QUANTITY_DECREASED = "QUANTITY_DECREASED"
1589
1619
  }
1620
+ /** @enumType */
1621
+ export type LineItemQuantityChangeTypeWithLiterals = LineItemQuantityChangeType | 'QUANTITY_INCREASED' | 'QUANTITY_DECREASED';
1590
1622
  export interface LineItemPriceChange {
1591
1623
  /** Item price before update. */
1592
1624
  originalPrice?: Price;
@@ -2017,10 +2049,14 @@ export declare enum ActivityType {
2017
2049
  /** @documentationMaturity preview */
2018
2050
  ORDER_REJECTED = "ORDER_REJECTED"
2019
2051
  }
2052
+ /** @enumType */
2053
+ 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';
2020
2054
  export declare enum AttributionSource {
2021
2055
  UNSPECIFIED = "UNSPECIFIED",
2022
2056
  FACEBOOK_ADS = "FACEBOOK_ADS"
2023
2057
  }
2058
+ /** @enumType */
2059
+ export type AttributionSourceWithLiterals = AttributionSource | 'UNSPECIFIED' | 'FACEBOOK_ADS';
2024
2060
  export interface CreatedBy extends CreatedByStringOneOf {
2025
2061
  /**
2026
2062
  * User ID - when the order was created by a Wix user on behalf of a buyer.
@@ -2070,7 +2106,7 @@ export interface CreatedByStringOneOf {
2070
2106
  }
2071
2107
  export interface ChannelInfo {
2072
2108
  /** Sales channel that submitted the order. */
2073
- type?: ChannelType;
2109
+ type?: ChannelTypeWithLiterals;
2074
2110
  /**
2075
2111
  * Reference to an order ID from an external system.
2076
2112
  * @maxLength 100
@@ -2116,6 +2152,8 @@ export declare enum ChannelType {
2116
2152
  /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
2117
2153
  FAIRE_COM = "FAIRE_COM"
2118
2154
  }
2155
+ /** @enumType */
2156
+ 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';
2119
2157
  export interface CustomField {
2120
2158
  /** Custom field value. */
2121
2159
  value?: any;
@@ -2364,7 +2402,7 @@ export interface RedirectUrls {
2364
2402
  }
2365
2403
  export interface DelayedCaptureSettings {
2366
2404
  /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
2367
- scheduledAction?: ScheduledAction;
2405
+ scheduledAction?: ScheduledActionWithLiterals;
2368
2406
  /** Delay duration before execution. Optional - if not set, providers default period will be used */
2369
2407
  delayDuration?: Duration;
2370
2408
  }
@@ -2375,6 +2413,8 @@ export declare enum ScheduledAction {
2375
2413
  /** Whether payment will be auto-captured when duration passes */
2376
2414
  CAPTURE = "CAPTURE"
2377
2415
  }
2416
+ /** @enumType */
2417
+ export type ScheduledActionWithLiterals = ScheduledAction | 'UNSPECIFIED' | 'VOID' | 'CAPTURE';
2378
2418
  export interface Duration {
2379
2419
  /**
2380
2420
  * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
@@ -2382,7 +2422,7 @@ export interface Duration {
2382
2422
  */
2383
2423
  count?: number;
2384
2424
  /** Duration unit: MINUTES, HOURS and DAYS */
2385
- unit?: DurationUnit;
2425
+ unit?: DurationUnitWithLiterals;
2386
2426
  }
2387
2427
  export declare enum DurationUnit {
2388
2428
  UNKNOWN_DURATION_UNIT = "UNKNOWN_DURATION_UNIT",
@@ -2390,6 +2430,8 @@ export declare enum DurationUnit {
2390
2430
  HOURS = "HOURS",
2391
2431
  DAYS = "DAYS"
2392
2432
  }
2433
+ /** @enumType */
2434
+ export type DurationUnitWithLiterals = DurationUnit | 'UNKNOWN_DURATION_UNIT' | 'MINUTES' | 'HOURS' | 'DAYS';
2393
2435
  export interface PreparePaymentCollectionResponse {
2394
2436
  /** Payment gateway order id which is associated with given payment */
2395
2437
  paymentGatewayOrderId?: string;
@@ -2404,7 +2446,7 @@ export interface GetPaymentCollectabilityStatusRequest {
2404
2446
  }
2405
2447
  export interface GetPaymentCollectabilityStatusResponse {
2406
2448
  /** Payment collectability status */
2407
- status?: PaymentCollectabilityStatus;
2449
+ status?: PaymentCollectabilityStatusWithLiterals;
2408
2450
  /** Collectable order amount */
2409
2451
  amount?: Price;
2410
2452
  }
@@ -2418,6 +2460,8 @@ export declare enum PaymentCollectabilityStatus {
2418
2460
  NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
2419
2461
  NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS"
2420
2462
  }
2463
+ /** @enumType */
2464
+ 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';
2421
2465
  export interface RecordManuallyCollectedPaymentRequest {
2422
2466
  /**
2423
2467
  * Order ID.
@@ -2447,7 +2491,7 @@ export interface PaymentStatusUpdated {
2447
2491
  /** The order that was updated */
2448
2492
  order?: Order;
2449
2493
  /** The previous status (before the update) */
2450
- previousPaymentStatus?: PaymentStatus;
2494
+ previousPaymentStatus?: PaymentStatusWithLiterals;
2451
2495
  }
2452
2496
  export interface BulkMarkOrdersAsPaidRequest {
2453
2497
  /**
@@ -2526,28 +2570,30 @@ export interface GetRefundabilityStatusResponse {
2526
2570
  }
2527
2571
  export interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
2528
2572
  /** Reason why payment is not refundable. */
2529
- nonRefundableReason?: NonRefundableReason;
2573
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
2530
2574
  /** Reason why payment is only refundable manually. */
2531
- manuallyRefundableReason?: ManuallyRefundableReason;
2575
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
2532
2576
  /** Payment ID. */
2533
2577
  paymentId?: string;
2534
2578
  /** Payment refundability status. */
2535
- refundabilityStatus?: RefundableStatus;
2579
+ refundabilityStatus?: RefundableStatusWithLiterals;
2536
2580
  /** Link to payment provider dashboard. */
2537
2581
  providerLink?: string | null;
2538
2582
  }
2539
2583
  /** @oneof */
2540
2584
  export interface RefundabilityAdditionalRefundabilityInfoOneOf {
2541
2585
  /** Reason why payment is not refundable. */
2542
- nonRefundableReason?: NonRefundableReason;
2586
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
2543
2587
  /** Reason why payment is only refundable manually. */
2544
- manuallyRefundableReason?: ManuallyRefundableReason;
2588
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
2545
2589
  }
2546
2590
  export declare enum RefundableStatus {
2547
2591
  NOT_REFUNDABLE = "NOT_REFUNDABLE",
2548
2592
  MANUAL = "MANUAL",
2549
2593
  REFUNDABLE = "REFUNDABLE"
2550
2594
  }
2595
+ /** @enumType */
2596
+ export type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
2551
2597
  export declare enum NonRefundableReason {
2552
2598
  NONE = "NONE",
2553
2599
  ALREADY_REFUNDED = "ALREADY_REFUNDED",
@@ -2563,12 +2609,16 @@ export declare enum NonRefundableReason {
2563
2609
  ORDER_IS_PENDING = "ORDER_IS_PENDING",
2564
2610
  ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
2565
2611
  }
2612
+ /** @enumType */
2613
+ 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';
2566
2614
  export declare enum ManuallyRefundableReason {
2567
2615
  EXPIRED = "EXPIRED",
2568
2616
  NOT_SUPPORTED = "NOT_SUPPORTED",
2569
2617
  OFFLINE = "OFFLINE",
2570
2618
  REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
2571
2619
  }
2620
+ /** @enumType */
2621
+ export type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
2572
2622
  export interface CreatePaymentGatewayOrderRequest {
2573
2623
  /**
2574
2624
  * Ecom order ID.
@@ -2800,7 +2850,7 @@ export interface RefundSideEffects {
2800
2850
  }
2801
2851
  export interface RestockInfo {
2802
2852
  /** Restock type. */
2803
- type?: RestockType;
2853
+ type?: RestockTypeWithLiterals;
2804
2854
  /**
2805
2855
  * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
2806
2856
  * @maxSize 300
@@ -2812,6 +2862,8 @@ export declare enum RestockType {
2812
2862
  ALL_ITEMS = "ALL_ITEMS",
2813
2863
  SOME_ITEMS = "SOME_ITEMS"
2814
2864
  }
2865
+ /** @enumType */
2866
+ export type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
2815
2867
  export interface RestockItem {
2816
2868
  /**
2817
2869
  * ID of the line item being restocked.
@@ -2915,7 +2967,7 @@ export interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMetho
2915
2967
  /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
2916
2968
  offlinePayment?: boolean;
2917
2969
  /** Payment status. */
2918
- status?: TransactionStatus;
2970
+ status?: TransactionStatusWithLiterals;
2919
2971
  /**
2920
2972
  * Whether there is a payment agreement that allows for future charges.
2921
2973
  * @immutable
@@ -2941,6 +2993,8 @@ export declare enum TransactionStatus {
2941
2993
  AUTHORIZED = "AUTHORIZED",
2942
2994
  VOIDED = "VOIDED"
2943
2995
  }
2996
+ /** @enumType */
2997
+ export type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
2944
2998
  export interface CreditCardPaymentMethodDetails {
2945
2999
  /**
2946
3000
  * The last 4 digits of the card number.
@@ -2980,7 +3034,7 @@ export interface AuthorizationCapture {
2980
3034
  */
2981
3035
  _id?: string | null;
2982
3036
  /** Status of this capture action */
2983
- status?: AuthorizationCaptureStatus;
3037
+ status?: AuthorizationCaptureStatusWithLiterals;
2984
3038
  /**
2985
3039
  * Amount of this capture
2986
3040
  * @immutable
@@ -3000,19 +3054,21 @@ export declare enum AuthorizationCaptureStatus {
3000
3054
  /** Capture operation failed. */
3001
3055
  FAILED = "FAILED"
3002
3056
  }
3057
+ /** @enumType */
3058
+ export type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
3003
3059
  export interface AuthorizationActionFailureDetails {
3004
3060
  /** @maxLength 100 */
3005
3061
  failureCode?: string;
3006
3062
  }
3007
3063
  export interface AuthorizationVoid {
3008
3064
  /** Status of this void action */
3009
- status?: AuthorizationVoidStatus;
3065
+ status?: AuthorizationVoidStatusWithLiterals;
3010
3066
  /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
3011
3067
  voidedDate?: Date | null;
3012
3068
  /** In case of status is FAILED may contain failure details */
3013
3069
  failureDetails?: AuthorizationActionFailureDetails;
3014
3070
  /** Reason of void action */
3015
- reason?: Reason;
3071
+ reason?: ReasonWithLiterals;
3016
3072
  }
3017
3073
  export declare enum AuthorizationVoidStatus {
3018
3074
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
@@ -3023,6 +3079,8 @@ export declare enum AuthorizationVoidStatus {
3023
3079
  /** Void operation failed. */
3024
3080
  FAILED = "FAILED"
3025
3081
  }
3082
+ /** @enumType */
3083
+ export type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
3026
3084
  /** Reason the authorization was voided. */
3027
3085
  export declare enum Reason {
3028
3086
  UNKNOWN_REASON = "UNKNOWN_REASON",
@@ -3031,9 +3089,11 @@ export declare enum Reason {
3031
3089
  /** Authorization passed execution date. */
3032
3090
  SCHEDULED = "SCHEDULED"
3033
3091
  }
3092
+ /** @enumType */
3093
+ export type ReasonWithLiterals = Reason | 'UNKNOWN_REASON' | 'MANUAL' | 'SCHEDULED';
3034
3094
  export interface V1ScheduledAction {
3035
3095
  /** Type of the action. */
3036
- actionType?: ActionType;
3096
+ actionType?: ActionTypeWithLiterals;
3037
3097
  /** The date and time of the action. */
3038
3098
  executionDate?: Date | null;
3039
3099
  }
@@ -3042,6 +3102,8 @@ export declare enum ActionType {
3042
3102
  VOID = "VOID",
3043
3103
  CAPTURE = "CAPTURE"
3044
3104
  }
3105
+ /** @enumType */
3106
+ export type ActionTypeWithLiterals = ActionType | 'UNKNOWN_ACTION_TYPE' | 'VOID' | 'CAPTURE';
3045
3107
  export interface GiftCardPaymentDetails {
3046
3108
  /**
3047
3109
  * Gift card payment ID.
@@ -3074,7 +3136,7 @@ export interface MembershipPaymentDetails {
3074
3136
  */
3075
3137
  lineItemId?: string;
3076
3138
  /** Payment status. */
3077
- status?: MembershipPaymentStatus;
3139
+ status?: MembershipPaymentStatusWithLiterals;
3078
3140
  /** Membership name. */
3079
3141
  name?: MembershipName;
3080
3142
  /**
@@ -3100,6 +3162,8 @@ export declare enum MembershipPaymentStatus {
3100
3162
  /** The attempt to charge the payment failed, for example, due to lack of credits. */
3101
3163
  CHARGE_FAILED = "CHARGE_FAILED"
3102
3164
  }
3165
+ /** @enumType */
3166
+ export type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED';
3103
3167
  export interface WixReceiptInfo {
3104
3168
  /**
3105
3169
  * Receipt ID
@@ -3177,7 +3241,7 @@ export interface RefundTransaction {
3177
3241
  */
3178
3242
  amount?: Price;
3179
3243
  /** Refund status. */
3180
- refundStatus?: RefundStatus;
3244
+ refundStatus?: RefundStatusWithLiterals;
3181
3245
  /** Optional details of current refund status. */
3182
3246
  refundStatusInfo?: RefundStatusInfo;
3183
3247
  /**
@@ -3207,6 +3271,8 @@ export declare enum RefundStatus {
3207
3271
  /** Refund was initiated on payment provider side. */
3208
3272
  STARTED = "STARTED"
3209
3273
  }
3274
+ /** @enumType */
3275
+ export type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
3210
3276
  export interface RefundStatusInfo {
3211
3277
  /**
3212
3278
  * Reason code for the refund's current status.
@@ -3474,7 +3540,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
3474
3540
  */
3475
3541
  appId?: string;
3476
3542
  /** @readonly */
3477
- identityType?: WebhookIdentityType;
3543
+ identityType?: WebhookIdentityTypeWithLiterals;
3478
3544
  }
3479
3545
  /** @oneof */
3480
3546
  export interface IdentificationDataIdOneOf {
@@ -3506,6 +3572,8 @@ export declare enum WebhookIdentityType {
3506
3572
  WIX_USER = "WIX_USER",
3507
3573
  APP = "APP"
3508
3574
  }
3575
+ /** @enumType */
3576
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
3509
3577
  export declare enum TextDetection {
3510
3578
  /** No detection was made */
3511
3579
  UNKNOWN_TEXT_DETECTION = "UNKNOWN_TEXT_DETECTION",
@@ -3514,6 +3582,8 @@ export declare enum TextDetection {
3514
3582
  /** The image does not contain text */
3515
3583
  NO_TEXT = "NO_TEXT"
3516
3584
  }
3585
+ /** @enumType */
3586
+ export type TextDetectionWithLiterals = TextDetection | 'UNKNOWN_TEXT_DETECTION' | 'CONTAINS_TEXT' | 'NO_TEXT';
3517
3587
  export declare enum AnimationDetection {
3518
3588
  /** No detection was made */
3519
3589
  UNKNOWN_ANIMATION_DETECTION = "UNKNOWN_ANIMATION_DETECTION",
@@ -3522,11 +3592,13 @@ export declare enum AnimationDetection {
3522
3592
  /** The image does not contain animation */
3523
3593
  NO_ANIMATION = "NO_ANIMATION"
3524
3594
  }
3595
+ /** @enumType */
3596
+ export type AnimationDetectionWithLiterals = AnimationDetection | 'UNKNOWN_ANIMATION_DETECTION' | 'CONTAINS_ANIMATION' | 'NO_ANIMATION';
3525
3597
  export interface ImageContent {
3526
3598
  /** Text detection */
3527
- text?: TextDetection;
3599
+ text?: TextDetectionWithLiterals;
3528
3600
  /** Animation detection */
3529
- animation?: AnimationDetection;
3601
+ animation?: AnimationDetectionWithLiterals;
3530
3602
  }
3531
3603
  export interface SendBuyerConfirmationEmailRequest {
3532
3604
  /** @format GUID */
@@ -3643,7 +3715,7 @@ export interface SendMerchantOrderReceivedPushRequest {
3643
3715
  export interface SendMerchantOrderReceivedPushResponse {
3644
3716
  }
3645
3717
  export interface PreviewEmailByTypeRequest {
3646
- emailType?: PreviewEmailType;
3718
+ emailType?: PreviewEmailTypeWithLiterals;
3647
3719
  }
3648
3720
  export declare enum PreviewEmailType {
3649
3721
  ORDER_PLACED = "ORDER_PLACED",
@@ -3651,6 +3723,8 @@ export declare enum PreviewEmailType {
3651
3723
  ORDER_SHIPPED = "ORDER_SHIPPED",
3652
3724
  ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
3653
3725
  }
3726
+ /** @enumType */
3727
+ export type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
3654
3728
  export interface PreviewEmailByTypeResponse {
3655
3729
  emailPreview?: string;
3656
3730
  }
@@ -3820,7 +3894,7 @@ export interface MetaSite {
3820
3894
  */
3821
3895
  apps?: App[];
3822
3896
  /** Namespace of meta site. */
3823
- namespace?: Namespace;
3897
+ namespace?: NamespaceWithLiterals;
3824
3898
  /**
3825
3899
  * Indicates whether https should be used for viewing a site.
3826
3900
  *
@@ -3921,7 +3995,7 @@ export interface App {
3921
3995
  * State of this app (see docs for state).
3922
3996
  * @readonly
3923
3997
  */
3924
- state?: State;
3998
+ state?: StateWithLiterals;
3925
3999
  /**
3926
4000
  * Identifier of the originating application. For example, if this app was part of a template,
3927
4001
  * then an app will get instance_id of that app as origin instance id.
@@ -3948,6 +4022,8 @@ export declare enum State {
3948
4022
  /** App is not installed, there is a user intention for it only (user will see the pimpl in the editor). */
3949
4023
  PENDING = "PENDING"
3950
4024
  }
4025
+ /** @enumType */
4026
+ export type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'TEMPLATE' | 'PENDING';
3951
4027
  export declare enum Namespace {
3952
4028
  UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
3953
4029
  /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
@@ -4030,6 +4106,8 @@ export declare enum Namespace {
4030
4106
  /** MIMIR - Siteless account for MIMIR Ai Job runner. */
4031
4107
  MIMIR = "MIMIR"
4032
4108
  }
4109
+ /** @enumType */
4110
+ 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';
4033
4111
  export interface SeoData {
4034
4112
  /**
4035
4113
  * A title.
@@ -4155,12 +4233,14 @@ export interface Sorting {
4155
4233
  */
4156
4234
  fieldName?: string;
4157
4235
  /** Sort order. */
4158
- order?: SortOrder;
4236
+ order?: SortOrderWithLiterals;
4159
4237
  }
4160
4238
  export declare enum SortOrder {
4161
4239
  ASC = "ASC",
4162
4240
  DESC = "DESC"
4163
4241
  }
4242
+ /** @enumType */
4243
+ export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
4164
4244
  export interface PlatformPaging {
4165
4245
  /**
4166
4246
  * Number of items to load.
@@ -4274,6 +4354,7 @@ export interface GetOrderOutOfBoxRequest {
4274
4354
  }
4275
4355
  export interface GetOrderOutOfBoxResponse {
4276
4356
  /**
4357
+ * Order id if found
4277
4358
  * @minLength 1
4278
4359
  * @maxLength 100
4279
4360
  */
@@ -4289,6 +4370,23 @@ export interface GetOrderAgcRequest {
4289
4370
  }
4290
4371
  export interface GetOrderAgcResponse {
4291
4372
  /**
4373
+ * Order id if found
4374
+ * @minLength 1
4375
+ * @maxLength 100
4376
+ */
4377
+ orderId?: string;
4378
+ }
4379
+ export interface GetOrderWithFilterByLocationRequest {
4380
+ /**
4381
+ * Order Id for EP order to retrieve
4382
+ * @minLength 1
4383
+ * @maxLength 100
4384
+ */
4385
+ _id?: string;
4386
+ }
4387
+ export interface GetOrderWithFilterByLocationResponse {
4388
+ /**
4389
+ * Order id if found
4292
4390
  * @minLength 1
4293
4391
  * @maxLength 100
4294
4392
  */
@@ -4381,7 +4479,7 @@ export interface VersionedDocumentUpdateOperation {
4381
4479
  /** documents to create or overwrite */
4382
4480
  documents?: InternalDocument[];
4383
4481
  /** versioning mode to use instead of default */
4384
- versioningMode?: VersioningMode;
4482
+ versioningMode?: VersioningModeWithLiterals;
4385
4483
  }
4386
4484
  export declare enum VersioningMode {
4387
4485
  /** use default versioning mode agreed with search team */
@@ -4391,6 +4489,8 @@ export declare enum VersioningMode {
4391
4489
  /** execute only if version is greater or equal to existing */
4392
4490
  GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
4393
4491
  }
4492
+ /** @enumType */
4493
+ export type VersioningModeWithLiterals = VersioningMode | 'DEFAULT' | 'GREATER_THAN' | 'GREATER_OR_EQUAL';
4394
4494
  export interface VersionedDeleteByIdsOperation {
4395
4495
  /** ids with version of the documents to delete */
4396
4496
  documentIds?: VersionedDocumentId[];
@@ -4401,7 +4501,7 @@ export interface VersionedDocumentId {
4401
4501
  /** document version */
4402
4502
  version?: string;
4403
4503
  /** versioning mode to use instead of default */
4404
- versioningMode?: VersioningMode;
4504
+ versioningMode?: VersioningModeWithLiterals;
4405
4505
  }
4406
4506
  export interface TriggerReindexRequest {
4407
4507
  /** @format GUID */
@@ -4538,7 +4638,7 @@ export interface OrderCreationSettings {
4538
4638
  * Condition for the order to be approved.
4539
4639
  * Default: `DEFAULT`
4540
4640
  */
4541
- orderApprovalStrategy?: OrderApprovalStrategy;
4641
+ orderApprovalStrategy?: OrderApprovalStrategyWithLiterals;
4542
4642
  /** Notification settings to be applied on order creation */
4543
4643
  notifications?: OrderCreateNotifications;
4544
4644
  }
@@ -4550,6 +4650,8 @@ export declare enum OrderApprovalStrategy {
4550
4650
  /** Order is automatically approved when payment method is saved for it. */
4551
4651
  PAYMENT_METHOD_SAVED = "PAYMENT_METHOD_SAVED"
4552
4652
  }
4653
+ /** @enumType */
4654
+ export type OrderApprovalStrategyWithLiterals = OrderApprovalStrategy | 'DEFAULT' | 'PAYMENT_RECEIVED' | 'PAYMENT_METHOD_SAVED';
4553
4655
  export interface OrderCreateNotifications {
4554
4656
  /**
4555
4657
  * Whether to send notification to the buyer.
@@ -4749,7 +4851,7 @@ export interface OrderLineItemChangedDetails {
4749
4851
  * + `FULL_PAYMENT_OFFLINE` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
4750
4852
  * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
4751
4853
  */
4752
- paymentOption?: DeltaPaymentOptionType;
4854
+ paymentOption?: DeltaPaymentOptionTypeWithLiterals;
4753
4855
  /**
4754
4856
  * Deprecated. Use `taxInfo` instead.
4755
4857
  * This field will be removed on September 30, 2024.
@@ -4789,6 +4891,8 @@ export declare enum DeltaPaymentOptionType {
4789
4891
  */
4790
4892
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
4791
4893
  }
4894
+ /** @enumType */
4895
+ export type DeltaPaymentOptionTypeWithLiterals = DeltaPaymentOptionType | 'UNKNOWN_PAYMENT_OPTION' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP_OFFLINE';
4792
4896
  export interface ItemChangedDetails {
4793
4897
  /**
4794
4898
  * The quantity before the change.
@@ -4846,7 +4950,7 @@ export interface DraftOrderCommitSettings {
4846
4950
  }
4847
4951
  export interface InventoryUpdateDetails {
4848
4952
  /** Action to be applied - decrease or restock */
4849
- actionType?: InventoryAction;
4953
+ actionType?: InventoryActionWithLiterals;
4850
4954
  /** Order line item id */
4851
4955
  lineItemId?: string;
4852
4956
  /** The amount to be increased or restocked */
@@ -4858,6 +4962,8 @@ export declare enum InventoryAction {
4858
4962
  /** Decrease inventory. Without failing on negative inventory. */
4859
4963
  DECREASE = "DECREASE"
4860
4964
  }
4965
+ /** @enumType */
4966
+ export type InventoryActionWithLiterals = InventoryAction | 'RESTOCK' | 'DECREASE';
4861
4967
  export interface CommitDeltasResponse {
4862
4968
  /** Order after deltas are applied */
4863
4969
  order?: Order;
@@ -5485,7 +5591,7 @@ export interface UpdateOrderStatusRequest {
5485
5591
  */
5486
5592
  orderId: string;
5487
5593
  /** New order status. */
5488
- status: OrderStatus;
5594
+ status: OrderStatusWithLiterals;
5489
5595
  }
5490
5596
  export interface UpdateOrderStatusResponse {
5491
5597
  /** Updated order. */
@@ -5508,9 +5614,9 @@ export interface FulfillmentStatusUpdated {
5508
5614
  /** The order that was updated */
5509
5615
  order?: Order;
5510
5616
  /** The previous status (before the update) */
5511
- previousFulfillmentStatus?: FulfillmentStatus;
5617
+ previousFulfillmentStatus?: FulfillmentStatusWithLiterals;
5512
5618
  /** the new status (after the update) */
5513
- newFulfillmentStatus?: FulfillmentStatus;
5619
+ newFulfillmentStatus?: FulfillmentStatusWithLiterals;
5514
5620
  /** the action that caused this update */
5515
5621
  action?: string;
5516
5622
  }
@@ -5765,7 +5871,7 @@ export interface InvoiceSentEvent {
5765
5871
  /** @readonly */
5766
5872
  data?: InvoiceFields;
5767
5873
  /** @readonly */
5768
- status?: InvoiceStatus;
5874
+ status?: InvoiceStatusWithLiterals;
5769
5875
  }
5770
5876
  export interface IdAndVersion {
5771
5877
  /** @format GUID */
@@ -5869,7 +5975,7 @@ export interface QuotesAddress {
5869
5975
  }
5870
5976
  export interface AddressDescription {
5871
5977
  content?: string;
5872
- placement?: Placement;
5978
+ placement?: PlacementWithLiterals;
5873
5979
  }
5874
5980
  export declare enum Placement {
5875
5981
  Unknown = "Unknown",
@@ -5877,6 +5983,8 @@ export declare enum Placement {
5877
5983
  Before = "Before",
5878
5984
  After = "After"
5879
5985
  }
5986
+ /** @enumType */
5987
+ export type PlacementWithLiterals = Placement | 'Unknown' | 'Replace' | 'Before' | 'After';
5880
5988
  export interface Phone {
5881
5989
  number?: string;
5882
5990
  }
@@ -5932,6 +6040,8 @@ export declare enum SubdivisionType {
5932
6040
  /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
5933
6041
  COUNTRY = "COUNTRY"
5934
6042
  }
6043
+ /** @enumType */
6044
+ 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';
5935
6045
  /** Subdivision Concordance values */
5936
6046
  export interface StandardDetails {
5937
6047
  /**
@@ -5988,7 +6098,7 @@ export interface Source {
5988
6098
  * App or service type.
5989
6099
  * @readonly
5990
6100
  */
5991
- sourceType?: SourceType;
6101
+ sourceType?: SourceTypeWithLiterals;
5992
6102
  }
5993
6103
  export declare enum SourceType {
5994
6104
  UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
@@ -5997,6 +6107,8 @@ export declare enum SourceType {
5997
6107
  ADMIN = "ADMIN",
5998
6108
  OTHER = "OTHER"
5999
6109
  }
6110
+ /** @enumType */
6111
+ export type SourceTypeWithLiterals = SourceType | 'UNKNOWN_SOURCE_TYPE' | 'WIX_APP' | 'EXTERNAL' | 'ADMIN' | 'OTHER';
6000
6112
  export interface LineItemMetaData {
6001
6113
  metadata?: Record<string, string>;
6002
6114
  }
@@ -6095,7 +6207,7 @@ export interface CustomFieldValue {
6095
6207
  /** The optional namespace of the custom field value. This field may be used to indicate intended usage or source. */
6096
6208
  namespace?: string | null;
6097
6209
  /** The group of the custom field indicates its intended placement in the financial document */
6098
- group?: CustomFieldGroup;
6210
+ group?: CustomFieldGroupWithLiterals;
6099
6211
  /** The value of the custom field */
6100
6212
  value?: Value;
6101
6213
  /**
@@ -6112,9 +6224,11 @@ export declare enum CustomFieldGroup {
6112
6224
  FOOTER = "FOOTER",
6113
6225
  OTHER = "OTHER"
6114
6226
  }
6227
+ /** @enumType */
6228
+ export type CustomFieldGroupWithLiterals = CustomFieldGroup | 'UNKNOWN_CUSTOM_FIELD_GROUP' | 'BUSINESS_DETAILS' | 'CUSTOMER_DETAILS' | 'DOCUMENT' | 'FOOTER' | 'OTHER';
6115
6229
  export interface Value {
6116
6230
  value?: string;
6117
- valueType?: ValueType;
6231
+ valueType?: ValueTypeWithLiterals;
6118
6232
  }
6119
6233
  export declare enum ValueType {
6120
6234
  UNKNOWN_VALUE_TYPE = "UNKNOWN_VALUE_TYPE",
@@ -6123,6 +6237,8 @@ export declare enum ValueType {
6123
6237
  BOOLEAN = "BOOLEAN",
6124
6238
  NUMBER = "NUMBER"
6125
6239
  }
6240
+ /** @enumType */
6241
+ export type ValueTypeWithLiterals = ValueType | 'UNKNOWN_VALUE_TYPE' | 'STRING' | 'DATE' | 'BOOLEAN' | 'NUMBER';
6126
6242
  export interface Deposit {
6127
6243
  /**
6128
6244
  * The flat amount of the deposit. The flat amount of the deposit must be less than the invoice total.
@@ -6139,13 +6255,15 @@ export interface Deposit {
6139
6255
  */
6140
6256
  percentage?: string;
6141
6257
  /** The type of the deposit. The default is FLAT. */
6142
- type?: DepositType;
6258
+ type?: DepositTypeWithLiterals;
6143
6259
  }
6144
6260
  export declare enum DepositType {
6145
6261
  UNKNOWN = "UNKNOWN",
6146
6262
  FLAT = "FLAT",
6147
6263
  PERCENTAGE = "PERCENTAGE"
6148
6264
  }
6265
+ /** @enumType */
6266
+ export type DepositTypeWithLiterals = DepositType | 'UNKNOWN' | 'FLAT' | 'PERCENTAGE';
6149
6267
  /**
6150
6268
  * InvoiceStatus allowed transitions based on current status:
6151
6269
  * Draft -> Deleted, Paid, Partially Paid, Sent
@@ -6167,6 +6285,8 @@ export declare enum InvoiceStatus {
6167
6285
  PartiallyPaid = "PartiallyPaid",
6168
6286
  PartialAndOverdue = "PartialAndOverdue"
6169
6287
  }
6288
+ /** @enumType */
6289
+ export type InvoiceStatusWithLiterals = InvoiceStatus | 'Draft' | 'Sent' | 'Processing' | 'Paid' | 'Overdue' | 'Void' | 'Deleted' | 'PartiallyPaid' | 'PartialAndOverdue';
6170
6290
  export interface TriggerSideEffectsFromLegacyData {
6171
6291
  storeId?: string;
6172
6292
  orderId?: string;
@@ -6509,7 +6629,9 @@ export declare function getOrder(_id: string): Promise<NonNullablePaths<Order, O
6509
6629
  * To learn about working with _Search_ endpoints, see
6510
6630
  * [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language), and
6511
6631
  * [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
6632
+ * @param search - Search options.
6512
6633
  * @public
6634
+ * @requiredField search
6513
6635
  * @permissionId ECOM.READ_ORDERS
6514
6636
  * @permissionScope Manage Stores - all permissions
6515
6637
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
@@ -6530,13 +6652,171 @@ export declare function getOrder(_id: string): Promise<NonNullablePaths<Order, O
6530
6652
  * @applicableIdentity APP
6531
6653
  * @fqn com.wix.ecom.orders.v1.Orders.SearchOrders
6532
6654
  */
6533
- export declare function searchOrders(options?: SearchOrdersOptions): Promise<NonNullablePaths<SearchOrdersResponse, {
6655
+ export declare function searchOrders(search: OrderSearch): Promise<NonNullablePaths<SearchOrdersResponse, {
6534
6656
  [P in OrderNonNullablePaths]: `orders.${number}.${P}`;
6535
6657
  }[OrderNonNullablePaths]>>;
6536
- export interface SearchOrdersOptions {
6537
- /** Search options. */
6538
- search?: CursorSearch;
6539
- }
6658
+ export interface OrderSearchSpec extends SearchSpec {
6659
+ aggregatable: [
6660
+ '_createdDate',
6661
+ '_id',
6662
+ '_updatedDate',
6663
+ 'archived',
6664
+ 'balanceSummary.authorized.amount',
6665
+ 'balanceSummary.pending.amount',
6666
+ 'balanceSummary.pendingRefund.amount',
6667
+ 'businessLocation._id',
6668
+ 'businessLocation.name',
6669
+ 'buyerInfo.contactId',
6670
+ 'buyerInfo.memberId',
6671
+ 'channelInfo.externalOrderId',
6672
+ 'channelInfo.type',
6673
+ 'checkoutId',
6674
+ 'createdBy.userId',
6675
+ 'fulfillmentStatus',
6676
+ 'fulfillmentStatusesAggregate.statuses',
6677
+ 'lineItems.catalogReference.appId',
6678
+ 'lineItems.catalogReference.catalogItemId',
6679
+ 'lineItems.locations._id',
6680
+ 'lineItems.productName.original',
6681
+ 'lineItems.subscriptionInfo._id',
6682
+ 'number',
6683
+ 'paymentStatus',
6684
+ 'priceSummary.total.amount',
6685
+ 'purchasedDate',
6686
+ 'seenByAHuman',
6687
+ 'shippingInfo.logistics.deliveryTime',
6688
+ 'shippingInfo.logistics.deliveryTimeSlot.from',
6689
+ 'shippingInfo.logistics.deliveryTimeSlot.to',
6690
+ 'shippingInfo.region.name',
6691
+ 'shippingInfo.title',
6692
+ 'status'
6693
+ ];
6694
+ paging: 'cursor';
6695
+ wql: [
6696
+ {
6697
+ operators: ['$eq', '$in', '$ne', '$nin'];
6698
+ fields: [
6699
+ 'channelInfo.type',
6700
+ 'fulfillmentStatus',
6701
+ 'paymentStatus',
6702
+ 'shippingInfo.region.name',
6703
+ 'shippingInfo.title',
6704
+ 'status'
6705
+ ];
6706
+ sort: 'BOTH';
6707
+ },
6708
+ {
6709
+ operators: '*';
6710
+ fields: [
6711
+ '_createdDate',
6712
+ '_updatedDate',
6713
+ 'balanceSummary.authorized.amount',
6714
+ 'balanceSummary.pending.amount',
6715
+ 'balanceSummary.pendingRefund.amount',
6716
+ 'billingInfo.contactDetails.firstName',
6717
+ 'billingInfo.contactDetails.lastName',
6718
+ 'businessLocation._id',
6719
+ 'businessLocation.name',
6720
+ 'buyerInfo.email',
6721
+ 'number',
6722
+ 'priceSummary.total.amount',
6723
+ 'purchasedDate',
6724
+ 'shippingInfo.logistics.deliveryTime',
6725
+ 'shippingInfo.logistics.deliveryTimeSlot.from',
6726
+ 'shippingInfo.logistics.deliveryTimeSlot.to'
6727
+ ];
6728
+ sort: 'BOTH';
6729
+ },
6730
+ {
6731
+ operators: '*';
6732
+ fields: ['archived', 'seenByAHuman'];
6733
+ sort: 'NONE';
6734
+ },
6735
+ {
6736
+ operators: ['$eq', '$in', '$ne', '$nin'];
6737
+ fields: [
6738
+ '_id',
6739
+ 'buyerInfo.contactId',
6740
+ 'buyerInfo.memberId',
6741
+ 'channelInfo.externalOrderId',
6742
+ 'checkoutId',
6743
+ 'createdBy.userId',
6744
+ 'lineItems.subscriptionInfo._id'
6745
+ ];
6746
+ sort: 'NONE';
6747
+ },
6748
+ {
6749
+ operators: ['$all', '$any'];
6750
+ fields: [
6751
+ 'lineItems.catalogReference.appId',
6752
+ 'lineItems.catalogReference.catalogItemId',
6753
+ 'lineItems.locations._id'
6754
+ ];
6755
+ sort: 'NONE';
6756
+ },
6757
+ {
6758
+ operators: ['$all', '$any'];
6759
+ fields: [
6760
+ 'fulfillmentStatusesAggregate.statuses',
6761
+ 'lineItems.productName.original'
6762
+ ];
6763
+ sort: 'BOTH';
6764
+ }
6765
+ ];
6766
+ }
6767
+ export type CommonSearchWithEntityContext = SearchSdkType<Order, OrderSearchSpec>;
6768
+ export type OrderSearch = {
6769
+ /**
6770
+ Cursor paging options.
6771
+ Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
6772
+ */
6773
+ cursorPaging?: {
6774
+ /**
6775
+ Maximum number of items to return in the results.
6776
+ @max: 100
6777
+ */
6778
+ limit?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['limit'] | null;
6779
+ /**
6780
+ Pointer to the next or previous page in the list of results.
6781
+
6782
+ Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
6783
+ Not relevant for the first request.
6784
+ @maxLength: 16000
6785
+ */
6786
+ cursor?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['cursor'] | null;
6787
+ };
6788
+ /**
6789
+ Filter object.
6790
+
6791
+ For example, the following `filter` object will only return orders with payment statuses of paid and/or partially paid:
6792
+
6793
+ `"filter": {"paymentStatus": {"$in": ["PAID", "PARTIALLY_PAID"]}}`
6794
+
6795
+ Learn more about the [filter format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
6796
+ */
6797
+ filter?: CommonSearchWithEntityContext['filter'] | null;
6798
+ /**
6799
+ Array of sort objects that specify the order in which results should be sorted.
6800
+
6801
+ For example, the following `sort` array will sort by `createdDate` in descending order:
6802
+
6803
+ `"sort": [{"fieldName": "createdDate", "order":"DESC"}]`.
6804
+
6805
+ Learn more about the [sort format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
6806
+ @maxSize: 4
6807
+ */
6808
+ sort?: {
6809
+ /**
6810
+ Name of the field to sort by.
6811
+ @maxLength: 512
6812
+ */
6813
+ fieldName?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['fieldName'];
6814
+ /**
6815
+ Sort order.
6816
+ */
6817
+ order?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['order'];
6818
+ }[];
6819
+ };
6540
6820
  /**
6541
6821
  * Creates an order.
6542
6822
  *
@@ -6663,19 +6943,19 @@ export interface UpdateOrder {
6663
6943
  /** Buyer information. */
6664
6944
  buyerInfo?: BuyerInfo;
6665
6945
  /** Order payment status. */
6666
- paymentStatus?: PaymentStatus;
6946
+ paymentStatus?: PaymentStatusWithLiterals;
6667
6947
  /**
6668
6948
  * Order fulfillment status.
6669
6949
  * @readonly
6670
6950
  */
6671
- fulfillmentStatus?: FulfillmentStatus;
6951
+ fulfillmentStatus?: FulfillmentStatusWithLiterals;
6672
6952
  /**
6673
6953
  * Language for communication with the buyer. Defaults to the site language.
6674
6954
  * For a site that supports multiple languages, this is the language the buyer selected.
6675
6955
  */
6676
6956
  buyerLanguage?: string | null;
6677
6957
  /** Weight measurement unit - defaults to site's weight unit. */
6678
- weightUnit?: WeightUnit;
6958
+ weightUnit?: WeightUnitWithLiterals;
6679
6959
  /**
6680
6960
  * 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.
6681
6961
  * @format CURRENCY
@@ -6709,7 +6989,7 @@ export interface UpdateOrder {
6709
6989
  */
6710
6990
  buyerNote?: string | null;
6711
6991
  /** Order status. */
6712
- status?: OrderStatus;
6992
+ status?: OrderStatusWithLiterals;
6713
6993
  /** Whether order is archived. */
6714
6994
  archived?: boolean | null;
6715
6995
  /**
@@ -6737,7 +7017,7 @@ export interface UpdateOrder {
6737
7017
  */
6738
7018
  activities?: Activity[];
6739
7019
  /** Order attribution source. */
6740
- attributionSource?: AttributionSource;
7020
+ attributionSource?: AttributionSourceWithLiterals;
6741
7021
  /**
6742
7022
  * ID of the order's initiator.
6743
7023
  * @readonly
@@ -6965,7 +7245,7 @@ export interface UpdateOrderLineItem {
6965
7245
  *
6966
7246
  * Default: `FULL_PAYMENT_ONLINE`
6967
7247
  */
6968
- paymentOption?: PaymentOptionType;
7248
+ paymentOption?: PaymentOptionTypeWithLiterals;
6969
7249
  /**
6970
7250
  * Deprecated. Use `taxInfo` instead.
6971
7251
  * This field will be removed on September 30, 2024.