@wix/auto_sdk_ecom_checkout 1.0.2 → 1.0.4

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 (45) 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.http.js +12 -0
  3. package/build/cjs/src/ecom-v1-checkout-checkout.http.js.map +1 -1
  4. package/build/cjs/src/ecom-v1-checkout-checkout.public.d.ts +1 -1
  5. package/build/cjs/src/ecom-v1-checkout-checkout.public.js +5 -0
  6. package/build/cjs/src/ecom-v1-checkout-checkout.public.js.map +1 -1
  7. package/build/cjs/src/ecom-v1-checkout-checkout.types.d.ts +999 -228
  8. package/build/cjs/src/ecom-v1-checkout-checkout.types.js.map +1 -1
  9. package/build/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +1065 -248
  10. package/build/cjs/src/ecom-v1-checkout-checkout.universal.js +9 -4
  11. package/build/cjs/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
  12. package/build/es/src/ecom-v1-checkout-checkout.context.d.ts +1 -1
  13. package/build/es/src/ecom-v1-checkout-checkout.http.js +12 -0
  14. package/build/es/src/ecom-v1-checkout-checkout.http.js.map +1 -1
  15. package/build/es/src/ecom-v1-checkout-checkout.public.d.ts +1 -1
  16. package/build/es/src/ecom-v1-checkout-checkout.public.js +5 -0
  17. package/build/es/src/ecom-v1-checkout-checkout.public.js.map +1 -1
  18. package/build/es/src/ecom-v1-checkout-checkout.types.d.ts +999 -228
  19. package/build/es/src/ecom-v1-checkout-checkout.types.js.map +1 -1
  20. package/build/es/src/ecom-v1-checkout-checkout.universal.d.ts +1065 -248
  21. package/build/es/src/ecom-v1-checkout-checkout.universal.js +9 -4
  22. package/build/es/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
  23. package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.d.ts +1 -1
  24. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js +12 -0
  25. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js.map +1 -1
  26. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.d.ts +1 -1
  27. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js +5 -0
  28. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js.map +1 -1
  29. package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.d.ts +1009 -228
  30. package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.js.map +1 -1
  31. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +1089 -255
  32. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js +9 -4
  33. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
  34. package/build/internal/es/src/ecom-v1-checkout-checkout.context.d.ts +1 -1
  35. package/build/internal/es/src/ecom-v1-checkout-checkout.http.js +12 -0
  36. package/build/internal/es/src/ecom-v1-checkout-checkout.http.js.map +1 -1
  37. package/build/internal/es/src/ecom-v1-checkout-checkout.public.d.ts +1 -1
  38. package/build/internal/es/src/ecom-v1-checkout-checkout.public.js +5 -0
  39. package/build/internal/es/src/ecom-v1-checkout-checkout.public.js.map +1 -1
  40. package/build/internal/es/src/ecom-v1-checkout-checkout.types.d.ts +1009 -228
  41. package/build/internal/es/src/ecom-v1-checkout-checkout.types.js.map +1 -1
  42. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.d.ts +1089 -255
  43. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js +9 -4
  44. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js.map +1 -1
  45. 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
  /**
@@ -152,10 +168,17 @@ export interface Checkout {
152
168
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
153
169
  */
154
170
  customContentReference?: CustomContentReference;
171
+ /**
172
+ * The business location ID associated with the checkout.
173
+ * Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
174
+ * @format GUID
175
+ */
176
+ businessLocationId?: string | null;
155
177
  }
156
178
  export interface LineItem {
157
179
  /**
158
180
  * Line item ID.
181
+ * @format GUID
159
182
  * @readonly
160
183
  */
161
184
  id?: string | null;
@@ -164,6 +187,8 @@ export interface LineItem {
164
187
  *
165
188
  * Min: `"1"`
166
189
  * Max: `"100000"`
190
+ * @min 1
191
+ * @max 100000
167
192
  */
168
193
  quantity?: number;
169
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. */
@@ -252,12 +277,9 @@ export interface LineItem {
252
277
  */
253
278
  subscriptionOptionInfo?: SubscriptionOptionInfo;
254
279
  /**
255
- * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
256
- * + `FULL_PAYMENT_ONLINE`: The entire payment for this item happens as part of the checkout.
257
- * + `FULL_PAYMENT_OFFLINE`: The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
258
- * + `MEMBERSHIP`: Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is `0`.
259
- * + `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`.
260
- * + `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`
261
283
  * @readonly
262
284
  */
263
285
  paymentOption?: PaymentOptionType;
@@ -271,6 +293,8 @@ export interface LineItem {
271
293
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
272
294
  * + In most cases, this field has the same value as `catalogReference.catalogItemId`.
273
295
  * + Used in membership validation.
296
+ * @minLength 1
297
+ * @maxLength 36
274
298
  * @readonly
275
299
  */
276
300
  rootCatalogItemId?: string | null;
@@ -284,6 +308,12 @@ export interface LineItem {
284
308
  * @readonly
285
309
  */
286
310
  depositAmount?: MultiCurrencyPrice;
311
+ /**
312
+ * Delivery profile ID.
313
+ * @format GUID
314
+ * @readonly
315
+ */
316
+ deliveryProfileId?: string | null;
287
317
  /**
288
318
  * Whether the line item is a custom line item. Custom line items don't trigger the Catalog service plugin.
289
319
  * @readonly
@@ -291,6 +321,8 @@ export interface LineItem {
291
321
  customLineItem?: boolean;
292
322
  /**
293
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
294
326
  * @readonly
295
327
  */
296
328
  consentRequiredPaymentPolicy?: string | null;
@@ -311,7 +343,11 @@ export interface LineItem {
311
343
  }
312
344
  /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
313
345
  export interface CatalogReference {
314
- /** 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
+ */
315
351
  catalogItemId?: string;
316
352
  /**
317
353
  * ID of the app providing the catalog.
@@ -322,6 +358,7 @@ export interface CatalogReference {
322
358
  * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
323
359
  * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
324
360
  * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
361
+ * @minLength 1
325
362
  */
326
363
  appId?: string;
327
364
  /**
@@ -337,6 +374,8 @@ export interface ProductName {
337
374
  *
338
375
  * Min: 1 character.
339
376
  * Max: 200 characters.
377
+ * @minLength 1
378
+ * @maxLength 200
340
379
  */
341
380
  original?: string;
342
381
  /**
@@ -345,6 +384,8 @@ export interface ProductName {
345
384
  * Min: 1 character.
346
385
  * Max: 400 characters.
347
386
  * Default: Same as `original`.
387
+ * @minLength 1
388
+ * @maxLength 400
348
389
  */
349
390
  translated?: string | null;
350
391
  }
@@ -355,11 +396,15 @@ export interface PageUrlV2 {
355
396
  url?: string | null;
356
397
  }
357
398
  export interface MultiCurrencyPrice {
358
- /** Amount. */
399
+ /**
400
+ * Amount.
401
+ * @decimalValue options { gte:0, lte:1000000000000000 }
402
+ */
359
403
  amount?: string;
360
404
  /**
361
405
  * Converted amount.
362
406
  * @readonly
407
+ * @decimalValue options { gte:0, lte:1000000000000000 }
363
408
  */
364
409
  convertedAmount?: string;
365
410
  /**
@@ -376,7 +421,10 @@ export interface MultiCurrencyPrice {
376
421
  export interface ItemTaxFullDetails {
377
422
  /** Amount for which tax is calculated. */
378
423
  taxableAmount?: MultiCurrencyPrice;
379
- /** 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
+ */
380
428
  taxRate?: string;
381
429
  /** Calculated tax, based on `taxable_amount` and `tax_rate`. */
382
430
  totalTax?: MultiCurrencyPrice;
@@ -388,9 +436,15 @@ export interface ItemTaxFullDetails {
388
436
  rateBreakdown?: TaxRateBreakdown[];
389
437
  }
390
438
  export interface TaxRateBreakdown {
391
- /** Name of tax against which the calculation was performed. */
439
+ /**
440
+ * Name of tax against which the calculation was performed.
441
+ * @maxLength 100
442
+ */
392
443
  name?: string;
393
- /** 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
+ */
394
448
  rate?: string;
395
449
  /** Amount of tax for this tax detail. */
396
450
  tax?: MultiCurrencyPrice;
@@ -400,21 +454,31 @@ export interface TaxRateBreakdown {
400
454
  * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
401
455
  */
402
456
  export interface TaxBreakdown {
403
- /** 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
+ */
404
461
  jurisdiction?: string | null;
405
462
  /** The amount of this line item price that was considered nontaxable. (Decimal value) */
406
463
  nonTaxableAmount?: MultiCurrencyPrice;
407
- /** 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
+ */
408
468
  rate?: string | null;
409
469
  /** The amount of tax estimated for this line item. (Decimal value) */
410
470
  taxAmount?: MultiCurrencyPrice;
411
471
  /** The taxable amount of this line item. */
412
472
  taxableAmount?: MultiCurrencyPrice;
413
- /** 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
+ */
414
477
  taxType?: string | null;
415
478
  /**
416
479
  * The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
417
480
  * This name should be explicit enough to allow the merchant to understand what tax was calculated.
481
+ * @maxLength 200
418
482
  */
419
483
  taxName?: string | null;
420
484
  /** The type of the jurisdiction in which this tax detail applies. */
@@ -448,32 +512,44 @@ export interface DescriptionLineValueOneOf {
448
512
  export interface DescriptionLineDescriptionLineValueOneOf {
449
513
  }
450
514
  export interface DescriptionLineName {
451
- /** 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
+ */
452
519
  original?: string;
453
520
  /**
454
521
  * Description line name translated into the buyer's language.
455
522
  *
456
523
  * Default: Same as `original`.
524
+ * @maxLength 200
457
525
  */
458
526
  translated?: string | null;
459
527
  }
460
528
  export interface PlainTextValue {
461
- /** 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
+ */
462
533
  original?: string;
463
534
  /**
464
535
  * Description line plain text value translated into the buyer's language.
465
536
  *
466
537
  * Default: Same as `original`.
538
+ * @maxLength 600
467
539
  */
468
540
  translated?: string | null;
469
541
  }
470
542
  export interface Color {
471
- /** 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
+ */
472
547
  original?: string;
473
548
  /**
474
549
  * Description line color name translated into the buyer's language.
475
550
  *
476
551
  * Default: Same as `original`.
552
+ * @maxLength 500
477
553
  */
478
554
  translated?: string | null;
479
555
  /** HEX or RGB color code for display. */
@@ -538,7 +614,10 @@ export declare enum ItemAvailabilityStatus {
538
614
  export interface PhysicalProperties {
539
615
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
540
616
  weight?: number | null;
541
- /** 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
+ */
542
621
  sku?: string | null;
543
622
  /** Whether this line item is shippable. */
544
623
  shippable?: boolean;
@@ -591,11 +670,16 @@ export interface SubscriptionSettings {
591
670
  *
592
671
  * Default: `1`.
593
672
  * If SubscriptionFrequency is Day the minimum interval is 7
673
+ * @min 1
674
+ * @max 50
594
675
  */
595
676
  interval?: number | null;
596
677
  /** Whether subscription is renewed automatically at the end of each period. */
597
678
  autoRenewal?: boolean;
598
- /** 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
+ */
599
683
  billingCycles?: number | null;
600
684
  }
601
685
  /** Frequency unit of recurring payment */
@@ -609,29 +693,53 @@ export declare enum SubscriptionFrequency {
609
693
  export interface FreeTrialPeriod {
610
694
  /** Frequency of priod. Values: DAY, WEEK, MONTH, YEAR */
611
695
  frequency?: SubscriptionFrequency;
612
- /** interval of period */
696
+ /**
697
+ * interval of period
698
+ * @min 1
699
+ * @max 50
700
+ */
613
701
  interval?: number;
614
702
  }
615
703
  export interface Title {
616
- /** 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
+ */
617
709
  original?: string;
618
710
  /**
619
711
  * Subscription option name translated into the buyer's language.
620
712
  *
621
713
  * Default: Same as `original`.
714
+ * @minLength 1
715
+ * @maxLength 150
622
716
  */
623
717
  translated?: string | null;
624
718
  }
625
719
  export interface Description {
626
- /** Subscription option description. */
720
+ /**
721
+ * Subscription option description.
722
+ * @maxLength 500
723
+ */
627
724
  original?: string;
628
- /** Translated subscription option description. */
725
+ /**
726
+ * Translated subscription option description.
727
+ * @maxLength 500
728
+ */
629
729
  translated?: string | null;
630
730
  }
631
731
  export interface SecuredMedia {
632
- /** Media ID in Wix Media Manager. */
732
+ /**
733
+ * Media ID in Wix Media Manager.
734
+ * @minLength 1
735
+ * @maxLength 100
736
+ */
633
737
  id?: string;
634
- /** Original filename. */
738
+ /**
739
+ * Original filename.
740
+ * @minLength 1
741
+ * @maxLength 1000
742
+ */
635
743
  fileName?: string;
636
744
  /** File type. */
637
745
  fileType?: FileType;
@@ -663,27 +771,46 @@ export interface ServiceProperties {
663
771
  * For example, the start time of a class.
664
772
  */
665
773
  scheduledDate?: Date | null;
666
- /** 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
+ */
667
779
  numberOfParticipants?: number | null;
668
780
  }
669
781
  export interface PriceDescription {
670
- /** __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
+ */
671
787
  original?: string;
672
788
  /**
673
789
  * Price description translated into the buyer's language.
674
790
  *
675
791
  * Default: Same as `original`.
792
+ * @minLength 1
793
+ * @maxLength 100
676
794
  */
677
795
  translated?: string | null;
678
796
  }
679
797
  export interface CatalogOverrideFields {
680
798
  /** Item name. */
681
799
  productName?: ProductName;
682
- /** Item price **after** discounts. */
800
+ /**
801
+ * Item price **after** discounts.
802
+ * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
803
+ */
683
804
  price?: string | null;
684
- /** Item price **before** discounts. */
805
+ /**
806
+ * Item price **before** discounts.
807
+ * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
808
+ */
685
809
  fullPrice?: string | null;
686
- /** 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
+ */
687
814
  descriptionLines?: DescriptionLine[];
688
815
  /** Physical properties of the item. */
689
816
  physicalProperties?: PhysicalProperties;
@@ -691,7 +818,11 @@ export interface CatalogOverrideFields {
691
818
  image?: Image;
692
819
  /** Payment method selected for the item. */
693
820
  paymentOption?: PaymentOption;
694
- /** 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
+ */
695
826
  depositAmount?: string | null;
696
827
  /**
697
828
  * Whether to save the payment method on the order.
@@ -714,11 +845,9 @@ export interface Image {
714
845
  }
715
846
  export interface PaymentOption {
716
847
  /**
717
- * + `FULL_PAYMENT_ONLINE`: The entire payment for this item happens as part of the checkout.
718
- * + `FULL_PAYMENT_OFFLINE`: The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
719
- * + `MEMBERSHIP`: Payment for this item is done by charging a membership. When selected, `price` is `0`.
720
- * + `DEPOSIT_ONLINE`: Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`.
721
- * + `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`
722
851
  */
723
852
  value?: PaymentOptionType;
724
853
  }
@@ -749,9 +878,17 @@ export interface ExtendedFields {
749
878
  namespaces?: Record<string, Record<string, any>>;
750
879
  }
751
880
  export interface Policy {
752
- /** Policy title - should be translated */
881
+ /**
882
+ * Policy title - should be translated
883
+ * @minLength 1
884
+ * @maxLength 29
885
+ */
753
886
  title?: string | null;
754
- /** Policy content - should be translated */
887
+ /**
888
+ * Policy content - should be translated
889
+ * @minLength 1
890
+ * @maxLength 3000
891
+ */
755
892
  content?: string;
756
893
  }
757
894
  /** Billing Info and shipping details */
@@ -763,19 +900,37 @@ export interface AddressWithContact {
763
900
  }
764
901
  /** Physical address */
765
902
  export interface ApiAddress {
766
- /** 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
+ */
767
907
  country?: string | null;
768
- /** 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
+ */
769
912
  subdivision?: string | null;
770
- /** City name. */
913
+ /**
914
+ * City name.
915
+ * @maxLength 50
916
+ */
771
917
  city?: string | null;
772
- /** Postal or zip code. */
918
+ /**
919
+ * Postal or zip code.
920
+ * @maxLength 50
921
+ */
773
922
  postalCode?: string | null;
774
923
  /** Street address. */
775
924
  streetAddress?: StreetAddress;
776
- /** Main address line (usually street name and number). */
925
+ /**
926
+ * Main address line (usually street name and number).
927
+ * @maxLength 150
928
+ */
777
929
  addressLine?: string | null;
778
- /** 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
+ */
779
934
  addressLine2?: string | null;
780
935
  /**
781
936
  * Country's full name.
@@ -802,13 +957,25 @@ export interface AddressLocation {
802
957
  }
803
958
  /** Full contact details for an address */
804
959
  export interface FullAddressContactDetails {
805
- /** First name. */
960
+ /**
961
+ * First name.
962
+ * @maxLength 100
963
+ */
806
964
  firstName?: string | null;
807
- /** Last name. */
965
+ /**
966
+ * Last name.
967
+ * @maxLength 100
968
+ */
808
969
  lastName?: string | null;
809
- /** Phone number. */
970
+ /**
971
+ * Phone number.
972
+ * @format PHONE
973
+ */
810
974
  phone?: string | null;
811
- /** Company name. */
975
+ /**
976
+ * Company name.
977
+ * @maxLength 1000
978
+ */
812
979
  company?: string | null;
813
980
  /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
814
981
  vatId?: CommonVatId;
@@ -850,11 +1017,15 @@ export interface ShippingInfo {
850
1017
  carrierServiceOptions?: CarrierServiceOption[];
851
1018
  }
852
1019
  export interface SelectedCarrierServiceOption {
853
- /** 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
+ */
854
1024
  code?: string;
855
1025
  /**
856
1026
  * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
857
1027
  * For example, "Standard" or "First-Class Package International".
1028
+ * @maxLength 250
858
1029
  * @readonly
859
1030
  */
860
1031
  title?: string;
@@ -875,17 +1046,29 @@ export interface SelectedCarrierServiceOption {
875
1046
  requestedShippingOption?: boolean;
876
1047
  /** Other charges */
877
1048
  otherCharges?: SelectedCarrierServiceOptionOtherCharge[];
878
- /** This carrier's unique ID */
1049
+ /**
1050
+ * This carrier's unique ID
1051
+ * @format GUID
1052
+ */
879
1053
  carrierId?: string | null;
880
- /** 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
+ */
881
1058
  deliveryAllocations?: DeliveryAllocation[];
882
1059
  /** If the delivery solution is a partial and doesn't apply to all items. */
883
1060
  partial?: boolean | null;
884
1061
  }
885
1062
  export interface DeliveryLogistics {
886
- /** 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
+ */
887
1067
  deliveryTime?: string | null;
888
- /** 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
+ */
889
1072
  instructions?: string | null;
890
1073
  /** Pickup details. */
891
1074
  pickupDetails?: PickupDetails;
@@ -927,7 +1110,10 @@ export interface SelectedCarrierServiceOptionPrices {
927
1110
  export interface SelectedCarrierServiceOptionOtherCharge {
928
1111
  /** Type of additional cost. */
929
1112
  type?: ChargeType;
930
- /** 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
+ */
931
1117
  details?: string | null;
932
1118
  /** Price of added charge. */
933
1119
  cost?: SelectedCarrierServiceOptionPrices;
@@ -945,32 +1131,56 @@ export interface DeliveryAllocation {
945
1131
  applicableLineItems?: ApplicableLineItems;
946
1132
  }
947
1133
  export interface Carrier {
948
- /** The carrier app id */
1134
+ /**
1135
+ * The carrier app id
1136
+ * @format GUID
1137
+ */
949
1138
  appId?: string | null;
950
- /** 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
+ */
951
1143
  code?: string;
952
1144
  }
953
1145
  export interface Region {
954
- /** The delivery region id. */
1146
+ /**
1147
+ * The delivery region id.
1148
+ * @format GUID
1149
+ */
955
1150
  id?: string | null;
956
- /** The delivery region name. */
1151
+ /**
1152
+ * The delivery region name.
1153
+ * @maxLength 100
1154
+ */
957
1155
  name?: string | null;
958
1156
  }
959
1157
  export interface ApplicableLineItems {
960
- /** 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
+ */
961
1164
  lineItemIds?: string[];
962
1165
  }
963
1166
  export interface ShippingRegion {
964
1167
  /**
965
1168
  * Shipping region ID.
1169
+ * @format GUID
966
1170
  * @readonly
967
1171
  */
968
1172
  id?: string;
969
- /** Shipping region name. */
1173
+ /**
1174
+ * Shipping region name.
1175
+ * @maxLength 100
1176
+ */
970
1177
  name?: string;
971
1178
  }
972
1179
  export interface CarrierServiceOption {
973
- /** Carrier ID. */
1180
+ /**
1181
+ * Carrier ID.
1182
+ * @format GUID
1183
+ */
974
1184
  carrierId?: string;
975
1185
  /** Shipping options offered by this carrier for this request. */
976
1186
  shippingOptions?: ShippingOption[];
@@ -979,18 +1189,23 @@ export interface ShippingOption {
979
1189
  /**
980
1190
  * Unique code of provided shipping option like "usps_std_overnight".
981
1191
  * For legacy calculators this would be the UUID of the option.
1192
+ * @maxLength 100
982
1193
  */
983
1194
  code?: string;
984
1195
  /**
985
1196
  * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
986
1197
  * For example, "Standard" or "First-Class Package International".
1198
+ * @maxLength 250
987
1199
  */
988
1200
  title?: string;
989
1201
  /** Delivery logistics. */
990
1202
  logistics?: DeliveryLogistics;
991
1203
  /** Sipping price information. */
992
1204
  cost?: ShippingPrice;
993
- /** 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
+ */
994
1209
  deliveryAllocations?: DeliveryAllocation[];
995
1210
  /** If the delivery solution is a partial and doesn't apply to all items. */
996
1211
  partial?: boolean | null;
@@ -1010,31 +1225,39 @@ export interface OtherCharge {
1010
1225
  export interface BuyerInfo extends BuyerInfoIdOneOf {
1011
1226
  /**
1012
1227
  * Visitor ID (if site visitor is **not** a member).
1228
+ * @format GUID
1013
1229
  * @readonly
1014
1230
  */
1015
1231
  visitorId?: string;
1016
1232
  /**
1017
1233
  * Member ID (if site visitor is a site member).
1234
+ * @format GUID
1018
1235
  * @readonly
1019
1236
  */
1020
1237
  memberId?: string;
1021
1238
  /**
1022
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
1023
1241
  * @readonly
1024
1242
  */
1025
1243
  contactId?: string | null;
1026
- /** Buyer email address. */
1244
+ /**
1245
+ * Buyer email address.
1246
+ * @format EMAIL
1247
+ */
1027
1248
  email?: string | null;
1028
1249
  }
1029
1250
  /** @oneof */
1030
1251
  export interface BuyerInfoIdOneOf {
1031
1252
  /**
1032
1253
  * Visitor ID (if site visitor is **not** a member).
1254
+ * @format GUID
1033
1255
  * @readonly
1034
1256
  */
1035
1257
  visitorId?: string;
1036
1258
  /**
1037
1259
  * Member ID (if site visitor is a site member).
1260
+ * @format GUID
1038
1261
  * @readonly
1039
1262
  */
1040
1263
  memberId?: string;
@@ -1195,11 +1418,16 @@ export interface GiftCard {
1195
1418
  obfuscatedCode?: string;
1196
1419
  /** Gift card value. */
1197
1420
  amount?: MultiCurrencyPrice;
1198
- /** App ID of the gift card provider. */
1421
+ /**
1422
+ * App ID of the gift card provider.
1423
+ * @format GUID
1424
+ */
1199
1425
  appId?: string;
1200
1426
  /**
1201
1427
  * External ID in the gift card provider's system.
1202
1428
  * Used for integration and tracking across different platforms.
1429
+ * @minLength 1
1430
+ * @maxLength 50
1203
1431
  */
1204
1432
  externalId?: string | null;
1205
1433
  }
@@ -1214,6 +1442,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1214
1442
  discountType?: DiscountType;
1215
1443
  /**
1216
1444
  * IDs of line items the discount applies to.
1445
+ * @format GUID
1217
1446
  * @deprecated IDs of line items the discount applies to.
1218
1447
  * @replacedBy line_items_discounts
1219
1448
  * @targetRemovalDate 2024-06-01
@@ -1248,11 +1477,18 @@ export interface Coupon {
1248
1477
  export interface MerchantDiscount {
1249
1478
  /** Discount value. */
1250
1479
  amount?: MultiCurrencyPrice;
1251
- /** 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
+ */
1252
1485
  percentage?: number | null;
1253
1486
  }
1254
1487
  export interface DiscountRule {
1255
- /** Discount rule ID */
1488
+ /**
1489
+ * Discount rule ID
1490
+ * @format GUID
1491
+ */
1256
1492
  id?: string;
1257
1493
  /** Discount rule name */
1258
1494
  name?: DiscountRuleName;
@@ -1260,13 +1496,24 @@ export interface DiscountRule {
1260
1496
  amount?: MultiCurrencyPrice;
1261
1497
  }
1262
1498
  export interface DiscountRuleName {
1263
- /** 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
+ */
1264
1504
  original?: string;
1265
- /** 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
+ */
1266
1510
  translated?: string | null;
1267
1511
  }
1268
1512
  export interface LineItemDiscount {
1269
- /** ID of line item the discount applies to. */
1513
+ /**
1514
+ * ID of line item the discount applies to.
1515
+ * @format GUID
1516
+ */
1270
1517
  id?: string;
1271
1518
  /** Discount value. */
1272
1519
  totalDiscountAmount?: MultiCurrencyPrice;
@@ -1274,9 +1521,17 @@ export interface LineItemDiscount {
1274
1521
  export interface CustomField {
1275
1522
  /** Custom field value. */
1276
1523
  value?: any;
1277
- /** Custom field title. */
1524
+ /**
1525
+ * Custom field title.
1526
+ * @minLength 1
1527
+ * @maxLength 500
1528
+ */
1278
1529
  title?: string;
1279
- /** Translated custom field title. */
1530
+ /**
1531
+ * Translated custom field title.
1532
+ * @minLength 1
1533
+ * @maxLength 500
1534
+ */
1280
1535
  translatedTitle?: string | null;
1281
1536
  }
1282
1537
  export declare enum WeightUnit {
@@ -1352,15 +1607,27 @@ export declare enum FallbackReason {
1352
1607
  * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
1353
1608
  */
1354
1609
  export interface AggregatedTaxBreakdown {
1355
- /** 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
+ */
1356
1614
  taxName?: string;
1357
- /** 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
+ */
1358
1619
  taxType?: string;
1359
- /** 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
+ */
1360
1624
  jurisdiction?: string;
1361
1625
  /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
1362
1626
  jurisdictionTypeEnum?: JurisdictionType;
1363
- /** 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
+ */
1364
1631
  rate?: string;
1365
1632
  /** The sum of all the tax from line items that calculated by the tax identifiers. */
1366
1633
  aggregatedTaxAmount?: MultiCurrencyPrice;
@@ -1403,13 +1670,23 @@ export interface CreatedBy extends CreatedByIdOneOf {
1403
1670
  /**
1404
1671
  * User ID - when the order was created by a Wix user on behalf of a buyer.
1405
1672
  * For example, via POS (point of service).
1673
+ * @format GUID
1406
1674
  */
1407
1675
  userId?: string;
1408
- /** 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
+ */
1409
1680
  memberId?: string;
1410
- /** 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
+ */
1411
1685
  visitorId?: string;
1412
- /** 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
+ */
1413
1690
  appId?: string;
1414
1691
  }
1415
1692
  /** @oneof */
@@ -1417,13 +1694,23 @@ export interface CreatedByIdOneOf {
1417
1694
  /**
1418
1695
  * User ID - when the order was created by a Wix user on behalf of a buyer.
1419
1696
  * For example, via POS (point of service).
1697
+ * @format GUID
1420
1698
  */
1421
1699
  userId?: string;
1422
- /** 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
+ */
1423
1704
  memberId?: string;
1424
- /** 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
+ */
1425
1709
  visitorId?: string;
1426
- /** 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
+ */
1427
1714
  appId?: string;
1428
1715
  }
1429
1716
  /** Reserved for internal use. */
@@ -1431,24 +1718,39 @@ export interface MembershipOptions {
1431
1718
  /**
1432
1719
  * Reserved for internal use.
1433
1720
  * @readonly
1721
+ * @maxSize 300
1434
1722
  */
1435
1723
  eligibleMemberships?: Membership[];
1436
1724
  /**
1437
1725
  * Reserved for internal use.
1438
1726
  * @readonly
1727
+ * @maxSize 300
1439
1728
  */
1440
1729
  invalidMemberships?: InvalidMembership[];
1441
1730
  /** Selected membership to apply to this checkout. */
1442
1731
  selectedMemberships?: SelectedMemberships;
1443
1732
  }
1444
1733
  export interface Membership {
1445
- /** Membership ID. */
1734
+ /**
1735
+ * Membership ID.
1736
+ * @minLength 1
1737
+ * @maxLength 100
1738
+ */
1446
1739
  id?: string;
1447
- /** ID of the application providing this payment option. */
1740
+ /**
1741
+ * ID of the application providing this payment option.
1742
+ * @format GUID
1743
+ */
1448
1744
  appId?: string;
1449
1745
  /** The name of this membership. */
1450
1746
  name?: MembershipName;
1451
- /** 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
+ */
1452
1754
  lineItemIds?: string[];
1453
1755
  /** Optional - For a membership that has limited credits, information about credit usage. */
1454
1756
  credits?: MembershipPaymentCredits;
@@ -1458,13 +1760,22 @@ export interface Membership {
1458
1760
  additionalData?: Record<string, any> | null;
1459
1761
  }
1460
1762
  export interface MembershipName {
1461
- /** Membership name. */
1763
+ /**
1764
+ * Membership name.
1765
+ * @maxLength 100
1766
+ */
1462
1767
  original?: string;
1463
- /** Translated membership name. Defaults to `original` when not provided. */
1768
+ /**
1769
+ * Translated membership name. Defaults to `original` when not provided.
1770
+ * @maxLength 100
1771
+ */
1464
1772
  translated?: string | null;
1465
1773
  }
1466
1774
  export interface MembershipPaymentCredits {
1467
- /** Membership's total amount of credits. */
1775
+ /**
1776
+ * Membership's total amount of credits.
1777
+ * @min 1
1778
+ */
1468
1779
  total?: number;
1469
1780
  /** Membership's remaining amount of credits. */
1470
1781
  remaining?: number;
@@ -1472,31 +1783,63 @@ export interface MembershipPaymentCredits {
1472
1783
  export interface InvalidMembership {
1473
1784
  /** Membership details. */
1474
1785
  membership?: Membership;
1475
- /** 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
+ */
1476
1791
  reason?: string;
1477
1792
  }
1478
1793
  export interface SelectedMemberships {
1479
- /** Selected memberships. */
1794
+ /**
1795
+ * Selected memberships.
1796
+ * @maxSize 300
1797
+ */
1480
1798
  memberships?: SelectedMembership[];
1481
1799
  }
1482
1800
  export interface SelectedMembership {
1483
- /** Membership ID. */
1801
+ /**
1802
+ * Membership ID.
1803
+ * @minLength 1
1804
+ * @maxLength 100
1805
+ */
1484
1806
  id?: string;
1485
- /** ID of the app providing this payment option. */
1807
+ /**
1808
+ * ID of the app providing this payment option.
1809
+ * @format GUID
1810
+ */
1486
1811
  appId?: string;
1487
- /** 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
+ */
1488
1819
  lineItemIds?: string[];
1489
1820
  }
1490
1821
  export interface AdditionalFee {
1491
- /** 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
+ */
1492
1827
  code?: string | null;
1493
- /** Translated additional fee's name. */
1828
+ /**
1829
+ * Translated additional fee's name.
1830
+ * @minLength 1
1831
+ * @maxLength 50
1832
+ */
1494
1833
  name?: string;
1495
1834
  /** Additional fee's price. */
1496
1835
  price?: MultiCurrencyPrice;
1497
1836
  /** Tax details. */
1498
1837
  taxDetails?: ItemTaxFullDetails;
1499
- /** Provider's app id. */
1838
+ /**
1839
+ * Provider's app id.
1840
+ * @minLength 1
1841
+ * @maxLength 100
1842
+ */
1500
1843
  providerAppId?: string | null;
1501
1844
  /** Additional fee's price before tax. */
1502
1845
  priceBeforeTax?: MultiCurrencyPrice;
@@ -1505,6 +1848,7 @@ export interface AdditionalFee {
1505
1848
  /**
1506
1849
  * Optional - Line items associated with this additional fee.
1507
1850
  * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
1851
+ * @format GUID
1508
1852
  */
1509
1853
  lineItemIds?: string[];
1510
1854
  /** the source the additional fee was added from */
@@ -1523,11 +1867,13 @@ export interface ConversionInfo {
1523
1867
  /**
1524
1868
  * The site currency.
1525
1869
  * @readonly
1870
+ * @format CURRENCY
1526
1871
  */
1527
1872
  siteCurrency?: string;
1528
1873
  /**
1529
1874
  * The rate used when converting from the site currency to the checkout currency.
1530
1875
  * @readonly
1876
+ * @decimalValue options { gt:0, lte:1000000000000000 }
1531
1877
  */
1532
1878
  conversionRate?: string;
1533
1879
  }
@@ -1536,7 +1882,11 @@ export interface Violation {
1536
1882
  severity?: Severity;
1537
1883
  /** Target location on a checkout or cart page where the violation will be displayed. */
1538
1884
  target?: Target;
1539
- /** 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
+ */
1540
1890
  description?: string | null;
1541
1891
  }
1542
1892
  export declare enum Severity {
@@ -1620,12 +1970,14 @@ export interface CustomContentReference {
1620
1970
  * ID of the app providing the content.
1621
1971
  *
1622
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
1623
1974
  */
1624
1975
  appId?: string;
1625
1976
  /**
1626
1977
  * ID of the component within the app it belongs to.
1627
1978
  *
1628
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
1629
1981
  */
1630
1982
  componentId?: string;
1631
1983
  }
@@ -1633,14 +1985,49 @@ export interface ExternalReference {
1633
1985
  /**
1634
1986
  * ID of the app associated with the purchase flow.
1635
1987
  * For example, the Wix Pay Links app ID.
1988
+ * @format GUID
1989
+ * @immutable
1636
1990
  */
1637
1991
  appId?: string;
1638
1992
  /**
1639
1993
  * Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.
1640
1994
  * For example, a Wix Pay Link ID.
1995
+ * @minLength 1
1996
+ * @maxLength 100
1997
+ * @immutable
1641
1998
  */
1642
1999
  resourceId?: string | null;
1643
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
+ }
1644
2031
  export interface UpdatedCheckoutMessage {
1645
2032
  /** Previous checkout. */
1646
2033
  oldCheckout?: Checkout;
@@ -1652,28 +2039,20 @@ export interface CreateCheckoutRequest {
1652
2039
  checkoutInfo?: Checkout;
1653
2040
  /** Coupon code. */
1654
2041
  couponCode?: string | null;
1655
- /** Catalog line items to add to the checkout. */
2042
+ /**
2043
+ * Catalog line items to add to the checkout.
2044
+ * @maxSize 300
2045
+ */
1656
2046
  lineItems?: LineItem[];
1657
2047
  /**
1658
2048
  * Custom line items to add to the checkout. Custom line items don't trigger the Catalog service plugin.
1659
2049
  *
1660
2050
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
1661
2051
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
2052
+ * @maxSize 300
1662
2053
  */
1663
2054
  customLineItems?: CustomLineItem[];
1664
- /**
1665
- * Sales channel that submitted the order.
1666
- * + `"UNSPECIFIED"`: Unspecified sales channel. This value is not supported.
1667
- * + `"WEB"`: A web client.
1668
- * + `"POS"`: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395)
1669
- * + `"EBAY"`: [eBay](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop)
1670
- * + `"AMAZON"`: [Amazon](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop)
1671
- * + `"WISH"`: [Wish](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-a-wish-shop)
1672
- * + `"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)
1673
- * + `"WIX_APP_STORE"`: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview)
1674
- * + `"BACKOFFICE_MERCHANT"`: Wix merchant backoffice
1675
- * + `"OTHER_PLATFORM"`: Other sales platform.
1676
- */
2055
+ /** Sales channel that submitted the order. */
1677
2056
  channelType: ChannelType;
1678
2057
  /**
1679
2058
  * Gift card code.
@@ -1689,6 +2068,7 @@ export interface CreateCheckoutRequest {
1689
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)
1690
2069
  * to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
1691
2070
  * standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
2071
+ * @maxLength 1000
1692
2072
  */
1693
2073
  overrideCheckoutUrl?: string | null;
1694
2074
  }
@@ -1698,17 +2078,24 @@ export interface CustomLineItem {
1698
2078
  *
1699
2079
  * Min: `1`
1700
2080
  * Max: `100000`
2081
+ * @min 1
2082
+ * @max 100000
1701
2083
  */
1702
2084
  quantity?: number;
1703
2085
  /**
1704
2086
  * Custom line item price.
1705
2087
  *
1706
2088
  * Must be a number or a decimal without symbols.
2089
+ * @format DECIMAL_VALUE
2090
+ * @decimalValue options { gte:0, lte:1000000000000000 }
1707
2091
  */
1708
2092
  price?: string;
1709
2093
  /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
1710
2094
  priceDescription?: PriceDescription;
1711
- /** 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
+ */
1712
2099
  descriptionLines?: DescriptionLine[];
1713
2100
  /** Custom line item's media. */
1714
2101
  media?: Image;
@@ -1716,9 +2103,13 @@ export interface CustomLineItem {
1716
2103
  * Custom line item ID. If passed, `id` must be unique.
1717
2104
  *
1718
2105
  * Default: auto-generated ID
2106
+ * @format GUID
1719
2107
  */
1720
2108
  id?: string | null;
1721
- /** Tax group ID for this custom line item. */
2109
+ /**
2110
+ * Tax group ID for this custom line item.
2111
+ * @format GUID
2112
+ */
1722
2113
  taxGroupId?: string | null;
1723
2114
  /** Name of the item or product. */
1724
2115
  productName?: ProductName;
@@ -1726,11 +2117,15 @@ export interface CustomLineItem {
1726
2117
  url?: PageUrlV2;
1727
2118
  /** Item type. Either a preset type or custom. */
1728
2119
  itemType?: ItemType;
1729
- /** 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
+ */
1730
2124
  fullPrice?: string | null;
1731
2125
  /**
1732
2126
  * Item quantity available for purchase. Only return this if inventory is managed.
1733
2127
  * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
2128
+ * @max 100000
1734
2129
  */
1735
2130
  quantityAvailable?: number | null;
1736
2131
  /** Physical properties of the item. */
@@ -1755,6 +2150,8 @@ export interface CustomLineItem {
1755
2150
  * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
1756
2151
  * + In most cases, this field is the same as `catalogReference.catalogItemId`.
1757
2152
  * + Used in membership validation.
2153
+ * @minLength 1
2154
+ * @maxLength 36
1758
2155
  */
1759
2156
  rootCatalogItemId?: string | null;
1760
2157
  /**
@@ -1762,12 +2159,20 @@ export interface CustomLineItem {
1762
2159
  *
1763
2160
  * Eligible for catalog items with type `DEPOSIT_ONLINE`.
1764
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
1765
2163
  */
1766
2164
  depositAmount?: string | null;
2165
+ /**
2166
+ * Delivery profile ID.
2167
+ * @format GUID
2168
+ */
2169
+ deliveryProfileId?: string | null;
1767
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. */
1768
2171
  catalogReference?: CatalogReference;
1769
2172
  /**
1770
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
1771
2176
  * @readonly
1772
2177
  */
1773
2178
  consentRequiredPaymentPolicy?: string | null;
@@ -1780,9 +2185,16 @@ export interface CustomLineItem {
1780
2185
  savePaymentMethod?: boolean;
1781
2186
  }
1782
2187
  export interface MerchantDiscountInput {
1783
- /** Discount amount. */
2188
+ /**
2189
+ * Discount amount.
2190
+ * @decimalValue options { gte:0 }
2191
+ */
1784
2192
  amount?: string;
1785
- /** 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
+ */
1786
2198
  lineItemIds?: string[];
1787
2199
  }
1788
2200
  export interface CreateCheckoutResponse {
@@ -1799,7 +2211,10 @@ export interface ShippingCalculationErrorDataShippingCalculationErrorOneOf {
1799
2211
  carrierErrors?: CarrierErrors;
1800
2212
  }
1801
2213
  export interface GetCheckoutRequest {
1802
- /** Checkout ID. */
2214
+ /**
2215
+ * Checkout ID.
2216
+ * @format GUID
2217
+ */
1803
2218
  id: string;
1804
2219
  }
1805
2220
  export interface GetCheckoutResponse {
@@ -1807,7 +2222,10 @@ export interface GetCheckoutResponse {
1807
2222
  checkout?: Checkout;
1808
2223
  }
1809
2224
  export interface GetCheckoutWithAllExtendedFieldsRequest {
1810
- /** Checkout ID. */
2225
+ /**
2226
+ * Checkout ID.
2227
+ * @format GUID
2228
+ */
1811
2229
  id?: string;
1812
2230
  }
1813
2231
  export interface GetCheckoutWithAllExtendedFieldsResponse {
@@ -1815,7 +2233,10 @@ export interface GetCheckoutWithAllExtendedFieldsResponse {
1815
2233
  checkout?: Checkout;
1816
2234
  }
1817
2235
  export interface GetCheckoutByCartIdRequest {
1818
- /** Cart ID. */
2236
+ /**
2237
+ * Cart ID.
2238
+ * @format GUID
2239
+ */
1819
2240
  id: string;
1820
2241
  }
1821
2242
  export interface GetCheckoutByCartIdResponse {
@@ -1823,7 +2244,10 @@ export interface GetCheckoutByCartIdResponse {
1823
2244
  checkout?: Checkout;
1824
2245
  }
1825
2246
  export interface GetWixCheckoutURLRequest {
1826
- /** Checkout ID. */
2247
+ /**
2248
+ * Checkout ID.
2249
+ * @format GUID
2250
+ */
1827
2251
  id: string;
1828
2252
  }
1829
2253
  export interface GetWixCheckoutURLResponse {
@@ -1831,7 +2255,10 @@ export interface GetWixCheckoutURLResponse {
1831
2255
  checkoutUrl?: string;
1832
2256
  }
1833
2257
  export interface GetCheckoutURLRequest {
1834
- /** Checkout ID. */
2258
+ /**
2259
+ * Checkout ID.
2260
+ * @format GUID
2261
+ */
1835
2262
  id: string;
1836
2263
  }
1837
2264
  export interface GetCheckoutURLResponse {
@@ -1855,15 +2282,20 @@ export interface UpdateCheckoutRequest {
1855
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)
1856
2283
  * to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
1857
2284
  * standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
2285
+ * @maxLength 1000
1858
2286
  */
1859
2287
  overrideCheckoutUrl?: string | null;
1860
- /** Catalog line items. */
2288
+ /**
2289
+ * Catalog line items.
2290
+ * @maxSize 300
2291
+ */
1861
2292
  lineItems?: LineItem[];
1862
2293
  /**
1863
2294
  * Custom line items. Custom line items don't trigger the Catalog service plugin.
1864
2295
  *
1865
2296
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
1866
2297
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
2298
+ * @maxSize 300
1867
2299
  */
1868
2300
  customLineItems?: CustomLineItem[];
1869
2301
  }
@@ -1872,7 +2304,10 @@ export interface UpdateCheckoutResponse {
1872
2304
  checkout?: Checkout;
1873
2305
  }
1874
2306
  export interface RemoveCouponRequest {
1875
- /** ID of the checkout to remove the coupon from. */
2307
+ /**
2308
+ * ID of the checkout to remove the coupon from.
2309
+ * @format GUID
2310
+ */
1876
2311
  id: string;
1877
2312
  }
1878
2313
  export interface RemoveCouponResponse {
@@ -1880,7 +2315,10 @@ export interface RemoveCouponResponse {
1880
2315
  checkout?: Checkout;
1881
2316
  }
1882
2317
  export interface RemoveGiftCardRequest {
1883
- /** 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
+ */
1884
2322
  id: string;
1885
2323
  }
1886
2324
  export interface RemoveGiftCardResponse {
@@ -1888,7 +2326,10 @@ export interface RemoveGiftCardResponse {
1888
2326
  checkout?: Checkout;
1889
2327
  }
1890
2328
  export interface RemoveOverrideCheckoutUrlRequest {
1891
- /** 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
+ */
1892
2333
  id: string;
1893
2334
  }
1894
2335
  export interface RemoveOverrideCheckoutUrlResponse {
@@ -1896,15 +2337,22 @@ export interface RemoveOverrideCheckoutUrlResponse {
1896
2337
  checkout?: Checkout;
1897
2338
  }
1898
2339
  export interface AddToCheckoutRequest {
1899
- /** Checkout ID. */
2340
+ /**
2341
+ * Checkout ID.
2342
+ * @format GUID
2343
+ */
1900
2344
  id: string;
1901
- /** Catalog line items. */
2345
+ /**
2346
+ * Catalog line items.
2347
+ * @maxSize 100
2348
+ */
1902
2349
  lineItems?: LineItem[];
1903
2350
  /**
1904
2351
  * Custom line items. Custom line items don't trigger the Catalog service plugin.
1905
2352
  *
1906
2353
  * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
1907
2354
  * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
2355
+ * @maxSize 100
1908
2356
  */
1909
2357
  customLineItems?: CustomLineItem[];
1910
2358
  }
@@ -1913,9 +2361,17 @@ export interface AddToCheckoutResponse {
1913
2361
  checkout?: Checkout;
1914
2362
  }
1915
2363
  export interface RemoveLineItemsRequest {
1916
- /** ID of the checkout to remove line items from. */
2364
+ /**
2365
+ * ID of the checkout to remove line items from.
2366
+ * @format GUID
2367
+ */
1917
2368
  id: string;
1918
- /** 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
+ */
1919
2375
  lineItemIds: string[];
1920
2376
  }
1921
2377
  export interface RemoveLineItemsResponse {
@@ -1923,7 +2379,10 @@ export interface RemoveLineItemsResponse {
1923
2379
  checkout?: Checkout;
1924
2380
  }
1925
2381
  export interface CreateOrderRequest {
1926
- /** Checkout ID. */
2382
+ /**
2383
+ * Checkout ID.
2384
+ * @format GUID
2385
+ */
1927
2386
  id: string;
1928
2387
  /** Indicates the payment method should be saved on the order */
1929
2388
  savePaymentMethod?: boolean;
@@ -1931,9 +2390,15 @@ export interface CreateOrderRequest {
1931
2390
  delayCapture?: boolean;
1932
2391
  }
1933
2392
  export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
1934
- /** ID of newly created order. */
2393
+ /**
2394
+ * ID of newly created order.
2395
+ * @format GUID
2396
+ */
1935
2397
  orderId?: string;
1936
- /** 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
+ */
1937
2402
  subscriptionId?: string;
1938
2403
  /**
1939
2404
  * Payment gateway order ID.
@@ -1949,9 +2414,15 @@ export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
1949
2414
  }
1950
2415
  /** @oneof */
1951
2416
  export interface CreateOrderResponseIdOneOf {
1952
- /** ID of newly created order. */
2417
+ /**
2418
+ * ID of newly created order.
2419
+ * @format GUID
2420
+ */
1953
2421
  orderId?: string;
1954
- /** 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
+ */
1955
2426
  subscriptionId?: string;
1956
2427
  }
1957
2428
  export interface PaymentErrorResponseData {
@@ -1960,12 +2431,16 @@ export interface PaymentErrorResponseData {
1960
2431
  failureDetails?: string | null;
1961
2432
  }
1962
2433
  export interface DoublePaymentErrorData extends DoublePaymentErrorDataIdOneOf {
2434
+ /** @format GUID */
1963
2435
  orderId?: string;
2436
+ /** @format GUID */
1964
2437
  subscriptionId?: string;
1965
2438
  }
1966
2439
  /** @oneof */
1967
2440
  export interface DoublePaymentErrorDataIdOneOf {
2441
+ /** @format GUID */
1968
2442
  orderId?: string;
2443
+ /** @format GUID */
1969
2444
  subscriptionId?: string;
1970
2445
  }
1971
2446
  export interface RedeemErrorData {
@@ -1976,7 +2451,10 @@ export interface ViolationsList {
1976
2451
  violations?: Violation[];
1977
2452
  }
1978
2453
  export interface CreateOrderAndChargeRequest {
1979
- /** Checkout ID. */
2454
+ /**
2455
+ * Checkout ID.
2456
+ * @format GUID
2457
+ */
1980
2458
  id: string;
1981
2459
  /** Payment token. */
1982
2460
  paymentToken?: string | null;
@@ -1986,9 +2464,15 @@ export interface CreateOrderAndChargeRequest {
1986
2464
  delayCapture?: boolean;
1987
2465
  }
1988
2466
  export interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOneOf {
1989
- /** ID of newly created order. */
2467
+ /**
2468
+ * ID of newly created order.
2469
+ * @format GUID
2470
+ */
1990
2471
  orderId?: string;
1991
- /** ID of newly created subscription. */
2472
+ /**
2473
+ * ID of newly created subscription.
2474
+ * @format GUID
2475
+ */
1992
2476
  subscriptionId?: string;
1993
2477
  /** Payment response token. */
1994
2478
  paymentResponseToken?: string | null;
@@ -2003,13 +2487,22 @@ export interface CreateOrderAndChargeResponse extends CreateOrderAndChargeRespon
2003
2487
  }
2004
2488
  /** @oneof */
2005
2489
  export interface CreateOrderAndChargeResponseIdOneOf {
2006
- /** ID of newly created order. */
2490
+ /**
2491
+ * ID of newly created order.
2492
+ * @format GUID
2493
+ */
2007
2494
  orderId?: string;
2008
- /** ID of newly created subscription. */
2495
+ /**
2496
+ * ID of newly created subscription.
2497
+ * @format GUID
2498
+ */
2009
2499
  subscriptionId?: string;
2010
2500
  }
2011
2501
  export interface MarkCheckoutAsCompletedRequest {
2012
- /** Checkout ID. */
2502
+ /**
2503
+ * Checkout ID.
2504
+ * @format GUID
2505
+ */
2013
2506
  id: string;
2014
2507
  }
2015
2508
  export interface MarkCheckoutAsCompletedResponse {
@@ -2019,13 +2512,23 @@ export interface CheckoutMarkedAsCompleted {
2019
2512
  checkout?: Checkout;
2020
2513
  }
2021
2514
  export interface UpdateLineItemsQuantityRequest {
2022
- /** Checkout ID. */
2515
+ /**
2516
+ * Checkout ID.
2517
+ * @format GUID
2518
+ */
2023
2519
  id: string;
2024
- /** Line item info to update. */
2520
+ /**
2521
+ * Line item info to update.
2522
+ * @minSize 1
2523
+ * @maxSize 100
2524
+ */
2025
2525
  lineItems: LineItemQuantityUpdate[];
2026
2526
  }
2027
2527
  export interface LineItemQuantityUpdate {
2028
- /** ID of the line item to update. */
2528
+ /**
2529
+ * ID of the line item to update.
2530
+ * @format GUID
2531
+ */
2029
2532
  id?: string;
2030
2533
  /**
2031
2534
  * New total amount of the line item,
@@ -2034,6 +2537,8 @@ export interface LineItemQuantityUpdate {
2034
2537
  * Min: `1`
2035
2538
  *
2036
2539
  * Max: `100000`
2540
+ * @min 1
2541
+ * @max 100000
2037
2542
  */
2038
2543
  quantity?: number;
2039
2544
  }
@@ -2042,7 +2547,10 @@ export interface UpdateLineItemsQuantityResponse {
2042
2547
  checkout?: Checkout;
2043
2548
  }
2044
2549
  export interface GetCheckoutPaymentSettingsRequest {
2045
- /** Checkout ID. */
2550
+ /**
2551
+ * Checkout ID.
2552
+ * @format GUID
2553
+ */
2046
2554
  id: string;
2047
2555
  }
2048
2556
  export interface GetCheckoutPaymentSettingsResponse {
@@ -2053,7 +2561,10 @@ export declare enum GetCheckoutPaymentSettingsResponsePaymentOption {
2053
2561
  MANUAL = "MANUAL"
2054
2562
  }
2055
2563
  export interface DeleteCheckoutRequest {
2056
- /** ID of the checkout to delete. */
2564
+ /**
2565
+ * ID of the checkout to delete.
2566
+ * @format GUID
2567
+ */
2057
2568
  id?: string;
2058
2569
  }
2059
2570
  export interface DeleteCheckoutResponse {
@@ -2067,20 +2578,33 @@ export interface Subscription {
2067
2578
  * @readonly
2068
2579
  */
2069
2580
  id?: string;
2070
- /** id of subscription in external system */
2581
+ /**
2582
+ * id of subscription in external system
2583
+ * @format GUID
2584
+ */
2071
2585
  externalId?: string | null;
2072
2586
  /**
2073
2587
  * Subscription creation date
2074
2588
  * @readonly
2075
2589
  */
2076
2590
  dateCreated?: Date | null;
2077
- /** The id of the cart this order was created from */
2591
+ /**
2592
+ * The id of the cart this order was created from
2593
+ * @format GUID
2594
+ */
2078
2595
  cartId?: string | null;
2079
- /** The id of the checkout this subscriptions was created from */
2596
+ /**
2597
+ * The id of the checkout this subscriptions was created from
2598
+ * @format GUID
2599
+ */
2080
2600
  checkoutId?: string | null;
2081
2601
  /** member or contact */
2082
2602
  buyerInfo?: V1BuyerInfo;
2083
- /** Line items ordered */
2603
+ /**
2604
+ * Line items ordered
2605
+ * @minSize 1
2606
+ * @maxSize 1
2607
+ */
2084
2608
  lineItems?: V1LineItem[];
2085
2609
  /** Totals for subscription's line items */
2086
2610
  totals?: Totals;
@@ -2092,7 +2616,10 @@ export interface Subscription {
2092
2616
  shippingInfo?: V1ShippingInfo;
2093
2617
  /** Coupon that was applied to subscription */
2094
2618
  appliedCoupon?: AppliedCoupon;
2095
- /** Message from the customer (e.g., customization request) */
2619
+ /**
2620
+ * Message from the customer (e.g., customization request)
2621
+ * @maxLength 1000
2622
+ */
2096
2623
  buyerNote?: string | null;
2097
2624
  /** Custom field */
2098
2625
  customField?: V1CustomField;
@@ -2110,7 +2637,10 @@ export interface Subscription {
2110
2637
  }
2111
2638
  /** Buyer Info */
2112
2639
  export interface V1BuyerInfo {
2113
- /** Wix customer ID */
2640
+ /**
2641
+ * Wix customer ID
2642
+ * @format GUID
2643
+ */
2114
2644
  id?: string;
2115
2645
  /** Customer type */
2116
2646
  identityType?: IdentityType;
@@ -2125,13 +2655,26 @@ export declare enum IdentityType {
2125
2655
  export interface V1LineItem {
2126
2656
  /** Line item ID (auto-generated) */
2127
2657
  index?: number;
2128
- /** Line item quantity */
2658
+ /**
2659
+ * Line item quantity
2660
+ * @min 1
2661
+ * @max 100000
2662
+ */
2129
2663
  quantity?: number;
2130
- /** Line item variantId (from Stores Catalog) */
2664
+ /**
2665
+ * Line item variantId (from Stores Catalog)
2666
+ * @format GUID
2667
+ */
2131
2668
  variantId?: string | null;
2132
- /** Line item options ordered */
2669
+ /**
2670
+ * Line item options ordered
2671
+ * @maxSize 6
2672
+ */
2133
2673
  options?: OptionSelection[];
2134
- /** Line item custom text field selections */
2674
+ /**
2675
+ * Line item custom text field selections
2676
+ * @maxSize 20
2677
+ */
2135
2678
  customTextFields?: CustomTextFieldSelection[];
2136
2679
  /** Charges details */
2137
2680
  chargeDetails?: ChargeDetails;
@@ -2139,53 +2682,109 @@ export interface V1LineItem {
2139
2682
  productDetails?: ProductDetails;
2140
2683
  }
2141
2684
  export interface OptionSelection {
2142
- /** Option name */
2685
+ /**
2686
+ * Option name
2687
+ * @maxLength 200
2688
+ */
2143
2689
  option?: string;
2144
- /** Selected choice for this option */
2690
+ /**
2691
+ * Selected choice for this option
2692
+ * @maxLength 500
2693
+ */
2145
2694
  selection?: string;
2146
2695
  }
2147
2696
  export interface CustomTextFieldSelection {
2148
- /** Custom text field name */
2697
+ /**
2698
+ * Custom text field name
2699
+ * @maxLength 100
2700
+ */
2149
2701
  title?: string;
2150
- /** Custom text field value */
2702
+ /**
2703
+ * Custom text field value
2704
+ * @maxLength 500
2705
+ */
2151
2706
  value?: string;
2152
2707
  }
2153
2708
  export interface ChargeDetails {
2154
- /** price of line item (depends on subscription option) */
2709
+ /**
2710
+ * price of line item (depends on subscription option)
2711
+ * @max 999999999.99
2712
+ */
2155
2713
  price?: number;
2156
- /** Total price charged to the customer (for this line items) after computation of quantity and discount */
2714
+ /**
2715
+ * Total price charged to the customer (for this line items) after computation of quantity and discount
2716
+ * @max 999999999.99
2717
+ */
2157
2718
  totalPrice?: number | null;
2158
- /** Discount applied for this line item */
2719
+ /**
2720
+ * Discount applied for this line item
2721
+ * @max 999999999.99
2722
+ */
2159
2723
  discount?: number | null;
2160
- /** Tax applied for this line item */
2724
+ /**
2725
+ * Tax applied for this line item
2726
+ * @max 999999999.99
2727
+ */
2161
2728
  tax?: number | null;
2162
2729
  /** Is tax applied for this line item */
2163
2730
  taxIncludedInPrice?: boolean;
2164
- /** Tax rate %, as a decimal point >= 0 */
2731
+ /**
2732
+ * Tax rate %, as a decimal point >= 0
2733
+ * @decimalValue options { maxScale:6, gte:0 }
2734
+ */
2165
2735
  taxRate?: string | null;
2166
2736
  }
2167
2737
  export interface ProductDetails {
2168
- /** Line item product ID (optional for POS orders) */
2738
+ /**
2739
+ * Line item product ID (optional for POS orders)
2740
+ * @minLength 1
2741
+ */
2169
2742
  productId?: string | null;
2170
- /** Line item name */
2743
+ /**
2744
+ * Line item name
2745
+ * @minLength 1
2746
+ * @maxLength 100
2747
+ */
2171
2748
  name?: string;
2172
- /** Line item name translated to buyer's language */
2749
+ /**
2750
+ * Line item name translated to buyer's language
2751
+ * @minLength 1
2752
+ * @maxLength 100
2753
+ */
2173
2754
  translatedName?: string | null;
2174
2755
  /** Line item type (may be extended) */
2175
2756
  lineItemType?: LineItemType;
2176
2757
  /** Line item primary media for preview */
2177
2758
  mediaItem?: MediaItem;
2178
- /** Line item SKU */
2759
+ /**
2760
+ * Line item SKU
2761
+ * @maxLength 40
2762
+ */
2179
2763
  sku?: string | null;
2180
- /** Line item weight */
2764
+ /**
2765
+ * Line item weight
2766
+ * @max 999999999.99
2767
+ */
2181
2768
  weight?: number | null;
2182
- /** Line item notes */
2769
+ /**
2770
+ * Line item notes
2771
+ * @maxLength 1000
2772
+ */
2183
2773
  notes?: string | null;
2184
- /** Line item fulfillerId from stores fulfillers. No value means self fulfilled */
2774
+ /**
2775
+ * Line item fulfillerId from stores fulfillers. No value means self fulfilled
2776
+ * @format GUID
2777
+ */
2185
2778
  fulfillerId?: string | null;
2186
- /** Tax group id */
2779
+ /**
2780
+ * Tax group id
2781
+ * @format GUID
2782
+ */
2187
2783
  taxGroupId?: string | null;
2188
- /** App id from the catalog reference */
2784
+ /**
2785
+ * App id from the catalog reference
2786
+ * @format GUID
2787
+ */
2189
2788
  appId?: string | null;
2190
2789
  }
2191
2790
  export declare enum LineItemType {
@@ -2206,16 +2805,19 @@ export interface MediaItem {
2206
2805
  mediaType?: MediaItemType;
2207
2806
  /**
2208
2807
  * Media URL
2808
+ * @format WEB_URL
2209
2809
  * @readonly
2210
2810
  */
2211
2811
  url?: string;
2212
2812
  /**
2213
2813
  * Media item width
2814
+ * @max 5000
2214
2815
  * @readonly
2215
2816
  */
2216
2817
  width?: number;
2217
2818
  /**
2218
2819
  * Media item height
2820
+ * @max 5000
2219
2821
  * @readonly
2220
2822
  */
2221
2823
  height?: number;
@@ -2223,7 +2825,10 @@ export interface MediaItem {
2223
2825
  id?: string | null;
2224
2826
  /** Media external URL */
2225
2827
  externalImageUrl?: string | null;
2226
- /** Alternative text for presentation when media cannot be displayed */
2828
+ /**
2829
+ * Alternative text for presentation when media cannot be displayed
2830
+ * @maxLength 256
2831
+ */
2227
2832
  altText?: string | null;
2228
2833
  }
2229
2834
  export declare enum MediaItemType {
@@ -2233,17 +2838,35 @@ export declare enum MediaItemType {
2233
2838
  IMAGE = "IMAGE"
2234
2839
  }
2235
2840
  export interface Totals {
2236
- /** Subtotal of all line items, before tax */
2841
+ /**
2842
+ * Subtotal of all line items, before tax
2843
+ * @max 999999999.99
2844
+ */
2237
2845
  subtotal?: number;
2238
- /** Total shipping price, including tax */
2846
+ /**
2847
+ * Total shipping price, including tax
2848
+ * @max 999999999.99
2849
+ */
2239
2850
  shipping?: number;
2240
- /** Total tax */
2851
+ /**
2852
+ * Total tax
2853
+ * @max 999999999.99
2854
+ */
2241
2855
  tax?: number;
2242
- /** Total calculated discount value */
2856
+ /**
2857
+ * Total calculated discount value
2858
+ * @max 999999999.99
2859
+ */
2243
2860
  discount?: number;
2244
- /** Total price */
2861
+ /**
2862
+ * Total price
2863
+ * @max 999999999.99
2864
+ */
2245
2865
  total?: number;
2246
- /** Total weight */
2866
+ /**
2867
+ * Total weight
2868
+ * @max 999999999.99
2869
+ */
2247
2870
  weight?: number | null;
2248
2871
  /**
2249
2872
  * Total line items quantity
@@ -2252,7 +2875,11 @@ export interface Totals {
2252
2875
  quantity?: number;
2253
2876
  }
2254
2877
  export interface StoreSettings {
2255
- /** Currency used for pricing in this store */
2878
+ /**
2879
+ * Currency used for pricing in this store
2880
+ * @maxLength 3
2881
+ * @format CURRENCY
2882
+ */
2256
2883
  currency?: string | null;
2257
2884
  /** Weight unit used in this store */
2258
2885
  weightUnit?: WeightUnit;
@@ -2260,56 +2887,103 @@ export interface StoreSettings {
2260
2887
  * The language to be used when communicating with the buyer
2261
2888
  * For a site that support multiple languages, this would be the language the buyer selected
2262
2889
  * Otherwise this would be the site language
2890
+ * @minLength 2
2891
+ * @maxLength 2
2263
2892
  */
2264
2893
  buyerLanguage?: string | null;
2265
2894
  }
2266
2895
  export interface Address extends AddressAddressLine1OptionsOneOf {
2267
- /** Address line 1 (free text) */
2896
+ /**
2897
+ * Address line 1 (free text)
2898
+ * @maxLength 1000
2899
+ */
2268
2900
  addressLine1?: string;
2269
2901
  /** Address line 1 (street) */
2270
2902
  street?: Street;
2271
2903
  /** Addressee name */
2272
2904
  fullName?: FullName;
2273
- /** Country code (2 letters) */
2905
+ /**
2906
+ * Country code (2 letters)
2907
+ * @format COUNTRY
2908
+ */
2274
2909
  country?: string | null;
2275
- /** State or district */
2910
+ /**
2911
+ * State or district
2912
+ * @maxLength 50
2913
+ */
2276
2914
  subdivision?: string | null;
2277
- /** City name */
2915
+ /**
2916
+ * City name
2917
+ * @maxLength 150
2918
+ */
2278
2919
  city?: string | null;
2279
- /** ZIP/postal code */
2920
+ /**
2921
+ * ZIP/postal code
2922
+ * @maxLength 200
2923
+ */
2280
2924
  zipCode?: string | null;
2281
- /** Phone number */
2925
+ /**
2926
+ * Phone number
2927
+ * @maxLength 200
2928
+ */
2282
2929
  phone?: string | null;
2283
- /** Company name */
2930
+ /**
2931
+ * Company name
2932
+ * @maxLength 500
2933
+ */
2284
2934
  company?: string | null;
2285
- /** Email address */
2935
+ /**
2936
+ * Email address
2937
+ * @maxLength 500
2938
+ */
2286
2939
  email?: string | null;
2287
- /** address line */
2940
+ /**
2941
+ * address line
2942
+ * @maxLength 250
2943
+ */
2288
2944
  addressLine2?: string | null;
2289
2945
  /** Tax information (for Brazil only) */
2290
2946
  vatId?: VatId;
2291
2947
  }
2292
2948
  /** @oneof */
2293
2949
  export interface AddressAddressLine1OptionsOneOf {
2294
- /** Address line 1 (free text) */
2950
+ /**
2951
+ * Address line 1 (free text)
2952
+ * @maxLength 1000
2953
+ */
2295
2954
  addressLine1?: string;
2296
2955
  /** Address line 1 (street) */
2297
2956
  street?: Street;
2298
2957
  }
2299
2958
  export interface FullName {
2300
- /** Customer's first name */
2959
+ /**
2960
+ * Customer's first name
2961
+ * @maxLength 1000
2962
+ */
2301
2963
  firstName?: string;
2302
- /** Customer's last name */
2964
+ /**
2965
+ * Customer's last name
2966
+ * @maxLength 1000
2967
+ */
2303
2968
  lastName?: string;
2304
2969
  }
2305
2970
  export interface Street {
2306
- /** Street number */
2971
+ /**
2972
+ * Street number
2973
+ * @maxLength 500
2974
+ */
2307
2975
  number?: string;
2308
- /** Street name */
2976
+ /**
2977
+ * Street name
2978
+ * @maxLength 1000
2979
+ */
2309
2980
  name?: string;
2310
2981
  }
2311
2982
  export interface VatId {
2312
- /** Customer's tax ID. */
2983
+ /**
2984
+ * Customer's tax ID.
2985
+ * @maxLength 50
2986
+ */
2313
2987
  number?: string;
2314
2988
  /**
2315
2989
  * Tax type.
@@ -2332,9 +3006,15 @@ export interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
2332
3006
  shipmentDetails?: ShipmentDetails;
2333
3007
  /** Pickup details (when this object describes pickup) */
2334
3008
  pickupDetails?: V1PickupDetails;
2335
- /** Delivery option name */
3009
+ /**
3010
+ * Delivery option name
3011
+ * @maxLength 250
3012
+ */
2336
3013
  deliveryOption?: string;
2337
- /** Delivery option delivery time */
3014
+ /**
3015
+ * Delivery option delivery time
3016
+ * @maxLength 500
3017
+ */
2338
3018
  estimatedDeliveryTime?: string | null;
2339
3019
  }
2340
3020
  /** @oneof */
@@ -2347,53 +3027,101 @@ export interface V1ShippingInfoDetailsOneOf {
2347
3027
  export interface ShipmentDetails {
2348
3028
  /** Shipping destination address */
2349
3029
  address?: Address;
2350
- /** Discount applied for shipping */
3030
+ /**
3031
+ * Discount applied for shipping
3032
+ * @max 999999999.99
3033
+ */
2351
3034
  discount?: number | null;
2352
- /** Tax applied for shipping */
3035
+ /**
3036
+ * Tax applied for shipping
3037
+ * @max 999999999.99
3038
+ */
2353
3039
  tax?: number | null;
2354
3040
  /** Whether tax is included in the price */
2355
3041
  taxIncludedInPrice?: boolean;
2356
- /** Tax rate % for shipping, as a decimal point >= 0 */
3042
+ /**
3043
+ * Tax rate % for shipping, as a decimal point >= 0
3044
+ * @decimalValue options { maxScale:6, gte:0 }
3045
+ */
2357
3046
  taxRate?: string | null;
2358
3047
  }
2359
3048
  export interface V1PickupDetails {
2360
3049
  /** Pickup address */
2361
3050
  address?: PickupAddress;
2362
- /** Store owner's pickup instructions */
3051
+ /**
3052
+ * Store owner's pickup instructions
3053
+ * @maxLength 1000
3054
+ */
2363
3055
  pickupInstructions?: string | null;
2364
3056
  }
2365
3057
  export interface PickupAddress {
2366
- /** Country code (2 letters) */
3058
+ /**
3059
+ * Country code (2 letters)
3060
+ * @format COUNTRY
3061
+ */
2367
3062
  country?: string;
2368
- /** State/District */
3063
+ /**
3064
+ * State/District
3065
+ * @maxLength 50
3066
+ */
2369
3067
  subdivision?: string | null;
2370
- /** Address */
3068
+ /**
3069
+ * Address
3070
+ * @maxLength 200
3071
+ */
2371
3072
  addressLine?: string;
2372
- /** City */
3073
+ /**
3074
+ * City
3075
+ * @maxLength 85
3076
+ */
2373
3077
  city?: string;
2374
- /** ZIP/postal code */
3078
+ /**
3079
+ * ZIP/postal code
3080
+ * @maxLength 50
3081
+ */
2375
3082
  zipCode?: string;
2376
3083
  }
2377
3084
  export interface AppliedCoupon {
2378
3085
  /** Coupon ID */
2379
3086
  couponId?: string;
2380
- /** Coupon name */
3087
+ /**
3088
+ * Coupon name
3089
+ * @maxLength 100
3090
+ */
2381
3091
  name?: string;
2382
- /** Coupon code */
3092
+ /**
3093
+ * Coupon code
3094
+ * @maxLength 100
3095
+ */
2383
3096
  code?: string;
2384
3097
  }
2385
3098
  /** Custom field */
2386
3099
  export interface V1CustomField {
2387
- /** Free text that the customer entered in the custom field during the checkout process */
3100
+ /**
3101
+ * Free text that the customer entered in the custom field during the checkout process
3102
+ * @maxLength 250
3103
+ */
2388
3104
  value?: string;
2389
- /** Title for the custom field */
3105
+ /**
3106
+ * Title for the custom field
3107
+ * @maxLength 200
3108
+ */
2390
3109
  title?: string;
2391
- /** The title translated according to the buyer language */
3110
+ /**
3111
+ * The title translated according to the buyer language
3112
+ * @maxLength 200
3113
+ */
2392
3114
  translatedTitle?: string;
2393
3115
  }
2394
3116
  export interface V1SubscriptionOptionInfo {
3117
+ /** @format GUID */
2395
3118
  id?: string | null;
3119
+ /**
3120
+ * @minLength 1
3121
+ * @maxLength 20
3122
+ */
2396
3123
  title?: string;
3124
+ /** @maxLength 60 */
2397
3125
  description?: string | null;
2398
3126
  discount?: Discount;
2399
3127
  }
@@ -2424,15 +3152,28 @@ export interface V1SubscriptionSettings {
2424
3152
  frequency?: SubscriptionFrequency;
2425
3153
  /** Whether subscription is renewed automatically at the end of each period. */
2426
3154
  autoRenewal?: boolean;
2427
- /** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */
3155
+ /**
3156
+ * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
3157
+ * @min 2
3158
+ * @max 999
3159
+ */
2428
3160
  billingCycles?: number | null;
2429
3161
  }
2430
3162
  export interface BillingInfo {
2431
- /** Payment method used for this order */
3163
+ /**
3164
+ * Payment method used for this order
3165
+ * @maxLength 50
3166
+ */
2432
3167
  paymentMethod?: string | null;
2433
- /** Transaction ID from payment gateway (e.g., Wix Payments) */
3168
+ /**
3169
+ * Transaction ID from payment gateway (e.g., Wix Payments)
3170
+ * @maxLength 100
3171
+ */
2434
3172
  paymentGatewayTransactionId?: string | null;
2435
- /** Order ID from payment gateway (e.g., Wix Payments) */
3173
+ /**
3174
+ * Order ID from payment gateway (e.g., Wix Payments)
3175
+ * @maxLength 100
3176
+ */
2436
3177
  paymentGatewayOrderId?: string | null;
2437
3178
  }
2438
3179
  export interface Empty {
@@ -2510,9 +3251,15 @@ export interface ActionEvent {
2510
3251
  bodyAsJson?: string;
2511
3252
  }
2512
3253
  export interface MessageEnvelope {
2513
- /** App instance ID. */
3254
+ /**
3255
+ * App instance ID.
3256
+ * @format GUID
3257
+ */
2514
3258
  instanceId?: string | null;
2515
- /** Event type. */
3259
+ /**
3260
+ * Event type.
3261
+ * @maxLength 150
3262
+ */
2516
3263
  eventType?: string;
2517
3264
  /** The identification type and identity data. */
2518
3265
  identity?: IdentificationData;
@@ -2520,26 +3267,50 @@ export interface MessageEnvelope {
2520
3267
  data?: string;
2521
3268
  }
2522
3269
  export interface IdentificationData extends IdentificationDataIdOneOf {
2523
- /** ID of a site visitor that has not logged in to the site. */
3270
+ /**
3271
+ * ID of a site visitor that has not logged in to the site.
3272
+ * @format GUID
3273
+ */
2524
3274
  anonymousVisitorId?: string;
2525
- /** ID of a site visitor that has logged in to the site. */
3275
+ /**
3276
+ * ID of a site visitor that has logged in to the site.
3277
+ * @format GUID
3278
+ */
2526
3279
  memberId?: string;
2527
- /** ID of a Wix user (site owner, contributor, etc.). */
3280
+ /**
3281
+ * ID of a Wix user (site owner, contributor, etc.).
3282
+ * @format GUID
3283
+ */
2528
3284
  wixUserId?: string;
2529
- /** ID of an app. */
3285
+ /**
3286
+ * ID of an app.
3287
+ * @format GUID
3288
+ */
2530
3289
  appId?: string;
2531
3290
  /** @readonly */
2532
3291
  identityType?: WebhookIdentityType;
2533
3292
  }
2534
3293
  /** @oneof */
2535
3294
  export interface IdentificationDataIdOneOf {
2536
- /** ID of a site visitor that has not logged in to the site. */
3295
+ /**
3296
+ * ID of a site visitor that has not logged in to the site.
3297
+ * @format GUID
3298
+ */
2537
3299
  anonymousVisitorId?: string;
2538
- /** ID of a site visitor that has logged in to the site. */
3300
+ /**
3301
+ * ID of a site visitor that has logged in to the site.
3302
+ * @format GUID
3303
+ */
2539
3304
  memberId?: string;
2540
- /** ID of a Wix user (site owner, contributor, etc.). */
3305
+ /**
3306
+ * ID of a Wix user (site owner, contributor, etc.).
3307
+ * @format GUID
3308
+ */
2541
3309
  wixUserId?: string;
2542
- /** ID of an app. */
3310
+ /**
3311
+ * ID of an app.
3312
+ * @format GUID
3313
+ */
2543
3314
  appId?: string;
2544
3315
  }
2545
3316
  export declare enum WebhookIdentityType {
@@ -2999,6 +3770,14 @@ interface CustomContentReferenceNonNullableFields {
2999
3770
  interface ExternalReferenceNonNullableFields {
3000
3771
  appId: string;
3001
3772
  }
3773
+ interface ChargeNonNullableFields {
3774
+ cycleFrom: number;
3775
+ priceSummary?: PriceSummaryNonNullableFields;
3776
+ }
3777
+ interface SubscriptionChargesNonNullableFields {
3778
+ lineItemIds: string[];
3779
+ charges: ChargeNonNullableFields[];
3780
+ }
3002
3781
  interface CheckoutNonNullableFields {
3003
3782
  lineItems: LineItemNonNullableFields[];
3004
3783
  billingInfo?: AddressWithContactNonNullableFields;
@@ -3034,6 +3813,8 @@ interface CheckoutNonNullableFields {
3034
3813
  payAfterFreeTrial?: PriceSummaryNonNullableFields;
3035
3814
  /** @internal */
3036
3815
  paymentRequired: boolean;
3816
+ /** @internal */
3817
+ subscriptionCharges: SubscriptionChargesNonNullableFields[];
3037
3818
  }
3038
3819
  export interface CreateCheckoutResponseNonNullableFields {
3039
3820
  checkout?: CheckoutNonNullableFields;