@shipengine/react-api 2.15.2 → 3.0.0

package/hooks/carriers/use-list-carriers.d.ts

@@ -1,7 +1,9 @@
+import { Carrier, SandboxableQuery } from "@shipengine/js-api";
+import { QueryProps } from "../../utilities";
 /**
  * @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("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").Carrier[], import("@shipengine/js-api").CodedError[]>;
+export declare const useListCarriers: (params?: QueryProps<Carrier[], SandboxableQuery>) => import("@tanstack/react-query").UseQueryResult<Carrier[], import("@shipengine/js-api").CodedError[]>;

package/hooks/shipping-rules/use-create-shipping-rule.d.ts

@@ -1,6 +1,8 @@
-import { ShippingRuleCreateInput } from "@shipengine/js-api";
+import { SandboxableMutation, ShippingRuleCreateInput } from "@shipengine/js-api";
 /**
  * @category ShipEngine API Hooks
  *
  */
-export declare const useCreateShippingRule: () => import("@tanstack/react-query").UseMutationResult<import("@shipengine/js-api").ShippingRule, import("@shipengine/js-api").CodedError[], ShippingRuleCreateInput, unknown>;
+export declare const useCreateShippingRule: () => import("@tanstack/react-query").UseMutationResult<import("@shipengine/js-api").ShippingRule, import("@shipengine/js-api").CodedError[], SandboxableMutation<{
+    shippingRule: ShippingRuleCreateInput;
+}>, unknown>;

package/hooks/shipping-rules/use-delete-shipping-rule.d.ts

@@ -1,5 +1,8 @@
+import { SandboxableMutation } from "@shipengine/js-api";
 /**
  * @category ShipEngine API Hooks
  *
  */
-export declare const useDeleteShippingRule: () => import("@tanstack/react-query").UseMutationResult<any, import("@shipengine/js-api").CodedError[], string, unknown>;
+export declare const useDeleteShippingRule: () => import("@tanstack/react-query").UseMutationResult<any, import("@shipengine/js-api").CodedError[], SandboxableMutation<{
+    shippingRuleId: string;
+}>, unknown>;

package/hooks/shipping-rules/use-edit-shipping-rule.d.ts

@@ -1,6 +1,8 @@
-import { ShippingRuleEditInput } from "@shipengine/js-api";
+import { SandboxableMutation, ShippingRuleEditInput } from "@shipengine/js-api";
 /**
  * @category ShipEngine API Hooks
  *
  */
-export declare const useEditShippingRule: () => import("@tanstack/react-query").UseMutationResult<import("@shipengine/js-api").ShippingRule, import("@shipengine/js-api").CodedError[], ShippingRuleEditInput, unknown>;
+export declare const useEditShippingRule: () => import("@tanstack/react-query").UseMutationResult<import("@shipengine/js-api").ShippingRule, import("@shipengine/js-api").CodedError[], SandboxableMutation<{
+    shippingRule: ShippingRuleEditInput;
+}>, unknown>;

package/hooks/shipping-rules/use-get-shipping-rule-by-id.d.ts

@@ -1,5 +1,9 @@
+import { SandboxableQuery, ShippingRule } from "@shipengine/js-api";
+import { QueryProps } from "../../utilities";
 /**
  * @category ShipEngine API Hooks
  *
  */
-export declare const useGetShippingRuleById: (shippingRuleId: string) => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").ShippingRule, import("@shipengine/js-api").CodedError[]>;
+export declare const useGetShippingRuleById: (params: QueryProps<ShippingRule, SandboxableQuery<{
+    shippingRuleId: string;
+}>>) => import("@tanstack/react-query").UseQueryResult<ShippingRule, import("@shipengine/js-api").CodedError[]>;

package/hooks/shipping-rules/use-get-shipping-rule-conditions-options.d.ts

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

package/hooks/shipping-rules/use-list-shipping-rules.d.ts

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

package/hooks/warehouses/use-list-warehouses.d.ts

@@ -1,10 +1,9 @@
-export type ListWarehouseOptions = {
-    enabled?: boolean;
-};
+import { SandboxableQuery, Warehouse } from "@shipengine/js-api";
+import { QueryProps } from "../../utilities";
 /**
  * @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: (options?: ListWarehouseOptions) => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").Warehouse[], import("@shipengine/js-api").CodedError[]>;
+export declare const useListWarehouses: (params?: QueryProps<Warehouse[], SandboxableQuery>) => import("@tanstack/react-query").UseQueryResult<Warehouse[], import("@shipengine/js-api").CodedError[]>;