/*
 * 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 { UnprocessableEntityError } from "../models/errors/unprocessableentityerror.js";
import {
  GetV1ExternalPayrollCalculateTaxesHeaderXGustoAPIVersion,
  GetV1ExternalPayrollCalculateTaxesRequest,
} from "../models/operations/getv1externalpayrollcalculatetaxes.js";
import { useGustoEmbeddedContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildExternalPayrollsCalculateTaxesQuery,
  ExternalPayrollsCalculateTaxesQueryData,
  prefetchExternalPayrollsCalculateTaxes,
  queryKeyExternalPayrollsCalculateTaxes,
} from "./externalPayrollsCalculateTaxes.core.js";
export {
  buildExternalPayrollsCalculateTaxesQuery,
  type ExternalPayrollsCalculateTaxesQueryData,
  prefetchExternalPayrollsCalculateTaxes,
  queryKeyExternalPayrollsCalculateTaxes,
};

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

/**
 * Get tax suggestions for an external payroll
 *
 * @remarks
 * Get tax suggestions for an external payroll. Earnings and/or benefits data must be saved prior to the calculation in order to retrieve accurate tax calculation.
 *
 * scope: `external_payrolls:read`
 */
export function useExternalPayrollsCalculateTaxes(
  request: GetV1ExternalPayrollCalculateTaxesRequest,
  options?: QueryHookOptions<
    ExternalPayrollsCalculateTaxesQueryData,
    ExternalPayrollsCalculateTaxesQueryError
  >,
): UseQueryResult<
  ExternalPayrollsCalculateTaxesQueryData,
  ExternalPayrollsCalculateTaxesQueryError
> {
  const client = useGustoEmbeddedContext();
  return useQuery({
    ...buildExternalPayrollsCalculateTaxesQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * Get tax suggestions for an external payroll
 *
 * @remarks
 * Get tax suggestions for an external payroll. Earnings and/or benefits data must be saved prior to the calculation in order to retrieve accurate tax calculation.
 *
 * scope: `external_payrolls:read`
 */
export function useExternalPayrollsCalculateTaxesSuspense(
  request: GetV1ExternalPayrollCalculateTaxesRequest,
  options?: SuspenseQueryHookOptions<
    ExternalPayrollsCalculateTaxesQueryData,
    ExternalPayrollsCalculateTaxesQueryError
  >,
): UseSuspenseQueryResult<
  ExternalPayrollsCalculateTaxesQueryData,
  ExternalPayrollsCalculateTaxesQueryError
> {
  const client = useGustoEmbeddedContext();
  return useSuspenseQuery({
    ...buildExternalPayrollsCalculateTaxesQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

export function setExternalPayrollsCalculateTaxesData(
  client: QueryClient,
  queryKeyBase: [
    companyUuid: string,
    externalPayrollId: string,
    parameters: {
      xGustoAPIVersion?:
        | GetV1ExternalPayrollCalculateTaxesHeaderXGustoAPIVersion
        | undefined;
    },
  ],
  data: ExternalPayrollsCalculateTaxesQueryData,
): ExternalPayrollsCalculateTaxesQueryData | undefined {
  const key = queryKeyExternalPayrollsCalculateTaxes(...queryKeyBase);

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

export function invalidateExternalPayrollsCalculateTaxes(
  client: QueryClient,
  queryKeyBase: TupleToPrefixes<
    [
      companyUuid: string,
      externalPayrollId: string,
      parameters: {
        xGustoAPIVersion?:
          | GetV1ExternalPayrollCalculateTaxesHeaderXGustoAPIVersion
          | undefined;
      },
    ]
  >,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: [
      "@gusto/embedded-api",
      "externalPayrolls",
      "calculateTaxes",
      ...queryKeyBase,
    ],
  });
}

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