@shipengine/react-api 1.11.1 → 1.11.3

package/hooks/labels/use-list-labels.d.ts

@@ -5,4 +5,6 @@ import { ListLabelsParams } from "@shipengine/js-api";
  * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/list-labels/)
  * @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/list_labels)
  */
-export declare const useListLabels: (params?: ListLabelsParams) => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").Label[], import("@shipengine/js-api").CodedError[]>;
+export declare const useListLabels: (_params?: ListLabelsParams & {
+    enabled?: boolean;
+}) => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").ListLabelsResult, import("@shipengine/js-api").CodedError[]>;

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

@@ -65,17 +65,17 @@ var o={trace:10,debug:20,info:30,warn:40,error:50,fatal:60},l={};function a(e){r
 var __defProp$1 = Object.defineProperty;
 var __defProps$1 = Object.defineProperties;
 var __getOwnPropDescs$1 = Object.getOwnPropertyDescriptors;
-var __getOwnPropSymbols$7 = Object.getOwnPropertySymbols;
-var __hasOwnProp$7 = Object.prototype.hasOwnProperty;
-var __propIsEnum$7 = Object.prototype.propertyIsEnumerable;
+var __getOwnPropSymbols$8 = Object.getOwnPropertySymbols;
+var __hasOwnProp$8 = Object.prototype.hasOwnProperty;
+var __propIsEnum$8 = Object.prototype.propertyIsEnumerable;
 var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __spreadValues$1 = (a, b) => {
   for (var prop in b || (b = {}))
-    if (__hasOwnProp$7.call(b, prop))
+    if (__hasOwnProp$8.call(b, prop))
       __defNormalProp$1(a, prop, b[prop]);
-  if (__getOwnPropSymbols$7)
-    for (var prop of __getOwnPropSymbols$7(b)) {
-      if (__propIsEnum$7.call(b, prop))
+  if (__getOwnPropSymbols$8)
+    for (var prop of __getOwnPropSymbols$8(b)) {
+      if (__propIsEnum$8.call(b, prop))
         __defNormalProp$1(a, prop, b[prop]);
     }
   return a;
@@ -773,17 +773,17 @@ const useGetInsuranceAccount = (insuranceProvider) => {
   });
 };
 
-var __getOwnPropSymbols$6 = Object.getOwnPropertySymbols;
-var __hasOwnProp$6 = Object.prototype.hasOwnProperty;
-var __propIsEnum$6 = Object.prototype.propertyIsEnumerable;
-var __objRest$5 = (source, exclude) => {
+var __getOwnPropSymbols$7 = Object.getOwnPropertySymbols;
+var __hasOwnProp$7 = Object.prototype.hasOwnProperty;
+var __propIsEnum$7 = Object.prototype.propertyIsEnumerable;
+var __objRest$6 = (source, exclude) => {
   var target = {};
   for (var prop in source)
-    if (__hasOwnProp$6.call(source, prop) && exclude.indexOf(prop) < 0)
+    if (__hasOwnProp$7.call(source, prop) && exclude.indexOf(prop) < 0)
       target[prop] = source[prop];
-  if (source != null && __getOwnPropSymbols$6)
-    for (var prop of __getOwnPropSymbols$6(source)) {
-      if (exclude.indexOf(prop) < 0 && __propIsEnum$6.call(source, prop))
+  if (source != null && __getOwnPropSymbols$7)
+    for (var prop of __getOwnPropSymbols$7(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$7.call(source, prop))
         target[prop] = source[prop];
     }
   return target;
@@ -812,7 +812,7 @@ const useCreateLabel = () => {
   const { client } = useShipEngine();
   return reactQuery.useMutation({
     mutationFn: (_a) => __async$j(void 0, null, function* () {
-      var _b = _a, { rateId } = _b, options = __objRest$5(_b, ["rateId"]);
+      var _b = _a, { rateId } = _b, options = __objRest$6(_b, ["rateId"]);
       const result = yield client.labels.createByRateId(rateId, options);
       return result.data;
     }),
@@ -836,14 +836,30 @@ const useGetLabel = (labelId) => {
   });
 };
 
-const useListLabels = (params) => {
+var __getOwnPropSymbols$6 = Object.getOwnPropertySymbols;
+var __hasOwnProp$6 = Object.prototype.hasOwnProperty;
+var __propIsEnum$6 = Object.prototype.propertyIsEnumerable;
+var __objRest$5 = (source, exclude) => {
+  var target = {};
+  for (var prop in source)
+    if (__hasOwnProp$6.call(source, prop) && exclude.indexOf(prop) < 0)
+      target[prop] = source[prop];
+  if (source != null && __getOwnPropSymbols$6)
+    for (var prop of __getOwnPropSymbols$6(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$6.call(source, prop))
+        target[prop] = source[prop];
+    }
+  return target;
+};
+const useListLabels = (_params) => {
   const { client } = useShipEngine();
+  const _a = _params || {}, { enabled = true } = _a, params = __objRest$5(_a, ["enabled"]);
   return reactQuery.useQuery({
-    enabled: params && Object.values(params).some((v) => v !== void 0),
+    enabled,
     onError,
     queryFn: () => client.labels.list(params),
     queryKey: ["useListLabels", params],
-    select: (result) => result.data.labels
+    select: (result) => result.data
   });
 };
 
@@ -1612,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) => {
@@ -1821,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

@@ -62,17 +62,17 @@ var o={trace:10,debug:20,info:30,warn:40,error:50,fatal:60},l={};function a(e){r
 var __defProp$1 = Object.defineProperty;
 var __defProps$1 = Object.defineProperties;
 var __getOwnPropDescs$1 = Object.getOwnPropertyDescriptors;
-var __getOwnPropSymbols$7 = Object.getOwnPropertySymbols;
-var __hasOwnProp$7 = Object.prototype.hasOwnProperty;
-var __propIsEnum$7 = Object.prototype.propertyIsEnumerable;
+var __getOwnPropSymbols$8 = Object.getOwnPropertySymbols;
+var __hasOwnProp$8 = Object.prototype.hasOwnProperty;
+var __propIsEnum$8 = Object.prototype.propertyIsEnumerable;
 var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __spreadValues$1 = (a, b) => {
   for (var prop in b || (b = {}))
-    if (__hasOwnProp$7.call(b, prop))
+    if (__hasOwnProp$8.call(b, prop))
       __defNormalProp$1(a, prop, b[prop]);
-  if (__getOwnPropSymbols$7)
-    for (var prop of __getOwnPropSymbols$7(b)) {
-      if (__propIsEnum$7.call(b, prop))
+  if (__getOwnPropSymbols$8)
+    for (var prop of __getOwnPropSymbols$8(b)) {
+      if (__propIsEnum$8.call(b, prop))
         __defNormalProp$1(a, prop, b[prop]);
     }
   return a;
@@ -770,17 +770,17 @@ const useGetInsuranceAccount = (insuranceProvider) => {
   });
 };
 
-var __getOwnPropSymbols$6 = Object.getOwnPropertySymbols;
-var __hasOwnProp$6 = Object.prototype.hasOwnProperty;
-var __propIsEnum$6 = Object.prototype.propertyIsEnumerable;
-var __objRest$5 = (source, exclude) => {
+var __getOwnPropSymbols$7 = Object.getOwnPropertySymbols;
+var __hasOwnProp$7 = Object.prototype.hasOwnProperty;
+var __propIsEnum$7 = Object.prototype.propertyIsEnumerable;
+var __objRest$6 = (source, exclude) => {
   var target = {};
   for (var prop in source)
-    if (__hasOwnProp$6.call(source, prop) && exclude.indexOf(prop) < 0)
+    if (__hasOwnProp$7.call(source, prop) && exclude.indexOf(prop) < 0)
       target[prop] = source[prop];
-  if (source != null && __getOwnPropSymbols$6)
-    for (var prop of __getOwnPropSymbols$6(source)) {
-      if (exclude.indexOf(prop) < 0 && __propIsEnum$6.call(source, prop))
+  if (source != null && __getOwnPropSymbols$7)
+    for (var prop of __getOwnPropSymbols$7(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$7.call(source, prop))
         target[prop] = source[prop];
     }
   return target;
@@ -809,7 +809,7 @@ const useCreateLabel = () => {
   const { client } = useShipEngine();
   return useMutation({
     mutationFn: (_a) => __async$j(void 0, null, function* () {
-      var _b = _a, { rateId } = _b, options = __objRest$5(_b, ["rateId"]);
+      var _b = _a, { rateId } = _b, options = __objRest$6(_b, ["rateId"]);
       const result = yield client.labels.createByRateId(rateId, options);
       return result.data;
     }),
@@ -833,14 +833,30 @@ const useGetLabel = (labelId) => {
   });
 };
 
-const useListLabels = (params) => {
+var __getOwnPropSymbols$6 = Object.getOwnPropertySymbols;
+var __hasOwnProp$6 = Object.prototype.hasOwnProperty;
+var __propIsEnum$6 = Object.prototype.propertyIsEnumerable;
+var __objRest$5 = (source, exclude) => {
+  var target = {};
+  for (var prop in source)
+    if (__hasOwnProp$6.call(source, prop) && exclude.indexOf(prop) < 0)
+      target[prop] = source[prop];
+  if (source != null && __getOwnPropSymbols$6)
+    for (var prop of __getOwnPropSymbols$6(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$6.call(source, prop))
+        target[prop] = source[prop];
+    }
+  return target;
+};
+const useListLabels = (_params) => {
   const { client } = useShipEngine();
+  const _a = _params || {}, { enabled = true } = _a, params = __objRest$5(_a, ["enabled"]);
   return useQuery({
-    enabled: params && Object.values(params).some((v) => v !== void 0),
+    enabled,
     onError,
     queryFn: () => client.labels.list(params),
     queryKey: ["useListLabels", params],
-    select: (result) => result.data.labels
+    select: (result) => result.data
   });
 };
 
@@ -1609,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) => {
@@ -1775,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.1",
+  "version": "1.11.3",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {