@wix/auto_sdk_ecom_delivery-profile 1.0.257 → 1.0.258

package/build/cjs/meta.d.ts

@@ -84,13 +84,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[];
@@ -135,7 +135,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`
      */
@@ -148,7 +152,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;
@@ -175,7 +179,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;
@@ -188,7 +192,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;
@@ -815,7 +819,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;
@@ -831,7 +835,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;