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

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 {
  buildClientGovernanceDocumentsVisibilityoverridesListQuery,
  ClientGovernanceDocumentsVisibilityoverridesListQueryData,
  prefetchClientGovernanceDocumentsVisibilityoverridesList,
  queryKeyClientGovernanceDocumentsVisibilityoverridesList,
} from "./clientGovernanceDocumentsVisibilityoverridesList.core.js";
export {
  buildClientGovernanceDocumentsVisibilityoverridesListQuery,
  type ClientGovernanceDocumentsVisibilityoverridesListQueryData,
  prefetchClientGovernanceDocumentsVisibilityoverridesList,
  queryKeyClientGovernanceDocumentsVisibilityoverridesList,
};

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

/**
 * Fetches documents visibility
 *
 * @remarks
 * Fetches the visibility override status of the documents passed.
 */
export function useClientGovernanceDocumentsVisibilityoverridesList(
  docIds?: Array<string> | undefined,
  options?: QueryHookOptions<
    ClientGovernanceDocumentsVisibilityoverridesListQueryData,
    ClientGovernanceDocumentsVisibilityoverridesListQueryError
  >,
): UseQueryResult<
  ClientGovernanceDocumentsVisibilityoverridesListQueryData,
  ClientGovernanceDocumentsVisibilityoverridesListQueryError
> {
  const client = useGleanContext();
  return useQuery({
    ...buildClientGovernanceDocumentsVisibilityoverridesListQuery(
      client,
      docIds,
      options,
    ),
    ...options,
  });
}

/**
 * Fetches documents visibility
 *
 * @remarks
 * Fetches the visibility override status of the documents passed.
 */
export function useClientGovernanceDocumentsVisibilityoverridesListSuspense(
  docIds?: Array<string> | undefined,
  options?: SuspenseQueryHookOptions<
    ClientGovernanceDocumentsVisibilityoverridesListQueryData,
    ClientGovernanceDocumentsVisibilityoverridesListQueryError
  >,
): UseSuspenseQueryResult<
  ClientGovernanceDocumentsVisibilityoverridesListQueryData,
  ClientGovernanceDocumentsVisibilityoverridesListQueryError
> {
  const client = useGleanContext();
  return useSuspenseQuery({
    ...buildClientGovernanceDocumentsVisibilityoverridesListQuery(
      client,
      docIds,
      options,
    ),
    ...options,
  });
}

export function setClientGovernanceDocumentsVisibilityoverridesListData(
  client: QueryClient,
  queryKeyBase: [parameters: { docIds?: Array<string> | undefined }],
  data: ClientGovernanceDocumentsVisibilityoverridesListQueryData,
): ClientGovernanceDocumentsVisibilityoverridesListQueryData | undefined {
  const key = queryKeyClientGovernanceDocumentsVisibilityoverridesList(
    ...queryKeyBase,
  );

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

export function invalidateClientGovernanceDocumentsVisibilityoverridesList(
  client: QueryClient,
  queryKeyBase: TupleToPrefixes<
    [parameters: { docIds?: Array<string> | undefined }]
  >,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: [
      "@gleanwork/api-client",
      "visibilityoverrides",
      "list",
      ...queryKeyBase,
    ],
  });
}

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