@wix/auto_sdk_ecom_subscription-contracts 1.0.1 → 1.0.2

package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts

@@ -7,6 +7,7 @@
 export interface SubscriptionContract {
     /**
      * SubscriptionContract ID.
+     * @format GUID
      * @readonly
      */
     _id?: string | null;
@@ -28,12 +29,20 @@ export interface SubscriptionContract {
      * @readonly
      */
     _updatedDate?: Date | null;
-    /** Subscription option description. For example, `"1kg of selected coffee, once a month"`. */
+    /**
+     * Subscription option description. For example, `"1kg of selected coffee, once a month"`.
+     * @maxLength 500
+     */
     description?: string | null;
-    /** Subscription detailed information. */
+    /**
+     * Subscription detailed information.
+     * @immutable
+     */
     subscriptionSettings?: V1SubscriptionSettings;
     /**
      * Order line items.
+     * @minSize 1
+     * @maxSize 1
      * @readonly
      */
     lineItems?: OrderLineItem[];
@@ -46,12 +55,17 @@ export interface SubscriptionContract {
     buyerLanguage?: string | null;
     /** Weight measurement unit - defaults to site's weight unit. */
     weightUnit?: WeightUnit;
-    /** Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format. */
+    /**
+     * Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
+     * @format CURRENCY
+     * @immutable
+     */
     currency?: string | null;
     /**
      * Whether tax is included in line item prices.
      *
      * Default: `false`
+     * @immutable
      */
     taxIncludedInPrices?: boolean;
     /**
@@ -83,19 +97,33 @@ export interface SubscriptionContract {
      * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls.
      */
     extendedFields?: ExtendedFields;
-    /** Subscription option title. For example, `"Monthly coffee Subscription"`. */
+    /**
+     * Subscription option title. For example, `"Monthly coffee Subscription"`.
+     * @minLength 1
+     * @maxLength 150
+     */
     title?: string | null;
-    /** Additional fees applied to subscription contract. */
+    /**
+     * Additional fees applied to subscription contract.
+     * @maxSize 100
+     */
     additionalFees?: AdditionalFee[];
 }
 export interface V1SubscriptionSettings {
     /** Frequency of recurring payment. */
     frequency?: SubscriptionFrequency;
-    /** Interval of recurring payment. */
+    /**
+     * Interval of recurring payment.
+     * @min 1
+     * @max 50
+     */
     interval?: number | null;
     /** Whether subscription is renewed automatically at the end of each period. */
     autoRenewal?: boolean;
-    /** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */
+    /**
+     * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
+     * @min 1
+     */
     billingCycles?: number | null;
     /** Whether to allow the customer to cancel the subscription. */
     enableCustomerCancellation?: boolean;
@@ -120,11 +148,18 @@ export declare enum SubscriptionFrequency {
 export interface V1FreeTrialPeriod {
     /** Frequency of priod. Values: DAY, WEEK, MONTH, YEAR */
     frequency?: SubscriptionFrequency;
-    /** interval of period */
+    /**
+     * interval of period
+     * @min 1
+     * @max 50
+     */
     interval?: number;
 }
 export interface OrderLineItem {
-    /** Line item ID. */
+    /**
+     * Line item ID.
+     * @immutable
+     */
     _id?: string;
     /**
      * Item name.
@@ -138,14 +173,21 @@ export interface OrderLineItem {
      * This field may be empty in the case of a custom line item.
      */
     catalogReference?: CatalogReference;
-    /** Line item quantity. */
+    /**
+     * Line item quantity.
+     * @min 1
+     * @max 100000
+     */
     quantity?: number;
     /**
      * Total discount for this line item's entire quantity.
      * @readonly
      */
     totalDiscount?: Price;
-    /** Line item description lines. Used for display purposes for the cart, checkout and order. */
+    /**
+     * Line item description lines. Used for display purposes for the cart, checkout and order.
+     * @maxSize 20
+     */
     descriptionLines?: DescriptionLine[];
     /** Line item image. */
     image?: string;
@@ -156,11 +198,18 @@ export interface OrderLineItem {
     /**
      * Fulfiller ID. Field is empty when the line item is self-fulfilled.
      * To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/list-fulfillments-for-single-order).
+     * @format GUID
      */
     fulfillerId?: string | null;
-    /** Number of items that were refunded. */
+    /**
+     * Number of items that were refunded.
+     * @max 100000
+     */
     refundQuantity?: number | null;
-    /** Number of items restocked. */
+    /**
+     * Number of items restocked.
+     * @max 100000
+     */
     restockQuantity?: number | null;
     /** Line item price after line item discounts for display purposes. */
     price?: Price;
@@ -180,11 +229,9 @@ export interface OrderLineItem {
      */
     totalPriceAfterTax?: Price;
     /**
-     * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
-     * + `FULL_PAYMENT_ONLINE` - The entire payment for this item happens as part of the checkout.
-     * + `FULL_PAYMENT_OFFLINE` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
-     * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
-     * + `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Eligible for catalog items with type `DEPOSIT_ONLINE` only.
+     * Type of selected payment option for current item.
+     *
+     * Default: `FULL_PAYMENT_ONLINE`
      */
     paymentOption?: PaymentOptionType;
     /**
@@ -219,6 +266,7 @@ export interface OrderLineItem {
     /**
      * ID of the app managing the inventory.
      * @internal
+     * @format GUID
      */
     inventoryAppId?: string | null;
     /**
@@ -234,6 +282,8 @@ export interface ProductName {
      *
      * Min: 1 character.
      * Max: 200 characters.
+     * @minLength 1
+     * @maxLength 200
      */
     original?: string;
     /**
@@ -242,12 +292,18 @@ export interface ProductName {
      * Min: 1 character.
      * Max: 400 characters.
      * Default: Same as `original`.
+     * @minLength 1
+     * @maxLength 400
      */
     translated?: string | null;
 }
 /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
 export interface CatalogReference {
-    /** ID of the item within the catalog it belongs to. */
+    /**
+     * ID of the item within the catalog it belongs to.
+     * @minLength 1
+     * @maxLength 36
+     */
     catalogItemId?: string;
     /**
      * ID of the app providing the catalog.
@@ -258,6 +314,7 @@ export interface CatalogReference {
      * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
      * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
      * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
+     * @minLength 1
      */
     appId?: string;
     /**
@@ -268,7 +325,10 @@ export interface CatalogReference {
     options?: Record<string, any> | null;
 }
 export interface Price {
-    /** Amount. */
+    /**
+     * Amount.
+     * @decimalValue options { gte:0, lte:1000000000000000 }
+     */
     amount?: string;
     /**
      * Amount formatted with currency symbol.
@@ -295,32 +355,44 @@ export interface DescriptionLineValueOneOf {
 export interface DescriptionLineDescriptionLineValueOneOf {
 }
 export interface DescriptionLineName {
-    /** 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). */
+    /**
+     * 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).
+     * @maxLength 100
+     */
     original?: string;
     /**
      * Description line name translated into the buyer's language.
      *
      * Default: Same as `original`.
+     * @maxLength 200
      */
     translated?: string | null;
 }
 export interface PlainTextValue {
-    /** 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). */
+    /**
+     * 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).
+     * @maxLength 600
+     */
     original?: string;
     /**
      * Description line plain text value translated into the buyer's language.
      *
      * Default: Same as `original`.
+     * @maxLength 600
      */
     translated?: string | null;
 }
 export interface Color {
-    /** 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). */
+    /**
+     * 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).
+     * @maxLength 500
+     */
     original?: string;
     /**
      * Description line color name translated into the buyer's language.
      *
      * Default: Same as `original`.
+     * @maxLength 500
      */
     translated?: string | null;
     /** HEX or RGB color code for display. */
@@ -347,7 +419,10 @@ export interface FocalPoint {
 export interface PhysicalProperties {
     /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
     weight?: number | null;
-    /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
+    /**
+     * Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
+     * @maxLength 40
+     */
     sku?: string | null;
     /** Whether this line item is shippable. */
     shippable?: boolean;
@@ -388,7 +463,10 @@ export declare enum PaymentOptionType {
 export interface ItemTaxFullDetails {
     /** Taxable amount of this line item. */
     taxableAmount?: Price;
-    /** Tax rate percentage, as a decimal numeral between 0 and 1. For example, `"0.13"`. */
+    /**
+     * Tax rate percentage, as a decimal numeral between 0 and 1. For example, `"0.13"`.
+     * @decimalValue options { gte:0, maxScale:6 }
+     */
     taxRate?: string;
     /** The calculated tax, based on the `taxableAmount` and `taxRate`. */
     totalTax?: Price;
@@ -398,16 +476,24 @@ export interface LineItemTaxInfo {
     taxAmount?: Price;
     /** Amount for which tax is calculated. */
     taxableAmount?: Price;
-    /** Tax rate %, as a decimal point. */
+    /**
+     * Tax rate %, as a decimal point.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0, maxScale:6 }
+     */
     taxRate?: string | null;
     /**
      * Tax group ID.
      * Learn more about [Tax Groups](https://dev.wix.com/docs/rest/business-management/payments/tax/tax-groups/introduction).
+     * @format GUID
      */
     taxGroupId?: string | null;
     /** Indicates whether the price already includes tax. */
     taxIncludedInPrice?: boolean;
-    /** Tax information for a line item. */
+    /**
+     * Tax information for a line item.
+     * @maxSize 7
+     */
     taxBreakdown?: LineItemTaxBreakdown[];
 }
 /**
@@ -415,17 +501,28 @@ export interface LineItemTaxInfo {
  * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
  */
 export interface LineItemTaxBreakdown {
-    /** Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec". */
+    /**
+     * Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
+     * @maxLength 200
+     */
     jurisdiction?: string | null;
-    /** Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000. */
+    /**
+     * Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0, maxScale:6 }
+     */
     rate?: string | null;
     /** Amount of tax calculated for this line item. */
     taxAmount?: Price;
-    /** The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc. */
+    /**
+     * The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
+     * @maxLength 200
+     */
     taxType?: string | null;
     /**
      * The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
      * This name should be explicit enough to allow the merchant to understand what tax was calculated.
+     * @maxLength 200
      */
     taxName?: string | null;
     /** Type of jurisdiction that taxes were calculated for. */
@@ -445,9 +542,18 @@ export declare enum JurisdictionType {
     SPECIAL = "SPECIAL"
 }
 export interface DigitalFile {
-    /** ID of the secure file in media. */
+    /**
+     * ID of the secure file in media.
+     * @minLength 1
+     * @maxLength 100
+     */
     fileId?: string;
-    /** Link will exist after the digital links have been generated on the order. */
+    /**
+     * Link will exist after the digital links have been generated on the order.
+     * @format WEB_URL
+     * @minLength 1
+     * @maxLength 2000
+     */
     link?: string | null;
     /**
      * Link expiration time and date.
@@ -456,30 +562,54 @@ export interface DigitalFile {
     expirationDate?: Date | null;
 }
 export interface SubscriptionInfo {
-    /** Subscription ID. */
+    /**
+     * Subscription ID.
+     * @format GUID
+     */
     _id?: string | null;
-    /** Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`. */
+    /**
+     * Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`.
+     * @min 1
+     */
     cycleNumber?: number;
-    /** Subscription option title. For example, `"Monthly coffee Subscription"`. */
+    /**
+     * Subscription option title. For example, `"Monthly coffee Subscription"`.
+     * @minLength 1
+     * @maxLength 20
+     */
     subscriptionOptionTitle?: string;
-    /** Subscription option description. For example, `"1kg of selected coffee, once a month"`. */
+    /**
+     * Subscription option description. For example, `"1kg of selected coffee, once a month"`.
+     * @maxLength 60
+     */
     subscriptionOptionDescription?: string | null;
-    /** Subscription detailed information. */
+    /**
+     * Subscription detailed information.
+     * @immutable
+     */
     subscriptionSettings?: SubscriptionSettings;
     /**
      * Description of the charges that will be applied for subscription.
      * @internal
+     * @maxLength 1000
      */
     chargesDescription?: string | null;
 }
 export interface SubscriptionSettings {
     /** Frequency of recurring payment. */
     frequency?: V2SubscriptionFrequency;
-    /** Interval of recurring payment. */
+    /**
+     * Interval of recurring payment.
+     * @min 1
+     * @max 50
+     */
     interval?: number | null;
     /** Whether subscription is renewed automatically at the end of each period. */
     autoRenewal?: boolean;
-    /** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */
+    /**
+     * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
+     * @min 1
+     */
     billingCycles?: number | null;
     /**
      * Whether to allow the customer to cancel the subscription.
@@ -508,33 +638,52 @@ export declare enum V2SubscriptionFrequency {
 export interface FreeTrialPeriod {
     /** Frequency of priod. Values: DAY, WEEK, MONTH, YEAR */
     frequency?: V2SubscriptionFrequency;
-    /** interval of period */
+    /**
+     * interval of period
+     * @min 1
+     * @max 50
+     */
     interval?: number;
 }
 export interface PriceDescription {
-    /** __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). */
+    /**
+     * __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).
+     * @minLength 1
+     * @maxLength 100
+     */
     original?: string;
     /**
      * Price description translated into the buyer's language.
      *
      * Default: Same as `original`.
+     * @minLength 1
+     * @maxLength 100
      */
     translated?: string | null;
 }
 export interface LocationAndQuantity {
-    /** Location id in the associated owner app. */
+    /**
+     * Location id in the associated owner app.
+     * @format GUID
+     */
     _id?: string;
     /**
      * Location owner app, if not provided then the site business info locations will be used.
+     * @format GUID
      * @deprecated Location owner app, if not provided then the site business info locations will be used.
      * @targetRemovalDate 2025-03-01
      */
     appId?: string | null;
-    /** Quantity for specific location. */
+    /**
+     * Quantity for specific location.
+     * @min 1
+     * @max 100000
+     */
     quantity?: number;
     /**
      * Location name.
      * @internal
+     * @maxLength 500
      * @readonly
      */
     name?: string | null;
@@ -567,20 +716,38 @@ export interface ExtendedFields {
 }
 /** Buyer Info */
 export interface BuyerInfo extends BuyerInfoIdOneOf {
-    /** Visitor ID (if site visitor is not a member). */
+    /**
+     * Visitor ID (if site visitor is not a member).
+     * @format GUID
+     */
     visitorId?: string;
-    /** Member ID (if site visitor is a site member). */
+    /**
+     * Member ID (if site visitor is a site member).
+     * @format GUID
+     */
     memberId?: string;
-    /** 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). */
+    /**
+     * 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).
+     * @format GUID
+     */
     contactId?: string | null;
-    /** Buyer email address. */
+    /**
+     * Buyer email address.
+     * @format EMAIL
+     */
     email?: string | null;
 }
 /** @oneof */
 export interface BuyerInfoIdOneOf {
-    /** Visitor ID (if site visitor is not a member). */
+    /**
+     * Visitor ID (if site visitor is not a member).
+     * @format GUID
+     */
     visitorId?: string;
-    /** Member ID (if site visitor is a site member). */
+    /**
+     * Member ID (if site visitor is a site member).
+     * @format GUID
+     */
     memberId?: string;
 }
 export declare enum WeightUnit {
@@ -614,19 +781,37 @@ export interface AddressWithContact {
 }
 /** Physical address */
 export interface Address {
-    /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */
+    /**
+     * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
+     * @format COUNTRY
+     */
     country?: string | null;
-    /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */
+    /**
+     * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
+     * @maxLength 50
+     */
     subdivision?: string | null;
-    /** City name. */
+    /**
+     * City name.
+     * @maxLength 50
+     */
     city?: string | null;
-    /** Postal or zip code. */
+    /**
+     * Postal or zip code.
+     * @maxLength 50
+     */
     postalCode?: string | null;
     /** Street address. */
     streetAddress?: StreetAddress;
-    /** Main address line (usually street name and number). */
+    /**
+     * Main address line (usually street name and number).
+     * @maxLength 150
+     */
     addressLine1?: string | null;
-    /** Free text providing more detailed address info. Usually contains apt, suite, floor. */
+    /**
+     * Free text providing more detailed address info. Usually contains apt, suite, floor.
+     * @maxLength 100
+     */
     addressLine2?: string | null;
     /**
      * Country's full name.
@@ -653,13 +838,25 @@ export interface AddressLocation {
 }
 /** Full contact details for an address */
 export interface FullAddressContactDetails {
-    /** First name. */
+    /**
+     * First name.
+     * @maxLength 100
+     */
     firstName?: string | null;
-    /** Last name. */
+    /**
+     * Last name.
+     * @maxLength 100
+     */
     lastName?: string | null;
-    /** Phone number. */
+    /**
+     * Phone number.
+     * @format PHONE
+     */
     phone?: string | null;
-    /** Company name. */
+    /**
+     * Company name.
+     * @maxLength 1000
+     */
     company?: string | null;
     /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
     vatId?: VatId;
@@ -685,13 +882,22 @@ export declare enum VatType {
     CNPJ = "CNPJ"
 }
 export interface ShippingInformation {
-    /** App Def Id of external provider which was a source of shipping info */
+    /**
+     * App Def Id of external provider which was a source of shipping info
+     * @minLength 1
+     * @maxLength 100
+     */
     carrierId?: string | null;
-    /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`. */
+    /**
+     * Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`.
+     * @minLength 1
+     * @maxLength 100
+     */
     code?: string | null;
     /**
      * Shipping option title.
      * For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`.
+     * @maxLength 250
      */
     title?: string;
     /** Shipping logistics. */
@@ -706,9 +912,15 @@ export interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
     shippingDestination?: AddressWithContact;
     /** Pickup details. */
     pickupDetails?: PickupDetails;
-    /** Expected delivery time in free text. For example, `"3-5 business days"`. */
+    /**
+     * Expected delivery time in free text. For example, `"3-5 business days"`.
+     * @maxLength 500
+     */
     deliveryTime?: string | null;
-    /** Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`. */
+    /**
+     * Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`.
+     * @maxLength 1000
+     */
     instructions?: string | null;
     /**
      * Deprecated - Latest expected delivery date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
@@ -733,19 +945,37 @@ export interface PickupDetails {
 }
 /** Physical address */
 export interface PickupAddress {
-    /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */
+    /**
+     * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
+     * @format COUNTRY
+     */
     country?: string | null;
-    /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */
+    /**
+     * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
+     * @maxLength 50
+     */
     subdivision?: string | null;
-    /** City name. */
+    /**
+     * City name.
+     * @maxLength 1000
+     */
     city?: string | null;
-    /** Postal or zip code. */
+    /**
+     * Postal or zip code.
+     * @maxLength 1000
+     */
     postalCode?: string | null;
     /** Street address object, with number, name, and apartment number in separate fields. */
     streetAddress?: StreetAddress;
-    /** Main address line (usually street name and number). */
+    /**
+     * Main address line (usually street name and number).
+     * @maxLength 1000
+     */
     addressLine1?: string | null;
-    /** Free text providing more detailed address info. Usually contains apt, suite, floor. */
+    /**
+     * Free text providing more detailed address info. Usually contains apt, suite, floor.
+     * @maxLength 1000
+     */
     addressLine2?: string | null;
     /**
      * Country's full name.
@@ -791,13 +1021,19 @@ export interface ShippingPrice {
     discount?: Price;
 }
 export interface ShippingRegion {
-    /** Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`. */
+    /**
+     * Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
+     * @maxLength 100
+     */
     name?: string | null;
 }
 export interface OrderTaxInfo {
     /** Calculated tax, added from line items. */
     totalTax?: Price;
-    /** The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate. */
+    /**
+     * The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
+     * @maxSize 50
+     */
     taxBreakdown?: OrderTaxBreakdown[];
     /**
      * Whether the order is exempt from tax calculations.
@@ -812,15 +1048,28 @@ export interface OrderTaxInfo {
  * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
  */
 export interface OrderTaxBreakdown {
-    /** The name of the tax against which this tax amount was calculated. */
+    /**
+     * The name of the tax against which this tax amount was calculated.
+     * @maxLength 200
+     */
     taxName?: string;
-    /** The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws. */
+    /**
+     * The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.
+     * @maxLength 200
+     */
     taxType?: string;
-    /** The name of the jurisdiction in which this tax detail applies. */
+    /**
+     * The name of the jurisdiction in which this tax detail applies.
+     * @maxLength 200
+     */
     jurisdiction?: string;
     /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
     jurisdictionType?: JurisdictionType;
-    /** The rate at which this tax detail was calculated. */
+    /**
+     * The rate at which this tax detail was calculated.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0, maxScale:6 }
+     */
     rate?: string;
     /** The sum of all the tax from line items that calculated by the tax identifiers. */
     aggregatedTaxAmount?: Price;
@@ -842,18 +1091,26 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
     /**
      * IDs of line items discount applies to.
      * Deprecated. Use `line_item_discounts` instead.
+     * @format GUID
+     * @maxSize 1
      * @deprecated IDs of line items discount applies to.
      * Deprecated. Use `line_item_discounts` instead.
      * @replacedBy line_item_discounts
      * @targetRemovalDate 2024-10-30
      */
     lineItemIds?: string[];
-    /** Discount id. */
+    /**
+     * Discount id.
+     * @format GUID
+     * @immutable
+     */
     _id?: string | null;
     /**
      * Number of subscription billing cycles the discount applies to.
      * If None and discount is linked to subscription line item, it applies to all cycles.
      * @internal
+     * @min 1
+     * @max 999
      */
     subscriptionCycles?: number | null;
 }
@@ -888,13 +1145,18 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
      * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
      */
     discountReason?: DiscountReason;
-    /** Discount description as free text (optional). */
+    /**
+     * Discount description as free text (optional).
+     * @maxLength 200
+     */
     description?: string | null;
     /** Discount amount. */
     amount?: Price;
     /**
      * Discount percentage.
      * @internal
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0, lte:100, maxScale:2 }
      */
     percentage?: string | null;
 }
@@ -905,7 +1167,10 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
      * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
      */
     discountReason?: DiscountReason;
-    /** Discount description as free text (optional). */
+    /**
+     * Discount description as free text (optional).
+     * @maxLength 200
+     */
     description?: string | null;
 }
 export declare enum DiscountReason {
@@ -913,7 +1178,10 @@ export declare enum DiscountReason {
     EXCHANGED_ITEMS = "EXCHANGED_ITEMS"
 }
 export interface DiscountRule {
-    /** Discount rule ID */
+    /**
+     * Discount rule ID
+     * @format GUID
+     */
     _id?: string;
     /** Discount rule name */
     name?: DiscountRuleName;
@@ -921,13 +1189,24 @@ export interface DiscountRule {
     amount?: Price;
 }
 export interface DiscountRuleName {
-    /** Original discount rule name (in site's default language). */
+    /**
+     * Original discount rule name (in site's default language).
+     * @minLength 1
+     * @maxLength 256
+     */
     original?: string;
-    /** Translated discount rule name according to buyer language. Defaults to `original` when not provided. */
+    /**
+     * Translated discount rule name according to buyer language. Defaults to `original` when not provided.
+     * @minLength 1
+     * @maxLength 500
+     */
     translated?: string | null;
 }
 export interface LineItemDiscount {
-    /** ID of line item the discount applies to. */
+    /**
+     * ID of line item the discount applies to.
+     * @format GUID
+     */
     _id?: string;
     /** Total discount for this line item. */
     totalDiscount?: Price;
@@ -935,9 +1214,15 @@ export interface LineItemDiscount {
 export interface ChannelInfo {
     /** Sales channel that submitted the order. */
     type?: ChannelType;
-    /** Reference to an order ID from an external system. */
+    /**
+     * Reference to an order ID from an external system.
+     * @maxLength 100
+     */
     externalOrderId?: string | null;
-    /** URL to the order in the external system. */
+    /**
+     * URL to the order in the external system.
+     * @maxLength 300
+     */
     externalOrderUrl?: string | null;
 }
 export declare enum ChannelType {
@@ -977,37 +1262,63 @@ export declare enum ChannelType {
 export interface CustomField {
     /** Custom field value. */
     value?: any;
-    /** Custom field title. */
+    /**
+     * Custom field title.
+     * @minLength 1
+     * @maxLength 500
+     */
     title?: string;
-    /** Translated custom field title. */
+    /**
+     * Translated custom field title.
+     * @minLength 1
+     * @maxLength 500
+     */
     translatedTitle?: string | null;
 }
 export interface AdditionalFee {
-    /** Additional fee's unique code for future processing. */
+    /**
+     * Additional fee's unique code for future processing.
+     * @minLength 1
+     * @maxLength 100
+     */
     code?: string | null;
-    /** Name of additional fee. */
+    /**
+     * Name of additional fee.
+     * @minLength 1
+     * @maxLength 50
+     */
     name?: string;
     /** Additional fee's price. */
     price?: Price;
     /** Tax details. */
     taxDetails?: ItemTaxFullDetails;
-    /** SPI implementer's `appId`. */
+    /**
+     * SPI implementer's `appId`.
+     * @format GUID
+     */
     providerAppId?: string | null;
     /** Additional fee's price before tax. */
     priceBeforeTax?: Price;
     /** Additional fee's price after tax. */
     priceAfterTax?: Price;
-    /** Additional fee's id. */
+    /**
+     * Additional fee's id.
+     * @format GUID
+     * @immutable
+     */
     _id?: string;
     /**
      * Optional - Line items associated with this additional fee.
      * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
+     * @format GUID
      */
     lineItemIds?: string[];
     /**
      * Number of subscription billing cycles the additional fee applies to.
      * If None and additional fee is linked to subscription line item, it applies to all cycles.
      * @internal
+     * @min 1
+     * @max 999
      */
     subscriptionCycles?: number | null;
 }
@@ -1015,10 +1326,13 @@ export interface Location {
     /**
      * Location ID.
      * Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
+     * @format GUID
      */
     _id?: string;
     /**
      * Location name.
+     * @minLength 1
+     * @maxLength 500
      * @readonly
      */
     name?: string;
@@ -1032,7 +1346,10 @@ export interface CreateSubscriptionContractResponse {
     subscriptionContract?: SubscriptionContract;
 }
 export interface GetSubscriptionContractRequest {
-    /** ID of the SubscriptionContract to retrieve. */
+    /**
+     * ID of the SubscriptionContract to retrieve.
+     * @format GUID
+     */
     subscriptionContractId: string;
 }
 export interface GetSubscriptionContractResponse {
@@ -1068,6 +1385,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
      * Sort object in the following format:
      * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
      * Learn more about the [sort format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     * @maxSize 5
      */
     sort?: Sorting[];
 }
@@ -1077,7 +1395,10 @@ export interface CursorQueryPagingMethodOneOf {
     cursorPaging?: CursorPaging;
 }
 export interface Sorting {
-    /** Name of the field to sort by. */
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
     fieldName?: string;
     /** Sort order. */
     order?: SortOrder;
@@ -1087,13 +1408,17 @@ export declare enum SortOrder {
     DESC = "DESC"
 }
 export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
     limit?: number | null;
     /**
      * Pointer to the next or previous page in the list of results.
      *
      * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
      * Not relevant for the first request.
+     * @maxLength 16000
      */
     cursor?: string | null;
 }
@@ -1117,9 +1442,15 @@ export interface CursorPagingMetadata {
     hasNext?: boolean | null;
 }
 export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
     next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
     prev?: string | null;
 }
 export interface DomainEvent extends DomainEventBodyOneOf {
@@ -1195,9 +1526,15 @@ export interface ActionEvent {
 export interface Empty {
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -1205,26 +1542,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {
@@ -1503,9 +1864,15 @@ export interface QuerySubscriptionContractsResponseNonNullableFields {
     subscriptionContracts: SubscriptionContractNonNullableFields[];
 }
 export interface BaseEventMetadata {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -1556,11 +1923,14 @@ export interface SubscriptionContractCreatedEnvelope {
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Read eCommerce - all read permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
  * @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
  * @webhook
  * @eventType wix.ecom.subscription_contracts.v1.subscription_contract_created
+ * @slug created
  * @documentationMaturity preview
  */
 export declare function onSubscriptionContractCreated(handler: (event: SubscriptionContractCreatedEnvelope) => void | Promise<void>): void;
@@ -1571,11 +1941,14 @@ export interface SubscriptionContractDeletedEnvelope {
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Read eCommerce - all read permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
  * @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
  * @webhook
  * @eventType wix.ecom.subscription_contracts.v1.subscription_contract_deleted
+ * @slug deleted
  * @documentationMaturity preview
  */
 export declare function onSubscriptionContractDeleted(handler: (event: SubscriptionContractDeletedEnvelope) => void | Promise<void>): void;
@@ -1587,11 +1960,14 @@ export interface SubscriptionContractUpdatedEnvelope {
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Read eCommerce - all read permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
  * @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
  * @webhook
  * @eventType wix.ecom.subscription_contracts.v1.subscription_contract_updated
+ * @slug updated
  * @documentationMaturity preview
  */
 export declare function onSubscriptionContractUpdated(handler: (event: SubscriptionContractUpdatedEnvelope) => void | Promise<void>): void;
@@ -1606,6 +1982,8 @@ export declare function onSubscriptionContractUpdated(handler: (event: Subscript
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Read eCommerce - all read permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
  * @applicableIdentity APP
@@ -1628,6 +2006,8 @@ export declare function getSubscriptionContract(subscriptionContractId: string):
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Read eCommerce - all read permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
  * @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ