@shipengine/react-api 1.12.2 → 1.12.4

package/hooks/carriers/index.d.ts

@@ -6,7 +6,6 @@ export * from "./use-get-countries-by-carrier";
 export * from "./use-get-currencies-by-carrier";
 export * from "./use-get-package-rating-group-by-carrier";
 export * from "./use-get-services-by-carrier";
-export * from "./use-get-wallet-history";
 export * from "./use-list-carriers";
 export * from "./use-update-auto-funding";
 export * from "./use-get-zones-by-carrier";

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

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

package/index.js

@@ -490,24 +490,6 @@ const useGetServicesByCarrier = (carrierId) => {
   });
 };
 
-const useGetWalletHistory = ({
-  enabled,
-  page,
-  range
-}) => {
-  const { client } = useShipEngine();
-  const [startDate, endDate] = range;
-  return reactQuery.useQuery({
-    enabled,
-    keepPreviousData: true,
-    // See https://react-query-v3.tanstack.com/guides/paginated-queries#better-paginated-queries-with-keeppreviousdata
-    onError,
-    queryFn: () => client.carriers.getWalletHistory(startDate, endDate, page),
-    queryKey: ["useGetWalletHistory", startDate, endDate, page],
-    select: (result) => result.data
-  });
-};
-
 const useListCarriers = () => {
   const { client } = useShipEngine();
   return reactQuery.useQuery({
@@ -750,8 +732,8 @@ const useGetFundingSourceMetadata = () => {
 const useGetFundingSourceTransactions = (fundingSourceId, params) => {
   const { client } = useShipEngine();
   return reactQuery.useQuery({
+    enabled: !!fundingSourceId,
     keepPreviousData: true,
-    onError,
     queryFn: () => client.fundingSources.transactions(fundingSourceId, params),
     queryKey: ["useGetFundingSourceTransactions", fundingSourceId, params],
     select: (result) => result.data
@@ -1868,7 +1850,6 @@ exports.useGetShipmentRates = useGetShipmentRates;
 exports.useGetShippingRuleById = useGetShippingRuleById;
 exports.useGetShippingRuleConditionsOptions = useGetShippingRuleConditionsOptions;
 exports.useGetThemeById = useGetThemeById;
-exports.useGetWalletHistory = useGetWalletHistory;
 exports.useGetZonesByCarrier = useGetZonesByCarrier;
 exports.useListCarriers = useListCarriers;
 exports.useListCustomPackageTypes = useListCustomPackageTypes;

package/index.mjs

@@ -487,24 +487,6 @@ const useGetServicesByCarrier = (carrierId) => {
   });
 };
 
-const useGetWalletHistory = ({
-  enabled,
-  page,
-  range
-}) => {
-  const { client } = useShipEngine();
-  const [startDate, endDate] = range;
-  return useQuery({
-    enabled,
-    keepPreviousData: true,
-    // See https://react-query-v3.tanstack.com/guides/paginated-queries#better-paginated-queries-with-keeppreviousdata
-    onError,
-    queryFn: () => client.carriers.getWalletHistory(startDate, endDate, page),
-    queryKey: ["useGetWalletHistory", startDate, endDate, page],
-    select: (result) => result.data
-  });
-};
-
 const useListCarriers = () => {
   const { client } = useShipEngine();
   return useQuery({
@@ -747,8 +729,8 @@ const useGetFundingSourceMetadata = () => {
 const useGetFundingSourceTransactions = (fundingSourceId, params) => {
   const { client } = useShipEngine();
   return useQuery({
+    enabled: !!fundingSourceId,
     keepPreviousData: true,
-    onError,
     queryFn: () => client.fundingSources.transactions(fundingSourceId, params),
     queryKey: ["useGetFundingSourceTransactions", fundingSourceId, params],
     select: (result) => result.data
@@ -1819,4 +1801,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, useGetShippingRuleById, useGetShippingRuleConditionsOptions, useGetThemeById, 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, 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 };

package/package.json

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

package/hooks/carriers/use-get-wallet-history.d.ts

@@ -1,10 +0,0 @@
-/**
- * @category ShipEngine API Hooks
- *
- * @see https://react-query-v3.tanstack.com/guides/paginated-queries
- */
-export declare const useGetWalletHistory: ({ enabled, page, range, }: {
-    enabled: boolean;
-    page: number;
-    range: [Date, Date];
-}) => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").WalletTransactionHistory, import("@shipengine/js-api").CodedError[]>;