@wix/auto_sdk_ecom_subscription-contracts 1.0.18 → 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 (130) hide show
  1. package/build/{cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts → ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal-C1mp-xS2.d.mts} +117 -217
  2. package/build/{es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts → ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal-C1mp-xS2.d.ts} +117 -217
  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/internal/{cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts → ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal-WYe0iZSk.d.mts} +117 -217
  10. package/build/internal/{es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts → ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal-WYe0iZSk.d.ts} +117 -217
  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/{cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts → internal/meta.d.mts} +93 -441
  18. package/build/{es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts → internal/meta.d.ts} +93 -441
  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/{internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts → meta.d.mts} +93 -441
  24. package/build/{internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts → meta.d.ts} +93 -441
  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.js +0 -342
  105. package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js.map +0 -1
  106. package/build/internal/es/index.d.ts +0 -1
  107. package/build/internal/es/index.js +0 -2
  108. package/build/internal/es/index.js.map +0 -1
  109. package/build/internal/es/index.typings.d.ts +0 -1
  110. package/build/internal/es/index.typings.js +0 -2
  111. package/build/internal/es/index.typings.js.map +0 -1
  112. package/build/internal/es/meta.d.ts +0 -1
  113. package/build/internal/es/meta.js +0 -2
  114. package/build/internal/es/meta.js.map +0 -1
  115. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.d.ts +0 -16
  116. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js +0 -16
  117. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js.map +0 -1
  118. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.d.ts +0 -14
  119. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js +0 -193
  120. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js.map +0 -1
  121. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.d.ts +0 -16
  122. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js +0 -38
  123. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js.map +0 -1
  124. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.d.ts +0 -32
  125. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js +0 -132
  126. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js.map +0 -1
  127. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js +0 -158
  128. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js.map +0 -1
  129. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js +0 -314
  130. package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js.map +0 -1
@@ -1,11 +1,10 @@
1
- import { NonNullablePaths } from '@wix/sdk-types';
2
1
  /**
3
2
  * A SubscriptionContract is a ...
4
3
  * You can ...
5
4
  * Read more about SubscriptionContracts
6
5
  * in this [article](<LINK_TO_KB_ARTICLE>).
7
6
  */
8
- export interface SubscriptionContract {
7
+ interface SubscriptionContract {
9
8
  /**
10
9
  * SubscriptionContract ID.
11
10
  * @format GUID
@@ -117,7 +116,7 @@ export interface SubscriptionContract {
117
116
  */
118
117
  additionalFees?: AdditionalFee[];
119
118
  }
120
- export interface V1SubscriptionDescription {
119
+ interface V1SubscriptionDescription {
121
120
  /**
122
121
  * Subscription option description.
123
122
  * @maxLength 500
@@ -129,7 +128,7 @@ export interface V1SubscriptionDescription {
129
128
  */
130
129
  translated?: string | null;
131
130
  }
132
- export interface V1SubscriptionSettings {
131
+ interface V1SubscriptionSettings {
133
132
  /** Frequency of recurring payment. */
134
133
  frequency?: SubscriptionFrequency;
135
134
  /**
@@ -148,14 +147,14 @@ export interface V1SubscriptionSettings {
148
147
  /** Whether to allow the customer to cancel the subscription. */
149
148
  enableCustomerCancellation?: boolean;
150
149
  }
151
- export declare enum SubscriptionFrequency {
150
+ declare enum SubscriptionFrequency {
152
151
  UNDEFINED = "UNDEFINED",
153
152
  DAY = "DAY",
154
153
  WEEK = "WEEK",
155
154
  MONTH = "MONTH",
156
155
  YEAR = "YEAR"
157
156
  }
158
- export interface V1FreeTrialPeriod {
157
+ interface V1FreeTrialPeriod {
159
158
  /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
160
159
  frequency?: SubscriptionFrequency;
161
160
  /**
@@ -165,7 +164,7 @@ export interface V1FreeTrialPeriod {
165
164
  */
166
165
  interval?: number;
167
166
  }
168
- export interface OrderLineItem {
167
+ interface OrderLineItem {
169
168
  /**
170
169
  * Line item ID.
171
170
  * @immutable
@@ -282,7 +281,7 @@ export interface OrderLineItem {
282
281
  */
283
282
  extendedFields?: ExtendedFields;
284
283
  }
285
- export interface ProductName {
284
+ interface ProductName {
286
285
  /**
287
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).
288
287
  *
@@ -304,7 +303,7 @@ export interface ProductName {
304
303
  translated?: string | null;
305
304
  }
306
305
  /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
307
- export interface CatalogReference {
306
+ interface CatalogReference {
308
307
  /**
309
308
  * ID of the item within the catalog it belongs to.
310
309
  * @minLength 1
@@ -330,7 +329,7 @@ export interface CatalogReference {
330
329
  */
331
330
  options?: Record<string, any> | null;
332
331
  }
333
- export interface Price {
332
+ interface Price {
334
333
  /**
335
334
  * Amount.
336
335
  * @decimalValue options { gte:0, lte:1000000000000000 }
@@ -342,7 +341,7 @@ export interface Price {
342
341
  */
343
342
  formattedAmount?: string;
344
343
  }
345
- export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
344
+ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
346
345
  /** Description line plain text value. */
347
346
  plainText?: PlainTextValue;
348
347
  /** Description line color value. */
@@ -351,16 +350,16 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
351
350
  name?: DescriptionLineName;
352
351
  }
353
352
  /** @oneof */
354
- export interface DescriptionLineValueOneOf {
353
+ interface DescriptionLineValueOneOf {
355
354
  /** Description line plain text value. */
356
355
  plainText?: PlainTextValue;
357
356
  /** Description line color value. */
358
357
  colorInfo?: Color;
359
358
  }
360
359
  /** @oneof */
361
- export interface DescriptionLineDescriptionLineValueOneOf {
360
+ interface DescriptionLineDescriptionLineValueOneOf {
362
361
  }
363
- export interface DescriptionLineName {
362
+ interface DescriptionLineName {
364
363
  /**
365
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).
366
365
  * @maxLength 100
@@ -374,7 +373,7 @@ export interface DescriptionLineName {
374
373
  */
375
374
  translated?: string | null;
376
375
  }
377
- export interface PlainTextValue {
376
+ interface PlainTextValue {
378
377
  /**
379
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).
380
379
  * @maxLength 600
@@ -388,7 +387,7 @@ export interface PlainTextValue {
388
387
  */
389
388
  translated?: string | null;
390
389
  }
391
- export interface Color {
390
+ interface Color {
392
391
  /**
393
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).
394
393
  * @maxLength 500
@@ -404,7 +403,7 @@ export interface Color {
404
403
  /** HEX or RGB color code for display. */
405
404
  code?: string | null;
406
405
  }
407
- export declare enum DescriptionLineType {
406
+ declare enum DescriptionLineType {
408
407
  /** Unrecognized type. */
409
408
  UNRECOGNISED = "UNRECOGNISED",
410
409
  /** Plain text type. */
@@ -412,7 +411,7 @@ export declare enum DescriptionLineType {
412
411
  /** Color type. */
413
412
  COLOR = "COLOR"
414
413
  }
415
- export interface FocalPoint {
414
+ interface FocalPoint {
416
415
  /** X-coordinate of the focal point. */
417
416
  x?: number;
418
417
  /** Y-coordinate of the focal point. */
@@ -422,7 +421,7 @@ export interface FocalPoint {
422
421
  /** crop by width */
423
422
  width?: number | null;
424
423
  }
425
- export interface PhysicalProperties {
424
+ interface PhysicalProperties {
426
425
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
427
426
  weight?: number | null;
428
427
  /**
@@ -433,20 +432,20 @@ export interface PhysicalProperties {
433
432
  /** Whether this line item is shippable. */
434
433
  shippable?: boolean;
435
434
  }
436
- export interface ItemType extends ItemTypeItemTypeDataOneOf {
435
+ interface ItemType extends ItemTypeItemTypeDataOneOf {
437
436
  /** Preset item type. */
438
437
  preset?: ItemTypeItemType;
439
438
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
440
439
  custom?: string;
441
440
  }
442
441
  /** @oneof */
443
- export interface ItemTypeItemTypeDataOneOf {
442
+ interface ItemTypeItemTypeDataOneOf {
444
443
  /** Preset item type. */
445
444
  preset?: ItemTypeItemType;
446
445
  /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
447
446
  custom?: string;
448
447
  }
449
- export declare enum ItemTypeItemType {
448
+ declare enum ItemTypeItemType {
450
449
  UNRECOGNISED = "UNRECOGNISED",
451
450
  PHYSICAL = "PHYSICAL",
452
451
  DIGITAL = "DIGITAL",
@@ -454,7 +453,7 @@ export declare enum ItemTypeItemType {
454
453
  SERVICE = "SERVICE"
455
454
  }
456
455
  /** Type of selected payment option for catalog item */
457
- export declare enum PaymentOptionType {
456
+ declare enum PaymentOptionType {
458
457
  /** The entire payment for this item happens as part of the checkout. */
459
458
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
460
459
  /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
@@ -466,7 +465,7 @@ export declare enum PaymentOptionType {
466
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`. */
467
466
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
468
467
  }
469
- export interface ItemTaxFullDetails {
468
+ interface ItemTaxFullDetails {
470
469
  /** Taxable amount of this line item. */
471
470
  taxableAmount?: Price;
472
471
  /**
@@ -477,7 +476,7 @@ export interface ItemTaxFullDetails {
477
476
  /** The calculated tax, based on the `taxableAmount` and `taxRate`. */
478
477
  totalTax?: Price;
479
478
  }
480
- export interface LineItemTaxInfo {
479
+ interface LineItemTaxInfo {
481
480
  /** Calculated tax, based on `taxable_amount` and `tax_rate`. */
482
481
  taxAmount?: Price;
483
482
  /** Amount for which tax is calculated. */
@@ -505,7 +504,7 @@ export interface LineItemTaxInfo {
505
504
  * TaxBreakdown represents tax information for a line item.
506
505
  * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
507
506
  */
508
- export interface LineItemTaxBreakdown {
507
+ interface LineItemTaxBreakdown {
509
508
  /**
510
509
  * Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
511
510
  * @maxLength 200
@@ -538,7 +537,7 @@ export interface LineItemTaxBreakdown {
538
537
  taxableAmount?: Price;
539
538
  }
540
539
  /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
541
- export declare enum JurisdictionType {
540
+ declare enum JurisdictionType {
542
541
  UNDEFINED = "UNDEFINED",
543
542
  COUNTRY = "COUNTRY",
544
543
  STATE = "STATE",
@@ -546,7 +545,7 @@ export declare enum JurisdictionType {
546
545
  CITY = "CITY",
547
546
  SPECIAL = "SPECIAL"
548
547
  }
549
- export interface DigitalFile {
548
+ interface DigitalFile {
550
549
  /**
551
550
  * ID of the secure file in media.
552
551
  * @minLength 1
@@ -566,7 +565,7 @@ export interface DigitalFile {
566
565
  */
567
566
  expirationDate?: Date | null;
568
567
  }
569
- export interface SubscriptionInfo {
568
+ interface SubscriptionInfo {
570
569
  /**
571
570
  * Subscription ID.
572
571
  * @format GUID
@@ -599,7 +598,7 @@ export interface SubscriptionInfo {
599
598
  */
600
599
  subscriptionSettings?: SubscriptionSettings;
601
600
  }
602
- export interface SubscriptionTitle {
601
+ interface SubscriptionTitle {
603
602
  /**
604
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).
605
604
  * @minLength 1
@@ -615,7 +614,7 @@ export interface SubscriptionTitle {
615
614
  */
616
615
  translated?: string | null;
617
616
  }
618
- export interface SubscriptionDescription {
617
+ interface SubscriptionDescription {
619
618
  /**
620
619
  * Subscription option description.
621
620
  * @maxLength 500
@@ -627,7 +626,7 @@ export interface SubscriptionDescription {
627
626
  */
628
627
  translated?: string | null;
629
628
  }
630
- export interface SubscriptionSettings {
629
+ interface SubscriptionSettings {
631
630
  /** Frequency of recurring payment. */
632
631
  frequency?: V2SubscriptionFrequency;
633
632
  /**
@@ -645,14 +644,14 @@ export interface SubscriptionSettings {
645
644
  billingCycles?: number | null;
646
645
  }
647
646
  /** Frequency unit of recurring payment */
648
- export declare enum V2SubscriptionFrequency {
647
+ declare enum V2SubscriptionFrequency {
649
648
  UNDEFINED = "UNDEFINED",
650
649
  DAY = "DAY",
651
650
  WEEK = "WEEK",
652
651
  MONTH = "MONTH",
653
652
  YEAR = "YEAR"
654
653
  }
655
- export interface FreeTrialPeriod {
654
+ interface FreeTrialPeriod {
656
655
  /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
657
656
  frequency?: V2SubscriptionFrequency;
658
657
  /**
@@ -662,20 +661,20 @@ export interface FreeTrialPeriod {
662
661
  */
663
662
  interval?: number;
664
663
  }
665
- export interface BillingAdjustment {
664
+ interface BillingAdjustment {
666
665
  /** The type of adjustment. */
667
666
  type?: AdjustmentType;
668
667
  /** Summary of the prorated adjustment amount. */
669
668
  priceSummary?: BillingAdjustmentPriceSummary;
670
669
  }
671
- export declare enum AdjustmentType {
670
+ declare enum AdjustmentType {
672
671
  UNKNOWN_ADJUSTMENT_TYPE = "UNKNOWN_ADJUSTMENT_TYPE",
673
672
  /** Adjustment increases the total amount due to changes like covering extra billing days. Typically results in an additional fee. */
674
673
  EXTRA_CHARGE = "EXTRA_CHARGE",
675
674
  /** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
676
675
  CREDIT = "CREDIT"
677
676
  }
678
- export interface BillingAdjustmentPriceSummary {
677
+ interface BillingAdjustmentPriceSummary {
679
678
  /** Subtotal of adjustment, before tax. */
680
679
  subtotal?: Price;
681
680
  /** Tax on adjustment. */
@@ -683,7 +682,7 @@ export interface BillingAdjustmentPriceSummary {
683
682
  /** Total price after tax. */
684
683
  total?: Price;
685
684
  }
686
- export interface PriceDescription {
685
+ interface PriceDescription {
687
686
  /**
688
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).
689
688
  * @minLength 1
@@ -699,7 +698,7 @@ export interface PriceDescription {
699
698
  */
700
699
  translated?: string | null;
701
700
  }
702
- export interface LocationAndQuantity {
701
+ interface LocationAndQuantity {
703
702
  /**
704
703
  * Location id in the associated owner app.
705
704
  * @format GUID
@@ -725,22 +724,22 @@ export interface LocationAndQuantity {
725
724
  */
726
725
  name?: string | null;
727
726
  }
728
- export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
727
+ interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
729
728
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
730
729
  addressType?: TaxableAddressType;
731
730
  }
732
731
  /** @oneof */
733
- export interface TaxableAddressTaxableAddressDataOneOf {
732
+ interface TaxableAddressTaxableAddressDataOneOf {
734
733
  /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
735
734
  addressType?: TaxableAddressType;
736
735
  }
737
- export declare enum TaxableAddressType {
736
+ declare enum TaxableAddressType {
738
737
  UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
739
738
  BUSINESS = "BUSINESS",
740
739
  BILLING = "BILLING",
741
740
  SHIPPING = "SHIPPING"
742
741
  }
743
- export interface ExtendedFields {
742
+ interface ExtendedFields {
744
743
  /**
745
744
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
746
745
  * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -752,7 +751,7 @@ export interface ExtendedFields {
752
751
  namespaces?: Record<string, Record<string, any>>;
753
752
  }
754
753
  /** Buyer Info */
755
- export interface BuyerInfo extends BuyerInfoIdOneOf {
754
+ interface BuyerInfo extends BuyerInfoIdOneOf {
756
755
  /**
757
756
  * Visitor ID (if site visitor is not a member).
758
757
  * @format GUID
@@ -775,7 +774,7 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
775
774
  email?: string | null;
776
775
  }
777
776
  /** @oneof */
778
- export interface BuyerInfoIdOneOf {
777
+ interface BuyerInfoIdOneOf {
779
778
  /**
780
779
  * Visitor ID (if site visitor is not a member).
781
780
  * @format GUID
@@ -787,7 +786,7 @@ export interface BuyerInfoIdOneOf {
787
786
  */
788
787
  memberId?: string;
789
788
  }
790
- export declare enum WeightUnit {
789
+ declare enum WeightUnit {
791
790
  /** Weight unit can't be classified due to an error. */
792
791
  UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
793
792
  /** Kilograms. */
@@ -795,7 +794,7 @@ export declare enum WeightUnit {
795
794
  /** Pounds. */
796
795
  LB = "LB"
797
796
  }
798
- export interface CurrencyConversionDetails {
797
+ interface CurrencyConversionDetails {
799
798
  /**
800
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.
801
800
  * @readonly
@@ -811,7 +810,7 @@ export interface CurrencyConversionDetails {
811
810
  */
812
811
  conversionRate?: string | null;
813
812
  }
814
- export interface PriceSummary {
813
+ interface PriceSummary {
815
814
  /** Subtotal of all the line items, before discounts and before tax. */
816
815
  subtotal?: Price;
817
816
  /** Total shipping price, before discounts and before tax. */
@@ -826,14 +825,14 @@ export interface PriceSummary {
826
825
  totalAdditionalFees?: Price;
827
826
  }
828
827
  /** Billing Info and shipping details */
829
- export interface AddressWithContact {
828
+ interface AddressWithContact {
830
829
  /** Address. */
831
830
  address?: Address;
832
831
  /** Contact details. */
833
832
  contactDetails?: FullAddressContactDetails;
834
833
  }
835
834
  /** Physical address */
836
- export interface Address {
835
+ interface Address {
837
836
  /**
838
837
  * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
839
838
  * @format COUNTRY
@@ -877,20 +876,20 @@ export interface Address {
877
876
  */
878
877
  subdivisionFullname?: string | null;
879
878
  }
880
- export interface StreetAddress {
879
+ interface StreetAddress {
881
880
  /** Street number. */
882
881
  number?: string;
883
882
  /** Street name. */
884
883
  name?: string;
885
884
  }
886
- export interface AddressLocation {
885
+ interface AddressLocation {
887
886
  /** Address latitude. */
888
887
  latitude?: number | null;
889
888
  /** Address longitude. */
890
889
  longitude?: number | null;
891
890
  }
892
891
  /** Full contact details for an address */
893
- export interface FullAddressContactDetails {
892
+ interface FullAddressContactDetails {
894
893
  /**
895
894
  * First name.
896
895
  * @maxLength 100
@@ -914,7 +913,7 @@ export interface FullAddressContactDetails {
914
913
  /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
915
914
  vatId?: VatId;
916
915
  }
917
- export interface VatId {
916
+ interface VatId {
918
917
  /** Customer's tax ID. */
919
918
  _id?: string;
920
919
  /**
@@ -927,14 +926,14 @@ export interface VatId {
927
926
  type?: VatType;
928
927
  }
929
928
  /** tax info types */
930
- export declare enum VatType {
929
+ declare enum VatType {
931
930
  UNSPECIFIED = "UNSPECIFIED",
932
931
  /** CPF - for individual tax payers. */
933
932
  CPF = "CPF",
934
933
  /** CNPJ - for corporations */
935
934
  CNPJ = "CNPJ"
936
935
  }
937
- export interface ShippingInformation {
936
+ interface ShippingInformation {
938
937
  /**
939
938
  * App Def Id of external provider which was a source of shipping info
940
939
  * @minLength 1
@@ -960,7 +959,7 @@ export interface ShippingInformation {
960
959
  /** Shipping region. */
961
960
  region?: ShippingRegion;
962
961
  }
963
- export interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
962
+ interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
964
963
  /** Shipping address and contact details. */
965
964
  shippingDestination?: AddressWithContact;
966
965
  /** Pickup details. */
@@ -984,20 +983,20 @@ export interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
984
983
  deliveryTimeSlot?: DeliveryTimeSlot;
985
984
  }
986
985
  /** @oneof */
987
- export interface DeliveryLogisticsAddressOneOf {
986
+ interface DeliveryLogisticsAddressOneOf {
988
987
  /** Shipping address and contact details. */
989
988
  shippingDestination?: AddressWithContact;
990
989
  /** Pickup details. */
991
990
  pickupDetails?: PickupDetails;
992
991
  }
993
- export interface PickupDetails {
992
+ interface PickupDetails {
994
993
  /** Pickup address. */
995
994
  address?: PickupAddress;
996
995
  /** Pickup method */
997
996
  pickupMethod?: PickupMethod;
998
997
  }
999
998
  /** Physical address */
1000
- export interface PickupAddress {
999
+ interface PickupAddress {
1001
1000
  /**
1002
1001
  * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
1003
1002
  * @format COUNTRY
@@ -1041,18 +1040,18 @@ export interface PickupAddress {
1041
1040
  */
1042
1041
  subdivisionFullname?: string | null;
1043
1042
  }
1044
- export declare enum PickupMethod {
1043
+ declare enum PickupMethod {
1045
1044
  UNKNOWN_METHOD = "UNKNOWN_METHOD",
1046
1045
  STORE_PICKUP = "STORE_PICKUP",
1047
1046
  PICKUP_POINT = "PICKUP_POINT"
1048
1047
  }
1049
- export interface DeliveryTimeSlot {
1048
+ interface DeliveryTimeSlot {
1050
1049
  /** Delivery slot starting time. */
1051
1050
  from?: Date | null;
1052
1051
  /** Delivery slot ending time. */
1053
1052
  to?: Date | null;
1054
1053
  }
1055
- export interface ShippingPrice {
1054
+ interface ShippingPrice {
1056
1055
  /** Shipping price for display purposes. */
1057
1056
  price?: Price;
1058
1057
  /**
@@ -1073,14 +1072,14 @@ export interface ShippingPrice {
1073
1072
  */
1074
1073
  discount?: Price;
1075
1074
  }
1076
- export interface ShippingRegion {
1075
+ interface ShippingRegion {
1077
1076
  /**
1078
1077
  * Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
1079
1078
  * @maxLength 100
1080
1079
  */
1081
1080
  name?: string | null;
1082
1081
  }
1083
- export interface OrderTaxInfo {
1082
+ interface OrderTaxInfo {
1084
1083
  /** Calculated tax, added from line items. */
1085
1084
  totalTax?: Price;
1086
1085
  /**
@@ -1100,7 +1099,7 @@ export interface OrderTaxInfo {
1100
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.
1101
1100
  * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
1102
1101
  */
1103
- export interface OrderTaxBreakdown {
1102
+ interface OrderTaxBreakdown {
1104
1103
  /**
1105
1104
  * The name of the tax against which this tax amount was calculated.
1106
1105
  * @maxLength 200
@@ -1127,7 +1126,7 @@ export interface OrderTaxBreakdown {
1127
1126
  /** The sum of all the tax from line items that calculated by the tax identifiers. */
1128
1127
  aggregatedTaxAmount?: Price;
1129
1128
  }
1130
- export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1129
+ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1131
1130
  /** Applied coupon info. */
1132
1131
  coupon?: Coupon;
1133
1132
  /** Merchant discount. */
@@ -1160,7 +1159,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1160
1159
  _id?: string | null;
1161
1160
  }
1162
1161
  /** @oneof */
1163
- export interface AppliedDiscountDiscountSourceOneOf {
1162
+ interface AppliedDiscountDiscountSourceOneOf {
1164
1163
  /** Applied coupon info. */
1165
1164
  coupon?: Coupon;
1166
1165
  /** Merchant discount. */
@@ -1168,13 +1167,13 @@ export interface AppliedDiscountDiscountSourceOneOf {
1168
1167
  /** Automatic Discount */
1169
1168
  discountRule?: DiscountRule;
1170
1169
  }
1171
- export declare enum DiscountType {
1170
+ declare enum DiscountType {
1172
1171
  GLOBAL = "GLOBAL",
1173
1172
  SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
1174
1173
  SHIPPING = "SHIPPING"
1175
1174
  }
1176
1175
  /** Coupon */
1177
- export interface Coupon {
1176
+ interface Coupon {
1178
1177
  /** Coupon ID. */
1179
1178
  _id?: string;
1180
1179
  /** Coupon code. */
@@ -1184,7 +1183,7 @@ export interface Coupon {
1184
1183
  /** Coupon value. */
1185
1184
  amount?: Price;
1186
1185
  }
1187
- export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
1186
+ interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
1188
1187
  /**
1189
1188
  * Pre-defined discount reason (optional).
1190
1189
  * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
@@ -1199,7 +1198,7 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
1199
1198
  amount?: Price;
1200
1199
  }
1201
1200
  /** @oneof */
1202
- export interface MerchantDiscountMerchantDiscountReasonOneOf {
1201
+ interface MerchantDiscountMerchantDiscountReasonOneOf {
1203
1202
  /**
1204
1203
  * Pre-defined discount reason (optional).
1205
1204
  * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
@@ -1211,12 +1210,12 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
1211
1210
  */
1212
1211
  description?: string | null;
1213
1212
  }
1214
- export declare enum DiscountReason {
1213
+ declare enum DiscountReason {
1215
1214
  UNSPECIFIED = "UNSPECIFIED",
1216
1215
  EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
1217
1216
  BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
1218
1217
  }
1219
- export interface DiscountRule {
1218
+ interface DiscountRule {
1220
1219
  /**
1221
1220
  * Discount rule ID
1222
1221
  * @format GUID
@@ -1227,7 +1226,7 @@ export interface DiscountRule {
1227
1226
  /** Discount value. */
1228
1227
  amount?: Price;
1229
1228
  }
1230
- export interface DiscountRuleName {
1229
+ interface DiscountRuleName {
1231
1230
  /**
1232
1231
  * Original discount rule name (in site's default language).
1233
1232
  * @minLength 1
@@ -1241,7 +1240,7 @@ export interface DiscountRuleName {
1241
1240
  */
1242
1241
  translated?: string | null;
1243
1242
  }
1244
- export interface LineItemDiscount {
1243
+ interface LineItemDiscount {
1245
1244
  /**
1246
1245
  * ID of line item the discount applies to.
1247
1246
  * @format GUID
@@ -1250,7 +1249,7 @@ export interface LineItemDiscount {
1250
1249
  /** Total discount for this line item. */
1251
1250
  totalDiscount?: Price;
1252
1251
  }
1253
- export interface ChannelInfo {
1252
+ interface ChannelInfo {
1254
1253
  /** Sales channel that submitted the order. */
1255
1254
  type?: ChannelType;
1256
1255
  /**
@@ -1264,7 +1263,7 @@ export interface ChannelInfo {
1264
1263
  */
1265
1264
  externalOrderUrl?: string | null;
1266
1265
  }
1267
- export declare enum ChannelType {
1266
+ declare enum ChannelType {
1268
1267
  /** Unspecified sales channel. This value is not supported. */
1269
1268
  UNSPECIFIED = "UNSPECIFIED",
1270
1269
  /** A web client. */
@@ -1298,7 +1297,7 @@ export declare enum ChannelType {
1298
1297
  /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
1299
1298
  FAIRE_COM = "FAIRE_COM"
1300
1299
  }
1301
- export interface CustomField {
1300
+ interface CustomField {
1302
1301
  /** Custom field value. */
1303
1302
  value?: any;
1304
1303
  /**
@@ -1314,7 +1313,7 @@ export interface CustomField {
1314
1313
  */
1315
1314
  translatedTitle?: string | null;
1316
1315
  }
1317
- export interface V1SubscriptionTitle {
1316
+ interface V1SubscriptionTitle {
1318
1317
  /**
1319
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).
1320
1319
  * @minLength 1
@@ -1330,7 +1329,7 @@ export interface V1SubscriptionTitle {
1330
1329
  */
1331
1330
  translated?: string | null;
1332
1331
  }
1333
- export interface AdditionalFee {
1332
+ interface AdditionalFee {
1334
1333
  /**
1335
1334
  * Additional fee's unique code for future processing.
1336
1335
  * @minLength 1
@@ -1369,7 +1368,7 @@ export interface AdditionalFee {
1369
1368
  */
1370
1369
  lineItemIds?: string[];
1371
1370
  }
1372
- export interface Location {
1371
+ interface Location {
1373
1372
  /**
1374
1373
  * Location ID.
1375
1374
  * Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
@@ -1384,38 +1383,38 @@ export interface Location {
1384
1383
  */
1385
1384
  name?: string;
1386
1385
  }
1387
- export interface CreateSubscriptionContractRequest {
1386
+ interface CreateSubscriptionContractRequest {
1388
1387
  /** SubscriptionContract to be created. */
1389
1388
  subscriptionContract?: SubscriptionContract;
1390
1389
  }
1391
- export interface CreateSubscriptionContractResponse {
1390
+ interface CreateSubscriptionContractResponse {
1392
1391
  /** The created SubscriptionContract. */
1393
1392
  subscriptionContract?: SubscriptionContract;
1394
1393
  }
1395
- export interface GetSubscriptionContractRequest {
1394
+ interface GetSubscriptionContractRequest {
1396
1395
  /**
1397
1396
  * ID of the SubscriptionContract to retrieve.
1398
1397
  * @format GUID
1399
1398
  */
1400
1399
  subscriptionContractId: string;
1401
1400
  }
1402
- export interface GetSubscriptionContractResponse {
1401
+ interface GetSubscriptionContractResponse {
1403
1402
  /** The requested SubscriptionContract. */
1404
1403
  subscriptionContract?: SubscriptionContract;
1405
1404
  }
1406
- export interface UpdateSubscriptionContractRequest {
1405
+ interface UpdateSubscriptionContractRequest {
1407
1406
  /** SubscriptionContract to be updated, may be partial. */
1408
1407
  subscriptionContract?: SubscriptionContract;
1409
1408
  }
1410
- export interface UpdateSubscriptionContractResponse {
1409
+ interface UpdateSubscriptionContractResponse {
1411
1410
  /** Updated SubscriptionContract. */
1412
1411
  subscriptionContract?: SubscriptionContract;
1413
1412
  }
1414
- export interface QuerySubscriptionContractsRequest {
1413
+ interface QuerySubscriptionContractsRequest {
1415
1414
  /** WQL expression. */
1416
1415
  query?: CursorQuery;
1417
1416
  }
1418
- export interface CursorQuery extends CursorQueryPagingMethodOneOf {
1417
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
1419
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`. */
1420
1419
  cursorPaging?: CursorPaging;
1421
1420
  /**
@@ -1437,11 +1436,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
1437
1436
  sort?: Sorting[];
1438
1437
  }
1439
1438
  /** @oneof */
1440
- export interface CursorQueryPagingMethodOneOf {
1439
+ interface CursorQueryPagingMethodOneOf {
1441
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`. */
1442
1441
  cursorPaging?: CursorPaging;
1443
1442
  }
1444
- export interface Sorting {
1443
+ interface Sorting {
1445
1444
  /**
1446
1445
  * Name of the field to sort by.
1447
1446
  * @maxLength 512
@@ -1450,11 +1449,11 @@ export interface Sorting {
1450
1449
  /** Sort order. */
1451
1450
  order?: SortOrder;
1452
1451
  }
1453
- export declare enum SortOrder {
1452
+ declare enum SortOrder {
1454
1453
  ASC = "ASC",
1455
1454
  DESC = "DESC"
1456
1455
  }
1457
- export interface CursorPaging {
1456
+ interface CursorPaging {
1458
1457
  /**
1459
1458
  * Maximum number of items to return in the results.
1460
1459
  * @max 100
@@ -1469,13 +1468,13 @@ export interface CursorPaging {
1469
1468
  */
1470
1469
  cursor?: string | null;
1471
1470
  }
1472
- export interface QuerySubscriptionContractsResponse {
1471
+ interface QuerySubscriptionContractsResponse {
1473
1472
  /** List of SubscriptionContracts. */
1474
1473
  subscriptionContracts?: SubscriptionContract[];
1475
1474
  /** Paging metadata */
1476
1475
  pagingMetadata?: CursorPagingMetadata;
1477
1476
  }
1478
- export interface CursorPagingMetadata {
1477
+ interface CursorPagingMetadata {
1479
1478
  /** Number of items returned in the response. */
1480
1479
  count?: number | null;
1481
1480
  /** Cursor strings that point to the next page, previous page, or both. */
@@ -1488,7 +1487,7 @@ export interface CursorPagingMetadata {
1488
1487
  */
1489
1488
  hasNext?: boolean | null;
1490
1489
  }
1491
- export interface Cursors {
1490
+ interface Cursors {
1492
1491
  /**
1493
1492
  * Cursor string pointing to the next page in the list of results.
1494
1493
  * @maxLength 16000
@@ -1500,7 +1499,7 @@ export interface Cursors {
1500
1499
  */
1501
1500
  prev?: string | null;
1502
1501
  }
1503
- export interface DomainEvent extends DomainEventBodyOneOf {
1502
+ interface DomainEvent extends DomainEventBodyOneOf {
1504
1503
  createdEvent?: EntityCreatedEvent;
1505
1504
  updatedEvent?: EntityUpdatedEvent;
1506
1505
  deletedEvent?: EntityDeletedEvent;
@@ -1543,19 +1542,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
1543
1542
  entityEventSequence?: string | null;
1544
1543
  }
1545
1544
  /** @oneof */
1546
- export interface DomainEventBodyOneOf {
1545
+ interface DomainEventBodyOneOf {
1547
1546
  createdEvent?: EntityCreatedEvent;
1548
1547
  updatedEvent?: EntityUpdatedEvent;
1549
1548
  deletedEvent?: EntityDeletedEvent;
1550
1549
  actionEvent?: ActionEvent;
1551
1550
  }
1552
- export interface EntityCreatedEvent {
1551
+ interface EntityCreatedEvent {
1553
1552
  entity?: string;
1554
1553
  }
1555
- export interface RestoreInfo {
1554
+ interface RestoreInfo {
1556
1555
  deletedDate?: Date | null;
1557
1556
  }
1558
- export interface EntityUpdatedEvent {
1557
+ interface EntityUpdatedEvent {
1559
1558
  /**
1560
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.
1561
1560
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -1563,16 +1562,16 @@ export interface EntityUpdatedEvent {
1563
1562
  */
1564
1563
  currentEntity?: string;
1565
1564
  }
1566
- export interface EntityDeletedEvent {
1565
+ interface EntityDeletedEvent {
1567
1566
  /** Entity that was deleted */
1568
1567
  deletedEntity?: string | null;
1569
1568
  }
1570
- export interface ActionEvent {
1569
+ interface ActionEvent {
1571
1570
  body?: string;
1572
1571
  }
1573
- export interface Empty {
1572
+ interface Empty {
1574
1573
  }
1575
- export interface MessageEnvelope {
1574
+ interface MessageEnvelope {
1576
1575
  /**
1577
1576
  * App instance ID.
1578
1577
  * @format GUID
@@ -1588,7 +1587,7 @@ export interface MessageEnvelope {
1588
1587
  /** Stringify payload. */
1589
1588
  data?: string;
1590
1589
  }
1591
- export interface IdentificationData extends IdentificationDataIdOneOf {
1590
+ interface IdentificationData extends IdentificationDataIdOneOf {
1592
1591
  /**
1593
1592
  * ID of a site visitor that has not logged in to the site.
1594
1593
  * @format GUID
@@ -1613,7 +1612,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
1613
1612
  identityType?: WebhookIdentityType;
1614
1613
  }
1615
1614
  /** @oneof */
1616
- export interface IdentificationDataIdOneOf {
1615
+ interface IdentificationDataIdOneOf {
1617
1616
  /**
1618
1617
  * ID of a site visitor that has not logged in to the site.
1619
1618
  * @format GUID
@@ -1635,14 +1634,14 @@ export interface IdentificationDataIdOneOf {
1635
1634
  */
1636
1635
  appId?: string;
1637
1636
  }
1638
- export declare enum WebhookIdentityType {
1637
+ declare enum WebhookIdentityType {
1639
1638
  UNKNOWN = "UNKNOWN",
1640
1639
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1641
1640
  MEMBER = "MEMBER",
1642
1641
  WIX_USER = "WIX_USER",
1643
1642
  APP = "APP"
1644
1643
  }
1645
- export interface BaseEventMetadata {
1644
+ interface BaseEventMetadata {
1646
1645
  /**
1647
1646
  * App instance ID.
1648
1647
  * @format GUID
@@ -1656,7 +1655,7 @@ export interface BaseEventMetadata {
1656
1655
  /** The identification type and identity data. */
1657
1656
  identity?: IdentificationData;
1658
1657
  }
1659
- export interface EventMetadata extends BaseEventMetadata {
1658
+ interface EventMetadata extends BaseEventMetadata {
1660
1659
  /**
1661
1660
  * Unique event ID.
1662
1661
  * Allows clients to ignore duplicate webhooks.
@@ -1694,117 +1693,17 @@ export interface EventMetadata extends BaseEventMetadata {
1694
1693
  */
1695
1694
  entityEventSequence?: string | null;
1696
1695
  }
1697
- export interface SubscriptionContractCreatedEnvelope {
1696
+ interface SubscriptionContractCreatedEnvelope {
1698
1697
  entity: SubscriptionContract;
1699
1698
  metadata: EventMetadata;
1700
1699
  }
1701
- /** @permissionScope Manage Stores - all permissions
1702
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1703
- * @permissionScope Read eCommerce - all read permissions
1704
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
1705
- * @permissionScope Manage Restaurants - all permissions
1706
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1707
- * @permissionScope Manage eCommerce - all permissions
1708
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1709
- * @permissionScope Picasso private app mega scope
1710
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1711
- * @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
1712
- * @webhook
1713
- * @eventType wix.ecom.subscription_contracts.v1.subscription_contract_created
1714
- * @slug created
1715
- * @documentationMaturity preview
1716
- */
1717
- export declare function onSubscriptionContractCreated(handler: (event: SubscriptionContractCreatedEnvelope) => void | Promise<void>): void;
1718
- export interface SubscriptionContractDeletedEnvelope {
1700
+ interface SubscriptionContractDeletedEnvelope {
1719
1701
  metadata: EventMetadata;
1720
1702
  }
1721
- /** @permissionScope Manage Stores - all permissions
1722
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1723
- * @permissionScope Read eCommerce - all read permissions
1724
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
1725
- * @permissionScope Manage Restaurants - all permissions
1726
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1727
- * @permissionScope Manage eCommerce - all permissions
1728
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1729
- * @permissionScope Picasso private app mega scope
1730
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1731
- * @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
1732
- * @webhook
1733
- * @eventType wix.ecom.subscription_contracts.v1.subscription_contract_deleted
1734
- * @slug deleted
1735
- * @documentationMaturity preview
1736
- */
1737
- export declare function onSubscriptionContractDeleted(handler: (event: SubscriptionContractDeletedEnvelope) => void | Promise<void>): void;
1738
- export interface SubscriptionContractUpdatedEnvelope {
1703
+ interface SubscriptionContractUpdatedEnvelope {
1739
1704
  entity: SubscriptionContract;
1740
1705
  metadata: EventMetadata;
1741
1706
  }
1742
- /** @permissionScope Manage Stores - all permissions
1743
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1744
- * @permissionScope Read eCommerce - all read permissions
1745
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
1746
- * @permissionScope Manage Restaurants - all permissions
1747
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1748
- * @permissionScope Manage eCommerce - all permissions
1749
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1750
- * @permissionScope Picasso private app mega scope
1751
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1752
- * @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
1753
- * @webhook
1754
- * @eventType wix.ecom.subscription_contracts.v1.subscription_contract_updated
1755
- * @slug updated
1756
- * @documentationMaturity preview
1757
- */
1758
- export declare function onSubscriptionContractUpdated(handler: (event: SubscriptionContractUpdatedEnvelope) => void | Promise<void>): void;
1759
- type SubscriptionContractNonNullablePaths = `subscriptionSettings.frequency` | `subscriptionSettings.autoRenewal` | `subscriptionSettings.enableCustomerCancellation` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.descriptionLines` | `lineItems.${number}.descriptionLines.${number}.plainText.original` | `lineItems.${number}.descriptionLines.${number}.colorInfo.original` | `lineItems.${number}.descriptionLines.${number}.name.original` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.taxInfo.taxBreakdown` | `lineItems.${number}.taxInfo.taxBreakdown.${number}.jurisdictionType` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.locations` | `lineItems.${number}.locations.${number}._id` | `lineItems.${number}.locations.${number}.quantity` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `weightUnit` | `taxIncludedInPrices` | `priceSummary.subtotal.amount` | `priceSummary.subtotal.formattedAmount` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.shippingDestination.address.streetAddress.number` | `shippingInfo.logistics.shippingDestination.address.streetAddress.name` | `shippingInfo.logistics.shippingDestination.contactDetails.vatId._id` | `shippingInfo.logistics.shippingDestination.contactDetails.vatId.type` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `shippingInfo.cost.price.amount` | `shippingInfo.cost.price.formattedAmount` | `shippingInfo.cost.taxDetails.taxRate` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.coupon.amount.amount` | `appliedDiscounts.${number}.coupon.amount.formattedAmount` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `appliedDiscounts.${number}.lineItemIds` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `recipientInfo.address.streetAddress.number` | `recipientInfo.address.streetAddress.name` | `recipientInfo.contactDetails.vatId._id` | `recipientInfo.contactDetails.vatId.type` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}.price.amount` | `additionalFees.${number}.price.formattedAmount` | `additionalFees.${number}.taxDetails.taxRate` | `additionalFees.${number}._id` | `additionalFees.${number}.lineItemIds`;
1760
- /**
1761
- * Retrieves a SubscriptionContract.
1762
- * @param subscriptionContractId - ID of the SubscriptionContract to retrieve.
1763
- * @public
1764
- * @documentationMaturity preview
1765
- * @requiredField subscriptionContractId
1766
- * @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
1767
- * @permissionScope Manage Stores - all permissions
1768
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1769
- * @permissionScope Read eCommerce - all read permissions
1770
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
1771
- * @permissionScope Manage Restaurants - all permissions
1772
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1773
- * @permissionScope Manage eCommerce - all permissions
1774
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1775
- * @permissionScope Picasso private app mega scope
1776
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1777
- * @applicableIdentity APP
1778
- * @returns The requested SubscriptionContract.
1779
- * @fqn wix.ecom.subscription_contracts.v1.SubscriptionContracts.GetSubscriptionContract
1780
- */
1781
- export declare function getSubscriptionContract(subscriptionContractId: string): Promise<NonNullablePaths<SubscriptionContract, SubscriptionContractNonNullablePaths>>;
1782
- /**
1783
- * Retrieves a list of SubscriptionContracts, given the provided [paging, filtering, and sorting][1].
1784
- *
1785
- * Up to 300 SubscriptionContracts can be returned per request.
1786
- *
1787
- * To learn how to query SubscriptionContracts, see [API Query Language][2].
1788
- *
1789
- * [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
1790
- * [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
1791
- * @public
1792
- * @documentationMaturity preview
1793
- * @permissionScope Manage Stores - all permissions
1794
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1795
- * @permissionScope Read eCommerce - all read permissions
1796
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
1797
- * @permissionScope Manage Restaurants - all permissions
1798
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1799
- * @permissionScope Manage eCommerce - all permissions
1800
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1801
- * @permissionScope Picasso private app mega scope
1802
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1803
- * @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
1804
- * @applicableIdentity APP
1805
- * @fqn wix.ecom.subscription_contracts.v1.SubscriptionContracts.QuerySubscriptionContracts
1806
- */
1807
- export declare function querySubscriptionContracts(): SubscriptionContractsQueryBuilder;
1808
1707
  interface QueryCursorResult {
1809
1708
  cursors: Cursors;
1810
1709
  hasNext: () => boolean;
@@ -1812,13 +1711,13 @@ interface QueryCursorResult {
1812
1711
  length: number;
1813
1712
  pageSize: number;
1814
1713
  }
1815
- export interface SubscriptionContractsQueryResult extends QueryCursorResult {
1714
+ interface SubscriptionContractsQueryResult extends QueryCursorResult {
1816
1715
  items: SubscriptionContract[];
1817
1716
  query: SubscriptionContractsQueryBuilder;
1818
1717
  next: () => Promise<SubscriptionContractsQueryResult>;
1819
1718
  prev: () => Promise<SubscriptionContractsQueryResult>;
1820
1719
  }
1821
- export interface SubscriptionContractsQueryBuilder {
1720
+ interface SubscriptionContractsQueryBuilder {
1822
1721
  /** @param propertyName - Property whose value is compared with `value`.
1823
1722
  * @param value - Value to compare against.
1824
1723
  * @documentationMaturity preview
@@ -1862,4 +1761,5 @@ export interface SubscriptionContractsQueryBuilder {
1862
1761
  /** @documentationMaturity preview */
1863
1762
  find: () => Promise<SubscriptionContractsQueryResult>;
1864
1763
  }
1865
- export {};
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 };