/*
 * 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 {
  GetV1BulkReportsRequestUuidHeaderXGustoAPIVersion,
  GetV1BulkReportsRequestUuidRequest,
  GetV1BulkReportsRequestUuidSecurity,
} from "../models/operations/getv1bulkreportsrequestuuid.js";
import { useGustoEmbeddedContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildReportsGetV1BulkReportsRequestUuidQuery,
  prefetchReportsGetV1BulkReportsRequestUuid,
  queryKeyReportsGetV1BulkReportsRequestUuid,
  ReportsGetV1BulkReportsRequestUuidQueryData,
} from "./reportsGetV1BulkReportsRequestUuid.core.js";
export {
  buildReportsGetV1BulkReportsRequestUuidQuery,
  prefetchReportsGetV1BulkReportsRequestUuid,
  queryKeyReportsGetV1BulkReportsRequestUuid,
  type ReportsGetV1BulkReportsRequestUuidQueryData,
};

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

/**
 * Get a bulk report batch
 *
 * @remarks
 * Get a bulk report batch's status and results given the `request_uuid`. While in progress, only batch metadata is returned; once complete, it also includes a signed `report_url` (a zip of all generated reports, valid for 10 minutes) and a per-company breakdown.
 *
 * Reports containing PHI are inaccessible with `company_reports:read:tier_2_only` data scope.
 *
 * 📘 System Access Authentication
 *
 * This endpoint uses the [Bearer Auth scheme with the system-level access token in the HTTP Authorization header](https://docs.gusto.com/embedded-payroll/docs/system-access)
 *
 * scope: `company_reports:read`
 */
export function useReportsGetV1BulkReportsRequestUuid(
  security: GetV1BulkReportsRequestUuidSecurity,
  request: GetV1BulkReportsRequestUuidRequest,
  options?: QueryHookOptions<
    ReportsGetV1BulkReportsRequestUuidQueryData,
    ReportsGetV1BulkReportsRequestUuidQueryError
  >,
): UseQueryResult<
  ReportsGetV1BulkReportsRequestUuidQueryData,
  ReportsGetV1BulkReportsRequestUuidQueryError
> {
  const client = useGustoEmbeddedContext();
  return useQuery({
    ...buildReportsGetV1BulkReportsRequestUuidQuery(
      client,
      security,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * Get a bulk report batch
 *
 * @remarks
 * Get a bulk report batch's status and results given the `request_uuid`. While in progress, only batch metadata is returned; once complete, it also includes a signed `report_url` (a zip of all generated reports, valid for 10 minutes) and a per-company breakdown.
 *
 * Reports containing PHI are inaccessible with `company_reports:read:tier_2_only` data scope.
 *
 * 📘 System Access Authentication
 *
 * This endpoint uses the [Bearer Auth scheme with the system-level access token in the HTTP Authorization header](https://docs.gusto.com/embedded-payroll/docs/system-access)
 *
 * scope: `company_reports:read`
 */
export function useReportsGetV1BulkReportsRequestUuidSuspense(
  security: GetV1BulkReportsRequestUuidSecurity,
  request: GetV1BulkReportsRequestUuidRequest,
  options?: SuspenseQueryHookOptions<
    ReportsGetV1BulkReportsRequestUuidQueryData,
    ReportsGetV1BulkReportsRequestUuidQueryError
  >,
): UseSuspenseQueryResult<
  ReportsGetV1BulkReportsRequestUuidQueryData,
  ReportsGetV1BulkReportsRequestUuidQueryError
> {
  const client = useGustoEmbeddedContext();
  return useSuspenseQuery({
    ...buildReportsGetV1BulkReportsRequestUuidQuery(
      client,
      security,
      request,
      options,
    ),
    ...options,
  });
}

export function setReportsGetV1BulkReportsRequestUuidData(
  client: QueryClient,
  queryKeyBase: [
    requestUuid: string,
    parameters: {
      xGustoAPIVersion?:
        | GetV1BulkReportsRequestUuidHeaderXGustoAPIVersion
        | undefined;
    },
  ],
  data: ReportsGetV1BulkReportsRequestUuidQueryData,
): ReportsGetV1BulkReportsRequestUuidQueryData | undefined {
  const key = queryKeyReportsGetV1BulkReportsRequestUuid(...queryKeyBase);

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

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

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