/*
 * 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 {
  GetV1ContractorFormPdfHeaderXGustoAPIVersion,
  GetV1ContractorFormPdfRequest,
} from "../models/operations/getv1contractorformpdf.js";
import { useGustoEmbeddedContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildContractorFormsGetPdfQuery,
  ContractorFormsGetPdfQueryData,
  prefetchContractorFormsGetPdf,
  queryKeyContractorFormsGetPdf,
} from "./contractorFormsGetPdf.core.js";
export {
  buildContractorFormsGetPdfQuery,
  type ContractorFormsGetPdfQueryData,
  prefetchContractorFormsGetPdf,
  queryKeyContractorFormsGetPdf,
};

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

/**
 * Get the contractor form pdf
 *
 * @remarks
 * Get the link to the form PDF
 *
 * scope: `contractor_forms:read`
 */
export function useContractorFormsGetPdf(
  request: GetV1ContractorFormPdfRequest,
  options?: QueryHookOptions<
    ContractorFormsGetPdfQueryData,
    ContractorFormsGetPdfQueryError
  >,
): UseQueryResult<
  ContractorFormsGetPdfQueryData,
  ContractorFormsGetPdfQueryError
> {
  const client = useGustoEmbeddedContext();
  return useQuery({
    ...buildContractorFormsGetPdfQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * Get the contractor form pdf
 *
 * @remarks
 * Get the link to the form PDF
 *
 * scope: `contractor_forms:read`
 */
export function useContractorFormsGetPdfSuspense(
  request: GetV1ContractorFormPdfRequest,
  options?: SuspenseQueryHookOptions<
    ContractorFormsGetPdfQueryData,
    ContractorFormsGetPdfQueryError
  >,
): UseSuspenseQueryResult<
  ContractorFormsGetPdfQueryData,
  ContractorFormsGetPdfQueryError
> {
  const client = useGustoEmbeddedContext();
  return useSuspenseQuery({
    ...buildContractorFormsGetPdfQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

export function setContractorFormsGetPdfData(
  client: QueryClient,
  queryKeyBase: [
    contractorUuid: string,
    formId: string,
    parameters: {
      xGustoAPIVersion?:
        | GetV1ContractorFormPdfHeaderXGustoAPIVersion
        | undefined;
    },
  ],
  data: ContractorFormsGetPdfQueryData,
): ContractorFormsGetPdfQueryData | undefined {
  const key = queryKeyContractorFormsGetPdf(...queryKeyBase);

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

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

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