/*
 * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 * @generated-id: 8cbac73526d7
 */

import {
  InvalidateQueryFilters,
  QueryClient,
  useQuery,
  UseQueryResult,
  useSuspenseQuery,
  UseSuspenseQueryResult,
} from "@tanstack/react-query";
import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
import {
  ConnectionError,
  InvalidRequestError,
  RequestAbortedError,
  RequestTimeoutError,
  UnexpectedClientError,
} from "../models/errors/httpclienterrors.js";
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import { useGleanContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildClientGovernanceDataReportsDownloadQuery,
  ClientGovernanceDataReportsDownloadQueryData,
  prefetchClientGovernanceDataReportsDownload,
  queryKeyClientGovernanceDataReportsDownload,
} from "./clientGovernanceDataReportsDownload.core.js";
export {
  buildClientGovernanceDataReportsDownloadQuery,
  type ClientGovernanceDataReportsDownloadQueryData,
  prefetchClientGovernanceDataReportsDownload,
  queryKeyClientGovernanceDataReportsDownload,
};

export type ClientGovernanceDataReportsDownloadQueryError =
  | GleanBaseError
  | ResponseValidationError
  | ConnectionError
  | RequestAbortedError
  | RequestTimeoutError
  | InvalidRequestError
  | UnexpectedClientError
  | SDKValidationError;

/**
 * Downloads violations CSV for report
 *
 * @remarks
 * Downloads CSV violations report for a specific report id.
 */
export function useClientGovernanceDataReportsDownload(
  id: string,
  options?: QueryHookOptions<
    ClientGovernanceDataReportsDownloadQueryData,
    ClientGovernanceDataReportsDownloadQueryError
  >,
): UseQueryResult<
  ClientGovernanceDataReportsDownloadQueryData,
  ClientGovernanceDataReportsDownloadQueryError
> {
  const client = useGleanContext();
  return useQuery({
    ...buildClientGovernanceDataReportsDownloadQuery(
      client,
      id,
      options,
    ),
    ...options,
  });
}

/**
 * Downloads violations CSV for report
 *
 * @remarks
 * Downloads CSV violations report for a specific report id.
 */
export function useClientGovernanceDataReportsDownloadSuspense(
  id: string,
  options?: SuspenseQueryHookOptions<
    ClientGovernanceDataReportsDownloadQueryData,
    ClientGovernanceDataReportsDownloadQueryError
  >,
): UseSuspenseQueryResult<
  ClientGovernanceDataReportsDownloadQueryData,
  ClientGovernanceDataReportsDownloadQueryError
> {
  const client = useGleanContext();
  return useSuspenseQuery({
    ...buildClientGovernanceDataReportsDownloadQuery(
      client,
      id,
      options,
    ),
    ...options,
  });
}

export function setClientGovernanceDataReportsDownloadData(
  client: QueryClient,
  queryKeyBase: [id: string],
  data: ClientGovernanceDataReportsDownloadQueryData,
): ClientGovernanceDataReportsDownloadQueryData | undefined {
  const key = queryKeyClientGovernanceDataReportsDownload(...queryKeyBase);

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

export function invalidateClientGovernanceDataReportsDownload(
  client: QueryClient,
  queryKeyBase: TupleToPrefixes<[id: string]>,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: ["@gleanwork/api-client", "reports", "download", ...queryKeyBase],
  });
}

export function invalidateAllClientGovernanceDataReportsDownload(
  client: QueryClient,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: ["@gleanwork/api-client", "reports", "download"],
  });
}