@novu/api 0.1.6 → 2.6.5

package/src/react-query/notificationsList.ts

@@ -0,0 +1,194 @@
+/*
+ * 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 { notificationsList } from "../funcs/notificationsList.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 {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+
+export type NotificationsListQueryData =
+  operations.NotificationsControllerListNotificationsResponse;
+
+/**
+ * Get notifications
+ */
+export function useNotificationsList(
+  request: operations.NotificationsControllerListNotificationsRequest,
+  options?: QueryHookOptions<NotificationsListQueryData>,
+): UseQueryResult<NotificationsListQueryData, Error> {
+  const client = useNovuContext();
+  return useQuery({
+    ...buildNotificationsListQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get notifications
+ */
+export function useNotificationsListSuspense(
+  request: operations.NotificationsControllerListNotificationsRequest,
+  options?: SuspenseQueryHookOptions<NotificationsListQueryData>,
+): UseSuspenseQueryResult<NotificationsListQueryData, Error> {
+  const client = useNovuContext();
+  return useSuspenseQuery({
+    ...buildNotificationsListQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function prefetchNotificationsList(
+  queryClient: QueryClient,
+  client$: NovuCore,
+  request: operations.NotificationsControllerListNotificationsRequest,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildNotificationsListQuery(
+      client$,
+      request,
+    ),
+  });
+}
+
+export function setNotificationsListData(
+  client: QueryClient,
+  queryKeyBase: [
+    parameters: {
+      channels?: Array<components.ChannelTypeEnum> | undefined;
+      templates?: Array<string> | undefined;
+      emails?: Array<string> | undefined;
+      search?: string | undefined;
+      subscriberIds?: Array<string> | undefined;
+      page?: number | undefined;
+      transactionId?: string | undefined;
+      after?: string | undefined;
+      before?: string | undefined;
+      idempotencyKey?: string | undefined;
+    },
+  ],
+  data: NotificationsListQueryData,
+): NotificationsListQueryData | undefined {
+  const key = queryKeyNotificationsList(...queryKeyBase);
+
+  return client.setQueryData<NotificationsListQueryData>(key, data);
+}
+
+export function invalidateNotificationsList(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: {
+      channels?: Array<components.ChannelTypeEnum> | undefined;
+      templates?: Array<string> | undefined;
+      emails?: Array<string> | undefined;
+      search?: string | undefined;
+      subscriberIds?: Array<string> | undefined;
+      page?: number | undefined;
+      transactionId?: string | undefined;
+      after?: string | undefined;
+      before?: string | undefined;
+      idempotencyKey?: string | undefined;
+    }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@novu/api", "Notifications", "list", ...queryKeyBase],
+  });
+}
+
+export function invalidateAllNotificationsList(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@novu/api", "Notifications", "list"],
+  });
+}
+
+export function buildNotificationsListQuery(
+  client$: NovuCore,
+  request: operations.NotificationsControllerListNotificationsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<NotificationsListQueryData>;
+} {
+  return {
+    queryKey: queryKeyNotificationsList({
+      channels: request.channels,
+      templates: request.templates,
+      emails: request.emails,
+      search: request.search,
+      subscriberIds: request.subscriberIds,
+      page: request.page,
+      transactionId: request.transactionId,
+      after: request.after,
+      before: request.before,
+      idempotencyKey: request.idempotencyKey,
+    }),
+    queryFn: async function notificationsListQueryFn(
+      ctx,
+    ): Promise<NotificationsListQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(notificationsList(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyNotificationsList(
+  parameters: {
+    channels?: Array<components.ChannelTypeEnum> | undefined;
+    templates?: Array<string> | undefined;
+    emails?: Array<string> | undefined;
+    search?: string | undefined;
+    subscriberIds?: Array<string> | undefined;
+    page?: number | undefined;
+    transactionId?: string | undefined;
+    after?: string | undefined;
+    before?: string | undefined;
+    idempotencyKey?: string | undefined;
+  },
+): QueryKey {
+  return ["@novu/api", "Notifications", "list", parameters];
+}

package/src/react-query/notificationsRetrieve.ts

@@ -0,0 +1,162 @@
+/*
+ * 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 { notificationsRetrieve } from "../funcs/notificationsRetrieve.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 NotificationsRetrieveQueryData =
+  operations.NotificationsControllerGetNotificationResponse;
+
+/**
+ * Get notification
+ */
+export function useNotificationsRetrieve(
+  notificationId: string,
+  idempotencyKey?: string | undefined,
+  options?: QueryHookOptions<NotificationsRetrieveQueryData>,
+): UseQueryResult<NotificationsRetrieveQueryData, Error> {
+  const client = useNovuContext();
+  return useQuery({
+    ...buildNotificationsRetrieveQuery(
+      client,
+      notificationId,
+      idempotencyKey,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get notification
+ */
+export function useNotificationsRetrieveSuspense(
+  notificationId: string,
+  idempotencyKey?: string | undefined,
+  options?: SuspenseQueryHookOptions<NotificationsRetrieveQueryData>,
+): UseSuspenseQueryResult<NotificationsRetrieveQueryData, Error> {
+  const client = useNovuContext();
+  return useSuspenseQuery({
+    ...buildNotificationsRetrieveQuery(
+      client,
+      notificationId,
+      idempotencyKey,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function prefetchNotificationsRetrieve(
+  queryClient: QueryClient,
+  client$: NovuCore,
+  notificationId: string,
+  idempotencyKey?: string | undefined,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildNotificationsRetrieveQuery(
+      client$,
+      notificationId,
+      idempotencyKey,
+    ),
+  });
+}
+
+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"],
+  });
+}
+
+export function buildNotificationsRetrieveQuery(
+  client$: NovuCore,
+  notificationId: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<NotificationsRetrieveQueryData>;
+} {
+  return {
+    queryKey: queryKeyNotificationsRetrieve(notificationId, { idempotencyKey }),
+    queryFn: async function notificationsRetrieveQueryFn(
+      ctx,
+    ): Promise<NotificationsRetrieveQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(notificationsRetrieve(
+        client$,
+        notificationId,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyNotificationsRetrieve(
+  notificationId: string,
+  parameters: { idempotencyKey?: string | undefined },
+): QueryKey {
+  return ["@novu/api", "Notifications", "retrieve", notificationId, parameters];
+}

package/src/react-query/notificationsStatsGraph.ts

@@ -0,0 +1,166 @@
+/*
+ * 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 { notificationsStatsGraph } from "../funcs/notificationsStatsGraph.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 NotificationsStatsGraphQueryData =
+  operations.NotificationsControllerGetActivityGraphStatsResponse;
+
+/**
+ * Get notification graph statistics
+ */
+export function useNotificationsStatsGraph(
+  days?: number | undefined,
+  idempotencyKey?: string | undefined,
+  options?: QueryHookOptions<NotificationsStatsGraphQueryData>,
+): UseQueryResult<NotificationsStatsGraphQueryData, Error> {
+  const client = useNovuContext();
+  return useQuery({
+    ...buildNotificationsStatsGraphQuery(
+      client,
+      days,
+      idempotencyKey,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get notification graph statistics
+ */
+export function useNotificationsStatsGraphSuspense(
+  days?: number | undefined,
+  idempotencyKey?: string | undefined,
+  options?: SuspenseQueryHookOptions<NotificationsStatsGraphQueryData>,
+): UseSuspenseQueryResult<NotificationsStatsGraphQueryData, Error> {
+  const client = useNovuContext();
+  return useSuspenseQuery({
+    ...buildNotificationsStatsGraphQuery(
+      client,
+      days,
+      idempotencyKey,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function prefetchNotificationsStatsGraph(
+  queryClient: QueryClient,
+  client$: NovuCore,
+  days?: number | undefined,
+  idempotencyKey?: string | undefined,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildNotificationsStatsGraphQuery(
+      client$,
+      days,
+      idempotencyKey,
+    ),
+  });
+}
+
+export function setNotificationsStatsGraphData(
+  client: QueryClient,
+  queryKeyBase: [
+    parameters: {
+      days?: number | undefined;
+      idempotencyKey?: string | undefined;
+    },
+  ],
+  data: NotificationsStatsGraphQueryData,
+): NotificationsStatsGraphQueryData | undefined {
+  const key = queryKeyNotificationsStatsGraph(...queryKeyBase);
+
+  return client.setQueryData<NotificationsStatsGraphQueryData>(key, data);
+}
+
+export function invalidateNotificationsStatsGraph(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: {
+      days?: number | undefined;
+      idempotencyKey?: string | undefined;
+    }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@novu/api", "Stats", "graph", ...queryKeyBase],
+  });
+}
+
+export function invalidateAllNotificationsStatsGraph(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@novu/api", "Stats", "graph"],
+  });
+}
+
+export function buildNotificationsStatsGraphQuery(
+  client$: NovuCore,
+  days?: number | undefined,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<NotificationsStatsGraphQueryData>;
+} {
+  return {
+    queryKey: queryKeyNotificationsStatsGraph({ days, idempotencyKey }),
+    queryFn: async function notificationsStatsGraphQueryFn(
+      ctx,
+    ): Promise<NotificationsStatsGraphQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(notificationsStatsGraph(
+        client$,
+        days,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyNotificationsStatsGraph(
+  parameters: {
+    days?: number | undefined;
+    idempotencyKey?: string | undefined;
+  },
+): QueryKey {
+  return ["@novu/api", "Stats", "graph", parameters];
+}

package/src/react-query/notificationsStatsRetrieve.ts

@@ -0,0 +1,147 @@
+/*
+ * 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 { notificationsStatsRetrieve } from "../funcs/notificationsStatsRetrieve.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 NotificationsStatsRetrieveQueryData =
+  operations.NotificationsControllerGetActivityStatsResponse;
+
+/**
+ * Get notification statistics
+ */
+export function useNotificationsStatsRetrieve(
+  idempotencyKey?: string | undefined,
+  options?: QueryHookOptions<NotificationsStatsRetrieveQueryData>,
+): UseQueryResult<NotificationsStatsRetrieveQueryData, Error> {
+  const client = useNovuContext();
+  return useQuery({
+    ...buildNotificationsStatsRetrieveQuery(
+      client,
+      idempotencyKey,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get notification statistics
+ */
+export function useNotificationsStatsRetrieveSuspense(
+  idempotencyKey?: string | undefined,
+  options?: SuspenseQueryHookOptions<NotificationsStatsRetrieveQueryData>,
+): UseSuspenseQueryResult<NotificationsStatsRetrieveQueryData, Error> {
+  const client = useNovuContext();
+  return useSuspenseQuery({
+    ...buildNotificationsStatsRetrieveQuery(
+      client,
+      idempotencyKey,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function prefetchNotificationsStatsRetrieve(
+  queryClient: QueryClient,
+  client$: NovuCore,
+  idempotencyKey?: string | undefined,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildNotificationsStatsRetrieveQuery(
+      client$,
+      idempotencyKey,
+    ),
+  });
+}
+
+export function setNotificationsStatsRetrieveData(
+  client: QueryClient,
+  queryKeyBase: [parameters: { idempotencyKey?: string | undefined }],
+  data: NotificationsStatsRetrieveQueryData,
+): NotificationsStatsRetrieveQueryData | undefined {
+  const key = queryKeyNotificationsStatsRetrieve(...queryKeyBase);
+
+  return client.setQueryData<NotificationsStatsRetrieveQueryData>(key, data);
+}
+
+export function invalidateNotificationsStatsRetrieve(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: { idempotencyKey?: string | undefined }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@novu/api", "Stats", "retrieve", ...queryKeyBase],
+  });
+}
+
+export function invalidateAllNotificationsStatsRetrieve(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@novu/api", "Stats", "retrieve"],
+  });
+}
+
+export function buildNotificationsStatsRetrieveQuery(
+  client$: NovuCore,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<NotificationsStatsRetrieveQueryData>;
+} {
+  return {
+    queryKey: queryKeyNotificationsStatsRetrieve({ idempotencyKey }),
+    queryFn: async function notificationsStatsRetrieveQueryFn(
+      ctx,
+    ): Promise<NotificationsStatsRetrieveQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(notificationsStatsRetrieve(
+        client$,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyNotificationsStatsRetrieve(
+  parameters: { idempotencyKey?: string | undefined },
+): QueryKey {
+  return ["@novu/api", "Stats", "retrieve", parameters];
+}