@shipengine/react-api 0.8.1 → 0.8.2

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.
@@ -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 useGetShipment: (shipmentId: string) => import("react-query").UseQueryResult<import("@shipengine/js-api").SalesOrderShipment, import("@shipengine/js-api").CodedError[]>;
6
+ export declare const useGetShipment: (shipmentId?: string) => import("react-query").UseQueryResult<import("@shipengine/js-api").SalesOrderShipment, import("@shipengine/js-api").CodedError[]>;
@@ -1,7 +1,10 @@
1
+ export type ListWarehouseOptions = {
2
+ enabled?: boolean;
3
+ };
1
4
  /**
2
5
  * @category ShipEngine API Hooks
3
6
  *
4
7
  * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/list-warehouses/)
5
8
  * @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/list_warehouses)
6
9
  */
7
- export declare const useListWarehouses: () => import("react-query").UseQueryResult<import("@shipengine/js-api").Warehouse[], import("@shipengine/js-api").CodedError[]>;
10
+ export declare const useListWarehouses: (options?: ListWarehouseOptions) => import("react-query").UseQueryResult<import("@shipengine/js-api").Warehouse[], import("@shipengine/js-api").CodedError[]>;
package/index.js CHANGED
@@ -520,10 +520,10 @@ const useGetShipment = (shipmentId) => {
520
520
  enabled: shipmentId !== void 0,
521
521
  onError,
522
522
  queryFn: () => {
523
- if (shipmentId) {
524
- return client.salesOrderShipments.get(shipmentId);
523
+ if (!shipmentId) {
524
+ return Promise.reject(new Error("shipmentId is required"));
525
525
  }
526
- return Promise.reject(new Error("shipmentId is required"));
526
+ return client.salesOrderShipments.get(shipmentId);
527
527
  },
528
528
  queryKey: ["useGetShipment", shipmentId],
529
529
  select: (result) => result.data
@@ -621,9 +621,11 @@ const useListSalesOrders = (params = {}) => {
621
621
  });
622
622
  };
623
623
 
624
- const useListWarehouses = () => {
624
+ const useListWarehouses = (options) => {
625
+ var _a;
625
626
  const { client } = useShipEngine();
626
627
  return reactQuery.useQuery({
628
+ enabled: (_a = options == null ? void 0 : options.enabled) != null ? _a : true,
627
629
  onError,
628
630
  queryFn: () => client.warehouses.list(),
629
631
  queryKey: ["useListWarehouses"],
package/index.mjs CHANGED
@@ -517,10 +517,10 @@ const useGetShipment = (shipmentId) => {
517
517
  enabled: shipmentId !== void 0,
518
518
  onError,
519
519
  queryFn: () => {
520
- if (shipmentId) {
521
- return client.salesOrderShipments.get(shipmentId);
520
+ if (!shipmentId) {
521
+ return Promise.reject(new Error("shipmentId is required"));
522
522
  }
523
- return Promise.reject(new Error("shipmentId is required"));
523
+ return client.salesOrderShipments.get(shipmentId);
524
524
  },
525
525
  queryKey: ["useGetShipment", shipmentId],
526
526
  select: (result) => result.data
@@ -618,9 +618,11 @@ const useListSalesOrders = (params = {}) => {
618
618
  });
619
619
  };
620
620
 
621
- const useListWarehouses = () => {
621
+ const useListWarehouses = (options) => {
622
+ var _a;
622
623
  const { client } = useShipEngine();
623
624
  return useQuery({
625
+ enabled: (_a = options == null ? void 0 : options.enabled) != null ? _a : true,
624
626
  onError,
625
627
  queryFn: () => client.warehouses.list(),
626
628
  queryKey: ["useListWarehouses"],
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shipengine/react-api",
3
- "version": "0.8.1",
3
+ "version": "0.8.2",
4
4
  "main": "./index.js",
5
5
  "types": "./index.d.ts",
6
6
  "exports": {