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

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 {
  buildClientGovernanceDataPoliciesListQuery,
  ClientGovernanceDataPoliciesListQueryData,
  prefetchClientGovernanceDataPoliciesList,
  queryKeyClientGovernanceDataPoliciesList,
} from "./clientGovernanceDataPoliciesList.core.js";
export {
  buildClientGovernanceDataPoliciesListQuery,
  type ClientGovernanceDataPoliciesListQueryData,
  prefetchClientGovernanceDataPoliciesList,
  queryKeyClientGovernanceDataPoliciesList,
};

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

/**
 * Lists policies
 *
 * @remarks
 * Lists policies with filtering.
 */
export function useClientGovernanceDataPoliciesList(
  autoHide?: boolean | undefined,
  frequency?: string | undefined,
  options?: QueryHookOptions<
    ClientGovernanceDataPoliciesListQueryData,
    ClientGovernanceDataPoliciesListQueryError
  >,
): UseQueryResult<
  ClientGovernanceDataPoliciesListQueryData,
  ClientGovernanceDataPoliciesListQueryError
> {
  const client = useGleanContext();
  return useQuery({
    ...buildClientGovernanceDataPoliciesListQuery(
      client,
      autoHide,
      frequency,
      options,
    ),
    ...options,
  });
}

/**
 * Lists policies
 *
 * @remarks
 * Lists policies with filtering.
 */
export function useClientGovernanceDataPoliciesListSuspense(
  autoHide?: boolean | undefined,
  frequency?: string | undefined,
  options?: SuspenseQueryHookOptions<
    ClientGovernanceDataPoliciesListQueryData,
    ClientGovernanceDataPoliciesListQueryError
  >,
): UseSuspenseQueryResult<
  ClientGovernanceDataPoliciesListQueryData,
  ClientGovernanceDataPoliciesListQueryError
> {
  const client = useGleanContext();
  return useSuspenseQuery({
    ...buildClientGovernanceDataPoliciesListQuery(
      client,
      autoHide,
      frequency,
      options,
    ),
    ...options,
  });
}

export function setClientGovernanceDataPoliciesListData(
  client: QueryClient,
  queryKeyBase: [
    parameters: {
      autoHide?: boolean | undefined;
      frequency?: string | undefined;
    },
  ],
  data: ClientGovernanceDataPoliciesListQueryData,
): ClientGovernanceDataPoliciesListQueryData | undefined {
  const key = queryKeyClientGovernanceDataPoliciesList(...queryKeyBase);

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

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

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