/*
 * 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 {
  GetV1ExternalPayrollHeaderXGustoAPIVersion,
  GetV1ExternalPayrollRequest,
} from "../models/operations/getv1externalpayroll.js";
import { useGustoEmbeddedContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildExternalPayrollsRetrieveQuery,
  ExternalPayrollsRetrieveQueryData,
  prefetchExternalPayrollsRetrieve,
  queryKeyExternalPayrollsRetrieve,
} from "./externalPayrollsRetrieve.core.js";
export {
  buildExternalPayrollsRetrieveQuery,
  type ExternalPayrollsRetrieveQueryData,
  prefetchExternalPayrollsRetrieve,
  queryKeyExternalPayrollsRetrieve,
};

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

/**
 * Get an external payroll
 *
 * @remarks
 * Get an external payroll for a given company.
 *
 * scope: `external_payrolls:read`
 */
export function useExternalPayrollsRetrieve(
  request: GetV1ExternalPayrollRequest,
  options?: QueryHookOptions<
    ExternalPayrollsRetrieveQueryData,
    ExternalPayrollsRetrieveQueryError
  >,
): UseQueryResult<
  ExternalPayrollsRetrieveQueryData,
  ExternalPayrollsRetrieveQueryError
> {
  const client = useGustoEmbeddedContext();
  return useQuery({
    ...buildExternalPayrollsRetrieveQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * Get an external payroll
 *
 * @remarks
 * Get an external payroll for a given company.
 *
 * scope: `external_payrolls:read`
 */
export function useExternalPayrollsRetrieveSuspense(
  request: GetV1ExternalPayrollRequest,
  options?: SuspenseQueryHookOptions<
    ExternalPayrollsRetrieveQueryData,
    ExternalPayrollsRetrieveQueryError
  >,
): UseSuspenseQueryResult<
  ExternalPayrollsRetrieveQueryData,
  ExternalPayrollsRetrieveQueryError
> {
  const client = useGustoEmbeddedContext();
  return useSuspenseQuery({
    ...buildExternalPayrollsRetrieveQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

export function setExternalPayrollsRetrieveData(
  client: QueryClient,
  queryKeyBase: [
    companyUuid: string,
    externalPayrollId: string,
    parameters: {
      xGustoAPIVersion?: GetV1ExternalPayrollHeaderXGustoAPIVersion | undefined;
    },
  ],
  data: ExternalPayrollsRetrieveQueryData,
): ExternalPayrollsRetrieveQueryData | undefined {
  const key = queryKeyExternalPayrollsRetrieve(...queryKeyBase);

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

export function invalidateExternalPayrollsRetrieve(
  client: QueryClient,
  queryKeyBase: TupleToPrefixes<
    [
      companyUuid: string,
      externalPayrollId: string,
      parameters: {
        xGustoAPIVersion?:
          | GetV1ExternalPayrollHeaderXGustoAPIVersion
          | undefined;
      },
    ]
  >,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: [
      "@gusto/embedded-api",
      "externalPayrolls",
      "retrieve",
      ...queryKeyBase,
    ],
  });
}

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