@shipengine/react-api 1.11.2 → 1.11.3

package/hooks/shipping-rules/index.d.ts

@@ -3,3 +3,4 @@ export * from "./use-create-shipping-rule";
 export * from "./use-delete-shipping-rule";
 export * from "./use-edit-shipping-rule";
 export * from "./use-get-shipping-rule-conditions-options";
+export * from "./use-get-shipping-rule-by-id";

package/hooks/shipping-rules/use-get-shipping-rule-by-id.d.ts

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

package/index.js

@@ -1628,6 +1628,19 @@ const useGetShippingRuleConditionsOptions = () => {
   });
 };
 
+const useGetShippingRuleById = (shippingRuleId) => {
+  const { client } = useShipEngine();
+  return reactQuery.useQuery({
+    enabled: !!shippingRuleId,
+    onError,
+    queryFn: () => {
+      return client.shippingRules.get(shippingRuleId);
+    },
+    queryKey: ["useGetShippingRuleById", shippingRuleId],
+    select: (result) => result.data
+  });
+};
+
 var __async$3 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
@@ -1837,6 +1850,7 @@ exports.useGetSalesOrderShipment = useGetSalesOrderShipment;
 exports.useGetServicesByCarrier = useGetServicesByCarrier;
 exports.useGetShipment = useGetShipment;
 exports.useGetShipmentRates = useGetShipmentRates;
+exports.useGetShippingRuleById = useGetShippingRuleById;
 exports.useGetShippingRuleConditionsOptions = useGetShippingRuleConditionsOptions;
 exports.useGetWalletHistory = useGetWalletHistory;
 exports.useGetZonesByCarrier = useGetZonesByCarrier;

package/index.mjs

@@ -1625,6 +1625,19 @@ const useGetShippingRuleConditionsOptions = () => {
   });
 };
 
+const useGetShippingRuleById = (shippingRuleId) => {
+  const { client } = useShipEngine();
+  return useQuery({
+    enabled: !!shippingRuleId,
+    onError,
+    queryFn: () => {
+      return client.shippingRules.get(shippingRuleId);
+    },
+    queryKey: ["useGetShippingRuleById", shippingRuleId],
+    select: (result) => result.data
+  });
+};
+
 var __async$3 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
@@ -1791,4 +1804,4 @@ const useUpdateAccountBillingPlan = () => {
   });
 };
 
-export { ShipEngine, ShipEngineContext, delay, logger, onError, retryUntil, useAddFunds, useCalculateRates, useConnectCarrier, useCreateAccountImage, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateShippingRule, useCreateWarehouse, useDeleteAccountImage, useDeleteRateCard, useDeleteShippingRule, useDeleteWarehouse, useDownloadRateCard, useEditShippingRule, useFundingSourcesAddFunds, useGetAccountBillingPlan, useGetAccountImages, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetFundingSourceMetadata, useGetFundingSourceTransactions, useGetInsuranceAccount, useGetLabel, useGetPackageRatingGroupByCarrier, useGetRateCardById, useGetSalesOrder, useGetSalesOrderShipment, useGetServicesByCarrier, useGetShipment, useGetShipmentRates, useGetShippingRuleConditionsOptions, useGetWalletHistory, useGetZonesByCarrier, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListOrderSources, useListRateCards, useListSalesOrderShipments, useListSalesOrders, useListShipments, useListShippingRules, useListWarehouses, useNotifySalesOrderShipped, useParseAddress, usePublishRateCard, useRefreshOrderSource, useRefreshOrderSourceAsync, useRegisterCarrier, useShipEngine, useUpdateAccountBillingPlan, useUpdateAccountImage, useUpdateAccountSettings, useUpdateAutoFunding, useUpdateFundingSource, useUpdateRateCard, useUpdateSalesOrderShipment, useUpdateWarehouse, useUploadRateCard, useValidateAddresses, useVoidLabel };
+export { ShipEngine, ShipEngineContext, delay, logger, onError, retryUntil, useAddFunds, useCalculateRates, useConnectCarrier, useCreateAccountImage, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateShippingRule, useCreateWarehouse, useDeleteAccountImage, useDeleteRateCard, useDeleteShippingRule, useDeleteWarehouse, useDownloadRateCard, useEditShippingRule, useFundingSourcesAddFunds, useGetAccountBillingPlan, useGetAccountImages, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetFundingSourceMetadata, useGetFundingSourceTransactions, useGetInsuranceAccount, useGetLabel, useGetPackageRatingGroupByCarrier, useGetRateCardById, useGetSalesOrder, useGetSalesOrderShipment, useGetServicesByCarrier, useGetShipment, useGetShipmentRates, useGetShippingRuleById, useGetShippingRuleConditionsOptions, useGetWalletHistory, useGetZonesByCarrier, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListOrderSources, useListRateCards, useListSalesOrderShipments, useListSalesOrders, useListShipments, useListShippingRules, useListWarehouses, useNotifySalesOrderShipped, useParseAddress, usePublishRateCard, useRefreshOrderSource, useRefreshOrderSourceAsync, useRegisterCarrier, useShipEngine, useUpdateAccountBillingPlan, useUpdateAccountImage, useUpdateAccountSettings, useUpdateAutoFunding, useUpdateFundingSource, useUpdateRateCard, useUpdateSalesOrderShipment, useUpdateWarehouse, useUploadRateCard, useValidateAddresses, useVoidLabel };

package/package.json

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