@shipengine/react-api 0.22.1 → 0.23.1

package/hooks/carriers/index.d.ts

@@ -9,3 +9,4 @@ export * from "./use-get-services-by-carrier";
 export * from "./use-get-wallet-history";
 export * from "./use-list-carriers";
 export * from "./use-update-auto-funding";
+export * from "./use-get-zones-by-carrier";

package/hooks/carriers/use-get-zones-by-carrier.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @category ShipEngine API Hooks
+ */
+export declare const useGetZonesByCarrier: (carrierId?: string) => import("react-query").UseQueryResult<import("@shipengine/js-api").CarrierZone[], import("@shipengine/js-api").CodedError[]>;

package/index.js

@@ -448,6 +448,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({
@@ -1507,6 +1524,7 @@ exports.useGetServicesByCarrier = useGetServicesByCarrier;
 exports.useGetShipment = useGetShipment;
 exports.useGetShipmentRates = useGetShipmentRates;
 exports.useGetWalletHistory = useGetWalletHistory;
+exports.useGetZonesByCarrier = useGetZonesByCarrier;
 exports.useListCarriers = useListCarriers;
 exports.useListCustomPackageTypes = useListCustomPackageTypes;
 exports.useListFundingSources = useListFundingSources;

package/index.mjs

@@ -445,6 +445,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({
@@ -1469,4 +1486,4 @@ const useUpdateWarehouse = () => {
   });
 };
 
-export { ShipEngine, ShipEngineContext, delay, logger, onError, retryUntil, useAddFunds, useCalculateRates, useConnectCarrier, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateWarehouse, useDeleteRateCard, useDeleteWarehouse, useDownloadRateCard, useFundingSourcesAddFunds, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetInsuranceAccount, useGetLabel, useGetPackageRatingGroupByCarrier, useGetRateCardById, useGetSalesOrder, useGetSalesOrderShipment, useGetServicesByCarrier, useGetShipment, useGetShipmentRates, useGetWalletHistory, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListOrderSources, useListRateCards, useListSalesOrderShipments, useListSalesOrders, useListShipments, useListWarehouses, useNotifySalesOrderShipped, useParseAddress, usePublishRateCard, useRefreshOrderSource, useRefreshOrderSourceAsync, useRegisterCarrier, useShipEngine, useUpdateAccountSettings, useUpdateAutoFunding, useUpdateFundingSource, useUpdateRateCard, useUpdateSalesOrderShipment, useUpdateWarehouse, useUploadRateCard, useValidateAddresses, useVoidLabel };
+export { ShipEngine, ShipEngineContext, delay, logger, onError, retryUntil, useAddFunds, useCalculateRates, useConnectCarrier, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateWarehouse, useDeleteRateCard, useDeleteWarehouse, useDownloadRateCard, useFundingSourcesAddFunds, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetInsuranceAccount, useGetLabel, useGetPackageRatingGroupByCarrier, useGetRateCardById, useGetSalesOrder, useGetSalesOrderShipment, useGetServicesByCarrier, useGetShipment, useGetShipmentRates, useGetWalletHistory, useGetZonesByCarrier, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListOrderSources, useListRateCards, useListSalesOrderShipments, useListSalesOrders, useListShipments, useListWarehouses, 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/react-api",
-  "version": "0.22.1",
+  "version": "0.23.1",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {