@shipengine/react-api 0.14.1 → 0.15.0

package/hooks/index.d.ts

@@ -8,6 +8,7 @@ export * from "./use-create-sales-order-shipment";
 export * from "./use-create-shipment";
 export * from "./use-create-warehouse";
 export * from "./use-delete-warehouse";
+export * from "./use-download-rate-card";
 export * from "./use-get-account-settings";
 export * from "./use-get-auto-funding-configuration";
 export * from "./use-get-carrier-by-id";

package/hooks/use-download-rate-card.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @category ShipEngine API Hooks
+ *
+ */
+export declare const useDownloadRateCard: (rateCardId: string) => import("react-query").UseQueryResult<Blob, import("@shipengine/js-api").CodedError[]>;

package/index.js

@@ -503,6 +503,19 @@ const useDeleteWarehouse = () => {
   });
 };
 
+const useDownloadRateCard = (rateCardId) => {
+  const { client } = useShipEngine();
+  return reactQuery.useQuery({
+    enabled: !!rateCardId.length,
+    onError,
+    queryFn: () => {
+      return client.rateCards.download(rateCardId);
+    },
+    queryKey: ["useDownloadRateCard", rateCardId],
+    select: (result) => result.data
+  });
+};
+
 const useGetAccountSettings = () => {
   const { client } = useShipEngine();
   return reactQuery.useQuery({
@@ -1336,6 +1349,7 @@ exports.useCreateSalesOrderShipment = useCreateSalesOrderShipment;
 exports.useCreateShipment = useCreateShipment;
 exports.useCreateWarehouse = useCreateWarehouse;
 exports.useDeleteWarehouse = useDeleteWarehouse;
+exports.useDownloadRateCard = useDownloadRateCard;
 exports.useGetAccountSettings = useGetAccountSettings;
 exports.useGetAutoFundingConfiguration = useGetAutoFundingConfiguration;
 exports.useGetCarrierById = useGetCarrierById;

package/index.mjs

@@ -500,6 +500,19 @@ const useDeleteWarehouse = () => {
   });
 };
 
+const useDownloadRateCard = (rateCardId) => {
+  const { client } = useShipEngine();
+  return useQuery({
+    enabled: !!rateCardId.length,
+    onError,
+    queryFn: () => {
+      return client.rateCards.download(rateCardId);
+    },
+    queryKey: ["useDownloadRateCard", rateCardId],
+    select: (result) => result.data
+  });
+};
+
 const useGetAccountSettings = () => {
   const { client } = useShipEngine();
   return useQuery({
@@ -1317,4 +1330,4 @@ const useVoidLabel = () => {
   });
 };
 
-export { ShipEngine, ShipEngineContext, delay, logger, onError, retryUntil, useAddFunds, useCalculateRates, useConnectCarrier, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateWarehouse, useDeleteWarehouse, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetInsuranceAccount, useGetLabel, useGetRatePackageFormatsByCarrier, useGetSalesOrder, useGetSalesOrderShipment, useGetServicesByCarrier, useGetShipment, useGetShipmentRates, useGetWalletHistory, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListOrderSources, useListRateCards, useListSalesOrderShipments, useListSalesOrders, useListShipments, useListWarehouses, useNotifySalesOrderShipped, useParseAddress, useRefreshOrderSource, useRefreshOrderSourceAsync, useRegisterCarrier, useShipEngine, useUpdateAccountSettings, useUpdateAutoFunding, useUpdateFundingSource, useUpdateRateCard, useUpdateSalesOrderShipment, useUpdateWarehouse, useValidateAddresses, useVoidLabel };
+export { ShipEngine, ShipEngineContext, delay, logger, onError, retryUntil, useAddFunds, useCalculateRates, useConnectCarrier, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateWarehouse, useDeleteWarehouse, useDownloadRateCard, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetInsuranceAccount, useGetLabel, useGetRatePackageFormatsByCarrier, useGetSalesOrder, useGetSalesOrderShipment, useGetServicesByCarrier, useGetShipment, useGetShipmentRates, useGetWalletHistory, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListOrderSources, useListRateCards, useListSalesOrderShipments, useListSalesOrders, useListShipments, useListWarehouses, useNotifySalesOrderShipped, useParseAddress, useRefreshOrderSource, useRefreshOrderSourceAsync, useRegisterCarrier, useShipEngine, useUpdateAccountSettings, useUpdateAutoFunding, useUpdateFundingSource, useUpdateRateCard, useUpdateSalesOrderShipment, useUpdateWarehouse, useValidateAddresses, useVoidLabel };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/react-api",
-  "version": "0.14.1",
+  "version": "0.15.0",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {