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

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 * as errors from "../models/errors/index.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 {
  buildClientAgentsRetrieveQuery,
  ClientAgentsRetrieveQueryData,
  prefetchClientAgentsRetrieve,
  queryKeyClientAgentsRetrieve,
} from "./clientAgentsRetrieve.core.js";
export {
  buildClientAgentsRetrieveQuery,
  type ClientAgentsRetrieveQueryData,
  prefetchClientAgentsRetrieve,
  queryKeyClientAgentsRetrieve,
};

export type ClientAgentsRetrieveQueryError =
  | errors.ErrorResponse
  | GleanBaseError
  | ResponseValidationError
  | ConnectionError
  | RequestAbortedError
  | RequestTimeoutError
  | InvalidRequestError
  | UnexpectedClientError
  | SDKValidationError;

/**
 * Retrieve an agent
 *
 * @remarks
 * Returns details of an [agent](https://developers.glean.com/agents/agents-api) created in the Agent Builder.
 */
export function useClientAgentsRetrieve(
  agentId: string,
  locale?: string | undefined,
  timezoneOffset?: number | undefined,
  options?: QueryHookOptions<
    ClientAgentsRetrieveQueryData,
    ClientAgentsRetrieveQueryError
  >,
): UseQueryResult<
  ClientAgentsRetrieveQueryData,
  ClientAgentsRetrieveQueryError
> {
  const client = useGleanContext();
  return useQuery({
    ...buildClientAgentsRetrieveQuery(
      client,
      agentId,
      locale,
      timezoneOffset,
      options,
    ),
    ...options,
  });
}

/**
 * Retrieve an agent
 *
 * @remarks
 * Returns details of an [agent](https://developers.glean.com/agents/agents-api) created in the Agent Builder.
 */
export function useClientAgentsRetrieveSuspense(
  agentId: string,
  locale?: string | undefined,
  timezoneOffset?: number | undefined,
  options?: SuspenseQueryHookOptions<
    ClientAgentsRetrieveQueryData,
    ClientAgentsRetrieveQueryError
  >,
): UseSuspenseQueryResult<
  ClientAgentsRetrieveQueryData,
  ClientAgentsRetrieveQueryError
> {
  const client = useGleanContext();
  return useSuspenseQuery({
    ...buildClientAgentsRetrieveQuery(
      client,
      agentId,
      locale,
      timezoneOffset,
      options,
    ),
    ...options,
  });
}

export function setClientAgentsRetrieveData(
  client: QueryClient,
  queryKeyBase: [
    agentId: string,
    parameters: {
      locale?: string | undefined;
      timezoneOffset?: number | undefined;
    },
  ],
  data: ClientAgentsRetrieveQueryData,
): ClientAgentsRetrieveQueryData | undefined {
  const key = queryKeyClientAgentsRetrieve(...queryKeyBase);

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

export function invalidateClientAgentsRetrieve(
  client: QueryClient,
  queryKeyBase: TupleToPrefixes<
    [
      agentId: string,
      parameters: {
        locale?: string | undefined;
        timezoneOffset?: number | undefined;
      },
    ]
  >,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: ["@gleanwork/api-client", "agents", "retrieve", ...queryKeyBase],
  });
}

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