@shipengine/react-api 4.2.0 → 4.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,10 +1,12 @@
1
1
  import { SE } from "@shipengine/js-api";
2
2
  export type UpdateFundingSourceData = {
3
- /** (Optional) AuctanePay Session info */
3
+ /** (Optional) Auctane Pay Session info */
4
4
  auctanePayInfo?: SE.AuctanePayInfo;
5
+ /** (Optional) Bank Account used for the funding source */
6
+ bankAccountInfo?: SE.BankAccountInfo;
5
7
  /** Billing info used for the Funding Source */
6
8
  billingInfo: SE.FundingSourceAddress;
7
- /** (Optional) CreditCardIng used the funding source */
9
+ /** (Optional) Credit Card used to the funding source */
8
10
  creditCardInfo?: SE.CreditCardInfo;
9
11
  /** The ID of the Funding Source to be updated */
10
12
  fundingSourceId: string;
@@ -5,4 +5,4 @@ export * from "./use-get-label";
5
5
  export * from "./use-list-labels";
6
6
  export * from "./use-void-label";
7
7
  export * from "./use-list-labels-infinite";
8
- export * from "./use-download-labels";
8
+ export * from "./use-export-labels";
@@ -0,0 +1,7 @@
1
+ import { ExportLabelsParams } from "@shipengine/js-api";
2
+ import { QueryProps } from "../../utilities";
3
+ /**
4
+ * @category ShipEngine API Hooks
5
+ *
6
+ */
7
+ export declare const useExportLabels: (params?: QueryProps<Blob, ExportLabelsParams>) => import("@tanstack/react-query").UseQueryResult<import("axios").AxiosResponse<Blob, any>, import("@shipengine/js-api").CodedError[]>;
@@ -4,4 +4,4 @@ export * from "./use-get-shipment";
4
4
  export * from "./use-list-shipments";
5
5
  export * from "./use-get-shipment-by-external-id";
6
6
  export * from "./use-cancel-shipment";
7
- export * from "./use-download-shipments";
7
+ export * from "./use-export-shipments";
@@ -0,0 +1,7 @@
1
+ import { ExportShipmentsParams } from "@shipengine/js-api";
2
+ import { QueryProps } from "../../utilities";
3
+ /**
4
+ * @category ShipEngine API Hooks
5
+ *
6
+ */
7
+ export declare const useExportShipments: (params?: QueryProps<Blob, ExportShipmentsParams>) => import("@tanstack/react-query").UseQueryResult<import("axios").AxiosResponse<Blob, any>, import("@shipengine/js-api").CodedError[]>;
package/index.js CHANGED
@@ -1086,12 +1086,14 @@ const useUpdateFundingSource = () => {
1086
1086
  mutationFn: (_0) => __async$D(void 0, [_0], function* ({
1087
1087
  billingInfo,
1088
1088
  creditCardInfo,
1089
+ bankAccountInfo,
1089
1090
  fundingSourceId,
1090
1091
  auctanePayInfo
1091
1092
  }) {
1092
1093
  const result = yield client.fundingSources.update(
1093
1094
  billingInfo,
1094
1095
  creditCardInfo,
1096
+ bankAccountInfo,
1095
1097
  auctanePayInfo,
1096
1098
  fundingSourceId
1097
1099
  );
@@ -1737,13 +1739,13 @@ var __objRest$e = (source, exclude) => {
1737
1739
  }
1738
1740
  return target;
1739
1741
  };
1740
- const useDownloadLabels = (params) => {
1742
+ const useExportLabels = (params) => {
1741
1743
  const { client } = useShipEngine();
1742
1744
  const _a = __spreadValues$i({}, params), { queryFnParams } = _a, rest = __objRest$e(_a, ["queryFnParams"]);
1743
1745
  return reactQuery.useQuery(__spreadProps$h(__spreadValues$i({}, rest), {
1744
1746
  onError,
1745
- queryFn: () => client.labels.download(queryFnParams),
1746
- queryKey: ["useDownloadLabels", params]
1747
+ queryFn: () => client.labels.export(queryFnParams),
1748
+ queryKey: ["useExportLabels", params]
1747
1749
  }));
1748
1750
  };
1749
1751
 
@@ -2696,13 +2698,13 @@ var __objRest$6 = (source, exclude) => {
2696
2698
  }
2697
2699
  return target;
2698
2700
  };
2699
- const useDownloadShipments = (params) => {
2701
+ const useExportShipments = (params) => {
2700
2702
  const { client } = useShipEngine();
2701
2703
  const _a = __spreadValues$c({}, params), { queryFnParams } = _a, rest = __objRest$6(_a, ["queryFnParams"]);
2702
2704
  return reactQuery.useQuery(__spreadProps$b(__spreadValues$c({}, rest), {
2703
2705
  onError,
2704
- queryFn: () => client.shipments.download(queryFnParams),
2705
- queryKey: ["useDownloadShipments", params]
2706
+ queryFn: () => client.shipments.export(queryFnParams),
2707
+ queryKey: ["useExportShipments", params]
2706
2708
  }));
2707
2709
  };
2708
2710
 
@@ -3733,10 +3735,10 @@ exports.useDeleteSellerApiKey = useDeleteSellerApiKey;
3733
3735
  exports.useDeleteShippingRule = useDeleteShippingRule;
3734
3736
  exports.useDeleteWarehouse = useDeleteWarehouse;
3735
3737
  exports.useDeleteWebhook = useDeleteWebhook;
3736
- exports.useDownloadLabels = useDownloadLabels;
3737
3738
  exports.useDownloadRateCard = useDownloadRateCard;
3738
- exports.useDownloadShipments = useDownloadShipments;
3739
3739
  exports.useEditShippingRule = useEditShippingRule;
3740
+ exports.useExportLabels = useExportLabels;
3741
+ exports.useExportShipments = useExportShipments;
3740
3742
  exports.useFundingSourcesAddFunds = useFundingSourcesAddFunds;
3741
3743
  exports.useGetAccountBilling = useGetAccountBilling;
3742
3744
  exports.useGetAccountBillingPlan = useGetAccountBillingPlan;
package/index.mjs CHANGED
@@ -1083,12 +1083,14 @@ const useUpdateFundingSource = () => {
1083
1083
  mutationFn: (_0) => __async$D(void 0, [_0], function* ({
1084
1084
  billingInfo,
1085
1085
  creditCardInfo,
1086
+ bankAccountInfo,
1086
1087
  fundingSourceId,
1087
1088
  auctanePayInfo
1088
1089
  }) {
1089
1090
  const result = yield client.fundingSources.update(
1090
1091
  billingInfo,
1091
1092
  creditCardInfo,
1093
+ bankAccountInfo,
1092
1094
  auctanePayInfo,
1093
1095
  fundingSourceId
1094
1096
  );
@@ -1734,13 +1736,13 @@ var __objRest$e = (source, exclude) => {
1734
1736
  }
1735
1737
  return target;
1736
1738
  };
1737
- const useDownloadLabels = (params) => {
1739
+ const useExportLabels = (params) => {
1738
1740
  const { client } = useShipEngine();
1739
1741
  const _a = __spreadValues$i({}, params), { queryFnParams } = _a, rest = __objRest$e(_a, ["queryFnParams"]);
1740
1742
  return useQuery(__spreadProps$h(__spreadValues$i({}, rest), {
1741
1743
  onError,
1742
- queryFn: () => client.labels.download(queryFnParams),
1743
- queryKey: ["useDownloadLabels", params]
1744
+ queryFn: () => client.labels.export(queryFnParams),
1745
+ queryKey: ["useExportLabels", params]
1744
1746
  }));
1745
1747
  };
1746
1748
 
@@ -2693,13 +2695,13 @@ var __objRest$6 = (source, exclude) => {
2693
2695
  }
2694
2696
  return target;
2695
2697
  };
2696
- const useDownloadShipments = (params) => {
2698
+ const useExportShipments = (params) => {
2697
2699
  const { client } = useShipEngine();
2698
2700
  const _a = __spreadValues$c({}, params), { queryFnParams } = _a, rest = __objRest$6(_a, ["queryFnParams"]);
2699
2701
  return useQuery(__spreadProps$b(__spreadValues$c({}, rest), {
2700
2702
  onError,
2701
- queryFn: () => client.shipments.download(queryFnParams),
2702
- queryKey: ["useDownloadShipments", params]
2703
+ queryFn: () => client.shipments.export(queryFnParams),
2704
+ queryKey: ["useExportShipments", params]
2703
2705
  }));
2704
2706
  };
2705
2707
 
@@ -3693,4 +3695,4 @@ const useUpdateWebhook = (params) => {
3693
3695
  }));
3694
3696
  };
3695
3697
 
3696
- export { ShipEngine, ShipEngineContext, delay, logger, onError, retryUntil, useAddFunds, useAddInsuranceFunds, useAddSandboxCarriers, useCalculateRates, useCancelShipment, useCarrierConnectionsServicesList, useConnectCarrier, useConnectCarrierAccount, useCreateAccountImage, useCreateAuctanePaySession, useCreateFundingSource, useCreateInvoiceAddress, useCreateLabel, useCreateLabelByRateId, useCreateLabelByShipmentId, useCreateRateCard, useCreateSalesOrderShipment, useCreateSandboxSeller, useCreateSellerApiKey, useCreateShipment, useCreateShippingRule, useCreateWarehouse, useCreateWebhook, useDeactivateOrderSource, useDeleteAccountImage, useDeleteCarrier, useDeleteRateCard, useDeleteSellerApiKey, useDeleteShippingRule, useDeleteWarehouse, useDeleteWebhook, useDownloadLabels, useDownloadRateCard, useDownloadShipments, useEditShippingRule, useFundingSourcesAddFunds, useGetAccountBilling, useGetAccountBillingPlan, useGetAccountImages, useGetAccountSettings, useGetAuctanePayConfig, useGetAutoFundingConfiguration, useGetCarrierById, useGetCarrierConnectionForm, useGetConnectionsCarrierSettings, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetFundingSourceMetadata, useGetFundingSourceTransactions, useGetHereToken, useGetInsuranceAccount, useGetInsuranceFundingSourceAcceptedTerms, useGetInvoiceAddress, useGetLabel, useGetPackageRatingGroupByCarrier, useGetRateCardById, useGetSalesOrder, useGetSalesOrderByExternalOrderId, useGetSalesOrderShipment, useGetServicePoint, useGetServicesByCarrier, useGetShipment, useGetShipmentByExternalId, useGetShipmentRates, useGetShippingRuleById, useGetShippingRuleConditionsOptions, useGetThemeById, useGetZonesByCarrier, useListCarrierConnections, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListLabelsInfinite, useListOrderSources, useListOrderSourcesConnections, useListRateCards, useListSalesOrderShipments, useListSalesOrderShipmentsByExternalOrderId, useListSalesOrders, useListSandboxSellerIds, useListSellerApiKeys, useListServicePoints, useListShipments, useListShippingRules, useListWarehouses, useListWebhooks, useNotifySalesOrderShipped, useParseAddress, usePublishRateCard, useRatesEstimate, useRefreshOrderSource, useRefreshOrderSourceAsync, useRegisterCarrier, useShipEngine, useUpdateAccountBillingPlan, useUpdateAccountImage, useUpdateAccountSettings, useUpdateAutoFunding, useUpdateConnectionsCarrierSettings, useUpdateFundingSource, useUpdateInvoiceAddress, useUpdateOrderSource, useUpdateRateCard, useUpdateSalesOrderShipment, useUpdateWarehouse, useUpdateWebhook, useUploadRateCard, useUpsertAccountBilling, useValidateAddresses, useVoidLabel };
3698
+ export { ShipEngine, ShipEngineContext, delay, logger, onError, retryUntil, useAddFunds, useAddInsuranceFunds, useAddSandboxCarriers, useCalculateRates, useCancelShipment, useCarrierConnectionsServicesList, useConnectCarrier, useConnectCarrierAccount, useCreateAccountImage, useCreateAuctanePaySession, useCreateFundingSource, useCreateInvoiceAddress, useCreateLabel, useCreateLabelByRateId, useCreateLabelByShipmentId, useCreateRateCard, useCreateSalesOrderShipment, useCreateSandboxSeller, useCreateSellerApiKey, useCreateShipment, useCreateShippingRule, useCreateWarehouse, useCreateWebhook, useDeactivateOrderSource, useDeleteAccountImage, useDeleteCarrier, useDeleteRateCard, useDeleteSellerApiKey, useDeleteShippingRule, useDeleteWarehouse, useDeleteWebhook, useDownloadRateCard, useEditShippingRule, useExportLabels, useExportShipments, useFundingSourcesAddFunds, useGetAccountBilling, useGetAccountBillingPlan, useGetAccountImages, useGetAccountSettings, useGetAuctanePayConfig, useGetAutoFundingConfiguration, useGetCarrierById, useGetCarrierConnectionForm, useGetConnectionsCarrierSettings, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetFundingSourceMetadata, useGetFundingSourceTransactions, useGetHereToken, useGetInsuranceAccount, useGetInsuranceFundingSourceAcceptedTerms, useGetInvoiceAddress, useGetLabel, useGetPackageRatingGroupByCarrier, useGetRateCardById, useGetSalesOrder, useGetSalesOrderByExternalOrderId, useGetSalesOrderShipment, useGetServicePoint, useGetServicesByCarrier, useGetShipment, useGetShipmentByExternalId, useGetShipmentRates, useGetShippingRuleById, useGetShippingRuleConditionsOptions, useGetThemeById, useGetZonesByCarrier, useListCarrierConnections, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListLabelsInfinite, useListOrderSources, useListOrderSourcesConnections, useListRateCards, useListSalesOrderShipments, useListSalesOrderShipmentsByExternalOrderId, useListSalesOrders, useListSandboxSellerIds, useListSellerApiKeys, useListServicePoints, useListShipments, useListShippingRules, useListWarehouses, useListWebhooks, useNotifySalesOrderShipped, useParseAddress, usePublishRateCard, useRatesEstimate, useRefreshOrderSource, useRefreshOrderSourceAsync, useRegisterCarrier, useShipEngine, useUpdateAccountBillingPlan, useUpdateAccountImage, useUpdateAccountSettings, useUpdateAutoFunding, useUpdateConnectionsCarrierSettings, useUpdateFundingSource, useUpdateInvoiceAddress, useUpdateOrderSource, useUpdateRateCard, useUpdateSalesOrderShipment, useUpdateWarehouse, useUpdateWebhook, useUploadRateCard, useUpsertAccountBilling, useValidateAddresses, useVoidLabel };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shipengine/react-api",
3
- "version": "4.2.0",
3
+ "version": "4.3.0",
4
4
  "main": "./index.js",
5
5
  "types": "./index.d.ts",
6
6
  "exports": {
@@ -1,7 +0,0 @@
1
- import { DownloadLabelsParams } from "@shipengine/js-api";
2
- import { QueryProps } from "../../utilities";
3
- /**
4
- * @category ShipEngine API Hooks
5
- *
6
- */
7
- export declare const useDownloadLabels: (params?: QueryProps<Blob, DownloadLabelsParams>) => import("@tanstack/react-query").UseQueryResult<import("axios").AxiosResponse<Blob, any>, import("@shipengine/js-api").CodedError[]>;
@@ -1,7 +0,0 @@
1
- import { DownloadShipmentsParams } from "@shipengine/js-api";
2
- import { QueryProps } from "../../utilities";
3
- /**
4
- * @category ShipEngine API Hooks
5
- *
6
- */
7
- export declare const useDownloadShipments: (params?: QueryProps<Blob, DownloadShipmentsParams>) => import("@tanstack/react-query").UseQueryResult<import("axios").AxiosResponse<Blob, any>, import("@shipengine/js-api").CodedError[]>;