@wix/auto_sdk_ecom_delivery-profile 1.0.53 → 1.0.55

package/build/es/index.typings.d.mts

@@ -1585,7 +1585,7 @@ type UpdateCarrierSettingsApplicationErrors = {
  * @returns The created DeliveryProfile.
  * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.CreateDeliveryProfile
  */
-declare function createDeliveryProfile(deliveryProfile: NonNullablePaths<DeliveryProfile, `deliveryRegions.${number}.destinations` | `deliveryRegions.${number}.destinations.${number}.countryCode` | `deliveryRegions.${number}.name` | `name`>): Promise<NonNullablePaths<DeliveryProfile, `deliveryRegions`> & {
+declare function createDeliveryProfile(deliveryProfile: NonNullablePaths<DeliveryProfile, `deliveryRegions.${number}.destinations` | `deliveryRegions.${number}.destinations.${number}.countryCode` | `deliveryRegions.${number}.name` | `name`, 6>): Promise<NonNullablePaths<DeliveryProfile, `deliveryRegions`, 2> & {
     __applicationErrorsType?: CreateDeliveryProfileApplicationErrors;
     __validationErrorsType?: CreateDeliveryProfileValidationErrors;
 }>;
@@ -1597,11 +1597,10 @@ declare function createDeliveryProfile(deliveryProfile: NonNullablePaths<Deliver
  * @requiredField deliveryProfileId
  * @permissionId ECOM.DELIVERY_PROFILE_READ
  * @applicableIdentity APP
- * @applicableIdentity VISITOR
  * @returns The requested DeliveryProfile.
  * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.GetDeliveryProfile
  */
-declare function getDeliveryProfile(deliveryProfileId: string): Promise<NonNullablePaths<DeliveryProfile, `deliveryRegions`>>;
+declare function getDeliveryProfile(deliveryProfileId: string): Promise<NonNullablePaths<DeliveryProfile, `deliveryRegions`, 2>>;
 /**
  * Updates a DeliveryProfile.
  *
@@ -1625,7 +1624,7 @@ declare function getDeliveryProfile(deliveryProfileId: string): Promise<NonNulla
  * @returns Updated DeliveryProfile.
  * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.UpdateDeliveryProfile
  */
-declare function updateDeliveryProfile(_id: string, deliveryProfile: NonNullablePaths<UpdateDeliveryProfile, `revision`>): Promise<NonNullablePaths<DeliveryProfile, `deliveryRegions`> & {
+declare function updateDeliveryProfile(_id: string, deliveryProfile: NonNullablePaths<UpdateDeliveryProfile, `revision`, 2>): Promise<NonNullablePaths<DeliveryProfile, `deliveryRegions`, 2> & {
     __applicationErrorsType?: UpdateDeliveryProfileApplicationErrors;
 }>;
 interface UpdateDeliveryProfile {
@@ -1697,7 +1696,6 @@ declare function deleteDeliveryProfile(deliveryProfileId: string): Promise<void>
  * @documentationMaturity preview
  * @permissionId ECOM.DELIVERY_PROFILE_READ
  * @applicableIdentity APP
- * @applicableIdentity VISITOR
  * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.QueryDeliveryProfiles
  */
 declare function queryDeliveryProfiles(): DeliveryProfilesQueryBuilder;
@@ -1792,7 +1790,7 @@ interface DeliveryProfilesQueryBuilder {
  * @applicableIdentity APP
  * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.AddDeliveryRegion
  */
-declare function addDeliveryRegion(deliveryProfileId: string, deliveryRegion: NonNullablePaths<DeliveryRegion, `destinations.${number}.countryCode` | `name`>, options?: AddDeliveryRegionOptions): Promise<NonNullablePaths<AddDeliveryRegionResponse, `deliveryProfile.deliveryRegions`> & {
+declare function addDeliveryRegion(deliveryProfileId: string, deliveryRegion: NonNullablePaths<DeliveryRegion, `destinations.${number}.countryCode` | `name`, 4>, options?: AddDeliveryRegionOptions): Promise<NonNullablePaths<AddDeliveryRegionResponse, `deliveryProfile.deliveryRegions`, 3> & {
     __applicationErrorsType?: AddDeliveryRegionApplicationErrors;
     __validationErrorsType?: AddDeliveryRegionValidationErrors;
 }>;
@@ -1819,7 +1817,7 @@ interface AddDeliveryRegionOptions {
  * @applicableIdentity APP
  * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.UpdateDeliveryRegion
  */
-declare function updateDeliveryRegion(identifiers: NonNullablePaths<UpdateDeliveryRegionIdentifiers, `deliveryProfileId` | `deliveryRegionId`>, deliveryRegion: UpdateDeliveryRegion, options?: UpdateDeliveryRegionOptions): Promise<NonNullablePaths<UpdateDeliveryRegionResponse, `deliveryProfile.deliveryRegions`> & {
+declare function updateDeliveryRegion(identifiers: NonNullablePaths<UpdateDeliveryRegionIdentifiers, `deliveryProfileId` | `deliveryRegionId`, 2>, deliveryRegion: UpdateDeliveryRegion, options?: UpdateDeliveryRegionOptions): Promise<NonNullablePaths<UpdateDeliveryRegionResponse, `deliveryProfile.deliveryRegions`, 3> & {
     __applicationErrorsType?: UpdateDeliveryRegionApplicationErrors;
     __validationErrorsType?: UpdateDeliveryRegionValidationErrors;
 }>;
@@ -1883,10 +1881,9 @@ interface UpdateDeliveryRegionOptions {
  * @requiredField deliveryRegionId
  * @permissionId ECOM.DELIVERY_PROFILE_READ
  * @applicableIdentity APP
- * @applicableIdentity VISITOR
  * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.GetDeliveryProfileByDeliveryRegionId
  */
-declare function getDeliveryProfileByDeliveryRegionId(deliveryRegionId: string): Promise<NonNullablePaths<GetDeliveryProfileByDeliveryRegionIdResponse, `deliveryProfile.deliveryRegions`> & {
+declare function getDeliveryProfileByDeliveryRegionId(deliveryRegionId: string): Promise<NonNullablePaths<GetDeliveryProfileByDeliveryRegionIdResponse, `deliveryProfile.deliveryRegions`, 3> & {
     __applicationErrorsType?: GetDeliveryProfileByDeliveryRegionIdApplicationErrors;
 }>;
 /**
@@ -1900,7 +1897,7 @@ declare function getDeliveryProfileByDeliveryRegionId(deliveryRegionId: string):
  * @applicableIdentity APP
  * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.RemoveDeliveryRegion
  */
-declare function removeDeliveryRegion(identifiers: NonNullablePaths<RemoveDeliveryRegionIdentifiers, `deliveryProfileId` | `deliveryRegionId`>, options?: RemoveDeliveryRegionOptions): Promise<NonNullablePaths<RemoveDeliveryRegionResponse, `deliveryProfile.deliveryRegions`> & {
+declare function removeDeliveryRegion(identifiers: NonNullablePaths<RemoveDeliveryRegionIdentifiers, `deliveryProfileId` | `deliveryRegionId`, 2>, options?: RemoveDeliveryRegionOptions): Promise<NonNullablePaths<RemoveDeliveryRegionResponse, `deliveryProfile.deliveryRegions`, 3> & {
     __applicationErrorsType?: RemoveDeliveryRegionApplicationErrors;
 }>;
 interface RemoveDeliveryRegionIdentifiers {
@@ -1934,7 +1931,7 @@ interface RemoveDeliveryRegionOptions {
  * @applicableIdentity APP
  * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.AddDeliveryCarrier
  */
-declare function addDeliveryCarrier(deliveryRegionId: string, options: NonNullablePaths<AddDeliveryCarrierOptions, `deliveryCarrier`>): Promise<NonNullablePaths<AddDeliveryCarrierResponse, `deliveryProfile.deliveryRegions`> & {
+declare function addDeliveryCarrier(deliveryRegionId: string, options: NonNullablePaths<AddDeliveryCarrierOptions, `deliveryCarrier`, 2>): Promise<NonNullablePaths<AddDeliveryCarrierResponse, `deliveryProfile.deliveryRegions`, 3> & {
     __applicationErrorsType?: AddDeliveryCarrierApplicationErrors;
     __validationErrorsType?: AddDeliveryCarrierValidationErrors;
 }>;
@@ -1954,7 +1951,7 @@ interface AddDeliveryCarrierOptions {
  * @applicableIdentity APP
  * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.RemoveDeliveryCarrier
  */
-declare function removeDeliveryCarrier(deliveryRegionId: string, options: NonNullablePaths<RemoveDeliveryCarrierOptions, `appId`>): Promise<NonNullablePaths<RemoveDeliveryCarrierResponse, `deliveryProfile.deliveryRegions`> & {
+declare function removeDeliveryCarrier(deliveryRegionId: string, options: NonNullablePaths<RemoveDeliveryCarrierOptions, `appId`, 2>): Promise<NonNullablePaths<RemoveDeliveryCarrierResponse, `deliveryProfile.deliveryRegions`, 3> & {
     __applicationErrorsType?: RemoveDeliveryCarrierApplicationErrors;
 }>;
 interface RemoveDeliveryCarrierOptions {
@@ -1975,7 +1972,7 @@ interface RemoveDeliveryCarrierOptions {
  * @applicableIdentity APP
  * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.UpdateDeliveryCarrier
  */
-declare function updateDeliveryCarrier(deliveryRegionId: string, options?: NonNullablePaths<UpdateDeliveryCarrierOptions, `deliveryCarrier.appId`>): Promise<NonNullablePaths<UpdateDeliveryCarrierResponse, `deliveryProfile.deliveryRegions`> & {
+declare function updateDeliveryCarrier(deliveryRegionId: string, options?: NonNullablePaths<UpdateDeliveryCarrierOptions, `deliveryCarrier.appId`, 3>): Promise<NonNullablePaths<UpdateDeliveryCarrierResponse, `deliveryProfile.deliveryRegions`, 3> & {
     __applicationErrorsType?: UpdateDeliveryCarrierApplicationErrors;
 }>;
 interface UpdateDeliveryCarrierOptions {
@@ -1993,14 +1990,14 @@ interface UpdateDeliveryCarrierOptions {
  * @replacedBy ListInstalledDeliveryCarriers
  * @targetRemovalDate 2025-04-01
  */
-declare function listDeliveryCarrierDetails(): Promise<NonNullablePaths<ListDeliveryCarrierDetailsResponse, `deliveryCarrierDetails` | `deliveryCarrierDetails.${number}._id` | `deliveryCarrierDetails.${number}.displayName` | `deliveryCarrierDetails.${number}.toggleGetCarrierSettingsEnabled` | `deliveryCarrierDetails.${number}.toggleUpdateCarrierActiveStatusEnabled`>>;
+declare function listDeliveryCarrierDetails(): Promise<NonNullablePaths<ListDeliveryCarrierDetailsResponse, `deliveryCarrierDetails` | `deliveryCarrierDetails.${number}._id` | `deliveryCarrierDetails.${number}.displayName` | `deliveryCarrierDetails.${number}.toggleGetCarrierSettingsEnabled` | `deliveryCarrierDetails.${number}.toggleUpdateCarrierActiveStatusEnabled`, 4>>;
 /** @public
  * @documentationMaturity preview
  * @permissionId ECOM.DELIVERY_CARRIER_READ
  * @applicableIdentity APP
  * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.ListInstalledDeliveryCarriers
  */
-declare function listInstalledDeliveryCarriers(): Promise<NonNullablePaths<ListInstalledDeliveryCarriersResponse, `installedDeliveryCarriers` | `installedDeliveryCarriers.${number}._id` | `installedDeliveryCarriers.${number}.displayName` | `installedDeliveryCarriers.${number}.toggleGetCarrierSettingsEnabled`>>;
+declare function listInstalledDeliveryCarriers(): Promise<NonNullablePaths<ListInstalledDeliveryCarriersResponse, `installedDeliveryCarriers` | `installedDeliveryCarriers.${number}._id` | `installedDeliveryCarriers.${number}.displayName` | `installedDeliveryCarriers.${number}.toggleGetCarrierSettingsEnabled`, 4>>;
 /**
  * Get delivery carrier settings for a delivery profile and delivery region.
  * These are returned in a table format for the dashboard.
@@ -2012,7 +2009,7 @@ declare function listInstalledDeliveryCarriers(): Promise<NonNullablePaths<ListI
  * @applicableIdentity APP
  * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.ListDeliveryCarriers
  */
-declare function listDeliveryCarriers(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`> & {
+declare function listDeliveryCarriers(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;
 }>;
 interface ListDeliveryCarriersOptions {
@@ -2037,7 +2034,7 @@ interface ListDeliveryCarriersOptions {
  * @applicableIdentity APP
  * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.UpdateCarrierSettings
  */
-declare function updateCarrierSettings(carrierId: string, options: NonNullablePaths<UpdateCarrierSettingsOptions, `active` | `rowId`>): Promise<void & {
+declare function updateCarrierSettings(carrierId: string, options: NonNullablePaths<UpdateCarrierSettingsOptions, `active` | `rowId`, 2>): Promise<void & {
     __applicationErrorsType?: UpdateCarrierSettingsApplicationErrors;
 }>;
 interface UpdateCarrierSettingsOptions {
@@ -2063,7 +2060,7 @@ interface UpdateCarrierSettingsOptions {
  * @applicableIdentity APP
  * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.UpdateExtendedFields
  */
-declare function updateExtendedFields(_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`>): Promise<NonNullablePaths<UpdateExtendedFieldsResponse, `deliveryProfile.deliveryRegions`>>;
+declare function updateExtendedFields(_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`, 2>): Promise<NonNullablePaths<UpdateExtendedFieldsResponse, `deliveryProfile.deliveryRegions`, 3>>;
 interface UpdateExtendedFieldsOptions {
     /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
     namespaceData: Record<string, any> | null;