@wix/auto_sdk_ecom_delivery-profile 1.0.75 → 1.0.76

package/build/internal/cjs/index.typings.d.ts

@@ -620,6 +620,47 @@ interface RequiredZipcodeResponse {
     /** If the site requires a zipcode for delivery */
     requiredZipcode?: boolean;
 }
+interface GetDeliveryDestinationPropertiesRequest {
+}
+interface GetDeliveryDestinationPropertiesResponse {
+    /** Delivery destination properties for Rest Of World */
+    restOfWorld?: DeliveryDestinationProperties;
+    /**
+     * List of countries and subdivisions and their delivery destination properties
+     * @maxSize 195
+     */
+    countries?: CountryDeliveryProperties[];
+}
+interface DeliveryDestinationProperties {
+    /** True if postal code is required for delivery in this destination */
+    postalCodeRequired?: boolean;
+    /** True if only pickup is available in this destination */
+    pickupOnly?: boolean;
+}
+interface CountryDeliveryProperties {
+    /**
+     * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
+     * @format COUNTRY
+     */
+    country?: string;
+    /** Delivery destination properties for country */
+    deliveryDestinationProperties?: DeliveryDestinationProperties;
+    /**
+     * List of subdivisions and their delivery destination properties
+     * @maxSize 100
+     */
+    subdivisions?: SubdivisionDeliveryProperties[];
+}
+interface SubdivisionDeliveryProperties {
+    /**
+     * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
+     * @minLength 1
+     * @maxLength 5
+     */
+    subdivision?: string;
+    /** Delivery destination properties for subdivision */
+    deliveryDestinationProperties?: DeliveryDestinationProperties;
+}
 interface ListDeliveryCarriersRequest {
     /**
      * Delivery profile id.
@@ -2008,6 +2049,15 @@ interface UpdateDeliveryCarrierOptions {
  * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.ListInstalledDeliveryCarriers
  */
 declare function listInstalledDeliveryCarriers(): Promise<NonNullablePaths<ListInstalledDeliveryCarriersResponse, `installedDeliveryCarriers` | `installedDeliveryCarriers.${number}._id` | `installedDeliveryCarriers.${number}.displayName` | `installedDeliveryCarriers.${number}.toggleGetCarrierSettingsEnabled`, 4>>;
+/**
+ * Retrieves delivery destination properties by ROW, and aggregated country and subdivision
+ * @public
+ * @documentationMaturity preview
+ * @permissionId ECOM.DELIVERY_PROFILE_READ
+ * @applicableIdentity APP
+ * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.GetDeliveryDestinationProperties
+ */
+declare function getDeliveryDestinationProperties(): Promise<NonNullablePaths<GetDeliveryDestinationPropertiesResponse, `restOfWorld.postalCodeRequired` | `restOfWorld.pickupOnly` | `countries` | `countries.${number}.country` | `countries.${number}.deliveryDestinationProperties.postalCodeRequired` | `countries.${number}.deliveryDestinationProperties.pickupOnly`, 5>>;
 /**
  * Get delivery carrier settings for a delivery profile and delivery region.
  * These are returned in a table format for the dashboard.
@@ -2076,4 +2126,4 @@ interface UpdateExtendedFieldsOptions {
     namespaceData: Record<string, any> | null;
 }
 
-export { 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 BulkActionMetadata, ChargeType, type ChargeTypeWithLiterals, type Column, type CreateDeliveryProfileApplicationErrors, type CreateDeliveryProfileRequest, type CreateDeliveryProfileResponse, type CreateDeliveryProfileValidationErrors, 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 DeliveryProfile, 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 ExtendedFields, 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 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, getDeliveryProfile, getDeliveryProfileByDeliveryRegionId, listDeliveryCarriers, listInstalledDeliveryCarriers, queryDeliveryProfiles, removeDeliveryCarrier, removeDeliveryRegion, updateCarrierSettings, updateDeliveryCarrier, updateDeliveryProfile, updateDeliveryRegion, updateExtendedFields };
+export { 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 BulkActionMetadata, ChargeType, type ChargeTypeWithLiterals, type Column, type CountryDeliveryProperties, type CreateDeliveryProfileApplicationErrors, type CreateDeliveryProfileRequest, type CreateDeliveryProfileResponse, type CreateDeliveryProfileValidationErrors, 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 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 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, queryDeliveryProfiles, removeDeliveryCarrier, removeDeliveryRegion, updateCarrierSettings, updateDeliveryCarrier, updateDeliveryProfile, updateDeliveryRegion, updateExtendedFields };

package/build/internal/cjs/index.typings.js

@@ -32,6 +32,7 @@ __export(index_typings_exports, {
   addDeliveryRegion: () => addDeliveryRegion2,
   createDeliveryProfile: () => createDeliveryProfile2,
   deleteDeliveryProfile: () => deleteDeliveryProfile2,
+  getDeliveryDestinationProperties: () => getDeliveryDestinationProperties2,
   getDeliveryProfile: () => getDeliveryProfile2,
   getDeliveryProfileByDeliveryRegionId: () => getDeliveryProfileByDeliveryRegionId2,
   listDeliveryCarriers: () => listDeliveryCarriers2,
@@ -547,6 +548,27 @@ function listInstalledDeliveryCarriers(payload) {
   }
   return __listInstalledDeliveryCarriers;
 }
+function getDeliveryDestinationProperties(payload) {
+  function __getDeliveryDestinationProperties({ host }) {
+    const metadata = {
+      entityFqdn: "wix.ecom.v1.delivery_profile",
+      method: "GET",
+      methodFqn: "wix.ecom.deliveryprofile.v1.DeliveryProfiles.GetDeliveryDestinationProperties",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixEcomDeliveryprofileV1DeliveryProfilesUrl({
+        protoPath: "/v1/delivery-profiles/delivery-destination-properties",
+        data: payload,
+        host
+      }),
+      params: (0, import_rest_modules.toURLSearchParams)(payload)
+    };
+    return metadata;
+  }
+  return __getDeliveryDestinationProperties;
+}
 function listDeliveryCarriers(payload) {
   function __listDeliveryCarriers({ host }) {
     const metadata = {
@@ -1079,6 +1101,31 @@ async function listInstalledDeliveryCarriers2() {
     throw transformedError;
   }
 }
+async function getDeliveryDestinationProperties2() {
+  const { httpClient, sideEffects } = arguments[0];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({});
+  const reqOpts = getDeliveryDestinationProperties(
+    payload
+  );
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: {},
+        singleArgumentUnchanged: false
+      },
+      []
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
 async function listDeliveryCarriers2(deliveryProfileId, options) {
   const { httpClient, sideEffects } = arguments[2];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
@@ -1184,6 +1231,7 @@ async function updateExtendedFields2(_id, namespace, options) {
   addDeliveryRegion,
   createDeliveryProfile,
   deleteDeliveryProfile,
+  getDeliveryDestinationProperties,
   getDeliveryProfile,
   getDeliveryProfileByDeliveryRegionId,
   listDeliveryCarriers,