@shipengine/react-api 1.14.0 → 2.0.1

package/hooks/carriers/use-update-auto-funding.d.ts

@@ -1,5 +1,9 @@
-import { SE } from "@shipengine/js-api";
+import { CarrierAutoFundingSettings } from "@shipengine/js-api";
+interface AutoFundingOptions extends CarrierAutoFundingSettings {
+    carrierId: string;
+}
 /**
  * @category ShipEngine API Hooks
  */
-export declare const useUpdateAutoFunding: (carrierId: string) => import("@tanstack/react-query").UseMutationResult<SE.CarrierAutoFundingSettingsResponse, SE.CodedError[], SE.CarrierAutoFundingSettings, unknown>;
+export declare const useUpdateAutoFunding: () => import("@tanstack/react-query").UseMutationResult<import("@shipengine/js-api").CarrierAutoFundingSettingsResponse, import("@shipengine/js-api").CodedError[], AutoFundingOptions, unknown>;
+export {};

package/hooks/connections/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./use-get-carrier-connection-form";
+export * from "./use-list-carriers";

package/hooks/connections/use-get-carrier-connection-form.d.ts

@@ -0,0 +1,8 @@
+import { GetCarrierConnectionFormParams } from "@shipengine/js-api";
+/**
+ * @category ShipEngine API Hooks
+ */
+export declare const useGetCarrierConnectionForm: (_params: GetCarrierConnectionFormParams & {
+    carrierName: string;
+    enabled?: boolean;
+}) => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").GetCarrierConnectionFormResponse, import("@shipengine/js-api").CodedError[]>;

package/hooks/connections/use-list-carriers.d.ts

@@ -0,0 +1,7 @@
+import { ListCarrierConnectionsParams } from "@shipengine/js-api";
+/**
+ * @category ShipEngine API Hooks
+ */
+export declare const useListCarrierConnections: (_params?: ListCarrierConnectionsParams & {
+    enabled?: boolean;
+}) => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").ListCarrierConnectionsResponse, import("@shipengine/js-api").CodedError[]>;

package/hooks/funding-sources/use-get-funding-source-transactions.d.ts

@@ -4,4 +4,4 @@ import { PageableQuery, SortableQuery } from "@shipengine/js-api";
  */
 export declare const useGetFundingSourceTransactions: (fundingSourceId: string, params?: {
     category?: string;
-} & PageableQuery & SortableQuery<"amount" | "category">) => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").FundingSourceTransactionsResponse, unknown>;
+} & PageableQuery & SortableQuery<"amount" | "category">) => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").FundingSourceTransactionsResponse, import("@shipengine/js-api").CodedError[]>;

package/hooks/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./account-settings";
 export * from "./addresses";
 export * from "./carriers";
+export * from "./connections";
 export * from "./custom-packages";
 export * from "./funding-sources";
 export * from "./insurance";

package/index.js

@@ -79,17 +79,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$8 = Object.getOwnPropertySymbols;
-var __hasOwnProp$8 = Object.prototype.hasOwnProperty;
-var __propIsEnum$8 = Object.prototype.propertyIsEnumerable;
+var __getOwnPropSymbols$b = Object.getOwnPropertySymbols;
+var __hasOwnProp$b = Object.prototype.hasOwnProperty;
+var __propIsEnum$b = 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$8.call(b, prop))
+    if (__hasOwnProp$b.call(b, prop))
       __defNormalProp$1(a, prop, b[prop]);
-  if (__getOwnPropSymbols$8)
-    for (var prop of __getOwnPropSymbols$8(b)) {
-      if (__propIsEnum$8.call(b, prop))
+  if (__getOwnPropSymbols$b)
+    for (var prop of __getOwnPropSymbols$b(b)) {
+      if (__propIsEnum$b.call(b, prop))
         __defNormalProp$1(a, prop, b[prop]);
     }
   return a;
@@ -514,6 +514,21 @@ const useListCarriers = () => {
   });
 };
 
+var __getOwnPropSymbols$a = Object.getOwnPropertySymbols;
+var __hasOwnProp$a = Object.prototype.hasOwnProperty;
+var __propIsEnum$a = Object.prototype.propertyIsEnumerable;
+var __objRest$9 = (source, exclude) => {
+  var target = {};
+  for (var prop in source)
+    if (__hasOwnProp$a.call(source, prop) && exclude.indexOf(prop) < 0)
+      target[prop] = source[prop];
+  if (source != null && __getOwnPropSymbols$a)
+    for (var prop of __getOwnPropSymbols$a(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$a.call(source, prop))
+        target[prop] = source[prop];
+    }
+  return target;
+};
 var __async$p = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
@@ -534,18 +549,19 @@ var __async$p = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
-const useUpdateAutoFunding = (carrierId) => {
+const useUpdateAutoFunding = () => {
   const { client } = useShipEngine();
   const queryClient = reactQuery.useQueryClient();
   return reactQuery.useMutation({
-    mutationFn: (options) => __async$p(void 0, null, function* () {
+    mutationFn: (_a) => __async$p(void 0, null, function* () {
+      var _b = _a, { carrierId } = _b, options = __objRest$9(_b, ["carrierId"]);
       const result = yield client.carriers.updateAutoFunding(carrierId, options);
       return result.data;
     }),
     mutationKey: ["useUpdateAutoFunding"],
     onError,
-    onSuccess: (_) => {
-      queryClient.invalidateQueries(["useGetAutoFunding", carrierId], { exact: true });
+    onSuccess: () => {
+      queryClient.invalidateQueries(["useGetAutoFunding"]);
     }
   });
 };
@@ -567,6 +583,60 @@ const useGetZonesByCarrier = (carrierId) => {
   });
 };
 
+var __getOwnPropSymbols$9 = Object.getOwnPropertySymbols;
+var __hasOwnProp$9 = Object.prototype.hasOwnProperty;
+var __propIsEnum$9 = Object.prototype.propertyIsEnumerable;
+var __objRest$8 = (source, exclude) => {
+  var target = {};
+  for (var prop in source)
+    if (__hasOwnProp$9.call(source, prop) && exclude.indexOf(prop) < 0)
+      target[prop] = source[prop];
+  if (source != null && __getOwnPropSymbols$9)
+    for (var prop of __getOwnPropSymbols$9(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$9.call(source, prop))
+        target[prop] = source[prop];
+    }
+  return target;
+};
+const useGetCarrierConnectionForm = (_params) => {
+  const { client } = useShipEngine();
+  const _a = _params || {}, { carrierName, enabled = true } = _a, params = __objRest$8(_a, ["carrierName", "enabled"]);
+  return reactQuery.useQuery({
+    enabled,
+    onError,
+    queryFn: () => client.connections.getCarrierConnectionForm(carrierName, params),
+    queryKey: ["useGetCarrierConnectionForm", params],
+    select: (result) => result.data
+  });
+};
+
+var __getOwnPropSymbols$8 = Object.getOwnPropertySymbols;
+var __hasOwnProp$8 = Object.prototype.hasOwnProperty;
+var __propIsEnum$8 = Object.prototype.propertyIsEnumerable;
+var __objRest$7 = (source, exclude) => {
+  var target = {};
+  for (var prop in source)
+    if (__hasOwnProp$8.call(source, prop) && exclude.indexOf(prop) < 0)
+      target[prop] = source[prop];
+  if (source != null && __getOwnPropSymbols$8)
+    for (var prop of __getOwnPropSymbols$8(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$8.call(source, prop))
+        target[prop] = source[prop];
+    }
+  return target;
+};
+const useListCarrierConnections = (_params) => {
+  const { client } = useShipEngine();
+  const _a = _params || {}, { enabled = true } = _a, params = __objRest$7(_a, ["enabled"]);
+  return reactQuery.useQuery({
+    enabled,
+    onError,
+    queryFn: () => client.connections.listCarriers(params),
+    queryKey: ["useListCarrierConnections", params],
+    select: (result) => result.data
+  });
+};
+
 const useListCustomPackageTypes = () => {
   const { client } = useShipEngine();
   return reactQuery.useQuery({
@@ -748,6 +818,7 @@ const useGetFundingSourceTransactions = (fundingSourceId, params) => {
   return reactQuery.useQuery({
     enabled: !!fundingSourceId,
     keepPreviousData: true,
+    onError,
     queryFn: () => client.fundingSources.transactions(fundingSourceId, params),
     queryKey: ["useGetFundingSourceTransactions", fundingSourceId, params],
     select: (result) => result.data
@@ -1880,6 +1951,7 @@ exports.useGetAccountImages = useGetAccountImages;
 exports.useGetAccountSettings = useGetAccountSettings;
 exports.useGetAutoFundingConfiguration = useGetAutoFundingConfiguration;
 exports.useGetCarrierById = useGetCarrierById;
+exports.useGetCarrierConnectionForm = useGetCarrierConnectionForm;
 exports.useGetCountriesByCarrier = useGetCountriesByCarrier;
 exports.useGetCurrenciesByCarrier = useGetCurrenciesByCarrier;
 exports.useGetFundingSourceById = useGetFundingSourceById;
@@ -1898,6 +1970,7 @@ exports.useGetShippingRuleById = useGetShippingRuleById;
 exports.useGetShippingRuleConditionsOptions = useGetShippingRuleConditionsOptions;
 exports.useGetThemeById = useGetThemeById;
 exports.useGetZonesByCarrier = useGetZonesByCarrier;
+exports.useListCarrierConnections = useListCarrierConnections;
 exports.useListCarriers = useListCarriers;
 exports.useListCustomPackageTypes = useListCustomPackageTypes;
 exports.useListFundingSources = useListFundingSources;

package/index.mjs

@@ -76,17 +76,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$8 = Object.getOwnPropertySymbols;
-var __hasOwnProp$8 = Object.prototype.hasOwnProperty;
-var __propIsEnum$8 = Object.prototype.propertyIsEnumerable;
+var __getOwnPropSymbols$b = Object.getOwnPropertySymbols;
+var __hasOwnProp$b = Object.prototype.hasOwnProperty;
+var __propIsEnum$b = 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$8.call(b, prop))
+    if (__hasOwnProp$b.call(b, prop))
       __defNormalProp$1(a, prop, b[prop]);
-  if (__getOwnPropSymbols$8)
-    for (var prop of __getOwnPropSymbols$8(b)) {
-      if (__propIsEnum$8.call(b, prop))
+  if (__getOwnPropSymbols$b)
+    for (var prop of __getOwnPropSymbols$b(b)) {
+      if (__propIsEnum$b.call(b, prop))
         __defNormalProp$1(a, prop, b[prop]);
     }
   return a;
@@ -511,6 +511,21 @@ const useListCarriers = () => {
   });
 };
 
+var __getOwnPropSymbols$a = Object.getOwnPropertySymbols;
+var __hasOwnProp$a = Object.prototype.hasOwnProperty;
+var __propIsEnum$a = Object.prototype.propertyIsEnumerable;
+var __objRest$9 = (source, exclude) => {
+  var target = {};
+  for (var prop in source)
+    if (__hasOwnProp$a.call(source, prop) && exclude.indexOf(prop) < 0)
+      target[prop] = source[prop];
+  if (source != null && __getOwnPropSymbols$a)
+    for (var prop of __getOwnPropSymbols$a(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$a.call(source, prop))
+        target[prop] = source[prop];
+    }
+  return target;
+};
 var __async$p = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
@@ -531,18 +546,19 @@ var __async$p = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
-const useUpdateAutoFunding = (carrierId) => {
+const useUpdateAutoFunding = () => {
   const { client } = useShipEngine();
   const queryClient = useQueryClient();
   return useMutation({
-    mutationFn: (options) => __async$p(void 0, null, function* () {
+    mutationFn: (_a) => __async$p(void 0, null, function* () {
+      var _b = _a, { carrierId } = _b, options = __objRest$9(_b, ["carrierId"]);
       const result = yield client.carriers.updateAutoFunding(carrierId, options);
       return result.data;
     }),
     mutationKey: ["useUpdateAutoFunding"],
     onError,
-    onSuccess: (_) => {
-      queryClient.invalidateQueries(["useGetAutoFunding", carrierId], { exact: true });
+    onSuccess: () => {
+      queryClient.invalidateQueries(["useGetAutoFunding"]);
     }
   });
 };
@@ -564,6 +580,60 @@ const useGetZonesByCarrier = (carrierId) => {
   });
 };
 
+var __getOwnPropSymbols$9 = Object.getOwnPropertySymbols;
+var __hasOwnProp$9 = Object.prototype.hasOwnProperty;
+var __propIsEnum$9 = Object.prototype.propertyIsEnumerable;
+var __objRest$8 = (source, exclude) => {
+  var target = {};
+  for (var prop in source)
+    if (__hasOwnProp$9.call(source, prop) && exclude.indexOf(prop) < 0)
+      target[prop] = source[prop];
+  if (source != null && __getOwnPropSymbols$9)
+    for (var prop of __getOwnPropSymbols$9(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$9.call(source, prop))
+        target[prop] = source[prop];
+    }
+  return target;
+};
+const useGetCarrierConnectionForm = (_params) => {
+  const { client } = useShipEngine();
+  const _a = _params || {}, { carrierName, enabled = true } = _a, params = __objRest$8(_a, ["carrierName", "enabled"]);
+  return useQuery({
+    enabled,
+    onError,
+    queryFn: () => client.connections.getCarrierConnectionForm(carrierName, params),
+    queryKey: ["useGetCarrierConnectionForm", params],
+    select: (result) => result.data
+  });
+};
+
+var __getOwnPropSymbols$8 = Object.getOwnPropertySymbols;
+var __hasOwnProp$8 = Object.prototype.hasOwnProperty;
+var __propIsEnum$8 = Object.prototype.propertyIsEnumerable;
+var __objRest$7 = (source, exclude) => {
+  var target = {};
+  for (var prop in source)
+    if (__hasOwnProp$8.call(source, prop) && exclude.indexOf(prop) < 0)
+      target[prop] = source[prop];
+  if (source != null && __getOwnPropSymbols$8)
+    for (var prop of __getOwnPropSymbols$8(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$8.call(source, prop))
+        target[prop] = source[prop];
+    }
+  return target;
+};
+const useListCarrierConnections = (_params) => {
+  const { client } = useShipEngine();
+  const _a = _params || {}, { enabled = true } = _a, params = __objRest$7(_a, ["enabled"]);
+  return useQuery({
+    enabled,
+    onError,
+    queryFn: () => client.connections.listCarriers(params),
+    queryKey: ["useListCarrierConnections", params],
+    select: (result) => result.data
+  });
+};
+
 const useListCustomPackageTypes = () => {
   const { client } = useShipEngine();
   return useQuery({
@@ -745,6 +815,7 @@ const useGetFundingSourceTransactions = (fundingSourceId, params) => {
   return useQuery({
     enabled: !!fundingSourceId,
     keepPreviousData: true,
+    onError,
     queryFn: () => client.fundingSources.transactions(fundingSourceId, params),
     queryKey: ["useGetFundingSourceTransactions", fundingSourceId, params],
     select: (result) => result.data
@@ -1847,4 +1918,4 @@ const useUpdateAccountBillingPlan = () => {
   });
 };
 
-export { ShipEngine, ShipEngineContext, delay, logger, onError, retryUntil, useAddFunds, useCalculateRates, useConnectCarrier, useCreateAccountImage, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateShippingRule, useCreateWarehouse, useDeactivateOrderSource, 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, useGetThemeById, 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, useDeactivateOrderSource, useDeleteAccountImage, useDeleteRateCard, useDeleteShippingRule, useDeleteWarehouse, useDownloadRateCard, useEditShippingRule, useFundingSourcesAddFunds, useGetAccountBillingPlan, useGetAccountImages, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetCarrierConnectionForm, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetFundingSourceMetadata, useGetFundingSourceTransactions, useGetInsuranceAccount, useGetLabel, useGetPackageRatingGroupByCarrier, useGetRateCardById, useGetSalesOrder, useGetSalesOrderShipment, useGetServicesByCarrier, useGetShipment, useGetShipmentRates, useGetShippingRuleById, useGetShippingRuleConditionsOptions, useGetThemeById, useGetZonesByCarrier, useListCarrierConnections, 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.14.0",
+  "version": "2.0.1",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {