@novu/api 0.3.0 → 2.6.6

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,
+      ));
+    },
+  };
+}

package/src/react-query/triggerBroadcast.ts

@@ -0,0 +1,94 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { NovuCore } from "../core.js";
+import { triggerBroadcast } from "../funcs/triggerBroadcast.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 TriggerBroadcastMutationVariables = {
+  triggerEventToAllRequestDto: components.TriggerEventToAllRequestDto;
+  idempotencyKey?: string | undefined;
+  options?: RequestOptions;
+};
+
+export type TriggerBroadcastMutationData =
+  operations.EventsControllerBroadcastEventToAllResponse;
+
+/**
+ * Broadcast event to all
+ *
+ * @remarks
+ * Trigger a broadcast event to all existing subscribers, could be used to send announcements, etc.
+ *       In the future could be used to trigger events to a subset of subscribers based on defined filters.
+ */
+export function useTriggerBroadcastMutation(
+  options?: MutationHookOptions<
+    TriggerBroadcastMutationData,
+    Error,
+    TriggerBroadcastMutationVariables
+  >,
+): UseMutationResult<
+  TriggerBroadcastMutationData,
+  Error,
+  TriggerBroadcastMutationVariables
+> {
+  const client = useNovuContext();
+  return useMutation({
+    ...buildTriggerBroadcastMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyTriggerBroadcast(): MutationKey {
+  return ["@novu/api", "triggerBroadcast"];
+}
+
+export function buildTriggerBroadcastMutation(
+  client$: NovuCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: TriggerBroadcastMutationVariables,
+  ) => Promise<TriggerBroadcastMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyTriggerBroadcast(),
+    mutationFn: function triggerBroadcastMutationFn({
+      triggerEventToAllRequestDto,
+      idempotencyKey,
+      options,
+    }): Promise<TriggerBroadcastMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(triggerBroadcast(
+        client$,
+        triggerEventToAllRequestDto,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/triggerBulk.ts

@@ -0,0 +1,95 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { NovuCore } from "../core.js";
+import { triggerBulk } from "../funcs/triggerBulk.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 TriggerBulkMutationVariables = {
+  bulkTriggerEventDto: components.BulkTriggerEventDto;
+  idempotencyKey?: string | undefined;
+  options?: RequestOptions;
+};
+
+export type TriggerBulkMutationData =
+  operations.EventsControllerTriggerBulkResponse;
+
+/**
+ * Bulk trigger event
+ *
+ * @remarks
+ *
+ *       Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API.
+ *       The bulk API is limited to 100 events per request.
+ */
+export function useTriggerBulkMutation(
+  options?: MutationHookOptions<
+    TriggerBulkMutationData,
+    Error,
+    TriggerBulkMutationVariables
+  >,
+): UseMutationResult<
+  TriggerBulkMutationData,
+  Error,
+  TriggerBulkMutationVariables
+> {
+  const client = useNovuContext();
+  return useMutation({
+    ...buildTriggerBulkMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyTriggerBulk(): MutationKey {
+  return ["@novu/api", "triggerBulk"];
+}
+
+export function buildTriggerBulkMutation(
+  client$: NovuCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: TriggerBulkMutationVariables,
+  ) => Promise<TriggerBulkMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyTriggerBulk(),
+    mutationFn: function triggerBulkMutationFn({
+      bulkTriggerEventDto,
+      idempotencyKey,
+      options,
+    }): Promise<TriggerBulkMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(triggerBulk(
+        client$,
+        bulkTriggerEventDto,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/workflowsCreate.ts

@@ -0,0 +1,83 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { NovuCore } from "../core.js";
+import { workflowsCreate } from "../funcs/workflowsCreate.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 { MutationHookOptions } from "./_types.js";
+
+export type WorkflowsCreateMutationVariables = {
+  idempotencyKey?: string | undefined;
+  options?: RequestOptions;
+};
+
+export type WorkflowsCreateMutationData =
+  operations.WorkflowControllerCreateResponse;
+
+export function useWorkflowsCreateMutation(
+  options?: MutationHookOptions<
+    WorkflowsCreateMutationData,
+    Error,
+    WorkflowsCreateMutationVariables
+  >,
+): UseMutationResult<
+  WorkflowsCreateMutationData,
+  Error,
+  WorkflowsCreateMutationVariables
+> {
+  const client = useNovuContext();
+  return useMutation({
+    ...buildWorkflowsCreateMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyWorkflowsCreate(): MutationKey {
+  return ["@novu/api", "Workflows", "create"];
+}
+
+export function buildWorkflowsCreateMutation(
+  client$: NovuCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: WorkflowsCreateMutationVariables,
+  ) => Promise<WorkflowsCreateMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyWorkflowsCreate(),
+    mutationFn: function workflowsCreateMutationFn({
+      idempotencyKey,
+      options,
+    }): Promise<WorkflowsCreateMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(workflowsCreate(
+        client$,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/workflowsDelete.ts

@@ -0,0 +1,87 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { NovuCore } from "../core.js";
+import { workflowsDelete } from "../funcs/workflowsDelete.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 { MutationHookOptions } from "./_types.js";
+
+export type WorkflowsDeleteMutationVariables = {
+  workflowId: string;
+  idempotencyKey?: string | undefined;
+  options?: RequestOptions;
+};
+
+export type WorkflowsDeleteMutationData =
+  | operations.WorkflowControllerRemoveWorkflowResponse
+  | undefined;
+
+export function useWorkflowsDeleteMutation(
+  options?: MutationHookOptions<
+    WorkflowsDeleteMutationData,
+    Error,
+    WorkflowsDeleteMutationVariables
+  >,
+): UseMutationResult<
+  WorkflowsDeleteMutationData,
+  Error,
+  WorkflowsDeleteMutationVariables
+> {
+  const client = useNovuContext();
+  return useMutation({
+    ...buildWorkflowsDeleteMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyWorkflowsDelete(): MutationKey {
+  return ["@novu/api", "Workflows", "delete"];
+}
+
+export function buildWorkflowsDeleteMutation(
+  client$: NovuCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: WorkflowsDeleteMutationVariables,
+  ) => Promise<WorkflowsDeleteMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyWorkflowsDelete(),
+    mutationFn: function workflowsDeleteMutationFn({
+      workflowId,
+      idempotencyKey,
+      options,
+    }): Promise<WorkflowsDeleteMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(workflowsDelete(
+        client$,
+        workflowId,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}