@wix/auto_sdk_ecom_checkout 1.0.14 → 1.0.16

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/{es/src/ecom-v1-checkout-checkout.types.d.ts → ecom-v1-checkout-checkout.universal-C4Y04uL3.d.mts} +658 -376
  2. package/build/{cjs/src/ecom-v1-checkout-checkout.types.d.ts → ecom-v1-checkout-checkout.universal-C4Y04uL3.d.ts} +658 -376
  3. package/build/index.d.mts +211 -0
  4. package/build/index.d.ts +211 -0
  5. package/build/index.js +2781 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +2707 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/internal/{cjs/src/ecom-v1-checkout-checkout.types.d.ts → ecom-v1-checkout-checkout.universal-ClmAJ_ss.d.mts} +867 -376
  10. package/build/internal/{es/src/ecom-v1-checkout-checkout.types.d.ts → ecom-v1-checkout-checkout.universal-ClmAJ_ss.d.ts} +867 -376
  11. package/build/internal/index.d.mts +252 -0
  12. package/build/internal/index.d.ts +252 -0
  13. package/build/internal/index.js +2781 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +2707 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +2322 -0
  18. package/build/internal/meta.d.ts +2322 -0
  19. package/build/internal/meta.js +1587 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +1544 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +2322 -0
  24. package/build/meta.d.ts +2322 -0
  25. package/build/meta.js +1587 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +1544 -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-checkout.context.d.ts +0 -34
  40. package/build/cjs/src/ecom-v1-checkout-checkout.context.js +0 -77
  41. package/build/cjs/src/ecom-v1-checkout-checkout.context.js.map +0 -1
  42. package/build/cjs/src/ecom-v1-checkout-checkout.http.d.ts +0 -122
  43. package/build/cjs/src/ecom-v1-checkout-checkout.http.js +0 -1338
  44. package/build/cjs/src/ecom-v1-checkout-checkout.http.js.map +0 -1
  45. package/build/cjs/src/ecom-v1-checkout-checkout.meta.d.ts +0 -59
  46. package/build/cjs/src/ecom-v1-checkout-checkout.meta.js +0 -351
  47. package/build/cjs/src/ecom-v1-checkout-checkout.meta.js.map +0 -1
  48. package/build/cjs/src/ecom-v1-checkout-checkout.public.d.ts +0 -186
  49. package/build/cjs/src/ecom-v1-checkout-checkout.public.js +0 -358
  50. package/build/cjs/src/ecom-v1-checkout-checkout.public.js.map +0 -1
  51. package/build/cjs/src/ecom-v1-checkout-checkout.types.js +0 -301
  52. package/build/cjs/src/ecom-v1-checkout-checkout.types.js.map +0 -1
  53. package/build/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +0 -4211
  54. package/build/cjs/src/ecom-v1-checkout-checkout.universal.js +0 -1597
  55. package/build/cjs/src/ecom-v1-checkout-checkout.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-checkout.context.d.ts +0 -34
  67. package/build/es/src/ecom-v1-checkout-checkout.context.js +0 -42
  68. package/build/es/src/ecom-v1-checkout-checkout.context.js.map +0 -1
  69. package/build/es/src/ecom-v1-checkout-checkout.http.d.ts +0 -122
  70. package/build/es/src/ecom-v1-checkout-checkout.http.js +0 -1318
  71. package/build/es/src/ecom-v1-checkout-checkout.http.js.map +0 -1
  72. package/build/es/src/ecom-v1-checkout-checkout.meta.d.ts +0 -59
  73. package/build/es/src/ecom-v1-checkout-checkout.meta.js +0 -308
  74. package/build/es/src/ecom-v1-checkout-checkout.meta.js.map +0 -1
  75. package/build/es/src/ecom-v1-checkout-checkout.public.d.ts +0 -186
  76. package/build/es/src/ecom-v1-checkout-checkout.public.js +0 -306
  77. package/build/es/src/ecom-v1-checkout-checkout.public.js.map +0 -1
  78. package/build/es/src/ecom-v1-checkout-checkout.types.js +0 -298
  79. package/build/es/src/ecom-v1-checkout-checkout.types.js.map +0 -1
  80. package/build/es/src/ecom-v1-checkout-checkout.universal.d.ts +0 -4211
  81. package/build/es/src/ecom-v1-checkout-checkout.universal.js +0 -1554
  82. package/build/es/src/ecom-v1-checkout-checkout.universal.js.map +0 -1
  83. package/build/internal/cjs/index.d.ts +0 -1
  84. package/build/internal/cjs/index.js +0 -18
  85. package/build/internal/cjs/index.js.map +0 -1
  86. package/build/internal/cjs/index.typings.d.ts +0 -1
  87. package/build/internal/cjs/index.typings.js +0 -18
  88. package/build/internal/cjs/index.typings.js.map +0 -1
  89. package/build/internal/cjs/meta.d.ts +0 -1
  90. package/build/internal/cjs/meta.js +0 -18
  91. package/build/internal/cjs/meta.js.map +0 -1
  92. package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.d.ts +0 -42
  93. package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.js +0 -77
  94. package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.js.map +0 -1
  95. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.d.ts +0 -122
  96. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js +0 -1338
  97. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js.map +0 -1
  98. package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.d.ts +0 -59
  99. package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.js +0 -351
  100. package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.js.map +0 -1
  101. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.d.ts +0 -219
  102. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js +0 -358
  103. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js.map +0 -1
  104. package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.js +0 -301
  105. package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.js.map +0 -1
  106. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +0 -4494
  107. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js +0 -1597
  108. package/build/internal/cjs/src/ecom-v1-checkout-checkout.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-checkout.context.d.ts +0 -42
  119. package/build/internal/es/src/ecom-v1-checkout-checkout.context.js +0 -42
  120. package/build/internal/es/src/ecom-v1-checkout-checkout.context.js.map +0 -1
  121. package/build/internal/es/src/ecom-v1-checkout-checkout.http.d.ts +0 -122
  122. package/build/internal/es/src/ecom-v1-checkout-checkout.http.js +0 -1318
  123. package/build/internal/es/src/ecom-v1-checkout-checkout.http.js.map +0 -1
  124. package/build/internal/es/src/ecom-v1-checkout-checkout.meta.d.ts +0 -59
  125. package/build/internal/es/src/ecom-v1-checkout-checkout.meta.js +0 -308
  126. package/build/internal/es/src/ecom-v1-checkout-checkout.meta.js.map +0 -1
  127. package/build/internal/es/src/ecom-v1-checkout-checkout.public.d.ts +0 -219
  128. package/build/internal/es/src/ecom-v1-checkout-checkout.public.js +0 -306
  129. package/build/internal/es/src/ecom-v1-checkout-checkout.public.js.map +0 -1
  130. package/build/internal/es/src/ecom-v1-checkout-checkout.types.js +0 -298
  131. package/build/internal/es/src/ecom-v1-checkout-checkout.types.js.map +0 -1
  132. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.d.ts +0 -4494
  133. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js +0 -1554
  134. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js.map +0 -1
@@ -1,10 +1,10 @@
1
- export interface Checkout {
1
+ interface Checkout {
2
2
  /**
3
3
  * Checkout ID.
4
4
  * @format GUID
5
5
  * @readonly
6
6
  */
7
- id?: string | null;
7
+ _id?: string | null;
8
8
  /**
9
9
  * Line items.
10
10
  *
@@ -19,7 +19,7 @@ export interface Checkout {
19
19
  /** Shipping information. */
20
20
  shippingInfo?: ShippingInfo;
21
21
  /**
22
- * [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer.
22
+ * [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
23
23
  * @maxLength 1000
24
24
  */
25
25
  buyerNote?: string | null;
@@ -107,12 +107,12 @@ export interface Checkout {
107
107
  * Date and time the checkout was created.
108
108
  * @readonly
109
109
  */
110
- createdDate?: Date | null;
110
+ _createdDate?: Date | null;
111
111
  /**
112
112
  * Date and time the checkout was updated.
113
113
  * @readonly
114
114
  */
115
- updatedDate?: Date | null;
115
+ _updatedDate?: Date | null;
116
116
  /**
117
117
  * Minimal amount to pay in order to place the order.
118
118
  * @readonly
@@ -136,7 +136,7 @@ export interface Checkout {
136
136
  */
137
137
  cartId?: string | null;
138
138
  /**
139
- * List of validation violations raised by the Validations service plugin ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/service-plugins/validations/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/service-plugins/validations-integration-service-plugin/introduction)).
139
+ * List of validation violations raised by the [Validations Custom Extension SPI](https://www.wix.com/velo/reference/spis/wix-ecom/ecom-validations/introduction).
140
140
  * @readonly
141
141
  */
142
142
  violations?: Violation[];
@@ -155,9 +155,7 @@ export interface Checkout {
155
155
  /**
156
156
  * Additional settings for customization of the checkout process.
157
157
  *
158
- * > **Notes:**
159
- * > * Custom settings can only be set when creating a checkout.
160
- * > * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
158
+ * Custom settings can only be defined when [creating a checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/createcheckout).
161
159
  * @immutable
162
160
  */
163
161
  customSettings?: CustomSettings;
@@ -168,6 +166,21 @@ export interface Checkout {
168
166
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
169
167
  */
170
168
  customContentReference?: CustomContentReference;
169
+ /**
170
+ * Order ID.
171
+ *
172
+ * This field is empty until the checkout completes and becomes an order.
173
+ * @internal
174
+ * @format GUID
175
+ * @readonly
176
+ */
177
+ orderId?: string | null;
178
+ /**
179
+ * Payment for subscriptions after free trial period.
180
+ * @internal
181
+ * @readonly
182
+ */
183
+ payAfterFreeTrial?: PriceSummary;
171
184
  /**
172
185
  * The business location ID associated with the checkout.
173
186
  *
@@ -175,14 +188,31 @@ export interface Checkout {
175
188
  * @format GUID
176
189
  */
177
190
  businessLocationId?: string | null;
191
+ /**
192
+ * Whether payment is required to create an order.
193
+ *
194
+ * Payment is required if any of the following conditions are met:
195
+ * 1. At least one item requires a payment method. This can be because the item has the `savePaymentMethod` field set to `true`, or the item is a subscription with a price greater than zero.
196
+ * 2. The calculated total amount due for immediate payment is greater than zero - `checkout.payNow > 0`.
197
+ * @internal
198
+ * @readonly
199
+ */
200
+ paymentRequired?: boolean;
201
+ /**
202
+ * Charges information for each subscription in the checkout.
203
+ * @internal
204
+ * @readonly
205
+ * @maxSize 100
206
+ */
207
+ subscriptionCharges?: SubscriptionCharges[];
178
208
  }
179
- export interface LineItem {
209
+ interface LineItem {
180
210
  /**
181
211
  * Line item ID.
182
212
  * @format GUID
183
213
  * @readonly
184
214
  */
185
- id?: string | null;
215
+ _id?: string | null;
186
216
  /**
187
217
  * Item quantity.
188
218
  *
@@ -192,7 +222,7 @@ export interface LineItem {
192
222
  * @max 100000
193
223
  */
194
224
  quantity?: number;
195
- /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
225
+ /** Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
196
226
  catalogReference?: CatalogReference;
197
227
  /**
198
228
  * Item name.
@@ -206,7 +236,7 @@ export interface LineItem {
206
236
  * URL to the item's page on the site.
207
237
  * @readonly
208
238
  */
209
- url?: PageUrlV2;
239
+ url?: string;
210
240
  /**
211
241
  * Item price **after** catalog-defined discount and line item discounts.
212
242
  * @readonly
@@ -248,7 +278,7 @@ export interface LineItem {
248
278
  */
249
279
  discount?: MultiCurrencyPrice;
250
280
  /**
251
- * Line item description lines. Used for display purposes for the cart, checkout and order.
281
+ * Line item description lines. Used for displaying the cart, checkout and order.
252
282
  * @readonly
253
283
  */
254
284
  descriptionLines?: DescriptionLine[];
@@ -256,7 +286,7 @@ export interface LineItem {
256
286
  * Line item image details.
257
287
  * @readonly
258
288
  */
259
- media?: CommonImage;
289
+ media?: string;
260
290
  /**
261
291
  * Item availability details.
262
292
  * @readonly
@@ -278,9 +308,11 @@ export interface LineItem {
278
308
  */
279
309
  subscriptionOptionInfo?: SubscriptionOptionInfo;
280
310
  /**
281
- * Type of selected payment option for current item.
282
- *
283
- * Default: `FULL_PAYMENT_ONLINE`
311
+ * Type of selected payment option for current item. Defaults to `"FULL_PAYMENT_ONLINE"`.
312
+ * + `"FULL_PAYMENT_ONLINE"`: The entire payment for this item happens as part of the checkout.
313
+ * + `"FULL_PAYMENT_OFFLINE"`: The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
314
+ * + `"MEMBERSHIP"`: Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
315
+ * + `"DEPOSIT_ONLINE"`: Partial payment for the given item to be paid upfront during the checkout. Amount to be paid is defined by deposit_amount field.
284
316
  * @readonly
285
317
  */
286
318
  paymentOption?: PaymentOptionType;
@@ -334,6 +366,18 @@ export interface LineItem {
334
366
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
335
367
  */
336
368
  catalogOverrideFields?: CatalogOverrideFields;
369
+ /**
370
+ * Whether the price is not yet defined, and will be updated after the order is created.
371
+ * @internal
372
+ * @readonly
373
+ */
374
+ priceUndetermined?: boolean;
375
+ /**
376
+ * Whether the line item quantity is fixed and cannot be changed.
377
+ * @internal
378
+ * @readonly
379
+ */
380
+ fixedQuantity?: boolean;
337
381
  /**
338
382
  * Whether to save the payment method on the order.
339
383
  *
@@ -341,9 +385,55 @@ export interface LineItem {
341
385
  * @readonly
342
386
  */
343
387
  savePaymentMethod?: boolean;
388
+ /**
389
+ * Address to use for tax calculation purposes.
390
+ * @internal
391
+ */
392
+ taxableAddress?: TaxableAddress;
393
+ /**
394
+ * Custom extended fields for the line item object.
395
+ *
396
+ * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
397
+ * @internal
398
+ */
399
+ extendedFields?: ExtendedFields;
400
+ /**
401
+ * Policies to be displayed to the customer on the checkout page.
402
+ * @internal
403
+ * @readonly
404
+ * @maxSize 5
405
+ */
406
+ policies?: Policy[];
407
+ /**
408
+ * ID of the app managing the inventory.
409
+ * @internal
410
+ * @format GUID
411
+ */
412
+ inventoryAppId?: string | null;
413
+ /**
414
+ * Whether the item can only be purchased by site members.
415
+ *
416
+ * Default: `false`
417
+ * @internal
418
+ * @readonly
419
+ */
420
+ membersOnly?: boolean;
421
+ /**
422
+ * Modifier groups that were added to the item.
423
+ * @internal
424
+ * @readonly
425
+ * @maxSize 10
426
+ */
427
+ modifierGroups?: ModifierGroup[];
428
+ /**
429
+ * Total price of all item modifiers. Included in the item price.
430
+ * @internal
431
+ * @readonly
432
+ */
433
+ modifiersTotalPrice?: MultiCurrencyPrice;
344
434
  }
345
435
  /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
346
- export interface CatalogReference {
436
+ interface CatalogReference {
347
437
  /**
348
438
  * ID of the item within the catalog it belongs to.
349
439
  * @minLength 1
@@ -363,13 +453,15 @@ export interface CatalogReference {
363
453
  */
364
454
  appId?: string;
365
455
  /**
366
- * Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
456
+ * Additional item details in key:value pairs.
457
+ *
458
+ * Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
367
459
  *
368
- * For products and variants from a Wix Stores catalog, learn more about eCommerce integration ([SDK](https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/e-commerce-integration) | [REST](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)).
460
+ * For products and variants from your Wix Stores catalog, learn more about [eCommerce integration](https://www.wix.com/velo/reference/wix-stores-backend/ecommerce-integration).
369
461
  */
370
462
  options?: Record<string, any> | null;
371
463
  }
372
- export interface ProductName {
464
+ interface ProductName {
373
465
  /**
374
466
  * __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).
375
467
  *
@@ -390,13 +482,7 @@ export interface ProductName {
390
482
  */
391
483
  translated?: string | null;
392
484
  }
393
- export interface PageUrlV2 {
394
- /** The relative path for the page within the site. For example, `/product-page/a-product`. */
395
- relativePath?: string;
396
- /** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
397
- url?: string | null;
398
- }
399
- export interface MultiCurrencyPrice {
485
+ interface MultiCurrencyPrice {
400
486
  /**
401
487
  * Amount.
402
488
  * @decimalValue options { gte:0, lte:1000000000000000 }
@@ -419,7 +505,7 @@ export interface MultiCurrencyPrice {
419
505
  */
420
506
  formattedConvertedAmount?: string;
421
507
  }
422
- export interface ItemTaxFullDetails {
508
+ interface ItemTaxFullDetails {
423
509
  /** Amount for which tax is calculated. */
424
510
  taxableAmount?: MultiCurrencyPrice;
425
511
  /**
@@ -436,7 +522,7 @@ export interface ItemTaxFullDetails {
436
522
  */
437
523
  rateBreakdown?: TaxRateBreakdown[];
438
524
  }
439
- export interface TaxRateBreakdown {
525
+ interface TaxRateBreakdown {
440
526
  /**
441
527
  * Name of tax against which the calculation was performed.
442
528
  * @maxLength 100
@@ -454,7 +540,7 @@ export interface TaxRateBreakdown {
454
540
  * TaxBreakdown represents tax information for a line item.
455
541
  * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
456
542
  */
457
- export interface TaxBreakdown {
543
+ interface TaxBreakdown {
458
544
  /**
459
545
  * The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
460
546
  * @maxLength 200
@@ -486,7 +572,7 @@ export interface TaxBreakdown {
486
572
  jurisdictionType?: JurisdictionType;
487
573
  }
488
574
  /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
489
- export declare enum JurisdictionType {
575
+ declare enum JurisdictionType {
490
576
  UNDEFINED = "UNDEFINED",
491
577
  COUNTRY = "COUNTRY",
492
578
  STATE = "STATE",
@@ -494,7 +580,7 @@ export declare enum JurisdictionType {
494
580
  CITY = "CITY",
495
581
  SPECIAL = "SPECIAL"
496
582
  }
497
- export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
583
+ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
498
584
  /** Description line plain text value. */
499
585
  plainText?: PlainTextValue;
500
586
  /** Description line color value. */
@@ -503,16 +589,16 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
503
589
  name?: DescriptionLineName;
504
590
  }
505
591
  /** @oneof */
506
- export interface DescriptionLineValueOneOf {
592
+ interface DescriptionLineValueOneOf {
507
593
  /** Description line plain text value. */
508
594
  plainText?: PlainTextValue;
509
595
  /** Description line color value. */
510
596
  colorInfo?: Color;
511
597
  }
512
598
  /** @oneof */
513
- export interface DescriptionLineDescriptionLineValueOneOf {
599
+ interface DescriptionLineDescriptionLineValueOneOf {
514
600
  }
515
- export interface DescriptionLineName {
601
+ interface DescriptionLineName {
516
602
  /**
517
603
  * 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).
518
604
  * @maxLength 100
@@ -526,7 +612,7 @@ export interface DescriptionLineName {
526
612
  */
527
613
  translated?: string | null;
528
614
  }
529
- export interface PlainTextValue {
615
+ interface PlainTextValue {
530
616
  /**
531
617
  * 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).
532
618
  * @maxLength 600
@@ -540,7 +626,7 @@ export interface PlainTextValue {
540
626
  */
541
627
  translated?: string | null;
542
628
  }
543
- export interface Color {
629
+ interface Color {
544
630
  /**
545
631
  * 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).
546
632
  * @maxLength 500
@@ -556,7 +642,7 @@ export interface Color {
556
642
  /** HEX or RGB color code for display. */
557
643
  code?: string | null;
558
644
  }
559
- export declare enum DescriptionLineType {
645
+ declare enum DescriptionLineType {
560
646
  /** Unrecognized type. */
561
647
  UNRECOGNISED = "UNRECOGNISED",
562
648
  /** Plain text type. */
@@ -564,30 +650,7 @@ export declare enum DescriptionLineType {
564
650
  /** Color type. */
565
651
  COLOR = "COLOR"
566
652
  }
567
- export interface CommonImage {
568
- /** WixMedia image ID. */
569
- id?: string;
570
- /** Image URL. */
571
- url?: string;
572
- /**
573
- * Original image height.
574
- * @readonly
575
- */
576
- height?: number;
577
- /**
578
- * Original image width.
579
- * @readonly
580
- */
581
- width?: number;
582
- /** Image alt text. */
583
- altText?: string | null;
584
- /**
585
- * Image filename.
586
- * @readonly
587
- */
588
- filename?: string | null;
589
- }
590
- export interface FocalPoint {
653
+ interface FocalPoint {
591
654
  /** X-coordinate of the focal point. */
592
655
  x?: number;
593
656
  /** Y-coordinate of the focal point. */
@@ -597,13 +660,13 @@ export interface FocalPoint {
597
660
  /** crop by width */
598
661
  width?: number | null;
599
662
  }
600
- export interface ItemAvailabilityInfo {
663
+ interface ItemAvailabilityInfo {
601
664
  /** Item availability status. */
602
665
  status?: ItemAvailabilityStatus;
603
666
  /** Quantity available. */
604
667
  quantityAvailable?: number | null;
605
668
  }
606
- export declare enum ItemAvailabilityStatus {
669
+ declare enum ItemAvailabilityStatus {
607
670
  AVAILABLE = "AVAILABLE",
608
671
  /** Item does not exist. */
609
672
  NOT_FOUND = "NOT_FOUND",
@@ -612,8 +675,8 @@ export declare enum ItemAvailabilityStatus {
612
675
  /** Available quantity is less than requested. */
613
676
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
614
677
  }
615
- export interface PhysicalProperties {
616
- /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
678
+ interface PhysicalProperties {
679
+ /** Line item weight. Measurement unit (`"KG"` or `"LB"`) is taken from `order.weightUnit`. */
617
680
  weight?: number | null;
618
681
  /**
619
682
  * Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
@@ -623,39 +686,39 @@ export interface PhysicalProperties {
623
686
  /** Whether this line item is shippable. */
624
687
  shippable?: boolean;
625
688
  }
626
- export interface Scope {
689
+ interface Scope {
627
690
  /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
628
691
  namespace?: string;
629
692
  /** Coupon scope's applied group (e.g., event or ticket in Wix Events) */
630
693
  group?: Group;
631
694
  }
632
- export interface Group {
695
+ interface Group {
633
696
  /** 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). */
634
697
  name?: string;
635
698
  /** Item ID (when the coupon scope is limited to just one item). */
636
699
  entityId?: string | null;
637
700
  }
638
- export interface ItemType extends ItemTypeItemTypeDataOneOf {
701
+ interface ItemType extends ItemTypeItemTypeDataOneOf {
639
702
  /** Preset item type. */
640
703
  preset?: ItemTypeItemType;
641
704
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
642
705
  custom?: string;
643
706
  }
644
707
  /** @oneof */
645
- export interface ItemTypeItemTypeDataOneOf {
708
+ interface ItemTypeItemTypeDataOneOf {
646
709
  /** Preset item type. */
647
710
  preset?: ItemTypeItemType;
648
711
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
649
712
  custom?: string;
650
713
  }
651
- export declare enum ItemTypeItemType {
714
+ declare enum ItemTypeItemType {
652
715
  UNRECOGNISED = "UNRECOGNISED",
653
716
  PHYSICAL = "PHYSICAL",
654
717
  DIGITAL = "DIGITAL",
655
718
  GIFT_CARD = "GIFT_CARD",
656
719
  SERVICE = "SERVICE"
657
720
  }
658
- export interface SubscriptionOptionInfo {
721
+ interface SubscriptionOptionInfo {
659
722
  /** Subscription option settings. */
660
723
  subscriptionSettings?: SubscriptionSettings;
661
724
  /** Subscription option title. */
@@ -663,7 +726,7 @@ export interface SubscriptionOptionInfo {
663
726
  /** Subscription option description. */
664
727
  description?: Description;
665
728
  }
666
- export interface SubscriptionSettings {
729
+ interface SubscriptionSettings {
667
730
  /** Frequency of recurring payment. */
668
731
  frequency?: SubscriptionFrequency;
669
732
  /**
@@ -682,16 +745,32 @@ export interface SubscriptionSettings {
682
745
  * @min 1
683
746
  */
684
747
  billingCycles?: number | null;
748
+ /**
749
+ * Whether to allow the customer to cancel the subscription..
750
+ * @internal
751
+ */
752
+ enableCustomerCancellation?: boolean;
753
+ /**
754
+ * Period until first cycle starts. If applied payNow will be 0
755
+ * If None => no free trial
756
+ * @internal
757
+ */
758
+ freeTrialPeriod?: FreeTrialPeriod;
759
+ /**
760
+ * The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
761
+ * @internal
762
+ */
763
+ startDate?: Date | null;
685
764
  }
686
765
  /** Frequency unit of recurring payment */
687
- export declare enum SubscriptionFrequency {
766
+ declare enum SubscriptionFrequency {
688
767
  UNDEFINED = "UNDEFINED",
689
768
  DAY = "DAY",
690
769
  WEEK = "WEEK",
691
770
  MONTH = "MONTH",
692
771
  YEAR = "YEAR"
693
772
  }
694
- export interface FreeTrialPeriod {
773
+ interface FreeTrialPeriod {
695
774
  /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
696
775
  frequency?: SubscriptionFrequency;
697
776
  /**
@@ -701,7 +780,7 @@ export interface FreeTrialPeriod {
701
780
  */
702
781
  interval?: number;
703
782
  }
704
- export interface Title {
783
+ interface Title {
705
784
  /**
706
785
  * 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).
707
786
  * @minLength 1
@@ -717,7 +796,7 @@ export interface Title {
717
796
  */
718
797
  translated?: string | null;
719
798
  }
720
- export interface Description {
799
+ interface Description {
721
800
  /**
722
801
  * Subscription option description.
723
802
  * @maxLength 500
@@ -729,13 +808,13 @@ export interface Description {
729
808
  */
730
809
  translated?: string | null;
731
810
  }
732
- export interface SecuredMedia {
811
+ interface SecuredMedia {
733
812
  /**
734
813
  * Media ID in Wix Media Manager.
735
814
  * @minLength 1
736
815
  * @maxLength 100
737
816
  */
738
- id?: string;
817
+ _id?: string;
739
818
  /**
740
819
  * Original filename.
741
820
  * @minLength 1
@@ -745,7 +824,7 @@ export interface SecuredMedia {
745
824
  /** File type. */
746
825
  fileType?: FileType;
747
826
  }
748
- export declare enum FileType {
827
+ declare enum FileType {
749
828
  UNSPECIFIED = "UNSPECIFIED",
750
829
  SECURE_PICTURE = "SECURE_PICTURE",
751
830
  SECURE_VIDEO = "SECURE_VIDEO",
@@ -754,7 +833,7 @@ export declare enum FileType {
754
833
  SECURE_ARCHIVE = "SECURE_ARCHIVE"
755
834
  }
756
835
  /** Type of selected payment option for catalog item */
757
- export declare enum PaymentOptionType {
836
+ declare enum PaymentOptionType {
758
837
  /** The entire payment for this item happens as part of the checkout. */
759
838
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
760
839
  /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
@@ -766,7 +845,7 @@ export declare enum PaymentOptionType {
766
845
  /** 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`. */
767
846
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
768
847
  }
769
- export interface ServiceProperties {
848
+ interface ServiceProperties {
770
849
  /**
771
850
  * 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.
772
851
  * For example, the start time of a class.
@@ -779,7 +858,7 @@ export interface ServiceProperties {
779
858
  */
780
859
  numberOfParticipants?: number | null;
781
860
  }
782
- export interface PriceDescription {
861
+ interface PriceDescription {
783
862
  /**
784
863
  * __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).
785
864
  * @minLength 1
@@ -795,7 +874,7 @@ export interface PriceDescription {
795
874
  */
796
875
  translated?: string | null;
797
876
  }
798
- export interface CatalogOverrideFields {
877
+ interface CatalogOverrideFields {
799
878
  /** Item name. */
800
879
  productName?: ProductName;
801
880
  /**
@@ -816,7 +895,7 @@ export interface CatalogOverrideFields {
816
895
  /** Physical properties of the item. */
817
896
  physicalProperties?: PhysicalProperties;
818
897
  /** Item image. */
819
- image?: Image;
898
+ image?: string;
820
899
  /** Payment method selected for the item. */
821
900
  paymentOption?: PaymentOption;
822
901
  /**
@@ -832,19 +911,7 @@ export interface CatalogOverrideFields {
832
911
  */
833
912
  savePaymentMethod?: boolean | null;
834
913
  }
835
- export interface Image {
836
- /** WixMedia image ID. */
837
- id?: string;
838
- /** Original image height. */
839
- height?: number;
840
- /** Original image width. */
841
- width?: number;
842
- /** Image alt text. Optional. */
843
- altText?: string | null;
844
- /** Image filename. Optional. */
845
- filename?: string | null;
846
- }
847
- export interface PaymentOption {
914
+ interface PaymentOption {
848
915
  /**
849
916
  * Type of selected payment option for current item.
850
917
  *
@@ -852,22 +919,22 @@ export interface PaymentOption {
852
919
  */
853
920
  value?: PaymentOptionType;
854
921
  }
855
- export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
922
+ interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
856
923
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
857
924
  addressType?: TaxableAddressType;
858
925
  }
859
926
  /** @oneof */
860
- export interface TaxableAddressTaxableAddressDataOneOf {
927
+ interface TaxableAddressTaxableAddressDataOneOf {
861
928
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
862
929
  addressType?: TaxableAddressType;
863
930
  }
864
- export declare enum TaxableAddressType {
931
+ declare enum TaxableAddressType {
865
932
  UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
866
933
  BUSINESS = "BUSINESS",
867
934
  BILLING = "BILLING",
868
935
  SHIPPING = "SHIPPING"
869
936
  }
870
- export interface ExtendedFields {
937
+ interface ExtendedFields {
871
938
  /**
872
939
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
873
940
  * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -878,7 +945,7 @@ export interface ExtendedFields {
878
945
  */
879
946
  namespaces?: Record<string, Record<string, any>>;
880
947
  }
881
- export interface Policy {
948
+ interface Policy {
882
949
  /**
883
950
  * Policy title - should be translated
884
951
  * @minLength 1
@@ -892,13 +959,13 @@ export interface Policy {
892
959
  */
893
960
  content?: string;
894
961
  }
895
- export interface ModifierGroup {
962
+ interface ModifierGroup {
896
963
  /**
897
964
  * Modifier group id.
898
965
  * @minLength 1
899
966
  * @maxLength 36
900
967
  */
901
- id?: string;
968
+ _id?: string;
902
969
  /** Modifier group name. */
903
970
  name?: TranslatableString;
904
971
  /**
@@ -908,7 +975,7 @@ export interface ModifierGroup {
908
975
  */
909
976
  modifiers?: ItemModifier[];
910
977
  }
911
- export interface TranslatableString {
978
+ interface TranslatableString {
912
979
  /**
913
980
  * __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).
914
981
  *
@@ -929,13 +996,13 @@ export interface TranslatableString {
929
996
  */
930
997
  translated?: string | null;
931
998
  }
932
- export interface ItemModifier {
999
+ interface ItemModifier {
933
1000
  /**
934
1001
  * Modifier ID.
935
1002
  * @minLength 1
936
1003
  * @maxLength 36
937
1004
  */
938
- id?: string;
1005
+ _id?: string;
939
1006
  /**
940
1007
  * The quantity of this modifier.
941
1008
  * @min 1
@@ -950,14 +1017,14 @@ export interface ItemModifier {
950
1017
  price?: MultiCurrencyPrice;
951
1018
  }
952
1019
  /** Billing Info and shipping details */
953
- export interface AddressWithContact {
1020
+ interface AddressWithContact {
954
1021
  /** Address. */
955
1022
  address?: ApiAddress;
956
1023
  /** Contact details. */
957
1024
  contactDetails?: FullAddressContactDetails;
958
1025
  }
959
1026
  /** Physical address */
960
- export interface ApiAddress {
1027
+ interface ApiAddress {
961
1028
  /**
962
1029
  * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
963
1030
  * @format COUNTRY
@@ -984,7 +1051,7 @@ export interface ApiAddress {
984
1051
  * Main address line (usually street name and number).
985
1052
  * @maxLength 150
986
1053
  */
987
- addressLine?: string | null;
1054
+ addressLine1?: string | null;
988
1055
  /**
989
1056
  * Free text providing more detailed address info. Usually contains apt, suite, floor.
990
1057
  * @maxLength 100
@@ -1001,20 +1068,20 @@ export interface ApiAddress {
1001
1068
  */
1002
1069
  subdivisionFullname?: string | null;
1003
1070
  }
1004
- export interface StreetAddress {
1071
+ interface StreetAddress {
1005
1072
  /** Street number. */
1006
1073
  number?: string;
1007
1074
  /** Street name. */
1008
1075
  name?: string;
1009
1076
  }
1010
- export interface AddressLocation {
1077
+ interface AddressLocation {
1011
1078
  /** Address latitude. */
1012
1079
  latitude?: number | null;
1013
1080
  /** Address longitude. */
1014
1081
  longitude?: number | null;
1015
1082
  }
1016
1083
  /** Full contact details for an address */
1017
- export interface FullAddressContactDetails {
1084
+ interface FullAddressContactDetails {
1018
1085
  /**
1019
1086
  * First name.
1020
1087
  * @maxLength 100
@@ -1038,9 +1105,9 @@ export interface FullAddressContactDetails {
1038
1105
  /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
1039
1106
  vatId?: CommonVatId;
1040
1107
  }
1041
- export interface CommonVatId {
1108
+ interface CommonVatId {
1042
1109
  /** Customer's tax ID. */
1043
- id?: string;
1110
+ _id?: string;
1044
1111
  /**
1045
1112
  * Tax type.
1046
1113
  *
@@ -1051,14 +1118,14 @@ export interface CommonVatId {
1051
1118
  type?: CommonVatType;
1052
1119
  }
1053
1120
  /** tax info types */
1054
- export declare enum CommonVatType {
1121
+ declare enum CommonVatType {
1055
1122
  UNSPECIFIED = "UNSPECIFIED",
1056
1123
  /** CPF - for individual tax payers. */
1057
1124
  CPF = "CPF",
1058
1125
  /** CNPJ - for corporations */
1059
1126
  CNPJ = "CNPJ"
1060
1127
  }
1061
- export interface ShippingInfo {
1128
+ interface ShippingInfo {
1062
1129
  /** Shipping address and contact details. */
1063
1130
  shippingDestination?: AddressWithContact;
1064
1131
  /** Selected option out of the options allowed for the `region`. */
@@ -1074,7 +1141,7 @@ export interface ShippingInfo {
1074
1141
  */
1075
1142
  carrierServiceOptions?: CarrierServiceOption[];
1076
1143
  }
1077
- export interface SelectedCarrierServiceOption {
1144
+ interface SelectedCarrierServiceOption {
1078
1145
  /**
1079
1146
  * Unique identifier of selected option. For example, "usps_std_overnight".
1080
1147
  * @maxLength 100
@@ -1117,7 +1184,7 @@ export interface SelectedCarrierServiceOption {
1117
1184
  /** If the delivery solution is a partial and doesn't apply to all items. */
1118
1185
  partial?: boolean | null;
1119
1186
  }
1120
- export interface DeliveryLogistics {
1187
+ interface DeliveryLogistics {
1121
1188
  /**
1122
1189
  * Expected delivery time, in free text. For example, "3-5 business days".
1123
1190
  * @maxLength 500
@@ -1131,7 +1198,7 @@ export interface DeliveryLogistics {
1131
1198
  /** Pickup details. */
1132
1199
  pickupDetails?: PickupDetails;
1133
1200
  }
1134
- export interface PickupDetails {
1201
+ interface PickupDetails {
1135
1202
  /** Pickup address. */
1136
1203
  address?: ApiAddress;
1137
1204
  /**
@@ -1142,18 +1209,18 @@ export interface PickupDetails {
1142
1209
  /** Pickup method */
1143
1210
  pickupMethod?: PickupMethod;
1144
1211
  }
1145
- export declare enum PickupMethod {
1212
+ declare enum PickupMethod {
1146
1213
  UNKNOWN_METHOD = "UNKNOWN_METHOD",
1147
1214
  STORE_PICKUP = "STORE_PICKUP",
1148
1215
  PICKUP_POINT = "PICKUP_POINT"
1149
1216
  }
1150
- export interface DeliveryTimeSlot {
1217
+ interface DeliveryTimeSlot {
1151
1218
  /** starting time of the delivery time slot */
1152
1219
  from?: Date | null;
1153
1220
  /** ending time of the delivery time slot */
1154
1221
  to?: Date | null;
1155
1222
  }
1156
- export interface SelectedCarrierServiceOptionPrices {
1223
+ interface SelectedCarrierServiceOptionPrices {
1157
1224
  /** Total shipping price, after discount and after tax. */
1158
1225
  totalPriceAfterTax?: MultiCurrencyPrice;
1159
1226
  /** Total price of shipping after discounts (when relevant), and before tax. */
@@ -1165,7 +1232,7 @@ export interface SelectedCarrierServiceOptionPrices {
1165
1232
  /** Shipping price before discount and before tax. */
1166
1233
  price?: MultiCurrencyPrice;
1167
1234
  }
1168
- export interface SelectedCarrierServiceOptionOtherCharge {
1235
+ interface SelectedCarrierServiceOptionOtherCharge {
1169
1236
  /** Type of additional cost. */
1170
1237
  type?: ChargeType;
1171
1238
  /**
@@ -1176,11 +1243,11 @@ export interface SelectedCarrierServiceOptionOtherCharge {
1176
1243
  /** Price of added charge. */
1177
1244
  cost?: SelectedCarrierServiceOptionPrices;
1178
1245
  }
1179
- export declare enum ChargeType {
1246
+ declare enum ChargeType {
1180
1247
  HANDLING_FEE = "HANDLING_FEE",
1181
1248
  INSURANCE = "INSURANCE"
1182
1249
  }
1183
- export interface DeliveryAllocation {
1250
+ interface DeliveryAllocation {
1184
1251
  /** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
1185
1252
  deliveryCarrier?: Carrier;
1186
1253
  /** The delivery region that are relevant for this delivery solution. */
@@ -1188,7 +1255,7 @@ export interface DeliveryAllocation {
1188
1255
  /** Populated if the delivery solution is a partially supplied by this carrier. */
1189
1256
  applicableLineItems?: ApplicableLineItems;
1190
1257
  }
1191
- export interface Carrier {
1258
+ interface Carrier {
1192
1259
  /**
1193
1260
  * The carrier app id
1194
1261
  * @format GUID
@@ -1200,19 +1267,19 @@ export interface Carrier {
1200
1267
  */
1201
1268
  code?: string;
1202
1269
  }
1203
- export interface Region {
1270
+ interface Region {
1204
1271
  /**
1205
1272
  * The delivery region id.
1206
1273
  * @format GUID
1207
1274
  */
1208
- id?: string | null;
1275
+ _id?: string | null;
1209
1276
  /**
1210
1277
  * The delivery region name.
1211
1278
  * @maxLength 100
1212
1279
  */
1213
1280
  name?: string | null;
1214
1281
  }
1215
- export interface ApplicableLineItems {
1282
+ interface ApplicableLineItems {
1216
1283
  /**
1217
1284
  * Line items that the delivery solution is for.
1218
1285
  * @maxSize 300
@@ -1221,20 +1288,20 @@ export interface ApplicableLineItems {
1221
1288
  */
1222
1289
  lineItemIds?: string[];
1223
1290
  }
1224
- export interface ShippingRegion {
1291
+ interface ShippingRegion {
1225
1292
  /**
1226
1293
  * Shipping region ID.
1227
1294
  * @format GUID
1228
1295
  * @readonly
1229
1296
  */
1230
- id?: string;
1297
+ _id?: string;
1231
1298
  /**
1232
1299
  * Shipping region name.
1233
1300
  * @maxLength 100
1234
1301
  */
1235
1302
  name?: string;
1236
1303
  }
1237
- export interface CarrierServiceOption {
1304
+ interface CarrierServiceOption {
1238
1305
  /**
1239
1306
  * Carrier ID.
1240
1307
  * @format GUID
@@ -1243,7 +1310,7 @@ export interface CarrierServiceOption {
1243
1310
  /** Shipping options offered by this carrier for this request. */
1244
1311
  shippingOptions?: ShippingOption[];
1245
1312
  }
1246
- export interface ShippingOption {
1313
+ interface ShippingOption {
1247
1314
  /**
1248
1315
  * Unique code of provided shipping option like "usps_std_overnight".
1249
1316
  * For legacy calculators this would be the UUID of the option.
@@ -1268,33 +1335,33 @@ export interface ShippingOption {
1268
1335
  /** If the delivery solution is a partial and doesn't apply to all items. */
1269
1336
  partial?: boolean | null;
1270
1337
  }
1271
- export interface ShippingPrice {
1338
+ interface ShippingPrice {
1272
1339
  /** Shipping price. */
1273
1340
  price?: MultiCurrencyPrice;
1274
1341
  /** Other costs such as insurance, handling & packaging for fragile items, etc. */
1275
1342
  otherCharges?: OtherCharge[];
1276
1343
  }
1277
- export interface OtherCharge {
1344
+ interface OtherCharge {
1278
1345
  /** Type of additional cost. */
1279
1346
  type?: ChargeType;
1280
1347
  /** Price of added cost. */
1281
1348
  price?: MultiCurrencyPrice;
1282
1349
  }
1283
- export interface BuyerInfo extends BuyerInfoIdOneOf {
1350
+ interface BuyerInfo extends BuyerInfoIdOneOf {
1284
1351
  /**
1285
- * Visitor ID (if site visitor is **not** a member).
1352
+ * Visitor ID - if the buyer is **not** a site member.
1286
1353
  * @format GUID
1287
1354
  * @readonly
1288
1355
  */
1289
1356
  visitorId?: string;
1290
1357
  /**
1291
- * Member ID (if site visitor is a site member).
1358
+ * Member ID - If the buyer is a site member.
1292
1359
  * @format GUID
1293
1360
  * @readonly
1294
1361
  */
1295
1362
  memberId?: string;
1296
1363
  /**
1297
- * Contact ID. Auto-created if one does not yet exist. For more information, see the Contacts API.
1364
+ * Contact ID. For more information, see the Contacts API.
1298
1365
  * @format GUID
1299
1366
  * @readonly
1300
1367
  */
@@ -1306,21 +1373,21 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
1306
1373
  email?: string | null;
1307
1374
  }
1308
1375
  /** @oneof */
1309
- export interface BuyerInfoIdOneOf {
1376
+ interface BuyerInfoIdOneOf {
1310
1377
  /**
1311
- * Visitor ID (if site visitor is **not** a member).
1378
+ * Visitor ID - if the buyer is **not** a site member.
1312
1379
  * @format GUID
1313
1380
  * @readonly
1314
1381
  */
1315
1382
  visitorId?: string;
1316
1383
  /**
1317
- * Member ID (if site visitor is a site member).
1384
+ * Member ID - If the buyer is a site member.
1318
1385
  * @format GUID
1319
1386
  * @readonly
1320
1387
  */
1321
1388
  memberId?: string;
1322
1389
  }
1323
- export interface PriceSummary {
1390
+ interface PriceSummary {
1324
1391
  /** Subtotal of all line items, before discounts and before tax. */
1325
1392
  subtotal?: MultiCurrencyPrice;
1326
1393
  /** Total shipping price, before discounts and before tax. */
@@ -1334,7 +1401,7 @@ export interface PriceSummary {
1334
1401
  /** Total additional fees price before tax. */
1335
1402
  additionalFees?: MultiCurrencyPrice;
1336
1403
  }
1337
- export interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
1404
+ interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
1338
1405
  /** General shipping calculation error. */
1339
1406
  generalShippingCalculationError?: Details;
1340
1407
  /** Carrier errors. */
@@ -1356,13 +1423,13 @@ export interface CalculationErrors extends CalculationErrorsShippingCalculationE
1356
1423
  discountsCalculationError?: Details;
1357
1424
  }
1358
1425
  /** @oneof */
1359
- export interface CalculationErrorsShippingCalculationErrorOneOf {
1426
+ interface CalculationErrorsShippingCalculationErrorOneOf {
1360
1427
  /** General shipping calculation error. */
1361
1428
  generalShippingCalculationError?: Details;
1362
1429
  /** Carrier errors. */
1363
1430
  carrierErrors?: CarrierErrors;
1364
1431
  }
1365
- export interface Details extends DetailsKindOneOf {
1432
+ interface Details extends DetailsKindOneOf {
1366
1433
  applicationError?: ApplicationError;
1367
1434
  validationError?: ValidationError;
1368
1435
  systemError?: SystemError;
@@ -1373,12 +1440,12 @@ export interface Details extends DetailsKindOneOf {
1373
1440
  tracing?: Record<string, string>;
1374
1441
  }
1375
1442
  /** @oneof */
1376
- export interface DetailsKindOneOf {
1443
+ interface DetailsKindOneOf {
1377
1444
  applicationError?: ApplicationError;
1378
1445
  validationError?: ValidationError;
1379
1446
  systemError?: SystemError;
1380
1447
  }
1381
- export interface ApplicationError {
1448
+ interface ApplicationError {
1382
1449
  /** Error code. */
1383
1450
  code?: string;
1384
1451
  /** Description of the error. */
@@ -1418,10 +1485,10 @@ export interface ApplicationError {
1418
1485
  * ]
1419
1486
  * }
1420
1487
  */
1421
- export interface ValidationError {
1488
+ interface ValidationError {
1422
1489
  fieldViolations?: FieldViolation[];
1423
1490
  }
1424
- export declare enum RuleType {
1491
+ declare enum RuleType {
1425
1492
  VALIDATION = "VALIDATION",
1426
1493
  OTHER = "OTHER",
1427
1494
  MAX = "MAX",
@@ -1444,7 +1511,7 @@ export declare enum RuleType {
1444
1511
  EXACT_SIZE = "EXACT_SIZE",
1445
1512
  REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
1446
1513
  }
1447
- export interface FieldViolation {
1514
+ interface FieldViolation {
1448
1515
  field?: string;
1449
1516
  description?: string;
1450
1517
  violatedRule?: RuleType;
@@ -1452,26 +1519,26 @@ export interface FieldViolation {
1452
1519
  ruleName?: string | null;
1453
1520
  data?: Record<string, any> | null;
1454
1521
  }
1455
- export interface SystemError {
1522
+ interface SystemError {
1456
1523
  /** Error code. */
1457
1524
  errorCode?: string | null;
1458
1525
  }
1459
- export interface CarrierErrors {
1526
+ interface CarrierErrors {
1460
1527
  /** Carrier errors. */
1461
1528
  errors?: CarrierError[];
1462
1529
  }
1463
- export interface CarrierError {
1530
+ interface CarrierError {
1464
1531
  /** Carrier ID. */
1465
1532
  carrierId?: string;
1466
1533
  /** Error details. */
1467
1534
  error?: Details;
1468
1535
  }
1469
- export interface GiftCard {
1536
+ interface GiftCard {
1470
1537
  /**
1471
1538
  * Gift Card ID.
1472
1539
  * @deprecated
1473
1540
  */
1474
- id?: string;
1541
+ _id?: string;
1475
1542
  /** Gift card obfuscated code. */
1476
1543
  obfuscatedCode?: string;
1477
1544
  /** Gift card value. */
@@ -1489,7 +1556,7 @@ export interface GiftCard {
1489
1556
  */
1490
1557
  externalId?: string | null;
1491
1558
  }
1492
- export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1559
+ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1493
1560
  /** Coupon details. */
1494
1561
  coupon?: Coupon;
1495
1562
  /** Merchant discount. */
@@ -1499,16 +1566,24 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1499
1566
  /** Discount type. */
1500
1567
  discountType?: DiscountType;
1501
1568
  /**
1502
- * IDs of line items the discount applies to.
1569
+ * IDs of the line items the discount applies to.
1503
1570
  * @format GUID
1504
1571
  * @deprecated IDs of line items the discount applies to.
1505
1572
  * @replacedBy line_items_discounts
1506
1573
  * @targetRemovalDate 2024-06-01
1507
1574
  */
1508
1575
  lineItemIds?: string[];
1576
+ /**
1577
+ * Number of subscription cycle this discount applies to
1578
+ * default None - all billing cycle
1579
+ * @internal
1580
+ * @min 1
1581
+ * @max 999
1582
+ */
1583
+ subscriptionCycles?: number | null;
1509
1584
  }
1510
1585
  /** @oneof */
1511
- export interface AppliedDiscountDiscountSourceOneOf {
1586
+ interface AppliedDiscountDiscountSourceOneOf {
1512
1587
  /** Coupon details. */
1513
1588
  coupon?: Coupon;
1514
1589
  /** Merchant discount. */
@@ -1516,15 +1591,15 @@ export interface AppliedDiscountDiscountSourceOneOf {
1516
1591
  /** Discount rule */
1517
1592
  discountRule?: DiscountRule;
1518
1593
  }
1519
- export declare enum DiscountType {
1594
+ declare enum DiscountType {
1520
1595
  GLOBAL = "GLOBAL",
1521
1596
  SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
1522
1597
  SHIPPING = "SHIPPING"
1523
1598
  }
1524
1599
  /** Coupon */
1525
- export interface Coupon {
1600
+ interface Coupon {
1526
1601
  /** Coupon ID. */
1527
- id?: string;
1602
+ _id?: string;
1528
1603
  /** Coupon code. */
1529
1604
  code?: string;
1530
1605
  /** Coupon value. */
@@ -1532,7 +1607,7 @@ export interface Coupon {
1532
1607
  /** Coupon name. */
1533
1608
  name?: string;
1534
1609
  }
1535
- export interface MerchantDiscount {
1610
+ interface MerchantDiscount {
1536
1611
  /** Discount value. */
1537
1612
  amount?: MultiCurrencyPrice;
1538
1613
  /**
@@ -1542,18 +1617,18 @@ export interface MerchantDiscount {
1542
1617
  */
1543
1618
  percentage?: number | null;
1544
1619
  }
1545
- export interface DiscountRule {
1620
+ interface DiscountRule {
1546
1621
  /**
1547
1622
  * Discount rule ID
1548
1623
  * @format GUID
1549
1624
  */
1550
- id?: string;
1625
+ _id?: string;
1551
1626
  /** Discount rule name */
1552
1627
  name?: DiscountRuleName;
1553
1628
  /** Discount value. */
1554
1629
  amount?: MultiCurrencyPrice;
1555
1630
  }
1556
- export interface DiscountRuleName {
1631
+ interface DiscountRuleName {
1557
1632
  /**
1558
1633
  * Original discount rule name (in site's default language).
1559
1634
  * @minLength 1
@@ -1567,16 +1642,16 @@ export interface DiscountRuleName {
1567
1642
  */
1568
1643
  translated?: string | null;
1569
1644
  }
1570
- export interface LineItemDiscount {
1645
+ interface LineItemDiscount {
1571
1646
  /**
1572
1647
  * ID of line item the discount applies to.
1573
1648
  * @format GUID
1574
1649
  */
1575
- id?: string;
1650
+ _id?: string;
1576
1651
  /** Discount value. */
1577
1652
  totalDiscountAmount?: MultiCurrencyPrice;
1578
1653
  }
1579
- export interface CustomField {
1654
+ interface CustomField {
1580
1655
  /** Custom field value. */
1581
1656
  value?: any;
1582
1657
  /**
@@ -1592,7 +1667,7 @@ export interface CustomField {
1592
1667
  */
1593
1668
  translatedTitle?: string | null;
1594
1669
  }
1595
- export declare enum WeightUnit {
1670
+ declare enum WeightUnit {
1596
1671
  /** Weight unit can't be classified due to an error. */
1597
1672
  UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
1598
1673
  /** Kilograms. */
@@ -1600,7 +1675,7 @@ export declare enum WeightUnit {
1600
1675
  /** Pounds. */
1601
1676
  LB = "LB"
1602
1677
  }
1603
- export interface TaxSummary {
1678
+ interface TaxSummary {
1604
1679
  /**
1605
1680
  * Amount for which tax is calculated, added from line items.
1606
1681
  * @readonly
@@ -1617,7 +1692,7 @@ export interface TaxSummary {
1617
1692
  */
1618
1693
  calculationDetails?: TaxCalculationDetails;
1619
1694
  }
1620
- export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
1695
+ interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
1621
1696
  /** Reason the manual calculation was used. */
1622
1697
  manualRateReason?: ManualCalculationReason;
1623
1698
  /** Details of the fallback rate calculation. */
@@ -1626,13 +1701,13 @@ export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationD
1626
1701
  rateType?: RateType;
1627
1702
  }
1628
1703
  /** @oneof */
1629
- export interface TaxCalculationDetailsCalculationDetailsOneOf {
1704
+ interface TaxCalculationDetailsCalculationDetailsOneOf {
1630
1705
  /** Reason the manual calculation was used. */
1631
1706
  manualRateReason?: ManualCalculationReason;
1632
1707
  /** Details of the fallback rate calculation. */
1633
1708
  autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
1634
1709
  }
1635
- export declare enum RateType {
1710
+ declare enum RateType {
1636
1711
  /** no tax being collected for this request due to location of purchase */
1637
1712
  NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
1638
1713
  /** manual rate used for calculation */
@@ -1642,19 +1717,19 @@ export declare enum RateType {
1642
1717
  /** fallback rate used for calculation */
1643
1718
  FALLBACK_RATE = "FALLBACK_RATE"
1644
1719
  }
1645
- export declare enum ManualCalculationReason {
1720
+ declare enum ManualCalculationReason {
1646
1721
  /** user set calculator in Business Manager to be Manual */
1647
1722
  GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
1648
1723
  /** specific region is on manual even though Global setting is Auto-tax */
1649
1724
  REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
1650
1725
  }
1651
- export interface AutoTaxFallbackCalculationDetails {
1726
+ interface AutoTaxFallbackCalculationDetails {
1652
1727
  /** reason for fallback */
1653
1728
  fallbackReason?: FallbackReason;
1654
1729
  /** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
1655
1730
  error?: ApplicationError;
1656
1731
  }
1657
- export declare enum FallbackReason {
1732
+ declare enum FallbackReason {
1658
1733
  /** auto-tax failed to be calculated */
1659
1734
  AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
1660
1735
  /** auto-tax was temporarily deactivated on a system-level */
@@ -1664,7 +1739,7 @@ export declare enum FallbackReason {
1664
1739
  * 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.
1665
1740
  * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
1666
1741
  */
1667
- export interface AggregatedTaxBreakdown {
1742
+ interface AggregatedTaxBreakdown {
1668
1743
  /**
1669
1744
  * The name of the tax against which this tax amount was calculated.
1670
1745
  * @maxLength 200
@@ -1690,7 +1765,7 @@ export interface AggregatedTaxBreakdown {
1690
1765
  /** The sum of all the tax from line items that calculated by the tax identifiers. */
1691
1766
  aggregatedTaxAmount?: MultiCurrencyPrice;
1692
1767
  }
1693
- export declare enum ChannelType {
1768
+ declare enum ChannelType {
1694
1769
  /** Unspecified sales channel. This value is not supported. */
1695
1770
  UNSPECIFIED = "UNSPECIFIED",
1696
1771
  /** A web client. */
@@ -1724,7 +1799,7 @@ export declare enum ChannelType {
1724
1799
  /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
1725
1800
  FAIRE_COM = "FAIRE_COM"
1726
1801
  }
1727
- export interface CreatedBy extends CreatedByIdOneOf {
1802
+ interface CreatedBy extends CreatedByIdOneOf {
1728
1803
  /**
1729
1804
  * User ID. When the order was created by a Wix user on behalf of a buyer.
1730
1805
  * For example, via POS (point of service).
@@ -1748,7 +1823,7 @@ export interface CreatedBy extends CreatedByIdOneOf {
1748
1823
  appId?: string;
1749
1824
  }
1750
1825
  /** @oneof */
1751
- export interface CreatedByIdOneOf {
1826
+ interface CreatedByIdOneOf {
1752
1827
  /**
1753
1828
  * User ID. When the order was created by a Wix user on behalf of a buyer.
1754
1829
  * For example, via POS (point of service).
@@ -1772,7 +1847,7 @@ export interface CreatedByIdOneOf {
1772
1847
  appId?: string;
1773
1848
  }
1774
1849
  /** Reserved for internal use. */
1775
- export interface MembershipOptions {
1850
+ interface MembershipOptions {
1776
1851
  /**
1777
1852
  * Reserved for internal use.
1778
1853
  * @readonly
@@ -1788,13 +1863,13 @@ export interface MembershipOptions {
1788
1863
  /** Selected membership to apply to this checkout. */
1789
1864
  selectedMemberships?: SelectedMemberships;
1790
1865
  }
1791
- export interface Membership {
1866
+ interface Membership {
1792
1867
  /**
1793
1868
  * Membership ID.
1794
1869
  * @minLength 1
1795
1870
  * @maxLength 100
1796
1871
  */
1797
- id?: string;
1872
+ _id?: string;
1798
1873
  /**
1799
1874
  * ID of the application providing this payment option.
1800
1875
  * @format GUID
@@ -1803,7 +1878,7 @@ export interface Membership {
1803
1878
  /** The name of this membership. */
1804
1879
  name?: MembershipName;
1805
1880
  /**
1806
- * Line item IDs which are "paid" for by this membership.
1881
+ * Line item IDs which are "paid for" by this membership.
1807
1882
  * @minSize 1
1808
1883
  * @maxSize 300
1809
1884
  * @minLength 1
@@ -1817,7 +1892,7 @@ export interface Membership {
1817
1892
  /** Additional data about this membership. */
1818
1893
  additionalData?: Record<string, any> | null;
1819
1894
  }
1820
- export interface MembershipName {
1895
+ interface MembershipName {
1821
1896
  /**
1822
1897
  * Membership name.
1823
1898
  * @maxLength 100
@@ -1829,7 +1904,7 @@ export interface MembershipName {
1829
1904
  */
1830
1905
  translated?: string | null;
1831
1906
  }
1832
- export interface MembershipPaymentCredits {
1907
+ interface MembershipPaymentCredits {
1833
1908
  /**
1834
1909
  * Membership's total amount of credits.
1835
1910
  * @min 1
@@ -1838,7 +1913,7 @@ export interface MembershipPaymentCredits {
1838
1913
  /** Membership's remaining amount of credits. */
1839
1914
  remaining?: number;
1840
1915
  }
1841
- export interface InvalidMembership {
1916
+ interface InvalidMembership {
1842
1917
  /** Membership details. */
1843
1918
  membership?: Membership;
1844
1919
  /**
@@ -1848,20 +1923,20 @@ export interface InvalidMembership {
1848
1923
  */
1849
1924
  reason?: string;
1850
1925
  }
1851
- export interface SelectedMemberships {
1926
+ interface SelectedMemberships {
1852
1927
  /**
1853
1928
  * Selected memberships.
1854
1929
  * @maxSize 300
1855
1930
  */
1856
1931
  memberships?: SelectedMembership[];
1857
1932
  }
1858
- export interface SelectedMembership {
1933
+ interface SelectedMembership {
1859
1934
  /**
1860
1935
  * Membership ID.
1861
1936
  * @minLength 1
1862
1937
  * @maxLength 100
1863
1938
  */
1864
- id?: string;
1939
+ _id?: string;
1865
1940
  /**
1866
1941
  * ID of the app providing this payment option.
1867
1942
  * @format GUID
@@ -1876,7 +1951,7 @@ export interface SelectedMembership {
1876
1951
  */
1877
1952
  lineItemIds?: string[];
1878
1953
  }
1879
- export interface AdditionalFee {
1954
+ interface AdditionalFee {
1880
1955
  /**
1881
1956
  * Additional fee's unique code (or ID) for future processing.
1882
1957
  * @minLength 1
@@ -1909,10 +1984,18 @@ export interface AdditionalFee {
1909
1984
  * @format GUID
1910
1985
  */
1911
1986
  lineItemIds?: string[];
1987
+ /**
1988
+ * Number of subscription cycle this fee applies to
1989
+ * default None - all billing cycle
1990
+ * @internal
1991
+ * @min 1
1992
+ * @max 999
1993
+ */
1994
+ subscriptionCycles?: number | null;
1912
1995
  /** the source the additional fee was added from */
1913
1996
  source?: AdditionalFeeSource;
1914
1997
  }
1915
- export declare enum AdditionalFeeSource {
1998
+ declare enum AdditionalFeeSource {
1916
1999
  UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
1917
2000
  /** The additional fee was added by an additional fee service plugin */
1918
2001
  SERVICE_PLUGIN = "SERVICE_PLUGIN",
@@ -1921,7 +2004,7 @@ export declare enum AdditionalFeeSource {
1921
2004
  /** The additional fee was added manually on the request */
1922
2005
  MANUAL = "MANUAL"
1923
2006
  }
1924
- export interface ConversionInfo {
2007
+ interface ConversionInfo {
1925
2008
  /**
1926
2009
  * The site currency.
1927
2010
  * @readonly
@@ -1935,7 +2018,7 @@ export interface ConversionInfo {
1935
2018
  */
1936
2019
  conversionRate?: string;
1937
2020
  }
1938
- export interface Violation {
2021
+ interface Violation {
1939
2022
  /** 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. */
1940
2023
  severity?: Severity;
1941
2024
  /** Target location on a checkout or cart page where the violation will be displayed. */
@@ -1947,7 +2030,7 @@ export interface Violation {
1947
2030
  */
1948
2031
  description?: string | null;
1949
2032
  }
1950
- export declare enum Severity {
2033
+ declare enum Severity {
1951
2034
  /** The user is allowed to move forward in the flow. */
1952
2035
  WARNING = "WARNING",
1953
2036
  /**
@@ -1956,48 +2039,53 @@ export declare enum Severity {
1956
2039
  */
1957
2040
  ERROR = "ERROR"
1958
2041
  }
1959
- export interface Target extends TargetTargetTypeOneOf {
2042
+ interface Target extends TargetTargetTypeOneOf {
1960
2043
  /** General (other) violation. */
1961
2044
  other?: Other;
1962
2045
  /** Specific line item violation. */
1963
2046
  lineItem?: TargetLineItem;
1964
2047
  }
1965
2048
  /** @oneof */
1966
- export interface TargetTargetTypeOneOf {
2049
+ interface TargetTargetTypeOneOf {
1967
2050
  /** General (other) violation. */
1968
2051
  other?: Other;
1969
2052
  /** Specific line item violation. */
1970
2053
  lineItem?: TargetLineItem;
1971
2054
  }
1972
2055
  /** Available locations on the webpage */
1973
- export declare enum NameInOther {
2056
+ declare enum NameInOther {
1974
2057
  /** Default location, in case no specific location is specified. */
1975
2058
  OTHER_DEFAULT = "OTHER_DEFAULT"
1976
2059
  }
1977
2060
  /** Available locations on the line item */
1978
- export declare enum NameInLineItem {
2061
+ declare enum NameInLineItem {
1979
2062
  /** Default location, in case no specific location is specified. */
1980
2063
  LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
1981
2064
  }
1982
- export declare enum SuggestedFix {
2065
+ declare enum SuggestedFix {
1983
2066
  /** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
1984
2067
  UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
1985
2068
  /** The line item should be removed from the cart or checkout to resolve the violation. */
1986
2069
  REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
1987
2070
  }
1988
2071
  /** General (other) violation. */
1989
- export interface Other {
2072
+ interface Other {
1990
2073
  /** Location on a checkout or a cart page where a general (other) violation will be displayed. */
1991
2074
  name?: NameInOther;
1992
2075
  }
1993
2076
  /** Specific line item violation. */
1994
- export interface TargetLineItem {
2077
+ interface TargetLineItem {
1995
2078
  /** Location on a checkout or a cart page where the specific line item violation will be displayed. */
1996
2079
  name?: NameInLineItem;
1997
2080
  /** ID of the line item containing the violation. */
1998
- id?: string | null;
2081
+ _id?: string | null;
2082
+ /**
2083
+ * Suggested fix for resolving the line item violation.
2084
+ * @internal
2085
+ */
2086
+ suggestedFix?: SuggestedFix;
1999
2087
  }
2000
- export interface CustomSettings {
2088
+ interface CustomSettings {
2001
2089
  /**
2002
2090
  * Whether to restrict the option to add or remove a gift card on the checkout page.
2003
2091
  *
@@ -2023,7 +2111,7 @@ export interface CustomSettings {
2023
2111
  */
2024
2112
  disabledManualPayment?: boolean;
2025
2113
  }
2026
- export interface CustomContentReference {
2114
+ interface CustomContentReference {
2027
2115
  /**
2028
2116
  * ID of the app providing the content.
2029
2117
  *
@@ -2039,7 +2127,7 @@ export interface CustomContentReference {
2039
2127
  */
2040
2128
  componentId?: string;
2041
2129
  }
2042
- export interface ExternalReference {
2130
+ interface ExternalReference {
2043
2131
  /**
2044
2132
  * ID of the app associated with the purchase flow.
2045
2133
  * For example, the Wix Pay Links app ID.
@@ -2056,7 +2144,7 @@ export interface ExternalReference {
2056
2144
  */
2057
2145
  resourceId?: string | null;
2058
2146
  }
2059
- export interface SubscriptionCharges {
2147
+ interface SubscriptionCharges {
2060
2148
  /**
2061
2149
  * ids of the items the subscription is defined on
2062
2150
  * @format GUID
@@ -2076,7 +2164,7 @@ export interface SubscriptionCharges {
2076
2164
  */
2077
2165
  charges?: Charge[];
2078
2166
  }
2079
- export interface Charge {
2167
+ interface Charge {
2080
2168
  /** The cycle number from which the charge starts. */
2081
2169
  cycleFrom?: number;
2082
2170
  /** The number of cycles for which the charge is applicable. */
@@ -2086,16 +2174,16 @@ export interface Charge {
2086
2174
  /** The billing date from which the charge starts. */
2087
2175
  cycleBillingDate?: Date | null;
2088
2176
  }
2089
- export interface UpdatedCheckoutMessage {
2177
+ interface UpdatedCheckoutMessage {
2090
2178
  /** Previous checkout. */
2091
2179
  oldCheckout?: Checkout;
2092
2180
  /** Updated checkout. */
2093
2181
  updatedCheckout?: Checkout;
2094
2182
  }
2095
- export interface CreateCheckoutRequest {
2183
+ interface CreateCheckoutRequest {
2096
2184
  /** Checkout information. */
2097
2185
  checkoutInfo?: Checkout;
2098
- /** Coupon code. */
2186
+ /** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
2099
2187
  couponCode?: string | null;
2100
2188
  /**
2101
2189
  * Catalog line items to add to the checkout.
@@ -2123,14 +2211,12 @@ export interface CreateCheckoutRequest {
2123
2211
  /**
2124
2212
  * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
2125
2213
  *
2126
- * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API
2127
- * to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
2128
- * standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
2214
+ * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
2129
2215
  * @maxLength 1000
2130
2216
  */
2131
2217
  overrideCheckoutUrl?: string | null;
2132
2218
  }
2133
- export interface CustomLineItem {
2219
+ interface CustomLineItem {
2134
2220
  /**
2135
2221
  * Custom line item quantity.
2136
2222
  *
@@ -2141,9 +2227,7 @@ export interface CustomLineItem {
2141
2227
  */
2142
2228
  quantity?: number;
2143
2229
  /**
2144
- * Custom line item price.
2145
- *
2146
- * Must be a number or a decimal without symbols.
2230
+ * Custom line item price. For security reasons, the `price` field should come from backend Velo code, and not be passed from the frontend.
2147
2231
  * @format DECIMAL_VALUE
2148
2232
  * @decimalValue options { gte:0, lte:1000000000000000 }
2149
2233
  */
@@ -2151,19 +2235,23 @@ export interface CustomLineItem {
2151
2235
  /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
2152
2236
  priceDescription?: PriceDescription;
2153
2237
  /**
2154
- * Custom line item description lines. Used for display purposes for the cart, checkout and order.
2238
+ * Custom line item description lines. Used for displaying the cart, checkout and order.
2155
2239
  * @maxSize 10
2156
2240
  */
2157
2241
  descriptionLines?: DescriptionLine[];
2158
- /** Custom line item's media. */
2159
- media?: Image;
2242
+ /**
2243
+ * Custom line item media.
2244
+ * + Link to an image/video from the [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager) - `"wix:image://v1/3c76e2_c53...4ea4~mv2.jpg#originWidth=1000&originHeight=1000"`.
2245
+ * + An image from the web - `"http(s)://<image url>"`.
2246
+ */
2247
+ media?: string;
2160
2248
  /**
2161
2249
  * Custom line item ID. If passed, `id` must be unique.
2162
2250
  *
2163
2251
  * Default: auto-generated ID
2164
2252
  * @format GUID
2165
2253
  */
2166
- id?: string | null;
2254
+ _id?: string | null;
2167
2255
  /**
2168
2256
  * Tax group ID for this custom line item.
2169
2257
  * @format GUID
@@ -2172,7 +2260,7 @@ export interface CustomLineItem {
2172
2260
  /** Name of the item or product. */
2173
2261
  productName?: ProductName;
2174
2262
  /** 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. */
2175
- url?: PageUrlV2;
2263
+ url?: string;
2176
2264
  /** Item type. Either a preset type or custom. */
2177
2265
  itemType?: ItemType;
2178
2266
  /**
@@ -2227,6 +2315,20 @@ export interface CustomLineItem {
2227
2315
  deliveryProfileId?: string | null;
2228
2316
  /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
2229
2317
  catalogReference?: CatalogReference;
2318
+ /**
2319
+ * Whether the price is not yet defined, and will be updated after the order is created.
2320
+ *
2321
+ * Default: `false`
2322
+ * @internal
2323
+ */
2324
+ priceUndetermined?: boolean;
2325
+ /**
2326
+ * Whether the line item quantity is fixed and cannot be changed.
2327
+ *
2328
+ * Default: `false`
2329
+ * @internal
2330
+ */
2331
+ fixedQuantity?: boolean;
2230
2332
  /**
2231
2333
  * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
2232
2334
  * @minLength 1
@@ -2241,105 +2343,123 @@ export interface CustomLineItem {
2241
2343
  * @readonly
2242
2344
  */
2243
2345
  savePaymentMethod?: boolean;
2346
+ /**
2347
+ * Policies to be displayed to the customer on the checkout page.
2348
+ * @internal
2349
+ * @maxSize 5
2350
+ */
2351
+ policies?: Policy[];
2352
+ /**
2353
+ * ID of the app managing the inventory.
2354
+ * @internal
2355
+ * @format GUID
2356
+ */
2357
+ inventoryAppId?: string | null;
2358
+ /**
2359
+ * Whether the item can only be purchased by site members.
2360
+ *
2361
+ * Default: `false`
2362
+ * @internal
2363
+ */
2364
+ membersOnly?: boolean;
2365
+ /**
2366
+ * Address to use for tax calculation purposes.
2367
+ * @internal
2368
+ */
2369
+ taxableAddress?: TaxableAddress;
2244
2370
  }
2245
- export interface MerchantDiscountInput {
2371
+ interface MerchantDiscountInput {
2246
2372
  /**
2247
2373
  * Discount amount.
2248
2374
  * @decimalValue options { gte:0 }
2249
2375
  */
2250
2376
  amount?: string;
2251
2377
  /**
2252
- * IDs of line items the discount applies to.
2378
+ * IDs of the line items the discount applies to.
2253
2379
  * @format GUID
2254
2380
  * @maxSize 300
2255
2381
  */
2256
2382
  lineItemIds?: string[];
2257
2383
  }
2258
- export interface CreateCheckoutResponse {
2384
+ interface CreateCheckoutResponse {
2259
2385
  /** Newly created checkout. */
2260
2386
  checkout?: Checkout;
2261
2387
  }
2262
- export interface ShippingCalculationErrorData extends ShippingCalculationErrorDataShippingCalculationErrorOneOf {
2388
+ interface ShippingCalculationErrorData extends ShippingCalculationErrorDataShippingCalculationErrorOneOf {
2263
2389
  generalShippingCalculationError?: Details;
2264
2390
  carrierErrors?: CarrierErrors;
2265
2391
  }
2266
2392
  /** @oneof */
2267
- export interface ShippingCalculationErrorDataShippingCalculationErrorOneOf {
2393
+ interface ShippingCalculationErrorDataShippingCalculationErrorOneOf {
2268
2394
  generalShippingCalculationError?: Details;
2269
2395
  carrierErrors?: CarrierErrors;
2270
2396
  }
2271
- export interface GetCheckoutRequest {
2397
+ interface GetCheckoutRequest {
2272
2398
  /**
2273
2399
  * Checkout ID.
2274
2400
  * @format GUID
2275
2401
  */
2276
- id: string;
2402
+ _id: string;
2277
2403
  }
2278
- export interface GetCheckoutResponse {
2404
+ interface GetCheckoutResponse {
2279
2405
  /** Retrieved checkout. */
2280
2406
  checkout?: Checkout;
2281
2407
  }
2282
- export interface GetCheckoutWithAllExtendedFieldsRequest {
2408
+ interface GetCheckoutWithAllExtendedFieldsRequest {
2283
2409
  /**
2284
2410
  * Checkout ID.
2285
2411
  * @format GUID
2286
2412
  */
2287
- id?: string;
2413
+ _id?: string;
2288
2414
  }
2289
- export interface GetCheckoutWithAllExtendedFieldsResponse {
2415
+ interface GetCheckoutWithAllExtendedFieldsResponse {
2290
2416
  /** Retrieved checkout. */
2291
2417
  checkout?: Checkout;
2292
2418
  }
2293
- export interface GetCheckoutByCartIdRequest {
2419
+ interface GetCheckoutByCartIdRequest {
2294
2420
  /**
2295
2421
  * Cart ID.
2296
2422
  * @format GUID
2297
2423
  */
2298
- id: string;
2424
+ _id: string;
2299
2425
  }
2300
- export interface GetCheckoutByCartIdResponse {
2426
+ interface GetCheckoutByCartIdResponse {
2301
2427
  /** Retrieved checkout. */
2302
2428
  checkout?: Checkout;
2303
2429
  }
2304
- export interface GetWixCheckoutURLRequest {
2430
+ interface GetWixCheckoutURLRequest {
2305
2431
  /**
2306
2432
  * Checkout ID.
2307
2433
  * @format GUID
2308
2434
  */
2309
- id: string;
2435
+ _id: string;
2310
2436
  }
2311
- export interface GetWixCheckoutURLResponse {
2437
+ interface GetWixCheckoutURLResponse {
2312
2438
  /** Checkout URL. */
2313
2439
  checkoutUrl?: string;
2314
2440
  }
2315
- export interface GetCheckoutURLRequest {
2441
+ interface GetCheckoutURLRequest {
2316
2442
  /**
2317
2443
  * Checkout ID.
2318
2444
  * @format GUID
2319
2445
  */
2320
- id: string;
2446
+ _id: string;
2321
2447
  }
2322
- export interface GetCheckoutURLResponse {
2448
+ interface GetCheckoutURLResponse {
2323
2449
  /** Checkout URL. */
2324
2450
  checkoutUrl?: string;
2325
2451
  }
2326
- export interface UpdateCheckoutRequest {
2452
+ interface UpdateCheckoutRequest {
2327
2453
  /** Checkout information. */
2328
2454
  checkout: Checkout;
2329
- /**
2330
- * Coupon code.
2331
- *
2332
- * The checkout can only hold 1 `couponCode` at a time. If an additional `couponCode` is added, it will override the existing `couponCode`.
2333
- */
2455
+ /** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
2334
2456
  couponCode?: string | null;
2335
2457
  /** Gift card code. */
2336
2458
  giftCardCode?: string | null;
2337
2459
  /**
2338
2460
  * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
2339
2461
  *
2340
- * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API
2341
- * to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
2342
- * standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
2462
+ * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
2343
2463
  * @maxLength 1000
2344
2464
  */
2345
2465
  overrideCheckoutUrl?: string | null;
@@ -2357,49 +2477,49 @@ export interface UpdateCheckoutRequest {
2357
2477
  */
2358
2478
  customLineItems?: CustomLineItem[];
2359
2479
  }
2360
- export interface UpdateCheckoutResponse {
2480
+ interface UpdateCheckoutResponse {
2361
2481
  /** Updated checkout. */
2362
2482
  checkout?: Checkout;
2363
2483
  }
2364
- export interface RemoveCouponRequest {
2484
+ interface RemoveCouponRequest {
2365
2485
  /**
2366
2486
  * ID of the checkout to remove the coupon from.
2367
2487
  * @format GUID
2368
2488
  */
2369
- id: string;
2489
+ _id: string;
2370
2490
  }
2371
- export interface RemoveCouponResponse {
2491
+ interface RemoveCouponResponse {
2372
2492
  /** Updated checkout after removal of coupon. */
2373
2493
  checkout?: Checkout;
2374
2494
  }
2375
- export interface RemoveGiftCardRequest {
2495
+ interface RemoveGiftCardRequest {
2376
2496
  /**
2377
2497
  * ID of the checkout to remove the gift card from.
2378
2498
  * @format GUID
2379
2499
  */
2380
- id: string;
2500
+ _id: string;
2381
2501
  }
2382
- export interface RemoveGiftCardResponse {
2502
+ interface RemoveGiftCardResponse {
2383
2503
  /** Updated checkout after removal of gift card. */
2384
2504
  checkout?: Checkout;
2385
2505
  }
2386
- export interface RemoveOverrideCheckoutUrlRequest {
2506
+ interface RemoveOverrideCheckoutUrlRequest {
2387
2507
  /**
2388
2508
  * ID of the checkout to remove the override checkout url from.
2389
2509
  * @format GUID
2390
2510
  */
2391
- id: string;
2511
+ _id: string;
2392
2512
  }
2393
- export interface RemoveOverrideCheckoutUrlResponse {
2513
+ interface RemoveOverrideCheckoutUrlResponse {
2394
2514
  /** Updated checkout after removal of override checkout url. */
2395
2515
  checkout?: Checkout;
2396
2516
  }
2397
- export interface AddToCheckoutRequest {
2517
+ interface AddToCheckoutRequest {
2398
2518
  /**
2399
2519
  * Checkout ID.
2400
2520
  * @format GUID
2401
2521
  */
2402
- id: string;
2522
+ _id: string;
2403
2523
  /**
2404
2524
  * Catalog line items.
2405
2525
  * @maxSize 100
@@ -2414,46 +2534,42 @@ export interface AddToCheckoutRequest {
2414
2534
  */
2415
2535
  customLineItems?: CustomLineItem[];
2416
2536
  }
2417
- export interface AddToCheckoutResponse {
2537
+ interface AddToCheckoutResponse {
2418
2538
  /** Updated checkout. */
2419
2539
  checkout?: Checkout;
2420
2540
  }
2421
- export interface RemoveLineItemsRequest {
2541
+ interface RemoveLineItemsRequest {
2422
2542
  /**
2423
2543
  * ID of the checkout to remove line items from.
2424
2544
  * @format GUID
2425
2545
  */
2426
- id: string;
2546
+ _id: string;
2427
2547
  /**
2428
2548
  * IDs of the line items to remove from the checkout.
2429
- *
2430
- * To find the IDs of the checkout line items you'd like to remove,
2431
- * pass the checkout ID to Get Checkout and look for the IDs under
2432
- * `lineItems`.
2433
2549
  * @format GUID
2434
2550
  * @minSize 1
2435
2551
  * @maxSize 300
2436
2552
  */
2437
2553
  lineItemIds: string[];
2438
2554
  }
2439
- export interface RemoveLineItemsResponse {
2555
+ interface RemoveLineItemsResponse {
2440
2556
  /** Updated checkout after removal of line items. */
2441
2557
  checkout?: Checkout;
2442
2558
  }
2443
- export interface CreateOrderRequest {
2559
+ interface CreateOrderRequest {
2444
2560
  /**
2445
2561
  * Checkout ID.
2446
2562
  * @format GUID
2447
2563
  */
2448
- id: string;
2564
+ _id: string;
2449
2565
  /** Whether the payment method should be saved on the order. */
2450
2566
  savePaymentMethod?: boolean;
2451
2567
  /** Whether to authorize the payment and delay the capture. */
2452
2568
  delayCapture?: boolean;
2453
2569
  }
2454
- export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
2570
+ interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
2455
2571
  /**
2456
- * ID of newly created order.
2572
+ * ID of the newly created order.
2457
2573
  * @format GUID
2458
2574
  */
2459
2575
  orderId?: string;
@@ -2466,16 +2582,15 @@ export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
2466
2582
  * Payment gateway order ID.
2467
2583
  *
2468
2584
  * For online orders, pass this value as the `paymentId` parameter to the Wix Pay [`startPayment()`](https://www.wix.com/velo/reference/wix-pay-frontend/startpayment) function so your customer can pay for the order.
2469
- * `paymentGatewayOrderId` will be returned if money needs to be charged.
2470
2585
  *
2471
- * In some cases, money cannot be charged:
2472
- * + When the total price (the `priceSummary.total.amount` field in the checkout/order objects) is `0`. For example, in the case of a free item or an item with a 100% discount.
2473
- * + If the total price is not `0`, but the payment is covered by alternative payment methods, such as a gift card.
2586
+ * This field will be returned if money needs to be charged. In some cases, money cannot be charged:
2587
+ * + When the total price (the `priceSummary.total.amount` field in the checkout/order objects) is 0. For example, in the case of a free item or an item with a 100% discount.
2588
+ * + If the total price is not 0, but the payment is covered by alternative payment methods, such as a gift card.
2474
2589
  */
2475
2590
  paymentGatewayOrderId?: string | null;
2476
2591
  }
2477
2592
  /** @oneof */
2478
- export interface CreateOrderResponseIdOneOf {
2593
+ interface CreateOrderResponseIdOneOf {
2479
2594
  /**
2480
2595
  * ID of newly created order.
2481
2596
  * @format GUID
@@ -2487,37 +2602,37 @@ export interface CreateOrderResponseIdOneOf {
2487
2602
  */
2488
2603
  subscriptionId?: string;
2489
2604
  }
2490
- export interface PaymentErrorResponseData {
2605
+ interface PaymentErrorResponseData {
2491
2606
  paymentResponseToken?: string | null;
2492
2607
  transactionStatus?: string;
2493
2608
  failureDetails?: string | null;
2494
2609
  }
2495
- export interface DoublePaymentErrorData extends DoublePaymentErrorDataIdOneOf {
2610
+ interface DoublePaymentErrorData extends DoublePaymentErrorDataIdOneOf {
2496
2611
  /** @format GUID */
2497
2612
  orderId?: string;
2498
2613
  /** @format GUID */
2499
2614
  subscriptionId?: string;
2500
2615
  }
2501
2616
  /** @oneof */
2502
- export interface DoublePaymentErrorDataIdOneOf {
2617
+ interface DoublePaymentErrorDataIdOneOf {
2503
2618
  /** @format GUID */
2504
2619
  orderId?: string;
2505
2620
  /** @format GUID */
2506
2621
  subscriptionId?: string;
2507
2622
  }
2508
- export interface RedeemErrorData {
2623
+ interface RedeemErrorData {
2509
2624
  reason?: string;
2510
2625
  }
2511
- export interface ViolationsList {
2626
+ interface ViolationsList {
2512
2627
  /** Violations risen by ValidationsSPI implementers. */
2513
2628
  violations?: Violation[];
2514
2629
  }
2515
- export interface CreateOrderAndChargeRequest {
2630
+ interface CreateOrderAndChargeRequest {
2516
2631
  /**
2517
2632
  * Checkout ID.
2518
2633
  * @format GUID
2519
2634
  */
2520
- id: string;
2635
+ _id: string;
2521
2636
  /** Payment token. */
2522
2637
  paymentToken?: string | null;
2523
2638
  /** Whether the payment method should be saved on the order. */
@@ -2525,7 +2640,7 @@ export interface CreateOrderAndChargeRequest {
2525
2640
  /** Whether to authorize the payment and delay the capture. */
2526
2641
  delayCapture?: boolean;
2527
2642
  }
2528
- export interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOneOf {
2643
+ interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOneOf {
2529
2644
  /**
2530
2645
  * ID of newly created order.
2531
2646
  * @format GUID
@@ -2539,16 +2654,23 @@ export interface CreateOrderAndChargeResponse extends CreateOrderAndChargeRespon
2539
2654
  /** Payment response token. */
2540
2655
  paymentResponseToken?: string | null;
2541
2656
  /**
2542
- * The payment gateway is cashier.
2543
- * payment_gateway_order_id will be returned given that money was charged.
2544
- * In some cases, money will not be charged:
2545
- * If the total price is 0 - For example, could be a free item or a an item with 100% discount
2546
- * If the total price is not 0, but the payment is covered by alternative payment methods such as gift card
2657
+ * For online orders, send this value as a parameter to the Wix Pay [`startPayment()`](https://www.wix.com/velo/reference/wix-pay/startpayment) function to enable your buyer to pay for the order.
2658
+ * `paymentGatewayOrderId` will be returned if money needs to be charged.
2659
+ *
2660
+ * In some cases, money should not be charged:
2661
+ * + If the total price is 0. For example, in the case of a free item or an item with 100% discount.
2662
+ * + If the total price is not 0, but the payment is covered by alternative payment methods, such as a gift card.
2547
2663
  */
2548
2664
  paymentGatewayOrderId?: string | null;
2665
+ /**
2666
+ * Whether an order was successfully created from this checkout and the payment transaction was completed
2667
+ * @internal
2668
+ * @readonly
2669
+ */
2670
+ checkoutCompleted?: boolean;
2549
2671
  }
2550
2672
  /** @oneof */
2551
- export interface CreateOrderAndChargeResponseIdOneOf {
2673
+ interface CreateOrderAndChargeResponseIdOneOf {
2552
2674
  /**
2553
2675
  * ID of newly created order.
2554
2676
  * @format GUID
@@ -2560,41 +2682,47 @@ export interface CreateOrderAndChargeResponseIdOneOf {
2560
2682
  */
2561
2683
  subscriptionId?: string;
2562
2684
  }
2563
- export interface MarkCheckoutAsCompletedAndRedirectToUrlRequest {
2685
+ interface MarkCheckoutAsCompletedAndRedirectToUrlRequest {
2564
2686
  /**
2565
2687
  * Server-signed JWT token with required information to complete checkout
2566
2688
  * @maxLength 4096
2567
2689
  */
2568
2690
  token: string;
2569
2691
  }
2570
- export interface RawHttpResponse {
2692
+ interface RawHttpResponse {
2571
2693
  body?: Uint8Array;
2572
2694
  statusCode?: number | null;
2573
2695
  headers?: HeadersEntry[];
2574
2696
  }
2575
- export interface HeadersEntry {
2697
+ interface HeadersEntry {
2576
2698
  key?: string;
2577
2699
  value?: string;
2578
2700
  }
2579
- export interface MarkCheckoutAsCompletedRequest {
2701
+ interface MarkCheckoutAsCompletedRequest {
2580
2702
  /**
2581
2703
  * Checkout ID.
2582
2704
  * @format GUID
2583
2705
  */
2584
- id: string;
2706
+ _id: string;
2707
+ /**
2708
+ * Order ID.
2709
+ * @internal
2710
+ * @format GUID
2711
+ */
2712
+ orderId?: string | null;
2585
2713
  }
2586
- export interface MarkCheckoutAsCompletedResponse {
2714
+ interface MarkCheckoutAsCompletedResponse {
2587
2715
  }
2588
2716
  /** Triggered when an order created from this checkout is successfully paid for or when a checkout is marked as completed. */
2589
- export interface CheckoutMarkedAsCompleted {
2717
+ interface CheckoutMarkedAsCompleted {
2590
2718
  checkout?: Checkout;
2591
2719
  }
2592
- export interface UpdateLineItemsQuantityRequest {
2720
+ interface UpdateLineItemsQuantityRequest {
2593
2721
  /**
2594
2722
  * Checkout ID.
2595
2723
  * @format GUID
2596
2724
  */
2597
- id: string;
2725
+ _id: string;
2598
2726
  /**
2599
2727
  * Line item info to update.
2600
2728
  * @minSize 1
@@ -2602,12 +2730,12 @@ export interface UpdateLineItemsQuantityRequest {
2602
2730
  */
2603
2731
  lineItems: LineItemQuantityUpdate[];
2604
2732
  }
2605
- export interface LineItemQuantityUpdate {
2733
+ interface LineItemQuantityUpdate {
2606
2734
  /**
2607
2735
  * ID of the line item to update.
2608
2736
  * @format GUID
2609
2737
  */
2610
- id?: string;
2738
+ _id?: string;
2611
2739
  /**
2612
2740
  * New total amount of the line item,
2613
2741
  * not the amount to add to the current `quantity`.
@@ -2620,42 +2748,42 @@ export interface LineItemQuantityUpdate {
2620
2748
  */
2621
2749
  quantity?: number;
2622
2750
  }
2623
- export interface UpdateLineItemsQuantityResponse {
2751
+ interface UpdateLineItemsQuantityResponse {
2624
2752
  /** Updated checkout. */
2625
2753
  checkout?: Checkout;
2626
2754
  }
2627
- export interface GetCheckoutPaymentSettingsRequest {
2755
+ interface GetCheckoutPaymentSettingsRequest {
2628
2756
  /**
2629
2757
  * Checkout ID.
2630
2758
  * @format GUID
2631
2759
  */
2632
- id: string;
2760
+ _id: string;
2633
2761
  }
2634
- export interface GetCheckoutPaymentSettingsResponse {
2762
+ interface GetCheckoutPaymentSettingsResponse {
2635
2763
  blockedPaymentOptions?: GetCheckoutPaymentSettingsResponsePaymentOption[];
2636
2764
  }
2637
- export declare enum GetCheckoutPaymentSettingsResponsePaymentOption {
2765
+ declare enum GetCheckoutPaymentSettingsResponsePaymentOption {
2638
2766
  UNKNOWN_PAYMENT_OPTION = "UNKNOWN_PAYMENT_OPTION",
2639
2767
  MANUAL = "MANUAL"
2640
2768
  }
2641
- export interface DeleteCheckoutRequest {
2769
+ interface DeleteCheckoutRequest {
2642
2770
  /**
2643
2771
  * ID of the checkout to delete.
2644
2772
  * @format GUID
2645
2773
  */
2646
- id?: string;
2774
+ _id?: string;
2647
2775
  }
2648
- export interface DeleteCheckoutResponse {
2776
+ interface DeleteCheckoutResponse {
2649
2777
  }
2650
- export interface SubscriptionCreated {
2778
+ interface SubscriptionCreated {
2651
2779
  subscription?: Subscription;
2652
2780
  }
2653
- export interface Subscription {
2781
+ interface Subscription {
2654
2782
  /**
2655
2783
  * Subscription id (auto-generated upon subscription creation)
2656
2784
  * @readonly
2657
2785
  */
2658
- id?: string;
2786
+ _id?: string;
2659
2787
  /**
2660
2788
  * id of subscription in external system
2661
2789
  * @format GUID
@@ -2714,23 +2842,23 @@ export interface Subscription {
2714
2842
  billingInfo?: BillingInfo;
2715
2843
  }
2716
2844
  /** Buyer Info */
2717
- export interface V1BuyerInfo {
2845
+ interface V1BuyerInfo {
2718
2846
  /**
2719
2847
  * Wix customer ID
2720
2848
  * @format GUID
2721
2849
  */
2722
- id?: string;
2850
+ _id?: string;
2723
2851
  /** Customer type */
2724
2852
  identityType?: IdentityType;
2725
2853
  }
2726
- export declare enum IdentityType {
2854
+ declare enum IdentityType {
2727
2855
  UNSPECIFIED_IDENTITY_TYPE = "UNSPECIFIED_IDENTITY_TYPE",
2728
2856
  /** Site member */
2729
2857
  MEMBER = "MEMBER",
2730
2858
  /** Contact */
2731
2859
  CONTACT = "CONTACT"
2732
2860
  }
2733
- export interface V1LineItem {
2861
+ interface V1LineItem {
2734
2862
  /** Line item ID (auto-generated) */
2735
2863
  index?: number;
2736
2864
  /**
@@ -2759,7 +2887,7 @@ export interface V1LineItem {
2759
2887
  /** Product details */
2760
2888
  productDetails?: ProductDetails;
2761
2889
  }
2762
- export interface OptionSelection {
2890
+ interface OptionSelection {
2763
2891
  /**
2764
2892
  * Option name
2765
2893
  * @maxLength 200
@@ -2771,7 +2899,7 @@ export interface OptionSelection {
2771
2899
  */
2772
2900
  selection?: string;
2773
2901
  }
2774
- export interface CustomTextFieldSelection {
2902
+ interface CustomTextFieldSelection {
2775
2903
  /**
2776
2904
  * Custom text field name
2777
2905
  * @maxLength 100
@@ -2783,7 +2911,7 @@ export interface CustomTextFieldSelection {
2783
2911
  */
2784
2912
  value?: string;
2785
2913
  }
2786
- export interface ChargeDetails {
2914
+ interface ChargeDetails {
2787
2915
  /**
2788
2916
  * price of line item (depends on subscription option)
2789
2917
  * @max 999999999.99
@@ -2812,7 +2940,7 @@ export interface ChargeDetails {
2812
2940
  */
2813
2941
  taxRate?: string | null;
2814
2942
  }
2815
- export interface ProductDetails {
2943
+ interface ProductDetails {
2816
2944
  /**
2817
2945
  * Line item product ID (optional for POS orders)
2818
2946
  * @minLength 1
@@ -2865,7 +2993,7 @@ export interface ProductDetails {
2865
2993
  */
2866
2994
  appId?: string | null;
2867
2995
  }
2868
- export declare enum LineItemType {
2996
+ declare enum LineItemType {
2869
2997
  /** Line item type can't be classified, due to an error */
2870
2998
  UNSPECIFIED_LINE_ITEM_TYPE = "UNSPECIFIED_LINE_ITEM_TYPE",
2871
2999
  /** Physical item type */
@@ -2875,7 +3003,7 @@ export declare enum LineItemType {
2875
3003
  /** Custom item price */
2876
3004
  CUSTOM_AMOUNT_ITEM = "CUSTOM_AMOUNT_ITEM"
2877
3005
  }
2878
- export interface MediaItem {
3006
+ interface MediaItem {
2879
3007
  /**
2880
3008
  * Media type
2881
3009
  * @readonly
@@ -2900,7 +3028,7 @@ export interface MediaItem {
2900
3028
  */
2901
3029
  height?: number;
2902
3030
  /** Media ID (for media items previously saved in Wix Media) */
2903
- id?: string | null;
3031
+ _id?: string | null;
2904
3032
  /** Media external URL */
2905
3033
  externalImageUrl?: string | null;
2906
3034
  /**
@@ -2909,13 +3037,13 @@ export interface MediaItem {
2909
3037
  */
2910
3038
  altText?: string | null;
2911
3039
  }
2912
- export declare enum MediaItemType {
3040
+ declare enum MediaItemType {
2913
3041
  /** Media item type can't be classified, due to an error */
2914
3042
  UNSPECIFIED_MEDIA_TYPE_ITEM = "UNSPECIFIED_MEDIA_TYPE_ITEM",
2915
3043
  /** Image item type */
2916
3044
  IMAGE = "IMAGE"
2917
3045
  }
2918
- export interface Totals {
3046
+ interface Totals {
2919
3047
  /**
2920
3048
  * Subtotal of all line items, before tax
2921
3049
  * @max 999999999.99
@@ -2952,7 +3080,7 @@ export interface Totals {
2952
3080
  */
2953
3081
  quantity?: number;
2954
3082
  }
2955
- export interface StoreSettings {
3083
+ interface StoreSettings {
2956
3084
  /**
2957
3085
  * Currency used for pricing in this store
2958
3086
  * @maxLength 3
@@ -2970,7 +3098,7 @@ export interface StoreSettings {
2970
3098
  */
2971
3099
  buyerLanguage?: string | null;
2972
3100
  }
2973
- export interface Address extends AddressAddressLine1OptionsOneOf {
3101
+ interface Address extends AddressAddressLine1OptionsOneOf {
2974
3102
  /**
2975
3103
  * Address line 1 (free text)
2976
3104
  * @maxLength 1000
@@ -3024,7 +3152,7 @@ export interface Address extends AddressAddressLine1OptionsOneOf {
3024
3152
  vatId?: VatId;
3025
3153
  }
3026
3154
  /** @oneof */
3027
- export interface AddressAddressLine1OptionsOneOf {
3155
+ interface AddressAddressLine1OptionsOneOf {
3028
3156
  /**
3029
3157
  * Address line 1 (free text)
3030
3158
  * @maxLength 1000
@@ -3033,7 +3161,7 @@ export interface AddressAddressLine1OptionsOneOf {
3033
3161
  /** Address line 1 (street) */
3034
3162
  street?: Street;
3035
3163
  }
3036
- export interface FullName {
3164
+ interface FullName {
3037
3165
  /**
3038
3166
  * Customer's first name
3039
3167
  * @maxLength 1000
@@ -3045,7 +3173,7 @@ export interface FullName {
3045
3173
  */
3046
3174
  lastName?: string;
3047
3175
  }
3048
- export interface Street {
3176
+ interface Street {
3049
3177
  /**
3050
3178
  * Street number
3051
3179
  * @maxLength 500
@@ -3057,7 +3185,7 @@ export interface Street {
3057
3185
  */
3058
3186
  name?: string;
3059
3187
  }
3060
- export interface VatId {
3188
+ interface VatId {
3061
3189
  /**
3062
3190
  * Customer's tax ID.
3063
3191
  * @maxLength 50
@@ -3071,7 +3199,7 @@ export interface VatId {
3071
3199
  type?: VatType;
3072
3200
  }
3073
3201
  /** Brazilian tax info types */
3074
- export declare enum VatType {
3202
+ declare enum VatType {
3075
3203
  /** When the tax info type can't be classified, due to an error */
3076
3204
  UNSPECIFIED_TAX_TYPE = "UNSPECIFIED_TAX_TYPE",
3077
3205
  /** CPF - for individual tax payers */
@@ -3079,7 +3207,7 @@ export declare enum VatType {
3079
3207
  /** CNPJ - for corporations */
3080
3208
  CNPJ = "CNPJ"
3081
3209
  }
3082
- export interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
3210
+ interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
3083
3211
  /** Shipment details (when this object describes shipment) */
3084
3212
  shipmentDetails?: ShipmentDetails;
3085
3213
  /** Pickup details (when this object describes pickup) */
@@ -3096,13 +3224,13 @@ export interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
3096
3224
  estimatedDeliveryTime?: string | null;
3097
3225
  }
3098
3226
  /** @oneof */
3099
- export interface V1ShippingInfoDetailsOneOf {
3227
+ interface V1ShippingInfoDetailsOneOf {
3100
3228
  /** Shipment details (when this object describes shipment) */
3101
3229
  shipmentDetails?: ShipmentDetails;
3102
3230
  /** Pickup details (when this object describes pickup) */
3103
3231
  pickupDetails?: V1PickupDetails;
3104
3232
  }
3105
- export interface ShipmentDetails {
3233
+ interface ShipmentDetails {
3106
3234
  /** Shipping destination address */
3107
3235
  address?: Address;
3108
3236
  /**
@@ -3123,7 +3251,7 @@ export interface ShipmentDetails {
3123
3251
  */
3124
3252
  taxRate?: string | null;
3125
3253
  }
3126
- export interface V1PickupDetails {
3254
+ interface V1PickupDetails {
3127
3255
  /** Pickup address */
3128
3256
  address?: PickupAddress;
3129
3257
  /**
@@ -3132,7 +3260,7 @@ export interface V1PickupDetails {
3132
3260
  */
3133
3261
  pickupInstructions?: string | null;
3134
3262
  }
3135
- export interface PickupAddress {
3263
+ interface PickupAddress {
3136
3264
  /**
3137
3265
  * Country code (2 letters)
3138
3266
  * @format COUNTRY
@@ -3159,7 +3287,7 @@ export interface PickupAddress {
3159
3287
  */
3160
3288
  zipCode?: string;
3161
3289
  }
3162
- export interface AppliedCoupon {
3290
+ interface AppliedCoupon {
3163
3291
  /** Coupon ID */
3164
3292
  couponId?: string;
3165
3293
  /**
@@ -3174,7 +3302,7 @@ export interface AppliedCoupon {
3174
3302
  code?: string;
3175
3303
  }
3176
3304
  /** Custom field */
3177
- export interface V1CustomField {
3305
+ interface V1CustomField {
3178
3306
  /**
3179
3307
  * Free text that the customer entered in the custom field during the checkout process
3180
3308
  * @maxLength 250
@@ -3191,9 +3319,9 @@ export interface V1CustomField {
3191
3319
  */
3192
3320
  translatedTitle?: string;
3193
3321
  }
3194
- export interface V1SubscriptionOptionInfo {
3322
+ interface V1SubscriptionOptionInfo {
3195
3323
  /** @format GUID */
3196
- id?: string | null;
3324
+ _id?: string | null;
3197
3325
  /**
3198
3326
  * @minLength 1
3199
3327
  * @maxLength 20
@@ -3203,29 +3331,29 @@ export interface V1SubscriptionOptionInfo {
3203
3331
  description?: string | null;
3204
3332
  discount?: Discount;
3205
3333
  }
3206
- export interface Discount {
3334
+ interface Discount {
3207
3335
  /** Discount type. */
3208
3336
  type?: DiscountDiscountType;
3209
3337
  /** Discount value. */
3210
3338
  value?: number;
3211
3339
  }
3212
- export declare enum DiscountDiscountType {
3340
+ declare enum DiscountDiscountType {
3213
3341
  UNDEFINED = "UNDEFINED",
3214
3342
  /** No discount */
3215
3343
  AMOUNT = "AMOUNT",
3216
3344
  PERCENT = "PERCENT"
3217
3345
  }
3218
- export interface ChannelInfo {
3346
+ interface ChannelInfo {
3219
3347
  /** Sales channel that submitted the subscription */
3220
3348
  type?: ChannelInfoChannelType;
3221
3349
  }
3222
- export declare enum ChannelInfoChannelType {
3350
+ declare enum ChannelInfoChannelType {
3223
3351
  UNSPECIFIED = "UNSPECIFIED",
3224
3352
  WEB = "WEB",
3225
3353
  OTHER_PLATFORM = "OTHER_PLATFORM",
3226
3354
  WIX_APP_STORE = "WIX_APP_STORE"
3227
3355
  }
3228
- export interface V1SubscriptionSettings {
3356
+ interface V1SubscriptionSettings {
3229
3357
  /** Frequency of recurring payment. */
3230
3358
  frequency?: SubscriptionFrequency;
3231
3359
  /** Whether subscription is renewed automatically at the end of each period. */
@@ -3237,7 +3365,7 @@ export interface V1SubscriptionSettings {
3237
3365
  */
3238
3366
  billingCycles?: number | null;
3239
3367
  }
3240
- export interface BillingInfo {
3368
+ interface BillingInfo {
3241
3369
  /**
3242
3370
  * Payment method used for this order
3243
3371
  * @maxLength 50
@@ -3254,9 +3382,9 @@ export interface BillingInfo {
3254
3382
  */
3255
3383
  paymentGatewayOrderId?: string | null;
3256
3384
  }
3257
- export interface Empty {
3385
+ interface Empty {
3258
3386
  }
3259
- export interface DomainEvent extends DomainEventBodyOneOf {
3387
+ interface DomainEvent extends DomainEventBodyOneOf {
3260
3388
  createdEvent?: EntityCreatedEvent;
3261
3389
  updatedEvent?: EntityUpdatedEvent;
3262
3390
  deletedEvent?: EntityDeletedEvent;
@@ -3265,7 +3393,7 @@ export interface DomainEvent extends DomainEventBodyOneOf {
3265
3393
  * Unique event ID.
3266
3394
  * Allows clients to ignore duplicate webhooks.
3267
3395
  */
3268
- id?: string;
3396
+ _id?: string;
3269
3397
  /**
3270
3398
  * Assumes actions are also always typed to an entity_type
3271
3399
  * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
@@ -3299,36 +3427,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
3299
3427
  entityEventSequence?: string | null;
3300
3428
  }
3301
3429
  /** @oneof */
3302
- export interface DomainEventBodyOneOf {
3430
+ interface DomainEventBodyOneOf {
3303
3431
  createdEvent?: EntityCreatedEvent;
3304
3432
  updatedEvent?: EntityUpdatedEvent;
3305
3433
  deletedEvent?: EntityDeletedEvent;
3306
3434
  actionEvent?: ActionEvent;
3307
3435
  }
3308
- export interface EntityCreatedEvent {
3309
- entityAsJson?: string;
3310
- /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
3311
- restoreInfo?: RestoreInfo;
3436
+ interface EntityCreatedEvent {
3437
+ entity?: string;
3312
3438
  }
3313
- export interface RestoreInfo {
3439
+ interface RestoreInfo {
3314
3440
  deletedDate?: Date | null;
3315
3441
  }
3316
- export interface EntityUpdatedEvent {
3442
+ interface EntityUpdatedEvent {
3317
3443
  /**
3318
3444
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
3319
3445
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
3320
3446
  * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
3321
3447
  */
3322
- currentEntityAsJson?: string;
3448
+ currentEntity?: string;
3323
3449
  }
3324
- export interface EntityDeletedEvent {
3450
+ interface EntityDeletedEvent {
3325
3451
  /** Entity that was deleted */
3326
- deletedEntityAsJson?: string | null;
3452
+ deletedEntity?: string | null;
3327
3453
  }
3328
- export interface ActionEvent {
3329
- bodyAsJson?: string;
3454
+ interface ActionEvent {
3455
+ body?: string;
3330
3456
  }
3331
- export interface MessageEnvelope {
3457
+ interface MessageEnvelope {
3332
3458
  /**
3333
3459
  * App instance ID.
3334
3460
  * @format GUID
@@ -3344,7 +3470,7 @@ export interface MessageEnvelope {
3344
3470
  /** Stringify payload. */
3345
3471
  data?: string;
3346
3472
  }
3347
- export interface IdentificationData extends IdentificationDataIdOneOf {
3473
+ interface IdentificationData extends IdentificationDataIdOneOf {
3348
3474
  /**
3349
3475
  * ID of a site visitor that has not logged in to the site.
3350
3476
  * @format GUID
@@ -3369,7 +3495,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
3369
3495
  identityType?: WebhookIdentityType;
3370
3496
  }
3371
3497
  /** @oneof */
3372
- export interface IdentificationDataIdOneOf {
3498
+ interface IdentificationDataIdOneOf {
3373
3499
  /**
3374
3500
  * ID of a site visitor that has not logged in to the site.
3375
3501
  * @format GUID
@@ -3391,10 +3517,375 @@ export interface IdentificationDataIdOneOf {
3391
3517
  */
3392
3518
  appId?: string;
3393
3519
  }
3394
- export declare enum WebhookIdentityType {
3520
+ declare enum WebhookIdentityType {
3395
3521
  UNKNOWN = "UNKNOWN",
3396
3522
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3397
3523
  MEMBER = "MEMBER",
3398
3524
  WIX_USER = "WIX_USER",
3399
3525
  APP = "APP"
3400
3526
  }
3527
+ interface BaseEventMetadata {
3528
+ /**
3529
+ * App instance ID.
3530
+ * @format GUID
3531
+ */
3532
+ instanceId?: string | null;
3533
+ /**
3534
+ * Event type.
3535
+ * @maxLength 150
3536
+ */
3537
+ eventType?: string;
3538
+ /** The identification type and identity data. */
3539
+ identity?: IdentificationData;
3540
+ }
3541
+ interface EventMetadata extends BaseEventMetadata {
3542
+ /**
3543
+ * Unique event ID.
3544
+ * Allows clients to ignore duplicate webhooks.
3545
+ */
3546
+ _id?: string;
3547
+ /**
3548
+ * Assumes actions are also always typed to an entity_type
3549
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
3550
+ */
3551
+ entityFqdn?: string;
3552
+ /**
3553
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
3554
+ * This is although the created/updated/deleted notion is duplication of the oneof types
3555
+ * Example: created/updated/deleted/started/completed/email_opened
3556
+ */
3557
+ slug?: string;
3558
+ /** ID of the entity associated with the event. */
3559
+ entityId?: string;
3560
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
3561
+ eventTime?: Date | null;
3562
+ /**
3563
+ * Whether the event was triggered as a result of a privacy regulation application
3564
+ * (for example, GDPR).
3565
+ */
3566
+ triggeredByAnonymizeRequest?: boolean | null;
3567
+ /** If present, indicates the action that triggered the event. */
3568
+ originatedFrom?: string | null;
3569
+ /**
3570
+ * A sequence number defining the order of updates to the underlying entity.
3571
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
3572
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
3573
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
3574
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
3575
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
3576
+ */
3577
+ entityEventSequence?: string | null;
3578
+ }
3579
+ interface CheckoutCompletedEnvelope {
3580
+ data: CheckoutMarkedAsCompleted;
3581
+ metadata: EventMetadata;
3582
+ }
3583
+ interface CheckoutCreatedEnvelope {
3584
+ entity: Checkout;
3585
+ metadata: EventMetadata;
3586
+ }
3587
+ interface CheckoutUpdatedEnvelope {
3588
+ entity: Checkout;
3589
+ metadata: EventMetadata;
3590
+ }
3591
+ interface CreateCheckoutOptions {
3592
+ /** Checkout information. */
3593
+ checkoutInfo?: Checkout;
3594
+ /** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
3595
+ couponCode?: string | null;
3596
+ /**
3597
+ * Catalog line items to add to the checkout.
3598
+ * @maxSize 300
3599
+ */
3600
+ lineItems?: LineItem[];
3601
+ /**
3602
+ * Custom line items to add to the checkout. Custom line items don't trigger the Catalog service plugin.
3603
+ *
3604
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
3605
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
3606
+ * @maxSize 300
3607
+ */
3608
+ customLineItems?: CustomLineItem[];
3609
+ /** Sales channel that submitted the order. */
3610
+ channelType: ChannelType;
3611
+ /**
3612
+ * Gift card code.
3613
+ *
3614
+ * The checkout can only hold 1 `giftCardCode` at a time. If an additional `giftCardCode` is added, it will override the existing `giftCardCode`.
3615
+ *
3616
+ * >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/setting-up-wix-gift-cards-9451439).
3617
+ */
3618
+ giftCardCode?: string | null;
3619
+ /**
3620
+ * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
3621
+ *
3622
+ * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
3623
+ * @maxLength 1000
3624
+ */
3625
+ overrideCheckoutUrl?: string | null;
3626
+ }
3627
+ interface UpdateCheckout {
3628
+ /**
3629
+ * Checkout ID.
3630
+ * @format GUID
3631
+ * @readonly
3632
+ */
3633
+ _id?: string | null;
3634
+ /**
3635
+ * Line items.
3636
+ *
3637
+ * Max: 300 items
3638
+ * @minSize 1
3639
+ * @maxSize 300
3640
+ * @readonly
3641
+ */
3642
+ lineItems?: LineItem[];
3643
+ /** Billing information. */
3644
+ billingInfo?: AddressWithContact;
3645
+ /** Shipping information. */
3646
+ shippingInfo?: ShippingInfo;
3647
+ /**
3648
+ * [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
3649
+ * @maxLength 1000
3650
+ */
3651
+ buyerNote?: string | null;
3652
+ /** Buyer information. */
3653
+ buyerInfo?: BuyerInfo;
3654
+ /**
3655
+ * All converted prices are displayed in this currency in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
3656
+ * @readonly
3657
+ * @format CURRENCY
3658
+ */
3659
+ conversionCurrency?: string;
3660
+ /**
3661
+ * Calculated price summary for the checkout.
3662
+ * @readonly
3663
+ */
3664
+ priceSummary?: PriceSummary;
3665
+ /**
3666
+ * Errors when calculating totals.
3667
+ * @readonly
3668
+ */
3669
+ calculationErrors?: CalculationErrors;
3670
+ /**
3671
+ * Applied gift card details.
3672
+ *
3673
+ * >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/setting-up-wix-gift-cards-9451439).
3674
+ * @readonly
3675
+ */
3676
+ giftCard?: GiftCard;
3677
+ /**
3678
+ * Applied discounts.
3679
+ * @readonly
3680
+ */
3681
+ appliedDiscounts?: AppliedDiscount[];
3682
+ /** Custom fields. */
3683
+ customFields?: CustomField[];
3684
+ /**
3685
+ * Weight measurement unit. Defaults to a site's weight unit.
3686
+ * @readonly
3687
+ */
3688
+ weightUnit?: WeightUnit;
3689
+ /**
3690
+ * Tax summary.
3691
+ * @readonly
3692
+ */
3693
+ taxSummary?: TaxSummary;
3694
+ /**
3695
+ * The currency used when submitting the order.
3696
+ * @format CURRENCY
3697
+ * @readonly
3698
+ */
3699
+ currency?: string;
3700
+ /**
3701
+ * Sales channel that submitted the order.
3702
+ * @readonly
3703
+ */
3704
+ channelType?: ChannelType;
3705
+ /**
3706
+ * Site language in which original values are shown.
3707
+ * @readonly
3708
+ */
3709
+ siteLanguage?: string;
3710
+ /**
3711
+ * Language for communication with the buyer. Defaults to the site language.
3712
+ * For a site that supports multiple languages, this is the language the buyer selected.
3713
+ * @readonly
3714
+ */
3715
+ buyerLanguage?: string;
3716
+ /**
3717
+ * Whether an order was successfully created from this checkout.
3718
+ * For an order to be successful, it must be successfully paid for (unless the total is 0).
3719
+ * @readonly
3720
+ */
3721
+ completed?: boolean;
3722
+ /**
3723
+ * Whether tax is included in line item prices.
3724
+ * @readonly
3725
+ */
3726
+ taxIncludedInPrice?: boolean;
3727
+ /**
3728
+ * ID of the checkout's initiator.
3729
+ * @readonly
3730
+ */
3731
+ createdBy?: CreatedBy;
3732
+ /**
3733
+ * Date and time the checkout was created.
3734
+ * @readonly
3735
+ */
3736
+ _createdDate?: Date | null;
3737
+ /**
3738
+ * Date and time the checkout was updated.
3739
+ * @readonly
3740
+ */
3741
+ _updatedDate?: Date | null;
3742
+ /**
3743
+ * Minimal amount to pay in order to place the order.
3744
+ * @readonly
3745
+ */
3746
+ payNow?: PriceSummary;
3747
+ /**
3748
+ * Remaining amount for the order to be fully paid.
3749
+ * @readonly
3750
+ */
3751
+ payLater?: PriceSummary;
3752
+ /** Memberships to apply when creating the order. */
3753
+ membershipOptions?: MembershipOptions;
3754
+ /**
3755
+ * Additional Fees.
3756
+ * @maxSize 100
3757
+ */
3758
+ additionalFees?: AdditionalFee[];
3759
+ /**
3760
+ * Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart.
3761
+ * @format GUID
3762
+ */
3763
+ cartId?: string | null;
3764
+ /**
3765
+ * List of validation violations raised by the [Validations Custom Extension SPI](https://www.wix.com/velo/reference/spis/wix-ecom/ecom-validations/introduction).
3766
+ * @readonly
3767
+ */
3768
+ violations?: Violation[];
3769
+ /**
3770
+ * Custom field data for the checkout object.
3771
+ *
3772
+ * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
3773
+ */
3774
+ extendedFields?: ExtendedFields;
3775
+ /**
3776
+ * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
3777
+ * @format GUID
3778
+ * @readonly
3779
+ */
3780
+ purchaseFlowId?: string | null;
3781
+ /**
3782
+ * Additional settings for customization of the checkout process.
3783
+ *
3784
+ * Custom settings can only be defined when [creating a checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/createcheckout).
3785
+ * @immutable
3786
+ */
3787
+ customSettings?: CustomSettings;
3788
+ /**
3789
+ * Reference IDs for the app and component providing custom checkout page content.
3790
+ *
3791
+ * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
3792
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
3793
+ */
3794
+ customContentReference?: CustomContentReference;
3795
+ /**
3796
+ * Order ID.
3797
+ *
3798
+ * This field is empty until the checkout completes and becomes an order.
3799
+ * @internal
3800
+ * @format GUID
3801
+ * @readonly
3802
+ */
3803
+ orderId?: string | null;
3804
+ /**
3805
+ * Payment for subscriptions after free trial period.
3806
+ * @internal
3807
+ * @readonly
3808
+ */
3809
+ payAfterFreeTrial?: PriceSummary;
3810
+ /**
3811
+ * The business location ID associated with the checkout.
3812
+ *
3813
+ * To learn more, see the Locations API.
3814
+ * @format GUID
3815
+ */
3816
+ businessLocationId?: string | null;
3817
+ /**
3818
+ * Whether payment is required to create an order.
3819
+ *
3820
+ * Payment is required if any of the following conditions are met:
3821
+ * 1. At least one item requires a payment method. This can be because the item has the `savePaymentMethod` field set to `true`, or the item is a subscription with a price greater than zero.
3822
+ * 2. The calculated total amount due for immediate payment is greater than zero - `checkout.payNow > 0`.
3823
+ * @internal
3824
+ * @readonly
3825
+ */
3826
+ paymentRequired?: boolean;
3827
+ /**
3828
+ * Charges information for each subscription in the checkout.
3829
+ * @internal
3830
+ * @readonly
3831
+ * @maxSize 100
3832
+ */
3833
+ subscriptionCharges?: SubscriptionCharges[];
3834
+ }
3835
+ interface UpdateCheckoutOptions {
3836
+ /** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
3837
+ couponCode?: string | null;
3838
+ /** Gift card code. */
3839
+ giftCardCode?: string | null;
3840
+ /**
3841
+ * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
3842
+ *
3843
+ * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
3844
+ * @maxLength 1000
3845
+ */
3846
+ overrideCheckoutUrl?: string | null;
3847
+ /**
3848
+ * Catalog line items.
3849
+ * @maxSize 300
3850
+ */
3851
+ lineItems?: LineItem[];
3852
+ /**
3853
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
3854
+ *
3855
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
3856
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
3857
+ * @maxSize 300
3858
+ */
3859
+ customLineItems?: CustomLineItem[];
3860
+ }
3861
+ interface AddToCheckoutOptions {
3862
+ /**
3863
+ * Catalog line items.
3864
+ * @maxSize 100
3865
+ */
3866
+ lineItems?: LineItem[];
3867
+ /**
3868
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
3869
+ *
3870
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
3871
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
3872
+ * @maxSize 100
3873
+ */
3874
+ customLineItems?: CustomLineItem[];
3875
+ }
3876
+ interface CreateOrderOptions {
3877
+ /** Whether the payment method should be saved on the order. */
3878
+ savePaymentMethod?: boolean;
3879
+ /** Whether to authorize the payment and delay the capture. */
3880
+ delayCapture?: boolean;
3881
+ }
3882
+ interface CreateOrderAndChargeOptions {
3883
+ /** Payment token. */
3884
+ paymentToken?: string | null;
3885
+ /** Whether the payment method should be saved on the order. */
3886
+ savePaymentMethod?: boolean;
3887
+ /** Whether to authorize the payment and delay the capture. */
3888
+ delayCapture?: boolean;
3889
+ }
3890
+
3891
+ export { type CatalogReference as $, type AddToCheckoutOptions as A, NameInLineItem as B, type CreateCheckoutOptions as C, DescriptionLineType as D, SuggestedFix as E, FileType as F, type GetCheckoutByCartIdResponse as G, GetCheckoutPaymentSettingsResponsePaymentOption as H, ItemAvailabilityStatus as I, JurisdictionType as J, IdentityType as K, type LineItemQuantityUpdate as L, ManualCalculationReason as M, NameInOther as N, LineItemType as O, PaymentOptionType as P, MediaItemType as Q, type RemoveCouponResponse as R, SubscriptionFrequency as S, TaxableAddressType as T, type UpdateCheckout as U, VatType as V, WeightUnit as W, DiscountDiscountType as X, ChannelInfoChannelType as Y, WebhookIdentityType as Z, type LineItem as _, type Checkout as a, type DetailsKindOneOf as a$, type ProductName as a0, type MultiCurrencyPrice as a1, type ItemTaxFullDetails as a2, type TaxRateBreakdown as a3, type TaxBreakdown as a4, type DescriptionLine as a5, type DescriptionLineValueOneOf as a6, type DescriptionLineDescriptionLineValueOneOf as a7, type DescriptionLineName as a8, type PlainTextValue as a9, type ApiAddress as aA, type StreetAddress as aB, type AddressLocation as aC, type FullAddressContactDetails as aD, type CommonVatId as aE, type ShippingInfo as aF, type SelectedCarrierServiceOption as aG, type DeliveryLogistics as aH, type PickupDetails as aI, type DeliveryTimeSlot as aJ, type SelectedCarrierServiceOptionPrices as aK, type SelectedCarrierServiceOptionOtherCharge as aL, type DeliveryAllocation as aM, type Carrier as aN, type Region as aO, type ApplicableLineItems as aP, type ShippingRegion as aQ, type CarrierServiceOption as aR, type ShippingOption as aS, type ShippingPrice as aT, type OtherCharge as aU, type BuyerInfo as aV, type BuyerInfoIdOneOf as aW, type PriceSummary as aX, type CalculationErrors as aY, type CalculationErrorsShippingCalculationErrorOneOf as aZ, type Details as a_, type Color as aa, type FocalPoint as ab, type ItemAvailabilityInfo as ac, type PhysicalProperties as ad, type Scope as ae, type Group as af, type ItemType as ag, type ItemTypeItemTypeDataOneOf as ah, type SubscriptionOptionInfo as ai, type SubscriptionSettings as aj, type FreeTrialPeriod as ak, type Title as al, type Description as am, type SecuredMedia as an, type ServiceProperties as ao, type PriceDescription as ap, type CatalogOverrideFields as aq, type PaymentOption as ar, type TaxableAddress as as, type TaxableAddressTaxableAddressDataOneOf as at, type ExtendedFields as au, type Policy as av, type ModifierGroup as aw, type TranslatableString as ax, type ItemModifier as ay, type AddressWithContact as az, type GetWixCheckoutURLResponse as b, type CreateOrderResponseIdOneOf as b$, type ApplicationError as b0, type ValidationError as b1, type FieldViolation as b2, type SystemError as b3, type CarrierErrors as b4, type CarrierError as b5, type GiftCard as b6, type AppliedDiscount as b7, type AppliedDiscountDiscountSourceOneOf as b8, type Coupon as b9, type CustomSettings as bA, type CustomContentReference as bB, type ExternalReference as bC, type SubscriptionCharges as bD, type Charge as bE, type UpdatedCheckoutMessage as bF, type CreateCheckoutRequest as bG, type CustomLineItem as bH, type MerchantDiscountInput as bI, type CreateCheckoutResponse as bJ, type ShippingCalculationErrorData as bK, type ShippingCalculationErrorDataShippingCalculationErrorOneOf as bL, type GetCheckoutRequest as bM, type GetCheckoutResponse as bN, type GetCheckoutWithAllExtendedFieldsRequest as bO, type GetCheckoutWithAllExtendedFieldsResponse as bP, type GetCheckoutByCartIdRequest as bQ, type GetWixCheckoutURLRequest as bR, type GetCheckoutURLRequest as bS, type UpdateCheckoutRequest as bT, type UpdateCheckoutResponse as bU, type RemoveCouponRequest as bV, type RemoveGiftCardRequest as bW, type RemoveOverrideCheckoutUrlRequest as bX, type AddToCheckoutRequest as bY, type RemoveLineItemsRequest as bZ, type CreateOrderRequest as b_, type MerchantDiscount as ba, type DiscountRule as bb, type DiscountRuleName as bc, type LineItemDiscount as bd, type CustomField as be, type TaxSummary as bf, type TaxCalculationDetails as bg, type TaxCalculationDetailsCalculationDetailsOneOf as bh, type AutoTaxFallbackCalculationDetails as bi, type AggregatedTaxBreakdown as bj, type CreatedBy as bk, type CreatedByIdOneOf as bl, type MembershipOptions as bm, type Membership as bn, type MembershipName as bo, type MembershipPaymentCredits as bp, type InvalidMembership as bq, type SelectedMemberships as br, type SelectedMembership as bs, type AdditionalFee as bt, type ConversionInfo as bu, type Violation as bv, type Target as bw, type TargetTargetTypeOneOf as bx, type Other as by, type TargetLineItem as bz, type GetCheckoutURLResponse as c, type PaymentErrorResponseData as c0, type DoublePaymentErrorData as c1, type DoublePaymentErrorDataIdOneOf as c2, type RedeemErrorData as c3, type ViolationsList as c4, type CreateOrderAndChargeRequest as c5, type CreateOrderAndChargeResponseIdOneOf as c6, type MarkCheckoutAsCompletedAndRedirectToUrlRequest as c7, type HeadersEntry as c8, type MarkCheckoutAsCompletedRequest as c9, type PickupAddress as cA, type AppliedCoupon as cB, type V1CustomField as cC, type V1SubscriptionOptionInfo as cD, type Discount as cE, type ChannelInfo as cF, type V1SubscriptionSettings as cG, type BillingInfo as cH, type Empty as cI, type DomainEvent as cJ, type DomainEventBodyOneOf as cK, type EntityCreatedEvent as cL, type RestoreInfo as cM, type EntityUpdatedEvent as cN, type EntityDeletedEvent as cO, type ActionEvent as cP, type MessageEnvelope as cQ, type IdentificationData as cR, type IdentificationDataIdOneOf as cS, type BaseEventMetadata as cT, type EventMetadata as cU, type CheckoutCompletedEnvelope as cV, type CheckoutCreatedEnvelope as cW, type CheckoutUpdatedEnvelope as cX, type MarkCheckoutAsCompletedResponse as ca, type CheckoutMarkedAsCompleted as cb, type UpdateLineItemsQuantityRequest as cc, type GetCheckoutPaymentSettingsRequest as cd, type DeleteCheckoutRequest as ce, type DeleteCheckoutResponse as cf, type SubscriptionCreated as cg, type Subscription as ch, type V1BuyerInfo as ci, type V1LineItem as cj, type OptionSelection as ck, type CustomTextFieldSelection as cl, type ChargeDetails as cm, type ProductDetails as cn, type MediaItem as co, type Totals as cp, type StoreSettings as cq, type Address as cr, type AddressAddressLine1OptionsOneOf as cs, type FullName as ct, type Street as cu, type VatId as cv, type V1ShippingInfo as cw, type V1ShippingInfoDetailsOneOf as cx, type ShipmentDetails as cy, type V1PickupDetails as cz, type UpdateCheckoutOptions as d, type RemoveGiftCardResponse as e, type RemoveOverrideCheckoutUrlResponse as f, type AddToCheckoutResponse as g, type RemoveLineItemsResponse as h, type CreateOrderOptions as i, type CreateOrderResponse as j, type CreateOrderAndChargeOptions as k, type CreateOrderAndChargeResponse as l, type RawHttpResponse as m, type UpdateLineItemsQuantityResponse as n, type GetCheckoutPaymentSettingsResponse as o, ItemTypeItemType as p, CommonVatType as q, PickupMethod as r, ChargeType as s, RuleType as t, DiscountType as u, RateType as v, FallbackReason as w, ChannelType as x, AdditionalFeeSource as y, Severity as z };