@shipengine/react-api 0.1.0

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@shipengine/react-api",
+  "version": "0.1.0",
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./index.mjs",
+      "require": "./index.js"
+    }
+  },
+  "typedoc": {
+    "displayName": "@shipengine/react-api",
+    "entryPoint": "./src/index.ts",
+    "readmeFile": "./README.md",
+    "tsconfig": "./tsconfig.lib.json"
+  }
+}

package/shipengine-api-react/src/hooks/index.d.ts

@@ -0,0 +1,32 @@
+export * from "./use-add-funds";
+export * from "./use-calculate-rates";
+export * from "./use-update-auto-funding";
+export * from "./use-connect-carrier";
+export * from "./use-create-label";
+export * from "./use-create-sales-order-shipment";
+export * from "./use-create-warehouse";
+export * from "./use-delete-warehouse";
+export * from "./use-get-auto-funding-configuration";
+export * from "./use-get-carrier-by-id";
+export * from "./use-get-insurance-account";
+export * from "./use-get-label";
+export * from "./use-get-account-settings";
+export * from "./use-get-wallet-transaction-history";
+export * from "./use-get-sales-order";
+export * from "./use-get-sales-order-shipment";
+export * from "./use-list-carriers";
+export * from "./use-list-labels";
+export * from "./use-list-order-sources";
+export * from "./use-list-custom-package-types";
+export * from "./use-list-sales-orders";
+export * from "./use-list-sales-order-shipments";
+export * from "./use-list-warehouses";
+export * from "./use-notify-sales-order";
+export * from "./use-parse-address";
+export * from "./use-refresh-order-source";
+export * from "./use-update-billing";
+export * from "./use-update-sales-order-shipment";
+export * from "./use-update-warehouse";
+export * from "./use-validate-addresses";
+export * from "./use-void-label";
+export * from "./use-get-shipment";

package/shipengine-api-react/src/hooks/use-add-funds.d.ts

@@ -0,0 +1,10 @@
+import { SE } from "@shipengine/js-api";
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/carriers/add-funds/)
+ * @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/add_funds_to_carrier)
+ */
+export declare const useAddFunds: (carrierId: string) => import("react-query").UseMutationResult<{
+    balance: SE.Money;
+}, SE.CodedError[], SE.Money, unknown>;

package/shipengine-api-react/src/hooks/use-calculate-rates.d.ts

@@ -0,0 +1,16 @@
+import { CalculateRatesOptions } from "@shipengine/js-api";
+export type CalculateRatesData = {
+    rateOptions: CalculateRatesOptions;
+    shipmentId: string;
+};
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/calculate_rates)
+ */
+export declare const useCalculateRates: () => import("react-query").UseMutationResult<Omit<import("@shipengine/js-api").Shipment, "items"> & {
+    items: import("@shipengine/js-api").SalesOrderShipmentItem[];
+    salesOrderIds: string[];
+} & {
+    rateResponse: import("@shipengine/js-api").RateResponse;
+}, import("@shipengine/js-api").CodedError[], CalculateRatesData, unknown>;

package/shipengine-api-react/src/hooks/use-connect-carrier.d.ts

@@ -0,0 +1,7 @@
+import { SE } from "@shipengine/js-api";
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/register-stamps/)
+ */
+export declare const useConnectCarrier: () => import("react-query").UseMutationResult<void, SE.CodedError[], SE.CarrierConnection, unknown>;

package/shipengine-api-react/src/hooks/use-create-label.d.ts

@@ -0,0 +1,11 @@
+import { CreateLabelOptions } from "@shipengine/js-api";
+export type CreateLabelData = {
+    rateId: string;
+} & CreateLabelOptions;
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/labels/create-from-rate/)
+ * @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/create_label_from_rate)
+ */
+export declare const useCreateLabel: () => import("react-query").UseMutationResult<import("@shipengine/js-api").Label, import("@shipengine/js-api").CodedError[], CreateLabelData, unknown>;

package/shipengine-api-react/src/hooks/use-create-sales-order-shipment.d.ts

@@ -0,0 +1,10 @@
+import { SE } from "@shipengine/js-api";
+export type CreateSalesOrderShipmentData = {
+    salesOrderId: string;
+} & Partial<SE.SalesOrderShipment>;
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/orders/create-a-shipment/)
+ */
+export declare const useCreateSalesOrderShipment: () => import("react-query").UseMutationResult<SE.SalesOrderShipment, SE.CodedError[], CreateSalesOrderShipmentData, unknown>;

package/shipengine-api-react/src/hooks/use-create-warehouse.d.ts

@@ -0,0 +1,8 @@
+import { SE } from "@shipengine/js-api";
+export type CreateWarehouseData = Partial<SE.Warehouse>;
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/create-warehouse/)
+ *  */
+export declare const useCreateWarehouse: () => import("react-query").UseMutationResult<SE.Warehouse, SE.CodedError[], Partial<SE.Warehouse>, unknown>;

package/shipengine-api-react/src/hooks/use-delete-warehouse.d.ts

@@ -0,0 +1,9 @@
+export type DeleteWarehouseData = {
+    warehouseId: string;
+};
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/delete-warehouse/)
+ *  */
+export declare const useDeleteWarehouse: () => import("react-query").UseMutationResult<void, import("@shipengine/js-api").CodedError[], DeleteWarehouseData, unknown>;

package/shipengine-api-react/src/hooks/use-get-account-settings.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [https://github.com/ShipEngine/shipengine-api-definition/pull/58/files#diff-775a1c7e38ec7549a98ad8c00e18cb9fc5b4c87ddeb1d496ca3525f48c7381e0
+ */
+export declare const useGetAccountSettings: () => import("react-query").UseQueryResult<import("@shipengine/js-api").Settings, import("@shipengine/js-api").CodedError[]>;

package/shipengine-api-react/src/hooks/use-get-auto-funding-configuration.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @category ShipEngine API Hooks
+ */
+export declare const useGetAutoFundingConfiguration: (carrierId?: string) => import("react-query").UseQueryResult<import("@shipengine/js-api").CarrierAutoFundingSettingsResponse, import("@shipengine/js-api").CodedError[]>;

package/shipengine-api-react/src/hooks/use-get-carrier-by-id.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/get-carrier-by-id/)
+ * @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/get_carrier_by_id)
+ */
+export declare const useGetCarrierById: (carrierId?: string) => import("react-query").UseQueryResult<import("@shipengine/js-api").Carrier, import("@shipengine/js-api").CodedError[]>;

package/shipengine-api-react/src/hooks/use-get-insurance-account.d.ts

@@ -0,0 +1,8 @@
+import { SE } from "@shipengine/js-api";
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/shipping/insurance/#check-your-insurance-balance)
+ * @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/get_insurance_balance)
+ */
+export declare const useGetInsuranceAccount: (insuranceProvider?: SE.InsuranceProvider) => import("react-query").UseQueryResult<SE.InsuranceAccount, SE.CodedError[]>;

package/shipengine-api-react/src/hooks/use-get-label.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/get_label_by_id)
+ */
+export declare const useGetLabel: (labelId?: string) => import("react-query").UseQueryResult<import("@shipengine/js-api").Label, import("@shipengine/js-api").CodedError[]>;

package/shipengine-api-react/src/hooks/use-get-sales-order-shipment.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/orders/get-a-shipment-with-sales-order-items/)
+ */
+export declare const useGetSalesOrderShipment: (shipmentId?: string) => import("react-query").UseQueryResult<import("@shipengine/js-api").SalesOrderShipment, import("@shipengine/js-api").CodedError[]>;

package/shipengine-api-react/src/hooks/use-get-sales-order.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/list-orders/)
+ */
+export declare const useGetSalesOrder: (salesOrderId?: string) => import("react-query").UseQueryResult<import("@shipengine/js-api").SalesOrder, import("@shipengine/js-api").CodedError[]>;

package/shipengine-api-react/src/hooks/use-get-shipment.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/list-orders/)
+ */
+export declare const useGetShipment: (shipmentId: string) => import("react-query").UseQueryResult<import("@shipengine/js-api").SalesOrderShipment, import("@shipengine/js-api").CodedError[]>;

package/shipengine-api-react/src/hooks/use-get-wallet-transaction-history.d.ts

@@ -0,0 +1,5 @@
+import { WalletTransactionHistory } from "@shipengine/js-api";
+/**
+ * @category ShipEngine API Hooks
+ */
+export declare const useGetWalletTransactionHistory: () => WalletTransactionHistory;

package/shipengine-api-react/src/hooks/use-list-carriers.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/list-carriers)
+ * @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/list_carriers)
+ */
+export declare const useListCarriers: () => import("react-query").UseQueryResult<import("@shipengine/js-api").Carrier[], import("@shipengine/js-api").CodedError[]>;

package/shipengine-api-react/src/hooks/use-list-custom-package-types.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/shipping/custom-package-types/#list-your-package-types)
+ * @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#tag/package_types)
+ */
+export declare const useListCustomPackageTypes: () => import("react-query").UseQueryResult<import("@shipengine/js-api").CustomPackage[], import("@shipengine/js-api").CodedError[]>;

package/shipengine-api-react/src/hooks/use-list-labels.d.ts

@@ -0,0 +1,8 @@
+import { ListLabelsParams } from "@shipengine/js-api";
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/list-labels/)
+ * @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/list_labels)
+ */
+export declare const useListLabels: (params?: ListLabelsParams) => import("react-query").UseQueryResult<import("@shipengine/js-api").Label[], import("@shipengine/js-api").CodedError[]>;

package/shipengine-api-react/src/hooks/use-list-order-sources.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/list-order-sources/)
+ */
+export declare const useListOrderSources: () => import("react-query").UseQueryResult<import("@shipengine/js-api").OrderSource[], import("@shipengine/js-api").CodedError[]>;

package/shipengine-api-react/src/hooks/use-list-sales-order-shipments.d.ts

@@ -0,0 +1,5 @@
+import { ListSalesOrderShipmentsParams } from "@shipengine/js-api";
+/**
+ * @category ShipEngine API Hooks
+ */
+export declare const useListSalesOrderShipments: (params?: ListSalesOrderShipmentsParams) => import("react-query").UseQueryResult<import("@shipengine/js-api").SalesOrderShipment[], import("@shipengine/js-api").CodedError[]>;

package/shipengine-api-react/src/hooks/use-list-sales-orders.d.ts

@@ -0,0 +1,7 @@
+import { ListSalesOrdersParams } from "@shipengine/js-api";
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/list-orders/)
+ */
+export declare const useListSalesOrders: (params?: ListSalesOrdersParams) => import("react-query").UseQueryResult<import("@shipengine/js-api").SalesOrder[], import("@shipengine/js-api").CodedError[]>;

package/shipengine-api-react/src/hooks/use-list-warehouses.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/list-warehouses/)
+ * @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/list_warehouses)
+ */
+export declare const useListWarehouses: () => import("react-query").UseQueryResult<import("@shipengine/js-api").Warehouse[], import("@shipengine/js-api").CodedError[]>;

package/shipengine-api-react/src/hooks/use-notify-sales-order.d.ts

@@ -0,0 +1,10 @@
+import { SE } from "@shipengine/js-api";
+export type NotifySalesOrderShippedData = {
+    salesOrderId: string;
+} & SE.SalesOrderTracking;
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/notify-order-source/)
+ */
+export declare const useNotifySalesOrderShipped: () => import("react-query").UseMutationResult<SE.SalesOrder, SE.CodedError[], NotifySalesOrderShippedData, unknown>;

package/shipengine-api-react/src/hooks/use-parse-address.d.ts

@@ -0,0 +1,12 @@
+import { SE } from "@shipengine/js-api";
+export type ParseAddressData = {
+    address?: Partial<SE.Address>;
+    text: string;
+};
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/addresses/parse/)
+ * @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/parse_address)
+ */
+export declare const useParseAddress: () => import("react-query").UseMutationResult<SE.AddressExtraction, SE.CodedError[], ParseAddressData, unknown>;

package/shipengine-api-react/src/hooks/use-refresh-order-source.d.ts

@@ -0,0 +1,11 @@
+import { SE } from "@shipengine/js-api";
+/**
+ * @category ShipEngine API Hooks
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/refresh-order-source/)
+ */
+export declare const useRefreshOrderSourceAsync: () => import("react-query").UseMutationResult<SE.OrderSource, unknown, string, unknown>;
+/**
+ * @category ShipEngine API Hooks
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/refresh-order-source/)
+ */
+export declare const useRefreshOrderSource: () => import("react-query").UseMutationResult<SE.OrderSource, SE.CodedError[], string, unknown>;

package/shipengine-api-react/src/hooks/use-shipengine.d.ts

@@ -0,0 +1 @@
+export declare const useShipEngine: () => import("../providers").ShipEngineContextValue;

package/shipengine-api-react/src/hooks/use-update-auto-funding.d.ts

@@ -0,0 +1,5 @@
+import { SE } from "@shipengine/js-api";
+/**
+ * @category ShipEngine API Hooks
+ */
+export declare const useUpdateAutoFunding: (carrierId: string) => import("react-query").UseMutationResult<SE.CarrierAutoFundingSettingsResponse, SE.CodedError[], SE.CarrierAutoFundingSettings, unknown>;

package/shipengine-api-react/src/hooks/use-update-billing.d.ts

@@ -0,0 +1,8 @@
+import { SE } from "@shipengine/js-api";
+/**
+ * @category ShipEngine API Hooks
+ */
+export declare const useUpdateBilling: () => import("react-query").UseMutationResult<{}, SE.CodedError[], {
+    address: SE.Address;
+    creditCard: SE.CreditCard;
+}, unknown>;

package/shipengine-api-react/src/hooks/use-update-sales-order-shipment.d.ts

@@ -0,0 +1,8 @@
+import { SE } from "@shipengine/js-api";
+export type UpdateSalesOrderShipmentData = Omit<Partial<SE.SalesOrderShipment>, "shipmentId"> & {
+    shipmentId: string;
+};
+/**
+ * @category ShipEngine API Hooks
+ */
+export declare const useUpdateSalesOrderShipment: () => import("react-query").UseMutationResult<SE.SalesOrderShipment, SE.CodedError[], UpdateSalesOrderShipmentData, unknown>;

package/shipengine-api-react/src/hooks/use-update-warehouse.d.ts

@@ -0,0 +1,10 @@
+import { SE } from "@shipengine/js-api";
+export type UpdateWarehouseData = {
+    warehouseId: string;
+} & Partial<SE.Warehouse>;
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/update-warehouse/)
+ *  */
+export declare const useUpdateWarehouse: () => import("react-query").UseMutationResult<void, SE.CodedError[], UpdateWarehouseData, unknown>;

package/shipengine-api-react/src/hooks/use-validate-addresses.d.ts

@@ -0,0 +1,8 @@
+import { SE } from "@shipengine/js-api";
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/addresses/validation)
+ * @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/validate_address)
+ */
+export declare const useValidateAddresses: () => import("react-query").UseMutationResult<SE.AddressValidation[], SE.CodedError[], SE.Address[], unknown>;

package/shipengine-api-react/src/hooks/use-void-label.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/labels/voiding/)
+ * @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/void_label)
+ */
+export declare const useVoidLabel: () => import("react-query").UseMutationResult<import("@shipengine/js-api").VoidRequest, import("@shipengine/js-api").CodedError[], string, unknown>;

package/shipengine-api-react/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./hooks";
+export * from "./providers";
+export * from "./utilities";

package/shipengine-api-react/src/providers/index.d.ts

@@ -0,0 +1 @@
+export * from "./shipengine";

package/shipengine-api-react/src/providers/shipengine.d.ts

@@ -0,0 +1,12 @@
+import { AxiosRequestHeaders } from "axios";
+import { ShipEngineAPI, ShipEngineAPIConfig } from "@shipengine/js-api";
+export interface ShipEngineContextValue {
+    client: ShipEngineAPI;
+}
+export declare const ShipEngineContext: import("react").Context<ShipEngineContextValue | undefined>;
+export type ShipEngineProviderProps = {
+    children: React.ReactNode;
+    getToken: () => Promise<string> | string;
+    headers?: AxiosRequestHeaders;
+} & ShipEngineAPIConfig;
+export declare const ShipEngineProvider: ({ baseURL, children, headers, getToken, }: ShipEngineProviderProps) => JSX.Element;

package/shipengine-api-react/src/utilities/delay.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @category Utilities
+ */
+export declare const delay: (ms: number) => Promise<unknown>;

package/shipengine-api-react/src/utilities/error.d.ts

@@ -0,0 +1,2 @@
+import { SE } from "@shipengine/js-api";
+export declare const onError: (errors: SE.CodedError[]) => void;

package/shipengine-api-react/src/utilities/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./delay";
+export * from "./error";
+export * from "./logger";
+export * from "./retry";

package/shipengine-api-react/src/utilities/logger.d.ts

@@ -0,0 +1 @@
+export declare const logger: import("browser-bunyan").Logger;

package/shipengine-api-react/src/utilities/retry.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @category Utilities
+ */
+export declare const retryUntil: <T>(callbackFn: () => Promise<T>, retries?: number, timeoutBetweenAttempts?: number) => Promise<T>;