@shipengine/react-api 0.5.0 → 0.5.1

package/hooks/index.d.ts

@@ -24,6 +24,7 @@ export * from "./use-list-warehouses";
 export * from "./use-notify-sales-order";
 export * from "./use-parse-address";
 export * from "./use-refresh-order-source";
+export * from "./use-get-shipment-rates";
 export * from "./use-update-account-settings";
 export * from "./use-update-auto-funding";
 export * from "./use-update-billing";

package/hooks/use-get-shipment-rates.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine Developer Docs](https://shipengine.github.io/shipengine-openapi/#operation/list_shipment_rates)
+ */
+export declare const useGetShipmentRates: (shipmentId: string, createdAtStart?: string) => import("react-query").UseQueryResult<import("@shipengine/js-api").ShipmentRateResponse, import("@shipengine/js-api").CodedError[]>;

package/index.js

@@ -709,6 +709,22 @@ const useRefreshOrderSource = () => {
   });
 };
 
+const useGetShipmentRates = (shipmentId, createdAtStart) => {
+  const { client } = useShipEngine();
+  return reactQuery.useQuery({
+    enabled: shipmentId !== void 0,
+    onError,
+    queryFn: () => {
+      if (shipmentId) {
+        return client.shipments.getShipmentRates({ createdAtStart, shipmentId });
+      }
+      return Promise.reject(new Error("shipmentId is required"));
+    },
+    queryKey: ["useGetShipmentRates", shipmentId, createdAtStart],
+    select: (result) => result.data
+  });
+};
+
 var __async$6 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
@@ -998,6 +1014,7 @@ exports.useGetLabel = useGetLabel;
 exports.useGetSalesOrder = useGetSalesOrder;
 exports.useGetSalesOrderShipment = useGetSalesOrderShipment;
 exports.useGetShipment = useGetShipment;
+exports.useGetShipmentRates = useGetShipmentRates;
 exports.useGetWalletHistory = useGetWalletHistory;
 exports.useListCarriers = useListCarriers;
 exports.useListCustomPackageTypes = useListCustomPackageTypes;

package/index.mjs

@@ -706,6 +706,22 @@ const useRefreshOrderSource = () => {
   });
 };
 
+const useGetShipmentRates = (shipmentId, createdAtStart) => {
+  const { client } = useShipEngine();
+  return useQuery({
+    enabled: shipmentId !== void 0,
+    onError,
+    queryFn: () => {
+      if (shipmentId) {
+        return client.shipments.getShipmentRates({ createdAtStart, shipmentId });
+      }
+      return Promise.reject(new Error("shipmentId is required"));
+    },
+    queryKey: ["useGetShipmentRates", shipmentId, createdAtStart],
+    select: (result) => result.data
+  });
+};
+
 var __async$6 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
@@ -974,4 +990,4 @@ const useVoidLabel = () => {
   });
 };
 
-export { ShipEngine, ShipEngineContext, delay, logger, onError, retryUntil, useAddFunds, useCalculateRates, useConnectCarrier, useCreateLabel, useCreateSalesOrderShipment, useCreateWarehouse, useDeleteWarehouse, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetInsuranceAccount, useGetLabel, useGetSalesOrder, useGetSalesOrderShipment, useGetShipment, useGetWalletHistory, useListCarriers, useListCustomPackageTypes, useListLabels, useListOrderSources, useListSalesOrderShipments, useListSalesOrders, useListWarehouses, useNotifySalesOrderShipped, useParseAddress, useRefreshOrderSource, useRefreshOrderSourceAsync, useShipEngine, useUpdateAccountSettings, useUpdateAutoFunding, useUpdateBilling, useUpdateSalesOrderShipment, useUpdateWarehouse, useValidateAddresses, useVoidLabel };
+export { ShipEngine, ShipEngineContext, delay, logger, onError, retryUntil, useAddFunds, useCalculateRates, useConnectCarrier, useCreateLabel, useCreateSalesOrderShipment, useCreateWarehouse, useDeleteWarehouse, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetInsuranceAccount, useGetLabel, useGetSalesOrder, useGetSalesOrderShipment, useGetShipment, useGetShipmentRates, useGetWalletHistory, useListCarriers, useListCustomPackageTypes, useListLabels, useListOrderSources, useListSalesOrderShipments, useListSalesOrders, useListWarehouses, useNotifySalesOrderShipped, useParseAddress, useRefreshOrderSource, useRefreshOrderSourceAsync, useShipEngine, useUpdateAccountSettings, useUpdateAutoFunding, useUpdateBilling, useUpdateSalesOrderShipment, useUpdateWarehouse, useValidateAddresses, useVoidLabel };

package/package.json

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