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

libs/internal-sdk/src/react-query/topicsSubscriptionsList.ts
173 строки5 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 * as operations from "../models/operations/index.js";
import { useNovuContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildTopicsSubscriptionsListQuery,
  prefetchTopicsSubscriptionsList,
  queryKeyTopicsSubscriptionsList,
  TopicsSubscriptionsListQueryData,
} from "./topicsSubscriptionsList.core.js";
export {
  buildTopicsSubscriptionsListQuery,
  prefetchTopicsSubscriptionsList,
  queryKeyTopicsSubscriptionsList,
  type TopicsSubscriptionsListQueryData,
};

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

/**
 * List topic subscriptions
 *
 * @remarks
 * List all subscriptions of subscribers for a topic.
 *     Checkout all available filters in the query section.
 */
export function useTopicsSubscriptionsList(
  request: operations.TopicsControllerListTopicSubscriptionsRequest,
  options?: QueryHookOptions<
    TopicsSubscriptionsListQueryData,
    TopicsSubscriptionsListQueryError
  >,
): UseQueryResult<
  TopicsSubscriptionsListQueryData,
  TopicsSubscriptionsListQueryError
> {
  const client = useNovuContext();
  return useQuery({
    ...buildTopicsSubscriptionsListQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * List topic subscriptions
 *
 * @remarks
 * List all subscriptions of subscribers for a topic.
 *     Checkout all available filters in the query section.
 */
export function useTopicsSubscriptionsListSuspense(
  request: operations.TopicsControllerListTopicSubscriptionsRequest,
  options?: SuspenseQueryHookOptions<
    TopicsSubscriptionsListQueryData,
    TopicsSubscriptionsListQueryError
  >,
): UseSuspenseQueryResult<
  TopicsSubscriptionsListQueryData,
  TopicsSubscriptionsListQueryError
> {
  const client = useNovuContext();
  return useSuspenseQuery({
    ...buildTopicsSubscriptionsListQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

export function setTopicsSubscriptionsListData(
  client: QueryClient,
  queryKeyBase: [
    topicKey: string,
    parameters: {
      after?: string | undefined;
      before?: string | undefined;
      limit?: number | undefined;
      orderDirection?:
        | operations.TopicsControllerListTopicSubscriptionsQueryParamOrderDirection
        | undefined;
      orderBy?: string | undefined;
      includeCursor?: boolean | undefined;
      subscriberId?: string | undefined;
      contextKeys?: Array<string> | undefined;
      idempotencyKey?: string | undefined;
    },
  ],
  data: TopicsSubscriptionsListQueryData,
): TopicsSubscriptionsListQueryData | undefined {
  const key = queryKeyTopicsSubscriptionsList(...queryKeyBase);

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

export function invalidateTopicsSubscriptionsList(
  client: QueryClient,
  queryKeyBase: TupleToPrefixes<
    [
      topicKey: string,
      parameters: {
        after?: string | undefined;
        before?: string | undefined;
        limit?: number | undefined;
        orderDirection?:
          | operations.TopicsControllerListTopicSubscriptionsQueryParamOrderDirection
          | undefined;
        orderBy?: string | undefined;
        includeCursor?: boolean | undefined;
        subscriberId?: string | undefined;
        contextKeys?: Array<string> | undefined;
        idempotencyKey?: string | undefined;
      },
    ]
  >,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: ["@novu/api", "Subscriptions", "list", ...queryKeyBase],
  });
}

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