@wix/auto_sdk_ecom_delivery-profile 1.0.242 → 1.0.244

package/build/internal/cjs/index.typings.d.ts

@@ -1,127 +1,143 @@
 import { QuerySpec, Query, NonNullablePaths } from '@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 {
@@ -131,21 +147,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
@@ -154,12 +169,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;
@@ -167,12 +182,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;
@@ -188,122 +203,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;
@@ -312,7 +330,7 @@ interface DeleteDeliveryProfileResponse {
 }
 interface DeleteDefaultDeliveryProfileRequest {
     /**
-     * Id of the DeliveryProfile to delete.
+     * Delivery profile ID.
      * @format GUID
      */
     deliveryProfileId?: string;
@@ -320,7 +338,7 @@ interface DeleteDefaultDeliveryProfileRequest {
 interface DeleteDefaultDeliveryProfileResponse {
 }
 interface QueryDeliveryProfilesRequest {
-    /** WQL expression. */
+    /** Query options. */
     query?: CursorQuery;
 }
 interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -379,11 +397,11 @@ interface CursorPaging {
 }
 interface QueryDeliveryProfilesResponse {
     /**
-     * List of DeliveryProfiles.
+     * List of delivery profiles.
      * @maxSize 100
      */
     deliveryProfiles?: DeliveryProfile[];
-    /** Paging metadata */
+    /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata;
 }
 interface CursorPagingMetadata {
@@ -413,176 +431,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 */
@@ -590,36 +608,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[];
@@ -631,17 +649,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
@@ -650,7 +668,7 @@ interface ListDeliveryCarriersRequest {
 }
 interface ListDeliveryCarriersResponse {
     /**
-     * The list of delivery settings for the given requests
+     * List of delivery carrier results.
      * @maxSize 100
      */
     results?: ListDeliveryCarriersResult[];
@@ -658,12 +676,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
      */
@@ -690,52 +708,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
      */
@@ -743,45 +761,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 {
@@ -794,16 +809,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 {
@@ -833,7 +848,7 @@ interface UpdateExtendedFieldsRequest {
     namespaceData: Record<string, any> | null;
 }
 interface UpdateExtendedFieldsResponse {
-    /** Updated DeliveryProfile. */
+    /** Updated delivery profile. */
     deliveryProfile?: DeliveryProfile;
 }
 interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
@@ -1715,7 +1730,9 @@ interface DeliveryProfileCreatedEnvelope {
     entity: DeliveryProfile;
     metadata: EventMetadata;
 }
-/** @permissionScope Manage Stores - all permissions
+/**
+ * Triggered when a delivery profile is created.
+ * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage Stores
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
@@ -1723,8 +1740,6 @@ interface DeliveryProfileCreatedEnvelope {
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
  * @permissionScope Wix Multilingual - Nile Wrapper Domain Events Read
  * @permissionScopeId SCOPE.MULTILINGUAL.NILE_WRAPPER_DOMAIN_EVENTS_READ
- * @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
@@ -1738,7 +1753,9 @@ interface DeliveryProfileDeletedEnvelope {
     entity: DeliveryProfile;
     metadata: EventMetadata;
 }
-/** @permissionScope Manage Stores - all permissions
+/**
+ * Triggered when a delivery profile is deleted.
+ * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage Stores
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
@@ -1746,8 +1763,6 @@ interface DeliveryProfileDeletedEnvelope {
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
  * @permissionScope Wix Multilingual - Nile Wrapper Domain Events Read
  * @permissionScopeId SCOPE.MULTILINGUAL.NILE_WRAPPER_DOMAIN_EVENTS_READ
- * @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
@@ -1761,7 +1776,9 @@ interface DeliveryProfileRegionAddedEnvelope {
     data: DeliveryRegionAdded;
     metadata: EventMetadata;
 }
-/** @permissionScope Manage Stores - all permissions
+/**
+ * Triggered when a delivery region is added to a delivery profile.
+ * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage Stores
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
@@ -1769,8 +1786,6 @@ interface DeliveryProfileRegionAddedEnvelope {
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
  * @permissionScope Wix Multilingual - Nile Wrapper Domain Events Read
  * @permissionScopeId SCOPE.MULTILINGUAL.NILE_WRAPPER_DOMAIN_EVENTS_READ
- * @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
@@ -1784,7 +1799,9 @@ interface DeliveryProfileRegionRemovedEnvelope {
     data: DeliveryRegionRemoved;
     metadata: EventMetadata;
 }
-/** @permissionScope Manage Stores - all permissions
+/**
+ * Triggered when a delivery region is removed from a delivery profile.
+ * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage Stores
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
@@ -1792,8 +1809,6 @@ interface DeliveryProfileRegionRemovedEnvelope {
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
  * @permissionScope Wix Multilingual - Nile Wrapper Domain Events Read
  * @permissionScopeId SCOPE.MULTILINGUAL.NILE_WRAPPER_DOMAIN_EVENTS_READ
- * @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
@@ -1807,7 +1822,9 @@ interface DeliveryProfileRegionUpdatedEnvelope {
     data: DeliveryRegionUpdated;
     metadata: EventMetadata;
 }
-/** @permissionScope Manage Stores - all permissions
+/**
+ * Triggered when a delivery region is updated.
+ * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage Stores
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
@@ -1815,8 +1832,6 @@ interface DeliveryProfileRegionUpdatedEnvelope {
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
  * @permissionScope Wix Multilingual - Nile Wrapper Domain Events Read
  * @permissionScopeId SCOPE.MULTILINGUAL.NILE_WRAPPER_DOMAIN_EVENTS_READ
- * @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
@@ -1832,7 +1847,9 @@ interface DeliveryProfileUpdatedEnvelope {
     /** @hidden */
     modifiedFields: Record<string, any>;
 }
-/** @permissionScope Manage Stores - all permissions
+/**
+ * Triggered when a delivery profile is updated.
+ * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage Stores
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
@@ -1840,8 +1857,6 @@ interface DeliveryProfileUpdatedEnvelope {
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
  * @permissionScope Wix Multilingual - Nile Wrapper Domain Events Read
  * @permissionScopeId SCOPE.MULTILINGUAL.NILE_WRAPPER_DOMAIN_EVENTS_READ
- * @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
@@ -1852,13 +1867,11 @@ interface DeliveryProfileUpdatedEnvelope {
  */
 declare function onDeliveryProfileUpdated(handler: (event: DeliveryProfileUpdatedEnvelope) => void | Promise<void>): void;
 /**
- * Creates a DeliveryProfile.
+ * Creates a delivery profile.
  *
- * The request body must include the DeliveryProfiles name. DeliveryRegions are optional.
  *
- * Note: A site can have up to 99 delivery profiles.
- * Attempts to exceed this limit will fail with DELIVERY_PROFILES_LIMIT_EXCEEDED.
- * @param deliveryProfile - DeliveryProfile to be created.
+ * A site can have up to 99 delivery profiles. Attempting to exceed this limit returns a `DELIVERY_PROFILES_LIMIT_EXCEEDED` error.
+ * @param deliveryProfile - Delivery profile to create.
  * @public
  * @documentationMaturity preview
  * @requiredField deliveryProfile
@@ -1867,42 +1880,31 @@ declare function onDeliveryProfileUpdated(handler: (event: DeliveryProfileUpdate
  * @requiredField deliveryProfile.name
  * @permissionId ECOM.DELIVERY_PROFILE_CREATE
  * @applicableIdentity APP
- * @returns The created DeliveryProfile.
+ * @returns Created delivery profile.
  * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.CreateDeliveryProfile
  */
 declare function createDeliveryProfile(deliveryProfile: NonNullablePaths<DeliveryProfile, `deliveryRegions.${number}.destinations.${number}.countryCode` | `deliveryRegions.${number}.name` | `name`, 6>): Promise<NonNullablePaths<DeliveryProfile, `deliveryRegions`, 2> & {
     __applicationErrorsType?: CreateDeliveryProfileApplicationErrors;
 }>;
 /**
- * Retrieves a DeliveryProfile.
- * @param deliveryProfileId - ID of the DeliveryProfile to retrieve.
+ * Retrieves a delivery profile.
+ * @param deliveryProfileId - Delivery profile ID.
  * @public
  * @documentationMaturity preview
  * @requiredField deliveryProfileId
  * @permissionId ECOM.DELIVERY_PROFILE_READ
  * @applicableIdentity APP
- * @returns The requested DeliveryProfile.
+ * @returns Retrieved delivery profile.
  * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.GetDeliveryProfile
  */
 declare function getDeliveryProfile(deliveryProfileId: string): Promise<NonNullablePaths<DeliveryProfile, `deliveryRegions`, 2>>;
 /**
- * Updates a DeliveryProfile.
- *
- * Each time the DeliveryProfile is updated,
- * `revision` increments by 1.
- * The current `revision` must be passed when updating the DeliveryProfile.
- * This ensures you're working with the latest DeliveryProfile
- * and prevents unintended overwrites.
- * Revision is required for all updates, including partial updates via field_mask,
- * to prevent concurrent modification conflicts.
+ * Updates a delivery profile.
  *
- * This method does not allow updating the DeliveryRegions in this DeliveryProfile.
- * To manage delivery regions within this profile, use the AddDeliveryRegion, UpdateDeliveryRegion,
- * and RemoveDeliveryRegion methods. These dedicated methods ensure proper validation of destinations and carriers.
+ * Each time the delivery profile is updated, `revision` increments by 1. The current `revision` must be passed when updating the delivery profile. This ensures you're working with the latest delivery profile and prevents unintended overwrites.
  *
- * Note: The field mask is automatically inferred from the fields you provide in delivery_profile.
- * You don't need to manually specify which fields to update.
- * @param _id - DeliveryProfile ID.
+ * This method doesn't support updating delivery regions in the profile. To manage delivery regions, use [Add Delivery Region](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/add-delivery-region), [Update Delivery Region](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/update-delivery-region), or [Remove Delivery Region](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/remove-delivery-region).
+ * @param _id - Delivery profile ID.
  * @public
  * @documentationMaturity preview
  * @requiredField _id
@@ -1910,7 +1912,7 @@ declare function getDeliveryProfile(deliveryProfileId: string): Promise<NonNulla
  * @requiredField deliveryProfile.revision
  * @permissionId ECOM.DELIVERY_PROFILE_UPDATE
  * @applicableIdentity APP
- * @returns Updated DeliveryProfile.
+ * @returns Updated delivery profile.
  * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.UpdateDeliveryProfile
  */
 declare function updateDeliveryProfile(_id: string, deliveryProfile: NonNullablePaths<UpdateDeliveryProfile, `revision`, 2>): Promise<NonNullablePaths<DeliveryProfile, `deliveryRegions`, 2> & {
@@ -1918,63 +1920,65 @@ declare function updateDeliveryProfile(_id: string, deliveryProfile: NonNullable
 }>;
 interface UpdateDeliveryProfile {
     /**
-     * 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;
 }
 /**
- * Deletes a DeliveryProfile.
+ * Deletes a delivery profile.
  *
- * Deleting a DeliveryProfile permanently removes them from the DeliveryProfile List.
  *
- * Permanently deletes the delivery profile. This action cannot be undone. All associated delivery regions and
- * carrier configurations will also be removed.
+ * Permanently deletes the delivery profile, including all associated delivery regions and carrier configurations. This action can't be undone.
  *
- * Cannot delete the default delivery profile because every site requires one for core delivery functionality.
- * @param deliveryProfileId - Id of the DeliveryProfile to delete.
+ * The default delivery profile can't be deleted because every site requires one for core delivery functionality.
+ * @param deliveryProfileId - Delivery profile ID.
  * @public
  * @documentationMaturity preview
  * @requiredField deliveryProfileId
@@ -1984,14 +1988,17 @@ interface UpdateDeliveryProfile {
  */
 declare function deleteDeliveryProfile(deliveryProfileId: string): Promise<void>;
 /**
- * Retrieves a list of DeliveryProfiles, given the provided [paging, filtering, and sorting][1].
+ * Retrieves a list of up to 100 delivery profiles, given the provided paging, filtering, and sorting.
+ *
+ * Query Delivery Profiles runs with these defaults, which you can override:
  *
- * Up to 100 DeliveryProfiles can be returned per request.
+ * - `createdDate` is sorted in `DESC` order.
+ * - `paging.limit` is `50`.
+ * - `paging.offset` is `0`.
  *
- * To learn how to query DeliveryProfiles, see [API Query Language][2].
+ * For field support for filters and sorting, see [Supported Filters and Sorting](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/supported-filters).
  *
- * [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
- * [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
+ * To learn how to query delivery profiles, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
  * @public
  * @documentationMaturity preview
  * @permissionId ECOM.DELIVERY_PROFILE_READ
@@ -2148,9 +2155,9 @@ type DeliveryProfileQuery = {
     }[];
 };
 /**
- * Creates a new DeliveryRegion in an existing DeliveryProfile.
- * @param deliveryProfileId - delivery profile id to associated with the DeliveryRegion
- * @param deliveryRegion - DeliveryRegion to be created
+ * Adds a delivery region to an existing delivery profile.
+ * @param deliveryProfileId - Delivery profile ID.
+ * @param deliveryRegion - Delivery region to add.
  * @public
  * @documentationMaturity preview
  * @requiredField deliveryProfileId
@@ -2167,19 +2174,16 @@ declare function addDeliveryRegion(deliveryProfileId: string, deliveryRegion: No
 }>;
 interface AddDeliveryRegionOptions {
     /**
-     * DeliveryProfile revision.
+     * Delivery profile revision.
      * @readonly
      */
     revision?: string | null;
 }
 /**
- * Update a DeliveryRegion, supports partial update
- * Pass the latest `revision` for a successful update
+ * Updates a delivery region.
  *
- * This method does not allow setting or updating the delivery delivery_carriers in this delivery_region.
- * Delivery carriers within a region must be managed using dedicated methods: AddDeliveryCarrier to add a carrier,
- * UpdateDeliveryCarrier to modify carrier settings, and RemoveDeliveryCarrier to remove a carrier.
- * This ensures proper validation and event tracking for carrier changes.
+ *
+ * This method doesn't support updating delivery carriers in the region. To manage carriers, use [Add Delivery Carrier](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/add-delivery-carrier), [Update Delivery Carrier](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/update-delivery-carrier), or [Remove Delivery Carrier](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/remove-delivery-carrier).
  * @public
  * @documentationMaturity preview
  * @requiredField deliveryRegion
@@ -2196,12 +2200,12 @@ declare function updateDeliveryRegion(identifiers: NonNullablePaths<UpdateDelive
 }>;
 interface UpdateDeliveryRegionIdentifiers {
     /**
-     * DeliveryProfile id that owns the DeliveryRegion
+     * Delivery profile ID.
      * @format GUID
      */
     deliveryProfileId: string;
     /**
-     * The delivery region id.
+     * Delivery region ID.
      * @format GUID
      * @readonly
      */
@@ -2209,46 +2213,50 @@ interface UpdateDeliveryRegionIdentifiers {
 }
 interface UpdateDeliveryRegion {
     /**
-     * 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 UpdateDeliveryRegionOptions {
     /**
-     * DeliveryProfile revision.
+     * Delivery profile revision.
      * @readonly
      */
     revision?: string | null;
 }
 /**
- * Retrieves a DeliveryProfile by delivery region ID.
- * @param deliveryRegionId - ID of the DeliveryRegion to retrieve the profile for.
+ * Retrieves a delivery profile by delivery region ID.
+ * @param deliveryRegionId - Delivery region ID.
  * @public
  * @documentationMaturity preview
  * @requiredField deliveryRegionId
@@ -2260,7 +2268,7 @@ declare function getDeliveryProfileByDeliveryRegionId(deliveryRegionId: string):
     __applicationErrorsType?: GetDeliveryProfileByDeliveryRegionIdApplicationErrors;
 }>;
 /**
- * Delete a DeliveryRegion
+ * Removes a delivery region from a delivery profile.
  * @public
  * @documentationMaturity preview
  * @requiredField identifiers
@@ -2275,26 +2283,26 @@ declare function removeDeliveryRegion(identifiers: NonNullablePaths<RemoveDelive
 }>;
 interface RemoveDeliveryRegionIdentifiers {
     /**
-     * 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;
 }
 interface RemoveDeliveryRegionOptions {
     /**
-     * DeliveryProfile revision.
+     * Delivery profile revision.
      * @readonly
      */
     revision?: string | null;
 }
 /**
- * Add a delivery_carrier to a delivery region
- * @param deliveryRegionId - delivery_region id to associated with the delivery_carrier.
+ * Adds a delivery carrier to a delivery region.
+ * @param deliveryRegionId - Delivery region ID.
  * @public
  * @documentationMaturity preview
  * @requiredField deliveryRegionId
@@ -2310,12 +2318,12 @@ declare function addDeliveryCarrier(deliveryRegionId: string, options: NonNullab
     __validationErrorsType?: AddDeliveryCarrierValidationErrors;
 }>;
 interface AddDeliveryCarrierOptions {
-    /** delivery_carrier to be added. */
+    /** Delivery carrier to add. */
     deliveryCarrier: DeliveryCarrier;
 }
 /**
- * Remove a delivery_carrier from a delivery region
- * @param deliveryRegionId - Id of the DeliveryRegion
+ * Removes a delivery carrier from a delivery region.
+ * @param deliveryRegionId - Delivery region ID.
  * @public
  * @documentationMaturity preview
  * @requiredField deliveryRegionId
@@ -2330,14 +2338,14 @@ declare function removeDeliveryCarrier(deliveryRegionId: string, options: NonNul
 }>;
 interface RemoveDeliveryCarrierOptions {
     /**
-     * DeliveryCarrier app id to be removed.
+     * App ID of the delivery carrier to remove.
      * @format GUID
      */
     appId: string;
 }
 /**
- * Update a delivery carrier in a delivery region
- * @param deliveryRegionId - DeliveryRegion id
+ * Updates a delivery carrier's settings in a delivery region.
+ * @param deliveryRegionId - Delivery region ID.
  * @public
  * @documentationMaturity preview
  * @requiredField deliveryRegionId
@@ -2350,11 +2358,14 @@ declare function updateDeliveryCarrier(deliveryRegionId: string, options?: NonNu
     __applicationErrorsType?: UpdateDeliveryCarrierApplicationErrors;
 }>;
 interface UpdateDeliveryCarrierOptions {
-    /** Updated delivery_carrier */
+    /** Delivery carrier to update. */
     deliveryCarrier?: DeliveryCarrier;
 }
 /**
- * List all installed delivery carriers in order to set their ids in delivery rules
+ * Retrieves a list of all delivery carriers installed on a site.
+ *
+ *
+ * Use this method to discover available carriers before adding them to delivery regions.
  * @public
  * @documentationMaturity preview
  * @permissionId ECOM.DELIVERY_CARRIER_READ
@@ -2363,7 +2374,10 @@ interface UpdateDeliveryCarrierOptions {
  */
 declare function listInstalledDeliveryCarriers(): Promise<NonNullablePaths<ListInstalledDeliveryCarriersResponse, `installedDeliveryCarriers` | `installedDeliveryCarriers.${number}._id` | `installedDeliveryCarriers.${number}.displayName` | `installedDeliveryCarriers.${number}.toggleGetCarrierSettingsEnabled`, 4>>;
 /**
- * Retrieves delivery destination properties by ROW, and aggregated country and subdivision
+ * Retrieves delivery destination properties.
+ *
+ *
+ * Returns properties for Rest of World, as well as aggregated country and subdivision data. Properties include whether postal codes are required and whether pickup is the only delivery option for each destination.
  * @public
  * @documentationMaturity preview
  * @permissionId ECOM.DELIVERY_PROFILE_READ
@@ -2372,9 +2386,11 @@ declare function listInstalledDeliveryCarriers(): Promise<NonNullablePaths<ListI
  */
 declare function getDeliveryDestinationProperties(): Promise<NonNullablePaths<GetDeliveryDestinationPropertiesResponse, `restOfWorld.postalCodeRequired` | `restOfWorld.pickupOnly` | `countries` | `countries.${number}.country` | `countries.${number}.deliveryDestinationProperties.postalCodeRequired` | `countries.${number}.deliveryDestinationProperties.pickupOnly`, 5>>;
 /**
- * Get delivery carrier settings for a delivery profile and delivery region.
- * These are returned in a table format for the dashboard.
- * @param deliveryProfileId - Delivery profile id.
+ * Retrieves delivery carrier settings for a delivery profile.
+ *
+ *
+ * Returns detailed carrier configurations, including regional settings for each carrier. This method provides more comprehensive information than List Installed Delivery Carriers.
+ * @param deliveryProfileId - Delivery profile ID.
  * @public
  * @documentationMaturity preview
  * @requiredField deliveryProfileId
@@ -2387,7 +2403,7 @@ declare function listDeliveryCarriers(deliveryProfileId: string, options?: ListD
 }>;
 interface ListDeliveryCarriersOptions {
     /**
-     * Delivery app ids to get settings for.
+     * App IDs of the delivery carriers to retrieve settings for.
      * @format GUID
      * @minSize 1
      * @maxSize 25
@@ -2395,8 +2411,8 @@ interface ListDeliveryCarriersOptions {
     appIds?: string[];
 }
 /**
- * Update carrier's external active settings
- * @param carrierId - Carrier id.
+ * Updates a carrier's external active settings.
+ * @param carrierId - Carrier app ID.
  * @internal
  * @documentationMaturity preview
  * @requiredField carrierId
@@ -2412,15 +2428,15 @@ declare function updateCarrierSettings(carrierId: string, options: NonNullablePa
 }>;
 interface UpdateCarrierSettingsOptions {
     /**
-     * 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;
 }
 /**
- * Sets delivery carrier's active status.
+ * Sets a delivery carrier's active status.
  * @param carrierAppId - Carrier app ID.
  * @public
  * @documentationMaturity preview