@wix/auto_sdk_ecom_checkout-templates 1.0.35 → 1.0.37

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 (134) hide show
  1. package/build/{cjs/src/ecom-v1-checkout-template-checkout-templates.types.d.ts → ecom-v1-checkout-template-checkout-templates.universal-DZSQyXAS.d.mts} +418 -278
  2. package/build/{internal/cjs/src/ecom-v1-checkout-template-checkout-templates.types.d.ts → ecom-v1-checkout-template-checkout-templates.universal-DZSQyXAS.d.ts} +418 -278
  3. package/build/index.d.mts +136 -0
  4. package/build/index.d.ts +136 -0
  5. package/build/index.js +1209 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +1149 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/internal/{cjs/src/ecom-v1-checkout-template-checkout-templates.universal.d.ts → ecom-v1-checkout-template-checkout-templates.universal-DQx0Jt-F.d.mts} +213 -457
  10. package/build/internal/{es/src/ecom-v1-checkout-template-checkout-templates.universal.d.ts → ecom-v1-checkout-template-checkout-templates.universal-DQx0Jt-F.d.ts} +213 -457
  11. package/build/internal/index.d.mts +136 -0
  12. package/build/internal/index.d.ts +136 -0
  13. package/build/internal/index.js +1209 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +1149 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +810 -0
  18. package/build/internal/meta.d.ts +810 -0
  19. package/build/internal/meta.js +491 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +458 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +810 -0
  24. package/build/meta.d.ts +810 -0
  25. package/build/meta.js +491 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +458 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +12 -11
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.context.d.ts +0 -32
  40. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.context.js +0 -61
  41. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.context.js.map +0 -1
  42. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.http.d.ts +0 -68
  43. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.http.js +0 -390
  44. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.http.js.map +0 -1
  45. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.meta.d.ts +0 -29
  46. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.meta.js +0 -161
  47. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.meta.js.map +0 -1
  48. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.public.d.ts +0 -112
  49. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.public.js +0 -271
  50. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.public.js.map +0 -1
  51. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.types.js +0 -261
  52. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.types.js.map +0 -1
  53. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.universal.d.ts +0 -3145
  54. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.universal.js +0 -730
  55. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/package.json +0 -3
  66. package/build/es/src/ecom-v1-checkout-template-checkout-templates.context.d.ts +0 -32
  67. package/build/es/src/ecom-v1-checkout-template-checkout-templates.context.js +0 -32
  68. package/build/es/src/ecom-v1-checkout-template-checkout-templates.context.js.map +0 -1
  69. package/build/es/src/ecom-v1-checkout-template-checkout-templates.http.d.ts +0 -68
  70. package/build/es/src/ecom-v1-checkout-template-checkout-templates.http.js +0 -380
  71. package/build/es/src/ecom-v1-checkout-template-checkout-templates.http.js.map +0 -1
  72. package/build/es/src/ecom-v1-checkout-template-checkout-templates.meta.d.ts +0 -29
  73. package/build/es/src/ecom-v1-checkout-template-checkout-templates.meta.js +0 -128
  74. package/build/es/src/ecom-v1-checkout-template-checkout-templates.meta.js.map +0 -1
  75. package/build/es/src/ecom-v1-checkout-template-checkout-templates.public.d.ts +0 -112
  76. package/build/es/src/ecom-v1-checkout-template-checkout-templates.public.js +0 -235
  77. package/build/es/src/ecom-v1-checkout-template-checkout-templates.public.js.map +0 -1
  78. package/build/es/src/ecom-v1-checkout-template-checkout-templates.types.d.ts +0 -2778
  79. package/build/es/src/ecom-v1-checkout-template-checkout-templates.types.js +0 -258
  80. package/build/es/src/ecom-v1-checkout-template-checkout-templates.types.js.map +0 -1
  81. package/build/es/src/ecom-v1-checkout-template-checkout-templates.universal.d.ts +0 -3145
  82. package/build/es/src/ecom-v1-checkout-template-checkout-templates.universal.js +0 -697
  83. package/build/es/src/ecom-v1-checkout-template-checkout-templates.universal.js.map +0 -1
  84. package/build/internal/cjs/index.d.ts +0 -1
  85. package/build/internal/cjs/index.js +0 -18
  86. package/build/internal/cjs/index.js.map +0 -1
  87. package/build/internal/cjs/index.typings.d.ts +0 -1
  88. package/build/internal/cjs/index.typings.js +0 -18
  89. package/build/internal/cjs/index.typings.js.map +0 -1
  90. package/build/internal/cjs/meta.d.ts +0 -1
  91. package/build/internal/cjs/meta.js +0 -18
  92. package/build/internal/cjs/meta.js.map +0 -1
  93. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.context.d.ts +0 -32
  94. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.context.js +0 -61
  95. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.context.js.map +0 -1
  96. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.http.d.ts +0 -68
  97. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.http.js +0 -390
  98. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.http.js.map +0 -1
  99. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.meta.d.ts +0 -29
  100. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.meta.js +0 -161
  101. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.meta.js.map +0 -1
  102. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.public.d.ts +0 -112
  103. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.public.js +0 -271
  104. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.public.js.map +0 -1
  105. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.types.js +0 -261
  106. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.types.js.map +0 -1
  107. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.universal.js +0 -730
  108. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.universal.js.map +0 -1
  109. package/build/internal/es/index.d.ts +0 -1
  110. package/build/internal/es/index.js +0 -2
  111. package/build/internal/es/index.js.map +0 -1
  112. package/build/internal/es/index.typings.d.ts +0 -1
  113. package/build/internal/es/index.typings.js +0 -2
  114. package/build/internal/es/index.typings.js.map +0 -1
  115. package/build/internal/es/meta.d.ts +0 -1
  116. package/build/internal/es/meta.js +0 -2
  117. package/build/internal/es/meta.js.map +0 -1
  118. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.context.d.ts +0 -32
  119. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.context.js +0 -32
  120. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.context.js.map +0 -1
  121. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.http.d.ts +0 -68
  122. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.http.js +0 -380
  123. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.http.js.map +0 -1
  124. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.meta.d.ts +0 -29
  125. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.meta.js +0 -128
  126. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.meta.js.map +0 -1
  127. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.public.d.ts +0 -112
  128. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.public.js +0 -235
  129. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.public.js.map +0 -1
  130. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.types.d.ts +0 -2778
  131. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.types.js +0 -258
  132. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.types.js.map +0 -1
  133. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.universal.js +0 -697
  134. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.universal.js.map +0 -1
@@ -1,10 +1,10 @@
1
- export interface CheckoutTemplate {
1
+ interface CheckoutTemplate {
2
2
  /**
3
3
  * Checkout template ID.
4
4
  * @format GUID
5
5
  * @readonly
6
6
  */
7
- id?: string | null;
7
+ _id?: string | null;
8
8
  /**
9
9
  * Status of the checkout template.
10
10
  *
@@ -50,14 +50,14 @@ export interface CheckoutTemplate {
50
50
  */
51
51
  externalReference?: ExternalReference;
52
52
  }
53
- export declare enum Status {
53
+ declare enum Status {
54
54
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
55
55
  ACTIVE = "ACTIVE",
56
56
  INACTIVE = "INACTIVE"
57
57
  }
58
58
  /** @enumType */
59
- export type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'ACTIVE' | 'INACTIVE';
60
- export interface CheckoutCustomization {
59
+ type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'ACTIVE' | 'INACTIVE';
60
+ interface CheckoutCustomization {
61
61
  /** Web client customizations. These customizations only apply to the standard Wix checkout page. */
62
62
  webClient?: WebClientCustomization;
63
63
  /**
@@ -79,7 +79,7 @@ export interface CheckoutCustomization {
79
79
  */
80
80
  disabledManualPayment?: boolean;
81
81
  }
82
- export interface WebClientCustomization {
82
+ interface WebClientCustomization {
83
83
  /**
84
84
  * Whether to disable the "Continue shopping" button.
85
85
  *
@@ -93,7 +93,7 @@ export interface WebClientCustomization {
93
93
  */
94
94
  disabledPolicyAgreementCheckbox?: boolean;
95
95
  }
96
- export interface V1LineItem {
96
+ interface V1LineItem {
97
97
  /**
98
98
  * Item quantity.
99
99
  *
@@ -109,7 +109,7 @@ export interface V1LineItem {
109
109
  catalogOverrideFields?: CatalogOverrideFields;
110
110
  }
111
111
  /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
112
- export interface CatalogReference {
112
+ interface CatalogReference {
113
113
  /**
114
114
  * ID of the item within the catalog it belongs to.
115
115
  * @minLength 1
@@ -135,7 +135,7 @@ export interface CatalogReference {
135
135
  */
136
136
  options?: Record<string, any> | null;
137
137
  }
138
- export interface CatalogOverrideFields {
138
+ interface CatalogOverrideFields {
139
139
  /** Item name. */
140
140
  productName?: ProductName;
141
141
  /**
@@ -156,7 +156,7 @@ export interface CatalogOverrideFields {
156
156
  /** Physical properties of the item. */
157
157
  physicalProperties?: PhysicalProperties;
158
158
  /** Item image. */
159
- image?: Image;
159
+ image?: string;
160
160
  /** Payment method selected for the item. */
161
161
  paymentOption?: PaymentOption;
162
162
  /**
@@ -172,7 +172,7 @@ export interface CatalogOverrideFields {
172
172
  */
173
173
  savePaymentMethod?: boolean | null;
174
174
  }
175
- export interface ProductName {
175
+ interface ProductName {
176
176
  /**
177
177
  * __Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
178
178
  *
@@ -193,7 +193,7 @@ export interface ProductName {
193
193
  */
194
194
  translated?: string | null;
195
195
  }
196
- export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
196
+ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
197
197
  /** Description line plain text value. */
198
198
  plainText?: PlainTextValue;
199
199
  /** Description line color value. */
@@ -202,16 +202,16 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
202
202
  name?: DescriptionLineName;
203
203
  }
204
204
  /** @oneof */
205
- export interface DescriptionLineValueOneOf {
205
+ interface DescriptionLineValueOneOf {
206
206
  /** Description line plain text value. */
207
207
  plainText?: PlainTextValue;
208
208
  /** Description line color value. */
209
209
  colorInfo?: Color;
210
210
  }
211
211
  /** @oneof */
212
- export interface DescriptionLineDescriptionLineValueOneOf {
212
+ interface DescriptionLineDescriptionLineValueOneOf {
213
213
  }
214
- export interface DescriptionLineName {
214
+ interface DescriptionLineName {
215
215
  /**
216
216
  * Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
217
217
  * @maxLength 100
@@ -225,7 +225,7 @@ export interface DescriptionLineName {
225
225
  */
226
226
  translated?: string | null;
227
227
  }
228
- export interface PlainTextValue {
228
+ interface PlainTextValue {
229
229
  /**
230
230
  * Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
231
231
  * @maxLength 600
@@ -239,7 +239,7 @@ export interface PlainTextValue {
239
239
  */
240
240
  translated?: string | null;
241
241
  }
242
- export interface Color {
242
+ interface Color {
243
243
  /**
244
244
  * Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
245
245
  * @maxLength 500
@@ -255,7 +255,7 @@ export interface Color {
255
255
  /** HEX or RGB color code for display. */
256
256
  code?: string | null;
257
257
  }
258
- export declare enum DescriptionLineType {
258
+ declare enum DescriptionLineType {
259
259
  /** Unrecognized type. */
260
260
  UNRECOGNISED = "UNRECOGNISED",
261
261
  /** Plain text type. */
@@ -263,9 +263,7 @@ export declare enum DescriptionLineType {
263
263
  /** Color type. */
264
264
  COLOR = "COLOR"
265
265
  }
266
- /** @enumType */
267
- export type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
268
- export interface PhysicalProperties {
266
+ interface PhysicalProperties {
269
267
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
270
268
  weight?: number | null;
271
269
  /**
@@ -276,19 +274,7 @@ export interface PhysicalProperties {
276
274
  /** Whether this line item is shippable. */
277
275
  shippable?: boolean;
278
276
  }
279
- export interface Image {
280
- /** WixMedia image ID. */
281
- id?: string;
282
- /** Original image height. */
283
- height?: number;
284
- /** Original image width. */
285
- width?: number;
286
- /** Image alt text. Optional. */
287
- altText?: string | null;
288
- /** Image filename. Optional. */
289
- filename?: string | null;
290
- }
291
- export interface PaymentOption {
277
+ interface PaymentOption {
292
278
  /**
293
279
  * Type of selected payment option for current item.
294
280
  *
@@ -297,7 +283,7 @@ export interface PaymentOption {
297
283
  value?: PaymentOptionTypeWithLiterals;
298
284
  }
299
285
  /** Type of selected payment option for catalog item */
300
- export declare enum PaymentOptionType {
286
+ declare enum PaymentOptionType {
301
287
  /** The entire payment for this item happens as part of the checkout. */
302
288
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
303
289
  /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
@@ -310,8 +296,8 @@ export declare enum PaymentOptionType {
310
296
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
311
297
  }
312
298
  /** @enumType */
313
- export type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
314
- export interface CustomLineItem {
299
+ type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
300
+ interface CustomLineItem {
315
301
  /**
316
302
  * Custom line item quantity.
317
303
  *
@@ -337,14 +323,14 @@ export interface CustomLineItem {
337
323
  */
338
324
  descriptionLines?: DescriptionLine[];
339
325
  /** Custom line item's media. */
340
- media?: Image;
326
+ media?: string;
341
327
  /**
342
328
  * Custom line item ID. If passed, `id` must be unique.
343
329
  *
344
330
  * Default: auto-generated ID
345
331
  * @format GUID
346
332
  */
347
- id?: string | null;
333
+ _id?: string | null;
348
334
  /**
349
335
  * Tax group ID for this custom line item.
350
336
  * @format GUID
@@ -353,7 +339,7 @@ export interface CustomLineItem {
353
339
  /** Name of the item or product. */
354
340
  productName?: ProductName;
355
341
  /** URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work. */
356
- url?: PageUrlV2;
342
+ url?: string;
357
343
  /** Item type. Either a preset type or custom. */
358
344
  itemType?: ItemType;
359
345
  /**
@@ -435,8 +421,13 @@ export interface CustomLineItem {
435
421
  membersOnly?: boolean;
436
422
  /** Address to use for tax calculation purposes. */
437
423
  taxableAddress?: TaxableAddress;
424
+ /**
425
+ * Modifier groups that were added to the item.
426
+ * @maxSize 25
427
+ */
428
+ modifierGroups?: V1ModifierGroup[];
438
429
  }
439
- export interface PriceDescription {
430
+ interface PriceDescription {
440
431
  /**
441
432
  * __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
442
433
  * @minLength 1
@@ -452,26 +443,20 @@ export interface PriceDescription {
452
443
  */
453
444
  translated?: string | null;
454
445
  }
455
- export interface PageUrlV2 {
456
- /** The relative path for the page within the site. For example, `/product-page/a-product`. */
457
- relativePath?: string;
458
- /** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
459
- url?: string | null;
460
- }
461
- export interface ItemType extends ItemTypeItemTypeDataOneOf {
446
+ interface ItemType extends ItemTypeItemTypeDataOneOf {
462
447
  /** Preset item type. */
463
448
  preset?: ItemTypeItemTypeWithLiterals;
464
449
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
465
450
  custom?: string;
466
451
  }
467
452
  /** @oneof */
468
- export interface ItemTypeItemTypeDataOneOf {
453
+ interface ItemTypeItemTypeDataOneOf {
469
454
  /** Preset item type. */
470
455
  preset?: ItemTypeItemTypeWithLiterals;
471
456
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
472
457
  custom?: string;
473
458
  }
474
- export declare enum ItemTypeItemType {
459
+ declare enum ItemTypeItemType {
475
460
  UNRECOGNISED = "UNRECOGNISED",
476
461
  PHYSICAL = "PHYSICAL",
477
462
  DIGITAL = "DIGITAL",
@@ -479,8 +464,8 @@ export declare enum ItemTypeItemType {
479
464
  SERVICE = "SERVICE"
480
465
  }
481
466
  /** @enumType */
482
- export type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
483
- export interface SubscriptionOptionInfo {
467
+ type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
468
+ interface SubscriptionOptionInfo {
484
469
  /** Subscription option settings. */
485
470
  subscriptionSettings?: SubscriptionSettings;
486
471
  /** Subscription option title. */
@@ -488,7 +473,7 @@ export interface SubscriptionOptionInfo {
488
473
  /** Subscription option description. */
489
474
  description?: Description;
490
475
  }
491
- export interface SubscriptionSettings {
476
+ interface SubscriptionSettings {
492
477
  /** Frequency of recurring payment. */
493
478
  frequency?: SubscriptionFrequencyWithLiterals;
494
479
  /**
@@ -516,7 +501,7 @@ export interface SubscriptionSettings {
516
501
  freeTrialPeriod?: FreeTrialPeriod;
517
502
  }
518
503
  /** Frequency unit of recurring payment */
519
- export declare enum SubscriptionFrequency {
504
+ declare enum SubscriptionFrequency {
520
505
  UNDEFINED = "UNDEFINED",
521
506
  DAY = "DAY",
522
507
  WEEK = "WEEK",
@@ -524,8 +509,8 @@ export declare enum SubscriptionFrequency {
524
509
  YEAR = "YEAR"
525
510
  }
526
511
  /** @enumType */
527
- export type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
528
- export interface FreeTrialPeriod {
512
+ type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
513
+ interface FreeTrialPeriod {
529
514
  /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
530
515
  frequency?: SubscriptionFrequencyWithLiterals;
531
516
  /**
@@ -535,7 +520,7 @@ export interface FreeTrialPeriod {
535
520
  */
536
521
  interval?: number;
537
522
  }
538
- export interface Title {
523
+ interface Title {
539
524
  /**
540
525
  * Subscription option name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
541
526
  * @minLength 1
@@ -551,7 +536,7 @@ export interface Title {
551
536
  */
552
537
  translated?: string | null;
553
538
  }
554
- export interface Description {
539
+ interface Description {
555
540
  /**
556
541
  * Subscription option description.
557
542
  * @maxLength 500
@@ -563,13 +548,13 @@ export interface Description {
563
548
  */
564
549
  translated?: string | null;
565
550
  }
566
- export interface SecuredMedia {
551
+ interface SecuredMedia {
567
552
  /**
568
553
  * Media ID in Wix Media Manager.
569
554
  * @minLength 1
570
555
  * @maxLength 100
571
556
  */
572
- id?: string;
557
+ _id?: string;
573
558
  /**
574
559
  * Original filename.
575
560
  * @minLength 1
@@ -579,7 +564,7 @@ export interface SecuredMedia {
579
564
  /** File type. */
580
565
  fileType?: FileTypeWithLiterals;
581
566
  }
582
- export declare enum FileType {
567
+ declare enum FileType {
583
568
  UNSPECIFIED = "UNSPECIFIED",
584
569
  SECURE_PICTURE = "SECURE_PICTURE",
585
570
  SECURE_VIDEO = "SECURE_VIDEO",
@@ -588,8 +573,8 @@ export declare enum FileType {
588
573
  SECURE_ARCHIVE = "SECURE_ARCHIVE"
589
574
  }
590
575
  /** @enumType */
591
- export type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
592
- export interface ServiceProperties {
576
+ type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
577
+ interface ServiceProperties {
593
578
  /**
594
579
  * Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
595
580
  * For example, the start time of a class.
@@ -602,7 +587,7 @@ export interface ServiceProperties {
602
587
  */
603
588
  numberOfParticipants?: number | null;
604
589
  }
605
- export interface Policy {
590
+ interface Policy {
606
591
  /**
607
592
  * Policy title - should be translated
608
593
  * @minLength 1
@@ -616,40 +601,40 @@ export interface Policy {
616
601
  */
617
602
  content?: string;
618
603
  }
619
- export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
604
+ interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
620
605
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
621
606
  addressType?: TaxableAddressTypeWithLiterals;
622
607
  }
623
608
  /** @oneof */
624
- export interface TaxableAddressTaxableAddressDataOneOf {
609
+ interface TaxableAddressTaxableAddressDataOneOf {
625
610
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
626
611
  addressType?: TaxableAddressTypeWithLiterals;
627
612
  }
628
- export declare enum TaxableAddressType {
613
+ declare enum TaxableAddressType {
629
614
  UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
630
615
  BUSINESS = "BUSINESS",
631
616
  BILLING = "BILLING",
632
617
  SHIPPING = "SHIPPING"
633
618
  }
634
619
  /** @enumType */
635
- export type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
636
- export interface V1ModifierGroup {
620
+ type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
621
+ interface V1ModifierGroup {
637
622
  /**
638
623
  * Modifier group id.
639
624
  * @minLength 1
640
625
  * @maxLength 36
641
626
  */
642
- id?: string;
627
+ _id?: string;
643
628
  /** Modifier group name. */
644
629
  name?: TranslatableString;
645
630
  /**
646
631
  * List of modifiers in this group.
647
632
  * @minSize 1
648
- * @maxSize 10
633
+ * @maxSize 25
649
634
  */
650
635
  modifiers?: V1ItemModifier[];
651
636
  }
652
- export interface TranslatableString {
637
+ interface TranslatableString {
653
638
  /**
654
639
  * __Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
655
640
  *
@@ -670,13 +655,13 @@ export interface TranslatableString {
670
655
  */
671
656
  translated?: string | null;
672
657
  }
673
- export interface V1ItemModifier {
658
+ interface V1ItemModifier {
674
659
  /**
675
660
  * Modifier ID.
676
661
  * @minLength 1
677
662
  * @maxLength 36
678
663
  */
679
- id?: string;
664
+ _id?: string;
680
665
  /**
681
666
  * The quantity of this modifier.
682
667
  * @min 1
@@ -693,7 +678,7 @@ export interface V1ItemModifier {
693
678
  */
694
679
  price?: string | null;
695
680
  }
696
- export interface ExtendedFields {
681
+ interface ExtendedFields {
697
682
  /**
698
683
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
699
684
  * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -704,7 +689,7 @@ export interface ExtendedFields {
704
689
  */
705
690
  namespaces?: Record<string, Record<string, any>>;
706
691
  }
707
- export interface CustomContentReference {
692
+ interface CustomContentReference {
708
693
  /**
709
694
  * ID of the app providing the content.
710
695
  *
@@ -720,7 +705,7 @@ export interface CustomContentReference {
720
705
  */
721
706
  componentId?: string;
722
707
  }
723
- export interface ExternalReference {
708
+ interface ExternalReference {
724
709
  /**
725
710
  * ID of the app associated with the purchase flow.
726
711
  * For example, the Wix Pay Links app ID.
@@ -738,19 +723,19 @@ export interface ExternalReference {
738
723
  resourceId?: string | null;
739
724
  }
740
725
  /** Triggered when newly checkout created successfully from checkout template */
741
- export interface CheckoutTemplateUsed {
726
+ interface CheckoutTemplateUsed {
742
727
  /** checkout template */
743
728
  checkoutTemplate?: CheckoutTemplate;
744
729
  /** newly created checkout */
745
730
  checkout?: Checkout;
746
731
  }
747
- export interface Checkout {
732
+ interface Checkout {
748
733
  /**
749
734
  * Checkout ID.
750
735
  * @format GUID
751
736
  * @readonly
752
737
  */
753
- id?: string | null;
738
+ _id?: string | null;
754
739
  /**
755
740
  * Line items.
756
741
  *
@@ -855,12 +840,12 @@ export interface Checkout {
855
840
  * Date and time the checkout was created.
856
841
  * @readonly
857
842
  */
858
- createdDate?: Date | null;
843
+ _createdDate?: Date | null;
859
844
  /**
860
845
  * Date and time the checkout was updated.
861
846
  * @readonly
862
847
  */
863
- updatedDate?: Date | null;
848
+ _updatedDate?: Date | null;
864
849
  /**
865
850
  * Minimal amount to pay in order to place the order.
866
851
  * @readonly
@@ -941,13 +926,13 @@ export interface Checkout {
941
926
  */
942
927
  paymentCurrency?: string;
943
928
  }
944
- export interface LineItem {
929
+ interface LineItem {
945
930
  /**
946
931
  * Line item ID.
947
932
  * @format GUID
948
933
  * @readonly
949
934
  */
950
- id?: string | null;
935
+ _id?: string | null;
951
936
  /**
952
937
  * Item quantity.
953
938
  *
@@ -971,7 +956,7 @@ export interface LineItem {
971
956
  * URL to the item's page on the site.
972
957
  * @readonly
973
958
  */
974
- url?: PageUrlV2;
959
+ url?: string;
975
960
  /**
976
961
  * Item price **after** catalog-defined discount and line item discounts.
977
962
  * @readonly
@@ -1021,7 +1006,7 @@ export interface LineItem {
1021
1006
  * Line item image details.
1022
1007
  * @readonly
1023
1008
  */
1024
- media?: CommonImage;
1009
+ media?: string;
1025
1010
  /**
1026
1011
  * Item availability details.
1027
1012
  * @readonly
@@ -1131,8 +1116,19 @@ export interface LineItem {
1131
1116
  * @readonly
1132
1117
  */
1133
1118
  membersOnly?: boolean;
1119
+ /**
1120
+ * Modifier groups that were added to the item.
1121
+ * @readonly
1122
+ * @maxSize 25
1123
+ */
1124
+ modifierGroups?: ModifierGroup[];
1125
+ /**
1126
+ * Total price of all item modifiers. Included in the item price.
1127
+ * @readonly
1128
+ */
1129
+ modifiersTotalPrice?: MultiCurrencyPrice;
1134
1130
  }
1135
- export interface MultiCurrencyPrice {
1131
+ interface MultiCurrencyPrice {
1136
1132
  /**
1137
1133
  * Amount.
1138
1134
  * @decimalValue options { gte:0, lte:1000000000000000 }
@@ -1155,7 +1151,7 @@ export interface MultiCurrencyPrice {
1155
1151
  */
1156
1152
  formattedConvertedAmount?: string;
1157
1153
  }
1158
- export interface ItemTaxFullDetails {
1154
+ interface ItemTaxFullDetails {
1159
1155
  /** Amount for which tax is calculated. */
1160
1156
  taxableAmount?: MultiCurrencyPrice;
1161
1157
  /**
@@ -1172,7 +1168,7 @@ export interface ItemTaxFullDetails {
1172
1168
  */
1173
1169
  rateBreakdown?: TaxRateBreakdown[];
1174
1170
  }
1175
- export interface TaxRateBreakdown {
1171
+ interface TaxRateBreakdown {
1176
1172
  /**
1177
1173
  * Name of tax against which the calculation was performed.
1178
1174
  * @maxLength 100
@@ -1190,7 +1186,7 @@ export interface TaxRateBreakdown {
1190
1186
  * TaxBreakdown represents tax information for a line item.
1191
1187
  * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
1192
1188
  */
1193
- export interface TaxBreakdown {
1189
+ interface TaxBreakdown {
1194
1190
  /**
1195
1191
  * The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
1196
1192
  * @maxLength 200
@@ -1222,7 +1218,7 @@ export interface TaxBreakdown {
1222
1218
  jurisdictionType?: JurisdictionTypeWithLiterals;
1223
1219
  }
1224
1220
  /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
1225
- export declare enum JurisdictionType {
1221
+ declare enum JurisdictionType {
1226
1222
  UNDEFINED = "UNDEFINED",
1227
1223
  COUNTRY = "COUNTRY",
1228
1224
  STATE = "STATE",
@@ -1231,31 +1227,8 @@ export declare enum JurisdictionType {
1231
1227
  SPECIAL = "SPECIAL"
1232
1228
  }
1233
1229
  /** @enumType */
1234
- export type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
1235
- export interface CommonImage {
1236
- /** WixMedia image ID. */
1237
- id?: string;
1238
- /** Image URL. */
1239
- url?: string;
1240
- /**
1241
- * Original image height.
1242
- * @readonly
1243
- */
1244
- height?: number;
1245
- /**
1246
- * Original image width.
1247
- * @readonly
1248
- */
1249
- width?: number;
1250
- /** Image alt text. */
1251
- altText?: string | null;
1252
- /**
1253
- * Image filename.
1254
- * @readonly
1255
- */
1256
- filename?: string | null;
1257
- }
1258
- export interface FocalPoint {
1230
+ type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
1231
+ interface FocalPoint {
1259
1232
  /** X-coordinate of the focal point. */
1260
1233
  x?: number;
1261
1234
  /** Y-coordinate of the focal point. */
@@ -1265,13 +1238,13 @@ export interface FocalPoint {
1265
1238
  /** crop by width */
1266
1239
  width?: number | null;
1267
1240
  }
1268
- export interface ItemAvailabilityInfo {
1241
+ interface ItemAvailabilityInfo {
1269
1242
  /** Item availability status. */
1270
1243
  status?: ItemAvailabilityStatusWithLiterals;
1271
1244
  /** Quantity available. */
1272
1245
  quantityAvailable?: number | null;
1273
1246
  }
1274
- export declare enum ItemAvailabilityStatus {
1247
+ declare enum ItemAvailabilityStatus {
1275
1248
  AVAILABLE = "AVAILABLE",
1276
1249
  /** Item does not exist. */
1277
1250
  NOT_FOUND = "NOT_FOUND",
@@ -1281,42 +1254,42 @@ export declare enum ItemAvailabilityStatus {
1281
1254
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
1282
1255
  }
1283
1256
  /** @enumType */
1284
- export type ItemAvailabilityStatusWithLiterals = ItemAvailabilityStatus | 'AVAILABLE' | 'NOT_FOUND' | 'NOT_AVAILABLE' | 'PARTIALLY_AVAILABLE';
1285
- export interface Scope {
1257
+ type ItemAvailabilityStatusWithLiterals = ItemAvailabilityStatus | 'AVAILABLE' | 'NOT_FOUND' | 'NOT_AVAILABLE' | 'PARTIALLY_AVAILABLE';
1258
+ interface Scope {
1286
1259
  /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
1287
1260
  namespace?: string;
1288
1261
  /** Coupon scope's applied group (e.g., event or ticket in Wix Events) */
1289
1262
  group?: Group;
1290
1263
  }
1291
- export interface Group {
1264
+ interface Group {
1292
1265
  /** Coupon scope's group (e.g., product or collection in Wix Stores). See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */
1293
1266
  name?: string;
1294
1267
  /** Item ID (when the coupon scope is limited to just one item). */
1295
1268
  entityId?: string | null;
1296
1269
  }
1297
- export interface ModifierGroup {
1270
+ interface ModifierGroup {
1298
1271
  /**
1299
1272
  * Modifier group id.
1300
1273
  * @minLength 1
1301
1274
  * @maxLength 36
1302
1275
  */
1303
- id?: string;
1276
+ _id?: string;
1304
1277
  /** Modifier group name. */
1305
1278
  name?: TranslatableString;
1306
1279
  /**
1307
1280
  * List of modifiers in this group.
1308
1281
  * @minSize 1
1309
- * @maxSize 10
1282
+ * @maxSize 25
1310
1283
  */
1311
1284
  modifiers?: ItemModifier[];
1312
1285
  }
1313
- export interface ItemModifier {
1286
+ interface ItemModifier {
1314
1287
  /**
1315
1288
  * Modifier ID.
1316
1289
  * @minLength 1
1317
1290
  * @maxLength 36
1318
1291
  */
1319
- id?: string;
1292
+ _id?: string;
1320
1293
  /**
1321
1294
  * The quantity of this modifier.
1322
1295
  * @min 1
@@ -1331,14 +1304,14 @@ export interface ItemModifier {
1331
1304
  price?: MultiCurrencyPrice;
1332
1305
  }
1333
1306
  /** Billing Info and shipping details */
1334
- export interface AddressWithContact {
1307
+ interface AddressWithContact {
1335
1308
  /** Address. */
1336
1309
  address?: Address;
1337
1310
  /** Contact details. */
1338
1311
  contactDetails?: FullAddressContactDetails;
1339
1312
  }
1340
1313
  /** Physical address */
1341
- export interface Address {
1314
+ interface Address {
1342
1315
  /**
1343
1316
  * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
1344
1317
  * @format COUNTRY
@@ -1365,7 +1338,7 @@ export interface Address {
1365
1338
  * Main address line (usually street name and number).
1366
1339
  * @maxLength 150
1367
1340
  */
1368
- addressLine?: string | null;
1341
+ addressLine1?: string | null;
1369
1342
  /**
1370
1343
  * Free text providing more detailed address info. Usually contains apt, suite, floor.
1371
1344
  * @maxLength 100
@@ -1382,20 +1355,20 @@ export interface Address {
1382
1355
  */
1383
1356
  subdivisionFullname?: string | null;
1384
1357
  }
1385
- export interface StreetAddress {
1358
+ interface StreetAddress {
1386
1359
  /** Street number. */
1387
1360
  number?: string;
1388
1361
  /** Street name. */
1389
1362
  name?: string;
1390
1363
  }
1391
- export interface AddressLocation {
1364
+ interface AddressLocation {
1392
1365
  /** Address latitude. */
1393
1366
  latitude?: number | null;
1394
1367
  /** Address longitude. */
1395
1368
  longitude?: number | null;
1396
1369
  }
1397
1370
  /** Full contact details for an address */
1398
- export interface FullAddressContactDetails {
1371
+ interface FullAddressContactDetails {
1399
1372
  /**
1400
1373
  * First name.
1401
1374
  * @maxLength 100
@@ -1419,9 +1392,9 @@ export interface FullAddressContactDetails {
1419
1392
  /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
1420
1393
  vatId?: VatId;
1421
1394
  }
1422
- export interface VatId {
1395
+ interface VatId {
1423
1396
  /** Customer's tax ID. */
1424
- id?: string;
1397
+ _id?: string;
1425
1398
  /**
1426
1399
  * Tax type.
1427
1400
  *
@@ -1432,7 +1405,7 @@ export interface VatId {
1432
1405
  type?: VatTypeWithLiterals;
1433
1406
  }
1434
1407
  /** tax info types */
1435
- export declare enum VatType {
1408
+ declare enum VatType {
1436
1409
  UNSPECIFIED = "UNSPECIFIED",
1437
1410
  /** CPF - for individual tax payers. */
1438
1411
  CPF = "CPF",
@@ -1440,8 +1413,8 @@ export declare enum VatType {
1440
1413
  CNPJ = "CNPJ"
1441
1414
  }
1442
1415
  /** @enumType */
1443
- export type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
1444
- export interface ShippingInfo {
1416
+ type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
1417
+ interface ShippingInfo {
1445
1418
  /** Shipping address and contact details. */
1446
1419
  shippingDestination?: AddressWithContact;
1447
1420
  /** Selected option out of the options allowed for the `region`. */
@@ -1457,7 +1430,7 @@ export interface ShippingInfo {
1457
1430
  */
1458
1431
  carrierServiceOptions?: CarrierServiceOption[];
1459
1432
  }
1460
- export interface SelectedCarrierServiceOption {
1433
+ interface SelectedCarrierServiceOption {
1461
1434
  /**
1462
1435
  * Unique identifier of selected option. For example, "usps_std_overnight".
1463
1436
  * @maxLength 100
@@ -1505,7 +1478,7 @@ export interface SelectedCarrierServiceOption {
1505
1478
  /** If the delivery solution is a partial and doesn't apply to all items. */
1506
1479
  partial?: boolean | null;
1507
1480
  }
1508
- export interface DeliveryLogistics {
1481
+ interface DeliveryLogistics {
1509
1482
  /**
1510
1483
  * Expected delivery time, in free text. For example, "3-5 business days".
1511
1484
  * @maxLength 500
@@ -1519,7 +1492,7 @@ export interface DeliveryLogistics {
1519
1492
  /** Pickup details. */
1520
1493
  pickupDetails?: PickupDetails;
1521
1494
  }
1522
- export interface PickupDetails {
1495
+ interface PickupDetails {
1523
1496
  /** Pickup address. */
1524
1497
  address?: Address;
1525
1498
  /**
@@ -1530,20 +1503,20 @@ export interface PickupDetails {
1530
1503
  /** Pickup method */
1531
1504
  pickupMethod?: PickupMethodWithLiterals;
1532
1505
  }
1533
- export declare enum PickupMethod {
1506
+ declare enum PickupMethod {
1534
1507
  UNKNOWN_METHOD = "UNKNOWN_METHOD",
1535
1508
  STORE_PICKUP = "STORE_PICKUP",
1536
1509
  PICKUP_POINT = "PICKUP_POINT"
1537
1510
  }
1538
1511
  /** @enumType */
1539
- export type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
1540
- export interface DeliveryTimeSlot {
1512
+ type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
1513
+ interface DeliveryTimeSlot {
1541
1514
  /** starting time of the delivery time slot */
1542
1515
  from?: Date | null;
1543
1516
  /** ending time of the delivery time slot */
1544
1517
  to?: Date | null;
1545
1518
  }
1546
- export interface SelectedCarrierServiceOptionPrices {
1519
+ interface SelectedCarrierServiceOptionPrices {
1547
1520
  /** Total shipping price, after discount and after tax. */
1548
1521
  totalPriceAfterTax?: MultiCurrencyPrice;
1549
1522
  /** Total price of shipping after discounts (when relevant), and before tax. */
@@ -1555,7 +1528,7 @@ export interface SelectedCarrierServiceOptionPrices {
1555
1528
  /** Shipping price before discount and before tax. */
1556
1529
  price?: MultiCurrencyPrice;
1557
1530
  }
1558
- export interface SelectedCarrierServiceOptionOtherCharge {
1531
+ interface SelectedCarrierServiceOptionOtherCharge {
1559
1532
  /** Type of additional cost. */
1560
1533
  type?: ChargeTypeWithLiterals;
1561
1534
  /**
@@ -1566,13 +1539,13 @@ export interface SelectedCarrierServiceOptionOtherCharge {
1566
1539
  /** Price of added charge. */
1567
1540
  cost?: SelectedCarrierServiceOptionPrices;
1568
1541
  }
1569
- export declare enum ChargeType {
1542
+ declare enum ChargeType {
1570
1543
  HANDLING_FEE = "HANDLING_FEE",
1571
1544
  INSURANCE = "INSURANCE"
1572
1545
  }
1573
1546
  /** @enumType */
1574
- export type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE' | 'INSURANCE';
1575
- export interface DeliveryAllocation {
1547
+ type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE' | 'INSURANCE';
1548
+ interface DeliveryAllocation {
1576
1549
  /** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
1577
1550
  deliveryCarrier?: Carrier;
1578
1551
  /** The delivery region that are relevant for this delivery solution. */
@@ -1580,7 +1553,7 @@ export interface DeliveryAllocation {
1580
1553
  /** Populated if the delivery solution is a partially supplied by this carrier. */
1581
1554
  applicableLineItems?: ApplicableLineItems;
1582
1555
  }
1583
- export interface Carrier {
1556
+ interface Carrier {
1584
1557
  /**
1585
1558
  * The carrier app id
1586
1559
  * @format GUID
@@ -1592,19 +1565,19 @@ export interface Carrier {
1592
1565
  */
1593
1566
  code?: string;
1594
1567
  }
1595
- export interface Region {
1568
+ interface Region {
1596
1569
  /**
1597
1570
  * The delivery region id.
1598
1571
  * @format GUID
1599
1572
  */
1600
- id?: string | null;
1573
+ _id?: string | null;
1601
1574
  /**
1602
1575
  * The delivery region name.
1603
1576
  * @maxLength 100
1604
1577
  */
1605
1578
  name?: string | null;
1606
1579
  }
1607
- export interface ApplicableLineItems {
1580
+ interface ApplicableLineItems {
1608
1581
  /**
1609
1582
  * Line items that the delivery solution is for.
1610
1583
  * @maxSize 300
@@ -1613,20 +1586,20 @@ export interface ApplicableLineItems {
1613
1586
  */
1614
1587
  lineItemIds?: string[];
1615
1588
  }
1616
- export interface ShippingRegion {
1589
+ interface ShippingRegion {
1617
1590
  /**
1618
1591
  * Shipping region ID.
1619
1592
  * @format GUID
1620
1593
  * @readonly
1621
1594
  */
1622
- id?: string;
1595
+ _id?: string;
1623
1596
  /**
1624
1597
  * Shipping region name.
1625
1598
  * @maxLength 100
1626
1599
  */
1627
1600
  name?: string;
1628
1601
  }
1629
- export interface CarrierServiceOption {
1602
+ interface CarrierServiceOption {
1630
1603
  /**
1631
1604
  * Carrier ID.
1632
1605
  * @format GUID
@@ -1635,7 +1608,7 @@ export interface CarrierServiceOption {
1635
1608
  /** Shipping options offered by this carrier for this request. */
1636
1609
  shippingOptions?: ShippingOption[];
1637
1610
  }
1638
- export interface ShippingOption {
1611
+ interface ShippingOption {
1639
1612
  /**
1640
1613
  * Unique code of provided shipping option like "usps_std_overnight".
1641
1614
  * For legacy calculators this would be the UUID of the option.
@@ -1660,13 +1633,13 @@ export interface ShippingOption {
1660
1633
  /** If the delivery solution is a partial and doesn't apply to all items. */
1661
1634
  partial?: boolean | null;
1662
1635
  }
1663
- export interface ShippingPrice {
1636
+ interface ShippingPrice {
1664
1637
  /** Shipping price. */
1665
1638
  price?: MultiCurrencyPrice;
1666
1639
  /** Other costs such as insurance, handling & packaging for fragile items, etc. */
1667
1640
  otherCharges?: OtherCharge[];
1668
1641
  }
1669
- export interface OtherCharge {
1642
+ interface OtherCharge {
1670
1643
  /** Type of additional cost. */
1671
1644
  type?: ChargeTypeWithLiterals;
1672
1645
  /** Price of added cost. */
@@ -1677,7 +1650,7 @@ export interface OtherCharge {
1677
1650
  */
1678
1651
  details?: string | null;
1679
1652
  }
1680
- export interface BuyerInfo extends BuyerInfoIdOneOf {
1653
+ interface BuyerInfo extends BuyerInfoIdOneOf {
1681
1654
  /**
1682
1655
  * Visitor ID (if site visitor is **not** a member).
1683
1656
  * @format GUID
@@ -1703,7 +1676,7 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
1703
1676
  email?: string | null;
1704
1677
  }
1705
1678
  /** @oneof */
1706
- export interface BuyerInfoIdOneOf {
1679
+ interface BuyerInfoIdOneOf {
1707
1680
  /**
1708
1681
  * Visitor ID (if site visitor is **not** a member).
1709
1682
  * @format GUID
@@ -1717,7 +1690,7 @@ export interface BuyerInfoIdOneOf {
1717
1690
  */
1718
1691
  memberId?: string;
1719
1692
  }
1720
- export interface PriceSummary {
1693
+ interface PriceSummary {
1721
1694
  /** Subtotal of all line items, before discounts and before tax. */
1722
1695
  subtotal?: MultiCurrencyPrice;
1723
1696
  /** Total shipping price, before discounts and before tax. */
@@ -1731,7 +1704,7 @@ export interface PriceSummary {
1731
1704
  /** Total additional fees price before tax. */
1732
1705
  additionalFees?: MultiCurrencyPrice;
1733
1706
  }
1734
- export interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
1707
+ interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
1735
1708
  /** General shipping calculation error. */
1736
1709
  generalShippingCalculationError?: Details;
1737
1710
  /** Carrier errors. */
@@ -1753,13 +1726,13 @@ export interface CalculationErrors extends CalculationErrorsShippingCalculationE
1753
1726
  discountsCalculationError?: Details;
1754
1727
  }
1755
1728
  /** @oneof */
1756
- export interface CalculationErrorsShippingCalculationErrorOneOf {
1729
+ interface CalculationErrorsShippingCalculationErrorOneOf {
1757
1730
  /** General shipping calculation error. */
1758
1731
  generalShippingCalculationError?: Details;
1759
1732
  /** Carrier errors. */
1760
1733
  carrierErrors?: CarrierErrors;
1761
1734
  }
1762
- export interface Details extends DetailsKindOneOf {
1735
+ interface Details extends DetailsKindOneOf {
1763
1736
  applicationError?: ApplicationError;
1764
1737
  validationError?: ValidationError;
1765
1738
  systemError?: SystemError;
@@ -1770,12 +1743,12 @@ export interface Details extends DetailsKindOneOf {
1770
1743
  tracing?: Record<string, string>;
1771
1744
  }
1772
1745
  /** @oneof */
1773
- export interface DetailsKindOneOf {
1746
+ interface DetailsKindOneOf {
1774
1747
  applicationError?: ApplicationError;
1775
1748
  validationError?: ValidationError;
1776
1749
  systemError?: SystemError;
1777
1750
  }
1778
- export interface ApplicationError {
1751
+ interface ApplicationError {
1779
1752
  /** Error code. */
1780
1753
  code?: string;
1781
1754
  /** Description of the error. */
@@ -1815,10 +1788,10 @@ export interface ApplicationError {
1815
1788
  * ]
1816
1789
  * }
1817
1790
  */
1818
- export interface ValidationError {
1791
+ interface ValidationError {
1819
1792
  fieldViolations?: FieldViolation[];
1820
1793
  }
1821
- export declare enum RuleType {
1794
+ declare enum RuleType {
1822
1795
  VALIDATION = "VALIDATION",
1823
1796
  OTHER = "OTHER",
1824
1797
  MAX = "MAX",
@@ -1842,8 +1815,8 @@ export declare enum RuleType {
1842
1815
  REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
1843
1816
  }
1844
1817
  /** @enumType */
1845
- export type RuleTypeWithLiterals = RuleType | 'VALIDATION' | 'OTHER' | 'MAX' | 'MIN' | 'MAX_LENGTH' | 'MIN_LENGTH' | 'MAX_SIZE' | 'MIN_SIZE' | 'FORMAT' | 'DECIMAL_LTE' | 'DECIMAL_GTE' | 'DECIMAL_LT' | 'DECIMAL_GT' | 'DECIMAL_MAX_SCALE' | 'INVALID_ENUM_VALUE' | 'REQUIRED_FIELD' | 'FIELD_NOT_ALLOWED' | 'ONE_OF_ALIGNMENT' | 'EXACT_LENGTH' | 'EXACT_SIZE' | 'REQUIRED_ONE_OF_FIELD';
1846
- export interface FieldViolation {
1818
+ type RuleTypeWithLiterals = RuleType | 'VALIDATION' | 'OTHER' | 'MAX' | 'MIN' | 'MAX_LENGTH' | 'MIN_LENGTH' | 'MAX_SIZE' | 'MIN_SIZE' | 'FORMAT' | 'DECIMAL_LTE' | 'DECIMAL_GTE' | 'DECIMAL_LT' | 'DECIMAL_GT' | 'DECIMAL_MAX_SCALE' | 'INVALID_ENUM_VALUE' | 'REQUIRED_FIELD' | 'FIELD_NOT_ALLOWED' | 'ONE_OF_ALIGNMENT' | 'EXACT_LENGTH' | 'EXACT_SIZE' | 'REQUIRED_ONE_OF_FIELD';
1819
+ interface FieldViolation {
1847
1820
  field?: string;
1848
1821
  description?: string;
1849
1822
  violatedRule?: RuleTypeWithLiterals;
@@ -1851,26 +1824,26 @@ export interface FieldViolation {
1851
1824
  ruleName?: string | null;
1852
1825
  data?: Record<string, any> | null;
1853
1826
  }
1854
- export interface SystemError {
1827
+ interface SystemError {
1855
1828
  /** Error code. */
1856
1829
  errorCode?: string | null;
1857
1830
  }
1858
- export interface CarrierErrors {
1831
+ interface CarrierErrors {
1859
1832
  /** Carrier errors. */
1860
1833
  errors?: CarrierError[];
1861
1834
  }
1862
- export interface CarrierError {
1835
+ interface CarrierError {
1863
1836
  /** Carrier ID. */
1864
1837
  carrierId?: string;
1865
1838
  /** Error details. */
1866
1839
  error?: Details;
1867
1840
  }
1868
- export interface GiftCard {
1841
+ interface GiftCard {
1869
1842
  /**
1870
1843
  * Gift Card ID.
1871
1844
  * @deprecated
1872
1845
  */
1873
- id?: string;
1846
+ _id?: string;
1874
1847
  /** Gift card obfuscated code. */
1875
1848
  obfuscatedCode?: string;
1876
1849
  /** Gift card value. */
@@ -1888,7 +1861,7 @@ export interface GiftCard {
1888
1861
  */
1889
1862
  externalId?: string | null;
1890
1863
  }
1891
- export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1864
+ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1892
1865
  /** Coupon details. */
1893
1866
  coupon?: Coupon;
1894
1867
  /** Merchant discount. */
@@ -1907,7 +1880,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1907
1880
  lineItemIds?: string[];
1908
1881
  }
1909
1882
  /** @oneof */
1910
- export interface AppliedDiscountDiscountSourceOneOf {
1883
+ interface AppliedDiscountDiscountSourceOneOf {
1911
1884
  /** Coupon details. */
1912
1885
  coupon?: Coupon;
1913
1886
  /** Merchant discount. */
@@ -1915,17 +1888,17 @@ export interface AppliedDiscountDiscountSourceOneOf {
1915
1888
  /** Discount rule */
1916
1889
  discountRule?: DiscountRule;
1917
1890
  }
1918
- export declare enum DiscountType {
1891
+ declare enum DiscountType {
1919
1892
  GLOBAL = "GLOBAL",
1920
1893
  SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
1921
1894
  SHIPPING = "SHIPPING"
1922
1895
  }
1923
1896
  /** @enumType */
1924
- export type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
1897
+ type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
1925
1898
  /** Coupon */
1926
- export interface Coupon {
1899
+ interface Coupon {
1927
1900
  /** Coupon ID. */
1928
- id?: string;
1901
+ _id?: string;
1929
1902
  /** Coupon code. */
1930
1903
  code?: string;
1931
1904
  /** Coupon value. */
@@ -1933,7 +1906,7 @@ export interface Coupon {
1933
1906
  /** Coupon name. */
1934
1907
  name?: string;
1935
1908
  }
1936
- export interface MerchantDiscount {
1909
+ interface MerchantDiscount {
1937
1910
  /** Discount value. */
1938
1911
  amount?: MultiCurrencyPrice;
1939
1912
  /**
@@ -1943,18 +1916,18 @@ export interface MerchantDiscount {
1943
1916
  */
1944
1917
  percentage?: number | null;
1945
1918
  }
1946
- export interface DiscountRule {
1919
+ interface DiscountRule {
1947
1920
  /**
1948
1921
  * Discount rule ID
1949
1922
  * @format GUID
1950
1923
  */
1951
- id?: string;
1924
+ _id?: string;
1952
1925
  /** Discount rule name */
1953
1926
  name?: DiscountRuleName;
1954
1927
  /** Discount value. */
1955
1928
  amount?: MultiCurrencyPrice;
1956
1929
  }
1957
- export interface DiscountRuleName {
1930
+ interface DiscountRuleName {
1958
1931
  /**
1959
1932
  * Original discount rule name (in site's default language).
1960
1933
  * @minLength 1
@@ -1968,16 +1941,16 @@ export interface DiscountRuleName {
1968
1941
  */
1969
1942
  translated?: string | null;
1970
1943
  }
1971
- export interface LineItemDiscount {
1944
+ interface LineItemDiscount {
1972
1945
  /**
1973
1946
  * ID of line item the discount applies to.
1974
1947
  * @format GUID
1975
1948
  */
1976
- id?: string;
1949
+ _id?: string;
1977
1950
  /** Discount value. */
1978
1951
  totalDiscountAmount?: MultiCurrencyPrice;
1979
1952
  }
1980
- export interface CustomField {
1953
+ interface CustomField {
1981
1954
  /** Custom field value. */
1982
1955
  value?: any;
1983
1956
  /**
@@ -1993,7 +1966,7 @@ export interface CustomField {
1993
1966
  */
1994
1967
  translatedTitle?: string | null;
1995
1968
  }
1996
- export declare enum WeightUnit {
1969
+ declare enum WeightUnit {
1997
1970
  /** Weight unit can't be classified due to an error. */
1998
1971
  UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
1999
1972
  /** Kilograms. */
@@ -2002,8 +1975,8 @@ export declare enum WeightUnit {
2002
1975
  LB = "LB"
2003
1976
  }
2004
1977
  /** @enumType */
2005
- export type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
2006
- export interface TaxSummary {
1978
+ type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
1979
+ interface TaxSummary {
2007
1980
  /**
2008
1981
  * Amount for which tax is calculated, added from line items.
2009
1982
  * @readonly
@@ -2020,7 +1993,7 @@ export interface TaxSummary {
2020
1993
  */
2021
1994
  calculationDetails?: TaxCalculationDetails;
2022
1995
  }
2023
- export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
1996
+ interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
2024
1997
  /** Reason the manual calculation was used. */
2025
1998
  manualRateReason?: ManualCalculationReasonWithLiterals;
2026
1999
  /** Details of the fallback rate calculation. */
@@ -2029,13 +2002,13 @@ export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationD
2029
2002
  rateType?: RateTypeWithLiterals;
2030
2003
  }
2031
2004
  /** @oneof */
2032
- export interface TaxCalculationDetailsCalculationDetailsOneOf {
2005
+ interface TaxCalculationDetailsCalculationDetailsOneOf {
2033
2006
  /** Reason the manual calculation was used. */
2034
2007
  manualRateReason?: ManualCalculationReasonWithLiterals;
2035
2008
  /** Details of the fallback rate calculation. */
2036
2009
  autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
2037
2010
  }
2038
- export declare enum RateType {
2011
+ declare enum RateType {
2039
2012
  /** no tax being collected for this request due to location of purchase */
2040
2013
  NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
2041
2014
  /** manual rate used for calculation */
@@ -2046,34 +2019,34 @@ export declare enum RateType {
2046
2019
  FALLBACK_RATE = "FALLBACK_RATE"
2047
2020
  }
2048
2021
  /** @enumType */
2049
- export type RateTypeWithLiterals = RateType | 'NO_TAX_COLLECTED' | 'MANUAL_RATE' | 'AUTO_RATE' | 'FALLBACK_RATE';
2050
- export declare enum ManualCalculationReason {
2022
+ type RateTypeWithLiterals = RateType | 'NO_TAX_COLLECTED' | 'MANUAL_RATE' | 'AUTO_RATE' | 'FALLBACK_RATE';
2023
+ declare enum ManualCalculationReason {
2051
2024
  /** user set calculator in Business Manager to be Manual */
2052
2025
  GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
2053
2026
  /** specific region is on manual even though Global setting is Auto-tax */
2054
2027
  REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
2055
2028
  }
2056
2029
  /** @enumType */
2057
- export type ManualCalculationReasonWithLiterals = ManualCalculationReason | 'GLOBAL_SETTING_TO_MANUAL' | 'REGION_SETTING_TO_MANUAL';
2058
- export interface AutoTaxFallbackCalculationDetails {
2030
+ type ManualCalculationReasonWithLiterals = ManualCalculationReason | 'GLOBAL_SETTING_TO_MANUAL' | 'REGION_SETTING_TO_MANUAL';
2031
+ interface AutoTaxFallbackCalculationDetails {
2059
2032
  /** reason for fallback */
2060
2033
  fallbackReason?: FallbackReasonWithLiterals;
2061
2034
  /** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
2062
2035
  error?: ApplicationError;
2063
2036
  }
2064
- export declare enum FallbackReason {
2037
+ declare enum FallbackReason {
2065
2038
  /** auto-tax failed to be calculated */
2066
2039
  AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
2067
2040
  /** auto-tax was temporarily deactivated on a system-level */
2068
2041
  AUTO_TAX_DEACTIVATED = "AUTO_TAX_DEACTIVATED"
2069
2042
  }
2070
2043
  /** @enumType */
2071
- export type FallbackReasonWithLiterals = FallbackReason | 'AUTO_TAX_FAILED' | 'AUTO_TAX_DEACTIVATED';
2044
+ type FallbackReasonWithLiterals = FallbackReason | 'AUTO_TAX_FAILED' | 'AUTO_TAX_DEACTIVATED';
2072
2045
  /**
2073
2046
  * The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
2074
2047
  * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
2075
2048
  */
2076
- export interface AggregatedTaxBreakdown {
2049
+ interface AggregatedTaxBreakdown {
2077
2050
  /**
2078
2051
  * The name of the tax against which this tax amount was calculated.
2079
2052
  * @maxLength 200
@@ -2099,7 +2072,7 @@ export interface AggregatedTaxBreakdown {
2099
2072
  /** The sum of all the tax from line items that calculated by the tax identifiers. */
2100
2073
  aggregatedTaxAmount?: MultiCurrencyPrice;
2101
2074
  }
2102
- export declare enum ChannelType {
2075
+ declare enum ChannelType {
2103
2076
  /** Unspecified sales channel. This value is not supported. */
2104
2077
  UNSPECIFIED = "UNSPECIFIED",
2105
2078
  /** A web client. */
@@ -2134,8 +2107,8 @@ export declare enum ChannelType {
2134
2107
  FAIRE_COM = "FAIRE_COM"
2135
2108
  }
2136
2109
  /** @enumType */
2137
- 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';
2138
- export interface CreatedBy extends CreatedByIdOneOf {
2110
+ 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';
2111
+ interface CreatedBy extends CreatedByIdOneOf {
2139
2112
  /**
2140
2113
  * User ID. When the order was created by a Wix user on behalf of a buyer.
2141
2114
  * For example, via POS (point of service).
@@ -2159,7 +2132,7 @@ export interface CreatedBy extends CreatedByIdOneOf {
2159
2132
  appId?: string;
2160
2133
  }
2161
2134
  /** @oneof */
2162
- export interface CreatedByIdOneOf {
2135
+ interface CreatedByIdOneOf {
2163
2136
  /**
2164
2137
  * User ID. When the order was created by a Wix user on behalf of a buyer.
2165
2138
  * For example, via POS (point of service).
@@ -2183,7 +2156,7 @@ export interface CreatedByIdOneOf {
2183
2156
  appId?: string;
2184
2157
  }
2185
2158
  /** Reserved for internal use. */
2186
- export interface MembershipOptions {
2159
+ interface MembershipOptions {
2187
2160
  /**
2188
2161
  * Reserved for internal use.
2189
2162
  * @readonly
@@ -2199,13 +2172,13 @@ export interface MembershipOptions {
2199
2172
  /** Selected membership to apply to this checkout. */
2200
2173
  selectedMemberships?: SelectedMemberships;
2201
2174
  }
2202
- export interface Membership {
2175
+ interface Membership {
2203
2176
  /**
2204
2177
  * Membership ID.
2205
2178
  * @minLength 1
2206
2179
  * @maxLength 100
2207
2180
  */
2208
- id?: string;
2181
+ _id?: string;
2209
2182
  /**
2210
2183
  * ID of the application providing this payment option.
2211
2184
  * @format GUID
@@ -2228,7 +2201,7 @@ export interface Membership {
2228
2201
  /** Additional data about this membership. */
2229
2202
  additionalData?: Record<string, any> | null;
2230
2203
  }
2231
- export interface MembershipName {
2204
+ interface MembershipName {
2232
2205
  /**
2233
2206
  * Membership name.
2234
2207
  * @maxLength 100
@@ -2240,7 +2213,7 @@ export interface MembershipName {
2240
2213
  */
2241
2214
  translated?: string | null;
2242
2215
  }
2243
- export interface MembershipPaymentCredits {
2216
+ interface MembershipPaymentCredits {
2244
2217
  /**
2245
2218
  * Membership's total amount of credits.
2246
2219
  * @min 1
@@ -2249,7 +2222,7 @@ export interface MembershipPaymentCredits {
2249
2222
  /** Membership's remaining amount of credits. */
2250
2223
  remaining?: number;
2251
2224
  }
2252
- export interface InvalidMembership {
2225
+ interface InvalidMembership {
2253
2226
  /** Membership details. */
2254
2227
  membership?: Membership;
2255
2228
  /**
@@ -2259,20 +2232,20 @@ export interface InvalidMembership {
2259
2232
  */
2260
2233
  reason?: string;
2261
2234
  }
2262
- export interface SelectedMemberships {
2235
+ interface SelectedMemberships {
2263
2236
  /**
2264
2237
  * Selected memberships.
2265
2238
  * @maxSize 300
2266
2239
  */
2267
2240
  memberships?: SelectedMembership[];
2268
2241
  }
2269
- export interface SelectedMembership {
2242
+ interface SelectedMembership {
2270
2243
  /**
2271
2244
  * Membership ID.
2272
2245
  * @minLength 1
2273
2246
  * @maxLength 100
2274
2247
  */
2275
- id?: string;
2248
+ _id?: string;
2276
2249
  /**
2277
2250
  * ID of the app providing this payment option.
2278
2251
  * @format GUID
@@ -2287,7 +2260,7 @@ export interface SelectedMembership {
2287
2260
  */
2288
2261
  lineItemIds?: string[];
2289
2262
  }
2290
- export interface AdditionalFee {
2263
+ interface AdditionalFee {
2291
2264
  /**
2292
2265
  * Additional fee's unique code (or ID) for future processing.
2293
2266
  * @minLength 1
@@ -2323,7 +2296,7 @@ export interface AdditionalFee {
2323
2296
  /** the source the additional fee was added from */
2324
2297
  source?: AdditionalFeeSourceWithLiterals;
2325
2298
  }
2326
- export declare enum AdditionalFeeSource {
2299
+ declare enum AdditionalFeeSource {
2327
2300
  UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
2328
2301
  /** The additional fee was added by an additional fee service plugin */
2329
2302
  SERVICE_PLUGIN = "SERVICE_PLUGIN",
@@ -2335,8 +2308,8 @@ export declare enum AdditionalFeeSource {
2335
2308
  SHIPPING = "SHIPPING"
2336
2309
  }
2337
2310
  /** @enumType */
2338
- export type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING';
2339
- export interface ConversionInfo {
2311
+ type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING';
2312
+ interface ConversionInfo {
2340
2313
  /**
2341
2314
  * The site currency.
2342
2315
  * @readonly
@@ -2350,7 +2323,7 @@ export interface ConversionInfo {
2350
2323
  */
2351
2324
  conversionRate?: string;
2352
2325
  }
2353
- export interface Violation {
2326
+ interface Violation {
2354
2327
  /** Severity of the violation. The violations are shown on the cart and checkout pages. A warning is displayed as yellow, and allows a site visitor to proceed with caution. An error is displayed as red, and doesn't allow a site visitor to proceed with the eCommerce flow. */
2355
2328
  severity?: SeverityWithLiterals;
2356
2329
  /** Target location on a checkout or cart page where the violation will be displayed. */
@@ -2362,7 +2335,7 @@ export interface Violation {
2362
2335
  */
2363
2336
  description?: string | null;
2364
2337
  }
2365
- export declare enum Severity {
2338
+ declare enum Severity {
2366
2339
  /** The user is allowed to move forward in the flow. */
2367
2340
  WARNING = "WARNING",
2368
2341
  /**
@@ -2372,55 +2345,53 @@ export declare enum Severity {
2372
2345
  ERROR = "ERROR"
2373
2346
  }
2374
2347
  /** @enumType */
2375
- export type SeverityWithLiterals = Severity | 'WARNING' | 'ERROR';
2376
- export interface Target extends TargetTargetTypeOneOf {
2348
+ type SeverityWithLiterals = Severity | 'WARNING' | 'ERROR';
2349
+ interface Target extends TargetTargetTypeOneOf {
2377
2350
  /** General (other) violation. */
2378
2351
  other?: Other;
2379
2352
  /** Specific line item violation. */
2380
2353
  lineItem?: TargetLineItem;
2381
2354
  }
2382
2355
  /** @oneof */
2383
- export interface TargetTargetTypeOneOf {
2356
+ interface TargetTargetTypeOneOf {
2384
2357
  /** General (other) violation. */
2385
2358
  other?: Other;
2386
2359
  /** Specific line item violation. */
2387
2360
  lineItem?: TargetLineItem;
2388
2361
  }
2389
2362
  /** Available locations on the webpage */
2390
- export declare enum NameInOther {
2363
+ declare enum NameInOther {
2391
2364
  /** Default location, in case no specific location is specified. */
2392
2365
  OTHER_DEFAULT = "OTHER_DEFAULT"
2393
2366
  }
2394
2367
  /** @enumType */
2395
- export type NameInOtherWithLiterals = NameInOther | 'OTHER_DEFAULT';
2368
+ type NameInOtherWithLiterals = NameInOther | 'OTHER_DEFAULT';
2396
2369
  /** Available locations on the line item */
2397
- export declare enum NameInLineItem {
2370
+ declare enum NameInLineItem {
2398
2371
  /** Default location, in case no specific location is specified. */
2399
2372
  LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
2400
2373
  }
2401
2374
  /** @enumType */
2402
- export type NameInLineItemWithLiterals = NameInLineItem | 'LINE_ITEM_DEFAULT';
2403
- export declare enum SuggestedFix {
2375
+ type NameInLineItemWithLiterals = NameInLineItem | 'LINE_ITEM_DEFAULT';
2376
+ declare enum SuggestedFix {
2404
2377
  /** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
2405
2378
  UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
2406
2379
  /** The line item should be removed from the cart or checkout to resolve the violation. */
2407
2380
  REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
2408
2381
  }
2409
- /** @enumType */
2410
- export type SuggestedFixWithLiterals = SuggestedFix | 'UNKNOWN_SUGGESTED_FIX' | 'REMOVE_LINE_ITEM';
2411
2382
  /** General (other) violation. */
2412
- export interface Other {
2383
+ interface Other {
2413
2384
  /** Location on a checkout or a cart page where a general (other) violation will be displayed. */
2414
2385
  name?: NameInOtherWithLiterals;
2415
2386
  }
2416
2387
  /** Specific line item violation. */
2417
- export interface TargetLineItem {
2388
+ interface TargetLineItem {
2418
2389
  /** Location on a checkout or a cart page where the specific line item violation will be displayed. */
2419
2390
  name?: NameInLineItemWithLiterals;
2420
2391
  /** ID of the line item containing the violation. */
2421
- id?: string | null;
2392
+ _id?: string | null;
2422
2393
  }
2423
- export interface CustomSettings {
2394
+ interface CustomSettings {
2424
2395
  /**
2425
2396
  * Whether to restrict the option to add or remove a gift card on the checkout page.
2426
2397
  *
@@ -2446,7 +2417,7 @@ export interface CustomSettings {
2446
2417
  */
2447
2418
  disabledManualPayment?: boolean;
2448
2419
  }
2449
- export interface SubscriptionCharges {
2420
+ interface SubscriptionCharges {
2450
2421
  /**
2451
2422
  * ids of the items the subscription is defined on
2452
2423
  * @format GUID
@@ -2466,7 +2437,7 @@ export interface SubscriptionCharges {
2466
2437
  */
2467
2438
  charges?: Charge[];
2468
2439
  }
2469
- export interface Charge {
2440
+ interface Charge {
2470
2441
  /** The cycle number from which the charge starts. */
2471
2442
  cycleFrom?: number;
2472
2443
  /** The number of cycles for which the charge is applicable. */
@@ -2476,47 +2447,47 @@ export interface Charge {
2476
2447
  /** The billing date from which the charge starts. */
2477
2448
  cycleBillingDate?: Date | null;
2478
2449
  }
2479
- export interface CreateCheckoutTemplateRequest {
2450
+ interface CreateCheckoutTemplateRequest {
2480
2451
  /** Checkout template to create. */
2481
2452
  checkoutTemplate: CheckoutTemplate;
2482
2453
  }
2483
- export interface CreateCheckoutTemplateResponse {
2454
+ interface CreateCheckoutTemplateResponse {
2484
2455
  /** Created checkout template. */
2485
2456
  checkoutTemplate?: CheckoutTemplate;
2486
2457
  }
2487
- export interface GetCheckoutTemplateRequest {
2458
+ interface GetCheckoutTemplateRequest {
2488
2459
  /**
2489
2460
  * ID of the checkout template to retrieve.
2490
2461
  * @format GUID
2491
2462
  */
2492
2463
  checkoutTemplateId: string;
2493
2464
  }
2494
- export interface GetCheckoutTemplateResponse {
2465
+ interface GetCheckoutTemplateResponse {
2495
2466
  /** Retrieved checkout template. */
2496
2467
  checkoutTemplate?: CheckoutTemplate;
2497
2468
  }
2498
- export interface UpdateCheckoutTemplateRequest {
2469
+ interface UpdateCheckoutTemplateRequest {
2499
2470
  /** Checkout template info to update. */
2500
2471
  checkoutTemplate: CheckoutTemplate;
2501
2472
  }
2502
- export interface UpdateCheckoutTemplateResponse {
2473
+ interface UpdateCheckoutTemplateResponse {
2503
2474
  /** Updated checkout template. */
2504
2475
  checkoutTemplate?: CheckoutTemplate;
2505
2476
  }
2506
- export interface DeleteCheckoutTemplateRequest {
2477
+ interface DeleteCheckoutTemplateRequest {
2507
2478
  /**
2508
2479
  * ID of the checkout template to delete.
2509
2480
  * @format GUID
2510
2481
  */
2511
2482
  checkoutTemplateId: string;
2512
2483
  }
2513
- export interface DeleteCheckoutTemplateResponse {
2484
+ interface DeleteCheckoutTemplateResponse {
2514
2485
  }
2515
- export interface QueryCheckoutTemplatesRequest {
2486
+ interface QueryCheckoutTemplatesRequest {
2516
2487
  /** Query options. */
2517
2488
  query?: CursorQuery;
2518
2489
  }
2519
- export interface CursorQuery extends CursorQueryPagingMethodOneOf {
2490
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
2520
2491
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
2521
2492
  cursorPaging?: CursorPaging;
2522
2493
  /**
@@ -2536,25 +2507,25 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
2536
2507
  sort?: Sorting[];
2537
2508
  }
2538
2509
  /** @oneof */
2539
- export interface CursorQueryPagingMethodOneOf {
2510
+ interface CursorQueryPagingMethodOneOf {
2540
2511
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
2541
2512
  cursorPaging?: CursorPaging;
2542
2513
  }
2543
- export interface Sorting {
2514
+ interface Sorting {
2544
2515
  /** Name of the field to sort by. */
2545
2516
  fieldName?: string;
2546
2517
  /** Sort order. */
2547
2518
  order?: SortOrderWithLiterals;
2548
2519
  }
2549
- export declare enum SortOrder {
2520
+ declare enum SortOrder {
2550
2521
  /** Ascending order. */
2551
2522
  ASC = "ASC",
2552
2523
  /** Descending order. */
2553
2524
  DESC = "DESC"
2554
2525
  }
2555
2526
  /** @enumType */
2556
- export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
2557
- export interface CursorPaging {
2527
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
2528
+ interface CursorPaging {
2558
2529
  /**
2559
2530
  * Number of items to load.
2560
2531
  * @max 100
@@ -2569,13 +2540,13 @@ export interface CursorPaging {
2569
2540
  */
2570
2541
  cursor?: string | null;
2571
2542
  }
2572
- export interface QueryCheckoutTemplatesResponse {
2543
+ interface QueryCheckoutTemplatesResponse {
2573
2544
  /** Retrieved checkout templates. */
2574
2545
  checkoutTemplates?: CheckoutTemplate[];
2575
2546
  /** Paging metadata. */
2576
2547
  pagingMetadata?: CursorPagingMetadata;
2577
2548
  }
2578
- export interface CursorPagingMetadata {
2549
+ interface CursorPagingMetadata {
2579
2550
  /** Number of items returned in the response. */
2580
2551
  count?: number | null;
2581
2552
  /** Offset that was requested. */
@@ -2587,13 +2558,13 @@ export interface CursorPagingMetadata {
2587
2558
  */
2588
2559
  hasNext?: boolean | null;
2589
2560
  }
2590
- export interface Cursors {
2561
+ interface Cursors {
2591
2562
  /** Cursor pointing to next page in the list of results. */
2592
2563
  next?: string | null;
2593
2564
  /** Cursor pointing to previous page in the list of results. */
2594
2565
  prev?: string | null;
2595
2566
  }
2596
- export interface CreateCheckoutFromTemplateRequest {
2567
+ interface CreateCheckoutFromTemplateRequest {
2597
2568
  /**
2598
2569
  * ID of the checkout template to use to create a checkout from.
2599
2570
  * @format GUID
@@ -2605,7 +2576,7 @@ export interface CreateCheckoutFromTemplateRequest {
2605
2576
  */
2606
2577
  siteId: string;
2607
2578
  }
2608
- export interface CreateCheckoutFromTemplateResponse {
2579
+ interface CreateCheckoutFromTemplateResponse {
2609
2580
  /**
2610
2581
  * ID of the created checkout.
2611
2582
  * @format GUID
@@ -2619,7 +2590,7 @@ export interface CreateCheckoutFromTemplateResponse {
2619
2590
  */
2620
2591
  purchaseFlowId?: string | null;
2621
2592
  }
2622
- export interface CreateAndRedirectToCheckoutRequest {
2593
+ interface CreateAndRedirectToCheckoutRequest {
2623
2594
  /**
2624
2595
  * ID of the checkout template to use to create a checkout.
2625
2596
  * @format GUID
@@ -2631,22 +2602,22 @@ export interface CreateAndRedirectToCheckoutRequest {
2631
2602
  */
2632
2603
  siteId: string;
2633
2604
  }
2634
- export interface RawHttpResponse {
2605
+ interface RawHttpResponse {
2635
2606
  body?: Uint8Array;
2636
2607
  statusCode?: number | null;
2637
2608
  headers?: HeadersEntry[];
2638
2609
  }
2639
- export interface HeadersEntry {
2610
+ interface HeadersEntry {
2640
2611
  key?: string;
2641
2612
  value?: string;
2642
2613
  }
2643
- export interface DomainEvent extends DomainEventBodyOneOf {
2614
+ interface DomainEvent extends DomainEventBodyOneOf {
2644
2615
  createdEvent?: EntityCreatedEvent;
2645
2616
  updatedEvent?: EntityUpdatedEvent;
2646
2617
  deletedEvent?: EntityDeletedEvent;
2647
2618
  actionEvent?: ActionEvent;
2648
2619
  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2649
- id?: string;
2620
+ _id?: string;
2650
2621
  /**
2651
2622
  * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2652
2623
  * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
@@ -2675,36 +2646,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
2675
2646
  entityEventSequence?: string | null;
2676
2647
  }
2677
2648
  /** @oneof */
2678
- export interface DomainEventBodyOneOf {
2649
+ interface DomainEventBodyOneOf {
2679
2650
  createdEvent?: EntityCreatedEvent;
2680
2651
  updatedEvent?: EntityUpdatedEvent;
2681
2652
  deletedEvent?: EntityDeletedEvent;
2682
2653
  actionEvent?: ActionEvent;
2683
2654
  }
2684
- export interface EntityCreatedEvent {
2685
- entityAsJson?: string;
2686
- /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
2687
- restoreInfo?: RestoreInfo;
2655
+ interface EntityCreatedEvent {
2656
+ entity?: string;
2688
2657
  }
2689
- export interface RestoreInfo {
2658
+ interface RestoreInfo {
2690
2659
  deletedDate?: Date | null;
2691
2660
  }
2692
- export interface EntityUpdatedEvent {
2661
+ interface EntityUpdatedEvent {
2693
2662
  /**
2694
2663
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2695
2664
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2696
2665
  * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2697
2666
  */
2698
- currentEntityAsJson?: string;
2667
+ currentEntity?: string;
2699
2668
  }
2700
- export interface EntityDeletedEvent {
2669
+ interface EntityDeletedEvent {
2701
2670
  /** Entity that was deleted. */
2702
- deletedEntityAsJson?: string | null;
2671
+ deletedEntity?: string | null;
2703
2672
  }
2704
- export interface ActionEvent {
2705
- bodyAsJson?: string;
2673
+ interface ActionEvent {
2674
+ body?: string;
2706
2675
  }
2707
- export interface MessageEnvelope {
2676
+ interface MessageEnvelope {
2708
2677
  /**
2709
2678
  * App instance ID.
2710
2679
  * @format GUID
@@ -2720,7 +2689,7 @@ export interface MessageEnvelope {
2720
2689
  /** Stringify payload. */
2721
2690
  data?: string;
2722
2691
  }
2723
- export interface IdentificationData extends IdentificationDataIdOneOf {
2692
+ interface IdentificationData extends IdentificationDataIdOneOf {
2724
2693
  /**
2725
2694
  * ID of a site visitor that has not logged in to the site.
2726
2695
  * @format GUID
@@ -2745,7 +2714,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
2745
2714
  identityType?: WebhookIdentityTypeWithLiterals;
2746
2715
  }
2747
2716
  /** @oneof */
2748
- export interface IdentificationDataIdOneOf {
2717
+ interface IdentificationDataIdOneOf {
2749
2718
  /**
2750
2719
  * ID of a site visitor that has not logged in to the site.
2751
2720
  * @format GUID
@@ -2767,7 +2736,7 @@ export interface IdentificationDataIdOneOf {
2767
2736
  */
2768
2737
  appId?: string;
2769
2738
  }
2770
- export declare enum WebhookIdentityType {
2739
+ declare enum WebhookIdentityType {
2771
2740
  UNKNOWN = "UNKNOWN",
2772
2741
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2773
2742
  MEMBER = "MEMBER",
@@ -2775,4 +2744,175 @@ export declare enum WebhookIdentityType {
2775
2744
  APP = "APP"
2776
2745
  }
2777
2746
  /** @enumType */
2778
- export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2747
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2748
+ interface BaseEventMetadata {
2749
+ /**
2750
+ * App instance ID.
2751
+ * @format GUID
2752
+ */
2753
+ instanceId?: string | null;
2754
+ /**
2755
+ * Event type.
2756
+ * @maxLength 150
2757
+ */
2758
+ eventType?: string;
2759
+ /** The identification type and identity data. */
2760
+ identity?: IdentificationData;
2761
+ }
2762
+ interface EventMetadata extends BaseEventMetadata {
2763
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2764
+ _id?: string;
2765
+ /**
2766
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2767
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2768
+ */
2769
+ entityFqdn?: string;
2770
+ /**
2771
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
2772
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2773
+ */
2774
+ slug?: string;
2775
+ /** ID of the entity associated with the event. */
2776
+ entityId?: string;
2777
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2778
+ eventTime?: Date | null;
2779
+ /**
2780
+ * Whether the event was triggered as a result of a privacy regulation application
2781
+ * (for example, GDPR).
2782
+ */
2783
+ triggeredByAnonymizeRequest?: boolean | null;
2784
+ /** If present, indicates the action that triggered the event. */
2785
+ originatedFrom?: string | null;
2786
+ /**
2787
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
2788
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
2789
+ */
2790
+ entityEventSequence?: string | null;
2791
+ }
2792
+ interface CheckoutTemplateCreatedEnvelope {
2793
+ entity: CheckoutTemplate;
2794
+ metadata: EventMetadata;
2795
+ }
2796
+ interface CheckoutTemplateDeletedEnvelope {
2797
+ metadata: EventMetadata;
2798
+ }
2799
+ interface CheckoutTemplateUpdatedEnvelope {
2800
+ entity: CheckoutTemplate;
2801
+ metadata: EventMetadata;
2802
+ }
2803
+ interface CheckoutTemplateUsedEnvelope {
2804
+ data: CheckoutTemplateUsed;
2805
+ metadata: EventMetadata;
2806
+ }
2807
+ interface UpdateCheckoutTemplate {
2808
+ /**
2809
+ * Checkout template ID.
2810
+ * @format GUID
2811
+ * @readonly
2812
+ */
2813
+ _id?: string | null;
2814
+ /**
2815
+ * Status of the checkout template.
2816
+ *
2817
+ * When `status` is `INACTIVE` checkouts will not be created with this template `id`. Instead, the endpoint will redirect to the domain site.
2818
+ *
2819
+ * Default: `ACTIVE`
2820
+ */
2821
+ status?: StatusWithLiterals;
2822
+ /** Custom settings to apply to the checkout page created from this template. */
2823
+ customization?: CheckoutCustomization;
2824
+ /**
2825
+ * Catalog line items.
2826
+ *
2827
+ * Max: 300 items
2828
+ * @maxSize 300
2829
+ */
2830
+ lineItems?: V1LineItem[];
2831
+ /**
2832
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
2833
+ *
2834
+ * Max: 300 items
2835
+ * @maxSize 300
2836
+ */
2837
+ customLineItems?: CustomLineItem[];
2838
+ /**
2839
+ * Coupon code.
2840
+ *
2841
+ * Note that a checkout can only hold one `couponCode` at a time. If an additional `couponCode` is added, it will override the existing `couponCode`.
2842
+ * For additional information, see the Coupons API.
2843
+ */
2844
+ couponCode?: string | null;
2845
+ /**
2846
+ * Reference IDs for the app and component providing custom checkout page content.
2847
+ *
2848
+ * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
2849
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
2850
+ */
2851
+ customContentReference?: CustomContentReference;
2852
+ /**
2853
+ * References to an external app and resource associated with the checkout.
2854
+ * Used for integration and tracking across different platforms.
2855
+ * @immutable
2856
+ */
2857
+ externalReference?: ExternalReference;
2858
+ }
2859
+ interface QueryCursorResult {
2860
+ cursors: Cursors;
2861
+ hasNext: () => boolean;
2862
+ hasPrev: () => boolean;
2863
+ length: number;
2864
+ pageSize: number;
2865
+ }
2866
+ interface CheckoutTemplatesQueryResult extends QueryCursorResult {
2867
+ items: CheckoutTemplate[];
2868
+ query: CheckoutTemplatesQueryBuilder;
2869
+ next: () => Promise<CheckoutTemplatesQueryResult>;
2870
+ prev: () => Promise<CheckoutTemplatesQueryResult>;
2871
+ }
2872
+ interface CheckoutTemplatesQueryBuilder {
2873
+ /** @param propertyName - Property whose value is compared with `value`.
2874
+ * @param value - Value to compare against.
2875
+ */
2876
+ eq: (propertyName: '_id' | 'status', value: any) => CheckoutTemplatesQueryBuilder;
2877
+ /** @param propertyName - Property whose value is compared with `value`.
2878
+ * @param value - Value to compare against.
2879
+ */
2880
+ ne: (propertyName: '_id' | 'status', value: any) => CheckoutTemplatesQueryBuilder;
2881
+ /** @param propertyName - Property whose value is compared with `value`.
2882
+ * @param value - Value to compare against.
2883
+ */
2884
+ ge: (propertyName: '_id', value: any) => CheckoutTemplatesQueryBuilder;
2885
+ /** @param propertyName - Property whose value is compared with `value`.
2886
+ * @param value - Value to compare against.
2887
+ */
2888
+ gt: (propertyName: '_id', value: any) => CheckoutTemplatesQueryBuilder;
2889
+ /** @param propertyName - Property whose value is compared with `value`.
2890
+ * @param value - Value to compare against.
2891
+ */
2892
+ le: (propertyName: '_id', value: any) => CheckoutTemplatesQueryBuilder;
2893
+ /** @param propertyName - Property whose value is compared with `value`.
2894
+ * @param value - Value to compare against.
2895
+ */
2896
+ lt: (propertyName: '_id', value: any) => CheckoutTemplatesQueryBuilder;
2897
+ /** @param propertyName - Property whose value is compared with `string`.
2898
+ * @param string - String to compare against. Case-insensitive.
2899
+ */
2900
+ startsWith: (propertyName: '_id', value: string) => CheckoutTemplatesQueryBuilder;
2901
+ /** @param propertyName - Property whose value is compared with `values`.
2902
+ * @param values - List of values to compare against.
2903
+ */
2904
+ hasSome: (propertyName: '_id' | 'status', value: any[]) => CheckoutTemplatesQueryBuilder;
2905
+ in: (propertyName: '_id' | 'status', value: any) => CheckoutTemplatesQueryBuilder;
2906
+ exists: (propertyName: '_id' | 'status', value: boolean) => CheckoutTemplatesQueryBuilder;
2907
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
2908
+ ascending: (...propertyNames: Array<'_id' | 'status'>) => CheckoutTemplatesQueryBuilder;
2909
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
2910
+ descending: (...propertyNames: Array<'_id' | 'status'>) => CheckoutTemplatesQueryBuilder;
2911
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
2912
+ limit: (limit: number) => CheckoutTemplatesQueryBuilder;
2913
+ /** @param cursor - A pointer to specific record */
2914
+ skipTo: (cursor: string) => CheckoutTemplatesQueryBuilder;
2915
+ find: () => Promise<CheckoutTemplatesQueryResult>;
2916
+ }
2917
+
2918
+ export { type SubscriptionOptionInfo as $, AdditionalFeeSource as A, type DescriptionLine as B, type CheckoutTemplate as C, DescriptionLineType as D, type DescriptionLineValueOneOf as E, FileType as F, type DescriptionLineDescriptionLineValueOneOf as G, type DescriptionLineName as H, ItemTypeItemType as I, JurisdictionType as J, type PlainTextValue as K, type Color as L, ManualCalculationReason as M, NameInOther as N, type PhysicalProperties as O, PaymentOptionType as P, type PaymentOption as Q, type RawHttpResponse as R, Status as S, TaxableAddressType as T, type UpdateCheckoutTemplate as U, VatType as V, WeightUnit as W, type CustomLineItem as X, type PriceDescription as Y, type ItemType as Z, type ItemTypeItemTypeDataOneOf as _, type CheckoutTemplatesQueryBuilder as a, type GiftCard as a$, type SubscriptionSettings as a0, type FreeTrialPeriod as a1, type Title as a2, type Description as a3, type SecuredMedia as a4, type ServiceProperties as a5, type Policy as a6, type TaxableAddress as a7, type TaxableAddressTaxableAddressDataOneOf as a8, type V1ModifierGroup as a9, type DeliveryLogistics as aA, type PickupDetails as aB, type DeliveryTimeSlot as aC, type SelectedCarrierServiceOptionPrices as aD, type SelectedCarrierServiceOptionOtherCharge as aE, type DeliveryAllocation as aF, type Carrier as aG, type Region as aH, type ApplicableLineItems as aI, type ShippingRegion as aJ, type CarrierServiceOption as aK, type ShippingOption as aL, type ShippingPrice as aM, type OtherCharge as aN, type BuyerInfo as aO, type BuyerInfoIdOneOf as aP, type PriceSummary as aQ, type CalculationErrors as aR, type CalculationErrorsShippingCalculationErrorOneOf as aS, type Details as aT, type DetailsKindOneOf as aU, type ApplicationError as aV, type ValidationError as aW, type FieldViolation as aX, type SystemError as aY, type CarrierErrors as aZ, type CarrierError as a_, type TranslatableString as aa, type V1ItemModifier as ab, type ExtendedFields as ac, type CustomContentReference as ad, type ExternalReference as ae, type CheckoutTemplateUsed as af, type Checkout as ag, type LineItem as ah, type MultiCurrencyPrice as ai, type ItemTaxFullDetails as aj, type TaxRateBreakdown as ak, type TaxBreakdown as al, type FocalPoint as am, type ItemAvailabilityInfo as an, type Scope as ao, type Group as ap, type ModifierGroup as aq, type ItemModifier as ar, type AddressWithContact as as, type Address as at, type StreetAddress as au, type AddressLocation as av, type FullAddressContactDetails as aw, type VatId as ax, type ShippingInfo as ay, type SelectedCarrierServiceOption as az, type CreateCheckoutFromTemplateResponse as b, type CheckoutTemplatesQueryResult as b$, type AppliedDiscount as b0, type AppliedDiscountDiscountSourceOneOf as b1, type Coupon as b2, type MerchantDiscount as b3, type DiscountRule as b4, type DiscountRuleName as b5, type LineItemDiscount as b6, type CustomField as b7, type TaxSummary as b8, type TaxCalculationDetails as b9, type UpdateCheckoutTemplateRequest as bA, type UpdateCheckoutTemplateResponse as bB, type DeleteCheckoutTemplateRequest as bC, type DeleteCheckoutTemplateResponse as bD, type QueryCheckoutTemplatesRequest as bE, type CursorQuery as bF, type CursorQueryPagingMethodOneOf as bG, type Sorting as bH, type CursorPaging as bI, type QueryCheckoutTemplatesResponse as bJ, type CursorPagingMetadata as bK, type Cursors as bL, type CreateCheckoutFromTemplateRequest as bM, type CreateAndRedirectToCheckoutRequest as bN, type HeadersEntry as bO, type DomainEvent as bP, type DomainEventBodyOneOf as bQ, type EntityCreatedEvent as bR, type RestoreInfo as bS, type EntityUpdatedEvent as bT, type EntityDeletedEvent as bU, type ActionEvent as bV, type MessageEnvelope as bW, type IdentificationData as bX, type IdentificationDataIdOneOf as bY, type BaseEventMetadata as bZ, type EventMetadata as b_, type TaxCalculationDetailsCalculationDetailsOneOf as ba, type AutoTaxFallbackCalculationDetails as bb, type AggregatedTaxBreakdown as bc, type CreatedBy as bd, type CreatedByIdOneOf as be, type MembershipOptions as bf, type Membership as bg, type MembershipName as bh, type MembershipPaymentCredits as bi, type InvalidMembership as bj, type SelectedMemberships as bk, type SelectedMembership as bl, type AdditionalFee as bm, type ConversionInfo as bn, type Violation as bo, type Target as bp, type TargetTargetTypeOneOf as bq, type Other as br, type TargetLineItem as bs, type CustomSettings as bt, type SubscriptionCharges as bu, type Charge as bv, type CreateCheckoutTemplateRequest as bw, type CreateCheckoutTemplateResponse as bx, type GetCheckoutTemplateRequest as by, type GetCheckoutTemplateResponse as bz, type CheckoutTemplateCreatedEnvelope as c, type CheckoutTemplateDeletedEnvelope as d, type CheckoutTemplateUpdatedEnvelope as e, type CheckoutTemplateUsedEnvelope as f, SubscriptionFrequency as g, ItemAvailabilityStatus as h, PickupMethod as i, ChargeType as j, RuleType as k, DiscountType as l, RateType as m, FallbackReason as n, ChannelType as o, Severity as p, NameInLineItem as q, SuggestedFix as r, SortOrder as s, WebhookIdentityType as t, type CheckoutCustomization as u, type WebClientCustomization as v, type V1LineItem as w, type CatalogReference as x, type CatalogOverrideFields as y, type ProductName as z };