/*
 * 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 {
  GetV1BenefitsBenefitIdHeaderXGustoAPIVersion,
  GetV1BenefitsBenefitIdRequest,
} from "../models/operations/getv1benefitsbenefitid.js";
import { useGustoEmbeddedContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildCompanyBenefitsGetSupportedQuery,
  CompanyBenefitsGetSupportedQueryData,
  prefetchCompanyBenefitsGetSupported,
  queryKeyCompanyBenefitsGetSupported,
} from "./companyBenefitsGetSupported.core.js";
export {
  buildCompanyBenefitsGetSupportedQuery,
  type CompanyBenefitsGetSupportedQueryData,
  prefetchCompanyBenefitsGetSupported,
  queryKeyCompanyBenefitsGetSupported,
};

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

/**
 * Get a supported benefit
 *
 * @remarks
 * Returns a benefit 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 useCompanyBenefitsGetSupported(
  request: GetV1BenefitsBenefitIdRequest,
  options?: QueryHookOptions<
    CompanyBenefitsGetSupportedQueryData,
    CompanyBenefitsGetSupportedQueryError
  >,
): UseQueryResult<
  CompanyBenefitsGetSupportedQueryData,
  CompanyBenefitsGetSupportedQueryError
> {
  const client = useGustoEmbeddedContext();
  return useQuery({
    ...buildCompanyBenefitsGetSupportedQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * Get a supported benefit
 *
 * @remarks
 * Returns a benefit 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 useCompanyBenefitsGetSupportedSuspense(
  request: GetV1BenefitsBenefitIdRequest,
  options?: SuspenseQueryHookOptions<
    CompanyBenefitsGetSupportedQueryData,
    CompanyBenefitsGetSupportedQueryError
  >,
): UseSuspenseQueryResult<
  CompanyBenefitsGetSupportedQueryData,
  CompanyBenefitsGetSupportedQueryError
> {
  const client = useGustoEmbeddedContext();
  return useSuspenseQuery({
    ...buildCompanyBenefitsGetSupportedQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

export function setCompanyBenefitsGetSupportedData(
  client: QueryClient,
  queryKeyBase: [
    benefitId: string,
    parameters: {
      xGustoAPIVersion?:
        | GetV1BenefitsBenefitIdHeaderXGustoAPIVersion
        | undefined;
    },
  ],
  data: CompanyBenefitsGetSupportedQueryData,
): CompanyBenefitsGetSupportedQueryData | undefined {
  const key = queryKeyCompanyBenefitsGetSupported(...queryKeyBase);

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

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

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