@shipengine/react-api 1.3.0 → 1.4.0

package/hooks/account-billing-plan/use-get-account-billing-plan.d.ts

@@ -1 +1 @@
-export declare const useGetAccountBillingPlan: () => import("@tanstack/react-query").UseQueryResult<import("packages/shipengine-api/javascript/src/account-billing-plan").AccountBillingPlanResponse, import("@shipengine/js-api").CodedError[]>;
+export declare const useGetAccountBillingPlan: () => import("@tanstack/react-query").UseQueryResult<import("packages/shipengine-api/javascript/src/types").AccountBillingPlanResponse, import("@shipengine/js-api").CodedError[]>;

package/hooks/carriers/use-add-funds.d.ts

@@ -1,10 +1,15 @@
 import { SE } from "@shipengine/js-api";
+type AddFundsData = {
+    carrierId: string;
+    funds: SE.Money;
+};
 /**
  * @category ShipEngine API Hooks
  *
  * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/carriers/add-funds/)
  * @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/add_funds_to_carrier)
  */
-export declare const useAddFunds: (carrierId: string) => import("@tanstack/react-query").UseMutationResult<{
+export declare const useAddFunds: () => import("@tanstack/react-query").UseMutationResult<{
     balance: SE.Money;
-}, SE.CodedError[], SE.Money, unknown>;
+}, SE.CodedError[], AddFundsData, unknown>;
+export {};

package/hooks/funding-sources/index.d.ts

@@ -4,3 +4,4 @@ export * from "./use-get-funding-source-by-id";
 export * from "./use-list-funding-sources";
 export * from "./use-register-carrier";
 export * from "./use-update-funding-source";
+export * from "./use-get-funding-source-metadata";

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

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

package/index.js

@@ -240,10 +240,10 @@ var __async$n = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
-const useAddFunds = (carrierId) => {
+const useAddFunds = () => {
   const { client } = useShipEngine();
   return reactQuery.useMutation({
-    mutationFn: (funds) => __async$n(void 0, null, function* () {
+    mutationFn: (_0) => __async$n(void 0, [_0], function* ({ carrierId, funds }) {
       const result = yield client.carriers.addFunds(carrierId, funds);
       return result.data;
     }),
@@ -631,6 +631,16 @@ const useUpdateFundingSource = () => {
   });
 };
 
+const useGetFundingSourceMetadata = () => {
+  const { client } = useShipEngine();
+  return reactQuery.useQuery({
+    onError,
+    queryFn: () => client.fundingSources.metadata(),
+    queryKey: ["useGetFundingSourceMetadata"],
+    select: (result) => result.data
+  });
+};
+
 const useGetInsuranceAccount = (insuranceProvider) => {
   const { client } = useShipEngine();
   return reactQuery.useQuery({
@@ -1570,6 +1580,7 @@ exports.useGetCarrierById = useGetCarrierById;
 exports.useGetCountriesByCarrier = useGetCountriesByCarrier;
 exports.useGetCurrenciesByCarrier = useGetCurrenciesByCarrier;
 exports.useGetFundingSourceById = useGetFundingSourceById;
+exports.useGetFundingSourceMetadata = useGetFundingSourceMetadata;
 exports.useGetInsuranceAccount = useGetInsuranceAccount;
 exports.useGetLabel = useGetLabel;
 exports.useGetPackageRatingGroupByCarrier = useGetPackageRatingGroupByCarrier;

package/index.mjs

@@ -237,10 +237,10 @@ var __async$n = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
-const useAddFunds = (carrierId) => {
+const useAddFunds = () => {
   const { client } = useShipEngine();
   return useMutation({
-    mutationFn: (funds) => __async$n(void 0, null, function* () {
+    mutationFn: (_0) => __async$n(void 0, [_0], function* ({ carrierId, funds }) {
       const result = yield client.carriers.addFunds(carrierId, funds);
       return result.data;
     }),
@@ -628,6 +628,16 @@ const useUpdateFundingSource = () => {
   });
 };
 
+const useGetFundingSourceMetadata = () => {
+  const { client } = useShipEngine();
+  return useQuery({
+    onError,
+    queryFn: () => client.fundingSources.metadata(),
+    queryKey: ["useGetFundingSourceMetadata"],
+    select: (result) => result.data
+  });
+};
+
 const useGetInsuranceAccount = (insuranceProvider) => {
   const { client } = useShipEngine();
   return useQuery({
@@ -1540,4 +1550,4 @@ const useGetAccountBillingPlan = () => {
   });
 };
 
-export { ShipEngine, ShipEngineContext, delay, logger, onError, retryUntil, useAddFunds, useCalculateRates, useConnectCarrier, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateShippingRule, useCreateWarehouse, useDeleteRateCard, useDeleteWarehouse, useDownloadRateCard, useFundingSourcesAddFunds, useGetAccountBillingPlan, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetInsuranceAccount, useGetLabel, useGetPackageRatingGroupByCarrier, useGetRateCardById, useGetSalesOrder, useGetSalesOrderShipment, useGetServicesByCarrier, useGetShipment, useGetShipmentRates, useGetWalletHistory, useGetZonesByCarrier, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListOrderSources, useListRateCards, useListSalesOrderShipments, useListSalesOrders, useListShipments, useListShippingRules, useListWarehouses, useNotifySalesOrderShipped, useParseAddress, usePublishRateCard, useRefreshOrderSource, useRefreshOrderSourceAsync, useRegisterCarrier, useShipEngine, useUpdateAccountSettings, useUpdateAutoFunding, useUpdateFundingSource, useUpdateRateCard, useUpdateSalesOrderShipment, useUpdateWarehouse, useUploadRateCard, useValidateAddresses, useVoidLabel };
+export { ShipEngine, ShipEngineContext, delay, logger, onError, retryUntil, useAddFunds, useCalculateRates, useConnectCarrier, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateShippingRule, useCreateWarehouse, useDeleteRateCard, useDeleteWarehouse, useDownloadRateCard, useFundingSourcesAddFunds, useGetAccountBillingPlan, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetFundingSourceMetadata, useGetInsuranceAccount, useGetLabel, useGetPackageRatingGroupByCarrier, useGetRateCardById, useGetSalesOrder, useGetSalesOrderShipment, useGetServicesByCarrier, useGetShipment, useGetShipmentRates, useGetWalletHistory, useGetZonesByCarrier, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListOrderSources, useListRateCards, useListSalesOrderShipments, useListSalesOrders, useListShipments, useListShippingRules, useListWarehouses, useNotifySalesOrderShipped, useParseAddress, usePublishRateCard, useRefreshOrderSource, useRefreshOrderSourceAsync, useRegisterCarrier, useShipEngine, useUpdateAccountSettings, useUpdateAutoFunding, useUpdateFundingSource, useUpdateRateCard, useUpdateSalesOrderShipment, useUpdateWarehouse, useUploadRateCard, useValidateAddresses, useVoidLabel };

package/package.json

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