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

libs/internal-sdk/src/react-query/subscribersNotificationsUnseenCount.ts
162 строки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 {
  buildSubscribersNotificationsUnseenCountQuery,
  prefetchSubscribersNotificationsUnseenCount,
  queryKeySubscribersNotificationsUnseenCount,
  SubscribersNotificationsUnseenCountQueryData,
} from "./subscribersNotificationsUnseenCount.core.js";
export {
  buildSubscribersNotificationsUnseenCountQuery,
  prefetchSubscribersNotificationsUnseenCount,
  queryKeySubscribersNotificationsUnseenCount,
  type SubscribersNotificationsUnseenCountQueryData,
};

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

/**
 * Retrieve unseen notifications count
 *
 * @remarks
 * This API is deprecated, use v2 API instead. Retrieve unseen in-app notifications count for a subscriber 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 useSubscribersNotificationsUnseenCount(
  request: operations.SubscribersV1ControllerGetUnseenCountRequest,
  options?: QueryHookOptions<
    SubscribersNotificationsUnseenCountQueryData,
    SubscribersNotificationsUnseenCountQueryError
  >,
): UseQueryResult<
  SubscribersNotificationsUnseenCountQueryData,
  SubscribersNotificationsUnseenCountQueryError
> {
  const client = useNovuContext();
  return useQuery({
    ...buildSubscribersNotificationsUnseenCountQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * Retrieve unseen notifications count
 *
 * @remarks
 * This API is deprecated, use v2 API instead. Retrieve unseen in-app notifications count for a subscriber 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 useSubscribersNotificationsUnseenCountSuspense(
  request: operations.SubscribersV1ControllerGetUnseenCountRequest,
  options?: SuspenseQueryHookOptions<
    SubscribersNotificationsUnseenCountQueryData,
    SubscribersNotificationsUnseenCountQueryError
  >,
): UseSuspenseQueryResult<
  SubscribersNotificationsUnseenCountQueryData,
  SubscribersNotificationsUnseenCountQueryError
> {
  const client = useNovuContext();
  return useSuspenseQuery({
    ...buildSubscribersNotificationsUnseenCountQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

export function setSubscribersNotificationsUnseenCountData(
  client: QueryClient,
  queryKeyBase: [
    subscriberId: string,
    parameters: {
      seen?: boolean | undefined;
      limit?: number | undefined;
      idempotencyKey?: string | undefined;
    },
  ],
  data: SubscribersNotificationsUnseenCountQueryData,
): SubscribersNotificationsUnseenCountQueryData | undefined {
  const key = queryKeySubscribersNotificationsUnseenCount(...queryKeyBase);

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

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

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