/*
 * 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 {
  GetV1CompanyFormHeaderXGustoAPIVersion,
  GetV1CompanyFormRequest,
} from "../models/operations/getv1companyform.js";
import { useGustoEmbeddedContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildCompanyFormsGetQuery,
  CompanyFormsGetQueryData,
  prefetchCompanyFormsGet,
  queryKeyCompanyFormsGet,
} from "./companyFormsGet.core.js";
export {
  buildCompanyFormsGetQuery,
  type CompanyFormsGetQueryData,
  prefetchCompanyFormsGet,
  queryKeyCompanyFormsGet,
};

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

/**
 * Get a company form
 *
 * @remarks
 * Get a company form
 *
 * scope: `company_forms:read`
 */
export function useCompanyFormsGet(
  request: GetV1CompanyFormRequest,
  options?: QueryHookOptions<
    CompanyFormsGetQueryData,
    CompanyFormsGetQueryError
  >,
): UseQueryResult<CompanyFormsGetQueryData, CompanyFormsGetQueryError> {
  const client = useGustoEmbeddedContext();
  return useQuery({
    ...buildCompanyFormsGetQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * Get a company form
 *
 * @remarks
 * Get a company form
 *
 * scope: `company_forms:read`
 */
export function useCompanyFormsGetSuspense(
  request: GetV1CompanyFormRequest,
  options?: SuspenseQueryHookOptions<
    CompanyFormsGetQueryData,
    CompanyFormsGetQueryError
  >,
): UseSuspenseQueryResult<CompanyFormsGetQueryData, CompanyFormsGetQueryError> {
  const client = useGustoEmbeddedContext();
  return useSuspenseQuery({
    ...buildCompanyFormsGetQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

export function setCompanyFormsGetData(
  client: QueryClient,
  queryKeyBase: [
    formId: string,
    parameters: {
      xGustoAPIVersion?: GetV1CompanyFormHeaderXGustoAPIVersion | undefined;
    },
  ],
  data: CompanyFormsGetQueryData,
): CompanyFormsGetQueryData | undefined {
  const key = queryKeyCompanyFormsGet(...queryKeyBase);

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

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

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