@wix/auto_sdk_ecom_delivery-profile 1.0.242 → 1.0.244

package/build/cjs/index.d.ts

@@ -5,14 +5,12 @@ export { AccountInfo, AccountInfoMetadata, ActionEvent, AddDeliveryCarrierReques
 declare function createDeliveryProfile$1(httpClient: HttpClient): CreateDeliveryProfileSignature;
 interface CreateDeliveryProfileSignature {
     /**
-     * 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 to be created.
-     * @returns The created DeliveryProfile.
+     * A site can have up to 99 delivery profiles. Attempting to exceed this limit returns a `DELIVERY_PROFILES_LIMIT_EXCEEDED` error.
+     * @param - Delivery profile to create.
+     * @returns Created delivery profile.
      */
     (deliveryProfile: NonNullablePaths<DeliveryProfile, `deliveryRegions.${number}.destinations.${number}.countryCode` | `deliveryRegions.${number}.name` | `name`, 6>): Promise<NonNullablePaths<DeliveryProfile, `deliveryRegions`, 2> & {
         __applicationErrorsType?: CreateDeliveryProfileApplicationErrors;
@@ -21,33 +19,22 @@ interface CreateDeliveryProfileSignature {
 declare function getDeliveryProfile$1(httpClient: HttpClient): GetDeliveryProfileSignature;
 interface GetDeliveryProfileSignature {
     /**
-     * Retrieves a DeliveryProfile.
-     * @param - ID of the DeliveryProfile to retrieve.
-     * @returns The requested DeliveryProfile.
+     * Retrieves a delivery profile.
+     * @param - Delivery profile ID.
+     * @returns Retrieved delivery profile.
      */
     (deliveryProfileId: string): Promise<NonNullablePaths<DeliveryProfile, `deliveryRegions`, 2>>;
 }
 declare function updateDeliveryProfile$1(httpClient: HttpClient): UpdateDeliveryProfileSignature;
 interface UpdateDeliveryProfileSignature {
     /**
-     * Updates a DeliveryProfile.
+     * Updates a delivery profile.
      *
-     * 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.
+     * 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.
      *
-     * 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.
-     *
-     * 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 - DeliveryProfile ID.
-     * @returns Updated DeliveryProfile.
+     * 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 - Delivery profile ID.
+     * @returns Updated delivery profile.
      */
     (_id: string, deliveryProfile: NonNullablePaths<UpdateDeliveryProfile, `revision`, 2>): Promise<NonNullablePaths<DeliveryProfile, `deliveryRegions`, 2> & {
         __applicationErrorsType?: UpdateDeliveryProfileApplicationErrors;
@@ -56,24 +43,22 @@ interface UpdateDeliveryProfileSignature {
 declare function deleteDeliveryProfile$1(httpClient: HttpClient): DeleteDeliveryProfileSignature;
 interface DeleteDeliveryProfileSignature {
     /**
-     * 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 - Id of the DeliveryProfile to delete.
+     * The default delivery profile can't be deleted because every site requires one for core delivery functionality.
+     * @param - Delivery profile ID.
      */
     (deliveryProfileId: string): Promise<void>;
 }
 declare function addDeliveryRegion$1(httpClient: HttpClient): AddDeliveryRegionSignature;
 interface AddDeliveryRegionSignature {
     /**
-     * Creates a new DeliveryRegion in an existing DeliveryProfile.
-     * @param - delivery profile id to associated with the DeliveryRegion
-     * @param - DeliveryRegion to be created
+     * Adds a delivery region to an existing delivery profile.
+     * @param - Delivery profile ID.
+     * @param - Delivery region to add.
      */
     (deliveryProfileId: string, deliveryRegion: NonNullablePaths<DeliveryRegion, `destinations.${number}.countryCode` | `name`, 4>, options?: AddDeliveryRegionOptions): Promise<NonNullablePaths<AddDeliveryRegionResponse, `deliveryProfile.deliveryRegions`, 3> & {
         __applicationErrorsType?: AddDeliveryRegionApplicationErrors;
@@ -83,13 +68,10 @@ interface AddDeliveryRegionSignature {
 declare function updateDeliveryRegion$1(httpClient: HttpClient): UpdateDeliveryRegionSignature;
 interface UpdateDeliveryRegionSignature {
     /**
-     * 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).
      */
     (identifiers: NonNullablePaths<UpdateDeliveryRegionIdentifiers, `deliveryProfileId` | `deliveryRegionId`, 2>, deliveryRegion: UpdateDeliveryRegion, options?: UpdateDeliveryRegionOptions): Promise<NonNullablePaths<UpdateDeliveryRegionResponse, `deliveryProfile.deliveryRegions`, 3> & {
         __applicationErrorsType?: UpdateDeliveryRegionApplicationErrors;
@@ -99,8 +81,8 @@ interface UpdateDeliveryRegionSignature {
 declare function getDeliveryProfileByDeliveryRegionId$1(httpClient: HttpClient): GetDeliveryProfileByDeliveryRegionIdSignature;
 interface GetDeliveryProfileByDeliveryRegionIdSignature {
     /**
-     * Retrieves a DeliveryProfile by delivery region ID.
-     * @param - ID of the DeliveryRegion to retrieve the profile for.
+     * Retrieves a delivery profile by delivery region ID.
+     * @param - Delivery region ID.
      */
     (deliveryRegionId: string): Promise<NonNullablePaths<GetDeliveryProfileByDeliveryRegionIdResponse, `deliveryProfile.deliveryRegions`, 3> & {
         __applicationErrorsType?: GetDeliveryProfileByDeliveryRegionIdApplicationErrors;
@@ -109,7 +91,7 @@ interface GetDeliveryProfileByDeliveryRegionIdSignature {
 declare function removeDeliveryRegion$1(httpClient: HttpClient): RemoveDeliveryRegionSignature;
 interface RemoveDeliveryRegionSignature {
     /**
-     * Delete a DeliveryRegion
+     * Removes a delivery region from a delivery profile.
      */
     (identifiers: NonNullablePaths<RemoveDeliveryRegionIdentifiers, `deliveryProfileId` | `deliveryRegionId`, 2>, options?: RemoveDeliveryRegionOptions): Promise<NonNullablePaths<RemoveDeliveryRegionResponse, `deliveryProfile.deliveryRegions`, 3> & {
         __applicationErrorsType?: RemoveDeliveryRegionApplicationErrors;
@@ -118,8 +100,8 @@ interface RemoveDeliveryRegionSignature {
 declare function addDeliveryCarrier$1(httpClient: HttpClient): AddDeliveryCarrierSignature;
 interface AddDeliveryCarrierSignature {
     /**
-     * Add a delivery_carrier to a delivery region
-     * @param - delivery_region id to associated with the delivery_carrier.
+     * Adds a delivery carrier to a delivery region.
+     * @param - Delivery region ID.
      */
     (deliveryRegionId: string, options: NonNullablePaths<AddDeliveryCarrierOptions, `deliveryCarrier` | `deliveryCarrier.backupRate.amount`, 4>): Promise<NonNullablePaths<AddDeliveryCarrierResponse, `deliveryProfile.deliveryRegions`, 3> & {
         __applicationErrorsType?: AddDeliveryCarrierApplicationErrors;
@@ -129,8 +111,8 @@ interface AddDeliveryCarrierSignature {
 declare function removeDeliveryCarrier$1(httpClient: HttpClient): RemoveDeliveryCarrierSignature;
 interface RemoveDeliveryCarrierSignature {
     /**
-     * Remove a delivery_carrier from a delivery region
-     * @param - Id of the DeliveryRegion
+     * Removes a delivery carrier from a delivery region.
+     * @param - Delivery region ID.
      */
     (deliveryRegionId: string, options: NonNullablePaths<RemoveDeliveryCarrierOptions, `appId`, 2>): Promise<NonNullablePaths<RemoveDeliveryCarrierResponse, `deliveryProfile.deliveryRegions`, 3> & {
         __applicationErrorsType?: RemoveDeliveryCarrierApplicationErrors;
@@ -139,8 +121,8 @@ interface RemoveDeliveryCarrierSignature {
 declare function updateDeliveryCarrier$1(httpClient: HttpClient): UpdateDeliveryCarrierSignature;
 interface UpdateDeliveryCarrierSignature {
     /**
-     * Update a delivery carrier in a delivery region
-     * @param - DeliveryRegion id
+     * Updates a delivery carrier's settings in a delivery region.
+     * @param - Delivery region ID.
      */
     (deliveryRegionId: string, options?: NonNullablePaths<UpdateDeliveryCarrierOptions, `deliveryCarrier.appId`, 3>): Promise<NonNullablePaths<UpdateDeliveryCarrierResponse, `deliveryProfile.deliveryRegions`, 3> & {
         __applicationErrorsType?: UpdateDeliveryCarrierApplicationErrors;
@@ -149,23 +131,31 @@ interface UpdateDeliveryCarrierSignature {
 declare function listInstalledDeliveryCarriers$1(httpClient: HttpClient): ListInstalledDeliveryCarriersSignature;
 interface ListInstalledDeliveryCarriersSignature {
     /**
-     * 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.
      */
     (): Promise<NonNullablePaths<ListInstalledDeliveryCarriersResponse, `installedDeliveryCarriers` | `installedDeliveryCarriers.${number}._id` | `installedDeliveryCarriers.${number}.displayName` | `installedDeliveryCarriers.${number}.toggleGetCarrierSettingsEnabled`, 4>>;
 }
 declare function getDeliveryDestinationProperties$1(httpClient: HttpClient): GetDeliveryDestinationPropertiesSignature;
 interface GetDeliveryDestinationPropertiesSignature {
     /**
-     * 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.
      */
     (): Promise<NonNullablePaths<GetDeliveryDestinationPropertiesResponse, `restOfWorld.postalCodeRequired` | `restOfWorld.pickupOnly` | `countries` | `countries.${number}.country` | `countries.${number}.deliveryDestinationProperties.postalCodeRequired` | `countries.${number}.deliveryDestinationProperties.pickupOnly`, 5>>;
 }
 declare function listDeliveryCarriers$1(httpClient: HttpClient): ListDeliveryCarriersSignature;
 interface ListDeliveryCarriersSignature {
     /**
-     * Get delivery carrier settings for a delivery profile and delivery region.
-     * These are returned in a table format for the dashboard.
-     * @param - 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 - 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> & {
         __applicationErrorsType?: ListDeliveryCarriersApplicationErrors;
@@ -174,7 +164,7 @@ interface ListDeliveryCarriersSignature {
 declare function setDeliveryCarrierActiveStatus$1(httpClient: HttpClient): SetDeliveryCarrierActiveStatusSignature;
 interface SetDeliveryCarrierActiveStatusSignature {
     /**
-     * Sets delivery carrier's active status.
+     * Sets a delivery carrier's active status.
      * @param - Carrier app ID.
      */
     (carrierAppId: string, options: NonNullablePaths<SetDeliveryCarrierActiveStatusOptions, `active` | `rowId`, 2>): Promise<void & {
@@ -218,17 +208,29 @@ declare const listDeliveryCarriers: MaybeContext<BuildRESTFunction<typeof listDe
 declare const setDeliveryCarrierActiveStatus: MaybeContext<BuildRESTFunction<typeof setDeliveryCarrierActiveStatus$1> & typeof setDeliveryCarrierActiveStatus$1>;
 declare const updateExtendedFields: MaybeContext<BuildRESTFunction<typeof updateExtendedFields$1> & typeof updateExtendedFields$1>;
 declare const queryDeliveryProfiles: MaybeContext<BuildRESTFunction<typeof customQueryDeliveryProfiles> & typeof customQueryDeliveryProfiles>;
-/** */
+/**
+ * Triggered when a delivery profile is created.
+ */
 declare const onDeliveryProfileCreated: BuildEventDefinition<typeof onDeliveryProfileCreated$1> & typeof onDeliveryProfileCreated$1;
-/** */
+/**
+ * Triggered when a delivery profile is deleted.
+ */
 declare const onDeliveryProfileDeleted: BuildEventDefinition<typeof onDeliveryProfileDeleted$1> & typeof onDeliveryProfileDeleted$1;
-/** */
+/**
+ * Triggered when a delivery region is added to a delivery profile.
+ */
 declare const onDeliveryProfileRegionAdded: BuildEventDefinition<typeof onDeliveryProfileRegionAdded$1> & typeof onDeliveryProfileRegionAdded$1;
-/** */
+/**
+ * Triggered when a delivery region is removed from a delivery profile.
+ */
 declare const onDeliveryProfileRegionRemoved: BuildEventDefinition<typeof onDeliveryProfileRegionRemoved$1> & typeof onDeliveryProfileRegionRemoved$1;
-/** */
+/**
+ * Triggered when a delivery region is updated.
+ */
 declare const onDeliveryProfileRegionUpdated: BuildEventDefinition<typeof onDeliveryProfileRegionUpdated$1> & typeof onDeliveryProfileRegionUpdated$1;
-/** */
+/**
+ * Triggered when a delivery profile is updated.
+ */
 declare const onDeliveryProfileUpdated: BuildEventDefinition<typeof onDeliveryProfileUpdated$1> & typeof onDeliveryProfileUpdated$1;
 
 export { AddDeliveryCarrierApplicationErrors, AddDeliveryCarrierOptions, AddDeliveryCarrierResponse, AddDeliveryCarrierValidationErrors, AddDeliveryRegionApplicationErrors, AddDeliveryRegionOptions, AddDeliveryRegionResponse, AddDeliveryRegionValidationErrors, CreateDeliveryProfileApplicationErrors, DeliveryProfile, DeliveryProfileCreatedEnvelope, DeliveryProfileDeletedEnvelope, DeliveryProfileQuery, DeliveryProfileRegionAddedEnvelope, DeliveryProfileRegionRemovedEnvelope, DeliveryProfileRegionUpdatedEnvelope, DeliveryProfileUpdatedEnvelope, DeliveryProfilesQueryBuilder, DeliveryRegion, GetDeliveryDestinationPropertiesResponse, GetDeliveryProfileByDeliveryRegionIdApplicationErrors, GetDeliveryProfileByDeliveryRegionIdResponse, ListDeliveryCarriersApplicationErrors, ListDeliveryCarriersOptions, ListDeliveryCarriersResponse, ListInstalledDeliveryCarriersResponse, RemoveDeliveryCarrierApplicationErrors, RemoveDeliveryCarrierOptions, RemoveDeliveryCarrierResponse, RemoveDeliveryRegionApplicationErrors, RemoveDeliveryRegionIdentifiers, RemoveDeliveryRegionOptions, RemoveDeliveryRegionResponse, SetDeliveryCarrierActiveStatusApplicationErrors, SetDeliveryCarrierActiveStatusOptions, UpdateDeliveryCarrierApplicationErrors, UpdateDeliveryCarrierOptions, UpdateDeliveryCarrierResponse, UpdateDeliveryProfile, UpdateDeliveryProfileApplicationErrors, UpdateDeliveryRegion, UpdateDeliveryRegionApplicationErrors, UpdateDeliveryRegionIdentifiers, UpdateDeliveryRegionOptions, UpdateDeliveryRegionResponse, UpdateDeliveryRegionValidationErrors, UpdateExtendedFieldsOptions, UpdateExtendedFieldsResponse, addDeliveryCarrier, addDeliveryRegion, createDeliveryProfile, deleteDeliveryProfile, getDeliveryDestinationProperties, getDeliveryProfile, getDeliveryProfileByDeliveryRegionId, listDeliveryCarriers, listInstalledDeliveryCarriers, onDeliveryProfileCreated, onDeliveryProfileDeleted, onDeliveryProfileRegionAdded, onDeliveryProfileRegionRemoved, onDeliveryProfileRegionUpdated, onDeliveryProfileUpdated, queryDeliveryProfiles, removeDeliveryCarrier, removeDeliveryRegion, setDeliveryCarrierActiveStatus, updateDeliveryCarrier, updateDeliveryProfile, updateDeliveryRegion, updateExtendedFields };