/*
 * 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 {
  GetV1CompanyBenefitsCompanyBenefitIdEmployeeBenefitsHeaderXGustoAPIVersion,
  GetV1CompanyBenefitsCompanyBenefitIdEmployeeBenefitsQueryParamInclude,
  GetV1CompanyBenefitsCompanyBenefitIdEmployeeBenefitsRequest,
} from "../models/operations/getv1companybenefitscompanybenefitidemployeebenefits.js";
import { useGustoEmbeddedContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildCompanyBenefitsGetEmployeeBenefitsQuery,
  CompanyBenefitsGetEmployeeBenefitsQueryData,
  prefetchCompanyBenefitsGetEmployeeBenefits,
  queryKeyCompanyBenefitsGetEmployeeBenefits,
} from "./companyBenefitsGetEmployeeBenefits.core.js";
export {
  buildCompanyBenefitsGetEmployeeBenefitsQuery,
  type CompanyBenefitsGetEmployeeBenefitsQueryData,
  prefetchCompanyBenefitsGetEmployeeBenefits,
  queryKeyCompanyBenefitsGetEmployeeBenefits,
};

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

/**
 * Get all employee benefits for a company benefit
 *
 * @remarks
 * Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee's enrollment.
 *
 * Returns an array of all employee benefits enrolled for this company benefit.
 *
 * Benefits containing PHI are only visible to applications with the `employee_benefits:read:phi` scope.
 *
 * scope: `employee_benefits:read`
 */
export function useCompanyBenefitsGetEmployeeBenefits(
  request: GetV1CompanyBenefitsCompanyBenefitIdEmployeeBenefitsRequest,
  options?: QueryHookOptions<
    CompanyBenefitsGetEmployeeBenefitsQueryData,
    CompanyBenefitsGetEmployeeBenefitsQueryError
  >,
): UseQueryResult<
  CompanyBenefitsGetEmployeeBenefitsQueryData,
  CompanyBenefitsGetEmployeeBenefitsQueryError
> {
  const client = useGustoEmbeddedContext();
  return useQuery({
    ...buildCompanyBenefitsGetEmployeeBenefitsQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * Get all employee benefits for a company benefit
 *
 * @remarks
 * Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee's enrollment.
 *
 * Returns an array of all employee benefits enrolled for this company benefit.
 *
 * Benefits containing PHI are only visible to applications with the `employee_benefits:read:phi` scope.
 *
 * scope: `employee_benefits:read`
 */
export function useCompanyBenefitsGetEmployeeBenefitsSuspense(
  request: GetV1CompanyBenefitsCompanyBenefitIdEmployeeBenefitsRequest,
  options?: SuspenseQueryHookOptions<
    CompanyBenefitsGetEmployeeBenefitsQueryData,
    CompanyBenefitsGetEmployeeBenefitsQueryError
  >,
): UseSuspenseQueryResult<
  CompanyBenefitsGetEmployeeBenefitsQueryData,
  CompanyBenefitsGetEmployeeBenefitsQueryError
> {
  const client = useGustoEmbeddedContext();
  return useSuspenseQuery({
    ...buildCompanyBenefitsGetEmployeeBenefitsQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

export function setCompanyBenefitsGetEmployeeBenefitsData(
  client: QueryClient,
  queryKeyBase: [
    companyBenefitId: string,
    parameters: {
      xGustoAPIVersion?:
        | GetV1CompanyBenefitsCompanyBenefitIdEmployeeBenefitsHeaderXGustoAPIVersion
        | undefined;
      page?: number | undefined;
      per?: number | undefined;
      include?:
        | GetV1CompanyBenefitsCompanyBenefitIdEmployeeBenefitsQueryParamInclude
        | undefined;
    },
  ],
  data: CompanyBenefitsGetEmployeeBenefitsQueryData,
): CompanyBenefitsGetEmployeeBenefitsQueryData | undefined {
  const key = queryKeyCompanyBenefitsGetEmployeeBenefits(...queryKeyBase);

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

export function invalidateCompanyBenefitsGetEmployeeBenefits(
  client: QueryClient,
  queryKeyBase: TupleToPrefixes<
    [
      companyBenefitId: string,
      parameters: {
        xGustoAPIVersion?:
          | GetV1CompanyBenefitsCompanyBenefitIdEmployeeBenefitsHeaderXGustoAPIVersion
          | undefined;
        page?: number | undefined;
        per?: number | undefined;
        include?:
          | GetV1CompanyBenefitsCompanyBenefitIdEmployeeBenefitsQueryParamInclude
          | undefined;
      },
    ]
  >,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: [
      "@gusto/embedded-api",
      "companyBenefits",
      "getEmployeeBenefits",
      ...queryKeyBase,
    ],
  });
}

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