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

libs/internal-sdk/src/react-query/notificationsRetrieve.ts
154 строки4 KB
Dima Grossman
chore(root): sdk gen version update for latest internal sdk changes (#10651)
10 апр 2026, 16:36
10 апр 2026, 16:36b5e0674
/*
 * 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 {
  buildNotificationsRetrieveQuery,
  NotificationsRetrieveQueryData,
  prefetchNotificationsRetrieve,
  queryKeyNotificationsRetrieve,
} from "./notificationsRetrieve.core.js";
export {
  buildNotificationsRetrieveQuery,
  type NotificationsRetrieveQueryData,
  prefetchNotificationsRetrieve,
  queryKeyNotificationsRetrieve,
};

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

/**
 * Retrieve an event
 *
 * @remarks
 * Retrieve an event by its unique key identifier **notificationId**.
 *     Here **notificationId** is of mongodbId type.
 *     This API returns the event details - execution logs, status, actual notification (message) generated by each workflow step.
 */
export function useNotificationsRetrieve(
  notificationId: string,
  idempotencyKey?: string | undefined,
  options?: QueryHookOptions<
    NotificationsRetrieveQueryData,
    NotificationsRetrieveQueryError
  >,
): UseQueryResult<
  NotificationsRetrieveQueryData,
  NotificationsRetrieveQueryError
> {
  const client = useNovuContext();
  return useQuery({
    ...buildNotificationsRetrieveQuery(
      client,
      notificationId,
      idempotencyKey,
      options,
    ),
    ...options,
  });
}

/**
 * Retrieve an event
 *
 * @remarks
 * Retrieve an event by its unique key identifier **notificationId**.
 *     Here **notificationId** is of mongodbId type.
 *     This API returns the event details - execution logs, status, actual notification (message) generated by each workflow step.
 */
export function useNotificationsRetrieveSuspense(
  notificationId: string,
  idempotencyKey?: string | undefined,
  options?: SuspenseQueryHookOptions<
    NotificationsRetrieveQueryData,
    NotificationsRetrieveQueryError
  >,
): UseSuspenseQueryResult<
  NotificationsRetrieveQueryData,
  NotificationsRetrieveQueryError
> {
  const client = useNovuContext();
  return useSuspenseQuery({
    ...buildNotificationsRetrieveQuery(
      client,
      notificationId,
      idempotencyKey,
      options,
    ),
    ...options,
  });
}

export function setNotificationsRetrieveData(
  client: QueryClient,
  queryKeyBase: [
    notificationId: string,
    parameters: { idempotencyKey?: string | undefined },
  ],
  data: NotificationsRetrieveQueryData,
): NotificationsRetrieveQueryData | undefined {
  const key = queryKeyNotificationsRetrieve(...queryKeyBase);

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

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

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