@shipengine/react-api 4.3.4 → 4.4.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/account-billing/use-get-account-billing.d.ts +4 -0
- package/hooks/account-billing/use-upsert-account-billing.d.ts +2 -1
- package/hooks/funding-sources/use-update-funding-source.d.ts +1 -3
- package/hooks/index.d.ts +1 -0
- package/hooks/users/index.d.ts +1 -0
- package/hooks/users/use-list-users.d.ts +8 -0
- package/index.js +768 -727
- package/index.mjs +768 -728
- package/package.json +1 -1
|
@@ -1,3 +1,7 @@
|
|
|
1
1
|
import { SE } from "@shipengine/js-api";
|
|
2
2
|
import { QueryProps } from "../../utilities";
|
|
3
|
+
/**
|
|
4
|
+
* @category ShipEngine API Hooks
|
|
5
|
+
* @see [ShipEngine API Reference](https://auctane.atlassian.net/wiki/spaces/SEEU/pages/5951389743/API+Contract+for+Subscriptions+Billing+Info)
|
|
6
|
+
*/
|
|
3
7
|
export declare const useGetAccountBilling: (params?: QueryProps<SE.AccountBillingResponse>) => import("@tanstack/react-query").UseQueryResult<SE.AccountBillingResponse, SE.CodedError[]>;
|
|
@@ -2,5 +2,6 @@ import { SE } from "@shipengine/js-api";
|
|
|
2
2
|
import { MutationProps } from "../../utilities";
|
|
3
3
|
/**
|
|
4
4
|
* @category ShipEngine API Hooks
|
|
5
|
-
*
|
|
5
|
+
* @see [ShipEngine API Reference](https://auctane.atlassian.net/wiki/spaces/SEEU/pages/5951389743/API+Contract+for+Subscriptions+Billing+Info)
|
|
6
|
+
*/
|
|
6
7
|
export declare const useUpsertAccountBilling: (params?: MutationProps<SE.UpsertAccountBillingRequestBody, SE.AccountBillingResponse>) => import("@tanstack/react-query").UseMutationResult<SE.AccountBillingResponse, SE.CodedError[], SE.UpsertAccountBillingRequestBody, unknown>;
|
|
@@ -2,8 +2,6 @@ import { SE } from "@shipengine/js-api";
|
|
|
2
2
|
export type UpdateFundingSourceData = {
|
|
3
3
|
/** (Optional) Auctane Pay Session info */
|
|
4
4
|
auctanePayInfo?: SE.AuctanePayInfo;
|
|
5
|
-
/** (Optional) Bank Account used for the funding source */
|
|
6
|
-
bankAccountInfo?: SE.BankAccountInfo;
|
|
7
5
|
/** Billing info used for the Funding Source */
|
|
8
6
|
billingInfo: SE.FundingSourceAddress;
|
|
9
7
|
/** (Optional) Credit Card used to the funding source */
|
|
@@ -14,7 +12,7 @@ export type UpdateFundingSourceData = {
|
|
|
14
12
|
/**
|
|
15
13
|
* @internal
|
|
16
14
|
* @category ShipEngine API Hooks
|
|
17
|
-
|
|
15
|
+
*/
|
|
18
16
|
export declare const useUpdateFundingSource: () => import("@tanstack/react-query").UseMutationResult<{
|
|
19
17
|
fundingSource: SE.FundingSource;
|
|
20
18
|
}, SE.CodedError[], UpdateFundingSourceData, unknown>;
|
package/hooks/index.d.ts
CHANGED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./use-list-users";
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { UserListOptions, UserListResponse } from "@shipengine/js-api";
|
|
2
|
+
import { QueryProps } from "../../utilities";
|
|
3
|
+
/**
|
|
4
|
+
* @category ShipEngine API Hooks
|
|
5
|
+
*
|
|
6
|
+
* @see [ShipEngine Developer Docs](https://docs.shipstation.com/openapi/users/listusers)
|
|
7
|
+
*/
|
|
8
|
+
export declare const useListUsers: (params?: QueryProps<UserListResponse, UserListOptions>) => import("@tanstack/react-query").UseQueryResult<UserListResponse, import("@shipengine/js-api").CodedError[]>;
|