@wix/auto_sdk_ecom_delivery-profile 1.0.242 → 1.0.243

package/build/cjs/meta.d.ts

@@ -2,127 +2,143 @@ import { CreateDeliveryProfileRequest as CreateDeliveryProfileRequest$1, CreateD
 import '@wix/sdk-types';
 
 /**
- * A DeliveryProfile is a collection of delivery configurations that define shipping options for products.
- * Each profile contains delivery regions, which specify where products can be shipped and which carriers can deliver
- * to those destinations. Use delivery profiles to organize and manage different shipping strategies for your store.
+ * A delivery profile is a collection of delivery regions that define shipping options for products.
+ * Each profile contains delivery regions, which specify where products can be shipped and which carriers can deliver to those destinations.
  */
 interface DeliveryProfile {
     /**
-     * DeliveryProfile ID.
+     * Delivery profile ID.
      * @format GUID
      * @readonly
      */
     id?: string | null;
     /**
-     * DeliveryProfile name.
+     * Delivery profile name.
      * @minLength 1
      * @maxLength 256
      */
     name?: string | null;
     /**
-     * Indicates whether this is the default DeliveryProfile.
-     * The first delivery profile is automatically created and marked as default when the Wix Stores app is installed.
-     * Default status cannot be changed or transferred to another profile.
-     * The default profile cannot be deleted because every site requires one for core delivery functionality.
+     * Whether this is the default delivery profile.
+     *
+     * > **Notes:**
+     * >
+     * > - The first delivery profile is automatically created and marked as default when the Wix Stores, Wix Bookings, Wix Events, or Wix Restaurants business solutions are installed on a site.
+     * > - Default status can't be changed or transferred to another profile.
+     * > - The default profile can't be deleted because every site requires one for core delivery functionality.
      * @readonly
      */
     default?: boolean | null;
     /**
-     * A list of DeliveryProfile regions.
+     * Delivery regions in this profile.
      * @maxSize 100
      */
     deliveryRegions?: DeliveryRegion[];
     /**
      * Information about who created the delivery profile.
-     * Contains either an app ID (for profiles created by apps) or a user ID (for profiles created by site users).
+     *
+     * Currently only for use with Wix Restaurants.
      */
     createdBy?: CreatedBy;
     /**
-     * DeliveryProfile revision.
+     * Revision number, which increments by 1 each time the delivery profile is updated. To prevent conflicting changes, the current revision must be passed when updating the delivery profile. Ignored when creating a delivery profile.
      * @readonly
      */
     revision?: string | null;
     /**
-     * Date and time the DeliveryProfile was created.
+     * Date and time the delivery profile was created.
      * @readonly
      */
     createdDate?: Date | null;
     /**
-     * Date and time the DeliveryProfile was last updated.
+     * Date and time the delivery profile was last updated.
      * @readonly
      */
     updatedDate?: Date | null;
-    /** [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields ) must be configured in the app dashboard before they can be accessed with API calls. */
+    /** Custom field data for the delivery profile object. [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls. */
     extendedFields?: ExtendedFields;
 }
 /**
- * A DeliveryRegion defines a geographic area and its associated delivery carriers.
- * Each region specifies destinations (countries and subdivisions) where products
- * can be shipped and the carriers available for those deliveries.
+ * A delivery region defines a geographic area and its associated delivery carriers.
+ * Each region specifies destinations (countries and subdivisions) where products can be shipped and the carriers available for those deliveries.
+ *
+ * During the eCommerce onboarding flow, an "International" region with empty destinations is automatically created. This serves as a "Rest of World" configuration that applies to destinations not explicitly defined in other regions.
  */
 interface DeliveryRegion {
     /**
-     * The delivery region id.
+     * Delivery region ID.
      * @format GUID
      * @readonly
      */
     id?: string | null;
     /**
-     * Optional name of the region, for example: "Domestic".
+     * Delivery region name. For example, `"Domestic"` or `"International"`.
      * @minLength 1
      * @maxLength 256
      */
     name?: string | null;
-    /** Indicates that this delivery region is active, default value is true. */
+    /**
+     * Whether this delivery region is active and available during checkout.
+     *
+     * Default: `true`
+     */
     active?: boolean | null;
     /**
-     * The spi implementers id of shipping-rates spi, assigned to this delivery region.
+     * Delivery carriers assigned to this region. Carriers are managed using the Add Delivery Carrier, Update Delivery Carrier, and Remove Delivery Carrier methods.
      * @maxSize 25
      * @readonly
      */
     deliveryCarriers?: DeliveryCarrier[];
     /**
-     * The operation region of this delivery region, if empty than it is global.
+     * Geographic destinations covered by this region. If empty, the region applies globally.
      * @maxSize 250
      */
     destinations?: Destination[];
     /**
-     * Represents the time this Profile was created
+     * Date and time the delivery region was created.
      * @readonly
      */
     createdDate?: Date | null;
 }
 interface DeliveryCarrier {
     /**
-     * ID of the app providing the content.
-     *
-     * You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
+     * Carrier app ID.
      *
-     * Can be fetched by ListDeliveryCarriers api.
+     * Get app IDs from the [app dashboard](https://dev.wix.com/dc3/my-apps/), or by calling [List Installed Delivery Carriers](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/list-installed-delivery-carriers).
      * @format GUID
      */
     appId?: string;
-    /** Backup rate to be used in case the cost returned by the provider is empty. */
+    /**
+     * Backup rate to use when the carrier doesn't return a rate for a specific shipping option.
+     *
+     * When `active` is `false` and the carrier doesn't return a rate, the carrier's shipping options aren't shown to customers.
+     */
     backupRate?: BackupRate;
     /**
-     * Additional charges to add to the delivery rate for this carrier
+     * Additional charges to add to the delivery rate. These charges are combined with the carrier's rate into a single shipping cost and itemized in order details.
      * @maxSize 10
      */
     additionalCharges?: AdditionalCharge[];
 }
 interface BackupRate {
     /**
-     * Default rate title that will concatenate to the delivery options the provider will offer.
+     * Title displayed for the backup rate. For example, `"Standard Shipping"`.
      * @minLength 1
      * @maxLength 32
      */
     title?: string | null;
     /**
-     * Default amount price for all delivery options that the provider will offer.
+     * Backup rate amount.
      * @decimalValue options { gte:0, maxScale:6 }
      */
     amount?: string | null;
-    /** Should the default rate be used. Default value is false. */
+    /**
+     * Whether the backup rate is active.
+     *
+     * When `false`, if the carrier doesn't return a rate, the carrier's shipping options aren't shown to customers.
+     *
+     * Default: `false`
+     */
     active?: boolean;
 }
 interface AdditionalCharge {
@@ -132,21 +148,20 @@ interface AdditionalCharge {
      */
     description?: string | null;
     /**
-     * Cost of additional charge. For example, `12.5`.
+     * Charge amount. For example, `"12.5"`.
      * @maxLength 16
      */
     amount?: string;
 }
-/** Defines the area inside one country that is relevant for this delivery region. */
+/** Geographic destination for a delivery region. */
 interface Destination {
     /**
-     * 2-letters code represents the country of the delivery destinations
+     * 2-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
      * @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 delivery region applies to the entire country.
+     * Subdivision codes in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. For example, `"US-CA"` for California. If empty, the delivery region applies to the entire country.
      * @maxSize 100
      * @minLength 1
      * @maxLength 256
@@ -155,12 +170,12 @@ interface Destination {
 }
 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.
+     * Wix user ID, when the delivery profile was created by a Wix user.
      * @format GUID
      */
     userId?: string | null;
@@ -168,12 +183,12 @@ interface CreatedBy extends CreatedByIdOneOf {
 /** @oneof */
 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.
+     * Wix user ID, when the delivery profile was created by a Wix user.
      * @format GUID
      */
     userId?: string | null;
@@ -189,122 +204,125 @@ interface ExtendedFields {
      */
     namespaces?: Record<string, Record<string, any>>;
 }
+/** Event payload for when a delivery region is added to a delivery profile. */
 interface DeliveryRegionAdded {
     /**
-     * The DeliveryProfile owns this region.
+     * ID of the delivery profile containing the region.
      * @format GUID
      */
     deliveryProfileId?: string;
     /**
-     * The delivery region id.
+     * ID of the added delivery region.
      * @format GUID
      * @readonly
      */
     deliveryRegionId?: string | null;
     /**
-     * Optional name of the delivery region, for example: "Domestic".
+     * Delivery region name. For example, `"Domestic"`.
      * @minLength 1
      * @maxLength 256
      */
     name?: string | null;
-    /** Indicates that this delivery region is active, default value is true. */
+    /** Whether the delivery region is active. */
     active?: boolean | null;
     /**
-     * The spi implementers id of shipping-rates spi, assigned to this delivery region.
+     * Delivery carriers assigned to this region.
      * @maxSize 25
      * @readonly
      */
     deliveryCarriers?: DeliveryCarrier[];
     /**
-     * The operation region of this delivery region, if empty than it is global.
+     * Geographic destinations covered by this region.
      * @maxSize 200
      */
     destinations?: Destination[];
     /**
-     * Represents the time this Profile was created
+     * Date and time the delivery region was created.
      * @readonly
      */
     createdDate?: Date | null;
 }
+/** Event payload for when a delivery region is removed from a delivery profile. */
 interface DeliveryRegionRemoved {
     /**
-     * The DeliveryProfile owns this region.
+     * ID of the delivery profile that contained the region.
      * @format GUID
      */
     deliveryProfileId?: string;
     /**
-     * The removed DeliveryRegion id.
+     * ID of the removed delivery region.
      * @format GUID
      */
     deliveryRegionId?: string;
 }
+/** Event payload for when a delivery region is updated. */
 interface DeliveryRegionUpdated {
     /**
-     * The DeliveryProfile owns this DeliveryRegion.
+     * ID of the delivery profile containing the region.
      * @format GUID
      */
     deliveryProfileId?: string;
     /**
-     * The delivery region id.
+     * ID of the updated delivery region.
      * @format GUID
      * @readonly
      */
     deliveryRegionId?: string | null;
     /**
-     * Optional name of the delivery region, for example: "Domestic".
+     * Delivery region name. For example, `"Domestic"`.
      * @minLength 1
      * @maxLength 256
      */
     name?: string | null;
-    /** Indicates that this delivery region is active, default value is true. */
+    /** Whether the delivery region is active. */
     active?: boolean | null;
     /**
-     * The spi implementers id of shipping-rates spi, assigned to this delivery region.
+     * Delivery carriers assigned to this region.
      * @maxSize 25
      * @readonly
      */
     deliveryCarriers?: DeliveryCarrier[];
     /**
-     * The operation region of this delivery region, if empty than it is global.
+     * Geographic destinations covered by this region. If empty, the region applies globally.
      * @maxSize 200
      */
     destinations?: Destination[];
     /**
-     * Represents the time this Profile was created
+     * Date and time the delivery region was created.
      * @readonly
      */
     createdDate?: Date | null;
 }
 interface CreateDeliveryProfileRequest {
-    /** DeliveryProfile to be created. */
+    /** Delivery profile to create. */
     deliveryProfile: DeliveryProfile;
 }
 interface CreateDeliveryProfileResponse {
-    /** The created DeliveryProfile. */
+    /** Created delivery profile. */
     deliveryProfile?: DeliveryProfile;
 }
 interface GetDeliveryProfileRequest {
     /**
-     * ID of the DeliveryProfile to retrieve.
+     * Delivery profile ID.
      * @format GUID
      */
     deliveryProfileId: string;
 }
 interface GetDeliveryProfileResponse {
-    /** The requested DeliveryProfile. */
+    /** Retrieved delivery profile. */
     deliveryProfile?: DeliveryProfile;
 }
 interface UpdateDeliveryProfileRequest {
-    /** DeliveryProfile to be updated, may be partial. */
+    /** Delivery profile to update. */
     deliveryProfile: DeliveryProfile;
 }
 interface UpdateDeliveryProfileResponse {
-    /** Updated DeliveryProfile. */
+    /** Updated delivery profile. */
     deliveryProfile?: DeliveryProfile;
 }
 interface DeleteDeliveryProfileRequest {
     /**
-     * Id of the DeliveryProfile to delete.
+     * Delivery profile ID.
      * @format GUID
      */
     deliveryProfileId: string;
@@ -313,7 +331,7 @@ interface DeleteDeliveryProfileResponse {
 }
 interface DeleteDefaultDeliveryProfileRequest {
     /**
-     * Id of the DeliveryProfile to delete.
+     * Delivery profile ID.
      * @format GUID
      */
     deliveryProfileId?: string;
@@ -321,7 +339,7 @@ interface DeleteDefaultDeliveryProfileRequest {
 interface DeleteDefaultDeliveryProfileResponse {
 }
 interface QueryDeliveryProfilesRequest {
-    /** WQL expression. */
+    /** Query options. */
     query?: CursorQuery;
 }
 interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -380,11 +398,11 @@ interface CursorPaging {
 }
 interface QueryDeliveryProfilesResponse {
     /**
-     * List of DeliveryProfiles.
+     * List of delivery profiles.
      * @maxSize 100
      */
     deliveryProfiles?: DeliveryProfile[];
-    /** Paging metadata */
+    /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata;
 }
 interface CursorPagingMetadata {
@@ -414,176 +432,176 @@ interface Cursors {
 }
 interface AddDeliveryRegionRequest {
     /**
-     * delivery profile id to associated with the DeliveryRegion
+     * Delivery profile ID.
      * @format GUID
      */
     deliveryProfileId: string;
-    /** DeliveryRegion to be created */
+    /** Delivery region to add. */
     deliveryRegion: DeliveryRegion;
     /**
-     * DeliveryProfile revision.
+     * Delivery profile revision.
      * @readonly
      */
     revision?: string | null;
 }
 interface AddDeliveryRegionResponse {
-    /** The updated DeliveryProfile with the new DeliveryRegion */
+    /** Updated delivery profile with the new delivery region. */
     deliveryProfile?: DeliveryProfile;
 }
 interface UpdateDeliveryRegionRequest {
     /**
-     * DeliveryProfile id that owns the DeliveryRegion
+     * Delivery profile ID.
      * @format GUID
      */
     deliveryProfileId: string;
-    /** DeliveryRegion to be updated, may be partial */
+    /** Delivery region to update. */
     deliveryRegion: DeliveryRegion;
     /**
-     * DeliveryProfile revision.
+     * Delivery profile revision.
      * @readonly
      */
     revision?: string | null;
 }
 interface UpdateDeliveryRegionResponse {
-    /** The updated DeliveryProfile with the updated DeliveryRegion */
+    /** Updated delivery profile with the updated delivery region. */
     deliveryProfile?: DeliveryProfile;
 }
 interface GetDeliveryProfileByDeliveryRegionIdRequest {
     /**
-     * ID of the DeliveryRegion to retrieve the profile for.
+     * Delivery region ID.
      * @format GUID
      */
     deliveryRegionId: string;
 }
 interface GetDeliveryProfileByDeliveryRegionIdResponse {
-    /** The DeliveryProfile containing the requested region. */
+    /** Delivery profile containing the requested region. */
     deliveryProfile?: DeliveryProfile;
 }
 interface RemoveDeliveryRegionRequest {
     /**
-     * DeliveryProfile id that owns the DeliveryRegion
+     * Delivery profile ID.
      * @format GUID
      */
     deliveryProfileId: string;
     /**
-     * Id of the DeliveryRegion to delete
+     * Delivery region ID.
      * @format GUID
      */
     deliveryRegionId: string;
     /**
-     * DeliveryProfile revision.
+     * Delivery profile revision.
      * @readonly
      */
     revision?: string | null;
 }
 interface RemoveDeliveryRegionResponse {
-    /** The updated DeliveryProfile without DeliveryRegion */
+    /** Updated delivery profile with the delivery region removed. */
     deliveryProfile?: DeliveryProfile;
 }
 interface AddDeliveryCarrierRequest {
     /**
-     * delivery_region id to associated with the delivery_carrier.
+     * Delivery region ID.
      * @format GUID
      */
     deliveryRegionId: string;
-    /** delivery_carrier to be added. */
+    /** Delivery carrier to add. */
     deliveryCarrier: DeliveryCarrier;
 }
 interface AddDeliveryCarrierResponse {
-    /** The updated DeliveryProfile */
+    /** Updated delivery profile. */
     deliveryProfile?: DeliveryProfile;
 }
 interface RemoveDeliveryCarrierRequest {
     /**
-     * Id of the DeliveryRegion
+     * Delivery region ID.
      * @format GUID
      */
     deliveryRegionId: string;
     /**
-     * DeliveryCarrier app id to be removed.
+     * App ID of the delivery carrier to remove.
      * @format GUID
      */
     appId: string;
 }
 interface RemoveDeliveryCarrierResponse {
-    /** The updated DeliveryProfile */
+    /** Updated delivery profile. */
     deliveryProfile?: DeliveryProfile;
 }
 interface UpdateDeliveryCarrierRequest {
     /**
-     * DeliveryRegion id
+     * Delivery region ID.
      * @format GUID
      */
     deliveryRegionId: string;
-    /** Updated delivery_carrier */
+    /** Delivery carrier to update. */
     deliveryCarrier?: DeliveryCarrier;
 }
 interface UpdateDeliveryCarrierResponse {
-    /** The updated DeliveryProfile with the updated DeliveryCarrier */
+    /** Updated delivery profile with the updated delivery carrier. */
     deliveryProfile?: DeliveryProfile;
 }
 interface ListInstalledDeliveryCarriersRequest {
 }
 interface ListInstalledDeliveryCarriersResponse {
     /**
-     * The list of carrier or multi-carrier services that has implemented the spi and installed on the current context(site)
+     * List of installed delivery carriers on the site.
      * @maxSize 100
      */
     installedDeliveryCarriers?: InstalledDeliveryCarrier[];
 }
 interface InstalledDeliveryCarrier {
     /**
-     * The id of the provider.
+     * Carrier app ID.
      * @format GUID
      */
     id?: string;
     /**
-     * The name of the Provider.
+     * Carrier display name.
      * @maxLength 256
      */
     displayName?: string;
     /**
-     * Provider's description.
+     * Carrier description.
      * @maxLength 200
      */
     description?: string | null;
     /**
-     * A link to learn more about the provider.
+     * URL to learn more about the carrier.
      * @maxLength 200
      */
     learnMoreUrl?: string | null;
     /**
-     * Dashboard URL for the provider.
+     * URL to the carrier's dashboard.
      * @minLength 1
      * @maxLength 2048
      * @format WEB_URL
      */
     dashboardUrl?: string | null;
-    /** If the provider fallback definition is mandatory. */
+    /** Whether a backup rate is required for this carrier. */
     fallbackDefinitionMandatory?: boolean | null;
     /**
-     * Thumbnail image for provider.
+     * URL for the carrier's thumbnail image.
      * @format WEB_URL
      */
     thumbnailUrl?: string | null;
-    /** feature toggle initialized with default value = false. should be true if implemented by spi provider */
+    /** Whether the carrier supports retrieving carrier settings. */
     toggleGetCarrierSettingsEnabled?: boolean;
 }
 interface ListDeliveryDestinationsRequest {
 }
 interface ListDeliveryDestinationsResponse {
-    /** Scope of destinations, when worldwide is selected, the destinations list will be empty. */
+    /** Scope of destinations. When `WORLDWIDE` is selected, the `destinations` list is empty. */
     destinationScope?: DestinationScopeWithLiterals;
     /**
-     * The list of destinations
+     * List of configured destinations.
      * @maxSize 200
      */
     destinations?: Destination[];
 }
 declare enum DestinationScope {
-    /** No additional destinations are requested */
+    /** Specific destinations are configured. */
     SPECIFIC_DESTINATIONS = "SPECIFIC_DESTINATIONS",
-    /** All Destinations */
+    /** All destinations worldwide. */
     WORLDWIDE = "WORLDWIDE"
 }
 /** @enumType */
@@ -591,36 +609,36 @@ type DestinationScopeWithLiterals = DestinationScope | 'SPECIFIC_DESTINATIONS' |
 interface RequiredZipcodeRequest {
 }
 interface RequiredZipcodeResponse {
-    /** If the site requires a zipcode for delivery */
+    /** Whether the site requires a postal code for delivery. */
     requiredZipcode?: boolean;
 }
 interface GetDeliveryDestinationPropertiesRequest {
 }
 interface GetDeliveryDestinationPropertiesResponse {
-    /** Delivery destination properties for Rest Of World */
+    /** Delivery destination properties for Rest of World. */
     restOfWorld?: DeliveryDestinationProperties;
     /**
-     * List of countries and subdivisions and their delivery destination properties
+     * List of countries and their delivery destination properties.
      * @maxSize 195
      */
     countries?: CountryDeliveryProperties[];
 }
 interface DeliveryDestinationProperties {
-    /** True if postal code is required for delivery in this destination */
+    /** Whether a postal code is required for delivery to this destination. */
     postalCodeRequired?: boolean;
-    /** True if only pickup is available in this destination */
+    /** Whether only pickup is available at this destination. */
     pickupOnly?: boolean;
 }
 interface CountryDeliveryProperties {
     /**
-     * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
+     * 2-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
      * @format COUNTRY
      */
     country?: string;
-    /** Delivery destination properties for country */
+    /** Delivery destination properties for the country. */
     deliveryDestinationProperties?: DeliveryDestinationProperties;
     /**
-     * List of subdivisions and their delivery destination properties
+     * List of subdivisions and their delivery destination properties.
      * @maxSize 100
      */
     subdivisions?: SubdivisionDeliveryProperties[];
@@ -632,17 +650,17 @@ interface SubdivisionDeliveryProperties {
      * @maxLength 5
      */
     subdivision?: string;
-    /** Delivery destination properties for subdivision */
+    /** Delivery destination properties for the subdivision. */
     deliveryDestinationProperties?: DeliveryDestinationProperties;
 }
 interface ListDeliveryCarriersRequest {
     /**
-     * Delivery profile id.
+     * Delivery profile ID.
      * @format GUID
      */
     deliveryProfileId: string;
     /**
-     * Delivery app ids to get settings for.
+     * App IDs of the delivery carriers to retrieve settings for.
      * @format GUID
      * @minSize 1
      * @maxSize 25
@@ -651,7 +669,7 @@ interface ListDeliveryCarriersRequest {
 }
 interface ListDeliveryCarriersResponse {
     /**
-     * The list of delivery settings for the given requests
+     * List of delivery carrier results.
      * @maxSize 100
      */
     results?: ListDeliveryCarriersResult[];
@@ -659,12 +677,12 @@ interface ListDeliveryCarriersResponse {
     bulkActionMetadata?: BulkActionMetadata;
 }
 interface ListDeliveryCarriersResult {
-    /** Information about successful action or error for failure. */
+    /** Metadata for the result, including success or error information. */
     deliveryCarrierMetadata?: ItemMetadata;
-    /** The delivery carrier details */
+    /** Delivery carrier details. */
     deliveryCarrierDetails?: DeliveryCarrierDetails;
     /**
-     * The delivery settings for the delivery profile and delivery region.
+     * Regional settings for the delivery carrier.
      * @minSize 1
      * @maxSize 5
      */
@@ -691,52 +709,52 @@ interface ApplicationError {
 }
 interface DeliveryCarrierDetails {
     /**
-     * The id of the provider.
+     * Carrier app ID.
      * @format GUID
      */
     id?: string;
     /**
-     * The name of the Provider.
+     * Carrier display name.
      * @maxLength 256
      */
     displayName?: string;
     /**
-     * Provider's description.
+     * Carrier description.
      * @maxLength 200
      */
     description?: string | null;
     /**
-     * A link to learn more about the provider.
+     * URL to learn more about the carrier.
      * @maxLength 200
      */
     learnMoreUrl?: string | null;
     /**
-     * Dashboard URL for the provider.
+     * URL to the carrier's dashboard.
      * @minLength 1
      * @maxLength 2048
      * @format WEB_URL
      */
     dashboardUrl?: string | null;
-    /** If the provider fallback definition is mandatory. */
+    /** Whether a backup rate is required for this carrier. */
     fallbackDefinitionMandatory?: boolean | null;
     /**
-     * Thumbnail image for provider.
+     * URL for the carrier's thumbnail image.
      * @format WEB_URL
      */
     thumbnailUrl?: string | null;
-    /** feature toggle initialized with default value = false. should be true if implemented by spi provider */
+    /** Whether the carrier supports retrieving carrier settings. */
     toggleGetCarrierSettingsEnabled?: boolean;
-    /** feature toggle initialized with default value = false. should be true if implemented by spi provider */
+    /** Whether the carrier supports updating carrier active status. */
     toggleUpdateCarrierActiveStatusEnabled?: boolean;
 }
 interface DeliveryCarrierRegionalSettings {
     /**
-     * The delivery rule id.
+     * Delivery region 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.
+     * Dashboard tables with shipping configuration for this region. Multiple tables can exist if the carrier is an aggregator of multiple services.
      * @minSize 1
      * @maxSize 5
      */
@@ -744,45 +762,42 @@ interface DeliveryCarrierRegionalSettings {
 }
 interface DashboardTable {
     /**
-     * The title of the delivery settings that will be displayed in the UI.
+     * Table title.
      * @maxLength 256
      */
     title?: string;
     /**
-     * The columns of the delivery settings that will be displayed in the UI.
+     * Table columns.
      * @maxSize 200
      */
     columns?: Column[];
     /**
-     * The content of the delivery settings. Each row is a map of column name to value.
+     * Table rows containing the configuration data.
      * @maxSize 25
      */
     rows?: Row[];
 }
 interface Column {
     /**
-     * The name of the column. This is used to get the data from the row.
+     * Column key, used to retrieve data from rows.
      * @maxLength 256
      */
     key?: string;
     /**
-     * The title of the column that will be displayed in the UI.
+     * Column display name.
      * @maxLength 256
      */
     name?: string;
 }
 interface Row {
     /**
-     * The external key of the data presented in a row. This is used to identify the row in the UI for editing.
+     * Unique row identifier, used to identify the row 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.
-     * Data will be in JSON format.
-     */
+    /** Row data as a JSON object. Each key corresponds to a column key. */
     data?: Record<string, any> | null;
-    /** The configuration's status of the current row. */
+    /** Whether this row's configuration is active. */
     active?: boolean;
 }
 interface BulkActionMetadata {
@@ -795,16 +810,16 @@ interface BulkActionMetadata {
 }
 interface UpdateCarrierSettingsRequest {
     /**
-     * Carrier id.
+     * Carrier app ID.
      * @format GUID
      */
     carrierId: string;
     /**
-     * Row id triggered the change
+     * ID of the dashboard table row that triggered the change.
      * @format GUID
      */
     rowId: string;
-    /** New status */
+    /** New active status. */
     active: boolean | null;
 }
 interface UpdateCarrierSettingsResponse {
@@ -834,7 +849,7 @@ interface UpdateExtendedFieldsRequest {
     namespaceData: Record<string, any> | null;
 }
 interface UpdateExtendedFieldsResponse {
-    /** Updated DeliveryProfile. */
+    /** Updated delivery profile. */
     deliveryProfile?: DeliveryProfile;
 }
 interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {