@wix/auto_sdk_ecom_delivery-profile 1.0.257 → 1.0.258

package/build/cjs/index.d.ts

@@ -46,7 +46,7 @@ interface DeleteDeliveryProfileSignature {
      * 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 - Delivery profile ID.
@@ -92,6 +92,9 @@ declare function removeDeliveryRegion$1(httpClient: HttpClient): RemoveDeliveryR
 interface RemoveDeliveryRegionSignature {
     /**
      * 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.
      */
     (identifiers: NonNullablePaths<RemoveDeliveryRegionIdentifiers, `deliveryProfileId` | `deliveryRegionId`, 2>, options?: RemoveDeliveryRegionOptions): Promise<NonNullablePaths<RemoveDeliveryRegionResponse, `deliveryProfile.deliveryRegions`, 3> & {
         __applicationErrorsType?: RemoveDeliveryRegionApplicationErrors;
@@ -122,6 +125,11 @@ declare function updateDeliveryCarrier$1(httpClient: HttpClient): UpdateDelivery
 interface UpdateDeliveryCarrierSignature {
     /**
      * 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 - Delivery region ID.
      */
     (deliveryRegionId: string, options?: NonNullablePaths<UpdateDeliveryCarrierOptions, `deliveryCarrier.appId`, 3>): Promise<NonNullablePaths<UpdateDeliveryCarrierResponse, `deliveryProfile.deliveryRegions`, 3> & {
@@ -154,7 +162,7 @@ interface ListDeliveryCarriersSignature {
      * 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 - Delivery profile ID.
      */
     (deliveryProfileId: string, options?: ListDeliveryCarriersOptions): Promise<NonNullablePaths<ListDeliveryCarriersResponse, `results` | `results.${number}.deliveryCarrierMetadata.success` | `results.${number}.deliveryCarrierMetadata.error.code` | `results.${number}.deliveryCarrierMetadata.error.description` | `results.${number}.deliveryCarrierDetails._id` | `results.${number}.deliveryCarrierDetails.displayName` | `results.${number}.deliveryCarrierDetails.toggleGetCarrierSettingsEnabled` | `results.${number}.deliveryCarrierDetails.toggleUpdateCarrierActiveStatusEnabled` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
@@ -174,7 +182,7 @@ interface SetDeliveryCarrierActiveStatusSignature {
 declare function updateExtendedFields$1(httpClient: HttpClient): UpdateExtendedFieldsSignature;
 interface UpdateExtendedFieldsSignature {
     /**
-     * Updates extended fields of a DeliveryProfile without incrementing revision
+     * Updates extended fields of a delivery profile without incrementing revision.
      * @param - ID of the entity to update.
      * @param - Identifier for the app whose extended fields are being updated.
      */