@shipengine/alchemy 2.3.0 → 2.3.1

package/index.js

@@ -5441,6 +5441,13 @@ class CarriersAPI {
     this.getCurrencies = (carrierId) => {
       return this.client.get(`/v1/carriers/${carrierId}/currencies`);
     };
+    /**
+     * The `getZones` method retrieves a list of zones for which the attached carrier
+     * provides support to.
+     */
+    this.getZones = (carrierId) => {
+      return this.client.get(`/v1/carriers/${carrierId}/zones`);
+    };
     this.client = client;
   }
 }
@@ -8778,6 +8785,23 @@ const useUpdateAutoFunding = (carrierId) => {
   });
 };
 
+const useGetZonesByCarrier = (carrierId) => {
+  const { client } = useShipEngine();
+  return reactQuery.useQuery({
+    enabled: !!carrierId,
+    onError,
+    queryFn: () => {
+      if (carrierId)
+        return client.carriers.getZones(carrierId);
+      return Promise.reject(new Error("carrierId is required"));
+    },
+    queryKey: ["useGetZonesByCarrier", carrierId],
+    select: (result) => result.data.zones,
+    // Fresh for 5 minutes
+    staleTime: 5 * 60 * 1e3
+  });
+};
+
 const useListCustomPackageTypes = () => {
   const { client } = useShipEngine();
   return reactQuery.useQuery({
@@ -10649,6 +10673,7 @@ exports.useGetServicesByCarrier = useGetServicesByCarrier;
 exports.useGetShipment = useGetShipment;
 exports.useGetShipmentRates = useGetShipmentRates;
 exports.useGetWalletHistory = useGetWalletHistory;
+exports.useGetZonesByCarrier = useGetZonesByCarrier;
 exports.useI18n = useI18n;
 exports.useListCarriers = useListCarriers;
 exports.useListCustomPackageTypes = useListCustomPackageTypes;

package/index.mjs

@@ -5419,6 +5419,13 @@ class CarriersAPI {
     this.getCurrencies = (carrierId) => {
       return this.client.get(`/v1/carriers/${carrierId}/currencies`);
     };
+    /**
+     * The `getZones` method retrieves a list of zones for which the attached carrier
+     * provides support to.
+     */
+    this.getZones = (carrierId) => {
+      return this.client.get(`/v1/carriers/${carrierId}/zones`);
+    };
     this.client = client;
   }
 }
@@ -8756,6 +8763,23 @@ const useUpdateAutoFunding = (carrierId) => {
   });
 };
 
+const useGetZonesByCarrier = (carrierId) => {
+  const { client } = useShipEngine();
+  return useQuery({
+    enabled: !!carrierId,
+    onError,
+    queryFn: () => {
+      if (carrierId)
+        return client.carriers.getZones(carrierId);
+      return Promise.reject(new Error("carrierId is required"));
+    },
+    queryKey: ["useGetZonesByCarrier", carrierId],
+    select: (result) => result.data.zones,
+    // Fresh for 5 minutes
+    staleTime: 5 * 60 * 1e3
+  });
+};
+
 const useListCustomPackageTypes = () => {
   const { client } = useShipEngine();
   return useQuery({
@@ -10554,4 +10578,4 @@ const alchemy = {
   createElement
 };
 
-export { AccountSettingsAPI, AddressesAPI, AlchemyContext, AlchemyProvider, AlchemyTestProvider, CarriersAPI, CodedError, ConfirmationType, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, Element, ElementContainerProvider, ErrorBoundary, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, LabelsAPI, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, ShipEngine, ShipEngineAPI, ShipEngineContext, ShipmentsAPI, WarehousesAPI, alchemy, alchemy as default, delay, getEndUserIpAddress, isCodedError, isCodedErrors, logger, memoizedCreateCache, onError, retryUntil, useAddFunds, useAlchemy, useCalculateRates, useConnectCarrier, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateWarehouse, useDeleteRateCard, useDeleteWarehouse, useDownloadRateCard, useElementContainer, useFundingSourcesAddFunds, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetInsuranceAccount, useGetLabel, useGetPackageRatingGroupByCarrier, useGetRateCardById, useGetSalesOrder, useGetSalesOrderShipment, useGetServicesByCarrier, useGetShipment, useGetShipmentRates, useGetWalletHistory, useI18n, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListOrderSources, useListRateCards, useListSalesOrderShipments, useListSalesOrders, useListShipments, useListWarehouses, useLoadFonts, useLoadIcons, useLoadTheme, useNotifySalesOrderShipped, useParseAddress, usePublishRateCard, useRefreshOrderSource, useRefreshOrderSourceAsync, useRegisterCarrier, useShipEngine, useUpdateAccountSettings, useUpdateAutoFunding, useUpdateFundingSource, useUpdateRateCard, useUpdateSalesOrderShipment, useUpdateWarehouse, useUploadRateCard, useValidateAddresses, useVoidLabel };
+export { AccountSettingsAPI, AddressesAPI, AlchemyContext, AlchemyProvider, AlchemyTestProvider, CarriersAPI, CodedError, ConfirmationType, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, Element, ElementContainerProvider, ErrorBoundary, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, LabelsAPI, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, ShipEngine, ShipEngineAPI, ShipEngineContext, ShipmentsAPI, WarehousesAPI, alchemy, alchemy as default, delay, getEndUserIpAddress, isCodedError, isCodedErrors, logger, memoizedCreateCache, onError, retryUntil, useAddFunds, useAlchemy, useCalculateRates, useConnectCarrier, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateWarehouse, useDeleteRateCard, useDeleteWarehouse, useDownloadRateCard, useElementContainer, useFundingSourcesAddFunds, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetInsuranceAccount, useGetLabel, useGetPackageRatingGroupByCarrier, useGetRateCardById, useGetSalesOrder, useGetSalesOrderShipment, useGetServicesByCarrier, useGetShipment, useGetShipmentRates, useGetWalletHistory, useGetZonesByCarrier, useI18n, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListOrderSources, useListRateCards, useListSalesOrderShipments, useListSalesOrders, useListShipments, useListWarehouses, useLoadFonts, useLoadIcons, useLoadTheme, useNotifySalesOrderShipped, useParseAddress, usePublishRateCard, useRefreshOrderSource, useRefreshOrderSourceAsync, useRegisterCarrier, useShipEngine, useUpdateAccountSettings, useUpdateAutoFunding, useUpdateFundingSource, useUpdateRateCard, useUpdateSalesOrderShipment, useUpdateWarehouse, useUploadRateCard, useValidateAddresses, useVoidLabel };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/alchemy",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {