@wix/auto_sdk_ecom_delivery-profile 1.0.83 → 1.0.84

package/build/cjs/index.d.ts

@@ -1,6 +1,6 @@
 import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
-import { DeliveryProfile, CreateDeliveryProfileApplicationErrors, CreateDeliveryProfileValidationErrors, UpdateDeliveryProfile, UpdateDeliveryProfileApplicationErrors, DeliveryRegion, AddDeliveryRegionOptions, AddDeliveryRegionResponse, AddDeliveryRegionApplicationErrors, AddDeliveryRegionValidationErrors, UpdateDeliveryRegionIdentifiers, UpdateDeliveryRegion, UpdateDeliveryRegionOptions, UpdateDeliveryRegionResponse, UpdateDeliveryRegionApplicationErrors, UpdateDeliveryRegionValidationErrors, GetDeliveryProfileByDeliveryRegionIdResponse, GetDeliveryProfileByDeliveryRegionIdApplicationErrors, RemoveDeliveryRegionIdentifiers, RemoveDeliveryRegionOptions, RemoveDeliveryRegionResponse, RemoveDeliveryRegionApplicationErrors, AddDeliveryCarrierOptions, AddDeliveryCarrierResponse, AddDeliveryCarrierApplicationErrors, AddDeliveryCarrierValidationErrors, RemoveDeliveryCarrierOptions, RemoveDeliveryCarrierResponse, RemoveDeliveryCarrierApplicationErrors, UpdateDeliveryCarrierOptions, UpdateDeliveryCarrierResponse, UpdateDeliveryCarrierApplicationErrors, ListInstalledDeliveryCarriersResponse, GetDeliveryDestinationPropertiesResponse, ListDeliveryCarriersOptions, ListDeliveryCarriersResponse, ListDeliveryCarriersApplicationErrors, UpdateCarrierSettingsOptions, UpdateCarrierSettingsApplicationErrors, UpdateExtendedFieldsOptions, UpdateExtendedFieldsResponse, DeliveryProfilesQueryBuilder, CursorQuery, typedQueryDeliveryProfiles } from './index.typings.js';
-export { ActionEvent, AddDeliveryCarrierRequest, AddDeliveryRegionRequest, AdditionalCharge, ApplicationError, Asset, BackupRate, BulkActionMetadata, ChargeType, ChargeTypeWithLiterals, Column, CountryDeliveryProperties, CreateDeliveryProfileRequest, CreateDeliveryProfileResponse, CreatedBy, CreatedByIdOneOf, CursorPaging, CursorPagingMetadata, CursorQueryPagingMethodOneOf, Cursors, DashboardTable, DeleteContext, DeleteDefaultDeliveryProfileRequest, DeleteDefaultDeliveryProfileResponse, DeleteDeliveryProfileRequest, DeleteDeliveryProfileResponse, DeleteStatus, DeleteStatusWithLiterals, DeliveryCarrier, DeliveryCarrierDetails, DeliveryCarrierRegionalSettings, DeliveryDestinationProperties, DeliveryProfilesQueryResult, DeliveryRegionAdded, DeliveryRegionRemoved, DeliveryRegionUpdated, Destination, DestinationScope, DestinationScopeWithLiterals, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, ExtendedFields, GetDeliveryDestinationPropertiesRequest, GetDeliveryProfileByDeliveryRegionIdRequest, GetDeliveryProfileRequest, GetDeliveryProfileResponse, IdentificationData, IdentificationDataIdOneOf, InstalledDeliveryCarrier, ItemMetadata, ListDeliveryCarriersRequest, ListDeliveryCarriersResult, ListDeliveryDestinationsRequest, ListDeliveryDestinationsResponse, ListInstalledDeliveryCarriersRequest, MessageEnvelope, MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf, Namespace, NamespaceChanged, NamespaceWithLiterals, OdeditorAssigned, OdeditorUnassigned, PicassoAssigned, PicassoUnassigned, QueryDeliveryProfilesRequest, QueryDeliveryProfilesResponse, RemoveDeliveryCarrierRequest, RemoveDeliveryRegionRequest, RequiredZipcodeRequest, RequiredZipcodeResponse, RestoreInfo, Row, ServiceProvisioned, ServiceRemoved, SiteCreated, SiteCreatedContext, SiteCreatedContextWithLiterals, SiteDeleted, SiteHardDeleted, SiteMarkedAsTemplate, SiteMarkedAsWixSite, SitePublished, SitePurgedExternally, SiteRenamed, SiteTransferred, SiteUndeleted, SiteUnpublished, SiteUrlChanged, SortOrder, SortOrderWithLiterals, Sorting, State, StateWithLiterals, StudioAssigned, StudioTwoAssigned, StudioTwoUnassigned, StudioUnassigned, SubdivisionDeliveryProperties, UpdateCarrierSettingsRequest, UpdateCarrierSettingsResponse, UpdateDeliveryCarrierRequest, UpdateDeliveryProfileRequest, UpdateDeliveryProfileResponse, UpdateDeliveryRegionRequest, UpdateExtendedFieldsRequest, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WixelAssigned, WixelUnassigned } from './index.typings.js';
+import { DeliveryProfile, CreateDeliveryProfileApplicationErrors, CreateDeliveryProfileValidationErrors, UpdateDeliveryProfile, UpdateDeliveryProfileApplicationErrors, DeliveryRegion, AddDeliveryRegionOptions, AddDeliveryRegionResponse, AddDeliveryRegionApplicationErrors, AddDeliveryRegionValidationErrors, UpdateDeliveryRegionIdentifiers, UpdateDeliveryRegion, UpdateDeliveryRegionOptions, UpdateDeliveryRegionResponse, UpdateDeliveryRegionApplicationErrors, UpdateDeliveryRegionValidationErrors, GetDeliveryProfileByDeliveryRegionIdResponse, GetDeliveryProfileByDeliveryRegionIdApplicationErrors, RemoveDeliveryRegionIdentifiers, RemoveDeliveryRegionOptions, RemoveDeliveryRegionResponse, RemoveDeliveryRegionApplicationErrors, AddDeliveryCarrierOptions, AddDeliveryCarrierResponse, AddDeliveryCarrierApplicationErrors, AddDeliveryCarrierValidationErrors, RemoveDeliveryCarrierOptions, RemoveDeliveryCarrierResponse, RemoveDeliveryCarrierApplicationErrors, UpdateDeliveryCarrierOptions, UpdateDeliveryCarrierResponse, UpdateDeliveryCarrierApplicationErrors, ListInstalledDeliveryCarriersResponse, GetDeliveryDestinationPropertiesResponse, ListDeliveryCarriersOptions, ListDeliveryCarriersResponse, ListDeliveryCarriersApplicationErrors, UpdateCarrierSettingsOptions, UpdateCarrierSettingsApplicationErrors, UpdateExtendedFieldsOptions, UpdateExtendedFieldsResponse, DeliveryProfilesQueryBuilder, DeliveryProfileQuery, typedQueryDeliveryProfiles } from './index.typings.js';
+export { ActionEvent, AddDeliveryCarrierRequest, AddDeliveryRegionRequest, AdditionalCharge, ApplicationError, Asset, BackupRate, BulkActionMetadata, ChargeType, ChargeTypeWithLiterals, Column, CommonQueryWithEntityContext, CountryDeliveryProperties, CreateDeliveryProfileRequest, CreateDeliveryProfileResponse, CreatedBy, CreatedByIdOneOf, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DashboardTable, DeleteContext, DeleteDefaultDeliveryProfileRequest, DeleteDefaultDeliveryProfileResponse, DeleteDeliveryProfileRequest, DeleteDeliveryProfileResponse, DeleteStatus, DeleteStatusWithLiterals, DeliveryCarrier, DeliveryCarrierDetails, DeliveryCarrierRegionalSettings, DeliveryDestinationProperties, DeliveryProfileQuerySpec, DeliveryProfilesQueryResult, DeliveryRegionAdded, DeliveryRegionRemoved, DeliveryRegionUpdated, Destination, DestinationScope, DestinationScopeWithLiterals, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, ExtendedFields, GetDeliveryDestinationPropertiesRequest, GetDeliveryProfileByDeliveryRegionIdRequest, GetDeliveryProfileRequest, GetDeliveryProfileResponse, IdentificationData, IdentificationDataIdOneOf, InstalledDeliveryCarrier, ItemMetadata, ListDeliveryCarriersRequest, ListDeliveryCarriersResult, ListDeliveryDestinationsRequest, ListDeliveryDestinationsResponse, ListInstalledDeliveryCarriersRequest, MessageEnvelope, MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf, Namespace, NamespaceChanged, NamespaceWithLiterals, OdeditorAssigned, OdeditorUnassigned, PicassoAssigned, PicassoUnassigned, QueryDeliveryProfilesRequest, QueryDeliveryProfilesResponse, RemoveDeliveryCarrierRequest, RemoveDeliveryRegionRequest, RequiredZipcodeRequest, RequiredZipcodeResponse, RestoreInfo, Row, ServiceProvisioned, ServiceRemoved, SiteCreated, SiteCreatedContext, SiteCreatedContextWithLiterals, SiteDeleted, SiteHardDeleted, SiteMarkedAsTemplate, SiteMarkedAsWixSite, SitePublished, SitePurgedExternally, SiteRenamed, SiteTransferred, SiteUndeleted, SiteUnpublished, SiteUrlChanged, SortOrder, SortOrderWithLiterals, Sorting, State, StateWithLiterals, StudioAssigned, StudioTwoAssigned, StudioTwoUnassigned, StudioUnassigned, SubdivisionDeliveryProperties, UpdateCarrierSettingsRequest, UpdateCarrierSettingsResponse, UpdateDeliveryCarrierRequest, UpdateDeliveryProfileRequest, UpdateDeliveryProfileResponse, UpdateDeliveryRegionRequest, UpdateExtendedFieldsRequest, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WixelAssigned, WixelUnassigned } from './index.typings.js';
 
 declare function createDeliveryProfile$1(httpClient: HttpClient): CreateDeliveryProfileSignature;
 interface CreateDeliveryProfileSignature {
@@ -8,6 +8,9 @@ interface CreateDeliveryProfileSignature {
      * Creates a DeliveryProfile.
      *
      * 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.
      */
@@ -30,15 +33,20 @@ interface UpdateDeliveryProfileSignature {
     /**
      * 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.
      *
      * This method does not allow updating the DeliveryRegions in this DeliveryProfile.
-     * Use AddDeliveryRegion, UpdateDeliveryRegion and RemoveDeliveryRegion for these functionalities.
+     * 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.
      */
@@ -52,6 +60,11 @@ interface DeleteDeliveryProfileSignature {
      * Deletes a DeliveryProfile.
      *
      * 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.
+     *
+     * Cannot delete the default delivery profile because every site requires one for core delivery functionality.
      * @param - Id of the DeliveryProfile to delete.
      */
     (deliveryProfileId: string): Promise<void>;
@@ -75,7 +88,9 @@ interface UpdateDeliveryRegionSignature {
      * Pass the latest `revision` for a successful update
      *
      * This method does not allow setting or updating the delivery delivery_carriers in this delivery_region.
-     * Use AddDeliveryCarrier, UpdateDeliveryCarrier and RemoveDeliveryCarrier for these functionalities.
+     * 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.
      */
     (identifiers: NonNullablePaths<UpdateDeliveryRegionIdentifiers, `deliveryProfileId` | `deliveryRegionId`, 2>, deliveryRegion: UpdateDeliveryRegion, options?: UpdateDeliveryRegionOptions): Promise<NonNullablePaths<UpdateDeliveryRegionResponse, `deliveryProfile.deliveryRegions`, 3> & {
         __applicationErrorsType?: UpdateDeliveryRegionApplicationErrors;
@@ -179,7 +194,7 @@ interface UpdateExtendedFieldsSignature {
 
 declare function customQueryDeliveryProfiles(httpClient: HttpClient): {
     (): DeliveryProfilesQueryBuilder;
-    (query: CursorQuery): ReturnType<typeof typedQueryDeliveryProfiles>;
+    (query: DeliveryProfileQuery): ReturnType<typeof typedQueryDeliveryProfiles>;
 };
 declare const createDeliveryProfile: MaybeContext<BuildRESTFunction<typeof createDeliveryProfile$1> & typeof createDeliveryProfile$1>;
 declare const getDeliveryProfile: MaybeContext<BuildRESTFunction<typeof getDeliveryProfile$1> & typeof getDeliveryProfile$1>;
@@ -199,4 +214,4 @@ declare const updateCarrierSettings: MaybeContext<BuildRESTFunction<typeof updat
 declare const updateExtendedFields: MaybeContext<BuildRESTFunction<typeof updateExtendedFields$1> & typeof updateExtendedFields$1>;
 declare const queryDeliveryProfiles: MaybeContext<BuildRESTFunction<typeof customQueryDeliveryProfiles> & typeof customQueryDeliveryProfiles>;
 
-export { AddDeliveryCarrierApplicationErrors, AddDeliveryCarrierOptions, AddDeliveryCarrierResponse, AddDeliveryCarrierValidationErrors, AddDeliveryRegionApplicationErrors, AddDeliveryRegionOptions, AddDeliveryRegionResponse, AddDeliveryRegionValidationErrors, CreateDeliveryProfileApplicationErrors, CreateDeliveryProfileValidationErrors, CursorQuery, DeliveryProfile, DeliveryProfilesQueryBuilder, DeliveryRegion, GetDeliveryDestinationPropertiesResponse, GetDeliveryProfileByDeliveryRegionIdApplicationErrors, GetDeliveryProfileByDeliveryRegionIdResponse, ListDeliveryCarriersApplicationErrors, ListDeliveryCarriersOptions, ListDeliveryCarriersResponse, ListInstalledDeliveryCarriersResponse, RemoveDeliveryCarrierApplicationErrors, RemoveDeliveryCarrierOptions, RemoveDeliveryCarrierResponse, RemoveDeliveryRegionApplicationErrors, RemoveDeliveryRegionIdentifiers, RemoveDeliveryRegionOptions, RemoveDeliveryRegionResponse, UpdateCarrierSettingsApplicationErrors, UpdateCarrierSettingsOptions, UpdateDeliveryCarrierApplicationErrors, UpdateDeliveryCarrierOptions, UpdateDeliveryCarrierResponse, UpdateDeliveryProfile, UpdateDeliveryProfileApplicationErrors, UpdateDeliveryRegion, UpdateDeliveryRegionApplicationErrors, UpdateDeliveryRegionIdentifiers, UpdateDeliveryRegionOptions, UpdateDeliveryRegionResponse, UpdateDeliveryRegionValidationErrors, UpdateExtendedFieldsOptions, UpdateExtendedFieldsResponse, addDeliveryCarrier, addDeliveryRegion, createDeliveryProfile, deleteDeliveryProfile, getDeliveryDestinationProperties, getDeliveryProfile, getDeliveryProfileByDeliveryRegionId, listDeliveryCarriers, listInstalledDeliveryCarriers, queryDeliveryProfiles, removeDeliveryCarrier, removeDeliveryRegion, updateCarrierSettings, updateDeliveryCarrier, updateDeliveryProfile, updateDeliveryRegion, updateExtendedFields };
+export { AddDeliveryCarrierApplicationErrors, AddDeliveryCarrierOptions, AddDeliveryCarrierResponse, AddDeliveryCarrierValidationErrors, AddDeliveryRegionApplicationErrors, AddDeliveryRegionOptions, AddDeliveryRegionResponse, AddDeliveryRegionValidationErrors, CreateDeliveryProfileApplicationErrors, CreateDeliveryProfileValidationErrors, DeliveryProfile, DeliveryProfileQuery, DeliveryProfilesQueryBuilder, DeliveryRegion, GetDeliveryDestinationPropertiesResponse, GetDeliveryProfileByDeliveryRegionIdApplicationErrors, GetDeliveryProfileByDeliveryRegionIdResponse, ListDeliveryCarriersApplicationErrors, ListDeliveryCarriersOptions, ListDeliveryCarriersResponse, ListInstalledDeliveryCarriersResponse, RemoveDeliveryCarrierApplicationErrors, RemoveDeliveryCarrierOptions, RemoveDeliveryCarrierResponse, RemoveDeliveryRegionApplicationErrors, RemoveDeliveryRegionIdentifiers, RemoveDeliveryRegionOptions, RemoveDeliveryRegionResponse, UpdateCarrierSettingsApplicationErrors, UpdateCarrierSettingsOptions, UpdateDeliveryCarrierApplicationErrors, UpdateDeliveryCarrierOptions, UpdateDeliveryCarrierResponse, UpdateDeliveryProfile, UpdateDeliveryProfileApplicationErrors, UpdateDeliveryRegion, UpdateDeliveryRegionApplicationErrors, UpdateDeliveryRegionIdentifiers, UpdateDeliveryRegionOptions, UpdateDeliveryRegionResponse, UpdateDeliveryRegionValidationErrors, UpdateExtendedFieldsOptions, UpdateExtendedFieldsResponse, addDeliveryCarrier, addDeliveryRegion, createDeliveryProfile, deleteDeliveryProfile, getDeliveryDestinationProperties, getDeliveryProfile, getDeliveryProfileByDeliveryRegionId, listDeliveryCarriers, listInstalledDeliveryCarriers, queryDeliveryProfiles, removeDeliveryCarrier, removeDeliveryRegion, updateCarrierSettings, updateDeliveryCarrier, updateDeliveryProfile, updateDeliveryRegion, updateExtendedFields };

package/build/cjs/index.js

@@ -709,6 +709,7 @@ var Namespace = /* @__PURE__ */ ((Namespace2) => {
   Namespace2["MIMIR"] = "MIMIR";
   Namespace2["TWINS"] = "TWINS";
   Namespace2["NANO"] = "NANO";
+  Namespace2["BASE44"] = "BASE44";
   return Namespace2;
 })(Namespace || {});
 var DeleteStatus = /* @__PURE__ */ ((DeleteStatus2) => {