@wix/auto_sdk_ecom_checkout-templates 1.0.36 → 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} +400 -276
  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} +400 -276
  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} +209 -450
  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} +209 -450
  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 -3161
  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 -2794
  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 -3161
  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 -2794
  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
  /**
@@ -441,7 +427,7 @@ export interface CustomLineItem {
441
427
  */
442
428
  modifierGroups?: V1ModifierGroup[];
443
429
  }
444
- export interface PriceDescription {
430
+ interface PriceDescription {
445
431
  /**
446
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).
447
433
  * @minLength 1
@@ -457,26 +443,20 @@ export interface PriceDescription {
457
443
  */
458
444
  translated?: string | null;
459
445
  }
460
- export interface PageUrlV2 {
461
- /** The relative path for the page within the site. For example, `/product-page/a-product`. */
462
- relativePath?: string;
463
- /** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
464
- url?: string | null;
465
- }
466
- export interface ItemType extends ItemTypeItemTypeDataOneOf {
446
+ interface ItemType extends ItemTypeItemTypeDataOneOf {
467
447
  /** Preset item type. */
468
448
  preset?: ItemTypeItemTypeWithLiterals;
469
449
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
470
450
  custom?: string;
471
451
  }
472
452
  /** @oneof */
473
- export interface ItemTypeItemTypeDataOneOf {
453
+ interface ItemTypeItemTypeDataOneOf {
474
454
  /** Preset item type. */
475
455
  preset?: ItemTypeItemTypeWithLiterals;
476
456
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
477
457
  custom?: string;
478
458
  }
479
- export declare enum ItemTypeItemType {
459
+ declare enum ItemTypeItemType {
480
460
  UNRECOGNISED = "UNRECOGNISED",
481
461
  PHYSICAL = "PHYSICAL",
482
462
  DIGITAL = "DIGITAL",
@@ -484,8 +464,8 @@ export declare enum ItemTypeItemType {
484
464
  SERVICE = "SERVICE"
485
465
  }
486
466
  /** @enumType */
487
- export type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
488
- export interface SubscriptionOptionInfo {
467
+ type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
468
+ interface SubscriptionOptionInfo {
489
469
  /** Subscription option settings. */
490
470
  subscriptionSettings?: SubscriptionSettings;
491
471
  /** Subscription option title. */
@@ -493,7 +473,7 @@ export interface SubscriptionOptionInfo {
493
473
  /** Subscription option description. */
494
474
  description?: Description;
495
475
  }
496
- export interface SubscriptionSettings {
476
+ interface SubscriptionSettings {
497
477
  /** Frequency of recurring payment. */
498
478
  frequency?: SubscriptionFrequencyWithLiterals;
499
479
  /**
@@ -521,7 +501,7 @@ export interface SubscriptionSettings {
521
501
  freeTrialPeriod?: FreeTrialPeriod;
522
502
  }
523
503
  /** Frequency unit of recurring payment */
524
- export declare enum SubscriptionFrequency {
504
+ declare enum SubscriptionFrequency {
525
505
  UNDEFINED = "UNDEFINED",
526
506
  DAY = "DAY",
527
507
  WEEK = "WEEK",
@@ -529,8 +509,8 @@ export declare enum SubscriptionFrequency {
529
509
  YEAR = "YEAR"
530
510
  }
531
511
  /** @enumType */
532
- export type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
533
- export interface FreeTrialPeriod {
512
+ type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
513
+ interface FreeTrialPeriod {
534
514
  /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
535
515
  frequency?: SubscriptionFrequencyWithLiterals;
536
516
  /**
@@ -540,7 +520,7 @@ export interface FreeTrialPeriod {
540
520
  */
541
521
  interval?: number;
542
522
  }
543
- export interface Title {
523
+ interface Title {
544
524
  /**
545
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).
546
526
  * @minLength 1
@@ -556,7 +536,7 @@ export interface Title {
556
536
  */
557
537
  translated?: string | null;
558
538
  }
559
- export interface Description {
539
+ interface Description {
560
540
  /**
561
541
  * Subscription option description.
562
542
  * @maxLength 500
@@ -568,13 +548,13 @@ export interface Description {
568
548
  */
569
549
  translated?: string | null;
570
550
  }
571
- export interface SecuredMedia {
551
+ interface SecuredMedia {
572
552
  /**
573
553
  * Media ID in Wix Media Manager.
574
554
  * @minLength 1
575
555
  * @maxLength 100
576
556
  */
577
- id?: string;
557
+ _id?: string;
578
558
  /**
579
559
  * Original filename.
580
560
  * @minLength 1
@@ -584,7 +564,7 @@ export interface SecuredMedia {
584
564
  /** File type. */
585
565
  fileType?: FileTypeWithLiterals;
586
566
  }
587
- export declare enum FileType {
567
+ declare enum FileType {
588
568
  UNSPECIFIED = "UNSPECIFIED",
589
569
  SECURE_PICTURE = "SECURE_PICTURE",
590
570
  SECURE_VIDEO = "SECURE_VIDEO",
@@ -593,8 +573,8 @@ export declare enum FileType {
593
573
  SECURE_ARCHIVE = "SECURE_ARCHIVE"
594
574
  }
595
575
  /** @enumType */
596
- export type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
597
- export interface ServiceProperties {
576
+ type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
577
+ interface ServiceProperties {
598
578
  /**
599
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.
600
580
  * For example, the start time of a class.
@@ -607,7 +587,7 @@ export interface ServiceProperties {
607
587
  */
608
588
  numberOfParticipants?: number | null;
609
589
  }
610
- export interface Policy {
590
+ interface Policy {
611
591
  /**
612
592
  * Policy title - should be translated
613
593
  * @minLength 1
@@ -621,30 +601,30 @@ export interface Policy {
621
601
  */
622
602
  content?: string;
623
603
  }
624
- export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
604
+ interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
625
605
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
626
606
  addressType?: TaxableAddressTypeWithLiterals;
627
607
  }
628
608
  /** @oneof */
629
- export interface TaxableAddressTaxableAddressDataOneOf {
609
+ interface TaxableAddressTaxableAddressDataOneOf {
630
610
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
631
611
  addressType?: TaxableAddressTypeWithLiterals;
632
612
  }
633
- export declare enum TaxableAddressType {
613
+ declare enum TaxableAddressType {
634
614
  UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
635
615
  BUSINESS = "BUSINESS",
636
616
  BILLING = "BILLING",
637
617
  SHIPPING = "SHIPPING"
638
618
  }
639
619
  /** @enumType */
640
- export type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
641
- export interface V1ModifierGroup {
620
+ type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
621
+ interface V1ModifierGroup {
642
622
  /**
643
623
  * Modifier group id.
644
624
  * @minLength 1
645
625
  * @maxLength 36
646
626
  */
647
- id?: string;
627
+ _id?: string;
648
628
  /** Modifier group name. */
649
629
  name?: TranslatableString;
650
630
  /**
@@ -654,7 +634,7 @@ export interface V1ModifierGroup {
654
634
  */
655
635
  modifiers?: V1ItemModifier[];
656
636
  }
657
- export interface TranslatableString {
637
+ interface TranslatableString {
658
638
  /**
659
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).
660
640
  *
@@ -675,13 +655,13 @@ export interface TranslatableString {
675
655
  */
676
656
  translated?: string | null;
677
657
  }
678
- export interface V1ItemModifier {
658
+ interface V1ItemModifier {
679
659
  /**
680
660
  * Modifier ID.
681
661
  * @minLength 1
682
662
  * @maxLength 36
683
663
  */
684
- id?: string;
664
+ _id?: string;
685
665
  /**
686
666
  * The quantity of this modifier.
687
667
  * @min 1
@@ -698,7 +678,7 @@ export interface V1ItemModifier {
698
678
  */
699
679
  price?: string | null;
700
680
  }
701
- export interface ExtendedFields {
681
+ interface ExtendedFields {
702
682
  /**
703
683
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
704
684
  * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -709,7 +689,7 @@ export interface ExtendedFields {
709
689
  */
710
690
  namespaces?: Record<string, Record<string, any>>;
711
691
  }
712
- export interface CustomContentReference {
692
+ interface CustomContentReference {
713
693
  /**
714
694
  * ID of the app providing the content.
715
695
  *
@@ -725,7 +705,7 @@ export interface CustomContentReference {
725
705
  */
726
706
  componentId?: string;
727
707
  }
728
- export interface ExternalReference {
708
+ interface ExternalReference {
729
709
  /**
730
710
  * ID of the app associated with the purchase flow.
731
711
  * For example, the Wix Pay Links app ID.
@@ -743,19 +723,19 @@ export interface ExternalReference {
743
723
  resourceId?: string | null;
744
724
  }
745
725
  /** Triggered when newly checkout created successfully from checkout template */
746
- export interface CheckoutTemplateUsed {
726
+ interface CheckoutTemplateUsed {
747
727
  /** checkout template */
748
728
  checkoutTemplate?: CheckoutTemplate;
749
729
  /** newly created checkout */
750
730
  checkout?: Checkout;
751
731
  }
752
- export interface Checkout {
732
+ interface Checkout {
753
733
  /**
754
734
  * Checkout ID.
755
735
  * @format GUID
756
736
  * @readonly
757
737
  */
758
- id?: string | null;
738
+ _id?: string | null;
759
739
  /**
760
740
  * Line items.
761
741
  *
@@ -860,12 +840,12 @@ export interface Checkout {
860
840
  * Date and time the checkout was created.
861
841
  * @readonly
862
842
  */
863
- createdDate?: Date | null;
843
+ _createdDate?: Date | null;
864
844
  /**
865
845
  * Date and time the checkout was updated.
866
846
  * @readonly
867
847
  */
868
- updatedDate?: Date | null;
848
+ _updatedDate?: Date | null;
869
849
  /**
870
850
  * Minimal amount to pay in order to place the order.
871
851
  * @readonly
@@ -946,13 +926,13 @@ export interface Checkout {
946
926
  */
947
927
  paymentCurrency?: string;
948
928
  }
949
- export interface LineItem {
929
+ interface LineItem {
950
930
  /**
951
931
  * Line item ID.
952
932
  * @format GUID
953
933
  * @readonly
954
934
  */
955
- id?: string | null;
935
+ _id?: string | null;
956
936
  /**
957
937
  * Item quantity.
958
938
  *
@@ -976,7 +956,7 @@ export interface LineItem {
976
956
  * URL to the item's page on the site.
977
957
  * @readonly
978
958
  */
979
- url?: PageUrlV2;
959
+ url?: string;
980
960
  /**
981
961
  * Item price **after** catalog-defined discount and line item discounts.
982
962
  * @readonly
@@ -1026,7 +1006,7 @@ export interface LineItem {
1026
1006
  * Line item image details.
1027
1007
  * @readonly
1028
1008
  */
1029
- media?: CommonImage;
1009
+ media?: string;
1030
1010
  /**
1031
1011
  * Item availability details.
1032
1012
  * @readonly
@@ -1148,7 +1128,7 @@ export interface LineItem {
1148
1128
  */
1149
1129
  modifiersTotalPrice?: MultiCurrencyPrice;
1150
1130
  }
1151
- export interface MultiCurrencyPrice {
1131
+ interface MultiCurrencyPrice {
1152
1132
  /**
1153
1133
  * Amount.
1154
1134
  * @decimalValue options { gte:0, lte:1000000000000000 }
@@ -1171,7 +1151,7 @@ export interface MultiCurrencyPrice {
1171
1151
  */
1172
1152
  formattedConvertedAmount?: string;
1173
1153
  }
1174
- export interface ItemTaxFullDetails {
1154
+ interface ItemTaxFullDetails {
1175
1155
  /** Amount for which tax is calculated. */
1176
1156
  taxableAmount?: MultiCurrencyPrice;
1177
1157
  /**
@@ -1188,7 +1168,7 @@ export interface ItemTaxFullDetails {
1188
1168
  */
1189
1169
  rateBreakdown?: TaxRateBreakdown[];
1190
1170
  }
1191
- export interface TaxRateBreakdown {
1171
+ interface TaxRateBreakdown {
1192
1172
  /**
1193
1173
  * Name of tax against which the calculation was performed.
1194
1174
  * @maxLength 100
@@ -1206,7 +1186,7 @@ export interface TaxRateBreakdown {
1206
1186
  * TaxBreakdown represents tax information for a line item.
1207
1187
  * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
1208
1188
  */
1209
- export interface TaxBreakdown {
1189
+ interface TaxBreakdown {
1210
1190
  /**
1211
1191
  * The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
1212
1192
  * @maxLength 200
@@ -1238,7 +1218,7 @@ export interface TaxBreakdown {
1238
1218
  jurisdictionType?: JurisdictionTypeWithLiterals;
1239
1219
  }
1240
1220
  /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
1241
- export declare enum JurisdictionType {
1221
+ declare enum JurisdictionType {
1242
1222
  UNDEFINED = "UNDEFINED",
1243
1223
  COUNTRY = "COUNTRY",
1244
1224
  STATE = "STATE",
@@ -1247,31 +1227,8 @@ export declare enum JurisdictionType {
1247
1227
  SPECIAL = "SPECIAL"
1248
1228
  }
1249
1229
  /** @enumType */
1250
- export type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
1251
- export interface CommonImage {
1252
- /** WixMedia image ID. */
1253
- id?: string;
1254
- /** Image URL. */
1255
- url?: string;
1256
- /**
1257
- * Original image height.
1258
- * @readonly
1259
- */
1260
- height?: number;
1261
- /**
1262
- * Original image width.
1263
- * @readonly
1264
- */
1265
- width?: number;
1266
- /** Image alt text. */
1267
- altText?: string | null;
1268
- /**
1269
- * Image filename.
1270
- * @readonly
1271
- */
1272
- filename?: string | null;
1273
- }
1274
- export interface FocalPoint {
1230
+ type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
1231
+ interface FocalPoint {
1275
1232
  /** X-coordinate of the focal point. */
1276
1233
  x?: number;
1277
1234
  /** Y-coordinate of the focal point. */
@@ -1281,13 +1238,13 @@ export interface FocalPoint {
1281
1238
  /** crop by width */
1282
1239
  width?: number | null;
1283
1240
  }
1284
- export interface ItemAvailabilityInfo {
1241
+ interface ItemAvailabilityInfo {
1285
1242
  /** Item availability status. */
1286
1243
  status?: ItemAvailabilityStatusWithLiterals;
1287
1244
  /** Quantity available. */
1288
1245
  quantityAvailable?: number | null;
1289
1246
  }
1290
- export declare enum ItemAvailabilityStatus {
1247
+ declare enum ItemAvailabilityStatus {
1291
1248
  AVAILABLE = "AVAILABLE",
1292
1249
  /** Item does not exist. */
1293
1250
  NOT_FOUND = "NOT_FOUND",
@@ -1297,26 +1254,26 @@ export declare enum ItemAvailabilityStatus {
1297
1254
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
1298
1255
  }
1299
1256
  /** @enumType */
1300
- export type ItemAvailabilityStatusWithLiterals = ItemAvailabilityStatus | 'AVAILABLE' | 'NOT_FOUND' | 'NOT_AVAILABLE' | 'PARTIALLY_AVAILABLE';
1301
- export interface Scope {
1257
+ type ItemAvailabilityStatusWithLiterals = ItemAvailabilityStatus | 'AVAILABLE' | 'NOT_FOUND' | 'NOT_AVAILABLE' | 'PARTIALLY_AVAILABLE';
1258
+ interface Scope {
1302
1259
  /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
1303
1260
  namespace?: string;
1304
1261
  /** Coupon scope's applied group (e.g., event or ticket in Wix Events) */
1305
1262
  group?: Group;
1306
1263
  }
1307
- export interface Group {
1264
+ interface Group {
1308
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). */
1309
1266
  name?: string;
1310
1267
  /** Item ID (when the coupon scope is limited to just one item). */
1311
1268
  entityId?: string | null;
1312
1269
  }
1313
- export interface ModifierGroup {
1270
+ interface ModifierGroup {
1314
1271
  /**
1315
1272
  * Modifier group id.
1316
1273
  * @minLength 1
1317
1274
  * @maxLength 36
1318
1275
  */
1319
- id?: string;
1276
+ _id?: string;
1320
1277
  /** Modifier group name. */
1321
1278
  name?: TranslatableString;
1322
1279
  /**
@@ -1326,13 +1283,13 @@ export interface ModifierGroup {
1326
1283
  */
1327
1284
  modifiers?: ItemModifier[];
1328
1285
  }
1329
- export interface ItemModifier {
1286
+ interface ItemModifier {
1330
1287
  /**
1331
1288
  * Modifier ID.
1332
1289
  * @minLength 1
1333
1290
  * @maxLength 36
1334
1291
  */
1335
- id?: string;
1292
+ _id?: string;
1336
1293
  /**
1337
1294
  * The quantity of this modifier.
1338
1295
  * @min 1
@@ -1347,14 +1304,14 @@ export interface ItemModifier {
1347
1304
  price?: MultiCurrencyPrice;
1348
1305
  }
1349
1306
  /** Billing Info and shipping details */
1350
- export interface AddressWithContact {
1307
+ interface AddressWithContact {
1351
1308
  /** Address. */
1352
1309
  address?: Address;
1353
1310
  /** Contact details. */
1354
1311
  contactDetails?: FullAddressContactDetails;
1355
1312
  }
1356
1313
  /** Physical address */
1357
- export interface Address {
1314
+ interface Address {
1358
1315
  /**
1359
1316
  * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
1360
1317
  * @format COUNTRY
@@ -1381,7 +1338,7 @@ export interface Address {
1381
1338
  * Main address line (usually street name and number).
1382
1339
  * @maxLength 150
1383
1340
  */
1384
- addressLine?: string | null;
1341
+ addressLine1?: string | null;
1385
1342
  /**
1386
1343
  * Free text providing more detailed address info. Usually contains apt, suite, floor.
1387
1344
  * @maxLength 100
@@ -1398,20 +1355,20 @@ export interface Address {
1398
1355
  */
1399
1356
  subdivisionFullname?: string | null;
1400
1357
  }
1401
- export interface StreetAddress {
1358
+ interface StreetAddress {
1402
1359
  /** Street number. */
1403
1360
  number?: string;
1404
1361
  /** Street name. */
1405
1362
  name?: string;
1406
1363
  }
1407
- export interface AddressLocation {
1364
+ interface AddressLocation {
1408
1365
  /** Address latitude. */
1409
1366
  latitude?: number | null;
1410
1367
  /** Address longitude. */
1411
1368
  longitude?: number | null;
1412
1369
  }
1413
1370
  /** Full contact details for an address */
1414
- export interface FullAddressContactDetails {
1371
+ interface FullAddressContactDetails {
1415
1372
  /**
1416
1373
  * First name.
1417
1374
  * @maxLength 100
@@ -1435,9 +1392,9 @@ export interface FullAddressContactDetails {
1435
1392
  /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
1436
1393
  vatId?: VatId;
1437
1394
  }
1438
- export interface VatId {
1395
+ interface VatId {
1439
1396
  /** Customer's tax ID. */
1440
- id?: string;
1397
+ _id?: string;
1441
1398
  /**
1442
1399
  * Tax type.
1443
1400
  *
@@ -1448,7 +1405,7 @@ export interface VatId {
1448
1405
  type?: VatTypeWithLiterals;
1449
1406
  }
1450
1407
  /** tax info types */
1451
- export declare enum VatType {
1408
+ declare enum VatType {
1452
1409
  UNSPECIFIED = "UNSPECIFIED",
1453
1410
  /** CPF - for individual tax payers. */
1454
1411
  CPF = "CPF",
@@ -1456,8 +1413,8 @@ export declare enum VatType {
1456
1413
  CNPJ = "CNPJ"
1457
1414
  }
1458
1415
  /** @enumType */
1459
- export type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
1460
- export interface ShippingInfo {
1416
+ type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
1417
+ interface ShippingInfo {
1461
1418
  /** Shipping address and contact details. */
1462
1419
  shippingDestination?: AddressWithContact;
1463
1420
  /** Selected option out of the options allowed for the `region`. */
@@ -1473,7 +1430,7 @@ export interface ShippingInfo {
1473
1430
  */
1474
1431
  carrierServiceOptions?: CarrierServiceOption[];
1475
1432
  }
1476
- export interface SelectedCarrierServiceOption {
1433
+ interface SelectedCarrierServiceOption {
1477
1434
  /**
1478
1435
  * Unique identifier of selected option. For example, "usps_std_overnight".
1479
1436
  * @maxLength 100
@@ -1521,7 +1478,7 @@ export interface SelectedCarrierServiceOption {
1521
1478
  /** If the delivery solution is a partial and doesn't apply to all items. */
1522
1479
  partial?: boolean | null;
1523
1480
  }
1524
- export interface DeliveryLogistics {
1481
+ interface DeliveryLogistics {
1525
1482
  /**
1526
1483
  * Expected delivery time, in free text. For example, "3-5 business days".
1527
1484
  * @maxLength 500
@@ -1535,7 +1492,7 @@ export interface DeliveryLogistics {
1535
1492
  /** Pickup details. */
1536
1493
  pickupDetails?: PickupDetails;
1537
1494
  }
1538
- export interface PickupDetails {
1495
+ interface PickupDetails {
1539
1496
  /** Pickup address. */
1540
1497
  address?: Address;
1541
1498
  /**
@@ -1546,20 +1503,20 @@ export interface PickupDetails {
1546
1503
  /** Pickup method */
1547
1504
  pickupMethod?: PickupMethodWithLiterals;
1548
1505
  }
1549
- export declare enum PickupMethod {
1506
+ declare enum PickupMethod {
1550
1507
  UNKNOWN_METHOD = "UNKNOWN_METHOD",
1551
1508
  STORE_PICKUP = "STORE_PICKUP",
1552
1509
  PICKUP_POINT = "PICKUP_POINT"
1553
1510
  }
1554
1511
  /** @enumType */
1555
- export type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
1556
- export interface DeliveryTimeSlot {
1512
+ type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
1513
+ interface DeliveryTimeSlot {
1557
1514
  /** starting time of the delivery time slot */
1558
1515
  from?: Date | null;
1559
1516
  /** ending time of the delivery time slot */
1560
1517
  to?: Date | null;
1561
1518
  }
1562
- export interface SelectedCarrierServiceOptionPrices {
1519
+ interface SelectedCarrierServiceOptionPrices {
1563
1520
  /** Total shipping price, after discount and after tax. */
1564
1521
  totalPriceAfterTax?: MultiCurrencyPrice;
1565
1522
  /** Total price of shipping after discounts (when relevant), and before tax. */
@@ -1571,7 +1528,7 @@ export interface SelectedCarrierServiceOptionPrices {
1571
1528
  /** Shipping price before discount and before tax. */
1572
1529
  price?: MultiCurrencyPrice;
1573
1530
  }
1574
- export interface SelectedCarrierServiceOptionOtherCharge {
1531
+ interface SelectedCarrierServiceOptionOtherCharge {
1575
1532
  /** Type of additional cost. */
1576
1533
  type?: ChargeTypeWithLiterals;
1577
1534
  /**
@@ -1582,13 +1539,13 @@ export interface SelectedCarrierServiceOptionOtherCharge {
1582
1539
  /** Price of added charge. */
1583
1540
  cost?: SelectedCarrierServiceOptionPrices;
1584
1541
  }
1585
- export declare enum ChargeType {
1542
+ declare enum ChargeType {
1586
1543
  HANDLING_FEE = "HANDLING_FEE",
1587
1544
  INSURANCE = "INSURANCE"
1588
1545
  }
1589
1546
  /** @enumType */
1590
- export type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE' | 'INSURANCE';
1591
- export interface DeliveryAllocation {
1547
+ type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE' | 'INSURANCE';
1548
+ interface DeliveryAllocation {
1592
1549
  /** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
1593
1550
  deliveryCarrier?: Carrier;
1594
1551
  /** The delivery region that are relevant for this delivery solution. */
@@ -1596,7 +1553,7 @@ export interface DeliveryAllocation {
1596
1553
  /** Populated if the delivery solution is a partially supplied by this carrier. */
1597
1554
  applicableLineItems?: ApplicableLineItems;
1598
1555
  }
1599
- export interface Carrier {
1556
+ interface Carrier {
1600
1557
  /**
1601
1558
  * The carrier app id
1602
1559
  * @format GUID
@@ -1608,19 +1565,19 @@ export interface Carrier {
1608
1565
  */
1609
1566
  code?: string;
1610
1567
  }
1611
- export interface Region {
1568
+ interface Region {
1612
1569
  /**
1613
1570
  * The delivery region id.
1614
1571
  * @format GUID
1615
1572
  */
1616
- id?: string | null;
1573
+ _id?: string | null;
1617
1574
  /**
1618
1575
  * The delivery region name.
1619
1576
  * @maxLength 100
1620
1577
  */
1621
1578
  name?: string | null;
1622
1579
  }
1623
- export interface ApplicableLineItems {
1580
+ interface ApplicableLineItems {
1624
1581
  /**
1625
1582
  * Line items that the delivery solution is for.
1626
1583
  * @maxSize 300
@@ -1629,20 +1586,20 @@ export interface ApplicableLineItems {
1629
1586
  */
1630
1587
  lineItemIds?: string[];
1631
1588
  }
1632
- export interface ShippingRegion {
1589
+ interface ShippingRegion {
1633
1590
  /**
1634
1591
  * Shipping region ID.
1635
1592
  * @format GUID
1636
1593
  * @readonly
1637
1594
  */
1638
- id?: string;
1595
+ _id?: string;
1639
1596
  /**
1640
1597
  * Shipping region name.
1641
1598
  * @maxLength 100
1642
1599
  */
1643
1600
  name?: string;
1644
1601
  }
1645
- export interface CarrierServiceOption {
1602
+ interface CarrierServiceOption {
1646
1603
  /**
1647
1604
  * Carrier ID.
1648
1605
  * @format GUID
@@ -1651,7 +1608,7 @@ export interface CarrierServiceOption {
1651
1608
  /** Shipping options offered by this carrier for this request. */
1652
1609
  shippingOptions?: ShippingOption[];
1653
1610
  }
1654
- export interface ShippingOption {
1611
+ interface ShippingOption {
1655
1612
  /**
1656
1613
  * Unique code of provided shipping option like "usps_std_overnight".
1657
1614
  * For legacy calculators this would be the UUID of the option.
@@ -1676,13 +1633,13 @@ export interface ShippingOption {
1676
1633
  /** If the delivery solution is a partial and doesn't apply to all items. */
1677
1634
  partial?: boolean | null;
1678
1635
  }
1679
- export interface ShippingPrice {
1636
+ interface ShippingPrice {
1680
1637
  /** Shipping price. */
1681
1638
  price?: MultiCurrencyPrice;
1682
1639
  /** Other costs such as insurance, handling & packaging for fragile items, etc. */
1683
1640
  otherCharges?: OtherCharge[];
1684
1641
  }
1685
- export interface OtherCharge {
1642
+ interface OtherCharge {
1686
1643
  /** Type of additional cost. */
1687
1644
  type?: ChargeTypeWithLiterals;
1688
1645
  /** Price of added cost. */
@@ -1693,7 +1650,7 @@ export interface OtherCharge {
1693
1650
  */
1694
1651
  details?: string | null;
1695
1652
  }
1696
- export interface BuyerInfo extends BuyerInfoIdOneOf {
1653
+ interface BuyerInfo extends BuyerInfoIdOneOf {
1697
1654
  /**
1698
1655
  * Visitor ID (if site visitor is **not** a member).
1699
1656
  * @format GUID
@@ -1719,7 +1676,7 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
1719
1676
  email?: string | null;
1720
1677
  }
1721
1678
  /** @oneof */
1722
- export interface BuyerInfoIdOneOf {
1679
+ interface BuyerInfoIdOneOf {
1723
1680
  /**
1724
1681
  * Visitor ID (if site visitor is **not** a member).
1725
1682
  * @format GUID
@@ -1733,7 +1690,7 @@ export interface BuyerInfoIdOneOf {
1733
1690
  */
1734
1691
  memberId?: string;
1735
1692
  }
1736
- export interface PriceSummary {
1693
+ interface PriceSummary {
1737
1694
  /** Subtotal of all line items, before discounts and before tax. */
1738
1695
  subtotal?: MultiCurrencyPrice;
1739
1696
  /** Total shipping price, before discounts and before tax. */
@@ -1747,7 +1704,7 @@ export interface PriceSummary {
1747
1704
  /** Total additional fees price before tax. */
1748
1705
  additionalFees?: MultiCurrencyPrice;
1749
1706
  }
1750
- export interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
1707
+ interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
1751
1708
  /** General shipping calculation error. */
1752
1709
  generalShippingCalculationError?: Details;
1753
1710
  /** Carrier errors. */
@@ -1769,13 +1726,13 @@ export interface CalculationErrors extends CalculationErrorsShippingCalculationE
1769
1726
  discountsCalculationError?: Details;
1770
1727
  }
1771
1728
  /** @oneof */
1772
- export interface CalculationErrorsShippingCalculationErrorOneOf {
1729
+ interface CalculationErrorsShippingCalculationErrorOneOf {
1773
1730
  /** General shipping calculation error. */
1774
1731
  generalShippingCalculationError?: Details;
1775
1732
  /** Carrier errors. */
1776
1733
  carrierErrors?: CarrierErrors;
1777
1734
  }
1778
- export interface Details extends DetailsKindOneOf {
1735
+ interface Details extends DetailsKindOneOf {
1779
1736
  applicationError?: ApplicationError;
1780
1737
  validationError?: ValidationError;
1781
1738
  systemError?: SystemError;
@@ -1786,12 +1743,12 @@ export interface Details extends DetailsKindOneOf {
1786
1743
  tracing?: Record<string, string>;
1787
1744
  }
1788
1745
  /** @oneof */
1789
- export interface DetailsKindOneOf {
1746
+ interface DetailsKindOneOf {
1790
1747
  applicationError?: ApplicationError;
1791
1748
  validationError?: ValidationError;
1792
1749
  systemError?: SystemError;
1793
1750
  }
1794
- export interface ApplicationError {
1751
+ interface ApplicationError {
1795
1752
  /** Error code. */
1796
1753
  code?: string;
1797
1754
  /** Description of the error. */
@@ -1831,10 +1788,10 @@ export interface ApplicationError {
1831
1788
  * ]
1832
1789
  * }
1833
1790
  */
1834
- export interface ValidationError {
1791
+ interface ValidationError {
1835
1792
  fieldViolations?: FieldViolation[];
1836
1793
  }
1837
- export declare enum RuleType {
1794
+ declare enum RuleType {
1838
1795
  VALIDATION = "VALIDATION",
1839
1796
  OTHER = "OTHER",
1840
1797
  MAX = "MAX",
@@ -1858,8 +1815,8 @@ export declare enum RuleType {
1858
1815
  REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
1859
1816
  }
1860
1817
  /** @enumType */
1861
- 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';
1862
- 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 {
1863
1820
  field?: string;
1864
1821
  description?: string;
1865
1822
  violatedRule?: RuleTypeWithLiterals;
@@ -1867,26 +1824,26 @@ export interface FieldViolation {
1867
1824
  ruleName?: string | null;
1868
1825
  data?: Record<string, any> | null;
1869
1826
  }
1870
- export interface SystemError {
1827
+ interface SystemError {
1871
1828
  /** Error code. */
1872
1829
  errorCode?: string | null;
1873
1830
  }
1874
- export interface CarrierErrors {
1831
+ interface CarrierErrors {
1875
1832
  /** Carrier errors. */
1876
1833
  errors?: CarrierError[];
1877
1834
  }
1878
- export interface CarrierError {
1835
+ interface CarrierError {
1879
1836
  /** Carrier ID. */
1880
1837
  carrierId?: string;
1881
1838
  /** Error details. */
1882
1839
  error?: Details;
1883
1840
  }
1884
- export interface GiftCard {
1841
+ interface GiftCard {
1885
1842
  /**
1886
1843
  * Gift Card ID.
1887
1844
  * @deprecated
1888
1845
  */
1889
- id?: string;
1846
+ _id?: string;
1890
1847
  /** Gift card obfuscated code. */
1891
1848
  obfuscatedCode?: string;
1892
1849
  /** Gift card value. */
@@ -1904,7 +1861,7 @@ export interface GiftCard {
1904
1861
  */
1905
1862
  externalId?: string | null;
1906
1863
  }
1907
- export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1864
+ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1908
1865
  /** Coupon details. */
1909
1866
  coupon?: Coupon;
1910
1867
  /** Merchant discount. */
@@ -1923,7 +1880,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1923
1880
  lineItemIds?: string[];
1924
1881
  }
1925
1882
  /** @oneof */
1926
- export interface AppliedDiscountDiscountSourceOneOf {
1883
+ interface AppliedDiscountDiscountSourceOneOf {
1927
1884
  /** Coupon details. */
1928
1885
  coupon?: Coupon;
1929
1886
  /** Merchant discount. */
@@ -1931,17 +1888,17 @@ export interface AppliedDiscountDiscountSourceOneOf {
1931
1888
  /** Discount rule */
1932
1889
  discountRule?: DiscountRule;
1933
1890
  }
1934
- export declare enum DiscountType {
1891
+ declare enum DiscountType {
1935
1892
  GLOBAL = "GLOBAL",
1936
1893
  SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
1937
1894
  SHIPPING = "SHIPPING"
1938
1895
  }
1939
1896
  /** @enumType */
1940
- export type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
1897
+ type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
1941
1898
  /** Coupon */
1942
- export interface Coupon {
1899
+ interface Coupon {
1943
1900
  /** Coupon ID. */
1944
- id?: string;
1901
+ _id?: string;
1945
1902
  /** Coupon code. */
1946
1903
  code?: string;
1947
1904
  /** Coupon value. */
@@ -1949,7 +1906,7 @@ export interface Coupon {
1949
1906
  /** Coupon name. */
1950
1907
  name?: string;
1951
1908
  }
1952
- export interface MerchantDiscount {
1909
+ interface MerchantDiscount {
1953
1910
  /** Discount value. */
1954
1911
  amount?: MultiCurrencyPrice;
1955
1912
  /**
@@ -1959,18 +1916,18 @@ export interface MerchantDiscount {
1959
1916
  */
1960
1917
  percentage?: number | null;
1961
1918
  }
1962
- export interface DiscountRule {
1919
+ interface DiscountRule {
1963
1920
  /**
1964
1921
  * Discount rule ID
1965
1922
  * @format GUID
1966
1923
  */
1967
- id?: string;
1924
+ _id?: string;
1968
1925
  /** Discount rule name */
1969
1926
  name?: DiscountRuleName;
1970
1927
  /** Discount value. */
1971
1928
  amount?: MultiCurrencyPrice;
1972
1929
  }
1973
- export interface DiscountRuleName {
1930
+ interface DiscountRuleName {
1974
1931
  /**
1975
1932
  * Original discount rule name (in site's default language).
1976
1933
  * @minLength 1
@@ -1984,16 +1941,16 @@ export interface DiscountRuleName {
1984
1941
  */
1985
1942
  translated?: string | null;
1986
1943
  }
1987
- export interface LineItemDiscount {
1944
+ interface LineItemDiscount {
1988
1945
  /**
1989
1946
  * ID of line item the discount applies to.
1990
1947
  * @format GUID
1991
1948
  */
1992
- id?: string;
1949
+ _id?: string;
1993
1950
  /** Discount value. */
1994
1951
  totalDiscountAmount?: MultiCurrencyPrice;
1995
1952
  }
1996
- export interface CustomField {
1953
+ interface CustomField {
1997
1954
  /** Custom field value. */
1998
1955
  value?: any;
1999
1956
  /**
@@ -2009,7 +1966,7 @@ export interface CustomField {
2009
1966
  */
2010
1967
  translatedTitle?: string | null;
2011
1968
  }
2012
- export declare enum WeightUnit {
1969
+ declare enum WeightUnit {
2013
1970
  /** Weight unit can't be classified due to an error. */
2014
1971
  UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
2015
1972
  /** Kilograms. */
@@ -2018,8 +1975,8 @@ export declare enum WeightUnit {
2018
1975
  LB = "LB"
2019
1976
  }
2020
1977
  /** @enumType */
2021
- export type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
2022
- export interface TaxSummary {
1978
+ type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
1979
+ interface TaxSummary {
2023
1980
  /**
2024
1981
  * Amount for which tax is calculated, added from line items.
2025
1982
  * @readonly
@@ -2036,7 +1993,7 @@ export interface TaxSummary {
2036
1993
  */
2037
1994
  calculationDetails?: TaxCalculationDetails;
2038
1995
  }
2039
- export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
1996
+ interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
2040
1997
  /** Reason the manual calculation was used. */
2041
1998
  manualRateReason?: ManualCalculationReasonWithLiterals;
2042
1999
  /** Details of the fallback rate calculation. */
@@ -2045,13 +2002,13 @@ export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationD
2045
2002
  rateType?: RateTypeWithLiterals;
2046
2003
  }
2047
2004
  /** @oneof */
2048
- export interface TaxCalculationDetailsCalculationDetailsOneOf {
2005
+ interface TaxCalculationDetailsCalculationDetailsOneOf {
2049
2006
  /** Reason the manual calculation was used. */
2050
2007
  manualRateReason?: ManualCalculationReasonWithLiterals;
2051
2008
  /** Details of the fallback rate calculation. */
2052
2009
  autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
2053
2010
  }
2054
- export declare enum RateType {
2011
+ declare enum RateType {
2055
2012
  /** no tax being collected for this request due to location of purchase */
2056
2013
  NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
2057
2014
  /** manual rate used for calculation */
@@ -2062,34 +2019,34 @@ export declare enum RateType {
2062
2019
  FALLBACK_RATE = "FALLBACK_RATE"
2063
2020
  }
2064
2021
  /** @enumType */
2065
- export type RateTypeWithLiterals = RateType | 'NO_TAX_COLLECTED' | 'MANUAL_RATE' | 'AUTO_RATE' | 'FALLBACK_RATE';
2066
- export declare enum ManualCalculationReason {
2022
+ type RateTypeWithLiterals = RateType | 'NO_TAX_COLLECTED' | 'MANUAL_RATE' | 'AUTO_RATE' | 'FALLBACK_RATE';
2023
+ declare enum ManualCalculationReason {
2067
2024
  /** user set calculator in Business Manager to be Manual */
2068
2025
  GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
2069
2026
  /** specific region is on manual even though Global setting is Auto-tax */
2070
2027
  REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
2071
2028
  }
2072
2029
  /** @enumType */
2073
- export type ManualCalculationReasonWithLiterals = ManualCalculationReason | 'GLOBAL_SETTING_TO_MANUAL' | 'REGION_SETTING_TO_MANUAL';
2074
- export interface AutoTaxFallbackCalculationDetails {
2030
+ type ManualCalculationReasonWithLiterals = ManualCalculationReason | 'GLOBAL_SETTING_TO_MANUAL' | 'REGION_SETTING_TO_MANUAL';
2031
+ interface AutoTaxFallbackCalculationDetails {
2075
2032
  /** reason for fallback */
2076
2033
  fallbackReason?: FallbackReasonWithLiterals;
2077
2034
  /** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
2078
2035
  error?: ApplicationError;
2079
2036
  }
2080
- export declare enum FallbackReason {
2037
+ declare enum FallbackReason {
2081
2038
  /** auto-tax failed to be calculated */
2082
2039
  AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
2083
2040
  /** auto-tax was temporarily deactivated on a system-level */
2084
2041
  AUTO_TAX_DEACTIVATED = "AUTO_TAX_DEACTIVATED"
2085
2042
  }
2086
2043
  /** @enumType */
2087
- export type FallbackReasonWithLiterals = FallbackReason | 'AUTO_TAX_FAILED' | 'AUTO_TAX_DEACTIVATED';
2044
+ type FallbackReasonWithLiterals = FallbackReason | 'AUTO_TAX_FAILED' | 'AUTO_TAX_DEACTIVATED';
2088
2045
  /**
2089
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.
2090
2047
  * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
2091
2048
  */
2092
- export interface AggregatedTaxBreakdown {
2049
+ interface AggregatedTaxBreakdown {
2093
2050
  /**
2094
2051
  * The name of the tax against which this tax amount was calculated.
2095
2052
  * @maxLength 200
@@ -2115,7 +2072,7 @@ export interface AggregatedTaxBreakdown {
2115
2072
  /** The sum of all the tax from line items that calculated by the tax identifiers. */
2116
2073
  aggregatedTaxAmount?: MultiCurrencyPrice;
2117
2074
  }
2118
- export declare enum ChannelType {
2075
+ declare enum ChannelType {
2119
2076
  /** Unspecified sales channel. This value is not supported. */
2120
2077
  UNSPECIFIED = "UNSPECIFIED",
2121
2078
  /** A web client. */
@@ -2150,8 +2107,8 @@ export declare enum ChannelType {
2150
2107
  FAIRE_COM = "FAIRE_COM"
2151
2108
  }
2152
2109
  /** @enumType */
2153
- 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';
2154
- 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 {
2155
2112
  /**
2156
2113
  * User ID. When the order was created by a Wix user on behalf of a buyer.
2157
2114
  * For example, via POS (point of service).
@@ -2175,7 +2132,7 @@ export interface CreatedBy extends CreatedByIdOneOf {
2175
2132
  appId?: string;
2176
2133
  }
2177
2134
  /** @oneof */
2178
- export interface CreatedByIdOneOf {
2135
+ interface CreatedByIdOneOf {
2179
2136
  /**
2180
2137
  * User ID. When the order was created by a Wix user on behalf of a buyer.
2181
2138
  * For example, via POS (point of service).
@@ -2199,7 +2156,7 @@ export interface CreatedByIdOneOf {
2199
2156
  appId?: string;
2200
2157
  }
2201
2158
  /** Reserved for internal use. */
2202
- export interface MembershipOptions {
2159
+ interface MembershipOptions {
2203
2160
  /**
2204
2161
  * Reserved for internal use.
2205
2162
  * @readonly
@@ -2215,13 +2172,13 @@ export interface MembershipOptions {
2215
2172
  /** Selected membership to apply to this checkout. */
2216
2173
  selectedMemberships?: SelectedMemberships;
2217
2174
  }
2218
- export interface Membership {
2175
+ interface Membership {
2219
2176
  /**
2220
2177
  * Membership ID.
2221
2178
  * @minLength 1
2222
2179
  * @maxLength 100
2223
2180
  */
2224
- id?: string;
2181
+ _id?: string;
2225
2182
  /**
2226
2183
  * ID of the application providing this payment option.
2227
2184
  * @format GUID
@@ -2244,7 +2201,7 @@ export interface Membership {
2244
2201
  /** Additional data about this membership. */
2245
2202
  additionalData?: Record<string, any> | null;
2246
2203
  }
2247
- export interface MembershipName {
2204
+ interface MembershipName {
2248
2205
  /**
2249
2206
  * Membership name.
2250
2207
  * @maxLength 100
@@ -2256,7 +2213,7 @@ export interface MembershipName {
2256
2213
  */
2257
2214
  translated?: string | null;
2258
2215
  }
2259
- export interface MembershipPaymentCredits {
2216
+ interface MembershipPaymentCredits {
2260
2217
  /**
2261
2218
  * Membership's total amount of credits.
2262
2219
  * @min 1
@@ -2265,7 +2222,7 @@ export interface MembershipPaymentCredits {
2265
2222
  /** Membership's remaining amount of credits. */
2266
2223
  remaining?: number;
2267
2224
  }
2268
- export interface InvalidMembership {
2225
+ interface InvalidMembership {
2269
2226
  /** Membership details. */
2270
2227
  membership?: Membership;
2271
2228
  /**
@@ -2275,20 +2232,20 @@ export interface InvalidMembership {
2275
2232
  */
2276
2233
  reason?: string;
2277
2234
  }
2278
- export interface SelectedMemberships {
2235
+ interface SelectedMemberships {
2279
2236
  /**
2280
2237
  * Selected memberships.
2281
2238
  * @maxSize 300
2282
2239
  */
2283
2240
  memberships?: SelectedMembership[];
2284
2241
  }
2285
- export interface SelectedMembership {
2242
+ interface SelectedMembership {
2286
2243
  /**
2287
2244
  * Membership ID.
2288
2245
  * @minLength 1
2289
2246
  * @maxLength 100
2290
2247
  */
2291
- id?: string;
2248
+ _id?: string;
2292
2249
  /**
2293
2250
  * ID of the app providing this payment option.
2294
2251
  * @format GUID
@@ -2303,7 +2260,7 @@ export interface SelectedMembership {
2303
2260
  */
2304
2261
  lineItemIds?: string[];
2305
2262
  }
2306
- export interface AdditionalFee {
2263
+ interface AdditionalFee {
2307
2264
  /**
2308
2265
  * Additional fee's unique code (or ID) for future processing.
2309
2266
  * @minLength 1
@@ -2339,7 +2296,7 @@ export interface AdditionalFee {
2339
2296
  /** the source the additional fee was added from */
2340
2297
  source?: AdditionalFeeSourceWithLiterals;
2341
2298
  }
2342
- export declare enum AdditionalFeeSource {
2299
+ declare enum AdditionalFeeSource {
2343
2300
  UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
2344
2301
  /** The additional fee was added by an additional fee service plugin */
2345
2302
  SERVICE_PLUGIN = "SERVICE_PLUGIN",
@@ -2351,8 +2308,8 @@ export declare enum AdditionalFeeSource {
2351
2308
  SHIPPING = "SHIPPING"
2352
2309
  }
2353
2310
  /** @enumType */
2354
- export type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING';
2355
- export interface ConversionInfo {
2311
+ type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING';
2312
+ interface ConversionInfo {
2356
2313
  /**
2357
2314
  * The site currency.
2358
2315
  * @readonly
@@ -2366,7 +2323,7 @@ export interface ConversionInfo {
2366
2323
  */
2367
2324
  conversionRate?: string;
2368
2325
  }
2369
- export interface Violation {
2326
+ interface Violation {
2370
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. */
2371
2328
  severity?: SeverityWithLiterals;
2372
2329
  /** Target location on a checkout or cart page where the violation will be displayed. */
@@ -2378,7 +2335,7 @@ export interface Violation {
2378
2335
  */
2379
2336
  description?: string | null;
2380
2337
  }
2381
- export declare enum Severity {
2338
+ declare enum Severity {
2382
2339
  /** The user is allowed to move forward in the flow. */
2383
2340
  WARNING = "WARNING",
2384
2341
  /**
@@ -2388,55 +2345,53 @@ export declare enum Severity {
2388
2345
  ERROR = "ERROR"
2389
2346
  }
2390
2347
  /** @enumType */
2391
- export type SeverityWithLiterals = Severity | 'WARNING' | 'ERROR';
2392
- export interface Target extends TargetTargetTypeOneOf {
2348
+ type SeverityWithLiterals = Severity | 'WARNING' | 'ERROR';
2349
+ interface Target extends TargetTargetTypeOneOf {
2393
2350
  /** General (other) violation. */
2394
2351
  other?: Other;
2395
2352
  /** Specific line item violation. */
2396
2353
  lineItem?: TargetLineItem;
2397
2354
  }
2398
2355
  /** @oneof */
2399
- export interface TargetTargetTypeOneOf {
2356
+ interface TargetTargetTypeOneOf {
2400
2357
  /** General (other) violation. */
2401
2358
  other?: Other;
2402
2359
  /** Specific line item violation. */
2403
2360
  lineItem?: TargetLineItem;
2404
2361
  }
2405
2362
  /** Available locations on the webpage */
2406
- export declare enum NameInOther {
2363
+ declare enum NameInOther {
2407
2364
  /** Default location, in case no specific location is specified. */
2408
2365
  OTHER_DEFAULT = "OTHER_DEFAULT"
2409
2366
  }
2410
2367
  /** @enumType */
2411
- export type NameInOtherWithLiterals = NameInOther | 'OTHER_DEFAULT';
2368
+ type NameInOtherWithLiterals = NameInOther | 'OTHER_DEFAULT';
2412
2369
  /** Available locations on the line item */
2413
- export declare enum NameInLineItem {
2370
+ declare enum NameInLineItem {
2414
2371
  /** Default location, in case no specific location is specified. */
2415
2372
  LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
2416
2373
  }
2417
2374
  /** @enumType */
2418
- export type NameInLineItemWithLiterals = NameInLineItem | 'LINE_ITEM_DEFAULT';
2419
- export declare enum SuggestedFix {
2375
+ type NameInLineItemWithLiterals = NameInLineItem | 'LINE_ITEM_DEFAULT';
2376
+ declare enum SuggestedFix {
2420
2377
  /** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
2421
2378
  UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
2422
2379
  /** The line item should be removed from the cart or checkout to resolve the violation. */
2423
2380
  REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
2424
2381
  }
2425
- /** @enumType */
2426
- export type SuggestedFixWithLiterals = SuggestedFix | 'UNKNOWN_SUGGESTED_FIX' | 'REMOVE_LINE_ITEM';
2427
2382
  /** General (other) violation. */
2428
- export interface Other {
2383
+ interface Other {
2429
2384
  /** Location on a checkout or a cart page where a general (other) violation will be displayed. */
2430
2385
  name?: NameInOtherWithLiterals;
2431
2386
  }
2432
2387
  /** Specific line item violation. */
2433
- export interface TargetLineItem {
2388
+ interface TargetLineItem {
2434
2389
  /** Location on a checkout or a cart page where the specific line item violation will be displayed. */
2435
2390
  name?: NameInLineItemWithLiterals;
2436
2391
  /** ID of the line item containing the violation. */
2437
- id?: string | null;
2392
+ _id?: string | null;
2438
2393
  }
2439
- export interface CustomSettings {
2394
+ interface CustomSettings {
2440
2395
  /**
2441
2396
  * Whether to restrict the option to add or remove a gift card on the checkout page.
2442
2397
  *
@@ -2462,7 +2417,7 @@ export interface CustomSettings {
2462
2417
  */
2463
2418
  disabledManualPayment?: boolean;
2464
2419
  }
2465
- export interface SubscriptionCharges {
2420
+ interface SubscriptionCharges {
2466
2421
  /**
2467
2422
  * ids of the items the subscription is defined on
2468
2423
  * @format GUID
@@ -2482,7 +2437,7 @@ export interface SubscriptionCharges {
2482
2437
  */
2483
2438
  charges?: Charge[];
2484
2439
  }
2485
- export interface Charge {
2440
+ interface Charge {
2486
2441
  /** The cycle number from which the charge starts. */
2487
2442
  cycleFrom?: number;
2488
2443
  /** The number of cycles for which the charge is applicable. */
@@ -2492,47 +2447,47 @@ export interface Charge {
2492
2447
  /** The billing date from which the charge starts. */
2493
2448
  cycleBillingDate?: Date | null;
2494
2449
  }
2495
- export interface CreateCheckoutTemplateRequest {
2450
+ interface CreateCheckoutTemplateRequest {
2496
2451
  /** Checkout template to create. */
2497
2452
  checkoutTemplate: CheckoutTemplate;
2498
2453
  }
2499
- export interface CreateCheckoutTemplateResponse {
2454
+ interface CreateCheckoutTemplateResponse {
2500
2455
  /** Created checkout template. */
2501
2456
  checkoutTemplate?: CheckoutTemplate;
2502
2457
  }
2503
- export interface GetCheckoutTemplateRequest {
2458
+ interface GetCheckoutTemplateRequest {
2504
2459
  /**
2505
2460
  * ID of the checkout template to retrieve.
2506
2461
  * @format GUID
2507
2462
  */
2508
2463
  checkoutTemplateId: string;
2509
2464
  }
2510
- export interface GetCheckoutTemplateResponse {
2465
+ interface GetCheckoutTemplateResponse {
2511
2466
  /** Retrieved checkout template. */
2512
2467
  checkoutTemplate?: CheckoutTemplate;
2513
2468
  }
2514
- export interface UpdateCheckoutTemplateRequest {
2469
+ interface UpdateCheckoutTemplateRequest {
2515
2470
  /** Checkout template info to update. */
2516
2471
  checkoutTemplate: CheckoutTemplate;
2517
2472
  }
2518
- export interface UpdateCheckoutTemplateResponse {
2473
+ interface UpdateCheckoutTemplateResponse {
2519
2474
  /** Updated checkout template. */
2520
2475
  checkoutTemplate?: CheckoutTemplate;
2521
2476
  }
2522
- export interface DeleteCheckoutTemplateRequest {
2477
+ interface DeleteCheckoutTemplateRequest {
2523
2478
  /**
2524
2479
  * ID of the checkout template to delete.
2525
2480
  * @format GUID
2526
2481
  */
2527
2482
  checkoutTemplateId: string;
2528
2483
  }
2529
- export interface DeleteCheckoutTemplateResponse {
2484
+ interface DeleteCheckoutTemplateResponse {
2530
2485
  }
2531
- export interface QueryCheckoutTemplatesRequest {
2486
+ interface QueryCheckoutTemplatesRequest {
2532
2487
  /** Query options. */
2533
2488
  query?: CursorQuery;
2534
2489
  }
2535
- export interface CursorQuery extends CursorQueryPagingMethodOneOf {
2490
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
2536
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`. */
2537
2492
  cursorPaging?: CursorPaging;
2538
2493
  /**
@@ -2552,25 +2507,25 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
2552
2507
  sort?: Sorting[];
2553
2508
  }
2554
2509
  /** @oneof */
2555
- export interface CursorQueryPagingMethodOneOf {
2510
+ interface CursorQueryPagingMethodOneOf {
2556
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`. */
2557
2512
  cursorPaging?: CursorPaging;
2558
2513
  }
2559
- export interface Sorting {
2514
+ interface Sorting {
2560
2515
  /** Name of the field to sort by. */
2561
2516
  fieldName?: string;
2562
2517
  /** Sort order. */
2563
2518
  order?: SortOrderWithLiterals;
2564
2519
  }
2565
- export declare enum SortOrder {
2520
+ declare enum SortOrder {
2566
2521
  /** Ascending order. */
2567
2522
  ASC = "ASC",
2568
2523
  /** Descending order. */
2569
2524
  DESC = "DESC"
2570
2525
  }
2571
2526
  /** @enumType */
2572
- export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
2573
- export interface CursorPaging {
2527
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
2528
+ interface CursorPaging {
2574
2529
  /**
2575
2530
  * Number of items to load.
2576
2531
  * @max 100
@@ -2585,13 +2540,13 @@ export interface CursorPaging {
2585
2540
  */
2586
2541
  cursor?: string | null;
2587
2542
  }
2588
- export interface QueryCheckoutTemplatesResponse {
2543
+ interface QueryCheckoutTemplatesResponse {
2589
2544
  /** Retrieved checkout templates. */
2590
2545
  checkoutTemplates?: CheckoutTemplate[];
2591
2546
  /** Paging metadata. */
2592
2547
  pagingMetadata?: CursorPagingMetadata;
2593
2548
  }
2594
- export interface CursorPagingMetadata {
2549
+ interface CursorPagingMetadata {
2595
2550
  /** Number of items returned in the response. */
2596
2551
  count?: number | null;
2597
2552
  /** Offset that was requested. */
@@ -2603,13 +2558,13 @@ export interface CursorPagingMetadata {
2603
2558
  */
2604
2559
  hasNext?: boolean | null;
2605
2560
  }
2606
- export interface Cursors {
2561
+ interface Cursors {
2607
2562
  /** Cursor pointing to next page in the list of results. */
2608
2563
  next?: string | null;
2609
2564
  /** Cursor pointing to previous page in the list of results. */
2610
2565
  prev?: string | null;
2611
2566
  }
2612
- export interface CreateCheckoutFromTemplateRequest {
2567
+ interface CreateCheckoutFromTemplateRequest {
2613
2568
  /**
2614
2569
  * ID of the checkout template to use to create a checkout from.
2615
2570
  * @format GUID
@@ -2621,7 +2576,7 @@ export interface CreateCheckoutFromTemplateRequest {
2621
2576
  */
2622
2577
  siteId: string;
2623
2578
  }
2624
- export interface CreateCheckoutFromTemplateResponse {
2579
+ interface CreateCheckoutFromTemplateResponse {
2625
2580
  /**
2626
2581
  * ID of the created checkout.
2627
2582
  * @format GUID
@@ -2635,7 +2590,7 @@ export interface CreateCheckoutFromTemplateResponse {
2635
2590
  */
2636
2591
  purchaseFlowId?: string | null;
2637
2592
  }
2638
- export interface CreateAndRedirectToCheckoutRequest {
2593
+ interface CreateAndRedirectToCheckoutRequest {
2639
2594
  /**
2640
2595
  * ID of the checkout template to use to create a checkout.
2641
2596
  * @format GUID
@@ -2647,22 +2602,22 @@ export interface CreateAndRedirectToCheckoutRequest {
2647
2602
  */
2648
2603
  siteId: string;
2649
2604
  }
2650
- export interface RawHttpResponse {
2605
+ interface RawHttpResponse {
2651
2606
  body?: Uint8Array;
2652
2607
  statusCode?: number | null;
2653
2608
  headers?: HeadersEntry[];
2654
2609
  }
2655
- export interface HeadersEntry {
2610
+ interface HeadersEntry {
2656
2611
  key?: string;
2657
2612
  value?: string;
2658
2613
  }
2659
- export interface DomainEvent extends DomainEventBodyOneOf {
2614
+ interface DomainEvent extends DomainEventBodyOneOf {
2660
2615
  createdEvent?: EntityCreatedEvent;
2661
2616
  updatedEvent?: EntityUpdatedEvent;
2662
2617
  deletedEvent?: EntityDeletedEvent;
2663
2618
  actionEvent?: ActionEvent;
2664
2619
  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2665
- id?: string;
2620
+ _id?: string;
2666
2621
  /**
2667
2622
  * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2668
2623
  * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
@@ -2691,36 +2646,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
2691
2646
  entityEventSequence?: string | null;
2692
2647
  }
2693
2648
  /** @oneof */
2694
- export interface DomainEventBodyOneOf {
2649
+ interface DomainEventBodyOneOf {
2695
2650
  createdEvent?: EntityCreatedEvent;
2696
2651
  updatedEvent?: EntityUpdatedEvent;
2697
2652
  deletedEvent?: EntityDeletedEvent;
2698
2653
  actionEvent?: ActionEvent;
2699
2654
  }
2700
- export interface EntityCreatedEvent {
2701
- entityAsJson?: string;
2702
- /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
2703
- restoreInfo?: RestoreInfo;
2655
+ interface EntityCreatedEvent {
2656
+ entity?: string;
2704
2657
  }
2705
- export interface RestoreInfo {
2658
+ interface RestoreInfo {
2706
2659
  deletedDate?: Date | null;
2707
2660
  }
2708
- export interface EntityUpdatedEvent {
2661
+ interface EntityUpdatedEvent {
2709
2662
  /**
2710
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.
2711
2664
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2712
2665
  * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2713
2666
  */
2714
- currentEntityAsJson?: string;
2667
+ currentEntity?: string;
2715
2668
  }
2716
- export interface EntityDeletedEvent {
2669
+ interface EntityDeletedEvent {
2717
2670
  /** Entity that was deleted. */
2718
- deletedEntityAsJson?: string | null;
2671
+ deletedEntity?: string | null;
2719
2672
  }
2720
- export interface ActionEvent {
2721
- bodyAsJson?: string;
2673
+ interface ActionEvent {
2674
+ body?: string;
2722
2675
  }
2723
- export interface MessageEnvelope {
2676
+ interface MessageEnvelope {
2724
2677
  /**
2725
2678
  * App instance ID.
2726
2679
  * @format GUID
@@ -2736,7 +2689,7 @@ export interface MessageEnvelope {
2736
2689
  /** Stringify payload. */
2737
2690
  data?: string;
2738
2691
  }
2739
- export interface IdentificationData extends IdentificationDataIdOneOf {
2692
+ interface IdentificationData extends IdentificationDataIdOneOf {
2740
2693
  /**
2741
2694
  * ID of a site visitor that has not logged in to the site.
2742
2695
  * @format GUID
@@ -2761,7 +2714,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
2761
2714
  identityType?: WebhookIdentityTypeWithLiterals;
2762
2715
  }
2763
2716
  /** @oneof */
2764
- export interface IdentificationDataIdOneOf {
2717
+ interface IdentificationDataIdOneOf {
2765
2718
  /**
2766
2719
  * ID of a site visitor that has not logged in to the site.
2767
2720
  * @format GUID
@@ -2783,7 +2736,7 @@ export interface IdentificationDataIdOneOf {
2783
2736
  */
2784
2737
  appId?: string;
2785
2738
  }
2786
- export declare enum WebhookIdentityType {
2739
+ declare enum WebhookIdentityType {
2787
2740
  UNKNOWN = "UNKNOWN",
2788
2741
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2789
2742
  MEMBER = "MEMBER",
@@ -2791,4 +2744,175 @@ export declare enum WebhookIdentityType {
2791
2744
  APP = "APP"
2792
2745
  }
2793
2746
  /** @enumType */
2794
- 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 };