/*
 * 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 {
  GetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsHeaderXGustoAPIVersion,
  GetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsRequest,
} from "../models/operations/getv1companybenefitscompanybenefitidcontributionexclusions.js";
import { useGustoEmbeddedContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildCompanyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsQuery,
  CompanyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsQueryData,
  prefetchCompanyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusions,
  queryKeyCompanyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusions,
} from "./companyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusions.core.js";
export {
  buildCompanyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsQuery,
  type CompanyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsQueryData,
  prefetchCompanyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusions,
  queryKeyCompanyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusions,
};

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

/**
 * Get contribution exclusions for a company benefit
 *
 * @remarks
 * Returns all contributions for a given company benefit and whether they are excluded or not.
 *
 * Currently this endpoint only works for 401-k and Roth 401-k benefit types.
 *
 * scope: `company_benefits:read`
 */
export function useCompanyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusions(
  request: GetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsRequest,
  options?: QueryHookOptions<
    CompanyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsQueryData,
    CompanyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsQueryError
  >,
): UseQueryResult<
  CompanyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsQueryData,
  CompanyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsQueryError
> {
  const client = useGustoEmbeddedContext();
  return useQuery({
    ...buildCompanyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * Get contribution exclusions for a company benefit
 *
 * @remarks
 * Returns all contributions for a given company benefit and whether they are excluded or not.
 *
 * Currently this endpoint only works for 401-k and Roth 401-k benefit types.
 *
 * scope: `company_benefits:read`
 */
export function useCompanyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsSuspense(
  request: GetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsRequest,
  options?: SuspenseQueryHookOptions<
    CompanyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsQueryData,
    CompanyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsQueryError
  >,
): UseSuspenseQueryResult<
  CompanyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsQueryData,
  CompanyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsQueryError
> {
  const client = useGustoEmbeddedContext();
  return useSuspenseQuery({
    ...buildCompanyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

export function setCompanyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsData(
  client: QueryClient,
  queryKeyBase: [
    companyBenefitId: string,
    parameters: {
      xGustoAPIVersion?:
        | GetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsHeaderXGustoAPIVersion
        | undefined;
    },
  ],
  data:
    CompanyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsQueryData,
):
  | CompanyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusionsQueryData
  | undefined
{
  const key =
    queryKeyCompanyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusions(
      ...queryKeyBase,
    );

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

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

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