/*
 * 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 {
  GetV1EmployeeFormPdfHeaderXGustoAPIVersion,
  GetV1EmployeeFormPdfRequest,
} from "../models/operations/getv1employeeformpdf.js";
import { useGustoEmbeddedContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildEmployeeFormsGetPdfQuery,
  EmployeeFormsGetPdfQueryData,
  prefetchEmployeeFormsGetPdf,
  queryKeyEmployeeFormsGetPdf,
} from "./employeeFormsGetPdf.core.js";
export {
  buildEmployeeFormsGetPdfQuery,
  type EmployeeFormsGetPdfQueryData,
  prefetchEmployeeFormsGetPdf,
  queryKeyEmployeeFormsGetPdf,
};

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

/**
 * Get the employee form pdf
 *
 * @remarks
 * Get the link to the employee form PDF
 *
 * scope: `employee_forms:read`
 */
export function useEmployeeFormsGetPdf(
  request: GetV1EmployeeFormPdfRequest,
  options?: QueryHookOptions<
    EmployeeFormsGetPdfQueryData,
    EmployeeFormsGetPdfQueryError
  >,
): UseQueryResult<EmployeeFormsGetPdfQueryData, EmployeeFormsGetPdfQueryError> {
  const client = useGustoEmbeddedContext();
  return useQuery({
    ...buildEmployeeFormsGetPdfQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * Get the employee form pdf
 *
 * @remarks
 * Get the link to the employee form PDF
 *
 * scope: `employee_forms:read`
 */
export function useEmployeeFormsGetPdfSuspense(
  request: GetV1EmployeeFormPdfRequest,
  options?: SuspenseQueryHookOptions<
    EmployeeFormsGetPdfQueryData,
    EmployeeFormsGetPdfQueryError
  >,
): UseSuspenseQueryResult<
  EmployeeFormsGetPdfQueryData,
  EmployeeFormsGetPdfQueryError
> {
  const client = useGustoEmbeddedContext();
  return useSuspenseQuery({
    ...buildEmployeeFormsGetPdfQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

export function setEmployeeFormsGetPdfData(
  client: QueryClient,
  queryKeyBase: [
    employeeId: string,
    formId: string,
    parameters: {
      xGustoAPIVersion?: GetV1EmployeeFormPdfHeaderXGustoAPIVersion | undefined;
    },
  ],
  data: EmployeeFormsGetPdfQueryData,
): EmployeeFormsGetPdfQueryData | undefined {
  const key = queryKeyEmployeeFormsGetPdf(...queryKeyBase);

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

export function invalidateEmployeeFormsGetPdf(
  client: QueryClient,
  queryKeyBase: TupleToPrefixes<
    [
      employeeId: string,
      formId: string,
      parameters: {
        xGustoAPIVersion?:
          | GetV1EmployeeFormPdfHeaderXGustoAPIVersion
          | undefined;
      },
    ]
  >,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: [
      "@gusto/embedded-api",
      "employeeForms",
      "getPdf",
      ...queryKeyBase,
    ],
  });
}

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