@shipengine/react-api 2.2.0 → 2.3.1

package/hooks/connections/index.d.ts

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

package/hooks/connections/use-connect-carrier-account.d.ts

@@ -0,0 +1,9 @@
+import { SE } from "@shipengine/js-api";
+export type ConnectCarrierAccountData = {
+    carrierName: string;
+    formData: SE.ConnectCarrierAccount;
+};
+/**
+ * @category ShipEngine API Hooks
+ */
+export declare const useConnectCarrierAccount: () => import("@tanstack/react-query").UseMutationResult<SE.ConnectCarrierAccountResponse, SE.CodedError[], ConnectCarrierAccountData, unknown>;

package/index.js

@@ -124,7 +124,7 @@ const retryUntil = (callbackFn, retries = 10, timeoutBetweenAttempts = 1e3) => P
   throw error;
 });
 
-var __async$y = (__this, __arguments, generator) => {
+var __async$z = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -147,7 +147,7 @@ var __async$y = (__this, __arguments, generator) => {
 const useCreateAccountImage = () => {
   const { client } = useShipEngine();
   return reactQuery.useMutation({
-    mutationFn: (data) => __async$y(void 0, null, function* () {
+    mutationFn: (data) => __async$z(void 0, null, function* () {
       const result = yield client.accountSettings.createImage(data);
       return result.data;
     }),
@@ -156,7 +156,7 @@ const useCreateAccountImage = () => {
   });
 };
 
-var __async$x = (__this, __arguments, generator) => {
+var __async$y = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -179,7 +179,7 @@ var __async$x = (__this, __arguments, generator) => {
 const useDeleteAccountImage = () => {
   const { client } = useShipEngine();
   return reactQuery.useMutation({
-    mutationFn: (labelImageId) => __async$x(void 0, null, function* () {
+    mutationFn: (labelImageId) => __async$y(void 0, null, function* () {
       const result = yield client.accountSettings.deleteImage(labelImageId);
       return result.data;
     }),
@@ -208,7 +208,7 @@ const useGetAccountSettings = () => {
   });
 };
 
-var __async$w = (__this, __arguments, generator) => {
+var __async$x = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -231,7 +231,7 @@ var __async$w = (__this, __arguments, generator) => {
 const useUpdateAccountImage = () => {
   const { client } = useShipEngine();
   return reactQuery.useMutation({
-    mutationFn: (data) => __async$w(void 0, null, function* () {
+    mutationFn: (data) => __async$x(void 0, null, function* () {
       const result = yield client.accountSettings.updateImage(data);
       return result.data;
     }),
@@ -240,7 +240,7 @@ const useUpdateAccountImage = () => {
   });
 };
 
-var __async$v = (__this, __arguments, generator) => {
+var __async$w = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -263,7 +263,7 @@ var __async$v = (__this, __arguments, generator) => {
 const useUpdateAccountSettings = () => {
   const { client } = useShipEngine();
   return reactQuery.useMutation({
-    mutationFn: (settings) => __async$v(void 0, null, function* () {
+    mutationFn: (settings) => __async$w(void 0, null, function* () {
       const result = yield client.accountSettings.update(settings);
       return result.data;
     }),
@@ -272,7 +272,7 @@ const useUpdateAccountSettings = () => {
   });
 };
 
-var __async$u = (__this, __arguments, generator) => {
+var __async$v = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -295,7 +295,7 @@ var __async$u = (__this, __arguments, generator) => {
 const useParseAddress = () => {
   const { client } = useShipEngine();
   return reactQuery.useMutation({
-    mutationFn: (_0) => __async$u(void 0, [_0], function* ({ address, text }) {
+    mutationFn: (_0) => __async$v(void 0, [_0], function* ({ address, text }) {
       const result = yield client.addresses.parse(text, address);
       return result.data;
     }),
@@ -304,7 +304,7 @@ const useParseAddress = () => {
   });
 };
 
-var __async$t = (__this, __arguments, generator) => {
+var __async$u = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -327,7 +327,7 @@ var __async$t = (__this, __arguments, generator) => {
 const useValidateAddresses = () => {
   const { client } = useShipEngine();
   return reactQuery.useMutation({
-    mutationFn: (addresses) => __async$t(void 0, null, function* () {
+    mutationFn: (addresses) => __async$u(void 0, null, function* () {
       const result = yield client.addresses.validate(addresses);
       return result.data;
     }),
@@ -336,7 +336,7 @@ const useValidateAddresses = () => {
   });
 };
 
-var __async$s = (__this, __arguments, generator) => {
+var __async$t = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -359,7 +359,7 @@ var __async$s = (__this, __arguments, generator) => {
 const useAddFunds = () => {
   const { client } = useShipEngine();
   return reactQuery.useMutation({
-    mutationFn: (_0) => __async$s(void 0, [_0], function* ({ carrierId, funds }) {
+    mutationFn: (_0) => __async$t(void 0, [_0], function* ({ carrierId, funds }) {
       const result = yield client.carriers.addFunds(carrierId, funds);
       return result.data;
     }),
@@ -368,7 +368,7 @@ const useAddFunds = () => {
   });
 };
 
-var __async$r = (__this, __arguments, generator) => {
+var __async$s = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -391,7 +391,7 @@ var __async$r = (__this, __arguments, generator) => {
 const useConnectCarrier = () => {
   const { client } = useShipEngine();
   return reactQuery.useMutation({
-    mutationFn: (params) => __async$r(void 0, null, function* () {
+    mutationFn: (params) => __async$s(void 0, null, function* () {
       const result = yield client.carriers.connect(params);
       return result.data;
     }),
@@ -525,7 +525,7 @@ var __objRest$a = (source, exclude) => {
     }
   return target;
 };
-var __async$q = (__this, __arguments, generator) => {
+var __async$r = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -549,7 +549,7 @@ const useUpdateAutoFunding = () => {
   const { client } = useShipEngine();
   const queryClient = reactQuery.useQueryClient();
   return reactQuery.useMutation({
-    mutationFn: (_a) => __async$q(void 0, null, function* () {
+    mutationFn: (_a) => __async$r(void 0, null, function* () {
       var _b = _a, { carrierId } = _b, options = __objRest$a(_b, ["carrierId"]);
       const result = yield client.carriers.updateAutoFunding(carrierId, options);
       return result.data;
@@ -633,6 +633,41 @@ const useListCarrierConnections = (_params) => {
   });
 };
 
+var __async$q = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+const useConnectCarrierAccount = () => {
+  const { client } = useShipEngine();
+  return reactQuery.useMutation({
+    mutationFn: (_0) => __async$q(void 0, [_0], function* ({ carrierName, formData }) {
+      const result = yield client.connections.connectCarrier(carrierName, formData);
+      if (result.status > 300 && result.status < 309) {
+        result.data.redirectUrl = result.request.res.responseUrl;
+      }
+      return result.data;
+    }),
+    mutationKey: ["useConnectCarrierAccount"],
+    onError
+  });
+};
+
 const useListCustomPackageTypes = () => {
   const { client } = useShipEngine();
   return reactQuery.useQuery({
@@ -1968,9 +2003,11 @@ const useUpdateAccountBillingPlan = () => {
 const useListServicePoints = (options) => {
   const { client } = useShipEngine();
   return reactQuery.useQuery({
+    enabled: options.providers.length > 0,
     onError,
     queryFn: () => client.servicePoints.list(options),
-    queryKey: ["useListServicePoints"],
+    queryKey: ["useListServicePoints", options],
+    retry: false,
     select: (result) => result.data
   });
 };
@@ -2008,6 +2045,7 @@ exports.useAddFunds = useAddFunds;
 exports.useAddInsuranceFunds = useAddInsuranceFunds;
 exports.useCalculateRates = useCalculateRates;
 exports.useConnectCarrier = useConnectCarrier;
+exports.useConnectCarrierAccount = useConnectCarrierAccount;
 exports.useCreateAccountImage = useCreateAccountImage;
 exports.useCreateFundingSource = useCreateFundingSource;
 exports.useCreateLabel = useCreateLabel;

package/index.mjs

@@ -121,7 +121,7 @@ const retryUntil = (callbackFn, retries = 10, timeoutBetweenAttempts = 1e3) => P
   throw error;
 });
 
-var __async$y = (__this, __arguments, generator) => {
+var __async$z = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -144,7 +144,7 @@ var __async$y = (__this, __arguments, generator) => {
 const useCreateAccountImage = () => {
   const { client } = useShipEngine();
   return useMutation({
-    mutationFn: (data) => __async$y(void 0, null, function* () {
+    mutationFn: (data) => __async$z(void 0, null, function* () {
       const result = yield client.accountSettings.createImage(data);
       return result.data;
     }),
@@ -153,7 +153,7 @@ const useCreateAccountImage = () => {
   });
 };
 
-var __async$x = (__this, __arguments, generator) => {
+var __async$y = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -176,7 +176,7 @@ var __async$x = (__this, __arguments, generator) => {
 const useDeleteAccountImage = () => {
   const { client } = useShipEngine();
   return useMutation({
-    mutationFn: (labelImageId) => __async$x(void 0, null, function* () {
+    mutationFn: (labelImageId) => __async$y(void 0, null, function* () {
       const result = yield client.accountSettings.deleteImage(labelImageId);
       return result.data;
     }),
@@ -205,7 +205,7 @@ const useGetAccountSettings = () => {
   });
 };
 
-var __async$w = (__this, __arguments, generator) => {
+var __async$x = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -228,7 +228,7 @@ var __async$w = (__this, __arguments, generator) => {
 const useUpdateAccountImage = () => {
   const { client } = useShipEngine();
   return useMutation({
-    mutationFn: (data) => __async$w(void 0, null, function* () {
+    mutationFn: (data) => __async$x(void 0, null, function* () {
       const result = yield client.accountSettings.updateImage(data);
       return result.data;
     }),
@@ -237,7 +237,7 @@ const useUpdateAccountImage = () => {
   });
 };
 
-var __async$v = (__this, __arguments, generator) => {
+var __async$w = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -260,7 +260,7 @@ var __async$v = (__this, __arguments, generator) => {
 const useUpdateAccountSettings = () => {
   const { client } = useShipEngine();
   return useMutation({
-    mutationFn: (settings) => __async$v(void 0, null, function* () {
+    mutationFn: (settings) => __async$w(void 0, null, function* () {
       const result = yield client.accountSettings.update(settings);
       return result.data;
     }),
@@ -269,7 +269,7 @@ const useUpdateAccountSettings = () => {
   });
 };
 
-var __async$u = (__this, __arguments, generator) => {
+var __async$v = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -292,7 +292,7 @@ var __async$u = (__this, __arguments, generator) => {
 const useParseAddress = () => {
   const { client } = useShipEngine();
   return useMutation({
-    mutationFn: (_0) => __async$u(void 0, [_0], function* ({ address, text }) {
+    mutationFn: (_0) => __async$v(void 0, [_0], function* ({ address, text }) {
       const result = yield client.addresses.parse(text, address);
       return result.data;
     }),
@@ -301,7 +301,7 @@ const useParseAddress = () => {
   });
 };
 
-var __async$t = (__this, __arguments, generator) => {
+var __async$u = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -324,7 +324,7 @@ var __async$t = (__this, __arguments, generator) => {
 const useValidateAddresses = () => {
   const { client } = useShipEngine();
   return useMutation({
-    mutationFn: (addresses) => __async$t(void 0, null, function* () {
+    mutationFn: (addresses) => __async$u(void 0, null, function* () {
       const result = yield client.addresses.validate(addresses);
       return result.data;
     }),
@@ -333,7 +333,7 @@ const useValidateAddresses = () => {
   });
 };
 
-var __async$s = (__this, __arguments, generator) => {
+var __async$t = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -356,7 +356,7 @@ var __async$s = (__this, __arguments, generator) => {
 const useAddFunds = () => {
   const { client } = useShipEngine();
   return useMutation({
-    mutationFn: (_0) => __async$s(void 0, [_0], function* ({ carrierId, funds }) {
+    mutationFn: (_0) => __async$t(void 0, [_0], function* ({ carrierId, funds }) {
       const result = yield client.carriers.addFunds(carrierId, funds);
       return result.data;
     }),
@@ -365,7 +365,7 @@ const useAddFunds = () => {
   });
 };
 
-var __async$r = (__this, __arguments, generator) => {
+var __async$s = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -388,7 +388,7 @@ var __async$r = (__this, __arguments, generator) => {
 const useConnectCarrier = () => {
   const { client } = useShipEngine();
   return useMutation({
-    mutationFn: (params) => __async$r(void 0, null, function* () {
+    mutationFn: (params) => __async$s(void 0, null, function* () {
       const result = yield client.carriers.connect(params);
       return result.data;
     }),
@@ -522,7 +522,7 @@ var __objRest$a = (source, exclude) => {
     }
   return target;
 };
-var __async$q = (__this, __arguments, generator) => {
+var __async$r = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -546,7 +546,7 @@ const useUpdateAutoFunding = () => {
   const { client } = useShipEngine();
   const queryClient = useQueryClient();
   return useMutation({
-    mutationFn: (_a) => __async$q(void 0, null, function* () {
+    mutationFn: (_a) => __async$r(void 0, null, function* () {
       var _b = _a, { carrierId } = _b, options = __objRest$a(_b, ["carrierId"]);
       const result = yield client.carriers.updateAutoFunding(carrierId, options);
       return result.data;
@@ -630,6 +630,41 @@ const useListCarrierConnections = (_params) => {
   });
 };
 
+var __async$q = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+const useConnectCarrierAccount = () => {
+  const { client } = useShipEngine();
+  return useMutation({
+    mutationFn: (_0) => __async$q(void 0, [_0], function* ({ carrierName, formData }) {
+      const result = yield client.connections.connectCarrier(carrierName, formData);
+      if (result.status > 300 && result.status < 309) {
+        result.data.redirectUrl = result.request.res.responseUrl;
+      }
+      return result.data;
+    }),
+    mutationKey: ["useConnectCarrierAccount"],
+    onError
+  });
+};
+
 const useListCustomPackageTypes = () => {
   const { client } = useShipEngine();
   return useQuery({
@@ -1965,9 +2000,11 @@ const useUpdateAccountBillingPlan = () => {
 const useListServicePoints = (options) => {
   const { client } = useShipEngine();
   return useQuery({
+    enabled: options.providers.length > 0,
     onError,
     queryFn: () => client.servicePoints.list(options),
-    queryKey: ["useListServicePoints"],
+    queryKey: ["useListServicePoints", options],
+    retry: false,
     select: (result) => result.data
   });
 };
@@ -1995,4 +2032,4 @@ const useGetServicePoint = ({
   });
 };
 
-export { ShipEngine, ShipEngineContext, delay, logger, onError, retryUntil, useAddFunds, useAddInsuranceFunds, 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, useGetServicePoint, useGetServicesByCarrier, useGetShipment, useGetShipmentRates, useGetShippingRuleById, useGetShippingRuleConditionsOptions, useGetThemeById, useGetZonesByCarrier, useListCarrierConnections, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListOrderSources, useListRateCards, useListSalesOrderShipments, useListSalesOrders, useListServicePoints, 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, useAddInsuranceFunds, useCalculateRates, useConnectCarrier, useConnectCarrierAccount, 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, useGetServicePoint, useGetServicesByCarrier, useGetShipment, useGetShipmentRates, useGetShippingRuleById, useGetShippingRuleConditionsOptions, useGetThemeById, useGetZonesByCarrier, useListCarrierConnections, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListOrderSources, useListRateCards, useListSalesOrderShipments, useListSalesOrders, useListServicePoints, 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": "2.2.0",
+  "version": "2.3.1",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {