@wix/auto_sdk_ecom_delivery-profile 1.0.1 → 1.0.2

package/build/es/src/ecom-v1-delivery-profile-delivery-profile.universal.d.ts

@@ -7,17 +7,25 @@
 export interface DeliveryProfile {
     /**
      * DeliveryProfile ID.
+     * @format GUID
      * @readonly
      */
     _id?: string | null;
-    /** DeliveryProfile name. */
+    /**
+     * DeliveryProfile name.
+     * @minLength 1
+     * @maxLength 256
+     */
     name?: string | null;
     /**
      * Flags this DeliveryProfile as the default DeliveryProfile.
      * @readonly
      */
     default?: boolean | null;
-    /** A list of DeliveryProfile regions. */
+    /**
+     * A list of DeliveryProfile regions.
+     * @maxSize 100
+     */
     deliveryRegions?: DeliveryRegion[];
     /** ID of the delivery profile's creator. */
     createdBy?: CreatedBy;
@@ -43,19 +51,28 @@ export interface DeliveryProfile {
 export interface DeliveryRegion {
     /**
      * The delivery region id.
+     * @format GUID
      * @readonly
      */
     _id?: string | null;
-    /** Optional name of the rule, for example: "Domestic". */
+    /**
+     * Optional name of the rule, for example: "Domestic".
+     * @minLength 1
+     * @maxLength 256
+     */
     name?: string | null;
     /** Indicates that this rule is active, default value is true. */
     active?: boolean | null;
     /**
      * The spi implementers id of shipping-rates spi, assigned to this rule.
+     * @maxSize 25
      * @readonly
      */
     deliveryCarriers?: DeliveryCarrier[];
-    /** The operation region of this rule, if empty than it is global. */
+    /**
+     * The operation region of this rule, if empty than it is global.
+     * @maxSize 200
+     */
     destinations?: Destination[];
     /**
      * Represents the time this Profile was created
@@ -64,53 +81,126 @@ export interface DeliveryRegion {
     _createdDate?: Date | null;
 }
 export interface DeliveryCarrier {
-    /** AppDefId of the provider as it is registered in the [app dashboard](https://dev.wix.com/dc3/my-apps/). Can be fetched by listDeliveryProvider api. */
+    /**
+     * AppDefId of the provider as it is registered in the [app dashboard](https://dev.wix.com/dc3/my-apps/). Can be fetched by listDeliveryProvider api.
+     * @format GUID
+     */
     appId?: string;
     /** Backup rate to be used in case the cost returned by the provider is empty. */
     backupRate?: BackupRate;
-    /** Additional charges to add to the delivery rate for this carrier */
+    /**
+     * Additional charges to add to the delivery rate for this carrier
+     * @maxSize 10
+     */
     additionalCharges?: AdditionalCharge[];
 }
 export interface BackupRate {
-    /** Default rate prefix that will concatenate to the delivery options the provider will offer. */
+    /**
+     * Default rate prefix that will concatenate to the delivery options the provider will offer.
+     * @minLength 1
+     * @maxLength 256
+     * @deprecated Default rate prefix that will concatenate to the delivery options the provider will offer.
+     * @replacedBy title
+     * @targetRemovalDate 2025-04-01
+     */
     prefix?: string | null;
-    /** Default rate price for all delivery options that the provider will offer. */
+    /**
+     * Default rate price for all delivery options that the provider will offer.
+     * @decimalValue options { gte:0, maxScale:6 }
+     * @deprecated Default rate price for all delivery options that the provider will offer.
+     * @replacedBy amount
+     * @targetRemovalDate 2025-04-01
+     */
     rate?: string | null;
-    /** Should the default rate be used. Default value is false. */
+    /**
+     * Should the default rate be used. Default value is false.
+     * @deprecated Should the default rate be used. Default value is false.
+     * @replacedBy active
+     * @targetRemovalDate 2025-04-01
+     */
     enabled?: boolean | null;
+    /**
+     * Default rate title that will concatenate to the delivery options the provider will offer.
+     * @minLength 1
+     * @maxLength 32
+     */
+    title?: string | null;
+    /**
+     * Default amount price for all delivery options that the provider will offer.
+     * @decimalValue options { gte:0, maxScale:6 }
+     */
+    amount?: string | null;
+    /** Should the default rate be used. Default value is false. */
+    active?: boolean;
 }
 export interface AdditionalCharge {
-    /** Additional charge type. */
+    /**
+     * Additional charge type.
+     * @deprecated Additional charge type.
+     * @targetRemovalDate 2025-04-01
+     */
     type?: ChargeType;
-    /** Description of the additional charge. For example, `"Handling fee of $5 applied for gift wrapping"`. */
+    /**
+     * Description of the additional charge. For example, `"Handling fee of $5 applied for gift wrapping"`.
+     * @maxLength 250
+     */
     description?: string | null;
-    /** Cost of additional charge. For example, `12.5`. */
+    /**
+     * Cost of additional charge. For example, `12.5`.
+     * @maxLength 16
+     * @deprecated Cost of additional charge. For example, `12.5`.
+     * @replacedBy amount
+     * @targetRemovalDate 2025-04-01
+     */
     price?: string;
+    /**
+     * Cost of additional charge. For example, `12.5`.
+     * @maxLength 16
+     */
+    amount?: string;
 }
 export declare enum ChargeType {
     HANDLING_FEE = "HANDLING_FEE"
 }
 /** Defines the area inside one country that is relevant for this rule. */
 export interface Destination {
-    /** 2-letters code represents the country of the delivery destinations */
+    /**
+     * 2-letters code represents the country of the delivery destinations
+     * @format COUNTRY
+     */
     countryCode?: string;
     /**
      * subdivisions - Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).
      * If empty, the rule applies to the entire country.
+     * @maxSize 100
+     * @minLength 1
+     * @maxLength 256
      */
     subdivisions?: string[];
 }
 export interface CreatedBy extends CreatedByIdOneOf {
-    /** App ID - when the delivery profile was created by an external application or Wix service. */
+    /**
+     * App ID - when the delivery profile was created by an external application or Wix service.
+     * @format GUID
+     */
     appId?: string | null;
-    /** User ID - when the delivery profile was created by a Wix user. */
+    /**
+     * User ID - when the delivery profile was created by a Wix user.
+     * @format GUID
+     */
     userId?: string | null;
 }
 /** @oneof */
 export interface CreatedByIdOneOf {
-    /** App ID - when the delivery profile was created by an external application or Wix service. */
+    /**
+     * App ID - when the delivery profile was created by an external application or Wix service.
+     * @format GUID
+     */
     appId?: string | null;
-    /** User ID - when the delivery profile was created by a Wix user. */
+    /**
+     * User ID - when the delivery profile was created by a Wix user.
+     * @format GUID
+     */
     userId?: string | null;
 }
 export interface ExtendedFields {
@@ -125,23 +215,35 @@ export interface ExtendedFields {
     namespaces?: Record<string, Record<string, any>>;
 }
 export interface DeliveryRegionAdded {
-    /** The DeliveryProfile owns this region. */
+    /**
+     * The DeliveryProfile owns this region.
+     * @format GUID
+     */
     deliveryProfileId?: string;
     /**
      * The delivery region id.
+     * @format GUID
      * @readonly
      */
     deliveryRegionId?: string | null;
-    /** Optional name of the rule, for example: "Domestic". */
+    /**
+     * Optional name of the rule, for example: "Domestic".
+     * @minLength 1
+     * @maxLength 256
+     */
     name?: string | null;
     /** Indicates that this rule is active, default value is true. */
     active?: boolean | null;
     /**
      * The spi implementers id of shipping-rates spi, assigned to this rule.
+     * @maxSize 25
      * @readonly
      */
     deliveryCarriers?: DeliveryCarrier[];
-    /** The operation region of this rule, if empty than it is global. */
+    /**
+     * The operation region of this rule, if empty than it is global.
+     * @maxSize 200
+     */
     destinations?: Destination[];
     /**
      * Represents the time this Profile was created
@@ -150,29 +252,44 @@ export interface DeliveryRegionAdded {
     _createdDate?: Date | null;
 }
 export interface DeliveryRegionRemoved {
-    /** The DeliveryProfile owns this region. */
+    /**
+     * The DeliveryProfile owns this region.
+     * @format GUID
+     */
     deliveryProfileId?: string;
     /** The removed DeliveryRegion id. */
     deliveryRegionId?: string;
 }
 export interface DeliveryRegionUpdated {
-    /** The DeliveryProfile owns this DeliveryRegion. */
+    /**
+     * The DeliveryProfile owns this DeliveryRegion.
+     * @format GUID
+     */
     deliveryProfileId?: string;
     /**
      * The delivery region id.
+     * @format GUID
      * @readonly
      */
     deliveryRegionId?: string | null;
-    /** Optional name of the rule, for example: "Domestic". */
+    /**
+     * Optional name of the rule, for example: "Domestic".
+     * @minLength 1
+     * @maxLength 256
+     */
     name?: string | null;
     /** Indicates that this rule is active, default value is true. */
     active?: boolean | null;
     /**
      * The spi implementers id of shipping-rates spi, assigned to this rule.
+     * @maxSize 25
      * @readonly
      */
     deliveryCarriers?: DeliveryCarrier[];
-    /** The operation region of this rule, if empty than it is global. */
+    /**
+     * The operation region of this rule, if empty than it is global.
+     * @maxSize 200
+     */
     destinations?: Destination[];
     /**
      * Represents the time this Profile was created
@@ -189,7 +306,10 @@ export interface CreateDeliveryProfileResponse {
     deliveryProfile?: DeliveryProfile;
 }
 export interface GetDeliveryProfileRequest {
-    /** ID of the DeliveryProfile to retrieve. */
+    /**
+     * ID of the DeliveryProfile to retrieve.
+     * @format GUID
+     */
     deliveryProfileId: string;
 }
 export interface GetDeliveryProfileResponse {
@@ -205,7 +325,10 @@ export interface UpdateDeliveryProfileResponse {
     deliveryProfile?: DeliveryProfile;
 }
 export interface DeleteDeliveryProfileRequest {
-    /** Id of the DeliveryProfile to delete. */
+    /**
+     * Id of the DeliveryProfile to delete.
+     * @format GUID
+     */
     deliveryProfileId: string;
 }
 export interface DeleteDeliveryProfileResponse {
@@ -229,6 +352,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /**
      * Sort object in the following format:
      * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 5
      */
     sort?: Sorting[];
 }
@@ -238,7 +362,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;
@@ -248,13 +375,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;
 }
@@ -278,13 +409,22 @@ 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 AddDeliveryRegionRequest {
-    /** delivery profile id to associated with the DeliveryRegion */
+    /**
+     * delivery profile id to associated with the DeliveryRegion
+     * @format GUID
+     */
     deliveryProfileId: string;
     /** DeliveryRegion to be created */
     deliveryRegion: DeliveryRegion;
@@ -299,7 +439,10 @@ export interface AddDeliveryRegionResponse {
     deliveryProfile?: DeliveryProfile;
 }
 export interface UpdateDeliveryRegionRequest {
-    /** DeliveryProfile id that owns the DeliveryRegion */
+    /**
+     * DeliveryProfile id that owns the DeliveryRegion
+     * @format GUID
+     */
     deliveryProfileId: string;
     /** DeliveryRegion to be updated, may be partial */
     deliveryRegion: DeliveryRegion;
@@ -314,9 +457,15 @@ export interface UpdateDeliveryRegionResponse {
     deliveryProfile?: DeliveryProfile;
 }
 export interface RemoveDeliveryRegionRequest {
-    /** DeliveryProfile id that owns the DeliveryRegion */
+    /**
+     * DeliveryProfile id that owns the DeliveryRegion
+     * @format GUID
+     */
     deliveryProfileId: string;
-    /** Id of the DeliveryRegion to delete */
+    /**
+     * Id of the DeliveryRegion to delete
+     * @format GUID
+     */
     deliveryRegionId: string;
     /**
      * DeliveryProfile revision.
@@ -329,7 +478,10 @@ export interface RemoveDeliveryRegionResponse {
     deliveryProfile?: DeliveryProfile;
 }
 export interface AddDeliveryCarrierRequest {
-    /** delivery_region id to associated with the delivery_carrier. */
+    /**
+     * delivery_region id to associated with the delivery_carrier.
+     * @format GUID
+     */
     deliveryRegionId: string;
     /** delivery_carrier to be added. */
     deliveryCarrier: DeliveryCarrier;
@@ -339,9 +491,15 @@ export interface AddDeliveryCarrierResponse {
     deliveryProfile?: DeliveryProfile;
 }
 export interface RemoveDeliveryCarrierRequest {
-    /** Id of the DeliveryRegion */
+    /**
+     * Id of the DeliveryRegion
+     * @format GUID
+     */
     deliveryRegionId: string;
-    /** DeliveryCarrier app id to be removed. */
+    /**
+     * DeliveryCarrier app id to be removed.
+     * @format GUID
+     */
     appId: string;
 }
 export interface RemoveDeliveryCarrierResponse {
@@ -349,7 +507,10 @@ export interface RemoveDeliveryCarrierResponse {
     deliveryProfile?: DeliveryProfile;
 }
 export interface UpdateDeliveryCarrierRequest {
-    /** DeliveryRegion id */
+    /**
+     * DeliveryRegion id
+     * @format GUID
+     */
     deliveryRegionId: string;
     /** Updated delivery_carrier */
     deliveryCarrier?: DeliveryCarrier;
@@ -361,23 +522,46 @@ export interface UpdateDeliveryCarrierResponse {
 export interface ListDeliveryCarrierDetailsRequest {
 }
 export interface ListDeliveryCarrierDetailsResponse {
-    /** The list of carrier or multi-carrier services that has implemented the spi and installed on the current context(site) */
+    /**
+     * The list of carrier or multi-carrier services that has implemented the spi and installed on the current context(site)
+     * @maxSize 100
+     */
     deliveryCarrierDetails?: DeliveryCarrierDetails[];
 }
 export interface DeliveryCarrierDetails {
-    /** The id of the provider. */
+    /**
+     * The id of the provider.
+     * @format GUID
+     */
     _id?: string;
-    /** The name of the Provider. */
+    /**
+     * The name of the Provider.
+     * @maxLength 256
+     */
     displayName?: string;
-    /** Provider's description. */
+    /**
+     * Provider's description.
+     * @maxLength 200
+     */
     description?: string | null;
-    /** A link to learn more about the provider. */
+    /**
+     * A link to learn more about the provider.
+     * @maxLength 200
+     */
     learnMoreUrl?: string | null;
-    /** Dashboard URL for the provider. */
+    /**
+     * Dashboard URL for the provider.
+     * @minLength 1
+     * @maxLength 2048
+     * @format WEB_URL
+     */
     dashboardUrl?: string | null;
     /** If the provider fallback definition is mandatory. */
     fallbackDefinitionMandatory?: boolean | null;
-    /** Thumbnail image for provider. */
+    /**
+     * Thumbnail image for provider.
+     * @format WEB_URL
+     */
     thumbnailUrl?: string | null;
     /** feature toggle initialized with default value = false. should be true if implemented by spi provider */
     toggleGetCarrierSettingsEnabled?: boolean;
@@ -387,23 +571,46 @@ export interface DeliveryCarrierDetails {
 export interface ListInstalledDeliveryCarriersRequest {
 }
 export interface ListInstalledDeliveryCarriersResponse {
-    /** The list of carrier or multi-carrier services that has implemented the spi and installed on the current context(site) */
+    /**
+     * The list of carrier or multi-carrier services that has implemented the spi and installed on the current context(site)
+     * @maxSize 100
+     */
     installedDeliveryCarriers?: InstalledDeliveryCarrier[];
 }
 export interface InstalledDeliveryCarrier {
-    /** The id of the provider. */
+    /**
+     * The id of the provider.
+     * @format GUID
+     */
     _id?: string;
-    /** The name of the Provider. */
+    /**
+     * The name of the Provider.
+     * @maxLength 256
+     */
     displayName?: string;
-    /** Provider's description. */
+    /**
+     * Provider's description.
+     * @maxLength 200
+     */
     description?: string | null;
-    /** A link to learn more about the provider. */
+    /**
+     * A link to learn more about the provider.
+     * @maxLength 200
+     */
     learnMoreUrl?: string | null;
-    /** Dashboard URL for the provider. */
+    /**
+     * Dashboard URL for the provider.
+     * @minLength 1
+     * @maxLength 2048
+     * @format WEB_URL
+     */
     dashboardUrl?: string | null;
     /** If the provider fallback definition is mandatory. */
     fallbackDefinitionMandatory?: boolean | null;
-    /** Thumbnail image for provider. */
+    /**
+     * Thumbnail image for provider.
+     * @format WEB_URL
+     */
     thumbnailUrl?: string | null;
     /** feature toggle initialized with default value = false. should be true if implemented by spi provider */
     toggleGetCarrierSettingsEnabled?: boolean;
@@ -413,7 +620,10 @@ export interface ListDeliveryDestinationsRequest {
 export interface ListDeliveryDestinationsResponse {
     /** Scope of destinations, when worldwide is selected, the destinations list will be empty. */
     destinationScope?: DestinationScope;
-    /** The list of destinations */
+    /**
+     * The list of destinations
+     * @maxSize 200
+     */
     destinations?: Destination[];
 }
 export declare enum DestinationScope {
@@ -429,13 +639,24 @@ export interface RequiredZipcodeResponse {
     requiredZipcode?: boolean;
 }
 export interface ListDeliveryCarriersRequest {
-    /** Delivery profile id. */
+    /**
+     * Delivery profile id.
+     * @format GUID
+     */
     deliveryProfileId: string;
-    /** Delivery app ids to get settings for. */
+    /**
+     * Delivery app ids to get settings for.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 25
+     */
     appIds?: string[];
 }
 export interface ListDeliveryCarriersResponse {
-    /** The list of delivery settings for the given requests */
+    /**
+     * The list of delivery settings for the given requests
+     * @maxSize 100
+     */
     results?: ListDeliveryCarriersResult[];
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
@@ -445,11 +666,18 @@ export interface ListDeliveryCarriersResult {
     deliveryCarrierMetadata?: ItemMetadata;
     /** The delivery carrier details */
     deliveryCarrierDetails?: DeliveryCarrierDetails;
-    /** The delivery settings for the delivery profile and delivery region. */
+    /**
+     * The delivery settings for the delivery profile and delivery region.
+     * @minSize 1
+     * @maxSize 5
+     */
     deliveryCarrierRegionalSettings?: DeliveryCarrierRegionalSettings[];
 }
 export interface ItemMetadata {
-    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    /**
+     * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
+     * @format GUID
+     */
     _id?: string | null;
     /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
     success?: boolean;
@@ -465,27 +693,52 @@ export interface ApplicationError {
     data?: Record<string, any> | null;
 }
 export interface DeliveryCarrierRegionalSettings {
-    /** The delivery rule id. */
+    /**
+     * The delivery rule id.
+     * @format GUID
+     */
     deliveryRegionId?: string;
-    /** The shipping table values that are associated with the delivery rule. Can be multiple if the provider is an aggregator of multiple carriers. */
+    /**
+     * The shipping table values that are associated with the delivery rule. Can be multiple if the provider is an aggregator of multiple carriers.
+     * @minSize 1
+     * @maxSize 5
+     */
     dashboardTables?: DashboardTable[];
 }
 export interface DashboardTable {
-    /** The title of the delivery settings that will be displayed in the UI. */
+    /**
+     * The title of the delivery settings that will be displayed in the UI.
+     * @maxLength 256
+     */
     title?: string;
-    /** The columns of the delivery settings that will be displayed in the UI. */
+    /**
+     * The columns of the delivery settings that will be displayed in the UI.
+     * @maxSize 200
+     */
     columns?: Column[];
-    /** The content of the delivery settings. Each row is a map of column name to value. */
+    /**
+     * The content of the delivery settings. Each row is a map of column name to value.
+     * @maxSize 25
+     */
     rows?: Row[];
 }
 export interface Column {
-    /** The name of the column. This is used to get the data from the row. */
+    /**
+     * The name of the column. This is used to get the data from the row.
+     * @maxLength 256
+     */
     key?: string;
-    /** The title of the column that will be displayed in the UI. */
+    /**
+     * The title of the column that will be displayed in the UI.
+     * @maxLength 256
+     */
     name?: string;
 }
 export interface Row {
-    /** The external key of the data presented in a row. This is used to identify the row in the UI for editing. */
+    /**
+     * The external key of the data presented in a row. This is used to identify the row in the UI for editing.
+     * @maxLength 256
+     */
     key?: string;
     /**
      * The data presented in the row. The key is the column `name` and the value is the data in the specific row and column.
@@ -504,9 +757,15 @@ export interface BulkActionMetadata {
     undetailedFailures?: number;
 }
 export interface UpdateCarrierSettingsRequest {
-    /** Carrier id. */
+    /**
+     * Carrier id.
+     * @format GUID
+     */
     carrierId: string;
-    /** Row id triggered the change */
+    /**
+     * Row id triggered the change
+     * @format GUID
+     */
     rowId: string;
     /** New status */
     active: boolean | null;
@@ -556,7 +815,10 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
     studioAssigned?: StudioAssigned;
     /** Emitted when Studio is detached. */
     studioUnassigned?: StudioUnassigned;
-    /** A meta site id. */
+    /**
+     * A meta site id.
+     * @format GUID
+     */
     metaSiteId?: string;
     /** A meta site version. Monotonically increasing. */
     version?: string;
@@ -565,6 +827,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
     /**
      * TODO(meta-site): Change validation once validations are disabled for consumers
      * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
+     * @maxSize 4000
      */
     assets?: Asset[];
 }
@@ -602,9 +865,15 @@ export interface MetaSiteSpecialEventPayloadOneOf {
     studioUnassigned?: StudioUnassigned;
 }
 export interface Asset {
-    /** An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). */
+    /**
+     * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
+     * @maxLength 36
+     */
     appDefId?: string;
-    /** An instance id. For legacy reasons may be UUID or a string. */
+    /**
+     * An instance id. For legacy reasons may be UUID or a string.
+     * @maxLength 200
+     */
     instanceId?: string;
     /** An application state. */
     state?: State;
@@ -617,9 +886,15 @@ export declare enum State {
     DEMO = "DEMO"
 }
 export interface SiteCreated {
-    /** A template identifier (empty if not created from a template). */
+    /**
+     * A template identifier (empty if not created from a template).
+     * @maxLength 36
+     */
     originTemplateId?: string;
-    /** An account id of the owner. */
+    /**
+     * An account id of the owner.
+     * @format GUID
+     */
     ownerId?: string;
     /** A context in which meta site was created. */
     context?: SiteCreatedContext;
@@ -628,9 +903,13 @@ export interface SiteCreated {
      *
      * In case of a creation from a template it's a template id.
      * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
+     * @format GUID
      */
     originMetaSiteId?: string | null;
-    /** A meta site name (URL slug). */
+    /**
+     * A meta site name (URL slug).
+     * @maxLength 20
+     */
     siteName?: string;
     /** A namespace. */
     namespace?: Namespace;
@@ -727,9 +1006,15 @@ export declare enum Namespace {
 }
 /** Site transferred to another user. */
 export interface SiteTransferred {
-    /** A previous owner id (user that transfers meta site). */
+    /**
+     * A previous owner id (user that transfers meta site).
+     * @format GUID
+     */
     oldOwnerId?: string;
-    /** A new owner id (user that accepts meta site). */
+    /**
+     * A new owner id (user that accepts meta site).
+     * @format GUID
+     */
     newOwnerId?: string;
 }
 /** Soft deletion of the meta site. Could be restored. */
@@ -742,9 +1027,15 @@ export interface DeleteContext {
     dateDeleted?: Date | null;
     /** A status. */
     deleteStatus?: DeleteStatus;
-    /** A reason (flow). */
+    /**
+     * A reason (flow).
+     * @maxLength 255
+     */
     deleteOrigin?: string;
-    /** A service that deleted it. */
+    /**
+     * A service that deleted it.
+     * @maxLength 255
+     */
     initiatorId?: string | null;
 }
 export declare enum DeleteStatus {
@@ -760,7 +1051,11 @@ export interface SiteUndeleted {
 export interface SitePublished {
 }
 export interface SiteUnpublished {
-    /** A list of URLs previously associated with the meta site. */
+    /**
+     * A list of URLs previously associated with the meta site.
+     * @maxLength 4000
+     * @maxSize 10000
+     */
     urls?: string[];
 }
 export interface SiteMarkedAsTemplate {
@@ -783,30 +1078,60 @@ export interface SiteMarkedAsWixSite {
  * To ensure this, the TPA on the template gets a new instance_id.
  */
 export interface ServiceProvisioned {
-    /** Either UUID or EmbeddedServiceType. */
+    /**
+     * Either UUID or EmbeddedServiceType.
+     * @maxLength 36
+     */
     appDefId?: string;
-    /** Not only UUID. Something here could be something weird. */
+    /**
+     * Not only UUID. Something here could be something weird.
+     * @maxLength 36
+     */
     instanceId?: string;
-    /** An instance id from which this instance is originated. */
+    /**
+     * An instance id from which this instance is originated.
+     * @maxLength 36
+     */
     originInstanceId?: string;
-    /** A version. */
+    /**
+     * A version.
+     * @maxLength 500
+     */
     version?: string | null;
-    /** The origin meta site id */
+    /**
+     * The origin meta site id
+     * @format GUID
+     */
     originMetaSiteId?: string | null;
 }
 export interface ServiceRemoved {
-    /** Either UUID or EmbeddedServiceType. */
+    /**
+     * Either UUID or EmbeddedServiceType.
+     * @maxLength 36
+     */
     appDefId?: string;
-    /** Not only UUID. Something here could be something weird. */
+    /**
+     * Not only UUID. Something here could be something weird.
+     * @maxLength 36
+     */
     instanceId?: string;
-    /** A version. */
+    /**
+     * A version.
+     * @maxLength 500
+     */
     version?: string | null;
 }
 /** Rename of the site. Meaning, free public url has been changed as well. */
 export interface SiteRenamed {
-    /** A new meta site name (URL slug). */
+    /**
+     * A new meta site name (URL slug).
+     * @maxLength 20
+     */
     newSiteName?: string;
-    /** A previous meta site name (URL slug). */
+    /**
+     * A previous meta site name (URL slug).
+     * @maxLength 255
+     */
     oldSiteName?: string;
 }
 /**
@@ -903,9 +1228,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;
@@ -913,26 +1244,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 {
@@ -942,12 +1297,17 @@ export declare enum WebhookIdentityType {
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
+interface BackupRateNonNullableFields {
+    active: boolean;
+}
 interface AdditionalChargeNonNullableFields {
     type: ChargeType;
     price: string;
+    amount: string;
 }
 interface DeliveryCarrierNonNullableFields {
     appId: string;
+    backupRate?: BackupRateNonNullableFields;
     additionalCharges: AdditionalChargeNonNullableFields[];
 }
 interface DestinationNonNullableFields {
@@ -1058,7 +1418,6 @@ export interface UpdateExtendedFieldsResponseNonNullableFields {
  * @public
  * @documentationMaturity preview
  * @requiredField deliveryProfile
- * @requiredField deliveryProfile.deliveryRegions.deliveryCarriers.backupRate.rate
  * @requiredField deliveryProfile.deliveryRegions.destinations
  * @requiredField deliveryProfile.deliveryRegions.destinations.countryCode
  * @requiredField deliveryProfile.deliveryRegions.name
@@ -1066,6 +1425,8 @@ export interface UpdateExtendedFieldsResponseNonNullableFields {
  * @permissionId ECOM.DELIVERY_PROFILE_CREATE
  * @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
@@ -1084,6 +1445,8 @@ export declare function createDeliveryProfile(deliveryProfile: DeliveryProfile):
  * @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
@@ -1113,6 +1476,8 @@ export declare function getDeliveryProfile(deliveryProfileId: string): Promise<D
  * @permissionId ECOM.DELIVERY_PROFILE_UPDATE
  * @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
@@ -1123,17 +1488,25 @@ export declare function updateDeliveryProfile(_id: string | null, deliveryProfil
 export interface UpdateDeliveryProfile {
     /**
      * DeliveryProfile ID.
+     * @format GUID
      * @readonly
      */
     _id?: string | null;
-    /** DeliveryProfile name. */
+    /**
+     * DeliveryProfile name.
+     * @minLength 1
+     * @maxLength 256
+     */
     name?: string | null;
     /**
      * Flags this DeliveryProfile as the default DeliveryProfile.
      * @readonly
      */
     default?: boolean | null;
-    /** A list of DeliveryProfile regions. */
+    /**
+     * A list of DeliveryProfile regions.
+     * @maxSize 100
+     */
     deliveryRegions?: DeliveryRegion[];
     /** ID of the delivery profile's creator. */
     createdBy?: CreatedBy;
@@ -1166,6 +1539,8 @@ export interface UpdateDeliveryProfile {
  * @permissionId ECOM.DELIVERY_PROFILE_DELETE
  * @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
@@ -1187,6 +1562,8 @@ export declare function deleteDeliveryProfile(deliveryProfileId: string): Promis
  * @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.DELIVERY_PROFILE_READ
@@ -1280,12 +1657,13 @@ export interface DeliveryProfilesQueryBuilder {
  * @documentationMaturity preview
  * @requiredField deliveryProfileId
  * @requiredField deliveryRegion
- * @requiredField deliveryRegion.deliveryCarriers.backupRate.rate
  * @requiredField deliveryRegion.destinations.countryCode
  * @requiredField deliveryRegion.name
  * @permissionId ECOM.DELIVERY_PROFILE_UPDATE
  * @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
@@ -1314,6 +1692,8 @@ export interface AddDeliveryRegionOptions {
  * @permissionId ECOM.DELIVERY_REGION_UPDATE
  * @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
@@ -1321,10 +1701,14 @@ export interface AddDeliveryRegionOptions {
  */
 export declare function updateDeliveryRegion(identifiers: UpdateDeliveryRegionIdentifiers, deliveryRegion: UpdateDeliveryRegion, options?: UpdateDeliveryRegionOptions): Promise<UpdateDeliveryRegionResponse & UpdateDeliveryRegionResponseNonNullableFields>;
 export interface UpdateDeliveryRegionIdentifiers {
-    /** DeliveryProfile id that owns the DeliveryRegion */
+    /**
+     * DeliveryProfile id that owns the DeliveryRegion
+     * @format GUID
+     */
     deliveryProfileId: string;
     /**
      * The delivery region id.
+     * @format GUID
      * @readonly
      */
     deliveryRegionId?: string | null;
@@ -1332,19 +1716,28 @@ export interface UpdateDeliveryRegionIdentifiers {
 export interface UpdateDeliveryRegion {
     /**
      * The delivery region id.
+     * @format GUID
      * @readonly
      */
     _id?: string | null;
-    /** Optional name of the rule, for example: "Domestic". */
+    /**
+     * Optional name of the rule, for example: "Domestic".
+     * @minLength 1
+     * @maxLength 256
+     */
     name?: string | null;
     /** Indicates that this rule is active, default value is true. */
     active?: boolean | null;
     /**
      * The spi implementers id of shipping-rates spi, assigned to this rule.
+     * @maxSize 25
      * @readonly
      */
     deliveryCarriers?: DeliveryCarrier[];
-    /** The operation region of this rule, if empty than it is global. */
+    /**
+     * The operation region of this rule, if empty than it is global.
+     * @maxSize 200
+     */
     destinations?: Destination[];
     /**
      * Represents the time this Profile was created
@@ -1369,6 +1762,8 @@ export interface UpdateDeliveryRegionOptions {
  * @permissionId ECOM.DELIVERY_PROFILE_UPDATE
  * @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
@@ -1376,9 +1771,15 @@ export interface UpdateDeliveryRegionOptions {
  */
 export declare function removeDeliveryRegion(identifiers: RemoveDeliveryRegionIdentifiers, options?: RemoveDeliveryRegionOptions): Promise<RemoveDeliveryRegionResponse & RemoveDeliveryRegionResponseNonNullableFields>;
 export interface RemoveDeliveryRegionIdentifiers {
-    /** DeliveryProfile id that owns the DeliveryRegion */
+    /**
+     * DeliveryProfile id that owns the DeliveryRegion
+     * @format GUID
+     */
     deliveryProfileId: string;
-    /** Id of the DeliveryRegion to delete */
+    /**
+     * Id of the DeliveryRegion to delete
+     * @format GUID
+     */
     deliveryRegionId: string;
 }
 export interface RemoveDeliveryRegionOptions {
@@ -1396,10 +1797,11 @@ export interface RemoveDeliveryRegionOptions {
  * @requiredField deliveryRegionId
  * @requiredField options
  * @requiredField options.deliveryCarrier
- * @requiredField options.deliveryCarrier.backupRate.rate
  * @permissionId ECOM.DELIVERY_CARRIER_ADD
  * @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
@@ -1421,6 +1823,8 @@ export interface AddDeliveryCarrierOptions {
  * @permissionId ECOM.DELIVERY_CARRIER_REMOVE
  * @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
@@ -1428,7 +1832,10 @@ export interface AddDeliveryCarrierOptions {
  */
 export declare function removeDeliveryCarrier(deliveryRegionId: string, options: RemoveDeliveryCarrierOptions): Promise<RemoveDeliveryCarrierResponse & RemoveDeliveryCarrierResponseNonNullableFields>;
 export interface RemoveDeliveryCarrierOptions {
-    /** DeliveryCarrier app id to be removed. */
+    /**
+     * DeliveryCarrier app id to be removed.
+     * @format GUID
+     */
     appId: string;
 }
 /**
@@ -1441,6 +1848,8 @@ export interface RemoveDeliveryCarrierOptions {
  * @permissionId ECOM.DELIVERY_CARRIER_UPDATE
  * @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
@@ -1460,6 +1869,8 @@ export interface UpdateDeliveryCarrierOptions {
  * @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
@@ -1476,6 +1887,8 @@ export declare function listDeliveryCarrierDetails(): Promise<ListDeliveryCarrie
  * @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
@@ -1494,6 +1907,8 @@ export declare function listInstalledDeliveryCarriers(): Promise<ListInstalledDe
  * @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
@@ -1501,7 +1916,12 @@ export declare function listInstalledDeliveryCarriers(): Promise<ListInstalledDe
  */
 export declare function listDeliveryCarriers(deliveryProfileId: string, options?: ListDeliveryCarriersOptions): Promise<ListDeliveryCarriersResponse & ListDeliveryCarriersResponseNonNullableFields>;
 export interface ListDeliveryCarriersOptions {
-    /** Delivery app ids to get settings for. */
+    /**
+     * Delivery app ids to get settings for.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 25
+     */
     appIds?: string[];
 }
 /**
@@ -1516,6 +1936,8 @@ export interface ListDeliveryCarriersOptions {
  * @permissionId ECOM.DELIVERY_CARRIER_UPDATE
  * @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
@@ -1523,7 +1945,10 @@ export interface ListDeliveryCarriersOptions {
  */
 export declare function updateCarrierSettings(carrierId: string, options: UpdateCarrierSettingsOptions): Promise<void>;
 export interface UpdateCarrierSettingsOptions {
-    /** Row id triggered the change */
+    /**
+     * Row id triggered the change
+     * @format GUID
+     */
     rowId: string;
     /** New status */
     active: boolean | null;
@@ -1541,6 +1966,8 @@ export interface UpdateCarrierSettingsOptions {
  * @permissionId ECOM.DELIVERY_PROFILE_UPDATE
  * @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