@shipengine/react-api 0.15.0 → 0.16.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.
- package/hooks/index.d.ts +1 -0
- package/hooks/use-download-rate-card.d.ts +1 -1
- package/hooks/use-get-rate-card-by-id.d.ts +5 -0
- package/index.js +15 -2
- package/index.mjs +15 -3
- package/package.json +1 -1
package/hooks/index.d.ts
CHANGED
|
@@ -20,6 +20,7 @@ export * from "./use-get-sales-order";
|
|
|
20
20
|
export * from "./use-get-sales-order-shipment";
|
|
21
21
|
export * from "./use-get-services-by-carrier";
|
|
22
22
|
export * from "./use-get-shipment";
|
|
23
|
+
export * from "./use-get-rate-card-by-id";
|
|
23
24
|
export * from "./use-get-wallet-history";
|
|
24
25
|
export * from "./use-get-countries-by-carrier";
|
|
25
26
|
export * from "./use-get-currencies-by-carrier";
|
|
@@ -2,4 +2,4 @@
|
|
|
2
2
|
* @category ShipEngine API Hooks
|
|
3
3
|
*
|
|
4
4
|
*/
|
|
5
|
-
export declare const useDownloadRateCard: (rateCardId: string) => import("react-query").UseQueryResult<Blob, import("@shipengine/js-api").CodedError[]>;
|
|
5
|
+
export declare const useDownloadRateCard: (rateCardId: string) => import("react-query").UseQueryResult<import("axios").AxiosResponse<Blob, any>, import("@shipengine/js-api").CodedError[]>;
|
package/index.js
CHANGED
|
@@ -511,8 +511,7 @@ const useDownloadRateCard = (rateCardId) => {
|
|
|
511
511
|
queryFn: () => {
|
|
512
512
|
return client.rateCards.download(rateCardId);
|
|
513
513
|
},
|
|
514
|
-
queryKey: ["useDownloadRateCard", rateCardId]
|
|
515
|
-
select: (result) => result.data
|
|
514
|
+
queryKey: ["useDownloadRateCard", rateCardId]
|
|
516
515
|
});
|
|
517
516
|
};
|
|
518
517
|
|
|
@@ -678,6 +677,19 @@ const useGetShipment = (shipmentId) => {
|
|
|
678
677
|
});
|
|
679
678
|
};
|
|
680
679
|
|
|
680
|
+
const useGetRateCardById = (rateCardId) => {
|
|
681
|
+
const { client } = useShipEngine();
|
|
682
|
+
return reactQuery.useQuery({
|
|
683
|
+
enabled: !!rateCardId,
|
|
684
|
+
onError,
|
|
685
|
+
queryFn: () => {
|
|
686
|
+
return client.rateCards.get(rateCardId);
|
|
687
|
+
},
|
|
688
|
+
queryKey: ["useGetRateCardById", rateCardId],
|
|
689
|
+
select: (result) => result.data
|
|
690
|
+
});
|
|
691
|
+
};
|
|
692
|
+
|
|
681
693
|
const useGetWalletHistory = ({
|
|
682
694
|
enabled,
|
|
683
695
|
page,
|
|
@@ -1358,6 +1370,7 @@ exports.useGetCurrenciesByCarrier = useGetCurrenciesByCarrier;
|
|
|
1358
1370
|
exports.useGetFundingSourceById = useGetFundingSourceById;
|
|
1359
1371
|
exports.useGetInsuranceAccount = useGetInsuranceAccount;
|
|
1360
1372
|
exports.useGetLabel = useGetLabel;
|
|
1373
|
+
exports.useGetRateCardById = useGetRateCardById;
|
|
1361
1374
|
exports.useGetRatePackageFormatsByCarrier = useGetRatePackageFormatsByCarrier;
|
|
1362
1375
|
exports.useGetSalesOrder = useGetSalesOrder;
|
|
1363
1376
|
exports.useGetSalesOrderShipment = useGetSalesOrderShipment;
|
package/index.mjs
CHANGED
|
@@ -508,8 +508,7 @@ const useDownloadRateCard = (rateCardId) => {
|
|
|
508
508
|
queryFn: () => {
|
|
509
509
|
return client.rateCards.download(rateCardId);
|
|
510
510
|
},
|
|
511
|
-
queryKey: ["useDownloadRateCard", rateCardId]
|
|
512
|
-
select: (result) => result.data
|
|
511
|
+
queryKey: ["useDownloadRateCard", rateCardId]
|
|
513
512
|
});
|
|
514
513
|
};
|
|
515
514
|
|
|
@@ -675,6 +674,19 @@ const useGetShipment = (shipmentId) => {
|
|
|
675
674
|
});
|
|
676
675
|
};
|
|
677
676
|
|
|
677
|
+
const useGetRateCardById = (rateCardId) => {
|
|
678
|
+
const { client } = useShipEngine();
|
|
679
|
+
return useQuery({
|
|
680
|
+
enabled: !!rateCardId,
|
|
681
|
+
onError,
|
|
682
|
+
queryFn: () => {
|
|
683
|
+
return client.rateCards.get(rateCardId);
|
|
684
|
+
},
|
|
685
|
+
queryKey: ["useGetRateCardById", rateCardId],
|
|
686
|
+
select: (result) => result.data
|
|
687
|
+
});
|
|
688
|
+
};
|
|
689
|
+
|
|
678
690
|
const useGetWalletHistory = ({
|
|
679
691
|
enabled,
|
|
680
692
|
page,
|
|
@@ -1330,4 +1342,4 @@ const useVoidLabel = () => {
|
|
|
1330
1342
|
});
|
|
1331
1343
|
};
|
|
1332
1344
|
|
|
1333
|
-
export { ShipEngine, ShipEngineContext, delay, logger, onError, retryUntil, useAddFunds, useCalculateRates, useConnectCarrier, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateWarehouse, useDeleteWarehouse, useDownloadRateCard, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetInsuranceAccount, useGetLabel, useGetRatePackageFormatsByCarrier, useGetSalesOrder, useGetSalesOrderShipment, useGetServicesByCarrier, useGetShipment, useGetShipmentRates, useGetWalletHistory, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListOrderSources, useListRateCards, useListSalesOrderShipments, useListSalesOrders, useListShipments, useListWarehouses, useNotifySalesOrderShipped, useParseAddress, useRefreshOrderSource, useRefreshOrderSourceAsync, useRegisterCarrier, useShipEngine, useUpdateAccountSettings, useUpdateAutoFunding, useUpdateFundingSource, useUpdateRateCard, useUpdateSalesOrderShipment, useUpdateWarehouse, useValidateAddresses, useVoidLabel };
|
|
1345
|
+
export { ShipEngine, ShipEngineContext, delay, logger, onError, retryUntil, useAddFunds, useCalculateRates, useConnectCarrier, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateWarehouse, useDeleteWarehouse, useDownloadRateCard, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetInsuranceAccount, useGetLabel, useGetRateCardById, useGetRatePackageFormatsByCarrier, useGetSalesOrder, useGetSalesOrderShipment, useGetServicesByCarrier, useGetShipment, useGetShipmentRates, useGetWalletHistory, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListOrderSources, useListRateCards, useListSalesOrderShipments, useListSalesOrders, useListShipments, useListWarehouses, useNotifySalesOrderShipped, useParseAddress, useRefreshOrderSource, useRefreshOrderSourceAsync, useRegisterCarrier, useShipEngine, useUpdateAccountSettings, useUpdateAutoFunding, useUpdateFundingSource, useUpdateRateCard, useUpdateSalesOrderShipment, useUpdateWarehouse, useValidateAddresses, useVoidLabel };
|