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

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 {
  buildClientGovernanceDataPoliciesDownloadQuery,
  ClientGovernanceDataPoliciesDownloadQueryData,
  prefetchClientGovernanceDataPoliciesDownload,
  queryKeyClientGovernanceDataPoliciesDownload,
} from "./clientGovernanceDataPoliciesDownload.core.js";
export {
  buildClientGovernanceDataPoliciesDownloadQuery,
  type ClientGovernanceDataPoliciesDownloadQueryData,
  prefetchClientGovernanceDataPoliciesDownload,
  queryKeyClientGovernanceDataPoliciesDownload,
};

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

/**
 * Downloads violations CSV for policy
 *
 * @remarks
 * Downloads CSV violations report for a specific policy id. This does not support continuous policies.
 */
export function useClientGovernanceDataPoliciesDownload(
  id: string,
  options?: QueryHookOptions<
    ClientGovernanceDataPoliciesDownloadQueryData,
    ClientGovernanceDataPoliciesDownloadQueryError
  >,
): UseQueryResult<
  ClientGovernanceDataPoliciesDownloadQueryData,
  ClientGovernanceDataPoliciesDownloadQueryError
> {
  const client = useGleanContext();
  return useQuery({
    ...buildClientGovernanceDataPoliciesDownloadQuery(
      client,
      id,
      options,
    ),
    ...options,
  });
}

/**
 * Downloads violations CSV for policy
 *
 * @remarks
 * Downloads CSV violations report for a specific policy id. This does not support continuous policies.
 */
export function useClientGovernanceDataPoliciesDownloadSuspense(
  id: string,
  options?: SuspenseQueryHookOptions<
    ClientGovernanceDataPoliciesDownloadQueryData,
    ClientGovernanceDataPoliciesDownloadQueryError
  >,
): UseSuspenseQueryResult<
  ClientGovernanceDataPoliciesDownloadQueryData,
  ClientGovernanceDataPoliciesDownloadQueryError
> {
  const client = useGleanContext();
  return useSuspenseQuery({
    ...buildClientGovernanceDataPoliciesDownloadQuery(
      client,
      id,
      options,
    ),
    ...options,
  });
}

export function setClientGovernanceDataPoliciesDownloadData(
  client: QueryClient,
  queryKeyBase: [id: string],
  data: ClientGovernanceDataPoliciesDownloadQueryData,
): ClientGovernanceDataPoliciesDownloadQueryData | undefined {
  const key = queryKeyClientGovernanceDataPoliciesDownload(...queryKeyBase);

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

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

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