@wix/auto_sdk_ecom_checkout-templates 1.0.13 → 1.0.14

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-Dlk9Q0d1.d.mts} +358 -244
  2. package/build/{internal/cjs/src/ecom-v1-checkout-template-checkout-templates.types.d.ts → ecom-v1-checkout-template-checkout-templates.universal-Dlk9Q0d1.d.ts} +358 -244
  3. package/build/index.d.mts +133 -0
  4. package/build/index.d.ts +133 -0
  5. package/build/index.js +1196 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +1136 -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-BDZkX1fX.d.mts} +182 -421
  10. package/build/internal/{es/src/ecom-v1-checkout-template-checkout-templates.universal.d.ts → ecom-v1-checkout-template-checkout-templates.universal-BDZkX1fX.d.ts} +182 -421
  11. package/build/internal/index.d.mts +133 -0
  12. package/build/internal/index.d.ts +133 -0
  13. package/build/internal/index.js +1196 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +1136 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +670 -0
  18. package/build/internal/meta.d.ts +670 -0
  19. package/build/internal/meta.js +479 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +446 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +670 -0
  24. package/build/meta.d.ts +670 -0
  25. package/build/meta.js +479 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +446 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +13 -12
  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 -378
  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 -259
  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 -2966
  54. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.universal.js +0 -728
  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 -368
  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 -2613
  79. package/build/es/src/ecom-v1-checkout-template-checkout-templates.types.js +0 -256
  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 -2966
  82. package/build/es/src/ecom-v1-checkout-template-checkout-templates.universal.js +0 -695
  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 -378
  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 -259
  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 -728
  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 -368
  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 -2613
  131. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.types.js +0 -256
  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 -695
  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
  *
@@ -44,12 +44,12 @@ export interface CheckoutTemplate {
44
44
  */
45
45
  customContentReference?: CustomContentReference;
46
46
  }
47
- export declare enum Status {
47
+ declare enum Status {
48
48
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
49
49
  ACTIVE = "ACTIVE",
50
50
  INACTIVE = "INACTIVE"
51
51
  }
52
- export interface CheckoutCustomization {
52
+ interface CheckoutCustomization {
53
53
  /** Web client customizations. These customizations only apply to the standard Wix checkout page. */
54
54
  webClient?: WebClientCustomization;
55
55
  /**
@@ -71,7 +71,7 @@ export interface CheckoutCustomization {
71
71
  */
72
72
  disabledManualPayment?: boolean;
73
73
  }
74
- export interface WebClientCustomization {
74
+ interface WebClientCustomization {
75
75
  /**
76
76
  * Whether to disable the "Continue shopping" button.
77
77
  *
@@ -85,7 +85,7 @@ export interface WebClientCustomization {
85
85
  */
86
86
  disabledPolicyAgreementCheckbox?: boolean;
87
87
  }
88
- export interface V1LineItem {
88
+ interface V1LineItem {
89
89
  /**
90
90
  * Item quantity.
91
91
  *
@@ -101,7 +101,7 @@ export interface V1LineItem {
101
101
  catalogOverrideFields?: CatalogOverrideFields;
102
102
  }
103
103
  /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
104
- export interface CatalogReference {
104
+ interface CatalogReference {
105
105
  /**
106
106
  * ID of the item within the catalog it belongs to.
107
107
  * @minLength 1
@@ -127,7 +127,7 @@ export interface CatalogReference {
127
127
  */
128
128
  options?: Record<string, any> | null;
129
129
  }
130
- export interface CatalogOverrideFields {
130
+ interface CatalogOverrideFields {
131
131
  /** Item name. */
132
132
  productName?: ProductName;
133
133
  /**
@@ -148,7 +148,7 @@ export interface CatalogOverrideFields {
148
148
  /** Physical properties of the item. */
149
149
  physicalProperties?: PhysicalProperties;
150
150
  /** Item image. */
151
- image?: Image;
151
+ image?: string;
152
152
  /** Payment method selected for the item. */
153
153
  paymentOption?: PaymentOption;
154
154
  /**
@@ -164,7 +164,7 @@ export interface CatalogOverrideFields {
164
164
  */
165
165
  savePaymentMethod?: boolean | null;
166
166
  }
167
- export interface ProductName {
167
+ interface ProductName {
168
168
  /**
169
169
  * __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).
170
170
  *
@@ -185,7 +185,7 @@ export interface ProductName {
185
185
  */
186
186
  translated?: string | null;
187
187
  }
188
- export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
188
+ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
189
189
  /** Description line plain text value. */
190
190
  plainText?: PlainTextValue;
191
191
  /** Description line color value. */
@@ -194,16 +194,16 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
194
194
  name?: DescriptionLineName;
195
195
  }
196
196
  /** @oneof */
197
- export interface DescriptionLineValueOneOf {
197
+ interface DescriptionLineValueOneOf {
198
198
  /** Description line plain text value. */
199
199
  plainText?: PlainTextValue;
200
200
  /** Description line color value. */
201
201
  colorInfo?: Color;
202
202
  }
203
203
  /** @oneof */
204
- export interface DescriptionLineDescriptionLineValueOneOf {
204
+ interface DescriptionLineDescriptionLineValueOneOf {
205
205
  }
206
- export interface DescriptionLineName {
206
+ interface DescriptionLineName {
207
207
  /**
208
208
  * 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).
209
209
  * @maxLength 100
@@ -217,7 +217,7 @@ export interface DescriptionLineName {
217
217
  */
218
218
  translated?: string | null;
219
219
  }
220
- export interface PlainTextValue {
220
+ interface PlainTextValue {
221
221
  /**
222
222
  * 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).
223
223
  * @maxLength 600
@@ -231,7 +231,7 @@ export interface PlainTextValue {
231
231
  */
232
232
  translated?: string | null;
233
233
  }
234
- export interface Color {
234
+ interface Color {
235
235
  /**
236
236
  * 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).
237
237
  * @maxLength 500
@@ -247,7 +247,7 @@ export interface Color {
247
247
  /** HEX or RGB color code for display. */
248
248
  code?: string | null;
249
249
  }
250
- export declare enum DescriptionLineType {
250
+ declare enum DescriptionLineType {
251
251
  /** Unrecognized type. */
252
252
  UNRECOGNISED = "UNRECOGNISED",
253
253
  /** Plain text type. */
@@ -255,7 +255,7 @@ export declare enum DescriptionLineType {
255
255
  /** Color type. */
256
256
  COLOR = "COLOR"
257
257
  }
258
- export interface PhysicalProperties {
258
+ interface PhysicalProperties {
259
259
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
260
260
  weight?: number | null;
261
261
  /**
@@ -266,19 +266,7 @@ export interface PhysicalProperties {
266
266
  /** Whether this line item is shippable. */
267
267
  shippable?: boolean;
268
268
  }
269
- export interface Image {
270
- /** WixMedia image ID. */
271
- id?: string;
272
- /** Original image height. */
273
- height?: number;
274
- /** Original image width. */
275
- width?: number;
276
- /** Image alt text. Optional. */
277
- altText?: string | null;
278
- /** Image filename. Optional. */
279
- filename?: string | null;
280
- }
281
- export interface PaymentOption {
269
+ interface PaymentOption {
282
270
  /**
283
271
  * Type of selected payment option for current item.
284
272
  *
@@ -287,7 +275,7 @@ export interface PaymentOption {
287
275
  value?: PaymentOptionType;
288
276
  }
289
277
  /** Type of selected payment option for catalog item */
290
- export declare enum PaymentOptionType {
278
+ declare enum PaymentOptionType {
291
279
  /** The entire payment for this item happens as part of the checkout. */
292
280
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
293
281
  /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
@@ -299,7 +287,7 @@ export declare enum PaymentOptionType {
299
287
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
300
288
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
301
289
  }
302
- export interface CustomLineItem {
290
+ interface CustomLineItem {
303
291
  /**
304
292
  * Custom line item quantity.
305
293
  *
@@ -325,14 +313,14 @@ export interface CustomLineItem {
325
313
  */
326
314
  descriptionLines?: DescriptionLine[];
327
315
  /** Custom line item's media. */
328
- media?: Image;
316
+ media?: string;
329
317
  /**
330
318
  * Custom line item ID. If passed, `id` must be unique.
331
319
  *
332
320
  * Default: auto-generated ID
333
321
  * @format GUID
334
322
  */
335
- id?: string | null;
323
+ _id?: string | null;
336
324
  /**
337
325
  * Tax group ID for this custom line item.
338
326
  * @format GUID
@@ -341,7 +329,7 @@ export interface CustomLineItem {
341
329
  /** Name of the item or product. */
342
330
  productName?: ProductName;
343
331
  /** 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. */
344
- url?: PageUrlV2;
332
+ url?: string;
345
333
  /** Item type. Either a preset type or custom. */
346
334
  itemType?: ItemType;
347
335
  /**
@@ -411,7 +399,7 @@ export interface CustomLineItem {
411
399
  */
412
400
  savePaymentMethod?: boolean;
413
401
  }
414
- export interface PriceDescription {
402
+ interface PriceDescription {
415
403
  /**
416
404
  * __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).
417
405
  * @minLength 1
@@ -427,33 +415,27 @@ export interface PriceDescription {
427
415
  */
428
416
  translated?: string | null;
429
417
  }
430
- export interface PageUrlV2 {
431
- /** The relative path for the page within the site. For example, `/product-page/a-product`. */
432
- relativePath?: string;
433
- /** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
434
- url?: string | null;
435
- }
436
- export interface ItemType extends ItemTypeItemTypeDataOneOf {
418
+ interface ItemType extends ItemTypeItemTypeDataOneOf {
437
419
  /** Preset item type. */
438
420
  preset?: ItemTypeItemType;
439
421
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
440
422
  custom?: string;
441
423
  }
442
424
  /** @oneof */
443
- export interface ItemTypeItemTypeDataOneOf {
425
+ interface ItemTypeItemTypeDataOneOf {
444
426
  /** Preset item type. */
445
427
  preset?: ItemTypeItemType;
446
428
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
447
429
  custom?: string;
448
430
  }
449
- export declare enum ItemTypeItemType {
431
+ declare enum ItemTypeItemType {
450
432
  UNRECOGNISED = "UNRECOGNISED",
451
433
  PHYSICAL = "PHYSICAL",
452
434
  DIGITAL = "DIGITAL",
453
435
  GIFT_CARD = "GIFT_CARD",
454
436
  SERVICE = "SERVICE"
455
437
  }
456
- export interface SubscriptionOptionInfo {
438
+ interface SubscriptionOptionInfo {
457
439
  /** Subscription option settings. */
458
440
  subscriptionSettings?: SubscriptionSettings;
459
441
  /** Subscription option title. */
@@ -461,7 +443,7 @@ export interface SubscriptionOptionInfo {
461
443
  /** Subscription option description. */
462
444
  description?: Description;
463
445
  }
464
- export interface SubscriptionSettings {
446
+ interface SubscriptionSettings {
465
447
  /** Frequency of recurring payment. */
466
448
  frequency?: SubscriptionFrequency;
467
449
  /**
@@ -482,14 +464,14 @@ export interface SubscriptionSettings {
482
464
  billingCycles?: number | null;
483
465
  }
484
466
  /** Frequency unit of recurring payment */
485
- export declare enum SubscriptionFrequency {
467
+ declare enum SubscriptionFrequency {
486
468
  UNDEFINED = "UNDEFINED",
487
469
  DAY = "DAY",
488
470
  WEEK = "WEEK",
489
471
  MONTH = "MONTH",
490
472
  YEAR = "YEAR"
491
473
  }
492
- export interface FreeTrialPeriod {
474
+ interface FreeTrialPeriod {
493
475
  /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
494
476
  frequency?: SubscriptionFrequency;
495
477
  /**
@@ -499,7 +481,7 @@ export interface FreeTrialPeriod {
499
481
  */
500
482
  interval?: number;
501
483
  }
502
- export interface Title {
484
+ interface Title {
503
485
  /**
504
486
  * 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).
505
487
  * @minLength 1
@@ -515,7 +497,7 @@ export interface Title {
515
497
  */
516
498
  translated?: string | null;
517
499
  }
518
- export interface Description {
500
+ interface Description {
519
501
  /**
520
502
  * Subscription option description.
521
503
  * @maxLength 500
@@ -527,13 +509,13 @@ export interface Description {
527
509
  */
528
510
  translated?: string | null;
529
511
  }
530
- export interface SecuredMedia {
512
+ interface SecuredMedia {
531
513
  /**
532
514
  * Media ID in Wix Media Manager.
533
515
  * @minLength 1
534
516
  * @maxLength 100
535
517
  */
536
- id?: string;
518
+ _id?: string;
537
519
  /**
538
520
  * Original filename.
539
521
  * @minLength 1
@@ -543,7 +525,7 @@ export interface SecuredMedia {
543
525
  /** File type. */
544
526
  fileType?: FileType;
545
527
  }
546
- export declare enum FileType {
528
+ declare enum FileType {
547
529
  UNSPECIFIED = "UNSPECIFIED",
548
530
  SECURE_PICTURE = "SECURE_PICTURE",
549
531
  SECURE_VIDEO = "SECURE_VIDEO",
@@ -551,7 +533,7 @@ export declare enum FileType {
551
533
  SECURE_MUSIC = "SECURE_MUSIC",
552
534
  SECURE_ARCHIVE = "SECURE_ARCHIVE"
553
535
  }
554
- export interface ServiceProperties {
536
+ interface ServiceProperties {
555
537
  /**
556
538
  * 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.
557
539
  * For example, the start time of a class.
@@ -564,7 +546,7 @@ export interface ServiceProperties {
564
546
  */
565
547
  numberOfParticipants?: number | null;
566
548
  }
567
- export interface Policy {
549
+ interface Policy {
568
550
  /**
569
551
  * Policy title - should be translated
570
552
  * @minLength 1
@@ -578,22 +560,22 @@ export interface Policy {
578
560
  */
579
561
  content?: string;
580
562
  }
581
- export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
563
+ interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
582
564
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
583
565
  addressType?: TaxableAddressType;
584
566
  }
585
567
  /** @oneof */
586
- export interface TaxableAddressTaxableAddressDataOneOf {
568
+ interface TaxableAddressTaxableAddressDataOneOf {
587
569
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
588
570
  addressType?: TaxableAddressType;
589
571
  }
590
- export declare enum TaxableAddressType {
572
+ declare enum TaxableAddressType {
591
573
  UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
592
574
  BUSINESS = "BUSINESS",
593
575
  BILLING = "BILLING",
594
576
  SHIPPING = "SHIPPING"
595
577
  }
596
- export interface ExtendedFields {
578
+ interface ExtendedFields {
597
579
  /**
598
580
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
599
581
  * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -604,7 +586,7 @@ export interface ExtendedFields {
604
586
  */
605
587
  namespaces?: Record<string, Record<string, any>>;
606
588
  }
607
- export interface CustomContentReference {
589
+ interface CustomContentReference {
608
590
  /**
609
591
  * ID of the app providing the content.
610
592
  *
@@ -620,7 +602,7 @@ export interface CustomContentReference {
620
602
  */
621
603
  componentId?: string;
622
604
  }
623
- export interface ExternalReference {
605
+ interface ExternalReference {
624
606
  /**
625
607
  * ID of the app associated with the purchase flow.
626
608
  * For example, the Wix Pay Links app ID.
@@ -638,19 +620,19 @@ export interface ExternalReference {
638
620
  resourceId?: string | null;
639
621
  }
640
622
  /** Triggered when newly checkout created successfully from checkout template */
641
- export interface CheckoutTemplateUsed {
623
+ interface CheckoutTemplateUsed {
642
624
  /** checkout template */
643
625
  checkoutTemplate?: CheckoutTemplate;
644
626
  /** newly created checkout */
645
627
  checkout?: Checkout;
646
628
  }
647
- export interface Checkout {
629
+ interface Checkout {
648
630
  /**
649
631
  * Checkout ID.
650
632
  * @format GUID
651
633
  * @readonly
652
634
  */
653
- id?: string | null;
635
+ _id?: string | null;
654
636
  /**
655
637
  * Line items.
656
638
  *
@@ -753,12 +735,12 @@ export interface Checkout {
753
735
  * Date and time the checkout was created.
754
736
  * @readonly
755
737
  */
756
- createdDate?: Date | null;
738
+ _createdDate?: Date | null;
757
739
  /**
758
740
  * Date and time the checkout was updated.
759
741
  * @readonly
760
742
  */
761
- updatedDate?: Date | null;
743
+ _updatedDate?: Date | null;
762
744
  /**
763
745
  * Minimal amount to pay in order to place the order.
764
746
  * @readonly
@@ -822,13 +804,13 @@ export interface Checkout {
822
804
  */
823
805
  businessLocationId?: string | null;
824
806
  }
825
- export interface LineItem {
807
+ interface LineItem {
826
808
  /**
827
809
  * Line item ID.
828
810
  * @format GUID
829
811
  * @readonly
830
812
  */
831
- id?: string | null;
813
+ _id?: string | null;
832
814
  /**
833
815
  * Item quantity.
834
816
  *
@@ -852,7 +834,7 @@ export interface LineItem {
852
834
  * URL to the item's page on the site.
853
835
  * @readonly
854
836
  */
855
- url?: PageUrlV2;
837
+ url?: string;
856
838
  /**
857
839
  * Item price **after** catalog-defined discount and line item discounts.
858
840
  * @readonly
@@ -902,7 +884,7 @@ export interface LineItem {
902
884
  * Line item image details.
903
885
  * @readonly
904
886
  */
905
- media?: CommonImage;
887
+ media?: string;
906
888
  /**
907
889
  * Item availability details.
908
890
  * @readonly
@@ -988,7 +970,7 @@ export interface LineItem {
988
970
  */
989
971
  savePaymentMethod?: boolean;
990
972
  }
991
- export interface MultiCurrencyPrice {
973
+ interface MultiCurrencyPrice {
992
974
  /**
993
975
  * Amount.
994
976
  * @decimalValue options { gte:0, lte:1000000000000000 }
@@ -1011,7 +993,7 @@ export interface MultiCurrencyPrice {
1011
993
  */
1012
994
  formattedConvertedAmount?: string;
1013
995
  }
1014
- export interface ItemTaxFullDetails {
996
+ interface ItemTaxFullDetails {
1015
997
  /** Amount for which tax is calculated. */
1016
998
  taxableAmount?: MultiCurrencyPrice;
1017
999
  /**
@@ -1028,7 +1010,7 @@ export interface ItemTaxFullDetails {
1028
1010
  */
1029
1011
  rateBreakdown?: TaxRateBreakdown[];
1030
1012
  }
1031
- export interface TaxRateBreakdown {
1013
+ interface TaxRateBreakdown {
1032
1014
  /**
1033
1015
  * Name of tax against which the calculation was performed.
1034
1016
  * @maxLength 100
@@ -1046,7 +1028,7 @@ export interface TaxRateBreakdown {
1046
1028
  * TaxBreakdown represents tax information for a line item.
1047
1029
  * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
1048
1030
  */
1049
- export interface TaxBreakdown {
1031
+ interface TaxBreakdown {
1050
1032
  /**
1051
1033
  * The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
1052
1034
  * @maxLength 200
@@ -1078,7 +1060,7 @@ export interface TaxBreakdown {
1078
1060
  jurisdictionType?: JurisdictionType;
1079
1061
  }
1080
1062
  /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
1081
- export declare enum JurisdictionType {
1063
+ declare enum JurisdictionType {
1082
1064
  UNDEFINED = "UNDEFINED",
1083
1065
  COUNTRY = "COUNTRY",
1084
1066
  STATE = "STATE",
@@ -1086,30 +1068,7 @@ export declare enum JurisdictionType {
1086
1068
  CITY = "CITY",
1087
1069
  SPECIAL = "SPECIAL"
1088
1070
  }
1089
- export interface CommonImage {
1090
- /** WixMedia image ID. */
1091
- id?: string;
1092
- /** Image URL. */
1093
- url?: string;
1094
- /**
1095
- * Original image height.
1096
- * @readonly
1097
- */
1098
- height?: number;
1099
- /**
1100
- * Original image width.
1101
- * @readonly
1102
- */
1103
- width?: number;
1104
- /** Image alt text. */
1105
- altText?: string | null;
1106
- /**
1107
- * Image filename.
1108
- * @readonly
1109
- */
1110
- filename?: string | null;
1111
- }
1112
- export interface FocalPoint {
1071
+ interface FocalPoint {
1113
1072
  /** X-coordinate of the focal point. */
1114
1073
  x?: number;
1115
1074
  /** Y-coordinate of the focal point. */
@@ -1119,13 +1078,13 @@ export interface FocalPoint {
1119
1078
  /** crop by width */
1120
1079
  width?: number | null;
1121
1080
  }
1122
- export interface ItemAvailabilityInfo {
1081
+ interface ItemAvailabilityInfo {
1123
1082
  /** Item availability status. */
1124
1083
  status?: ItemAvailabilityStatus;
1125
1084
  /** Quantity available. */
1126
1085
  quantityAvailable?: number | null;
1127
1086
  }
1128
- export declare enum ItemAvailabilityStatus {
1087
+ declare enum ItemAvailabilityStatus {
1129
1088
  AVAILABLE = "AVAILABLE",
1130
1089
  /** Item does not exist. */
1131
1090
  NOT_FOUND = "NOT_FOUND",
@@ -1134,25 +1093,25 @@ export declare enum ItemAvailabilityStatus {
1134
1093
  /** Available quantity is less than requested. */
1135
1094
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
1136
1095
  }
1137
- export interface Scope {
1096
+ interface Scope {
1138
1097
  /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
1139
1098
  namespace?: string;
1140
1099
  /** Coupon scope's applied group (e.g., event or ticket in Wix Events) */
1141
1100
  group?: Group;
1142
1101
  }
1143
- export interface Group {
1102
+ interface Group {
1144
1103
  /** 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). */
1145
1104
  name?: string;
1146
1105
  /** Item ID (when the coupon scope is limited to just one item). */
1147
1106
  entityId?: string | null;
1148
1107
  }
1149
- export interface ModifierGroup {
1108
+ interface ModifierGroup {
1150
1109
  /**
1151
1110
  * Modifier group id.
1152
1111
  * @minLength 1
1153
1112
  * @maxLength 36
1154
1113
  */
1155
- id?: string;
1114
+ _id?: string;
1156
1115
  /** Modifier group name. */
1157
1116
  name?: TranslatableString;
1158
1117
  /**
@@ -1162,7 +1121,7 @@ export interface ModifierGroup {
1162
1121
  */
1163
1122
  modifiers?: ItemModifier[];
1164
1123
  }
1165
- export interface TranslatableString {
1124
+ interface TranslatableString {
1166
1125
  /**
1167
1126
  * __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).
1168
1127
  *
@@ -1183,13 +1142,13 @@ export interface TranslatableString {
1183
1142
  */
1184
1143
  translated?: string | null;
1185
1144
  }
1186
- export interface ItemModifier {
1145
+ interface ItemModifier {
1187
1146
  /**
1188
1147
  * Modifier ID.
1189
1148
  * @minLength 1
1190
1149
  * @maxLength 36
1191
1150
  */
1192
- id?: string;
1151
+ _id?: string;
1193
1152
  /**
1194
1153
  * The quantity of this modifier.
1195
1154
  * @min 1
@@ -1204,14 +1163,14 @@ export interface ItemModifier {
1204
1163
  price?: MultiCurrencyPrice;
1205
1164
  }
1206
1165
  /** Billing Info and shipping details */
1207
- export interface AddressWithContact {
1166
+ interface AddressWithContact {
1208
1167
  /** Address. */
1209
1168
  address?: Address;
1210
1169
  /** Contact details. */
1211
1170
  contactDetails?: FullAddressContactDetails;
1212
1171
  }
1213
1172
  /** Physical address */
1214
- export interface Address {
1173
+ interface Address {
1215
1174
  /**
1216
1175
  * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
1217
1176
  * @format COUNTRY
@@ -1238,7 +1197,7 @@ export interface Address {
1238
1197
  * Main address line (usually street name and number).
1239
1198
  * @maxLength 150
1240
1199
  */
1241
- addressLine?: string | null;
1200
+ addressLine1?: string | null;
1242
1201
  /**
1243
1202
  * Free text providing more detailed address info. Usually contains apt, suite, floor.
1244
1203
  * @maxLength 100
@@ -1255,20 +1214,20 @@ export interface Address {
1255
1214
  */
1256
1215
  subdivisionFullname?: string | null;
1257
1216
  }
1258
- export interface StreetAddress {
1217
+ interface StreetAddress {
1259
1218
  /** Street number. */
1260
1219
  number?: string;
1261
1220
  /** Street name. */
1262
1221
  name?: string;
1263
1222
  }
1264
- export interface AddressLocation {
1223
+ interface AddressLocation {
1265
1224
  /** Address latitude. */
1266
1225
  latitude?: number | null;
1267
1226
  /** Address longitude. */
1268
1227
  longitude?: number | null;
1269
1228
  }
1270
1229
  /** Full contact details for an address */
1271
- export interface FullAddressContactDetails {
1230
+ interface FullAddressContactDetails {
1272
1231
  /**
1273
1232
  * First name.
1274
1233
  * @maxLength 100
@@ -1292,9 +1251,9 @@ export interface FullAddressContactDetails {
1292
1251
  /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
1293
1252
  vatId?: VatId;
1294
1253
  }
1295
- export interface VatId {
1254
+ interface VatId {
1296
1255
  /** Customer's tax ID. */
1297
- id?: string;
1256
+ _id?: string;
1298
1257
  /**
1299
1258
  * Tax type.
1300
1259
  *
@@ -1305,14 +1264,14 @@ export interface VatId {
1305
1264
  type?: VatType;
1306
1265
  }
1307
1266
  /** tax info types */
1308
- export declare enum VatType {
1267
+ declare enum VatType {
1309
1268
  UNSPECIFIED = "UNSPECIFIED",
1310
1269
  /** CPF - for individual tax payers. */
1311
1270
  CPF = "CPF",
1312
1271
  /** CNPJ - for corporations */
1313
1272
  CNPJ = "CNPJ"
1314
1273
  }
1315
- export interface ShippingInfo {
1274
+ interface ShippingInfo {
1316
1275
  /** Shipping address and contact details. */
1317
1276
  shippingDestination?: AddressWithContact;
1318
1277
  /** Selected option out of the options allowed for the `region`. */
@@ -1328,7 +1287,7 @@ export interface ShippingInfo {
1328
1287
  */
1329
1288
  carrierServiceOptions?: CarrierServiceOption[];
1330
1289
  }
1331
- export interface SelectedCarrierServiceOption {
1290
+ interface SelectedCarrierServiceOption {
1332
1291
  /**
1333
1292
  * Unique identifier of selected option. For example, "usps_std_overnight".
1334
1293
  * @maxLength 100
@@ -1371,7 +1330,7 @@ export interface SelectedCarrierServiceOption {
1371
1330
  /** If the delivery solution is a partial and doesn't apply to all items. */
1372
1331
  partial?: boolean | null;
1373
1332
  }
1374
- export interface DeliveryLogistics {
1333
+ interface DeliveryLogistics {
1375
1334
  /**
1376
1335
  * Expected delivery time, in free text. For example, "3-5 business days".
1377
1336
  * @maxLength 500
@@ -1385,7 +1344,7 @@ export interface DeliveryLogistics {
1385
1344
  /** Pickup details. */
1386
1345
  pickupDetails?: PickupDetails;
1387
1346
  }
1388
- export interface PickupDetails {
1347
+ interface PickupDetails {
1389
1348
  /** Pickup address. */
1390
1349
  address?: Address;
1391
1350
  /**
@@ -1396,18 +1355,18 @@ export interface PickupDetails {
1396
1355
  /** Pickup method */
1397
1356
  pickupMethod?: PickupMethod;
1398
1357
  }
1399
- export declare enum PickupMethod {
1358
+ declare enum PickupMethod {
1400
1359
  UNKNOWN_METHOD = "UNKNOWN_METHOD",
1401
1360
  STORE_PICKUP = "STORE_PICKUP",
1402
1361
  PICKUP_POINT = "PICKUP_POINT"
1403
1362
  }
1404
- export interface DeliveryTimeSlot {
1363
+ interface DeliveryTimeSlot {
1405
1364
  /** starting time of the delivery time slot */
1406
1365
  from?: Date | null;
1407
1366
  /** ending time of the delivery time slot */
1408
1367
  to?: Date | null;
1409
1368
  }
1410
- export interface SelectedCarrierServiceOptionPrices {
1369
+ interface SelectedCarrierServiceOptionPrices {
1411
1370
  /** Total shipping price, after discount and after tax. */
1412
1371
  totalPriceAfterTax?: MultiCurrencyPrice;
1413
1372
  /** Total price of shipping after discounts (when relevant), and before tax. */
@@ -1419,7 +1378,7 @@ export interface SelectedCarrierServiceOptionPrices {
1419
1378
  /** Shipping price before discount and before tax. */
1420
1379
  price?: MultiCurrencyPrice;
1421
1380
  }
1422
- export interface SelectedCarrierServiceOptionOtherCharge {
1381
+ interface SelectedCarrierServiceOptionOtherCharge {
1423
1382
  /** Type of additional cost. */
1424
1383
  type?: ChargeType;
1425
1384
  /**
@@ -1430,11 +1389,11 @@ export interface SelectedCarrierServiceOptionOtherCharge {
1430
1389
  /** Price of added charge. */
1431
1390
  cost?: SelectedCarrierServiceOptionPrices;
1432
1391
  }
1433
- export declare enum ChargeType {
1392
+ declare enum ChargeType {
1434
1393
  HANDLING_FEE = "HANDLING_FEE",
1435
1394
  INSURANCE = "INSURANCE"
1436
1395
  }
1437
- export interface DeliveryAllocation {
1396
+ interface DeliveryAllocation {
1438
1397
  /** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
1439
1398
  deliveryCarrier?: Carrier;
1440
1399
  /** The delivery region that are relevant for this delivery solution. */
@@ -1442,7 +1401,7 @@ export interface DeliveryAllocation {
1442
1401
  /** Populated if the delivery solution is a partially supplied by this carrier. */
1443
1402
  applicableLineItems?: ApplicableLineItems;
1444
1403
  }
1445
- export interface Carrier {
1404
+ interface Carrier {
1446
1405
  /**
1447
1406
  * The carrier app id
1448
1407
  * @format GUID
@@ -1454,19 +1413,19 @@ export interface Carrier {
1454
1413
  */
1455
1414
  code?: string;
1456
1415
  }
1457
- export interface Region {
1416
+ interface Region {
1458
1417
  /**
1459
1418
  * The delivery region id.
1460
1419
  * @format GUID
1461
1420
  */
1462
- id?: string | null;
1421
+ _id?: string | null;
1463
1422
  /**
1464
1423
  * The delivery region name.
1465
1424
  * @maxLength 100
1466
1425
  */
1467
1426
  name?: string | null;
1468
1427
  }
1469
- export interface ApplicableLineItems {
1428
+ interface ApplicableLineItems {
1470
1429
  /**
1471
1430
  * Line items that the delivery solution is for.
1472
1431
  * @maxSize 300
@@ -1475,20 +1434,20 @@ export interface ApplicableLineItems {
1475
1434
  */
1476
1435
  lineItemIds?: string[];
1477
1436
  }
1478
- export interface ShippingRegion {
1437
+ interface ShippingRegion {
1479
1438
  /**
1480
1439
  * Shipping region ID.
1481
1440
  * @format GUID
1482
1441
  * @readonly
1483
1442
  */
1484
- id?: string;
1443
+ _id?: string;
1485
1444
  /**
1486
1445
  * Shipping region name.
1487
1446
  * @maxLength 100
1488
1447
  */
1489
1448
  name?: string;
1490
1449
  }
1491
- export interface CarrierServiceOption {
1450
+ interface CarrierServiceOption {
1492
1451
  /**
1493
1452
  * Carrier ID.
1494
1453
  * @format GUID
@@ -1497,7 +1456,7 @@ export interface CarrierServiceOption {
1497
1456
  /** Shipping options offered by this carrier for this request. */
1498
1457
  shippingOptions?: ShippingOption[];
1499
1458
  }
1500
- export interface ShippingOption {
1459
+ interface ShippingOption {
1501
1460
  /**
1502
1461
  * Unique code of provided shipping option like "usps_std_overnight".
1503
1462
  * For legacy calculators this would be the UUID of the option.
@@ -1522,19 +1481,19 @@ export interface ShippingOption {
1522
1481
  /** If the delivery solution is a partial and doesn't apply to all items. */
1523
1482
  partial?: boolean | null;
1524
1483
  }
1525
- export interface ShippingPrice {
1484
+ interface ShippingPrice {
1526
1485
  /** Shipping price. */
1527
1486
  price?: MultiCurrencyPrice;
1528
1487
  /** Other costs such as insurance, handling & packaging for fragile items, etc. */
1529
1488
  otherCharges?: OtherCharge[];
1530
1489
  }
1531
- export interface OtherCharge {
1490
+ interface OtherCharge {
1532
1491
  /** Type of additional cost. */
1533
1492
  type?: ChargeType;
1534
1493
  /** Price of added cost. */
1535
1494
  price?: MultiCurrencyPrice;
1536
1495
  }
1537
- export interface BuyerInfo extends BuyerInfoIdOneOf {
1496
+ interface BuyerInfo extends BuyerInfoIdOneOf {
1538
1497
  /**
1539
1498
  * Visitor ID (if site visitor is **not** a member).
1540
1499
  * @format GUID
@@ -1560,7 +1519,7 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
1560
1519
  email?: string | null;
1561
1520
  }
1562
1521
  /** @oneof */
1563
- export interface BuyerInfoIdOneOf {
1522
+ interface BuyerInfoIdOneOf {
1564
1523
  /**
1565
1524
  * Visitor ID (if site visitor is **not** a member).
1566
1525
  * @format GUID
@@ -1574,7 +1533,7 @@ export interface BuyerInfoIdOneOf {
1574
1533
  */
1575
1534
  memberId?: string;
1576
1535
  }
1577
- export interface PriceSummary {
1536
+ interface PriceSummary {
1578
1537
  /** Subtotal of all line items, before discounts and before tax. */
1579
1538
  subtotal?: MultiCurrencyPrice;
1580
1539
  /** Total shipping price, before discounts and before tax. */
@@ -1588,7 +1547,7 @@ export interface PriceSummary {
1588
1547
  /** Total additional fees price before tax. */
1589
1548
  additionalFees?: MultiCurrencyPrice;
1590
1549
  }
1591
- export interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
1550
+ interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
1592
1551
  /** General shipping calculation error. */
1593
1552
  generalShippingCalculationError?: Details;
1594
1553
  /** Carrier errors. */
@@ -1610,13 +1569,13 @@ export interface CalculationErrors extends CalculationErrorsShippingCalculationE
1610
1569
  discountsCalculationError?: Details;
1611
1570
  }
1612
1571
  /** @oneof */
1613
- export interface CalculationErrorsShippingCalculationErrorOneOf {
1572
+ interface CalculationErrorsShippingCalculationErrorOneOf {
1614
1573
  /** General shipping calculation error. */
1615
1574
  generalShippingCalculationError?: Details;
1616
1575
  /** Carrier errors. */
1617
1576
  carrierErrors?: CarrierErrors;
1618
1577
  }
1619
- export interface Details extends DetailsKindOneOf {
1578
+ interface Details extends DetailsKindOneOf {
1620
1579
  applicationError?: ApplicationError;
1621
1580
  validationError?: ValidationError;
1622
1581
  systemError?: SystemError;
@@ -1627,12 +1586,12 @@ export interface Details extends DetailsKindOneOf {
1627
1586
  tracing?: Record<string, string>;
1628
1587
  }
1629
1588
  /** @oneof */
1630
- export interface DetailsKindOneOf {
1589
+ interface DetailsKindOneOf {
1631
1590
  applicationError?: ApplicationError;
1632
1591
  validationError?: ValidationError;
1633
1592
  systemError?: SystemError;
1634
1593
  }
1635
- export interface ApplicationError {
1594
+ interface ApplicationError {
1636
1595
  /** Error code. */
1637
1596
  code?: string;
1638
1597
  /** Description of the error. */
@@ -1672,10 +1631,10 @@ export interface ApplicationError {
1672
1631
  * ]
1673
1632
  * }
1674
1633
  */
1675
- export interface ValidationError {
1634
+ interface ValidationError {
1676
1635
  fieldViolations?: FieldViolation[];
1677
1636
  }
1678
- export declare enum RuleType {
1637
+ declare enum RuleType {
1679
1638
  VALIDATION = "VALIDATION",
1680
1639
  OTHER = "OTHER",
1681
1640
  MAX = "MAX",
@@ -1698,7 +1657,7 @@ export declare enum RuleType {
1698
1657
  EXACT_SIZE = "EXACT_SIZE",
1699
1658
  REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
1700
1659
  }
1701
- export interface FieldViolation {
1660
+ interface FieldViolation {
1702
1661
  field?: string;
1703
1662
  description?: string;
1704
1663
  violatedRule?: RuleType;
@@ -1706,26 +1665,26 @@ export interface FieldViolation {
1706
1665
  ruleName?: string | null;
1707
1666
  data?: Record<string, any> | null;
1708
1667
  }
1709
- export interface SystemError {
1668
+ interface SystemError {
1710
1669
  /** Error code. */
1711
1670
  errorCode?: string | null;
1712
1671
  }
1713
- export interface CarrierErrors {
1672
+ interface CarrierErrors {
1714
1673
  /** Carrier errors. */
1715
1674
  errors?: CarrierError[];
1716
1675
  }
1717
- export interface CarrierError {
1676
+ interface CarrierError {
1718
1677
  /** Carrier ID. */
1719
1678
  carrierId?: string;
1720
1679
  /** Error details. */
1721
1680
  error?: Details;
1722
1681
  }
1723
- export interface GiftCard {
1682
+ interface GiftCard {
1724
1683
  /**
1725
1684
  * Gift Card ID.
1726
1685
  * @deprecated
1727
1686
  */
1728
- id?: string;
1687
+ _id?: string;
1729
1688
  /** Gift card obfuscated code. */
1730
1689
  obfuscatedCode?: string;
1731
1690
  /** Gift card value. */
@@ -1743,7 +1702,7 @@ export interface GiftCard {
1743
1702
  */
1744
1703
  externalId?: string | null;
1745
1704
  }
1746
- export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1705
+ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1747
1706
  /** Coupon details. */
1748
1707
  coupon?: Coupon;
1749
1708
  /** Merchant discount. */
@@ -1762,7 +1721,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1762
1721
  lineItemIds?: string[];
1763
1722
  }
1764
1723
  /** @oneof */
1765
- export interface AppliedDiscountDiscountSourceOneOf {
1724
+ interface AppliedDiscountDiscountSourceOneOf {
1766
1725
  /** Coupon details. */
1767
1726
  coupon?: Coupon;
1768
1727
  /** Merchant discount. */
@@ -1770,15 +1729,15 @@ export interface AppliedDiscountDiscountSourceOneOf {
1770
1729
  /** Discount rule */
1771
1730
  discountRule?: DiscountRule;
1772
1731
  }
1773
- export declare enum DiscountType {
1732
+ declare enum DiscountType {
1774
1733
  GLOBAL = "GLOBAL",
1775
1734
  SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
1776
1735
  SHIPPING = "SHIPPING"
1777
1736
  }
1778
1737
  /** Coupon */
1779
- export interface Coupon {
1738
+ interface Coupon {
1780
1739
  /** Coupon ID. */
1781
- id?: string;
1740
+ _id?: string;
1782
1741
  /** Coupon code. */
1783
1742
  code?: string;
1784
1743
  /** Coupon value. */
@@ -1786,7 +1745,7 @@ export interface Coupon {
1786
1745
  /** Coupon name. */
1787
1746
  name?: string;
1788
1747
  }
1789
- export interface MerchantDiscount {
1748
+ interface MerchantDiscount {
1790
1749
  /** Discount value. */
1791
1750
  amount?: MultiCurrencyPrice;
1792
1751
  /**
@@ -1796,18 +1755,18 @@ export interface MerchantDiscount {
1796
1755
  */
1797
1756
  percentage?: number | null;
1798
1757
  }
1799
- export interface DiscountRule {
1758
+ interface DiscountRule {
1800
1759
  /**
1801
1760
  * Discount rule ID
1802
1761
  * @format GUID
1803
1762
  */
1804
- id?: string;
1763
+ _id?: string;
1805
1764
  /** Discount rule name */
1806
1765
  name?: DiscountRuleName;
1807
1766
  /** Discount value. */
1808
1767
  amount?: MultiCurrencyPrice;
1809
1768
  }
1810
- export interface DiscountRuleName {
1769
+ interface DiscountRuleName {
1811
1770
  /**
1812
1771
  * Original discount rule name (in site's default language).
1813
1772
  * @minLength 1
@@ -1821,16 +1780,16 @@ export interface DiscountRuleName {
1821
1780
  */
1822
1781
  translated?: string | null;
1823
1782
  }
1824
- export interface LineItemDiscount {
1783
+ interface LineItemDiscount {
1825
1784
  /**
1826
1785
  * ID of line item the discount applies to.
1827
1786
  * @format GUID
1828
1787
  */
1829
- id?: string;
1788
+ _id?: string;
1830
1789
  /** Discount value. */
1831
1790
  totalDiscountAmount?: MultiCurrencyPrice;
1832
1791
  }
1833
- export interface CustomField {
1792
+ interface CustomField {
1834
1793
  /** Custom field value. */
1835
1794
  value?: any;
1836
1795
  /**
@@ -1846,7 +1805,7 @@ export interface CustomField {
1846
1805
  */
1847
1806
  translatedTitle?: string | null;
1848
1807
  }
1849
- export declare enum WeightUnit {
1808
+ declare enum WeightUnit {
1850
1809
  /** Weight unit can't be classified due to an error. */
1851
1810
  UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
1852
1811
  /** Kilograms. */
@@ -1854,7 +1813,7 @@ export declare enum WeightUnit {
1854
1813
  /** Pounds. */
1855
1814
  LB = "LB"
1856
1815
  }
1857
- export interface TaxSummary {
1816
+ interface TaxSummary {
1858
1817
  /**
1859
1818
  * Amount for which tax is calculated, added from line items.
1860
1819
  * @readonly
@@ -1871,7 +1830,7 @@ export interface TaxSummary {
1871
1830
  */
1872
1831
  calculationDetails?: TaxCalculationDetails;
1873
1832
  }
1874
- export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
1833
+ interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
1875
1834
  /** Reason the manual calculation was used. */
1876
1835
  manualRateReason?: ManualCalculationReason;
1877
1836
  /** Details of the fallback rate calculation. */
@@ -1880,13 +1839,13 @@ export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationD
1880
1839
  rateType?: RateType;
1881
1840
  }
1882
1841
  /** @oneof */
1883
- export interface TaxCalculationDetailsCalculationDetailsOneOf {
1842
+ interface TaxCalculationDetailsCalculationDetailsOneOf {
1884
1843
  /** Reason the manual calculation was used. */
1885
1844
  manualRateReason?: ManualCalculationReason;
1886
1845
  /** Details of the fallback rate calculation. */
1887
1846
  autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
1888
1847
  }
1889
- export declare enum RateType {
1848
+ declare enum RateType {
1890
1849
  /** no tax being collected for this request due to location of purchase */
1891
1850
  NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
1892
1851
  /** manual rate used for calculation */
@@ -1896,19 +1855,19 @@ export declare enum RateType {
1896
1855
  /** fallback rate used for calculation */
1897
1856
  FALLBACK_RATE = "FALLBACK_RATE"
1898
1857
  }
1899
- export declare enum ManualCalculationReason {
1858
+ declare enum ManualCalculationReason {
1900
1859
  /** user set calculator in Business Manager to be Manual */
1901
1860
  GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
1902
1861
  /** specific region is on manual even though Global setting is Auto-tax */
1903
1862
  REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
1904
1863
  }
1905
- export interface AutoTaxFallbackCalculationDetails {
1864
+ interface AutoTaxFallbackCalculationDetails {
1906
1865
  /** reason for fallback */
1907
1866
  fallbackReason?: FallbackReason;
1908
1867
  /** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
1909
1868
  error?: ApplicationError;
1910
1869
  }
1911
- export declare enum FallbackReason {
1870
+ declare enum FallbackReason {
1912
1871
  /** auto-tax failed to be calculated */
1913
1872
  AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
1914
1873
  /** auto-tax was temporarily deactivated on a system-level */
@@ -1918,7 +1877,7 @@ export declare enum FallbackReason {
1918
1877
  * 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.
1919
1878
  * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
1920
1879
  */
1921
- export interface AggregatedTaxBreakdown {
1880
+ interface AggregatedTaxBreakdown {
1922
1881
  /**
1923
1882
  * The name of the tax against which this tax amount was calculated.
1924
1883
  * @maxLength 200
@@ -1944,7 +1903,7 @@ export interface AggregatedTaxBreakdown {
1944
1903
  /** The sum of all the tax from line items that calculated by the tax identifiers. */
1945
1904
  aggregatedTaxAmount?: MultiCurrencyPrice;
1946
1905
  }
1947
- export declare enum ChannelType {
1906
+ declare enum ChannelType {
1948
1907
  /** Unspecified sales channel. This value is not supported. */
1949
1908
  UNSPECIFIED = "UNSPECIFIED",
1950
1909
  /** A web client. */
@@ -1978,7 +1937,7 @@ export declare enum ChannelType {
1978
1937
  /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
1979
1938
  FAIRE_COM = "FAIRE_COM"
1980
1939
  }
1981
- export interface CreatedBy extends CreatedByIdOneOf {
1940
+ interface CreatedBy extends CreatedByIdOneOf {
1982
1941
  /**
1983
1942
  * User ID. When the order was created by a Wix user on behalf of a buyer.
1984
1943
  * For example, via POS (point of service).
@@ -2002,7 +1961,7 @@ export interface CreatedBy extends CreatedByIdOneOf {
2002
1961
  appId?: string;
2003
1962
  }
2004
1963
  /** @oneof */
2005
- export interface CreatedByIdOneOf {
1964
+ interface CreatedByIdOneOf {
2006
1965
  /**
2007
1966
  * User ID. When the order was created by a Wix user on behalf of a buyer.
2008
1967
  * For example, via POS (point of service).
@@ -2026,7 +1985,7 @@ export interface CreatedByIdOneOf {
2026
1985
  appId?: string;
2027
1986
  }
2028
1987
  /** Reserved for internal use. */
2029
- export interface MembershipOptions {
1988
+ interface MembershipOptions {
2030
1989
  /**
2031
1990
  * Reserved for internal use.
2032
1991
  * @readonly
@@ -2042,13 +2001,13 @@ export interface MembershipOptions {
2042
2001
  /** Selected membership to apply to this checkout. */
2043
2002
  selectedMemberships?: SelectedMemberships;
2044
2003
  }
2045
- export interface Membership {
2004
+ interface Membership {
2046
2005
  /**
2047
2006
  * Membership ID.
2048
2007
  * @minLength 1
2049
2008
  * @maxLength 100
2050
2009
  */
2051
- id?: string;
2010
+ _id?: string;
2052
2011
  /**
2053
2012
  * ID of the application providing this payment option.
2054
2013
  * @format GUID
@@ -2071,7 +2030,7 @@ export interface Membership {
2071
2030
  /** Additional data about this membership. */
2072
2031
  additionalData?: Record<string, any> | null;
2073
2032
  }
2074
- export interface MembershipName {
2033
+ interface MembershipName {
2075
2034
  /**
2076
2035
  * Membership name.
2077
2036
  * @maxLength 100
@@ -2083,7 +2042,7 @@ export interface MembershipName {
2083
2042
  */
2084
2043
  translated?: string | null;
2085
2044
  }
2086
- export interface MembershipPaymentCredits {
2045
+ interface MembershipPaymentCredits {
2087
2046
  /**
2088
2047
  * Membership's total amount of credits.
2089
2048
  * @min 1
@@ -2092,7 +2051,7 @@ export interface MembershipPaymentCredits {
2092
2051
  /** Membership's remaining amount of credits. */
2093
2052
  remaining?: number;
2094
2053
  }
2095
- export interface InvalidMembership {
2054
+ interface InvalidMembership {
2096
2055
  /** Membership details. */
2097
2056
  membership?: Membership;
2098
2057
  /**
@@ -2102,20 +2061,20 @@ export interface InvalidMembership {
2102
2061
  */
2103
2062
  reason?: string;
2104
2063
  }
2105
- export interface SelectedMemberships {
2064
+ interface SelectedMemberships {
2106
2065
  /**
2107
2066
  * Selected memberships.
2108
2067
  * @maxSize 300
2109
2068
  */
2110
2069
  memberships?: SelectedMembership[];
2111
2070
  }
2112
- export interface SelectedMembership {
2071
+ interface SelectedMembership {
2113
2072
  /**
2114
2073
  * Membership ID.
2115
2074
  * @minLength 1
2116
2075
  * @maxLength 100
2117
2076
  */
2118
- id?: string;
2077
+ _id?: string;
2119
2078
  /**
2120
2079
  * ID of the app providing this payment option.
2121
2080
  * @format GUID
@@ -2130,7 +2089,7 @@ export interface SelectedMembership {
2130
2089
  */
2131
2090
  lineItemIds?: string[];
2132
2091
  }
2133
- export interface AdditionalFee {
2092
+ interface AdditionalFee {
2134
2093
  /**
2135
2094
  * Additional fee's unique code (or ID) for future processing.
2136
2095
  * @minLength 1
@@ -2166,7 +2125,7 @@ export interface AdditionalFee {
2166
2125
  /** the source the additional fee was added from */
2167
2126
  source?: AdditionalFeeSource;
2168
2127
  }
2169
- export declare enum AdditionalFeeSource {
2128
+ declare enum AdditionalFeeSource {
2170
2129
  UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
2171
2130
  /** The additional fee was added by an additional fee service plugin */
2172
2131
  SERVICE_PLUGIN = "SERVICE_PLUGIN",
@@ -2175,7 +2134,7 @@ export declare enum AdditionalFeeSource {
2175
2134
  /** The additional fee was added manually on the request */
2176
2135
  MANUAL = "MANUAL"
2177
2136
  }
2178
- export interface ConversionInfo {
2137
+ interface ConversionInfo {
2179
2138
  /**
2180
2139
  * The site currency.
2181
2140
  * @readonly
@@ -2189,7 +2148,7 @@ export interface ConversionInfo {
2189
2148
  */
2190
2149
  conversionRate?: string;
2191
2150
  }
2192
- export interface Violation {
2151
+ interface Violation {
2193
2152
  /** 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. */
2194
2153
  severity?: Severity;
2195
2154
  /** Target location on a checkout or cart page where the violation will be displayed. */
@@ -2201,7 +2160,7 @@ export interface Violation {
2201
2160
  */
2202
2161
  description?: string | null;
2203
2162
  }
2204
- export declare enum Severity {
2163
+ declare enum Severity {
2205
2164
  /** The user is allowed to move forward in the flow. */
2206
2165
  WARNING = "WARNING",
2207
2166
  /**
@@ -2210,48 +2169,48 @@ export declare enum Severity {
2210
2169
  */
2211
2170
  ERROR = "ERROR"
2212
2171
  }
2213
- export interface Target extends TargetTargetTypeOneOf {
2172
+ interface Target extends TargetTargetTypeOneOf {
2214
2173
  /** General (other) violation. */
2215
2174
  other?: Other;
2216
2175
  /** Specific line item violation. */
2217
2176
  lineItem?: TargetLineItem;
2218
2177
  }
2219
2178
  /** @oneof */
2220
- export interface TargetTargetTypeOneOf {
2179
+ interface TargetTargetTypeOneOf {
2221
2180
  /** General (other) violation. */
2222
2181
  other?: Other;
2223
2182
  /** Specific line item violation. */
2224
2183
  lineItem?: TargetLineItem;
2225
2184
  }
2226
2185
  /** Available locations on the webpage */
2227
- export declare enum NameInOther {
2186
+ declare enum NameInOther {
2228
2187
  /** Default location, in case no specific location is specified. */
2229
2188
  OTHER_DEFAULT = "OTHER_DEFAULT"
2230
2189
  }
2231
2190
  /** Available locations on the line item */
2232
- export declare enum NameInLineItem {
2191
+ declare enum NameInLineItem {
2233
2192
  /** Default location, in case no specific location is specified. */
2234
2193
  LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
2235
2194
  }
2236
- export declare enum SuggestedFix {
2195
+ declare enum SuggestedFix {
2237
2196
  /** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
2238
2197
  UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
2239
2198
  /** The line item should be removed from the cart or checkout to resolve the violation. */
2240
2199
  REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
2241
2200
  }
2242
2201
  /** General (other) violation. */
2243
- export interface Other {
2202
+ interface Other {
2244
2203
  /** Location on a checkout or a cart page where a general (other) violation will be displayed. */
2245
2204
  name?: NameInOther;
2246
2205
  }
2247
2206
  /** Specific line item violation. */
2248
- export interface TargetLineItem {
2207
+ interface TargetLineItem {
2249
2208
  /** Location on a checkout or a cart page where the specific line item violation will be displayed. */
2250
2209
  name?: NameInLineItem;
2251
2210
  /** ID of the line item containing the violation. */
2252
- id?: string | null;
2211
+ _id?: string | null;
2253
2212
  }
2254
- export interface CustomSettings {
2213
+ interface CustomSettings {
2255
2214
  /**
2256
2215
  * Whether to restrict the option to add or remove a gift card on the checkout page.
2257
2216
  *
@@ -2277,7 +2236,7 @@ export interface CustomSettings {
2277
2236
  */
2278
2237
  disabledManualPayment?: boolean;
2279
2238
  }
2280
- export interface SubscriptionCharges {
2239
+ interface SubscriptionCharges {
2281
2240
  /**
2282
2241
  * ids of the items the subscription is defined on
2283
2242
  * @format GUID
@@ -2297,7 +2256,7 @@ export interface SubscriptionCharges {
2297
2256
  */
2298
2257
  charges?: Charge[];
2299
2258
  }
2300
- export interface Charge {
2259
+ interface Charge {
2301
2260
  /** The cycle number from which the charge starts. */
2302
2261
  cycleFrom?: number;
2303
2262
  /** The number of cycles for which the charge is applicable. */
@@ -2307,47 +2266,47 @@ export interface Charge {
2307
2266
  /** The billing date from which the charge starts. */
2308
2267
  cycleBillingDate?: Date | null;
2309
2268
  }
2310
- export interface CreateCheckoutTemplateRequest {
2269
+ interface CreateCheckoutTemplateRequest {
2311
2270
  /** Checkout template to create. */
2312
2271
  checkoutTemplate: CheckoutTemplate;
2313
2272
  }
2314
- export interface CreateCheckoutTemplateResponse {
2273
+ interface CreateCheckoutTemplateResponse {
2315
2274
  /** Created checkout template. */
2316
2275
  checkoutTemplate?: CheckoutTemplate;
2317
2276
  }
2318
- export interface GetCheckoutTemplateRequest {
2277
+ interface GetCheckoutTemplateRequest {
2319
2278
  /**
2320
2279
  * ID of the checkout template to retrieve.
2321
2280
  * @format GUID
2322
2281
  */
2323
2282
  checkoutTemplateId: string;
2324
2283
  }
2325
- export interface GetCheckoutTemplateResponse {
2284
+ interface GetCheckoutTemplateResponse {
2326
2285
  /** Retrieved checkout template. */
2327
2286
  checkoutTemplate?: CheckoutTemplate;
2328
2287
  }
2329
- export interface UpdateCheckoutTemplateRequest {
2288
+ interface UpdateCheckoutTemplateRequest {
2330
2289
  /** Checkout template info to update. */
2331
2290
  checkoutTemplate: CheckoutTemplate;
2332
2291
  }
2333
- export interface UpdateCheckoutTemplateResponse {
2292
+ interface UpdateCheckoutTemplateResponse {
2334
2293
  /** Updated checkout template. */
2335
2294
  checkoutTemplate?: CheckoutTemplate;
2336
2295
  }
2337
- export interface DeleteCheckoutTemplateRequest {
2296
+ interface DeleteCheckoutTemplateRequest {
2338
2297
  /**
2339
2298
  * ID of the checkout template to delete.
2340
2299
  * @format GUID
2341
2300
  */
2342
2301
  checkoutTemplateId: string;
2343
2302
  }
2344
- export interface DeleteCheckoutTemplateResponse {
2303
+ interface DeleteCheckoutTemplateResponse {
2345
2304
  }
2346
- export interface QueryCheckoutTemplatesRequest {
2305
+ interface QueryCheckoutTemplatesRequest {
2347
2306
  /** Query options. */
2348
2307
  query?: CursorQuery;
2349
2308
  }
2350
- export interface CursorQuery extends CursorQueryPagingMethodOneOf {
2309
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
2351
2310
  /** 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`. */
2352
2311
  cursorPaging?: CursorPaging;
2353
2312
  /**
@@ -2367,23 +2326,23 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
2367
2326
  sort?: Sorting[];
2368
2327
  }
2369
2328
  /** @oneof */
2370
- export interface CursorQueryPagingMethodOneOf {
2329
+ interface CursorQueryPagingMethodOneOf {
2371
2330
  /** 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`. */
2372
2331
  cursorPaging?: CursorPaging;
2373
2332
  }
2374
- export interface Sorting {
2333
+ interface Sorting {
2375
2334
  /** Name of the field to sort by. */
2376
2335
  fieldName?: string;
2377
2336
  /** Sort order. */
2378
2337
  order?: SortOrder;
2379
2338
  }
2380
- export declare enum SortOrder {
2339
+ declare enum SortOrder {
2381
2340
  /** Ascending order. */
2382
2341
  ASC = "ASC",
2383
2342
  /** Descending order. */
2384
2343
  DESC = "DESC"
2385
2344
  }
2386
- export interface CursorPaging {
2345
+ interface CursorPaging {
2387
2346
  /**
2388
2347
  * Number of items to load.
2389
2348
  * @max 100
@@ -2398,13 +2357,13 @@ export interface CursorPaging {
2398
2357
  */
2399
2358
  cursor?: string | null;
2400
2359
  }
2401
- export interface QueryCheckoutTemplatesResponse {
2360
+ interface QueryCheckoutTemplatesResponse {
2402
2361
  /** Retrieved checkout templates. */
2403
2362
  checkoutTemplates?: CheckoutTemplate[];
2404
2363
  /** Paging metadata. */
2405
2364
  pagingMetadata?: CursorPagingMetadata;
2406
2365
  }
2407
- export interface CursorPagingMetadata {
2366
+ interface CursorPagingMetadata {
2408
2367
  /** Number of items returned in the response. */
2409
2368
  count?: number | null;
2410
2369
  /** Offset that was requested. */
@@ -2416,13 +2375,13 @@ export interface CursorPagingMetadata {
2416
2375
  */
2417
2376
  hasNext?: boolean | null;
2418
2377
  }
2419
- export interface Cursors {
2378
+ interface Cursors {
2420
2379
  /** Cursor pointing to next page in the list of results. */
2421
2380
  next?: string | null;
2422
2381
  /** Cursor pointing to previous page in the list of results. */
2423
2382
  prev?: string | null;
2424
2383
  }
2425
- export interface CreateCheckoutFromTemplateRequest {
2384
+ interface CreateCheckoutFromTemplateRequest {
2426
2385
  /**
2427
2386
  * ID of the checkout template to use to create a checkout from.
2428
2387
  * @format GUID
@@ -2434,7 +2393,7 @@ export interface CreateCheckoutFromTemplateRequest {
2434
2393
  */
2435
2394
  siteId: string;
2436
2395
  }
2437
- export interface CreateCheckoutFromTemplateResponse {
2396
+ interface CreateCheckoutFromTemplateResponse {
2438
2397
  /**
2439
2398
  * ID of the created checkout.
2440
2399
  * @format GUID
@@ -2448,7 +2407,7 @@ export interface CreateCheckoutFromTemplateResponse {
2448
2407
  */
2449
2408
  purchaseFlowId?: string | null;
2450
2409
  }
2451
- export interface CreateAndRedirectToCheckoutRequest {
2410
+ interface CreateAndRedirectToCheckoutRequest {
2452
2411
  /**
2453
2412
  * ID of the checkout template to use to create a checkout.
2454
2413
  * @format GUID
@@ -2460,16 +2419,16 @@ export interface CreateAndRedirectToCheckoutRequest {
2460
2419
  */
2461
2420
  siteId: string;
2462
2421
  }
2463
- export interface RawHttpResponse {
2422
+ interface RawHttpResponse {
2464
2423
  body?: Uint8Array;
2465
2424
  statusCode?: number | null;
2466
2425
  headers?: HeadersEntry[];
2467
2426
  }
2468
- export interface HeadersEntry {
2427
+ interface HeadersEntry {
2469
2428
  key?: string;
2470
2429
  value?: string;
2471
2430
  }
2472
- export interface DomainEvent extends DomainEventBodyOneOf {
2431
+ interface DomainEvent extends DomainEventBodyOneOf {
2473
2432
  createdEvent?: EntityCreatedEvent;
2474
2433
  updatedEvent?: EntityUpdatedEvent;
2475
2434
  deletedEvent?: EntityDeletedEvent;
@@ -2478,7 +2437,7 @@ export interface DomainEvent extends DomainEventBodyOneOf {
2478
2437
  * Unique event ID.
2479
2438
  * Allows clients to ignore duplicate webhooks.
2480
2439
  */
2481
- id?: string;
2440
+ _id?: string;
2482
2441
  /**
2483
2442
  * Assumes actions are also always typed to an entity_type
2484
2443
  * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
@@ -2512,36 +2471,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
2512
2471
  entityEventSequence?: string | null;
2513
2472
  }
2514
2473
  /** @oneof */
2515
- export interface DomainEventBodyOneOf {
2474
+ interface DomainEventBodyOneOf {
2516
2475
  createdEvent?: EntityCreatedEvent;
2517
2476
  updatedEvent?: EntityUpdatedEvent;
2518
2477
  deletedEvent?: EntityDeletedEvent;
2519
2478
  actionEvent?: ActionEvent;
2520
2479
  }
2521
- export interface EntityCreatedEvent {
2522
- entityAsJson?: string;
2523
- /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
2524
- restoreInfo?: RestoreInfo;
2480
+ interface EntityCreatedEvent {
2481
+ entity?: string;
2525
2482
  }
2526
- export interface RestoreInfo {
2483
+ interface RestoreInfo {
2527
2484
  deletedDate?: Date | null;
2528
2485
  }
2529
- export interface EntityUpdatedEvent {
2486
+ interface EntityUpdatedEvent {
2530
2487
  /**
2531
2488
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2532
2489
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2533
2490
  * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2534
2491
  */
2535
- currentEntityAsJson?: string;
2492
+ currentEntity?: string;
2536
2493
  }
2537
- export interface EntityDeletedEvent {
2494
+ interface EntityDeletedEvent {
2538
2495
  /** Entity that was deleted */
2539
- deletedEntityAsJson?: string | null;
2496
+ deletedEntity?: string | null;
2540
2497
  }
2541
- export interface ActionEvent {
2542
- bodyAsJson?: string;
2498
+ interface ActionEvent {
2499
+ body?: string;
2543
2500
  }
2544
- export interface MessageEnvelope {
2501
+ interface MessageEnvelope {
2545
2502
  /**
2546
2503
  * App instance ID.
2547
2504
  * @format GUID
@@ -2557,7 +2514,7 @@ export interface MessageEnvelope {
2557
2514
  /** Stringify payload. */
2558
2515
  data?: string;
2559
2516
  }
2560
- export interface IdentificationData extends IdentificationDataIdOneOf {
2517
+ interface IdentificationData extends IdentificationDataIdOneOf {
2561
2518
  /**
2562
2519
  * ID of a site visitor that has not logged in to the site.
2563
2520
  * @format GUID
@@ -2582,7 +2539,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
2582
2539
  identityType?: WebhookIdentityType;
2583
2540
  }
2584
2541
  /** @oneof */
2585
- export interface IdentificationDataIdOneOf {
2542
+ interface IdentificationDataIdOneOf {
2586
2543
  /**
2587
2544
  * ID of a site visitor that has not logged in to the site.
2588
2545
  * @format GUID
@@ -2604,10 +2561,167 @@ export interface IdentificationDataIdOneOf {
2604
2561
  */
2605
2562
  appId?: string;
2606
2563
  }
2607
- export declare enum WebhookIdentityType {
2564
+ declare enum WebhookIdentityType {
2608
2565
  UNKNOWN = "UNKNOWN",
2609
2566
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2610
2567
  MEMBER = "MEMBER",
2611
2568
  WIX_USER = "WIX_USER",
2612
2569
  APP = "APP"
2613
2570
  }
2571
+ interface BaseEventMetadata {
2572
+ /**
2573
+ * App instance ID.
2574
+ * @format GUID
2575
+ */
2576
+ instanceId?: string | null;
2577
+ /**
2578
+ * Event type.
2579
+ * @maxLength 150
2580
+ */
2581
+ eventType?: string;
2582
+ /** The identification type and identity data. */
2583
+ identity?: IdentificationData;
2584
+ }
2585
+ interface EventMetadata extends BaseEventMetadata {
2586
+ /**
2587
+ * Unique event ID.
2588
+ * Allows clients to ignore duplicate webhooks.
2589
+ */
2590
+ _id?: string;
2591
+ /**
2592
+ * Assumes actions are also always typed to an entity_type
2593
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
2594
+ */
2595
+ entityFqdn?: string;
2596
+ /**
2597
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
2598
+ * This is although the created/updated/deleted notion is duplication of the oneof types
2599
+ * Example: created/updated/deleted/started/completed/email_opened
2600
+ */
2601
+ slug?: string;
2602
+ /** ID of the entity associated with the event. */
2603
+ entityId?: string;
2604
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
2605
+ eventTime?: Date | null;
2606
+ /**
2607
+ * Whether the event was triggered as a result of a privacy regulation application
2608
+ * (for example, GDPR).
2609
+ */
2610
+ triggeredByAnonymizeRequest?: boolean | null;
2611
+ /** If present, indicates the action that triggered the event. */
2612
+ originatedFrom?: string | null;
2613
+ /**
2614
+ * A sequence number defining the order of updates to the underlying entity.
2615
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
2616
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
2617
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
2618
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
2619
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
2620
+ */
2621
+ entityEventSequence?: string | null;
2622
+ }
2623
+ interface CheckoutTemplateCreatedEnvelope {
2624
+ entity: CheckoutTemplate;
2625
+ metadata: EventMetadata;
2626
+ }
2627
+ interface CheckoutTemplateDeletedEnvelope {
2628
+ metadata: EventMetadata;
2629
+ }
2630
+ interface CheckoutTemplateUpdatedEnvelope {
2631
+ entity: CheckoutTemplate;
2632
+ metadata: EventMetadata;
2633
+ }
2634
+ interface CheckoutTemplateUsedEnvelope {
2635
+ data: CheckoutTemplateUsed;
2636
+ metadata: EventMetadata;
2637
+ }
2638
+ interface UpdateCheckoutTemplate {
2639
+ /**
2640
+ * Checkout template ID.
2641
+ * @format GUID
2642
+ * @readonly
2643
+ */
2644
+ _id?: string | null;
2645
+ /**
2646
+ * Status of the checkout template.
2647
+ *
2648
+ * When `status` is `INACTIVE` checkouts will not be created with this template `id`. Instead, the endpoint will redirect to the domain site.
2649
+ *
2650
+ * Default: `ACTIVE`
2651
+ */
2652
+ status?: Status;
2653
+ /** Custom settings to apply to the checkout page created from this template. */
2654
+ customization?: CheckoutCustomization;
2655
+ /**
2656
+ * Catalog line items.
2657
+ *
2658
+ * Max: 300 items
2659
+ * @maxSize 300
2660
+ */
2661
+ lineItems?: V1LineItem[];
2662
+ /**
2663
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
2664
+ *
2665
+ * Max: 300 items
2666
+ * @maxSize 300
2667
+ */
2668
+ customLineItems?: CustomLineItem[];
2669
+ /**
2670
+ * Coupon code.
2671
+ *
2672
+ * Note that a checkout can only hold one `couponCode` at a time. If an additional `couponCode` is added, it will override the existing `couponCode`.
2673
+ * For additional information, see the Coupons API.
2674
+ */
2675
+ couponCode?: string | null;
2676
+ /**
2677
+ * Reference IDs for the app and component providing custom checkout page content.
2678
+ *
2679
+ * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
2680
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
2681
+ */
2682
+ customContentReference?: CustomContentReference;
2683
+ }
2684
+ interface QueryCursorResult {
2685
+ cursors: Cursors;
2686
+ hasNext: () => boolean;
2687
+ hasPrev: () => boolean;
2688
+ length: number;
2689
+ pageSize: number;
2690
+ }
2691
+ interface CheckoutTemplatesQueryResult extends QueryCursorResult {
2692
+ items: CheckoutTemplate[];
2693
+ query: CheckoutTemplatesQueryBuilder;
2694
+ next: () => Promise<CheckoutTemplatesQueryResult>;
2695
+ prev: () => Promise<CheckoutTemplatesQueryResult>;
2696
+ }
2697
+ interface CheckoutTemplatesQueryBuilder {
2698
+ /** @param propertyName - Property whose value is compared with `value`.
2699
+ * @param value - Value to compare against.
2700
+ */
2701
+ eq: (propertyName: '_id' | 'status', value: any) => CheckoutTemplatesQueryBuilder;
2702
+ /** @param propertyName - Property whose value is compared with `value`.
2703
+ * @param value - Value to compare against.
2704
+ */
2705
+ ne: (propertyName: '_id' | 'status', value: any) => CheckoutTemplatesQueryBuilder;
2706
+ /** @param propertyName - Property whose value is compared with `string`.
2707
+ * @param string - String to compare against. Case-insensitive.
2708
+ */
2709
+ startsWith: (propertyName: '_id', value: string) => CheckoutTemplatesQueryBuilder;
2710
+ /** @param propertyName - Property whose value is compared with `values`.
2711
+ * @param values - List of values to compare against.
2712
+ */
2713
+ hasSome: (propertyName: '_id' | 'status', value: any[]) => CheckoutTemplatesQueryBuilder;
2714
+ in: (propertyName: '_id' | 'status', value: any) => CheckoutTemplatesQueryBuilder;
2715
+ exists: (propertyName: '_id' | 'status', value: boolean) => CheckoutTemplatesQueryBuilder;
2716
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
2717
+ ascending: (...propertyNames: Array<'_id' | 'status'>) => CheckoutTemplatesQueryBuilder;
2718
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
2719
+ descending: (...propertyNames: Array<'_id' | 'status'>) => CheckoutTemplatesQueryBuilder;
2720
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
2721
+ limit: (limit: number) => CheckoutTemplatesQueryBuilder;
2722
+ /** @param cursor - A pointer to specific record */
2723
+ skipTo: (cursor: string) => CheckoutTemplatesQueryBuilder;
2724
+ find: () => Promise<CheckoutTemplatesQueryResult>;
2725
+ }
2726
+
2727
+ export { type Description as $, AdditionalFeeSource as A, type PlainTextValue as B, type CheckoutTemplate as C, DescriptionLineType as D, type Color as E, FileType as F, type PhysicalProperties as G, type PaymentOption as H, ItemTypeItemType as I, JurisdictionType as J, type CustomLineItem as K, type PriceDescription as L, ManualCalculationReason as M, NameInOther as N, type ItemType as O, PaymentOptionType as P, type ItemTypeItemTypeDataOneOf as Q, type RawHttpResponse as R, Status as S, TaxableAddressType as T, type UpdateCheckoutTemplate as U, VatType as V, WeightUnit as W, type SubscriptionOptionInfo as X, type SubscriptionSettings as Y, type FreeTrialPeriod as Z, type Title as _, type CheckoutTemplatesQueryBuilder as a, type DiscountRuleName as a$, type SecuredMedia as a0, type ServiceProperties as a1, type Policy as a2, type TaxableAddress as a3, type TaxableAddressTaxableAddressDataOneOf as a4, type ExtendedFields as a5, type CustomContentReference as a6, type ExternalReference as a7, type CheckoutTemplateUsed as a8, type Checkout as a9, type Carrier as aA, type Region as aB, type ApplicableLineItems as aC, type ShippingRegion as aD, type CarrierServiceOption as aE, type ShippingOption as aF, type ShippingPrice as aG, type OtherCharge as aH, type BuyerInfo as aI, type BuyerInfoIdOneOf as aJ, type PriceSummary as aK, type CalculationErrors as aL, type CalculationErrorsShippingCalculationErrorOneOf as aM, type Details as aN, type DetailsKindOneOf as aO, type ApplicationError as aP, type ValidationError as aQ, type FieldViolation as aR, type SystemError as aS, type CarrierErrors as aT, type CarrierError as aU, type GiftCard as aV, type AppliedDiscount as aW, type AppliedDiscountDiscountSourceOneOf as aX, type Coupon as aY, type MerchantDiscount as aZ, type DiscountRule as a_, type LineItem as aa, type MultiCurrencyPrice as ab, type ItemTaxFullDetails as ac, type TaxRateBreakdown as ad, type TaxBreakdown as ae, type FocalPoint as af, type ItemAvailabilityInfo as ag, type Scope as ah, type Group as ai, type ModifierGroup as aj, type TranslatableString as ak, type ItemModifier as al, type AddressWithContact as am, type Address as an, type StreetAddress as ao, type AddressLocation as ap, type FullAddressContactDetails as aq, type VatId as ar, type ShippingInfo as as, type SelectedCarrierServiceOption as at, type DeliveryLogistics as au, type PickupDetails as av, type DeliveryTimeSlot as aw, type SelectedCarrierServiceOptionPrices as ax, type SelectedCarrierServiceOptionOtherCharge as ay, type DeliveryAllocation as az, type CreateCheckoutFromTemplateResponse as b, type LineItemDiscount as b0, type CustomField as b1, type TaxSummary as b2, type TaxCalculationDetails as b3, type TaxCalculationDetailsCalculationDetailsOneOf as b4, type AutoTaxFallbackCalculationDetails as b5, type AggregatedTaxBreakdown as b6, type CreatedBy as b7, type CreatedByIdOneOf as b8, type MembershipOptions as b9, type CursorQueryPagingMethodOneOf as bA, type Sorting as bB, type CursorPaging as bC, type QueryCheckoutTemplatesResponse as bD, type CursorPagingMetadata as bE, type Cursors as bF, type CreateCheckoutFromTemplateRequest as bG, type CreateAndRedirectToCheckoutRequest as bH, type HeadersEntry as bI, type DomainEvent as bJ, type DomainEventBodyOneOf as bK, type EntityCreatedEvent as bL, type RestoreInfo as bM, type EntityUpdatedEvent as bN, type EntityDeletedEvent as bO, type ActionEvent as bP, type MessageEnvelope as bQ, type IdentificationData as bR, type IdentificationDataIdOneOf as bS, type BaseEventMetadata as bT, type EventMetadata as bU, type CheckoutTemplateCreatedEnvelope as bV, type CheckoutTemplateDeletedEnvelope as bW, type CheckoutTemplateUpdatedEnvelope as bX, type CheckoutTemplateUsedEnvelope as bY, type CheckoutTemplatesQueryResult as bZ, type Membership as ba, type MembershipName as bb, type MembershipPaymentCredits as bc, type InvalidMembership as bd, type SelectedMemberships as be, type SelectedMembership as bf, type AdditionalFee as bg, type ConversionInfo as bh, type Violation as bi, type Target as bj, type TargetTargetTypeOneOf as bk, type Other as bl, type TargetLineItem as bm, type CustomSettings as bn, type SubscriptionCharges as bo, type Charge as bp, type CreateCheckoutTemplateRequest as bq, type CreateCheckoutTemplateResponse as br, type GetCheckoutTemplateRequest as bs, type GetCheckoutTemplateResponse as bt, type UpdateCheckoutTemplateRequest as bu, type UpdateCheckoutTemplateResponse as bv, type DeleteCheckoutTemplateRequest as bw, type DeleteCheckoutTemplateResponse as bx, type QueryCheckoutTemplatesRequest as by, type CursorQuery as bz, SubscriptionFrequency as c, ItemAvailabilityStatus as d, PickupMethod as e, ChargeType as f, RuleType as g, DiscountType as h, RateType as i, FallbackReason as j, ChannelType as k, Severity as l, NameInLineItem as m, SuggestedFix as n, SortOrder as o, WebhookIdentityType as p, type CheckoutCustomization as q, type WebClientCustomization as r, type V1LineItem as s, type CatalogReference as t, type CatalogOverrideFields as u, type ProductName as v, type DescriptionLine as w, type DescriptionLineValueOneOf as x, type DescriptionLineDescriptionLineValueOneOf as y, type DescriptionLineName as z };