@wix/auto_sdk_ecom_checkout 1.0.3 → 1.0.5

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 (69) hide show
  1. package/build/cjs/src/ecom-v1-checkout-checkout.context.d.ts +1 -1
  2. package/build/cjs/src/ecom-v1-checkout-checkout.context.js +4 -1
  3. package/build/cjs/src/ecom-v1-checkout-checkout.context.js.map +1 -1
  4. package/build/cjs/src/ecom-v1-checkout-checkout.http.d.ts +2 -0
  5. package/build/cjs/src/ecom-v1-checkout-checkout.http.js +40 -1
  6. package/build/cjs/src/ecom-v1-checkout-checkout.http.js.map +1 -1
  7. package/build/cjs/src/ecom-v1-checkout-checkout.meta.d.ts +1 -0
  8. package/build/cjs/src/ecom-v1-checkout-checkout.meta.js +20 -1
  9. package/build/cjs/src/ecom-v1-checkout-checkout.meta.js.map +1 -1
  10. package/build/cjs/src/ecom-v1-checkout-checkout.public.d.ts +1 -1
  11. package/build/cjs/src/ecom-v1-checkout-checkout.public.js +14 -2
  12. package/build/cjs/src/ecom-v1-checkout-checkout.public.js.map +1 -1
  13. package/build/cjs/src/ecom-v1-checkout-checkout.types.d.ts +1018 -228
  14. package/build/cjs/src/ecom-v1-checkout-checkout.types.js.map +1 -1
  15. package/build/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +1079 -248
  16. package/build/cjs/src/ecom-v1-checkout-checkout.universal.js +51 -5
  17. package/build/cjs/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
  18. package/build/es/src/ecom-v1-checkout-checkout.context.d.ts +1 -1
  19. package/build/es/src/ecom-v1-checkout-checkout.context.js +3 -1
  20. package/build/es/src/ecom-v1-checkout-checkout.context.js.map +1 -1
  21. package/build/es/src/ecom-v1-checkout-checkout.http.d.ts +2 -0
  22. package/build/es/src/ecom-v1-checkout-checkout.http.js +38 -0
  23. package/build/es/src/ecom-v1-checkout-checkout.http.js.map +1 -1
  24. package/build/es/src/ecom-v1-checkout-checkout.meta.d.ts +1 -0
  25. package/build/es/src/ecom-v1-checkout-checkout.meta.js +18 -0
  26. package/build/es/src/ecom-v1-checkout-checkout.meta.js.map +1 -1
  27. package/build/es/src/ecom-v1-checkout-checkout.public.d.ts +1 -1
  28. package/build/es/src/ecom-v1-checkout-checkout.public.js +12 -1
  29. package/build/es/src/ecom-v1-checkout-checkout.public.js.map +1 -1
  30. package/build/es/src/ecom-v1-checkout-checkout.types.d.ts +1018 -228
  31. package/build/es/src/ecom-v1-checkout-checkout.types.js.map +1 -1
  32. package/build/es/src/ecom-v1-checkout-checkout.universal.d.ts +1079 -248
  33. package/build/es/src/ecom-v1-checkout-checkout.universal.js +49 -4
  34. package/build/es/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
  35. package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.d.ts +4 -2
  36. package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.js +4 -1
  37. package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.js.map +1 -1
  38. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.d.ts +2 -0
  39. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js +40 -1
  40. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js.map +1 -1
  41. package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.d.ts +1 -0
  42. package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.js +20 -1
  43. package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.js.map +1 -1
  44. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.d.ts +11 -2
  45. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js +14 -2
  46. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js.map +1 -1
  47. package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.d.ts +1028 -228
  48. package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.js.map +1 -1
  49. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +1133 -253
  50. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js +51 -5
  51. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
  52. package/build/internal/es/src/ecom-v1-checkout-checkout.context.d.ts +4 -2
  53. package/build/internal/es/src/ecom-v1-checkout-checkout.context.js +3 -1
  54. package/build/internal/es/src/ecom-v1-checkout-checkout.context.js.map +1 -1
  55. package/build/internal/es/src/ecom-v1-checkout-checkout.http.d.ts +2 -0
  56. package/build/internal/es/src/ecom-v1-checkout-checkout.http.js +38 -0
  57. package/build/internal/es/src/ecom-v1-checkout-checkout.http.js.map +1 -1
  58. package/build/internal/es/src/ecom-v1-checkout-checkout.meta.d.ts +1 -0
  59. package/build/internal/es/src/ecom-v1-checkout-checkout.meta.js +18 -0
  60. package/build/internal/es/src/ecom-v1-checkout-checkout.meta.js.map +1 -1
  61. package/build/internal/es/src/ecom-v1-checkout-checkout.public.d.ts +11 -2
  62. package/build/internal/es/src/ecom-v1-checkout-checkout.public.js +12 -1
  63. package/build/internal/es/src/ecom-v1-checkout-checkout.public.js.map +1 -1
  64. package/build/internal/es/src/ecom-v1-checkout-checkout.types.d.ts +1028 -228
  65. package/build/internal/es/src/ecom-v1-checkout-checkout.types.js.map +1 -1
  66. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.d.ts +1133 -253
  67. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js +49 -4
  68. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
  69. package/package.json +2 -2
@@ -1,6 +1,7 @@
1
1
  export interface Checkout {
2
2
  /**
3
3
  * Checkout ID.
4
+ * @format GUID
4
5
  * @readonly
5
6
  */
6
7
  id?: string | null;
@@ -8,6 +9,8 @@ export interface Checkout {
8
9
  * Line items.
9
10
  *
10
11
  * Max: 300 items
12
+ * @minSize 1
13
+ * @maxSize 300
11
14
  * @readonly
12
15
  */
13
16
  lineItems?: LineItem[];
@@ -15,13 +18,17 @@ export interface Checkout {
15
18
  billingInfo?: AddressWithContact;
16
19
  /** Shipping information. */
17
20
  shippingInfo?: ShippingInfo;
18
- /** [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. */
21
+ /**
22
+ * [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
23
+ * @maxLength 1000
24
+ */
19
25
  buyerNote?: string | null;
20
26
  /** Buyer information. */
21
27
  buyerInfo?: BuyerInfo;
22
28
  /**
23
29
  * All converted prices are displayed in this currency in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
24
30
  * @readonly
31
+ * @format CURRENCY
25
32
  */
26
33
  conversionCurrency?: string;
27
34
  /**
@@ -60,6 +67,7 @@ export interface Checkout {
60
67
  taxSummary?: TaxSummary;
61
68
  /**
62
69
  * The currency used when submitting the order.
70
+ * @format CURRENCY
63
71
  * @readonly
64
72
  */
65
73
  currency?: string;
@@ -117,9 +125,15 @@ export interface Checkout {
117
125
  payLater?: PriceSummary;
118
126
  /** Memberships to apply when creating the order. */
119
127
  membershipOptions?: MembershipOptions;
120
- /** Additional Fees. */
128
+ /**
129
+ * Additional Fees.
130
+ * @maxSize 100
131
+ */
121
132
  additionalFees?: AdditionalFee[];
122
- /** Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart. */
133
+ /**
134
+ * Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart.
135
+ * @format GUID
136
+ */
123
137
  cartId?: string | null;
124
138
  /**
125
139
  * List of validation violations raised by the [Validations service plugin](https://dev.wix.com/api/rest/wix-ecommerce/validations-integration-spi/introduction).
@@ -134,6 +148,7 @@ export interface Checkout {
134
148
  extendedFields?: ExtendedFields;
135
149
  /**
136
150
  * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
151
+ * @format GUID
137
152
  * @readonly
138
153
  */
139
154
  purchaseFlowId?: string | null;
@@ -143,6 +158,7 @@ export interface Checkout {
143
158
  * > **Notes:**
144
159
  * > * Custom settings can only be set when [creating a checkout](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/checkout/create-checkout).
145
160
  * > * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
161
+ * @immutable
146
162
  */
147
163
  customSettings?: CustomSettings;
148
164
  /**
@@ -155,12 +171,14 @@ export interface Checkout {
155
171
  /**
156
172
  * The business location ID associated with the checkout.
157
173
  * Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
174
+ * @format GUID
158
175
  */
159
176
  businessLocationId?: string | null;
160
177
  }
161
178
  export interface LineItem {
162
179
  /**
163
180
  * Line item ID.
181
+ * @format GUID
164
182
  * @readonly
165
183
  */
166
184
  id?: string | null;
@@ -169,6 +187,8 @@ export interface LineItem {
169
187
  *
170
188
  * Min: `"1"`
171
189
  * Max: `"100000"`
190
+ * @min 1
191
+ * @max 100000
172
192
  */
173
193
  quantity?: number;
174
194
  /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
@@ -257,12 +277,9 @@ export interface LineItem {
257
277
  */
258
278
  subscriptionOptionInfo?: SubscriptionOptionInfo;
259
279
  /**
260
- * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
261
- * + `FULL_PAYMENT_ONLINE`: The entire payment for this item happens as part of the checkout.
262
- * + `FULL_PAYMENT_OFFLINE`: The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
263
- * + `MEMBERSHIP`: Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is `0`.
264
- * + `DEPOSIT_ONLINE`: Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is defined by `lineItem.deposit`.
265
- * + `MEMBERSHIP_OFFLINE`: Payment for this item can only be performed by using a membership and must be manually redeemed in the dashboard by the site owner. When this option is used, `lineItem.price.amount` is `0`.
280
+ * Type of selected payment option for current item.
281
+ *
282
+ * Default: `FULL_PAYMENT_ONLINE`
266
283
  * @readonly
267
284
  */
268
285
  paymentOption?: PaymentOptionType;
@@ -276,6 +293,8 @@ export interface LineItem {
276
293
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
277
294
  * + In most cases, this field has the same value as `catalogReference.catalogItemId`.
278
295
  * + Used in membership validation.
296
+ * @minLength 1
297
+ * @maxLength 36
279
298
  * @readonly
280
299
  */
281
300
  rootCatalogItemId?: string | null;
@@ -289,6 +308,12 @@ export interface LineItem {
289
308
  * @readonly
290
309
  */
291
310
  depositAmount?: MultiCurrencyPrice;
311
+ /**
312
+ * Delivery profile ID.
313
+ * @format GUID
314
+ * @readonly
315
+ */
316
+ deliveryProfileId?: string | null;
292
317
  /**
293
318
  * Whether the line item is a custom line item. Custom line items don't trigger the Catalog service plugin.
294
319
  * @readonly
@@ -296,6 +321,8 @@ export interface LineItem {
296
321
  customLineItem?: boolean;
297
322
  /**
298
323
  * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
324
+ * @minLength 1
325
+ * @maxLength 2500
299
326
  * @readonly
300
327
  */
301
328
  consentRequiredPaymentPolicy?: string | null;
@@ -316,7 +343,11 @@ export interface LineItem {
316
343
  }
317
344
  /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
318
345
  export interface CatalogReference {
319
- /** ID of the item within the catalog it belongs to. */
346
+ /**
347
+ * ID of the item within the catalog it belongs to.
348
+ * @minLength 1
349
+ * @maxLength 36
350
+ */
320
351
  catalogItemId?: string;
321
352
  /**
322
353
  * ID of the app providing the catalog.
@@ -327,6 +358,7 @@ export interface CatalogReference {
327
358
  * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
328
359
  * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
329
360
  * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
361
+ * @minLength 1
330
362
  */
331
363
  appId?: string;
332
364
  /**
@@ -342,6 +374,8 @@ export interface ProductName {
342
374
  *
343
375
  * Min: 1 character.
344
376
  * Max: 200 characters.
377
+ * @minLength 1
378
+ * @maxLength 200
345
379
  */
346
380
  original?: string;
347
381
  /**
@@ -350,6 +384,8 @@ export interface ProductName {
350
384
  * Min: 1 character.
351
385
  * Max: 400 characters.
352
386
  * Default: Same as `original`.
387
+ * @minLength 1
388
+ * @maxLength 400
353
389
  */
354
390
  translated?: string | null;
355
391
  }
@@ -360,11 +396,15 @@ export interface PageUrlV2 {
360
396
  url?: string | null;
361
397
  }
362
398
  export interface MultiCurrencyPrice {
363
- /** Amount. */
399
+ /**
400
+ * Amount.
401
+ * @decimalValue options { gte:0, lte:1000000000000000 }
402
+ */
364
403
  amount?: string;
365
404
  /**
366
405
  * Converted amount.
367
406
  * @readonly
407
+ * @decimalValue options { gte:0, lte:1000000000000000 }
368
408
  */
369
409
  convertedAmount?: string;
370
410
  /**
@@ -381,7 +421,10 @@ export interface MultiCurrencyPrice {
381
421
  export interface ItemTaxFullDetails {
382
422
  /** Amount for which tax is calculated. */
383
423
  taxableAmount?: MultiCurrencyPrice;
384
- /** Tax rate %, as a decimal point between 0 and 1. */
424
+ /**
425
+ * Tax rate %, as a decimal point between 0 and 1.
426
+ * @decimalValue options { gte:0, lte:1, maxScale:6 }
427
+ */
385
428
  taxRate?: string;
386
429
  /** Calculated tax, based on `taxable_amount` and `tax_rate`. */
387
430
  totalTax?: MultiCurrencyPrice;
@@ -393,9 +436,15 @@ export interface ItemTaxFullDetails {
393
436
  rateBreakdown?: TaxRateBreakdown[];
394
437
  }
395
438
  export interface TaxRateBreakdown {
396
- /** Name of tax against which the calculation was performed. */
439
+ /**
440
+ * Name of tax against which the calculation was performed.
441
+ * @maxLength 100
442
+ */
397
443
  name?: string;
398
- /** Rate at which this tax detail was calculated. */
444
+ /**
445
+ * Rate at which this tax detail was calculated.
446
+ * @decimalValue options { gte:0, lte:1, maxScale:6 }
447
+ */
399
448
  rate?: string;
400
449
  /** Amount of tax for this tax detail. */
401
450
  tax?: MultiCurrencyPrice;
@@ -405,21 +454,31 @@ export interface TaxRateBreakdown {
405
454
  * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
406
455
  */
407
456
  export interface TaxBreakdown {
408
- /** The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec". */
457
+ /**
458
+ * The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
459
+ * @maxLength 200
460
+ */
409
461
  jurisdiction?: string | null;
410
462
  /** The amount of this line item price that was considered nontaxable. (Decimal value) */
411
463
  nonTaxableAmount?: MultiCurrencyPrice;
412
- /** The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value) */
464
+ /**
465
+ * The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value)
466
+ * @decimalValue options { gte:0, maxScale:6 }
467
+ */
413
468
  rate?: string | null;
414
469
  /** The amount of tax estimated for this line item. (Decimal value) */
415
470
  taxAmount?: MultiCurrencyPrice;
416
471
  /** The taxable amount of this line item. */
417
472
  taxableAmount?: MultiCurrencyPrice;
418
- /** The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc. */
473
+ /**
474
+ * The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
475
+ * @maxLength 200
476
+ */
419
477
  taxType?: string | null;
420
478
  /**
421
479
  * The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
422
480
  * This name should be explicit enough to allow the merchant to understand what tax was calculated.
481
+ * @maxLength 200
423
482
  */
424
483
  taxName?: string | null;
425
484
  /** The type of the jurisdiction in which this tax detail applies. */
@@ -453,32 +512,44 @@ export interface DescriptionLineValueOneOf {
453
512
  export interface DescriptionLineDescriptionLineValueOneOf {
454
513
  }
455
514
  export interface DescriptionLineName {
456
- /** 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). */
515
+ /**
516
+ * 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).
517
+ * @maxLength 100
518
+ */
457
519
  original?: string;
458
520
  /**
459
521
  * Description line name translated into the buyer's language.
460
522
  *
461
523
  * Default: Same as `original`.
524
+ * @maxLength 200
462
525
  */
463
526
  translated?: string | null;
464
527
  }
465
528
  export interface PlainTextValue {
466
- /** 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). */
529
+ /**
530
+ * 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).
531
+ * @maxLength 600
532
+ */
467
533
  original?: string;
468
534
  /**
469
535
  * Description line plain text value translated into the buyer's language.
470
536
  *
471
537
  * Default: Same as `original`.
538
+ * @maxLength 600
472
539
  */
473
540
  translated?: string | null;
474
541
  }
475
542
  export interface Color {
476
- /** 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). */
543
+ /**
544
+ * 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).
545
+ * @maxLength 500
546
+ */
477
547
  original?: string;
478
548
  /**
479
549
  * Description line color name translated into the buyer's language.
480
550
  *
481
551
  * Default: Same as `original`.
552
+ * @maxLength 500
482
553
  */
483
554
  translated?: string | null;
484
555
  /** HEX or RGB color code for display. */
@@ -543,7 +614,10 @@ export declare enum ItemAvailabilityStatus {
543
614
  export interface PhysicalProperties {
544
615
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
545
616
  weight?: number | null;
546
- /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
617
+ /**
618
+ * Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
619
+ * @maxLength 40
620
+ */
547
621
  sku?: string | null;
548
622
  /** Whether this line item is shippable. */
549
623
  shippable?: boolean;
@@ -596,11 +670,16 @@ export interface SubscriptionSettings {
596
670
  *
597
671
  * Default: `1`.
598
672
  * If SubscriptionFrequency is Day the minimum interval is 7
673
+ * @min 1
674
+ * @max 50
599
675
  */
600
676
  interval?: number | null;
601
677
  /** Whether subscription is renewed automatically at the end of each period. */
602
678
  autoRenewal?: boolean;
603
- /** Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`. */
679
+ /**
680
+ * Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`.
681
+ * @min 1
682
+ */
604
683
  billingCycles?: number | null;
605
684
  }
606
685
  /** Frequency unit of recurring payment */
@@ -614,29 +693,53 @@ export declare enum SubscriptionFrequency {
614
693
  export interface FreeTrialPeriod {
615
694
  /** Frequency of priod. Values: DAY, WEEK, MONTH, YEAR */
616
695
  frequency?: SubscriptionFrequency;
617
- /** interval of period */
696
+ /**
697
+ * interval of period
698
+ * @min 1
699
+ * @max 50
700
+ */
618
701
  interval?: number;
619
702
  }
620
703
  export interface Title {
621
- /** 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). */
704
+ /**
705
+ * 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).
706
+ * @minLength 1
707
+ * @maxLength 150
708
+ */
622
709
  original?: string;
623
710
  /**
624
711
  * Subscription option name translated into the buyer's language.
625
712
  *
626
713
  * Default: Same as `original`.
714
+ * @minLength 1
715
+ * @maxLength 150
627
716
  */
628
717
  translated?: string | null;
629
718
  }
630
719
  export interface Description {
631
- /** Subscription option description. */
720
+ /**
721
+ * Subscription option description.
722
+ * @maxLength 500
723
+ */
632
724
  original?: string;
633
- /** Translated subscription option description. */
725
+ /**
726
+ * Translated subscription option description.
727
+ * @maxLength 500
728
+ */
634
729
  translated?: string | null;
635
730
  }
636
731
  export interface SecuredMedia {
637
- /** Media ID in Wix Media Manager. */
732
+ /**
733
+ * Media ID in Wix Media Manager.
734
+ * @minLength 1
735
+ * @maxLength 100
736
+ */
638
737
  id?: string;
639
- /** Original filename. */
738
+ /**
739
+ * Original filename.
740
+ * @minLength 1
741
+ * @maxLength 1000
742
+ */
640
743
  fileName?: string;
641
744
  /** File type. */
642
745
  fileType?: FileType;
@@ -668,27 +771,46 @@ export interface ServiceProperties {
668
771
  * For example, the start time of a class.
669
772
  */
670
773
  scheduledDate?: Date | null;
671
- /** The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room. */
774
+ /**
775
+ * The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room.
776
+ * @min 1
777
+ * @max 10000
778
+ */
672
779
  numberOfParticipants?: number | null;
673
780
  }
674
781
  export interface PriceDescription {
675
- /** __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). */
782
+ /**
783
+ * __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).
784
+ * @minLength 1
785
+ * @maxLength 100
786
+ */
676
787
  original?: string;
677
788
  /**
678
789
  * Price description translated into the buyer's language.
679
790
  *
680
791
  * Default: Same as `original`.
792
+ * @minLength 1
793
+ * @maxLength 100
681
794
  */
682
795
  translated?: string | null;
683
796
  }
684
797
  export interface CatalogOverrideFields {
685
798
  /** Item name. */
686
799
  productName?: ProductName;
687
- /** Item price **after** discounts. */
800
+ /**
801
+ * Item price **after** discounts.
802
+ * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
803
+ */
688
804
  price?: string | null;
689
- /** Item price **before** discounts. */
805
+ /**
806
+ * Item price **before** discounts.
807
+ * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
808
+ */
690
809
  fullPrice?: string | null;
691
- /** Item description lines. Used when displaying the line item to customers. */
810
+ /**
811
+ * Item description lines. Used when displaying the line item to customers.
812
+ * @maxSize 20
813
+ */
692
814
  descriptionLines?: DescriptionLine[];
693
815
  /** Physical properties of the item. */
694
816
  physicalProperties?: PhysicalProperties;
@@ -696,7 +818,11 @@ export interface CatalogOverrideFields {
696
818
  image?: Image;
697
819
  /** Payment method selected for the item. */
698
820
  paymentOption?: PaymentOption;
699
- /** Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`. */
821
+ /**
822
+ * Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`.
823
+ * @format DECIMAL_VALUE
824
+ * @decimalValue options { gt:0, lte:999999999, maxScale:3 }
825
+ */
700
826
  depositAmount?: string | null;
701
827
  /**
702
828
  * Whether to save the payment method on the order.
@@ -719,11 +845,9 @@ export interface Image {
719
845
  }
720
846
  export interface PaymentOption {
721
847
  /**
722
- * + `FULL_PAYMENT_ONLINE`: The entire payment for this item happens as part of the checkout.
723
- * + `FULL_PAYMENT_OFFLINE`: The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
724
- * + `MEMBERSHIP`: Payment for this item is done by charging a membership. When selected, `price` is `0`.
725
- * + `DEPOSIT_ONLINE`: Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`.
726
- * + `MEMBERSHIP_OFFLINE`: 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`.
848
+ * Type of selected payment option for current item.
849
+ *
850
+ * Default: `FULL_PAYMENT_ONLINE`
727
851
  */
728
852
  value?: PaymentOptionType;
729
853
  }
@@ -754,9 +878,17 @@ export interface ExtendedFields {
754
878
  namespaces?: Record<string, Record<string, any>>;
755
879
  }
756
880
  export interface Policy {
757
- /** Policy title - should be translated */
881
+ /**
882
+ * Policy title - should be translated
883
+ * @minLength 1
884
+ * @maxLength 29
885
+ */
758
886
  title?: string | null;
759
- /** Policy content - should be translated */
887
+ /**
888
+ * Policy content - should be translated
889
+ * @minLength 1
890
+ * @maxLength 3000
891
+ */
760
892
  content?: string;
761
893
  }
762
894
  /** Billing Info and shipping details */
@@ -768,19 +900,37 @@ export interface AddressWithContact {
768
900
  }
769
901
  /** Physical address */
770
902
  export interface ApiAddress {
771
- /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */
903
+ /**
904
+ * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
905
+ * @format COUNTRY
906
+ */
772
907
  country?: string | null;
773
- /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */
908
+ /**
909
+ * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
910
+ * @maxLength 50
911
+ */
774
912
  subdivision?: string | null;
775
- /** City name. */
913
+ /**
914
+ * City name.
915
+ * @maxLength 50
916
+ */
776
917
  city?: string | null;
777
- /** Postal or zip code. */
918
+ /**
919
+ * Postal or zip code.
920
+ * @maxLength 50
921
+ */
778
922
  postalCode?: string | null;
779
923
  /** Street address. */
780
924
  streetAddress?: StreetAddress;
781
- /** Main address line (usually street name and number). */
925
+ /**
926
+ * Main address line (usually street name and number).
927
+ * @maxLength 150
928
+ */
782
929
  addressLine?: string | null;
783
- /** Free text providing more detailed address info. Usually contains apt, suite, floor. */
930
+ /**
931
+ * Free text providing more detailed address info. Usually contains apt, suite, floor.
932
+ * @maxLength 100
933
+ */
784
934
  addressLine2?: string | null;
785
935
  /**
786
936
  * Country's full name.
@@ -807,13 +957,25 @@ export interface AddressLocation {
807
957
  }
808
958
  /** Full contact details for an address */
809
959
  export interface FullAddressContactDetails {
810
- /** First name. */
960
+ /**
961
+ * First name.
962
+ * @maxLength 100
963
+ */
811
964
  firstName?: string | null;
812
- /** Last name. */
965
+ /**
966
+ * Last name.
967
+ * @maxLength 100
968
+ */
813
969
  lastName?: string | null;
814
- /** Phone number. */
970
+ /**
971
+ * Phone number.
972
+ * @format PHONE
973
+ */
815
974
  phone?: string | null;
816
- /** Company name. */
975
+ /**
976
+ * Company name.
977
+ * @maxLength 1000
978
+ */
817
979
  company?: string | null;
818
980
  /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
819
981
  vatId?: CommonVatId;
@@ -855,11 +1017,15 @@ export interface ShippingInfo {
855
1017
  carrierServiceOptions?: CarrierServiceOption[];
856
1018
  }
857
1019
  export interface SelectedCarrierServiceOption {
858
- /** Unique identifier of selected option. For example, "usps_std_overnight". */
1020
+ /**
1021
+ * Unique identifier of selected option. For example, "usps_std_overnight".
1022
+ * @maxLength 100
1023
+ */
859
1024
  code?: string;
860
1025
  /**
861
1026
  * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
862
1027
  * For example, "Standard" or "First-Class Package International".
1028
+ * @maxLength 250
863
1029
  * @readonly
864
1030
  */
865
1031
  title?: string;
@@ -880,17 +1046,29 @@ export interface SelectedCarrierServiceOption {
880
1046
  requestedShippingOption?: boolean;
881
1047
  /** Other charges */
882
1048
  otherCharges?: SelectedCarrierServiceOptionOtherCharge[];
883
- /** This carrier's unique ID */
1049
+ /**
1050
+ * This carrier's unique ID
1051
+ * @format GUID
1052
+ */
884
1053
  carrierId?: string | null;
885
- /** Delivery solution allocations to different delivery carriers and delivery regions */
1054
+ /**
1055
+ * Delivery solution allocations to different delivery carriers and delivery regions
1056
+ * @maxSize 300
1057
+ */
886
1058
  deliveryAllocations?: DeliveryAllocation[];
887
1059
  /** If the delivery solution is a partial and doesn't apply to all items. */
888
1060
  partial?: boolean | null;
889
1061
  }
890
1062
  export interface DeliveryLogistics {
891
- /** Expected delivery time, in free text. For example, "3-5 business days". */
1063
+ /**
1064
+ * Expected delivery time, in free text. For example, "3-5 business days".
1065
+ * @maxLength 500
1066
+ */
892
1067
  deliveryTime?: string | null;
893
- /** Instructions for caller, e.g for pickup: "Please deliver during opening hours, and please don't park in disabled parking spot". */
1068
+ /**
1069
+ * Instructions for caller, e.g for pickup: "Please deliver during opening hours, and please don't park in disabled parking spot".
1070
+ * @maxLength 1000
1071
+ */
894
1072
  instructions?: string | null;
895
1073
  /** Pickup details. */
896
1074
  pickupDetails?: PickupDetails;
@@ -932,7 +1110,10 @@ export interface SelectedCarrierServiceOptionPrices {
932
1110
  export interface SelectedCarrierServiceOptionOtherCharge {
933
1111
  /** Type of additional cost. */
934
1112
  type?: ChargeType;
935
- /** Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'. */
1113
+ /**
1114
+ * Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'.
1115
+ * @maxLength 200
1116
+ */
936
1117
  details?: string | null;
937
1118
  /** Price of added charge. */
938
1119
  cost?: SelectedCarrierServiceOptionPrices;
@@ -950,32 +1131,56 @@ export interface DeliveryAllocation {
950
1131
  applicableLineItems?: ApplicableLineItems;
951
1132
  }
952
1133
  export interface Carrier {
953
- /** The carrier app id */
1134
+ /**
1135
+ * The carrier app id
1136
+ * @format GUID
1137
+ */
954
1138
  appId?: string | null;
955
- /** Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`. */
1139
+ /**
1140
+ * Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`.
1141
+ * @maxLength 250
1142
+ */
956
1143
  code?: string;
957
1144
  }
958
1145
  export interface Region {
959
- /** The delivery region id. */
1146
+ /**
1147
+ * The delivery region id.
1148
+ * @format GUID
1149
+ */
960
1150
  id?: string | null;
961
- /** The delivery region name. */
1151
+ /**
1152
+ * The delivery region name.
1153
+ * @maxLength 100
1154
+ */
962
1155
  name?: string | null;
963
1156
  }
964
1157
  export interface ApplicableLineItems {
965
- /** Line items that the delivery solution is for. */
1158
+ /**
1159
+ * Line items that the delivery solution is for.
1160
+ * @maxSize 300
1161
+ * @minLength 1
1162
+ * @maxLength 100
1163
+ */
966
1164
  lineItemIds?: string[];
967
1165
  }
968
1166
  export interface ShippingRegion {
969
1167
  /**
970
1168
  * Shipping region ID.
1169
+ * @format GUID
971
1170
  * @readonly
972
1171
  */
973
1172
  id?: string;
974
- /** Shipping region name. */
1173
+ /**
1174
+ * Shipping region name.
1175
+ * @maxLength 100
1176
+ */
975
1177
  name?: string;
976
1178
  }
977
1179
  export interface CarrierServiceOption {
978
- /** Carrier ID. */
1180
+ /**
1181
+ * Carrier ID.
1182
+ * @format GUID
1183
+ */
979
1184
  carrierId?: string;
980
1185
  /** Shipping options offered by this carrier for this request. */
981
1186
  shippingOptions?: ShippingOption[];
@@ -984,18 +1189,23 @@ export interface ShippingOption {
984
1189
  /**
985
1190
  * Unique code of provided shipping option like "usps_std_overnight".
986
1191
  * For legacy calculators this would be the UUID of the option.
1192
+ * @maxLength 100
987
1193
  */
988
1194
  code?: string;
989
1195
  /**
990
1196
  * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
991
1197
  * For example, "Standard" or "First-Class Package International".
1198
+ * @maxLength 250
992
1199
  */
993
1200
  title?: string;
994
1201
  /** Delivery logistics. */
995
1202
  logistics?: DeliveryLogistics;
996
1203
  /** Sipping price information. */
997
1204
  cost?: ShippingPrice;
998
- /** Delivery solution allocations to different delivery carriers and delivery regions */
1205
+ /**
1206
+ * Delivery solution allocations to different delivery carriers and delivery regions
1207
+ * @maxSize 300
1208
+ */
999
1209
  deliveryAllocations?: DeliveryAllocation[];
1000
1210
  /** If the delivery solution is a partial and doesn't apply to all items. */
1001
1211
  partial?: boolean | null;
@@ -1015,31 +1225,39 @@ export interface OtherCharge {
1015
1225
  export interface BuyerInfo extends BuyerInfoIdOneOf {
1016
1226
  /**
1017
1227
  * Visitor ID (if site visitor is **not** a member).
1228
+ * @format GUID
1018
1229
  * @readonly
1019
1230
  */
1020
1231
  visitorId?: string;
1021
1232
  /**
1022
1233
  * Member ID (if site visitor is a site member).
1234
+ * @format GUID
1023
1235
  * @readonly
1024
1236
  */
1025
1237
  memberId?: string;
1026
1238
  /**
1027
1239
  * Contact ID. Auto-created if one does not yet exist. For more information, see [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/introduction).
1240
+ * @format GUID
1028
1241
  * @readonly
1029
1242
  */
1030
1243
  contactId?: string | null;
1031
- /** Buyer email address. */
1244
+ /**
1245
+ * Buyer email address.
1246
+ * @format EMAIL
1247
+ */
1032
1248
  email?: string | null;
1033
1249
  }
1034
1250
  /** @oneof */
1035
1251
  export interface BuyerInfoIdOneOf {
1036
1252
  /**
1037
1253
  * Visitor ID (if site visitor is **not** a member).
1254
+ * @format GUID
1038
1255
  * @readonly
1039
1256
  */
1040
1257
  visitorId?: string;
1041
1258
  /**
1042
1259
  * Member ID (if site visitor is a site member).
1260
+ * @format GUID
1043
1261
  * @readonly
1044
1262
  */
1045
1263
  memberId?: string;
@@ -1200,11 +1418,16 @@ export interface GiftCard {
1200
1418
  obfuscatedCode?: string;
1201
1419
  /** Gift card value. */
1202
1420
  amount?: MultiCurrencyPrice;
1203
- /** App ID of the gift card provider. */
1421
+ /**
1422
+ * App ID of the gift card provider.
1423
+ * @format GUID
1424
+ */
1204
1425
  appId?: string;
1205
1426
  /**
1206
1427
  * External ID in the gift card provider's system.
1207
1428
  * Used for integration and tracking across different platforms.
1429
+ * @minLength 1
1430
+ * @maxLength 50
1208
1431
  */
1209
1432
  externalId?: string | null;
1210
1433
  }
@@ -1219,6 +1442,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1219
1442
  discountType?: DiscountType;
1220
1443
  /**
1221
1444
  * IDs of line items the discount applies to.
1445
+ * @format GUID
1222
1446
  * @deprecated IDs of line items the discount applies to.
1223
1447
  * @replacedBy line_items_discounts
1224
1448
  * @targetRemovalDate 2024-06-01
@@ -1253,11 +1477,18 @@ export interface Coupon {
1253
1477
  export interface MerchantDiscount {
1254
1478
  /** Discount value. */
1255
1479
  amount?: MultiCurrencyPrice;
1256
- /** Discount Percentage. Will be calculated from items price before other discounts. */
1480
+ /**
1481
+ * Discount Percentage. Will be calculated from items price before other discounts.
1482
+ * @min 1
1483
+ * @max 100
1484
+ */
1257
1485
  percentage?: number | null;
1258
1486
  }
1259
1487
  export interface DiscountRule {
1260
- /** Discount rule ID */
1488
+ /**
1489
+ * Discount rule ID
1490
+ * @format GUID
1491
+ */
1261
1492
  id?: string;
1262
1493
  /** Discount rule name */
1263
1494
  name?: DiscountRuleName;
@@ -1265,13 +1496,24 @@ export interface DiscountRule {
1265
1496
  amount?: MultiCurrencyPrice;
1266
1497
  }
1267
1498
  export interface DiscountRuleName {
1268
- /** Original discount rule name (in site's default language). */
1499
+ /**
1500
+ * Original discount rule name (in site's default language).
1501
+ * @minLength 1
1502
+ * @maxLength 256
1503
+ */
1269
1504
  original?: string;
1270
- /** Translated discount rule name according to buyer language. Defaults to `original` when not provided. */
1505
+ /**
1506
+ * Translated discount rule name according to buyer language. Defaults to `original` when not provided.
1507
+ * @minLength 1
1508
+ * @maxLength 500
1509
+ */
1271
1510
  translated?: string | null;
1272
1511
  }
1273
1512
  export interface LineItemDiscount {
1274
- /** ID of line item the discount applies to. */
1513
+ /**
1514
+ * ID of line item the discount applies to.
1515
+ * @format GUID
1516
+ */
1275
1517
  id?: string;
1276
1518
  /** Discount value. */
1277
1519
  totalDiscountAmount?: MultiCurrencyPrice;
@@ -1279,9 +1521,17 @@ export interface LineItemDiscount {
1279
1521
  export interface CustomField {
1280
1522
  /** Custom field value. */
1281
1523
  value?: any;
1282
- /** Custom field title. */
1524
+ /**
1525
+ * Custom field title.
1526
+ * @minLength 1
1527
+ * @maxLength 500
1528
+ */
1283
1529
  title?: string;
1284
- /** Translated custom field title. */
1530
+ /**
1531
+ * Translated custom field title.
1532
+ * @minLength 1
1533
+ * @maxLength 500
1534
+ */
1285
1535
  translatedTitle?: string | null;
1286
1536
  }
1287
1537
  export declare enum WeightUnit {
@@ -1357,15 +1607,27 @@ export declare enum FallbackReason {
1357
1607
  * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
1358
1608
  */
1359
1609
  export interface AggregatedTaxBreakdown {
1360
- /** The name of the tax against which this tax amount was calculated. */
1610
+ /**
1611
+ * The name of the tax against which this tax amount was calculated.
1612
+ * @maxLength 200
1613
+ */
1361
1614
  taxName?: string;
1362
- /** The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws. */
1615
+ /**
1616
+ * The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.
1617
+ * @maxLength 200
1618
+ */
1363
1619
  taxType?: string;
1364
- /** The name of the jurisdiction in which this tax detail applies. */
1620
+ /**
1621
+ * The name of the jurisdiction in which this tax detail applies.
1622
+ * @maxLength 200
1623
+ */
1365
1624
  jurisdiction?: string;
1366
1625
  /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
1367
1626
  jurisdictionTypeEnum?: JurisdictionType;
1368
- /** The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value) */
1627
+ /**
1628
+ * The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value)
1629
+ * @decimalValue options { gte:0, maxScale:6 }
1630
+ */
1369
1631
  rate?: string;
1370
1632
  /** The sum of all the tax from line items that calculated by the tax identifiers. */
1371
1633
  aggregatedTaxAmount?: MultiCurrencyPrice;
@@ -1408,13 +1670,23 @@ export interface CreatedBy extends CreatedByIdOneOf {
1408
1670
  /**
1409
1671
  * User ID - when the order was created by a Wix user on behalf of a buyer.
1410
1672
  * For example, via POS (point of service).
1673
+ * @format GUID
1411
1674
  */
1412
1675
  userId?: string;
1413
- /** Member ID - when the order was created by a **logged in** site visitor. */
1676
+ /**
1677
+ * Member ID - when the order was created by a **logged in** site visitor.
1678
+ * @format GUID
1679
+ */
1414
1680
  memberId?: string;
1415
- /** Visitor ID - when the order was created by a site visitor that was **not** logged in. */
1681
+ /**
1682
+ * Visitor ID - when the order was created by a site visitor that was **not** logged in.
1683
+ * @format GUID
1684
+ */
1416
1685
  visitorId?: string;
1417
- /** App ID - when the order was created by an external application or Wix service. */
1686
+ /**
1687
+ * App ID - when the order was created by an external application or Wix service.
1688
+ * @format GUID
1689
+ */
1418
1690
  appId?: string;
1419
1691
  }
1420
1692
  /** @oneof */
@@ -1422,13 +1694,23 @@ export interface CreatedByIdOneOf {
1422
1694
  /**
1423
1695
  * User ID - when the order was created by a Wix user on behalf of a buyer.
1424
1696
  * For example, via POS (point of service).
1697
+ * @format GUID
1425
1698
  */
1426
1699
  userId?: string;
1427
- /** Member ID - when the order was created by a **logged in** site visitor. */
1700
+ /**
1701
+ * Member ID - when the order was created by a **logged in** site visitor.
1702
+ * @format GUID
1703
+ */
1428
1704
  memberId?: string;
1429
- /** Visitor ID - when the order was created by a site visitor that was **not** logged in. */
1705
+ /**
1706
+ * Visitor ID - when the order was created by a site visitor that was **not** logged in.
1707
+ * @format GUID
1708
+ */
1430
1709
  visitorId?: string;
1431
- /** App ID - when the order was created by an external application or Wix service. */
1710
+ /**
1711
+ * App ID - when the order was created by an external application or Wix service.
1712
+ * @format GUID
1713
+ */
1432
1714
  appId?: string;
1433
1715
  }
1434
1716
  /** Reserved for internal use. */
@@ -1436,24 +1718,39 @@ export interface MembershipOptions {
1436
1718
  /**
1437
1719
  * Reserved for internal use.
1438
1720
  * @readonly
1721
+ * @maxSize 300
1439
1722
  */
1440
1723
  eligibleMemberships?: Membership[];
1441
1724
  /**
1442
1725
  * Reserved for internal use.
1443
1726
  * @readonly
1727
+ * @maxSize 300
1444
1728
  */
1445
1729
  invalidMemberships?: InvalidMembership[];
1446
1730
  /** Selected membership to apply to this checkout. */
1447
1731
  selectedMemberships?: SelectedMemberships;
1448
1732
  }
1449
1733
  export interface Membership {
1450
- /** Membership ID. */
1734
+ /**
1735
+ * Membership ID.
1736
+ * @minLength 1
1737
+ * @maxLength 100
1738
+ */
1451
1739
  id?: string;
1452
- /** ID of the application providing this payment option. */
1740
+ /**
1741
+ * ID of the application providing this payment option.
1742
+ * @format GUID
1743
+ */
1453
1744
  appId?: string;
1454
1745
  /** The name of this membership. */
1455
1746
  name?: MembershipName;
1456
- /** Line item IDs which are "paid" for by this membership. */
1747
+ /**
1748
+ * Line item IDs which are "paid" for by this membership.
1749
+ * @minSize 1
1750
+ * @maxSize 300
1751
+ * @minLength 1
1752
+ * @maxLength 100
1753
+ */
1457
1754
  lineItemIds?: string[];
1458
1755
  /** Optional - For a membership that has limited credits, information about credit usage. */
1459
1756
  credits?: MembershipPaymentCredits;
@@ -1463,13 +1760,22 @@ export interface Membership {
1463
1760
  additionalData?: Record<string, any> | null;
1464
1761
  }
1465
1762
  export interface MembershipName {
1466
- /** Membership name. */
1763
+ /**
1764
+ * Membership name.
1765
+ * @maxLength 100
1766
+ */
1467
1767
  original?: string;
1468
- /** Translated membership name. Defaults to `original` when not provided. */
1768
+ /**
1769
+ * Translated membership name. Defaults to `original` when not provided.
1770
+ * @maxLength 100
1771
+ */
1469
1772
  translated?: string | null;
1470
1773
  }
1471
1774
  export interface MembershipPaymentCredits {
1472
- /** Membership's total amount of credits. */
1775
+ /**
1776
+ * Membership's total amount of credits.
1777
+ * @min 1
1778
+ */
1473
1779
  total?: number;
1474
1780
  /** Membership's remaining amount of credits. */
1475
1781
  remaining?: number;
@@ -1477,31 +1783,63 @@ export interface MembershipPaymentCredits {
1477
1783
  export interface InvalidMembership {
1478
1784
  /** Membership details. */
1479
1785
  membership?: Membership;
1480
- /** Reason why this membership is invalid and cannot be used. */
1786
+ /**
1787
+ * Reason why this membership is invalid and cannot be used.
1788
+ * @minLength 1
1789
+ * @maxLength 100
1790
+ */
1481
1791
  reason?: string;
1482
1792
  }
1483
1793
  export interface SelectedMemberships {
1484
- /** Selected memberships. */
1794
+ /**
1795
+ * Selected memberships.
1796
+ * @maxSize 300
1797
+ */
1485
1798
  memberships?: SelectedMembership[];
1486
1799
  }
1487
1800
  export interface SelectedMembership {
1488
- /** Membership ID. */
1801
+ /**
1802
+ * Membership ID.
1803
+ * @minLength 1
1804
+ * @maxLength 100
1805
+ */
1489
1806
  id?: string;
1490
- /** ID of the app providing this payment option. */
1807
+ /**
1808
+ * ID of the app providing this payment option.
1809
+ * @format GUID
1810
+ */
1491
1811
  appId?: string;
1492
- /** IDs of the line items this membership applies to. */
1812
+ /**
1813
+ * IDs of the line items this membership applies to.
1814
+ * @minSize 1
1815
+ * @maxSize 300
1816
+ * @minLength 1
1817
+ * @maxLength 100
1818
+ */
1493
1819
  lineItemIds?: string[];
1494
1820
  }
1495
1821
  export interface AdditionalFee {
1496
- /** Additional fee's unique code (or ID) for future processing. */
1822
+ /**
1823
+ * Additional fee's unique code (or ID) for future processing.
1824
+ * @minLength 1
1825
+ * @maxLength 100
1826
+ */
1497
1827
  code?: string | null;
1498
- /** Translated additional fee's name. */
1828
+ /**
1829
+ * Translated additional fee's name.
1830
+ * @minLength 1
1831
+ * @maxLength 50
1832
+ */
1499
1833
  name?: string;
1500
1834
  /** Additional fee's price. */
1501
1835
  price?: MultiCurrencyPrice;
1502
1836
  /** Tax details. */
1503
1837
  taxDetails?: ItemTaxFullDetails;
1504
- /** Provider's app id. */
1838
+ /**
1839
+ * Provider's app id.
1840
+ * @minLength 1
1841
+ * @maxLength 100
1842
+ */
1505
1843
  providerAppId?: string | null;
1506
1844
  /** Additional fee's price before tax. */
1507
1845
  priceBeforeTax?: MultiCurrencyPrice;
@@ -1510,6 +1848,7 @@ export interface AdditionalFee {
1510
1848
  /**
1511
1849
  * Optional - Line items associated with this additional fee.
1512
1850
  * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
1851
+ * @format GUID
1513
1852
  */
1514
1853
  lineItemIds?: string[];
1515
1854
  /** the source the additional fee was added from */
@@ -1528,11 +1867,13 @@ export interface ConversionInfo {
1528
1867
  /**
1529
1868
  * The site currency.
1530
1869
  * @readonly
1870
+ * @format CURRENCY
1531
1871
  */
1532
1872
  siteCurrency?: string;
1533
1873
  /**
1534
1874
  * The rate used when converting from the site currency to the checkout currency.
1535
1875
  * @readonly
1876
+ * @decimalValue options { gt:0, lte:1000000000000000 }
1536
1877
  */
1537
1878
  conversionRate?: string;
1538
1879
  }
@@ -1541,7 +1882,11 @@ export interface Violation {
1541
1882
  severity?: Severity;
1542
1883
  /** Target location on a checkout or cart page where the violation will be displayed. */
1543
1884
  target?: Target;
1544
- /** Violation description. Can include rich text. Only HTTP or HTTPS links in the following format are allowed: `<a href="https://www.wix.com">Click me</a>`. */
1885
+ /**
1886
+ * Violation description. Can include rich text. Only HTTP or HTTPS links in the following format are allowed: `<a href="https://www.wix.com">Click me</a>`.
1887
+ * @minLength 1
1888
+ * @maxLength 1000
1889
+ */
1545
1890
  description?: string | null;
1546
1891
  }
1547
1892
  export declare enum Severity {
@@ -1625,12 +1970,14 @@ export interface CustomContentReference {
1625
1970
  * ID of the app providing the content.
1626
1971
  *
1627
1972
  * You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
1973
+ * @format GUID
1628
1974
  */
1629
1975
  appId?: string;
1630
1976
  /**
1631
1977
  * ID of the component within the app it belongs to.
1632
1978
  *
1633
1979
  * You can get your component's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
1980
+ * @format GUID
1634
1981
  */
1635
1982
  componentId?: string;
1636
1983
  }
@@ -1638,14 +1985,49 @@ export interface ExternalReference {
1638
1985
  /**
1639
1986
  * ID of the app associated with the purchase flow.
1640
1987
  * For example, the Wix Pay Links app ID.
1988
+ * @format GUID
1989
+ * @immutable
1641
1990
  */
1642
1991
  appId?: string;
1643
1992
  /**
1644
1993
  * Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.
1645
1994
  * For example, a Wix Pay Link ID.
1995
+ * @minLength 1
1996
+ * @maxLength 100
1997
+ * @immutable
1646
1998
  */
1647
1999
  resourceId?: string | null;
1648
2000
  }
2001
+ export interface SubscriptionCharges {
2002
+ /**
2003
+ * ids of the items the subscription is defined on
2004
+ * @format GUID
2005
+ * @minSize 1
2006
+ * @maxSize 300
2007
+ */
2008
+ lineItemIds?: string[];
2009
+ /**
2010
+ * Generated description explaining future charges amount and schedule.
2011
+ * Translated to subscription order buyer language, or to site language if was not provided.
2012
+ * @maxLength 1000
2013
+ */
2014
+ description?: string | null;
2015
+ /**
2016
+ * Charges for subscription.
2017
+ * @maxSize 50
2018
+ */
2019
+ charges?: Charge[];
2020
+ }
2021
+ export interface Charge {
2022
+ /** The cycle number from which the charge starts. */
2023
+ cycleFrom?: number;
2024
+ /** The number of cycles for which the charge is applicable. */
2025
+ cycleCount?: number | null;
2026
+ /** Charge summary. */
2027
+ priceSummary?: PriceSummary;
2028
+ /** The billing date from which the charge starts. */
2029
+ cycleBillingDate?: Date | null;
2030
+ }
1649
2031
  export interface UpdatedCheckoutMessage {
1650
2032
  /** Previous checkout. */
1651
2033
  oldCheckout?: Checkout;
@@ -1657,28 +2039,20 @@ export interface CreateCheckoutRequest {
1657
2039
  checkoutInfo?: Checkout;
1658
2040
  /** Coupon code. */
1659
2041
  couponCode?: string | null;
1660
- /** Catalog line items to add to the checkout. */
2042
+ /**
2043
+ * Catalog line items to add to the checkout.
2044
+ * @maxSize 300
2045
+ */
1661
2046
  lineItems?: LineItem[];
1662
2047
  /**
1663
2048
  * Custom line items to add to the checkout. Custom line items don't trigger the Catalog service plugin.
1664
2049
  *
1665
2050
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
1666
2051
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
2052
+ * @maxSize 300
1667
2053
  */
1668
2054
  customLineItems?: CustomLineItem[];
1669
- /**
1670
- * Sales channel that submitted the order.
1671
- * + `"UNSPECIFIED"`: Unspecified sales channel. This value is not supported.
1672
- * + `"WEB"`: A web client.
1673
- * + `"POS"`: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395)
1674
- * + `"EBAY"`: [eBay](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop)
1675
- * + `"AMAZON"`: [Amazon](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop)
1676
- * + `"WISH"`: [Wish](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-a-wish-shop)
1677
- * + `"WIX_INVOICES"`: Wix Invoices app in [your dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finvoices/settings/general-settings)
1678
- * + `"WIX_APP_STORE"`: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview)
1679
- * + `"BACKOFFICE_MERCHANT"`: Wix merchant backoffice
1680
- * + `"OTHER_PLATFORM"`: Other sales platform.
1681
- */
2055
+ /** Sales channel that submitted the order. */
1682
2056
  channelType: ChannelType;
1683
2057
  /**
1684
2058
  * Gift card code.
@@ -1694,6 +2068,7 @@ export interface CreateCheckoutRequest {
1694
2068
  * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the [Abandoned Checkout API](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/abandoned-checkout/introduction)
1695
2069
  * to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
1696
2070
  * standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
2071
+ * @maxLength 1000
1697
2072
  */
1698
2073
  overrideCheckoutUrl?: string | null;
1699
2074
  }
@@ -1703,17 +2078,24 @@ export interface CustomLineItem {
1703
2078
  *
1704
2079
  * Min: `1`
1705
2080
  * Max: `100000`
2081
+ * @min 1
2082
+ * @max 100000
1706
2083
  */
1707
2084
  quantity?: number;
1708
2085
  /**
1709
2086
  * Custom line item price.
1710
2087
  *
1711
2088
  * Must be a number or a decimal without symbols.
2089
+ * @format DECIMAL_VALUE
2090
+ * @decimalValue options { gte:0, lte:1000000000000000 }
1712
2091
  */
1713
2092
  price?: string;
1714
2093
  /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
1715
2094
  priceDescription?: PriceDescription;
1716
- /** Custom line item description lines. Used for display purposes for the cart, checkout and order. */
2095
+ /**
2096
+ * Custom line item description lines. Used for display purposes for the cart, checkout and order.
2097
+ * @maxSize 10
2098
+ */
1717
2099
  descriptionLines?: DescriptionLine[];
1718
2100
  /** Custom line item's media. */
1719
2101
  media?: Image;
@@ -1721,9 +2103,13 @@ export interface CustomLineItem {
1721
2103
  * Custom line item ID. If passed, `id` must be unique.
1722
2104
  *
1723
2105
  * Default: auto-generated ID
2106
+ * @format GUID
1724
2107
  */
1725
2108
  id?: string | null;
1726
- /** Tax group ID for this custom line item. */
2109
+ /**
2110
+ * Tax group ID for this custom line item.
2111
+ * @format GUID
2112
+ */
1727
2113
  taxGroupId?: string | null;
1728
2114
  /** Name of the item or product. */
1729
2115
  productName?: ProductName;
@@ -1731,11 +2117,15 @@ export interface CustomLineItem {
1731
2117
  url?: PageUrlV2;
1732
2118
  /** Item type. Either a preset type or custom. */
1733
2119
  itemType?: ItemType;
1734
- /** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
2120
+ /**
2121
+ * Item price **before** catalog-defined discount. Defaults to `price` when not provided.
2122
+ * @format DECIMAL_VALUE
2123
+ */
1735
2124
  fullPrice?: string | null;
1736
2125
  /**
1737
2126
  * Item quantity available for purchase. Only return this if inventory is managed.
1738
2127
  * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
2128
+ * @max 100000
1739
2129
  */
1740
2130
  quantityAvailable?: number | null;
1741
2131
  /** Physical properties of the item. */
@@ -1760,6 +2150,8 @@ export interface CustomLineItem {
1760
2150
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
1761
2151
  * + In most cases, this field is the same as `catalogReference.catalogItemId`.
1762
2152
  * + Used in membership validation.
2153
+ * @minLength 1
2154
+ * @maxLength 36
1763
2155
  */
1764
2156
  rootCatalogItemId?: string | null;
1765
2157
  /**
@@ -1767,12 +2159,20 @@ export interface CustomLineItem {
1767
2159
  *
1768
2160
  * Eligible for catalog items with type `DEPOSIT_ONLINE`.
1769
2161
  * When omitted, the item's price will not be split and is expected to be paid in a single installment.
2162
+ * @format DECIMAL_VALUE
1770
2163
  */
1771
2164
  depositAmount?: string | null;
2165
+ /**
2166
+ * Delivery profile ID.
2167
+ * @format GUID
2168
+ */
2169
+ deliveryProfileId?: string | null;
1772
2170
  /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
1773
2171
  catalogReference?: CatalogReference;
1774
2172
  /**
1775
2173
  * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
2174
+ * @minLength 1
2175
+ * @maxLength 1000
1776
2176
  * @readonly
1777
2177
  */
1778
2178
  consentRequiredPaymentPolicy?: string | null;
@@ -1785,9 +2185,16 @@ export interface CustomLineItem {
1785
2185
  savePaymentMethod?: boolean;
1786
2186
  }
1787
2187
  export interface MerchantDiscountInput {
1788
- /** Discount amount. */
2188
+ /**
2189
+ * Discount amount.
2190
+ * @decimalValue options { gte:0 }
2191
+ */
1789
2192
  amount?: string;
1790
- /** IDs of line items the discount applies to. */
2193
+ /**
2194
+ * IDs of line items the discount applies to.
2195
+ * @format GUID
2196
+ * @maxSize 300
2197
+ */
1791
2198
  lineItemIds?: string[];
1792
2199
  }
1793
2200
  export interface CreateCheckoutResponse {
@@ -1804,7 +2211,10 @@ export interface ShippingCalculationErrorDataShippingCalculationErrorOneOf {
1804
2211
  carrierErrors?: CarrierErrors;
1805
2212
  }
1806
2213
  export interface GetCheckoutRequest {
1807
- /** Checkout ID. */
2214
+ /**
2215
+ * Checkout ID.
2216
+ * @format GUID
2217
+ */
1808
2218
  id: string;
1809
2219
  }
1810
2220
  export interface GetCheckoutResponse {
@@ -1812,7 +2222,10 @@ export interface GetCheckoutResponse {
1812
2222
  checkout?: Checkout;
1813
2223
  }
1814
2224
  export interface GetCheckoutWithAllExtendedFieldsRequest {
1815
- /** Checkout ID. */
2225
+ /**
2226
+ * Checkout ID.
2227
+ * @format GUID
2228
+ */
1816
2229
  id?: string;
1817
2230
  }
1818
2231
  export interface GetCheckoutWithAllExtendedFieldsResponse {
@@ -1820,7 +2233,10 @@ export interface GetCheckoutWithAllExtendedFieldsResponse {
1820
2233
  checkout?: Checkout;
1821
2234
  }
1822
2235
  export interface GetCheckoutByCartIdRequest {
1823
- /** Cart ID. */
2236
+ /**
2237
+ * Cart ID.
2238
+ * @format GUID
2239
+ */
1824
2240
  id: string;
1825
2241
  }
1826
2242
  export interface GetCheckoutByCartIdResponse {
@@ -1828,7 +2244,10 @@ export interface GetCheckoutByCartIdResponse {
1828
2244
  checkout?: Checkout;
1829
2245
  }
1830
2246
  export interface GetWixCheckoutURLRequest {
1831
- /** Checkout ID. */
2247
+ /**
2248
+ * Checkout ID.
2249
+ * @format GUID
2250
+ */
1832
2251
  id: string;
1833
2252
  }
1834
2253
  export interface GetWixCheckoutURLResponse {
@@ -1836,7 +2255,10 @@ export interface GetWixCheckoutURLResponse {
1836
2255
  checkoutUrl?: string;
1837
2256
  }
1838
2257
  export interface GetCheckoutURLRequest {
1839
- /** Checkout ID. */
2258
+ /**
2259
+ * Checkout ID.
2260
+ * @format GUID
2261
+ */
1840
2262
  id: string;
1841
2263
  }
1842
2264
  export interface GetCheckoutURLResponse {
@@ -1860,15 +2282,20 @@ export interface UpdateCheckoutRequest {
1860
2282
  * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the [Abandoned Checkout API](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/abandoned-checkout/introduction)
1861
2283
  * to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
1862
2284
  * standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
2285
+ * @maxLength 1000
1863
2286
  */
1864
2287
  overrideCheckoutUrl?: string | null;
1865
- /** Catalog line items. */
2288
+ /**
2289
+ * Catalog line items.
2290
+ * @maxSize 300
2291
+ */
1866
2292
  lineItems?: LineItem[];
1867
2293
  /**
1868
2294
  * Custom line items. Custom line items don't trigger the Catalog service plugin.
1869
2295
  *
1870
2296
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
1871
2297
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
2298
+ * @maxSize 300
1872
2299
  */
1873
2300
  customLineItems?: CustomLineItem[];
1874
2301
  }
@@ -1877,7 +2304,10 @@ export interface UpdateCheckoutResponse {
1877
2304
  checkout?: Checkout;
1878
2305
  }
1879
2306
  export interface RemoveCouponRequest {
1880
- /** ID of the checkout to remove the coupon from. */
2307
+ /**
2308
+ * ID of the checkout to remove the coupon from.
2309
+ * @format GUID
2310
+ */
1881
2311
  id: string;
1882
2312
  }
1883
2313
  export interface RemoveCouponResponse {
@@ -1885,7 +2315,10 @@ export interface RemoveCouponResponse {
1885
2315
  checkout?: Checkout;
1886
2316
  }
1887
2317
  export interface RemoveGiftCardRequest {
1888
- /** ID of the checkout to remove the gift card from. */
2318
+ /**
2319
+ * ID of the checkout to remove the gift card from.
2320
+ * @format GUID
2321
+ */
1889
2322
  id: string;
1890
2323
  }
1891
2324
  export interface RemoveGiftCardResponse {
@@ -1893,7 +2326,10 @@ export interface RemoveGiftCardResponse {
1893
2326
  checkout?: Checkout;
1894
2327
  }
1895
2328
  export interface RemoveOverrideCheckoutUrlRequest {
1896
- /** ID of the checkout to remove the override checkout url from. */
2329
+ /**
2330
+ * ID of the checkout to remove the override checkout url from.
2331
+ * @format GUID
2332
+ */
1897
2333
  id: string;
1898
2334
  }
1899
2335
  export interface RemoveOverrideCheckoutUrlResponse {
@@ -1901,15 +2337,22 @@ export interface RemoveOverrideCheckoutUrlResponse {
1901
2337
  checkout?: Checkout;
1902
2338
  }
1903
2339
  export interface AddToCheckoutRequest {
1904
- /** Checkout ID. */
2340
+ /**
2341
+ * Checkout ID.
2342
+ * @format GUID
2343
+ */
1905
2344
  id: string;
1906
- /** Catalog line items. */
2345
+ /**
2346
+ * Catalog line items.
2347
+ * @maxSize 100
2348
+ */
1907
2349
  lineItems?: LineItem[];
1908
2350
  /**
1909
2351
  * Custom line items. Custom line items don't trigger the Catalog service plugin.
1910
2352
  *
1911
2353
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
1912
2354
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
2355
+ * @maxSize 100
1913
2356
  */
1914
2357
  customLineItems?: CustomLineItem[];
1915
2358
  }
@@ -1918,9 +2361,17 @@ export interface AddToCheckoutResponse {
1918
2361
  checkout?: Checkout;
1919
2362
  }
1920
2363
  export interface RemoveLineItemsRequest {
1921
- /** ID of the checkout to remove line items from. */
2364
+ /**
2365
+ * ID of the checkout to remove line items from.
2366
+ * @format GUID
2367
+ */
1922
2368
  id: string;
1923
- /** IDs of the line items to remove from the checkout. */
2369
+ /**
2370
+ * IDs of the line items to remove from the checkout.
2371
+ * @format GUID
2372
+ * @minSize 1
2373
+ * @maxSize 300
2374
+ */
1924
2375
  lineItemIds: string[];
1925
2376
  }
1926
2377
  export interface RemoveLineItemsResponse {
@@ -1928,7 +2379,10 @@ export interface RemoveLineItemsResponse {
1928
2379
  checkout?: Checkout;
1929
2380
  }
1930
2381
  export interface CreateOrderRequest {
1931
- /** Checkout ID. */
2382
+ /**
2383
+ * Checkout ID.
2384
+ * @format GUID
2385
+ */
1932
2386
  id: string;
1933
2387
  /** Indicates the payment method should be saved on the order */
1934
2388
  savePaymentMethod?: boolean;
@@ -1936,9 +2390,15 @@ export interface CreateOrderRequest {
1936
2390
  delayCapture?: boolean;
1937
2391
  }
1938
2392
  export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
1939
- /** ID of newly created order. */
2393
+ /**
2394
+ * ID of newly created order.
2395
+ * @format GUID
2396
+ */
1940
2397
  orderId?: string;
1941
- /** ID of newly created subscription. Learn more about your site's [Subscriptions](https://support.wix.com/en/article/wix-stores-managing-product-subscriptions). */
2398
+ /**
2399
+ * ID of newly created subscription. Learn more about your site's [Subscriptions](https://support.wix.com/en/article/wix-stores-managing-product-subscriptions).
2400
+ * @format GUID
2401
+ */
1942
2402
  subscriptionId?: string;
1943
2403
  /**
1944
2404
  * Payment gateway order ID.
@@ -1954,9 +2414,15 @@ export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
1954
2414
  }
1955
2415
  /** @oneof */
1956
2416
  export interface CreateOrderResponseIdOneOf {
1957
- /** ID of newly created order. */
2417
+ /**
2418
+ * ID of newly created order.
2419
+ * @format GUID
2420
+ */
1958
2421
  orderId?: string;
1959
- /** ID of newly created subscription. Learn more about your site's [Subscriptions](https://support.wix.com/en/article/wix-stores-managing-product-subscriptions). */
2422
+ /**
2423
+ * ID of newly created subscription. Learn more about your site's [Subscriptions](https://support.wix.com/en/article/wix-stores-managing-product-subscriptions).
2424
+ * @format GUID
2425
+ */
1960
2426
  subscriptionId?: string;
1961
2427
  }
1962
2428
  export interface PaymentErrorResponseData {
@@ -1965,12 +2431,16 @@ export interface PaymentErrorResponseData {
1965
2431
  failureDetails?: string | null;
1966
2432
  }
1967
2433
  export interface DoublePaymentErrorData extends DoublePaymentErrorDataIdOneOf {
2434
+ /** @format GUID */
1968
2435
  orderId?: string;
2436
+ /** @format GUID */
1969
2437
  subscriptionId?: string;
1970
2438
  }
1971
2439
  /** @oneof */
1972
2440
  export interface DoublePaymentErrorDataIdOneOf {
2441
+ /** @format GUID */
1973
2442
  orderId?: string;
2443
+ /** @format GUID */
1974
2444
  subscriptionId?: string;
1975
2445
  }
1976
2446
  export interface RedeemErrorData {
@@ -1981,7 +2451,10 @@ export interface ViolationsList {
1981
2451
  violations?: Violation[];
1982
2452
  }
1983
2453
  export interface CreateOrderAndChargeRequest {
1984
- /** Checkout ID. */
2454
+ /**
2455
+ * Checkout ID.
2456
+ * @format GUID
2457
+ */
1985
2458
  id: string;
1986
2459
  /** Payment token. */
1987
2460
  paymentToken?: string | null;
@@ -1991,9 +2464,15 @@ export interface CreateOrderAndChargeRequest {
1991
2464
  delayCapture?: boolean;
1992
2465
  }
1993
2466
  export interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOneOf {
1994
- /** ID of newly created order. */
2467
+ /**
2468
+ * ID of newly created order.
2469
+ * @format GUID
2470
+ */
1995
2471
  orderId?: string;
1996
- /** ID of newly created subscription. */
2472
+ /**
2473
+ * ID of newly created subscription.
2474
+ * @format GUID
2475
+ */
1997
2476
  subscriptionId?: string;
1998
2477
  /** Payment response token. */
1999
2478
  paymentResponseToken?: string | null;
@@ -2008,13 +2487,38 @@ export interface CreateOrderAndChargeResponse extends CreateOrderAndChargeRespon
2008
2487
  }
2009
2488
  /** @oneof */
2010
2489
  export interface CreateOrderAndChargeResponseIdOneOf {
2011
- /** ID of newly created order. */
2490
+ /**
2491
+ * ID of newly created order.
2492
+ * @format GUID
2493
+ */
2012
2494
  orderId?: string;
2013
- /** ID of newly created subscription. */
2495
+ /**
2496
+ * ID of newly created subscription.
2497
+ * @format GUID
2498
+ */
2014
2499
  subscriptionId?: string;
2015
2500
  }
2501
+ export interface MarkCheckoutAsCompletedAndRedirectToUrlRequest {
2502
+ /**
2503
+ * Server-signed JWT token with required information to complete checkout
2504
+ * @maxLength 4096
2505
+ */
2506
+ token: string;
2507
+ }
2508
+ export interface RawHttpResponse {
2509
+ body?: Uint8Array;
2510
+ statusCode?: number | null;
2511
+ headers?: HeadersEntry[];
2512
+ }
2513
+ export interface HeadersEntry {
2514
+ key?: string;
2515
+ value?: string;
2516
+ }
2016
2517
  export interface MarkCheckoutAsCompletedRequest {
2017
- /** Checkout ID. */
2518
+ /**
2519
+ * Checkout ID.
2520
+ * @format GUID
2521
+ */
2018
2522
  id: string;
2019
2523
  }
2020
2524
  export interface MarkCheckoutAsCompletedResponse {
@@ -2024,13 +2528,23 @@ export interface CheckoutMarkedAsCompleted {
2024
2528
  checkout?: Checkout;
2025
2529
  }
2026
2530
  export interface UpdateLineItemsQuantityRequest {
2027
- /** Checkout ID. */
2531
+ /**
2532
+ * Checkout ID.
2533
+ * @format GUID
2534
+ */
2028
2535
  id: string;
2029
- /** Line item info to update. */
2536
+ /**
2537
+ * Line item info to update.
2538
+ * @minSize 1
2539
+ * @maxSize 100
2540
+ */
2030
2541
  lineItems: LineItemQuantityUpdate[];
2031
2542
  }
2032
2543
  export interface LineItemQuantityUpdate {
2033
- /** ID of the line item to update. */
2544
+ /**
2545
+ * ID of the line item to update.
2546
+ * @format GUID
2547
+ */
2034
2548
  id?: string;
2035
2549
  /**
2036
2550
  * New total amount of the line item,
@@ -2039,6 +2553,8 @@ export interface LineItemQuantityUpdate {
2039
2553
  * Min: `1`
2040
2554
  *
2041
2555
  * Max: `100000`
2556
+ * @min 1
2557
+ * @max 100000
2042
2558
  */
2043
2559
  quantity?: number;
2044
2560
  }
@@ -2047,7 +2563,10 @@ export interface UpdateLineItemsQuantityResponse {
2047
2563
  checkout?: Checkout;
2048
2564
  }
2049
2565
  export interface GetCheckoutPaymentSettingsRequest {
2050
- /** Checkout ID. */
2566
+ /**
2567
+ * Checkout ID.
2568
+ * @format GUID
2569
+ */
2051
2570
  id: string;
2052
2571
  }
2053
2572
  export interface GetCheckoutPaymentSettingsResponse {
@@ -2058,7 +2577,10 @@ export declare enum GetCheckoutPaymentSettingsResponsePaymentOption {
2058
2577
  MANUAL = "MANUAL"
2059
2578
  }
2060
2579
  export interface DeleteCheckoutRequest {
2061
- /** ID of the checkout to delete. */
2580
+ /**
2581
+ * ID of the checkout to delete.
2582
+ * @format GUID
2583
+ */
2062
2584
  id?: string;
2063
2585
  }
2064
2586
  export interface DeleteCheckoutResponse {
@@ -2072,20 +2594,33 @@ export interface Subscription {
2072
2594
  * @readonly
2073
2595
  */
2074
2596
  id?: string;
2075
- /** id of subscription in external system */
2597
+ /**
2598
+ * id of subscription in external system
2599
+ * @format GUID
2600
+ */
2076
2601
  externalId?: string | null;
2077
2602
  /**
2078
2603
  * Subscription creation date
2079
2604
  * @readonly
2080
2605
  */
2081
2606
  dateCreated?: Date | null;
2082
- /** The id of the cart this order was created from */
2607
+ /**
2608
+ * The id of the cart this order was created from
2609
+ * @format GUID
2610
+ */
2083
2611
  cartId?: string | null;
2084
- /** The id of the checkout this subscriptions was created from */
2612
+ /**
2613
+ * The id of the checkout this subscriptions was created from
2614
+ * @format GUID
2615
+ */
2085
2616
  checkoutId?: string | null;
2086
2617
  /** member or contact */
2087
2618
  buyerInfo?: V1BuyerInfo;
2088
- /** Line items ordered */
2619
+ /**
2620
+ * Line items ordered
2621
+ * @minSize 1
2622
+ * @maxSize 1
2623
+ */
2089
2624
  lineItems?: V1LineItem[];
2090
2625
  /** Totals for subscription's line items */
2091
2626
  totals?: Totals;
@@ -2097,7 +2632,10 @@ export interface Subscription {
2097
2632
  shippingInfo?: V1ShippingInfo;
2098
2633
  /** Coupon that was applied to subscription */
2099
2634
  appliedCoupon?: AppliedCoupon;
2100
- /** Message from the customer (e.g., customization request) */
2635
+ /**
2636
+ * Message from the customer (e.g., customization request)
2637
+ * @maxLength 1000
2638
+ */
2101
2639
  buyerNote?: string | null;
2102
2640
  /** Custom field */
2103
2641
  customField?: V1CustomField;
@@ -2115,7 +2653,10 @@ export interface Subscription {
2115
2653
  }
2116
2654
  /** Buyer Info */
2117
2655
  export interface V1BuyerInfo {
2118
- /** Wix customer ID */
2656
+ /**
2657
+ * Wix customer ID
2658
+ * @format GUID
2659
+ */
2119
2660
  id?: string;
2120
2661
  /** Customer type */
2121
2662
  identityType?: IdentityType;
@@ -2130,13 +2671,26 @@ export declare enum IdentityType {
2130
2671
  export interface V1LineItem {
2131
2672
  /** Line item ID (auto-generated) */
2132
2673
  index?: number;
2133
- /** Line item quantity */
2674
+ /**
2675
+ * Line item quantity
2676
+ * @min 1
2677
+ * @max 100000
2678
+ */
2134
2679
  quantity?: number;
2135
- /** Line item variantId (from Stores Catalog) */
2680
+ /**
2681
+ * Line item variantId (from Stores Catalog)
2682
+ * @format GUID
2683
+ */
2136
2684
  variantId?: string | null;
2137
- /** Line item options ordered */
2685
+ /**
2686
+ * Line item options ordered
2687
+ * @maxSize 6
2688
+ */
2138
2689
  options?: OptionSelection[];
2139
- /** Line item custom text field selections */
2690
+ /**
2691
+ * Line item custom text field selections
2692
+ * @maxSize 20
2693
+ */
2140
2694
  customTextFields?: CustomTextFieldSelection[];
2141
2695
  /** Charges details */
2142
2696
  chargeDetails?: ChargeDetails;
@@ -2144,53 +2698,109 @@ export interface V1LineItem {
2144
2698
  productDetails?: ProductDetails;
2145
2699
  }
2146
2700
  export interface OptionSelection {
2147
- /** Option name */
2701
+ /**
2702
+ * Option name
2703
+ * @maxLength 200
2704
+ */
2148
2705
  option?: string;
2149
- /** Selected choice for this option */
2706
+ /**
2707
+ * Selected choice for this option
2708
+ * @maxLength 500
2709
+ */
2150
2710
  selection?: string;
2151
2711
  }
2152
2712
  export interface CustomTextFieldSelection {
2153
- /** Custom text field name */
2713
+ /**
2714
+ * Custom text field name
2715
+ * @maxLength 100
2716
+ */
2154
2717
  title?: string;
2155
- /** Custom text field value */
2718
+ /**
2719
+ * Custom text field value
2720
+ * @maxLength 500
2721
+ */
2156
2722
  value?: string;
2157
2723
  }
2158
2724
  export interface ChargeDetails {
2159
- /** price of line item (depends on subscription option) */
2725
+ /**
2726
+ * price of line item (depends on subscription option)
2727
+ * @max 999999999.99
2728
+ */
2160
2729
  price?: number;
2161
- /** Total price charged to the customer (for this line items) after computation of quantity and discount */
2730
+ /**
2731
+ * Total price charged to the customer (for this line items) after computation of quantity and discount
2732
+ * @max 999999999.99
2733
+ */
2162
2734
  totalPrice?: number | null;
2163
- /** Discount applied for this line item */
2735
+ /**
2736
+ * Discount applied for this line item
2737
+ * @max 999999999.99
2738
+ */
2164
2739
  discount?: number | null;
2165
- /** Tax applied for this line item */
2740
+ /**
2741
+ * Tax applied for this line item
2742
+ * @max 999999999.99
2743
+ */
2166
2744
  tax?: number | null;
2167
2745
  /** Is tax applied for this line item */
2168
2746
  taxIncludedInPrice?: boolean;
2169
- /** Tax rate %, as a decimal point >= 0 */
2747
+ /**
2748
+ * Tax rate %, as a decimal point >= 0
2749
+ * @decimalValue options { maxScale:6, gte:0 }
2750
+ */
2170
2751
  taxRate?: string | null;
2171
2752
  }
2172
2753
  export interface ProductDetails {
2173
- /** Line item product ID (optional for POS orders) */
2754
+ /**
2755
+ * Line item product ID (optional for POS orders)
2756
+ * @minLength 1
2757
+ */
2174
2758
  productId?: string | null;
2175
- /** Line item name */
2759
+ /**
2760
+ * Line item name
2761
+ * @minLength 1
2762
+ * @maxLength 100
2763
+ */
2176
2764
  name?: string;
2177
- /** Line item name translated to buyer's language */
2765
+ /**
2766
+ * Line item name translated to buyer's language
2767
+ * @minLength 1
2768
+ * @maxLength 100
2769
+ */
2178
2770
  translatedName?: string | null;
2179
2771
  /** Line item type (may be extended) */
2180
2772
  lineItemType?: LineItemType;
2181
2773
  /** Line item primary media for preview */
2182
2774
  mediaItem?: MediaItem;
2183
- /** Line item SKU */
2775
+ /**
2776
+ * Line item SKU
2777
+ * @maxLength 40
2778
+ */
2184
2779
  sku?: string | null;
2185
- /** Line item weight */
2780
+ /**
2781
+ * Line item weight
2782
+ * @max 999999999.99
2783
+ */
2186
2784
  weight?: number | null;
2187
- /** Line item notes */
2785
+ /**
2786
+ * Line item notes
2787
+ * @maxLength 1000
2788
+ */
2188
2789
  notes?: string | null;
2189
- /** Line item fulfillerId from stores fulfillers. No value means self fulfilled */
2790
+ /**
2791
+ * Line item fulfillerId from stores fulfillers. No value means self fulfilled
2792
+ * @format GUID
2793
+ */
2190
2794
  fulfillerId?: string | null;
2191
- /** Tax group id */
2795
+ /**
2796
+ * Tax group id
2797
+ * @format GUID
2798
+ */
2192
2799
  taxGroupId?: string | null;
2193
- /** App id from the catalog reference */
2800
+ /**
2801
+ * App id from the catalog reference
2802
+ * @format GUID
2803
+ */
2194
2804
  appId?: string | null;
2195
2805
  }
2196
2806
  export declare enum LineItemType {
@@ -2211,16 +2821,19 @@ export interface MediaItem {
2211
2821
  mediaType?: MediaItemType;
2212
2822
  /**
2213
2823
  * Media URL
2824
+ * @format WEB_URL
2214
2825
  * @readonly
2215
2826
  */
2216
2827
  url?: string;
2217
2828
  /**
2218
2829
  * Media item width
2830
+ * @max 5000
2219
2831
  * @readonly
2220
2832
  */
2221
2833
  width?: number;
2222
2834
  /**
2223
2835
  * Media item height
2836
+ * @max 5000
2224
2837
  * @readonly
2225
2838
  */
2226
2839
  height?: number;
@@ -2228,7 +2841,10 @@ export interface MediaItem {
2228
2841
  id?: string | null;
2229
2842
  /** Media external URL */
2230
2843
  externalImageUrl?: string | null;
2231
- /** Alternative text for presentation when media cannot be displayed */
2844
+ /**
2845
+ * Alternative text for presentation when media cannot be displayed
2846
+ * @maxLength 256
2847
+ */
2232
2848
  altText?: string | null;
2233
2849
  }
2234
2850
  export declare enum MediaItemType {
@@ -2238,17 +2854,35 @@ export declare enum MediaItemType {
2238
2854
  IMAGE = "IMAGE"
2239
2855
  }
2240
2856
  export interface Totals {
2241
- /** Subtotal of all line items, before tax */
2857
+ /**
2858
+ * Subtotal of all line items, before tax
2859
+ * @max 999999999.99
2860
+ */
2242
2861
  subtotal?: number;
2243
- /** Total shipping price, including tax */
2862
+ /**
2863
+ * Total shipping price, including tax
2864
+ * @max 999999999.99
2865
+ */
2244
2866
  shipping?: number;
2245
- /** Total tax */
2867
+ /**
2868
+ * Total tax
2869
+ * @max 999999999.99
2870
+ */
2246
2871
  tax?: number;
2247
- /** Total calculated discount value */
2872
+ /**
2873
+ * Total calculated discount value
2874
+ * @max 999999999.99
2875
+ */
2248
2876
  discount?: number;
2249
- /** Total price */
2877
+ /**
2878
+ * Total price
2879
+ * @max 999999999.99
2880
+ */
2250
2881
  total?: number;
2251
- /** Total weight */
2882
+ /**
2883
+ * Total weight
2884
+ * @max 999999999.99
2885
+ */
2252
2886
  weight?: number | null;
2253
2887
  /**
2254
2888
  * Total line items quantity
@@ -2257,7 +2891,11 @@ export interface Totals {
2257
2891
  quantity?: number;
2258
2892
  }
2259
2893
  export interface StoreSettings {
2260
- /** Currency used for pricing in this store */
2894
+ /**
2895
+ * Currency used for pricing in this store
2896
+ * @maxLength 3
2897
+ * @format CURRENCY
2898
+ */
2261
2899
  currency?: string | null;
2262
2900
  /** Weight unit used in this store */
2263
2901
  weightUnit?: WeightUnit;
@@ -2265,56 +2903,103 @@ export interface StoreSettings {
2265
2903
  * The language to be used when communicating with the buyer
2266
2904
  * For a site that support multiple languages, this would be the language the buyer selected
2267
2905
  * Otherwise this would be the site language
2906
+ * @minLength 2
2907
+ * @maxLength 2
2268
2908
  */
2269
2909
  buyerLanguage?: string | null;
2270
2910
  }
2271
2911
  export interface Address extends AddressAddressLine1OptionsOneOf {
2272
- /** Address line 1 (free text) */
2912
+ /**
2913
+ * Address line 1 (free text)
2914
+ * @maxLength 1000
2915
+ */
2273
2916
  addressLine1?: string;
2274
2917
  /** Address line 1 (street) */
2275
2918
  street?: Street;
2276
2919
  /** Addressee name */
2277
2920
  fullName?: FullName;
2278
- /** Country code (2 letters) */
2921
+ /**
2922
+ * Country code (2 letters)
2923
+ * @format COUNTRY
2924
+ */
2279
2925
  country?: string | null;
2280
- /** State or district */
2926
+ /**
2927
+ * State or district
2928
+ * @maxLength 50
2929
+ */
2281
2930
  subdivision?: string | null;
2282
- /** City name */
2931
+ /**
2932
+ * City name
2933
+ * @maxLength 150
2934
+ */
2283
2935
  city?: string | null;
2284
- /** ZIP/postal code */
2936
+ /**
2937
+ * ZIP/postal code
2938
+ * @maxLength 200
2939
+ */
2285
2940
  zipCode?: string | null;
2286
- /** Phone number */
2941
+ /**
2942
+ * Phone number
2943
+ * @maxLength 200
2944
+ */
2287
2945
  phone?: string | null;
2288
- /** Company name */
2946
+ /**
2947
+ * Company name
2948
+ * @maxLength 500
2949
+ */
2289
2950
  company?: string | null;
2290
- /** Email address */
2951
+ /**
2952
+ * Email address
2953
+ * @maxLength 500
2954
+ */
2291
2955
  email?: string | null;
2292
- /** address line */
2956
+ /**
2957
+ * address line
2958
+ * @maxLength 250
2959
+ */
2293
2960
  addressLine2?: string | null;
2294
2961
  /** Tax information (for Brazil only) */
2295
2962
  vatId?: VatId;
2296
2963
  }
2297
2964
  /** @oneof */
2298
2965
  export interface AddressAddressLine1OptionsOneOf {
2299
- /** Address line 1 (free text) */
2966
+ /**
2967
+ * Address line 1 (free text)
2968
+ * @maxLength 1000
2969
+ */
2300
2970
  addressLine1?: string;
2301
2971
  /** Address line 1 (street) */
2302
2972
  street?: Street;
2303
2973
  }
2304
2974
  export interface FullName {
2305
- /** Customer's first name */
2975
+ /**
2976
+ * Customer's first name
2977
+ * @maxLength 1000
2978
+ */
2306
2979
  firstName?: string;
2307
- /** Customer's last name */
2980
+ /**
2981
+ * Customer's last name
2982
+ * @maxLength 1000
2983
+ */
2308
2984
  lastName?: string;
2309
2985
  }
2310
2986
  export interface Street {
2311
- /** Street number */
2987
+ /**
2988
+ * Street number
2989
+ * @maxLength 500
2990
+ */
2312
2991
  number?: string;
2313
- /** Street name */
2992
+ /**
2993
+ * Street name
2994
+ * @maxLength 1000
2995
+ */
2314
2996
  name?: string;
2315
2997
  }
2316
2998
  export interface VatId {
2317
- /** Customer's tax ID. */
2999
+ /**
3000
+ * Customer's tax ID.
3001
+ * @maxLength 50
3002
+ */
2318
3003
  number?: string;
2319
3004
  /**
2320
3005
  * Tax type.
@@ -2337,9 +3022,15 @@ export interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
2337
3022
  shipmentDetails?: ShipmentDetails;
2338
3023
  /** Pickup details (when this object describes pickup) */
2339
3024
  pickupDetails?: V1PickupDetails;
2340
- /** Delivery option name */
3025
+ /**
3026
+ * Delivery option name
3027
+ * @maxLength 250
3028
+ */
2341
3029
  deliveryOption?: string;
2342
- /** Delivery option delivery time */
3030
+ /**
3031
+ * Delivery option delivery time
3032
+ * @maxLength 500
3033
+ */
2343
3034
  estimatedDeliveryTime?: string | null;
2344
3035
  }
2345
3036
  /** @oneof */
@@ -2352,53 +3043,101 @@ export interface V1ShippingInfoDetailsOneOf {
2352
3043
  export interface ShipmentDetails {
2353
3044
  /** Shipping destination address */
2354
3045
  address?: Address;
2355
- /** Discount applied for shipping */
3046
+ /**
3047
+ * Discount applied for shipping
3048
+ * @max 999999999.99
3049
+ */
2356
3050
  discount?: number | null;
2357
- /** Tax applied for shipping */
3051
+ /**
3052
+ * Tax applied for shipping
3053
+ * @max 999999999.99
3054
+ */
2358
3055
  tax?: number | null;
2359
3056
  /** Whether tax is included in the price */
2360
3057
  taxIncludedInPrice?: boolean;
2361
- /** Tax rate % for shipping, as a decimal point >= 0 */
3058
+ /**
3059
+ * Tax rate % for shipping, as a decimal point >= 0
3060
+ * @decimalValue options { maxScale:6, gte:0 }
3061
+ */
2362
3062
  taxRate?: string | null;
2363
3063
  }
2364
3064
  export interface V1PickupDetails {
2365
3065
  /** Pickup address */
2366
3066
  address?: PickupAddress;
2367
- /** Store owner's pickup instructions */
3067
+ /**
3068
+ * Store owner's pickup instructions
3069
+ * @maxLength 1000
3070
+ */
2368
3071
  pickupInstructions?: string | null;
2369
3072
  }
2370
3073
  export interface PickupAddress {
2371
- /** Country code (2 letters) */
3074
+ /**
3075
+ * Country code (2 letters)
3076
+ * @format COUNTRY
3077
+ */
2372
3078
  country?: string;
2373
- /** State/District */
3079
+ /**
3080
+ * State/District
3081
+ * @maxLength 50
3082
+ */
2374
3083
  subdivision?: string | null;
2375
- /** Address */
3084
+ /**
3085
+ * Address
3086
+ * @maxLength 200
3087
+ */
2376
3088
  addressLine?: string;
2377
- /** City */
3089
+ /**
3090
+ * City
3091
+ * @maxLength 85
3092
+ */
2378
3093
  city?: string;
2379
- /** ZIP/postal code */
3094
+ /**
3095
+ * ZIP/postal code
3096
+ * @maxLength 50
3097
+ */
2380
3098
  zipCode?: string;
2381
3099
  }
2382
3100
  export interface AppliedCoupon {
2383
3101
  /** Coupon ID */
2384
3102
  couponId?: string;
2385
- /** Coupon name */
3103
+ /**
3104
+ * Coupon name
3105
+ * @maxLength 100
3106
+ */
2386
3107
  name?: string;
2387
- /** Coupon code */
3108
+ /**
3109
+ * Coupon code
3110
+ * @maxLength 100
3111
+ */
2388
3112
  code?: string;
2389
3113
  }
2390
3114
  /** Custom field */
2391
3115
  export interface V1CustomField {
2392
- /** Free text that the customer entered in the custom field during the checkout process */
3116
+ /**
3117
+ * Free text that the customer entered in the custom field during the checkout process
3118
+ * @maxLength 250
3119
+ */
2393
3120
  value?: string;
2394
- /** Title for the custom field */
3121
+ /**
3122
+ * Title for the custom field
3123
+ * @maxLength 200
3124
+ */
2395
3125
  title?: string;
2396
- /** The title translated according to the buyer language */
3126
+ /**
3127
+ * The title translated according to the buyer language
3128
+ * @maxLength 200
3129
+ */
2397
3130
  translatedTitle?: string;
2398
3131
  }
2399
3132
  export interface V1SubscriptionOptionInfo {
3133
+ /** @format GUID */
2400
3134
  id?: string | null;
3135
+ /**
3136
+ * @minLength 1
3137
+ * @maxLength 20
3138
+ */
2401
3139
  title?: string;
3140
+ /** @maxLength 60 */
2402
3141
  description?: string | null;
2403
3142
  discount?: Discount;
2404
3143
  }
@@ -2429,15 +3168,28 @@ export interface V1SubscriptionSettings {
2429
3168
  frequency?: SubscriptionFrequency;
2430
3169
  /** Whether subscription is renewed automatically at the end of each period. */
2431
3170
  autoRenewal?: boolean;
2432
- /** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */
3171
+ /**
3172
+ * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
3173
+ * @min 2
3174
+ * @max 999
3175
+ */
2433
3176
  billingCycles?: number | null;
2434
3177
  }
2435
3178
  export interface BillingInfo {
2436
- /** Payment method used for this order */
3179
+ /**
3180
+ * Payment method used for this order
3181
+ * @maxLength 50
3182
+ */
2437
3183
  paymentMethod?: string | null;
2438
- /** Transaction ID from payment gateway (e.g., Wix Payments) */
3184
+ /**
3185
+ * Transaction ID from payment gateway (e.g., Wix Payments)
3186
+ * @maxLength 100
3187
+ */
2439
3188
  paymentGatewayTransactionId?: string | null;
2440
- /** Order ID from payment gateway (e.g., Wix Payments) */
3189
+ /**
3190
+ * Order ID from payment gateway (e.g., Wix Payments)
3191
+ * @maxLength 100
3192
+ */
2441
3193
  paymentGatewayOrderId?: string | null;
2442
3194
  }
2443
3195
  export interface Empty {
@@ -2515,9 +3267,15 @@ export interface ActionEvent {
2515
3267
  bodyAsJson?: string;
2516
3268
  }
2517
3269
  export interface MessageEnvelope {
2518
- /** App instance ID. */
3270
+ /**
3271
+ * App instance ID.
3272
+ * @format GUID
3273
+ */
2519
3274
  instanceId?: string | null;
2520
- /** Event type. */
3275
+ /**
3276
+ * Event type.
3277
+ * @maxLength 150
3278
+ */
2521
3279
  eventType?: string;
2522
3280
  /** The identification type and identity data. */
2523
3281
  identity?: IdentificationData;
@@ -2525,26 +3283,50 @@ export interface MessageEnvelope {
2525
3283
  data?: string;
2526
3284
  }
2527
3285
  export interface IdentificationData extends IdentificationDataIdOneOf {
2528
- /** ID of a site visitor that has not logged in to the site. */
3286
+ /**
3287
+ * ID of a site visitor that has not logged in to the site.
3288
+ * @format GUID
3289
+ */
2529
3290
  anonymousVisitorId?: string;
2530
- /** ID of a site visitor that has logged in to the site. */
3291
+ /**
3292
+ * ID of a site visitor that has logged in to the site.
3293
+ * @format GUID
3294
+ */
2531
3295
  memberId?: string;
2532
- /** ID of a Wix user (site owner, contributor, etc.). */
3296
+ /**
3297
+ * ID of a Wix user (site owner, contributor, etc.).
3298
+ * @format GUID
3299
+ */
2533
3300
  wixUserId?: string;
2534
- /** ID of an app. */
3301
+ /**
3302
+ * ID of an app.
3303
+ * @format GUID
3304
+ */
2535
3305
  appId?: string;
2536
3306
  /** @readonly */
2537
3307
  identityType?: WebhookIdentityType;
2538
3308
  }
2539
3309
  /** @oneof */
2540
3310
  export interface IdentificationDataIdOneOf {
2541
- /** ID of a site visitor that has not logged in to the site. */
3311
+ /**
3312
+ * ID of a site visitor that has not logged in to the site.
3313
+ * @format GUID
3314
+ */
2542
3315
  anonymousVisitorId?: string;
2543
- /** ID of a site visitor that has logged in to the site. */
3316
+ /**
3317
+ * ID of a site visitor that has logged in to the site.
3318
+ * @format GUID
3319
+ */
2544
3320
  memberId?: string;
2545
- /** ID of a Wix user (site owner, contributor, etc.). */
3321
+ /**
3322
+ * ID of a Wix user (site owner, contributor, etc.).
3323
+ * @format GUID
3324
+ */
2546
3325
  wixUserId?: string;
2547
- /** ID of an app. */
3326
+ /**
3327
+ * ID of an app.
3328
+ * @format GUID
3329
+ */
2548
3330
  appId?: string;
2549
3331
  }
2550
3332
  export declare enum WebhookIdentityType {
@@ -3042,6 +3824,14 @@ export interface CreateOrderAndChargeResponseNonNullableFields {
3042
3824
  orderId: string;
3043
3825
  subscriptionId: string;
3044
3826
  }
3827
+ interface HeadersEntryNonNullableFields {
3828
+ key: string;
3829
+ value: string;
3830
+ }
3831
+ export interface RawHttpResponseNonNullableFields {
3832
+ body: Uint8Array;
3833
+ headers: HeadersEntryNonNullableFields[];
3834
+ }
3045
3835
  export interface UpdateLineItemsQuantityResponseNonNullableFields {
3046
3836
  checkout?: CheckoutNonNullableFields;
3047
3837
  }