@novu/api 0.2.1 → 0.4.0

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

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { topicsSubscribersRemove } from "../../funcs/topicsSubscribersRemove.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  removeSubscribersRequestDto:
+    components.RemoveSubscribersRequestDto$inboundSchema,
+  topicKey: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$topicsSubscribersRemove: ToolDefinition<typeof args> = {
+  name: "topics-subscribers_remove",
+  description: `Subscribers removal
+
+Remove subscribers from a topic`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await topicsSubscribersRemove(
+      client,
+      args.removeSubscribersRequestDto,
+      args.topicKey,
+      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/topicsSubscribersRetrieve.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { topicsSubscribersRetrieve } from "../../funcs/topicsSubscribersRetrieve.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  externalSubscriberId: z.string(),
+  topicKey: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$topicsSubscribersRetrieve: ToolDefinition<typeof args> = {
+  name: "topics-subscribers_retrieve",
+  description: `Check topic subscriber
+
+Check if a subscriber belongs to a certain topic`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await topicsSubscribersRetrieve(
+      client,
+      args.externalSubscriberId,
+      args.topicKey,
+      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/trigger.ts

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { trigger } from "../../funcs/trigger.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  triggerEventRequestDto: components.TriggerEventRequestDto$inboundSchema,
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$trigger: ToolDefinition<typeof args> = {
+  name: "trigger",
+  description: `Trigger event
+
+
+    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.
+    `,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await trigger(
+      client,
+      args.triggerEventRequestDto,
+      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/triggerBroadcast.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { triggerBroadcast } from "../../funcs/triggerBroadcast.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  triggerEventToAllRequestDto:
+    components.TriggerEventToAllRequestDto$inboundSchema,
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$triggerBroadcast: ToolDefinition<typeof args> = {
+  name: "trigger-broadcast",
+  description: `Broadcast event to all
+
+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.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await triggerBroadcast(
+      client,
+      args.triggerEventToAllRequestDto,
+      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/triggerBulk.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { triggerBulk } from "../../funcs/triggerBulk.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  bulkTriggerEventDto: components.BulkTriggerEventDto$inboundSchema,
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$triggerBulk: ToolDefinition<typeof args> = {
+  name: "trigger-bulk",
+  description: `Bulk trigger event
+
+
+      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.
+    `,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await triggerBulk(
+      client,
+      args.bulkTriggerEventDto,
+      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.ts

@@ -0,0 +1,116 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
+import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { objectOutputType, ZodRawShape, ZodTypeAny } from "zod";
+import { NovuCore } from "../core.js";
+import { ConsoleLogger } from "./console-logger.js";
+import { MCPScope } from "./scopes.js";
+import { isAsyncIterable, isBinaryData, valueToBase64 } from "./shared.js";
+
+export type ToolDefinition<Args extends undefined | ZodRawShape = undefined> =
+  Args extends ZodRawShape ? {
+      name: string;
+      description: string;
+      scopes?: MCPScope[];
+      args: Args;
+      tool: (
+        client: NovuCore,
+        args: objectOutputType<Args, ZodTypeAny>,
+        extra: RequestHandlerExtra,
+      ) => CallToolResult | Promise<CallToolResult>;
+    }
+    : {
+      name: string;
+      description: string;
+      scopes?: MCPScope[];
+      args?: undefined;
+      tool: (
+        client: NovuCore,
+        extra: RequestHandlerExtra,
+      ) => CallToolResult | Promise<CallToolResult>;
+    };
+
+export async function formatResult(
+  value: unknown,
+  init: { response?: Response | undefined },
+): Promise<CallToolResult> {
+  if (typeof value === "undefined") {
+    return { content: [] };
+  }
+
+  const { response } = init;
+  const contentType = response?.headers.get("content-type") ?? "";
+  let content: CallToolResult["content"] = [];
+
+  if (contentType.search(/\bjson\b/g)) {
+    content = [{ type: "text", text: JSON.stringify(value) }];
+  } else if (
+    contentType.startsWith("text/event-stream")
+    && isAsyncIterable(value)
+  ) {
+    content = await consumeSSE(value);
+  } else if (contentType.startsWith("text/") && typeof value === "string") {
+    content = [{ type: "text", text: value }];
+  } else if (isBinaryData(value) && contentType.startsWith("image/")) {
+    const data = await valueToBase64(value);
+    content = data == null
+      ? []
+      : [{ type: "image", data, mimeType: contentType }];
+  } else {
+    return {
+      content: [{
+        type: "text",
+        text: `Unsupported content type: "${contentType}"`,
+      }],
+      isError: true,
+    };
+  }
+
+  return { content };
+}
+
+async function consumeSSE(
+  value: AsyncIterable<unknown>,
+): Promise<CallToolResult["content"]> {
+  const content: CallToolResult["content"] = [];
+
+  for await (const chunk of value) {
+    if (typeof chunk === "string") {
+      content.push({ type: "text", text: chunk });
+    } else {
+      content.push({ type: "text", text: JSON.stringify(chunk) });
+    }
+  }
+
+  return content;
+}
+
+export function createRegisterTool(
+  logger: ConsoleLogger,
+  server: McpServer,
+  sdk: NovuCore,
+  allowedScopes: Set<MCPScope>,
+): <A extends ZodRawShape | undefined>(tool: ToolDefinition<A>) => void {
+  return <A extends ZodRawShape | undefined>(tool: ToolDefinition<A>): void => {
+    const toolScopes = tool.scopes ?? [];
+    if (!toolScopes.every((s) => allowedScopes.has(s))) {
+      return;
+    }
+
+    if (tool.args) {
+      server.tool(tool.name, tool.description, tool.args, async (args, ctx) => {
+        return tool.tool(sdk, args, ctx);
+      });
+    } else {
+      server.tool(tool.name, tool.description, async (ctx) => {
+        return tool.tool(sdk, ctx);
+      });
+    }
+
+    logger.debug("Registered tool", { name: tool.name });
+  };
+}

package/src/models/components/activitynotificationtemplateresponsedto.ts

@@ -13,6 +13,11 @@ import {
   NotificationTriggerDto$Outbound,
   NotificationTriggerDto$outboundSchema,
 } from "./notificationtriggerdto.js";
+import {
+  WorkflowOriginEnum,
+  WorkflowOriginEnum$inboundSchema,
+  WorkflowOriginEnum$outboundSchema,
+} from "./workfloworiginenum.js";
 
 export type ActivityNotificationTemplateResponseDto = {
   /**
@@ -23,6 +28,10 @@ export type ActivityNotificationTemplateResponseDto = {
    * Name of the template
    */
   name: string;
+  /**
+   * Origin of the workflow
+   */
+  origin?: WorkflowOriginEnum | undefined;
   /**
    * Triggers of the template
    */
@@ -37,6 +46,7 @@ export const ActivityNotificationTemplateResponseDto$inboundSchema: z.ZodType<
 > = z.object({
   _id: z.string().optional(),
   name: z.string(),
+  origin: WorkflowOriginEnum$inboundSchema.optional(),
   triggers: z.array(NotificationTriggerDto$inboundSchema),
 }).transform((v) => {
   return remap$(v, {
@@ -48,6 +58,7 @@ export const ActivityNotificationTemplateResponseDto$inboundSchema: z.ZodType<
 export type ActivityNotificationTemplateResponseDto$Outbound = {
   _id?: string | undefined;
   name: string;
+  origin?: string | undefined;
   triggers: Array<NotificationTriggerDto$Outbound>;
 };
 
@@ -59,6 +70,7 @@ export const ActivityNotificationTemplateResponseDto$outboundSchema: z.ZodType<
 > = z.object({
   id: z.string().optional(),
   name: z.string(),
+  origin: WorkflowOriginEnum$outboundSchema.optional(),
   triggers: z.array(NotificationTriggerDto$outboundSchema),
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/createsubscriberrequestdto.ts

@@ -6,112 +6,46 @@ import * as z from "zod";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-import {
-  SubscriberChannelDto,
-  SubscriberChannelDto$inboundSchema,
-  SubscriberChannelDto$Outbound,
-  SubscriberChannelDto$outboundSchema,
-} from "./subscriberchanneldto.js";
-
-export type CreateSubscriberRequestDtoData =
-  | string
-  | Array<string>
-  | boolean
-  | number;
 
 export type CreateSubscriberRequestDto = {
   /**
-   * The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems
+   * Unique identifier of the subscriber
    */
   subscriberId: string;
   /**
-   * The email address of the subscriber.
+   * First name of the subscriber
    */
-  email?: string | undefined;
+  firstName?: string | null | undefined;
   /**
-   * The first name of the subscriber.
+   * Last name of the subscriber
    */
-  firstName?: string | undefined;
+  lastName?: string | null | undefined;
   /**
-   * The last name of the subscriber.
+   * Email address of the subscriber
    */
-  lastName?: string | undefined;
+  email?: string | null | undefined;
   /**
-   * The phone number of the subscriber.
+   * Phone number of the subscriber
    */
-  phone?: string | undefined;
+  phone?: string | null | undefined;
   /**
-   * An HTTP URL to the profile image of your subscriber.
+   * Avatar URL or identifier
    */
-  avatar?: string | undefined;
+  avatar?: string | null | undefined;
   /**
-   * The locale of the subscriber.
+   * Timezone of the subscriber
    */
-  locale?: string | undefined;
+  timezone?: string | null | undefined;
   /**
-   * An optional payload object that can contain any properties.
+   * Locale of the subscriber
    */
-  data?: { [k: string]: string | Array<string> | boolean | number } | undefined;
+  locale?: string | null | undefined;
   /**
-   * An optional array of subscriber channels.
+   * Additional custom data for the subscriber
    */
-  channels?: Array<SubscriberChannelDto> | undefined;
+  data?: { [k: string]: any } | null | undefined;
 };
 
-/** @internal */
-export const CreateSubscriberRequestDtoData$inboundSchema: z.ZodType<
-  CreateSubscriberRequestDtoData,
-  z.ZodTypeDef,
-  unknown
-> = z.union([z.string(), z.array(z.string()), z.boolean(), z.number()]);
-
-/** @internal */
-export type CreateSubscriberRequestDtoData$Outbound =
-  | string
-  | Array<string>
-  | boolean
-  | number;
-
-/** @internal */
-export const CreateSubscriberRequestDtoData$outboundSchema: z.ZodType<
-  CreateSubscriberRequestDtoData$Outbound,
-  z.ZodTypeDef,
-  CreateSubscriberRequestDtoData
-> = z.union([z.string(), z.array(z.string()), z.boolean(), z.number()]);
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace CreateSubscriberRequestDtoData$ {
-  /** @deprecated use `CreateSubscriberRequestDtoData$inboundSchema` instead. */
-  export const inboundSchema = CreateSubscriberRequestDtoData$inboundSchema;
-  /** @deprecated use `CreateSubscriberRequestDtoData$outboundSchema` instead. */
-  export const outboundSchema = CreateSubscriberRequestDtoData$outboundSchema;
-  /** @deprecated use `CreateSubscriberRequestDtoData$Outbound` instead. */
-  export type Outbound = CreateSubscriberRequestDtoData$Outbound;
-}
-
-export function createSubscriberRequestDtoDataToJSON(
-  createSubscriberRequestDtoData: CreateSubscriberRequestDtoData,
-): string {
-  return JSON.stringify(
-    CreateSubscriberRequestDtoData$outboundSchema.parse(
-      createSubscriberRequestDtoData,
-    ),
-  );
-}
-
-export function createSubscriberRequestDtoDataFromJSON(
-  jsonString: string,
-): SafeParseResult<CreateSubscriberRequestDtoData, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => CreateSubscriberRequestDtoData$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'CreateSubscriberRequestDtoData' from JSON`,
-  );
-}
-
 /** @internal */
 export const CreateSubscriberRequestDto$inboundSchema: z.ZodType<
   CreateSubscriberRequestDto,
@@ -119,29 +53,27 @@ export const CreateSubscriberRequestDto$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   subscriberId: z.string(),
-  email: z.string().optional(),
-  firstName: z.string().optional(),
-  lastName: z.string().optional(),
-  phone: z.string().optional(),
-  avatar: z.string().optional(),
-  locale: z.string().optional(),
-  data: z.record(
-    z.union([z.string(), z.array(z.string()), z.boolean(), z.number()]),
-  ).optional(),
-  channels: z.array(SubscriberChannelDto$inboundSchema).optional(),
+  firstName: z.nullable(z.string()).optional(),
+  lastName: z.nullable(z.string()).optional(),
+  email: z.nullable(z.string()).optional(),
+  phone: z.nullable(z.string()).optional(),
+  avatar: z.nullable(z.string()).optional(),
+  timezone: z.nullable(z.string()).optional(),
+  locale: z.nullable(z.string()).optional(),
+  data: z.nullable(z.record(z.any())).optional(),
 });
 
 /** @internal */
 export type CreateSubscriberRequestDto$Outbound = {
   subscriberId: string;
-  email?: string | undefined;
-  firstName?: string | undefined;
-  lastName?: string | undefined;
-  phone?: string | undefined;
-  avatar?: string | undefined;
-  locale?: string | undefined;
-  data?: { [k: string]: string | Array<string> | boolean | number } | undefined;
-  channels?: Array<SubscriberChannelDto$Outbound> | undefined;
+  firstName?: string | null | undefined;
+  lastName?: string | null | undefined;
+  email?: string | null | undefined;
+  phone?: string | null | undefined;
+  avatar?: string | null | undefined;
+  timezone?: string | null | undefined;
+  locale?: string | null | undefined;
+  data?: { [k: string]: any } | null | undefined;
 };
 
 /** @internal */
@@ -151,16 +83,14 @@ export const CreateSubscriberRequestDto$outboundSchema: z.ZodType<
   CreateSubscriberRequestDto
 > = z.object({
   subscriberId: z.string(),
-  email: z.string().optional(),
-  firstName: z.string().optional(),
-  lastName: z.string().optional(),
-  phone: z.string().optional(),
-  avatar: z.string().optional(),
-  locale: z.string().optional(),
-  data: z.record(
-    z.union([z.string(), z.array(z.string()), z.boolean(), z.number()]),
-  ).optional(),
-  channels: z.array(SubscriberChannelDto$outboundSchema).optional(),
+  firstName: z.nullable(z.string()).optional(),
+  lastName: z.nullable(z.string()).optional(),
+  email: z.nullable(z.string()).optional(),
+  phone: z.nullable(z.string()).optional(),
+  avatar: z.nullable(z.string()).optional(),
+  timezone: z.nullable(z.string()).optional(),
+  locale: z.nullable(z.string()).optional(),
+  data: z.nullable(z.record(z.any())).optional(),
 });
 
 /**

package/src/models/components/index.ts

@@ -113,5 +113,6 @@ export * from "./updateintegrationrequestdto.js";
 export * from "./updatesubscriberchannelrequestdto.js";
 export * from "./updatesubscriberonlineflagrequestdto.js";
 export * from "./workflowinfodto.js";
+export * from "./workfloworiginenum.js";
 export * from "./workflowpreferencedto.js";
 export * from "./workflowresponse.js";

package/src/models/components/patchsubscriberrequestdto.ts

@@ -13,10 +13,6 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 export type PatchSubscriberRequestDtoData = {};
 
 export type PatchSubscriberRequestDto = {
-  /**
-   * Unique identifier of the subscriber
-   */
-  subscriberId?: string | null | undefined;
   /**
    * First name of the subscriber
    */
@@ -107,7 +103,6 @@ export const PatchSubscriberRequestDto$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  subscriberId: z.nullable(z.string()).optional(),
   firstName: z.nullable(z.string()).optional(),
   lastName: z.nullable(z.string()).optional(),
   email: z.nullable(z.string()).optional(),
@@ -121,7 +116,6 @@ export const PatchSubscriberRequestDto$inboundSchema: z.ZodType<
 
 /** @internal */
 export type PatchSubscriberRequestDto$Outbound = {
-  subscriberId?: string | null | undefined;
   firstName?: string | null | undefined;
   lastName?: string | null | undefined;
   email?: string | null | undefined;
@@ -138,7 +132,6 @@ export const PatchSubscriberRequestDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   PatchSubscriberRequestDto
 > = z.object({
-  subscriberId: z.nullable(z.string()).optional(),
   firstName: z.nullable(z.string()).optional(),
   lastName: z.nullable(z.string()).optional(),
   email: z.nullable(z.string()).optional(),

package/src/models/components/subscriberpayloaddto.ts

@@ -52,6 +52,10 @@ export type SubscriberPayloadDto = {
    * An optional array of subscriber channels.
    */
   channels?: Array<SubscriberChannelDto> | undefined;
+  /**
+   * The timezone of the subscriber.
+   */
+  timezone?: string | undefined;
 };
 
 /** @internal */
@@ -109,6 +113,7 @@ export const SubscriberPayloadDto$inboundSchema: z.ZodType<
     z.union([z.string(), z.array(z.string()), z.boolean(), z.number()]),
   ).optional(),
   channels: z.array(SubscriberChannelDto$inboundSchema).optional(),
+  timezone: z.string().optional(),
 });
 
 /** @internal */
@@ -122,6 +127,7 @@ export type SubscriberPayloadDto$Outbound = {
   locale?: string | undefined;
   data?: { [k: string]: string | Array<string> | boolean | number } | undefined;
   channels?: Array<SubscriberChannelDto$Outbound> | undefined;
+  timezone?: string | undefined;
 };
 
 /** @internal */
@@ -141,6 +147,7 @@ export const SubscriberPayloadDto$outboundSchema: z.ZodType<
     z.union([z.string(), z.array(z.string()), z.boolean(), z.number()]),
   ).optional(),
   channels: z.array(SubscriberChannelDto$outboundSchema).optional(),
+  timezone: z.string().optional(),
 });
 
 /**

package/src/models/components/triggereventresponsedto.ts

@@ -18,6 +18,7 @@ export const Status = {
   NoWorkflowStepsDefined: "no_workflow_steps_defined",
   Processed: "processed",
   NoTenantFound: "no_tenant_found",
+  InvalidRecipients: "invalid_recipients",
 } as const;
 /**
  * Status of the trigger