/*
 * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 */

import {
  InvalidateQueryFilters,
  QueryClient,
  useQuery,
  UseQueryResult,
  useSuspenseQuery,
  UseSuspenseQueryResult,
} from "@tanstack/react-query";
import { GustoEmbeddedError } from "../models/errors/gustoembeddederror.js";
import {
  ConnectionError,
  InvalidRequestError,
  RequestAbortedError,
  RequestTimeoutError,
  UnexpectedClientError,
} from "../models/errors/httpclienterrors.js";
import { NotFoundErrorObject } from "../models/errors/notfounderrorobject.js";
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import {
  GetRecoveryCasesHeaderXGustoAPIVersion,
  GetRecoveryCasesRequest,
} from "../models/operations/getrecoverycases.js";
import { useGustoEmbeddedContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildRecoveryCasesGetQuery,
  prefetchRecoveryCasesGet,
  queryKeyRecoveryCasesGet,
  RecoveryCasesGetQueryData,
} from "./recoveryCasesGet.core.js";
export {
  buildRecoveryCasesGetQuery,
  prefetchRecoveryCasesGet,
  queryKeyRecoveryCasesGet,
  type RecoveryCasesGetQueryData,
};

export type RecoveryCasesGetQueryError =
  | NotFoundErrorObject
  | GustoEmbeddedError
  | ResponseValidationError
  | ConnectionError
  | RequestAbortedError
  | RequestTimeoutError
  | InvalidRequestError
  | UnexpectedClientError
  | SDKValidationError;

/**
 * Get all recovery cases for a company
 *
 * @remarks
 * Fetch all recovery cases for a company.
 *
 * scope: `recovery_cases:read`
 */
export function useRecoveryCasesGet(
  request: GetRecoveryCasesRequest,
  options?: QueryHookOptions<
    RecoveryCasesGetQueryData,
    RecoveryCasesGetQueryError
  >,
): UseQueryResult<RecoveryCasesGetQueryData, RecoveryCasesGetQueryError> {
  const client = useGustoEmbeddedContext();
  return useQuery({
    ...buildRecoveryCasesGetQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * Get all recovery cases for a company
 *
 * @remarks
 * Fetch all recovery cases for a company.
 *
 * scope: `recovery_cases:read`
 */
export function useRecoveryCasesGetSuspense(
  request: GetRecoveryCasesRequest,
  options?: SuspenseQueryHookOptions<
    RecoveryCasesGetQueryData,
    RecoveryCasesGetQueryError
  >,
): UseSuspenseQueryResult<
  RecoveryCasesGetQueryData,
  RecoveryCasesGetQueryError
> {
  const client = useGustoEmbeddedContext();
  return useSuspenseQuery({
    ...buildRecoveryCasesGetQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

export function setRecoveryCasesGetData(
  client: QueryClient,
  queryKeyBase: [
    companyUuid: string,
    parameters: {
      xGustoAPIVersion?: GetRecoveryCasesHeaderXGustoAPIVersion | undefined;
      page?: number | undefined;
      per?: number | undefined;
    },
  ],
  data: RecoveryCasesGetQueryData,
): RecoveryCasesGetQueryData | undefined {
  const key = queryKeyRecoveryCasesGet(...queryKeyBase);

  return client.setQueryData<RecoveryCasesGetQueryData>(key, data);
}

export function invalidateRecoveryCasesGet(
  client: QueryClient,
  queryKeyBase: TupleToPrefixes<
    [
      companyUuid: string,
      parameters: {
        xGustoAPIVersion?: GetRecoveryCasesHeaderXGustoAPIVersion | undefined;
        page?: number | undefined;
        per?: number | undefined;
      },
    ]
  >,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: ["@gusto/embedded-api", "recoveryCases", "get", ...queryKeyBase],
  });
}

export function invalidateAllRecoveryCasesGet(
  client: QueryClient,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: ["@gusto/embedded-api", "recoveryCases", "get"],
  });
}