@wix/auto_sdk_ecom_current-cart 1.0.34 → 1.0.36

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-cart-current-cart.types.d.ts → ecom-v1-cart-current-cart.universal-Hy6hC49z.d.mts} +416 -305
  2. package/build/{internal/cjs/src/ecom-v1-cart-current-cart.types.d.ts → ecom-v1-cart-current-cart.universal-Hy6hC49z.d.ts} +416 -305
  3. package/build/index.d.mts +143 -0
  4. package/build/index.d.ts +143 -0
  5. package/build/index.js +1555 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +1495 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/{es/src/ecom-v1-cart-current-cart.types.d.ts → internal/ecom-v1-cart-current-cart.universal-TcsLxps1.d.mts} +518 -303
  10. package/build/internal/{es/src/ecom-v1-cart-current-cart.types.d.ts → ecom-v1-cart-current-cart.universal-TcsLxps1.d.ts} +518 -303
  11. package/build/internal/index.d.mts +143 -0
  12. package/build/internal/index.d.ts +143 -0
  13. package/build/internal/index.js +1555 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +1495 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +2172 -0
  18. package/build/internal/meta.d.ts +2172 -0
  19. package/build/internal/meta.js +791 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +756 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +2172 -0
  24. package/build/meta.d.ts +2172 -0
  25. package/build/meta.js +791 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +756 -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-cart-current-cart.context.d.ts +0 -27
  40. package/build/cjs/src/ecom-v1-cart-current-cart.context.js +0 -55
  41. package/build/cjs/src/ecom-v1-cart-current-cart.context.js.map +0 -1
  42. package/build/cjs/src/ecom-v1-cart-current-cart.http.d.ts +0 -80
  43. package/build/cjs/src/ecom-v1-cart-current-cart.http.js +0 -662
  44. package/build/cjs/src/ecom-v1-cart-current-cart.http.js.map +0 -1
  45. package/build/cjs/src/ecom-v1-cart-current-cart.meta.d.ts +0 -21
  46. package/build/cjs/src/ecom-v1-cart-current-cart.meta.js +0 -199
  47. package/build/cjs/src/ecom-v1-cart-current-cart.meta.js.map +0 -1
  48. package/build/cjs/src/ecom-v1-cart-current-cart.public.d.ts +0 -123
  49. package/build/cjs/src/ecom-v1-cart-current-cart.public.js +0 -208
  50. package/build/cjs/src/ecom-v1-cart-current-cart.public.js.map +0 -1
  51. package/build/cjs/src/ecom-v1-cart-current-cart.types.js +0 -257
  52. package/build/cjs/src/ecom-v1-cart-current-cart.types.js.map +0 -1
  53. package/build/cjs/src/ecom-v1-cart-current-cart.universal.d.ts +0 -3188
  54. package/build/cjs/src/ecom-v1-cart-current-cart.universal.js +0 -911
  55. package/build/cjs/src/ecom-v1-cart-current-cart.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-cart-current-cart.context.d.ts +0 -27
  67. package/build/es/src/ecom-v1-cart-current-cart.context.js +0 -27
  68. package/build/es/src/ecom-v1-cart-current-cart.context.js.map +0 -1
  69. package/build/es/src/ecom-v1-cart-current-cart.http.d.ts +0 -80
  70. package/build/es/src/ecom-v1-cart-current-cart.http.js +0 -650
  71. package/build/es/src/ecom-v1-cart-current-cart.http.js.map +0 -1
  72. package/build/es/src/ecom-v1-cart-current-cart.meta.d.ts +0 -21
  73. package/build/es/src/ecom-v1-cart-current-cart.meta.js +0 -164
  74. package/build/es/src/ecom-v1-cart-current-cart.meta.js.map +0 -1
  75. package/build/es/src/ecom-v1-cart-current-cart.public.d.ts +0 -123
  76. package/build/es/src/ecom-v1-cart-current-cart.public.js +0 -171
  77. package/build/es/src/ecom-v1-cart-current-cart.public.js.map +0 -1
  78. package/build/es/src/ecom-v1-cart-current-cart.types.js +0 -254
  79. package/build/es/src/ecom-v1-cart-current-cart.types.js.map +0 -1
  80. package/build/es/src/ecom-v1-cart-current-cart.universal.d.ts +0 -3188
  81. package/build/es/src/ecom-v1-cart-current-cart.universal.js +0 -876
  82. package/build/es/src/ecom-v1-cart-current-cart.universal.js.map +0 -1
  83. package/build/internal/cjs/index.d.ts +0 -1
  84. package/build/internal/cjs/index.js +0 -18
  85. package/build/internal/cjs/index.js.map +0 -1
  86. package/build/internal/cjs/index.typings.d.ts +0 -1
  87. package/build/internal/cjs/index.typings.js +0 -18
  88. package/build/internal/cjs/index.typings.js.map +0 -1
  89. package/build/internal/cjs/meta.d.ts +0 -1
  90. package/build/internal/cjs/meta.js +0 -18
  91. package/build/internal/cjs/meta.js.map +0 -1
  92. package/build/internal/cjs/src/ecom-v1-cart-current-cart.context.d.ts +0 -27
  93. package/build/internal/cjs/src/ecom-v1-cart-current-cart.context.js +0 -55
  94. package/build/internal/cjs/src/ecom-v1-cart-current-cart.context.js.map +0 -1
  95. package/build/internal/cjs/src/ecom-v1-cart-current-cart.http.d.ts +0 -80
  96. package/build/internal/cjs/src/ecom-v1-cart-current-cart.http.js +0 -662
  97. package/build/internal/cjs/src/ecom-v1-cart-current-cart.http.js.map +0 -1
  98. package/build/internal/cjs/src/ecom-v1-cart-current-cart.meta.d.ts +0 -21
  99. package/build/internal/cjs/src/ecom-v1-cart-current-cart.meta.js +0 -199
  100. package/build/internal/cjs/src/ecom-v1-cart-current-cart.meta.js.map +0 -1
  101. package/build/internal/cjs/src/ecom-v1-cart-current-cart.public.d.ts +0 -123
  102. package/build/internal/cjs/src/ecom-v1-cart-current-cart.public.js +0 -208
  103. package/build/internal/cjs/src/ecom-v1-cart-current-cart.public.js.map +0 -1
  104. package/build/internal/cjs/src/ecom-v1-cart-current-cart.types.js +0 -257
  105. package/build/internal/cjs/src/ecom-v1-cart-current-cart.types.js.map +0 -1
  106. package/build/internal/cjs/src/ecom-v1-cart-current-cart.universal.d.ts +0 -3307
  107. package/build/internal/cjs/src/ecom-v1-cart-current-cart.universal.js +0 -911
  108. package/build/internal/cjs/src/ecom-v1-cart-current-cart.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-cart-current-cart.context.d.ts +0 -27
  119. package/build/internal/es/src/ecom-v1-cart-current-cart.context.js +0 -27
  120. package/build/internal/es/src/ecom-v1-cart-current-cart.context.js.map +0 -1
  121. package/build/internal/es/src/ecom-v1-cart-current-cart.http.d.ts +0 -80
  122. package/build/internal/es/src/ecom-v1-cart-current-cart.http.js +0 -650
  123. package/build/internal/es/src/ecom-v1-cart-current-cart.http.js.map +0 -1
  124. package/build/internal/es/src/ecom-v1-cart-current-cart.meta.d.ts +0 -21
  125. package/build/internal/es/src/ecom-v1-cart-current-cart.meta.js +0 -164
  126. package/build/internal/es/src/ecom-v1-cart-current-cart.meta.js.map +0 -1
  127. package/build/internal/es/src/ecom-v1-cart-current-cart.public.d.ts +0 -123
  128. package/build/internal/es/src/ecom-v1-cart-current-cart.public.js +0 -171
  129. package/build/internal/es/src/ecom-v1-cart-current-cart.public.js.map +0 -1
  130. package/build/internal/es/src/ecom-v1-cart-current-cart.types.js +0 -254
  131. package/build/internal/es/src/ecom-v1-cart-current-cart.types.js.map +0 -1
  132. package/build/internal/es/src/ecom-v1-cart-current-cart.universal.d.ts +0 -3307
  133. package/build/internal/es/src/ecom-v1-cart-current-cart.universal.js +0 -876
  134. package/build/internal/es/src/ecom-v1-cart-current-cart.universal.js.map +0 -1
@@ -1,9 +1,9 @@
1
- export interface Cart {
1
+ interface Cart {
2
2
  /**
3
3
  * Cart ID.
4
4
  * @format GUID
5
5
  */
6
- id?: string | null;
6
+ _id?: string | null;
7
7
  /**
8
8
  * Line items.
9
9
  * @minSize 1
@@ -67,12 +67,12 @@ export interface Cart {
67
67
  * Date and time the cart was created.
68
68
  * @readonly
69
69
  */
70
- createdDate?: Date | null;
70
+ _createdDate?: Date | null;
71
71
  /**
72
72
  * Date and time the cart was updated.
73
73
  * @readonly
74
74
  */
75
- updatedDate?: Date | null;
75
+ _updatedDate?: Date | null;
76
76
  /** Contact info. */
77
77
  contactInfo?: AddressWithContact;
78
78
  /**
@@ -106,13 +106,13 @@ export interface Cart {
106
106
  */
107
107
  paymentCurrency?: string;
108
108
  }
109
- export interface LineItem {
109
+ interface LineItem {
110
110
  /**
111
111
  * Line item ID.
112
112
  * @format GUID
113
113
  * @readonly
114
114
  */
115
- id?: string | null;
115
+ _id?: string | null;
116
116
  /**
117
117
  * Item quantity.
118
118
  * @min 1
@@ -133,7 +133,7 @@ export interface LineItem {
133
133
  * URL to the item's page on the site.
134
134
  * @readonly
135
135
  */
136
- url?: PageUrlV2;
136
+ url?: string;
137
137
  /**
138
138
  * Item price **after** catalog-defined discount and line item discounts.
139
139
  * @readonly
@@ -163,7 +163,7 @@ export interface LineItem {
163
163
  * Line item image details.
164
164
  * @readonly
165
165
  */
166
- image?: CommonImage;
166
+ image?: string;
167
167
  /**
168
168
  * Item availability details.
169
169
  * @readonly
@@ -276,9 +276,20 @@ export interface LineItem {
276
276
  * @readonly
277
277
  */
278
278
  membersOnly?: boolean;
279
+ /**
280
+ * Modifier groups that were added to the item.
281
+ * @readonly
282
+ * @maxSize 25
283
+ */
284
+ modifierGroups?: ModifierGroup[];
285
+ /**
286
+ * Total price of all item modifiers. Included in the item price.
287
+ * @readonly
288
+ */
289
+ modifiersTotalPrice?: MultiCurrencyPrice;
279
290
  }
280
291
  /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
281
- export interface CatalogReference {
292
+ interface CatalogReference {
282
293
  /**
283
294
  * ID of the item within the catalog it belongs to.
284
295
  * @minLength 1
@@ -304,7 +315,7 @@ export interface CatalogReference {
304
315
  */
305
316
  options?: Record<string, any> | null;
306
317
  }
307
- export interface ProductName {
318
+ interface ProductName {
308
319
  /**
309
320
  * __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).
310
321
  *
@@ -325,13 +336,7 @@ export interface ProductName {
325
336
  */
326
337
  translated?: string | null;
327
338
  }
328
- export interface PageUrlV2 {
329
- /** The relative path for the page within the site. For example, `/product-page/a-product`. */
330
- relativePath?: string;
331
- /** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
332
- url?: string | null;
333
- }
334
- export interface MultiCurrencyPrice {
339
+ interface MultiCurrencyPrice {
335
340
  /**
336
341
  * Amount.
337
342
  * @decimalValue options { gte:0, lte:1000000000000000 }
@@ -354,7 +359,7 @@ export interface MultiCurrencyPrice {
354
359
  */
355
360
  formattedConvertedAmount?: string;
356
361
  }
357
- export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
362
+ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
358
363
  /** Description line plain text value. */
359
364
  plainText?: PlainTextValue;
360
365
  /** Description line color value. */
@@ -363,16 +368,16 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
363
368
  name?: DescriptionLineName;
364
369
  }
365
370
  /** @oneof */
366
- export interface DescriptionLineValueOneOf {
371
+ interface DescriptionLineValueOneOf {
367
372
  /** Description line plain text value. */
368
373
  plainText?: PlainTextValue;
369
374
  /** Description line color value. */
370
375
  colorInfo?: Color;
371
376
  }
372
377
  /** @oneof */
373
- export interface DescriptionLineDescriptionLineValueOneOf {
378
+ interface DescriptionLineDescriptionLineValueOneOf {
374
379
  }
375
- export interface DescriptionLineName {
380
+ interface DescriptionLineName {
376
381
  /**
377
382
  * 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).
378
383
  * @maxLength 100
@@ -386,7 +391,7 @@ export interface DescriptionLineName {
386
391
  */
387
392
  translated?: string | null;
388
393
  }
389
- export interface PlainTextValue {
394
+ interface PlainTextValue {
390
395
  /**
391
396
  * 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).
392
397
  * @maxLength 600
@@ -400,7 +405,7 @@ export interface PlainTextValue {
400
405
  */
401
406
  translated?: string | null;
402
407
  }
403
- export interface Color {
408
+ interface Color {
404
409
  /**
405
410
  * 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).
406
411
  * @maxLength 500
@@ -416,7 +421,7 @@ export interface Color {
416
421
  /** HEX or RGB color code for display. */
417
422
  code?: string | null;
418
423
  }
419
- export declare enum DescriptionLineType {
424
+ declare enum DescriptionLineType {
420
425
  /** Unrecognized type. */
421
426
  UNRECOGNISED = "UNRECOGNISED",
422
427
  /** Plain text type. */
@@ -424,32 +429,7 @@ export declare enum DescriptionLineType {
424
429
  /** Color type. */
425
430
  COLOR = "COLOR"
426
431
  }
427
- /** @enumType */
428
- export type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
429
- export interface CommonImage {
430
- /** WixMedia image ID. */
431
- id?: string;
432
- /** Image URL. */
433
- url?: string;
434
- /**
435
- * Original image height.
436
- * @readonly
437
- */
438
- height?: number;
439
- /**
440
- * Original image width.
441
- * @readonly
442
- */
443
- width?: number;
444
- /** Image alt text. */
445
- altText?: string | null;
446
- /**
447
- * Image filename.
448
- * @readonly
449
- */
450
- filename?: string | null;
451
- }
452
- export interface FocalPoint {
432
+ interface FocalPoint {
453
433
  /** X-coordinate of the focal point. */
454
434
  x?: number;
455
435
  /** Y-coordinate of the focal point. */
@@ -459,13 +439,13 @@ export interface FocalPoint {
459
439
  /** crop by width */
460
440
  width?: number | null;
461
441
  }
462
- export interface ItemAvailabilityInfo {
442
+ interface ItemAvailabilityInfo {
463
443
  /** Item availability status. */
464
444
  status?: ItemAvailabilityStatusWithLiterals;
465
445
  /** Quantity available. */
466
446
  quantityAvailable?: number | null;
467
447
  }
468
- export declare enum ItemAvailabilityStatus {
448
+ declare enum ItemAvailabilityStatus {
469
449
  AVAILABLE = "AVAILABLE",
470
450
  /** Item does not exist. */
471
451
  NOT_FOUND = "NOT_FOUND",
@@ -475,8 +455,8 @@ export declare enum ItemAvailabilityStatus {
475
455
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
476
456
  }
477
457
  /** @enumType */
478
- export type ItemAvailabilityStatusWithLiterals = ItemAvailabilityStatus | 'AVAILABLE' | 'NOT_FOUND' | 'NOT_AVAILABLE' | 'PARTIALLY_AVAILABLE';
479
- export interface PhysicalProperties {
458
+ type ItemAvailabilityStatusWithLiterals = ItemAvailabilityStatus | 'AVAILABLE' | 'NOT_FOUND' | 'NOT_AVAILABLE' | 'PARTIALLY_AVAILABLE';
459
+ interface PhysicalProperties {
480
460
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
481
461
  weight?: number | null;
482
462
  /**
@@ -487,32 +467,32 @@ export interface PhysicalProperties {
487
467
  /** Whether this line item is shippable. */
488
468
  shippable?: boolean;
489
469
  }
490
- export interface Scope {
470
+ interface Scope {
491
471
  /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
492
472
  namespace?: string;
493
473
  /** Coupon scope's applied group (e.g., event or ticket in Wix Events) */
494
474
  group?: Group;
495
475
  }
496
- export interface Group {
476
+ interface Group {
497
477
  /** 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). */
498
478
  name?: string;
499
479
  /** Item ID (when the coupon scope is limited to just one item). */
500
480
  entityId?: string | null;
501
481
  }
502
- export interface ItemType extends ItemTypeItemTypeDataOneOf {
482
+ interface ItemType extends ItemTypeItemTypeDataOneOf {
503
483
  /** Preset item type. */
504
484
  preset?: ItemTypeItemTypeWithLiterals;
505
485
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
506
486
  custom?: string;
507
487
  }
508
488
  /** @oneof */
509
- export interface ItemTypeItemTypeDataOneOf {
489
+ interface ItemTypeItemTypeDataOneOf {
510
490
  /** Preset item type. */
511
491
  preset?: ItemTypeItemTypeWithLiterals;
512
492
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
513
493
  custom?: string;
514
494
  }
515
- export declare enum ItemTypeItemType {
495
+ declare enum ItemTypeItemType {
516
496
  UNRECOGNISED = "UNRECOGNISED",
517
497
  PHYSICAL = "PHYSICAL",
518
498
  DIGITAL = "DIGITAL",
@@ -520,8 +500,8 @@ export declare enum ItemTypeItemType {
520
500
  SERVICE = "SERVICE"
521
501
  }
522
502
  /** @enumType */
523
- export type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
524
- export interface SubscriptionOptionInfo {
503
+ type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
504
+ interface SubscriptionOptionInfo {
525
505
  /** Subscription option settings. */
526
506
  subscriptionSettings?: SubscriptionSettings;
527
507
  /** Subscription option title. */
@@ -529,7 +509,7 @@ export interface SubscriptionOptionInfo {
529
509
  /** Subscription option description. */
530
510
  description?: Description;
531
511
  }
532
- export interface SubscriptionSettings {
512
+ interface SubscriptionSettings {
533
513
  /** Frequency of recurring payment. */
534
514
  frequency?: SubscriptionFrequencyWithLiterals;
535
515
  /**
@@ -557,7 +537,7 @@ export interface SubscriptionSettings {
557
537
  freeTrialPeriod?: FreeTrialPeriod;
558
538
  }
559
539
  /** Frequency unit of recurring payment */
560
- export declare enum SubscriptionFrequency {
540
+ declare enum SubscriptionFrequency {
561
541
  UNDEFINED = "UNDEFINED",
562
542
  DAY = "DAY",
563
543
  WEEK = "WEEK",
@@ -565,8 +545,8 @@ export declare enum SubscriptionFrequency {
565
545
  YEAR = "YEAR"
566
546
  }
567
547
  /** @enumType */
568
- export type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
569
- export interface FreeTrialPeriod {
548
+ type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
549
+ interface FreeTrialPeriod {
570
550
  /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
571
551
  frequency?: SubscriptionFrequencyWithLiterals;
572
552
  /**
@@ -576,7 +556,7 @@ export interface FreeTrialPeriod {
576
556
  */
577
557
  interval?: number;
578
558
  }
579
- export interface Title {
559
+ interface Title {
580
560
  /**
581
561
  * 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).
582
562
  * @minLength 1
@@ -592,7 +572,7 @@ export interface Title {
592
572
  */
593
573
  translated?: string | null;
594
574
  }
595
- export interface Description {
575
+ interface Description {
596
576
  /**
597
577
  * Subscription option description.
598
578
  * @maxLength 500
@@ -604,13 +584,13 @@ export interface Description {
604
584
  */
605
585
  translated?: string | null;
606
586
  }
607
- export interface SecuredMedia {
587
+ interface SecuredMedia {
608
588
  /**
609
589
  * Media ID in Wix Media Manager.
610
590
  * @minLength 1
611
591
  * @maxLength 100
612
592
  */
613
- id?: string;
593
+ _id?: string;
614
594
  /**
615
595
  * Original filename.
616
596
  * @minLength 1
@@ -620,7 +600,7 @@ export interface SecuredMedia {
620
600
  /** File type. */
621
601
  fileType?: FileTypeWithLiterals;
622
602
  }
623
- export declare enum FileType {
603
+ declare enum FileType {
624
604
  UNSPECIFIED = "UNSPECIFIED",
625
605
  SECURE_PICTURE = "SECURE_PICTURE",
626
606
  SECURE_VIDEO = "SECURE_VIDEO",
@@ -629,9 +609,9 @@ export declare enum FileType {
629
609
  SECURE_ARCHIVE = "SECURE_ARCHIVE"
630
610
  }
631
611
  /** @enumType */
632
- export type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
612
+ type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
633
613
  /** Type of selected payment option for catalog item */
634
- export declare enum PaymentOptionType {
614
+ declare enum PaymentOptionType {
635
615
  /** The entire payment for this item happens as part of the checkout. */
636
616
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
637
617
  /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
@@ -644,8 +624,8 @@ export declare enum PaymentOptionType {
644
624
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
645
625
  }
646
626
  /** @enumType */
647
- export type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
648
- export interface ServiceProperties {
627
+ type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
628
+ interface ServiceProperties {
649
629
  /**
650
630
  * 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.
651
631
  * For example, the start time of a class.
@@ -658,7 +638,7 @@ export interface ServiceProperties {
658
638
  */
659
639
  numberOfParticipants?: number | null;
660
640
  }
661
- export interface PriceDescription {
641
+ interface PriceDescription {
662
642
  /**
663
643
  * __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).
664
644
  * @minLength 1
@@ -675,20 +655,20 @@ export interface PriceDescription {
675
655
  translated?: string | null;
676
656
  }
677
657
  /** Selected Membership */
678
- export interface SelectedMembership {
658
+ interface SelectedMembership {
679
659
  /**
680
660
  * Membership ID.
681
661
  * @minLength 1
682
662
  * @maxLength 100
683
663
  */
684
- id?: string;
664
+ _id?: string;
685
665
  /**
686
666
  * ID of the app providing this payment option.
687
667
  * @format GUID
688
668
  */
689
669
  appId?: string;
690
670
  }
691
- export interface CatalogOverrideFields {
671
+ interface CatalogOverrideFields {
692
672
  /** Item name. */
693
673
  productName?: ProductName;
694
674
  /**
@@ -709,7 +689,7 @@ export interface CatalogOverrideFields {
709
689
  /** Physical properties of the item. */
710
690
  physicalProperties?: PhysicalProperties;
711
691
  /** Item image. */
712
- image?: Image;
692
+ image?: string;
713
693
  /** Payment method selected for the item. */
714
694
  paymentOption?: PaymentOption;
715
695
  /**
@@ -725,19 +705,7 @@ export interface CatalogOverrideFields {
725
705
  */
726
706
  savePaymentMethod?: boolean | null;
727
707
  }
728
- export interface Image {
729
- /** WixMedia image ID. */
730
- id?: string;
731
- /** Original image height. */
732
- height?: number;
733
- /** Original image width. */
734
- width?: number;
735
- /** Image alt text. Optional. */
736
- altText?: string | null;
737
- /** Image filename. Optional. */
738
- filename?: string | null;
739
- }
740
- export interface PaymentOption {
708
+ interface PaymentOption {
741
709
  /**
742
710
  * Type of selected payment option for current item.
743
711
  *
@@ -745,24 +713,24 @@ export interface PaymentOption {
745
713
  */
746
714
  value?: PaymentOptionTypeWithLiterals;
747
715
  }
748
- export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
716
+ interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
749
717
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
750
718
  addressType?: TaxableAddressTypeWithLiterals;
751
719
  }
752
720
  /** @oneof */
753
- export interface TaxableAddressTaxableAddressDataOneOf {
721
+ interface TaxableAddressTaxableAddressDataOneOf {
754
722
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
755
723
  addressType?: TaxableAddressTypeWithLiterals;
756
724
  }
757
- export declare enum TaxableAddressType {
725
+ declare enum TaxableAddressType {
758
726
  UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
759
727
  BUSINESS = "BUSINESS",
760
728
  BILLING = "BILLING",
761
729
  SHIPPING = "SHIPPING"
762
730
  }
763
731
  /** @enumType */
764
- export type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
765
- export interface ExtendedFields {
732
+ type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
733
+ interface ExtendedFields {
766
734
  /**
767
735
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
768
736
  * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -773,7 +741,7 @@ export interface ExtendedFields {
773
741
  */
774
742
  namespaces?: Record<string, Record<string, any>>;
775
743
  }
776
- export interface Policy {
744
+ interface Policy {
777
745
  /**
778
746
  * Policy title - should be translated
779
747
  * @minLength 1
@@ -787,23 +755,23 @@ export interface Policy {
787
755
  */
788
756
  content?: string;
789
757
  }
790
- export interface ModifierGroup {
758
+ interface ModifierGroup {
791
759
  /**
792
760
  * Modifier group id.
793
761
  * @minLength 1
794
762
  * @maxLength 36
795
763
  */
796
- id?: string;
764
+ _id?: string;
797
765
  /** Modifier group name. */
798
766
  name?: TranslatableString;
799
767
  /**
800
768
  * List of modifiers in this group.
801
769
  * @minSize 1
802
- * @maxSize 10
770
+ * @maxSize 25
803
771
  */
804
772
  modifiers?: ItemModifier[];
805
773
  }
806
- export interface TranslatableString {
774
+ interface TranslatableString {
807
775
  /**
808
776
  * __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).
809
777
  *
@@ -824,13 +792,13 @@ export interface TranslatableString {
824
792
  */
825
793
  translated?: string | null;
826
794
  }
827
- export interface ItemModifier {
795
+ interface ItemModifier {
828
796
  /**
829
797
  * Modifier ID.
830
798
  * @minLength 1
831
799
  * @maxLength 36
832
800
  */
833
- id?: string;
801
+ _id?: string;
834
802
  /**
835
803
  * The quantity of this modifier.
836
804
  * @min 1
@@ -845,7 +813,7 @@ export interface ItemModifier {
845
813
  price?: MultiCurrencyPrice;
846
814
  }
847
815
  /** Buyer Info */
848
- export interface BuyerInfo extends BuyerInfoIdOneOf {
816
+ interface BuyerInfo extends BuyerInfoIdOneOf {
849
817
  /**
850
818
  * Visitor ID. If the buyer is **not** a site member.
851
819
  * @format GUID
@@ -876,7 +844,7 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
876
844
  email?: string | null;
877
845
  }
878
846
  /** @oneof */
879
- export interface BuyerInfoIdOneOf {
847
+ interface BuyerInfoIdOneOf {
880
848
  /**
881
849
  * Visitor ID. If the buyer is **not** a site member.
882
850
  * @format GUID
@@ -896,7 +864,7 @@ export interface BuyerInfoIdOneOf {
896
864
  */
897
865
  userId?: string;
898
866
  }
899
- export declare enum WeightUnit {
867
+ declare enum WeightUnit {
900
868
  /** Weight unit can't be classified due to an error. */
901
869
  UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
902
870
  /** Kilograms. */
@@ -905,42 +873,42 @@ export declare enum WeightUnit {
905
873
  LB = "LB"
906
874
  }
907
875
  /** @enumType */
908
- export type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
909
- export interface CartDiscount extends CartDiscountDiscountSourceOneOf {
876
+ type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
877
+ interface CartDiscount extends CartDiscountDiscountSourceOneOf {
910
878
  /** Coupon details. */
911
879
  coupon?: Coupon;
912
880
  /** Merchant discount. */
913
881
  merchantDiscount?: MerchantDiscount;
914
882
  }
915
883
  /** @oneof */
916
- export interface CartDiscountDiscountSourceOneOf {
884
+ interface CartDiscountDiscountSourceOneOf {
917
885
  /** Coupon details. */
918
886
  coupon?: Coupon;
919
887
  /** Merchant discount. */
920
888
  merchantDiscount?: MerchantDiscount;
921
889
  }
922
- export interface Coupon {
890
+ interface Coupon {
923
891
  /** Coupon ID. */
924
- id?: string;
892
+ _id?: string;
925
893
  /** Coupon code. */
926
894
  code?: string;
927
895
  }
928
- export interface MerchantDiscount {
896
+ interface MerchantDiscount {
929
897
  /** Discount value. */
930
898
  amount?: MultiCurrencyPrice;
931
899
  }
932
- export interface DiscountRule {
900
+ interface DiscountRule {
933
901
  /**
934
902
  * Discount rule ID
935
903
  * @format GUID
936
904
  */
937
- id?: string;
905
+ _id?: string;
938
906
  /** Discount rule name */
939
907
  name?: DiscountRuleName;
940
908
  /** Discount value. */
941
909
  amount?: MultiCurrencyPrice;
942
910
  }
943
- export interface DiscountRuleName {
911
+ interface DiscountRuleName {
944
912
  /**
945
913
  * Original discount rule name (in site's default language).
946
914
  * @minLength 1
@@ -954,7 +922,7 @@ export interface DiscountRuleName {
954
922
  */
955
923
  translated?: string | null;
956
924
  }
957
- export declare enum DiscountType {
925
+ declare enum DiscountType {
958
926
  /** "GLOBAL" - discount applies to entire order. */
959
927
  GLOBAL = "GLOBAL",
960
928
  /** "SPECIFIC-ITEMS" - discount applies to specific items. */
@@ -962,17 +930,15 @@ export declare enum DiscountType {
962
930
  /** "SHIPPING" - discount applies to shipping. For example, free shipping. */
963
931
  SHIPPING = "SHIPPING"
964
932
  }
965
- /** @enumType */
966
- export type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
967
933
  /** Billing Info and shipping details */
968
- export interface AddressWithContact {
934
+ interface AddressWithContact {
969
935
  /** Address. */
970
936
  address?: Address;
971
937
  /** Contact details. */
972
938
  contactDetails?: FullAddressContactDetails;
973
939
  }
974
940
  /** Physical address */
975
- export interface Address {
941
+ interface Address {
976
942
  /**
977
943
  * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
978
944
  * @format COUNTRY
@@ -999,7 +965,7 @@ export interface Address {
999
965
  * Main address line (usually street name and number).
1000
966
  * @maxLength 150
1001
967
  */
1002
- addressLine?: string | null;
968
+ addressLine1?: string | null;
1003
969
  /**
1004
970
  * Free text providing more detailed address info. Usually contains apt, suite, floor.
1005
971
  * @maxLength 100
@@ -1016,20 +982,20 @@ export interface Address {
1016
982
  */
1017
983
  subdivisionFullname?: string | null;
1018
984
  }
1019
- export interface StreetAddress {
985
+ interface StreetAddress {
1020
986
  /** Street number. */
1021
987
  number?: string;
1022
988
  /** Street name. */
1023
989
  name?: string;
1024
990
  }
1025
- export interface AddressLocation {
991
+ interface AddressLocation {
1026
992
  /** Address latitude. */
1027
993
  latitude?: number | null;
1028
994
  /** Address longitude. */
1029
995
  longitude?: number | null;
1030
996
  }
1031
997
  /** Full contact details for an address */
1032
- export interface FullAddressContactDetails {
998
+ interface FullAddressContactDetails {
1033
999
  /**
1034
1000
  * First name.
1035
1001
  * @maxLength 100
@@ -1053,9 +1019,9 @@ export interface FullAddressContactDetails {
1053
1019
  /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
1054
1020
  vatId?: VatId;
1055
1021
  }
1056
- export interface VatId {
1022
+ interface VatId {
1057
1023
  /** Customer's tax ID. */
1058
- id?: string;
1024
+ _id?: string;
1059
1025
  /**
1060
1026
  * Tax type.
1061
1027
  *
@@ -1066,7 +1032,7 @@ export interface VatId {
1066
1032
  type?: VatTypeWithLiterals;
1067
1033
  }
1068
1034
  /** tax info types */
1069
- export declare enum VatType {
1035
+ declare enum VatType {
1070
1036
  UNSPECIFIED = "UNSPECIFIED",
1071
1037
  /** CPF - for individual tax payers. */
1072
1038
  CPF = "CPF",
@@ -1074,8 +1040,8 @@ export declare enum VatType {
1074
1040
  CNPJ = "CNPJ"
1075
1041
  }
1076
1042
  /** @enumType */
1077
- export type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
1078
- export interface SelectedShippingOption {
1043
+ type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
1044
+ interface SelectedShippingOption {
1079
1045
  /**
1080
1046
  * Carrier ID.
1081
1047
  * @format GUID
@@ -1088,13 +1054,13 @@ export interface SelectedShippingOption {
1088
1054
  */
1089
1055
  code?: string;
1090
1056
  }
1091
- export interface GetCurrentCartRequest {
1057
+ interface GetCurrentCartRequest {
1092
1058
  }
1093
- export interface GetCurrentCartResponse {
1059
+ interface GetCurrentCartResponse {
1094
1060
  /** Current session's active cart. */
1095
1061
  cart?: Cart;
1096
1062
  }
1097
- export interface UpdateCartRequest {
1063
+ interface UpdateCartRequest {
1098
1064
  /** Cart info. */
1099
1065
  cartInfo?: Cart;
1100
1066
  /** Coupon code. For more information, see the Coupons API. */
@@ -1118,7 +1084,7 @@ export interface UpdateCartRequest {
1118
1084
  */
1119
1085
  customLineItems?: CustomLineItem[];
1120
1086
  }
1121
- export interface MerchantDiscountInput {
1087
+ interface MerchantDiscountInput {
1122
1088
  /**
1123
1089
  * Discount amount.
1124
1090
  * @decimalValue options { gte:0 }
@@ -1131,7 +1097,7 @@ export interface MerchantDiscountInput {
1131
1097
  */
1132
1098
  lineItemIds?: string[];
1133
1099
  }
1134
- export interface CustomLineItem {
1100
+ interface CustomLineItem {
1135
1101
  /**
1136
1102
  * Custom line item quantity.
1137
1103
  *
@@ -1156,15 +1122,19 @@ export interface CustomLineItem {
1156
1122
  * @maxSize 10
1157
1123
  */
1158
1124
  descriptionLines?: DescriptionLine[];
1159
- /** Custom line item's media. */
1160
- media?: Image;
1125
+ /**
1126
+ * Custom line item media. Supported formats:
1127
+ * + Link to an image/video from the [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager) - `"wix:image://v1/3c76e2_c53...4ea4~mv2.jpg#originWidth=1000&originHeight=1000"`.
1128
+ * + An image from the web - `"http(s)://<image url>"`.
1129
+ */
1130
+ media?: string;
1161
1131
  /**
1162
1132
  * Custom line item ID. If passed, `id` must be unique.
1163
1133
  *
1164
1134
  * Default: auto-generated ID
1165
1135
  * @format GUID
1166
1136
  */
1167
- id?: string | null;
1137
+ _id?: string | null;
1168
1138
  /**
1169
1139
  * Tax group ID for this custom line item.
1170
1140
  * @format GUID
@@ -1173,7 +1143,7 @@ export interface CustomLineItem {
1173
1143
  /** Name of the item or product. */
1174
1144
  productName?: ProductName;
1175
1145
  /** URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work. */
1176
- url?: PageUrlV2;
1146
+ url?: string;
1177
1147
  /** Item type. Either a preset type or custom. */
1178
1148
  itemType?: ItemType;
1179
1149
  /**
@@ -1255,30 +1225,35 @@ export interface CustomLineItem {
1255
1225
  membersOnly?: boolean;
1256
1226
  /** Address to use for tax calculation purposes. */
1257
1227
  taxableAddress?: TaxableAddress;
1228
+ /**
1229
+ * Modifier groups that were added to the item.
1230
+ * @maxSize 25
1231
+ */
1232
+ modifierGroups?: V1ModifierGroup[];
1258
1233
  }
1259
- export interface V1ModifierGroup {
1234
+ interface V1ModifierGroup {
1260
1235
  /**
1261
1236
  * Modifier group id.
1262
1237
  * @minLength 1
1263
1238
  * @maxLength 36
1264
1239
  */
1265
- id?: string;
1240
+ _id?: string;
1266
1241
  /** Modifier group name. */
1267
1242
  name?: TranslatableString;
1268
1243
  /**
1269
1244
  * List of modifiers in this group.
1270
1245
  * @minSize 1
1271
- * @maxSize 10
1246
+ * @maxSize 25
1272
1247
  */
1273
1248
  modifiers?: V1ItemModifier[];
1274
1249
  }
1275
- export interface V1ItemModifier {
1250
+ interface V1ItemModifier {
1276
1251
  /**
1277
1252
  * Modifier ID.
1278
1253
  * @minLength 1
1279
1254
  * @maxLength 36
1280
1255
  */
1281
- id?: string;
1256
+ _id?: string;
1282
1257
  /**
1283
1258
  * The quantity of this modifier.
1284
1259
  * @min 1
@@ -1295,11 +1270,11 @@ export interface V1ItemModifier {
1295
1270
  */
1296
1271
  price?: string | null;
1297
1272
  }
1298
- export interface UpdateCartResponse {
1273
+ interface UpdateCartResponse {
1299
1274
  /** Updated Cart. */
1300
1275
  cart?: Cart;
1301
1276
  }
1302
- export interface AddToCurrentCartRequest {
1277
+ interface AddToCurrentCartRequest {
1303
1278
  /**
1304
1279
  * Catalog line items.
1305
1280
  * @maxSize 100
@@ -1321,11 +1296,11 @@ export interface AddToCurrentCartRequest {
1321
1296
  */
1322
1297
  businessLocationId?: string | null;
1323
1298
  }
1324
- export interface AddToCartResponse {
1299
+ interface AddToCartResponse {
1325
1300
  /** Updated cart. */
1326
1301
  cart?: Cart;
1327
1302
  }
1328
- export interface AddToCurrentCartAndEstimateTotalsRequest {
1303
+ interface AddToCurrentCartAndEstimateTotalsRequest {
1329
1304
  /**
1330
1305
  * Catalog line items.
1331
1306
  * @maxSize 100
@@ -1360,20 +1335,20 @@ export interface AddToCurrentCartAndEstimateTotalsRequest {
1360
1335
  */
1361
1336
  calculateShipping?: boolean | null;
1362
1337
  }
1363
- export interface SelectedMemberships {
1338
+ interface SelectedMemberships {
1364
1339
  /**
1365
1340
  * Selected memberships.
1366
1341
  * @maxSize 300
1367
1342
  */
1368
1343
  memberships?: HostSelectedMembership[];
1369
1344
  }
1370
- export interface HostSelectedMembership {
1345
+ interface HostSelectedMembership {
1371
1346
  /**
1372
1347
  * Membership ID.
1373
1348
  * @minLength 1
1374
1349
  * @maxLength 100
1375
1350
  */
1376
- id?: string;
1351
+ _id?: string;
1377
1352
  /**
1378
1353
  * ID of the app providing this payment option.
1379
1354
  * @format GUID
@@ -1388,7 +1363,7 @@ export interface HostSelectedMembership {
1388
1363
  */
1389
1364
  lineItemIds?: string[];
1390
1365
  }
1391
- export interface EstimateTotalsResponse {
1366
+ interface EstimateTotalsResponse {
1392
1367
  /** Cart. */
1393
1368
  cart?: Cart;
1394
1369
  /** Calculated line items. */
@@ -1435,7 +1410,7 @@ export interface EstimateTotalsResponse {
1435
1410
  */
1436
1411
  violations?: Violation[];
1437
1412
  }
1438
- export interface CalculatedLineItem {
1413
+ interface CalculatedLineItem {
1439
1414
  /** Line item ID. */
1440
1415
  lineItemId?: string;
1441
1416
  /** Price breakdown for this line item. */
@@ -1451,7 +1426,7 @@ export interface CalculatedLineItem {
1451
1426
  /** tax calculation address. */
1452
1427
  taxableAddress?: TaxableAddress;
1453
1428
  }
1454
- export interface LineItemPricesData {
1429
+ interface LineItemPricesData {
1455
1430
  /** Total price after discounts, tax, and modifiers. */
1456
1431
  totalPriceAfterTax?: MultiCurrencyPrice;
1457
1432
  /** Total price after discounts and modifiers, and before tax. */
@@ -1475,7 +1450,7 @@ export interface LineItemPricesData {
1475
1450
  */
1476
1451
  fullPrice?: MultiCurrencyPrice;
1477
1452
  }
1478
- export interface ItemTaxFullDetails {
1453
+ interface ItemTaxFullDetails {
1479
1454
  /** Amount for which tax is calculated. */
1480
1455
  taxableAmount?: MultiCurrencyPrice;
1481
1456
  /**
@@ -1492,7 +1467,7 @@ export interface ItemTaxFullDetails {
1492
1467
  */
1493
1468
  rateBreakdown?: TaxRateBreakdown[];
1494
1469
  }
1495
- export interface TaxRateBreakdown {
1470
+ interface TaxRateBreakdown {
1496
1471
  /**
1497
1472
  * Name of tax against which the calculation was performed.
1498
1473
  * @maxLength 100
@@ -1510,7 +1485,7 @@ export interface TaxRateBreakdown {
1510
1485
  * TaxBreakdown represents tax information for a line item.
1511
1486
  * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
1512
1487
  */
1513
- export interface TaxBreakdown {
1488
+ interface TaxBreakdown {
1514
1489
  /**
1515
1490
  * The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
1516
1491
  * @maxLength 200
@@ -1542,7 +1517,7 @@ export interface TaxBreakdown {
1542
1517
  jurisdictionType?: JurisdictionTypeWithLiterals;
1543
1518
  }
1544
1519
  /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
1545
- export declare enum JurisdictionType {
1520
+ declare enum JurisdictionType {
1546
1521
  UNDEFINED = "UNDEFINED",
1547
1522
  COUNTRY = "COUNTRY",
1548
1523
  STATE = "STATE",
@@ -1551,14 +1526,14 @@ export declare enum JurisdictionType {
1551
1526
  SPECIAL = "SPECIAL"
1552
1527
  }
1553
1528
  /** @enumType */
1554
- export type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
1555
- export interface CalculatedItemModifier {
1529
+ type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
1530
+ interface CalculatedItemModifier {
1556
1531
  /**
1557
1532
  * Modifier ID.
1558
1533
  * @minLength 1
1559
1534
  * @maxLength 36
1560
1535
  */
1561
- id?: string;
1536
+ _id?: string;
1562
1537
  /**
1563
1538
  * ID of the group this modifier belongs to.
1564
1539
  * @minLength 1
@@ -1571,7 +1546,7 @@ export interface CalculatedItemModifier {
1571
1546
  */
1572
1547
  price?: MultiCurrencyPrice;
1573
1548
  }
1574
- export interface PriceSummary {
1549
+ interface PriceSummary {
1575
1550
  /** Subtotal of all line items, before discounts and before tax. */
1576
1551
  subtotal?: MultiCurrencyPrice;
1577
1552
  /** Total shipping price, before discounts and before tax. */
@@ -1585,12 +1560,12 @@ export interface PriceSummary {
1585
1560
  /** Total additional fees price before tax. */
1586
1561
  additionalFees?: MultiCurrencyPrice;
1587
1562
  }
1588
- export interface GiftCard {
1563
+ interface GiftCard {
1589
1564
  /**
1590
1565
  * Gift Card ID.
1591
1566
  * @deprecated
1592
1567
  */
1593
- id?: string;
1568
+ _id?: string;
1594
1569
  /** Gift card obfuscated code. */
1595
1570
  obfuscatedCode?: string;
1596
1571
  /** Gift card value. */
@@ -1608,7 +1583,7 @@ export interface GiftCard {
1608
1583
  */
1609
1584
  externalId?: string | null;
1610
1585
  }
1611
- export interface TaxSummary {
1586
+ interface TaxSummary {
1612
1587
  /**
1613
1588
  * Amount for which tax is calculated, added from line items.
1614
1589
  * @readonly
@@ -1625,7 +1600,7 @@ export interface TaxSummary {
1625
1600
  */
1626
1601
  calculationDetails?: TaxCalculationDetails;
1627
1602
  }
1628
- export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
1603
+ interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
1629
1604
  /** Reason the manual calculation was used. */
1630
1605
  manualRateReason?: ManualCalculationReasonWithLiterals;
1631
1606
  /** Details of the fallback rate calculation. */
@@ -1634,13 +1609,13 @@ export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationD
1634
1609
  rateType?: RateTypeWithLiterals;
1635
1610
  }
1636
1611
  /** @oneof */
1637
- export interface TaxCalculationDetailsCalculationDetailsOneOf {
1612
+ interface TaxCalculationDetailsCalculationDetailsOneOf {
1638
1613
  /** Reason the manual calculation was used. */
1639
1614
  manualRateReason?: ManualCalculationReasonWithLiterals;
1640
1615
  /** Details of the fallback rate calculation. */
1641
1616
  autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
1642
1617
  }
1643
- export declare enum RateType {
1618
+ declare enum RateType {
1644
1619
  /** no tax being collected for this request due to location of purchase */
1645
1620
  NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
1646
1621
  /** manual rate used for calculation */
@@ -1651,30 +1626,30 @@ export declare enum RateType {
1651
1626
  FALLBACK_RATE = "FALLBACK_RATE"
1652
1627
  }
1653
1628
  /** @enumType */
1654
- export type RateTypeWithLiterals = RateType | 'NO_TAX_COLLECTED' | 'MANUAL_RATE' | 'AUTO_RATE' | 'FALLBACK_RATE';
1655
- export declare enum ManualCalculationReason {
1629
+ type RateTypeWithLiterals = RateType | 'NO_TAX_COLLECTED' | 'MANUAL_RATE' | 'AUTO_RATE' | 'FALLBACK_RATE';
1630
+ declare enum ManualCalculationReason {
1656
1631
  /** user set calculator in Business Manager to be Manual */
1657
1632
  GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
1658
1633
  /** specific region is on manual even though Global setting is Auto-tax */
1659
1634
  REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
1660
1635
  }
1661
1636
  /** @enumType */
1662
- export type ManualCalculationReasonWithLiterals = ManualCalculationReason | 'GLOBAL_SETTING_TO_MANUAL' | 'REGION_SETTING_TO_MANUAL';
1663
- export interface AutoTaxFallbackCalculationDetails {
1637
+ type ManualCalculationReasonWithLiterals = ManualCalculationReason | 'GLOBAL_SETTING_TO_MANUAL' | 'REGION_SETTING_TO_MANUAL';
1638
+ interface AutoTaxFallbackCalculationDetails {
1664
1639
  /** reason for fallback */
1665
1640
  fallbackReason?: FallbackReasonWithLiterals;
1666
1641
  /** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
1667
1642
  error?: ApplicationError;
1668
1643
  }
1669
- export declare enum FallbackReason {
1644
+ declare enum FallbackReason {
1670
1645
  /** auto-tax failed to be calculated */
1671
1646
  AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
1672
1647
  /** auto-tax was temporarily deactivated on a system-level */
1673
1648
  AUTO_TAX_DEACTIVATED = "AUTO_TAX_DEACTIVATED"
1674
1649
  }
1675
1650
  /** @enumType */
1676
- export type FallbackReasonWithLiterals = FallbackReason | 'AUTO_TAX_FAILED' | 'AUTO_TAX_DEACTIVATED';
1677
- export interface ApplicationError {
1651
+ type FallbackReasonWithLiterals = FallbackReason | 'AUTO_TAX_FAILED' | 'AUTO_TAX_DEACTIVATED';
1652
+ interface ApplicationError {
1678
1653
  /** Error code. */
1679
1654
  code?: string;
1680
1655
  /** Description of the error. */
@@ -1686,7 +1661,7 @@ export interface ApplicationError {
1686
1661
  * 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.
1687
1662
  * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
1688
1663
  */
1689
- export interface AggregatedTaxBreakdown {
1664
+ interface AggregatedTaxBreakdown {
1690
1665
  /**
1691
1666
  * The name of the tax against which this tax amount was calculated.
1692
1667
  * @maxLength 200
@@ -1712,7 +1687,7 @@ export interface AggregatedTaxBreakdown {
1712
1687
  /** The sum of all the tax from line items that calculated by the tax identifiers. */
1713
1688
  aggregatedTaxAmount?: MultiCurrencyPrice;
1714
1689
  }
1715
- export interface ShippingInformation {
1690
+ interface ShippingInformation {
1716
1691
  /** Shipping region. */
1717
1692
  region?: ShippingRegion;
1718
1693
  /** Selected shipping option. */
@@ -1720,20 +1695,20 @@ export interface ShippingInformation {
1720
1695
  /** All shipping options. */
1721
1696
  carrierServiceOptions?: CarrierServiceOption[];
1722
1697
  }
1723
- export interface ShippingRegion {
1698
+ interface ShippingRegion {
1724
1699
  /**
1725
1700
  * Shipping region ID.
1726
1701
  * @format GUID
1727
1702
  * @readonly
1728
1703
  */
1729
- id?: string;
1704
+ _id?: string;
1730
1705
  /**
1731
1706
  * Shipping region name.
1732
1707
  * @maxLength 100
1733
1708
  */
1734
1709
  name?: string;
1735
1710
  }
1736
- export interface SelectedCarrierServiceOption {
1711
+ interface SelectedCarrierServiceOption {
1737
1712
  /**
1738
1713
  * Unique identifier of selected option. For example, "usps_std_overnight".
1739
1714
  * @maxLength 100
@@ -1781,7 +1756,7 @@ export interface SelectedCarrierServiceOption {
1781
1756
  /** If the delivery solution is a partial and doesn't apply to all items. */
1782
1757
  partial?: boolean | null;
1783
1758
  }
1784
- export interface DeliveryLogistics {
1759
+ interface DeliveryLogistics {
1785
1760
  /**
1786
1761
  * Expected delivery time, in free text. For example, "3-5 business days".
1787
1762
  * @maxLength 500
@@ -1795,7 +1770,7 @@ export interface DeliveryLogistics {
1795
1770
  /** Pickup details. */
1796
1771
  pickupDetails?: PickupDetails;
1797
1772
  }
1798
- export interface PickupDetails {
1773
+ interface PickupDetails {
1799
1774
  /** Pickup address. */
1800
1775
  address?: Address;
1801
1776
  /**
@@ -1806,20 +1781,20 @@ export interface PickupDetails {
1806
1781
  /** Pickup method */
1807
1782
  pickupMethod?: PickupMethodWithLiterals;
1808
1783
  }
1809
- export declare enum PickupMethod {
1784
+ declare enum PickupMethod {
1810
1785
  UNKNOWN_METHOD = "UNKNOWN_METHOD",
1811
1786
  STORE_PICKUP = "STORE_PICKUP",
1812
1787
  PICKUP_POINT = "PICKUP_POINT"
1813
1788
  }
1814
1789
  /** @enumType */
1815
- export type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
1816
- export interface DeliveryTimeSlot {
1790
+ type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
1791
+ interface DeliveryTimeSlot {
1817
1792
  /** starting time of the delivery time slot */
1818
1793
  from?: Date | null;
1819
1794
  /** ending time of the delivery time slot */
1820
1795
  to?: Date | null;
1821
1796
  }
1822
- export interface SelectedCarrierServiceOptionPrices {
1797
+ interface SelectedCarrierServiceOptionPrices {
1823
1798
  /** Total shipping price, after discount and after tax. */
1824
1799
  totalPriceAfterTax?: MultiCurrencyPrice;
1825
1800
  /** Total price of shipping after discounts (when relevant), and before tax. */
@@ -1831,7 +1806,7 @@ export interface SelectedCarrierServiceOptionPrices {
1831
1806
  /** Shipping price before discount and before tax. */
1832
1807
  price?: MultiCurrencyPrice;
1833
1808
  }
1834
- export interface SelectedCarrierServiceOptionOtherCharge {
1809
+ interface SelectedCarrierServiceOptionOtherCharge {
1835
1810
  /** Type of additional cost. */
1836
1811
  type?: ChargeTypeWithLiterals;
1837
1812
  /**
@@ -1842,13 +1817,13 @@ export interface SelectedCarrierServiceOptionOtherCharge {
1842
1817
  /** Price of added charge. */
1843
1818
  cost?: SelectedCarrierServiceOptionPrices;
1844
1819
  }
1845
- export declare enum ChargeType {
1820
+ declare enum ChargeType {
1846
1821
  HANDLING_FEE = "HANDLING_FEE",
1847
1822
  INSURANCE = "INSURANCE"
1848
1823
  }
1849
1824
  /** @enumType */
1850
- export type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE' | 'INSURANCE';
1851
- export interface DeliveryAllocation {
1825
+ type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE' | 'INSURANCE';
1826
+ interface DeliveryAllocation {
1852
1827
  /** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
1853
1828
  deliveryCarrier?: Carrier;
1854
1829
  /** The delivery region that are relevant for this delivery solution. */
@@ -1856,7 +1831,7 @@ export interface DeliveryAllocation {
1856
1831
  /** Populated if the delivery solution is a partially supplied by this carrier. */
1857
1832
  applicableLineItems?: ApplicableLineItems;
1858
1833
  }
1859
- export interface Carrier {
1834
+ interface Carrier {
1860
1835
  /**
1861
1836
  * The carrier app id
1862
1837
  * @format GUID
@@ -1868,19 +1843,19 @@ export interface Carrier {
1868
1843
  */
1869
1844
  code?: string;
1870
1845
  }
1871
- export interface Region {
1846
+ interface Region {
1872
1847
  /**
1873
1848
  * The delivery region id.
1874
1849
  * @format GUID
1875
1850
  */
1876
- id?: string | null;
1851
+ _id?: string | null;
1877
1852
  /**
1878
1853
  * The delivery region name.
1879
1854
  * @maxLength 100
1880
1855
  */
1881
1856
  name?: string | null;
1882
1857
  }
1883
- export interface ApplicableLineItems {
1858
+ interface ApplicableLineItems {
1884
1859
  /**
1885
1860
  * Line items that the delivery solution is for.
1886
1861
  * @maxSize 300
@@ -1889,7 +1864,7 @@ export interface ApplicableLineItems {
1889
1864
  */
1890
1865
  lineItemIds?: string[];
1891
1866
  }
1892
- export interface CarrierServiceOption {
1867
+ interface CarrierServiceOption {
1893
1868
  /**
1894
1869
  * Carrier ID.
1895
1870
  * @format GUID
@@ -1898,7 +1873,7 @@ export interface CarrierServiceOption {
1898
1873
  /** Shipping options offered by this carrier for this request. */
1899
1874
  shippingOptions?: ShippingOption[];
1900
1875
  }
1901
- export interface ShippingOption {
1876
+ interface ShippingOption {
1902
1877
  /**
1903
1878
  * Unique code of provided shipping option like "usps_std_overnight".
1904
1879
  * For legacy calculators this would be the UUID of the option.
@@ -1923,13 +1898,13 @@ export interface ShippingOption {
1923
1898
  /** If the delivery solution is a partial and doesn't apply to all items. */
1924
1899
  partial?: boolean | null;
1925
1900
  }
1926
- export interface ShippingPrice {
1901
+ interface ShippingPrice {
1927
1902
  /** Shipping price. */
1928
1903
  price?: MultiCurrencyPrice;
1929
1904
  /** Other costs such as insurance, handling & packaging for fragile items, etc. */
1930
1905
  otherCharges?: OtherCharge[];
1931
1906
  }
1932
- export interface OtherCharge {
1907
+ interface OtherCharge {
1933
1908
  /** Type of additional cost. */
1934
1909
  type?: ChargeTypeWithLiterals;
1935
1910
  /** Price of added cost. */
@@ -1940,7 +1915,7 @@ export interface OtherCharge {
1940
1915
  */
1941
1916
  details?: string | null;
1942
1917
  }
1943
- export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1918
+ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1944
1919
  /** Coupon details. */
1945
1920
  coupon?: V1Coupon;
1946
1921
  /** Merchant discount. */
@@ -1959,7 +1934,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1959
1934
  lineItemIds?: string[];
1960
1935
  }
1961
1936
  /** @oneof */
1962
- export interface AppliedDiscountDiscountSourceOneOf {
1937
+ interface AppliedDiscountDiscountSourceOneOf {
1963
1938
  /** Coupon details. */
1964
1939
  coupon?: V1Coupon;
1965
1940
  /** Merchant discount. */
@@ -1967,17 +1942,17 @@ export interface AppliedDiscountDiscountSourceOneOf {
1967
1942
  /** Discount rule */
1968
1943
  discountRule?: V1DiscountRule;
1969
1944
  }
1970
- export declare enum AppliedDiscountDiscountType {
1945
+ declare enum AppliedDiscountDiscountType {
1971
1946
  GLOBAL = "GLOBAL",
1972
1947
  SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
1973
1948
  SHIPPING = "SHIPPING"
1974
1949
  }
1975
1950
  /** @enumType */
1976
- export type AppliedDiscountDiscountTypeWithLiterals = AppliedDiscountDiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
1951
+ type AppliedDiscountDiscountTypeWithLiterals = AppliedDiscountDiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
1977
1952
  /** Coupon */
1978
- export interface V1Coupon {
1953
+ interface V1Coupon {
1979
1954
  /** Coupon ID. */
1980
- id?: string;
1955
+ _id?: string;
1981
1956
  /** Coupon code. */
1982
1957
  code?: string;
1983
1958
  /** Coupon value. */
@@ -1985,7 +1960,7 @@ export interface V1Coupon {
1985
1960
  /** Coupon name. */
1986
1961
  name?: string;
1987
1962
  }
1988
- export interface V1MerchantDiscount {
1963
+ interface V1MerchantDiscount {
1989
1964
  /** Discount value. */
1990
1965
  amount?: MultiCurrencyPrice;
1991
1966
  /**
@@ -1995,18 +1970,18 @@ export interface V1MerchantDiscount {
1995
1970
  */
1996
1971
  percentage?: number | null;
1997
1972
  }
1998
- export interface V1DiscountRule {
1973
+ interface V1DiscountRule {
1999
1974
  /**
2000
1975
  * Discount rule ID
2001
1976
  * @format GUID
2002
1977
  */
2003
- id?: string;
1978
+ _id?: string;
2004
1979
  /** Discount rule name */
2005
1980
  name?: V1DiscountRuleName;
2006
1981
  /** Discount value. */
2007
1982
  amount?: MultiCurrencyPrice;
2008
1983
  }
2009
- export interface V1DiscountRuleName {
1984
+ interface V1DiscountRuleName {
2010
1985
  /**
2011
1986
  * Original discount rule name (in site's default language).
2012
1987
  * @minLength 1
@@ -2020,16 +1995,16 @@ export interface V1DiscountRuleName {
2020
1995
  */
2021
1996
  translated?: string | null;
2022
1997
  }
2023
- export interface LineItemDiscount {
1998
+ interface LineItemDiscount {
2024
1999
  /**
2025
2000
  * ID of line item the discount applies to.
2026
2001
  * @format GUID
2027
2002
  */
2028
- id?: string;
2003
+ _id?: string;
2029
2004
  /** Discount value. */
2030
2005
  totalDiscountAmount?: MultiCurrencyPrice;
2031
2006
  }
2032
- export interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
2007
+ interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
2033
2008
  /** General shipping calculation error. */
2034
2009
  generalShippingCalculationError?: Details;
2035
2010
  /** Carrier errors. */
@@ -2051,13 +2026,13 @@ export interface CalculationErrors extends CalculationErrorsShippingCalculationE
2051
2026
  discountsCalculationError?: Details;
2052
2027
  }
2053
2028
  /** @oneof */
2054
- export interface CalculationErrorsShippingCalculationErrorOneOf {
2029
+ interface CalculationErrorsShippingCalculationErrorOneOf {
2055
2030
  /** General shipping calculation error. */
2056
2031
  generalShippingCalculationError?: Details;
2057
2032
  /** Carrier errors. */
2058
2033
  carrierErrors?: CarrierErrors;
2059
2034
  }
2060
- export interface Details extends DetailsKindOneOf {
2035
+ interface Details extends DetailsKindOneOf {
2061
2036
  applicationError?: ApplicationError;
2062
2037
  validationError?: ValidationError;
2063
2038
  systemError?: SystemError;
@@ -2068,7 +2043,7 @@ export interface Details extends DetailsKindOneOf {
2068
2043
  tracing?: Record<string, string>;
2069
2044
  }
2070
2045
  /** @oneof */
2071
- export interface DetailsKindOneOf {
2046
+ interface DetailsKindOneOf {
2072
2047
  applicationError?: ApplicationError;
2073
2048
  validationError?: ValidationError;
2074
2049
  systemError?: SystemError;
@@ -2105,10 +2080,10 @@ export interface DetailsKindOneOf {
2105
2080
  * ]
2106
2081
  * }
2107
2082
  */
2108
- export interface ValidationError {
2083
+ interface ValidationError {
2109
2084
  fieldViolations?: FieldViolation[];
2110
2085
  }
2111
- export declare enum RuleType {
2086
+ declare enum RuleType {
2112
2087
  VALIDATION = "VALIDATION",
2113
2088
  OTHER = "OTHER",
2114
2089
  MAX = "MAX",
@@ -2132,8 +2107,8 @@ export declare enum RuleType {
2132
2107
  REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
2133
2108
  }
2134
2109
  /** @enumType */
2135
- 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';
2136
- export interface FieldViolation {
2110
+ 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';
2111
+ interface FieldViolation {
2137
2112
  field?: string;
2138
2113
  description?: string;
2139
2114
  violatedRule?: RuleTypeWithLiterals;
@@ -2141,21 +2116,21 @@ export interface FieldViolation {
2141
2116
  ruleName?: string | null;
2142
2117
  data?: Record<string, any> | null;
2143
2118
  }
2144
- export interface SystemError {
2119
+ interface SystemError {
2145
2120
  /** Error code. */
2146
2121
  errorCode?: string | null;
2147
2122
  }
2148
- export interface CarrierErrors {
2123
+ interface CarrierErrors {
2149
2124
  /** Carrier errors. */
2150
2125
  errors?: CarrierError[];
2151
2126
  }
2152
- export interface CarrierError {
2127
+ interface CarrierError {
2153
2128
  /** Carrier ID. */
2154
2129
  carrierId?: string;
2155
2130
  /** Error details. */
2156
2131
  error?: Details;
2157
2132
  }
2158
- export interface MembershipOptions {
2133
+ interface MembershipOptions {
2159
2134
  /**
2160
2135
  * List of payment options that can be used.
2161
2136
  * @maxSize 300
@@ -2172,13 +2147,13 @@ export interface MembershipOptions {
2172
2147
  */
2173
2148
  selectedMemberships?: HostSelectedMembership[];
2174
2149
  }
2175
- export interface Membership {
2150
+ interface Membership {
2176
2151
  /**
2177
2152
  * Membership ID.
2178
2153
  * @minLength 1
2179
2154
  * @maxLength 100
2180
2155
  */
2181
- id?: string;
2156
+ _id?: string;
2182
2157
  /**
2183
2158
  * ID of the application providing this payment option.
2184
2159
  * @format GUID
@@ -2201,7 +2176,7 @@ export interface Membership {
2201
2176
  /** Additional data about this membership. */
2202
2177
  additionalData?: Record<string, any> | null;
2203
2178
  }
2204
- export interface MembershipName {
2179
+ interface MembershipName {
2205
2180
  /**
2206
2181
  * Membership name.
2207
2182
  * @maxLength 100
@@ -2213,7 +2188,7 @@ export interface MembershipName {
2213
2188
  */
2214
2189
  translated?: string | null;
2215
2190
  }
2216
- export interface MembershipPaymentCredits {
2191
+ interface MembershipPaymentCredits {
2217
2192
  /**
2218
2193
  * Membership's total amount of credits.
2219
2194
  * @min 1
@@ -2222,7 +2197,7 @@ export interface MembershipPaymentCredits {
2222
2197
  /** Membership's remaining amount of credits. */
2223
2198
  remaining?: number;
2224
2199
  }
2225
- export interface InvalidMembership {
2200
+ interface InvalidMembership {
2226
2201
  /** Membership details. */
2227
2202
  membership?: Membership;
2228
2203
  /**
@@ -2232,7 +2207,7 @@ export interface InvalidMembership {
2232
2207
  */
2233
2208
  reason?: string;
2234
2209
  }
2235
- export interface AdditionalFee {
2210
+ interface AdditionalFee {
2236
2211
  /**
2237
2212
  * Additional fee's unique code (or ID) for future processing.
2238
2213
  * @minLength 1
@@ -2268,7 +2243,7 @@ export interface AdditionalFee {
2268
2243
  /** the source the additional fee was added from */
2269
2244
  source?: AdditionalFeeSourceWithLiterals;
2270
2245
  }
2271
- export declare enum AdditionalFeeSource {
2246
+ declare enum AdditionalFeeSource {
2272
2247
  UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
2273
2248
  /** The additional fee was added by an additional fee service plugin */
2274
2249
  SERVICE_PLUGIN = "SERVICE_PLUGIN",
@@ -2280,8 +2255,8 @@ export declare enum AdditionalFeeSource {
2280
2255
  SHIPPING = "SHIPPING"
2281
2256
  }
2282
2257
  /** @enumType */
2283
- export type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING';
2284
- export interface Violation {
2258
+ type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING';
2259
+ interface Violation {
2285
2260
  /** 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. */
2286
2261
  severity?: SeverityWithLiterals;
2287
2262
  /** Target location on a checkout or cart page where the violation will be displayed. */
@@ -2293,7 +2268,7 @@ export interface Violation {
2293
2268
  */
2294
2269
  description?: string | null;
2295
2270
  }
2296
- export declare enum Severity {
2271
+ declare enum Severity {
2297
2272
  /** The user is allowed to move forward in the flow. */
2298
2273
  WARNING = "WARNING",
2299
2274
  /**
@@ -2303,55 +2278,53 @@ export declare enum Severity {
2303
2278
  ERROR = "ERROR"
2304
2279
  }
2305
2280
  /** @enumType */
2306
- export type SeverityWithLiterals = Severity | 'WARNING' | 'ERROR';
2307
- export interface Target extends TargetTargetTypeOneOf {
2281
+ type SeverityWithLiterals = Severity | 'WARNING' | 'ERROR';
2282
+ interface Target extends TargetTargetTypeOneOf {
2308
2283
  /** General (other) violation. */
2309
2284
  other?: Other;
2310
2285
  /** Specific line item violation. */
2311
2286
  lineItem?: TargetLineItem;
2312
2287
  }
2313
2288
  /** @oneof */
2314
- export interface TargetTargetTypeOneOf {
2289
+ interface TargetTargetTypeOneOf {
2315
2290
  /** General (other) violation. */
2316
2291
  other?: Other;
2317
2292
  /** Specific line item violation. */
2318
2293
  lineItem?: TargetLineItem;
2319
2294
  }
2320
2295
  /** Available locations on the webpage */
2321
- export declare enum NameInOther {
2296
+ declare enum NameInOther {
2322
2297
  /** Default location, in case no specific location is specified. */
2323
2298
  OTHER_DEFAULT = "OTHER_DEFAULT"
2324
2299
  }
2325
2300
  /** @enumType */
2326
- export type NameInOtherWithLiterals = NameInOther | 'OTHER_DEFAULT';
2301
+ type NameInOtherWithLiterals = NameInOther | 'OTHER_DEFAULT';
2327
2302
  /** Available locations on the line item */
2328
- export declare enum NameInLineItem {
2303
+ declare enum NameInLineItem {
2329
2304
  /** Default location, in case no specific location is specified. */
2330
2305
  LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
2331
2306
  }
2332
2307
  /** @enumType */
2333
- export type NameInLineItemWithLiterals = NameInLineItem | 'LINE_ITEM_DEFAULT';
2334
- export declare enum SuggestedFix {
2308
+ type NameInLineItemWithLiterals = NameInLineItem | 'LINE_ITEM_DEFAULT';
2309
+ declare enum SuggestedFix {
2335
2310
  /** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
2336
2311
  UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
2337
2312
  /** The line item should be removed from the cart or checkout to resolve the violation. */
2338
2313
  REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
2339
2314
  }
2340
- /** @enumType */
2341
- export type SuggestedFixWithLiterals = SuggestedFix | 'UNKNOWN_SUGGESTED_FIX' | 'REMOVE_LINE_ITEM';
2342
2315
  /** General (other) violation. */
2343
- export interface Other {
2316
+ interface Other {
2344
2317
  /** Location on a checkout or a cart page where a general (other) violation will be displayed. */
2345
2318
  name?: NameInOtherWithLiterals;
2346
2319
  }
2347
2320
  /** Specific line item violation. */
2348
- export interface TargetLineItem {
2321
+ interface TargetLineItem {
2349
2322
  /** Location on a checkout or a cart page where the specific line item violation will be displayed. */
2350
2323
  name?: NameInLineItemWithLiterals;
2351
2324
  /** ID of the line item containing the violation. */
2352
- id?: string | null;
2325
+ _id?: string | null;
2353
2326
  }
2354
- export interface RemoveLineItemsFromCurrentCartRequest {
2327
+ interface RemoveLineItemsFromCurrentCartRequest {
2355
2328
  /**
2356
2329
  * Line item IDs to remove from cart.
2357
2330
  * @format GUID
@@ -2360,11 +2333,11 @@ export interface RemoveLineItemsFromCurrentCartRequest {
2360
2333
  */
2361
2334
  lineItemIds: string[];
2362
2335
  }
2363
- export interface RemoveLineItemsResponse {
2336
+ interface RemoveLineItemsResponse {
2364
2337
  /** Updated cart. */
2365
2338
  cart?: Cart;
2366
2339
  }
2367
- export interface CreateCheckoutFromCurrentCartRequest {
2340
+ interface CreateCheckoutFromCurrentCartRequest {
2368
2341
  /** __Required.__ Sales channel type. */
2369
2342
  channelType?: ChannelTypeWithLiterals;
2370
2343
  /** Shipping address. Used for calculating tax and shipping (when applicable). */
@@ -2379,7 +2352,7 @@ export interface CreateCheckoutFromCurrentCartRequest {
2379
2352
  */
2380
2353
  email?: string | null;
2381
2354
  }
2382
- export declare enum ChannelType {
2355
+ declare enum ChannelType {
2383
2356
  /** Unspecified sales channel. This value is not supported. */
2384
2357
  UNSPECIFIED = "UNSPECIFIED",
2385
2358
  /** A web client. */
@@ -2414,18 +2387,18 @@ export declare enum ChannelType {
2414
2387
  FAIRE_COM = "FAIRE_COM"
2415
2388
  }
2416
2389
  /** @enumType */
2417
- 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';
2418
- export interface CreateCheckoutResponse {
2390
+ 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';
2391
+ interface CreateCheckoutResponse {
2419
2392
  /** The newly created checkout's ID. */
2420
2393
  checkoutId?: string;
2421
2394
  }
2422
- export interface RemoveCouponFromCurrentCartRequest {
2395
+ interface RemoveCouponFromCurrentCartRequest {
2423
2396
  }
2424
- export interface RemoveCouponResponse {
2397
+ interface RemoveCouponResponse {
2425
2398
  /** Updated cart. */
2426
2399
  cart?: Cart;
2427
2400
  }
2428
- export interface UpdateCurrentCartLineItemQuantityRequest {
2401
+ interface UpdateCurrentCartLineItemQuantityRequest {
2429
2402
  /**
2430
2403
  * Line item IDs and their new quantity.
2431
2404
  * @minSize 1
@@ -2433,12 +2406,12 @@ export interface UpdateCurrentCartLineItemQuantityRequest {
2433
2406
  */
2434
2407
  lineItems: LineItemQuantityUpdate[];
2435
2408
  }
2436
- export interface LineItemQuantityUpdate {
2409
+ interface LineItemQuantityUpdate {
2437
2410
  /**
2438
2411
  * *Required.** Line item ID.
2439
2412
  * @format GUID
2440
2413
  */
2441
- id?: string;
2414
+ _id?: string;
2442
2415
  /**
2443
2416
  * *Required.** New quantity. Number must be 1 or higher.
2444
2417
  * @min 1
@@ -2446,11 +2419,11 @@ export interface LineItemQuantityUpdate {
2446
2419
  */
2447
2420
  quantity?: number;
2448
2421
  }
2449
- export interface UpdateLineItemsQuantityResponse {
2422
+ interface UpdateLineItemsQuantityResponse {
2450
2423
  /** Updated cart. */
2451
2424
  cart?: Cart;
2452
2425
  }
2453
- export interface EstimateCurrentCartTotalsRequest {
2426
+ interface EstimateCurrentCartTotalsRequest {
2454
2427
  /** Selected shipping option. */
2455
2428
  selectedShippingOption?: SelectedShippingOption;
2456
2429
  /** Shipping address. Used for calculating tax and shipping (when applicable). */
@@ -2472,17 +2445,17 @@ export interface EstimateCurrentCartTotalsRequest {
2472
2445
  */
2473
2446
  calculateShipping?: boolean | null;
2474
2447
  }
2475
- export interface DeleteCurrentCartRequest {
2448
+ interface DeleteCurrentCartRequest {
2476
2449
  }
2477
- export interface DeleteCartResponse {
2450
+ interface DeleteCartResponse {
2478
2451
  }
2479
- export interface DomainEvent extends DomainEventBodyOneOf {
2452
+ interface DomainEvent extends DomainEventBodyOneOf {
2480
2453
  createdEvent?: EntityCreatedEvent;
2481
2454
  updatedEvent?: EntityUpdatedEvent;
2482
2455
  deletedEvent?: EntityDeletedEvent;
2483
2456
  actionEvent?: ActionEvent;
2484
2457
  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2485
- id?: string;
2458
+ _id?: string;
2486
2459
  /**
2487
2460
  * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2488
2461
  * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
@@ -2511,36 +2484,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
2511
2484
  entityEventSequence?: string | null;
2512
2485
  }
2513
2486
  /** @oneof */
2514
- export interface DomainEventBodyOneOf {
2487
+ interface DomainEventBodyOneOf {
2515
2488
  createdEvent?: EntityCreatedEvent;
2516
2489
  updatedEvent?: EntityUpdatedEvent;
2517
2490
  deletedEvent?: EntityDeletedEvent;
2518
2491
  actionEvent?: ActionEvent;
2519
2492
  }
2520
- export interface EntityCreatedEvent {
2521
- entityAsJson?: string;
2522
- /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
2523
- restoreInfo?: RestoreInfo;
2493
+ interface EntityCreatedEvent {
2494
+ entity?: string;
2524
2495
  }
2525
- export interface RestoreInfo {
2496
+ interface RestoreInfo {
2526
2497
  deletedDate?: Date | null;
2527
2498
  }
2528
- export interface EntityUpdatedEvent {
2499
+ interface EntityUpdatedEvent {
2529
2500
  /**
2530
2501
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2531
2502
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2532
2503
  * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2533
2504
  */
2534
- currentEntityAsJson?: string;
2505
+ currentEntity?: string;
2535
2506
  }
2536
- export interface EntityDeletedEvent {
2507
+ interface EntityDeletedEvent {
2537
2508
  /** Entity that was deleted. */
2538
- deletedEntityAsJson?: string | null;
2509
+ deletedEntity?: string | null;
2539
2510
  }
2540
- export interface ActionEvent {
2541
- bodyAsJson?: string;
2511
+ interface ActionEvent {
2512
+ body?: string;
2542
2513
  }
2543
- export interface MessageEnvelope {
2514
+ interface MessageEnvelope {
2544
2515
  /**
2545
2516
  * App instance ID.
2546
2517
  * @format GUID
@@ -2556,7 +2527,7 @@ export interface MessageEnvelope {
2556
2527
  /** Stringify payload. */
2557
2528
  data?: string;
2558
2529
  }
2559
- export interface IdentificationData extends IdentificationDataIdOneOf {
2530
+ interface IdentificationData extends IdentificationDataIdOneOf {
2560
2531
  /**
2561
2532
  * ID of a site visitor that has not logged in to the site.
2562
2533
  * @format GUID
@@ -2581,7 +2552,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
2581
2552
  identityType?: WebhookIdentityTypeWithLiterals;
2582
2553
  }
2583
2554
  /** @oneof */
2584
- export interface IdentificationDataIdOneOf {
2555
+ interface IdentificationDataIdOneOf {
2585
2556
  /**
2586
2557
  * ID of a site visitor that has not logged in to the site.
2587
2558
  * @format GUID
@@ -2603,7 +2574,7 @@ export interface IdentificationDataIdOneOf {
2603
2574
  */
2604
2575
  appId?: string;
2605
2576
  }
2606
- export declare enum WebhookIdentityType {
2577
+ declare enum WebhookIdentityType {
2607
2578
  UNKNOWN = "UNKNOWN",
2608
2579
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2609
2580
  MEMBER = "MEMBER",
@@ -2611,8 +2582,8 @@ export declare enum WebhookIdentityType {
2611
2582
  APP = "APP"
2612
2583
  }
2613
2584
  /** @enumType */
2614
- export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2615
- export interface CreateCartRequest {
2585
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2586
+ interface CreateCartRequest {
2616
2587
  /** Cart info. */
2617
2588
  cartInfo?: Cart;
2618
2589
  /** Code of an existing coupon to apply to cart. For more information, see the Coupons API. */
@@ -2636,38 +2607,38 @@ export interface CreateCartRequest {
2636
2607
  */
2637
2608
  customLineItems?: CustomLineItem[];
2638
2609
  }
2639
- export interface CreateCartResponse {
2610
+ interface CreateCartResponse {
2640
2611
  /** Cart. */
2641
2612
  cart?: Cart;
2642
2613
  }
2643
- export interface GetCartRequest {
2614
+ interface GetCartRequest {
2644
2615
  /**
2645
2616
  * Cart ID.
2646
2617
  * @format GUID
2647
2618
  */
2648
- id?: string;
2619
+ _id?: string;
2649
2620
  }
2650
- export interface GetCartResponse {
2621
+ interface GetCartResponse {
2651
2622
  /** Retrieved cart. */
2652
2623
  cart?: Cart;
2653
2624
  }
2654
- export interface GetCartByCheckoutIdRequest {
2625
+ interface GetCartByCheckoutIdRequest {
2655
2626
  /**
2656
2627
  * Checkout ID.
2657
2628
  * @format GUID
2658
2629
  */
2659
- id?: string;
2630
+ _id?: string;
2660
2631
  }
2661
- export interface GetCartByCheckoutIdResponse {
2632
+ interface GetCartByCheckoutIdResponse {
2662
2633
  /** Retrieved cart. */
2663
2634
  cart?: Cart;
2664
2635
  }
2665
- export interface AddToCartRequest {
2636
+ interface AddToCartRequest {
2666
2637
  /**
2667
2638
  * Cart ID.
2668
2639
  * @format GUID
2669
2640
  */
2670
- id?: string;
2641
+ _id?: string;
2671
2642
  /**
2672
2643
  * Catalog line items.
2673
2644
  * @maxSize 100
@@ -2690,12 +2661,12 @@ export interface AddToCartRequest {
2690
2661
  */
2691
2662
  businessLocationId?: string | null;
2692
2663
  }
2693
- export interface RemoveLineItemsRequest {
2664
+ interface RemoveLineItemsRequest {
2694
2665
  /**
2695
2666
  * Cart ID.
2696
2667
  * @format GUID
2697
2668
  */
2698
- id?: string;
2669
+ _id?: string;
2699
2670
  /**
2700
2671
  * Line item IDs to remove from cart.
2701
2672
  * @format GUID
@@ -2704,12 +2675,12 @@ export interface RemoveLineItemsRequest {
2704
2675
  */
2705
2676
  lineItemIds?: string[];
2706
2677
  }
2707
- export interface CreateCheckoutRequest {
2678
+ interface CreateCheckoutRequest {
2708
2679
  /**
2709
2680
  * Cart ID.
2710
2681
  * @format GUID
2711
2682
  */
2712
- id?: string;
2683
+ _id?: string;
2713
2684
  /** __Required.__ Sales channel type. */
2714
2685
  channelType?: ChannelTypeWithLiterals;
2715
2686
  /** Shipping address. Used for calculating tax and shipping (when applicable). */
@@ -2724,19 +2695,19 @@ export interface CreateCheckoutRequest {
2724
2695
  */
2725
2696
  email?: string | null;
2726
2697
  }
2727
- export interface RemoveCouponRequest {
2698
+ interface RemoveCouponRequest {
2728
2699
  /**
2729
2700
  * Cart ID.
2730
2701
  * @format GUID
2731
2702
  */
2732
- id?: string;
2703
+ _id?: string;
2733
2704
  }
2734
- export interface UpdateLineItemsQuantityRequest {
2705
+ interface UpdateLineItemsQuantityRequest {
2735
2706
  /**
2736
2707
  * Cart ID.
2737
2708
  * @format GUID
2738
2709
  */
2739
- id?: string;
2710
+ _id?: string;
2740
2711
  /**
2741
2712
  * Line item IDs and their new quantity.
2742
2713
  * @minSize 1
@@ -2744,12 +2715,12 @@ export interface UpdateLineItemsQuantityRequest {
2744
2715
  */
2745
2716
  lineItems?: LineItemQuantityUpdate[];
2746
2717
  }
2747
- export interface EstimateTotalsRequest {
2718
+ interface EstimateTotalsRequest {
2748
2719
  /**
2749
2720
  * Cart ID.
2750
2721
  * @format GUID
2751
2722
  */
2752
- id?: string;
2723
+ _id?: string;
2753
2724
  /** Selected shipping option. */
2754
2725
  selectedShippingOption?: SelectedShippingOption;
2755
2726
  /** Shipping address. Used for calculating tax and shipping (when applicable). */
@@ -2771,23 +2742,163 @@ export interface EstimateTotalsRequest {
2771
2742
  */
2772
2743
  calculateShipping?: boolean | null;
2773
2744
  }
2774
- export interface DeleteCartRequest {
2745
+ interface DeleteCartRequest {
2775
2746
  /**
2776
2747
  * ID of the cart to delete.
2777
2748
  * @format GUID
2778
2749
  */
2779
- id?: string;
2750
+ _id?: string;
2780
2751
  }
2781
- export interface Empty {
2752
+ interface Empty {
2782
2753
  }
2783
- export interface RemoveBusinessLocationRequest {
2754
+ interface RemoveBusinessLocationRequest {
2784
2755
  /**
2785
2756
  * Cart ID.
2786
2757
  * @format GUID
2787
2758
  */
2788
- id?: string;
2759
+ _id?: string;
2789
2760
  }
2790
- export interface RemoveBusinessLocationResponse {
2761
+ interface RemoveBusinessLocationResponse {
2791
2762
  /** Updated cart. */
2792
2763
  cart?: Cart;
2793
2764
  }
2765
+ interface BaseEventMetadata {
2766
+ /**
2767
+ * App instance ID.
2768
+ * @format GUID
2769
+ */
2770
+ instanceId?: string | null;
2771
+ /**
2772
+ * Event type.
2773
+ * @maxLength 150
2774
+ */
2775
+ eventType?: string;
2776
+ /** The identification type and identity data. */
2777
+ identity?: IdentificationData;
2778
+ }
2779
+ interface EventMetadata extends BaseEventMetadata {
2780
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2781
+ _id?: string;
2782
+ /**
2783
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2784
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2785
+ */
2786
+ entityFqdn?: string;
2787
+ /**
2788
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
2789
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2790
+ */
2791
+ slug?: string;
2792
+ /** ID of the entity associated with the event. */
2793
+ entityId?: string;
2794
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2795
+ eventTime?: Date | null;
2796
+ /**
2797
+ * Whether the event was triggered as a result of a privacy regulation application
2798
+ * (for example, GDPR).
2799
+ */
2800
+ triggeredByAnonymizeRequest?: boolean | null;
2801
+ /** If present, indicates the action that triggered the event. */
2802
+ originatedFrom?: string | null;
2803
+ /**
2804
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
2805
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
2806
+ */
2807
+ entityEventSequence?: string | null;
2808
+ }
2809
+ interface CartDeletedEnvelope {
2810
+ metadata: EventMetadata;
2811
+ }
2812
+ interface CartUpdatedEnvelope {
2813
+ entity: Cart;
2814
+ metadata: EventMetadata;
2815
+ }
2816
+ interface CartCreatedEnvelope {
2817
+ entity: Cart;
2818
+ metadata: EventMetadata;
2819
+ }
2820
+ interface UpdateCurrentCartOptions {
2821
+ /** Cart info. */
2822
+ cartInfo?: Cart;
2823
+ /** Coupon code. For more information, see the Coupons API. */
2824
+ couponCode?: string | null;
2825
+ /**
2826
+ * Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will be applied to the whole cart.
2827
+ * @maxSize 100
2828
+ */
2829
+ merchantDiscounts?: MerchantDiscountInput[];
2830
+ /**
2831
+ * Catalog line items.
2832
+ * @maxSize 300
2833
+ */
2834
+ lineItems?: LineItem[];
2835
+ /**
2836
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
2837
+ *
2838
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
2839
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
2840
+ * @maxSize 300
2841
+ */
2842
+ customLineItems?: CustomLineItem[];
2843
+ }
2844
+ interface AddToCurrentCartOptions {
2845
+ /**
2846
+ * Catalog line items.
2847
+ * @maxSize 100
2848
+ */
2849
+ lineItems?: LineItem[];
2850
+ /**
2851
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
2852
+ *
2853
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
2854
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
2855
+ * @maxSize 100
2856
+ */
2857
+ customLineItems?: CustomLineItem[];
2858
+ /**
2859
+ * Business location ID.
2860
+ * To update a cart's business location ID, use the UpdateCart method.
2861
+ * Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
2862
+ * @format GUID
2863
+ */
2864
+ businessLocationId?: string | null;
2865
+ }
2866
+ interface CreateCheckoutFromCurrentCartOptions {
2867
+ /** __Required.__ Sales channel type. */
2868
+ channelType?: ChannelTypeWithLiterals;
2869
+ /** Shipping address. Used for calculating tax and shipping (when applicable). */
2870
+ shippingAddress?: Address;
2871
+ /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */
2872
+ billingAddress?: Address;
2873
+ /** Selected shipping option. */
2874
+ selectedShippingOption?: SelectedShippingOption;
2875
+ /**
2876
+ * Required when setting billing or shipping address and user is not logged in.
2877
+ * @format EMAIL
2878
+ */
2879
+ email?: string | null;
2880
+ }
2881
+ interface EstimateCurrentCartTotalsOptions {
2882
+ /** Selected shipping option. */
2883
+ selectedShippingOption?: SelectedShippingOption;
2884
+ /** Shipping address. Used for calculating tax and shipping (when applicable). */
2885
+ shippingAddress?: Address;
2886
+ /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */
2887
+ billingAddress?: Address;
2888
+ /** The selected membership payment options and which line items they apply to. */
2889
+ selectedMemberships?: SelectedMemberships;
2890
+ /**
2891
+ * Whether to calculate tax in the calculation request.
2892
+ *
2893
+ * Default: `true`
2894
+ */
2895
+ calculateTax?: boolean | null;
2896
+ /**
2897
+ * Whether to calculate shipping in the calculation request.
2898
+ *
2899
+ * Default: `true`
2900
+ */
2901
+ calculateShipping?: boolean | null;
2902
+ }
2903
+
2904
+ export { type Scope as $, type AddToCurrentCartOptions as A, type MultiCurrencyPrice as B, type Cart as C, DescriptionLineType as D, type EstimateCurrentCartTotalsOptions as E, FileType as F, type DescriptionLine as G, type DescriptionLineValueOneOf as H, ItemAvailabilityStatus as I, JurisdictionType as J, type DescriptionLineDescriptionLineValueOneOf as K, type LineItemQuantityUpdate as L, ManualCalculationReason as M, NameInOther as N, type DescriptionLineName as O, PaymentOptionType as P, type PlainTextValue as Q, type RemoveLineItemsResponse as R, SubscriptionFrequency as S, TaxableAddressType as T, type UpdateCurrentCartOptions as U, VatType as V, WeightUnit as W, type Color as X, type FocalPoint as Y, type ItemAvailabilityInfo as Z, type PhysicalProperties as _, type AddToCartResponse as a, type ShippingRegion as a$, type Group as a0, type ItemType as a1, type ItemTypeItemTypeDataOneOf as a2, type SubscriptionOptionInfo as a3, type SubscriptionSettings as a4, type FreeTrialPeriod as a5, type Title as a6, type Description as a7, type SecuredMedia as a8, type ServiceProperties as a9, type GetCurrentCartRequest as aA, type GetCurrentCartResponse as aB, type UpdateCartRequest as aC, type MerchantDiscountInput as aD, type CustomLineItem as aE, type V1ModifierGroup as aF, type V1ItemModifier as aG, type UpdateCartResponse as aH, type AddToCurrentCartRequest as aI, type AddToCurrentCartAndEstimateTotalsRequest as aJ, type SelectedMemberships as aK, type HostSelectedMembership as aL, type CalculatedLineItem as aM, type LineItemPricesData as aN, type ItemTaxFullDetails as aO, type TaxRateBreakdown as aP, type TaxBreakdown as aQ, type CalculatedItemModifier as aR, type PriceSummary as aS, type GiftCard as aT, type TaxSummary as aU, type TaxCalculationDetails as aV, type TaxCalculationDetailsCalculationDetailsOneOf as aW, type AutoTaxFallbackCalculationDetails as aX, type ApplicationError as aY, type AggregatedTaxBreakdown as aZ, type ShippingInformation as a_, type PriceDescription as aa, type SelectedMembership as ab, type CatalogOverrideFields as ac, type PaymentOption as ad, type TaxableAddress as ae, type TaxableAddressTaxableAddressDataOneOf as af, type ExtendedFields as ag, type Policy as ah, type ModifierGroup as ai, type TranslatableString as aj, type ItemModifier as ak, type BuyerInfo as al, type BuyerInfoIdOneOf as am, type CartDiscount as an, type CartDiscountDiscountSourceOneOf as ao, type Coupon as ap, type MerchantDiscount as aq, type DiscountRule as ar, type DiscountRuleName as as, type AddressWithContact as at, type Address as au, type StreetAddress as av, type AddressLocation as aw, type FullAddressContactDetails as ax, type VatId as ay, type SelectedShippingOption as az, type CreateCheckoutFromCurrentCartOptions as b, type GetCartByCheckoutIdResponse as b$, type SelectedCarrierServiceOption as b0, type DeliveryLogistics as b1, type PickupDetails as b2, type DeliveryTimeSlot as b3, type SelectedCarrierServiceOptionPrices as b4, type SelectedCarrierServiceOptionOtherCharge as b5, type DeliveryAllocation as b6, type Carrier as b7, type Region as b8, type ApplicableLineItems as b9, type Violation as bA, type Target as bB, type TargetTargetTypeOneOf as bC, type Other as bD, type TargetLineItem as bE, type RemoveLineItemsFromCurrentCartRequest as bF, type CreateCheckoutFromCurrentCartRequest as bG, type RemoveCouponFromCurrentCartRequest as bH, type UpdateCurrentCartLineItemQuantityRequest as bI, type EstimateCurrentCartTotalsRequest as bJ, type DeleteCurrentCartRequest as bK, type DeleteCartResponse as bL, type DomainEvent as bM, type DomainEventBodyOneOf as bN, type EntityCreatedEvent as bO, type RestoreInfo as bP, type EntityUpdatedEvent as bQ, type EntityDeletedEvent as bR, type ActionEvent as bS, type MessageEnvelope as bT, type IdentificationData as bU, type IdentificationDataIdOneOf as bV, type CreateCartRequest as bW, type CreateCartResponse as bX, type GetCartRequest as bY, type GetCartResponse as bZ, type GetCartByCheckoutIdRequest as b_, type CarrierServiceOption as ba, type ShippingOption as bb, type ShippingPrice as bc, type OtherCharge as bd, type AppliedDiscount as be, type AppliedDiscountDiscountSourceOneOf as bf, type V1Coupon as bg, type V1MerchantDiscount as bh, type V1DiscountRule as bi, type V1DiscountRuleName as bj, type LineItemDiscount as bk, type CalculationErrors as bl, type CalculationErrorsShippingCalculationErrorOneOf as bm, type Details as bn, type DetailsKindOneOf as bo, type ValidationError as bp, type FieldViolation as bq, type SystemError as br, type CarrierErrors as bs, type CarrierError as bt, type MembershipOptions as bu, type Membership as bv, type MembershipName as bw, type MembershipPaymentCredits as bx, type InvalidMembership as by, type AdditionalFee as bz, type CreateCheckoutResponse as c, type AddToCartRequest as c0, type RemoveLineItemsRequest as c1, type CreateCheckoutRequest as c2, type RemoveCouponRequest as c3, type UpdateLineItemsQuantityRequest as c4, type EstimateTotalsRequest as c5, type DeleteCartRequest as c6, type Empty as c7, type RemoveBusinessLocationRequest as c8, type RemoveBusinessLocationResponse as c9, type BaseEventMetadata as ca, type EventMetadata as cb, type RemoveCouponResponse as d, type UpdateLineItemsQuantityResponse as e, type EstimateTotalsResponse as f, type CartDeletedEnvelope as g, type CartUpdatedEnvelope as h, type CartCreatedEnvelope as i, ItemTypeItemType as j, DiscountType as k, RateType as l, FallbackReason as m, PickupMethod as n, ChargeType as o, AppliedDiscountDiscountType as p, RuleType as q, AdditionalFeeSource as r, Severity as s, NameInLineItem as t, SuggestedFix as u, ChannelType as v, WebhookIdentityType as w, type LineItem as x, type CatalogReference as y, type ProductName as z };