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

libs/internal-sdk/src/react-query/subscribersNotificationsFeed.ts
165 строк5 KB
Pawan Jain
refactor(api-service): validate flattened provider IDs fixes NV-8087 (#11611)
23 июн 2026, 07:40
23 июн 2026, 07:40043e6db
/*
 * 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 * as operations from "../models/operations/index.js";
import { useNovuContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildSubscribersNotificationsFeedQuery,
  prefetchSubscribersNotificationsFeed,
  queryKeySubscribersNotificationsFeed,
  SubscribersNotificationsFeedQueryData,
} from "./subscribersNotificationsFeed.core.js";
export {
  buildSubscribersNotificationsFeedQuery,
  prefetchSubscribersNotificationsFeed,
  queryKeySubscribersNotificationsFeed,
  type SubscribersNotificationsFeedQueryData,
};

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

/**
 * Retrieve subscriber notifications
 *
 * @remarks
 * This API is deprecated, use v2 API instead. Retrieve subscriber in-app notifications by its unique key identifier **subscriberId**.
 *
 * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
 */
export function useSubscribersNotificationsFeed(
  request: operations.SubscribersV1ControllerGetNotificationsFeedRequest,
  options?: QueryHookOptions<
    SubscribersNotificationsFeedQueryData,
    SubscribersNotificationsFeedQueryError
  >,
): UseQueryResult<
  SubscribersNotificationsFeedQueryData,
  SubscribersNotificationsFeedQueryError
> {
  const client = useNovuContext();
  return useQuery({
    ...buildSubscribersNotificationsFeedQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * Retrieve subscriber notifications
 *
 * @remarks
 * This API is deprecated, use v2 API instead. Retrieve subscriber in-app notifications by its unique key identifier **subscriberId**.
 *
 * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
 */
export function useSubscribersNotificationsFeedSuspense(
  request: operations.SubscribersV1ControllerGetNotificationsFeedRequest,
  options?: SuspenseQueryHookOptions<
    SubscribersNotificationsFeedQueryData,
    SubscribersNotificationsFeedQueryError
  >,
): UseSuspenseQueryResult<
  SubscribersNotificationsFeedQueryData,
  SubscribersNotificationsFeedQueryError
> {
  const client = useNovuContext();
  return useSuspenseQuery({
    ...buildSubscribersNotificationsFeedQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

export function setSubscribersNotificationsFeedData(
  client: QueryClient,
  queryKeyBase: [
    subscriberId: string,
    parameters: {
      page?: number | undefined;
      limit?: number | undefined;
      read?: boolean | undefined;
      seen?: boolean | undefined;
      payload?: string | undefined;
      idempotencyKey?: string | undefined;
    },
  ],
  data: SubscribersNotificationsFeedQueryData,
): SubscribersNotificationsFeedQueryData | undefined {
  const key = queryKeySubscribersNotificationsFeed(...queryKeyBase);

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

export function invalidateSubscribersNotificationsFeed(
  client: QueryClient,
  queryKeyBase: TupleToPrefixes<
    [
      subscriberId: string,
      parameters: {
        page?: number | undefined;
        limit?: number | undefined;
        read?: boolean | undefined;
        seen?: boolean | undefined;
        payload?: string | undefined;
        idempotencyKey?: string | undefined;
      },
    ]
  >,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: ["@novu/api", "Notifications", "feed", ...queryKeyBase],
  });
}

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