@novu/api 0.1.6 → 2.6.5

package/src/react-query/topicsRetrieve.ts

@@ -0,0 +1,163 @@
+/*
+ * 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 { topicsRetrieve } from "../funcs/topicsRetrieve.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 TopicsRetrieveQueryData =
+  operations.TopicsControllerGetTopicResponse;
+
+/**
+ * Get topic
+ *
+ * @remarks
+ * Get a topic by its topic key
+ */
+export function useTopicsRetrieve(
+  topicKey: string,
+  idempotencyKey?: string | undefined,
+  options?: QueryHookOptions<TopicsRetrieveQueryData>,
+): UseQueryResult<TopicsRetrieveQueryData, Error> {
+  const client = useNovuContext();
+  return useQuery({
+    ...buildTopicsRetrieveQuery(
+      client,
+      topicKey,
+      idempotencyKey,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get topic
+ *
+ * @remarks
+ * Get a topic by its topic key
+ */
+export function useTopicsRetrieveSuspense(
+  topicKey: string,
+  idempotencyKey?: string | undefined,
+  options?: SuspenseQueryHookOptions<TopicsRetrieveQueryData>,
+): UseSuspenseQueryResult<TopicsRetrieveQueryData, Error> {
+  const client = useNovuContext();
+  return useSuspenseQuery({
+    ...buildTopicsRetrieveQuery(
+      client,
+      topicKey,
+      idempotencyKey,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function prefetchTopicsRetrieve(
+  queryClient: QueryClient,
+  client$: NovuCore,
+  topicKey: string,
+  idempotencyKey?: string | undefined,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildTopicsRetrieveQuery(
+      client$,
+      topicKey,
+      idempotencyKey,
+    ),
+  });
+}
+
+export function setTopicsRetrieveData(
+  client: QueryClient,
+  queryKeyBase: [
+    topicKey: string,
+    parameters: { idempotencyKey?: string | undefined },
+  ],
+  data: TopicsRetrieveQueryData,
+): TopicsRetrieveQueryData | undefined {
+  const key = queryKeyTopicsRetrieve(...queryKeyBase);
+
+  return client.setQueryData<TopicsRetrieveQueryData>(key, data);
+}
+
+export function invalidateTopicsRetrieve(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [topicKey: string, parameters: { idempotencyKey?: string | undefined }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@novu/api", "Topics", "retrieve", ...queryKeyBase],
+  });
+}
+
+export function invalidateAllTopicsRetrieve(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@novu/api", "Topics", "retrieve"],
+  });
+}
+
+export function buildTopicsRetrieveQuery(
+  client$: NovuCore,
+  topicKey: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (context: QueryFunctionContext) => Promise<TopicsRetrieveQueryData>;
+} {
+  return {
+    queryKey: queryKeyTopicsRetrieve(topicKey, { idempotencyKey }),
+    queryFn: async function topicsRetrieveQueryFn(
+      ctx,
+    ): Promise<TopicsRetrieveQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(topicsRetrieve(
+        client$,
+        topicKey,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyTopicsRetrieve(
+  topicKey: string,
+  parameters: { idempotencyKey?: string | undefined },
+): QueryKey {
+  return ["@novu/api", "Topics", "retrieve", topicKey, parameters];
+}

package/src/react-query/topicsSubscribersAssign.ts

@@ -0,0 +1,96 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { NovuCore } from "../core.js";
+import { topicsSubscribersAssign } from "../funcs/topicsSubscribersAssign.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 TopicsSubscribersAssignMutationVariables = {
+  addSubscribersRequestDto: components.AddSubscribersRequestDto;
+  topicKey: string;
+  idempotencyKey?: string | undefined;
+  options?: RequestOptions;
+};
+
+export type TopicsSubscribersAssignMutationData =
+  operations.TopicsControllerAssignResponse;
+
+/**
+ * Subscribers addition
+ *
+ * @remarks
+ * Add subscribers to a topic by key
+ */
+export function useTopicsSubscribersAssignMutation(
+  options?: MutationHookOptions<
+    TopicsSubscribersAssignMutationData,
+    Error,
+    TopicsSubscribersAssignMutationVariables
+  >,
+): UseMutationResult<
+  TopicsSubscribersAssignMutationData,
+  Error,
+  TopicsSubscribersAssignMutationVariables
+> {
+  const client = useNovuContext();
+  return useMutation({
+    ...buildTopicsSubscribersAssignMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyTopicsSubscribersAssign(): MutationKey {
+  return ["@novu/api", "Subscribers", "assign"];
+}
+
+export function buildTopicsSubscribersAssignMutation(
+  client$: NovuCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: TopicsSubscribersAssignMutationVariables,
+  ) => Promise<TopicsSubscribersAssignMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyTopicsSubscribersAssign(),
+    mutationFn: function topicsSubscribersAssignMutationFn({
+      addSubscribersRequestDto,
+      topicKey,
+      idempotencyKey,
+      options,
+    }): Promise<TopicsSubscribersAssignMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(topicsSubscribersAssign(
+        client$,
+        addSubscribersRequestDto,
+        topicKey,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/topicsSubscribersRemove.ts

@@ -0,0 +1,97 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { NovuCore } from "../core.js";
+import { topicsSubscribersRemove } from "../funcs/topicsSubscribersRemove.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 TopicsSubscribersRemoveMutationVariables = {
+  removeSubscribersRequestDto: components.RemoveSubscribersRequestDto;
+  topicKey: string;
+  idempotencyKey?: string | undefined;
+  options?: RequestOptions;
+};
+
+export type TopicsSubscribersRemoveMutationData =
+  | operations.TopicsControllerRemoveSubscribersResponse
+  | undefined;
+
+/**
+ * Subscribers removal
+ *
+ * @remarks
+ * Remove subscribers from a topic
+ */
+export function useTopicsSubscribersRemoveMutation(
+  options?: MutationHookOptions<
+    TopicsSubscribersRemoveMutationData,
+    Error,
+    TopicsSubscribersRemoveMutationVariables
+  >,
+): UseMutationResult<
+  TopicsSubscribersRemoveMutationData,
+  Error,
+  TopicsSubscribersRemoveMutationVariables
+> {
+  const client = useNovuContext();
+  return useMutation({
+    ...buildTopicsSubscribersRemoveMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyTopicsSubscribersRemove(): MutationKey {
+  return ["@novu/api", "Subscribers", "remove"];
+}
+
+export function buildTopicsSubscribersRemoveMutation(
+  client$: NovuCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: TopicsSubscribersRemoveMutationVariables,
+  ) => Promise<TopicsSubscribersRemoveMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyTopicsSubscribersRemove(),
+    mutationFn: function topicsSubscribersRemoveMutationFn({
+      removeSubscribersRequestDto,
+      topicKey,
+      idempotencyKey,
+      options,
+    }): Promise<TopicsSubscribersRemoveMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(topicsSubscribersRemove(
+        client$,
+        removeSubscribersRequestDto,
+        topicKey,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/topicsSubscribersRetrieve.ts

@@ -0,0 +1,190 @@
+/*
+ * 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 { topicsSubscribersRetrieve } from "../funcs/topicsSubscribersRetrieve.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 TopicsSubscribersRetrieveQueryData =
+  operations.TopicsControllerGetTopicSubscriberResponse;
+
+/**
+ * Check topic subscriber
+ *
+ * @remarks
+ * Check if a subscriber belongs to a certain topic
+ */
+export function useTopicsSubscribersRetrieve(
+  topicKey: string,
+  externalSubscriberId: string,
+  idempotencyKey?: string | undefined,
+  options?: QueryHookOptions<TopicsSubscribersRetrieveQueryData>,
+): UseQueryResult<TopicsSubscribersRetrieveQueryData, Error> {
+  const client = useNovuContext();
+  return useQuery({
+    ...buildTopicsSubscribersRetrieveQuery(
+      client,
+      topicKey,
+      externalSubscriberId,
+      idempotencyKey,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Check topic subscriber
+ *
+ * @remarks
+ * Check if a subscriber belongs to a certain topic
+ */
+export function useTopicsSubscribersRetrieveSuspense(
+  topicKey: string,
+  externalSubscriberId: string,
+  idempotencyKey?: string | undefined,
+  options?: SuspenseQueryHookOptions<TopicsSubscribersRetrieveQueryData>,
+): UseSuspenseQueryResult<TopicsSubscribersRetrieveQueryData, Error> {
+  const client = useNovuContext();
+  return useSuspenseQuery({
+    ...buildTopicsSubscribersRetrieveQuery(
+      client,
+      topicKey,
+      externalSubscriberId,
+      idempotencyKey,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function prefetchTopicsSubscribersRetrieve(
+  queryClient: QueryClient,
+  client$: NovuCore,
+  topicKey: string,
+  externalSubscriberId: string,
+  idempotencyKey?: string | undefined,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildTopicsSubscribersRetrieveQuery(
+      client$,
+      topicKey,
+      externalSubscriberId,
+      idempotencyKey,
+    ),
+  });
+}
+
+export function setTopicsSubscribersRetrieveData(
+  client: QueryClient,
+  queryKeyBase: [
+    topicKey: string,
+    externalSubscriberId: string,
+    parameters: { idempotencyKey?: string | undefined },
+  ],
+  data: TopicsSubscribersRetrieveQueryData,
+): TopicsSubscribersRetrieveQueryData | undefined {
+  const key = queryKeyTopicsSubscribersRetrieve(...queryKeyBase);
+
+  return client.setQueryData<TopicsSubscribersRetrieveQueryData>(key, data);
+}
+
+export function invalidateTopicsSubscribersRetrieve(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [
+      topicKey: string,
+      externalSubscriberId: string,
+      parameters: { idempotencyKey?: string | undefined },
+    ]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@novu/api", "Subscribers", "retrieve", ...queryKeyBase],
+  });
+}
+
+export function invalidateAllTopicsSubscribersRetrieve(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@novu/api", "Subscribers", "retrieve"],
+  });
+}
+
+export function buildTopicsSubscribersRetrieveQuery(
+  client$: NovuCore,
+  topicKey: string,
+  externalSubscriberId: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<TopicsSubscribersRetrieveQueryData>;
+} {
+  return {
+    queryKey: queryKeyTopicsSubscribersRetrieve(
+      topicKey,
+      externalSubscriberId,
+      { idempotencyKey },
+    ),
+    queryFn: async function topicsSubscribersRetrieveQueryFn(
+      ctx,
+    ): Promise<TopicsSubscribersRetrieveQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(topicsSubscribersRetrieve(
+        client$,
+        topicKey,
+        externalSubscriberId,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyTopicsSubscribersRetrieve(
+  topicKey: string,
+  externalSubscriberId: string,
+  parameters: { idempotencyKey?: string | undefined },
+): QueryKey {
+  return [
+    "@novu/api",
+    "Subscribers",
+    "retrieve",
+    topicKey,
+    externalSubscriberId,
+    parameters,
+  ];
+}

package/src/react-query/trigger.ts

@@ -0,0 +1,91 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { NovuCore } from "../core.js";
+import { trigger } from "../funcs/trigger.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 TriggerMutationVariables = {
+  triggerEventRequestDto: components.TriggerEventRequestDto;
+  idempotencyKey?: string | undefined;
+  options?: RequestOptions;
+};
+
+export type TriggerMutationData = operations.EventsControllerTriggerResponse;
+
+/**
+ * Trigger event
+ *
+ * @remarks
+ *
+ *     Trigger event is the main (and only) way to send notifications to subscribers.
+ *     The trigger identifier is used to match the particular workflow associated with it.
+ *     Additional information can be passed according the body interface below.
+ */
+export function useTriggerMutation(
+  options?: MutationHookOptions<
+    TriggerMutationData,
+    Error,
+    TriggerMutationVariables
+  >,
+): UseMutationResult<TriggerMutationData, Error, TriggerMutationVariables> {
+  const client = useNovuContext();
+  return useMutation({
+    ...buildTriggerMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyTrigger(): MutationKey {
+  return ["@novu/api", "trigger"];
+}
+
+export function buildTriggerMutation(
+  client$: NovuCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: TriggerMutationVariables,
+  ) => Promise<TriggerMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyTrigger(),
+    mutationFn: function triggerMutationFn({
+      triggerEventRequestDto,
+      idempotencyKey,
+      options,
+    }): Promise<TriggerMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(trigger(
+        client$,
+        triggerEventRequestDto,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}