@wix/auto_sdk_ecom_subscription-contracts 1.0.17 → 1.0.19

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 (132) hide show
  1. package/build/{cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts → ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal-C1mp-xS2.d.mts} +251 -398
  2. package/build/{es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts → ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal-C1mp-xS2.d.ts} +251 -398
  3. package/build/index.d.mts +39 -0
  4. package/build/index.d.ts +39 -0
  5. package/build/index.js +659 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +615 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/{cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts → internal/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal-WYe0iZSk.d.mts} +207 -447
  10. package/build/{es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts → internal/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal-WYe0iZSk.d.ts} +207 -447
  11. package/build/internal/index.d.mts +39 -0
  12. package/build/internal/index.d.ts +39 -0
  13. package/build/internal/index.js +659 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +615 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/{cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts → meta.d.mts} +93 -751
  18. package/build/internal/{es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts → meta.d.ts} +93 -751
  19. package/build/internal/meta.js +257 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +229 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +1320 -0
  24. package/build/meta.d.ts +1320 -0
  25. package/build/meta.js +257 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +229 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +13 -12
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.d.ts +0 -16
  40. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js +0 -35
  41. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js.map +0 -1
  42. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.d.ts +0 -14
  43. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js +0 -198
  44. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js.map +0 -1
  45. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.d.ts +0 -16
  46. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js +0 -66
  47. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js.map +0 -1
  48. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.d.ts +0 -32
  49. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js +0 -153
  50. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js.map +0 -1
  51. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js +0 -161
  52. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js.map +0 -1
  53. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js +0 -342
  54. package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js.map +0 -1
  55. package/build/es/index.d.ts +0 -1
  56. package/build/es/index.js +0 -2
  57. package/build/es/index.js.map +0 -1
  58. package/build/es/index.typings.d.ts +0 -1
  59. package/build/es/index.typings.js +0 -2
  60. package/build/es/index.typings.js.map +0 -1
  61. package/build/es/meta.d.ts +0 -1
  62. package/build/es/meta.js +0 -2
  63. package/build/es/meta.js.map +0 -1
  64. package/build/es/package.json +0 -3
  65. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.d.ts +0 -16
  66. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js +0 -16
  67. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js.map +0 -1
  68. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.d.ts +0 -14
  69. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js +0 -193
  70. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js.map +0 -1
  71. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.d.ts +0 -16
  72. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js +0 -38
  73. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js.map +0 -1
  74. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.d.ts +0 -32
  75. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js +0 -132
  76. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js.map +0 -1
  77. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js +0 -158
  78. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js.map +0 -1
  79. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js +0 -314
  80. package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js.map +0 -1
  81. package/build/internal/cjs/index.d.ts +0 -1
  82. package/build/internal/cjs/index.js +0 -18
  83. package/build/internal/cjs/index.js.map +0 -1
  84. package/build/internal/cjs/index.typings.d.ts +0 -1
  85. package/build/internal/cjs/index.typings.js +0 -18
  86. package/build/internal/cjs/index.typings.js.map +0 -1
  87. package/build/internal/cjs/meta.d.ts +0 -1
  88. package/build/internal/cjs/meta.js +0 -18
  89. package/build/internal/cjs/meta.js.map +0 -1
  90. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.d.ts +0 -16
  91. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js +0 -35
  92. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js.map +0 -1
  93. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.d.ts +0 -14
  94. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js +0 -198
  95. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js.map +0 -1
  96. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.d.ts +0 -16
  97. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js +0 -66
  98. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js.map +0 -1
  99. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.d.ts +0 -32
  100. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js +0 -153
  101. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js.map +0 -1
  102. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js +0 -161
  103. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js.map +0 -1
  104. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts +0 -2251
  105. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js +0 -342
  106. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js.map +0 -1
  107. package/build/internal/es/index.d.ts +0 -1
  108. package/build/internal/es/index.js +0 -2
  109. package/build/internal/es/index.js.map +0 -1
  110. package/build/internal/es/index.typings.d.ts +0 -1
  111. package/build/internal/es/index.typings.js +0 -2
  112. package/build/internal/es/index.typings.js.map +0 -1
  113. package/build/internal/es/meta.d.ts +0 -1
  114. package/build/internal/es/meta.js +0 -2
  115. package/build/internal/es/meta.js.map +0 -1
  116. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.d.ts +0 -16
  117. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js +0 -16
  118. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js.map +0 -1
  119. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.d.ts +0 -14
  120. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js +0 -193
  121. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js.map +0 -1
  122. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.d.ts +0 -16
  123. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js +0 -38
  124. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js.map +0 -1
  125. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.d.ts +0 -32
  126. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js +0 -132
  127. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js.map +0 -1
  128. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js +0 -158
  129. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js.map +0 -1
  130. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts +0 -2251
  131. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js +0 -314
  132. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js.map +0 -1
@@ -4,13 +4,13 @@
4
4
  * Read more about SubscriptionContracts
5
5
  * in this [article](<LINK_TO_KB_ARTICLE>).
6
6
  */
7
- export interface SubscriptionContract {
7
+ interface SubscriptionContract {
8
8
  /**
9
9
  * SubscriptionContract ID.
10
10
  * @format GUID
11
11
  * @readonly
12
12
  */
13
- id?: string | null;
13
+ _id?: string | null;
14
14
  /**
15
15
  * Revision number, which increments by 1 each time the SubscriptionContract is updated.
16
16
  * To prevent conflicting changes, the current revision must be passed when updating the SubscriptionContract.
@@ -23,12 +23,12 @@ export interface SubscriptionContract {
23
23
  * Date and time the subscription contract was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
24
24
  * @readonly
25
25
  */
26
- createdDate?: Date | null;
26
+ _createdDate?: Date | null;
27
27
  /**
28
28
  * Date and time the subscription contract was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
29
29
  * @readonly
30
30
  */
31
- updatedDate?: Date | null;
31
+ _updatedDate?: Date | null;
32
32
  /**
33
33
  * Subscription option description. For example, `"1kg of selected coffee, once a month"`.
34
34
  * @maxLength 500
@@ -116,7 +116,7 @@ export interface SubscriptionContract {
116
116
  */
117
117
  additionalFees?: AdditionalFee[];
118
118
  }
119
- export interface V1SubscriptionDescription {
119
+ interface V1SubscriptionDescription {
120
120
  /**
121
121
  * Subscription option description.
122
122
  * @maxLength 500
@@ -128,7 +128,7 @@ export interface V1SubscriptionDescription {
128
128
  */
129
129
  translated?: string | null;
130
130
  }
131
- export interface V1SubscriptionSettings {
131
+ interface V1SubscriptionSettings {
132
132
  /** Frequency of recurring payment. */
133
133
  frequency?: SubscriptionFrequency;
134
134
  /**
@@ -147,14 +147,14 @@ export interface V1SubscriptionSettings {
147
147
  /** Whether to allow the customer to cancel the subscription. */
148
148
  enableCustomerCancellation?: boolean;
149
149
  }
150
- export declare enum SubscriptionFrequency {
150
+ declare enum SubscriptionFrequency {
151
151
  UNDEFINED = "UNDEFINED",
152
152
  DAY = "DAY",
153
153
  WEEK = "WEEK",
154
154
  MONTH = "MONTH",
155
155
  YEAR = "YEAR"
156
156
  }
157
- export interface V1FreeTrialPeriod {
157
+ interface V1FreeTrialPeriod {
158
158
  /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
159
159
  frequency?: SubscriptionFrequency;
160
160
  /**
@@ -164,12 +164,12 @@ export interface V1FreeTrialPeriod {
164
164
  */
165
165
  interval?: number;
166
166
  }
167
- export interface OrderLineItem {
167
+ interface OrderLineItem {
168
168
  /**
169
169
  * Line item ID.
170
170
  * @immutable
171
171
  */
172
- id?: string;
172
+ _id?: string;
173
173
  /**
174
174
  * Item name.
175
175
  * + Stores - `product.name`
@@ -199,7 +199,7 @@ export interface OrderLineItem {
199
199
  */
200
200
  descriptionLines?: DescriptionLine[];
201
201
  /** Line item image. */
202
- image?: Image;
202
+ image?: string;
203
203
  /** Physical properties of the item. When relevant, contains information such as SKU and item weight. */
204
204
  physicalProperties?: PhysicalProperties;
205
205
  /** Item type. Either a preset type or custom. */
@@ -281,7 +281,7 @@ export interface OrderLineItem {
281
281
  */
282
282
  extendedFields?: ExtendedFields;
283
283
  }
284
- export interface ProductName {
284
+ interface ProductName {
285
285
  /**
286
286
  * __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).
287
287
  *
@@ -303,7 +303,7 @@ export interface ProductName {
303
303
  translated?: string | null;
304
304
  }
305
305
  /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
306
- export interface CatalogReference {
306
+ interface CatalogReference {
307
307
  /**
308
308
  * ID of the item within the catalog it belongs to.
309
309
  * @minLength 1
@@ -329,7 +329,7 @@ export interface CatalogReference {
329
329
  */
330
330
  options?: Record<string, any> | null;
331
331
  }
332
- export interface Price {
332
+ interface Price {
333
333
  /**
334
334
  * Amount.
335
335
  * @decimalValue options { gte:0, lte:1000000000000000 }
@@ -341,7 +341,7 @@ export interface Price {
341
341
  */
342
342
  formattedAmount?: string;
343
343
  }
344
- export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
344
+ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
345
345
  /** Description line plain text value. */
346
346
  plainText?: PlainTextValue;
347
347
  /** Description line color value. */
@@ -350,16 +350,16 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
350
350
  name?: DescriptionLineName;
351
351
  }
352
352
  /** @oneof */
353
- export interface DescriptionLineValueOneOf {
353
+ interface DescriptionLineValueOneOf {
354
354
  /** Description line plain text value. */
355
355
  plainText?: PlainTextValue;
356
356
  /** Description line color value. */
357
357
  colorInfo?: Color;
358
358
  }
359
359
  /** @oneof */
360
- export interface DescriptionLineDescriptionLineValueOneOf {
360
+ interface DescriptionLineDescriptionLineValueOneOf {
361
361
  }
362
- export interface DescriptionLineName {
362
+ interface DescriptionLineName {
363
363
  /**
364
364
  * 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).
365
365
  * @maxLength 100
@@ -373,7 +373,7 @@ export interface DescriptionLineName {
373
373
  */
374
374
  translated?: string | null;
375
375
  }
376
- export interface PlainTextValue {
376
+ interface PlainTextValue {
377
377
  /**
378
378
  * 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).
379
379
  * @maxLength 600
@@ -387,7 +387,7 @@ export interface PlainTextValue {
387
387
  */
388
388
  translated?: string | null;
389
389
  }
390
- export interface Color {
390
+ interface Color {
391
391
  /**
392
392
  * 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).
393
393
  * @maxLength 500
@@ -403,7 +403,7 @@ export interface Color {
403
403
  /** HEX or RGB color code for display. */
404
404
  code?: string | null;
405
405
  }
406
- export declare enum DescriptionLineType {
406
+ declare enum DescriptionLineType {
407
407
  /** Unrecognized type. */
408
408
  UNRECOGNISED = "UNRECOGNISED",
409
409
  /** Plain text type. */
@@ -411,30 +411,7 @@ export declare enum DescriptionLineType {
411
411
  /** Color type. */
412
412
  COLOR = "COLOR"
413
413
  }
414
- export interface Image {
415
- /** WixMedia image ID. */
416
- id?: string;
417
- /** Image URL. */
418
- url?: string;
419
- /**
420
- * Original image height.
421
- * @readonly
422
- */
423
- height?: number;
424
- /**
425
- * Original image width.
426
- * @readonly
427
- */
428
- width?: number;
429
- /** Image alt text. */
430
- altText?: string | null;
431
- /**
432
- * Image filename.
433
- * @readonly
434
- */
435
- filename?: string | null;
436
- }
437
- export interface FocalPoint {
414
+ interface FocalPoint {
438
415
  /** X-coordinate of the focal point. */
439
416
  x?: number;
440
417
  /** Y-coordinate of the focal point. */
@@ -444,7 +421,7 @@ export interface FocalPoint {
444
421
  /** crop by width */
445
422
  width?: number | null;
446
423
  }
447
- export interface PhysicalProperties {
424
+ interface PhysicalProperties {
448
425
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
449
426
  weight?: number | null;
450
427
  /**
@@ -455,20 +432,20 @@ export interface PhysicalProperties {
455
432
  /** Whether this line item is shippable. */
456
433
  shippable?: boolean;
457
434
  }
458
- export interface ItemType extends ItemTypeItemTypeDataOneOf {
435
+ interface ItemType extends ItemTypeItemTypeDataOneOf {
459
436
  /** Preset item type. */
460
437
  preset?: ItemTypeItemType;
461
438
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
462
439
  custom?: string;
463
440
  }
464
441
  /** @oneof */
465
- export interface ItemTypeItemTypeDataOneOf {
442
+ interface ItemTypeItemTypeDataOneOf {
466
443
  /** Preset item type. */
467
444
  preset?: ItemTypeItemType;
468
445
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
469
446
  custom?: string;
470
447
  }
471
- export declare enum ItemTypeItemType {
448
+ declare enum ItemTypeItemType {
472
449
  UNRECOGNISED = "UNRECOGNISED",
473
450
  PHYSICAL = "PHYSICAL",
474
451
  DIGITAL = "DIGITAL",
@@ -476,7 +453,7 @@ export declare enum ItemTypeItemType {
476
453
  SERVICE = "SERVICE"
477
454
  }
478
455
  /** Type of selected payment option for catalog item */
479
- export declare enum PaymentOptionType {
456
+ declare enum PaymentOptionType {
480
457
  /** The entire payment for this item happens as part of the checkout. */
481
458
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
482
459
  /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
@@ -488,7 +465,7 @@ export declare enum PaymentOptionType {
488
465
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
489
466
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
490
467
  }
491
- export interface ItemTaxFullDetails {
468
+ interface ItemTaxFullDetails {
492
469
  /** Taxable amount of this line item. */
493
470
  taxableAmount?: Price;
494
471
  /**
@@ -499,7 +476,7 @@ export interface ItemTaxFullDetails {
499
476
  /** The calculated tax, based on the `taxableAmount` and `taxRate`. */
500
477
  totalTax?: Price;
501
478
  }
502
- export interface LineItemTaxInfo {
479
+ interface LineItemTaxInfo {
503
480
  /** Calculated tax, based on `taxable_amount` and `tax_rate`. */
504
481
  taxAmount?: Price;
505
482
  /** Amount for which tax is calculated. */
@@ -527,7 +504,7 @@ export interface LineItemTaxInfo {
527
504
  * TaxBreakdown represents tax information for a line item.
528
505
  * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
529
506
  */
530
- export interface LineItemTaxBreakdown {
507
+ interface LineItemTaxBreakdown {
531
508
  /**
532
509
  * Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
533
510
  * @maxLength 200
@@ -560,7 +537,7 @@ export interface LineItemTaxBreakdown {
560
537
  taxableAmount?: Price;
561
538
  }
562
539
  /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
563
- export declare enum JurisdictionType {
540
+ declare enum JurisdictionType {
564
541
  UNDEFINED = "UNDEFINED",
565
542
  COUNTRY = "COUNTRY",
566
543
  STATE = "STATE",
@@ -568,7 +545,7 @@ export declare enum JurisdictionType {
568
545
  CITY = "CITY",
569
546
  SPECIAL = "SPECIAL"
570
547
  }
571
- export interface DigitalFile {
548
+ interface DigitalFile {
572
549
  /**
573
550
  * ID of the secure file in media.
574
551
  * @minLength 1
@@ -588,12 +565,12 @@ export interface DigitalFile {
588
565
  */
589
566
  expirationDate?: Date | null;
590
567
  }
591
- export interface SubscriptionInfo {
568
+ interface SubscriptionInfo {
592
569
  /**
593
570
  * Subscription ID.
594
571
  * @format GUID
595
572
  */
596
- id?: string | null;
573
+ _id?: string | null;
597
574
  /**
598
575
  * Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`.
599
576
  * @min 1
@@ -621,7 +598,7 @@ export interface SubscriptionInfo {
621
598
  */
622
599
  subscriptionSettings?: SubscriptionSettings;
623
600
  }
624
- export interface SubscriptionTitle {
601
+ interface SubscriptionTitle {
625
602
  /**
626
603
  * 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).
627
604
  * @minLength 1
@@ -637,7 +614,7 @@ export interface SubscriptionTitle {
637
614
  */
638
615
  translated?: string | null;
639
616
  }
640
- export interface SubscriptionDescription {
617
+ interface SubscriptionDescription {
641
618
  /**
642
619
  * Subscription option description.
643
620
  * @maxLength 500
@@ -649,7 +626,7 @@ export interface SubscriptionDescription {
649
626
  */
650
627
  translated?: string | null;
651
628
  }
652
- export interface SubscriptionSettings {
629
+ interface SubscriptionSettings {
653
630
  /** Frequency of recurring payment. */
654
631
  frequency?: V2SubscriptionFrequency;
655
632
  /**
@@ -667,14 +644,14 @@ export interface SubscriptionSettings {
667
644
  billingCycles?: number | null;
668
645
  }
669
646
  /** Frequency unit of recurring payment */
670
- export declare enum V2SubscriptionFrequency {
647
+ declare enum V2SubscriptionFrequency {
671
648
  UNDEFINED = "UNDEFINED",
672
649
  DAY = "DAY",
673
650
  WEEK = "WEEK",
674
651
  MONTH = "MONTH",
675
652
  YEAR = "YEAR"
676
653
  }
677
- export interface FreeTrialPeriod {
654
+ interface FreeTrialPeriod {
678
655
  /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
679
656
  frequency?: V2SubscriptionFrequency;
680
657
  /**
@@ -684,20 +661,20 @@ export interface FreeTrialPeriod {
684
661
  */
685
662
  interval?: number;
686
663
  }
687
- export interface BillingAdjustment {
664
+ interface BillingAdjustment {
688
665
  /** The type of adjustment. */
689
666
  type?: AdjustmentType;
690
667
  /** Summary of the prorated adjustment amount. */
691
668
  priceSummary?: BillingAdjustmentPriceSummary;
692
669
  }
693
- export declare enum AdjustmentType {
670
+ declare enum AdjustmentType {
694
671
  UNKNOWN_ADJUSTMENT_TYPE = "UNKNOWN_ADJUSTMENT_TYPE",
695
672
  /** Adjustment increases the total amount due to changes like covering extra billing days. Typically results in an additional fee. */
696
673
  EXTRA_CHARGE = "EXTRA_CHARGE",
697
674
  /** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
698
675
  CREDIT = "CREDIT"
699
676
  }
700
- export interface BillingAdjustmentPriceSummary {
677
+ interface BillingAdjustmentPriceSummary {
701
678
  /** Subtotal of adjustment, before tax. */
702
679
  subtotal?: Price;
703
680
  /** Tax on adjustment. */
@@ -705,7 +682,7 @@ export interface BillingAdjustmentPriceSummary {
705
682
  /** Total price after tax. */
706
683
  total?: Price;
707
684
  }
708
- export interface PriceDescription {
685
+ interface PriceDescription {
709
686
  /**
710
687
  * __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).
711
688
  * @minLength 1
@@ -721,12 +698,12 @@ export interface PriceDescription {
721
698
  */
722
699
  translated?: string | null;
723
700
  }
724
- export interface LocationAndQuantity {
701
+ interface LocationAndQuantity {
725
702
  /**
726
703
  * Location id in the associated owner app.
727
704
  * @format GUID
728
705
  */
729
- id?: string;
706
+ _id?: string;
730
707
  /**
731
708
  * Location owner app, if not provided then the site business info locations will be used.
732
709
  * @format GUID
@@ -747,22 +724,22 @@ export interface LocationAndQuantity {
747
724
  */
748
725
  name?: string | null;
749
726
  }
750
- export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
727
+ interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
751
728
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
752
729
  addressType?: TaxableAddressType;
753
730
  }
754
731
  /** @oneof */
755
- export interface TaxableAddressTaxableAddressDataOneOf {
732
+ interface TaxableAddressTaxableAddressDataOneOf {
756
733
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
757
734
  addressType?: TaxableAddressType;
758
735
  }
759
- export declare enum TaxableAddressType {
736
+ declare enum TaxableAddressType {
760
737
  UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
761
738
  BUSINESS = "BUSINESS",
762
739
  BILLING = "BILLING",
763
740
  SHIPPING = "SHIPPING"
764
741
  }
765
- export interface ExtendedFields {
742
+ interface ExtendedFields {
766
743
  /**
767
744
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
768
745
  * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -774,7 +751,7 @@ export interface ExtendedFields {
774
751
  namespaces?: Record<string, Record<string, any>>;
775
752
  }
776
753
  /** Buyer Info */
777
- export interface BuyerInfo extends BuyerInfoIdOneOf {
754
+ interface BuyerInfo extends BuyerInfoIdOneOf {
778
755
  /**
779
756
  * Visitor ID (if site visitor is not a member).
780
757
  * @format GUID
@@ -797,7 +774,7 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
797
774
  email?: string | null;
798
775
  }
799
776
  /** @oneof */
800
- export interface BuyerInfoIdOneOf {
777
+ interface BuyerInfoIdOneOf {
801
778
  /**
802
779
  * Visitor ID (if site visitor is not a member).
803
780
  * @format GUID
@@ -809,7 +786,7 @@ export interface BuyerInfoIdOneOf {
809
786
  */
810
787
  memberId?: string;
811
788
  }
812
- export declare enum WeightUnit {
789
+ declare enum WeightUnit {
813
790
  /** Weight unit can't be classified due to an error. */
814
791
  UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
815
792
  /** Kilograms. */
@@ -817,7 +794,7 @@ export declare enum WeightUnit {
817
794
  /** Pounds. */
818
795
  LB = "LB"
819
796
  }
820
- export interface CurrencyConversionDetails {
797
+ interface CurrencyConversionDetails {
821
798
  /**
822
799
  * Original currency used to calculate the pricing before conversion to payment currency set on the order [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
823
800
  * @readonly
@@ -833,7 +810,7 @@ export interface CurrencyConversionDetails {
833
810
  */
834
811
  conversionRate?: string | null;
835
812
  }
836
- export interface PriceSummary {
813
+ interface PriceSummary {
837
814
  /** Subtotal of all the line items, before discounts and before tax. */
838
815
  subtotal?: Price;
839
816
  /** Total shipping price, before discounts and before tax. */
@@ -848,14 +825,14 @@ export interface PriceSummary {
848
825
  totalAdditionalFees?: Price;
849
826
  }
850
827
  /** Billing Info and shipping details */
851
- export interface AddressWithContact {
828
+ interface AddressWithContact {
852
829
  /** Address. */
853
830
  address?: Address;
854
831
  /** Contact details. */
855
832
  contactDetails?: FullAddressContactDetails;
856
833
  }
857
834
  /** Physical address */
858
- export interface Address {
835
+ interface Address {
859
836
  /**
860
837
  * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
861
838
  * @format COUNTRY
@@ -882,7 +859,7 @@ export interface Address {
882
859
  * Main address line (usually street name and number).
883
860
  * @maxLength 150
884
861
  */
885
- addressLine?: string | null;
862
+ addressLine1?: string | null;
886
863
  /**
887
864
  * Free text providing more detailed address info. Usually contains apt, suite, floor.
888
865
  * @maxLength 100
@@ -899,20 +876,20 @@ export interface Address {
899
876
  */
900
877
  subdivisionFullname?: string | null;
901
878
  }
902
- export interface StreetAddress {
879
+ interface StreetAddress {
903
880
  /** Street number. */
904
881
  number?: string;
905
882
  /** Street name. */
906
883
  name?: string;
907
884
  }
908
- export interface AddressLocation {
885
+ interface AddressLocation {
909
886
  /** Address latitude. */
910
887
  latitude?: number | null;
911
888
  /** Address longitude. */
912
889
  longitude?: number | null;
913
890
  }
914
891
  /** Full contact details for an address */
915
- export interface FullAddressContactDetails {
892
+ interface FullAddressContactDetails {
916
893
  /**
917
894
  * First name.
918
895
  * @maxLength 100
@@ -936,9 +913,9 @@ export interface FullAddressContactDetails {
936
913
  /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
937
914
  vatId?: VatId;
938
915
  }
939
- export interface VatId {
916
+ interface VatId {
940
917
  /** Customer's tax ID. */
941
- id?: string;
918
+ _id?: string;
942
919
  /**
943
920
  * Tax type.
944
921
  *
@@ -949,14 +926,14 @@ export interface VatId {
949
926
  type?: VatType;
950
927
  }
951
928
  /** tax info types */
952
- export declare enum VatType {
929
+ declare enum VatType {
953
930
  UNSPECIFIED = "UNSPECIFIED",
954
931
  /** CPF - for individual tax payers. */
955
932
  CPF = "CPF",
956
933
  /** CNPJ - for corporations */
957
934
  CNPJ = "CNPJ"
958
935
  }
959
- export interface ShippingInformation {
936
+ interface ShippingInformation {
960
937
  /**
961
938
  * App Def Id of external provider which was a source of shipping info
962
939
  * @minLength 1
@@ -982,7 +959,7 @@ export interface ShippingInformation {
982
959
  /** Shipping region. */
983
960
  region?: ShippingRegion;
984
961
  }
985
- export interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
962
+ interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
986
963
  /** Shipping address and contact details. */
987
964
  shippingDestination?: AddressWithContact;
988
965
  /** Pickup details. */
@@ -1006,20 +983,20 @@ export interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
1006
983
  deliveryTimeSlot?: DeliveryTimeSlot;
1007
984
  }
1008
985
  /** @oneof */
1009
- export interface DeliveryLogisticsAddressOneOf {
986
+ interface DeliveryLogisticsAddressOneOf {
1010
987
  /** Shipping address and contact details. */
1011
988
  shippingDestination?: AddressWithContact;
1012
989
  /** Pickup details. */
1013
990
  pickupDetails?: PickupDetails;
1014
991
  }
1015
- export interface PickupDetails {
992
+ interface PickupDetails {
1016
993
  /** Pickup address. */
1017
994
  address?: PickupAddress;
1018
995
  /** Pickup method */
1019
996
  pickupMethod?: PickupMethod;
1020
997
  }
1021
998
  /** Physical address */
1022
- export interface PickupAddress {
999
+ interface PickupAddress {
1023
1000
  /**
1024
1001
  * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
1025
1002
  * @format COUNTRY
@@ -1046,7 +1023,7 @@ export interface PickupAddress {
1046
1023
  * Main address line (usually street name and number).
1047
1024
  * @maxLength 1000
1048
1025
  */
1049
- addressLine?: string | null;
1026
+ addressLine1?: string | null;
1050
1027
  /**
1051
1028
  * Free text providing more detailed address info. Usually contains apt, suite, floor.
1052
1029
  * @maxLength 1000
@@ -1063,18 +1040,18 @@ export interface PickupAddress {
1063
1040
  */
1064
1041
  subdivisionFullname?: string | null;
1065
1042
  }
1066
- export declare enum PickupMethod {
1043
+ declare enum PickupMethod {
1067
1044
  UNKNOWN_METHOD = "UNKNOWN_METHOD",
1068
1045
  STORE_PICKUP = "STORE_PICKUP",
1069
1046
  PICKUP_POINT = "PICKUP_POINT"
1070
1047
  }
1071
- export interface DeliveryTimeSlot {
1048
+ interface DeliveryTimeSlot {
1072
1049
  /** Delivery slot starting time. */
1073
1050
  from?: Date | null;
1074
1051
  /** Delivery slot ending time. */
1075
1052
  to?: Date | null;
1076
1053
  }
1077
- export interface ShippingPrice {
1054
+ interface ShippingPrice {
1078
1055
  /** Shipping price for display purposes. */
1079
1056
  price?: Price;
1080
1057
  /**
@@ -1095,14 +1072,14 @@ export interface ShippingPrice {
1095
1072
  */
1096
1073
  discount?: Price;
1097
1074
  }
1098
- export interface ShippingRegion {
1075
+ interface ShippingRegion {
1099
1076
  /**
1100
1077
  * Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
1101
1078
  * @maxLength 100
1102
1079
  */
1103
1080
  name?: string | null;
1104
1081
  }
1105
- export interface OrderTaxInfo {
1082
+ interface OrderTaxInfo {
1106
1083
  /** Calculated tax, added from line items. */
1107
1084
  totalTax?: Price;
1108
1085
  /**
@@ -1122,7 +1099,7 @@ export interface OrderTaxInfo {
1122
1099
  * 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.
1123
1100
  * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
1124
1101
  */
1125
- export interface OrderTaxBreakdown {
1102
+ interface OrderTaxBreakdown {
1126
1103
  /**
1127
1104
  * The name of the tax against which this tax amount was calculated.
1128
1105
  * @maxLength 200
@@ -1149,7 +1126,7 @@ export interface OrderTaxBreakdown {
1149
1126
  /** The sum of all the tax from line items that calculated by the tax identifiers. */
1150
1127
  aggregatedTaxAmount?: Price;
1151
1128
  }
1152
- export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1129
+ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1153
1130
  /** Applied coupon info. */
1154
1131
  coupon?: Coupon;
1155
1132
  /** Merchant discount. */
@@ -1179,10 +1156,10 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1179
1156
  * @format GUID
1180
1157
  * @immutable
1181
1158
  */
1182
- id?: string | null;
1159
+ _id?: string | null;
1183
1160
  }
1184
1161
  /** @oneof */
1185
- export interface AppliedDiscountDiscountSourceOneOf {
1162
+ interface AppliedDiscountDiscountSourceOneOf {
1186
1163
  /** Applied coupon info. */
1187
1164
  coupon?: Coupon;
1188
1165
  /** Merchant discount. */
@@ -1190,15 +1167,15 @@ export interface AppliedDiscountDiscountSourceOneOf {
1190
1167
  /** Automatic Discount */
1191
1168
  discountRule?: DiscountRule;
1192
1169
  }
1193
- export declare enum DiscountType {
1170
+ declare enum DiscountType {
1194
1171
  GLOBAL = "GLOBAL",
1195
1172
  SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
1196
1173
  SHIPPING = "SHIPPING"
1197
1174
  }
1198
1175
  /** Coupon */
1199
- export interface Coupon {
1176
+ interface Coupon {
1200
1177
  /** Coupon ID. */
1201
- id?: string;
1178
+ _id?: string;
1202
1179
  /** Coupon code. */
1203
1180
  code?: string;
1204
1181
  /** Coupon name. */
@@ -1206,7 +1183,7 @@ export interface Coupon {
1206
1183
  /** Coupon value. */
1207
1184
  amount?: Price;
1208
1185
  }
1209
- export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
1186
+ interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
1210
1187
  /**
1211
1188
  * Pre-defined discount reason (optional).
1212
1189
  * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
@@ -1221,7 +1198,7 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
1221
1198
  amount?: Price;
1222
1199
  }
1223
1200
  /** @oneof */
1224
- export interface MerchantDiscountMerchantDiscountReasonOneOf {
1201
+ interface MerchantDiscountMerchantDiscountReasonOneOf {
1225
1202
  /**
1226
1203
  * Pre-defined discount reason (optional).
1227
1204
  * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
@@ -1233,23 +1210,23 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
1233
1210
  */
1234
1211
  description?: string | null;
1235
1212
  }
1236
- export declare enum DiscountReason {
1213
+ declare enum DiscountReason {
1237
1214
  UNSPECIFIED = "UNSPECIFIED",
1238
1215
  EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
1239
1216
  BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
1240
1217
  }
1241
- export interface DiscountRule {
1218
+ interface DiscountRule {
1242
1219
  /**
1243
1220
  * Discount rule ID
1244
1221
  * @format GUID
1245
1222
  */
1246
- id?: string;
1223
+ _id?: string;
1247
1224
  /** Discount rule name */
1248
1225
  name?: DiscountRuleName;
1249
1226
  /** Discount value. */
1250
1227
  amount?: Price;
1251
1228
  }
1252
- export interface DiscountRuleName {
1229
+ interface DiscountRuleName {
1253
1230
  /**
1254
1231
  * Original discount rule name (in site's default language).
1255
1232
  * @minLength 1
@@ -1263,16 +1240,16 @@ export interface DiscountRuleName {
1263
1240
  */
1264
1241
  translated?: string | null;
1265
1242
  }
1266
- export interface LineItemDiscount {
1243
+ interface LineItemDiscount {
1267
1244
  /**
1268
1245
  * ID of line item the discount applies to.
1269
1246
  * @format GUID
1270
1247
  */
1271
- id?: string;
1248
+ _id?: string;
1272
1249
  /** Total discount for this line item. */
1273
1250
  totalDiscount?: Price;
1274
1251
  }
1275
- export interface ChannelInfo {
1252
+ interface ChannelInfo {
1276
1253
  /** Sales channel that submitted the order. */
1277
1254
  type?: ChannelType;
1278
1255
  /**
@@ -1286,7 +1263,7 @@ export interface ChannelInfo {
1286
1263
  */
1287
1264
  externalOrderUrl?: string | null;
1288
1265
  }
1289
- export declare enum ChannelType {
1266
+ declare enum ChannelType {
1290
1267
  /** Unspecified sales channel. This value is not supported. */
1291
1268
  UNSPECIFIED = "UNSPECIFIED",
1292
1269
  /** A web client. */
@@ -1320,7 +1297,7 @@ export declare enum ChannelType {
1320
1297
  /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
1321
1298
  FAIRE_COM = "FAIRE_COM"
1322
1299
  }
1323
- export interface CustomField {
1300
+ interface CustomField {
1324
1301
  /** Custom field value. */
1325
1302
  value?: any;
1326
1303
  /**
@@ -1336,7 +1313,7 @@ export interface CustomField {
1336
1313
  */
1337
1314
  translatedTitle?: string | null;
1338
1315
  }
1339
- export interface V1SubscriptionTitle {
1316
+ interface V1SubscriptionTitle {
1340
1317
  /**
1341
1318
  * 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).
1342
1319
  * @minLength 1
@@ -1352,7 +1329,7 @@ export interface V1SubscriptionTitle {
1352
1329
  */
1353
1330
  translated?: string | null;
1354
1331
  }
1355
- export interface AdditionalFee {
1332
+ interface AdditionalFee {
1356
1333
  /**
1357
1334
  * Additional fee's unique code for future processing.
1358
1335
  * @minLength 1
@@ -1383,7 +1360,7 @@ export interface AdditionalFee {
1383
1360
  * @format GUID
1384
1361
  * @immutable
1385
1362
  */
1386
- id?: string;
1363
+ _id?: string;
1387
1364
  /**
1388
1365
  * Optional - Line items associated with this additional fee.
1389
1366
  * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
@@ -1391,13 +1368,13 @@ export interface AdditionalFee {
1391
1368
  */
1392
1369
  lineItemIds?: string[];
1393
1370
  }
1394
- export interface Location {
1371
+ interface Location {
1395
1372
  /**
1396
1373
  * Location ID.
1397
1374
  * Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
1398
1375
  * @format GUID
1399
1376
  */
1400
- id?: string;
1377
+ _id?: string;
1401
1378
  /**
1402
1379
  * Location name.
1403
1380
  * @minLength 1
@@ -1406,38 +1383,38 @@ export interface Location {
1406
1383
  */
1407
1384
  name?: string;
1408
1385
  }
1409
- export interface CreateSubscriptionContractRequest {
1386
+ interface CreateSubscriptionContractRequest {
1410
1387
  /** SubscriptionContract to be created. */
1411
1388
  subscriptionContract?: SubscriptionContract;
1412
1389
  }
1413
- export interface CreateSubscriptionContractResponse {
1390
+ interface CreateSubscriptionContractResponse {
1414
1391
  /** The created SubscriptionContract. */
1415
1392
  subscriptionContract?: SubscriptionContract;
1416
1393
  }
1417
- export interface GetSubscriptionContractRequest {
1394
+ interface GetSubscriptionContractRequest {
1418
1395
  /**
1419
1396
  * ID of the SubscriptionContract to retrieve.
1420
1397
  * @format GUID
1421
1398
  */
1422
1399
  subscriptionContractId: string;
1423
1400
  }
1424
- export interface GetSubscriptionContractResponse {
1401
+ interface GetSubscriptionContractResponse {
1425
1402
  /** The requested SubscriptionContract. */
1426
1403
  subscriptionContract?: SubscriptionContract;
1427
1404
  }
1428
- export interface UpdateSubscriptionContractRequest {
1405
+ interface UpdateSubscriptionContractRequest {
1429
1406
  /** SubscriptionContract to be updated, may be partial. */
1430
1407
  subscriptionContract?: SubscriptionContract;
1431
1408
  }
1432
- export interface UpdateSubscriptionContractResponse {
1409
+ interface UpdateSubscriptionContractResponse {
1433
1410
  /** Updated SubscriptionContract. */
1434
1411
  subscriptionContract?: SubscriptionContract;
1435
1412
  }
1436
- export interface QuerySubscriptionContractsRequest {
1413
+ interface QuerySubscriptionContractsRequest {
1437
1414
  /** WQL expression. */
1438
1415
  query?: CursorQuery;
1439
1416
  }
1440
- export interface CursorQuery extends CursorQueryPagingMethodOneOf {
1417
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
1441
1418
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
1442
1419
  cursorPaging?: CursorPaging;
1443
1420
  /**
@@ -1459,11 +1436,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
1459
1436
  sort?: Sorting[];
1460
1437
  }
1461
1438
  /** @oneof */
1462
- export interface CursorQueryPagingMethodOneOf {
1439
+ interface CursorQueryPagingMethodOneOf {
1463
1440
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
1464
1441
  cursorPaging?: CursorPaging;
1465
1442
  }
1466
- export interface Sorting {
1443
+ interface Sorting {
1467
1444
  /**
1468
1445
  * Name of the field to sort by.
1469
1446
  * @maxLength 512
@@ -1472,11 +1449,11 @@ export interface Sorting {
1472
1449
  /** Sort order. */
1473
1450
  order?: SortOrder;
1474
1451
  }
1475
- export declare enum SortOrder {
1452
+ declare enum SortOrder {
1476
1453
  ASC = "ASC",
1477
1454
  DESC = "DESC"
1478
1455
  }
1479
- export interface CursorPaging {
1456
+ interface CursorPaging {
1480
1457
  /**
1481
1458
  * Maximum number of items to return in the results.
1482
1459
  * @max 100
@@ -1491,13 +1468,13 @@ export interface CursorPaging {
1491
1468
  */
1492
1469
  cursor?: string | null;
1493
1470
  }
1494
- export interface QuerySubscriptionContractsResponse {
1471
+ interface QuerySubscriptionContractsResponse {
1495
1472
  /** List of SubscriptionContracts. */
1496
1473
  subscriptionContracts?: SubscriptionContract[];
1497
1474
  /** Paging metadata */
1498
1475
  pagingMetadata?: CursorPagingMetadata;
1499
1476
  }
1500
- export interface CursorPagingMetadata {
1477
+ interface CursorPagingMetadata {
1501
1478
  /** Number of items returned in the response. */
1502
1479
  count?: number | null;
1503
1480
  /** Cursor strings that point to the next page, previous page, or both. */
@@ -1510,7 +1487,7 @@ export interface CursorPagingMetadata {
1510
1487
  */
1511
1488
  hasNext?: boolean | null;
1512
1489
  }
1513
- export interface Cursors {
1490
+ interface Cursors {
1514
1491
  /**
1515
1492
  * Cursor string pointing to the next page in the list of results.
1516
1493
  * @maxLength 16000
@@ -1522,7 +1499,7 @@ export interface Cursors {
1522
1499
  */
1523
1500
  prev?: string | null;
1524
1501
  }
1525
- export interface DomainEvent extends DomainEventBodyOneOf {
1502
+ interface DomainEvent extends DomainEventBodyOneOf {
1526
1503
  createdEvent?: EntityCreatedEvent;
1527
1504
  updatedEvent?: EntityUpdatedEvent;
1528
1505
  deletedEvent?: EntityDeletedEvent;
@@ -1531,7 +1508,7 @@ export interface DomainEvent extends DomainEventBodyOneOf {
1531
1508
  * Unique event ID.
1532
1509
  * Allows clients to ignore duplicate webhooks.
1533
1510
  */
1534
- id?: string;
1511
+ _id?: string;
1535
1512
  /**
1536
1513
  * Assumes actions are also always typed to an entity_type
1537
1514
  * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
@@ -1565,38 +1542,36 @@ export interface DomainEvent extends DomainEventBodyOneOf {
1565
1542
  entityEventSequence?: string | null;
1566
1543
  }
1567
1544
  /** @oneof */
1568
- export interface DomainEventBodyOneOf {
1545
+ interface DomainEventBodyOneOf {
1569
1546
  createdEvent?: EntityCreatedEvent;
1570
1547
  updatedEvent?: EntityUpdatedEvent;
1571
1548
  deletedEvent?: EntityDeletedEvent;
1572
1549
  actionEvent?: ActionEvent;
1573
1550
  }
1574
- export interface EntityCreatedEvent {
1575
- entityAsJson?: string;
1576
- /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
1577
- restoreInfo?: RestoreInfo;
1551
+ interface EntityCreatedEvent {
1552
+ entity?: string;
1578
1553
  }
1579
- export interface RestoreInfo {
1554
+ interface RestoreInfo {
1580
1555
  deletedDate?: Date | null;
1581
1556
  }
1582
- export interface EntityUpdatedEvent {
1557
+ interface EntityUpdatedEvent {
1583
1558
  /**
1584
1559
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1585
1560
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1586
1561
  * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1587
1562
  */
1588
- currentEntityAsJson?: string;
1563
+ currentEntity?: string;
1589
1564
  }
1590
- export interface EntityDeletedEvent {
1565
+ interface EntityDeletedEvent {
1591
1566
  /** Entity that was deleted */
1592
- deletedEntityAsJson?: string | null;
1567
+ deletedEntity?: string | null;
1593
1568
  }
1594
- export interface ActionEvent {
1595
- bodyAsJson?: string;
1569
+ interface ActionEvent {
1570
+ body?: string;
1596
1571
  }
1597
- export interface Empty {
1572
+ interface Empty {
1598
1573
  }
1599
- export interface MessageEnvelope {
1574
+ interface MessageEnvelope {
1600
1575
  /**
1601
1576
  * App instance ID.
1602
1577
  * @format GUID
@@ -1612,7 +1587,7 @@ export interface MessageEnvelope {
1612
1587
  /** Stringify payload. */
1613
1588
  data?: string;
1614
1589
  }
1615
- export interface IdentificationData extends IdentificationDataIdOneOf {
1590
+ interface IdentificationData extends IdentificationDataIdOneOf {
1616
1591
  /**
1617
1592
  * ID of a site visitor that has not logged in to the site.
1618
1593
  * @format GUID
@@ -1637,7 +1612,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
1637
1612
  identityType?: WebhookIdentityType;
1638
1613
  }
1639
1614
  /** @oneof */
1640
- export interface IdentificationDataIdOneOf {
1615
+ interface IdentificationDataIdOneOf {
1641
1616
  /**
1642
1617
  * ID of a site visitor that has not logged in to the site.
1643
1618
  * @format GUID
@@ -1659,254 +1634,132 @@ export interface IdentificationDataIdOneOf {
1659
1634
  */
1660
1635
  appId?: string;
1661
1636
  }
1662
- export declare enum WebhookIdentityType {
1637
+ declare enum WebhookIdentityType {
1663
1638
  UNKNOWN = "UNKNOWN",
1664
1639
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1665
1640
  MEMBER = "MEMBER",
1666
1641
  WIX_USER = "WIX_USER",
1667
1642
  APP = "APP"
1668
1643
  }
1669
- interface V1SubscriptionSettingsNonNullableFields {
1670
- frequency: SubscriptionFrequency;
1671
- autoRenewal: boolean;
1672
- enableCustomerCancellation: boolean;
1673
- }
1674
- interface ProductNameNonNullableFields {
1675
- original: string;
1676
- }
1677
- interface CatalogReferenceNonNullableFields {
1678
- catalogItemId: string;
1679
- appId: string;
1680
- }
1681
- interface PriceNonNullableFields {
1682
- amount: string;
1683
- formattedAmount: string;
1684
- }
1685
- interface PlainTextValueNonNullableFields {
1686
- original: string;
1687
- }
1688
- interface ColorNonNullableFields {
1689
- original: string;
1690
- }
1691
- interface DescriptionLineNameNonNullableFields {
1692
- original: string;
1693
- }
1694
- interface DescriptionLineNonNullableFields {
1695
- plainText?: PlainTextValueNonNullableFields;
1696
- colorInfo?: ColorNonNullableFields;
1697
- plainTextValue?: PlainTextValueNonNullableFields;
1698
- color: string;
1699
- name?: DescriptionLineNameNonNullableFields;
1700
- lineType: DescriptionLineType;
1701
- }
1702
- interface FocalPointNonNullableFields {
1703
- x: number;
1704
- y: number;
1705
- }
1706
- interface ImageNonNullableFields {
1707
- id: string;
1708
- url: string;
1709
- height: number;
1710
- width: number;
1711
- focalPoint?: FocalPointNonNullableFields;
1712
- }
1713
- interface PhysicalPropertiesNonNullableFields {
1714
- shippable: boolean;
1715
- }
1716
- interface ItemTypeNonNullableFields {
1717
- preset: ItemTypeItemType;
1718
- custom: string;
1719
- }
1720
- interface ItemTaxFullDetailsNonNullableFields {
1721
- taxableAmount?: PriceNonNullableFields;
1722
- taxRate: string;
1723
- totalTax?: PriceNonNullableFields;
1724
- }
1725
- interface LineItemTaxBreakdownNonNullableFields {
1726
- taxAmount?: PriceNonNullableFields;
1727
- jurisdictionType: JurisdictionType;
1728
- nonTaxableAmount?: PriceNonNullableFields;
1729
- taxableAmount?: PriceNonNullableFields;
1730
- }
1731
- interface LineItemTaxInfoNonNullableFields {
1732
- taxAmount?: PriceNonNullableFields;
1733
- taxableAmount?: PriceNonNullableFields;
1734
- taxIncludedInPrice: boolean;
1735
- taxBreakdown: LineItemTaxBreakdownNonNullableFields[];
1736
- }
1737
- interface DigitalFileNonNullableFields {
1738
- fileId: string;
1739
- }
1740
- interface SubscriptionSettingsNonNullableFields {
1741
- frequency: V2SubscriptionFrequency;
1742
- autoRenewal: boolean;
1743
- }
1744
- interface SubscriptionInfoNonNullableFields {
1745
- cycleNumber: number;
1746
- subscriptionOptionTitle: string;
1747
- subscriptionSettings?: SubscriptionSettingsNonNullableFields;
1748
- }
1749
- interface PriceDescriptionNonNullableFields {
1750
- original: string;
1751
- }
1752
- interface LocationAndQuantityNonNullableFields {
1753
- id: string;
1754
- quantity: number;
1755
- }
1756
- interface OrderLineItemNonNullableFields {
1757
- id: string;
1758
- productName?: ProductNameNonNullableFields;
1759
- catalogReference?: CatalogReferenceNonNullableFields;
1760
- quantity: number;
1761
- totalDiscount?: PriceNonNullableFields;
1762
- descriptionLines: DescriptionLineNonNullableFields[];
1763
- image?: ImageNonNullableFields;
1764
- physicalProperties?: PhysicalPropertiesNonNullableFields;
1765
- itemType?: ItemTypeNonNullableFields;
1766
- price?: PriceNonNullableFields;
1767
- priceBeforeDiscounts?: PriceNonNullableFields;
1768
- totalPriceBeforeTax?: PriceNonNullableFields;
1769
- totalPriceAfterTax?: PriceNonNullableFields;
1770
- paymentOption: PaymentOptionType;
1771
- taxDetails?: ItemTaxFullDetailsNonNullableFields;
1772
- taxInfo?: LineItemTaxInfoNonNullableFields;
1773
- digitalFile?: DigitalFileNonNullableFields;
1774
- subscriptionInfo?: SubscriptionInfoNonNullableFields;
1775
- priceDescription?: PriceDescriptionNonNullableFields;
1776
- depositAmount?: PriceNonNullableFields;
1777
- locations: LocationAndQuantityNonNullableFields[];
1778
- lineItemPrice?: PriceNonNullableFields;
1779
- }
1780
- interface BuyerInfoNonNullableFields {
1781
- visitorId: string;
1782
- memberId: string;
1783
- }
1784
- interface PriceSummaryNonNullableFields {
1785
- subtotal?: PriceNonNullableFields;
1786
- shipping?: PriceNonNullableFields;
1787
- tax?: PriceNonNullableFields;
1788
- discount?: PriceNonNullableFields;
1789
- totalPrice?: PriceNonNullableFields;
1790
- total?: PriceNonNullableFields;
1791
- totalWithGiftCard?: PriceNonNullableFields;
1792
- totalWithoutGiftCard?: PriceNonNullableFields;
1793
- totalAdditionalFees?: PriceNonNullableFields;
1794
- }
1795
- interface StreetAddressNonNullableFields {
1796
- number: string;
1797
- name: string;
1798
- apt: string;
1799
- }
1800
- interface AddressNonNullableFields {
1801
- streetAddress?: StreetAddressNonNullableFields;
1802
- }
1803
- interface VatIdNonNullableFields {
1804
- id: string;
1805
- type: VatType;
1806
- }
1807
- interface FullAddressContactDetailsNonNullableFields {
1808
- vatId?: VatIdNonNullableFields;
1809
- }
1810
- interface AddressWithContactNonNullableFields {
1811
- address?: AddressNonNullableFields;
1812
- contactDetails?: FullAddressContactDetailsNonNullableFields;
1813
- }
1814
- interface PickupAddressNonNullableFields {
1815
- streetAddress?: StreetAddressNonNullableFields;
1816
- }
1817
- interface PickupDetailsNonNullableFields {
1818
- address?: PickupAddressNonNullableFields;
1819
- pickupMethod: PickupMethod;
1820
- }
1821
- interface DeliveryLogisticsNonNullableFields {
1822
- shippingDestination?: AddressWithContactNonNullableFields;
1823
- pickupDetails?: PickupDetailsNonNullableFields;
1824
- }
1825
- interface ShippingPriceNonNullableFields {
1826
- price?: PriceNonNullableFields;
1827
- totalPriceBeforeTax?: PriceNonNullableFields;
1828
- totalPriceAfterTax?: PriceNonNullableFields;
1829
- taxDetails?: ItemTaxFullDetailsNonNullableFields;
1830
- discount?: PriceNonNullableFields;
1831
- }
1832
- interface ShippingInformationNonNullableFields {
1833
- title: string;
1834
- logistics?: DeliveryLogisticsNonNullableFields;
1835
- cost?: ShippingPriceNonNullableFields;
1836
- }
1837
- interface OrderTaxBreakdownNonNullableFields {
1838
- taxName: string;
1839
- taxType: string;
1840
- jurisdiction: string;
1841
- jurisdictionType: JurisdictionType;
1842
- rate: string;
1843
- aggregatedTaxAmount?: PriceNonNullableFields;
1844
- aggregatedTaxableAmount?: PriceNonNullableFields;
1845
- }
1846
- interface OrderTaxInfoNonNullableFields {
1847
- totalTax?: PriceNonNullableFields;
1848
- taxBreakdown: OrderTaxBreakdownNonNullableFields[];
1849
- }
1850
- interface CouponNonNullableFields {
1851
- id: string;
1852
- code: string;
1853
- name: string;
1854
- amount?: PriceNonNullableFields;
1855
- }
1856
- interface MerchantDiscountNonNullableFields {
1857
- discountReason: DiscountReason;
1858
- amount?: PriceNonNullableFields;
1859
- }
1860
- interface DiscountRuleNameNonNullableFields {
1861
- original: string;
1862
- }
1863
- interface DiscountRuleNonNullableFields {
1864
- id: string;
1865
- name?: DiscountRuleNameNonNullableFields;
1866
- amount?: PriceNonNullableFields;
1867
- }
1868
- interface AppliedDiscountNonNullableFields {
1869
- coupon?: CouponNonNullableFields;
1870
- merchantDiscount?: MerchantDiscountNonNullableFields;
1871
- discountRule?: DiscountRuleNonNullableFields;
1872
- discountType: DiscountType;
1873
- lineItemIds: string[];
1874
- }
1875
- interface ChannelInfoNonNullableFields {
1876
- type: ChannelType;
1877
- }
1878
- interface CustomFieldNonNullableFields {
1879
- title: string;
1880
- }
1881
- interface AdditionalFeeNonNullableFields {
1882
- name: string;
1883
- price?: PriceNonNullableFields;
1884
- taxDetails?: ItemTaxFullDetailsNonNullableFields;
1885
- priceBeforeTax?: PriceNonNullableFields;
1886
- priceAfterTax?: PriceNonNullableFields;
1887
- id: string;
1888
- lineItemIds: string[];
1889
- }
1890
- interface SubscriptionContractNonNullableFields {
1891
- subscriptionSettings?: V1SubscriptionSettingsNonNullableFields;
1892
- lineItems: OrderLineItemNonNullableFields[];
1893
- buyerInfo?: BuyerInfoNonNullableFields;
1894
- weightUnit: WeightUnit;
1895
- taxIncludedInPrices: boolean;
1896
- priceSummary?: PriceSummaryNonNullableFields;
1897
- billingInfo?: AddressWithContactNonNullableFields;
1898
- shippingInfo?: ShippingInformationNonNullableFields;
1899
- taxInfo?: OrderTaxInfoNonNullableFields;
1900
- appliedDiscounts: AppliedDiscountNonNullableFields[];
1901
- channelInfo?: ChannelInfoNonNullableFields;
1902
- customFields: CustomFieldNonNullableFields[];
1903
- recipientInfo?: AddressWithContactNonNullableFields;
1904
- additionalFees: AdditionalFeeNonNullableFields[];
1905
- }
1906
- export interface GetSubscriptionContractResponseNonNullableFields {
1907
- subscriptionContract?: SubscriptionContractNonNullableFields;
1908
- }
1909
- export interface QuerySubscriptionContractsResponseNonNullableFields {
1910
- subscriptionContracts: SubscriptionContractNonNullableFields[];
1911
- }
1912
- export {};
1644
+ interface BaseEventMetadata {
1645
+ /**
1646
+ * App instance ID.
1647
+ * @format GUID
1648
+ */
1649
+ instanceId?: string | null;
1650
+ /**
1651
+ * Event type.
1652
+ * @maxLength 150
1653
+ */
1654
+ eventType?: string;
1655
+ /** The identification type and identity data. */
1656
+ identity?: IdentificationData;
1657
+ }
1658
+ interface EventMetadata extends BaseEventMetadata {
1659
+ /**
1660
+ * Unique event ID.
1661
+ * Allows clients to ignore duplicate webhooks.
1662
+ */
1663
+ _id?: string;
1664
+ /**
1665
+ * Assumes actions are also always typed to an entity_type
1666
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1667
+ */
1668
+ entityFqdn?: string;
1669
+ /**
1670
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1671
+ * This is although the created/updated/deleted notion is duplication of the oneof types
1672
+ * Example: created/updated/deleted/started/completed/email_opened
1673
+ */
1674
+ slug?: string;
1675
+ /** ID of the entity associated with the event. */
1676
+ entityId?: string;
1677
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1678
+ eventTime?: Date | null;
1679
+ /**
1680
+ * Whether the event was triggered as a result of a privacy regulation application
1681
+ * (for example, GDPR).
1682
+ */
1683
+ triggeredByAnonymizeRequest?: boolean | null;
1684
+ /** If present, indicates the action that triggered the event. */
1685
+ originatedFrom?: string | null;
1686
+ /**
1687
+ * A sequence number defining the order of updates to the underlying entity.
1688
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
1689
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1690
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1691
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
1692
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1693
+ */
1694
+ entityEventSequence?: string | null;
1695
+ }
1696
+ interface SubscriptionContractCreatedEnvelope {
1697
+ entity: SubscriptionContract;
1698
+ metadata: EventMetadata;
1699
+ }
1700
+ interface SubscriptionContractDeletedEnvelope {
1701
+ metadata: EventMetadata;
1702
+ }
1703
+ interface SubscriptionContractUpdatedEnvelope {
1704
+ entity: SubscriptionContract;
1705
+ metadata: EventMetadata;
1706
+ }
1707
+ interface QueryCursorResult {
1708
+ cursors: Cursors;
1709
+ hasNext: () => boolean;
1710
+ hasPrev: () => boolean;
1711
+ length: number;
1712
+ pageSize: number;
1713
+ }
1714
+ interface SubscriptionContractsQueryResult extends QueryCursorResult {
1715
+ items: SubscriptionContract[];
1716
+ query: SubscriptionContractsQueryBuilder;
1717
+ next: () => Promise<SubscriptionContractsQueryResult>;
1718
+ prev: () => Promise<SubscriptionContractsQueryResult>;
1719
+ }
1720
+ interface SubscriptionContractsQueryBuilder {
1721
+ /** @param propertyName - Property whose value is compared with `value`.
1722
+ * @param value - Value to compare against.
1723
+ * @documentationMaturity preview
1724
+ */
1725
+ eq: (propertyName: '_id' | 'buyerInfo.contactId', value: any) => SubscriptionContractsQueryBuilder;
1726
+ /** @param propertyName - Property whose value is compared with `value`.
1727
+ * @param value - Value to compare against.
1728
+ * @documentationMaturity preview
1729
+ */
1730
+ ne: (propertyName: '_id' | 'buyerInfo.contactId', value: any) => SubscriptionContractsQueryBuilder;
1731
+ /** @param propertyName - Property whose value is compared with `string`.
1732
+ * @param string - String to compare against. Case-insensitive.
1733
+ * @documentationMaturity preview
1734
+ */
1735
+ startsWith: (propertyName: '_id' | 'buyerInfo.contactId', value: string) => SubscriptionContractsQueryBuilder;
1736
+ /** @param propertyName - Property whose value is compared with `values`.
1737
+ * @param values - List of values to compare against.
1738
+ * @documentationMaturity preview
1739
+ */
1740
+ hasSome: (propertyName: '_id' | 'buyerInfo.contactId', value: any[]) => SubscriptionContractsQueryBuilder;
1741
+ /** @documentationMaturity preview */
1742
+ in: (propertyName: '_id' | 'buyerInfo.contactId', value: any) => SubscriptionContractsQueryBuilder;
1743
+ /** @documentationMaturity preview */
1744
+ exists: (propertyName: '_id' | 'buyerInfo.contactId', value: boolean) => SubscriptionContractsQueryBuilder;
1745
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
1746
+ * @documentationMaturity preview
1747
+ */
1748
+ ascending: (...propertyNames: Array<'_id' | 'buyerInfo.contactId'>) => SubscriptionContractsQueryBuilder;
1749
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
1750
+ * @documentationMaturity preview
1751
+ */
1752
+ descending: (...propertyNames: Array<'_id' | 'buyerInfo.contactId'>) => SubscriptionContractsQueryBuilder;
1753
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
1754
+ * @documentationMaturity preview
1755
+ */
1756
+ limit: (limit: number) => SubscriptionContractsQueryBuilder;
1757
+ /** @param cursor - A pointer to specific record
1758
+ * @documentationMaturity preview
1759
+ */
1760
+ skipTo: (cursor: string) => SubscriptionContractsQueryBuilder;
1761
+ /** @documentationMaturity preview */
1762
+ find: () => Promise<SubscriptionContractsQueryResult>;
1763
+ }
1764
+
1765
+ export { type CurrencyConversionDetails as $, AdjustmentType as A, type SubscriptionInfo as B, ChannelType as C, DescriptionLineType as D, type SubscriptionTitle as E, type FocalPoint as F, type SubscriptionDescription as G, type SubscriptionSettings as H, ItemTypeItemType as I, JurisdictionType as J, type FreeTrialPeriod as K, type LineItemTaxInfo as L, type BillingAdjustment as M, type BillingAdjustmentPriceSummary as N, type OrderLineItem as O, PaymentOptionType as P, type PriceDescription as Q, type LocationAndQuantity as R, type SubscriptionContract as S, TaxableAddressType as T, type TaxableAddress as U, V2SubscriptionFrequency as V, WeightUnit as W, type TaxableAddressTaxableAddressDataOneOf as X, type ExtendedFields as Y, type BuyerInfo as Z, type BuyerInfoIdOneOf as _, type SubscriptionContractsQueryBuilder as a, type PriceSummary as a0, type AddressWithContact as a1, type Address as a2, type StreetAddress as a3, type AddressLocation as a4, type FullAddressContactDetails as a5, type VatId as a6, type ShippingInformation as a7, type DeliveryLogistics as a8, type DeliveryLogisticsAddressOneOf as a9, type QuerySubscriptionContractsRequest as aA, type CursorQuery as aB, type CursorQueryPagingMethodOneOf as aC, type Sorting as aD, type CursorPaging as aE, type QuerySubscriptionContractsResponse as aF, type CursorPagingMetadata as aG, type Cursors as aH, type DomainEvent as aI, type DomainEventBodyOneOf as aJ, type EntityCreatedEvent as aK, type RestoreInfo as aL, type EntityUpdatedEvent as aM, type EntityDeletedEvent as aN, type ActionEvent as aO, type Empty as aP, type MessageEnvelope as aQ, type IdentificationData as aR, type IdentificationDataIdOneOf as aS, type BaseEventMetadata as aT, type EventMetadata as aU, type SubscriptionContractCreatedEnvelope as aV, type SubscriptionContractDeletedEnvelope as aW, type SubscriptionContractUpdatedEnvelope as aX, type SubscriptionContractsQueryResult as aY, type PickupDetails as aa, type PickupAddress as ab, type DeliveryTimeSlot as ac, type ShippingPrice as ad, type ShippingRegion as ae, type OrderTaxInfo as af, type OrderTaxBreakdown as ag, type AppliedDiscount as ah, type AppliedDiscountDiscountSourceOneOf as ai, type Coupon as aj, type MerchantDiscount as ak, type MerchantDiscountMerchantDiscountReasonOneOf as al, type DiscountRule as am, type DiscountRuleName as an, type LineItemDiscount as ao, type ChannelInfo as ap, type CustomField as aq, type V1SubscriptionTitle as ar, type AdditionalFee as as, type Location as at, type CreateSubscriptionContractRequest as au, type CreateSubscriptionContractResponse as av, type GetSubscriptionContractRequest as aw, type GetSubscriptionContractResponse as ax, type UpdateSubscriptionContractRequest as ay, type UpdateSubscriptionContractResponse as az, SubscriptionFrequency as b, VatType as c, PickupMethod as d, DiscountType as e, DiscountReason as f, SortOrder as g, WebhookIdentityType as h, type V1SubscriptionDescription as i, type V1SubscriptionSettings as j, type V1FreeTrialPeriod as k, type ProductName as l, type CatalogReference as m, type Price as n, type DescriptionLine as o, type DescriptionLineValueOneOf as p, type DescriptionLineDescriptionLineValueOneOf as q, type DescriptionLineName as r, type PlainTextValue as s, type Color as t, type PhysicalProperties as u, type ItemType as v, type ItemTypeItemTypeDataOneOf as w, type ItemTaxFullDetails as x, type LineItemTaxBreakdown as y, type DigitalFile as z };