@wix/auto_sdk_ecom_checkout-templates 1.0.36 → 1.0.37

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (134) hide show
  1. package/build/{cjs/src/ecom-v1-checkout-template-checkout-templates.types.d.ts → ecom-v1-checkout-template-checkout-templates.universal-DZSQyXAS.d.mts} +400 -276
  2. package/build/{internal/cjs/src/ecom-v1-checkout-template-checkout-templates.types.d.ts → ecom-v1-checkout-template-checkout-templates.universal-DZSQyXAS.d.ts} +400 -276
  3. package/build/index.d.mts +136 -0
  4. package/build/index.d.ts +136 -0
  5. package/build/index.js +1209 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +1149 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/internal/{cjs/src/ecom-v1-checkout-template-checkout-templates.universal.d.ts → ecom-v1-checkout-template-checkout-templates.universal-DQx0Jt-F.d.mts} +209 -450
  10. package/build/internal/{es/src/ecom-v1-checkout-template-checkout-templates.universal.d.ts → ecom-v1-checkout-template-checkout-templates.universal-DQx0Jt-F.d.ts} +209 -450
  11. package/build/internal/index.d.mts +136 -0
  12. package/build/internal/index.d.ts +136 -0
  13. package/build/internal/index.js +1209 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +1149 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +810 -0
  18. package/build/internal/meta.d.ts +810 -0
  19. package/build/internal/meta.js +491 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +458 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +810 -0
  24. package/build/meta.d.ts +810 -0
  25. package/build/meta.js +491 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +458 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +12 -11
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.context.d.ts +0 -32
  40. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.context.js +0 -61
  41. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.context.js.map +0 -1
  42. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.http.d.ts +0 -68
  43. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.http.js +0 -390
  44. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.http.js.map +0 -1
  45. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.meta.d.ts +0 -29
  46. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.meta.js +0 -161
  47. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.meta.js.map +0 -1
  48. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.public.d.ts +0 -112
  49. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.public.js +0 -271
  50. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.public.js.map +0 -1
  51. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.types.js +0 -261
  52. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.types.js.map +0 -1
  53. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.universal.d.ts +0 -3161
  54. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.universal.js +0 -730
  55. package/build/cjs/src/ecom-v1-checkout-template-checkout-templates.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/package.json +0 -3
  66. package/build/es/src/ecom-v1-checkout-template-checkout-templates.context.d.ts +0 -32
  67. package/build/es/src/ecom-v1-checkout-template-checkout-templates.context.js +0 -32
  68. package/build/es/src/ecom-v1-checkout-template-checkout-templates.context.js.map +0 -1
  69. package/build/es/src/ecom-v1-checkout-template-checkout-templates.http.d.ts +0 -68
  70. package/build/es/src/ecom-v1-checkout-template-checkout-templates.http.js +0 -380
  71. package/build/es/src/ecom-v1-checkout-template-checkout-templates.http.js.map +0 -1
  72. package/build/es/src/ecom-v1-checkout-template-checkout-templates.meta.d.ts +0 -29
  73. package/build/es/src/ecom-v1-checkout-template-checkout-templates.meta.js +0 -128
  74. package/build/es/src/ecom-v1-checkout-template-checkout-templates.meta.js.map +0 -1
  75. package/build/es/src/ecom-v1-checkout-template-checkout-templates.public.d.ts +0 -112
  76. package/build/es/src/ecom-v1-checkout-template-checkout-templates.public.js +0 -235
  77. package/build/es/src/ecom-v1-checkout-template-checkout-templates.public.js.map +0 -1
  78. package/build/es/src/ecom-v1-checkout-template-checkout-templates.types.d.ts +0 -2794
  79. package/build/es/src/ecom-v1-checkout-template-checkout-templates.types.js +0 -258
  80. package/build/es/src/ecom-v1-checkout-template-checkout-templates.types.js.map +0 -1
  81. package/build/es/src/ecom-v1-checkout-template-checkout-templates.universal.d.ts +0 -3161
  82. package/build/es/src/ecom-v1-checkout-template-checkout-templates.universal.js +0 -697
  83. package/build/es/src/ecom-v1-checkout-template-checkout-templates.universal.js.map +0 -1
  84. package/build/internal/cjs/index.d.ts +0 -1
  85. package/build/internal/cjs/index.js +0 -18
  86. package/build/internal/cjs/index.js.map +0 -1
  87. package/build/internal/cjs/index.typings.d.ts +0 -1
  88. package/build/internal/cjs/index.typings.js +0 -18
  89. package/build/internal/cjs/index.typings.js.map +0 -1
  90. package/build/internal/cjs/meta.d.ts +0 -1
  91. package/build/internal/cjs/meta.js +0 -18
  92. package/build/internal/cjs/meta.js.map +0 -1
  93. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.context.d.ts +0 -32
  94. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.context.js +0 -61
  95. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.context.js.map +0 -1
  96. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.http.d.ts +0 -68
  97. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.http.js +0 -390
  98. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.http.js.map +0 -1
  99. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.meta.d.ts +0 -29
  100. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.meta.js +0 -161
  101. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.meta.js.map +0 -1
  102. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.public.d.ts +0 -112
  103. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.public.js +0 -271
  104. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.public.js.map +0 -1
  105. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.types.js +0 -261
  106. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.types.js.map +0 -1
  107. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.universal.js +0 -730
  108. package/build/internal/cjs/src/ecom-v1-checkout-template-checkout-templates.universal.js.map +0 -1
  109. package/build/internal/es/index.d.ts +0 -1
  110. package/build/internal/es/index.js +0 -2
  111. package/build/internal/es/index.js.map +0 -1
  112. package/build/internal/es/index.typings.d.ts +0 -1
  113. package/build/internal/es/index.typings.js +0 -2
  114. package/build/internal/es/index.typings.js.map +0 -1
  115. package/build/internal/es/meta.d.ts +0 -1
  116. package/build/internal/es/meta.js +0 -2
  117. package/build/internal/es/meta.js.map +0 -1
  118. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.context.d.ts +0 -32
  119. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.context.js +0 -32
  120. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.context.js.map +0 -1
  121. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.http.d.ts +0 -68
  122. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.http.js +0 -380
  123. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.http.js.map +0 -1
  124. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.meta.d.ts +0 -29
  125. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.meta.js +0 -128
  126. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.meta.js.map +0 -1
  127. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.public.d.ts +0 -112
  128. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.public.js +0 -235
  129. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.public.js.map +0 -1
  130. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.types.d.ts +0 -2794
  131. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.types.js +0 -258
  132. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.types.js.map +0 -1
  133. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.universal.js +0 -697
  134. package/build/internal/es/src/ecom-v1-checkout-template-checkout-templates.universal.js.map +0 -1
@@ -1,5 +1,4 @@
1
- import { NonNullablePaths } from '@wix/sdk-types';
2
- export interface CheckoutTemplate {
1
+ interface CheckoutTemplate {
3
2
  /**
4
3
  * Checkout template ID.
5
4
  * @format GUID
@@ -51,14 +50,14 @@ export interface CheckoutTemplate {
51
50
  */
52
51
  externalReference?: ExternalReference;
53
52
  }
54
- export declare enum Status {
53
+ declare enum Status {
55
54
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
56
55
  ACTIVE = "ACTIVE",
57
56
  INACTIVE = "INACTIVE"
58
57
  }
59
58
  /** @enumType */
60
- export type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'ACTIVE' | 'INACTIVE';
61
- export interface CheckoutCustomization {
59
+ type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'ACTIVE' | 'INACTIVE';
60
+ interface CheckoutCustomization {
62
61
  /** Web client customizations. These customizations only apply to the standard Wix checkout page. */
63
62
  webClient?: WebClientCustomization;
64
63
  /**
@@ -80,7 +79,7 @@ export interface CheckoutCustomization {
80
79
  */
81
80
  disabledManualPayment?: boolean;
82
81
  }
83
- export interface WebClientCustomization {
82
+ interface WebClientCustomization {
84
83
  /**
85
84
  * Whether to disable the "Continue shopping" button.
86
85
  *
@@ -94,7 +93,7 @@ export interface WebClientCustomization {
94
93
  */
95
94
  disabledPolicyAgreementCheckbox?: boolean;
96
95
  }
97
- export interface V1LineItem {
96
+ interface V1LineItem {
98
97
  /**
99
98
  * Item quantity.
100
99
  *
@@ -110,7 +109,7 @@ export interface V1LineItem {
110
109
  catalogOverrideFields?: CatalogOverrideFields;
111
110
  }
112
111
  /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
113
- export interface CatalogReference {
112
+ interface CatalogReference {
114
113
  /**
115
114
  * ID of the item within the catalog it belongs to.
116
115
  * @minLength 1
@@ -136,7 +135,7 @@ export interface CatalogReference {
136
135
  */
137
136
  options?: Record<string, any> | null;
138
137
  }
139
- export interface CatalogOverrideFields {
138
+ interface CatalogOverrideFields {
140
139
  /** Item name. */
141
140
  productName?: ProductName;
142
141
  /**
@@ -173,7 +172,7 @@ export interface CatalogOverrideFields {
173
172
  */
174
173
  savePaymentMethod?: boolean | null;
175
174
  }
176
- export interface ProductName {
175
+ interface ProductName {
177
176
  /**
178
177
  * __Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
179
178
  *
@@ -194,7 +193,7 @@ export interface ProductName {
194
193
  */
195
194
  translated?: string | null;
196
195
  }
197
- export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
196
+ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
198
197
  /** Description line plain text value. */
199
198
  plainText?: PlainTextValue;
200
199
  /** Description line color value. */
@@ -208,16 +207,16 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
208
207
  modifierDescriptionLine?: boolean;
209
208
  }
210
209
  /** @oneof */
211
- export interface DescriptionLineValueOneOf {
210
+ interface DescriptionLineValueOneOf {
212
211
  /** Description line plain text value. */
213
212
  plainText?: PlainTextValue;
214
213
  /** Description line color value. */
215
214
  colorInfo?: Color;
216
215
  }
217
216
  /** @oneof */
218
- export interface DescriptionLineDescriptionLineValueOneOf {
217
+ interface DescriptionLineDescriptionLineValueOneOf {
219
218
  }
220
- export interface DescriptionLineName {
219
+ interface DescriptionLineName {
221
220
  /**
222
221
  * 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).
223
222
  * @maxLength 100
@@ -231,7 +230,7 @@ export interface DescriptionLineName {
231
230
  */
232
231
  translated?: string | null;
233
232
  }
234
- export interface PlainTextValue {
233
+ interface PlainTextValue {
235
234
  /**
236
235
  * 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).
237
236
  * @maxLength 600
@@ -245,7 +244,7 @@ export interface PlainTextValue {
245
244
  */
246
245
  translated?: string | null;
247
246
  }
248
- export interface Color {
247
+ interface Color {
249
248
  /**
250
249
  * 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).
251
250
  * @maxLength 500
@@ -261,7 +260,7 @@ export interface Color {
261
260
  /** HEX or RGB color code for display. */
262
261
  code?: string | null;
263
262
  }
264
- export declare enum DescriptionLineType {
263
+ declare enum DescriptionLineType {
265
264
  /** Unrecognized type. */
266
265
  UNRECOGNISED = "UNRECOGNISED",
267
266
  /** Plain text type. */
@@ -269,9 +268,7 @@ export declare enum DescriptionLineType {
269
268
  /** Color type. */
270
269
  COLOR = "COLOR"
271
270
  }
272
- /** @enumType */
273
- export type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
274
- export interface PhysicalProperties {
271
+ interface PhysicalProperties {
275
272
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
276
273
  weight?: number | null;
277
274
  /**
@@ -282,7 +279,7 @@ export interface PhysicalProperties {
282
279
  /** Whether this line item is shippable. */
283
280
  shippable?: boolean;
284
281
  }
285
- export interface PaymentOption {
282
+ interface PaymentOption {
286
283
  /**
287
284
  * Type of selected payment option for current item.
288
285
  *
@@ -291,7 +288,7 @@ export interface PaymentOption {
291
288
  value?: PaymentOptionTypeWithLiterals;
292
289
  }
293
290
  /** Type of selected payment option for catalog item */
294
- export declare enum PaymentOptionType {
291
+ declare enum PaymentOptionType {
295
292
  /** The entire payment for this item happens as part of the checkout. */
296
293
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
297
294
  /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
@@ -304,8 +301,8 @@ export declare enum PaymentOptionType {
304
301
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
305
302
  }
306
303
  /** @enumType */
307
- export type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
308
- export interface CustomLineItem {
304
+ type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
305
+ interface CustomLineItem {
309
306
  /**
310
307
  * Custom line item quantity.
311
308
  *
@@ -455,7 +452,7 @@ export interface CustomLineItem {
455
452
  */
456
453
  modifierGroups?: V1ModifierGroup[];
457
454
  }
458
- export interface PriceDescription {
455
+ interface PriceDescription {
459
456
  /**
460
457
  * __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).
461
458
  * @minLength 1
@@ -471,20 +468,20 @@ export interface PriceDescription {
471
468
  */
472
469
  translated?: string | null;
473
470
  }
474
- export interface ItemType extends ItemTypeItemTypeDataOneOf {
471
+ interface ItemType extends ItemTypeItemTypeDataOneOf {
475
472
  /** Preset item type. */
476
473
  preset?: ItemTypeItemTypeWithLiterals;
477
474
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
478
475
  custom?: string;
479
476
  }
480
477
  /** @oneof */
481
- export interface ItemTypeItemTypeDataOneOf {
478
+ interface ItemTypeItemTypeDataOneOf {
482
479
  /** Preset item type. */
483
480
  preset?: ItemTypeItemTypeWithLiterals;
484
481
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
485
482
  custom?: string;
486
483
  }
487
- export declare enum ItemTypeItemType {
484
+ declare enum ItemTypeItemType {
488
485
  UNRECOGNISED = "UNRECOGNISED",
489
486
  PHYSICAL = "PHYSICAL",
490
487
  DIGITAL = "DIGITAL",
@@ -492,8 +489,8 @@ export declare enum ItemTypeItemType {
492
489
  SERVICE = "SERVICE"
493
490
  }
494
491
  /** @enumType */
495
- export type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
496
- export interface SubscriptionOptionInfo {
492
+ type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
493
+ interface SubscriptionOptionInfo {
497
494
  /** Subscription option settings. */
498
495
  subscriptionSettings?: SubscriptionSettings;
499
496
  /** Subscription option title. */
@@ -501,7 +498,7 @@ export interface SubscriptionOptionInfo {
501
498
  /** Subscription option description. */
502
499
  description?: Description;
503
500
  }
504
- export interface SubscriptionSettings {
501
+ interface SubscriptionSettings {
505
502
  /** Frequency of recurring payment. */
506
503
  frequency?: SubscriptionFrequencyWithLiterals;
507
504
  /**
@@ -534,7 +531,7 @@ export interface SubscriptionSettings {
534
531
  startDate?: Date | null;
535
532
  }
536
533
  /** Frequency unit of recurring payment */
537
- export declare enum SubscriptionFrequency {
534
+ declare enum SubscriptionFrequency {
538
535
  UNDEFINED = "UNDEFINED",
539
536
  DAY = "DAY",
540
537
  WEEK = "WEEK",
@@ -542,8 +539,8 @@ export declare enum SubscriptionFrequency {
542
539
  YEAR = "YEAR"
543
540
  }
544
541
  /** @enumType */
545
- export type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
546
- export interface FreeTrialPeriod {
542
+ type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
543
+ interface FreeTrialPeriod {
547
544
  /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
548
545
  frequency?: SubscriptionFrequencyWithLiterals;
549
546
  /**
@@ -553,7 +550,7 @@ export interface FreeTrialPeriod {
553
550
  */
554
551
  interval?: number;
555
552
  }
556
- export interface Title {
553
+ interface Title {
557
554
  /**
558
555
  * 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).
559
556
  * @minLength 1
@@ -569,7 +566,7 @@ export interface Title {
569
566
  */
570
567
  translated?: string | null;
571
568
  }
572
- export interface Description {
569
+ interface Description {
573
570
  /**
574
571
  * Subscription option description.
575
572
  * @maxLength 500
@@ -581,7 +578,7 @@ export interface Description {
581
578
  */
582
579
  translated?: string | null;
583
580
  }
584
- export interface SecuredMedia {
581
+ interface SecuredMedia {
585
582
  /**
586
583
  * Media ID in Wix Media Manager.
587
584
  * @minLength 1
@@ -597,7 +594,7 @@ export interface SecuredMedia {
597
594
  /** File type. */
598
595
  fileType?: FileTypeWithLiterals;
599
596
  }
600
- export declare enum FileType {
597
+ declare enum FileType {
601
598
  UNSPECIFIED = "UNSPECIFIED",
602
599
  SECURE_PICTURE = "SECURE_PICTURE",
603
600
  SECURE_VIDEO = "SECURE_VIDEO",
@@ -606,8 +603,8 @@ export declare enum FileType {
606
603
  SECURE_ARCHIVE = "SECURE_ARCHIVE"
607
604
  }
608
605
  /** @enumType */
609
- export type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
610
- export interface ServiceProperties {
606
+ type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
607
+ interface ServiceProperties {
611
608
  /**
612
609
  * 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.
613
610
  * For example, the start time of a class.
@@ -620,7 +617,7 @@ export interface ServiceProperties {
620
617
  */
621
618
  numberOfParticipants?: number | null;
622
619
  }
623
- export interface Policy {
620
+ interface Policy {
624
621
  /**
625
622
  * Policy title - should be translated
626
623
  * @minLength 1
@@ -634,24 +631,24 @@ export interface Policy {
634
631
  */
635
632
  content?: string;
636
633
  }
637
- export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
634
+ interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
638
635
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
639
636
  addressType?: TaxableAddressTypeWithLiterals;
640
637
  }
641
638
  /** @oneof */
642
- export interface TaxableAddressTaxableAddressDataOneOf {
639
+ interface TaxableAddressTaxableAddressDataOneOf {
643
640
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
644
641
  addressType?: TaxableAddressTypeWithLiterals;
645
642
  }
646
- export declare enum TaxableAddressType {
643
+ declare enum TaxableAddressType {
647
644
  UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
648
645
  BUSINESS = "BUSINESS",
649
646
  BILLING = "BILLING",
650
647
  SHIPPING = "SHIPPING"
651
648
  }
652
649
  /** @enumType */
653
- export type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
654
- export interface V1ModifierGroup {
650
+ type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
651
+ interface V1ModifierGroup {
655
652
  /**
656
653
  * Modifier group id.
657
654
  * @minLength 1
@@ -667,7 +664,7 @@ export interface V1ModifierGroup {
667
664
  */
668
665
  modifiers?: V1ItemModifier[];
669
666
  }
670
- export interface TranslatableString {
667
+ interface TranslatableString {
671
668
  /**
672
669
  * __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).
673
670
  *
@@ -688,7 +685,7 @@ export interface TranslatableString {
688
685
  */
689
686
  translated?: string | null;
690
687
  }
691
- export interface V1ItemModifier {
688
+ interface V1ItemModifier {
692
689
  /**
693
690
  * Modifier ID.
694
691
  * @minLength 1
@@ -711,7 +708,7 @@ export interface V1ItemModifier {
711
708
  */
712
709
  price?: string | null;
713
710
  }
714
- export interface ExtendedFields {
711
+ interface ExtendedFields {
715
712
  /**
716
713
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
717
714
  * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -722,7 +719,7 @@ export interface ExtendedFields {
722
719
  */
723
720
  namespaces?: Record<string, Record<string, any>>;
724
721
  }
725
- export interface CustomContentReference {
722
+ interface CustomContentReference {
726
723
  /**
727
724
  * ID of the app providing the content.
728
725
  *
@@ -738,7 +735,7 @@ export interface CustomContentReference {
738
735
  */
739
736
  componentId?: string;
740
737
  }
741
- export interface ExternalReference {
738
+ interface ExternalReference {
742
739
  /**
743
740
  * ID of the app associated with the purchase flow.
744
741
  * For example, the Wix Pay Links app ID.
@@ -756,13 +753,13 @@ export interface ExternalReference {
756
753
  resourceId?: string | null;
757
754
  }
758
755
  /** Triggered when newly checkout created successfully from checkout template */
759
- export interface CheckoutTemplateUsed {
756
+ interface CheckoutTemplateUsed {
760
757
  /** checkout template */
761
758
  checkoutTemplate?: CheckoutTemplate;
762
759
  /** newly created checkout */
763
760
  checkout?: Checkout;
764
761
  }
765
- export interface Checkout {
762
+ interface Checkout {
766
763
  /**
767
764
  * Checkout ID.
768
765
  * @format GUID
@@ -985,7 +982,7 @@ export interface Checkout {
985
982
  */
986
983
  paymentCurrency?: string;
987
984
  }
988
- export interface LineItem {
985
+ interface LineItem {
989
986
  /**
990
987
  * Line item ID.
991
988
  * @format GUID
@@ -1200,7 +1197,7 @@ export interface LineItem {
1200
1197
  */
1201
1198
  modifiersTotalPrice?: MultiCurrencyPrice;
1202
1199
  }
1203
- export interface MultiCurrencyPrice {
1200
+ interface MultiCurrencyPrice {
1204
1201
  /**
1205
1202
  * Amount.
1206
1203
  * @decimalValue options { gte:0, lte:1000000000000000 }
@@ -1223,7 +1220,7 @@ export interface MultiCurrencyPrice {
1223
1220
  */
1224
1221
  formattedConvertedAmount?: string;
1225
1222
  }
1226
- export interface ItemTaxFullDetails {
1223
+ interface ItemTaxFullDetails {
1227
1224
  /** Amount for which tax is calculated. */
1228
1225
  taxableAmount?: MultiCurrencyPrice;
1229
1226
  /**
@@ -1240,7 +1237,7 @@ export interface ItemTaxFullDetails {
1240
1237
  */
1241
1238
  rateBreakdown?: TaxRateBreakdown[];
1242
1239
  }
1243
- export interface TaxRateBreakdown {
1240
+ interface TaxRateBreakdown {
1244
1241
  /**
1245
1242
  * Name of tax against which the calculation was performed.
1246
1243
  * @maxLength 100
@@ -1258,7 +1255,7 @@ export interface TaxRateBreakdown {
1258
1255
  * TaxBreakdown represents tax information for a line item.
1259
1256
  * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
1260
1257
  */
1261
- export interface TaxBreakdown {
1258
+ interface TaxBreakdown {
1262
1259
  /**
1263
1260
  * The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
1264
1261
  * @maxLength 200
@@ -1290,7 +1287,7 @@ export interface TaxBreakdown {
1290
1287
  jurisdictionType?: JurisdictionTypeWithLiterals;
1291
1288
  }
1292
1289
  /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
1293
- export declare enum JurisdictionType {
1290
+ declare enum JurisdictionType {
1294
1291
  UNDEFINED = "UNDEFINED",
1295
1292
  COUNTRY = "COUNTRY",
1296
1293
  STATE = "STATE",
@@ -1299,8 +1296,8 @@ export declare enum JurisdictionType {
1299
1296
  SPECIAL = "SPECIAL"
1300
1297
  }
1301
1298
  /** @enumType */
1302
- export type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
1303
- export interface FocalPoint {
1299
+ type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
1300
+ interface FocalPoint {
1304
1301
  /** X-coordinate of the focal point. */
1305
1302
  x?: number;
1306
1303
  /** Y-coordinate of the focal point. */
@@ -1310,13 +1307,13 @@ export interface FocalPoint {
1310
1307
  /** crop by width */
1311
1308
  width?: number | null;
1312
1309
  }
1313
- export interface ItemAvailabilityInfo {
1310
+ interface ItemAvailabilityInfo {
1314
1311
  /** Item availability status. */
1315
1312
  status?: ItemAvailabilityStatusWithLiterals;
1316
1313
  /** Quantity available. */
1317
1314
  quantityAvailable?: number | null;
1318
1315
  }
1319
- export declare enum ItemAvailabilityStatus {
1316
+ declare enum ItemAvailabilityStatus {
1320
1317
  AVAILABLE = "AVAILABLE",
1321
1318
  /** Item does not exist. */
1322
1319
  NOT_FOUND = "NOT_FOUND",
@@ -1326,20 +1323,20 @@ export declare enum ItemAvailabilityStatus {
1326
1323
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
1327
1324
  }
1328
1325
  /** @enumType */
1329
- export type ItemAvailabilityStatusWithLiterals = ItemAvailabilityStatus | 'AVAILABLE' | 'NOT_FOUND' | 'NOT_AVAILABLE' | 'PARTIALLY_AVAILABLE';
1330
- export interface Scope {
1326
+ type ItemAvailabilityStatusWithLiterals = ItemAvailabilityStatus | 'AVAILABLE' | 'NOT_FOUND' | 'NOT_AVAILABLE' | 'PARTIALLY_AVAILABLE';
1327
+ interface Scope {
1331
1328
  /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
1332
1329
  namespace?: string;
1333
1330
  /** Coupon scope's applied group (e.g., event or ticket in Wix Events) */
1334
1331
  group?: Group;
1335
1332
  }
1336
- export interface Group {
1333
+ interface Group {
1337
1334
  /** 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). */
1338
1335
  name?: string;
1339
1336
  /** Item ID (when the coupon scope is limited to just one item). */
1340
1337
  entityId?: string | null;
1341
1338
  }
1342
- export interface ModifierGroup {
1339
+ interface ModifierGroup {
1343
1340
  /**
1344
1341
  * Modifier group id.
1345
1342
  * @minLength 1
@@ -1355,7 +1352,7 @@ export interface ModifierGroup {
1355
1352
  */
1356
1353
  modifiers?: ItemModifier[];
1357
1354
  }
1358
- export interface ItemModifier {
1355
+ interface ItemModifier {
1359
1356
  /**
1360
1357
  * Modifier ID.
1361
1358
  * @minLength 1
@@ -1376,14 +1373,14 @@ export interface ItemModifier {
1376
1373
  price?: MultiCurrencyPrice;
1377
1374
  }
1378
1375
  /** Billing Info and shipping details */
1379
- export interface AddressWithContact {
1376
+ interface AddressWithContact {
1380
1377
  /** Address. */
1381
1378
  address?: Address;
1382
1379
  /** Contact details. */
1383
1380
  contactDetails?: FullAddressContactDetails;
1384
1381
  }
1385
1382
  /** Physical address */
1386
- export interface Address {
1383
+ interface Address {
1387
1384
  /**
1388
1385
  * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
1389
1386
  * @format COUNTRY
@@ -1427,20 +1424,20 @@ export interface Address {
1427
1424
  */
1428
1425
  subdivisionFullname?: string | null;
1429
1426
  }
1430
- export interface StreetAddress {
1427
+ interface StreetAddress {
1431
1428
  /** Street number. */
1432
1429
  number?: string;
1433
1430
  /** Street name. */
1434
1431
  name?: string;
1435
1432
  }
1436
- export interface AddressLocation {
1433
+ interface AddressLocation {
1437
1434
  /** Address latitude. */
1438
1435
  latitude?: number | null;
1439
1436
  /** Address longitude. */
1440
1437
  longitude?: number | null;
1441
1438
  }
1442
1439
  /** Full contact details for an address */
1443
- export interface FullAddressContactDetails {
1440
+ interface FullAddressContactDetails {
1444
1441
  /**
1445
1442
  * First name.
1446
1443
  * @maxLength 100
@@ -1464,7 +1461,7 @@ export interface FullAddressContactDetails {
1464
1461
  /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
1465
1462
  vatId?: VatId;
1466
1463
  }
1467
- export interface VatId {
1464
+ interface VatId {
1468
1465
  /** Customer's tax ID. */
1469
1466
  _id?: string;
1470
1467
  /**
@@ -1477,7 +1474,7 @@ export interface VatId {
1477
1474
  type?: VatTypeWithLiterals;
1478
1475
  }
1479
1476
  /** tax info types */
1480
- export declare enum VatType {
1477
+ declare enum VatType {
1481
1478
  UNSPECIFIED = "UNSPECIFIED",
1482
1479
  /** CPF - for individual tax payers. */
1483
1480
  CPF = "CPF",
@@ -1485,8 +1482,8 @@ export declare enum VatType {
1485
1482
  CNPJ = "CNPJ"
1486
1483
  }
1487
1484
  /** @enumType */
1488
- export type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
1489
- export interface ShippingInfo {
1485
+ type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
1486
+ interface ShippingInfo {
1490
1487
  /** Shipping address and contact details. */
1491
1488
  shippingDestination?: AddressWithContact;
1492
1489
  /** Selected option out of the options allowed for the `region`. */
@@ -1502,7 +1499,7 @@ export interface ShippingInfo {
1502
1499
  */
1503
1500
  carrierServiceOptions?: CarrierServiceOption[];
1504
1501
  }
1505
- export interface SelectedCarrierServiceOption {
1502
+ interface SelectedCarrierServiceOption {
1506
1503
  /**
1507
1504
  * Unique identifier of selected option. For example, "usps_std_overnight".
1508
1505
  * @maxLength 100
@@ -1550,7 +1547,7 @@ export interface SelectedCarrierServiceOption {
1550
1547
  /** If the delivery solution is a partial and doesn't apply to all items. */
1551
1548
  partial?: boolean | null;
1552
1549
  }
1553
- export interface DeliveryLogistics {
1550
+ interface DeliveryLogistics {
1554
1551
  /**
1555
1552
  * Expected delivery time, in free text. For example, "3-5 business days".
1556
1553
  * @maxLength 500
@@ -1564,7 +1561,7 @@ export interface DeliveryLogistics {
1564
1561
  /** Pickup details. */
1565
1562
  pickupDetails?: PickupDetails;
1566
1563
  }
1567
- export interface PickupDetails {
1564
+ interface PickupDetails {
1568
1565
  /** Pickup address. */
1569
1566
  address?: Address;
1570
1567
  /**
@@ -1575,20 +1572,20 @@ export interface PickupDetails {
1575
1572
  /** Pickup method */
1576
1573
  pickupMethod?: PickupMethodWithLiterals;
1577
1574
  }
1578
- export declare enum PickupMethod {
1575
+ declare enum PickupMethod {
1579
1576
  UNKNOWN_METHOD = "UNKNOWN_METHOD",
1580
1577
  STORE_PICKUP = "STORE_PICKUP",
1581
1578
  PICKUP_POINT = "PICKUP_POINT"
1582
1579
  }
1583
1580
  /** @enumType */
1584
- export type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
1585
- export interface DeliveryTimeSlot {
1581
+ type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
1582
+ interface DeliveryTimeSlot {
1586
1583
  /** starting time of the delivery time slot */
1587
1584
  from?: Date | null;
1588
1585
  /** ending time of the delivery time slot */
1589
1586
  to?: Date | null;
1590
1587
  }
1591
- export interface SelectedCarrierServiceOptionPrices {
1588
+ interface SelectedCarrierServiceOptionPrices {
1592
1589
  /** Total shipping price, after discount and after tax. */
1593
1590
  totalPriceAfterTax?: MultiCurrencyPrice;
1594
1591
  /** Total price of shipping after discounts (when relevant), and before tax. */
@@ -1600,7 +1597,7 @@ export interface SelectedCarrierServiceOptionPrices {
1600
1597
  /** Shipping price before discount and before tax. */
1601
1598
  price?: MultiCurrencyPrice;
1602
1599
  }
1603
- export interface SelectedCarrierServiceOptionOtherCharge {
1600
+ interface SelectedCarrierServiceOptionOtherCharge {
1604
1601
  /** Type of additional cost. */
1605
1602
  type?: ChargeTypeWithLiterals;
1606
1603
  /**
@@ -1611,13 +1608,13 @@ export interface SelectedCarrierServiceOptionOtherCharge {
1611
1608
  /** Price of added charge. */
1612
1609
  cost?: SelectedCarrierServiceOptionPrices;
1613
1610
  }
1614
- export declare enum ChargeType {
1611
+ declare enum ChargeType {
1615
1612
  HANDLING_FEE = "HANDLING_FEE",
1616
1613
  INSURANCE = "INSURANCE"
1617
1614
  }
1618
1615
  /** @enumType */
1619
- export type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE' | 'INSURANCE';
1620
- export interface DeliveryAllocation {
1616
+ type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE' | 'INSURANCE';
1617
+ interface DeliveryAllocation {
1621
1618
  /** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
1622
1619
  deliveryCarrier?: Carrier;
1623
1620
  /** The delivery region that are relevant for this delivery solution. */
@@ -1625,7 +1622,7 @@ export interface DeliveryAllocation {
1625
1622
  /** Populated if the delivery solution is a partially supplied by this carrier. */
1626
1623
  applicableLineItems?: ApplicableLineItems;
1627
1624
  }
1628
- export interface Carrier {
1625
+ interface Carrier {
1629
1626
  /**
1630
1627
  * The carrier app id
1631
1628
  * @format GUID
@@ -1637,7 +1634,7 @@ export interface Carrier {
1637
1634
  */
1638
1635
  code?: string;
1639
1636
  }
1640
- export interface Region {
1637
+ interface Region {
1641
1638
  /**
1642
1639
  * The delivery region id.
1643
1640
  * @format GUID
@@ -1649,7 +1646,7 @@ export interface Region {
1649
1646
  */
1650
1647
  name?: string | null;
1651
1648
  }
1652
- export interface ApplicableLineItems {
1649
+ interface ApplicableLineItems {
1653
1650
  /**
1654
1651
  * Line items that the delivery solution is for.
1655
1652
  * @maxSize 300
@@ -1658,7 +1655,7 @@ export interface ApplicableLineItems {
1658
1655
  */
1659
1656
  lineItemIds?: string[];
1660
1657
  }
1661
- export interface ShippingRegion {
1658
+ interface ShippingRegion {
1662
1659
  /**
1663
1660
  * Shipping region ID.
1664
1661
  * @format GUID
@@ -1671,7 +1668,7 @@ export interface ShippingRegion {
1671
1668
  */
1672
1669
  name?: string;
1673
1670
  }
1674
- export interface CarrierServiceOption {
1671
+ interface CarrierServiceOption {
1675
1672
  /**
1676
1673
  * Carrier ID.
1677
1674
  * @format GUID
@@ -1680,7 +1677,7 @@ export interface CarrierServiceOption {
1680
1677
  /** Shipping options offered by this carrier for this request. */
1681
1678
  shippingOptions?: ShippingOption[];
1682
1679
  }
1683
- export interface ShippingOption {
1680
+ interface ShippingOption {
1684
1681
  /**
1685
1682
  * Unique code of provided shipping option like "usps_std_overnight".
1686
1683
  * For legacy calculators this would be the UUID of the option.
@@ -1705,13 +1702,13 @@ export interface ShippingOption {
1705
1702
  /** If the delivery solution is a partial and doesn't apply to all items. */
1706
1703
  partial?: boolean | null;
1707
1704
  }
1708
- export interface ShippingPrice {
1705
+ interface ShippingPrice {
1709
1706
  /** Shipping price. */
1710
1707
  price?: MultiCurrencyPrice;
1711
1708
  /** Other costs such as insurance, handling & packaging for fragile items, etc. */
1712
1709
  otherCharges?: OtherCharge[];
1713
1710
  }
1714
- export interface OtherCharge {
1711
+ interface OtherCharge {
1715
1712
  /** Type of additional cost. */
1716
1713
  type?: ChargeTypeWithLiterals;
1717
1714
  /** Price of added cost. */
@@ -1722,7 +1719,7 @@ export interface OtherCharge {
1722
1719
  */
1723
1720
  details?: string | null;
1724
1721
  }
1725
- export interface BuyerInfo extends BuyerInfoIdOneOf {
1722
+ interface BuyerInfo extends BuyerInfoIdOneOf {
1726
1723
  /**
1727
1724
  * Visitor ID (if site visitor is **not** a member).
1728
1725
  * @format GUID
@@ -1748,7 +1745,7 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
1748
1745
  email?: string | null;
1749
1746
  }
1750
1747
  /** @oneof */
1751
- export interface BuyerInfoIdOneOf {
1748
+ interface BuyerInfoIdOneOf {
1752
1749
  /**
1753
1750
  * Visitor ID (if site visitor is **not** a member).
1754
1751
  * @format GUID
@@ -1762,7 +1759,7 @@ export interface BuyerInfoIdOneOf {
1762
1759
  */
1763
1760
  memberId?: string;
1764
1761
  }
1765
- export interface PriceSummary {
1762
+ interface PriceSummary {
1766
1763
  /** Subtotal of all line items, before discounts and before tax. */
1767
1764
  subtotal?: MultiCurrencyPrice;
1768
1765
  /** Total shipping price, before discounts and before tax. */
@@ -1776,7 +1773,7 @@ export interface PriceSummary {
1776
1773
  /** Total additional fees price before tax. */
1777
1774
  additionalFees?: MultiCurrencyPrice;
1778
1775
  }
1779
- export interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
1776
+ interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
1780
1777
  /** General shipping calculation error. */
1781
1778
  generalShippingCalculationError?: Details;
1782
1779
  /** Carrier errors. */
@@ -1798,13 +1795,13 @@ export interface CalculationErrors extends CalculationErrorsShippingCalculationE
1798
1795
  discountsCalculationError?: Details;
1799
1796
  }
1800
1797
  /** @oneof */
1801
- export interface CalculationErrorsShippingCalculationErrorOneOf {
1798
+ interface CalculationErrorsShippingCalculationErrorOneOf {
1802
1799
  /** General shipping calculation error. */
1803
1800
  generalShippingCalculationError?: Details;
1804
1801
  /** Carrier errors. */
1805
1802
  carrierErrors?: CarrierErrors;
1806
1803
  }
1807
- export interface Details extends DetailsKindOneOf {
1804
+ interface Details extends DetailsKindOneOf {
1808
1805
  applicationError?: ApplicationError;
1809
1806
  validationError?: ValidationError;
1810
1807
  systemError?: SystemError;
@@ -1815,12 +1812,12 @@ export interface Details extends DetailsKindOneOf {
1815
1812
  tracing?: Record<string, string>;
1816
1813
  }
1817
1814
  /** @oneof */
1818
- export interface DetailsKindOneOf {
1815
+ interface DetailsKindOneOf {
1819
1816
  applicationError?: ApplicationError;
1820
1817
  validationError?: ValidationError;
1821
1818
  systemError?: SystemError;
1822
1819
  }
1823
- export interface ApplicationError {
1820
+ interface ApplicationError {
1824
1821
  /** Error code. */
1825
1822
  code?: string;
1826
1823
  /** Description of the error. */
@@ -1860,10 +1857,10 @@ export interface ApplicationError {
1860
1857
  * ]
1861
1858
  * }
1862
1859
  */
1863
- export interface ValidationError {
1860
+ interface ValidationError {
1864
1861
  fieldViolations?: FieldViolation[];
1865
1862
  }
1866
- export declare enum RuleType {
1863
+ declare enum RuleType {
1867
1864
  VALIDATION = "VALIDATION",
1868
1865
  OTHER = "OTHER",
1869
1866
  MAX = "MAX",
@@ -1887,8 +1884,8 @@ export declare enum RuleType {
1887
1884
  REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
1888
1885
  }
1889
1886
  /** @enumType */
1890
- 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';
1891
- export interface FieldViolation {
1887
+ 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';
1888
+ interface FieldViolation {
1892
1889
  field?: string;
1893
1890
  description?: string;
1894
1891
  violatedRule?: RuleTypeWithLiterals;
@@ -1896,21 +1893,21 @@ export interface FieldViolation {
1896
1893
  ruleName?: string | null;
1897
1894
  data?: Record<string, any> | null;
1898
1895
  }
1899
- export interface SystemError {
1896
+ interface SystemError {
1900
1897
  /** Error code. */
1901
1898
  errorCode?: string | null;
1902
1899
  }
1903
- export interface CarrierErrors {
1900
+ interface CarrierErrors {
1904
1901
  /** Carrier errors. */
1905
1902
  errors?: CarrierError[];
1906
1903
  }
1907
- export interface CarrierError {
1904
+ interface CarrierError {
1908
1905
  /** Carrier ID. */
1909
1906
  carrierId?: string;
1910
1907
  /** Error details. */
1911
1908
  error?: Details;
1912
1909
  }
1913
- export interface GiftCard {
1910
+ interface GiftCard {
1914
1911
  /**
1915
1912
  * Gift Card ID.
1916
1913
  * @deprecated
@@ -1933,7 +1930,7 @@ export interface GiftCard {
1933
1930
  */
1934
1931
  externalId?: string | null;
1935
1932
  }
1936
- export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1933
+ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1937
1934
  /** Coupon details. */
1938
1935
  coupon?: Coupon;
1939
1936
  /** Merchant discount. */
@@ -1960,7 +1957,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1960
1957
  subscriptionCycles?: number | null;
1961
1958
  }
1962
1959
  /** @oneof */
1963
- export interface AppliedDiscountDiscountSourceOneOf {
1960
+ interface AppliedDiscountDiscountSourceOneOf {
1964
1961
  /** Coupon details. */
1965
1962
  coupon?: Coupon;
1966
1963
  /** Merchant discount. */
@@ -1968,15 +1965,15 @@ export interface AppliedDiscountDiscountSourceOneOf {
1968
1965
  /** Discount rule */
1969
1966
  discountRule?: DiscountRule;
1970
1967
  }
1971
- export declare enum DiscountType {
1968
+ declare enum DiscountType {
1972
1969
  GLOBAL = "GLOBAL",
1973
1970
  SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
1974
1971
  SHIPPING = "SHIPPING"
1975
1972
  }
1976
1973
  /** @enumType */
1977
- export type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
1974
+ type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
1978
1975
  /** Coupon */
1979
- export interface Coupon {
1976
+ interface Coupon {
1980
1977
  /** Coupon ID. */
1981
1978
  _id?: string;
1982
1979
  /** Coupon code. */
@@ -1986,7 +1983,7 @@ export interface Coupon {
1986
1983
  /** Coupon name. */
1987
1984
  name?: string;
1988
1985
  }
1989
- export interface MerchantDiscount {
1986
+ interface MerchantDiscount {
1990
1987
  /** Discount value. */
1991
1988
  amount?: MultiCurrencyPrice;
1992
1989
  /**
@@ -1996,7 +1993,7 @@ export interface MerchantDiscount {
1996
1993
  */
1997
1994
  percentage?: number | null;
1998
1995
  }
1999
- export interface DiscountRule {
1996
+ interface DiscountRule {
2000
1997
  /**
2001
1998
  * Discount rule ID
2002
1999
  * @format GUID
@@ -2007,7 +2004,7 @@ export interface DiscountRule {
2007
2004
  /** Discount value. */
2008
2005
  amount?: MultiCurrencyPrice;
2009
2006
  }
2010
- export interface DiscountRuleName {
2007
+ interface DiscountRuleName {
2011
2008
  /**
2012
2009
  * Original discount rule name (in site's default language).
2013
2010
  * @minLength 1
@@ -2021,7 +2018,7 @@ export interface DiscountRuleName {
2021
2018
  */
2022
2019
  translated?: string | null;
2023
2020
  }
2024
- export interface LineItemDiscount {
2021
+ interface LineItemDiscount {
2025
2022
  /**
2026
2023
  * ID of line item the discount applies to.
2027
2024
  * @format GUID
@@ -2030,7 +2027,7 @@ export interface LineItemDiscount {
2030
2027
  /** Discount value. */
2031
2028
  totalDiscountAmount?: MultiCurrencyPrice;
2032
2029
  }
2033
- export interface CustomField {
2030
+ interface CustomField {
2034
2031
  /** Custom field value. */
2035
2032
  value?: any;
2036
2033
  /**
@@ -2046,7 +2043,7 @@ export interface CustomField {
2046
2043
  */
2047
2044
  translatedTitle?: string | null;
2048
2045
  }
2049
- export declare enum WeightUnit {
2046
+ declare enum WeightUnit {
2050
2047
  /** Weight unit can't be classified due to an error. */
2051
2048
  UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
2052
2049
  /** Kilograms. */
@@ -2055,8 +2052,8 @@ export declare enum WeightUnit {
2055
2052
  LB = "LB"
2056
2053
  }
2057
2054
  /** @enumType */
2058
- export type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
2059
- export interface TaxSummary {
2055
+ type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
2056
+ interface TaxSummary {
2060
2057
  /**
2061
2058
  * Amount for which tax is calculated, added from line items.
2062
2059
  * @readonly
@@ -2073,7 +2070,7 @@ export interface TaxSummary {
2073
2070
  */
2074
2071
  calculationDetails?: TaxCalculationDetails;
2075
2072
  }
2076
- export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
2073
+ interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
2077
2074
  /** Reason the manual calculation was used. */
2078
2075
  manualRateReason?: ManualCalculationReasonWithLiterals;
2079
2076
  /** Details of the fallback rate calculation. */
@@ -2082,13 +2079,13 @@ export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationD
2082
2079
  rateType?: RateTypeWithLiterals;
2083
2080
  }
2084
2081
  /** @oneof */
2085
- export interface TaxCalculationDetailsCalculationDetailsOneOf {
2082
+ interface TaxCalculationDetailsCalculationDetailsOneOf {
2086
2083
  /** Reason the manual calculation was used. */
2087
2084
  manualRateReason?: ManualCalculationReasonWithLiterals;
2088
2085
  /** Details of the fallback rate calculation. */
2089
2086
  autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
2090
2087
  }
2091
- export declare enum RateType {
2088
+ declare enum RateType {
2092
2089
  /** no tax being collected for this request due to location of purchase */
2093
2090
  NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
2094
2091
  /** manual rate used for calculation */
@@ -2099,34 +2096,34 @@ export declare enum RateType {
2099
2096
  FALLBACK_RATE = "FALLBACK_RATE"
2100
2097
  }
2101
2098
  /** @enumType */
2102
- export type RateTypeWithLiterals = RateType | 'NO_TAX_COLLECTED' | 'MANUAL_RATE' | 'AUTO_RATE' | 'FALLBACK_RATE';
2103
- export declare enum ManualCalculationReason {
2099
+ type RateTypeWithLiterals = RateType | 'NO_TAX_COLLECTED' | 'MANUAL_RATE' | 'AUTO_RATE' | 'FALLBACK_RATE';
2100
+ declare enum ManualCalculationReason {
2104
2101
  /** user set calculator in Business Manager to be Manual */
2105
2102
  GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
2106
2103
  /** specific region is on manual even though Global setting is Auto-tax */
2107
2104
  REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
2108
2105
  }
2109
2106
  /** @enumType */
2110
- export type ManualCalculationReasonWithLiterals = ManualCalculationReason | 'GLOBAL_SETTING_TO_MANUAL' | 'REGION_SETTING_TO_MANUAL';
2111
- export interface AutoTaxFallbackCalculationDetails {
2107
+ type ManualCalculationReasonWithLiterals = ManualCalculationReason | 'GLOBAL_SETTING_TO_MANUAL' | 'REGION_SETTING_TO_MANUAL';
2108
+ interface AutoTaxFallbackCalculationDetails {
2112
2109
  /** reason for fallback */
2113
2110
  fallbackReason?: FallbackReasonWithLiterals;
2114
2111
  /** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
2115
2112
  error?: ApplicationError;
2116
2113
  }
2117
- export declare enum FallbackReason {
2114
+ declare enum FallbackReason {
2118
2115
  /** auto-tax failed to be calculated */
2119
2116
  AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
2120
2117
  /** auto-tax was temporarily deactivated on a system-level */
2121
2118
  AUTO_TAX_DEACTIVATED = "AUTO_TAX_DEACTIVATED"
2122
2119
  }
2123
2120
  /** @enumType */
2124
- export type FallbackReasonWithLiterals = FallbackReason | 'AUTO_TAX_FAILED' | 'AUTO_TAX_DEACTIVATED';
2121
+ type FallbackReasonWithLiterals = FallbackReason | 'AUTO_TAX_FAILED' | 'AUTO_TAX_DEACTIVATED';
2125
2122
  /**
2126
2123
  * 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.
2127
2124
  * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
2128
2125
  */
2129
- export interface AggregatedTaxBreakdown {
2126
+ interface AggregatedTaxBreakdown {
2130
2127
  /**
2131
2128
  * The name of the tax against which this tax amount was calculated.
2132
2129
  * @maxLength 200
@@ -2152,7 +2149,7 @@ export interface AggregatedTaxBreakdown {
2152
2149
  /** The sum of all the tax from line items that calculated by the tax identifiers. */
2153
2150
  aggregatedTaxAmount?: MultiCurrencyPrice;
2154
2151
  }
2155
- export declare enum ChannelType {
2152
+ declare enum ChannelType {
2156
2153
  /** Unspecified sales channel. This value is not supported. */
2157
2154
  UNSPECIFIED = "UNSPECIFIED",
2158
2155
  /** A web client. */
@@ -2187,8 +2184,8 @@ export declare enum ChannelType {
2187
2184
  FAIRE_COM = "FAIRE_COM"
2188
2185
  }
2189
2186
  /** @enumType */
2190
- 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';
2191
- export interface CreatedBy extends CreatedByIdOneOf {
2187
+ 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';
2188
+ interface CreatedBy extends CreatedByIdOneOf {
2192
2189
  /**
2193
2190
  * User ID. When the order was created by a Wix user on behalf of a buyer.
2194
2191
  * For example, via POS (point of service).
@@ -2212,7 +2209,7 @@ export interface CreatedBy extends CreatedByIdOneOf {
2212
2209
  appId?: string;
2213
2210
  }
2214
2211
  /** @oneof */
2215
- export interface CreatedByIdOneOf {
2212
+ interface CreatedByIdOneOf {
2216
2213
  /**
2217
2214
  * User ID. When the order was created by a Wix user on behalf of a buyer.
2218
2215
  * For example, via POS (point of service).
@@ -2236,7 +2233,7 @@ export interface CreatedByIdOneOf {
2236
2233
  appId?: string;
2237
2234
  }
2238
2235
  /** Reserved for internal use. */
2239
- export interface MembershipOptions {
2236
+ interface MembershipOptions {
2240
2237
  /**
2241
2238
  * Reserved for internal use.
2242
2239
  * @readonly
@@ -2252,7 +2249,7 @@ export interface MembershipOptions {
2252
2249
  /** Selected membership to apply to this checkout. */
2253
2250
  selectedMemberships?: SelectedMemberships;
2254
2251
  }
2255
- export interface Membership {
2252
+ interface Membership {
2256
2253
  /**
2257
2254
  * Membership ID.
2258
2255
  * @minLength 1
@@ -2281,7 +2278,7 @@ export interface Membership {
2281
2278
  /** Additional data about this membership. */
2282
2279
  additionalData?: Record<string, any> | null;
2283
2280
  }
2284
- export interface MembershipName {
2281
+ interface MembershipName {
2285
2282
  /**
2286
2283
  * Membership name.
2287
2284
  * @maxLength 100
@@ -2293,7 +2290,7 @@ export interface MembershipName {
2293
2290
  */
2294
2291
  translated?: string | null;
2295
2292
  }
2296
- export interface MembershipPaymentCredits {
2293
+ interface MembershipPaymentCredits {
2297
2294
  /**
2298
2295
  * Membership's total amount of credits.
2299
2296
  * @min 1
@@ -2302,7 +2299,7 @@ export interface MembershipPaymentCredits {
2302
2299
  /** Membership's remaining amount of credits. */
2303
2300
  remaining?: number;
2304
2301
  }
2305
- export interface InvalidMembership {
2302
+ interface InvalidMembership {
2306
2303
  /** Membership details. */
2307
2304
  membership?: Membership;
2308
2305
  /**
@@ -2312,14 +2309,14 @@ export interface InvalidMembership {
2312
2309
  */
2313
2310
  reason?: string;
2314
2311
  }
2315
- export interface SelectedMemberships {
2312
+ interface SelectedMemberships {
2316
2313
  /**
2317
2314
  * Selected memberships.
2318
2315
  * @maxSize 300
2319
2316
  */
2320
2317
  memberships?: SelectedMembership[];
2321
2318
  }
2322
- export interface SelectedMembership {
2319
+ interface SelectedMembership {
2323
2320
  /**
2324
2321
  * Membership ID.
2325
2322
  * @minLength 1
@@ -2340,7 +2337,7 @@ export interface SelectedMembership {
2340
2337
  */
2341
2338
  lineItemIds?: string[];
2342
2339
  }
2343
- export interface AdditionalFee {
2340
+ interface AdditionalFee {
2344
2341
  /**
2345
2342
  * Additional fee's unique code (or ID) for future processing.
2346
2343
  * @minLength 1
@@ -2384,7 +2381,7 @@ export interface AdditionalFee {
2384
2381
  /** the source the additional fee was added from */
2385
2382
  source?: AdditionalFeeSourceWithLiterals;
2386
2383
  }
2387
- export declare enum AdditionalFeeSource {
2384
+ declare enum AdditionalFeeSource {
2388
2385
  UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
2389
2386
  /** The additional fee was added by an additional fee service plugin */
2390
2387
  SERVICE_PLUGIN = "SERVICE_PLUGIN",
@@ -2396,8 +2393,8 @@ export declare enum AdditionalFeeSource {
2396
2393
  SHIPPING = "SHIPPING"
2397
2394
  }
2398
2395
  /** @enumType */
2399
- export type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING';
2400
- export interface ConversionInfo {
2396
+ type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING';
2397
+ interface ConversionInfo {
2401
2398
  /**
2402
2399
  * The site currency.
2403
2400
  * @readonly
@@ -2411,7 +2408,7 @@ export interface ConversionInfo {
2411
2408
  */
2412
2409
  conversionRate?: string;
2413
2410
  }
2414
- export interface Violation {
2411
+ interface Violation {
2415
2412
  /** 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. */
2416
2413
  severity?: SeverityWithLiterals;
2417
2414
  /** Target location on a checkout or cart page where the violation will be displayed. */
@@ -2423,7 +2420,7 @@ export interface Violation {
2423
2420
  */
2424
2421
  description?: string | null;
2425
2422
  }
2426
- export declare enum Severity {
2423
+ declare enum Severity {
2427
2424
  /** The user is allowed to move forward in the flow. */
2428
2425
  WARNING = "WARNING",
2429
2426
  /**
@@ -2433,49 +2430,49 @@ export declare enum Severity {
2433
2430
  ERROR = "ERROR"
2434
2431
  }
2435
2432
  /** @enumType */
2436
- export type SeverityWithLiterals = Severity | 'WARNING' | 'ERROR';
2437
- export interface Target extends TargetTargetTypeOneOf {
2433
+ type SeverityWithLiterals = Severity | 'WARNING' | 'ERROR';
2434
+ interface Target extends TargetTargetTypeOneOf {
2438
2435
  /** General (other) violation. */
2439
2436
  other?: Other;
2440
2437
  /** Specific line item violation. */
2441
2438
  lineItem?: TargetLineItem;
2442
2439
  }
2443
2440
  /** @oneof */
2444
- export interface TargetTargetTypeOneOf {
2441
+ interface TargetTargetTypeOneOf {
2445
2442
  /** General (other) violation. */
2446
2443
  other?: Other;
2447
2444
  /** Specific line item violation. */
2448
2445
  lineItem?: TargetLineItem;
2449
2446
  }
2450
2447
  /** Available locations on the webpage */
2451
- export declare enum NameInOther {
2448
+ declare enum NameInOther {
2452
2449
  /** Default location, in case no specific location is specified. */
2453
2450
  OTHER_DEFAULT = "OTHER_DEFAULT"
2454
2451
  }
2455
2452
  /** @enumType */
2456
- export type NameInOtherWithLiterals = NameInOther | 'OTHER_DEFAULT';
2453
+ type NameInOtherWithLiterals = NameInOther | 'OTHER_DEFAULT';
2457
2454
  /** Available locations on the line item */
2458
- export declare enum NameInLineItem {
2455
+ declare enum NameInLineItem {
2459
2456
  /** Default location, in case no specific location is specified. */
2460
2457
  LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
2461
2458
  }
2462
2459
  /** @enumType */
2463
- export type NameInLineItemWithLiterals = NameInLineItem | 'LINE_ITEM_DEFAULT';
2464
- export declare enum SuggestedFix {
2460
+ type NameInLineItemWithLiterals = NameInLineItem | 'LINE_ITEM_DEFAULT';
2461
+ declare enum SuggestedFix {
2465
2462
  /** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
2466
2463
  UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
2467
2464
  /** The line item should be removed from the cart or checkout to resolve the violation. */
2468
2465
  REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
2469
2466
  }
2470
2467
  /** @enumType */
2471
- export type SuggestedFixWithLiterals = SuggestedFix | 'UNKNOWN_SUGGESTED_FIX' | 'REMOVE_LINE_ITEM';
2468
+ type SuggestedFixWithLiterals = SuggestedFix | 'UNKNOWN_SUGGESTED_FIX' | 'REMOVE_LINE_ITEM';
2472
2469
  /** General (other) violation. */
2473
- export interface Other {
2470
+ interface Other {
2474
2471
  /** Location on a checkout or a cart page where a general (other) violation will be displayed. */
2475
2472
  name?: NameInOtherWithLiterals;
2476
2473
  }
2477
2474
  /** Specific line item violation. */
2478
- export interface TargetLineItem {
2475
+ interface TargetLineItem {
2479
2476
  /** Location on a checkout or a cart page where the specific line item violation will be displayed. */
2480
2477
  name?: NameInLineItemWithLiterals;
2481
2478
  /** ID of the line item containing the violation. */
@@ -2486,7 +2483,7 @@ export interface TargetLineItem {
2486
2483
  */
2487
2484
  suggestedFix?: SuggestedFixWithLiterals;
2488
2485
  }
2489
- export interface CustomSettings {
2486
+ interface CustomSettings {
2490
2487
  /**
2491
2488
  * Whether to restrict the option to add or remove a gift card on the checkout page.
2492
2489
  *
@@ -2512,7 +2509,7 @@ export interface CustomSettings {
2512
2509
  */
2513
2510
  disabledManualPayment?: boolean;
2514
2511
  }
2515
- export interface SubscriptionCharges {
2512
+ interface SubscriptionCharges {
2516
2513
  /**
2517
2514
  * ids of the items the subscription is defined on
2518
2515
  * @format GUID
@@ -2532,7 +2529,7 @@ export interface SubscriptionCharges {
2532
2529
  */
2533
2530
  charges?: Charge[];
2534
2531
  }
2535
- export interface Charge {
2532
+ interface Charge {
2536
2533
  /** The cycle number from which the charge starts. */
2537
2534
  cycleFrom?: number;
2538
2535
  /** The number of cycles for which the charge is applicable. */
@@ -2542,47 +2539,47 @@ export interface Charge {
2542
2539
  /** The billing date from which the charge starts. */
2543
2540
  cycleBillingDate?: Date | null;
2544
2541
  }
2545
- export interface CreateCheckoutTemplateRequest {
2542
+ interface CreateCheckoutTemplateRequest {
2546
2543
  /** Checkout template to create. */
2547
2544
  checkoutTemplate: CheckoutTemplate;
2548
2545
  }
2549
- export interface CreateCheckoutTemplateResponse {
2546
+ interface CreateCheckoutTemplateResponse {
2550
2547
  /** Created checkout template. */
2551
2548
  checkoutTemplate?: CheckoutTemplate;
2552
2549
  }
2553
- export interface GetCheckoutTemplateRequest {
2550
+ interface GetCheckoutTemplateRequest {
2554
2551
  /**
2555
2552
  * ID of the checkout template to retrieve.
2556
2553
  * @format GUID
2557
2554
  */
2558
2555
  checkoutTemplateId: string;
2559
2556
  }
2560
- export interface GetCheckoutTemplateResponse {
2557
+ interface GetCheckoutTemplateResponse {
2561
2558
  /** Retrieved checkout template. */
2562
2559
  checkoutTemplate?: CheckoutTemplate;
2563
2560
  }
2564
- export interface UpdateCheckoutTemplateRequest {
2561
+ interface UpdateCheckoutTemplateRequest {
2565
2562
  /** Checkout template info to update. */
2566
2563
  checkoutTemplate: CheckoutTemplate;
2567
2564
  }
2568
- export interface UpdateCheckoutTemplateResponse {
2565
+ interface UpdateCheckoutTemplateResponse {
2569
2566
  /** Updated checkout template. */
2570
2567
  checkoutTemplate?: CheckoutTemplate;
2571
2568
  }
2572
- export interface DeleteCheckoutTemplateRequest {
2569
+ interface DeleteCheckoutTemplateRequest {
2573
2570
  /**
2574
2571
  * ID of the checkout template to delete.
2575
2572
  * @format GUID
2576
2573
  */
2577
2574
  checkoutTemplateId: string;
2578
2575
  }
2579
- export interface DeleteCheckoutTemplateResponse {
2576
+ interface DeleteCheckoutTemplateResponse {
2580
2577
  }
2581
- export interface QueryCheckoutTemplatesRequest {
2578
+ interface QueryCheckoutTemplatesRequest {
2582
2579
  /** Query options. */
2583
2580
  query?: CursorQuery;
2584
2581
  }
2585
- export interface CursorQuery extends CursorQueryPagingMethodOneOf {
2582
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
2586
2583
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
2587
2584
  cursorPaging?: CursorPaging;
2588
2585
  /**
@@ -2602,25 +2599,25 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
2602
2599
  sort?: Sorting[];
2603
2600
  }
2604
2601
  /** @oneof */
2605
- export interface CursorQueryPagingMethodOneOf {
2602
+ interface CursorQueryPagingMethodOneOf {
2606
2603
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
2607
2604
  cursorPaging?: CursorPaging;
2608
2605
  }
2609
- export interface Sorting {
2606
+ interface Sorting {
2610
2607
  /** Name of the field to sort by. */
2611
2608
  fieldName?: string;
2612
2609
  /** Sort order. */
2613
2610
  order?: SortOrderWithLiterals;
2614
2611
  }
2615
- export declare enum SortOrder {
2612
+ declare enum SortOrder {
2616
2613
  /** Ascending order. */
2617
2614
  ASC = "ASC",
2618
2615
  /** Descending order. */
2619
2616
  DESC = "DESC"
2620
2617
  }
2621
2618
  /** @enumType */
2622
- export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
2623
- export interface CursorPaging {
2619
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
2620
+ interface CursorPaging {
2624
2621
  /**
2625
2622
  * Number of items to load.
2626
2623
  * @max 100
@@ -2635,13 +2632,13 @@ export interface CursorPaging {
2635
2632
  */
2636
2633
  cursor?: string | null;
2637
2634
  }
2638
- export interface QueryCheckoutTemplatesResponse {
2635
+ interface QueryCheckoutTemplatesResponse {
2639
2636
  /** Retrieved checkout templates. */
2640
2637
  checkoutTemplates?: CheckoutTemplate[];
2641
2638
  /** Paging metadata. */
2642
2639
  pagingMetadata?: CursorPagingMetadata;
2643
2640
  }
2644
- export interface CursorPagingMetadata {
2641
+ interface CursorPagingMetadata {
2645
2642
  /** Number of items returned in the response. */
2646
2643
  count?: number | null;
2647
2644
  /** Offset that was requested. */
@@ -2653,13 +2650,13 @@ export interface CursorPagingMetadata {
2653
2650
  */
2654
2651
  hasNext?: boolean | null;
2655
2652
  }
2656
- export interface Cursors {
2653
+ interface Cursors {
2657
2654
  /** Cursor pointing to next page in the list of results. */
2658
2655
  next?: string | null;
2659
2656
  /** Cursor pointing to previous page in the list of results. */
2660
2657
  prev?: string | null;
2661
2658
  }
2662
- export interface CreateCheckoutFromTemplateRequest {
2659
+ interface CreateCheckoutFromTemplateRequest {
2663
2660
  /**
2664
2661
  * ID of the checkout template to use to create a checkout from.
2665
2662
  * @format GUID
@@ -2671,7 +2668,7 @@ export interface CreateCheckoutFromTemplateRequest {
2671
2668
  */
2672
2669
  siteId: string;
2673
2670
  }
2674
- export interface CreateCheckoutFromTemplateResponse {
2671
+ interface CreateCheckoutFromTemplateResponse {
2675
2672
  /**
2676
2673
  * ID of the created checkout.
2677
2674
  * @format GUID
@@ -2685,7 +2682,7 @@ export interface CreateCheckoutFromTemplateResponse {
2685
2682
  */
2686
2683
  purchaseFlowId?: string | null;
2687
2684
  }
2688
- export interface CreateAndRedirectToCheckoutRequest {
2685
+ interface CreateAndRedirectToCheckoutRequest {
2689
2686
  /**
2690
2687
  * ID of the checkout template to use to create a checkout.
2691
2688
  * @format GUID
@@ -2697,16 +2694,16 @@ export interface CreateAndRedirectToCheckoutRequest {
2697
2694
  */
2698
2695
  siteId: string;
2699
2696
  }
2700
- export interface RawHttpResponse {
2697
+ interface RawHttpResponse {
2701
2698
  body?: Uint8Array;
2702
2699
  statusCode?: number | null;
2703
2700
  headers?: HeadersEntry[];
2704
2701
  }
2705
- export interface HeadersEntry {
2702
+ interface HeadersEntry {
2706
2703
  key?: string;
2707
2704
  value?: string;
2708
2705
  }
2709
- export interface DomainEvent extends DomainEventBodyOneOf {
2706
+ interface DomainEvent extends DomainEventBodyOneOf {
2710
2707
  createdEvent?: EntityCreatedEvent;
2711
2708
  updatedEvent?: EntityUpdatedEvent;
2712
2709
  deletedEvent?: EntityDeletedEvent;
@@ -2741,19 +2738,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
2741
2738
  entityEventSequence?: string | null;
2742
2739
  }
2743
2740
  /** @oneof */
2744
- export interface DomainEventBodyOneOf {
2741
+ interface DomainEventBodyOneOf {
2745
2742
  createdEvent?: EntityCreatedEvent;
2746
2743
  updatedEvent?: EntityUpdatedEvent;
2747
2744
  deletedEvent?: EntityDeletedEvent;
2748
2745
  actionEvent?: ActionEvent;
2749
2746
  }
2750
- export interface EntityCreatedEvent {
2747
+ interface EntityCreatedEvent {
2751
2748
  entity?: string;
2752
2749
  }
2753
- export interface RestoreInfo {
2750
+ interface RestoreInfo {
2754
2751
  deletedDate?: Date | null;
2755
2752
  }
2756
- export interface EntityUpdatedEvent {
2753
+ interface EntityUpdatedEvent {
2757
2754
  /**
2758
2755
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2759
2756
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -2761,14 +2758,14 @@ export interface EntityUpdatedEvent {
2761
2758
  */
2762
2759
  currentEntity?: string;
2763
2760
  }
2764
- export interface EntityDeletedEvent {
2761
+ interface EntityDeletedEvent {
2765
2762
  /** Entity that was deleted. */
2766
2763
  deletedEntity?: string | null;
2767
2764
  }
2768
- export interface ActionEvent {
2765
+ interface ActionEvent {
2769
2766
  body?: string;
2770
2767
  }
2771
- export interface MessageEnvelope {
2768
+ interface MessageEnvelope {
2772
2769
  /**
2773
2770
  * App instance ID.
2774
2771
  * @format GUID
@@ -2784,7 +2781,7 @@ export interface MessageEnvelope {
2784
2781
  /** Stringify payload. */
2785
2782
  data?: string;
2786
2783
  }
2787
- export interface IdentificationData extends IdentificationDataIdOneOf {
2784
+ interface IdentificationData extends IdentificationDataIdOneOf {
2788
2785
  /**
2789
2786
  * ID of a site visitor that has not logged in to the site.
2790
2787
  * @format GUID
@@ -2809,7 +2806,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
2809
2806
  identityType?: WebhookIdentityTypeWithLiterals;
2810
2807
  }
2811
2808
  /** @oneof */
2812
- export interface IdentificationDataIdOneOf {
2809
+ interface IdentificationDataIdOneOf {
2813
2810
  /**
2814
2811
  * ID of a site visitor that has not logged in to the site.
2815
2812
  * @format GUID
@@ -2831,7 +2828,7 @@ export interface IdentificationDataIdOneOf {
2831
2828
  */
2832
2829
  appId?: string;
2833
2830
  }
2834
- export declare enum WebhookIdentityType {
2831
+ declare enum WebhookIdentityType {
2835
2832
  UNKNOWN = "UNKNOWN",
2836
2833
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2837
2834
  MEMBER = "MEMBER",
@@ -2839,8 +2836,8 @@ export declare enum WebhookIdentityType {
2839
2836
  APP = "APP"
2840
2837
  }
2841
2838
  /** @enumType */
2842
- export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2843
- export interface BaseEventMetadata {
2839
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2840
+ interface BaseEventMetadata {
2844
2841
  /**
2845
2842
  * App instance ID.
2846
2843
  * @format GUID
@@ -2854,7 +2851,7 @@ export interface BaseEventMetadata {
2854
2851
  /** The identification type and identity data. */
2855
2852
  identity?: IdentificationData;
2856
2853
  }
2857
- export interface EventMetadata extends BaseEventMetadata {
2854
+ interface EventMetadata extends BaseEventMetadata {
2858
2855
  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2859
2856
  _id?: string;
2860
2857
  /**
@@ -2884,169 +2881,22 @@ export interface EventMetadata extends BaseEventMetadata {
2884
2881
  */
2885
2882
  entityEventSequence?: string | null;
2886
2883
  }
2887
- export interface CheckoutTemplateCreatedEnvelope {
2884
+ interface CheckoutTemplateCreatedEnvelope {
2888
2885
  entity: CheckoutTemplate;
2889
2886
  metadata: EventMetadata;
2890
2887
  }
2891
- /**
2892
- * Triggered when a checkout template is created.
2893
- * @permissionScope Manage Stores - all permissions
2894
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2895
- * @permissionScope Manage Stores
2896
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2897
- * @permissionScope Manage Restaurants - all permissions
2898
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2899
- * @permissionScope Manage eCommerce - all permissions
2900
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
2901
- * @permissionId ECOM.CHECKOUT_TEMPLATE_READ
2902
- * @webhook
2903
- * @eventType wix.ecom.v1.checkout_template_created
2904
- * @slug created
2905
- */
2906
- export declare function onCheckoutTemplateCreated(handler: (event: CheckoutTemplateCreatedEnvelope) => void | Promise<void>): void;
2907
- export interface CheckoutTemplateDeletedEnvelope {
2888
+ interface CheckoutTemplateDeletedEnvelope {
2908
2889
  metadata: EventMetadata;
2909
2890
  }
2910
- /**
2911
- * Triggered when a checkout template is deleted.
2912
- * @permissionScope Manage Stores - all permissions
2913
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2914
- * @permissionScope Manage Stores
2915
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2916
- * @permissionScope Manage Restaurants - all permissions
2917
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2918
- * @permissionScope Manage eCommerce - all permissions
2919
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
2920
- * @permissionId ECOM.CHECKOUT_TEMPLATE_READ
2921
- * @webhook
2922
- * @eventType wix.ecom.v1.checkout_template_deleted
2923
- * @slug deleted
2924
- */
2925
- export declare function onCheckoutTemplateDeleted(handler: (event: CheckoutTemplateDeletedEnvelope) => void | Promise<void>): void;
2926
- export interface CheckoutTemplateUpdatedEnvelope {
2891
+ interface CheckoutTemplateUpdatedEnvelope {
2927
2892
  entity: CheckoutTemplate;
2928
2893
  metadata: EventMetadata;
2929
2894
  }
2930
- /**
2931
- * Triggered when a checkout template is updated.
2932
- * @permissionScope Manage Stores - all permissions
2933
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2934
- * @permissionScope Manage Stores
2935
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2936
- * @permissionScope Manage Restaurants - all permissions
2937
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2938
- * @permissionScope Manage eCommerce - all permissions
2939
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
2940
- * @permissionId ECOM.CHECKOUT_TEMPLATE_READ
2941
- * @webhook
2942
- * @eventType wix.ecom.v1.checkout_template_updated
2943
- * @slug updated
2944
- */
2945
- export declare function onCheckoutTemplateUpdated(handler: (event: CheckoutTemplateUpdatedEnvelope) => void | Promise<void>): void;
2946
- export interface CheckoutTemplateUsedEnvelope {
2895
+ interface CheckoutTemplateUsedEnvelope {
2947
2896
  data: CheckoutTemplateUsed;
2948
2897
  metadata: EventMetadata;
2949
2898
  }
2950
- /**
2951
- * Triggered when a checkout is created from a checkout template.
2952
- * @permissionScope Manage Stores - all permissions
2953
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2954
- * @permissionScope Manage Stores
2955
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2956
- * @permissionScope Manage Restaurants - all permissions
2957
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2958
- * @permissionScope Manage eCommerce - all permissions
2959
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
2960
- * @permissionId ECOM.CHECKOUT_TEMPLATE_READ
2961
- * @webhook
2962
- * @eventType wix.ecom.v1.checkout_template_used
2963
- * @slug used
2964
- */
2965
- export declare function onCheckoutTemplateUsed(handler: (event: CheckoutTemplateUsedEnvelope) => void | Promise<void>): void;
2966
- type CheckoutTemplateNonNullablePaths = `status` | `customization.webClient.disabledContinueShoppingButton` | `customization.webClient.disabledPolicyAgreementCheckbox` | `customization.lockedGiftCard` | `customization.lockedCoupon` | `customization.disabledManualPayment` | `lineItems` | `lineItems.${number}.quantity` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.catalogOverrideFields.productName.original` | `lineItems.${number}.catalogOverrideFields.physicalProperties.shippable` | `lineItems.${number}.catalogOverrideFields.paymentOption.value` | `customLineItems` | `customLineItems.${number}.quantity` | `customLineItems.${number}.price` | `customLineItems.${number}.priceDescription.original` | `customLineItems.${number}.productName.original` | `customLineItems.${number}.itemType.preset` | `customLineItems.${number}.itemType.custom` | `customLineItems.${number}.physicalProperties.shippable` | `customLineItems.${number}.paymentOption` | `customLineItems.${number}.catalogReference.catalogItemId` | `customLineItems.${number}.catalogReference.appId` | `customLineItems.${number}.savePaymentMethod` | `customLineItems.${number}.membersOnly` | `customLineItems.${number}.taxableAddress.addressType` | `customContentReference.appId` | `customContentReference.componentId` | `externalReference.appId`;
2967
- /**
2968
- * Creates a checkout template.
2969
- *
2970
- * A checkout template is used to create a new checkout that will include predefined information. For example, a single link with
2971
- * a `checkoutTemplateId` can be shared with customers and each time the link is clicked, a new checkout page will be created
2972
- * for that customer with certain checkout information already populated.
2973
- *
2974
- * The customizable features include the option to allow or to lock coupon codes or gift cards. For example, if a store owner is
2975
- * using the checkout template to offer a flash sale to their social media followers, they may want to lock the option to apply an
2976
- * additional coupon on top of the sale being offered. If so, they can set `customization.lockedCoupon` to `true`.
2977
- *
2978
- * A checkout can be created with a checkout template by calling Create Checkout From Template.
2979
- * The site may add further customizations to the new checkout and then redirect the customer using the new checkout's `checkoutUrl`.
2980
- * @param checkoutTemplate - Checkout template to create.
2981
- * @public
2982
- * @requiredField checkoutTemplate
2983
- * @requiredField checkoutTemplate.customLineItems.descriptionLines.name
2984
- * @requiredField checkoutTemplate.customLineItems.descriptionLines.value
2985
- * @requiredField checkoutTemplate.customLineItems.itemType
2986
- * @requiredField checkoutTemplate.customLineItems.productName
2987
- * @requiredField checkoutTemplate.customLineItems.quantity
2988
- * @requiredField checkoutTemplate.lineItems.catalogReference
2989
- * @requiredField checkoutTemplate.lineItems.catalogReference.appId
2990
- * @requiredField checkoutTemplate.lineItems.catalogReference.catalogItemId
2991
- * @requiredField checkoutTemplate.lineItems.quantity
2992
- * @permissionId ECOM.CHECKOUT_TEMPLATE_CREATE
2993
- * @permissionScope Manage Stores - all permissions
2994
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2995
- * @permissionScope Manage Stores
2996
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2997
- * @permissionScope Manage Restaurants - all permissions
2998
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2999
- * @permissionScope Manage eCommerce - all permissions
3000
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3001
- * @applicableIdentity APP
3002
- * @returns Created checkout template.
3003
- * @fqn wix.ecom.checkout_template.api.v1.CheckoutTemplateService.CreateCheckoutTemplate
3004
- */
3005
- export declare function createCheckoutTemplate(checkoutTemplate: NonNullablePaths<CheckoutTemplate, `customLineItems.${number}.descriptionLines` | `customLineItems.${number}.descriptionLines.${number}.name` | `customLineItems.${number}.itemType` | `customLineItems.${number}.productName` | `customLineItems.${number}.quantity` | `lineItems.${number}.catalogReference` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.quantity`>): Promise<NonNullablePaths<CheckoutTemplate, CheckoutTemplateNonNullablePaths>>;
3006
- /**
3007
- * Retrieves a checkout template.
3008
- * @param checkoutTemplateId - ID of the checkout template to retrieve.
3009
- * @public
3010
- * @requiredField checkoutTemplateId
3011
- * @permissionId ECOM.CHECKOUT_TEMPLATE_READ
3012
- * @permissionScope Manage Stores - all permissions
3013
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3014
- * @permissionScope Manage Stores
3015
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
3016
- * @permissionScope Manage Restaurants - all permissions
3017
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3018
- * @permissionScope Manage eCommerce - all permissions
3019
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3020
- * @applicableIdentity APP
3021
- * @returns Retrieved checkout template.
3022
- * @fqn wix.ecom.checkout_template.api.v1.CheckoutTemplateService.GetCheckoutTemplate
3023
- */
3024
- export declare function getCheckoutTemplate(checkoutTemplateId: string): Promise<NonNullablePaths<CheckoutTemplate, CheckoutTemplateNonNullablePaths>>;
3025
- /**
3026
- * Updates a checkout template.
3027
- *
3028
- * If the info in a checkout template is updated, only new checkouts created from this template will include the updated items. Checkouts previously
3029
- * created from this template before the update will not be affected.
3030
- * @param _id - Checkout template ID.
3031
- * @public
3032
- * @requiredField _id
3033
- * @requiredField checkoutTemplate
3034
- * @param checkoutTemplate - Checkout template info to update.
3035
- * @permissionId ECOM.CHECKOUT_TEMPLATE_UPDATE
3036
- * @permissionScope Manage Stores - all permissions
3037
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3038
- * @permissionScope Manage Stores
3039
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
3040
- * @permissionScope Manage Restaurants - all permissions
3041
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3042
- * @permissionScope Manage eCommerce - all permissions
3043
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3044
- * @applicableIdentity APP
3045
- * @returns Updated checkout template.
3046
- * @fqn wix.ecom.checkout_template.api.v1.CheckoutTemplateService.UpdateCheckoutTemplate
3047
- */
3048
- export declare function updateCheckoutTemplate(_id: string, checkoutTemplate: UpdateCheckoutTemplate): Promise<NonNullablePaths<CheckoutTemplate, CheckoutTemplateNonNullablePaths>>;
3049
- export interface UpdateCheckoutTemplate {
2899
+ interface UpdateCheckoutTemplate {
3050
2900
  /**
3051
2901
  * Checkout template ID.
3052
2902
  * @format GUID
@@ -3098,56 +2948,6 @@ export interface UpdateCheckoutTemplate {
3098
2948
  */
3099
2949
  externalReference?: ExternalReference;
3100
2950
  }
3101
- /**
3102
- * Deletes a checkout template.
3103
- *
3104
- * If a checkout template is deleted and a customer attempts to create a checkout with that `checkoutTemplateId` then
3105
- * the customer will be redirected to the domain site.
3106
- * @param checkoutTemplateId - ID of the checkout template to delete.
3107
- * @public
3108
- * @requiredField checkoutTemplateId
3109
- * @permissionId ECOM.CHECKOUT_TEMPLATE_DELETE
3110
- * @permissionScope Manage Stores - all permissions
3111
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3112
- * @permissionScope Manage Stores
3113
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
3114
- * @permissionScope Manage Restaurants - all permissions
3115
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3116
- * @permissionScope Manage eCommerce - all permissions
3117
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3118
- * @applicableIdentity APP
3119
- * @fqn wix.ecom.checkout_template.api.v1.CheckoutTemplateService.DeleteCheckoutTemplate
3120
- */
3121
- export declare function deleteCheckoutTemplate(checkoutTemplateId: string): Promise<void>;
3122
- /**
3123
- * Creates a query to retrieve a list of checkout templates.
3124
- *
3125
- * The `queryCheckoutTemplates()` function builds a query to retrieve a list of checkout templates and returns a `CheckoutTemplatesQueryBuilder` object.
3126
- *
3127
- * The returned object contains the query definition, which is typically used to run the query using the `find()` function.
3128
- *
3129
- * You can refine the query by chaining `CheckoutTemplatesQueryBuilder` functions onto the query. `CheckoutTemplatesQueryBuilder` functions enable you to sort, filter, and control the results that `queryCheckoutTemplates()` returns.
3130
- *
3131
- * `queryCheckoutTemplates()` runs with the following `CheckoutTemplatesQueryBuilder` default that you can override:
3132
- * + `ascending("_id")`
3133
- *
3134
- * The functions that are chained to `queryCheckoutTemplates()` are applied in the order they are called. For example, if you apply `ascending("status")` and then `ascending("_id")`, the results are sorted first by the `"status"`, and then, if there are multiple results with the same `"status"`, the items are sorted by `"_id"`.
3135
- *
3136
- * The following `CheckoutTemplatesQueryBuilder` functions are supported for the `queryCheckoutTemplates()` function. For a full description of the checkout template object, see the object returned for the `items` property in `CheckoutTemplatesQueryResult`.
3137
- * @public
3138
- * @permissionScope Manage Stores - all permissions
3139
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3140
- * @permissionScope Manage Stores
3141
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
3142
- * @permissionScope Manage Restaurants - all permissions
3143
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3144
- * @permissionScope Manage eCommerce - all permissions
3145
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3146
- * @permissionId ECOM.CHECKOUT_TEMPLATE_READ
3147
- * @applicableIdentity APP
3148
- * @fqn wix.ecom.checkout_template.api.v1.CheckoutTemplateService.QueryCheckoutTemplates
3149
- */
3150
- export declare function queryCheckoutTemplates(): CheckoutTemplatesQueryBuilder;
3151
2951
  interface QueryCursorResult {
3152
2952
  cursors: Cursors;
3153
2953
  hasNext: () => boolean;
@@ -3155,13 +2955,13 @@ interface QueryCursorResult {
3155
2955
  length: number;
3156
2956
  pageSize: number;
3157
2957
  }
3158
- export interface CheckoutTemplatesQueryResult extends QueryCursorResult {
2958
+ interface CheckoutTemplatesQueryResult extends QueryCursorResult {
3159
2959
  items: CheckoutTemplate[];
3160
2960
  query: CheckoutTemplatesQueryBuilder;
3161
2961
  next: () => Promise<CheckoutTemplatesQueryResult>;
3162
2962
  prev: () => Promise<CheckoutTemplatesQueryResult>;
3163
2963
  }
3164
- export interface CheckoutTemplatesQueryBuilder {
2964
+ interface CheckoutTemplatesQueryBuilder {
3165
2965
  /** @param propertyName - Property whose value is compared with `value`.
3166
2966
  * @param value - Value to compare against.
3167
2967
  */
@@ -3206,46 +3006,5 @@ export interface CheckoutTemplatesQueryBuilder {
3206
3006
  skipTo: (cursor: string) => CheckoutTemplatesQueryBuilder;
3207
3007
  find: () => Promise<CheckoutTemplatesQueryResult>;
3208
3008
  }
3209
- /**
3210
- * Creates a new checkout based on the checkout template.
3211
- *
3212
- * Before using this method, you must have a checkout template available. Create a checkout template with Create Checkout Template.
3213
- *
3214
- * The customer can be directed to the new checkout using the checkout's `checkoutUrl`.
3215
- * @param checkoutTemplateId - ID of the checkout template to use to create a checkout from.
3216
- * @param siteId - ID of the site associated with the checkout template.
3217
- * @public
3218
- * @requiredField checkoutTemplateId
3219
- * @requiredField siteId
3220
- * @permissionId ECOM.CHECKOUT_TEMPLATE_CREATE_CHECKOUT
3221
- * @permissionScope Manage Stores - all permissions
3222
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3223
- * @permissionScope Manage Stores
3224
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
3225
- * @permissionScope Manage Restaurants - all permissions
3226
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3227
- * @permissionScope Manage eCommerce - all permissions
3228
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3229
- * @applicableIdentity APP
3230
- * @applicableIdentity VISITOR
3231
- * @fqn wix.ecom.checkout_template.api.v1.CheckoutTemplateService.CreateCheckoutFromTemplate
3232
- */
3233
- export declare function createCheckoutFromTemplate(checkoutTemplateId: string, siteId: string): Promise<NonNullablePaths<CreateCheckoutFromTemplateResponse, `checkoutId` | `checkoutUrl`>>;
3234
- /**
3235
- * Creates a new checkout based on the checkout template and redirects to the new checkout page.
3236
- *
3237
- * Before using this method, you must have a checkout template available. Create a checkout template with Create Checkout Template.
3238
- *
3239
- * To build a URL that uses this method, follow this format:
3240
- * `https://www.wixapis.com/ecom/v1/checkout-templates/{checkoutTemplateId}/create-and-redirect-to-checkout?siteId={siteId}`
3241
- *
3242
- * To create a checkout but not automatically redirect to the checkout page, use Create Checkout From Template.
3243
- * @param checkoutTemplateId - ID of the checkout template to use to create a checkout.
3244
- * @param siteId - ID of the site associated with the checkout template.
3245
- * @public
3246
- * @requiredField checkoutTemplateId
3247
- * @requiredField siteId
3248
- * @fqn wix.ecom.checkout_template.api.v1.CheckoutTemplateService.CreateAndRedirectToCheckout
3249
- */
3250
- export declare function createAndRedirectToCheckout(checkoutTemplateId: string, siteId: string): Promise<NonNullablePaths<RawHttpResponse, `body` | `headers` | `headers.${number}.key` | `headers.${number}.value`>>;
3251
- export {};
3009
+
3010
+ export { type SubscriptionOptionInfo as $, AdditionalFeeSource as A, type DescriptionLine as B, type CheckoutTemplate as C, DescriptionLineType as D, type DescriptionLineValueOneOf as E, FileType as F, type DescriptionLineDescriptionLineValueOneOf as G, type DescriptionLineName as H, ItemTypeItemType as I, JurisdictionType as J, type PlainTextValue as K, type Color as L, ManualCalculationReason as M, NameInOther as N, type PhysicalProperties as O, PaymentOptionType as P, type PaymentOption as Q, type RawHttpResponse as R, Status as S, TaxableAddressType as T, type UpdateCheckoutTemplate as U, VatType as V, WeightUnit as W, type CustomLineItem as X, type PriceDescription as Y, type ItemType as Z, type ItemTypeItemTypeDataOneOf as _, type CheckoutTemplatesQueryBuilder as a, type GiftCard as a$, type SubscriptionSettings as a0, type FreeTrialPeriod as a1, type Title as a2, type Description as a3, type SecuredMedia as a4, type ServiceProperties as a5, type Policy as a6, type TaxableAddress as a7, type TaxableAddressTaxableAddressDataOneOf as a8, type V1ModifierGroup as a9, type DeliveryLogistics as aA, type PickupDetails as aB, type DeliveryTimeSlot as aC, type SelectedCarrierServiceOptionPrices as aD, type SelectedCarrierServiceOptionOtherCharge as aE, type DeliveryAllocation as aF, type Carrier as aG, type Region as aH, type ApplicableLineItems as aI, type ShippingRegion as aJ, type CarrierServiceOption as aK, type ShippingOption as aL, type ShippingPrice as aM, type OtherCharge as aN, type BuyerInfo as aO, type BuyerInfoIdOneOf as aP, type PriceSummary as aQ, type CalculationErrors as aR, type CalculationErrorsShippingCalculationErrorOneOf as aS, type Details as aT, type DetailsKindOneOf as aU, type ApplicationError as aV, type ValidationError as aW, type FieldViolation as aX, type SystemError as aY, type CarrierErrors as aZ, type CarrierError as a_, type TranslatableString as aa, type V1ItemModifier as ab, type ExtendedFields as ac, type CustomContentReference as ad, type ExternalReference as ae, type CheckoutTemplateUsed as af, type Checkout as ag, type LineItem as ah, type MultiCurrencyPrice as ai, type ItemTaxFullDetails as aj, type TaxRateBreakdown as ak, type TaxBreakdown as al, type FocalPoint as am, type ItemAvailabilityInfo as an, type Scope as ao, type Group as ap, type ModifierGroup as aq, type ItemModifier as ar, type AddressWithContact as as, type Address as at, type StreetAddress as au, type AddressLocation as av, type FullAddressContactDetails as aw, type VatId as ax, type ShippingInfo as ay, type SelectedCarrierServiceOption as az, type CreateCheckoutFromTemplateResponse as b, type CheckoutTemplatesQueryResult as b$, type AppliedDiscount as b0, type AppliedDiscountDiscountSourceOneOf as b1, type Coupon as b2, type MerchantDiscount as b3, type DiscountRule as b4, type DiscountRuleName as b5, type LineItemDiscount as b6, type CustomField as b7, type TaxSummary as b8, type TaxCalculationDetails as b9, type UpdateCheckoutTemplateRequest as bA, type UpdateCheckoutTemplateResponse as bB, type DeleteCheckoutTemplateRequest as bC, type DeleteCheckoutTemplateResponse as bD, type QueryCheckoutTemplatesRequest as bE, type CursorQuery as bF, type CursorQueryPagingMethodOneOf as bG, type Sorting as bH, type CursorPaging as bI, type QueryCheckoutTemplatesResponse as bJ, type CursorPagingMetadata as bK, type Cursors as bL, type CreateCheckoutFromTemplateRequest as bM, type CreateAndRedirectToCheckoutRequest as bN, type HeadersEntry as bO, type DomainEvent as bP, type DomainEventBodyOneOf as bQ, type EntityCreatedEvent as bR, type RestoreInfo as bS, type EntityUpdatedEvent as bT, type EntityDeletedEvent as bU, type ActionEvent as bV, type MessageEnvelope as bW, type IdentificationData as bX, type IdentificationDataIdOneOf as bY, type BaseEventMetadata as bZ, type EventMetadata as b_, type TaxCalculationDetailsCalculationDetailsOneOf as ba, type AutoTaxFallbackCalculationDetails as bb, type AggregatedTaxBreakdown as bc, type CreatedBy as bd, type CreatedByIdOneOf as be, type MembershipOptions as bf, type Membership as bg, type MembershipName as bh, type MembershipPaymentCredits as bi, type InvalidMembership as bj, type SelectedMemberships as bk, type SelectedMembership as bl, type AdditionalFee as bm, type ConversionInfo as bn, type Violation as bo, type Target as bp, type TargetTargetTypeOneOf as bq, type Other as br, type TargetLineItem as bs, type CustomSettings as bt, type SubscriptionCharges as bu, type Charge as bv, type CreateCheckoutTemplateRequest as bw, type CreateCheckoutTemplateResponse as bx, type GetCheckoutTemplateRequest as by, type GetCheckoutTemplateResponse as bz, type CheckoutTemplateCreatedEnvelope as c, type CheckoutTemplateDeletedEnvelope as d, type CheckoutTemplateUpdatedEnvelope as e, type CheckoutTemplateUsedEnvelope as f, SubscriptionFrequency as g, ItemAvailabilityStatus as h, PickupMethod as i, ChargeType as j, RuleType as k, DiscountType as l, RateType as m, FallbackReason as n, ChannelType as o, Severity as p, NameInLineItem as q, SuggestedFix as r, SortOrder as s, WebhookIdentityType as t, type CheckoutCustomization as u, type WebClientCustomization as v, type V1LineItem as w, type CatalogReference as x, type CatalogOverrideFields as y, type ProductName as z };