@novu/api 0.2.0 → 2.6.5

package/src/react-query/subscribersCreateBulk.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 { subscribersCreateBulk } from "../funcs/subscribersCreateBulk.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 SubscribersCreateBulkMutationVariables = {
+  bulkSubscriberCreateDto: components.BulkSubscriberCreateDto;
+  idempotencyKey?: string | undefined;
+  options?: RequestOptions;
+};
+
+export type SubscribersCreateBulkMutationData =
+  operations.SubscribersV1ControllerBulkCreateSubscribersResponse;
+
+/**
+ * Bulk create subscribers
+ *
+ * @remarks
+ *
+ *       Using this endpoint you can create multiple subscribers at once, to avoid multiple calls to the API.
+ *       The bulk API is limited to 500 subscribers per request.
+ */
+export function useSubscribersCreateBulkMutation(
+  options?: MutationHookOptions<
+    SubscribersCreateBulkMutationData,
+    Error,
+    SubscribersCreateBulkMutationVariables
+  >,
+): UseMutationResult<
+  SubscribersCreateBulkMutationData,
+  Error,
+  SubscribersCreateBulkMutationVariables
+> {
+  const client = useNovuContext();
+  return useMutation({
+    ...buildSubscribersCreateBulkMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeySubscribersCreateBulk(): MutationKey {
+  return ["@novu/api", "Subscribers", "createBulk"];
+}
+
+export function buildSubscribersCreateBulkMutation(
+  client$: NovuCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: SubscribersCreateBulkMutationVariables,
+  ) => Promise<SubscribersCreateBulkMutationData>;
+} {
+  return {
+    mutationKey: mutationKeySubscribersCreateBulk(),
+    mutationFn: function subscribersCreateBulkMutationFn({
+      bulkSubscriberCreateDto,
+      idempotencyKey,
+      options,
+    }): Promise<SubscribersCreateBulkMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(subscribersCreateBulk(
+        client$,
+        bulkSubscriberCreateDto,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/subscribersCredentialsAppend.ts

@@ -0,0 +1,98 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { NovuCore } from "../core.js";
+import { subscribersCredentialsAppend } from "../funcs/subscribersCredentialsAppend.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 SubscribersCredentialsAppendMutationVariables = {
+  updateSubscriberChannelRequestDto:
+    components.UpdateSubscriberChannelRequestDto;
+  subscriberId: string;
+  idempotencyKey?: string | undefined;
+  options?: RequestOptions;
+};
+
+export type SubscribersCredentialsAppendMutationData =
+  operations.SubscribersV1ControllerModifySubscriberChannelResponse;
+
+/**
+ * Modify subscriber credentials
+ *
+ * @remarks
+ * Subscriber credentials associated to the delivery methods such as slack and push tokens.
+ *     This endpoint appends provided credentials and deviceTokens to the existing ones.
+ */
+export function useSubscribersCredentialsAppendMutation(
+  options?: MutationHookOptions<
+    SubscribersCredentialsAppendMutationData,
+    Error,
+    SubscribersCredentialsAppendMutationVariables
+  >,
+): UseMutationResult<
+  SubscribersCredentialsAppendMutationData,
+  Error,
+  SubscribersCredentialsAppendMutationVariables
+> {
+  const client = useNovuContext();
+  return useMutation({
+    ...buildSubscribersCredentialsAppendMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeySubscribersCredentialsAppend(): MutationKey {
+  return ["@novu/api", "Credentials", "append"];
+}
+
+export function buildSubscribersCredentialsAppendMutation(
+  client$: NovuCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: SubscribersCredentialsAppendMutationVariables,
+  ) => Promise<SubscribersCredentialsAppendMutationData>;
+} {
+  return {
+    mutationKey: mutationKeySubscribersCredentialsAppend(),
+    mutationFn: function subscribersCredentialsAppendMutationFn({
+      updateSubscriberChannelRequestDto,
+      subscriberId,
+      idempotencyKey,
+      options,
+    }): Promise<SubscribersCredentialsAppendMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(subscribersCredentialsAppend(
+        client$,
+        updateSubscriberChannelRequestDto,
+        subscriberId,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/subscribersCredentialsDelete.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 { subscribersCredentialsDelete } from "../funcs/subscribersCredentialsDelete.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 SubscribersCredentialsDeleteMutationVariables = {
+  subscriberId: string;
+  providerId: string;
+  idempotencyKey?: string | undefined;
+  options?: RequestOptions;
+};
+
+export type SubscribersCredentialsDeleteMutationData =
+  | operations.SubscribersV1ControllerDeleteSubscriberCredentialsResponse
+  | undefined;
+
+/**
+ * Delete subscriber credentials by providerId
+ *
+ * @remarks
+ * Delete subscriber credentials such as slack and expo tokens.
+ */
+export function useSubscribersCredentialsDeleteMutation(
+  options?: MutationHookOptions<
+    SubscribersCredentialsDeleteMutationData,
+    Error,
+    SubscribersCredentialsDeleteMutationVariables
+  >,
+): UseMutationResult<
+  SubscribersCredentialsDeleteMutationData,
+  Error,
+  SubscribersCredentialsDeleteMutationVariables
+> {
+  const client = useNovuContext();
+  return useMutation({
+    ...buildSubscribersCredentialsDeleteMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeySubscribersCredentialsDelete(): MutationKey {
+  return ["@novu/api", "Credentials", "delete"];
+}
+
+export function buildSubscribersCredentialsDeleteMutation(
+  client$: NovuCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: SubscribersCredentialsDeleteMutationVariables,
+  ) => Promise<SubscribersCredentialsDeleteMutationData>;
+} {
+  return {
+    mutationKey: mutationKeySubscribersCredentialsDelete(),
+    mutationFn: function subscribersCredentialsDeleteMutationFn({
+      subscriberId,
+      providerId,
+      idempotencyKey,
+      options,
+    }): Promise<SubscribersCredentialsDeleteMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(subscribersCredentialsDelete(
+        client$,
+        subscriberId,
+        providerId,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/subscribersCredentialsUpdate.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 { subscribersCredentialsUpdate } from "../funcs/subscribersCredentialsUpdate.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 SubscribersCredentialsUpdateMutationVariables = {
+  updateSubscriberChannelRequestDto:
+    components.UpdateSubscriberChannelRequestDto;
+  subscriberId: string;
+  idempotencyKey?: string | undefined;
+  options?: RequestOptions;
+};
+
+export type SubscribersCredentialsUpdateMutationData =
+  operations.SubscribersV1ControllerUpdateSubscriberChannelResponse;
+
+/**
+ * Update subscriber credentials
+ *
+ * @remarks
+ * Subscriber credentials associated to the delivery methods such as slack and push tokens.
+ */
+export function useSubscribersCredentialsUpdateMutation(
+  options?: MutationHookOptions<
+    SubscribersCredentialsUpdateMutationData,
+    Error,
+    SubscribersCredentialsUpdateMutationVariables
+  >,
+): UseMutationResult<
+  SubscribersCredentialsUpdateMutationData,
+  Error,
+  SubscribersCredentialsUpdateMutationVariables
+> {
+  const client = useNovuContext();
+  return useMutation({
+    ...buildSubscribersCredentialsUpdateMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeySubscribersCredentialsUpdate(): MutationKey {
+  return ["@novu/api", "Credentials", "update"];
+}
+
+export function buildSubscribersCredentialsUpdateMutation(
+  client$: NovuCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: SubscribersCredentialsUpdateMutationVariables,
+  ) => Promise<SubscribersCredentialsUpdateMutationData>;
+} {
+  return {
+    mutationKey: mutationKeySubscribersCredentialsUpdate(),
+    mutationFn: function subscribersCredentialsUpdateMutationFn({
+      updateSubscriberChannelRequestDto,
+      subscriberId,
+      idempotencyKey,
+      options,
+    }): Promise<SubscribersCredentialsUpdateMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(subscribersCredentialsUpdate(
+        client$,
+        updateSubscriberChannelRequestDto,
+        subscriberId,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/subscribersDelete.ts

@@ -0,0 +1,92 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { NovuCore } from "../core.js";
+import { subscribersDelete } from "../funcs/subscribersDelete.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 SubscribersDeleteMutationVariables = {
+  subscriberId: string;
+  idempotencyKey?: string | undefined;
+  options?: RequestOptions;
+};
+
+export type SubscribersDeleteMutationData =
+  operations.SubscribersControllerRemoveSubscriberResponse;
+
+/**
+ * Delete subscriber
+ *
+ * @remarks
+ * Deletes a subscriber entity from the Novu platform
+ */
+export function useSubscribersDeleteMutation(
+  options?: MutationHookOptions<
+    SubscribersDeleteMutationData,
+    Error,
+    SubscribersDeleteMutationVariables
+  >,
+): UseMutationResult<
+  SubscribersDeleteMutationData,
+  Error,
+  SubscribersDeleteMutationVariables
+> {
+  const client = useNovuContext();
+  return useMutation({
+    ...buildSubscribersDeleteMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeySubscribersDelete(): MutationKey {
+  return ["@novu/api", "Subscribers", "delete"];
+}
+
+export function buildSubscribersDeleteMutation(
+  client$: NovuCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: SubscribersDeleteMutationVariables,
+  ) => Promise<SubscribersDeleteMutationData>;
+} {
+  return {
+    mutationKey: mutationKeySubscribersDelete(),
+    mutationFn: function subscribersDeleteMutationFn({
+      subscriberId,
+      idempotencyKey,
+      options,
+    }): Promise<SubscribersDeleteMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(subscribersDelete(
+        client$,
+        subscriberId,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}