@shipengine/react-api 3.8.3 → 3.9.0

package/hooks/index.d.ts

@@ -5,6 +5,7 @@ export * from "./connections";
 export * from "./custom-packages";
 export * from "./funding-sources";
 export * from "./insurance";
+export * from "./invoice-address";
 export * from "./labels";
 export * from "./order-sources";
 export * from "./rate-cards";

package/hooks/invoice-address/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./use-create-invoice-address";
+export * from "./use-update-invoice-address";
+export * from "./use-get-invoice-address";

package/hooks/invoice-address/use-create-invoice-address.d.ts

@@ -0,0 +1,7 @@
+import { SE } from "@shipengine/js-api";
+import { MutationProps } from "../../utilities";
+/**
+ * @internal
+ * @category ShipEngine API Hooks
+ */
+export declare const useCreateInvoiceAddress: (params?: MutationProps<SE.InvoiceAddress, SE.InvoiceAddress>) => import("@tanstack/react-query").UseMutationResult<SE.InvoiceAddress, SE.CodedError[], SE.InvoiceAddress, unknown>;

package/hooks/invoice-address/use-get-invoice-address.d.ts

@@ -0,0 +1,7 @@
+import { SE } from "@shipengine/js-api";
+import { QueryProps } from "../../utilities";
+/**
+ * @internal
+ * @category ShipEngine API Hooks
+ */
+export declare const useGetInvoiceAddress: (params?: QueryProps<SE.InvoiceAddress>) => import("@tanstack/react-query").UseQueryResult<SE.InvoiceAddress, SE.CodedError[]>;

package/hooks/invoice-address/use-update-invoice-address.d.ts

@@ -0,0 +1,7 @@
+import { SE } from "@shipengine/js-api";
+import { MutationProps } from "../../utilities";
+/**
+ * @internal
+ * @category ShipEngine API Hooks
+ */
+export declare const useUpdateInvoiceAddress: (params?: MutationProps<SE.InvoiceAddress, SE.InvoiceAddress>) => import("@tanstack/react-query").UseMutationResult<SE.InvoiceAddress, SE.CodedError[], SE.InvoiceAddress, unknown>;

package/hooks/sales-orders/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./use-get-sales-order";
+export * from "./use-get-sales-order-by-external-order-id";
 export * from "./use-list-sales-orders";
 export * from "./use-notify-sales-order";

package/hooks/sales-orders/use-get-sales-order-by-external-order-id.d.ts

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

package/hooks/sales-orders/use-get-sales-order.d.ts

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

package/hooks/sales-orders-shipment/index.d.ts

@@ -2,3 +2,4 @@ export * from "./use-create-sales-order-shipment";
 export * from "./use-get-sales-order-shipment";
 export * from "./use-list-sales-order-shipments";
 export * from "./use-update-sales-order-shipment";
+export * from "./use-list-sales-order-shipments-by-external-order-id";

package/hooks/sales-orders-shipment/use-list-sales-order-shipments-by-external-order-id.d.ts

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

package/hooks/sales-orders-shipment/use-list-sales-order-shipments.d.ts

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