@wix/auto_sdk_ecom_delivery-profile 1.0.257 → 1.0.258

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

@@ -83,13 +83,13 @@ interface DeliveryRegion {
      */
     active?: boolean | null;
     /**
-     * Delivery carriers assigned to this region. Carriers are managed using the Add Delivery Carrier, Update Delivery Carrier, and Remove Delivery Carrier methods.
+     * Delivery carriers assigned to this region. Carriers are managed using the [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), and [Remove Delivery Carrier](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/remove-delivery-carrier) methods.
      * @maxSize 25
      * @readonly
      */
     deliveryCarriers?: DeliveryCarrier[];
     /**
-     * Geographic destinations covered by this region. If empty, the region applies globally.
+     * Geographic destinations covered by this region. If empty, the region applies globally (Rest of World). A site can have up to 250 destinations across all delivery profiles.
      * @maxSize 250
      */
     destinations?: Destination[];
@@ -134,7 +134,11 @@ interface BackupRate {
     /**
      * 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.
+     * The backup rate is used in the following situations:
+     * + When `active` is `true`.
+     * + When the carrier does not return a cost for any reason.
+     *
+     * If active, and no cost is returned by the carrier, the backup rate will be displayed to customers as the shipping option.
      *
      * Default: `false`
      */
@@ -147,7 +151,7 @@ interface AdditionalCharge {
      */
     description?: string | null;
     /**
-     * Charge amount. For example, `"12.5"`.
+     * Additional fixed charge amount to add to the delivery rate. For example, `"12.50"`.
      * @maxLength 16
      */
     amount?: string;
@@ -174,7 +178,7 @@ interface CreatedBy extends CreatedByIdOneOf {
      */
     appId?: string | null;
     /**
-     * Wix 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 using the dashboard or an API call.
      * @format GUID
      */
     userId?: string | null;
@@ -187,7 +191,7 @@ interface CreatedByIdOneOf {
      */
     appId?: string | null;
     /**
-     * Wix 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 using the dashboard or an API call.
      * @format GUID
      */
     userId?: string | null;
@@ -814,7 +818,7 @@ interface UpdateCarrierSettingsRequest {
      */
     carrierId: string;
     /**
-     * ID of the dashboard table row that triggered the change.
+     * Row ID in the carrier's dashboard settings table that identifies the specific shipping configuration to update. Retrieved from [List Delivery Carriers](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/list-delivery-carriers).
      * @format GUID
      */
     rowId: string;
@@ -830,7 +834,9 @@ interface SetDeliveryCarrierActiveStatusRequest {
      */
     carrierAppId: string;
     /**
-     * Row ID that triggered the change.
+     * Row identifier in the carrier's dashboard settings table that identifies the specific shipping configuration to update.
+     *
+     * Pass the `row.key` field from the response of [List Delivery Carriers](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/list-delivery-carriers).
      * @format GUID
      */
     rowId: string;
@@ -1740,6 +1746,8 @@ 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
@@ -1763,6 +1771,8 @@ 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
@@ -1786,6 +1796,8 @@ 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
@@ -1809,6 +1821,8 @@ 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
@@ -1832,6 +1846,8 @@ 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
@@ -1857,6 +1873,8 @@ 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
@@ -1975,7 +1993,7 @@ interface UpdateDeliveryProfile {
  * Deletes a delivery profile.
  *
  *
- * Permanently deletes the delivery profile, including all associated delivery regions and carrier configurations. This action can't be undone.
+ * Permanently deletes the delivery profile and its delivery regions and carrier configurations. Delivery regions are unique to each profile and aren't shared across profiles. This action can't be undone.
  *
  * The default delivery profile can't be deleted because every site requires one for core delivery functionality.
  * @param deliveryProfileId - Delivery profile ID.
@@ -1996,9 +2014,7 @@ declare function deleteDeliveryProfile(deliveryProfileId: string): Promise<void>
  * - `paging.limit` is `50`.
  * - `paging.offset` is `0`.
  *
- * 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).
- *
- * To learn how to query delivery profiles, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
+ * To learn how to query delivery profiles, see [API Query Language](hhttps://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language).
  * @public
  * @documentationMaturity preview
  * @permissionId ECOM.DELIVERY_PROFILE_READ
@@ -2231,13 +2247,13 @@ interface UpdateDeliveryRegion {
      */
     active?: boolean | null;
     /**
-     * Delivery carriers assigned to this region. Carriers are managed using the Add Delivery Carrier, Update Delivery Carrier, and Remove Delivery Carrier methods.
+     * Delivery carriers assigned to this region. Carriers are managed using the [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), and [Remove Delivery Carrier](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/remove-delivery-carrier) methods.
      * @maxSize 25
      * @readonly
      */
     deliveryCarriers?: DeliveryCarrier[];
     /**
-     * Geographic destinations covered by this region. If empty, the region applies globally.
+     * Geographic destinations covered by this region. If empty, the region applies globally (Rest of World). A site can have up to 250 destinations across all delivery profiles.
      * @maxSize 250
      */
     destinations?: Destination[];
@@ -2269,6 +2285,9 @@ declare function getDeliveryProfileByDeliveryRegionId(deliveryRegionId: string):
 }>;
 /**
  * Removes a delivery region from a delivery profile.
+ *
+ *
+ * You can remove all delivery regions from a profile, leaving the profile empty. An empty profile won't provide shipping options until a new delivery region is added.
  * @public
  * @documentationMaturity preview
  * @requiredField identifiers
@@ -2345,6 +2364,11 @@ interface RemoveDeliveryCarrierOptions {
 }
 /**
  * Updates a delivery carrier's settings in a delivery region.
+ *
+ *
+ * This method updates an existing carrier's settings (such as backup rate and additional charges) using a partial update. Only the fields you provide are updated; other carrier settings remain unchanged.
+ *
+ * To add a new carrier to a region, use [Add Delivery Carrier](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/add-delivery-carrier).
  * @param deliveryRegionId - Delivery region ID.
  * @public
  * @documentationMaturity preview
@@ -2389,7 +2413,7 @@ declare function getDeliveryDestinationProperties(): Promise<NonNullablePaths<Ge
  * 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.
+ * Returns detailed carrier configurations, including regional settings for each carrier. This method provides more comprehensive information than [List Installed Delivery Carriers](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/list-installed-delivery-carriers).
  * @param deliveryProfileId - Delivery profile ID.
  * @public
  * @documentationMaturity preview
@@ -2428,7 +2452,7 @@ declare function updateCarrierSettings(carrierId: string, options: NonNullablePa
 }>;
 interface UpdateCarrierSettingsOptions {
     /**
-     * ID of the dashboard table row that triggered the change.
+     * Row ID in the carrier's dashboard settings table that identifies the specific shipping configuration to update. Retrieved from [List Delivery Carriers](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/list-delivery-carriers).
      * @format GUID
      */
     rowId: string;
@@ -2453,7 +2477,9 @@ declare function setDeliveryCarrierActiveStatus(carrierAppId: string, options: N
 }>;
 interface SetDeliveryCarrierActiveStatusOptions {
     /**
-     * Row ID that triggered the change.
+     * Row identifier in the carrier's dashboard settings table that identifies the specific shipping configuration to update.
+     *
+     * Pass the `row.key` field from the response of [List Delivery Carriers](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/list-delivery-carriers).
      * @format GUID
      */
     rowId: string;
@@ -2461,7 +2487,7 @@ interface SetDeliveryCarrierActiveStatusOptions {
     active: boolean | null;
 }
 /**
- * Updates extended fields of a DeliveryProfile without incrementing revision
+ * Updates extended fields of a delivery profile without incrementing revision.
  * @param _id - ID of the entity to update.
  * @param namespace - Identifier for the app whose extended fields are being updated.
  * @public