@novu/api 1.3.0 → 1.5.0

package/src/lib/config.ts

@@ -58,8 +58,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "2.2.0",
-  sdkVersion: "1.3.0",
-  genVersion: "2.620.2",
-  userAgent: "speakeasy-sdk/typescript 1.3.0 2.620.2 2.2.0 @novu/api",
+  openapiDocVersion: "2.3.0",
+  sdkVersion: "1.5.0",
+  genVersion: "2.661.4",
+  userAgent: "speakeasy-sdk/typescript 1.5.0 2.661.4 2.3.0 @novu/api",
 } as const;

package/src/lib/files.ts

@@ -38,3 +38,45 @@ export async function readableStreamToArrayBuffer(
 
   return concatenatedChunks.buffer as ArrayBuffer;
 }
+
+/**
+ * Determines the MIME content type based on a file's extension.
+ * Returns null if the extension is not recognized.
+ */
+export function getContentTypeFromFileName(fileName: string): string | null {
+  if (!fileName) return null;
+
+  const ext = fileName.toLowerCase().split(".").pop();
+  if (!ext) return null;
+
+  const mimeTypes: Record<string, string> = {
+    json: "application/json",
+    xml: "application/xml",
+    html: "text/html",
+    htm: "text/html",
+    txt: "text/plain",
+    csv: "text/csv",
+    pdf: "application/pdf",
+    png: "image/png",
+    jpg: "image/jpeg",
+    jpeg: "image/jpeg",
+    gif: "image/gif",
+    svg: "image/svg+xml",
+    js: "application/javascript",
+    css: "text/css",
+    zip: "application/zip",
+    tar: "application/x-tar",
+    gz: "application/gzip",
+    mp4: "video/mp4",
+    mp3: "audio/mpeg",
+    wav: "audio/wav",
+    webp: "image/webp",
+    ico: "image/x-icon",
+    woff: "font/woff",
+    woff2: "font/woff2",
+    ttf: "font/ttf",
+    otf: "font/otf",
+  };
+
+  return mimeTypes[ext] || null;
+}

package/src/lib/matchers.ts

@@ -2,12 +2,11 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
 import { SDKError } from "../models/errors/sdkerror.js";
-import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
-import { Result } from "../types/fp.js";
+import { ERR, OK, Result } from "../types/fp.js";
 import { matchResponse, matchStatusCode, StatusCodePredicate } from "./http.js";
 import { isPlainObject } from "./is-plain-object.js";
-import { safeParse } from "./schemas.js";
 
 export type Encoding =
   | "jsonl"
@@ -176,17 +175,19 @@ export type MatchedError<Matchers> = Matchers extends Matcher<any, infer E>[]
   : never;
 export type MatchFunc<T, E> = (
   response: Response,
+  request: Request,
   options?: { resultKey?: string; extraFields?: Record<string, unknown> },
 ) => Promise<[result: Result<T, E>, raw: unknown]>;
 
 export function match<T, E>(
   ...matchers: Array<Matcher<T, E>>
-): MatchFunc<T, E | SDKError | SDKValidationError> {
+): MatchFunc<T, E | SDKError | ResponseValidationError> {
   return async function matchFunc(
     response: Response,
+    request: Request,
     options?: { resultKey?: string; extraFields?: Record<string, unknown> },
   ): Promise<
-    [result: Result<T, E | SDKError | SDKValidationError>, raw: unknown]
+    [result: Result<T, E | SDKError | ResponseValidationError>, raw: unknown]
   > {
     let raw: unknown;
     let matcher: Matcher<T, E> | undefined;
@@ -205,21 +206,22 @@ export function match<T, E>(
     }
 
     if (!matcher) {
-      const responseBody = await response.text();
       return [{
         ok: false,
-        error: new SDKError(
-          "Unexpected API response status or content-type",
+        error: new SDKError("Unexpected Status or Content-Type", {
           response,
-          responseBody,
-        ),
-      }, responseBody];
+          request,
+          body: await response.text().catch(() => ""),
+        }),
+      }, raw];
     }
 
     const encoding = matcher.enc;
+    let body = "";
     switch (encoding) {
       case "json":
-        raw = await response.json();
+        body = await response.text();
+        raw = JSON.parse(body);
         break;
       case "jsonl":
         raw = response.body;
@@ -231,16 +233,19 @@ export function match<T, E>(
         raw = response.body;
         break;
       case "text":
-        raw = await response.text();
+        body = await response.text();
+        raw = body;
         break;
       case "sse":
         raw = response.body;
         break;
       case "nil":
-        raw = await discardResponseBody(response);
+        body = await response.text();
+        raw = undefined;
         break;
       case "fail":
-        raw = await response.text();
+        body = await response.text();
+        raw = body;
         break;
       default:
         encoding satisfies never;
@@ -250,11 +255,7 @@ export function match<T, E>(
     if (matcher.enc === "fail") {
       return [{
         ok: false,
-        error: new SDKError(
-          "API error occurred",
-          response,
-          typeof raw === "string" ? raw : "",
-        ),
+        error: new SDKError("API error occurred", { request, response, body }),
       }, raw];
     }
 
@@ -266,6 +267,9 @@ export function match<T, E>(
         ...options?.extraFields,
         ...(matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null),
         ...(isPlainObject(raw) ? raw : null),
+        request$: request,
+        response$: response,
+        body$: body,
       };
     } else if (resultKey) {
       data = {
@@ -284,18 +288,20 @@ export function match<T, E>(
     }
 
     if ("err" in matcher) {
-      const result = safeParse(
+      const result = safeParseResponse(
         data,
         (v: unknown) => matcher.schema.parse(v),
         "Response validation failed",
+        { request, response, body },
       );
       return [result.ok ? { ok: false, error: result.value } : result, raw];
     } else {
       return [
-        safeParse(
+        safeParseResponse(
           data,
           (v: unknown) => matcher.schema.parse(v),
           "Response validation failed",
+          { request, response, body },
         ),
         raw,
       ];
@@ -318,25 +324,22 @@ export function unpackHeaders(headers: Headers): Record<string, string[]> {
   return out;
 }
 
-/**
- * Discards the response body to free up resources.
- *
- * To learn why this is need, see the undici docs:
- * https://undici.nodejs.org/#/?id=garbage-collection
- */
-export async function discardResponseBody(res: Response) {
-  const reader = res.body?.getReader();
-  if (reader == null) {
-    return;
-  }
-
+function safeParseResponse<Inp, Out>(
+  rawValue: Inp,
+  fn: (value: Inp) => Out,
+  errorMessage: string,
+  httpMeta: { response: Response; request: Request; body: string },
+): Result<Out, ResponseValidationError> {
   try {
-    let done = false;
-    while (!done) {
-      const res = await reader.read();
-      done = res.done;
-    }
-  } finally {
-    reader.releaseLock();
+    return OK(fn(rawValue));
+  } catch (err) {
+    return ERR(
+      new ResponseValidationError(errorMessage, {
+        cause: err,
+        rawValue,
+        rawMessage: errorMessage,
+        ...httpMeta,
+      }),
+    );
   }
 }

package/src/lib/security.ts

@@ -6,8 +6,8 @@ import * as components from "../models/components/index.js";
 
 type OAuth2PasswordFlow = {
   username: string;
-  password?: string | undefined;
-  clientID: string;
+  password: string;
+  clientID?: string | undefined;
   clientSecret?: string | undefined;
   tokenURL: string;
 };

package/src/mcp-server/cli/start/command.ts

@@ -6,7 +6,6 @@ import { buildCommand } from "@stricli/core";
 import { numberParser } from "@stricli/core";
 import * as z from "zod";
 import { consoleLoggerLevels } from "../../console-logger.js";
-import { mcpScopes } from "../../scopes.js";
 
 export const startCommand = buildCommand({
   loader: async () => {
@@ -37,18 +36,6 @@ export const startCommand = buildCommand({
           return z.string().parse(value);
         },
       },
-      ...(mcpScopes.length
-        ? {
-          scope: {
-            kind: "enum",
-            brief:
-              "Mount tools/resources that match given scope (repeatable flag)",
-            values: mcpScopes,
-            variadic: true,
-            optional: true,
-          },
-        }
-        : {}),
       "secret-key": {
         kind: "parsed",
         brief: "Sets the secretKey auth field for the API",

package/src/mcp-server/cli/start/impl.ts

@@ -11,14 +11,12 @@ import {
   ConsoleLoggerLevel,
   createConsoleLogger,
 } from "../../console-logger.js";
-import { MCPScope } from "../../scopes.js";
 import { createMCPServer } from "../../server.js";
 
 interface StartCommandFlags {
   readonly transport: "stdio" | "sse";
   readonly port: number;
   readonly tool?: string[];
-  readonly scope?: MCPScope[];
   readonly "secret-key"?: string | undefined;
   readonly "server-url"?: string;
   readonly "server-index"?: SDKOptions["serverIdx"];
@@ -49,7 +47,6 @@ async function startStdio(flags: StartCommandFlags) {
   const server = createMCPServer({
     logger,
     allowedTools: flags.tool,
-    scopes: flags.scope,
     ...{ secretKey: flags["secret-key"] ?? "" },
     serverURL: flags["server-url"],
     serverIdx: flags["server-index"],
@@ -70,7 +67,6 @@ async function startSSE(flags: StartCommandFlags) {
   const mcpServer = createMCPServer({
     logger,
     allowedTools: flags.tool,
-    scopes: flags.scope,
     ...{ secretKey: flags["secret-key"] ?? "" },
     serverURL: flags["server-url"],
     serverIdx: flags["server-index"],

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

@@ -19,7 +19,7 @@ const routes = buildRouteMap({
 export const app = buildApplication(routes, {
   name: "mcp",
   versionInfo: {
-    currentVersion: "1.3.0",
+    currentVersion: "1.5.0",
   },
 });
 

package/src/mcp-server/server.ts

@@ -14,6 +14,11 @@ import {
 import { MCPScope } from "./scopes.js";
 import { createRegisterTool } from "./tools.js";
 import { tool$cancel } from "./tools/cancel.js";
+import { tool$environmentsCreate } from "./tools/environmentsCreate.js";
+import { tool$environmentsDelete } from "./tools/environmentsDelete.js";
+import { tool$environmentsGetTags } from "./tools/environmentsGetTags.js";
+import { tool$environmentsList } from "./tools/environmentsList.js";
+import { tool$environmentsUpdate } from "./tools/environmentsUpdate.js";
 import { tool$integrationsCreate } from "./tools/integrationsCreate.js";
 import { tool$integrationsDelete } from "./tools/integrationsDelete.js";
 import { tool$integrationsList } from "./tools/integrationsList.js";
@@ -25,6 +30,7 @@ import { tool$messagesDeleteByTransactionId } from "./tools/messagesDeleteByTran
 import { tool$messagesRetrieve } from "./tools/messagesRetrieve.js";
 import { tool$notificationsList } from "./tools/notificationsList.js";
 import { tool$notificationsRetrieve } from "./tools/notificationsRetrieve.js";
+import { tool$retrieve } from "./tools/retrieve.js";
 import { tool$subscribersCreate } from "./tools/subscribersCreate.js";
 import { tool$subscribersCreateBulk } from "./tools/subscribersCreateBulk.js";
 import { tool$subscribersCredentialsAppend } from "./tools/subscribersCredentialsAppend.js";
@@ -55,6 +61,14 @@ import { tool$topicsUpdate } from "./tools/topicsUpdate.js";
 import { tool$trigger } from "./tools/trigger.js";
 import { tool$triggerBroadcast } from "./tools/triggerBroadcast.js";
 import { tool$triggerBulk } from "./tools/triggerBulk.js";
+import { tool$workflowsCreate } from "./tools/workflowsCreate.js";
+import { tool$workflowsDelete } from "./tools/workflowsDelete.js";
+import { tool$workflowsGet } from "./tools/workflowsGet.js";
+import { tool$workflowsList } from "./tools/workflowsList.js";
+import { tool$workflowsPatch } from "./tools/workflowsPatch.js";
+import { tool$workflowsStepsRetrieve } from "./tools/workflowsStepsRetrieve.js";
+import { tool$workflowsSync } from "./tools/workflowsSync.js";
+import { tool$workflowsUpdate } from "./tools/workflowsUpdate.js";
 
 export function createMCPServer(deps: {
   logger: ConsoleLogger;
@@ -66,7 +80,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "Novu",
-    version: "1.3.0",
+    version: "1.5.0",
   });
 
   const client = new NovuCore({
@@ -100,6 +114,12 @@ export function createMCPServer(deps: {
   tool(tool$cancel);
   tool(tool$triggerBroadcast);
   tool(tool$triggerBulk);
+  tool(tool$retrieve);
+  tool(tool$environmentsGetTags);
+  tool(tool$environmentsCreate);
+  tool(tool$environmentsList);
+  tool(tool$environmentsUpdate);
+  tool(tool$environmentsDelete);
   tool(tool$subscribersSearch);
   tool(tool$subscribersCreate);
   tool(tool$subscribersRetrieve);
@@ -111,6 +131,13 @@ export function createMCPServer(deps: {
   tool(tool$topicsGet);
   tool(tool$topicsUpdate);
   tool(tool$topicsDelete);
+  tool(tool$workflowsCreate);
+  tool(tool$workflowsList);
+  tool(tool$workflowsUpdate);
+  tool(tool$workflowsGet);
+  tool(tool$workflowsDelete);
+  tool(tool$workflowsPatch);
+  tool(tool$workflowsSync);
   tool(tool$integrationsList);
   tool(tool$integrationsCreate);
   tool(tool$integrationsUpdate);
@@ -138,6 +165,7 @@ export function createMCPServer(deps: {
   tool(tool$topicsSubscriptionsCreate);
   tool(tool$topicsSubscriptionsDelete);
   tool(tool$topicsSubscribersRetrieve);
+  tool(tool$workflowsStepsRetrieve);
 
   return server;
 }

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

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { environmentsCreate } from "../../funcs/environmentsCreate.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  createEnvironmentRequestDto:
+    components.CreateEnvironmentRequestDto$inboundSchema,
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$environmentsCreate: ToolDefinition<typeof args> = {
+  name: "environments-create",
+  description: `Create an environment
+
+Creates a new environment within the current organization. 
+    Environments allow you to manage different stages of your application development lifecycle.
+    Each environment has its own set of API keys and configurations.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await environmentsCreate(
+      client,
+      args.createEnvironmentRequestDto,
+      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/environmentsDelete.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { environmentsDelete } from "../../funcs/environmentsDelete.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  environmentId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$environmentsDelete: ToolDefinition<typeof args> = {
+  name: "environments-delete",
+  description: `Delete an environment
+
+Delete an environment by its unique identifier **environmentId**. 
+    This action is irreversible and will remove the environment and all its associated data.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await environmentsDelete(
+      client,
+      args.environmentId,
+      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/environmentsGetTags.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { environmentsGetTags } from "../../funcs/environmentsGetTags.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  environmentId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$environmentsGetTags: ToolDefinition<typeof args> = {
+  name: "environments-get-tags",
+  description: `Get environment tags
+
+Retrieve all unique tags used in workflows within the specified environment. These tags can be used for filtering workflows.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await environmentsGetTags(
+      client,
+      args.environmentId,
+      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/environmentsList.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { environmentsList } from "../../funcs/environmentsList.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$environmentsList: ToolDefinition<typeof args> = {
+  name: "environments-list",
+  description: `List all environments
+
+This API returns a list of environments for the current organization. 
+    Each environment contains its configuration, API keys (if user has access), and metadata.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await environmentsList(
+      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/environmentsUpdate.ts

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { environmentsUpdate } from "../../funcs/environmentsUpdate.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  updateEnvironmentRequestDto:
+    components.UpdateEnvironmentRequestDto$inboundSchema,
+  environmentId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$environmentsUpdate: ToolDefinition<typeof args> = {
+  name: "environments-update",
+  description: `Update an environment
+
+Update an environment by its unique identifier **environmentId**. 
+    You can modify the environment name, identifier, color, and other configuration settings.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await environmentsUpdate(
+      client,
+      args.updateEnvironmentRequestDto,
+      args.environmentId,
+      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/retrieve.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { retrieve } from "../../funcs/retrieve.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.LogsControllerGetLogsRequest$inboundSchema,
+};
+
+export const tool$retrieve: ToolDefinition<typeof args> = {
+  name: "retrieve",
+  description: ``,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await retrieve(
+      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;
+
+    return formatResult(value, apiCall);
+  },
+};

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

@@ -16,10 +16,10 @@ const args = {
 
 export const tool$subscribersCredentialsAppend: ToolDefinition<typeof args> = {
   name: "subscribers-credentials-append",
-  description: `Upsert provider credentials
+  description: `Create or Partially Update provider credentials
 
-Update credentials for a provider such as **slack** and **FCM**. 
-      **providerId** is required field. This API replaces the existing deviceTokens with the provided ones.`,
+Create or Partially credentials for a provider such as **slack** and **FCM**. 
+      **providerId** is required field. This API creates the **deviceTokens** or replaces the existing ones.`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await subscribersCredentialsAppend(

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

@@ -16,10 +16,10 @@ const args = {
 
 export const tool$subscribersCredentialsUpdate: ToolDefinition<typeof args> = {
   name: "subscribers-credentials-update",
-  description: `Update provider credentials
+  description: `Upsert provider credentials
 
-Update credentials for a provider such as slack and push tokens. 
-      **providerId** is required field. This API appends the **deviceTokens** to the existing ones.`,
+Upsert credentials for a provider such as slack and push tokens. 
+      **providerId** is required field. This API creates **deviceTokens** or appends to the existing ones.`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await subscribersCredentialsUpdate(