@wix/auto_sdk_ecom_cart 1.0.3 → 1.0.4

package/build/internal/cjs/src/ecom-v1-cart-cart.universal.d.ts

@@ -1,17 +1,26 @@
 export interface Cart {
-    /** Cart ID. */
+    /**
+     * Cart ID.
+     * @format GUID
+     */
     _id?: string | null;
     /**
      * Line items.
+     * @minSize 1
+     * @maxSize 300
      * @readonly
      */
     lineItems?: LineItem[];
-    /** [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. */
+    /**
+     * [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
+     * @maxLength 1000
+     */
     buyerNote?: string | null;
     /** Buyer information. */
     buyerInfo?: BuyerInfo;
     /**
      * Currency used for pricing.
+     * @format CURRENCY
      * @readonly
      */
     currency?: string;
@@ -19,6 +28,7 @@ export interface Cart {
      * Currency code used for all the converted prices that are returned.
      * For a site that supports multiple currencies, this is the currency the buyer selected.
      * @readonly
+     * @format CURRENCY
      */
     conversionCurrency?: string;
     /**
@@ -45,6 +55,7 @@ export interface Cart {
     /**
      * ID of the checkout that originated from this cart.
      * @readonly
+     * @format GUID
      */
     checkoutId?: string | null;
     /**
@@ -68,10 +79,12 @@ export interface Cart {
      * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
      *
      * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
+     * @maxLength 1000
      */
     overrideCheckoutUrl?: string | null;
     /**
      * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
+     * @format GUID
      * @readonly
      */
     purchaseFlowId?: string | null;
@@ -80,16 +93,22 @@ export interface Cart {
     /**
      * The business location ID associated with the cart.
      * Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
+     * @format GUID
      */
     businessLocationId?: string | null;
 }
 export interface LineItem {
     /**
      * Line item ID.
+     * @format GUID
      * @readonly
      */
     _id?: string | null;
-    /** Item quantity. */
+    /**
+     * Item quantity.
+     * @min 1
+     * @max 100000
+     */
     quantity?: number;
     /** Catalog and item reference. Holds 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. */
     catalogReference?: CatalogReference;
@@ -170,6 +189,8 @@ export interface LineItem {
      * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
      * + in most cases, this field is the same as `catalogReference.catalogItemId`.
      * + Used in membership validation.
+     * @minLength 1
+     * @maxLength 36
      * @readonly
      */
     rootCatalogItemId?: string | null;
@@ -186,13 +207,14 @@ export interface LineItem {
     /** Selected membership to be used as payment for this item. Must be used with `lineItem.paymentOption` set to `MEMBERSHIP` or `MEMBERSHIP_OFFLINE`. This field can be empty when `lineItem.paymentOption` is set to `MEMBERSHIP_OFFLINE`. */
     selectedMembership?: SelectedMembership;
     /**
-     * The Item's Delivery Profile Id
-     * @internal
+     * Delivery profile ID.
+     * @format GUID
      * @readonly
      */
     deliveryProfileId?: string | null;
     /**
      * Tax group ID for this line item.
+     * @format GUID
      * @readonly
      */
     taxGroupId?: string | null;
@@ -203,6 +225,8 @@ export interface LineItem {
     customLineItem?: boolean;
     /**
      * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
+     * @minLength 1
+     * @maxLength 2500
      * @readonly
      */
     consentRequiredPaymentPolicy?: string | null;
@@ -233,7 +257,7 @@ export interface LineItem {
      */
     savePaymentMethod?: boolean;
     /**
-     * Address to be used for tax calculation.
+     * Address to use for tax calculation purposes.
      * @internal
      */
     taxableAddress?: TaxableAddress;
@@ -248,11 +272,13 @@ export interface LineItem {
      * Policies to be displayed to the customer on the checkout page.
      * @internal
      * @readonly
+     * @maxSize 5
      */
     policies?: Policy[];
     /**
      * ID of the app managing the inventory.
      * @internal
+     * @format GUID
      */
     inventoryAppId?: string | null;
     /**
@@ -266,7 +292,11 @@ export interface LineItem {
 }
 /** 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.
@@ -277,6 +307,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;
     /**
@@ -289,17 +320,29 @@ export interface CatalogReference {
     options?: Record<string, any> | null;
 }
 export interface ProductName {
-    /** **Required** - Original product name (in site's default language). */
+    /**
+     * **Required** - Original product name (in site's default language).
+     * @minLength 1
+     * @maxLength 200
+     */
     original?: string;
-    /** Description product name translated into buyer's language. Defaults to `original` when not defined. */
+    /**
+     * Description product name translated into buyer's language. Defaults to `original` when not defined.
+     * @minLength 1
+     * @maxLength 400
+     */
     translated?: string | null;
 }
 export interface MultiCurrencyPrice {
-    /** Amount. */
+    /**
+     * Amount.
+     * @decimalValue options { gte:0, lte:1000000000000000 }
+     */
     amount?: string;
     /**
      * Converted amount.
      * @readonly
+     * @decimalValue options { gte:0, lte:1000000000000000 }
      */
     convertedAmount?: string;
     /**
@@ -332,21 +375,39 @@ export interface DescriptionLineValueOneOf {
 export interface DescriptionLineDescriptionLineValueOneOf {
 }
 export interface DescriptionLineName {
-    /** Description line name in site's default language. */
+    /**
+     * Description line name in site's default language.
+     * @maxLength 100
+     */
     original?: string;
-    /** Description line name translated into buyer's language. Defaults to `original` when not defined. */
+    /**
+     * Description line name translated into buyer's language. Defaults to `original` when not defined.
+     * @maxLength 200
+     */
     translated?: string | null;
 }
 export interface PlainTextValue {
-    /** Description line plain text value in site's default language. */
+    /**
+     * Description line plain text value in site's default language.
+     * @maxLength 600
+     */
     original?: string;
-    /** Description line plain text value translated into buyer's language. Defaults to `original` when not defined. */
+    /**
+     * Description line plain text value translated into buyer's language. Defaults to `original` when not defined.
+     * @maxLength 600
+     */
     translated?: string | null;
 }
 export interface Color {
-    /** Description line color name in site's default language. */
+    /**
+     * Description line color name in site's default language.
+     * @maxLength 500
+     */
     original?: string;
-    /** Description line color name translated into buyer's language. Defaults to `original` when not defined. */
+    /**
+     * Description line color name translated into buyer's language. Defaults to `original` when not defined.
+     * @maxLength 500
+     */
     translated?: string | null;
     /**
      * HEX or RGB color code for display.
@@ -396,7 +457,10 @@ export declare enum ItemAvailabilityStatus {
 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;
@@ -449,11 +513,16 @@ export interface SubscriptionSettings {
      *
      * Default: `1`.
      * If SubscriptionFrequency is Day the minimum interval is 7
+     * @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` is `true`. */
+    /**
+     * Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`.
+     * @min 1
+     */
     billingCycles?: number | null;
     /**
      * Whether to allow the customer to cancel the subscription..
@@ -483,29 +552,53 @@ export declare enum SubscriptionFrequency {
 export interface FreeTrialPeriod {
     /** Frequency of priod. Values: DAY, WEEK, MONTH, YEAR */
     frequency?: SubscriptionFrequency;
-    /** interval of period */
+    /**
+     * interval of period
+     * @min 1
+     * @max 50
+     */
     interval?: number;
 }
 export interface Title {
-    /** 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). */
+    /**
+     * 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).
+     * @minLength 1
+     * @maxLength 150
+     */
     original?: string;
     /**
      * Subscription option name translated into the buyer's language.
      *
      * Default: Same as `original`.
+     * @minLength 1
+     * @maxLength 150
      */
     translated?: string | null;
 }
 export interface Description {
-    /** Subscription option description. */
+    /**
+     * Subscription option description.
+     * @maxLength 500
+     */
     original?: string;
-    /** Translated subscription option description. */
+    /**
+     * Translated subscription option description.
+     * @maxLength 500
+     */
     translated?: string | null;
 }
 export interface SecuredMedia {
-    /** Media ID in Wix Media Manager. */
+    /**
+     * Media ID in Wix Media Manager.
+     * @minLength 1
+     * @maxLength 100
+     */
     _id?: string;
-    /** Original filename. */
+    /**
+     * Original filename.
+     * @minLength 1
+     * @maxLength 1000
+     */
     fileName?: string;
     /** File type. */
     fileType?: FileType;
@@ -534,33 +627,59 @@ export declare enum PaymentOptionType {
 export interface ServiceProperties {
     /** The date and time for which the service is supposed to be provided. For example, the time of the class. */
     scheduledDate?: Date | null;
-    /** The number of people participating in this service. For example, the number of people attending the class or the number of people per hotel room. */
+    /**
+     * The number of people participating in this service. For example, the number of people attending the class or the number of people per hotel room.
+     * @min 1
+     * @max 10000
+     */
     numberOfParticipants?: number | null;
 }
 export interface PriceDescription {
     /**
      * **Required** - Original price description (in site's default language).
      *
+     * @minLength 1
+     * @maxLength 100
      */
     original?: string;
-    /** Product name translated into buyer's language. Defaults to `original` when not defined. */
+    /**
+     * Product name translated into buyer's language. Defaults to `original` when not defined.
+     * @minLength 1
+     * @maxLength 100
+     */
     translated?: string | null;
 }
 /** Selected Membership */
 export interface SelectedMembership {
-    /** Membership ID. */
+    /**
+     * Membership ID.
+     * @minLength 1
+     * @maxLength 100
+     */
     _id?: string;
-    /** ID of the app providing this payment option. */
+    /**
+     * ID of the app providing this payment option.
+     * @format GUID
+     */
     appId?: string;
 }
 export interface CatalogOverrideFields {
     /** Item name. */
     productName?: ProductName;
-    /** Item price **after** discounts. */
+    /**
+     * Item price **after** discounts.
+     * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
+     */
     price?: string | null;
-    /** Item price **before** discounts. */
+    /**
+     * Item price **before** discounts.
+     * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
+     */
     fullPrice?: string | null;
-    /** Item description lines. Used when displaying the line item to customers. */
+    /**
+     * Item description lines. Used when displaying the line item to customers.
+     * @maxSize 20
+     */
     descriptionLines?: DescriptionLine[];
     /** Physical properties of the item. */
     physicalProperties?: PhysicalProperties;
@@ -568,7 +687,11 @@ export interface CatalogOverrideFields {
     image?: string;
     /** Payment method selected for the item. */
     paymentOption?: PaymentOption;
-    /** Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`. */
+    /**
+     * Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gt:0, lte:999999999, maxScale:3 }
+     */
     depositAmount?: string | null;
     /**
      * Whether to save the payment method on the order.
@@ -579,11 +702,9 @@ export interface CatalogOverrideFields {
 }
 export interface PaymentOption {
     /**
-     * + `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 selected, `price` is `0`.
-     * + `DEPOSIT_ONLINE`: Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`.
-     * + `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`.
+     * Type of selected payment option for current item.
+     *
+     * Default: `FULL_PAYMENT_ONLINE`
      */
     value?: PaymentOptionType;
 }
@@ -614,47 +735,67 @@ export interface ExtendedFields {
     namespaces?: Record<string, Record<string, any>>;
 }
 export interface Policy {
-    /** Policy title - should be translated */
+    /**
+     * Policy title - should be translated
+     * @minLength 1
+     * @maxLength 29
+     */
     title?: string | null;
-    /** Policy content - should be translated */
+    /**
+     * Policy content - should be translated
+     * @minLength 1
+     * @maxLength 3000
+     */
     content?: string;
 }
 /** Buyer Info */
 export interface BuyerInfo extends BuyerInfoIdOneOf {
     /**
      * Visitor ID - if the buyer is **not** a site member.
+     * @format GUID
      * @readonly
      */
     visitorId?: string;
     /**
      * Member ID - if the buyer is a site member.
+     * @format GUID
      * @readonly
      */
     memberId?: string;
     /**
      * User ID - if the cart owner is a Wix user.
+     * @format GUID
      * @readonly
      */
     userId?: string;
-    /** Contact ID. For more information, see the Contacts API. */
+    /**
+     * Contact ID. For more information, see the Contacts API.
+     * @format GUID
+     */
     contactId?: string | null;
-    /** Buyer email address. */
+    /**
+     * Buyer email address.
+     * @format EMAIL
+     */
     email?: string | null;
 }
 /** @oneof */
 export interface BuyerInfoIdOneOf {
     /**
      * Visitor ID - if the buyer is **not** a site member.
+     * @format GUID
      * @readonly
      */
     visitorId?: string;
     /**
      * Member ID - if the buyer is a site member.
+     * @format GUID
      * @readonly
      */
     memberId?: string;
     /**
      * User ID - if the cart owner is a Wix user.
+     * @format GUID
      * @readonly
      */
     userId?: string;
@@ -711,7 +852,10 @@ export interface MerchantDiscount {
     amount?: MultiCurrencyPrice;
 }
 export interface DiscountRule {
-    /** Discount rule ID */
+    /**
+     * Discount rule ID
+     * @format GUID
+     */
     _id?: string;
     /** Discount rule name */
     name?: DiscountRuleName;
@@ -719,9 +863,17 @@ export interface DiscountRule {
     amount?: MultiCurrencyPrice;
 }
 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;
-    /** Discount rule name translated into buyer's language. Defaults to `original` when not defined. */
+    /**
+     * Discount rule name translated into buyer's language. Defaults to `original` when not defined.
+     * @minLength 1
+     * @maxLength 500
+     */
     translated?: string | null;
 }
 export declare enum DiscountType {
@@ -741,19 +893,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.
@@ -780,13 +950,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;
@@ -812,9 +994,16 @@ export declare enum VatType {
     CNPJ = "CNPJ"
 }
 export interface SelectedShippingOption {
-    /** Carrier ID. */
+    /**
+     * Carrier ID.
+     * @format GUID
+     */
     carrierId?: string | null;
-    /** Selected shipping option code. For example, "usps_std_overnight". */
+    /**
+     * Selected shipping option code. For example, "usps_std_overnight".
+     * @minLength 1
+     * @maxLength 100
+     */
     code?: string;
 }
 export interface GetCurrentCartRequest {
@@ -828,22 +1017,36 @@ export interface UpdateCartRequest {
     cartInfo?: Cart;
     /** The code of an existing coupon to apply to the cart. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
     couponCode?: string | null;
-    /** Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will be applied to the whole cart. */
+    /**
+     * Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will be applied to the whole cart.
+     * @maxSize 100
+     */
     merchantDiscounts?: MerchantDiscountInput[];
-    /** Catalog line items. */
+    /**
+     * Catalog line items.
+     * @maxSize 300
+     */
     lineItems?: LineItem[];
     /**
      * Custom line items. Custom line items don't trigger the Catalog service plugin.
      *
      * To access and manage custom line items, 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).
+     * @maxSize 300
      */
     customLineItems?: CustomLineItem[];
 }
 export interface MerchantDiscountInput {
-    /** Discount amount. */
+    /**
+     * Discount amount.
+     * @decimalValue options { gte:0 }
+     */
     amount?: string;
-    /** IDs of the line items the discount applies to. */
+    /**
+     * IDs of the line items the discount applies to.
+     * @format GUID
+     * @maxSize 300
+     */
     lineItemIds?: string[];
 }
 export interface CustomLineItem {
@@ -852,17 +1055,24 @@ export interface CustomLineItem {
      *
      * Min: `1`
      * Max: `100000`
+     * @min 1
+     * @max 100000
      */
     quantity?: number;
     /**
      * Custom line item price.
      *
      * Must be a number or a decimal without symbols.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0, lte:1000000000000000 }
      */
     price?: string;
     /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
     priceDescription?: PriceDescription;
-    /** Custom line item description lines. Used for displaying the cart, checkout and order. */
+    /**
+     * Custom line item description lines. Used for displaying the cart, checkout and order.
+     * @maxSize 10
+     */
     descriptionLines?: DescriptionLine[];
     /**
      * Custom line item media. Supported formats:
@@ -874,9 +1084,13 @@ export interface CustomLineItem {
      * Custom line item ID. If passed, `id` must be unique.
      *
      * Default: auto-generated ID
+     * @format GUID
      */
     _id?: string | null;
-    /** Tax group ID for this custom line item. */
+    /**
+     * Tax group ID for this custom line item.
+     * @format GUID
+     */
     taxGroupId?: string | null;
     /** Name of the item or product. */
     productName?: ProductName;
@@ -884,11 +1098,15 @@ export interface CustomLineItem {
     url?: string;
     /** Item type. Either a preset type or custom. */
     itemType?: ItemType;
-    /** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
+    /**
+     * Item price **before** catalog-defined discount. Defaults to `price` when not provided.
+     * @format DECIMAL_VALUE
+     */
     fullPrice?: string | null;
     /**
      * Item quantity available for purchase. Only return this if inventory is managed.
      * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
+     * @max 100000
      */
     quantityAvailable?: number | null;
     /** Physical properties of the item. */
@@ -913,6 +1131,8 @@ export interface CustomLineItem {
      * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
      * + In most cases, this field is the same as `catalogReference.catalogItemId`.
      * + Used in membership validation.
+     * @minLength 1
+     * @maxLength 36
      */
     rootCatalogItemId?: string | null;
     /**
@@ -920,11 +1140,12 @@ export interface CustomLineItem {
      *
      * Eligible for catalog items with type `DEPOSIT_ONLINE`.
      * When omitted, the item's price will not be split and is expected to be paid in a single installment.
+     * @format DECIMAL_VALUE
      */
     depositAmount?: string | null;
     /**
-     * Delivery Profile ID.
-     * @internal
+     * Delivery profile ID.
+     * @format GUID
      */
     deliveryProfileId?: string | null;
     /** 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. */
@@ -945,6 +1166,8 @@ export interface CustomLineItem {
     fixedQuantity?: boolean;
     /**
      * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
+     * @minLength 1
+     * @maxLength 1000
      * @readonly
      */
     consentRequiredPaymentPolicy?: string | null;
@@ -958,11 +1181,13 @@ export interface CustomLineItem {
     /**
      * Policies to be displayed to the customer on the checkout page.
      * @internal
+     * @maxSize 5
      */
     policies?: Policy[];
     /**
      * ID of the app managing the inventory.
      * @internal
+     * @format GUID
      */
     inventoryAppId?: string | null;
     /**
@@ -972,25 +1197,35 @@ export interface CustomLineItem {
      * @internal
      */
     membersOnly?: boolean;
+    /**
+     * Address to use for tax calculation purposes.
+     * @internal
+     */
+    taxableAddress?: TaxableAddress;
 }
 export interface UpdateCartResponse {
     /** Updated Cart. */
     cart?: Cart;
 }
 export interface AddToCurrentCartRequest {
-    /** Catalog line items. */
+    /**
+     * Catalog line items.
+     * @maxSize 100
+     */
     lineItems?: LineItem[];
     /**
      * Custom line items. Custom line items don't trigger the Catalog service plugin.
      *
      * To access and manage custom line items, 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).
+     * @maxSize 100
      */
     customLineItems?: CustomLineItem[];
     /**
      * Business location ID.
      * To update a cart's business location ID, use the UpdateCart method.
      * Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
+     * @format GUID
      */
     businessLocationId?: string | null;
 }
@@ -999,13 +1234,17 @@ export interface AddToCartResponse {
     cart?: Cart;
 }
 export interface AddToCurrentCartAndEstimateTotalsRequest {
-    /** Catalog line items. */
+    /**
+     * Catalog line items.
+     * @maxSize 100
+     */
     lineItems?: LineItem[];
     /**
      * Custom line items. Custom line items don't trigger the Catalog service plugin.
      *
      * To access and manage custom line items, 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).
+     * @maxSize 100
      */
     customLineItems?: CustomLineItem[];
     /** Selected shipping option. */
@@ -1030,15 +1269,31 @@ export interface AddToCurrentCartAndEstimateTotalsRequest {
     calculateShipping?: boolean | null;
 }
 export interface SelectedMemberships {
-    /** Selected memberships. */
+    /**
+     * Selected memberships.
+     * @maxSize 300
+     */
     memberships?: HostSelectedMembership[];
 }
 export interface HostSelectedMembership {
-    /** Membership ID. */
+    /**
+     * Membership ID.
+     * @minLength 1
+     * @maxLength 100
+     */
     _id?: string;
-    /** ID of the app providing this payment option. */
+    /**
+     * ID of the app providing this payment option.
+     * @format GUID
+     */
     appId?: string;
-    /** IDs of the line items this membership applies to. */
+    /**
+     * IDs of the line items this membership applies to.
+     * @minSize 1
+     * @maxSize 300
+     * @minLength 1
+     * @maxLength 100
+     */
     lineItemIds?: string[];
 }
 export interface EstimateTotalsResponse {
@@ -1060,7 +1315,10 @@ export interface EstimateTotalsResponse {
     calculationErrors?: CalculationErrors;
     /** Weight measurement unit - defaults to site's weight unit. */
     weightUnit?: WeightUnit;
-    /** Currency used for pricing in this store. */
+    /**
+     * Currency used for pricing in this store.
+     * @format CURRENCY
+     */
     currency?: string;
     /**
      * Minimal amount to pay in order to place the order.
@@ -1074,7 +1332,10 @@ export interface EstimateTotalsResponse {
     payLater?: PriceSummary;
     /** Information about valid and invalid memberships, and which ones are selected for usage. */
     membershipOptions?: MembershipOptions;
-    /** Additional fees */
+    /**
+     * Additional fees
+     * @maxSize 100
+     */
     additionalFees?: AdditionalFee[];
     /**
      * List of validation violations raised by the [Validations Custom Extension SPI](https://www.wix.com/velo/reference/spis/wix-ecom/ecom-validations/introduction).
@@ -1121,7 +1382,10 @@ export interface LineItemPricesData {
 export interface ItemTaxFullDetails {
     /** Amount for which tax is calculated. */
     taxableAmount?: MultiCurrencyPrice;
-    /** Tax rate %, as a decimal point between 0 and 1. */
+    /**
+     * Tax rate %, as a decimal point between 0 and 1.
+     * @decimalValue options { gte:0, lte:1, maxScale:6 }
+     */
     taxRate?: string;
     /** Calculated tax, based on `taxable_amount` and `tax_rate`. */
     totalTax?: MultiCurrencyPrice;
@@ -1133,9 +1397,15 @@ export interface ItemTaxFullDetails {
     rateBreakdown?: TaxRateBreakdown[];
 }
 export interface TaxRateBreakdown {
-    /** Name of tax against which the calculation was performed. */
+    /**
+     * Name of tax against which the calculation was performed.
+     * @maxLength 100
+     */
     name?: string;
-    /** Rate at which this tax detail was calculated. */
+    /**
+     * Rate at which this tax detail was calculated.
+     * @decimalValue options { gte:0, lte:1, maxScale:6 }
+     */
     rate?: string;
     /** Amount of tax for this tax detail. */
     tax?: MultiCurrencyPrice;
@@ -1145,21 +1415,31 @@ export interface TaxRateBreakdown {
  * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
  */
 export interface TaxBreakdown {
-    /** The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec". */
+    /**
+     * The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
+     * @maxLength 200
+     */
     jurisdiction?: string | null;
     /** The amount of this line item price that was considered nontaxable. (Decimal value) */
     nonTaxableAmount?: MultiCurrencyPrice;
-    /** The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value) */
+    /**
+     * The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value)
+     * @decimalValue options { gte:0, maxScale:6 }
+     */
     rate?: string | null;
     /** The amount of tax estimated for this line item. (Decimal value) */
     taxAmount?: MultiCurrencyPrice;
     /** The taxable amount of this line item. */
     taxableAmount?: MultiCurrencyPrice;
-    /** 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;
     /** The type of the jurisdiction in which this tax detail applies. */
@@ -1198,11 +1478,16 @@ export interface GiftCard {
     obfuscatedCode?: string;
     /** Gift card value. */
     amount?: MultiCurrencyPrice;
-    /** App ID of the gift card provider. */
+    /**
+     * App ID of the gift card provider.
+     * @format GUID
+     */
     appId?: string;
     /**
      * External ID in the gift card provider's system.
      * Used for integration and tracking across different platforms.
+     * @minLength 1
+     * @maxLength 50
      */
     externalId?: string | null;
 }
@@ -1289,15 +1574,27 @@ export interface ApplicationError {
  * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
  */
 export interface AggregatedTaxBreakdown {
-    /** 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). */
     jurisdictionTypeEnum?: JurisdictionType;
-    /** The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value) */
+    /**
+     * The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (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?: MultiCurrencyPrice;
@@ -1313,18 +1610,26 @@ export interface ShippingInformation {
 export interface ShippingRegion {
     /**
      * Shipping region ID.
+     * @format GUID
      * @readonly
      */
     _id?: string;
-    /** Shipping region name. */
+    /**
+     * Shipping region name.
+     * @maxLength 100
+     */
     name?: string;
 }
 export interface SelectedCarrierServiceOption {
-    /** Unique identifier of selected option. For example, "usps_std_overnight". */
+    /**
+     * Unique identifier of selected option. For example, "usps_std_overnight".
+     * @maxLength 100
+     */
     code?: string;
     /**
      * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
      * For example, "Standard" or "First-Class Package International".
+     * @maxLength 250
      * @readonly
      */
     title?: string;
@@ -1345,17 +1650,29 @@ export interface SelectedCarrierServiceOption {
     requestedShippingOption?: boolean;
     /** Other charges */
     otherCharges?: SelectedCarrierServiceOptionOtherCharge[];
-    /** This carrier's unique ID */
+    /**
+     * This carrier's unique ID
+     * @format GUID
+     */
     carrierId?: string | null;
-    /** Delivery solution allocations to different delivery carriers and delivery regions */
+    /**
+     * Delivery solution allocations to different delivery carriers and delivery regions
+     * @maxSize 300
+     */
     deliveryAllocations?: DeliveryAllocation[];
     /** If the delivery solution is a partial and doesn't apply to all items. */
     partial?: boolean | null;
 }
 export interface DeliveryLogistics {
-    /** 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 caller, e.g for pickup: "Please deliver during opening hours, and please don't park in disabled parking spot". */
+    /**
+     * Instructions for caller, e.g for pickup: "Please deliver during opening hours, and please don't park in disabled parking spot".
+     * @maxLength 1000
+     */
     instructions?: string | null;
     /** Pickup details. */
     pickupDetails?: PickupDetails;
@@ -1397,7 +1714,10 @@ export interface SelectedCarrierServiceOptionPrices {
 export interface SelectedCarrierServiceOptionOtherCharge {
     /** Type of additional cost. */
     type?: ChargeType;
-    /** Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'. */
+    /**
+     * Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'.
+     * @maxLength 200
+     */
     details?: string | null;
     /** Price of added charge. */
     cost?: SelectedCarrierServiceOptionPrices;
@@ -1415,23 +1735,43 @@ export interface DeliveryAllocation {
     applicableLineItems?: ApplicableLineItems;
 }
 export interface Carrier {
-    /** The carrier app id */
+    /**
+     * The carrier app id
+     * @format GUID
+     */
     appId?: string | null;
-    /** Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`. */
+    /**
+     * Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`.
+     * @maxLength 250
+     */
     code?: string;
 }
 export interface Region {
-    /** The delivery region id. */
+    /**
+     * The delivery region id.
+     * @format GUID
+     */
     _id?: string | null;
-    /** The delivery region name. */
+    /**
+     * The delivery region name.
+     * @maxLength 100
+     */
     name?: string | null;
 }
 export interface ApplicableLineItems {
-    /** Line items that the delivery solution is for. */
+    /**
+     * Line items that the delivery solution is for.
+     * @maxSize 300
+     * @minLength 1
+     * @maxLength 100
+     */
     lineItemIds?: string[];
 }
 export interface CarrierServiceOption {
-    /** Carrier ID. */
+    /**
+     * Carrier ID.
+     * @format GUID
+     */
     carrierId?: string;
     /** Shipping options offered by this carrier for this request. */
     shippingOptions?: ShippingOption[];
@@ -1440,18 +1780,23 @@ export interface ShippingOption {
     /**
      * Unique code of provided shipping option like "usps_std_overnight".
      * For legacy calculators this would be the UUID of the option.
+     * @maxLength 100
      */
     code?: string;
     /**
      * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
      * For example, "Standard" or "First-Class Package International".
+     * @maxLength 250
      */
     title?: string;
     /** Delivery logistics. */
     logistics?: DeliveryLogistics;
     /** Sipping price information. */
     cost?: ShippingPrice;
-    /** Delivery solution allocations to different delivery carriers and delivery regions */
+    /**
+     * Delivery solution allocations to different delivery carriers and delivery regions
+     * @maxSize 300
+     */
     deliveryAllocations?: DeliveryAllocation[];
     /** If the delivery solution is a partial and doesn't apply to all items. */
     partial?: boolean | null;
@@ -1479,6 +1824,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
     discountType?: AppliedDiscountDiscountType;
     /**
      * IDs of the line items the discount applies to.
+     * @format GUID
      * @deprecated IDs of line items the discount applies to.
      * @replacedBy line_items_discounts
      * @targetRemovalDate 2024-06-01
@@ -1488,6 +1834,8 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
      * Number of subscription cycle this discount applies to
      * default None - all billing cycle
      * @internal
+     * @min 1
+     * @max 999
      */
     subscriptionCycles?: number | null;
 }
@@ -1519,11 +1867,18 @@ export interface V1Coupon {
 export interface V1MerchantDiscount {
     /** Discount value. */
     amount?: MultiCurrencyPrice;
-    /** Discount Percentage. Will be calculated from items price before other discounts. */
+    /**
+     * Discount Percentage. Will be calculated from items price before other discounts.
+     * @min 1
+     * @max 100
+     */
     percentage?: number | null;
 }
 export interface V1DiscountRule {
-    /** Discount rule ID */
+    /**
+     * Discount rule ID
+     * @format GUID
+     */
     _id?: string;
     /** Discount rule name */
     name?: V1DiscountRuleName;
@@ -1531,13 +1886,24 @@ export interface V1DiscountRule {
     amount?: MultiCurrencyPrice;
 }
 export interface V1DiscountRuleName {
-    /** 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;
     /** Discount value. */
     totalDiscountAmount?: MultiCurrencyPrice;
@@ -1667,21 +2033,43 @@ export interface CarrierError {
     error?: Details;
 }
 export interface MembershipOptions {
-    /** List of payment options that can be used. */
+    /**
+     * List of payment options that can be used.
+     * @maxSize 300
+     */
     eligibleMemberships?: Membership[];
-    /** List of payment options that are owned by the member, but cannot be used due to reason provided. */
+    /**
+     * List of payment options that are owned by the member, but cannot be used due to reason provided.
+     * @maxSize 300
+     */
     invalidMemberships?: InvalidMembership[];
-    /** The selected membership payment options and which line items they apply to. */
+    /**
+     * The selected membership payment options and which line items they apply to.
+     * @maxSize 300
+     */
     selectedMemberships?: HostSelectedMembership[];
 }
 export interface Membership {
-    /** Membership ID. */
+    /**
+     * Membership ID.
+     * @minLength 1
+     * @maxLength 100
+     */
     _id?: string;
-    /** ID of the application providing this payment option. */
+    /**
+     * ID of the application providing this payment option.
+     * @format GUID
+     */
     appId?: string;
     /** The name of this membership. */
     name?: MembershipName;
-    /** Line item IDs which are "paid" for by this membership. */
+    /**
+     * Line item IDs which are "paid" for by this membership.
+     * @minSize 1
+     * @maxSize 300
+     * @minLength 1
+     * @maxLength 100
+     */
     lineItemIds?: string[];
     /** Optional - For a membership that has limited credits, information about credit usage. */
     credits?: MembershipPaymentCredits;
@@ -1691,13 +2079,22 @@ export interface Membership {
     additionalData?: Record<string, any> | null;
 }
 export interface MembershipName {
-    /** Membership name. */
+    /**
+     * Membership name.
+     * @maxLength 100
+     */
     original?: string;
-    /** Membership name translated into buyer's language. Defaults to `original` when not defined. */
+    /**
+     * Membership name translated into buyer's language. Defaults to `original` when not defined.
+     * @maxLength 100
+     */
     translated?: string | null;
 }
 export interface MembershipPaymentCredits {
-    /** Membership's total amount of credits. */
+    /**
+     * Membership's total amount of credits.
+     * @min 1
+     */
     total?: number;
     /** Membership's remaining amount of credits. */
     remaining?: number;
@@ -1705,19 +2102,35 @@ export interface MembershipPaymentCredits {
 export interface InvalidMembership {
     /** Membership details. */
     membership?: Membership;
-    /** Reason why this membership is invalid and cannot be used. */
+    /**
+     * Reason why this membership is invalid and cannot be used.
+     * @minLength 1
+     * @maxLength 100
+     */
     reason?: string;
 }
 export interface AdditionalFee {
-    /** Additional fee's unique code (or ID) for future processing. */
+    /**
+     * Additional fee's unique code (or ID) for future processing.
+     * @minLength 1
+     * @maxLength 100
+     */
     code?: string | null;
-    /** Translated additional fee's name. */
+    /**
+     * Translated additional fee's name.
+     * @minLength 1
+     * @maxLength 50
+     */
     name?: string;
     /** Additional fee's price. */
     price?: MultiCurrencyPrice;
     /** Tax details. */
     taxDetails?: ItemTaxFullDetails;
-    /** Provider's app id. */
+    /**
+     * Provider's app id.
+     * @minLength 1
+     * @maxLength 100
+     */
     providerAppId?: string | null;
     /** Additional fee's price before tax. */
     priceBeforeTax?: MultiCurrencyPrice;
@@ -1726,12 +2139,15 @@ export interface AdditionalFee {
     /**
      * 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 cycle this fee applies to
      * default None - all billing cycle
      * @internal
+     * @min 1
+     * @max 999
      */
     subscriptionCycles?: number | null;
     /** the source the additional fee was added from */
@@ -1751,7 +2167,11 @@ export interface Violation {
     severity?: Severity;
     /** Target location on a checkout or cart page where the violation will be displayed. */
     target?: Target;
-    /** 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>`. */
+    /**
+     * 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>`.
+     * @minLength 1
+     * @maxLength 1000
+     */
     description?: string | null;
 }
 export declare enum Severity {
@@ -1810,7 +2230,12 @@ export interface TargetLineItem {
     suggestedFix?: SuggestedFix;
 }
 export interface RemoveLineItemsFromCurrentCartRequest {
-    /** IDs of the line items to remove from the cart. */
+    /**
+     * IDs of the line items to remove from the cart.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
     lineItemIds?: string[];
 }
 export interface RemoveLineItemsResponse {
@@ -1826,7 +2251,10 @@ export interface CreateCheckoutFromCurrentCartRequest {
     billingAddress?: Address;
     /** Selected shipping option. */
     selectedShippingOption?: SelectedShippingOption;
-    /** Mandatory when setting a billing or shipping address if the site visitor isn't logged in. */
+    /**
+     * Mandatory when setting a billing or shipping address if the site visitor isn't logged in.
+     * @format EMAIL
+     */
     email?: string | null;
 }
 export declare enum ChannelType {
@@ -1874,13 +2302,24 @@ export interface RemoveCouponResponse {
     cart?: Cart;
 }
 export interface UpdateCurrentCartLineItemQuantityRequest {
-    /** Line item IDs and their new quantity. */
+    /**
+     * Line item IDs and their new quantity.
+     * @minSize 1
+     * @maxSize 100
+     */
     lineItems?: LineItemQuantityUpdate[];
 }
 export interface LineItemQuantityUpdate {
-    /** Line item ID. Required. */
+    /**
+     * Line item ID. Required.
+     * @format GUID
+     */
     _id?: string;
-    /** New quantity. Number must be 1 or higher. Required. */
+    /**
+     * New quantity. Number must be 1 or higher. Required.
+     * @min 1
+     * @max 100000
+     */
     quantity?: number;
 }
 export interface UpdateLineItemsQuantityResponse {
@@ -1984,9 +2423,15 @@ export interface ActionEvent {
     body?: string;
 }
 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;
@@ -1994,26 +2439,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 {
@@ -2028,15 +2497,22 @@ export interface CreateCartRequest {
     cartInfo?: Cart;
     /** The code of an existing coupon to apply to the cart. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
     couponCode?: string | null;
-    /** Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will apply to the whole cart. */
+    /**
+     * Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will apply to the whole cart.
+     * @maxSize 100
+     */
     merchantDiscounts?: MerchantDiscountInput[];
-    /** Catalog line items. */
+    /**
+     * Catalog line items.
+     * @maxSize 300
+     */
     lineItems?: LineItem[];
     /**
      * Custom line items. Custom line items don't trigger the Catalog service plugin.
      *
      * To access and manage custom line items, 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).
+     * @maxSize 300
      */
     customLineItems?: CustomLineItem[];
 }
@@ -2045,7 +2521,10 @@ export interface CreateCartResponse {
     cart?: Cart;
 }
 export interface GetCartRequest {
-    /** ID of the cart to retrieve. */
+    /**
+     * ID of the cart to retrieve.
+     * @format GUID
+     */
     _id: string;
 }
 export interface GetCartResponse {
@@ -2053,7 +2532,10 @@ export interface GetCartResponse {
     cart?: Cart;
 }
 export interface GetCartByCheckoutIdRequest {
-    /** Checkout ID. */
+    /**
+     * Checkout ID.
+     * @format GUID
+     */
     _id: string;
 }
 export interface GetCartByCheckoutIdResponse {
@@ -2061,32 +2543,51 @@ export interface GetCartByCheckoutIdResponse {
     cart?: Cart;
 }
 export interface AddToCartRequest {
-    /** Cart ID. */
+    /**
+     * Cart ID.
+     * @format GUID
+     */
     _id: string;
-    /** Catalog line items. */
+    /**
+     * Catalog line items.
+     * @maxSize 100
+     */
     lineItems?: LineItem[];
     /**
      * Custom line items. Custom line items don't trigger the Catalog service plugin.
      *
      * To access and manage custom line items, 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).
+     * @maxSize 100
      */
     customLineItems?: CustomLineItem[];
     /**
      * The business location ID associated with the cart.
      * The `businessLocationId` field cannot be passed if one already exists on the cart. To update a cart's business location ID, use the UpdateCart method.
      * Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
+     * @format GUID
      */
     businessLocationId?: string | null;
 }
 export interface RemoveLineItemsRequest {
-    /** Cart ID. */
+    /**
+     * Cart ID.
+     * @format GUID
+     */
     _id: string;
-    /** IDs of the line items to remove from the cart. */
+    /**
+     * IDs of the line items to remove from the cart.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
     lineItemIds: string[];
 }
 export interface CreateCheckoutRequest {
-    /** Cart ID. */
+    /**
+     * Cart ID.
+     * @format GUID
+     */
     _id: string;
     /** **Required**. Sales channel type. */
     channelType?: ChannelType;
@@ -2096,21 +2597,37 @@ export interface CreateCheckoutRequest {
     billingAddress?: Address;
     /** Selected shipping option. */
     selectedShippingOption?: SelectedShippingOption;
-    /** Mandatory when setting a billing or shipping address if the site visitor isn't logged in. */
+    /**
+     * Mandatory when setting a billing or shipping address if the site visitor isn't logged in.
+     * @format EMAIL
+     */
     email?: string | null;
 }
 export interface RemoveCouponRequest {
-    /** Cart ID. */
+    /**
+     * Cart ID.
+     * @format GUID
+     */
     _id: string;
 }
 export interface UpdateLineItemsQuantityRequest {
-    /** Cart ID. */
+    /**
+     * Cart ID.
+     * @format GUID
+     */
     _id: string;
-    /** Line item IDs and their new quantity. */
+    /**
+     * Line item IDs and their new quantity.
+     * @minSize 1
+     * @maxSize 100
+     */
     lineItems: LineItemQuantityUpdate[];
 }
 export interface EstimateTotalsRequest {
-    /** Cart ID. */
+    /**
+     * Cart ID.
+     * @format GUID
+     */
     _id: string;
     /** Selected shipping option. */
     selectedShippingOption?: SelectedShippingOption;
@@ -2134,13 +2651,19 @@ export interface EstimateTotalsRequest {
     calculateShipping?: boolean | null;
 }
 export interface DeleteCartRequest {
-    /** ID of the cart to delete. */
+    /**
+     * ID of the cart to delete.
+     * @format GUID
+     */
     _id: string;
 }
 export interface Empty {
 }
 export interface RemoveBusinessLocationRequest {
-    /** Cart ID. */
+    /**
+     * Cart ID.
+     * @format GUID
+     */
     _id: string;
 }
 export interface RemoveBusinessLocationResponse {
@@ -2660,9 +3183,15 @@ export interface RemoveBusinessLocationResponseNonNullableFields {
     cart?: CartNonNullableFields;
 }
 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;
@@ -2727,6 +3256,8 @@ export interface CartDeletedEnvelope {
  * @permissionId ECOM.READ_CARTS
  * @webhook
  * @eventType wix.ecom.v1.cart_deleted
+ * @serviceIdentifier com.wix.ecom.cart.api.v1.CurrentCartService
+ * @slug deleted
  */
 export declare function onCartDeleted(handler: (event: CartDeletedEnvelope) => void | Promise<void>): void;
 export interface CartUpdatedEnvelope {
@@ -2750,6 +3281,7 @@ export interface CartUpdatedEnvelope {
  * @permissionId ECOM.READ_CARTS
  * @webhook
  * @eventType wix.ecom.v1.cart_updated
+ * @slug updated
  */
 export declare function onCartUpdated(handler: (event: CartUpdatedEnvelope) => void | Promise<void>): void;
 export interface CartCreatedEnvelope {
@@ -2775,6 +3307,8 @@ export interface CartCreatedEnvelope {
  * @permissionId ECOM.READ_CARTS
  * @webhook
  * @eventType wix.ecom.v1.cart_created
+ * @serviceIdentifier com.wix.ecom.cart.api.v1.CartService
+ * @slug created
  */
 export declare function onCartCreated(handler: (event: CartCreatedEnvelope) => void | Promise<void>): void;
 /**
@@ -2785,8 +3319,8 @@ export declare function onCartCreated(handler: (event: CartCreatedEnvelope) => v
  *
  * > **Note:** When adding catalog items, `options.lineItems.catalogReference` is required.
  * @public
- * @requiredField options.customLineItems.descriptionLines
  * @requiredField options.customLineItems.descriptionLines.name
+ * @requiredField options.customLineItems.descriptionLines.value
  * @requiredField options.customLineItems.itemType
  * @requiredField options.customLineItems.price
  * @requiredField options.customLineItems.productName
@@ -2800,12 +3334,16 @@ export declare function onCartCreated(handler: (event: CartCreatedEnvelope) => v
  * @permissionId ECOM.ADMIN_MODIFY_CARTS
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage eCommerce - Admin Permissions
  * @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
  * @applicableIdentity APP
@@ -2819,29 +3357,35 @@ export interface CreateCartOptions {
     cartInfo?: Cart;
     /** The code of an existing coupon to apply to the cart. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
     couponCode?: string | null;
-    /** Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will apply to the whole cart. */
+    /**
+     * Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will apply to the whole cart.
+     * @maxSize 100
+     */
     merchantDiscounts?: MerchantDiscountInput[];
-    /** Catalog line items. */
+    /**
+     * Catalog line items.
+     * @maxSize 300
+     */
     lineItems?: LineItem[];
     /**
      * Custom line items. Custom line items don't trigger the Catalog service plugin.
      *
      * To access and manage custom line items, 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).
+     * @maxSize 300
      */
     customLineItems?: CustomLineItem[];
 }
 /**
  * Updates a specified cart's properties.
  *
- *
- * The `updateCart()` function returns a Promise that resolves when the specified cart's properties are updated.
+ * After a cart is updated, call `refreshCart()` to update the cart's UI elements and trigger the `onCartChange()` event.
  *
  * > **Note:** When updating catalog items, `options.lineItems.catalogReference` is required.
  * @public
  * @requiredField _id
- * @requiredField options.customLineItems.descriptionLines
  * @requiredField options.customLineItems.descriptionLines.name
+ * @requiredField options.customLineItems.descriptionLines.value
  * @requiredField options.customLineItems.itemType
  * @requiredField options.customLineItems.productName
  * @requiredField options.lineItems.catalogReference
@@ -2851,12 +3395,16 @@ export interface CreateCartOptions {
  * @permissionId ECOM.ADMIN_MODIFY_CARTS
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage eCommerce - Admin Permissions
  * @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
  * @applicableIdentity APP
@@ -2868,19 +3416,28 @@ export declare function updateCart(_id: string | null, options?: UpdateCartOptio
 export interface UpdateCartOptions {
     /** The information for the cart being updated. */
     cartInfo: {
-        /** ID of the cart to be updated. */
+        /**
+         * ID of the cart to be updated.
+         * @format GUID
+         */
         _id?: string | null;
         /**
          * Line items.
+         * @minSize 1
+         * @maxSize 300
          * @readonly
          */
         lineItems?: LineItem[];
-        /** [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. */
+        /**
+         * [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
+         * @maxLength 1000
+         */
         buyerNote?: string | null;
         /** Buyer information. */
         buyerInfo?: BuyerInfo;
         /**
          * Currency used for pricing.
+         * @format CURRENCY
          * @readonly
          */
         currency?: string;
@@ -2888,6 +3445,7 @@ export interface UpdateCartOptions {
          * Currency code used for all the converted prices that are returned.
          * For a site that supports multiple currencies, this is the currency the buyer selected.
          * @readonly
+         * @format CURRENCY
          */
         conversionCurrency?: string;
         /**
@@ -2914,6 +3472,7 @@ export interface UpdateCartOptions {
         /**
          * ID of the checkout that originated from this cart.
          * @readonly
+         * @format GUID
          */
         checkoutId?: string | null;
         /**
@@ -2937,10 +3496,12 @@ export interface UpdateCartOptions {
          * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
          *
          * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
+         * @maxLength 1000
          */
         overrideCheckoutUrl?: string | null;
         /**
          * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
+         * @format GUID
          * @readonly
          */
         purchaseFlowId?: string | null;
@@ -2949,20 +3510,28 @@ export interface UpdateCartOptions {
         /**
          * The business location ID associated with the cart.
          * Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
+         * @format GUID
          */
         businessLocationId?: string | null;
     };
     /** The code of an existing coupon to apply to the cart. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
     couponCode?: string | null;
-    /** Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will be applied to the whole cart. */
+    /**
+     * Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will be applied to the whole cart.
+     * @maxSize 100
+     */
     merchantDiscounts?: MerchantDiscountInput[];
-    /** Catalog line items. */
+    /**
+     * Catalog line items.
+     * @maxSize 300
+     */
     lineItems?: LineItem[];
     /**
      * Custom line items. Custom line items don't trigger the Catalog service plugin.
      *
      * To access and manage custom line items, 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).
+     * @maxSize 300
      */
     customLineItems?: CustomLineItem[];
 }
@@ -3024,15 +3593,14 @@ export declare function getCartByCheckoutId(_id: string): Promise<GetCartByCheck
 /**
  * Adds catalog line items to a cart.
  *
- *
- * The `addToCart()` function returns a Promise that resolves to the updated cart when the specified items have been added.
+ * After a cart is updated, call `refreshCart()` to update the cart's UI elements and trigger the `onCartChange()` event.
  *
  * > **Note:** When adding catalog items, `options.lineItems.catalogReference` is required.
  * @param _id - Cart ID.
  * @public
  * @requiredField _id
- * @requiredField options.customLineItems.descriptionLines
  * @requiredField options.customLineItems.descriptionLines.name
+ * @requiredField options.customLineItems.descriptionLines.value
  * @requiredField options.customLineItems.itemType
  * @requiredField options.customLineItems.price
  * @requiredField options.customLineItems.productName
@@ -3045,12 +3613,16 @@ export declare function getCartByCheckoutId(_id: string): Promise<GetCartByCheck
  * @permissionId ECOM.ADMIN_MODIFY_CARTS
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage eCommerce - Admin Permissions
  * @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
  * @applicableIdentity APP
@@ -3060,27 +3632,31 @@ export declare function getCartByCheckoutId(_id: string): Promise<GetCartByCheck
  */
 export declare function addToCart(_id: string, options?: AddToCartOptions): Promise<AddToCartResponse & AddToCartResponseNonNullableFields>;
 export interface AddToCartOptions {
-    /** Catalog line items. */
+    /**
+     * Catalog line items.
+     * @maxSize 100
+     */
     lineItems?: LineItem[];
     /**
      * Custom line items. Custom line items don't trigger the Catalog service plugin.
      *
      * To access and manage custom line items, 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).
+     * @maxSize 100
      */
     customLineItems?: CustomLineItem[];
     /**
      * The business location ID associated with the cart.
      * The `businessLocationId` field cannot be passed if one already exists on the cart. To update a cart's business location ID, use the UpdateCart method.
      * Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
+     * @format GUID
      */
     businessLocationId?: string | null;
 }
 /**
  * Removes line items from the specified cart.
  *
- *
- * The `removeLineItems()` function returns a Promise that resolves to the updated cart when the line items are removed from the specified cart.
+ * After a cart is updated, call `refreshCart()` to update the cart's UI elements and trigger the `onCartChange()` event.
  * @public
  * @requiredField _id
  * @requiredField lineItemIds
@@ -3089,6 +3665,8 @@ export interface AddToCartOptions {
  * @permissionId ECOM.MODIFY_CARTS
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
  * @applicableIdentity APP
@@ -3135,20 +3713,24 @@ export interface CreateCheckoutOptions {
     billingAddress?: Address;
     /** Selected shipping option. */
     selectedShippingOption?: SelectedShippingOption;
-    /** Mandatory when setting a billing or shipping address if the site visitor isn't logged in. */
+    /**
+     * Mandatory when setting a billing or shipping address if the site visitor isn't logged in.
+     * @format EMAIL
+     */
     email?: string | null;
 }
 /**
  * Removes the coupon from a specified cart.
  *
- *
- * The `removeCoupon()` function returns a Promise that resolves to the updated cart when the coupon is removed from the specified cart.
+ * After a cart is updated, call `refreshCart()` to update the cart's UI elements and trigger the `onCartChange()` event.
  * @param _id - Cart ID.
  * @public
  * @requiredField _id
  * @permissionId ECOM.MODIFY_CARTS
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
  * @applicableIdentity APP
@@ -3160,12 +3742,11 @@ export declare function removeCoupon(_id: string): Promise<RemoveCouponResponse
 /**
  * Updates the quantity of one or more line items in a specified cart.
  *
+ * After a cart is updated, call `refreshCart()` to update the cart's UI elements and trigger the `onCartChange()` event.
  *
- * The `updateLineItemsQuantity()` function returns a Promise that resolves when the quantities of the specified cart's line items are updated.
+ * This method is only for updating the quantity of line items. To entirely remove a line item from the cart, use `removeLineItems()`. To add a new line item to the cart, use `addToCart()`.
  *
- * This endpoint is only for updating the quantity of line items. To entirely remove a line item from the cart, use [`removeLineItems()`](#removelineitems). To add a new line item to the cart, use [`addToCart()`](#addtocart).
- *
- * This endpoint checks the amount of stock remaining for this line item. If the specified `quantity` is greater than the remaining stock, then the `quantity` returned in the response is the total amount of remaining stock.
+ * This method checks the amount of stock remaining for this line item. If the specified `quantity` is greater than the remaining stock, then the `quantity` returned in the response is the total amount of remaining stock.
  * @param _id - Cart ID.
  * @param lineItems - Line item IDs and their new quantity.
  * @public
@@ -3174,6 +3755,8 @@ export declare function removeCoupon(_id: string): Promise<RemoveCouponResponse
  * @permissionId ECOM.MODIFY_CARTS
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
  * @applicableIdentity APP
@@ -3247,6 +3830,8 @@ export interface EstimateTotalsOptions {
  * @permissionId ECOM.MODIFY_CARTS
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
  * @applicableIdentity APP
@@ -3264,6 +3849,8 @@ export declare function deleteCart(_id: string): Promise<void>;
  * @permissionId ECOM.MODIFY_CARTS
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Manage eCommerce - all permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
  * @applicableIdentity APP