@wix/auto_sdk_ecom_delivery-profile 1.0.95 → 1.0.96

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

@@ -827,6 +827,22 @@ interface UpdateCarrierSettingsRequest {
 }
 interface UpdateCarrierSettingsResponse {
 }
+interface SetDeliveryCarrierActiveStatusRequest {
+    /**
+     * Carrier app ID.
+     * @format GUID
+     */
+    carrierAppId: string;
+    /**
+     * Row ID that triggered the change.
+     * @format GUID
+     */
+    rowId: string;
+    /** Whether the configuration defined in the row is active. */
+    active: boolean | null;
+}
+interface SetDeliveryCarrierActiveStatusResponse {
+}
 interface UpdateExtendedFieldsRequest {
     /** ID of the entity to update. */
     _id: string;
@@ -1637,6 +1653,12 @@ type UpdateCarrierSettingsApplicationErrors = {
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
+type SetDeliveryCarrierActiveStatusApplicationErrors = {
+    code?: 'DELIVERY_CARRIER_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+};
 interface BaseEventMetadata {
     /**
      * App instance ID.
@@ -2373,6 +2395,31 @@ interface UpdateCarrierSettingsOptions {
     /** New status */
     active: boolean | null;
 }
+/**
+ * Sets delivery carrier's active status.
+ * @param carrierAppId - Carrier app ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField carrierAppId
+ * @requiredField options
+ * @requiredField options.active
+ * @requiredField options.rowId
+ * @permissionId ECOM.DELIVERY_CARRIER_UPDATE
+ * @applicableIdentity APP
+ * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.SetDeliveryCarrierActiveStatus
+ */
+declare function setDeliveryCarrierActiveStatus(carrierAppId: string, options: NonNullablePaths<SetDeliveryCarrierActiveStatusOptions, `active` | `rowId`, 2>): Promise<void & {
+    __applicationErrorsType?: SetDeliveryCarrierActiveStatusApplicationErrors;
+}>;
+interface SetDeliveryCarrierActiveStatusOptions {
+    /**
+     * Row ID that triggered the change.
+     * @format GUID
+     */
+    rowId: string;
+    /** Whether the configuration defined in the row is active. */
+    active: boolean | null;
+}
 /**
  * Updates extended fields of a DeliveryProfile without incrementing revision
  * @param _id - ID of the entity to update.
@@ -2393,4 +2440,4 @@ interface UpdateExtendedFieldsOptions {
     namespaceData: Record<string, any> | null;
 }
 
-export { type AccountDetails, type ActionEvent, type AddDeliveryCarrierApplicationErrors, type AddDeliveryCarrierOptions, type AddDeliveryCarrierRequest, type AddDeliveryCarrierResponse, type AddDeliveryCarrierValidationErrors, type AddDeliveryRegionApplicationErrors, type AddDeliveryRegionOptions, type AddDeliveryRegionRequest, type AddDeliveryRegionResponse, type AddDeliveryRegionValidationErrors, type AdditionalCharge, type ApplicationError, type Asset, type BackupRate, type BaseEventMetadata, type BulkActionMetadata, ChargeType, type ChargeTypeWithLiterals, type Column, type CommonQueryWithEntityContext, type CountryDeliveryProperties, type CreateDeliveryProfileApplicationErrors, type CreateDeliveryProfileRequest, type CreateDeliveryProfileResponse, type CreatedBy, type CreatedByIdOneOf, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DashboardTable, type DeleteContext, type DeleteDefaultDeliveryProfileRequest, type DeleteDefaultDeliveryProfileResponse, type DeleteDeliveryProfileRequest, type DeleteDeliveryProfileResponse, DeleteStatus, type DeleteStatusWithLiterals, type DeliveryCarrier, type DeliveryCarrierDetails, type DeliveryCarrierRegionalSettings, type DeliveryDestinationProperties, type DeliveryProfile, type DeliveryProfileCreatedEnvelope, type DeliveryProfileDeletedEnvelope, type DeliveryProfileQuery, type DeliveryProfileQuerySpec, type DeliveryProfileRegionAddedEnvelope, type DeliveryProfileRegionRemovedEnvelope, type DeliveryProfileRegionUpdatedEnvelope, type DeliveryProfileUpdatedEnvelope, type DeliveryProfilesQueryBuilder, type DeliveryProfilesQueryResult, type DeliveryRegion, type DeliveryRegionAdded, type DeliveryRegionRemoved, type DeliveryRegionUpdated, type Destination, DestinationScope, type DestinationScopeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type GetDeliveryDestinationPropertiesRequest, type GetDeliveryDestinationPropertiesResponse, type GetDeliveryProfileByDeliveryRegionIdApplicationErrors, type GetDeliveryProfileByDeliveryRegionIdRequest, type GetDeliveryProfileByDeliveryRegionIdResponse, type GetDeliveryProfileRequest, type GetDeliveryProfileResponse, type IdentificationData, type IdentificationDataIdOneOf, type InstalledDeliveryCarrier, type ItemMetadata, type ListDeliveryCarriersApplicationErrors, type ListDeliveryCarriersOptions, type ListDeliveryCarriersRequest, type ListDeliveryCarriersResponse, type ListDeliveryCarriersResult, type ListDeliveryDestinationsRequest, type ListDeliveryDestinationsResponse, type ListInstalledDeliveryCarriersRequest, type ListInstalledDeliveryCarriersResponse, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type OdeditorAssigned, type OdeditorUnassigned, type PicassoAssigned, type PicassoUnassigned, type QueryDeliveryProfilesRequest, type QueryDeliveryProfilesResponse, type RemoveDeliveryCarrierApplicationErrors, type RemoveDeliveryCarrierOptions, type RemoveDeliveryCarrierRequest, type RemoveDeliveryCarrierResponse, type RemoveDeliveryRegionApplicationErrors, type RemoveDeliveryRegionIdentifiers, type RemoveDeliveryRegionOptions, type RemoveDeliveryRegionRequest, type RemoveDeliveryRegionResponse, type RequiredZipcodeRequest, type RequiredZipcodeResponse, type RestoreInfo, type Row, type ServiceProvisioned, type ServiceRemoved, type SiteCreated, SiteCreatedContext, type SiteCreatedContextWithLiterals, type SiteDeleted, type SiteHardDeleted, type SiteMarkedAsTemplate, type SiteMarkedAsWixSite, type SitePublished, type SitePurgedExternally, type SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, type SiteUrlChanged, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, type StudioAssigned, type StudioTwoAssigned, type StudioTwoUnassigned, type StudioUnassigned, type SubdivisionDeliveryProperties, type UpdateCarrierSettingsApplicationErrors, type UpdateCarrierSettingsOptions, type UpdateCarrierSettingsRequest, type UpdateCarrierSettingsResponse, type UpdateDeliveryCarrierApplicationErrors, type UpdateDeliveryCarrierOptions, type UpdateDeliveryCarrierRequest, type UpdateDeliveryCarrierResponse, type UpdateDeliveryProfile, type UpdateDeliveryProfileApplicationErrors, type UpdateDeliveryProfileRequest, type UpdateDeliveryProfileResponse, type UpdateDeliveryRegion, type UpdateDeliveryRegionApplicationErrors, type UpdateDeliveryRegionIdentifiers, type UpdateDeliveryRegionOptions, type UpdateDeliveryRegionRequest, type UpdateDeliveryRegionResponse, type UpdateDeliveryRegionValidationErrors, type UpdateExtendedFieldsOptions, type UpdateExtendedFieldsRequest, type UpdateExtendedFieldsResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixelAssigned, type WixelUnassigned, addDeliveryCarrier, addDeliveryRegion, createDeliveryProfile, deleteDeliveryProfile, getDeliveryDestinationProperties, getDeliveryProfile, getDeliveryProfileByDeliveryRegionId, listDeliveryCarriers, listInstalledDeliveryCarriers, onDeliveryProfileCreated, onDeliveryProfileDeleted, onDeliveryProfileRegionAdded, onDeliveryProfileRegionRemoved, onDeliveryProfileRegionUpdated, onDeliveryProfileUpdated, queryDeliveryProfiles, removeDeliveryCarrier, removeDeliveryRegion, typedQueryDeliveryProfiles, updateDeliveryCarrier, updateDeliveryProfile, updateDeliveryRegion, updateExtendedFields };
+export { type AccountDetails, type ActionEvent, type AddDeliveryCarrierApplicationErrors, type AddDeliveryCarrierOptions, type AddDeliveryCarrierRequest, type AddDeliveryCarrierResponse, type AddDeliveryCarrierValidationErrors, type AddDeliveryRegionApplicationErrors, type AddDeliveryRegionOptions, type AddDeliveryRegionRequest, type AddDeliveryRegionResponse, type AddDeliveryRegionValidationErrors, type AdditionalCharge, type ApplicationError, type Asset, type BackupRate, type BaseEventMetadata, type BulkActionMetadata, ChargeType, type ChargeTypeWithLiterals, type Column, type CommonQueryWithEntityContext, type CountryDeliveryProperties, type CreateDeliveryProfileApplicationErrors, type CreateDeliveryProfileRequest, type CreateDeliveryProfileResponse, type CreatedBy, type CreatedByIdOneOf, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DashboardTable, type DeleteContext, type DeleteDefaultDeliveryProfileRequest, type DeleteDefaultDeliveryProfileResponse, type DeleteDeliveryProfileRequest, type DeleteDeliveryProfileResponse, DeleteStatus, type DeleteStatusWithLiterals, type DeliveryCarrier, type DeliveryCarrierDetails, type DeliveryCarrierRegionalSettings, type DeliveryDestinationProperties, type DeliveryProfile, type DeliveryProfileCreatedEnvelope, type DeliveryProfileDeletedEnvelope, type DeliveryProfileQuery, type DeliveryProfileQuerySpec, type DeliveryProfileRegionAddedEnvelope, type DeliveryProfileRegionRemovedEnvelope, type DeliveryProfileRegionUpdatedEnvelope, type DeliveryProfileUpdatedEnvelope, type DeliveryProfilesQueryBuilder, type DeliveryProfilesQueryResult, type DeliveryRegion, type DeliveryRegionAdded, type DeliveryRegionRemoved, type DeliveryRegionUpdated, type Destination, DestinationScope, type DestinationScopeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type GetDeliveryDestinationPropertiesRequest, type GetDeliveryDestinationPropertiesResponse, type GetDeliveryProfileByDeliveryRegionIdApplicationErrors, type GetDeliveryProfileByDeliveryRegionIdRequest, type GetDeliveryProfileByDeliveryRegionIdResponse, type GetDeliveryProfileRequest, type GetDeliveryProfileResponse, type IdentificationData, type IdentificationDataIdOneOf, type InstalledDeliveryCarrier, type ItemMetadata, type ListDeliveryCarriersApplicationErrors, type ListDeliveryCarriersOptions, type ListDeliveryCarriersRequest, type ListDeliveryCarriersResponse, type ListDeliveryCarriersResult, type ListDeliveryDestinationsRequest, type ListDeliveryDestinationsResponse, type ListInstalledDeliveryCarriersRequest, type ListInstalledDeliveryCarriersResponse, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type OdeditorAssigned, type OdeditorUnassigned, type PicassoAssigned, type PicassoUnassigned, type QueryDeliveryProfilesRequest, type QueryDeliveryProfilesResponse, type RemoveDeliveryCarrierApplicationErrors, type RemoveDeliveryCarrierOptions, type RemoveDeliveryCarrierRequest, type RemoveDeliveryCarrierResponse, type RemoveDeliveryRegionApplicationErrors, type RemoveDeliveryRegionIdentifiers, type RemoveDeliveryRegionOptions, type RemoveDeliveryRegionRequest, type RemoveDeliveryRegionResponse, type RequiredZipcodeRequest, type RequiredZipcodeResponse, type RestoreInfo, type Row, type ServiceProvisioned, type ServiceRemoved, type SetDeliveryCarrierActiveStatusApplicationErrors, type SetDeliveryCarrierActiveStatusOptions, type SetDeliveryCarrierActiveStatusRequest, type SetDeliveryCarrierActiveStatusResponse, type SiteCreated, SiteCreatedContext, type SiteCreatedContextWithLiterals, type SiteDeleted, type SiteHardDeleted, type SiteMarkedAsTemplate, type SiteMarkedAsWixSite, type SitePublished, type SitePurgedExternally, type SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, type SiteUrlChanged, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, type StudioAssigned, type StudioTwoAssigned, type StudioTwoUnassigned, type StudioUnassigned, type SubdivisionDeliveryProperties, type UpdateCarrierSettingsApplicationErrors, type UpdateCarrierSettingsOptions, type UpdateCarrierSettingsRequest, type UpdateCarrierSettingsResponse, type UpdateDeliveryCarrierApplicationErrors, type UpdateDeliveryCarrierOptions, type UpdateDeliveryCarrierRequest, type UpdateDeliveryCarrierResponse, type UpdateDeliveryProfile, type UpdateDeliveryProfileApplicationErrors, type UpdateDeliveryProfileRequest, type UpdateDeliveryProfileResponse, type UpdateDeliveryRegion, type UpdateDeliveryRegionApplicationErrors, type UpdateDeliveryRegionIdentifiers, type UpdateDeliveryRegionOptions, type UpdateDeliveryRegionRequest, type UpdateDeliveryRegionResponse, type UpdateDeliveryRegionValidationErrors, type UpdateExtendedFieldsOptions, type UpdateExtendedFieldsRequest, type UpdateExtendedFieldsResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixelAssigned, type WixelUnassigned, addDeliveryCarrier, addDeliveryRegion, createDeliveryProfile, deleteDeliveryProfile, getDeliveryDestinationProperties, getDeliveryProfile, getDeliveryProfileByDeliveryRegionId, listDeliveryCarriers, listInstalledDeliveryCarriers, onDeliveryProfileCreated, onDeliveryProfileDeleted, onDeliveryProfileRegionAdded, onDeliveryProfileRegionRemoved, onDeliveryProfileRegionUpdated, onDeliveryProfileUpdated, queryDeliveryProfiles, removeDeliveryCarrier, removeDeliveryRegion, setDeliveryCarrierActiveStatus, typedQueryDeliveryProfiles, updateDeliveryCarrier, updateDeliveryProfile, updateDeliveryRegion, updateExtendedFields };

package/build/es/index.typings.mjs

@@ -568,6 +568,27 @@ function updateCarrierSettings(payload) {
   }
   return __updateCarrierSettings;
 }
+function setDeliveryCarrierActiveStatus(payload) {
+  function __setDeliveryCarrierActiveStatus({ host }) {
+    const metadata = {
+      entityFqdn: "wix.ecom.v1.delivery_profile",
+      method: "POST",
+      methodFqn: "wix.ecom.deliveryprofile.v1.DeliveryProfiles.SetDeliveryCarrierActiveStatus",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixEcomDeliveryprofileV1DeliveryProfilesUrl({
+        protoPath: "/v1/delivery-profiles/delivery-carriers/set-active-status",
+        data: payload,
+        host
+      }),
+      data: payload
+    };
+    return metadata;
+  }
+  return __setDeliveryCarrierActiveStatus;
+}
 function updateExtendedFields(payload) {
   function __updateExtendedFields({ host }) {
     const metadata = {
@@ -1167,6 +1188,37 @@ async function updateCarrierSettings2(carrierId, options) {
     throw transformedError;
   }
 }
+async function setDeliveryCarrierActiveStatus2(carrierAppId, options) {
+  const { httpClient, sideEffects } = arguments[2];
+  const payload = renameKeysFromSDKRequestToRESTRequest({
+    carrierAppId,
+    rowId: options?.rowId,
+    active: options?.active
+  });
+  const reqOpts = setDeliveryCarrierActiveStatus(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return renameKeysFromRESTResponseToSDKResponse(result.data);
+  } catch (err) {
+    const transformedError = sdkTransformError(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: {
+          carrierAppId: "$[0]",
+          rowId: "$[1].rowId",
+          active: "$[1].active"
+        },
+        singleArgumentUnchanged: false
+      },
+      ["carrierAppId", "options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
 async function updateExtendedFields2(_id, namespace, options) {
   const { httpClient, sideEffects } = arguments[3];
   const payload = renameKeysFromSDKRequestToRESTRequest({
@@ -1219,6 +1271,7 @@ export {
   queryDeliveryProfiles2 as queryDeliveryProfiles,
   removeDeliveryCarrier2 as removeDeliveryCarrier,
   removeDeliveryRegion2 as removeDeliveryRegion,
+  setDeliveryCarrierActiveStatus2 as setDeliveryCarrierActiveStatus,
   typedQueryDeliveryProfiles,
   updateCarrierSettings2 as updateCarrierSettings,
   updateDeliveryCarrier2 as updateDeliveryCarrier,