libs/internal-sdk/src/react-query/agentsRetrieve.ts - next - githubmirror/novu

libs/internal-sdk/src/react-query/agentsRetrieve.ts
138 строк4 KB
AdemDev
feat(providers): add LINE Messaging API chat provider fixes NV-7614 (#11148)
13 июл 2026, 11:20
13 июл 2026, 11:2051e40a8
/*
 * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 */

import {
  InvalidateQueryFilters,
  QueryClient,
  useQuery,
  UseQueryResult,
  useSuspenseQuery,
  UseSuspenseQueryResult,
} from "@tanstack/react-query";
import {
  ConnectionError,
  InvalidRequestError,
  RequestAbortedError,
  RequestTimeoutError,
  UnexpectedClientError,
} from "../models/errors/httpclienterrors.js";
import * as errors from "../models/errors/index.js";
import { NovuError } from "../models/errors/novuerror.js";
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import { useNovuContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  AgentsRetrieveQueryData,
  buildAgentsRetrieveQuery,
  prefetchAgentsRetrieve,
  queryKeyAgentsRetrieve,
} from "./agentsRetrieve.core.js";
export {
  type AgentsRetrieveQueryData,
  buildAgentsRetrieveQuery,
  prefetchAgentsRetrieve,
  queryKeyAgentsRetrieve,
};

export type AgentsRetrieveQueryError =
  | errors.ErrorDto
  | errors.ValidationErrorDto
  | NovuError
  | ResponseValidationError
  | ConnectionError
  | RequestAbortedError
  | RequestTimeoutError
  | InvalidRequestError
  | UnexpectedClientError
  | SDKValidationError;

/**
 * Retrieve an agent
 *
 * @remarks
 * Retrieve an agent by its external identifier (not the internal MongoDB id).
 */
export function useAgentsRetrieve(
  identifier: string,
  idempotencyKey?: string | undefined,
  options?: QueryHookOptions<AgentsRetrieveQueryData, AgentsRetrieveQueryError>,
): UseQueryResult<AgentsRetrieveQueryData, AgentsRetrieveQueryError> {
  const client = useNovuContext();
  return useQuery({
    ...buildAgentsRetrieveQuery(
      client,
      identifier,
      idempotencyKey,
      options,
    ),
    ...options,
  });
}

/**
 * Retrieve an agent
 *
 * @remarks
 * Retrieve an agent by its external identifier (not the internal MongoDB id).
 */
export function useAgentsRetrieveSuspense(
  identifier: string,
  idempotencyKey?: string | undefined,
  options?: SuspenseQueryHookOptions<
    AgentsRetrieveQueryData,
    AgentsRetrieveQueryError
  >,
): UseSuspenseQueryResult<AgentsRetrieveQueryData, AgentsRetrieveQueryError> {
  const client = useNovuContext();
  return useSuspenseQuery({
    ...buildAgentsRetrieveQuery(
      client,
      identifier,
      idempotencyKey,
      options,
    ),
    ...options,
  });
}

export function setAgentsRetrieveData(
  client: QueryClient,
  queryKeyBase: [
    identifier: string,
    parameters: { idempotencyKey?: string | undefined },
  ],
  data: AgentsRetrieveQueryData,
): AgentsRetrieveQueryData | undefined {
  const key = queryKeyAgentsRetrieve(...queryKeyBase);

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

export function invalidateAgentsRetrieve(
  client: QueryClient,
  queryKeyBase: TupleToPrefixes<
    [identifier: string, parameters: { idempotencyKey?: string | undefined }]
  >,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: ["@novu/api", "Agents", "retrieve", ...queryKeyBase],
  });
}

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