@shipengine/react-api 1.0.0-next.5 → 1.0.1
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/account-settings/index.d.ts +2 -0
- package/hooks/{use-get-account-settings.d.ts → account-settings/use-get-account-settings.d.ts} +1 -1
- package/hooks/account-settings/use-update-account-settings.d.ts +5 -0
- package/hooks/addresses/index.d.ts +2 -0
- package/hooks/{use-parse-address.d.ts → addresses/use-parse-address.d.ts} +1 -1
- package/hooks/{use-validate-addresses.d.ts → addresses/use-validate-addresses.d.ts} +1 -1
- package/hooks/carriers/index.d.ts +12 -0
- package/hooks/{use-add-funds.d.ts → carriers/use-add-funds.d.ts} +1 -1
- package/hooks/{use-connect-carrier.d.ts → carriers/use-connect-carrier.d.ts} +1 -1
- package/hooks/carriers/use-get-auto-funding-configuration.d.ts +4 -0
- package/hooks/{use-get-carrier-by-id.d.ts → carriers/use-get-carrier-by-id.d.ts} +1 -1
- package/hooks/carriers/use-get-countries-by-carrier.d.ts +5 -0
- package/hooks/carriers/use-get-currencies-by-carrier.d.ts +5 -0
- package/hooks/carriers/use-get-package-rating-group-by-carrier.d.ts +5 -0
- package/hooks/carriers/use-get-services-by-carrier.d.ts +7 -0
- package/hooks/carriers/use-get-wallet-history.d.ts +10 -0
- package/hooks/carriers/use-get-zones-by-carrier.d.ts +4 -0
- package/hooks/{use-list-carriers.d.ts → carriers/use-list-carriers.d.ts} +1 -1
- package/hooks/carriers/use-update-auto-funding.d.ts +5 -0
- package/hooks/custom-packages/index.d.ts +1 -0
- package/hooks/{use-list-custom-package-types.d.ts → custom-packages/use-list-custom-package-types.d.ts} +1 -1
- package/hooks/funding-sources/index.d.ts +6 -0
- package/hooks/funding-sources/use-create-funding-source.d.ts +7 -0
- package/hooks/funding-sources/use-funding-sources-add-funds.d.ts +7 -0
- package/hooks/funding-sources/use-get-funding-source-by-id.d.ts +4 -0
- package/hooks/funding-sources/use-list-funding-sources.d.ts +4 -0
- package/hooks/funding-sources/use-register-carrier.d.ts +5 -0
- package/hooks/funding-sources/use-update-funding-source.d.ts +12 -0
- package/hooks/index.d.ts +15 -33
- package/hooks/insurance/index.d.ts +1 -0
- package/hooks/{use-get-insurance-account.d.ts → insurance/use-get-insurance-account.d.ts} +1 -1
- package/hooks/labels/index.d.ts +4 -0
- package/hooks/{use-create-label.d.ts → labels/use-create-label.d.ts} +1 -1
- package/hooks/{use-get-label.d.ts → labels/use-get-label.d.ts} +1 -1
- package/hooks/{use-list-labels.d.ts → labels/use-list-labels.d.ts} +1 -1
- package/hooks/{use-void-label.d.ts → labels/use-void-label.d.ts} +1 -1
- package/hooks/order-sources/index.d.ts +2 -0
- package/hooks/order-sources/use-list-order-sources.d.ts +6 -0
- package/hooks/{use-refresh-order-source.d.ts → order-sources/use-refresh-order-source.d.ts} +2 -2
- package/hooks/rate-cards/index.d.ts +8 -0
- package/hooks/rate-cards/use-create-rate-card.d.ts +6 -0
- package/hooks/rate-cards/use-delete-rate-card.d.ts +4 -0
- package/hooks/rate-cards/use-download-rate-card.d.ts +5 -0
- package/hooks/rate-cards/use-get-rate-card-by-id.d.ts +5 -0
- package/hooks/rate-cards/use-list-rate-cards.d.ts +5 -0
- package/hooks/rate-cards/use-publish-rate-card.d.ts +5 -0
- package/hooks/rate-cards/use-update-rate-card.d.ts +6 -0
- package/hooks/rate-cards/use-upload-rate-card.d.ts +9 -0
- package/hooks/rates/index.d.ts +1 -0
- package/hooks/{use-calculate-rates.d.ts → rates/use-calculate-rates.d.ts} +1 -1
- package/hooks/sales-orders/index.d.ts +3 -0
- package/hooks/{use-get-sales-order.d.ts → sales-orders/use-get-sales-order.d.ts} +1 -1
- package/hooks/{use-list-sales-orders.d.ts → sales-orders/use-list-sales-orders.d.ts} +1 -1
- package/hooks/{use-notify-sales-order.d.ts → sales-orders/use-notify-sales-order.d.ts} +1 -1
- package/hooks/sales-orders-shipment/index.d.ts +4 -0
- package/hooks/{use-create-sales-order-shipment.d.ts → sales-orders-shipment/use-create-sales-order-shipment.d.ts} +1 -1
- package/hooks/{use-get-sales-order-shipment.d.ts → sales-orders-shipment/use-get-sales-order-shipment.d.ts} +1 -1
- package/hooks/{use-list-sales-order-shipments.d.ts → sales-orders-shipment/use-list-sales-order-shipments.d.ts} +1 -1
- package/hooks/{use-update-sales-order-shipment.d.ts → sales-orders-shipment/use-update-sales-order-shipment.d.ts} +1 -1
- package/hooks/shipments/index.d.ts +4 -0
- package/hooks/shipments/use-create-shipment.d.ts +10 -0
- package/hooks/shipments/use-get-shipment-rates.d.ts +6 -0
- package/hooks/shipments/use-get-shipment.d.ts +6 -0
- package/hooks/shipments/use-list-shipments.d.ts +7 -0
- package/hooks/warehouses/index.d.ts +4 -0
- package/hooks/{use-create-warehouse.d.ts → warehouses/use-create-warehouse.d.ts} +1 -1
- package/hooks/{use-delete-warehouse.d.ts → warehouses/use-delete-warehouse.d.ts} +1 -1
- package/hooks/warehouses/use-list-warehouses.d.ts +10 -0
- package/hooks/{use-update-warehouse.d.ts → warehouses/use-update-warehouse.d.ts} +1 -1
- package/index.js +1559 -16
- package/index.mjs +1412 -3264
- package/package.json +5 -4
- package/hooks/use-get-auto-funding-configuration.d.ts +0 -4
- package/hooks/use-get-shipment.d.ts +0 -6
- package/hooks/use-get-wallet-transaction-history.d.ts +0 -5
- package/hooks/use-list-order-sources.d.ts +0 -6
- package/hooks/use-list-warehouses.d.ts +0 -7
- package/hooks/use-update-account-settings.d.ts +0 -10
- package/hooks/use-update-auto-funding.d.ts +0 -5
- package/hooks/use-update-billing.d.ts +0 -8
package/hooks/{use-get-account-settings.d.ts → account-settings/use-get-account-settings.d.ts}
RENAMED
|
@@ -3,4 +3,4 @@
|
|
|
3
3
|
*
|
|
4
4
|
* @see [https://github.com/ShipEngine/shipengine-api-definition/pull/58/files#diff-775a1c7e38ec7549a98ad8c00e18cb9fc5b4c87ddeb1d496ca3525f48c7381e0
|
|
5
5
|
*/
|
|
6
|
-
export declare const useGetAccountSettings: () => import("react-query").UseQueryResult<import("@shipengine/js-api").AccountSettings, import("@shipengine/js-api").CodedError[]>;
|
|
6
|
+
export declare const useGetAccountSettings: () => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").AccountSettings, import("@shipengine/js-api").CodedError[]>;
|
|
@@ -9,4 +9,4 @@ export type ParseAddressData = {
|
|
|
9
9
|
* @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/addresses/parse/)
|
|
10
10
|
* @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/parse_address)
|
|
11
11
|
*/
|
|
12
|
-
export declare const useParseAddress: () => import("react-query").UseMutationResult<SE.AddressExtraction, SE.CodedError[], ParseAddressData, unknown>;
|
|
12
|
+
export declare const useParseAddress: () => import("@tanstack/react-query").UseMutationResult<SE.AddressExtraction, SE.CodedError[], ParseAddressData, unknown>;
|
|
@@ -5,4 +5,4 @@ import { SE } from "@shipengine/js-api";
|
|
|
5
5
|
* @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/addresses/validation)
|
|
6
6
|
* @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/validate_address)
|
|
7
7
|
*/
|
|
8
|
-
export declare const useValidateAddresses: () => import("react-query").UseMutationResult<SE.AddressValidation[], SE.CodedError[], SE.Address[], unknown>;
|
|
8
|
+
export declare const useValidateAddresses: () => import("@tanstack/react-query").UseMutationResult<SE.AddressValidation[], SE.CodedError[], SE.Address[], unknown>;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
export * from "./use-add-funds";
|
|
2
|
+
export * from "./use-connect-carrier";
|
|
3
|
+
export * from "./use-get-auto-funding-configuration";
|
|
4
|
+
export * from "./use-get-carrier-by-id";
|
|
5
|
+
export * from "./use-get-countries-by-carrier";
|
|
6
|
+
export * from "./use-get-currencies-by-carrier";
|
|
7
|
+
export * from "./use-get-package-rating-group-by-carrier";
|
|
8
|
+
export * from "./use-get-services-by-carrier";
|
|
9
|
+
export * from "./use-get-wallet-history";
|
|
10
|
+
export * from "./use-list-carriers";
|
|
11
|
+
export * from "./use-update-auto-funding";
|
|
12
|
+
export * from "./use-get-zones-by-carrier";
|
|
@@ -5,6 +5,6 @@ import { SE } from "@shipengine/js-api";
|
|
|
5
5
|
* @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/carriers/add-funds/)
|
|
6
6
|
* @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/add_funds_to_carrier)
|
|
7
7
|
*/
|
|
8
|
-
export declare const useAddFunds: (carrierId: string) => import("react-query").UseMutationResult<{
|
|
8
|
+
export declare const useAddFunds: (carrierId: string) => import("@tanstack/react-query").UseMutationResult<{
|
|
9
9
|
balance: SE.Money;
|
|
10
10
|
}, SE.CodedError[], SE.Money, unknown>;
|
|
@@ -4,4 +4,4 @@ import { SE } from "@shipengine/js-api";
|
|
|
4
4
|
*
|
|
5
5
|
* @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/register-stamps/)
|
|
6
6
|
*/
|
|
7
|
-
export declare const useConnectCarrier: () => import("react-query").UseMutationResult<void, SE.CodedError[], SE.CarrierConnection, unknown>;
|
|
7
|
+
export declare const useConnectCarrier: () => import("@tanstack/react-query").UseMutationResult<void, SE.CodedError[], SE.CarrierConnection, unknown>;
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @category ShipEngine API Hooks
|
|
3
|
+
*/
|
|
4
|
+
export declare const useGetAutoFundingConfiguration: (carrierId?: string) => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").CarrierAutoFundingSettingsResponse, import("@shipengine/js-api").CodedError[]>;
|
|
@@ -4,4 +4,4 @@
|
|
|
4
4
|
* @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/get-carrier-by-id/)
|
|
5
5
|
* @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/get_carrier_by_id)
|
|
6
6
|
*/
|
|
7
|
-
export declare const useGetCarrierById: (carrierId?: string) => import("react-query").UseQueryResult<import("@shipengine/js-api").Carrier, import("@shipengine/js-api").CodedError[]>;
|
|
7
|
+
export declare const useGetCarrierById: (carrierId?: string) => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").Carrier, import("@shipengine/js-api").CodedError[]>;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @category ShipEngine API Hooks
|
|
3
|
+
*
|
|
4
|
+
* @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/list-carrier-services/)
|
|
5
|
+
* @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/list_carrier_services)
|
|
6
|
+
*/
|
|
7
|
+
export declare const useGetServicesByCarrier: (carrierId?: string) => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").CarrierService[], import("@shipengine/js-api").CodedError[]>;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @category ShipEngine API Hooks
|
|
3
|
+
*
|
|
4
|
+
* @see https://react-query-v3.tanstack.com/guides/paginated-queries
|
|
5
|
+
*/
|
|
6
|
+
export declare const useGetWalletHistory: ({ enabled, page, range, }: {
|
|
7
|
+
enabled: boolean;
|
|
8
|
+
page: number;
|
|
9
|
+
range: [Date, Date];
|
|
10
|
+
}) => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").WalletTransactionHistory, import("@shipengine/js-api").CodedError[]>;
|
|
@@ -4,4 +4,4 @@
|
|
|
4
4
|
* @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/list-carriers)
|
|
5
5
|
* @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/list_carriers)
|
|
6
6
|
*/
|
|
7
|
-
export declare const useListCarriers: () => import("react-query").UseQueryResult<import("@shipengine/js-api").Carrier[], import("@shipengine/js-api").CodedError[]>;
|
|
7
|
+
export declare const useListCarriers: () => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").Carrier[], import("@shipengine/js-api").CodedError[]>;
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { SE } from "@shipengine/js-api";
|
|
2
|
+
/**
|
|
3
|
+
* @category ShipEngine API Hooks
|
|
4
|
+
*/
|
|
5
|
+
export declare const useUpdateAutoFunding: (carrierId: string) => import("@tanstack/react-query").UseMutationResult<SE.CarrierAutoFundingSettingsResponse, SE.CodedError[], SE.CarrierAutoFundingSettings, unknown>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./use-list-custom-package-types";
|
|
@@ -4,4 +4,4 @@
|
|
|
4
4
|
* @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/shipping/custom-package-types/#list-your-package-types)
|
|
5
5
|
* @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#tag/package_types)
|
|
6
6
|
*/
|
|
7
|
-
export declare const useListCustomPackageTypes: () => import("react-query").UseQueryResult<import("@shipengine/js-api").CustomPackage[], import("@shipengine/js-api").CodedError[]>;
|
|
7
|
+
export declare const useListCustomPackageTypes: () => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").CustomPackage[], import("@shipengine/js-api").CodedError[]>;
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export * from "./use-create-funding-source";
|
|
2
|
+
export * from "./use-funding-sources-add-funds";
|
|
3
|
+
export * from "./use-get-funding-source-by-id";
|
|
4
|
+
export * from "./use-list-funding-sources";
|
|
5
|
+
export * from "./use-register-carrier";
|
|
6
|
+
export * from "./use-update-funding-source";
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { SE } from "@shipengine/js-api";
|
|
2
|
+
/**
|
|
3
|
+
* @category ShipEngine API Hooks
|
|
4
|
+
* */
|
|
5
|
+
export declare const useCreateFundingSource: () => import("@tanstack/react-query").UseMutationResult<{
|
|
6
|
+
fundingSource: SE.FundingSource;
|
|
7
|
+
}, SE.CodedError[], SE.CreateFundingSource, unknown>;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { SE } from "@shipengine/js-api";
|
|
2
|
+
/**
|
|
3
|
+
* @category ShipEngine API Hooks
|
|
4
|
+
*
|
|
5
|
+
* @see [ShipEngine API Reference](https://auctane.atlassian.net/wiki/spaces/~6272e3473d0b58006947a648/pages/3628370266/ShipEngine+Funding+Sources+API#PUT-v1/funding_sources/%7Bfunding_source_id%7D/add_funds)
|
|
6
|
+
*/
|
|
7
|
+
export declare const useFundingSourcesAddFunds: (fundingSourceId: string) => import("@tanstack/react-query").UseMutationResult<SE.AddFundsResponse, SE.CodedError[], SE.Money, unknown>;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { SE } from "@shipengine/js-api";
|
|
2
|
+
export type UpdateFundingSourceData = {
|
|
3
|
+
billingInfo: SE.FundingSourceAddress;
|
|
4
|
+
creditCardInfo: SE.CreditCardInfo;
|
|
5
|
+
fundingSourceId: string;
|
|
6
|
+
};
|
|
7
|
+
/**
|
|
8
|
+
* @category ShipEngine API Hooks
|
|
9
|
+
* */
|
|
10
|
+
export declare const useUpdateFundingSource: () => import("@tanstack/react-query").UseMutationResult<{
|
|
11
|
+
fundingSource: SE.FundingSource;
|
|
12
|
+
}, SE.CodedError[], UpdateFundingSourceData, unknown>;
|
package/hooks/index.d.ts
CHANGED
|
@@ -1,33 +1,15 @@
|
|
|
1
|
-
export * from "./
|
|
2
|
-
export * from "./
|
|
3
|
-
export * from "./
|
|
4
|
-
export * from "./
|
|
5
|
-
export * from "./
|
|
6
|
-
export * from "./
|
|
7
|
-
export * from "./
|
|
8
|
-
export * from "./
|
|
9
|
-
export * from "./
|
|
10
|
-
export * from "./
|
|
11
|
-
export * from "./
|
|
12
|
-
export * from "./
|
|
13
|
-
export * from "./
|
|
14
|
-
export * from "./
|
|
15
|
-
export * from "./
|
|
16
|
-
export * from "./use-get-wallet-transaction-history";
|
|
17
|
-
export * from "./use-list-carriers";
|
|
18
|
-
export * from "./use-list-custom-package-types";
|
|
19
|
-
export * from "./use-list-labels";
|
|
20
|
-
export * from "./use-list-order-sources";
|
|
21
|
-
export * from "./use-list-sales-order-shipments";
|
|
22
|
-
export * from "./use-list-sales-orders";
|
|
23
|
-
export * from "./use-list-warehouses";
|
|
24
|
-
export * from "./use-notify-sales-order";
|
|
25
|
-
export * from "./use-parse-address";
|
|
26
|
-
export * from "./use-refresh-order-source";
|
|
27
|
-
export * from "./use-update-account-settings";
|
|
28
|
-
export * from "./use-update-auto-funding";
|
|
29
|
-
export * from "./use-update-billing";
|
|
30
|
-
export * from "./use-update-sales-order-shipment";
|
|
31
|
-
export * from "./use-update-warehouse";
|
|
32
|
-
export * from "./use-validate-addresses";
|
|
33
|
-
export * from "./use-void-label";
|
|
1
|
+
export * from "./account-settings";
|
|
2
|
+
export * from "./addresses";
|
|
3
|
+
export * from "./carriers";
|
|
4
|
+
export * from "./custom-packages";
|
|
5
|
+
export * from "./funding-sources";
|
|
6
|
+
export * from "./insurance";
|
|
7
|
+
export * from "./labels";
|
|
8
|
+
export * from "./order-sources";
|
|
9
|
+
export * from "./rate-cards";
|
|
10
|
+
export * from "./rates";
|
|
11
|
+
export * from "./sales-orders";
|
|
12
|
+
export * from "./sales-orders-shipment";
|
|
13
|
+
export * from "./shipments";
|
|
14
|
+
export * from "./warehouses";
|
|
15
|
+
export * from "./rate-cards";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./use-get-insurance-account";
|
|
@@ -5,4 +5,4 @@ import { SE } from "@shipengine/js-api";
|
|
|
5
5
|
* @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/shipping/insurance/#check-your-insurance-balance)
|
|
6
6
|
* @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/get_insurance_balance)
|
|
7
7
|
*/
|
|
8
|
-
export declare const useGetInsuranceAccount: (insuranceProvider?: SE.InsuranceProvider) => import("react-query").UseQueryResult<SE.InsuranceAccount, SE.CodedError[]>;
|
|
8
|
+
export declare const useGetInsuranceAccount: (insuranceProvider?: SE.InsuranceProvider) => import("@tanstack/react-query").UseQueryResult<SE.InsuranceAccount, SE.CodedError[]>;
|
|
@@ -8,4 +8,4 @@ export type CreateLabelData = {
|
|
|
8
8
|
* @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/labels/create-from-rate/)
|
|
9
9
|
* @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/create_label_from_rate)
|
|
10
10
|
*/
|
|
11
|
-
export declare const useCreateLabel: () => import("react-query").UseMutationResult<import("@shipengine/js-api").Label, import("@shipengine/js-api").CodedError[], CreateLabelData, unknown>;
|
|
11
|
+
export declare const useCreateLabel: () => import("@tanstack/react-query").UseMutationResult<import("@shipengine/js-api").Label, import("@shipengine/js-api").CodedError[], CreateLabelData, unknown>;
|
|
@@ -3,4 +3,4 @@
|
|
|
3
3
|
*
|
|
4
4
|
* @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/get_label_by_id)
|
|
5
5
|
*/
|
|
6
|
-
export declare const useGetLabel: (labelId?: string) => import("react-query").UseQueryResult<import("@shipengine/js-api").Label, import("@shipengine/js-api").CodedError[]>;
|
|
6
|
+
export declare const useGetLabel: (labelId?: string) => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").Label, import("@shipengine/js-api").CodedError[]>;
|
|
@@ -5,4 +5,4 @@ import { ListLabelsParams } from "@shipengine/js-api";
|
|
|
5
5
|
* @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/list-labels/)
|
|
6
6
|
* @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/list_labels)
|
|
7
7
|
*/
|
|
8
|
-
export declare const useListLabels: (params?: ListLabelsParams) => import("react-query").UseQueryResult<import("@shipengine/js-api").Label[], import("@shipengine/js-api").CodedError[]>;
|
|
8
|
+
export declare const useListLabels: (params?: ListLabelsParams) => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").Label[], import("@shipengine/js-api").CodedError[]>;
|
|
@@ -4,4 +4,4 @@
|
|
|
4
4
|
* @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/labels/voiding/)
|
|
5
5
|
* @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/void_label)
|
|
6
6
|
*/
|
|
7
|
-
export declare const useVoidLabel: () => import("react-query").UseMutationResult<import("@shipengine/js-api").VoidRequest, import("@shipengine/js-api").CodedError[], string, unknown>;
|
|
7
|
+
export declare const useVoidLabel: () => import("@tanstack/react-query").UseMutationResult<import("@shipengine/js-api").VoidRequest, import("@shipengine/js-api").CodedError[], string, unknown>;
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @category ShipEngine API Hooks
|
|
3
|
+
*
|
|
4
|
+
* @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/list-order-sources/)
|
|
5
|
+
*/
|
|
6
|
+
export declare const useListOrderSources: () => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").OrderSource[], import("@shipengine/js-api").CodedError[]>;
|
|
@@ -3,9 +3,9 @@ import { SE } from "@shipengine/js-api";
|
|
|
3
3
|
* @category ShipEngine API Hooks
|
|
4
4
|
* @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/refresh-order-source/)
|
|
5
5
|
*/
|
|
6
|
-
export declare const useRefreshOrderSourceAsync: () => import("react-query").UseMutationResult<SE.OrderSource, unknown, string, unknown>;
|
|
6
|
+
export declare const useRefreshOrderSourceAsync: () => import("@tanstack/react-query").UseMutationResult<SE.OrderSource, unknown, string, unknown>;
|
|
7
7
|
/**
|
|
8
8
|
* @category ShipEngine API Hooks
|
|
9
9
|
* @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/refresh-order-source/)
|
|
10
10
|
*/
|
|
11
|
-
export declare const useRefreshOrderSource: () => import("react-query").UseMutationResult<SE.OrderSource, SE.CodedError[], string, unknown>;
|
|
11
|
+
export declare const useRefreshOrderSource: () => import("@tanstack/react-query").UseMutationResult<SE.OrderSource, SE.CodedError[], string, unknown>;
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export * from "./use-create-rate-card";
|
|
2
|
+
export * from "./use-download-rate-card";
|
|
3
|
+
export * from "./use-get-rate-card-by-id";
|
|
4
|
+
export * from "./use-list-rate-cards";
|
|
5
|
+
export * from "./use-publish-rate-card";
|
|
6
|
+
export * from "./use-update-rate-card";
|
|
7
|
+
export * from "./use-upload-rate-card";
|
|
8
|
+
export * from "./use-delete-rate-card";
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { RateCardInput } from "@shipengine/js-api";
|
|
2
|
+
/**
|
|
3
|
+
* @category ShipEngine API Hooks
|
|
4
|
+
*
|
|
5
|
+
*/
|
|
6
|
+
export declare const useCreateRateCard: () => import("@tanstack/react-query").UseMutationResult<import("@shipengine/js-api").RateCard, import("@shipengine/js-api").CodedError[], RateCardInput, unknown>;
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
export type UploadRateCardData = {
|
|
2
|
+
file: File;
|
|
3
|
+
rateCardId: string;
|
|
4
|
+
};
|
|
5
|
+
/**
|
|
6
|
+
* @category ShipEngine API Hooks
|
|
7
|
+
*
|
|
8
|
+
*/
|
|
9
|
+
export declare const useUploadRateCard: () => import("@tanstack/react-query").UseMutationResult<import("@shipengine/js-api").RateCard, import("@shipengine/js-api").CodedError[], UploadRateCardData, unknown>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./use-calculate-rates";
|
|
@@ -8,7 +8,7 @@ export type CalculateRatesData = {
|
|
|
8
8
|
*
|
|
9
9
|
* @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/calculate_rates)
|
|
10
10
|
*/
|
|
11
|
-
export declare const useCalculateRates: () => import("react-query").UseMutationResult<Omit<import("@shipengine/js-api").Shipment, "items"> & {
|
|
11
|
+
export declare const useCalculateRates: () => import("@tanstack/react-query").UseMutationResult<Omit<import("@shipengine/js-api").Shipment, "items"> & {
|
|
12
12
|
items: import("@shipengine/js-api").SalesOrderShipmentItem[];
|
|
13
13
|
salesOrderIds: string[];
|
|
14
14
|
} & {
|
|
@@ -3,4 +3,4 @@
|
|
|
3
3
|
*
|
|
4
4
|
* @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/list-orders/)
|
|
5
5
|
*/
|
|
6
|
-
export declare const useGetSalesOrder: (salesOrderId?: string) => import("react-query").UseQueryResult<import("@shipengine/js-api").SalesOrder, import("@shipengine/js-api").CodedError[]>;
|
|
6
|
+
export declare const useGetSalesOrder: (salesOrderId?: string) => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").SalesOrder, import("@shipengine/js-api").CodedError[]>;
|
|
@@ -4,4 +4,4 @@ import { ListSalesOrdersParams } from "@shipengine/js-api";
|
|
|
4
4
|
*
|
|
5
5
|
* @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/list-orders/)
|
|
6
6
|
*/
|
|
7
|
-
export declare const useListSalesOrders: (params?: ListSalesOrdersParams) => import("react-query").UseQueryResult<import("@shipengine/js-api").SalesOrder[], import("@shipengine/js-api").CodedError[]>;
|
|
7
|
+
export declare const useListSalesOrders: (params?: ListSalesOrdersParams) => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").SalesOrder[], import("@shipengine/js-api").CodedError[]>;
|
|
@@ -7,4 +7,4 @@ export type NotifySalesOrderShippedData = {
|
|
|
7
7
|
*
|
|
8
8
|
* @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/notify-order-source/)
|
|
9
9
|
*/
|
|
10
|
-
export declare const useNotifySalesOrderShipped: () => import("react-query").UseMutationResult<SE.SalesOrder, SE.CodedError[], NotifySalesOrderShippedData, unknown>;
|
|
10
|
+
export declare const useNotifySalesOrderShipped: () => import("@tanstack/react-query").UseMutationResult<SE.SalesOrder, SE.CodedError[], NotifySalesOrderShippedData, unknown>;
|
|
@@ -7,4 +7,4 @@ export type CreateSalesOrderShipmentData = {
|
|
|
7
7
|
*
|
|
8
8
|
* @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/orders/create-a-shipment/)
|
|
9
9
|
*/
|
|
10
|
-
export declare const useCreateSalesOrderShipment: () => import("react-query").UseMutationResult<SE.SalesOrderShipment, SE.CodedError[], CreateSalesOrderShipmentData, unknown>;
|
|
10
|
+
export declare const useCreateSalesOrderShipment: () => import("@tanstack/react-query").UseMutationResult<SE.SalesOrderShipment, SE.CodedError[], CreateSalesOrderShipmentData, unknown>;
|
|
@@ -3,4 +3,4 @@
|
|
|
3
3
|
*
|
|
4
4
|
* @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/orders/get-a-shipment-with-sales-order-items/)
|
|
5
5
|
*/
|
|
6
|
-
export declare const useGetSalesOrderShipment: (shipmentId?: string) => import("react-query").UseQueryResult<import("@shipengine/js-api").SalesOrderShipment, import("@shipengine/js-api").CodedError[]>;
|
|
6
|
+
export declare const useGetSalesOrderShipment: (shipmentId?: string) => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").SalesOrderShipment, import("@shipengine/js-api").CodedError[]>;
|
|
@@ -2,4 +2,4 @@ import { ListSalesOrderShipmentsParams } from "@shipengine/js-api";
|
|
|
2
2
|
/**
|
|
3
3
|
* @category ShipEngine API Hooks
|
|
4
4
|
*/
|
|
5
|
-
export declare const useListSalesOrderShipments: (params?: ListSalesOrderShipmentsParams) => import("react-query").UseQueryResult<import("@shipengine/js-api").SalesOrderShipment[], import("@shipengine/js-api").CodedError[]>;
|
|
5
|
+
export declare const useListSalesOrderShipments: (params?: ListSalesOrderShipmentsParams) => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").SalesOrderShipment[], import("@shipengine/js-api").CodedError[]>;
|
|
@@ -5,4 +5,4 @@ export type UpdateSalesOrderShipmentData = Omit<Partial<SE.SalesOrderShipment>,
|
|
|
5
5
|
/**
|
|
6
6
|
* @category ShipEngine API Hooks
|
|
7
7
|
*/
|
|
8
|
-
export declare const useUpdateSalesOrderShipment: () => import("react-query").UseMutationResult<SE.SalesOrderShipment, SE.CodedError[], UpdateSalesOrderShipmentData, unknown>;
|
|
8
|
+
export declare const useUpdateSalesOrderShipment: () => import("@tanstack/react-query").UseMutationResult<SE.SalesOrderShipment, SE.CodedError[], UpdateSalesOrderShipmentData, unknown>;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { SE } from "@shipengine/js-api";
|
|
2
|
+
export type CreateShipmentData = {
|
|
3
|
+
warehouseId: string;
|
|
4
|
+
} & Partial<Omit<SE.Shipment, "items">>;
|
|
5
|
+
/**
|
|
6
|
+
* @category ShipEngine API Hooks
|
|
7
|
+
*
|
|
8
|
+
* @see [ShipEngine Developer Docs](https://shipengine.github.io/shipengine-openapi/#operation/create_shipments)
|
|
9
|
+
*/
|
|
10
|
+
export declare const useCreateShipment: () => import("@tanstack/react-query").UseMutationResult<import("@shipengine/js-api").CreateShipmentResult, SE.CodedError[], CreateShipmentData, unknown>;
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @category ShipEngine API Hooks
|
|
3
|
+
*
|
|
4
|
+
* @see [ShipEngine Developer Docs](https://shipengine.github.io/shipengine-openapi/#operation/list_shipment_rates)
|
|
5
|
+
*/
|
|
6
|
+
export declare const useGetShipmentRates: (shipmentId?: string, createdAtStart?: string) => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").ShipmentRateResponse, import("@shipengine/js-api").CodedError[]>;
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @category ShipEngine API Hooks
|
|
3
|
+
*
|
|
4
|
+
* @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/list-orders/)
|
|
5
|
+
*/
|
|
6
|
+
export declare const useGetShipment: (shipmentId?: string) => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").SalesOrderShipment, import("@shipengine/js-api").CodedError[]>;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { ListShipmentOptions } from "@shipengine/js-api";
|
|
2
|
+
/**
|
|
3
|
+
* @category ShipEngine API Hooks
|
|
4
|
+
*/
|
|
5
|
+
export declare const useListShipments: (_params?: ListShipmentOptions & {
|
|
6
|
+
enabled?: boolean;
|
|
7
|
+
}) => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").ListShipmentResult, import("@shipengine/js-api").CodedError[]>;
|
|
@@ -5,4 +5,4 @@ export type CreateWarehouseData = Partial<SE.Warehouse>;
|
|
|
5
5
|
*
|
|
6
6
|
* @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/create-warehouse/)
|
|
7
7
|
* */
|
|
8
|
-
export declare const useCreateWarehouse: () => import("react-query").UseMutationResult<SE.Warehouse, SE.CodedError[], Partial<SE.Warehouse>, unknown>;
|
|
8
|
+
export declare const useCreateWarehouse: () => import("@tanstack/react-query").UseMutationResult<SE.Warehouse, SE.CodedError[], Partial<SE.Warehouse>, unknown>;
|
|
@@ -6,4 +6,4 @@ export type DeleteWarehouseData = {
|
|
|
6
6
|
*
|
|
7
7
|
* @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/delete-warehouse/)
|
|
8
8
|
* */
|
|
9
|
-
export declare const useDeleteWarehouse: () => import("react-query").UseMutationResult<void, import("@shipengine/js-api").CodedError[], DeleteWarehouseData, unknown>;
|
|
9
|
+
export declare const useDeleteWarehouse: () => import("@tanstack/react-query").UseMutationResult<void, import("@shipengine/js-api").CodedError[], DeleteWarehouseData, unknown>;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export type ListWarehouseOptions = {
|
|
2
|
+
enabled?: boolean;
|
|
3
|
+
};
|
|
4
|
+
/**
|
|
5
|
+
* @category ShipEngine API Hooks
|
|
6
|
+
*
|
|
7
|
+
* @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/list-warehouses/)
|
|
8
|
+
* @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/list_warehouses)
|
|
9
|
+
*/
|
|
10
|
+
export declare const useListWarehouses: (options?: ListWarehouseOptions) => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").Warehouse[], import("@shipengine/js-api").CodedError[]>;
|
|
@@ -7,4 +7,4 @@ export type UpdateWarehouseData = {
|
|
|
7
7
|
*
|
|
8
8
|
* @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/update-warehouse/)
|
|
9
9
|
* */
|
|
10
|
-
export declare const useUpdateWarehouse: () => import("react-query").UseMutationResult<void, SE.CodedError[], UpdateWarehouseData, unknown>;
|
|
10
|
+
export declare const useUpdateWarehouse: () => import("@tanstack/react-query").UseMutationResult<void, SE.CodedError[], UpdateWarehouseData, unknown>;
|