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

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 {
  buildGovernanceDownloadfindingsexportQuery,
  GovernanceDownloadfindingsexportQueryData,
  prefetchGovernanceDownloadfindingsexport,
  queryKeyGovernanceDownloadfindingsexport,
} from "./governanceDownloadfindingsexport.core.js";
export {
  buildGovernanceDownloadfindingsexportQuery,
  type GovernanceDownloadfindingsexportQueryData,
  prefetchGovernanceDownloadfindingsexport,
  queryKeyGovernanceDownloadfindingsexport,
};

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

/**
 * Downloads findings export
 *
 * @remarks
 * Downloads a DLP findings export as a CSV file.
 */
export function useGovernanceDownloadfindingsexport(
  id: string,
  options?: QueryHookOptions<
    GovernanceDownloadfindingsexportQueryData,
    GovernanceDownloadfindingsexportQueryError
  >,
): UseQueryResult<
  GovernanceDownloadfindingsexportQueryData,
  GovernanceDownloadfindingsexportQueryError
> {
  const client = useGleanContext();
  return useQuery({
    ...buildGovernanceDownloadfindingsexportQuery(
      client,
      id,
      options,
    ),
    ...options,
  });
}

/**
 * Downloads findings export
 *
 * @remarks
 * Downloads a DLP findings export as a CSV file.
 */
export function useGovernanceDownloadfindingsexportSuspense(
  id: string,
  options?: SuspenseQueryHookOptions<
    GovernanceDownloadfindingsexportQueryData,
    GovernanceDownloadfindingsexportQueryError
  >,
): UseSuspenseQueryResult<
  GovernanceDownloadfindingsexportQueryData,
  GovernanceDownloadfindingsexportQueryError
> {
  const client = useGleanContext();
  return useSuspenseQuery({
    ...buildGovernanceDownloadfindingsexportQuery(
      client,
      id,
      options,
    ),
    ...options,
  });
}

export function setGovernanceDownloadfindingsexportData(
  client: QueryClient,
  queryKeyBase: [id: string],
  data: GovernanceDownloadfindingsexportQueryData,
): GovernanceDownloadfindingsexportQueryData | undefined {
  const key = queryKeyGovernanceDownloadfindingsexport(...queryKeyBase);

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

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

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