@novu/api 2.6.6 → 3.11.0

package/src/react-query/subscribersNotificationsFeed.ts

@@ -1,182 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import {
-  InvalidateQueryFilters,
-  QueryClient,
-  QueryFunctionContext,
-  QueryKey,
-  useQuery,
-  UseQueryResult,
-  useSuspenseQuery,
-  UseSuspenseQueryResult,
-} from "@tanstack/react-query";
-import { NovuCore } from "../core.js";
-import { subscribersNotificationsFeed } from "../funcs/subscribersNotificationsFeed.js";
-import { combineSignals } from "../lib/primitives.js";
-import { RequestOptions } from "../lib/sdks.js";
-import * as operations from "../models/operations/index.js";
-import { unwrapAsync } from "../types/fp.js";
-import { useNovuContext } from "./_context.js";
-import {
-  QueryHookOptions,
-  SuspenseQueryHookOptions,
-  TupleToPrefixes,
-} from "./_types.js";
-
-export type SubscribersNotificationsFeedQueryData =
-  operations.SubscribersV1ControllerGetNotificationsFeedResponse;
-
-/**
- * Get in-app notification feed for a particular subscriber
- */
-export function useSubscribersNotificationsFeed(
-  request: operations.SubscribersV1ControllerGetNotificationsFeedRequest,
-  options?: QueryHookOptions<SubscribersNotificationsFeedQueryData>,
-): UseQueryResult<SubscribersNotificationsFeedQueryData, Error> {
-  const client = useNovuContext();
-  return useQuery({
-    ...buildSubscribersNotificationsFeedQuery(
-      client,
-      request,
-      options,
-    ),
-    ...options,
-  });
-}
-
-/**
- * Get in-app notification feed for a particular subscriber
- */
-export function useSubscribersNotificationsFeedSuspense(
-  request: operations.SubscribersV1ControllerGetNotificationsFeedRequest,
-  options?: SuspenseQueryHookOptions<SubscribersNotificationsFeedQueryData>,
-): UseSuspenseQueryResult<SubscribersNotificationsFeedQueryData, Error> {
-  const client = useNovuContext();
-  return useSuspenseQuery({
-    ...buildSubscribersNotificationsFeedQuery(
-      client,
-      request,
-      options,
-    ),
-    ...options,
-  });
-}
-
-export function prefetchSubscribersNotificationsFeed(
-  queryClient: QueryClient,
-  client$: NovuCore,
-  request: operations.SubscribersV1ControllerGetNotificationsFeedRequest,
-): Promise<void> {
-  return queryClient.prefetchQuery({
-    ...buildSubscribersNotificationsFeedQuery(
-      client$,
-      request,
-    ),
-  });
-}
-
-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"],
-  });
-}
-
-export function buildSubscribersNotificationsFeedQuery(
-  client$: NovuCore,
-  request: operations.SubscribersV1ControllerGetNotificationsFeedRequest,
-  options?: RequestOptions,
-): {
-  queryKey: QueryKey;
-  queryFn: (
-    context: QueryFunctionContext,
-  ) => Promise<SubscribersNotificationsFeedQueryData>;
-} {
-  return {
-    queryKey: queryKeySubscribersNotificationsFeed(request.subscriberId, {
-      page: request.page,
-      limit: request.limit,
-      read: request.read,
-      seen: request.seen,
-      payload: request.payload,
-      idempotencyKey: request.idempotencyKey,
-    }),
-    queryFn: async function subscribersNotificationsFeedQueryFn(
-      ctx,
-    ): Promise<SubscribersNotificationsFeedQueryData> {
-      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
-      const mergedOptions = {
-        ...options,
-        fetchOptions: { ...options?.fetchOptions, signal: sig },
-      };
-
-      return unwrapAsync(subscribersNotificationsFeed(
-        client$,
-        request,
-        mergedOptions,
-      ));
-    },
-  };
-}
-
-export function queryKeySubscribersNotificationsFeed(
-  subscriberId: string,
-  parameters: {
-    page?: number | undefined;
-    limit?: number | undefined;
-    read?: boolean | undefined;
-    seen?: boolean | undefined;
-    payload?: string | undefined;
-    idempotencyKey?: string | undefined;
-  },
-): QueryKey {
-  return ["@novu/api", "Notifications", "feed", subscriberId, parameters];
-}

package/src/react-query/subscribersNotificationsUnseenCount.ts

@@ -1,184 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import {
-  InvalidateQueryFilters,
-  QueryClient,
-  QueryFunctionContext,
-  QueryKey,
-  useQuery,
-  UseQueryResult,
-  useSuspenseQuery,
-  UseSuspenseQueryResult,
-} from "@tanstack/react-query";
-import { NovuCore } from "../core.js";
-import { subscribersNotificationsUnseenCount } from "../funcs/subscribersNotificationsUnseenCount.js";
-import { combineSignals } from "../lib/primitives.js";
-import { RequestOptions } from "../lib/sdks.js";
-import * as operations from "../models/operations/index.js";
-import { unwrapAsync } from "../types/fp.js";
-import { useNovuContext } from "./_context.js";
-import {
-  QueryHookOptions,
-  SuspenseQueryHookOptions,
-  TupleToPrefixes,
-} from "./_types.js";
-
-export type SubscribersNotificationsUnseenCountQueryData =
-  operations.SubscribersV1ControllerGetUnseenCountResponse;
-
-/**
- * Get the unseen in-app notifications count for subscribers feed
- */
-export function useSubscribersNotificationsUnseenCount(
-  request: operations.SubscribersV1ControllerGetUnseenCountRequest,
-  options?: QueryHookOptions<SubscribersNotificationsUnseenCountQueryData>,
-): UseQueryResult<SubscribersNotificationsUnseenCountQueryData, Error> {
-  const client = useNovuContext();
-  return useQuery({
-    ...buildSubscribersNotificationsUnseenCountQuery(
-      client,
-      request,
-      options,
-    ),
-    ...options,
-  });
-}
-
-/**
- * Get the unseen in-app notifications count for subscribers feed
- */
-export function useSubscribersNotificationsUnseenCountSuspense(
-  request: operations.SubscribersV1ControllerGetUnseenCountRequest,
-  options?: SuspenseQueryHookOptions<
-    SubscribersNotificationsUnseenCountQueryData
-  >,
-): UseSuspenseQueryResult<SubscribersNotificationsUnseenCountQueryData, Error> {
-  const client = useNovuContext();
-  return useSuspenseQuery({
-    ...buildSubscribersNotificationsUnseenCountQuery(
-      client,
-      request,
-      options,
-    ),
-    ...options,
-  });
-}
-
-export function prefetchSubscribersNotificationsUnseenCount(
-  queryClient: QueryClient,
-  client$: NovuCore,
-  request: operations.SubscribersV1ControllerGetUnseenCountRequest,
-): Promise<void> {
-  return queryClient.prefetchQuery({
-    ...buildSubscribersNotificationsUnseenCountQuery(
-      client$,
-      request,
-    ),
-  });
-}
-
-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"],
-  });
-}
-
-export function buildSubscribersNotificationsUnseenCountQuery(
-  client$: NovuCore,
-  request: operations.SubscribersV1ControllerGetUnseenCountRequest,
-  options?: RequestOptions,
-): {
-  queryKey: QueryKey;
-  queryFn: (
-    context: QueryFunctionContext,
-  ) => Promise<SubscribersNotificationsUnseenCountQueryData>;
-} {
-  return {
-    queryKey: queryKeySubscribersNotificationsUnseenCount(
-      request.subscriberId,
-      {
-        seen: request.seen,
-        limit: request.limit,
-        idempotencyKey: request.idempotencyKey,
-      },
-    ),
-    queryFn: async function subscribersNotificationsUnseenCountQueryFn(
-      ctx,
-    ): Promise<SubscribersNotificationsUnseenCountQueryData> {
-      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
-      const mergedOptions = {
-        ...options,
-        fetchOptions: { ...options?.fetchOptions, signal: sig },
-      };
-
-      return unwrapAsync(subscribersNotificationsUnseenCount(
-        client$,
-        request,
-        mergedOptions,
-      ));
-    },
-  };
-}
-
-export function queryKeySubscribersNotificationsUnseenCount(
-  subscriberId: string,
-  parameters: {
-    seen?: boolean | undefined;
-    limit?: number | undefined;
-    idempotencyKey?: string | undefined;
-  },
-): QueryKey {
-  return [
-    "@novu/api",
-    "Notifications",
-    "unseenCount",
-    subscriberId,
-    parameters,
-  ];
-}

package/src/react-query/subscribersPatch.ts

@@ -1,96 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import {
-  MutationKey,
-  useMutation,
-  UseMutationResult,
-} from "@tanstack/react-query";
-import { NovuCore } from "../core.js";
-import { subscribersPatch } from "../funcs/subscribersPatch.js";
-import { combineSignals } from "../lib/primitives.js";
-import { RequestOptions } from "../lib/sdks.js";
-import * as components from "../models/components/index.js";
-import * as operations from "../models/operations/index.js";
-import { unwrapAsync } from "../types/fp.js";
-import { useNovuContext } from "./_context.js";
-import { MutationHookOptions } from "./_types.js";
-
-export type SubscribersPatchMutationVariables = {
-  patchSubscriberRequestDto: components.PatchSubscriberRequestDto;
-  subscriberId: string;
-  idempotencyKey?: string | undefined;
-  options?: RequestOptions;
-};
-
-export type SubscribersPatchMutationData =
-  operations.SubscribersControllerPatchSubscriberResponse;
-
-/**
- * Patch subscriber
- *
- * @remarks
- * Patch subscriber by your internal id used to identify the subscriber
- */
-export function useSubscribersPatchMutation(
-  options?: MutationHookOptions<
-    SubscribersPatchMutationData,
-    Error,
-    SubscribersPatchMutationVariables
-  >,
-): UseMutationResult<
-  SubscribersPatchMutationData,
-  Error,
-  SubscribersPatchMutationVariables
-> {
-  const client = useNovuContext();
-  return useMutation({
-    ...buildSubscribersPatchMutation(client, options),
-    ...options,
-  });
-}
-
-export function mutationKeySubscribersPatch(): MutationKey {
-  return ["@novu/api", "Subscribers", "patch"];
-}
-
-export function buildSubscribersPatchMutation(
-  client$: NovuCore,
-  hookOptions?: RequestOptions,
-): {
-  mutationKey: MutationKey;
-  mutationFn: (
-    variables: SubscribersPatchMutationVariables,
-  ) => Promise<SubscribersPatchMutationData>;
-} {
-  return {
-    mutationKey: mutationKeySubscribersPatch(),
-    mutationFn: function subscribersPatchMutationFn({
-      patchSubscriberRequestDto,
-      subscriberId,
-      idempotencyKey,
-      options,
-    }): Promise<SubscribersPatchMutationData> {
-      const mergedOptions = {
-        ...hookOptions,
-        ...options,
-        fetchOptions: {
-          ...hookOptions?.fetchOptions,
-          ...options?.fetchOptions,
-          signal: combineSignals(
-            hookOptions?.fetchOptions?.signal,
-            options?.fetchOptions?.signal,
-          ),
-        },
-      };
-      return unwrapAsync(subscribersPatch(
-        client$,
-        patchSubscriberRequestDto,
-        subscriberId,
-        idempotencyKey,
-        mergedOptions,
-      ));
-    },
-  };
-}

package/src/react-query/subscribersPreferencesList.ts

@@ -1,167 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import {
-  InvalidateQueryFilters,
-  QueryClient,
-  QueryFunctionContext,
-  QueryKey,
-  useQuery,
-  UseQueryResult,
-  useSuspenseQuery,
-  UseSuspenseQueryResult,
-} from "@tanstack/react-query";
-import { NovuCore } from "../core.js";
-import { subscribersPreferencesList } from "../funcs/subscribersPreferencesList.js";
-import { combineSignals } from "../lib/primitives.js";
-import { RequestOptions } from "../lib/sdks.js";
-import * as operations from "../models/operations/index.js";
-import { unwrapAsync } from "../types/fp.js";
-import { useNovuContext } from "./_context.js";
-import {
-  QueryHookOptions,
-  SuspenseQueryHookOptions,
-  TupleToPrefixes,
-} from "./_types.js";
-
-export type SubscribersPreferencesListQueryData =
-  operations.SubscribersControllerGetSubscriberPreferencesResponse;
-
-/**
- * Get subscriber preferences
- *
- * @remarks
- * Get subscriber global and workflow specific preferences
- */
-export function useSubscribersPreferencesList(
-  subscriberId: string,
-  idempotencyKey?: string | undefined,
-  options?: QueryHookOptions<SubscribersPreferencesListQueryData>,
-): UseQueryResult<SubscribersPreferencesListQueryData, Error> {
-  const client = useNovuContext();
-  return useQuery({
-    ...buildSubscribersPreferencesListQuery(
-      client,
-      subscriberId,
-      idempotencyKey,
-      options,
-    ),
-    ...options,
-  });
-}
-
-/**
- * Get subscriber preferences
- *
- * @remarks
- * Get subscriber global and workflow specific preferences
- */
-export function useSubscribersPreferencesListSuspense(
-  subscriberId: string,
-  idempotencyKey?: string | undefined,
-  options?: SuspenseQueryHookOptions<SubscribersPreferencesListQueryData>,
-): UseSuspenseQueryResult<SubscribersPreferencesListQueryData, Error> {
-  const client = useNovuContext();
-  return useSuspenseQuery({
-    ...buildSubscribersPreferencesListQuery(
-      client,
-      subscriberId,
-      idempotencyKey,
-      options,
-    ),
-    ...options,
-  });
-}
-
-export function prefetchSubscribersPreferencesList(
-  queryClient: QueryClient,
-  client$: NovuCore,
-  subscriberId: string,
-  idempotencyKey?: string | undefined,
-): Promise<void> {
-  return queryClient.prefetchQuery({
-    ...buildSubscribersPreferencesListQuery(
-      client$,
-      subscriberId,
-      idempotencyKey,
-    ),
-  });
-}
-
-export function setSubscribersPreferencesListData(
-  client: QueryClient,
-  queryKeyBase: [
-    subscriberId: string,
-    parameters: { idempotencyKey?: string | undefined },
-  ],
-  data: SubscribersPreferencesListQueryData,
-): SubscribersPreferencesListQueryData | undefined {
-  const key = queryKeySubscribersPreferencesList(...queryKeyBase);
-
-  return client.setQueryData<SubscribersPreferencesListQueryData>(key, data);
-}
-
-export function invalidateSubscribersPreferencesList(
-  client: QueryClient,
-  queryKeyBase: TupleToPrefixes<
-    [subscriberId: string, parameters: { idempotencyKey?: string | undefined }]
-  >,
-  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
-): Promise<void> {
-  return client.invalidateQueries({
-    ...filters,
-    queryKey: ["@novu/api", "Preferences", "list", ...queryKeyBase],
-  });
-}
-
-export function invalidateAllSubscribersPreferencesList(
-  client: QueryClient,
-  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
-): Promise<void> {
-  return client.invalidateQueries({
-    ...filters,
-    queryKey: ["@novu/api", "Preferences", "list"],
-  });
-}
-
-export function buildSubscribersPreferencesListQuery(
-  client$: NovuCore,
-  subscriberId: string,
-  idempotencyKey?: string | undefined,
-  options?: RequestOptions,
-): {
-  queryKey: QueryKey;
-  queryFn: (
-    context: QueryFunctionContext,
-  ) => Promise<SubscribersPreferencesListQueryData>;
-} {
-  return {
-    queryKey: queryKeySubscribersPreferencesList(subscriberId, {
-      idempotencyKey,
-    }),
-    queryFn: async function subscribersPreferencesListQueryFn(
-      ctx,
-    ): Promise<SubscribersPreferencesListQueryData> {
-      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
-      const mergedOptions = {
-        ...options,
-        fetchOptions: { ...options?.fetchOptions, signal: sig },
-      };
-
-      return unwrapAsync(subscribersPreferencesList(
-        client$,
-        subscriberId,
-        idempotencyKey,
-        mergedOptions,
-      ));
-    },
-  };
-}
-
-export function queryKeySubscribersPreferencesList(
-  subscriberId: string,
-  parameters: { idempotencyKey?: string | undefined },
-): QueryKey {
-  return ["@novu/api", "Preferences", "list", subscriberId, parameters];
-}