@novu/api 0.3.0 → 0.4.0

package/src/mcp-server/server.ts

@@ -0,0 +1,126 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { NovuCore } from "../core.js";
+import { SDKOptions } from "../lib/config.js";
+import type { ConsoleLogger } from "./console-logger.js";
+import { MCPScope, mcpScopes } from "./scopes.js";
+import { createRegisterTool } from "./tools.js";
+import { tool$cancel } from "./tools/cancel.js";
+import { tool$integrationsCreate } from "./tools/integrationsCreate.js";
+import { tool$integrationsDelete } from "./tools/integrationsDelete.js";
+import { tool$integrationsList } from "./tools/integrationsList.js";
+import { tool$integrationsListActive } from "./tools/integrationsListActive.js";
+import { tool$integrationsSetAsPrimary } from "./tools/integrationsSetAsPrimary.js";
+import { tool$integrationsUpdate } from "./tools/integrationsUpdate.js";
+import { tool$integrationsWebhooksRetrieve } from "./tools/integrationsWebhooksRetrieve.js";
+import { tool$messagesDelete } from "./tools/messagesDelete.js";
+import { tool$messagesDeleteByTransactionId } from "./tools/messagesDeleteByTransactionId.js";
+import { tool$messagesRetrieve } from "./tools/messagesRetrieve.js";
+import { tool$notificationsList } from "./tools/notificationsList.js";
+import { tool$notificationsRetrieve } from "./tools/notificationsRetrieve.js";
+import { tool$notificationsStatsGraph } from "./tools/notificationsStatsGraph.js";
+import { tool$notificationsStatsRetrieve } from "./tools/notificationsStatsRetrieve.js";
+import { tool$subscribersAuthenticationChatAccessOauth } from "./tools/subscribersAuthenticationChatAccessOauth.js";
+import { tool$subscribersAuthenticationChatAccessOauthCallBack } from "./tools/subscribersAuthenticationChatAccessOauthCallBack.js";
+import { tool$subscribersCreate } from "./tools/subscribersCreate.js";
+import { tool$subscribersCreateBulk } from "./tools/subscribersCreateBulk.js";
+import { tool$subscribersCredentialsAppend } from "./tools/subscribersCredentialsAppend.js";
+import { tool$subscribersCredentialsDelete } from "./tools/subscribersCredentialsDelete.js";
+import { tool$subscribersCredentialsUpdate } from "./tools/subscribersCredentialsUpdate.js";
+import { tool$subscribersDelete } from "./tools/subscribersDelete.js";
+import { tool$subscribersList } from "./tools/subscribersList.js";
+import { tool$subscribersMessagesMarkAll } from "./tools/subscribersMessagesMarkAll.js";
+import { tool$subscribersMessagesMarkAllAs } from "./tools/subscribersMessagesMarkAllAs.js";
+import { tool$subscribersMessagesUpdateAsSeen } from "./tools/subscribersMessagesUpdateAsSeen.js";
+import { tool$subscribersNotificationsFeed } from "./tools/subscribersNotificationsFeed.js";
+import { tool$subscribersNotificationsUnseenCount } from "./tools/subscribersNotificationsUnseenCount.js";
+import { tool$subscribersPatch } from "./tools/subscribersPatch.js";
+import { tool$subscribersPreferencesList } from "./tools/subscribersPreferencesList.js";
+import { tool$subscribersPreferencesUpdate } from "./tools/subscribersPreferencesUpdate.js";
+import { tool$subscribersPropertiesUpdateOnlineFlag } from "./tools/subscribersPropertiesUpdateOnlineFlag.js";
+import { tool$subscribersRetrieve } from "./tools/subscribersRetrieve.js";
+import { tool$subscribersSearch } from "./tools/subscribersSearch.js";
+import { tool$topicsCreate } from "./tools/topicsCreate.js";
+import { tool$topicsDelete } from "./tools/topicsDelete.js";
+import { tool$topicsList } from "./tools/topicsList.js";
+import { tool$topicsRename } from "./tools/topicsRename.js";
+import { tool$topicsRetrieve } from "./tools/topicsRetrieve.js";
+import { tool$topicsSubscribersAssign } from "./tools/topicsSubscribersAssign.js";
+import { tool$topicsSubscribersRemove } from "./tools/topicsSubscribersRemove.js";
+import { tool$topicsSubscribersRetrieve } from "./tools/topicsSubscribersRetrieve.js";
+import { tool$trigger } from "./tools/trigger.js";
+import { tool$triggerBroadcast } from "./tools/triggerBroadcast.js";
+import { tool$triggerBulk } from "./tools/triggerBulk.js";
+
+export function createMCPServer(deps: {
+  logger: ConsoleLogger;
+  scopes?: MCPScope[] | undefined;
+  serverURL?: string | undefined;
+  secretKey?: SDKOptions["secretKey"] | undefined;
+  serverIdx?: SDKOptions["serverIdx"] | undefined;
+}) {
+  const server = new McpServer({
+    name: "Novu",
+    version: "0.4.0",
+  });
+
+  const client = new NovuCore({
+    secretKey: deps.secretKey,
+    serverURL: deps.serverURL,
+    serverIdx: deps.serverIdx,
+  });
+  const scopes = new Set(deps.scopes ?? mcpScopes);
+  const tool = createRegisterTool(deps.logger, server, client, scopes);
+
+  tool(tool$trigger);
+  tool(tool$triggerBulk);
+  tool(tool$triggerBroadcast);
+  tool(tool$cancel);
+  tool(tool$notificationsList);
+  tool(tool$notificationsRetrieve);
+  tool(tool$integrationsList);
+  tool(tool$integrationsCreate);
+  tool(tool$integrationsListActive);
+  tool(tool$integrationsUpdate);
+  tool(tool$integrationsDelete);
+  tool(tool$integrationsSetAsPrimary);
+  tool(tool$subscribersList);
+  tool(tool$subscribersCreateBulk);
+  tool(tool$subscribersSearch);
+  tool(tool$subscribersCreate);
+  tool(tool$subscribersRetrieve);
+  tool(tool$subscribersPatch);
+  tool(tool$subscribersDelete);
+  tool(tool$messagesRetrieve);
+  tool(tool$messagesDelete);
+  tool(tool$messagesDeleteByTransactionId);
+  tool(tool$topicsCreate);
+  tool(tool$topicsList);
+  tool(tool$topicsDelete);
+  tool(tool$topicsRetrieve);
+  tool(tool$topicsRename);
+  tool(tool$notificationsStatsRetrieve);
+  tool(tool$notificationsStatsGraph);
+  tool(tool$integrationsWebhooksRetrieve);
+  tool(tool$subscribersCredentialsUpdate);
+  tool(tool$subscribersCredentialsAppend);
+  tool(tool$subscribersCredentialsDelete);
+  tool(tool$subscribersPropertiesUpdateOnlineFlag);
+  tool(tool$subscribersNotificationsFeed);
+  tool(tool$subscribersNotificationsUnseenCount);
+  tool(tool$subscribersMessagesMarkAllAs);
+  tool(tool$subscribersMessagesMarkAll);
+  tool(tool$subscribersMessagesUpdateAsSeen);
+  tool(tool$subscribersAuthenticationChatAccessOauthCallBack);
+  tool(tool$subscribersAuthenticationChatAccessOauth);
+  tool(tool$subscribersPreferencesList);
+  tool(tool$subscribersPreferencesUpdate);
+  tool(tool$topicsSubscribersAssign);
+  tool(tool$topicsSubscribersRetrieve);
+  tool(tool$topicsSubscribersRemove);
+
+  return server;
+}

package/src/mcp-server/shared.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { bytesToBase64 } from "../lib/base64.js";
+
+type BinaryData =
+  | Uint8Array
+  | ArrayBuffer
+  | Blob
+  | ReadableStream
+  | Response
+  | string;
+
+export async function consumeStream(
+  stream: ReadableStream<Uint8Array>,
+): Promise<Uint8Array> {
+  const reader = stream.getReader();
+  const chunks: Uint8Array[] = [];
+
+  try {
+    while (true) {
+      const { done, value } = await reader.read();
+      if (value != null) chunks.push(value);
+      if (done) break;
+    }
+  } finally {
+    reader.releaseLock();
+  }
+
+  return new Uint8Array(await new Blob(chunks).arrayBuffer());
+}
+
+export function isAsyncIterable(
+  value: unknown,
+): value is AsyncIterable<string> {
+  return (
+    typeof value === "object" && value != null && Symbol.asyncIterator in value
+  );
+}
+
+export function isBinaryData(value: unknown): value is BinaryData {
+  return (
+    value instanceof Uint8Array
+    || value instanceof ArrayBuffer
+    || value instanceof Blob
+    || value instanceof ReadableStream
+    || value instanceof Response
+    || typeof value === "string"
+  );
+}
+
+const base64Schema = z.string().base64();
+
+export async function valueToBase64(
+  value: BinaryData | null | undefined,
+): Promise<string | null> {
+  if (value == null) {
+    return null;
+  } else if (value instanceof Uint8Array) {
+    return bytesToBase64(value);
+  } else if (value instanceof ArrayBuffer) {
+    return bytesToBase64(new Uint8Array(value));
+  } else if (value instanceof Response || value instanceof Blob) {
+    return bytesToBase64(new Uint8Array(await value.arrayBuffer()));
+  } else if (value instanceof ReadableStream) {
+    return bytesToBase64(await consumeStream(value));
+  } else if (typeof value === "string") {
+    return base64Schema.parse(value);
+  } else {
+    value satisfies never;
+    throw new Error(`Unsupported image value type: ${typeof value}`);
+  }
+}

package/src/mcp-server/tools/cancel.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { cancel } from "../../funcs/cancel.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  transactionId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$cancel: ToolDefinition<typeof args> = {
+  name: "cancel",
+  description: `Cancel triggered event
+
+
+    Using a previously generated transactionId during the event trigger,
+     will cancel any active or pending workflows. This is useful to cancel active digests, delays etc...
+    `,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await cancel(
+      client,
+      args.transactionId,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/integrationsCreate.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { integrationsCreate } from "../../funcs/integrationsCreate.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  createIntegrationRequestDto:
+    components.CreateIntegrationRequestDto$inboundSchema,
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$integrationsCreate: ToolDefinition<typeof args> = {
+  name: "integrations_create",
+  description: `Create integration
+
+Create an integration for the current environment the user is based on the API key provided`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await integrationsCreate(
+      client,
+      args.createIntegrationRequestDto,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/integrationsDelete.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { integrationsDelete } from "../../funcs/integrationsDelete.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  integrationId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$integrationsDelete: ToolDefinition<typeof args> = {
+  name: "integrations_delete",
+  description: `Delete integration`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await integrationsDelete(
+      client,
+      args.integrationId,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/integrationsList.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { integrationsList } from "../../funcs/integrationsList.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$integrationsList: ToolDefinition<typeof args> = {
+  name: "integrations_list",
+  description: `Get integrations
+
+Return all the integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await integrationsList(
+      client,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/integrationsListActive.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { integrationsListActive } from "../../funcs/integrationsListActive.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$integrationsListActive: ToolDefinition<typeof args> = {
+  name: "integrations_list-active",
+  description: `Get active integrations
+
+Return all the active integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await integrationsListActive(
+      client,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/integrationsSetAsPrimary.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { integrationsSetAsPrimary } from "../../funcs/integrationsSetAsPrimary.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  integrationId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$integrationsSetAsPrimary: ToolDefinition<typeof args> = {
+  name: "integrations_set-as-primary",
+  description: `Set integration as primary`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await integrationsSetAsPrimary(
+      client,
+      args.integrationId,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/integrationsUpdate.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { integrationsUpdate } from "../../funcs/integrationsUpdate.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  updateIntegrationRequestDto:
+    components.UpdateIntegrationRequestDto$inboundSchema,
+  integrationId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$integrationsUpdate: ToolDefinition<typeof args> = {
+  name: "integrations_update",
+  description: `Update integration`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await integrationsUpdate(
+      client,
+      args.updateIntegrationRequestDto,
+      args.integrationId,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/integrationsWebhooksRetrieve.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { integrationsWebhooksRetrieve } from "../../funcs/integrationsWebhooksRetrieve.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  providerOrIntegrationId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$integrationsWebhooksRetrieve: ToolDefinition<typeof args> = {
+  name: "integrations-webhooks_retrieve",
+  description: `Get webhook support status for provider
+
+Return the status of the webhook for this provider, if it is supported or if it is not based on a boolean value`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await integrationsWebhooksRetrieve(
+      client,
+      args.providerOrIntegrationId,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/messagesDelete.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { messagesDelete } from "../../funcs/messagesDelete.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  messageId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$messagesDelete: ToolDefinition<typeof args> = {
+  name: "messages_delete",
+  description: `Delete message
+
+Deletes a message entity from the Novu platform`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await messagesDelete(
+      client,
+      args.messageId,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/messagesDeleteByTransactionId.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { messagesDeleteByTransactionId } from "../../funcs/messagesDeleteByTransactionId.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  transactionId: z.string(),
+  channel: operations.Channel$inboundSchema.optional(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$messagesDeleteByTransactionId: ToolDefinition<typeof args> = {
+  name: "messages_delete-by-transaction-id",
+  description: `Delete messages by transactionId
+
+Deletes messages entity from the Novu platform using TransactionId of message`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await messagesDeleteByTransactionId(
+      client,
+      args.transactionId,
+      args.channel,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    return formatResult(void 0, apiCall);
+  },
+};

package/src/mcp-server/tools/messagesRetrieve.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { messagesRetrieve } from "../../funcs/messagesRetrieve.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.MessagesControllerGetMessagesRequest$inboundSchema,
+};
+
+export const tool$messagesRetrieve: ToolDefinition<typeof args> = {
+  name: "messages_retrieve",
+  description: `Get messages
+
+Returns a list of messages, could paginate using the \`page\` query parameter`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await messagesRetrieve(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/notificationsList.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { notificationsList } from "../../funcs/notificationsList.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request:
+    operations.NotificationsControllerListNotificationsRequest$inboundSchema,
+};
+
+export const tool$notificationsList: ToolDefinition<typeof args> = {
+  name: "notifications_list",
+  description: `Get notifications`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await notificationsList(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};