/*
 * 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 { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import {
  GetV1BenefitsHeaderXGustoAPIVersion,
  GetV1BenefitsRequest,
} from "../models/operations/getv1benefits.js";
import { useGustoEmbeddedContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildCompanyBenefitsGetAllQuery,
  CompanyBenefitsGetAllQueryData,
  prefetchCompanyBenefitsGetAll,
  queryKeyCompanyBenefitsGetAll,
} from "./companyBenefitsGetAll.core.js";
export {
  buildCompanyBenefitsGetAllQuery,
  type CompanyBenefitsGetAllQueryData,
  prefetchCompanyBenefitsGetAll,
  queryKeyCompanyBenefitsGetAll,
};

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

/**
 * Get all supported benefits
 *
 * @remarks
 * Returns all benefits supported by Gusto. The benefit object in Gusto contains high level information about a particular benefit type and its tax considerations. When companies choose to offer a benefit, they are creating a Company Benefit object associated with a particular benefit.
 *
 * scope: `benefits:read`
 */
export function useCompanyBenefitsGetAll(
  request: GetV1BenefitsRequest,
  options?: QueryHookOptions<
    CompanyBenefitsGetAllQueryData,
    CompanyBenefitsGetAllQueryError
  >,
): UseQueryResult<
  CompanyBenefitsGetAllQueryData,
  CompanyBenefitsGetAllQueryError
> {
  const client = useGustoEmbeddedContext();
  return useQuery({
    ...buildCompanyBenefitsGetAllQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * Get all supported benefits
 *
 * @remarks
 * Returns all benefits supported by Gusto. The benefit object in Gusto contains high level information about a particular benefit type and its tax considerations. When companies choose to offer a benefit, they are creating a Company Benefit object associated with a particular benefit.
 *
 * scope: `benefits:read`
 */
export function useCompanyBenefitsGetAllSuspense(
  request: GetV1BenefitsRequest,
  options?: SuspenseQueryHookOptions<
    CompanyBenefitsGetAllQueryData,
    CompanyBenefitsGetAllQueryError
  >,
): UseSuspenseQueryResult<
  CompanyBenefitsGetAllQueryData,
  CompanyBenefitsGetAllQueryError
> {
  const client = useGustoEmbeddedContext();
  return useSuspenseQuery({
    ...buildCompanyBenefitsGetAllQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

export function setCompanyBenefitsGetAllData(
  client: QueryClient,
  queryKeyBase: [
    parameters: {
      xGustoAPIVersion?: GetV1BenefitsHeaderXGustoAPIVersion | undefined;
    },
  ],
  data: CompanyBenefitsGetAllQueryData,
): CompanyBenefitsGetAllQueryData | undefined {
  const key = queryKeyCompanyBenefitsGetAll(...queryKeyBase);

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

export function invalidateCompanyBenefitsGetAll(
  client: QueryClient,
  queryKeyBase: TupleToPrefixes<
    [parameters: {
      xGustoAPIVersion?: GetV1BenefitsHeaderXGustoAPIVersion | undefined;
    }]
  >,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: [
      "@gusto/embedded-api",
      "companyBenefits",
      "getAll",
      ...queryKeyBase,
    ],
  });
}

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