/*
 * 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 {
  GetWireInRequestsWireInRequestUuidHeaderXGustoAPIVersion,
  GetWireInRequestsWireInRequestUuidRequest,
} from "../models/operations/getwireinrequestswireinrequestuuid.js";
import { useGustoEmbeddedContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildWireInRequestsGetQuery,
  prefetchWireInRequestsGet,
  queryKeyWireInRequestsGet,
  WireInRequestsGetQueryData,
} from "./wireInRequestsGet.core.js";
export {
  buildWireInRequestsGetQuery,
  prefetchWireInRequestsGet,
  queryKeyWireInRequestsGet,
  type WireInRequestsGetQueryData,
};

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

/**
 * Get a single Wire In Request
 *
 * @remarks
 * Fetch a Wire In Request.
 *
 * scope: `payrolls:read`
 */
export function useWireInRequestsGet(
  request: GetWireInRequestsWireInRequestUuidRequest,
  options?: QueryHookOptions<
    WireInRequestsGetQueryData,
    WireInRequestsGetQueryError
  >,
): UseQueryResult<WireInRequestsGetQueryData, WireInRequestsGetQueryError> {
  const client = useGustoEmbeddedContext();
  return useQuery({
    ...buildWireInRequestsGetQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * Get a single Wire In Request
 *
 * @remarks
 * Fetch a Wire In Request.
 *
 * scope: `payrolls:read`
 */
export function useWireInRequestsGetSuspense(
  request: GetWireInRequestsWireInRequestUuidRequest,
  options?: SuspenseQueryHookOptions<
    WireInRequestsGetQueryData,
    WireInRequestsGetQueryError
  >,
): UseSuspenseQueryResult<
  WireInRequestsGetQueryData,
  WireInRequestsGetQueryError
> {
  const client = useGustoEmbeddedContext();
  return useSuspenseQuery({
    ...buildWireInRequestsGetQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

export function setWireInRequestsGetData(
  client: QueryClient,
  queryKeyBase: [
    wireInRequestUuid: string,
    parameters: {
      xGustoAPIVersion?:
        | GetWireInRequestsWireInRequestUuidHeaderXGustoAPIVersion
        | undefined;
    },
  ],
  data: WireInRequestsGetQueryData,
): WireInRequestsGetQueryData | undefined {
  const key = queryKeyWireInRequestsGet(...queryKeyBase);

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

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

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