/*
 * 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 {
  GetV1ContractorsContractorUuidHeaderXGustoAPIVersion,
  GetV1ContractorsContractorUuidQueryParamInclude,
  GetV1ContractorsContractorUuidRequest,
} from "../models/operations/getv1contractorscontractoruuid.js";
import { useGustoEmbeddedContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildContractorsGetQuery,
  ContractorsGetQueryData,
  prefetchContractorsGet,
  queryKeyContractorsGet,
} from "./contractorsGet.core.js";
export {
  buildContractorsGetQuery,
  type ContractorsGetQueryData,
  prefetchContractorsGet,
  queryKeyContractorsGet,
};

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

/**
 * Get a contractor
 *
 * @remarks
 * Get a contractor.
 *
 * scope: `contractors:read`
 */
export function useContractorsGet(
  request: GetV1ContractorsContractorUuidRequest,
  options?: QueryHookOptions<ContractorsGetQueryData, ContractorsGetQueryError>,
): UseQueryResult<ContractorsGetQueryData, ContractorsGetQueryError> {
  const client = useGustoEmbeddedContext();
  return useQuery({
    ...buildContractorsGetQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * Get a contractor
 *
 * @remarks
 * Get a contractor.
 *
 * scope: `contractors:read`
 */
export function useContractorsGetSuspense(
  request: GetV1ContractorsContractorUuidRequest,
  options?: SuspenseQueryHookOptions<
    ContractorsGetQueryData,
    ContractorsGetQueryError
  >,
): UseSuspenseQueryResult<ContractorsGetQueryData, ContractorsGetQueryError> {
  const client = useGustoEmbeddedContext();
  return useSuspenseQuery({
    ...buildContractorsGetQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

export function setContractorsGetData(
  client: QueryClient,
  queryKeyBase: [
    contractorUuid: string,
    parameters: {
      xGustoAPIVersion?:
        | GetV1ContractorsContractorUuidHeaderXGustoAPIVersion
        | undefined;
      include?:
        | Array<GetV1ContractorsContractorUuidQueryParamInclude>
        | undefined;
    },
  ],
  data: ContractorsGetQueryData,
): ContractorsGetQueryData | undefined {
  const key = queryKeyContractorsGet(...queryKeyBase);

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

export function invalidateContractorsGet(
  client: QueryClient,
  queryKeyBase: TupleToPrefixes<
    [
      contractorUuid: string,
      parameters: {
        xGustoAPIVersion?:
          | GetV1ContractorsContractorUuidHeaderXGustoAPIVersion
          | undefined;
        include?:
          | Array<GetV1ContractorsContractorUuidQueryParamInclude>
          | undefined;
      },
    ]
  >,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: ["@gusto/embedded-api", "Contractors", "get", ...queryKeyBase],
  });
}

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