@wix/auto_sdk_ecom_cart 1.0.35 → 1.0.37

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (134) hide show
  1. package/build/{cjs/src/ecom-v1-cart-cart.types.d.ts → ecom-v1-cart-cart.universal-B6O4guqp.d.mts} +530 -303
  2. package/build/{internal/cjs/src/ecom-v1-cart-cart.types.d.ts → ecom-v1-cart-cart.universal-B6O4guqp.d.ts} +530 -303
  3. package/build/index.d.mts +151 -0
  4. package/build/index.d.ts +151 -0
  5. package/build/index.js +1939 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +1876 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/{es/src/ecom-v1-cart-cart.types.d.ts → internal/ecom-v1-cart-cart.universal-C4hqggNx.d.mts} +632 -301
  10. package/build/internal/{es/src/ecom-v1-cart-cart.types.d.ts → ecom-v1-cart-cart.universal-C4hqggNx.d.ts} +632 -301
  11. package/build/internal/index.d.mts +162 -0
  12. package/build/internal/index.d.ts +162 -0
  13. package/build/internal/index.js +1939 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +1876 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +2288 -0
  18. package/build/internal/meta.d.ts +2288 -0
  19. package/build/internal/meta.js +1027 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +989 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +2288 -0
  24. package/build/meta.d.ts +2288 -0
  25. package/build/meta.js +1027 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +989 -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-cart.context.d.ts +0 -29
  40. package/build/cjs/src/ecom-v1-cart-cart.context.js +0 -59
  41. package/build/cjs/src/ecom-v1-cart-cart.context.js.map +0 -1
  42. package/build/cjs/src/ecom-v1-cart-cart.http.d.ts +0 -60
  43. package/build/cjs/src/ecom-v1-cart-cart.http.js +0 -818
  44. package/build/cjs/src/ecom-v1-cart-cart.http.js.map +0 -1
  45. package/build/cjs/src/ecom-v1-cart-cart.meta.d.ts +0 -46
  46. package/build/cjs/src/ecom-v1-cart-cart.meta.js +0 -256
  47. package/build/cjs/src/ecom-v1-cart-cart.meta.js.map +0 -1
  48. package/build/cjs/src/ecom-v1-cart-cart.public.d.ts +0 -129
  49. package/build/cjs/src/ecom-v1-cart-cart.public.js +0 -227
  50. package/build/cjs/src/ecom-v1-cart-cart.public.js.map +0 -1
  51. package/build/cjs/src/ecom-v1-cart-cart.types.js +0 -257
  52. package/build/cjs/src/ecom-v1-cart-cart.types.js.map +0 -1
  53. package/build/cjs/src/ecom-v1-cart-cart.universal.d.ts +0 -3417
  54. package/build/cjs/src/ecom-v1-cart-cart.universal.js +0 -1170
  55. package/build/cjs/src/ecom-v1-cart-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-cart.context.d.ts +0 -29
  67. package/build/es/src/ecom-v1-cart-cart.context.js +0 -31
  68. package/build/es/src/ecom-v1-cart-cart.context.js.map +0 -1
  69. package/build/es/src/ecom-v1-cart-cart.http.d.ts +0 -60
  70. package/build/es/src/ecom-v1-cart-cart.http.js +0 -803
  71. package/build/es/src/ecom-v1-cart-cart.http.js.map +0 -1
  72. package/build/es/src/ecom-v1-cart-cart.meta.d.ts +0 -46
  73. package/build/es/src/ecom-v1-cart-cart.meta.js +0 -218
  74. package/build/es/src/ecom-v1-cart-cart.meta.js.map +0 -1
  75. package/build/es/src/ecom-v1-cart-cart.public.d.ts +0 -129
  76. package/build/es/src/ecom-v1-cart-cart.public.js +0 -187
  77. package/build/es/src/ecom-v1-cart-cart.public.js.map +0 -1
  78. package/build/es/src/ecom-v1-cart-cart.types.js +0 -254
  79. package/build/es/src/ecom-v1-cart-cart.types.js.map +0 -1
  80. package/build/es/src/ecom-v1-cart-cart.universal.d.ts +0 -3417
  81. package/build/es/src/ecom-v1-cart-cart.universal.js +0 -1132
  82. package/build/es/src/ecom-v1-cart-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-cart.context.d.ts +0 -31
  93. package/build/internal/cjs/src/ecom-v1-cart-cart.context.js +0 -59
  94. package/build/internal/cjs/src/ecom-v1-cart-cart.context.js.map +0 -1
  95. package/build/internal/cjs/src/ecom-v1-cart-cart.http.d.ts +0 -60
  96. package/build/internal/cjs/src/ecom-v1-cart-cart.http.js +0 -818
  97. package/build/internal/cjs/src/ecom-v1-cart-cart.http.js.map +0 -1
  98. package/build/internal/cjs/src/ecom-v1-cart-cart.meta.d.ts +0 -46
  99. package/build/internal/cjs/src/ecom-v1-cart-cart.meta.js +0 -256
  100. package/build/internal/cjs/src/ecom-v1-cart-cart.meta.js.map +0 -1
  101. package/build/internal/cjs/src/ecom-v1-cart-cart.public.d.ts +0 -138
  102. package/build/internal/cjs/src/ecom-v1-cart-cart.public.js +0 -227
  103. package/build/internal/cjs/src/ecom-v1-cart-cart.public.js.map +0 -1
  104. package/build/internal/cjs/src/ecom-v1-cart-cart.types.js +0 -257
  105. package/build/internal/cjs/src/ecom-v1-cart-cart.types.js.map +0 -1
  106. package/build/internal/cjs/src/ecom-v1-cart-cart.universal.d.ts +0 -3545
  107. package/build/internal/cjs/src/ecom-v1-cart-cart.universal.js +0 -1170
  108. package/build/internal/cjs/src/ecom-v1-cart-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-cart.context.d.ts +0 -31
  119. package/build/internal/es/src/ecom-v1-cart-cart.context.js +0 -31
  120. package/build/internal/es/src/ecom-v1-cart-cart.context.js.map +0 -1
  121. package/build/internal/es/src/ecom-v1-cart-cart.http.d.ts +0 -60
  122. package/build/internal/es/src/ecom-v1-cart-cart.http.js +0 -803
  123. package/build/internal/es/src/ecom-v1-cart-cart.http.js.map +0 -1
  124. package/build/internal/es/src/ecom-v1-cart-cart.meta.d.ts +0 -46
  125. package/build/internal/es/src/ecom-v1-cart-cart.meta.js +0 -218
  126. package/build/internal/es/src/ecom-v1-cart-cart.meta.js.map +0 -1
  127. package/build/internal/es/src/ecom-v1-cart-cart.public.d.ts +0 -138
  128. package/build/internal/es/src/ecom-v1-cart-cart.public.js +0 -187
  129. package/build/internal/es/src/ecom-v1-cart-cart.public.js.map +0 -1
  130. package/build/internal/es/src/ecom-v1-cart-cart.types.js +0 -254
  131. package/build/internal/es/src/ecom-v1-cart-cart.types.js.map +0 -1
  132. package/build/internal/es/src/ecom-v1-cart-cart.universal.d.ts +0 -3545
  133. package/build/internal/es/src/ecom-v1-cart-cart.universal.js +0 -1132
  134. package/build/internal/es/src/ecom-v1-cart-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
@@ -289,7 +289,7 @@ export interface LineItem {
289
289
  modifiersTotalPrice?: MultiCurrencyPrice;
290
290
  }
291
291
  /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
292
- export interface CatalogReference {
292
+ interface CatalogReference {
293
293
  /**
294
294
  * ID of the item within the catalog it belongs to.
295
295
  * @minLength 1
@@ -315,7 +315,7 @@ export interface CatalogReference {
315
315
  */
316
316
  options?: Record<string, any> | null;
317
317
  }
318
- export interface ProductName {
318
+ interface ProductName {
319
319
  /**
320
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).
321
321
  *
@@ -336,13 +336,7 @@ export interface ProductName {
336
336
  */
337
337
  translated?: string | null;
338
338
  }
339
- export interface PageUrlV2 {
340
- /** The relative path for the page within the site. For example, `/product-page/a-product`. */
341
- relativePath?: string;
342
- /** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
343
- url?: string | null;
344
- }
345
- export interface MultiCurrencyPrice {
339
+ interface MultiCurrencyPrice {
346
340
  /**
347
341
  * Amount.
348
342
  * @decimalValue options { gte:0, lte:1000000000000000 }
@@ -365,7 +359,7 @@ export interface MultiCurrencyPrice {
365
359
  */
366
360
  formattedConvertedAmount?: string;
367
361
  }
368
- export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
362
+ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
369
363
  /** Description line plain text value. */
370
364
  plainText?: PlainTextValue;
371
365
  /** Description line color value. */
@@ -374,16 +368,16 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
374
368
  name?: DescriptionLineName;
375
369
  }
376
370
  /** @oneof */
377
- export interface DescriptionLineValueOneOf {
371
+ interface DescriptionLineValueOneOf {
378
372
  /** Description line plain text value. */
379
373
  plainText?: PlainTextValue;
380
374
  /** Description line color value. */
381
375
  colorInfo?: Color;
382
376
  }
383
377
  /** @oneof */
384
- export interface DescriptionLineDescriptionLineValueOneOf {
378
+ interface DescriptionLineDescriptionLineValueOneOf {
385
379
  }
386
- export interface DescriptionLineName {
380
+ interface DescriptionLineName {
387
381
  /**
388
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).
389
383
  * @maxLength 100
@@ -397,7 +391,7 @@ export interface DescriptionLineName {
397
391
  */
398
392
  translated?: string | null;
399
393
  }
400
- export interface PlainTextValue {
394
+ interface PlainTextValue {
401
395
  /**
402
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).
403
397
  * @maxLength 600
@@ -411,7 +405,7 @@ export interface PlainTextValue {
411
405
  */
412
406
  translated?: string | null;
413
407
  }
414
- export interface Color {
408
+ interface Color {
415
409
  /**
416
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).
417
411
  * @maxLength 500
@@ -427,7 +421,7 @@ export interface Color {
427
421
  /** HEX or RGB color code for display. */
428
422
  code?: string | null;
429
423
  }
430
- export declare enum DescriptionLineType {
424
+ declare enum DescriptionLineType {
431
425
  /** Unrecognized type. */
432
426
  UNRECOGNISED = "UNRECOGNISED",
433
427
  /** Plain text type. */
@@ -435,32 +429,7 @@ export declare enum DescriptionLineType {
435
429
  /** Color type. */
436
430
  COLOR = "COLOR"
437
431
  }
438
- /** @enumType */
439
- export type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
440
- export interface CommonImage {
441
- /** WixMedia image ID. */
442
- id?: string;
443
- /** Image URL. */
444
- url?: string;
445
- /**
446
- * Original image height.
447
- * @readonly
448
- */
449
- height?: number;
450
- /**
451
- * Original image width.
452
- * @readonly
453
- */
454
- width?: number;
455
- /** Image alt text. */
456
- altText?: string | null;
457
- /**
458
- * Image filename.
459
- * @readonly
460
- */
461
- filename?: string | null;
462
- }
463
- export interface FocalPoint {
432
+ interface FocalPoint {
464
433
  /** X-coordinate of the focal point. */
465
434
  x?: number;
466
435
  /** Y-coordinate of the focal point. */
@@ -470,13 +439,13 @@ export interface FocalPoint {
470
439
  /** crop by width */
471
440
  width?: number | null;
472
441
  }
473
- export interface ItemAvailabilityInfo {
442
+ interface ItemAvailabilityInfo {
474
443
  /** Item availability status. */
475
444
  status?: ItemAvailabilityStatusWithLiterals;
476
445
  /** Quantity available. */
477
446
  quantityAvailable?: number | null;
478
447
  }
479
- export declare enum ItemAvailabilityStatus {
448
+ declare enum ItemAvailabilityStatus {
480
449
  AVAILABLE = "AVAILABLE",
481
450
  /** Item does not exist. */
482
451
  NOT_FOUND = "NOT_FOUND",
@@ -486,8 +455,8 @@ export declare enum ItemAvailabilityStatus {
486
455
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
487
456
  }
488
457
  /** @enumType */
489
- export type ItemAvailabilityStatusWithLiterals = ItemAvailabilityStatus | 'AVAILABLE' | 'NOT_FOUND' | 'NOT_AVAILABLE' | 'PARTIALLY_AVAILABLE';
490
- export interface PhysicalProperties {
458
+ type ItemAvailabilityStatusWithLiterals = ItemAvailabilityStatus | 'AVAILABLE' | 'NOT_FOUND' | 'NOT_AVAILABLE' | 'PARTIALLY_AVAILABLE';
459
+ interface PhysicalProperties {
491
460
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
492
461
  weight?: number | null;
493
462
  /**
@@ -498,32 +467,32 @@ export interface PhysicalProperties {
498
467
  /** Whether this line item is shippable. */
499
468
  shippable?: boolean;
500
469
  }
501
- export interface Scope {
470
+ interface Scope {
502
471
  /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
503
472
  namespace?: string;
504
473
  /** Coupon scope's applied group (e.g., event or ticket in Wix Events) */
505
474
  group?: Group;
506
475
  }
507
- export interface Group {
476
+ interface Group {
508
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). */
509
478
  name?: string;
510
479
  /** Item ID (when the coupon scope is limited to just one item). */
511
480
  entityId?: string | null;
512
481
  }
513
- export interface ItemType extends ItemTypeItemTypeDataOneOf {
482
+ interface ItemType extends ItemTypeItemTypeDataOneOf {
514
483
  /** Preset item type. */
515
484
  preset?: ItemTypeItemTypeWithLiterals;
516
485
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
517
486
  custom?: string;
518
487
  }
519
488
  /** @oneof */
520
- export interface ItemTypeItemTypeDataOneOf {
489
+ interface ItemTypeItemTypeDataOneOf {
521
490
  /** Preset item type. */
522
491
  preset?: ItemTypeItemTypeWithLiterals;
523
492
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
524
493
  custom?: string;
525
494
  }
526
- export declare enum ItemTypeItemType {
495
+ declare enum ItemTypeItemType {
527
496
  UNRECOGNISED = "UNRECOGNISED",
528
497
  PHYSICAL = "PHYSICAL",
529
498
  DIGITAL = "DIGITAL",
@@ -531,8 +500,8 @@ export declare enum ItemTypeItemType {
531
500
  SERVICE = "SERVICE"
532
501
  }
533
502
  /** @enumType */
534
- export type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
535
- export interface SubscriptionOptionInfo {
503
+ type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
504
+ interface SubscriptionOptionInfo {
536
505
  /** Subscription option settings. */
537
506
  subscriptionSettings?: SubscriptionSettings;
538
507
  /** Subscription option title. */
@@ -540,7 +509,7 @@ export interface SubscriptionOptionInfo {
540
509
  /** Subscription option description. */
541
510
  description?: Description;
542
511
  }
543
- export interface SubscriptionSettings {
512
+ interface SubscriptionSettings {
544
513
  /** Frequency of recurring payment. */
545
514
  frequency?: SubscriptionFrequencyWithLiterals;
546
515
  /**
@@ -568,7 +537,7 @@ export interface SubscriptionSettings {
568
537
  freeTrialPeriod?: FreeTrialPeriod;
569
538
  }
570
539
  /** Frequency unit of recurring payment */
571
- export declare enum SubscriptionFrequency {
540
+ declare enum SubscriptionFrequency {
572
541
  UNDEFINED = "UNDEFINED",
573
542
  DAY = "DAY",
574
543
  WEEK = "WEEK",
@@ -576,8 +545,8 @@ export declare enum SubscriptionFrequency {
576
545
  YEAR = "YEAR"
577
546
  }
578
547
  /** @enumType */
579
- export type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
580
- export interface FreeTrialPeriod {
548
+ type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
549
+ interface FreeTrialPeriod {
581
550
  /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
582
551
  frequency?: SubscriptionFrequencyWithLiterals;
583
552
  /**
@@ -587,7 +556,7 @@ export interface FreeTrialPeriod {
587
556
  */
588
557
  interval?: number;
589
558
  }
590
- export interface Title {
559
+ interface Title {
591
560
  /**
592
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).
593
562
  * @minLength 1
@@ -603,7 +572,7 @@ export interface Title {
603
572
  */
604
573
  translated?: string | null;
605
574
  }
606
- export interface Description {
575
+ interface Description {
607
576
  /**
608
577
  * Subscription option description.
609
578
  * @maxLength 500
@@ -615,13 +584,13 @@ export interface Description {
615
584
  */
616
585
  translated?: string | null;
617
586
  }
618
- export interface SecuredMedia {
587
+ interface SecuredMedia {
619
588
  /**
620
589
  * Media ID in Wix Media Manager.
621
590
  * @minLength 1
622
591
  * @maxLength 100
623
592
  */
624
- id?: string;
593
+ _id?: string;
625
594
  /**
626
595
  * Original filename.
627
596
  * @minLength 1
@@ -631,7 +600,7 @@ export interface SecuredMedia {
631
600
  /** File type. */
632
601
  fileType?: FileTypeWithLiterals;
633
602
  }
634
- export declare enum FileType {
603
+ declare enum FileType {
635
604
  UNSPECIFIED = "UNSPECIFIED",
636
605
  SECURE_PICTURE = "SECURE_PICTURE",
637
606
  SECURE_VIDEO = "SECURE_VIDEO",
@@ -640,9 +609,9 @@ export declare enum FileType {
640
609
  SECURE_ARCHIVE = "SECURE_ARCHIVE"
641
610
  }
642
611
  /** @enumType */
643
- 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';
644
613
  /** Type of selected payment option for catalog item */
645
- export declare enum PaymentOptionType {
614
+ declare enum PaymentOptionType {
646
615
  /** The entire payment for this item happens as part of the checkout. */
647
616
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
648
617
  /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
@@ -655,8 +624,8 @@ export declare enum PaymentOptionType {
655
624
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
656
625
  }
657
626
  /** @enumType */
658
- export type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
659
- export interface ServiceProperties {
627
+ type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
628
+ interface ServiceProperties {
660
629
  /**
661
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.
662
631
  * For example, the start time of a class.
@@ -669,7 +638,7 @@ export interface ServiceProperties {
669
638
  */
670
639
  numberOfParticipants?: number | null;
671
640
  }
672
- export interface PriceDescription {
641
+ interface PriceDescription {
673
642
  /**
674
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).
675
644
  * @minLength 1
@@ -686,20 +655,20 @@ export interface PriceDescription {
686
655
  translated?: string | null;
687
656
  }
688
657
  /** Selected Membership */
689
- export interface SelectedMembership {
658
+ interface SelectedMembership {
690
659
  /**
691
660
  * Membership ID.
692
661
  * @minLength 1
693
662
  * @maxLength 100
694
663
  */
695
- id?: string;
664
+ _id?: string;
696
665
  /**
697
666
  * ID of the app providing this payment option.
698
667
  * @format GUID
699
668
  */
700
669
  appId?: string;
701
670
  }
702
- export interface CatalogOverrideFields {
671
+ interface CatalogOverrideFields {
703
672
  /** Item name. */
704
673
  productName?: ProductName;
705
674
  /**
@@ -720,7 +689,7 @@ export interface CatalogOverrideFields {
720
689
  /** Physical properties of the item. */
721
690
  physicalProperties?: PhysicalProperties;
722
691
  /** Item image. */
723
- image?: Image;
692
+ image?: string;
724
693
  /** Payment method selected for the item. */
725
694
  paymentOption?: PaymentOption;
726
695
  /**
@@ -736,19 +705,7 @@ export interface CatalogOverrideFields {
736
705
  */
737
706
  savePaymentMethod?: boolean | null;
738
707
  }
739
- export interface Image {
740
- /** WixMedia image ID. */
741
- id?: string;
742
- /** Original image height. */
743
- height?: number;
744
- /** Original image width. */
745
- width?: number;
746
- /** Image alt text. Optional. */
747
- altText?: string | null;
748
- /** Image filename. Optional. */
749
- filename?: string | null;
750
- }
751
- export interface PaymentOption {
708
+ interface PaymentOption {
752
709
  /**
753
710
  * Type of selected payment option for current item.
754
711
  *
@@ -756,24 +713,24 @@ export interface PaymentOption {
756
713
  */
757
714
  value?: PaymentOptionTypeWithLiterals;
758
715
  }
759
- export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
716
+ interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
760
717
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
761
718
  addressType?: TaxableAddressTypeWithLiterals;
762
719
  }
763
720
  /** @oneof */
764
- export interface TaxableAddressTaxableAddressDataOneOf {
721
+ interface TaxableAddressTaxableAddressDataOneOf {
765
722
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
766
723
  addressType?: TaxableAddressTypeWithLiterals;
767
724
  }
768
- export declare enum TaxableAddressType {
725
+ declare enum TaxableAddressType {
769
726
  UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
770
727
  BUSINESS = "BUSINESS",
771
728
  BILLING = "BILLING",
772
729
  SHIPPING = "SHIPPING"
773
730
  }
774
731
  /** @enumType */
775
- export type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
776
- export interface ExtendedFields {
732
+ type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
733
+ interface ExtendedFields {
777
734
  /**
778
735
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
779
736
  * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -784,7 +741,7 @@ export interface ExtendedFields {
784
741
  */
785
742
  namespaces?: Record<string, Record<string, any>>;
786
743
  }
787
- export interface Policy {
744
+ interface Policy {
788
745
  /**
789
746
  * Policy title - should be translated
790
747
  * @minLength 1
@@ -798,13 +755,13 @@ export interface Policy {
798
755
  */
799
756
  content?: string;
800
757
  }
801
- export interface ModifierGroup {
758
+ interface ModifierGroup {
802
759
  /**
803
760
  * Modifier group id.
804
761
  * @minLength 1
805
762
  * @maxLength 36
806
763
  */
807
- id?: string;
764
+ _id?: string;
808
765
  /** Modifier group name. */
809
766
  name?: TranslatableString;
810
767
  /**
@@ -814,7 +771,7 @@ export interface ModifierGroup {
814
771
  */
815
772
  modifiers?: ItemModifier[];
816
773
  }
817
- export interface TranslatableString {
774
+ interface TranslatableString {
818
775
  /**
819
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).
820
777
  *
@@ -835,13 +792,13 @@ export interface TranslatableString {
835
792
  */
836
793
  translated?: string | null;
837
794
  }
838
- export interface ItemModifier {
795
+ interface ItemModifier {
839
796
  /**
840
797
  * Modifier ID.
841
798
  * @minLength 1
842
799
  * @maxLength 36
843
800
  */
844
- id?: string;
801
+ _id?: string;
845
802
  /**
846
803
  * The quantity of this modifier.
847
804
  * @min 1
@@ -856,7 +813,7 @@ export interface ItemModifier {
856
813
  price?: MultiCurrencyPrice;
857
814
  }
858
815
  /** Buyer Info */
859
- export interface BuyerInfo extends BuyerInfoIdOneOf {
816
+ interface BuyerInfo extends BuyerInfoIdOneOf {
860
817
  /**
861
818
  * Visitor ID. If the buyer is **not** a site member.
862
819
  * @format GUID
@@ -887,7 +844,7 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
887
844
  email?: string | null;
888
845
  }
889
846
  /** @oneof */
890
- export interface BuyerInfoIdOneOf {
847
+ interface BuyerInfoIdOneOf {
891
848
  /**
892
849
  * Visitor ID. If the buyer is **not** a site member.
893
850
  * @format GUID
@@ -907,7 +864,7 @@ export interface BuyerInfoIdOneOf {
907
864
  */
908
865
  userId?: string;
909
866
  }
910
- export declare enum WeightUnit {
867
+ declare enum WeightUnit {
911
868
  /** Weight unit can't be classified due to an error. */
912
869
  UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
913
870
  /** Kilograms. */
@@ -916,42 +873,42 @@ export declare enum WeightUnit {
916
873
  LB = "LB"
917
874
  }
918
875
  /** @enumType */
919
- export type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
920
- export interface CartDiscount extends CartDiscountDiscountSourceOneOf {
876
+ type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
877
+ interface CartDiscount extends CartDiscountDiscountSourceOneOf {
921
878
  /** Coupon details. */
922
879
  coupon?: Coupon;
923
880
  /** Merchant discount. */
924
881
  merchantDiscount?: MerchantDiscount;
925
882
  }
926
883
  /** @oneof */
927
- export interface CartDiscountDiscountSourceOneOf {
884
+ interface CartDiscountDiscountSourceOneOf {
928
885
  /** Coupon details. */
929
886
  coupon?: Coupon;
930
887
  /** Merchant discount. */
931
888
  merchantDiscount?: MerchantDiscount;
932
889
  }
933
- export interface Coupon {
890
+ interface Coupon {
934
891
  /** Coupon ID. */
935
- id?: string;
892
+ _id?: string;
936
893
  /** Coupon code. */
937
894
  code?: string;
938
895
  }
939
- export interface MerchantDiscount {
896
+ interface MerchantDiscount {
940
897
  /** Discount value. */
941
898
  amount?: MultiCurrencyPrice;
942
899
  }
943
- export interface DiscountRule {
900
+ interface DiscountRule {
944
901
  /**
945
902
  * Discount rule ID
946
903
  * @format GUID
947
904
  */
948
- id?: string;
905
+ _id?: string;
949
906
  /** Discount rule name */
950
907
  name?: DiscountRuleName;
951
908
  /** Discount value. */
952
909
  amount?: MultiCurrencyPrice;
953
910
  }
954
- export interface DiscountRuleName {
911
+ interface DiscountRuleName {
955
912
  /**
956
913
  * Original discount rule name (in site's default language).
957
914
  * @minLength 1
@@ -965,7 +922,7 @@ export interface DiscountRuleName {
965
922
  */
966
923
  translated?: string | null;
967
924
  }
968
- export declare enum DiscountType {
925
+ declare enum DiscountType {
969
926
  /** "GLOBAL" - discount applies to entire order. */
970
927
  GLOBAL = "GLOBAL",
971
928
  /** "SPECIFIC-ITEMS" - discount applies to specific items. */
@@ -973,17 +930,15 @@ export declare enum DiscountType {
973
930
  /** "SHIPPING" - discount applies to shipping. For example, free shipping. */
974
931
  SHIPPING = "SHIPPING"
975
932
  }
976
- /** @enumType */
977
- export type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
978
933
  /** Billing Info and shipping details */
979
- export interface AddressWithContact {
934
+ interface AddressWithContact {
980
935
  /** Address. */
981
936
  address?: Address;
982
937
  /** Contact details. */
983
938
  contactDetails?: FullAddressContactDetails;
984
939
  }
985
940
  /** Physical address */
986
- export interface Address {
941
+ interface Address {
987
942
  /**
988
943
  * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
989
944
  * @format COUNTRY
@@ -1010,7 +965,7 @@ export interface Address {
1010
965
  * Main address line (usually street name and number).
1011
966
  * @maxLength 150
1012
967
  */
1013
- addressLine?: string | null;
968
+ addressLine1?: string | null;
1014
969
  /**
1015
970
  * Free text providing more detailed address info. Usually contains apt, suite, floor.
1016
971
  * @maxLength 100
@@ -1027,20 +982,20 @@ export interface Address {
1027
982
  */
1028
983
  subdivisionFullname?: string | null;
1029
984
  }
1030
- export interface StreetAddress {
985
+ interface StreetAddress {
1031
986
  /** Street number. */
1032
987
  number?: string;
1033
988
  /** Street name. */
1034
989
  name?: string;
1035
990
  }
1036
- export interface AddressLocation {
991
+ interface AddressLocation {
1037
992
  /** Address latitude. */
1038
993
  latitude?: number | null;
1039
994
  /** Address longitude. */
1040
995
  longitude?: number | null;
1041
996
  }
1042
997
  /** Full contact details for an address */
1043
- export interface FullAddressContactDetails {
998
+ interface FullAddressContactDetails {
1044
999
  /**
1045
1000
  * First name.
1046
1001
  * @maxLength 100
@@ -1064,9 +1019,9 @@ export interface FullAddressContactDetails {
1064
1019
  /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
1065
1020
  vatId?: VatId;
1066
1021
  }
1067
- export interface VatId {
1022
+ interface VatId {
1068
1023
  /** Customer's tax ID. */
1069
- id?: string;
1024
+ _id?: string;
1070
1025
  /**
1071
1026
  * Tax type.
1072
1027
  *
@@ -1077,7 +1032,7 @@ export interface VatId {
1077
1032
  type?: VatTypeWithLiterals;
1078
1033
  }
1079
1034
  /** tax info types */
1080
- export declare enum VatType {
1035
+ declare enum VatType {
1081
1036
  UNSPECIFIED = "UNSPECIFIED",
1082
1037
  /** CPF - for individual tax payers. */
1083
1038
  CPF = "CPF",
@@ -1085,8 +1040,8 @@ export declare enum VatType {
1085
1040
  CNPJ = "CNPJ"
1086
1041
  }
1087
1042
  /** @enumType */
1088
- export type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
1089
- export interface SelectedShippingOption {
1043
+ type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
1044
+ interface SelectedShippingOption {
1090
1045
  /**
1091
1046
  * Carrier ID.
1092
1047
  * @format GUID
@@ -1099,13 +1054,13 @@ export interface SelectedShippingOption {
1099
1054
  */
1100
1055
  code?: string;
1101
1056
  }
1102
- export interface GetCurrentCartRequest {
1057
+ interface GetCurrentCartRequest {
1103
1058
  }
1104
- export interface GetCurrentCartResponse {
1059
+ interface GetCurrentCartResponse {
1105
1060
  /** Current session's active cart. */
1106
1061
  cart?: Cart;
1107
1062
  }
1108
- export interface UpdateCartRequest {
1063
+ interface UpdateCartRequest {
1109
1064
  /** Cart info. */
1110
1065
  cartInfo?: Cart;
1111
1066
  /** Coupon code. For more information, see the Coupons API. */
@@ -1129,7 +1084,7 @@ export interface UpdateCartRequest {
1129
1084
  */
1130
1085
  customLineItems?: CustomLineItem[];
1131
1086
  }
1132
- export interface MerchantDiscountInput {
1087
+ interface MerchantDiscountInput {
1133
1088
  /**
1134
1089
  * Discount amount.
1135
1090
  * @decimalValue options { gte:0 }
@@ -1142,7 +1097,7 @@ export interface MerchantDiscountInput {
1142
1097
  */
1143
1098
  lineItemIds?: string[];
1144
1099
  }
1145
- export interface CustomLineItem {
1100
+ interface CustomLineItem {
1146
1101
  /**
1147
1102
  * Custom line item quantity.
1148
1103
  *
@@ -1167,15 +1122,19 @@ export interface CustomLineItem {
1167
1122
  * @maxSize 10
1168
1123
  */
1169
1124
  descriptionLines?: DescriptionLine[];
1170
- /** Custom line item's media. */
1171
- 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;
1172
1131
  /**
1173
1132
  * Custom line item ID. If passed, `id` must be unique.
1174
1133
  *
1175
1134
  * Default: auto-generated ID
1176
1135
  * @format GUID
1177
1136
  */
1178
- id?: string | null;
1137
+ _id?: string | null;
1179
1138
  /**
1180
1139
  * Tax group ID for this custom line item.
1181
1140
  * @format GUID
@@ -1184,7 +1143,7 @@ export interface CustomLineItem {
1184
1143
  /** Name of the item or product. */
1185
1144
  productName?: ProductName;
1186
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. */
1187
- url?: PageUrlV2;
1146
+ url?: string;
1188
1147
  /** Item type. Either a preset type or custom. */
1189
1148
  itemType?: ItemType;
1190
1149
  /**
@@ -1272,13 +1231,13 @@ export interface CustomLineItem {
1272
1231
  */
1273
1232
  modifierGroups?: V1ModifierGroup[];
1274
1233
  }
1275
- export interface V1ModifierGroup {
1234
+ interface V1ModifierGroup {
1276
1235
  /**
1277
1236
  * Modifier group id.
1278
1237
  * @minLength 1
1279
1238
  * @maxLength 36
1280
1239
  */
1281
- id?: string;
1240
+ _id?: string;
1282
1241
  /** Modifier group name. */
1283
1242
  name?: TranslatableString;
1284
1243
  /**
@@ -1288,13 +1247,13 @@ export interface V1ModifierGroup {
1288
1247
  */
1289
1248
  modifiers?: V1ItemModifier[];
1290
1249
  }
1291
- export interface V1ItemModifier {
1250
+ interface V1ItemModifier {
1292
1251
  /**
1293
1252
  * Modifier ID.
1294
1253
  * @minLength 1
1295
1254
  * @maxLength 36
1296
1255
  */
1297
- id?: string;
1256
+ _id?: string;
1298
1257
  /**
1299
1258
  * The quantity of this modifier.
1300
1259
  * @min 1
@@ -1311,11 +1270,11 @@ export interface V1ItemModifier {
1311
1270
  */
1312
1271
  price?: string | null;
1313
1272
  }
1314
- export interface UpdateCartResponse {
1273
+ interface UpdateCartResponse {
1315
1274
  /** Updated Cart. */
1316
1275
  cart?: Cart;
1317
1276
  }
1318
- export interface AddToCurrentCartRequest {
1277
+ interface AddToCurrentCartRequest {
1319
1278
  /**
1320
1279
  * Catalog line items.
1321
1280
  * @maxSize 100
@@ -1337,11 +1296,11 @@ export interface AddToCurrentCartRequest {
1337
1296
  */
1338
1297
  businessLocationId?: string | null;
1339
1298
  }
1340
- export interface AddToCartResponse {
1299
+ interface AddToCartResponse {
1341
1300
  /** Updated cart. */
1342
1301
  cart?: Cart;
1343
1302
  }
1344
- export interface AddToCurrentCartAndEstimateTotalsRequest {
1303
+ interface AddToCurrentCartAndEstimateTotalsRequest {
1345
1304
  /**
1346
1305
  * Catalog line items.
1347
1306
  * @maxSize 100
@@ -1376,20 +1335,20 @@ export interface AddToCurrentCartAndEstimateTotalsRequest {
1376
1335
  */
1377
1336
  calculateShipping?: boolean | null;
1378
1337
  }
1379
- export interface SelectedMemberships {
1338
+ interface SelectedMemberships {
1380
1339
  /**
1381
1340
  * Selected memberships.
1382
1341
  * @maxSize 300
1383
1342
  */
1384
1343
  memberships?: HostSelectedMembership[];
1385
1344
  }
1386
- export interface HostSelectedMembership {
1345
+ interface HostSelectedMembership {
1387
1346
  /**
1388
1347
  * Membership ID.
1389
1348
  * @minLength 1
1390
1349
  * @maxLength 100
1391
1350
  */
1392
- id?: string;
1351
+ _id?: string;
1393
1352
  /**
1394
1353
  * ID of the app providing this payment option.
1395
1354
  * @format GUID
@@ -1404,7 +1363,7 @@ export interface HostSelectedMembership {
1404
1363
  */
1405
1364
  lineItemIds?: string[];
1406
1365
  }
1407
- export interface EstimateTotalsResponse {
1366
+ interface EstimateTotalsResponse {
1408
1367
  /** Cart. */
1409
1368
  cart?: Cart;
1410
1369
  /** Calculated line items. */
@@ -1451,7 +1410,7 @@ export interface EstimateTotalsResponse {
1451
1410
  */
1452
1411
  violations?: Violation[];
1453
1412
  }
1454
- export interface CalculatedLineItem {
1413
+ interface CalculatedLineItem {
1455
1414
  /** Line item ID. */
1456
1415
  lineItemId?: string;
1457
1416
  /** Price breakdown for this line item. */
@@ -1467,7 +1426,7 @@ export interface CalculatedLineItem {
1467
1426
  /** tax calculation address. */
1468
1427
  taxableAddress?: TaxableAddress;
1469
1428
  }
1470
- export interface LineItemPricesData {
1429
+ interface LineItemPricesData {
1471
1430
  /** Total price after discounts, tax, and modifiers. */
1472
1431
  totalPriceAfterTax?: MultiCurrencyPrice;
1473
1432
  /** Total price after discounts and modifiers, and before tax. */
@@ -1491,7 +1450,7 @@ export interface LineItemPricesData {
1491
1450
  */
1492
1451
  fullPrice?: MultiCurrencyPrice;
1493
1452
  }
1494
- export interface ItemTaxFullDetails {
1453
+ interface ItemTaxFullDetails {
1495
1454
  /** Amount for which tax is calculated. */
1496
1455
  taxableAmount?: MultiCurrencyPrice;
1497
1456
  /**
@@ -1508,7 +1467,7 @@ export interface ItemTaxFullDetails {
1508
1467
  */
1509
1468
  rateBreakdown?: TaxRateBreakdown[];
1510
1469
  }
1511
- export interface TaxRateBreakdown {
1470
+ interface TaxRateBreakdown {
1512
1471
  /**
1513
1472
  * Name of tax against which the calculation was performed.
1514
1473
  * @maxLength 100
@@ -1526,7 +1485,7 @@ export interface TaxRateBreakdown {
1526
1485
  * TaxBreakdown represents tax information for a line item.
1527
1486
  * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
1528
1487
  */
1529
- export interface TaxBreakdown {
1488
+ interface TaxBreakdown {
1530
1489
  /**
1531
1490
  * The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
1532
1491
  * @maxLength 200
@@ -1558,7 +1517,7 @@ export interface TaxBreakdown {
1558
1517
  jurisdictionType?: JurisdictionTypeWithLiterals;
1559
1518
  }
1560
1519
  /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
1561
- export declare enum JurisdictionType {
1520
+ declare enum JurisdictionType {
1562
1521
  UNDEFINED = "UNDEFINED",
1563
1522
  COUNTRY = "COUNTRY",
1564
1523
  STATE = "STATE",
@@ -1567,14 +1526,14 @@ export declare enum JurisdictionType {
1567
1526
  SPECIAL = "SPECIAL"
1568
1527
  }
1569
1528
  /** @enumType */
1570
- export type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
1571
- export interface CalculatedItemModifier {
1529
+ type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
1530
+ interface CalculatedItemModifier {
1572
1531
  /**
1573
1532
  * Modifier ID.
1574
1533
  * @minLength 1
1575
1534
  * @maxLength 36
1576
1535
  */
1577
- id?: string;
1536
+ _id?: string;
1578
1537
  /**
1579
1538
  * ID of the group this modifier belongs to.
1580
1539
  * @minLength 1
@@ -1587,7 +1546,7 @@ export interface CalculatedItemModifier {
1587
1546
  */
1588
1547
  price?: MultiCurrencyPrice;
1589
1548
  }
1590
- export interface PriceSummary {
1549
+ interface PriceSummary {
1591
1550
  /** Subtotal of all line items, before discounts and before tax. */
1592
1551
  subtotal?: MultiCurrencyPrice;
1593
1552
  /** Total shipping price, before discounts and before tax. */
@@ -1601,12 +1560,12 @@ export interface PriceSummary {
1601
1560
  /** Total additional fees price before tax. */
1602
1561
  additionalFees?: MultiCurrencyPrice;
1603
1562
  }
1604
- export interface GiftCard {
1563
+ interface GiftCard {
1605
1564
  /**
1606
1565
  * Gift Card ID.
1607
1566
  * @deprecated
1608
1567
  */
1609
- id?: string;
1568
+ _id?: string;
1610
1569
  /** Gift card obfuscated code. */
1611
1570
  obfuscatedCode?: string;
1612
1571
  /** Gift card value. */
@@ -1624,7 +1583,7 @@ export interface GiftCard {
1624
1583
  */
1625
1584
  externalId?: string | null;
1626
1585
  }
1627
- export interface TaxSummary {
1586
+ interface TaxSummary {
1628
1587
  /**
1629
1588
  * Amount for which tax is calculated, added from line items.
1630
1589
  * @readonly
@@ -1641,7 +1600,7 @@ export interface TaxSummary {
1641
1600
  */
1642
1601
  calculationDetails?: TaxCalculationDetails;
1643
1602
  }
1644
- export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
1603
+ interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
1645
1604
  /** Reason the manual calculation was used. */
1646
1605
  manualRateReason?: ManualCalculationReasonWithLiterals;
1647
1606
  /** Details of the fallback rate calculation. */
@@ -1650,13 +1609,13 @@ export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationD
1650
1609
  rateType?: RateTypeWithLiterals;
1651
1610
  }
1652
1611
  /** @oneof */
1653
- export interface TaxCalculationDetailsCalculationDetailsOneOf {
1612
+ interface TaxCalculationDetailsCalculationDetailsOneOf {
1654
1613
  /** Reason the manual calculation was used. */
1655
1614
  manualRateReason?: ManualCalculationReasonWithLiterals;
1656
1615
  /** Details of the fallback rate calculation. */
1657
1616
  autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
1658
1617
  }
1659
- export declare enum RateType {
1618
+ declare enum RateType {
1660
1619
  /** no tax being collected for this request due to location of purchase */
1661
1620
  NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
1662
1621
  /** manual rate used for calculation */
@@ -1667,30 +1626,30 @@ export declare enum RateType {
1667
1626
  FALLBACK_RATE = "FALLBACK_RATE"
1668
1627
  }
1669
1628
  /** @enumType */
1670
- export type RateTypeWithLiterals = RateType | 'NO_TAX_COLLECTED' | 'MANUAL_RATE' | 'AUTO_RATE' | 'FALLBACK_RATE';
1671
- export declare enum ManualCalculationReason {
1629
+ type RateTypeWithLiterals = RateType | 'NO_TAX_COLLECTED' | 'MANUAL_RATE' | 'AUTO_RATE' | 'FALLBACK_RATE';
1630
+ declare enum ManualCalculationReason {
1672
1631
  /** user set calculator in Business Manager to be Manual */
1673
1632
  GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
1674
1633
  /** specific region is on manual even though Global setting is Auto-tax */
1675
1634
  REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
1676
1635
  }
1677
1636
  /** @enumType */
1678
- export type ManualCalculationReasonWithLiterals = ManualCalculationReason | 'GLOBAL_SETTING_TO_MANUAL' | 'REGION_SETTING_TO_MANUAL';
1679
- export interface AutoTaxFallbackCalculationDetails {
1637
+ type ManualCalculationReasonWithLiterals = ManualCalculationReason | 'GLOBAL_SETTING_TO_MANUAL' | 'REGION_SETTING_TO_MANUAL';
1638
+ interface AutoTaxFallbackCalculationDetails {
1680
1639
  /** reason for fallback */
1681
1640
  fallbackReason?: FallbackReasonWithLiterals;
1682
1641
  /** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
1683
1642
  error?: ApplicationError;
1684
1643
  }
1685
- export declare enum FallbackReason {
1644
+ declare enum FallbackReason {
1686
1645
  /** auto-tax failed to be calculated */
1687
1646
  AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
1688
1647
  /** auto-tax was temporarily deactivated on a system-level */
1689
1648
  AUTO_TAX_DEACTIVATED = "AUTO_TAX_DEACTIVATED"
1690
1649
  }
1691
1650
  /** @enumType */
1692
- export type FallbackReasonWithLiterals = FallbackReason | 'AUTO_TAX_FAILED' | 'AUTO_TAX_DEACTIVATED';
1693
- export interface ApplicationError {
1651
+ type FallbackReasonWithLiterals = FallbackReason | 'AUTO_TAX_FAILED' | 'AUTO_TAX_DEACTIVATED';
1652
+ interface ApplicationError {
1694
1653
  /** Error code. */
1695
1654
  code?: string;
1696
1655
  /** Description of the error. */
@@ -1702,7 +1661,7 @@ export interface ApplicationError {
1702
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.
1703
1662
  * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
1704
1663
  */
1705
- export interface AggregatedTaxBreakdown {
1664
+ interface AggregatedTaxBreakdown {
1706
1665
  /**
1707
1666
  * The name of the tax against which this tax amount was calculated.
1708
1667
  * @maxLength 200
@@ -1728,7 +1687,7 @@ export interface AggregatedTaxBreakdown {
1728
1687
  /** The sum of all the tax from line items that calculated by the tax identifiers. */
1729
1688
  aggregatedTaxAmount?: MultiCurrencyPrice;
1730
1689
  }
1731
- export interface ShippingInformation {
1690
+ interface ShippingInformation {
1732
1691
  /** Shipping region. */
1733
1692
  region?: ShippingRegion;
1734
1693
  /** Selected shipping option. */
@@ -1736,20 +1695,20 @@ export interface ShippingInformation {
1736
1695
  /** All shipping options. */
1737
1696
  carrierServiceOptions?: CarrierServiceOption[];
1738
1697
  }
1739
- export interface ShippingRegion {
1698
+ interface ShippingRegion {
1740
1699
  /**
1741
1700
  * Shipping region ID.
1742
1701
  * @format GUID
1743
1702
  * @readonly
1744
1703
  */
1745
- id?: string;
1704
+ _id?: string;
1746
1705
  /**
1747
1706
  * Shipping region name.
1748
1707
  * @maxLength 100
1749
1708
  */
1750
1709
  name?: string;
1751
1710
  }
1752
- export interface SelectedCarrierServiceOption {
1711
+ interface SelectedCarrierServiceOption {
1753
1712
  /**
1754
1713
  * Unique identifier of selected option. For example, "usps_std_overnight".
1755
1714
  * @maxLength 100
@@ -1797,7 +1756,7 @@ export interface SelectedCarrierServiceOption {
1797
1756
  /** If the delivery solution is a partial and doesn't apply to all items. */
1798
1757
  partial?: boolean | null;
1799
1758
  }
1800
- export interface DeliveryLogistics {
1759
+ interface DeliveryLogistics {
1801
1760
  /**
1802
1761
  * Expected delivery time, in free text. For example, "3-5 business days".
1803
1762
  * @maxLength 500
@@ -1811,7 +1770,7 @@ export interface DeliveryLogistics {
1811
1770
  /** Pickup details. */
1812
1771
  pickupDetails?: PickupDetails;
1813
1772
  }
1814
- export interface PickupDetails {
1773
+ interface PickupDetails {
1815
1774
  /** Pickup address. */
1816
1775
  address?: Address;
1817
1776
  /**
@@ -1822,20 +1781,20 @@ export interface PickupDetails {
1822
1781
  /** Pickup method */
1823
1782
  pickupMethod?: PickupMethodWithLiterals;
1824
1783
  }
1825
- export declare enum PickupMethod {
1784
+ declare enum PickupMethod {
1826
1785
  UNKNOWN_METHOD = "UNKNOWN_METHOD",
1827
1786
  STORE_PICKUP = "STORE_PICKUP",
1828
1787
  PICKUP_POINT = "PICKUP_POINT"
1829
1788
  }
1830
1789
  /** @enumType */
1831
- export type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
1832
- export interface DeliveryTimeSlot {
1790
+ type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
1791
+ interface DeliveryTimeSlot {
1833
1792
  /** starting time of the delivery time slot */
1834
1793
  from?: Date | null;
1835
1794
  /** ending time of the delivery time slot */
1836
1795
  to?: Date | null;
1837
1796
  }
1838
- export interface SelectedCarrierServiceOptionPrices {
1797
+ interface SelectedCarrierServiceOptionPrices {
1839
1798
  /** Total shipping price, after discount and after tax. */
1840
1799
  totalPriceAfterTax?: MultiCurrencyPrice;
1841
1800
  /** Total price of shipping after discounts (when relevant), and before tax. */
@@ -1847,7 +1806,7 @@ export interface SelectedCarrierServiceOptionPrices {
1847
1806
  /** Shipping price before discount and before tax. */
1848
1807
  price?: MultiCurrencyPrice;
1849
1808
  }
1850
- export interface SelectedCarrierServiceOptionOtherCharge {
1809
+ interface SelectedCarrierServiceOptionOtherCharge {
1851
1810
  /** Type of additional cost. */
1852
1811
  type?: ChargeTypeWithLiterals;
1853
1812
  /**
@@ -1858,13 +1817,13 @@ export interface SelectedCarrierServiceOptionOtherCharge {
1858
1817
  /** Price of added charge. */
1859
1818
  cost?: SelectedCarrierServiceOptionPrices;
1860
1819
  }
1861
- export declare enum ChargeType {
1820
+ declare enum ChargeType {
1862
1821
  HANDLING_FEE = "HANDLING_FEE",
1863
1822
  INSURANCE = "INSURANCE"
1864
1823
  }
1865
1824
  /** @enumType */
1866
- export type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE' | 'INSURANCE';
1867
- export interface DeliveryAllocation {
1825
+ type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE' | 'INSURANCE';
1826
+ interface DeliveryAllocation {
1868
1827
  /** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
1869
1828
  deliveryCarrier?: Carrier;
1870
1829
  /** The delivery region that are relevant for this delivery solution. */
@@ -1872,7 +1831,7 @@ export interface DeliveryAllocation {
1872
1831
  /** Populated if the delivery solution is a partially supplied by this carrier. */
1873
1832
  applicableLineItems?: ApplicableLineItems;
1874
1833
  }
1875
- export interface Carrier {
1834
+ interface Carrier {
1876
1835
  /**
1877
1836
  * The carrier app id
1878
1837
  * @format GUID
@@ -1884,19 +1843,19 @@ export interface Carrier {
1884
1843
  */
1885
1844
  code?: string;
1886
1845
  }
1887
- export interface Region {
1846
+ interface Region {
1888
1847
  /**
1889
1848
  * The delivery region id.
1890
1849
  * @format GUID
1891
1850
  */
1892
- id?: string | null;
1851
+ _id?: string | null;
1893
1852
  /**
1894
1853
  * The delivery region name.
1895
1854
  * @maxLength 100
1896
1855
  */
1897
1856
  name?: string | null;
1898
1857
  }
1899
- export interface ApplicableLineItems {
1858
+ interface ApplicableLineItems {
1900
1859
  /**
1901
1860
  * Line items that the delivery solution is for.
1902
1861
  * @maxSize 300
@@ -1905,7 +1864,7 @@ export interface ApplicableLineItems {
1905
1864
  */
1906
1865
  lineItemIds?: string[];
1907
1866
  }
1908
- export interface CarrierServiceOption {
1867
+ interface CarrierServiceOption {
1909
1868
  /**
1910
1869
  * Carrier ID.
1911
1870
  * @format GUID
@@ -1914,7 +1873,7 @@ export interface CarrierServiceOption {
1914
1873
  /** Shipping options offered by this carrier for this request. */
1915
1874
  shippingOptions?: ShippingOption[];
1916
1875
  }
1917
- export interface ShippingOption {
1876
+ interface ShippingOption {
1918
1877
  /**
1919
1878
  * Unique code of provided shipping option like "usps_std_overnight".
1920
1879
  * For legacy calculators this would be the UUID of the option.
@@ -1939,13 +1898,13 @@ export interface ShippingOption {
1939
1898
  /** If the delivery solution is a partial and doesn't apply to all items. */
1940
1899
  partial?: boolean | null;
1941
1900
  }
1942
- export interface ShippingPrice {
1901
+ interface ShippingPrice {
1943
1902
  /** Shipping price. */
1944
1903
  price?: MultiCurrencyPrice;
1945
1904
  /** Other costs such as insurance, handling & packaging for fragile items, etc. */
1946
1905
  otherCharges?: OtherCharge[];
1947
1906
  }
1948
- export interface OtherCharge {
1907
+ interface OtherCharge {
1949
1908
  /** Type of additional cost. */
1950
1909
  type?: ChargeTypeWithLiterals;
1951
1910
  /** Price of added cost. */
@@ -1956,7 +1915,7 @@ export interface OtherCharge {
1956
1915
  */
1957
1916
  details?: string | null;
1958
1917
  }
1959
- export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1918
+ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1960
1919
  /** Coupon details. */
1961
1920
  coupon?: V1Coupon;
1962
1921
  /** Merchant discount. */
@@ -1975,7 +1934,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1975
1934
  lineItemIds?: string[];
1976
1935
  }
1977
1936
  /** @oneof */
1978
- export interface AppliedDiscountDiscountSourceOneOf {
1937
+ interface AppliedDiscountDiscountSourceOneOf {
1979
1938
  /** Coupon details. */
1980
1939
  coupon?: V1Coupon;
1981
1940
  /** Merchant discount. */
@@ -1983,17 +1942,17 @@ export interface AppliedDiscountDiscountSourceOneOf {
1983
1942
  /** Discount rule */
1984
1943
  discountRule?: V1DiscountRule;
1985
1944
  }
1986
- export declare enum AppliedDiscountDiscountType {
1945
+ declare enum AppliedDiscountDiscountType {
1987
1946
  GLOBAL = "GLOBAL",
1988
1947
  SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
1989
1948
  SHIPPING = "SHIPPING"
1990
1949
  }
1991
1950
  /** @enumType */
1992
- export type AppliedDiscountDiscountTypeWithLiterals = AppliedDiscountDiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
1951
+ type AppliedDiscountDiscountTypeWithLiterals = AppliedDiscountDiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
1993
1952
  /** Coupon */
1994
- export interface V1Coupon {
1953
+ interface V1Coupon {
1995
1954
  /** Coupon ID. */
1996
- id?: string;
1955
+ _id?: string;
1997
1956
  /** Coupon code. */
1998
1957
  code?: string;
1999
1958
  /** Coupon value. */
@@ -2001,7 +1960,7 @@ export interface V1Coupon {
2001
1960
  /** Coupon name. */
2002
1961
  name?: string;
2003
1962
  }
2004
- export interface V1MerchantDiscount {
1963
+ interface V1MerchantDiscount {
2005
1964
  /** Discount value. */
2006
1965
  amount?: MultiCurrencyPrice;
2007
1966
  /**
@@ -2011,18 +1970,18 @@ export interface V1MerchantDiscount {
2011
1970
  */
2012
1971
  percentage?: number | null;
2013
1972
  }
2014
- export interface V1DiscountRule {
1973
+ interface V1DiscountRule {
2015
1974
  /**
2016
1975
  * Discount rule ID
2017
1976
  * @format GUID
2018
1977
  */
2019
- id?: string;
1978
+ _id?: string;
2020
1979
  /** Discount rule name */
2021
1980
  name?: V1DiscountRuleName;
2022
1981
  /** Discount value. */
2023
1982
  amount?: MultiCurrencyPrice;
2024
1983
  }
2025
- export interface V1DiscountRuleName {
1984
+ interface V1DiscountRuleName {
2026
1985
  /**
2027
1986
  * Original discount rule name (in site's default language).
2028
1987
  * @minLength 1
@@ -2036,16 +1995,16 @@ export interface V1DiscountRuleName {
2036
1995
  */
2037
1996
  translated?: string | null;
2038
1997
  }
2039
- export interface LineItemDiscount {
1998
+ interface LineItemDiscount {
2040
1999
  /**
2041
2000
  * ID of line item the discount applies to.
2042
2001
  * @format GUID
2043
2002
  */
2044
- id?: string;
2003
+ _id?: string;
2045
2004
  /** Discount value. */
2046
2005
  totalDiscountAmount?: MultiCurrencyPrice;
2047
2006
  }
2048
- export interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
2007
+ interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
2049
2008
  /** General shipping calculation error. */
2050
2009
  generalShippingCalculationError?: Details;
2051
2010
  /** Carrier errors. */
@@ -2067,13 +2026,13 @@ export interface CalculationErrors extends CalculationErrorsShippingCalculationE
2067
2026
  discountsCalculationError?: Details;
2068
2027
  }
2069
2028
  /** @oneof */
2070
- export interface CalculationErrorsShippingCalculationErrorOneOf {
2029
+ interface CalculationErrorsShippingCalculationErrorOneOf {
2071
2030
  /** General shipping calculation error. */
2072
2031
  generalShippingCalculationError?: Details;
2073
2032
  /** Carrier errors. */
2074
2033
  carrierErrors?: CarrierErrors;
2075
2034
  }
2076
- export interface Details extends DetailsKindOneOf {
2035
+ interface Details extends DetailsKindOneOf {
2077
2036
  applicationError?: ApplicationError;
2078
2037
  validationError?: ValidationError;
2079
2038
  systemError?: SystemError;
@@ -2084,7 +2043,7 @@ export interface Details extends DetailsKindOneOf {
2084
2043
  tracing?: Record<string, string>;
2085
2044
  }
2086
2045
  /** @oneof */
2087
- export interface DetailsKindOneOf {
2046
+ interface DetailsKindOneOf {
2088
2047
  applicationError?: ApplicationError;
2089
2048
  validationError?: ValidationError;
2090
2049
  systemError?: SystemError;
@@ -2121,10 +2080,10 @@ export interface DetailsKindOneOf {
2121
2080
  * ]
2122
2081
  * }
2123
2082
  */
2124
- export interface ValidationError {
2083
+ interface ValidationError {
2125
2084
  fieldViolations?: FieldViolation[];
2126
2085
  }
2127
- export declare enum RuleType {
2086
+ declare enum RuleType {
2128
2087
  VALIDATION = "VALIDATION",
2129
2088
  OTHER = "OTHER",
2130
2089
  MAX = "MAX",
@@ -2148,8 +2107,8 @@ export declare enum RuleType {
2148
2107
  REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
2149
2108
  }
2150
2109
  /** @enumType */
2151
- 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';
2152
- 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 {
2153
2112
  field?: string;
2154
2113
  description?: string;
2155
2114
  violatedRule?: RuleTypeWithLiterals;
@@ -2157,21 +2116,21 @@ export interface FieldViolation {
2157
2116
  ruleName?: string | null;
2158
2117
  data?: Record<string, any> | null;
2159
2118
  }
2160
- export interface SystemError {
2119
+ interface SystemError {
2161
2120
  /** Error code. */
2162
2121
  errorCode?: string | null;
2163
2122
  }
2164
- export interface CarrierErrors {
2123
+ interface CarrierErrors {
2165
2124
  /** Carrier errors. */
2166
2125
  errors?: CarrierError[];
2167
2126
  }
2168
- export interface CarrierError {
2127
+ interface CarrierError {
2169
2128
  /** Carrier ID. */
2170
2129
  carrierId?: string;
2171
2130
  /** Error details. */
2172
2131
  error?: Details;
2173
2132
  }
2174
- export interface MembershipOptions {
2133
+ interface MembershipOptions {
2175
2134
  /**
2176
2135
  * List of payment options that can be used.
2177
2136
  * @maxSize 300
@@ -2188,13 +2147,13 @@ export interface MembershipOptions {
2188
2147
  */
2189
2148
  selectedMemberships?: HostSelectedMembership[];
2190
2149
  }
2191
- export interface Membership {
2150
+ interface Membership {
2192
2151
  /**
2193
2152
  * Membership ID.
2194
2153
  * @minLength 1
2195
2154
  * @maxLength 100
2196
2155
  */
2197
- id?: string;
2156
+ _id?: string;
2198
2157
  /**
2199
2158
  * ID of the application providing this payment option.
2200
2159
  * @format GUID
@@ -2217,7 +2176,7 @@ export interface Membership {
2217
2176
  /** Additional data about this membership. */
2218
2177
  additionalData?: Record<string, any> | null;
2219
2178
  }
2220
- export interface MembershipName {
2179
+ interface MembershipName {
2221
2180
  /**
2222
2181
  * Membership name.
2223
2182
  * @maxLength 100
@@ -2229,7 +2188,7 @@ export interface MembershipName {
2229
2188
  */
2230
2189
  translated?: string | null;
2231
2190
  }
2232
- export interface MembershipPaymentCredits {
2191
+ interface MembershipPaymentCredits {
2233
2192
  /**
2234
2193
  * Membership's total amount of credits.
2235
2194
  * @min 1
@@ -2238,7 +2197,7 @@ export interface MembershipPaymentCredits {
2238
2197
  /** Membership's remaining amount of credits. */
2239
2198
  remaining?: number;
2240
2199
  }
2241
- export interface InvalidMembership {
2200
+ interface InvalidMembership {
2242
2201
  /** Membership details. */
2243
2202
  membership?: Membership;
2244
2203
  /**
@@ -2248,7 +2207,7 @@ export interface InvalidMembership {
2248
2207
  */
2249
2208
  reason?: string;
2250
2209
  }
2251
- export interface AdditionalFee {
2210
+ interface AdditionalFee {
2252
2211
  /**
2253
2212
  * Additional fee's unique code (or ID) for future processing.
2254
2213
  * @minLength 1
@@ -2284,7 +2243,7 @@ export interface AdditionalFee {
2284
2243
  /** the source the additional fee was added from */
2285
2244
  source?: AdditionalFeeSourceWithLiterals;
2286
2245
  }
2287
- export declare enum AdditionalFeeSource {
2246
+ declare enum AdditionalFeeSource {
2288
2247
  UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
2289
2248
  /** The additional fee was added by an additional fee service plugin */
2290
2249
  SERVICE_PLUGIN = "SERVICE_PLUGIN",
@@ -2296,8 +2255,8 @@ export declare enum AdditionalFeeSource {
2296
2255
  SHIPPING = "SHIPPING"
2297
2256
  }
2298
2257
  /** @enumType */
2299
- export type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING';
2300
- export interface Violation {
2258
+ type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING';
2259
+ interface Violation {
2301
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. */
2302
2261
  severity?: SeverityWithLiterals;
2303
2262
  /** Target location on a checkout or cart page where the violation will be displayed. */
@@ -2309,7 +2268,7 @@ export interface Violation {
2309
2268
  */
2310
2269
  description?: string | null;
2311
2270
  }
2312
- export declare enum Severity {
2271
+ declare enum Severity {
2313
2272
  /** The user is allowed to move forward in the flow. */
2314
2273
  WARNING = "WARNING",
2315
2274
  /**
@@ -2319,55 +2278,53 @@ export declare enum Severity {
2319
2278
  ERROR = "ERROR"
2320
2279
  }
2321
2280
  /** @enumType */
2322
- export type SeverityWithLiterals = Severity | 'WARNING' | 'ERROR';
2323
- export interface Target extends TargetTargetTypeOneOf {
2281
+ type SeverityWithLiterals = Severity | 'WARNING' | 'ERROR';
2282
+ interface Target extends TargetTargetTypeOneOf {
2324
2283
  /** General (other) violation. */
2325
2284
  other?: Other;
2326
2285
  /** Specific line item violation. */
2327
2286
  lineItem?: TargetLineItem;
2328
2287
  }
2329
2288
  /** @oneof */
2330
- export interface TargetTargetTypeOneOf {
2289
+ interface TargetTargetTypeOneOf {
2331
2290
  /** General (other) violation. */
2332
2291
  other?: Other;
2333
2292
  /** Specific line item violation. */
2334
2293
  lineItem?: TargetLineItem;
2335
2294
  }
2336
2295
  /** Available locations on the webpage */
2337
- export declare enum NameInOther {
2296
+ declare enum NameInOther {
2338
2297
  /** Default location, in case no specific location is specified. */
2339
2298
  OTHER_DEFAULT = "OTHER_DEFAULT"
2340
2299
  }
2341
2300
  /** @enumType */
2342
- export type NameInOtherWithLiterals = NameInOther | 'OTHER_DEFAULT';
2301
+ type NameInOtherWithLiterals = NameInOther | 'OTHER_DEFAULT';
2343
2302
  /** Available locations on the line item */
2344
- export declare enum NameInLineItem {
2303
+ declare enum NameInLineItem {
2345
2304
  /** Default location, in case no specific location is specified. */
2346
2305
  LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
2347
2306
  }
2348
2307
  /** @enumType */
2349
- export type NameInLineItemWithLiterals = NameInLineItem | 'LINE_ITEM_DEFAULT';
2350
- export declare enum SuggestedFix {
2308
+ type NameInLineItemWithLiterals = NameInLineItem | 'LINE_ITEM_DEFAULT';
2309
+ declare enum SuggestedFix {
2351
2310
  /** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
2352
2311
  UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
2353
2312
  /** The line item should be removed from the cart or checkout to resolve the violation. */
2354
2313
  REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
2355
2314
  }
2356
- /** @enumType */
2357
- export type SuggestedFixWithLiterals = SuggestedFix | 'UNKNOWN_SUGGESTED_FIX' | 'REMOVE_LINE_ITEM';
2358
2315
  /** General (other) violation. */
2359
- export interface Other {
2316
+ interface Other {
2360
2317
  /** Location on a checkout or a cart page where a general (other) violation will be displayed. */
2361
2318
  name?: NameInOtherWithLiterals;
2362
2319
  }
2363
2320
  /** Specific line item violation. */
2364
- export interface TargetLineItem {
2321
+ interface TargetLineItem {
2365
2322
  /** Location on a checkout or a cart page where the specific line item violation will be displayed. */
2366
2323
  name?: NameInLineItemWithLiterals;
2367
2324
  /** ID of the line item containing the violation. */
2368
- id?: string | null;
2325
+ _id?: string | null;
2369
2326
  }
2370
- export interface RemoveLineItemsFromCurrentCartRequest {
2327
+ interface RemoveLineItemsFromCurrentCartRequest {
2371
2328
  /**
2372
2329
  * Line item IDs to remove from cart.
2373
2330
  * @format GUID
@@ -2376,11 +2333,11 @@ export interface RemoveLineItemsFromCurrentCartRequest {
2376
2333
  */
2377
2334
  lineItemIds?: string[];
2378
2335
  }
2379
- export interface RemoveLineItemsResponse {
2336
+ interface RemoveLineItemsResponse {
2380
2337
  /** Updated cart. */
2381
2338
  cart?: Cart;
2382
2339
  }
2383
- export interface CreateCheckoutFromCurrentCartRequest {
2340
+ interface CreateCheckoutFromCurrentCartRequest {
2384
2341
  /** __Required.__ Sales channel type. */
2385
2342
  channelType?: ChannelTypeWithLiterals;
2386
2343
  /** Shipping address. Used for calculating tax and shipping (when applicable). */
@@ -2395,7 +2352,7 @@ export interface CreateCheckoutFromCurrentCartRequest {
2395
2352
  */
2396
2353
  email?: string | null;
2397
2354
  }
2398
- export declare enum ChannelType {
2355
+ declare enum ChannelType {
2399
2356
  /** Unspecified sales channel. This value is not supported. */
2400
2357
  UNSPECIFIED = "UNSPECIFIED",
2401
2358
  /** A web client. */
@@ -2430,18 +2387,18 @@ export declare enum ChannelType {
2430
2387
  FAIRE_COM = "FAIRE_COM"
2431
2388
  }
2432
2389
  /** @enumType */
2433
- 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';
2434
- 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 {
2435
2392
  /** The newly created checkout's ID. */
2436
2393
  checkoutId?: string;
2437
2394
  }
2438
- export interface RemoveCouponFromCurrentCartRequest {
2395
+ interface RemoveCouponFromCurrentCartRequest {
2439
2396
  }
2440
- export interface RemoveCouponResponse {
2397
+ interface RemoveCouponResponse {
2441
2398
  /** Updated cart. */
2442
2399
  cart?: Cart;
2443
2400
  }
2444
- export interface UpdateCurrentCartLineItemQuantityRequest {
2401
+ interface UpdateCurrentCartLineItemQuantityRequest {
2445
2402
  /**
2446
2403
  * Line item IDs and their new quantity.
2447
2404
  * @minSize 1
@@ -2449,12 +2406,12 @@ export interface UpdateCurrentCartLineItemQuantityRequest {
2449
2406
  */
2450
2407
  lineItems?: LineItemQuantityUpdate[];
2451
2408
  }
2452
- export interface LineItemQuantityUpdate {
2409
+ interface LineItemQuantityUpdate {
2453
2410
  /**
2454
2411
  * *Required.** Line item ID.
2455
2412
  * @format GUID
2456
2413
  */
2457
- id?: string;
2414
+ _id?: string;
2458
2415
  /**
2459
2416
  * *Required.** New quantity. Number must be 1 or higher.
2460
2417
  * @min 1
@@ -2462,11 +2419,11 @@ export interface LineItemQuantityUpdate {
2462
2419
  */
2463
2420
  quantity?: number;
2464
2421
  }
2465
- export interface UpdateLineItemsQuantityResponse {
2422
+ interface UpdateLineItemsQuantityResponse {
2466
2423
  /** Updated cart. */
2467
2424
  cart?: Cart;
2468
2425
  }
2469
- export interface EstimateCurrentCartTotalsRequest {
2426
+ interface EstimateCurrentCartTotalsRequest {
2470
2427
  /** Selected shipping option. */
2471
2428
  selectedShippingOption?: SelectedShippingOption;
2472
2429
  /** Shipping address. Used for calculating tax and shipping (when applicable). */
@@ -2488,17 +2445,17 @@ export interface EstimateCurrentCartTotalsRequest {
2488
2445
  */
2489
2446
  calculateShipping?: boolean | null;
2490
2447
  }
2491
- export interface DeleteCurrentCartRequest {
2448
+ interface DeleteCurrentCartRequest {
2492
2449
  }
2493
- export interface DeleteCartResponse {
2450
+ interface DeleteCartResponse {
2494
2451
  }
2495
- export interface DomainEvent extends DomainEventBodyOneOf {
2452
+ interface DomainEvent extends DomainEventBodyOneOf {
2496
2453
  createdEvent?: EntityCreatedEvent;
2497
2454
  updatedEvent?: EntityUpdatedEvent;
2498
2455
  deletedEvent?: EntityDeletedEvent;
2499
2456
  actionEvent?: ActionEvent;
2500
2457
  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2501
- id?: string;
2458
+ _id?: string;
2502
2459
  /**
2503
2460
  * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2504
2461
  * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
@@ -2527,36 +2484,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
2527
2484
  entityEventSequence?: string | null;
2528
2485
  }
2529
2486
  /** @oneof */
2530
- export interface DomainEventBodyOneOf {
2487
+ interface DomainEventBodyOneOf {
2531
2488
  createdEvent?: EntityCreatedEvent;
2532
2489
  updatedEvent?: EntityUpdatedEvent;
2533
2490
  deletedEvent?: EntityDeletedEvent;
2534
2491
  actionEvent?: ActionEvent;
2535
2492
  }
2536
- export interface EntityCreatedEvent {
2537
- entityAsJson?: string;
2538
- /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
2539
- restoreInfo?: RestoreInfo;
2493
+ interface EntityCreatedEvent {
2494
+ entity?: string;
2540
2495
  }
2541
- export interface RestoreInfo {
2496
+ interface RestoreInfo {
2542
2497
  deletedDate?: Date | null;
2543
2498
  }
2544
- export interface EntityUpdatedEvent {
2499
+ interface EntityUpdatedEvent {
2545
2500
  /**
2546
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.
2547
2502
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2548
2503
  * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2549
2504
  */
2550
- currentEntityAsJson?: string;
2505
+ currentEntity?: string;
2551
2506
  }
2552
- export interface EntityDeletedEvent {
2507
+ interface EntityDeletedEvent {
2553
2508
  /** Entity that was deleted. */
2554
- deletedEntityAsJson?: string | null;
2509
+ deletedEntity?: string | null;
2555
2510
  }
2556
- export interface ActionEvent {
2557
- bodyAsJson?: string;
2511
+ interface ActionEvent {
2512
+ body?: string;
2558
2513
  }
2559
- export interface MessageEnvelope {
2514
+ interface MessageEnvelope {
2560
2515
  /**
2561
2516
  * App instance ID.
2562
2517
  * @format GUID
@@ -2572,7 +2527,7 @@ export interface MessageEnvelope {
2572
2527
  /** Stringify payload. */
2573
2528
  data?: string;
2574
2529
  }
2575
- export interface IdentificationData extends IdentificationDataIdOneOf {
2530
+ interface IdentificationData extends IdentificationDataIdOneOf {
2576
2531
  /**
2577
2532
  * ID of a site visitor that has not logged in to the site.
2578
2533
  * @format GUID
@@ -2597,7 +2552,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
2597
2552
  identityType?: WebhookIdentityTypeWithLiterals;
2598
2553
  }
2599
2554
  /** @oneof */
2600
- export interface IdentificationDataIdOneOf {
2555
+ interface IdentificationDataIdOneOf {
2601
2556
  /**
2602
2557
  * ID of a site visitor that has not logged in to the site.
2603
2558
  * @format GUID
@@ -2619,7 +2574,7 @@ export interface IdentificationDataIdOneOf {
2619
2574
  */
2620
2575
  appId?: string;
2621
2576
  }
2622
- export declare enum WebhookIdentityType {
2577
+ declare enum WebhookIdentityType {
2623
2578
  UNKNOWN = "UNKNOWN",
2624
2579
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2625
2580
  MEMBER = "MEMBER",
@@ -2627,8 +2582,8 @@ export declare enum WebhookIdentityType {
2627
2582
  APP = "APP"
2628
2583
  }
2629
2584
  /** @enumType */
2630
- export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2631
- export interface CreateCartRequest {
2585
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2586
+ interface CreateCartRequest {
2632
2587
  /** Cart info. */
2633
2588
  cartInfo?: Cart;
2634
2589
  /** Code of an existing coupon to apply to cart. For more information, see the Coupons API. */
@@ -2652,38 +2607,38 @@ export interface CreateCartRequest {
2652
2607
  */
2653
2608
  customLineItems?: CustomLineItem[];
2654
2609
  }
2655
- export interface CreateCartResponse {
2610
+ interface CreateCartResponse {
2656
2611
  /** Cart. */
2657
2612
  cart?: Cart;
2658
2613
  }
2659
- export interface GetCartRequest {
2614
+ interface GetCartRequest {
2660
2615
  /**
2661
2616
  * Cart ID.
2662
2617
  * @format GUID
2663
2618
  */
2664
- id: string;
2619
+ _id: string;
2665
2620
  }
2666
- export interface GetCartResponse {
2621
+ interface GetCartResponse {
2667
2622
  /** Retrieved cart. */
2668
2623
  cart?: Cart;
2669
2624
  }
2670
- export interface GetCartByCheckoutIdRequest {
2625
+ interface GetCartByCheckoutIdRequest {
2671
2626
  /**
2672
2627
  * Checkout ID.
2673
2628
  * @format GUID
2674
2629
  */
2675
- id: string;
2630
+ _id: string;
2676
2631
  }
2677
- export interface GetCartByCheckoutIdResponse {
2632
+ interface GetCartByCheckoutIdResponse {
2678
2633
  /** Retrieved cart. */
2679
2634
  cart?: Cart;
2680
2635
  }
2681
- export interface AddToCartRequest {
2636
+ interface AddToCartRequest {
2682
2637
  /**
2683
2638
  * Cart ID.
2684
2639
  * @format GUID
2685
2640
  */
2686
- id: string;
2641
+ _id: string;
2687
2642
  /**
2688
2643
  * Catalog line items.
2689
2644
  * @maxSize 100
@@ -2706,12 +2661,12 @@ export interface AddToCartRequest {
2706
2661
  */
2707
2662
  businessLocationId?: string | null;
2708
2663
  }
2709
- export interface RemoveLineItemsRequest {
2664
+ interface RemoveLineItemsRequest {
2710
2665
  /**
2711
2666
  * Cart ID.
2712
2667
  * @format GUID
2713
2668
  */
2714
- id: string;
2669
+ _id: string;
2715
2670
  /**
2716
2671
  * Line item IDs to remove from cart.
2717
2672
  * @format GUID
@@ -2720,12 +2675,12 @@ export interface RemoveLineItemsRequest {
2720
2675
  */
2721
2676
  lineItemIds: string[];
2722
2677
  }
2723
- export interface CreateCheckoutRequest {
2678
+ interface CreateCheckoutRequest {
2724
2679
  /**
2725
2680
  * Cart ID.
2726
2681
  * @format GUID
2727
2682
  */
2728
- id: string;
2683
+ _id: string;
2729
2684
  /** __Required.__ Sales channel type. */
2730
2685
  channelType?: ChannelTypeWithLiterals;
2731
2686
  /** Shipping address. Used for calculating tax and shipping (when applicable). */
@@ -2740,19 +2695,19 @@ export interface CreateCheckoutRequest {
2740
2695
  */
2741
2696
  email?: string | null;
2742
2697
  }
2743
- export interface RemoveCouponRequest {
2698
+ interface RemoveCouponRequest {
2744
2699
  /**
2745
2700
  * Cart ID.
2746
2701
  * @format GUID
2747
2702
  */
2748
- id: string;
2703
+ _id: string;
2749
2704
  }
2750
- export interface UpdateLineItemsQuantityRequest {
2705
+ interface UpdateLineItemsQuantityRequest {
2751
2706
  /**
2752
2707
  * Cart ID.
2753
2708
  * @format GUID
2754
2709
  */
2755
- id: string;
2710
+ _id: string;
2756
2711
  /**
2757
2712
  * Line item IDs and their new quantity.
2758
2713
  * @minSize 1
@@ -2760,12 +2715,12 @@ export interface UpdateLineItemsQuantityRequest {
2760
2715
  */
2761
2716
  lineItems: LineItemQuantityUpdate[];
2762
2717
  }
2763
- export interface EstimateTotalsRequest {
2718
+ interface EstimateTotalsRequest {
2764
2719
  /**
2765
2720
  * Cart ID.
2766
2721
  * @format GUID
2767
2722
  */
2768
- id: string;
2723
+ _id: string;
2769
2724
  /** Selected shipping option. */
2770
2725
  selectedShippingOption?: SelectedShippingOption;
2771
2726
  /** Shipping address. Used for calculating tax and shipping (when applicable). */
@@ -2787,23 +2742,295 @@ export interface EstimateTotalsRequest {
2787
2742
  */
2788
2743
  calculateShipping?: boolean | null;
2789
2744
  }
2790
- export interface DeleteCartRequest {
2745
+ interface DeleteCartRequest {
2791
2746
  /**
2792
2747
  * ID of the cart to delete.
2793
2748
  * @format GUID
2794
2749
  */
2795
- id: string;
2750
+ _id: string;
2796
2751
  }
2797
- export interface Empty {
2752
+ interface Empty {
2798
2753
  }
2799
- export interface RemoveBusinessLocationRequest {
2754
+ interface RemoveBusinessLocationRequest {
2800
2755
  /**
2801
2756
  * Cart ID.
2802
2757
  * @format GUID
2803
2758
  */
2804
- id: string;
2759
+ _id: string;
2805
2760
  }
2806
- export interface RemoveBusinessLocationResponse {
2761
+ interface RemoveBusinessLocationResponse {
2807
2762
  /** Updated cart. */
2808
2763
  cart?: Cart;
2809
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 CreateCartOptions {
2821
+ /** Cart info. */
2822
+ cartInfo?: Cart;
2823
+ /** Code of an existing coupon to apply to cart. 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 UpdateCartOptions {
2845
+ /** The information for the cart being updated. */
2846
+ cartInfo: {
2847
+ /**
2848
+ * Cart ID.
2849
+ * @format GUID
2850
+ */
2851
+ _id?: string | null;
2852
+ /**
2853
+ * Line items.
2854
+ * @minSize 1
2855
+ * @maxSize 300
2856
+ * @readonly
2857
+ */
2858
+ lineItems?: LineItem[];
2859
+ /**
2860
+ * [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer.
2861
+ * @maxLength 1000
2862
+ */
2863
+ buyerNote?: string | null;
2864
+ /** Buyer information. */
2865
+ buyerInfo?: BuyerInfo;
2866
+ /**
2867
+ * The site's default currency, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
2868
+ * @format CURRENCY
2869
+ * @readonly
2870
+ */
2871
+ currency?: string;
2872
+ /**
2873
+ * The currency selected by the buyer during the purchase flow, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
2874
+ * @readonly
2875
+ * @format CURRENCY
2876
+ */
2877
+ conversionCurrency?: string;
2878
+ /**
2879
+ * Language for communication with the buyer. Defaults to the site language.
2880
+ *
2881
+ * For a site that supports multiple languages, this is the language the buyer selected.
2882
+ * @readonly
2883
+ */
2884
+ buyerLanguage?: string | null;
2885
+ /**
2886
+ * Site language in which original values are displayed.
2887
+ * @readonly
2888
+ */
2889
+ siteLanguage?: string | null;
2890
+ /**
2891
+ * Whether tax is included in line item prices.
2892
+ * @readonly
2893
+ */
2894
+ taxIncludedInPrices?: boolean | null;
2895
+ /**
2896
+ * Weight measurement unit - defaults to site's weight unit.
2897
+ * @readonly
2898
+ */
2899
+ weightUnit?: WeightUnitWithLiterals;
2900
+ /**
2901
+ * ID of the checkout that originated from this cart.
2902
+ * @readonly
2903
+ * @format GUID
2904
+ */
2905
+ checkoutId?: string | null;
2906
+ /**
2907
+ * Cart discounts.
2908
+ * @readonly
2909
+ */
2910
+ appliedDiscounts?: CartDiscount[];
2911
+ /**
2912
+ * Date and time the cart was created.
2913
+ * @readonly
2914
+ */
2915
+ _createdDate?: Date | null;
2916
+ /**
2917
+ * Date and time the cart was updated.
2918
+ * @readonly
2919
+ */
2920
+ _updatedDate?: Date | null;
2921
+ /** Contact info. */
2922
+ contactInfo?: AddressWithContact;
2923
+ /**
2924
+ * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
2925
+ *
2926
+ * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API
2927
+ * to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
2928
+ * standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
2929
+ * @maxLength 1000
2930
+ */
2931
+ overrideCheckoutUrl?: string | null;
2932
+ /**
2933
+ * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
2934
+ * @format GUID
2935
+ * @readonly
2936
+ */
2937
+ purchaseFlowId?: string | null;
2938
+ /** Selected shipping option. */
2939
+ selectedShippingOption?: SelectedShippingOption;
2940
+ /**
2941
+ * The business location ID associated with the cart.
2942
+ *
2943
+ * To learn more, see the Locations API.
2944
+ * @format GUID
2945
+ */
2946
+ businessLocationId?: string | null;
2947
+ /**
2948
+ * Currency used for payment, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
2949
+ * @readonly
2950
+ * @format CURRENCY
2951
+ */
2952
+ paymentCurrency?: string;
2953
+ };
2954
+ /** Coupon code. For more information, see the Coupons API. */
2955
+ couponCode?: string | null;
2956
+ /**
2957
+ * Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will be applied to the whole cart.
2958
+ * @maxSize 100
2959
+ */
2960
+ merchantDiscounts?: MerchantDiscountInput[];
2961
+ /**
2962
+ * Catalog line items.
2963
+ * @maxSize 300
2964
+ */
2965
+ lineItems?: LineItem[];
2966
+ /**
2967
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
2968
+ *
2969
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
2970
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
2971
+ * @maxSize 300
2972
+ */
2973
+ customLineItems?: CustomLineItem[];
2974
+ }
2975
+ interface AddToCartOptions {
2976
+ /**
2977
+ * Catalog line items.
2978
+ * @maxSize 100
2979
+ */
2980
+ lineItems?: LineItem[];
2981
+ /**
2982
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
2983
+ *
2984
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
2985
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
2986
+ * @maxSize 100
2987
+ */
2988
+ customLineItems?: CustomLineItem[];
2989
+ /**
2990
+ * The business location ID associated with the cart.
2991
+ *
2992
+ * The `businessLocationId` field cannot be passed if one already exists on the cart. To update a cart's business location ID, use the Update Cart method.
2993
+ * To learn more, see the Locations API.
2994
+ * @format GUID
2995
+ */
2996
+ businessLocationId?: string | null;
2997
+ }
2998
+ interface CreateCheckoutOptions {
2999
+ /** __Required.__ Sales channel type. */
3000
+ channelType?: ChannelTypeWithLiterals;
3001
+ /** Shipping address. Used for calculating tax and shipping (when applicable). */
3002
+ shippingAddress?: Address;
3003
+ /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */
3004
+ billingAddress?: Address;
3005
+ /** Selected shipping option. */
3006
+ selectedShippingOption?: SelectedShippingOption;
3007
+ /**
3008
+ * Required when setting a billing or shipping address if the site visitor isn't logged in.
3009
+ * @format EMAIL
3010
+ */
3011
+ email?: string | null;
3012
+ }
3013
+ interface EstimateTotalsOptions {
3014
+ /** Selected shipping option. */
3015
+ selectedShippingOption?: SelectedShippingOption;
3016
+ /** Shipping address. Used for calculating tax and shipping (when applicable). */
3017
+ shippingAddress?: Address;
3018
+ /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */
3019
+ billingAddress?: Address;
3020
+ /** The selected membership payment options and which line items they apply to. */
3021
+ selectedMemberships?: SelectedMemberships;
3022
+ /**
3023
+ * Whether to calculate tax in the calculation request.
3024
+ *
3025
+ * Default: `true`
3026
+ */
3027
+ calculateTax?: boolean | null;
3028
+ /**
3029
+ * Whether to calculate shipping in the calculation request.
3030
+ *
3031
+ * Default: `true`
3032
+ */
3033
+ calculateShipping?: boolean | null;
3034
+ }
3035
+
3036
+ export { type ItemAvailabilityInfo as $, type AddToCartOptions as A, type CatalogReference as B, type CreateCartOptions as C, DescriptionLineType as D, type EstimateTotalsOptions as E, FileType as F, type ProductName as G, type MultiCurrencyPrice as H, ItemAvailabilityStatus as I, JurisdictionType as J, type DescriptionLine as K, type LineItemQuantityUpdate as L, ManualCalculationReason as M, NameInOther as N, type DescriptionLineValueOneOf as O, PaymentOptionType as P, type DescriptionLineDescriptionLineValueOneOf as Q, type RemoveLineItemsResponse as R, SubscriptionFrequency as S, TaxableAddressType as T, type UpdateCartOptions as U, VatType as V, WeightUnit as W, type DescriptionLineName as X, type PlainTextValue as Y, type Color as Z, type FocalPoint as _, type Cart as a, type AggregatedTaxBreakdown as a$, type PhysicalProperties as a0, type Scope as a1, type Group as a2, type ItemType as a3, type ItemTypeItemTypeDataOneOf as a4, type SubscriptionOptionInfo as a5, type SubscriptionSettings as a6, type FreeTrialPeriod as a7, type Title as a8, type Description as a9, type VatId as aA, type SelectedShippingOption as aB, type GetCurrentCartRequest as aC, type GetCurrentCartResponse as aD, type UpdateCartRequest as aE, type MerchantDiscountInput as aF, type CustomLineItem as aG, type V1ModifierGroup as aH, type V1ItemModifier as aI, type UpdateCartResponse as aJ, type AddToCurrentCartRequest as aK, type AddToCurrentCartAndEstimateTotalsRequest as aL, type SelectedMemberships as aM, type HostSelectedMembership as aN, type CalculatedLineItem as aO, type LineItemPricesData as aP, type ItemTaxFullDetails as aQ, type TaxRateBreakdown as aR, type TaxBreakdown as aS, type CalculatedItemModifier as aT, type PriceSummary as aU, type GiftCard as aV, type TaxSummary as aW, type TaxCalculationDetails as aX, type TaxCalculationDetailsCalculationDetailsOneOf as aY, type AutoTaxFallbackCalculationDetails as aZ, type ApplicationError as a_, type SecuredMedia as aa, type ServiceProperties as ab, type PriceDescription as ac, type SelectedMembership as ad, type CatalogOverrideFields as ae, type PaymentOption as af, type TaxableAddress as ag, type TaxableAddressTaxableAddressDataOneOf as ah, type ExtendedFields as ai, type Policy as aj, type ModifierGroup as ak, type TranslatableString as al, type ItemModifier as am, type BuyerInfo as an, type BuyerInfoIdOneOf as ao, type CartDiscount as ap, type CartDiscountDiscountSourceOneOf as aq, type Coupon as ar, type MerchantDiscount as as, type DiscountRule as at, type DiscountRuleName as au, type AddressWithContact as av, type Address as aw, type StreetAddress as ax, type AddressLocation as ay, type FullAddressContactDetails as az, type AddToCartResponse as b, type GetCartResponse as b$, type ShippingInformation as b0, type ShippingRegion as b1, type SelectedCarrierServiceOption as b2, type DeliveryLogistics as b3, type PickupDetails as b4, type DeliveryTimeSlot as b5, type SelectedCarrierServiceOptionPrices as b6, type SelectedCarrierServiceOptionOtherCharge as b7, type DeliveryAllocation as b8, type Carrier as b9, type InvalidMembership as bA, type AdditionalFee as bB, type Violation as bC, type Target as bD, type TargetTargetTypeOneOf as bE, type Other as bF, type TargetLineItem as bG, type RemoveLineItemsFromCurrentCartRequest as bH, type CreateCheckoutFromCurrentCartRequest as bI, type RemoveCouponFromCurrentCartRequest as bJ, type UpdateCurrentCartLineItemQuantityRequest as bK, type EstimateCurrentCartTotalsRequest as bL, type DeleteCurrentCartRequest as bM, type DeleteCartResponse as bN, type DomainEvent as bO, type DomainEventBodyOneOf as bP, type EntityCreatedEvent as bQ, type RestoreInfo as bR, type EntityUpdatedEvent as bS, type EntityDeletedEvent as bT, type ActionEvent as bU, type MessageEnvelope as bV, type IdentificationData as bW, type IdentificationDataIdOneOf as bX, type CreateCartRequest as bY, type CreateCartResponse as bZ, type GetCartRequest as b_, type Region as ba, type ApplicableLineItems as bb, type CarrierServiceOption as bc, type ShippingOption as bd, type ShippingPrice as be, type OtherCharge as bf, type AppliedDiscount as bg, type AppliedDiscountDiscountSourceOneOf as bh, type V1Coupon as bi, type V1MerchantDiscount as bj, type V1DiscountRule as bk, type V1DiscountRuleName as bl, type LineItemDiscount as bm, type CalculationErrors as bn, type CalculationErrorsShippingCalculationErrorOneOf as bo, type Details as bp, type DetailsKindOneOf as bq, type ValidationError as br, type FieldViolation as bs, type SystemError as bt, type CarrierErrors as bu, type CarrierError as bv, type MembershipOptions as bw, type Membership as bx, type MembershipName as by, type MembershipPaymentCredits as bz, type CreateCheckoutOptions as c, type GetCartByCheckoutIdRequest as c0, type GetCartByCheckoutIdResponse as c1, type AddToCartRequest as c2, type RemoveLineItemsRequest as c3, type CreateCheckoutRequest as c4, type RemoveCouponRequest as c5, type UpdateLineItemsQuantityRequest as c6, type EstimateTotalsRequest as c7, type DeleteCartRequest as c8, type Empty as c9, type RemoveBusinessLocationRequest as ca, type BaseEventMetadata as cb, type EventMetadata as cc, type CreateCheckoutResponse as d, type RemoveCouponResponse as e, type UpdateLineItemsQuantityResponse as f, type EstimateTotalsResponse as g, type RemoveBusinessLocationResponse as h, type CartDeletedEnvelope as i, type CartUpdatedEnvelope as j, type CartCreatedEnvelope as k, ItemTypeItemType as l, DiscountType as m, RateType as n, FallbackReason as o, PickupMethod as p, ChargeType as q, AppliedDiscountDiscountType as r, RuleType as s, AdditionalFeeSource as t, Severity as u, NameInLineItem as v, SuggestedFix as w, ChannelType as x, WebhookIdentityType as y, type LineItem as z };