@wix/auto_sdk_ecom_checkout 1.0.35 → 1.0.37

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (134) hide show
  1. package/build/{es/src/ecom-v1-checkout-checkout.types.d.ts → ecom-v1-checkout-checkout.universal-DEDRvPML.d.mts} +674 -365
  2. package/build/{cjs/src/ecom-v1-checkout-checkout.types.d.ts → ecom-v1-checkout-checkout.universal-DEDRvPML.d.ts} +674 -365
  3. package/build/index.d.mts +210 -0
  4. package/build/index.d.ts +210 -0
  5. package/build/index.js +2782 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +2708 -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-CirtPjnM.d.mts} +803 -364
  10. package/build/internal/{es/src/ecom-v1-checkout-checkout.types.d.ts → ecom-v1-checkout-checkout.universal-CirtPjnM.d.ts} +803 -364
  11. package/build/internal/index.d.mts +240 -0
  12. package/build/internal/index.d.ts +240 -0
  13. package/build/internal/index.js +2782 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +2708 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +2606 -0
  18. package/build/internal/meta.d.ts +2606 -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 +2606 -0
  24. package/build/meta.d.ts +2606 -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 +12 -11
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/ecom-v1-checkout-checkout.context.d.ts +0 -35
  40. package/build/cjs/src/ecom-v1-checkout-checkout.context.js +0 -76
  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 -194
  49. package/build/cjs/src/ecom-v1-checkout-checkout.public.js +0 -357
  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 -303
  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 -4429
  54. package/build/cjs/src/ecom-v1-checkout-checkout.universal.js +0 -1599
  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 -35
  67. package/build/es/src/ecom-v1-checkout-checkout.context.js +0 -41
  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 -194
  76. package/build/es/src/ecom-v1-checkout-checkout.public.js +0 -305
  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 -300
  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 -4429
  81. package/build/es/src/ecom-v1-checkout-checkout.universal.js +0 -1556
  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 -41
  93. package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.js +0 -76
  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 -218
  102. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js +0 -357
  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 -303
  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 -4615
  107. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js +0 -1599
  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 -41
  119. package/build/internal/es/src/ecom-v1-checkout-checkout.context.js +0 -41
  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 -218
  128. package/build/internal/es/src/ecom-v1-checkout-checkout.public.js +0 -305
  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 -300
  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 -4615
  133. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js +0 -1556
  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
  *
@@ -109,12 +109,12 @@ export interface Checkout {
109
109
  * Date and time the checkout was created.
110
110
  * @readonly
111
111
  */
112
- createdDate?: Date | null;
112
+ _createdDate?: Date | null;
113
113
  /**
114
114
  * Date and time the checkout was updated.
115
115
  * @readonly
116
116
  */
117
- updatedDate?: Date | null;
117
+ _updatedDate?: Date | null;
118
118
  /**
119
119
  * Minimal amount to pay in order to place the order.
120
120
  * @readonly
@@ -176,6 +176,15 @@ export interface Checkout {
176
176
  * @immutable
177
177
  */
178
178
  externalReference?: ExternalReference;
179
+ /**
180
+ * Order ID.
181
+ *
182
+ * This field is empty until the checkout completes and becomes an order.
183
+ * @internal
184
+ * @format GUID
185
+ * @readonly
186
+ */
187
+ orderId?: string | null;
179
188
  /**
180
189
  * Payment for subscriptions after free trial period.
181
190
  * @readonly
@@ -188,6 +197,23 @@ export interface Checkout {
188
197
  * @format GUID
189
198
  */
190
199
  businessLocationId?: string | null;
200
+ /**
201
+ * Whether payment is required to create an order.
202
+ *
203
+ * Payment is required if any of the following conditions are met:
204
+ * 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.
205
+ * 2. The calculated total amount due for immediate payment is greater than zero - `checkout.payNow > 0`.
206
+ * @internal
207
+ * @readonly
208
+ */
209
+ paymentRequired?: boolean;
210
+ /**
211
+ * Charges information for each subscription in the checkout.
212
+ * @internal
213
+ * @readonly
214
+ * @maxSize 100
215
+ */
216
+ subscriptionCharges?: SubscriptionCharges[];
191
217
  /**
192
218
  * Currency used for payment, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
193
219
  * @readonly
@@ -195,13 +221,13 @@ export interface Checkout {
195
221
  */
196
222
  paymentCurrency?: string;
197
223
  }
198
- export interface LineItem {
224
+ interface LineItem {
199
225
  /**
200
226
  * Line item ID.
201
227
  * @format GUID
202
228
  * @readonly
203
229
  */
204
- id?: string | null;
230
+ _id?: string | null;
205
231
  /**
206
232
  * Item quantity.
207
233
  *
@@ -225,7 +251,7 @@ export interface LineItem {
225
251
  * URL to the item's page on the site.
226
252
  * @readonly
227
253
  */
228
- url?: PageUrlV2;
254
+ url?: string;
229
255
  /**
230
256
  * Item price **after** catalog-defined discount and line item discounts.
231
257
  * @readonly
@@ -275,7 +301,7 @@ export interface LineItem {
275
301
  * Line item image details.
276
302
  * @readonly
277
303
  */
278
- media?: CommonImage;
304
+ media?: string;
279
305
  /**
280
306
  * Item availability details.
281
307
  * @readonly
@@ -372,12 +398,25 @@ export interface LineItem {
372
398
  savePaymentMethod?: boolean;
373
399
  /** Address to use for tax calculation purposes. */
374
400
  taxableAddress?: TaxableAddress;
401
+ /**
402
+ * Custom extended fields for the line item object.
403
+ *
404
+ * [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.
405
+ * @internal
406
+ */
407
+ extendedFields?: ExtendedFields;
375
408
  /**
376
409
  * Policies to be displayed to the customer on the checkout page.
377
410
  * @readonly
378
411
  * @maxSize 5
379
412
  */
380
413
  policies?: Policy[];
414
+ /**
415
+ * ID of the app managing the inventory.
416
+ * @internal
417
+ * @format GUID
418
+ */
419
+ inventoryAppId?: string | null;
381
420
  /**
382
421
  * Whether the item can only be purchased by site members.
383
422
  *
@@ -398,7 +437,7 @@ export interface LineItem {
398
437
  modifiersTotalPrice?: MultiCurrencyPrice;
399
438
  }
400
439
  /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
401
- export interface CatalogReference {
440
+ interface CatalogReference {
402
441
  /**
403
442
  * ID of the item within the catalog it belongs to.
404
443
  * @minLength 1
@@ -424,7 +463,7 @@ export interface CatalogReference {
424
463
  */
425
464
  options?: Record<string, any> | null;
426
465
  }
427
- export interface ProductName {
466
+ interface ProductName {
428
467
  /**
429
468
  * __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).
430
469
  *
@@ -445,13 +484,7 @@ export interface ProductName {
445
484
  */
446
485
  translated?: string | null;
447
486
  }
448
- export interface PageUrlV2 {
449
- /** The relative path for the page within the site. For example, `/product-page/a-product`. */
450
- relativePath?: string;
451
- /** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
452
- url?: string | null;
453
- }
454
- export interface MultiCurrencyPrice {
487
+ interface MultiCurrencyPrice {
455
488
  /**
456
489
  * Amount.
457
490
  * @decimalValue options { gte:0, lte:1000000000000000 }
@@ -474,7 +507,7 @@ export interface MultiCurrencyPrice {
474
507
  */
475
508
  formattedConvertedAmount?: string;
476
509
  }
477
- export interface ItemTaxFullDetails {
510
+ interface ItemTaxFullDetails {
478
511
  /** Amount for which tax is calculated. */
479
512
  taxableAmount?: MultiCurrencyPrice;
480
513
  /**
@@ -491,7 +524,7 @@ export interface ItemTaxFullDetails {
491
524
  */
492
525
  rateBreakdown?: TaxRateBreakdown[];
493
526
  }
494
- export interface TaxRateBreakdown {
527
+ interface TaxRateBreakdown {
495
528
  /**
496
529
  * Name of tax against which the calculation was performed.
497
530
  * @maxLength 100
@@ -509,7 +542,7 @@ export interface TaxRateBreakdown {
509
542
  * TaxBreakdown represents tax information for a line item.
510
543
  * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
511
544
  */
512
- export interface TaxBreakdown {
545
+ interface TaxBreakdown {
513
546
  /**
514
547
  * The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
515
548
  * @maxLength 200
@@ -541,7 +574,7 @@ export interface TaxBreakdown {
541
574
  jurisdictionType?: JurisdictionTypeWithLiterals;
542
575
  }
543
576
  /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
544
- export declare enum JurisdictionType {
577
+ declare enum JurisdictionType {
545
578
  UNDEFINED = "UNDEFINED",
546
579
  COUNTRY = "COUNTRY",
547
580
  STATE = "STATE",
@@ -550,26 +583,31 @@ export declare enum JurisdictionType {
550
583
  SPECIAL = "SPECIAL"
551
584
  }
552
585
  /** @enumType */
553
- export type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
554
- export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
586
+ type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
587
+ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
555
588
  /** Description line plain text value. */
556
589
  plainText?: PlainTextValue;
557
590
  /** Description line color value. */
558
591
  colorInfo?: Color;
559
592
  /** Description line name. */
560
593
  name?: DescriptionLineName;
594
+ /**
595
+ * Whether the description line originates from a modifier.
596
+ * @internal
597
+ */
598
+ modifierDescriptionLine?: boolean;
561
599
  }
562
600
  /** @oneof */
563
- export interface DescriptionLineValueOneOf {
601
+ interface DescriptionLineValueOneOf {
564
602
  /** Description line plain text value. */
565
603
  plainText?: PlainTextValue;
566
604
  /** Description line color value. */
567
605
  colorInfo?: Color;
568
606
  }
569
607
  /** @oneof */
570
- export interface DescriptionLineDescriptionLineValueOneOf {
608
+ interface DescriptionLineDescriptionLineValueOneOf {
571
609
  }
572
- export interface DescriptionLineName {
610
+ interface DescriptionLineName {
573
611
  /**
574
612
  * 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).
575
613
  * @maxLength 100
@@ -583,7 +621,7 @@ export interface DescriptionLineName {
583
621
  */
584
622
  translated?: string | null;
585
623
  }
586
- export interface PlainTextValue {
624
+ interface PlainTextValue {
587
625
  /**
588
626
  * 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).
589
627
  * @maxLength 600
@@ -597,7 +635,7 @@ export interface PlainTextValue {
597
635
  */
598
636
  translated?: string | null;
599
637
  }
600
- export interface Color {
638
+ interface Color {
601
639
  /**
602
640
  * 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).
603
641
  * @maxLength 500
@@ -613,7 +651,7 @@ export interface Color {
613
651
  /** HEX or RGB color code for display. */
614
652
  code?: string | null;
615
653
  }
616
- export declare enum DescriptionLineType {
654
+ declare enum DescriptionLineType {
617
655
  /** Unrecognized type. */
618
656
  UNRECOGNISED = "UNRECOGNISED",
619
657
  /** Plain text type. */
@@ -621,32 +659,7 @@ export declare enum DescriptionLineType {
621
659
  /** Color type. */
622
660
  COLOR = "COLOR"
623
661
  }
624
- /** @enumType */
625
- export type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
626
- export interface CommonImage {
627
- /** WixMedia image ID. */
628
- id?: string;
629
- /** Image URL. */
630
- url?: string;
631
- /**
632
- * Original image height.
633
- * @readonly
634
- */
635
- height?: number;
636
- /**
637
- * Original image width.
638
- * @readonly
639
- */
640
- width?: number;
641
- /** Image alt text. */
642
- altText?: string | null;
643
- /**
644
- * Image filename.
645
- * @readonly
646
- */
647
- filename?: string | null;
648
- }
649
- export interface FocalPoint {
662
+ interface FocalPoint {
650
663
  /** X-coordinate of the focal point. */
651
664
  x?: number;
652
665
  /** Y-coordinate of the focal point. */
@@ -656,13 +669,13 @@ export interface FocalPoint {
656
669
  /** crop by width */
657
670
  width?: number | null;
658
671
  }
659
- export interface ItemAvailabilityInfo {
672
+ interface ItemAvailabilityInfo {
660
673
  /** Item availability status. */
661
674
  status?: ItemAvailabilityStatusWithLiterals;
662
675
  /** Quantity available. */
663
676
  quantityAvailable?: number | null;
664
677
  }
665
- export declare enum ItemAvailabilityStatus {
678
+ declare enum ItemAvailabilityStatus {
666
679
  AVAILABLE = "AVAILABLE",
667
680
  /** Item does not exist. */
668
681
  NOT_FOUND = "NOT_FOUND",
@@ -672,8 +685,8 @@ export declare enum ItemAvailabilityStatus {
672
685
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
673
686
  }
674
687
  /** @enumType */
675
- export type ItemAvailabilityStatusWithLiterals = ItemAvailabilityStatus | 'AVAILABLE' | 'NOT_FOUND' | 'NOT_AVAILABLE' | 'PARTIALLY_AVAILABLE';
676
- export interface PhysicalProperties {
688
+ type ItemAvailabilityStatusWithLiterals = ItemAvailabilityStatus | 'AVAILABLE' | 'NOT_FOUND' | 'NOT_AVAILABLE' | 'PARTIALLY_AVAILABLE';
689
+ interface PhysicalProperties {
677
690
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
678
691
  weight?: number | null;
679
692
  /**
@@ -684,32 +697,32 @@ export interface PhysicalProperties {
684
697
  /** Whether this line item is shippable. */
685
698
  shippable?: boolean;
686
699
  }
687
- export interface Scope {
700
+ interface Scope {
688
701
  /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
689
702
  namespace?: string;
690
703
  /** Coupon scope's applied group (e.g., event or ticket in Wix Events) */
691
704
  group?: Group;
692
705
  }
693
- export interface Group {
706
+ interface Group {
694
707
  /** 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). */
695
708
  name?: string;
696
709
  /** Item ID (when the coupon scope is limited to just one item). */
697
710
  entityId?: string | null;
698
711
  }
699
- export interface ItemType extends ItemTypeItemTypeDataOneOf {
712
+ interface ItemType extends ItemTypeItemTypeDataOneOf {
700
713
  /** Preset item type. */
701
714
  preset?: ItemTypeItemTypeWithLiterals;
702
715
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
703
716
  custom?: string;
704
717
  }
705
718
  /** @oneof */
706
- export interface ItemTypeItemTypeDataOneOf {
719
+ interface ItemTypeItemTypeDataOneOf {
707
720
  /** Preset item type. */
708
721
  preset?: ItemTypeItemTypeWithLiterals;
709
722
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
710
723
  custom?: string;
711
724
  }
712
- export declare enum ItemTypeItemType {
725
+ declare enum ItemTypeItemType {
713
726
  UNRECOGNISED = "UNRECOGNISED",
714
727
  PHYSICAL = "PHYSICAL",
715
728
  DIGITAL = "DIGITAL",
@@ -717,8 +730,8 @@ export declare enum ItemTypeItemType {
717
730
  SERVICE = "SERVICE"
718
731
  }
719
732
  /** @enumType */
720
- export type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
721
- export interface SubscriptionOptionInfo {
733
+ type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
734
+ interface SubscriptionOptionInfo {
722
735
  /** Subscription option settings. */
723
736
  subscriptionSettings?: SubscriptionSettings;
724
737
  /** Subscription option title. */
@@ -726,7 +739,7 @@ export interface SubscriptionOptionInfo {
726
739
  /** Subscription option description. */
727
740
  description?: Description;
728
741
  }
729
- export interface SubscriptionSettings {
742
+ interface SubscriptionSettings {
730
743
  /** Frequency of recurring payment. */
731
744
  frequency?: SubscriptionFrequencyWithLiterals;
732
745
  /**
@@ -752,9 +765,14 @@ export interface SubscriptionSettings {
752
765
  * If None => no free trial
753
766
  */
754
767
  freeTrialPeriod?: FreeTrialPeriod;
768
+ /**
769
+ * The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
770
+ * @internal
771
+ */
772
+ startDate?: Date | null;
755
773
  }
756
774
  /** Frequency unit of recurring payment */
757
- export declare enum SubscriptionFrequency {
775
+ declare enum SubscriptionFrequency {
758
776
  UNDEFINED = "UNDEFINED",
759
777
  DAY = "DAY",
760
778
  WEEK = "WEEK",
@@ -762,8 +780,8 @@ export declare enum SubscriptionFrequency {
762
780
  YEAR = "YEAR"
763
781
  }
764
782
  /** @enumType */
765
- export type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
766
- export interface FreeTrialPeriod {
783
+ type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
784
+ interface FreeTrialPeriod {
767
785
  /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
768
786
  frequency?: SubscriptionFrequencyWithLiterals;
769
787
  /**
@@ -773,7 +791,7 @@ export interface FreeTrialPeriod {
773
791
  */
774
792
  interval?: number;
775
793
  }
776
- export interface Title {
794
+ interface Title {
777
795
  /**
778
796
  * 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).
779
797
  * @minLength 1
@@ -789,7 +807,7 @@ export interface Title {
789
807
  */
790
808
  translated?: string | null;
791
809
  }
792
- export interface Description {
810
+ interface Description {
793
811
  /**
794
812
  * Subscription option description.
795
813
  * @maxLength 500
@@ -801,13 +819,13 @@ export interface Description {
801
819
  */
802
820
  translated?: string | null;
803
821
  }
804
- export interface SecuredMedia {
822
+ interface SecuredMedia {
805
823
  /**
806
824
  * Media ID in Wix Media Manager.
807
825
  * @minLength 1
808
826
  * @maxLength 100
809
827
  */
810
- id?: string;
828
+ _id?: string;
811
829
  /**
812
830
  * Original filename.
813
831
  * @minLength 1
@@ -817,7 +835,7 @@ export interface SecuredMedia {
817
835
  /** File type. */
818
836
  fileType?: FileTypeWithLiterals;
819
837
  }
820
- export declare enum FileType {
838
+ declare enum FileType {
821
839
  UNSPECIFIED = "UNSPECIFIED",
822
840
  SECURE_PICTURE = "SECURE_PICTURE",
823
841
  SECURE_VIDEO = "SECURE_VIDEO",
@@ -826,9 +844,9 @@ export declare enum FileType {
826
844
  SECURE_ARCHIVE = "SECURE_ARCHIVE"
827
845
  }
828
846
  /** @enumType */
829
- export type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
847
+ type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
830
848
  /** Type of selected payment option for catalog item */
831
- export declare enum PaymentOptionType {
849
+ declare enum PaymentOptionType {
832
850
  /** The entire payment for this item happens as part of the checkout. */
833
851
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
834
852
  /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
@@ -841,8 +859,8 @@ export declare enum PaymentOptionType {
841
859
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
842
860
  }
843
861
  /** @enumType */
844
- export type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
845
- export interface ServiceProperties {
862
+ type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
863
+ interface ServiceProperties {
846
864
  /**
847
865
  * 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.
848
866
  * For example, the start time of a class.
@@ -855,7 +873,7 @@ export interface ServiceProperties {
855
873
  */
856
874
  numberOfParticipants?: number | null;
857
875
  }
858
- export interface PriceDescription {
876
+ interface PriceDescription {
859
877
  /**
860
878
  * __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).
861
879
  * @minLength 1
@@ -871,7 +889,7 @@ export interface PriceDescription {
871
889
  */
872
890
  translated?: string | null;
873
891
  }
874
- export interface CatalogOverrideFields {
892
+ interface CatalogOverrideFields {
875
893
  /** Item name. */
876
894
  productName?: ProductName;
877
895
  /**
@@ -892,7 +910,7 @@ export interface CatalogOverrideFields {
892
910
  /** Physical properties of the item. */
893
911
  physicalProperties?: PhysicalProperties;
894
912
  /** Item image. */
895
- image?: Image;
913
+ image?: string;
896
914
  /** Payment method selected for the item. */
897
915
  paymentOption?: PaymentOption;
898
916
  /**
@@ -908,19 +926,7 @@ export interface CatalogOverrideFields {
908
926
  */
909
927
  savePaymentMethod?: boolean | null;
910
928
  }
911
- export interface Image {
912
- /** WixMedia image ID. */
913
- id?: string;
914
- /** Original image height. */
915
- height?: number;
916
- /** Original image width. */
917
- width?: number;
918
- /** Image alt text. Optional. */
919
- altText?: string | null;
920
- /** Image filename. Optional. */
921
- filename?: string | null;
922
- }
923
- export interface PaymentOption {
929
+ interface PaymentOption {
924
930
  /**
925
931
  * Type of selected payment option for current item.
926
932
  *
@@ -928,24 +934,24 @@ export interface PaymentOption {
928
934
  */
929
935
  value?: PaymentOptionTypeWithLiterals;
930
936
  }
931
- export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
937
+ interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
932
938
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
933
939
  addressType?: TaxableAddressTypeWithLiterals;
934
940
  }
935
941
  /** @oneof */
936
- export interface TaxableAddressTaxableAddressDataOneOf {
942
+ interface TaxableAddressTaxableAddressDataOneOf {
937
943
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
938
944
  addressType?: TaxableAddressTypeWithLiterals;
939
945
  }
940
- export declare enum TaxableAddressType {
946
+ declare enum TaxableAddressType {
941
947
  UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
942
948
  BUSINESS = "BUSINESS",
943
949
  BILLING = "BILLING",
944
950
  SHIPPING = "SHIPPING"
945
951
  }
946
952
  /** @enumType */
947
- export type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
948
- export interface ExtendedFields {
953
+ type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
954
+ interface ExtendedFields {
949
955
  /**
950
956
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
951
957
  * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -956,7 +962,7 @@ export interface ExtendedFields {
956
962
  */
957
963
  namespaces?: Record<string, Record<string, any>>;
958
964
  }
959
- export interface Policy {
965
+ interface Policy {
960
966
  /**
961
967
  * Policy title - should be translated
962
968
  * @minLength 1
@@ -970,13 +976,13 @@ export interface Policy {
970
976
  */
971
977
  content?: string;
972
978
  }
973
- export interface ModifierGroup {
979
+ interface ModifierGroup {
974
980
  /**
975
981
  * Modifier group id.
976
982
  * @minLength 1
977
983
  * @maxLength 36
978
984
  */
979
- id?: string;
985
+ _id?: string;
980
986
  /** Modifier group name. */
981
987
  name?: TranslatableString;
982
988
  /**
@@ -986,7 +992,7 @@ export interface ModifierGroup {
986
992
  */
987
993
  modifiers?: ItemModifier[];
988
994
  }
989
- export interface TranslatableString {
995
+ interface TranslatableString {
990
996
  /**
991
997
  * __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).
992
998
  *
@@ -1007,13 +1013,13 @@ export interface TranslatableString {
1007
1013
  */
1008
1014
  translated?: string | null;
1009
1015
  }
1010
- export interface ItemModifier {
1016
+ interface ItemModifier {
1011
1017
  /**
1012
1018
  * Modifier ID.
1013
1019
  * @minLength 1
1014
1020
  * @maxLength 36
1015
1021
  */
1016
- id?: string;
1022
+ _id?: string;
1017
1023
  /**
1018
1024
  * The quantity of this modifier.
1019
1025
  * @min 1
@@ -1028,14 +1034,14 @@ export interface ItemModifier {
1028
1034
  price?: MultiCurrencyPrice;
1029
1035
  }
1030
1036
  /** Billing Info and shipping details */
1031
- export interface AddressWithContact {
1037
+ interface AddressWithContact {
1032
1038
  /** Address. */
1033
1039
  address?: ApiAddress;
1034
1040
  /** Contact details. */
1035
1041
  contactDetails?: FullAddressContactDetails;
1036
1042
  }
1037
1043
  /** Physical address */
1038
- export interface ApiAddress {
1044
+ interface ApiAddress {
1039
1045
  /**
1040
1046
  * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
1041
1047
  * @format COUNTRY
@@ -1062,7 +1068,7 @@ export interface ApiAddress {
1062
1068
  * Main address line (usually street name and number).
1063
1069
  * @maxLength 150
1064
1070
  */
1065
- addressLine?: string | null;
1071
+ addressLine1?: string | null;
1066
1072
  /**
1067
1073
  * Free text providing more detailed address info. Usually contains apt, suite, floor.
1068
1074
  * @maxLength 100
@@ -1079,20 +1085,20 @@ export interface ApiAddress {
1079
1085
  */
1080
1086
  subdivisionFullname?: string | null;
1081
1087
  }
1082
- export interface StreetAddress {
1088
+ interface StreetAddress {
1083
1089
  /** Street number. */
1084
1090
  number?: string;
1085
1091
  /** Street name. */
1086
1092
  name?: string;
1087
1093
  }
1088
- export interface AddressLocation {
1094
+ interface AddressLocation {
1089
1095
  /** Address latitude. */
1090
1096
  latitude?: number | null;
1091
1097
  /** Address longitude. */
1092
1098
  longitude?: number | null;
1093
1099
  }
1094
1100
  /** Full contact details for an address */
1095
- export interface FullAddressContactDetails {
1101
+ interface FullAddressContactDetails {
1096
1102
  /**
1097
1103
  * First name.
1098
1104
  * @maxLength 100
@@ -1116,9 +1122,9 @@ export interface FullAddressContactDetails {
1116
1122
  /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
1117
1123
  vatId?: CommonVatId;
1118
1124
  }
1119
- export interface CommonVatId {
1125
+ interface CommonVatId {
1120
1126
  /** Customer's tax ID. */
1121
- id?: string;
1127
+ _id?: string;
1122
1128
  /**
1123
1129
  * Tax type.
1124
1130
  *
@@ -1129,7 +1135,7 @@ export interface CommonVatId {
1129
1135
  type?: CommonVatTypeWithLiterals;
1130
1136
  }
1131
1137
  /** tax info types */
1132
- export declare enum CommonVatType {
1138
+ declare enum CommonVatType {
1133
1139
  UNSPECIFIED = "UNSPECIFIED",
1134
1140
  /** CPF - for individual tax payers. */
1135
1141
  CPF = "CPF",
@@ -1137,8 +1143,8 @@ export declare enum CommonVatType {
1137
1143
  CNPJ = "CNPJ"
1138
1144
  }
1139
1145
  /** @enumType */
1140
- export type CommonVatTypeWithLiterals = CommonVatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
1141
- export interface ShippingInfo {
1146
+ type CommonVatTypeWithLiterals = CommonVatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
1147
+ interface ShippingInfo {
1142
1148
  /** Shipping address and contact details. */
1143
1149
  shippingDestination?: AddressWithContact;
1144
1150
  /** Selected option out of the options allowed for the `region`. */
@@ -1154,7 +1160,7 @@ export interface ShippingInfo {
1154
1160
  */
1155
1161
  carrierServiceOptions?: CarrierServiceOption[];
1156
1162
  }
1157
- export interface SelectedCarrierServiceOption {
1163
+ interface SelectedCarrierServiceOption {
1158
1164
  /**
1159
1165
  * Unique identifier of selected option. For example, "usps_std_overnight".
1160
1166
  * @maxLength 100
@@ -1202,7 +1208,7 @@ export interface SelectedCarrierServiceOption {
1202
1208
  /** If the delivery solution is a partial and doesn't apply to all items. */
1203
1209
  partial?: boolean | null;
1204
1210
  }
1205
- export interface DeliveryLogistics {
1211
+ interface DeliveryLogistics {
1206
1212
  /**
1207
1213
  * Expected delivery time, in free text. For example, "3-5 business days".
1208
1214
  * @maxLength 500
@@ -1216,7 +1222,7 @@ export interface DeliveryLogistics {
1216
1222
  /** Pickup details. */
1217
1223
  pickupDetails?: PickupDetails;
1218
1224
  }
1219
- export interface PickupDetails {
1225
+ interface PickupDetails {
1220
1226
  /** Pickup address. */
1221
1227
  address?: ApiAddress;
1222
1228
  /**
@@ -1227,20 +1233,20 @@ export interface PickupDetails {
1227
1233
  /** Pickup method */
1228
1234
  pickupMethod?: PickupMethodWithLiterals;
1229
1235
  }
1230
- export declare enum PickupMethod {
1236
+ declare enum PickupMethod {
1231
1237
  UNKNOWN_METHOD = "UNKNOWN_METHOD",
1232
1238
  STORE_PICKUP = "STORE_PICKUP",
1233
1239
  PICKUP_POINT = "PICKUP_POINT"
1234
1240
  }
1235
1241
  /** @enumType */
1236
- export type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
1237
- export interface DeliveryTimeSlot {
1242
+ type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
1243
+ interface DeliveryTimeSlot {
1238
1244
  /** starting time of the delivery time slot */
1239
1245
  from?: Date | null;
1240
1246
  /** ending time of the delivery time slot */
1241
1247
  to?: Date | null;
1242
1248
  }
1243
- export interface SelectedCarrierServiceOptionPrices {
1249
+ interface SelectedCarrierServiceOptionPrices {
1244
1250
  /** Total shipping price, after discount and after tax. */
1245
1251
  totalPriceAfterTax?: MultiCurrencyPrice;
1246
1252
  /** Total price of shipping after discounts (when relevant), and before tax. */
@@ -1252,7 +1258,7 @@ export interface SelectedCarrierServiceOptionPrices {
1252
1258
  /** Shipping price before discount and before tax. */
1253
1259
  price?: MultiCurrencyPrice;
1254
1260
  }
1255
- export interface SelectedCarrierServiceOptionOtherCharge {
1261
+ interface SelectedCarrierServiceOptionOtherCharge {
1256
1262
  /** Type of additional cost. */
1257
1263
  type?: ChargeTypeWithLiterals;
1258
1264
  /**
@@ -1263,13 +1269,13 @@ export interface SelectedCarrierServiceOptionOtherCharge {
1263
1269
  /** Price of added charge. */
1264
1270
  cost?: SelectedCarrierServiceOptionPrices;
1265
1271
  }
1266
- export declare enum ChargeType {
1272
+ declare enum ChargeType {
1267
1273
  HANDLING_FEE = "HANDLING_FEE",
1268
1274
  INSURANCE = "INSURANCE"
1269
1275
  }
1270
1276
  /** @enumType */
1271
- export type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE' | 'INSURANCE';
1272
- export interface DeliveryAllocation {
1277
+ type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE' | 'INSURANCE';
1278
+ interface DeliveryAllocation {
1273
1279
  /** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
1274
1280
  deliveryCarrier?: Carrier;
1275
1281
  /** The delivery region that are relevant for this delivery solution. */
@@ -1277,7 +1283,7 @@ export interface DeliveryAllocation {
1277
1283
  /** Populated if the delivery solution is a partially supplied by this carrier. */
1278
1284
  applicableLineItems?: ApplicableLineItems;
1279
1285
  }
1280
- export interface Carrier {
1286
+ interface Carrier {
1281
1287
  /**
1282
1288
  * The carrier app id
1283
1289
  * @format GUID
@@ -1289,19 +1295,19 @@ export interface Carrier {
1289
1295
  */
1290
1296
  code?: string;
1291
1297
  }
1292
- export interface Region {
1298
+ interface Region {
1293
1299
  /**
1294
1300
  * The delivery region id.
1295
1301
  * @format GUID
1296
1302
  */
1297
- id?: string | null;
1303
+ _id?: string | null;
1298
1304
  /**
1299
1305
  * The delivery region name.
1300
1306
  * @maxLength 100
1301
1307
  */
1302
1308
  name?: string | null;
1303
1309
  }
1304
- export interface ApplicableLineItems {
1310
+ interface ApplicableLineItems {
1305
1311
  /**
1306
1312
  * Line items that the delivery solution is for.
1307
1313
  * @maxSize 300
@@ -1310,20 +1316,20 @@ export interface ApplicableLineItems {
1310
1316
  */
1311
1317
  lineItemIds?: string[];
1312
1318
  }
1313
- export interface ShippingRegion {
1319
+ interface ShippingRegion {
1314
1320
  /**
1315
1321
  * Shipping region ID.
1316
1322
  * @format GUID
1317
1323
  * @readonly
1318
1324
  */
1319
- id?: string;
1325
+ _id?: string;
1320
1326
  /**
1321
1327
  * Shipping region name.
1322
1328
  * @maxLength 100
1323
1329
  */
1324
1330
  name?: string;
1325
1331
  }
1326
- export interface CarrierServiceOption {
1332
+ interface CarrierServiceOption {
1327
1333
  /**
1328
1334
  * Carrier ID.
1329
1335
  * @format GUID
@@ -1332,7 +1338,7 @@ export interface CarrierServiceOption {
1332
1338
  /** Shipping options offered by this carrier for this request. */
1333
1339
  shippingOptions?: ShippingOption[];
1334
1340
  }
1335
- export interface ShippingOption {
1341
+ interface ShippingOption {
1336
1342
  /**
1337
1343
  * Unique code of provided shipping option like "usps_std_overnight".
1338
1344
  * For legacy calculators this would be the UUID of the option.
@@ -1357,13 +1363,13 @@ export interface ShippingOption {
1357
1363
  /** If the delivery solution is a partial and doesn't apply to all items. */
1358
1364
  partial?: boolean | null;
1359
1365
  }
1360
- export interface ShippingPrice {
1366
+ interface ShippingPrice {
1361
1367
  /** Shipping price. */
1362
1368
  price?: MultiCurrencyPrice;
1363
1369
  /** Other costs such as insurance, handling & packaging for fragile items, etc. */
1364
1370
  otherCharges?: OtherCharge[];
1365
1371
  }
1366
- export interface OtherCharge {
1372
+ interface OtherCharge {
1367
1373
  /** Type of additional cost. */
1368
1374
  type?: ChargeTypeWithLiterals;
1369
1375
  /** Price of added cost. */
@@ -1374,7 +1380,7 @@ export interface OtherCharge {
1374
1380
  */
1375
1381
  details?: string | null;
1376
1382
  }
1377
- export interface BuyerInfo extends BuyerInfoIdOneOf {
1383
+ interface BuyerInfo extends BuyerInfoIdOneOf {
1378
1384
  /**
1379
1385
  * Visitor ID (if site visitor is **not** a member).
1380
1386
  * @format GUID
@@ -1400,7 +1406,7 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
1400
1406
  email?: string | null;
1401
1407
  }
1402
1408
  /** @oneof */
1403
- export interface BuyerInfoIdOneOf {
1409
+ interface BuyerInfoIdOneOf {
1404
1410
  /**
1405
1411
  * Visitor ID (if site visitor is **not** a member).
1406
1412
  * @format GUID
@@ -1414,7 +1420,7 @@ export interface BuyerInfoIdOneOf {
1414
1420
  */
1415
1421
  memberId?: string;
1416
1422
  }
1417
- export interface PriceSummary {
1423
+ interface PriceSummary {
1418
1424
  /** Subtotal of all line items, before discounts and before tax. */
1419
1425
  subtotal?: MultiCurrencyPrice;
1420
1426
  /** Total shipping price, before discounts and before tax. */
@@ -1428,7 +1434,7 @@ export interface PriceSummary {
1428
1434
  /** Total additional fees price before tax. */
1429
1435
  additionalFees?: MultiCurrencyPrice;
1430
1436
  }
1431
- export interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
1437
+ interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
1432
1438
  /** General shipping calculation error. */
1433
1439
  generalShippingCalculationError?: Details;
1434
1440
  /** Carrier errors. */
@@ -1450,13 +1456,13 @@ export interface CalculationErrors extends CalculationErrorsShippingCalculationE
1450
1456
  discountsCalculationError?: Details;
1451
1457
  }
1452
1458
  /** @oneof */
1453
- export interface CalculationErrorsShippingCalculationErrorOneOf {
1459
+ interface CalculationErrorsShippingCalculationErrorOneOf {
1454
1460
  /** General shipping calculation error. */
1455
1461
  generalShippingCalculationError?: Details;
1456
1462
  /** Carrier errors. */
1457
1463
  carrierErrors?: CarrierErrors;
1458
1464
  }
1459
- export interface Details extends DetailsKindOneOf {
1465
+ interface Details extends DetailsKindOneOf {
1460
1466
  applicationError?: ApplicationError;
1461
1467
  validationError?: ValidationError;
1462
1468
  systemError?: SystemError;
@@ -1467,12 +1473,12 @@ export interface Details extends DetailsKindOneOf {
1467
1473
  tracing?: Record<string, string>;
1468
1474
  }
1469
1475
  /** @oneof */
1470
- export interface DetailsKindOneOf {
1476
+ interface DetailsKindOneOf {
1471
1477
  applicationError?: ApplicationError;
1472
1478
  validationError?: ValidationError;
1473
1479
  systemError?: SystemError;
1474
1480
  }
1475
- export interface ApplicationError {
1481
+ interface ApplicationError {
1476
1482
  /** Error code. */
1477
1483
  code?: string;
1478
1484
  /** Description of the error. */
@@ -1512,10 +1518,10 @@ export interface ApplicationError {
1512
1518
  * ]
1513
1519
  * }
1514
1520
  */
1515
- export interface ValidationError {
1521
+ interface ValidationError {
1516
1522
  fieldViolations?: FieldViolation[];
1517
1523
  }
1518
- export declare enum RuleType {
1524
+ declare enum RuleType {
1519
1525
  VALIDATION = "VALIDATION",
1520
1526
  OTHER = "OTHER",
1521
1527
  MAX = "MAX",
@@ -1539,8 +1545,8 @@ export declare enum RuleType {
1539
1545
  REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
1540
1546
  }
1541
1547
  /** @enumType */
1542
- export type RuleTypeWithLiterals = RuleType | 'VALIDATION' | 'OTHER' | 'MAX' | 'MIN' | 'MAX_LENGTH' | 'MIN_LENGTH' | 'MAX_SIZE' | 'MIN_SIZE' | 'FORMAT' | 'DECIMAL_LTE' | 'DECIMAL_GTE' | 'DECIMAL_LT' | 'DECIMAL_GT' | 'DECIMAL_MAX_SCALE' | 'INVALID_ENUM_VALUE' | 'REQUIRED_FIELD' | 'FIELD_NOT_ALLOWED' | 'ONE_OF_ALIGNMENT' | 'EXACT_LENGTH' | 'EXACT_SIZE' | 'REQUIRED_ONE_OF_FIELD';
1543
- export interface FieldViolation {
1548
+ type RuleTypeWithLiterals = RuleType | 'VALIDATION' | 'OTHER' | 'MAX' | 'MIN' | 'MAX_LENGTH' | 'MIN_LENGTH' | 'MAX_SIZE' | 'MIN_SIZE' | 'FORMAT' | 'DECIMAL_LTE' | 'DECIMAL_GTE' | 'DECIMAL_LT' | 'DECIMAL_GT' | 'DECIMAL_MAX_SCALE' | 'INVALID_ENUM_VALUE' | 'REQUIRED_FIELD' | 'FIELD_NOT_ALLOWED' | 'ONE_OF_ALIGNMENT' | 'EXACT_LENGTH' | 'EXACT_SIZE' | 'REQUIRED_ONE_OF_FIELD';
1549
+ interface FieldViolation {
1544
1550
  field?: string;
1545
1551
  description?: string;
1546
1552
  violatedRule?: RuleTypeWithLiterals;
@@ -1548,26 +1554,26 @@ export interface FieldViolation {
1548
1554
  ruleName?: string | null;
1549
1555
  data?: Record<string, any> | null;
1550
1556
  }
1551
- export interface SystemError {
1557
+ interface SystemError {
1552
1558
  /** Error code. */
1553
1559
  errorCode?: string | null;
1554
1560
  }
1555
- export interface CarrierErrors {
1561
+ interface CarrierErrors {
1556
1562
  /** Carrier errors. */
1557
1563
  errors?: CarrierError[];
1558
1564
  }
1559
- export interface CarrierError {
1565
+ interface CarrierError {
1560
1566
  /** Carrier ID. */
1561
1567
  carrierId?: string;
1562
1568
  /** Error details. */
1563
1569
  error?: Details;
1564
1570
  }
1565
- export interface GiftCard {
1571
+ interface GiftCard {
1566
1572
  /**
1567
1573
  * Gift Card ID.
1568
1574
  * @deprecated
1569
1575
  */
1570
- id?: string;
1576
+ _id?: string;
1571
1577
  /** Gift card obfuscated code. */
1572
1578
  obfuscatedCode?: string;
1573
1579
  /** Gift card value. */
@@ -1585,7 +1591,7 @@ export interface GiftCard {
1585
1591
  */
1586
1592
  externalId?: string | null;
1587
1593
  }
1588
- export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1594
+ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1589
1595
  /** Coupon details. */
1590
1596
  coupon?: Coupon;
1591
1597
  /** Merchant discount. */
@@ -1602,9 +1608,17 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1602
1608
  * @targetRemovalDate 2024-06-01
1603
1609
  */
1604
1610
  lineItemIds?: string[];
1611
+ /**
1612
+ * Number of subscription cycle this discount applies to
1613
+ * default None - all billing cycle
1614
+ * @internal
1615
+ * @min 1
1616
+ * @max 999
1617
+ */
1618
+ subscriptionCycles?: number | null;
1605
1619
  }
1606
1620
  /** @oneof */
1607
- export interface AppliedDiscountDiscountSourceOneOf {
1621
+ interface AppliedDiscountDiscountSourceOneOf {
1608
1622
  /** Coupon details. */
1609
1623
  coupon?: Coupon;
1610
1624
  /** Merchant discount. */
@@ -1612,17 +1626,17 @@ export interface AppliedDiscountDiscountSourceOneOf {
1612
1626
  /** Discount rule */
1613
1627
  discountRule?: DiscountRule;
1614
1628
  }
1615
- export declare enum DiscountType {
1629
+ declare enum DiscountType {
1616
1630
  GLOBAL = "GLOBAL",
1617
1631
  SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
1618
1632
  SHIPPING = "SHIPPING"
1619
1633
  }
1620
1634
  /** @enumType */
1621
- export type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
1635
+ type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
1622
1636
  /** Coupon */
1623
- export interface Coupon {
1637
+ interface Coupon {
1624
1638
  /** Coupon ID. */
1625
- id?: string;
1639
+ _id?: string;
1626
1640
  /** Coupon code. */
1627
1641
  code?: string;
1628
1642
  /** Coupon value. */
@@ -1630,7 +1644,7 @@ export interface Coupon {
1630
1644
  /** Coupon name. */
1631
1645
  name?: string;
1632
1646
  }
1633
- export interface MerchantDiscount {
1647
+ interface MerchantDiscount {
1634
1648
  /** Discount value. */
1635
1649
  amount?: MultiCurrencyPrice;
1636
1650
  /**
@@ -1640,18 +1654,18 @@ export interface MerchantDiscount {
1640
1654
  */
1641
1655
  percentage?: number | null;
1642
1656
  }
1643
- export interface DiscountRule {
1657
+ interface DiscountRule {
1644
1658
  /**
1645
1659
  * Discount rule ID
1646
1660
  * @format GUID
1647
1661
  */
1648
- id?: string;
1662
+ _id?: string;
1649
1663
  /** Discount rule name */
1650
1664
  name?: DiscountRuleName;
1651
1665
  /** Discount value. */
1652
1666
  amount?: MultiCurrencyPrice;
1653
1667
  }
1654
- export interface DiscountRuleName {
1668
+ interface DiscountRuleName {
1655
1669
  /**
1656
1670
  * Original discount rule name (in site's default language).
1657
1671
  * @minLength 1
@@ -1665,16 +1679,16 @@ export interface DiscountRuleName {
1665
1679
  */
1666
1680
  translated?: string | null;
1667
1681
  }
1668
- export interface LineItemDiscount {
1682
+ interface LineItemDiscount {
1669
1683
  /**
1670
1684
  * ID of line item the discount applies to.
1671
1685
  * @format GUID
1672
1686
  */
1673
- id?: string;
1687
+ _id?: string;
1674
1688
  /** Discount value. */
1675
1689
  totalDiscountAmount?: MultiCurrencyPrice;
1676
1690
  }
1677
- export interface CustomField {
1691
+ interface CustomField {
1678
1692
  /** Custom field value. */
1679
1693
  value?: any;
1680
1694
  /**
@@ -1690,7 +1704,7 @@ export interface CustomField {
1690
1704
  */
1691
1705
  translatedTitle?: string | null;
1692
1706
  }
1693
- export declare enum WeightUnit {
1707
+ declare enum WeightUnit {
1694
1708
  /** Weight unit can't be classified due to an error. */
1695
1709
  UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
1696
1710
  /** Kilograms. */
@@ -1699,8 +1713,8 @@ export declare enum WeightUnit {
1699
1713
  LB = "LB"
1700
1714
  }
1701
1715
  /** @enumType */
1702
- export type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
1703
- export interface TaxSummary {
1716
+ type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
1717
+ interface TaxSummary {
1704
1718
  /**
1705
1719
  * Amount for which tax is calculated, added from line items.
1706
1720
  * @readonly
@@ -1717,7 +1731,7 @@ export interface TaxSummary {
1717
1731
  */
1718
1732
  calculationDetails?: TaxCalculationDetails;
1719
1733
  }
1720
- export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
1734
+ interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
1721
1735
  /** Reason the manual calculation was used. */
1722
1736
  manualRateReason?: ManualCalculationReasonWithLiterals;
1723
1737
  /** Details of the fallback rate calculation. */
@@ -1726,13 +1740,13 @@ export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationD
1726
1740
  rateType?: RateTypeWithLiterals;
1727
1741
  }
1728
1742
  /** @oneof */
1729
- export interface TaxCalculationDetailsCalculationDetailsOneOf {
1743
+ interface TaxCalculationDetailsCalculationDetailsOneOf {
1730
1744
  /** Reason the manual calculation was used. */
1731
1745
  manualRateReason?: ManualCalculationReasonWithLiterals;
1732
1746
  /** Details of the fallback rate calculation. */
1733
1747
  autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
1734
1748
  }
1735
- export declare enum RateType {
1749
+ declare enum RateType {
1736
1750
  /** no tax being collected for this request due to location of purchase */
1737
1751
  NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
1738
1752
  /** manual rate used for calculation */
@@ -1743,34 +1757,34 @@ export declare enum RateType {
1743
1757
  FALLBACK_RATE = "FALLBACK_RATE"
1744
1758
  }
1745
1759
  /** @enumType */
1746
- export type RateTypeWithLiterals = RateType | 'NO_TAX_COLLECTED' | 'MANUAL_RATE' | 'AUTO_RATE' | 'FALLBACK_RATE';
1747
- export declare enum ManualCalculationReason {
1760
+ type RateTypeWithLiterals = RateType | 'NO_TAX_COLLECTED' | 'MANUAL_RATE' | 'AUTO_RATE' | 'FALLBACK_RATE';
1761
+ declare enum ManualCalculationReason {
1748
1762
  /** user set calculator in Business Manager to be Manual */
1749
1763
  GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
1750
1764
  /** specific region is on manual even though Global setting is Auto-tax */
1751
1765
  REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
1752
1766
  }
1753
1767
  /** @enumType */
1754
- export type ManualCalculationReasonWithLiterals = ManualCalculationReason | 'GLOBAL_SETTING_TO_MANUAL' | 'REGION_SETTING_TO_MANUAL';
1755
- export interface AutoTaxFallbackCalculationDetails {
1768
+ type ManualCalculationReasonWithLiterals = ManualCalculationReason | 'GLOBAL_SETTING_TO_MANUAL' | 'REGION_SETTING_TO_MANUAL';
1769
+ interface AutoTaxFallbackCalculationDetails {
1756
1770
  /** reason for fallback */
1757
1771
  fallbackReason?: FallbackReasonWithLiterals;
1758
1772
  /** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
1759
1773
  error?: ApplicationError;
1760
1774
  }
1761
- export declare enum FallbackReason {
1775
+ declare enum FallbackReason {
1762
1776
  /** auto-tax failed to be calculated */
1763
1777
  AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
1764
1778
  /** auto-tax was temporarily deactivated on a system-level */
1765
1779
  AUTO_TAX_DEACTIVATED = "AUTO_TAX_DEACTIVATED"
1766
1780
  }
1767
1781
  /** @enumType */
1768
- export type FallbackReasonWithLiterals = FallbackReason | 'AUTO_TAX_FAILED' | 'AUTO_TAX_DEACTIVATED';
1782
+ type FallbackReasonWithLiterals = FallbackReason | 'AUTO_TAX_FAILED' | 'AUTO_TAX_DEACTIVATED';
1769
1783
  /**
1770
1784
  * 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.
1771
1785
  * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
1772
1786
  */
1773
- export interface AggregatedTaxBreakdown {
1787
+ interface AggregatedTaxBreakdown {
1774
1788
  /**
1775
1789
  * The name of the tax against which this tax amount was calculated.
1776
1790
  * @maxLength 200
@@ -1796,7 +1810,7 @@ export interface AggregatedTaxBreakdown {
1796
1810
  /** The sum of all the tax from line items that calculated by the tax identifiers. */
1797
1811
  aggregatedTaxAmount?: MultiCurrencyPrice;
1798
1812
  }
1799
- export declare enum ChannelType {
1813
+ declare enum ChannelType {
1800
1814
  /** Unspecified sales channel. This value is not supported. */
1801
1815
  UNSPECIFIED = "UNSPECIFIED",
1802
1816
  /** A web client. */
@@ -1831,8 +1845,8 @@ export declare enum ChannelType {
1831
1845
  FAIRE_COM = "FAIRE_COM"
1832
1846
  }
1833
1847
  /** @enumType */
1834
- export type ChannelTypeWithLiterals = ChannelType | 'UNSPECIFIED' | 'WEB' | 'POS' | 'EBAY' | 'AMAZON' | 'OTHER_PLATFORM' | 'WIX_APP_STORE' | 'WIX_INVOICES' | 'BACKOFFICE_MERCHANT' | 'WISH' | 'CLASS_PASS' | 'GLOBAL_E' | 'FACEBOOK' | 'ETSY' | 'TIKTOK' | 'FAIRE_COM';
1835
- export interface CreatedBy extends CreatedByIdOneOf {
1848
+ type ChannelTypeWithLiterals = ChannelType | 'UNSPECIFIED' | 'WEB' | 'POS' | 'EBAY' | 'AMAZON' | 'OTHER_PLATFORM' | 'WIX_APP_STORE' | 'WIX_INVOICES' | 'BACKOFFICE_MERCHANT' | 'WISH' | 'CLASS_PASS' | 'GLOBAL_E' | 'FACEBOOK' | 'ETSY' | 'TIKTOK' | 'FAIRE_COM';
1849
+ interface CreatedBy extends CreatedByIdOneOf {
1836
1850
  /**
1837
1851
  * User ID. When the order was created by a Wix user on behalf of a buyer.
1838
1852
  * For example, via POS (point of service).
@@ -1856,7 +1870,7 @@ export interface CreatedBy extends CreatedByIdOneOf {
1856
1870
  appId?: string;
1857
1871
  }
1858
1872
  /** @oneof */
1859
- export interface CreatedByIdOneOf {
1873
+ interface CreatedByIdOneOf {
1860
1874
  /**
1861
1875
  * User ID. When the order was created by a Wix user on behalf of a buyer.
1862
1876
  * For example, via POS (point of service).
@@ -1880,7 +1894,7 @@ export interface CreatedByIdOneOf {
1880
1894
  appId?: string;
1881
1895
  }
1882
1896
  /** Reserved for internal use. */
1883
- export interface MembershipOptions {
1897
+ interface MembershipOptions {
1884
1898
  /**
1885
1899
  * Reserved for internal use.
1886
1900
  * @readonly
@@ -1896,13 +1910,13 @@ export interface MembershipOptions {
1896
1910
  /** Selected membership to apply to this checkout. */
1897
1911
  selectedMemberships?: SelectedMemberships;
1898
1912
  }
1899
- export interface Membership {
1913
+ interface Membership {
1900
1914
  /**
1901
1915
  * Membership ID.
1902
1916
  * @minLength 1
1903
1917
  * @maxLength 100
1904
1918
  */
1905
- id?: string;
1919
+ _id?: string;
1906
1920
  /**
1907
1921
  * ID of the application providing this payment option.
1908
1922
  * @format GUID
@@ -1925,7 +1939,7 @@ export interface Membership {
1925
1939
  /** Additional data about this membership. */
1926
1940
  additionalData?: Record<string, any> | null;
1927
1941
  }
1928
- export interface MembershipName {
1942
+ interface MembershipName {
1929
1943
  /**
1930
1944
  * Membership name.
1931
1945
  * @maxLength 100
@@ -1937,7 +1951,7 @@ export interface MembershipName {
1937
1951
  */
1938
1952
  translated?: string | null;
1939
1953
  }
1940
- export interface MembershipPaymentCredits {
1954
+ interface MembershipPaymentCredits {
1941
1955
  /**
1942
1956
  * Membership's total amount of credits.
1943
1957
  * @min 1
@@ -1946,7 +1960,7 @@ export interface MembershipPaymentCredits {
1946
1960
  /** Membership's remaining amount of credits. */
1947
1961
  remaining?: number;
1948
1962
  }
1949
- export interface InvalidMembership {
1963
+ interface InvalidMembership {
1950
1964
  /** Membership details. */
1951
1965
  membership?: Membership;
1952
1966
  /**
@@ -1956,20 +1970,20 @@ export interface InvalidMembership {
1956
1970
  */
1957
1971
  reason?: string;
1958
1972
  }
1959
- export interface SelectedMemberships {
1973
+ interface SelectedMemberships {
1960
1974
  /**
1961
1975
  * Selected memberships.
1962
1976
  * @maxSize 300
1963
1977
  */
1964
1978
  memberships?: SelectedMembership[];
1965
1979
  }
1966
- export interface SelectedMembership {
1980
+ interface SelectedMembership {
1967
1981
  /**
1968
1982
  * Membership ID.
1969
1983
  * @minLength 1
1970
1984
  * @maxLength 100
1971
1985
  */
1972
- id?: string;
1986
+ _id?: string;
1973
1987
  /**
1974
1988
  * ID of the app providing this payment option.
1975
1989
  * @format GUID
@@ -1984,7 +1998,7 @@ export interface SelectedMembership {
1984
1998
  */
1985
1999
  lineItemIds?: string[];
1986
2000
  }
1987
- export interface AdditionalFee {
2001
+ interface AdditionalFee {
1988
2002
  /**
1989
2003
  * Additional fee's unique code (or ID) for future processing.
1990
2004
  * @minLength 1
@@ -2017,10 +2031,18 @@ export interface AdditionalFee {
2017
2031
  * @format GUID
2018
2032
  */
2019
2033
  lineItemIds?: string[];
2034
+ /**
2035
+ * Number of subscription cycle this fee applies to
2036
+ * default None - all billing cycle
2037
+ * @internal
2038
+ * @min 1
2039
+ * @max 999
2040
+ */
2041
+ subscriptionCycles?: number | null;
2020
2042
  /** the source the additional fee was added from */
2021
2043
  source?: AdditionalFeeSourceWithLiterals;
2022
2044
  }
2023
- export declare enum AdditionalFeeSource {
2045
+ declare enum AdditionalFeeSource {
2024
2046
  UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
2025
2047
  /** The additional fee was added by an additional fee service plugin */
2026
2048
  SERVICE_PLUGIN = "SERVICE_PLUGIN",
@@ -2032,8 +2054,8 @@ export declare enum AdditionalFeeSource {
2032
2054
  SHIPPING = "SHIPPING"
2033
2055
  }
2034
2056
  /** @enumType */
2035
- export type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING';
2036
- export interface ConversionInfo {
2057
+ type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING';
2058
+ interface ConversionInfo {
2037
2059
  /**
2038
2060
  * The site currency.
2039
2061
  * @readonly
@@ -2047,7 +2069,7 @@ export interface ConversionInfo {
2047
2069
  */
2048
2070
  conversionRate?: string;
2049
2071
  }
2050
- export interface Violation {
2072
+ interface Violation {
2051
2073
  /** 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. */
2052
2074
  severity?: SeverityWithLiterals;
2053
2075
  /** Target location on a checkout or cart page where the violation will be displayed. */
@@ -2059,7 +2081,7 @@ export interface Violation {
2059
2081
  */
2060
2082
  description?: string | null;
2061
2083
  }
2062
- export declare enum Severity {
2084
+ declare enum Severity {
2063
2085
  /** The user is allowed to move forward in the flow. */
2064
2086
  WARNING = "WARNING",
2065
2087
  /**
@@ -2069,55 +2091,60 @@ export declare enum Severity {
2069
2091
  ERROR = "ERROR"
2070
2092
  }
2071
2093
  /** @enumType */
2072
- export type SeverityWithLiterals = Severity | 'WARNING' | 'ERROR';
2073
- export interface Target extends TargetTargetTypeOneOf {
2094
+ type SeverityWithLiterals = Severity | 'WARNING' | 'ERROR';
2095
+ interface Target extends TargetTargetTypeOneOf {
2074
2096
  /** General (other) violation. */
2075
2097
  other?: Other;
2076
2098
  /** Specific line item violation. */
2077
2099
  lineItem?: TargetLineItem;
2078
2100
  }
2079
2101
  /** @oneof */
2080
- export interface TargetTargetTypeOneOf {
2102
+ interface TargetTargetTypeOneOf {
2081
2103
  /** General (other) violation. */
2082
2104
  other?: Other;
2083
2105
  /** Specific line item violation. */
2084
2106
  lineItem?: TargetLineItem;
2085
2107
  }
2086
2108
  /** Available locations on the webpage */
2087
- export declare enum NameInOther {
2109
+ declare enum NameInOther {
2088
2110
  /** Default location, in case no specific location is specified. */
2089
2111
  OTHER_DEFAULT = "OTHER_DEFAULT"
2090
2112
  }
2091
2113
  /** @enumType */
2092
- export type NameInOtherWithLiterals = NameInOther | 'OTHER_DEFAULT';
2114
+ type NameInOtherWithLiterals = NameInOther | 'OTHER_DEFAULT';
2093
2115
  /** Available locations on the line item */
2094
- export declare enum NameInLineItem {
2116
+ declare enum NameInLineItem {
2095
2117
  /** Default location, in case no specific location is specified. */
2096
2118
  LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
2097
2119
  }
2098
2120
  /** @enumType */
2099
- export type NameInLineItemWithLiterals = NameInLineItem | 'LINE_ITEM_DEFAULT';
2100
- export declare enum SuggestedFix {
2121
+ type NameInLineItemWithLiterals = NameInLineItem | 'LINE_ITEM_DEFAULT';
2122
+ declare enum SuggestedFix {
2101
2123
  /** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
2102
2124
  UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
2103
2125
  /** The line item should be removed from the cart or checkout to resolve the violation. */
2104
2126
  REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
2105
2127
  }
2106
2128
  /** @enumType */
2107
- export type SuggestedFixWithLiterals = SuggestedFix | 'UNKNOWN_SUGGESTED_FIX' | 'REMOVE_LINE_ITEM';
2129
+ type SuggestedFixWithLiterals = SuggestedFix | 'UNKNOWN_SUGGESTED_FIX' | 'REMOVE_LINE_ITEM';
2108
2130
  /** General (other) violation. */
2109
- export interface Other {
2131
+ interface Other {
2110
2132
  /** Location on a checkout or a cart page where a general (other) violation will be displayed. */
2111
2133
  name?: NameInOtherWithLiterals;
2112
2134
  }
2113
2135
  /** Specific line item violation. */
2114
- export interface TargetLineItem {
2136
+ interface TargetLineItem {
2115
2137
  /** Location on a checkout or a cart page where the specific line item violation will be displayed. */
2116
2138
  name?: NameInLineItemWithLiterals;
2117
2139
  /** ID of the line item containing the violation. */
2118
- id?: string | null;
2140
+ _id?: string | null;
2141
+ /**
2142
+ * Suggested fix for resolving the line item violation.
2143
+ * @internal
2144
+ */
2145
+ suggestedFix?: SuggestedFixWithLiterals;
2119
2146
  }
2120
- export interface CustomSettings {
2147
+ interface CustomSettings {
2121
2148
  /**
2122
2149
  * Whether to restrict the option to add or remove a gift card on the checkout page.
2123
2150
  *
@@ -2143,7 +2170,7 @@ export interface CustomSettings {
2143
2170
  */
2144
2171
  disabledManualPayment?: boolean;
2145
2172
  }
2146
- export interface CustomContentReference {
2173
+ interface CustomContentReference {
2147
2174
  /**
2148
2175
  * ID of the app providing the content.
2149
2176
  *
@@ -2159,7 +2186,7 @@ export interface CustomContentReference {
2159
2186
  */
2160
2187
  componentId?: string;
2161
2188
  }
2162
- export interface ExternalReference {
2189
+ interface ExternalReference {
2163
2190
  /**
2164
2191
  * ID of the app associated with the purchase flow.
2165
2192
  * For example, the Wix Pay Links app ID.
@@ -2176,7 +2203,7 @@ export interface ExternalReference {
2176
2203
  */
2177
2204
  resourceId?: string | null;
2178
2205
  }
2179
- export interface SubscriptionCharges {
2206
+ interface SubscriptionCharges {
2180
2207
  /**
2181
2208
  * ids of the items the subscription is defined on
2182
2209
  * @format GUID
@@ -2196,7 +2223,7 @@ export interface SubscriptionCharges {
2196
2223
  */
2197
2224
  charges?: Charge[];
2198
2225
  }
2199
- export interface Charge {
2226
+ interface Charge {
2200
2227
  /** The cycle number from which the charge starts. */
2201
2228
  cycleFrom?: number;
2202
2229
  /** The number of cycles for which the charge is applicable. */
@@ -2206,13 +2233,13 @@ export interface Charge {
2206
2233
  /** The billing date from which the charge starts. */
2207
2234
  cycleBillingDate?: Date | null;
2208
2235
  }
2209
- export interface UpdatedCheckoutMessage {
2236
+ interface UpdatedCheckoutMessage {
2210
2237
  /** Previous checkout. */
2211
2238
  oldCheckout?: Checkout;
2212
2239
  /** Updated checkout. */
2213
2240
  updatedCheckout?: Checkout;
2214
2241
  }
2215
- export interface CreateCheckoutRequest {
2242
+ interface CreateCheckoutRequest {
2216
2243
  /** Checkout information. */
2217
2244
  checkoutInfo?: Checkout;
2218
2245
  /** Coupon code. */
@@ -2250,7 +2277,7 @@ export interface CreateCheckoutRequest {
2250
2277
  */
2251
2278
  overrideCheckoutUrl?: string | null;
2252
2279
  }
2253
- export interface CustomLineItem {
2280
+ interface CustomLineItem {
2254
2281
  /**
2255
2282
  * Custom line item quantity.
2256
2283
  *
@@ -2261,9 +2288,7 @@ export interface CustomLineItem {
2261
2288
  */
2262
2289
  quantity?: number;
2263
2290
  /**
2264
- * Custom line item price.
2265
- *
2266
- * Must be a number or a decimal without symbols.
2291
+ * Custom line item price. For security reasons, the `price` field should come from backend code, and not be passed from the frontend.
2267
2292
  * @format DECIMAL_VALUE
2268
2293
  * @decimalValue options { gte:0, lte:1000000000000000 }
2269
2294
  */
@@ -2275,15 +2300,19 @@ export interface CustomLineItem {
2275
2300
  * @maxSize 10
2276
2301
  */
2277
2302
  descriptionLines?: DescriptionLine[];
2278
- /** Custom line item's media. */
2279
- media?: Image;
2303
+ /**
2304
+ * Custom line item media.
2305
+ * + 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"`.
2306
+ * + An image from the web - `"http(s)://<image url>"`.
2307
+ */
2308
+ media?: string;
2280
2309
  /**
2281
2310
  * Custom line item ID. If passed, `id` must be unique.
2282
2311
  *
2283
2312
  * Default: auto-generated ID
2284
2313
  * @format GUID
2285
2314
  */
2286
- id?: string | null;
2315
+ _id?: string | null;
2287
2316
  /**
2288
2317
  * Tax group ID for this custom line item.
2289
2318
  * @format GUID
@@ -2292,7 +2321,7 @@ export interface CustomLineItem {
2292
2321
  /** Name of the item or product. */
2293
2322
  productName?: ProductName;
2294
2323
  /** 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. */
2295
- url?: PageUrlV2;
2324
+ url?: string;
2296
2325
  /** Item type. Either a preset type or custom. */
2297
2326
  itemType?: ItemType;
2298
2327
  /**
@@ -2347,6 +2376,20 @@ export interface CustomLineItem {
2347
2376
  deliveryProfileId?: string | null;
2348
2377
  /** 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. */
2349
2378
  catalogReference?: CatalogReference;
2379
+ /**
2380
+ * Whether the price is not yet defined, and will be updated after the order is created.
2381
+ *
2382
+ * Default: `false`
2383
+ * @internal
2384
+ */
2385
+ priceUndetermined?: boolean;
2386
+ /**
2387
+ * Whether the line item quantity is fixed and cannot be changed.
2388
+ *
2389
+ * Default: `false`
2390
+ * @internal
2391
+ */
2392
+ fixedQuantity?: boolean;
2350
2393
  /**
2351
2394
  * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
2352
2395
  * @minLength 1
@@ -2366,6 +2409,12 @@ export interface CustomLineItem {
2366
2409
  * @maxSize 5
2367
2410
  */
2368
2411
  policies?: Policy[];
2412
+ /**
2413
+ * ID of the app managing the inventory.
2414
+ * @internal
2415
+ * @format GUID
2416
+ */
2417
+ inventoryAppId?: string | null;
2369
2418
  /**
2370
2419
  * Whether the item can only be purchased by site members.
2371
2420
  *
@@ -2380,13 +2429,13 @@ export interface CustomLineItem {
2380
2429
  */
2381
2430
  modifierGroups?: V1ModifierGroup[];
2382
2431
  }
2383
- export interface V1ModifierGroup {
2432
+ interface V1ModifierGroup {
2384
2433
  /**
2385
2434
  * Modifier group id.
2386
2435
  * @minLength 1
2387
2436
  * @maxLength 36
2388
2437
  */
2389
- id?: string;
2438
+ _id?: string;
2390
2439
  /** Modifier group name. */
2391
2440
  name?: TranslatableString;
2392
2441
  /**
@@ -2396,13 +2445,13 @@ export interface V1ModifierGroup {
2396
2445
  */
2397
2446
  modifiers?: V1ItemModifier[];
2398
2447
  }
2399
- export interface V1ItemModifier {
2448
+ interface V1ItemModifier {
2400
2449
  /**
2401
2450
  * Modifier ID.
2402
2451
  * @minLength 1
2403
2452
  * @maxLength 36
2404
2453
  */
2405
- id?: string;
2454
+ _id?: string;
2406
2455
  /**
2407
2456
  * The quantity of this modifier.
2408
2457
  * @min 1
@@ -2419,7 +2468,7 @@ export interface V1ItemModifier {
2419
2468
  */
2420
2469
  price?: string | null;
2421
2470
  }
2422
- export interface MerchantDiscountInput {
2471
+ interface MerchantDiscountInput {
2423
2472
  /**
2424
2473
  * Discount amount.
2425
2474
  * @decimalValue options { gte:0 }
@@ -2432,75 +2481,75 @@ export interface MerchantDiscountInput {
2432
2481
  */
2433
2482
  lineItemIds?: string[];
2434
2483
  }
2435
- export interface CreateCheckoutResponse {
2484
+ interface CreateCheckoutResponse {
2436
2485
  /** Newly created checkout. */
2437
2486
  checkout?: Checkout;
2438
2487
  }
2439
- export interface ShippingCalculationErrorData extends ShippingCalculationErrorDataShippingCalculationErrorOneOf {
2488
+ interface ShippingCalculationErrorData extends ShippingCalculationErrorDataShippingCalculationErrorOneOf {
2440
2489
  generalShippingCalculationError?: Details;
2441
2490
  carrierErrors?: CarrierErrors;
2442
2491
  }
2443
2492
  /** @oneof */
2444
- export interface ShippingCalculationErrorDataShippingCalculationErrorOneOf {
2493
+ interface ShippingCalculationErrorDataShippingCalculationErrorOneOf {
2445
2494
  generalShippingCalculationError?: Details;
2446
2495
  carrierErrors?: CarrierErrors;
2447
2496
  }
2448
- export interface GetCheckoutRequest {
2497
+ interface GetCheckoutRequest {
2449
2498
  /**
2450
2499
  * Checkout ID.
2451
2500
  * @format GUID
2452
2501
  */
2453
- id: string;
2502
+ _id: string;
2454
2503
  }
2455
- export interface GetCheckoutResponse {
2504
+ interface GetCheckoutResponse {
2456
2505
  /** Retrieved checkout. */
2457
2506
  checkout?: Checkout;
2458
2507
  }
2459
- export interface GetCheckoutWithAllExtendedFieldsRequest {
2508
+ interface GetCheckoutWithAllExtendedFieldsRequest {
2460
2509
  /**
2461
2510
  * Checkout ID.
2462
2511
  * @format GUID
2463
2512
  */
2464
- id?: string;
2513
+ _id?: string;
2465
2514
  }
2466
- export interface GetCheckoutWithAllExtendedFieldsResponse {
2515
+ interface GetCheckoutWithAllExtendedFieldsResponse {
2467
2516
  /** Retrieved checkout. */
2468
2517
  checkout?: Checkout;
2469
2518
  }
2470
- export interface GetCheckoutByCartIdRequest {
2519
+ interface GetCheckoutByCartIdRequest {
2471
2520
  /**
2472
2521
  * Cart ID.
2473
2522
  * @format GUID
2474
2523
  */
2475
- id: string;
2524
+ _id: string;
2476
2525
  }
2477
- export interface GetCheckoutByCartIdResponse {
2526
+ interface GetCheckoutByCartIdResponse {
2478
2527
  /** Retrieved checkout. */
2479
2528
  checkout?: Checkout;
2480
2529
  }
2481
- export interface GetWixCheckoutURLRequest {
2530
+ interface GetWixCheckoutURLRequest {
2482
2531
  /**
2483
2532
  * Checkout ID.
2484
2533
  * @format GUID
2485
2534
  */
2486
- id: string;
2535
+ _id: string;
2487
2536
  }
2488
- export interface GetWixCheckoutURLResponse {
2537
+ interface GetWixCheckoutURLResponse {
2489
2538
  /** Checkout URL. */
2490
2539
  checkoutUrl?: string;
2491
2540
  }
2492
- export interface GetCheckoutURLRequest {
2541
+ interface GetCheckoutURLRequest {
2493
2542
  /**
2494
2543
  * Checkout ID.
2495
2544
  * @format GUID
2496
2545
  */
2497
- id: string;
2546
+ _id: string;
2498
2547
  }
2499
- export interface GetCheckoutURLResponse {
2548
+ interface GetCheckoutURLResponse {
2500
2549
  /** Checkout URL. */
2501
2550
  checkoutUrl?: string;
2502
2551
  }
2503
- export interface UpdateCheckoutRequest {
2552
+ interface UpdateCheckoutRequest {
2504
2553
  /** Checkout information. */
2505
2554
  checkout: Checkout;
2506
2555
  /**
@@ -2534,49 +2583,49 @@ export interface UpdateCheckoutRequest {
2534
2583
  */
2535
2584
  customLineItems?: CustomLineItem[];
2536
2585
  }
2537
- export interface UpdateCheckoutResponse {
2586
+ interface UpdateCheckoutResponse {
2538
2587
  /** Updated checkout. */
2539
2588
  checkout?: Checkout;
2540
2589
  }
2541
- export interface RemoveCouponRequest {
2590
+ interface RemoveCouponRequest {
2542
2591
  /**
2543
2592
  * ID of the checkout to remove the coupon from.
2544
2593
  * @format GUID
2545
2594
  */
2546
- id: string;
2595
+ _id: string;
2547
2596
  }
2548
- export interface RemoveCouponResponse {
2597
+ interface RemoveCouponResponse {
2549
2598
  /** Updated checkout after removal of coupon. */
2550
2599
  checkout?: Checkout;
2551
2600
  }
2552
- export interface RemoveGiftCardRequest {
2601
+ interface RemoveGiftCardRequest {
2553
2602
  /**
2554
2603
  * ID of the checkout to remove the gift card from.
2555
2604
  * @format GUID
2556
2605
  */
2557
- id: string;
2606
+ _id: string;
2558
2607
  }
2559
- export interface RemoveGiftCardResponse {
2608
+ interface RemoveGiftCardResponse {
2560
2609
  /** Updated checkout after removal of gift card. */
2561
2610
  checkout?: Checkout;
2562
2611
  }
2563
- export interface RemoveOverrideCheckoutUrlRequest {
2612
+ interface RemoveOverrideCheckoutUrlRequest {
2564
2613
  /**
2565
2614
  * ID of the checkout to remove the override checkout url from.
2566
2615
  * @format GUID
2567
2616
  */
2568
- id: string;
2617
+ _id: string;
2569
2618
  }
2570
- export interface RemoveOverrideCheckoutUrlResponse {
2619
+ interface RemoveOverrideCheckoutUrlResponse {
2571
2620
  /** Updated checkout after removal of override checkout url. */
2572
2621
  checkout?: Checkout;
2573
2622
  }
2574
- export interface AddToCheckoutRequest {
2623
+ interface AddToCheckoutRequest {
2575
2624
  /**
2576
2625
  * Checkout ID.
2577
2626
  * @format GUID
2578
2627
  */
2579
- id: string;
2628
+ _id: string;
2580
2629
  /**
2581
2630
  * Catalog line items.
2582
2631
  * @maxSize 100
@@ -2591,16 +2640,16 @@ export interface AddToCheckoutRequest {
2591
2640
  */
2592
2641
  customLineItems?: CustomLineItem[];
2593
2642
  }
2594
- export interface AddToCheckoutResponse {
2643
+ interface AddToCheckoutResponse {
2595
2644
  /** Updated checkout. */
2596
2645
  checkout?: Checkout;
2597
2646
  }
2598
- export interface RemoveLineItemsRequest {
2647
+ interface RemoveLineItemsRequest {
2599
2648
  /**
2600
2649
  * ID of the checkout to remove line items from.
2601
2650
  * @format GUID
2602
2651
  */
2603
- id: string;
2652
+ _id: string;
2604
2653
  /**
2605
2654
  * IDs of the line items to remove from the checkout.
2606
2655
  *
@@ -2613,22 +2662,22 @@ export interface RemoveLineItemsRequest {
2613
2662
  */
2614
2663
  lineItemIds: string[];
2615
2664
  }
2616
- export interface RemoveLineItemsResponse {
2665
+ interface RemoveLineItemsResponse {
2617
2666
  /** Updated checkout after removal of line items. */
2618
2667
  checkout?: Checkout;
2619
2668
  }
2620
- export interface CreateOrderRequest {
2669
+ interface CreateOrderRequest {
2621
2670
  /**
2622
2671
  * Checkout ID.
2623
2672
  * @format GUID
2624
2673
  */
2625
- id: string;
2674
+ _id: string;
2626
2675
  /** Whether the payment method should be saved on the order. */
2627
2676
  savePaymentMethod?: boolean;
2628
2677
  /** Whether to authorize the payment and delay the capture. */
2629
2678
  delayCapture?: boolean;
2630
2679
  }
2631
- export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
2680
+ interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
2632
2681
  /**
2633
2682
  * ID of newly created order.
2634
2683
  * @format GUID
@@ -2652,7 +2701,7 @@ export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
2652
2701
  paymentGatewayOrderId?: string | null;
2653
2702
  }
2654
2703
  /** @oneof */
2655
- export interface CreateOrderResponseIdOneOf {
2704
+ interface CreateOrderResponseIdOneOf {
2656
2705
  /**
2657
2706
  * ID of newly created order.
2658
2707
  * @format GUID
@@ -2664,37 +2713,37 @@ export interface CreateOrderResponseIdOneOf {
2664
2713
  */
2665
2714
  subscriptionId?: string;
2666
2715
  }
2667
- export interface PaymentErrorResponseData {
2716
+ interface PaymentErrorResponseData {
2668
2717
  paymentResponseToken?: string | null;
2669
2718
  transactionStatus?: string;
2670
2719
  failureDetails?: string | null;
2671
2720
  }
2672
- export interface DoublePaymentErrorData extends DoublePaymentErrorDataIdOneOf {
2721
+ interface DoublePaymentErrorData extends DoublePaymentErrorDataIdOneOf {
2673
2722
  /** @format GUID */
2674
2723
  orderId?: string;
2675
2724
  /** @format GUID */
2676
2725
  subscriptionId?: string;
2677
2726
  }
2678
2727
  /** @oneof */
2679
- export interface DoublePaymentErrorDataIdOneOf {
2728
+ interface DoublePaymentErrorDataIdOneOf {
2680
2729
  /** @format GUID */
2681
2730
  orderId?: string;
2682
2731
  /** @format GUID */
2683
2732
  subscriptionId?: string;
2684
2733
  }
2685
- export interface RedeemErrorData {
2734
+ interface RedeemErrorData {
2686
2735
  reason?: string;
2687
2736
  }
2688
- export interface ViolationsList {
2737
+ interface ViolationsList {
2689
2738
  /** Violations risen by ValidationsSPI implementers. */
2690
2739
  violations?: Violation[];
2691
2740
  }
2692
- export interface CreateOrderAndChargeRequest {
2741
+ interface CreateOrderAndChargeRequest {
2693
2742
  /**
2694
2743
  * Checkout ID.
2695
2744
  * @format GUID
2696
2745
  */
2697
- id: string;
2746
+ _id: string;
2698
2747
  /** Payment token. */
2699
2748
  paymentToken?: string | null;
2700
2749
  /** Whether the payment method should be saved on the order. */
@@ -2702,7 +2751,7 @@ export interface CreateOrderAndChargeRequest {
2702
2751
  /** Whether to authorize the payment and delay the capture. */
2703
2752
  delayCapture?: boolean;
2704
2753
  }
2705
- export interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOneOf {
2754
+ interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOneOf {
2706
2755
  /**
2707
2756
  * ID of newly created order.
2708
2757
  * @format GUID
@@ -2723,9 +2772,15 @@ export interface CreateOrderAndChargeResponse extends CreateOrderAndChargeRespon
2723
2772
  * If the total price is not 0, but the payment is covered by alternative payment methods such as gift card
2724
2773
  */
2725
2774
  paymentGatewayOrderId?: string | null;
2775
+ /**
2776
+ * Whether an order was successfully created from this checkout and the payment transaction was completed
2777
+ * @internal
2778
+ * @readonly
2779
+ */
2780
+ checkoutCompleted?: boolean;
2726
2781
  }
2727
2782
  /** @oneof */
2728
- export interface CreateOrderAndChargeResponseIdOneOf {
2783
+ interface CreateOrderAndChargeResponseIdOneOf {
2729
2784
  /**
2730
2785
  * ID of newly created order.
2731
2786
  * @format GUID
@@ -2737,41 +2792,47 @@ export interface CreateOrderAndChargeResponseIdOneOf {
2737
2792
  */
2738
2793
  subscriptionId?: string;
2739
2794
  }
2740
- export interface MarkCheckoutAsCompletedAndRedirectToUrlRequest {
2795
+ interface MarkCheckoutAsCompletedAndRedirectToUrlRequest {
2741
2796
  /**
2742
2797
  * Server-signed JWT token with required information to complete checkout
2743
2798
  * @maxLength 4096
2744
2799
  */
2745
2800
  token: string;
2746
2801
  }
2747
- export interface RawHttpResponse {
2802
+ interface RawHttpResponse {
2748
2803
  body?: Uint8Array;
2749
2804
  statusCode?: number | null;
2750
2805
  headers?: HeadersEntry[];
2751
2806
  }
2752
- export interface HeadersEntry {
2807
+ interface HeadersEntry {
2753
2808
  key?: string;
2754
2809
  value?: string;
2755
2810
  }
2756
- export interface MarkCheckoutAsCompletedRequest {
2811
+ interface MarkCheckoutAsCompletedRequest {
2757
2812
  /**
2758
2813
  * Checkout ID.
2759
2814
  * @format GUID
2760
2815
  */
2761
- id: string;
2816
+ _id: string;
2817
+ /**
2818
+ * Order ID.
2819
+ * @internal
2820
+ * @format GUID
2821
+ */
2822
+ orderId?: string | null;
2762
2823
  }
2763
- export interface MarkCheckoutAsCompletedResponse {
2824
+ interface MarkCheckoutAsCompletedResponse {
2764
2825
  }
2765
2826
  /** Triggered when an order created from this checkout is successfully paid for or when a checkout is marked as completed. */
2766
- export interface CheckoutMarkedAsCompleted {
2827
+ interface CheckoutMarkedAsCompleted {
2767
2828
  checkout?: Checkout;
2768
2829
  }
2769
- export interface UpdateLineItemsQuantityRequest {
2830
+ interface UpdateLineItemsQuantityRequest {
2770
2831
  /**
2771
2832
  * Checkout ID.
2772
2833
  * @format GUID
2773
2834
  */
2774
- id: string;
2835
+ _id: string;
2775
2836
  /**
2776
2837
  * Line item info to update.
2777
2838
  * @minSize 1
@@ -2779,12 +2840,12 @@ export interface UpdateLineItemsQuantityRequest {
2779
2840
  */
2780
2841
  lineItems: LineItemQuantityUpdate[];
2781
2842
  }
2782
- export interface LineItemQuantityUpdate {
2843
+ interface LineItemQuantityUpdate {
2783
2844
  /**
2784
2845
  * ID of the line item to update.
2785
2846
  * @format GUID
2786
2847
  */
2787
- id?: string;
2848
+ _id?: string;
2788
2849
  /**
2789
2850
  * New total amount of the line item,
2790
2851
  * not the amount to add to the current `quantity`.
@@ -2797,44 +2858,44 @@ export interface LineItemQuantityUpdate {
2797
2858
  */
2798
2859
  quantity?: number;
2799
2860
  }
2800
- export interface UpdateLineItemsQuantityResponse {
2861
+ interface UpdateLineItemsQuantityResponse {
2801
2862
  /** Updated checkout. */
2802
2863
  checkout?: Checkout;
2803
2864
  }
2804
- export interface GetCheckoutPaymentSettingsRequest {
2865
+ interface GetCheckoutPaymentSettingsRequest {
2805
2866
  /**
2806
2867
  * Checkout ID.
2807
2868
  * @format GUID
2808
2869
  */
2809
- id: string;
2870
+ _id: string;
2810
2871
  }
2811
- export interface GetCheckoutPaymentSettingsResponse {
2872
+ interface GetCheckoutPaymentSettingsResponse {
2812
2873
  blockedPaymentOptions?: GetCheckoutPaymentSettingsResponsePaymentOptionWithLiterals[];
2813
2874
  }
2814
- export declare enum GetCheckoutPaymentSettingsResponsePaymentOption {
2875
+ declare enum GetCheckoutPaymentSettingsResponsePaymentOption {
2815
2876
  UNKNOWN_PAYMENT_OPTION = "UNKNOWN_PAYMENT_OPTION",
2816
2877
  MANUAL = "MANUAL"
2817
2878
  }
2818
2879
  /** @enumType */
2819
- export type GetCheckoutPaymentSettingsResponsePaymentOptionWithLiterals = GetCheckoutPaymentSettingsResponsePaymentOption | 'UNKNOWN_PAYMENT_OPTION' | 'MANUAL';
2820
- export interface DeleteCheckoutRequest {
2880
+ type GetCheckoutPaymentSettingsResponsePaymentOptionWithLiterals = GetCheckoutPaymentSettingsResponsePaymentOption | 'UNKNOWN_PAYMENT_OPTION' | 'MANUAL';
2881
+ interface DeleteCheckoutRequest {
2821
2882
  /**
2822
2883
  * ID of the checkout to delete.
2823
2884
  * @format GUID
2824
2885
  */
2825
- id?: string;
2886
+ _id?: string;
2826
2887
  }
2827
- export interface DeleteCheckoutResponse {
2888
+ interface DeleteCheckoutResponse {
2828
2889
  }
2829
- export interface SubscriptionCreated {
2890
+ interface SubscriptionCreated {
2830
2891
  subscription?: Subscription;
2831
2892
  }
2832
- export interface Subscription {
2893
+ interface Subscription {
2833
2894
  /**
2834
2895
  * Subscription id (auto-generated upon subscription creation)
2835
2896
  * @readonly
2836
2897
  */
2837
- id?: string;
2898
+ _id?: string;
2838
2899
  /**
2839
2900
  * id of subscription in external system
2840
2901
  * @format GUID
@@ -2893,16 +2954,16 @@ export interface Subscription {
2893
2954
  billingInfo?: BillingInfo;
2894
2955
  }
2895
2956
  /** Buyer Info */
2896
- export interface V1BuyerInfo {
2957
+ interface V1BuyerInfo {
2897
2958
  /**
2898
2959
  * Wix customer ID
2899
2960
  * @format GUID
2900
2961
  */
2901
- id?: string;
2962
+ _id?: string;
2902
2963
  /** Customer type */
2903
2964
  identityType?: IdentityTypeWithLiterals;
2904
2965
  }
2905
- export declare enum IdentityType {
2966
+ declare enum IdentityType {
2906
2967
  UNSPECIFIED_IDENTITY_TYPE = "UNSPECIFIED_IDENTITY_TYPE",
2907
2968
  /** Site member */
2908
2969
  MEMBER = "MEMBER",
@@ -2910,8 +2971,8 @@ export declare enum IdentityType {
2910
2971
  CONTACT = "CONTACT"
2911
2972
  }
2912
2973
  /** @enumType */
2913
- export type IdentityTypeWithLiterals = IdentityType | 'UNSPECIFIED_IDENTITY_TYPE' | 'MEMBER' | 'CONTACT';
2914
- export interface V1LineItem {
2974
+ type IdentityTypeWithLiterals = IdentityType | 'UNSPECIFIED_IDENTITY_TYPE' | 'MEMBER' | 'CONTACT';
2975
+ interface V1LineItem {
2915
2976
  /** Line item ID (auto-generated) */
2916
2977
  index?: number;
2917
2978
  /**
@@ -2940,7 +3001,7 @@ export interface V1LineItem {
2940
3001
  /** Product details */
2941
3002
  productDetails?: ProductDetails;
2942
3003
  }
2943
- export interface OptionSelection {
3004
+ interface OptionSelection {
2944
3005
  /**
2945
3006
  * Option name
2946
3007
  * @maxLength 200
@@ -2952,7 +3013,7 @@ export interface OptionSelection {
2952
3013
  */
2953
3014
  selection?: string;
2954
3015
  }
2955
- export interface CustomTextFieldSelection {
3016
+ interface CustomTextFieldSelection {
2956
3017
  /**
2957
3018
  * Custom text field name
2958
3019
  * @maxLength 100
@@ -2964,7 +3025,7 @@ export interface CustomTextFieldSelection {
2964
3025
  */
2965
3026
  value?: string;
2966
3027
  }
2967
- export interface ChargeDetails {
3028
+ interface ChargeDetails {
2968
3029
  /**
2969
3030
  * price of line item (depends on subscription option)
2970
3031
  * @max 999999999.99
@@ -2993,7 +3054,7 @@ export interface ChargeDetails {
2993
3054
  */
2994
3055
  taxRate?: string | null;
2995
3056
  }
2996
- export interface ProductDetails {
3057
+ interface ProductDetails {
2997
3058
  /**
2998
3059
  * Line item product ID (optional for POS orders)
2999
3060
  * @minLength 1
@@ -3046,7 +3107,7 @@ export interface ProductDetails {
3046
3107
  */
3047
3108
  appId?: string | null;
3048
3109
  }
3049
- export declare enum LineItemType {
3110
+ declare enum LineItemType {
3050
3111
  /** Line item type can't be classified, due to an error */
3051
3112
  UNSPECIFIED_LINE_ITEM_TYPE = "UNSPECIFIED_LINE_ITEM_TYPE",
3052
3113
  /** Physical item type */
@@ -3057,8 +3118,8 @@ export declare enum LineItemType {
3057
3118
  CUSTOM_AMOUNT_ITEM = "CUSTOM_AMOUNT_ITEM"
3058
3119
  }
3059
3120
  /** @enumType */
3060
- export type LineItemTypeWithLiterals = LineItemType | 'UNSPECIFIED_LINE_ITEM_TYPE' | 'PHYSICAL' | 'DIGITAL' | 'CUSTOM_AMOUNT_ITEM';
3061
- export interface MediaItem {
3121
+ type LineItemTypeWithLiterals = LineItemType | 'UNSPECIFIED_LINE_ITEM_TYPE' | 'PHYSICAL' | 'DIGITAL' | 'CUSTOM_AMOUNT_ITEM';
3122
+ interface MediaItem {
3062
3123
  /**
3063
3124
  * Media type
3064
3125
  * @readonly
@@ -3083,7 +3144,7 @@ export interface MediaItem {
3083
3144
  */
3084
3145
  height?: number;
3085
3146
  /** Media ID (for media items previously saved in Wix Media) */
3086
- id?: string | null;
3147
+ _id?: string | null;
3087
3148
  /** Media external URL */
3088
3149
  externalImageUrl?: string | null;
3089
3150
  /**
@@ -3092,15 +3153,15 @@ export interface MediaItem {
3092
3153
  */
3093
3154
  altText?: string | null;
3094
3155
  }
3095
- export declare enum MediaItemType {
3156
+ declare enum MediaItemType {
3096
3157
  /** Media item type can't be classified, due to an error */
3097
3158
  UNSPECIFIED_MEDIA_TYPE_ITEM = "UNSPECIFIED_MEDIA_TYPE_ITEM",
3098
3159
  /** Image item type */
3099
3160
  IMAGE = "IMAGE"
3100
3161
  }
3101
3162
  /** @enumType */
3102
- export type MediaItemTypeWithLiterals = MediaItemType | 'UNSPECIFIED_MEDIA_TYPE_ITEM' | 'IMAGE';
3103
- export interface Totals {
3163
+ type MediaItemTypeWithLiterals = MediaItemType | 'UNSPECIFIED_MEDIA_TYPE_ITEM' | 'IMAGE';
3164
+ interface Totals {
3104
3165
  /**
3105
3166
  * Subtotal of all line items, before tax
3106
3167
  * @max 999999999.99
@@ -3137,7 +3198,7 @@ export interface Totals {
3137
3198
  */
3138
3199
  quantity?: number;
3139
3200
  }
3140
- export interface StoreSettings {
3201
+ interface StoreSettings {
3141
3202
  /**
3142
3203
  * Currency used for pricing in this store
3143
3204
  * @maxLength 3
@@ -3155,7 +3216,7 @@ export interface StoreSettings {
3155
3216
  */
3156
3217
  buyerLanguage?: string | null;
3157
3218
  }
3158
- export interface Address extends AddressAddressLine1OptionsOneOf {
3219
+ interface Address extends AddressAddressLine1OptionsOneOf {
3159
3220
  /**
3160
3221
  * Address line 1 (free text)
3161
3222
  * @maxLength 1000
@@ -3209,7 +3270,7 @@ export interface Address extends AddressAddressLine1OptionsOneOf {
3209
3270
  vatId?: VatId;
3210
3271
  }
3211
3272
  /** @oneof */
3212
- export interface AddressAddressLine1OptionsOneOf {
3273
+ interface AddressAddressLine1OptionsOneOf {
3213
3274
  /**
3214
3275
  * Address line 1 (free text)
3215
3276
  * @maxLength 1000
@@ -3218,7 +3279,7 @@ export interface AddressAddressLine1OptionsOneOf {
3218
3279
  /** Address line 1 (street) */
3219
3280
  street?: Street;
3220
3281
  }
3221
- export interface FullName {
3282
+ interface FullName {
3222
3283
  /**
3223
3284
  * Customer's first name
3224
3285
  * @maxLength 1000
@@ -3230,7 +3291,7 @@ export interface FullName {
3230
3291
  */
3231
3292
  lastName?: string;
3232
3293
  }
3233
- export interface Street {
3294
+ interface Street {
3234
3295
  /**
3235
3296
  * Street number
3236
3297
  * @maxLength 500
@@ -3242,7 +3303,7 @@ export interface Street {
3242
3303
  */
3243
3304
  name?: string;
3244
3305
  }
3245
- export interface VatId {
3306
+ interface VatId {
3246
3307
  /**
3247
3308
  * Customer's tax ID.
3248
3309
  * @maxLength 50
@@ -3256,7 +3317,7 @@ export interface VatId {
3256
3317
  type?: VatTypeWithLiterals;
3257
3318
  }
3258
3319
  /** Brazilian tax info types */
3259
- export declare enum VatType {
3320
+ declare enum VatType {
3260
3321
  /** When the tax info type can't be classified, due to an error */
3261
3322
  UNSPECIFIED_TAX_TYPE = "UNSPECIFIED_TAX_TYPE",
3262
3323
  /** CPF - for individual tax payers */
@@ -3265,8 +3326,8 @@ export declare enum VatType {
3265
3326
  CNPJ = "CNPJ"
3266
3327
  }
3267
3328
  /** @enumType */
3268
- export type VatTypeWithLiterals = VatType | 'UNSPECIFIED_TAX_TYPE' | 'CPF' | 'CNPJ';
3269
- export interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
3329
+ type VatTypeWithLiterals = VatType | 'UNSPECIFIED_TAX_TYPE' | 'CPF' | 'CNPJ';
3330
+ interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
3270
3331
  /** Shipment details (when this object describes shipment) */
3271
3332
  shipmentDetails?: ShipmentDetails;
3272
3333
  /** Pickup details (when this object describes pickup) */
@@ -3283,13 +3344,13 @@ export interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
3283
3344
  estimatedDeliveryTime?: string | null;
3284
3345
  }
3285
3346
  /** @oneof */
3286
- export interface V1ShippingInfoDetailsOneOf {
3347
+ interface V1ShippingInfoDetailsOneOf {
3287
3348
  /** Shipment details (when this object describes shipment) */
3288
3349
  shipmentDetails?: ShipmentDetails;
3289
3350
  /** Pickup details (when this object describes pickup) */
3290
3351
  pickupDetails?: V1PickupDetails;
3291
3352
  }
3292
- export interface ShipmentDetails {
3353
+ interface ShipmentDetails {
3293
3354
  /** Shipping destination address */
3294
3355
  address?: Address;
3295
3356
  /**
@@ -3310,7 +3371,7 @@ export interface ShipmentDetails {
3310
3371
  */
3311
3372
  taxRate?: string | null;
3312
3373
  }
3313
- export interface V1PickupDetails {
3374
+ interface V1PickupDetails {
3314
3375
  /** Pickup address */
3315
3376
  address?: PickupAddress;
3316
3377
  /**
@@ -3319,7 +3380,7 @@ export interface V1PickupDetails {
3319
3380
  */
3320
3381
  pickupInstructions?: string | null;
3321
3382
  }
3322
- export interface PickupAddress {
3383
+ interface PickupAddress {
3323
3384
  /**
3324
3385
  * Country code (2 letters)
3325
3386
  * @format COUNTRY
@@ -3346,7 +3407,7 @@ export interface PickupAddress {
3346
3407
  */
3347
3408
  zipCode?: string;
3348
3409
  }
3349
- export interface AppliedCoupon {
3410
+ interface AppliedCoupon {
3350
3411
  /** Coupon ID */
3351
3412
  couponId?: string;
3352
3413
  /**
@@ -3361,7 +3422,7 @@ export interface AppliedCoupon {
3361
3422
  code?: string;
3362
3423
  }
3363
3424
  /** Custom field */
3364
- export interface V1CustomField {
3425
+ interface V1CustomField {
3365
3426
  /**
3366
3427
  * Free text that the customer entered in the custom field during the checkout process
3367
3428
  * @maxLength 250
@@ -3378,9 +3439,9 @@ export interface V1CustomField {
3378
3439
  */
3379
3440
  translatedTitle?: string;
3380
3441
  }
3381
- export interface V1SubscriptionOptionInfo {
3442
+ interface V1SubscriptionOptionInfo {
3382
3443
  /** @format GUID */
3383
- id?: string | null;
3444
+ _id?: string | null;
3384
3445
  /**
3385
3446
  * @minLength 1
3386
3447
  * @maxLength 20
@@ -3390,33 +3451,33 @@ export interface V1SubscriptionOptionInfo {
3390
3451
  description?: string | null;
3391
3452
  discount?: Discount;
3392
3453
  }
3393
- export interface Discount {
3454
+ interface Discount {
3394
3455
  /** Discount type. */
3395
3456
  type?: DiscountDiscountTypeWithLiterals;
3396
3457
  /** Discount value. */
3397
3458
  value?: number;
3398
3459
  }
3399
- export declare enum DiscountDiscountType {
3460
+ declare enum DiscountDiscountType {
3400
3461
  UNDEFINED = "UNDEFINED",
3401
3462
  /** No discount */
3402
3463
  AMOUNT = "AMOUNT",
3403
3464
  PERCENT = "PERCENT"
3404
3465
  }
3405
3466
  /** @enumType */
3406
- export type DiscountDiscountTypeWithLiterals = DiscountDiscountType | 'UNDEFINED' | 'AMOUNT' | 'PERCENT';
3407
- export interface ChannelInfo {
3467
+ type DiscountDiscountTypeWithLiterals = DiscountDiscountType | 'UNDEFINED' | 'AMOUNT' | 'PERCENT';
3468
+ interface ChannelInfo {
3408
3469
  /** Sales channel that submitted the subscription */
3409
3470
  type?: ChannelInfoChannelTypeWithLiterals;
3410
3471
  }
3411
- export declare enum ChannelInfoChannelType {
3472
+ declare enum ChannelInfoChannelType {
3412
3473
  UNSPECIFIED = "UNSPECIFIED",
3413
3474
  WEB = "WEB",
3414
3475
  OTHER_PLATFORM = "OTHER_PLATFORM",
3415
3476
  WIX_APP_STORE = "WIX_APP_STORE"
3416
3477
  }
3417
3478
  /** @enumType */
3418
- export type ChannelInfoChannelTypeWithLiterals = ChannelInfoChannelType | 'UNSPECIFIED' | 'WEB' | 'OTHER_PLATFORM' | 'WIX_APP_STORE';
3419
- export interface V1SubscriptionSettings {
3479
+ type ChannelInfoChannelTypeWithLiterals = ChannelInfoChannelType | 'UNSPECIFIED' | 'WEB' | 'OTHER_PLATFORM' | 'WIX_APP_STORE';
3480
+ interface V1SubscriptionSettings {
3420
3481
  /** Frequency of recurring payment. */
3421
3482
  frequency?: SubscriptionFrequencyWithLiterals;
3422
3483
  /** Whether subscription is renewed automatically at the end of each period. */
@@ -3428,7 +3489,7 @@ export interface V1SubscriptionSettings {
3428
3489
  */
3429
3490
  billingCycles?: number | null;
3430
3491
  }
3431
- export interface BillingInfo {
3492
+ interface BillingInfo {
3432
3493
  /**
3433
3494
  * Payment method used for this order
3434
3495
  * @maxLength 50
@@ -3445,15 +3506,15 @@ export interface BillingInfo {
3445
3506
  */
3446
3507
  paymentGatewayOrderId?: string | null;
3447
3508
  }
3448
- export interface Empty {
3509
+ interface Empty {
3449
3510
  }
3450
- export interface DomainEvent extends DomainEventBodyOneOf {
3511
+ interface DomainEvent extends DomainEventBodyOneOf {
3451
3512
  createdEvent?: EntityCreatedEvent;
3452
3513
  updatedEvent?: EntityUpdatedEvent;
3453
3514
  deletedEvent?: EntityDeletedEvent;
3454
3515
  actionEvent?: ActionEvent;
3455
3516
  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
3456
- id?: string;
3517
+ _id?: string;
3457
3518
  /**
3458
3519
  * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
3459
3520
  * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
@@ -3482,36 +3543,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
3482
3543
  entityEventSequence?: string | null;
3483
3544
  }
3484
3545
  /** @oneof */
3485
- export interface DomainEventBodyOneOf {
3546
+ interface DomainEventBodyOneOf {
3486
3547
  createdEvent?: EntityCreatedEvent;
3487
3548
  updatedEvent?: EntityUpdatedEvent;
3488
3549
  deletedEvent?: EntityDeletedEvent;
3489
3550
  actionEvent?: ActionEvent;
3490
3551
  }
3491
- export interface EntityCreatedEvent {
3492
- entityAsJson?: string;
3493
- /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
3494
- restoreInfo?: RestoreInfo;
3552
+ interface EntityCreatedEvent {
3553
+ entity?: string;
3495
3554
  }
3496
- export interface RestoreInfo {
3555
+ interface RestoreInfo {
3497
3556
  deletedDate?: Date | null;
3498
3557
  }
3499
- export interface EntityUpdatedEvent {
3558
+ interface EntityUpdatedEvent {
3500
3559
  /**
3501
3560
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
3502
3561
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
3503
3562
  * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
3504
3563
  */
3505
- currentEntityAsJson?: string;
3564
+ currentEntity?: string;
3506
3565
  }
3507
- export interface EntityDeletedEvent {
3566
+ interface EntityDeletedEvent {
3508
3567
  /** Entity that was deleted. */
3509
- deletedEntityAsJson?: string | null;
3568
+ deletedEntity?: string | null;
3510
3569
  }
3511
- export interface ActionEvent {
3512
- bodyAsJson?: string;
3570
+ interface ActionEvent {
3571
+ body?: string;
3513
3572
  }
3514
- export interface MessageEnvelope {
3573
+ interface MessageEnvelope {
3515
3574
  /**
3516
3575
  * App instance ID.
3517
3576
  * @format GUID
@@ -3527,7 +3586,7 @@ export interface MessageEnvelope {
3527
3586
  /** Stringify payload. */
3528
3587
  data?: string;
3529
3588
  }
3530
- export interface IdentificationData extends IdentificationDataIdOneOf {
3589
+ interface IdentificationData extends IdentificationDataIdOneOf {
3531
3590
  /**
3532
3591
  * ID of a site visitor that has not logged in to the site.
3533
3592
  * @format GUID
@@ -3552,7 +3611,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
3552
3611
  identityType?: WebhookIdentityTypeWithLiterals;
3553
3612
  }
3554
3613
  /** @oneof */
3555
- export interface IdentificationDataIdOneOf {
3614
+ interface IdentificationDataIdOneOf {
3556
3615
  /**
3557
3616
  * ID of a site visitor that has not logged in to the site.
3558
3617
  * @format GUID
@@ -3574,7 +3633,7 @@ export interface IdentificationDataIdOneOf {
3574
3633
  */
3575
3634
  appId?: string;
3576
3635
  }
3577
- export declare enum WebhookIdentityType {
3636
+ declare enum WebhookIdentityType {
3578
3637
  UNKNOWN = "UNKNOWN",
3579
3638
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3580
3639
  MEMBER = "MEMBER",
@@ -3582,4 +3641,384 @@ export declare enum WebhookIdentityType {
3582
3641
  APP = "APP"
3583
3642
  }
3584
3643
  /** @enumType */
3585
- export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
3644
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
3645
+ interface BaseEventMetadata {
3646
+ /**
3647
+ * App instance ID.
3648
+ * @format GUID
3649
+ */
3650
+ instanceId?: string | null;
3651
+ /**
3652
+ * Event type.
3653
+ * @maxLength 150
3654
+ */
3655
+ eventType?: string;
3656
+ /** The identification type and identity data. */
3657
+ identity?: IdentificationData;
3658
+ }
3659
+ interface EventMetadata extends BaseEventMetadata {
3660
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
3661
+ _id?: string;
3662
+ /**
3663
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
3664
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
3665
+ */
3666
+ entityFqdn?: string;
3667
+ /**
3668
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
3669
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
3670
+ */
3671
+ slug?: string;
3672
+ /** ID of the entity associated with the event. */
3673
+ entityId?: string;
3674
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
3675
+ eventTime?: Date | null;
3676
+ /**
3677
+ * Whether the event was triggered as a result of a privacy regulation application
3678
+ * (for example, GDPR).
3679
+ */
3680
+ triggeredByAnonymizeRequest?: boolean | null;
3681
+ /** If present, indicates the action that triggered the event. */
3682
+ originatedFrom?: string | null;
3683
+ /**
3684
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
3685
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
3686
+ */
3687
+ entityEventSequence?: string | null;
3688
+ }
3689
+ interface CheckoutCompletedEnvelope {
3690
+ data: CheckoutMarkedAsCompleted;
3691
+ metadata: EventMetadata;
3692
+ }
3693
+ interface CheckoutCreatedEnvelope {
3694
+ entity: Checkout;
3695
+ metadata: EventMetadata;
3696
+ }
3697
+ interface CheckoutUpdatedEnvelope {
3698
+ entity: Checkout;
3699
+ metadata: EventMetadata;
3700
+ }
3701
+ interface CreateCheckoutOptions {
3702
+ /** Checkout information. */
3703
+ checkoutInfo?: Checkout;
3704
+ /** Coupon code. */
3705
+ couponCode?: string | null;
3706
+ /**
3707
+ * Catalog line items to add to the checkout.
3708
+ * @maxSize 300
3709
+ */
3710
+ lineItems?: LineItem[];
3711
+ /**
3712
+ * Custom line items to add to the checkout. Custom line items don't trigger the Catalog service plugin.
3713
+ *
3714
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
3715
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
3716
+ * @maxSize 300
3717
+ */
3718
+ customLineItems?: CustomLineItem[];
3719
+ /** Sales channel that submitted the order. */
3720
+ channelType: ChannelTypeWithLiterals;
3721
+ /**
3722
+ * Gift card code.
3723
+ *
3724
+ * The checkout can only hold 1 `giftCardCode` at a time. If an additional `giftCardCode` is added, it will override the existing `giftCardCode`.
3725
+ *
3726
+ * >**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).
3727
+ */
3728
+ giftCardCode?: string | null;
3729
+ /**
3730
+ * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
3731
+ *
3732
+ * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API
3733
+ * to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
3734
+ * standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
3735
+ * @maxLength 1000
3736
+ */
3737
+ overrideCheckoutUrl?: string | null;
3738
+ }
3739
+ interface UpdateCheckout {
3740
+ /**
3741
+ * Checkout ID.
3742
+ * @format GUID
3743
+ * @readonly
3744
+ */
3745
+ _id?: string | null;
3746
+ /**
3747
+ * Line items.
3748
+ *
3749
+ * Max: 300 items
3750
+ * @minSize 1
3751
+ * @maxSize 300
3752
+ * @readonly
3753
+ */
3754
+ lineItems?: LineItem[];
3755
+ /** Billing information. */
3756
+ billingInfo?: AddressWithContact;
3757
+ /** Shipping information. */
3758
+ shippingInfo?: ShippingInfo;
3759
+ /**
3760
+ * [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer.
3761
+ * @maxLength 1000
3762
+ */
3763
+ buyerNote?: string | null;
3764
+ /** Buyer information. */
3765
+ buyerInfo?: BuyerInfo;
3766
+ /**
3767
+ * The currency selected by the buyer during the purchase flow, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
3768
+ * @readonly
3769
+ * @format CURRENCY
3770
+ */
3771
+ conversionCurrency?: string;
3772
+ /**
3773
+ * Calculated price summary for the checkout.
3774
+ * @readonly
3775
+ */
3776
+ priceSummary?: PriceSummary;
3777
+ /**
3778
+ * Errors when calculating totals.
3779
+ * @readonly
3780
+ */
3781
+ calculationErrors?: CalculationErrors;
3782
+ /**
3783
+ * Applied gift card details.
3784
+ *
3785
+ * >**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).
3786
+ * @readonly
3787
+ */
3788
+ giftCard?: GiftCard;
3789
+ /**
3790
+ * Applied discounts.
3791
+ * @readonly
3792
+ */
3793
+ appliedDiscounts?: AppliedDiscount[];
3794
+ /** Custom fields. */
3795
+ customFields?: CustomField[];
3796
+ /**
3797
+ * Weight measurement unit. Defaults to a site's weight unit.
3798
+ * @readonly
3799
+ */
3800
+ weightUnit?: WeightUnitWithLiterals;
3801
+ /**
3802
+ * Tax summary.
3803
+ * @readonly
3804
+ */
3805
+ taxSummary?: TaxSummary;
3806
+ /**
3807
+ * The site's default currency, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
3808
+ * @format CURRENCY
3809
+ * @readonly
3810
+ */
3811
+ currency?: string;
3812
+ /**
3813
+ * Sales channel that submitted the order.
3814
+ * @readonly
3815
+ */
3816
+ channelType?: ChannelTypeWithLiterals;
3817
+ /**
3818
+ * Site language in which original values are shown.
3819
+ * @readonly
3820
+ */
3821
+ siteLanguage?: string;
3822
+ /**
3823
+ * Language for communication with the buyer. Defaults to the site language.
3824
+ *
3825
+ * For a site that supports multiple languages, this is the language the buyer selected.
3826
+ * @readonly
3827
+ */
3828
+ buyerLanguage?: string;
3829
+ /**
3830
+ * Whether an order was successfully created from this checkout.
3831
+ *
3832
+ * For an order to be successful, it must be successfully paid for (unless the total is 0).
3833
+ * @readonly
3834
+ */
3835
+ completed?: boolean;
3836
+ /**
3837
+ * Whether tax is included in line item prices.
3838
+ * @readonly
3839
+ */
3840
+ taxIncludedInPrice?: boolean;
3841
+ /**
3842
+ * ID of the checkout's initiator.
3843
+ * @readonly
3844
+ */
3845
+ createdBy?: CreatedBy;
3846
+ /**
3847
+ * Date and time the checkout was created.
3848
+ * @readonly
3849
+ */
3850
+ _createdDate?: Date | null;
3851
+ /**
3852
+ * Date and time the checkout was updated.
3853
+ * @readonly
3854
+ */
3855
+ _updatedDate?: Date | null;
3856
+ /**
3857
+ * Minimal amount to pay in order to place the order.
3858
+ * @readonly
3859
+ */
3860
+ payNow?: PriceSummary;
3861
+ /**
3862
+ * Remaining amount for the order to be fully paid.
3863
+ * @readonly
3864
+ */
3865
+ payLater?: PriceSummary;
3866
+ /** Memberships to apply when creating the order. */
3867
+ membershipOptions?: MembershipOptions;
3868
+ /**
3869
+ * Additional Fees.
3870
+ * @maxSize 100
3871
+ */
3872
+ additionalFees?: AdditionalFee[];
3873
+ /**
3874
+ * Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart.
3875
+ * @format GUID
3876
+ */
3877
+ cartId?: string | null;
3878
+ /**
3879
+ * 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)).
3880
+ * @readonly
3881
+ */
3882
+ violations?: Violation[];
3883
+ /**
3884
+ * Custom field data for the checkout object.
3885
+ *
3886
+ * [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.
3887
+ */
3888
+ extendedFields?: ExtendedFields;
3889
+ /**
3890
+ * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
3891
+ * @format GUID
3892
+ * @readonly
3893
+ */
3894
+ purchaseFlowId?: string | null;
3895
+ /**
3896
+ * Additional settings for customization of the checkout process.
3897
+ *
3898
+ * > **Notes:**
3899
+ * > * Custom settings can only be set when creating a checkout.
3900
+ * > * 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).
3901
+ * @immutable
3902
+ */
3903
+ customSettings?: CustomSettings;
3904
+ /**
3905
+ * Reference IDs for the app and component providing custom checkout page content.
3906
+ *
3907
+ * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
3908
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
3909
+ */
3910
+ customContentReference?: CustomContentReference;
3911
+ /**
3912
+ * References to an external app and resource associated with this checkout.
3913
+ * Used for integration and tracking across different platforms.
3914
+ * @immutable
3915
+ */
3916
+ externalReference?: ExternalReference;
3917
+ /**
3918
+ * Order ID.
3919
+ *
3920
+ * This field is empty until the checkout completes and becomes an order.
3921
+ * @internal
3922
+ * @format GUID
3923
+ * @readonly
3924
+ */
3925
+ orderId?: string | null;
3926
+ /**
3927
+ * Payment for subscriptions after free trial period.
3928
+ * @readonly
3929
+ */
3930
+ payAfterFreeTrial?: PriceSummary;
3931
+ /**
3932
+ * The business location ID associated with the checkout.
3933
+ *
3934
+ * To learn more, see the Locations API.
3935
+ * @format GUID
3936
+ */
3937
+ businessLocationId?: string | null;
3938
+ /**
3939
+ * Whether payment is required to create an order.
3940
+ *
3941
+ * Payment is required if any of the following conditions are met:
3942
+ * 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.
3943
+ * 2. The calculated total amount due for immediate payment is greater than zero - `checkout.payNow > 0`.
3944
+ * @internal
3945
+ * @readonly
3946
+ */
3947
+ paymentRequired?: boolean;
3948
+ /**
3949
+ * Charges information for each subscription in the checkout.
3950
+ * @internal
3951
+ * @readonly
3952
+ * @maxSize 100
3953
+ */
3954
+ subscriptionCharges?: SubscriptionCharges[];
3955
+ /**
3956
+ * Currency used for payment, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
3957
+ * @readonly
3958
+ * @format CURRENCY
3959
+ */
3960
+ paymentCurrency?: string;
3961
+ }
3962
+ interface UpdateCheckoutOptions {
3963
+ /**
3964
+ * Coupon code.
3965
+ *
3966
+ * The checkout can only hold 1 `couponCode` at a time. If an additional `couponCode` is added, it will override the existing `couponCode`.
3967
+ */
3968
+ couponCode?: string | null;
3969
+ /** Gift card code. */
3970
+ giftCardCode?: string | null;
3971
+ /**
3972
+ * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
3973
+ *
3974
+ * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API
3975
+ * to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
3976
+ * standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
3977
+ * @maxLength 1000
3978
+ */
3979
+ overrideCheckoutUrl?: string | null;
3980
+ /**
3981
+ * Catalog line items.
3982
+ * @maxSize 300
3983
+ */
3984
+ lineItems?: LineItem[];
3985
+ /**
3986
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
3987
+ *
3988
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
3989
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
3990
+ * @maxSize 300
3991
+ */
3992
+ customLineItems?: CustomLineItem[];
3993
+ }
3994
+ interface AddToCheckoutOptions {
3995
+ /**
3996
+ * Catalog line items.
3997
+ * @maxSize 100
3998
+ */
3999
+ lineItems?: LineItem[];
4000
+ /**
4001
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
4002
+ *
4003
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
4004
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
4005
+ * @maxSize 100
4006
+ */
4007
+ customLineItems?: CustomLineItem[];
4008
+ }
4009
+ interface CreateOrderOptions {
4010
+ /** Whether the payment method should be saved on the order. */
4011
+ savePaymentMethod?: boolean;
4012
+ /** Whether to authorize the payment and delay the capture. */
4013
+ delayCapture?: boolean;
4014
+ }
4015
+ interface CreateOrderAndChargeOptions {
4016
+ /** Payment token. */
4017
+ paymentToken?: string | null;
4018
+ /** Whether the payment method should be saved on the order. */
4019
+ savePaymentMethod?: boolean;
4020
+ /** Whether to authorize the payment and delay the capture. */
4021
+ delayCapture?: boolean;
4022
+ }
4023
+
4024
+ export { ChannelInfoChannelType as $, type AddToCheckoutOptions as A, ChannelType as B, type CreateCheckoutOptions as C, DescriptionLineType as D, AdditionalFeeSource as E, FileType as F, type GetCheckoutByCartIdResponse as G, Severity as H, ItemAvailabilityStatus as I, JurisdictionType as J, NameInLineItem as K, type LineItemQuantityUpdate as L, ManualCalculationReason as M, NameInOther as N, SuggestedFix as O, PaymentOptionType as P, GetCheckoutPaymentSettingsResponsePaymentOption as Q, type RemoveCouponResponse as R, SubscriptionFrequency as S, TaxableAddressType as T, type UpdateCheckout as U, IdentityType as V, WeightUnit as W, LineItemType as X, MediaItemType as Y, VatType as Z, DiscountDiscountType as _, type Checkout as a, type CalculationErrors as a$, WebhookIdentityType as a0, type LineItem as a1, type CatalogReference as a2, type ProductName as a3, type MultiCurrencyPrice as a4, type ItemTaxFullDetails as a5, type TaxRateBreakdown as a6, type TaxBreakdown as a7, type DescriptionLine as a8, type DescriptionLineValueOneOf as a9, type TranslatableString as aA, type ItemModifier as aB, type AddressWithContact as aC, type ApiAddress as aD, type StreetAddress as aE, type AddressLocation as aF, type FullAddressContactDetails as aG, type CommonVatId as aH, type ShippingInfo as aI, type SelectedCarrierServiceOption as aJ, type DeliveryLogistics as aK, type PickupDetails as aL, type DeliveryTimeSlot as aM, type SelectedCarrierServiceOptionPrices as aN, type SelectedCarrierServiceOptionOtherCharge as aO, type DeliveryAllocation as aP, type Carrier as aQ, type Region as aR, type ApplicableLineItems as aS, type ShippingRegion as aT, type CarrierServiceOption as aU, type ShippingOption as aV, type ShippingPrice as aW, type OtherCharge as aX, type BuyerInfo as aY, type BuyerInfoIdOneOf as aZ, type PriceSummary as a_, type DescriptionLineDescriptionLineValueOneOf as aa, type DescriptionLineName as ab, type PlainTextValue as ac, type Color as ad, type FocalPoint as ae, type ItemAvailabilityInfo as af, type PhysicalProperties as ag, type Scope as ah, type Group as ai, type ItemType as aj, type ItemTypeItemTypeDataOneOf as ak, type SubscriptionOptionInfo as al, type SubscriptionSettings as am, type FreeTrialPeriod as an, type Title as ao, type Description as ap, type SecuredMedia as aq, type ServiceProperties as ar, type PriceDescription as as, type CatalogOverrideFields as at, type PaymentOption as au, type TaxableAddress as av, type TaxableAddressTaxableAddressDataOneOf as aw, type ExtendedFields as ax, type Policy as ay, type ModifierGroup as az, type GetWixCheckoutURLResponse as b, type RemoveGiftCardRequest as b$, type CalculationErrorsShippingCalculationErrorOneOf as b0, type Details as b1, type DetailsKindOneOf as b2, type ApplicationError as b3, type ValidationError as b4, type FieldViolation as b5, type SystemError as b6, type CarrierErrors as b7, type CarrierError as b8, type GiftCard as b9, type TargetTargetTypeOneOf as bA, type Other as bB, type TargetLineItem as bC, type CustomSettings as bD, type CustomContentReference as bE, type ExternalReference as bF, type SubscriptionCharges as bG, type Charge as bH, type UpdatedCheckoutMessage as bI, type CreateCheckoutRequest as bJ, type CustomLineItem as bK, type V1ModifierGroup as bL, type V1ItemModifier as bM, type MerchantDiscountInput as bN, type CreateCheckoutResponse as bO, type ShippingCalculationErrorData as bP, type ShippingCalculationErrorDataShippingCalculationErrorOneOf as bQ, type GetCheckoutRequest as bR, type GetCheckoutResponse as bS, type GetCheckoutWithAllExtendedFieldsRequest as bT, type GetCheckoutWithAllExtendedFieldsResponse as bU, type GetCheckoutByCartIdRequest as bV, type GetWixCheckoutURLRequest as bW, type GetCheckoutURLRequest as bX, type UpdateCheckoutRequest as bY, type UpdateCheckoutResponse as bZ, type RemoveCouponRequest as b_, type AppliedDiscount as ba, type AppliedDiscountDiscountSourceOneOf as bb, type Coupon as bc, type MerchantDiscount as bd, type DiscountRule as be, type DiscountRuleName as bf, type LineItemDiscount as bg, type CustomField as bh, type TaxSummary as bi, type TaxCalculationDetails as bj, type TaxCalculationDetailsCalculationDetailsOneOf as bk, type AutoTaxFallbackCalculationDetails as bl, type AggregatedTaxBreakdown as bm, type CreatedBy as bn, type CreatedByIdOneOf as bo, type MembershipOptions as bp, type Membership as bq, type MembershipName as br, type MembershipPaymentCredits as bs, type InvalidMembership as bt, type SelectedMemberships as bu, type SelectedMembership as bv, type AdditionalFee as bw, type ConversionInfo as bx, type Violation as by, type Target as bz, type GetCheckoutURLResponse as c, type RemoveOverrideCheckoutUrlRequest as c0, type AddToCheckoutRequest as c1, type RemoveLineItemsRequest as c2, type CreateOrderRequest as c3, type CreateOrderResponseIdOneOf as c4, type PaymentErrorResponseData as c5, type DoublePaymentErrorData as c6, type DoublePaymentErrorDataIdOneOf as c7, type RedeemErrorData as c8, type ViolationsList as c9, type VatId as cA, type V1ShippingInfo as cB, type V1ShippingInfoDetailsOneOf as cC, type ShipmentDetails as cD, type V1PickupDetails as cE, type PickupAddress as cF, type AppliedCoupon as cG, type V1CustomField as cH, type V1SubscriptionOptionInfo as cI, type Discount as cJ, type ChannelInfo as cK, type V1SubscriptionSettings as cL, type BillingInfo as cM, type Empty as cN, type DomainEvent as cO, type DomainEventBodyOneOf as cP, type EntityCreatedEvent as cQ, type RestoreInfo as cR, type EntityUpdatedEvent as cS, type EntityDeletedEvent as cT, type ActionEvent as cU, type MessageEnvelope as cV, type IdentificationData as cW, type IdentificationDataIdOneOf as cX, type BaseEventMetadata as cY, type EventMetadata as cZ, type CreateOrderAndChargeRequest as ca, type CreateOrderAndChargeResponseIdOneOf as cb, type MarkCheckoutAsCompletedAndRedirectToUrlRequest as cc, type HeadersEntry as cd, type MarkCheckoutAsCompletedRequest as ce, type MarkCheckoutAsCompletedResponse as cf, type CheckoutMarkedAsCompleted as cg, type UpdateLineItemsQuantityRequest as ch, type GetCheckoutPaymentSettingsRequest as ci, type DeleteCheckoutRequest as cj, type DeleteCheckoutResponse as ck, type SubscriptionCreated as cl, type Subscription as cm, type V1BuyerInfo as cn, type V1LineItem as co, type OptionSelection as cp, type CustomTextFieldSelection as cq, type ChargeDetails as cr, type ProductDetails as cs, type MediaItem as ct, type Totals as cu, type StoreSettings as cv, type Address as cw, type AddressAddressLine1OptionsOneOf as cx, type FullName as cy, type Street 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, type CheckoutCompletedEnvelope as p, type CheckoutCreatedEnvelope as q, type CheckoutUpdatedEnvelope as r, ItemTypeItemType as s, CommonVatType as t, PickupMethod as u, ChargeType as v, RuleType as w, DiscountType as x, RateType as y, FallbackReason as z };