@novu/api 3.17.1 → 3.18.1

package/src/models/components/managedruntimedto.ts

@@ -0,0 +1,81 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+import {
+  AgentSkillInputDto,
+  AgentSkillInputDto$Outbound,
+  AgentSkillInputDto$outboundSchema,
+} from "./agentskillinputdto.js";
+
+export const ProviderId = {
+  Anthropic: "anthropic",
+  NovuAnthropic: "novu-anthropic",
+  AnthropicAws: "anthropic-aws",
+} as const;
+export type ProviderId = ClosedEnum<typeof ProviderId>;
+
+export type ManagedRuntimeDto = {
+  providerId: ProviderId;
+  /**
+   * ID of an existing Novu integration (kind: "agent") that holds the provider API key and provisioned environment. Create the integration first via POST /integrations.
+   */
+  integrationId: string;
+  /**
+   * ID of an existing agent on the provider platform. When set, Novu adopts the agent instead of creating a new one.
+   */
+  externalAgentId?: string | undefined;
+  /**
+   * ID of an existing environment on the provider platform. When set, Novu adopts the environment.
+   */
+  externalEnvironmentId?: string | undefined;
+  model?: string | undefined;
+  systemPrompt?: string | undefined;
+  tools?: Array<string> | undefined;
+  mcpServers?: Array<string> | undefined;
+  skills?: Array<AgentSkillInputDto> | undefined;
+};
+
+/** @internal */
+export const ProviderId$outboundSchema: z.ZodNativeEnum<typeof ProviderId> = z
+  .nativeEnum(ProviderId);
+
+/** @internal */
+export type ManagedRuntimeDto$Outbound = {
+  providerId: string;
+  integrationId: string;
+  externalAgentId?: string | undefined;
+  externalEnvironmentId?: string | undefined;
+  model?: string | undefined;
+  systemPrompt?: string | undefined;
+  tools?: Array<string> | undefined;
+  mcpServers?: Array<string> | undefined;
+  skills?: Array<AgentSkillInputDto$Outbound> | undefined;
+};
+
+/** @internal */
+export const ManagedRuntimeDto$outboundSchema: z.ZodType<
+  ManagedRuntimeDto$Outbound,
+  z.ZodTypeDef,
+  ManagedRuntimeDto
+> = z.object({
+  providerId: ProviderId$outboundSchema,
+  integrationId: z.string(),
+  externalAgentId: z.string().optional(),
+  externalEnvironmentId: z.string().optional(),
+  model: z.string().optional(),
+  systemPrompt: z.string().optional(),
+  tools: z.array(z.string()).optional(),
+  mcpServers: z.array(z.string()).optional(),
+  skills: z.array(AgentSkillInputDto$outboundSchema).optional(),
+});
+
+export function managedRuntimeDtoToJSON(
+  managedRuntimeDto: ManagedRuntimeDto,
+): string {
+  return JSON.stringify(
+    ManagedRuntimeDto$outboundSchema.parse(managedRuntimeDto),
+  );
+}

package/src/models/components/managedruntimeresponsedto.ts

@@ -0,0 +1,70 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AgentMcpServerDto,
+  AgentMcpServerDto$inboundSchema,
+} from "./agentmcpserverdto.js";
+import { AgentToolDto, AgentToolDto$inboundSchema } from "./agenttooldto.js";
+
+export type ManagedRuntimeResponseDto = {
+  providerId: string;
+  integrationId: string;
+  externalAgentId: string;
+  /**
+   * The provider-side environment that hosts this agent. Hydrated from the linked integration credentials. Absent when the integration has not been provisioned.
+   */
+  externalEnvironmentId?: string | undefined;
+  /**
+   * The provider-side workspace id used in console deep links. Defaults to `'default'` (the auto-created Default Workspace). Hydrated from the linked integration credentials.
+   */
+  externalWorkspaceId?: string | undefined;
+  /**
+   * Deep link to the agent in the provider console (e.g. platform.claude.com).
+   */
+  consoleUrl?: string | undefined;
+  /**
+   * Live tools enabled on the managed-runtime provider for this agent. Sourced from the provider on read; omitted when the provider is temporarily unreachable.
+   */
+  tools?: Array<AgentToolDto> | undefined;
+  /**
+   * MCP servers enabled on this agent, projected onto the runtime catalog `{ externalId, name, url }` shape. Mongo is the source of truth; the projection matches what the provider sees. Omitted when the provider read fails after a managed-agent write.
+   */
+  mcpServers?: Array<AgentMcpServerDto> | undefined;
+  /**
+   * System prompt used when invoking the agent.
+   */
+  systemPrompt?: string | undefined;
+};
+
+/** @internal */
+export const ManagedRuntimeResponseDto$inboundSchema: z.ZodType<
+  ManagedRuntimeResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  providerId: z.string(),
+  integrationId: z.string(),
+  externalAgentId: z.string(),
+  externalEnvironmentId: z.string().optional(),
+  externalWorkspaceId: z.string().optional(),
+  consoleUrl: z.string().optional(),
+  tools: z.array(AgentToolDto$inboundSchema).optional(),
+  mcpServers: z.array(AgentMcpServerDto$inboundSchema).optional(),
+  systemPrompt: z.string().optional(),
+});
+
+export function managedRuntimeResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ManagedRuntimeResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ManagedRuntimeResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ManagedRuntimeResponseDto' from JSON`,
+  );
+}

package/src/models/components/markdownreplycontentdto.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  FileRefDto,
+  FileRefDto$Outbound,
+  FileRefDto$outboundSchema,
+} from "./filerefdto.js";
+
+export type MarkdownReplyContentDto = {
+  /**
+   * Plain text or markdown body. Converted to the platform-native format by Novu.
+   */
+  markdown: string;
+  /**
+   * Optional attachments (max 15). Each file needs exactly one of data or url.
+   */
+  files?: Array<FileRefDto> | undefined;
+};
+
+/** @internal */
+export type MarkdownReplyContentDto$Outbound = {
+  markdown: string;
+  files?: Array<FileRefDto$Outbound> | undefined;
+};
+
+/** @internal */
+export const MarkdownReplyContentDto$outboundSchema: z.ZodType<
+  MarkdownReplyContentDto$Outbound,
+  z.ZodTypeDef,
+  MarkdownReplyContentDto
+> = z.object({
+  markdown: z.string(),
+  files: z.array(FileRefDto$outboundSchema).optional(),
+});
+
+export function markdownReplyContentDtoToJSON(
+  markdownReplyContentDto: MarkdownReplyContentDto,
+): string {
+  return JSON.stringify(
+    MarkdownReplyContentDto$outboundSchema.parse(markdownReplyContentDto),
+  );
+}

package/src/models/components/messageresponsedto.ts

@@ -29,7 +29,7 @@ import {
 /**
  * Content of the message, can be an email block or a string
  */
-export type Content = Array<EmailBlock> | string;
+export type MessageResponseDtoContent = Array<EmailBlock> | string;
 
 export type MessageResponseDto = {
   /**
@@ -175,16 +175,19 @@ export type MessageResponseDto = {
 };
 
 /** @internal */
-export const Content$inboundSchema: z.ZodType<Content, z.ZodTypeDef, unknown> =
-  z.union([z.array(EmailBlock$inboundSchema), z.string()]);
+export const MessageResponseDtoContent$inboundSchema: z.ZodType<
+  MessageResponseDtoContent,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.array(EmailBlock$inboundSchema), z.string()]);
 
-export function contentFromJSON(
+export function messageResponseDtoContentFromJSON(
   jsonString: string,
-): SafeParseResult<Content, SDKValidationError> {
+): SafeParseResult<MessageResponseDtoContent, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Content$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Content' from JSON`,
+    (x) => MessageResponseDtoContent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MessageResponseDtoContent' from JSON`,
   );
 }
 

package/src/models/components/metadataclearsignaldto.ts

@@ -0,0 +1,59 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const MetadataClearSignalDtoType = {
+  Metadata: "metadata",
+} as const;
+export type MetadataClearSignalDtoType = ClosedEnum<
+  typeof MetadataClearSignalDtoType
+>;
+
+export const MetadataClearSignalDtoAction = {
+  Clear: "clear",
+} as const;
+export type MetadataClearSignalDtoAction = ClosedEnum<
+  typeof MetadataClearSignalDtoAction
+>;
+
+export type MetadataClearSignalDto = {
+  type: MetadataClearSignalDtoType;
+  action: MetadataClearSignalDtoAction;
+};
+
+/** @internal */
+export const MetadataClearSignalDtoType$outboundSchema: z.ZodNativeEnum<
+  typeof MetadataClearSignalDtoType
+> = z.nativeEnum(MetadataClearSignalDtoType);
+
+/** @internal */
+export const MetadataClearSignalDtoAction$outboundSchema: z.ZodNativeEnum<
+  typeof MetadataClearSignalDtoAction
+> = z.nativeEnum(MetadataClearSignalDtoAction);
+
+/** @internal */
+export type MetadataClearSignalDto$Outbound = {
+  type: string;
+  action: string;
+};
+
+/** @internal */
+export const MetadataClearSignalDto$outboundSchema: z.ZodType<
+  MetadataClearSignalDto$Outbound,
+  z.ZodTypeDef,
+  MetadataClearSignalDto
+> = z.object({
+  type: MetadataClearSignalDtoType$outboundSchema,
+  action: MetadataClearSignalDtoAction$outboundSchema,
+});
+
+export function metadataClearSignalDtoToJSON(
+  metadataClearSignalDto: MetadataClearSignalDto,
+): string {
+  return JSON.stringify(
+    MetadataClearSignalDto$outboundSchema.parse(metadataClearSignalDto),
+  );
+}

package/src/models/components/metadatadeletesignaldto.ts

@@ -0,0 +1,65 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const MetadataDeleteSignalDtoType = {
+  Metadata: "metadata",
+} as const;
+export type MetadataDeleteSignalDtoType = ClosedEnum<
+  typeof MetadataDeleteSignalDtoType
+>;
+
+export const MetadataDeleteSignalDtoAction = {
+  Delete: "delete",
+} as const;
+export type MetadataDeleteSignalDtoAction = ClosedEnum<
+  typeof MetadataDeleteSignalDtoAction
+>;
+
+export type MetadataDeleteSignalDto = {
+  type: MetadataDeleteSignalDtoType;
+  action: MetadataDeleteSignalDtoAction;
+  /**
+   * Metadata key to remove.
+   */
+  key: string;
+};
+
+/** @internal */
+export const MetadataDeleteSignalDtoType$outboundSchema: z.ZodNativeEnum<
+  typeof MetadataDeleteSignalDtoType
+> = z.nativeEnum(MetadataDeleteSignalDtoType);
+
+/** @internal */
+export const MetadataDeleteSignalDtoAction$outboundSchema: z.ZodNativeEnum<
+  typeof MetadataDeleteSignalDtoAction
+> = z.nativeEnum(MetadataDeleteSignalDtoAction);
+
+/** @internal */
+export type MetadataDeleteSignalDto$Outbound = {
+  type: string;
+  action: string;
+  key: string;
+};
+
+/** @internal */
+export const MetadataDeleteSignalDto$outboundSchema: z.ZodType<
+  MetadataDeleteSignalDto$Outbound,
+  z.ZodTypeDef,
+  MetadataDeleteSignalDto
+> = z.object({
+  type: MetadataDeleteSignalDtoType$outboundSchema,
+  action: MetadataDeleteSignalDtoAction$outboundSchema,
+  key: z.string(),
+});
+
+export function metadataDeleteSignalDtoToJSON(
+  metadataDeleteSignalDto: MetadataDeleteSignalDto,
+): string {
+  return JSON.stringify(
+    MetadataDeleteSignalDto$outboundSchema.parse(metadataDeleteSignalDto),
+  );
+}

package/src/models/components/metadatasetsignaldto.ts

@@ -0,0 +1,100 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const MetadataSetSignalDtoType = {
+  Metadata: "metadata",
+} as const;
+export type MetadataSetSignalDtoType = ClosedEnum<
+  typeof MetadataSetSignalDtoType
+>;
+
+/**
+ * Defaults to `set` when omitted.
+ */
+export const Action = {
+  Set: "set",
+} as const;
+/**
+ * Defaults to `set` when omitted.
+ */
+export type Action = ClosedEnum<typeof Action>;
+
+/**
+ * JSON-serializable value to store.
+ */
+export type MetadataSetSignalDtoValue = {};
+
+export type MetadataSetSignalDto = {
+  type: MetadataSetSignalDtoType;
+  /**
+   * Defaults to `set` when omitted.
+   */
+  action?: Action | undefined;
+  /**
+   * Metadata key (1–128 chars; letters, digits, and `-` `_` `:` separators).
+   */
+  key: string;
+  /**
+   * JSON-serializable value to store.
+   */
+  value: MetadataSetSignalDtoValue;
+};
+
+/** @internal */
+export const MetadataSetSignalDtoType$outboundSchema: z.ZodNativeEnum<
+  typeof MetadataSetSignalDtoType
+> = z.nativeEnum(MetadataSetSignalDtoType);
+
+/** @internal */
+export const Action$outboundSchema: z.ZodNativeEnum<typeof Action> = z
+  .nativeEnum(Action);
+
+/** @internal */
+export type MetadataSetSignalDtoValue$Outbound = {};
+
+/** @internal */
+export const MetadataSetSignalDtoValue$outboundSchema: z.ZodType<
+  MetadataSetSignalDtoValue$Outbound,
+  z.ZodTypeDef,
+  MetadataSetSignalDtoValue
+> = z.object({});
+
+export function metadataSetSignalDtoValueToJSON(
+  metadataSetSignalDtoValue: MetadataSetSignalDtoValue,
+): string {
+  return JSON.stringify(
+    MetadataSetSignalDtoValue$outboundSchema.parse(metadataSetSignalDtoValue),
+  );
+}
+
+/** @internal */
+export type MetadataSetSignalDto$Outbound = {
+  type: string;
+  action: string;
+  key: string;
+  value: MetadataSetSignalDtoValue$Outbound;
+};
+
+/** @internal */
+export const MetadataSetSignalDto$outboundSchema: z.ZodType<
+  MetadataSetSignalDto$Outbound,
+  z.ZodTypeDef,
+  MetadataSetSignalDto
+> = z.object({
+  type: MetadataSetSignalDtoType$outboundSchema,
+  action: Action$outboundSchema.default("set"),
+  key: z.string(),
+  value: z.lazy(() => MetadataSetSignalDtoValue$outboundSchema),
+});
+
+export function metadataSetSignalDtoToJSON(
+  metadataSetSignalDto: MetadataSetSignalDto,
+): string {
+  return JSON.stringify(
+    MetadataSetSignalDto$outboundSchema.parse(metadataSetSignalDto),
+  );
+}

package/src/models/components/planusagedto.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type PlanUsageDto = {
+  /**
+   * Current usage count for the resource in this environment.
+   */
+  used: number;
+  /**
+   * Amount included in the organization plan.
+   */
+  limit: number;
+};
+
+/** @internal */
+export const PlanUsageDto$inboundSchema: z.ZodType<
+  PlanUsageDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  used: z.number(),
+  limit: z.number(),
+});
+
+export function planUsageDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanUsageDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlanUsageDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanUsageDto' from JSON`,
+  );
+}

package/src/models/components/providersidenum.ts

@@ -9,6 +9,7 @@ import { ClosedEnum } from "../../types/enums.js";
  * Provider ID of the job
  */
 export const ProvidersIdEnum = {
+  Anypost: "anypost",
   Emailjs: "emailjs",
   Mailgun: "mailgun",
   Mailjet: "mailjet",
@@ -80,6 +81,7 @@ export const ProvidersIdEnum = {
   Slack: "slack",
   Discord: "discord",
   Msteams: "msteams",
+  WebexMessaging: "webex-messaging",
   Mattermost: "mattermost",
   Ryver: "ryver",
   Zulip: "zulip",
@@ -87,9 +89,11 @@ export const ProvidersIdEnum = {
   Getstream: "getstream",
   RocketChat: "rocket-chat",
   WhatsappBusiness: "whatsapp-business",
+  Line: "line",
   ChatWebhook: "chat-webhook",
   NovuSlack: "novu-slack",
   Telegram: "telegram",
+  Sendblue: "sendblue",
   Anthropic: "anthropic",
   NovuAnthropic: "novu-anthropic",
   AnthropicAws: "anthropic-aws",

package/src/models/components/resolvedto.ts

@@ -0,0 +1,30 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type ResolveDto = {
+  /**
+   * Optional human-readable resolution summary stored on the conversation.
+   */
+  summary?: string | undefined;
+};
+
+/** @internal */
+export type ResolveDto$Outbound = {
+  summary?: string | undefined;
+};
+
+/** @internal */
+export const ResolveDto$outboundSchema: z.ZodType<
+  ResolveDto$Outbound,
+  z.ZodTypeDef,
+  ResolveDto
+> = z.object({
+  summary: z.string().optional(),
+});
+
+export function resolveDtoToJSON(resolveDto: ResolveDto): string {
+  return JSON.stringify(ResolveDto$outboundSchema.parse(resolveDto));
+}

package/src/models/components/subscriberchanneldto.ts

@@ -17,6 +17,7 @@ export const SubscriberChannelDtoProviderId = {
   Slack: "slack",
   Discord: "discord",
   Msteams: "msteams",
+  WebexMessaging: "webex-messaging",
   Mattermost: "mattermost",
   Ryver: "ryver",
   Zulip: "zulip",
@@ -24,9 +25,11 @@ export const SubscriberChannelDtoProviderId = {
   Getstream: "getstream",
   RocketChat: "rocket-chat",
   WhatsappBusiness: "whatsapp-business",
+  Line: "line",
   ChatWebhook: "chat-webhook",
   NovuSlack: "novu-slack",
   Telegram: "telegram",
+  Sendblue: "sendblue",
   Fcm: "fcm",
   Apns: "apns",
   Expo: "expo",

package/src/models/components/subscriptionpreferencedto.ts

@@ -64,7 +64,7 @@ export type SubscriptionPreferenceDto = {
    */
   enabled: boolean;
   /**
-   * Optional condition using JSON Logic rules
+   * Optional JSON Logic condition evaluated against the trigger payload at fan-out time (for example, `{ "var": "payload.tier" }`)
    */
   condition?: { [k: string]: any } | undefined;
 };

package/src/models/components/toolapprovalcardreplycontentdto.ts

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  FileRefDto,
+  FileRefDto$Outbound,
+  FileRefDto$outboundSchema,
+} from "./filerefdto.js";
+
+export type ToolApprovalCardReplyContentDto = {
+  /**
+   * Novu tool-approval card descriptor (`type: "tool-approval-card"`). Used with `toolApprovalRequest` to render Approve/Deny UI.
+   */
+  toolApprovalCard: { [k: string]: any };
+  files?: Array<FileRefDto> | undefined;
+};
+
+/** @internal */
+export type ToolApprovalCardReplyContentDto$Outbound = {
+  toolApprovalCard: { [k: string]: any };
+  files?: Array<FileRefDto$Outbound> | undefined;
+};
+
+/** @internal */
+export const ToolApprovalCardReplyContentDto$outboundSchema: z.ZodType<
+  ToolApprovalCardReplyContentDto$Outbound,
+  z.ZodTypeDef,
+  ToolApprovalCardReplyContentDto
+> = z.object({
+  toolApprovalCard: z.record(z.any()),
+  files: z.array(FileRefDto$outboundSchema).optional(),
+});
+
+export function toolApprovalCardReplyContentDtoToJSON(
+  toolApprovalCardReplyContentDto: ToolApprovalCardReplyContentDto,
+): string {
+  return JSON.stringify(
+    ToolApprovalCardReplyContentDto$outboundSchema.parse(
+      toolApprovalCardReplyContentDto,
+    ),
+  );
+}

package/src/models/components/toolapprovalrequestpayloaddto.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type ToolApprovalRequestPayloadDto = {
+  /**
+   * Unique id for this approval request (matches the AI SDK approvalId).
+   */
+  approvalId: string;
+  /**
+   * Id of the tool call awaiting approval.
+   */
+  toolCallId: string;
+  /**
+   * Name of the gated tool.
+   */
+  name: string;
+  /**
+   * Tool input the model proposed.
+   */
+  input?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export type ToolApprovalRequestPayloadDto$Outbound = {
+  approvalId: string;
+  toolCallId: string;
+  name: string;
+  input?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const ToolApprovalRequestPayloadDto$outboundSchema: z.ZodType<
+  ToolApprovalRequestPayloadDto$Outbound,
+  z.ZodTypeDef,
+  ToolApprovalRequestPayloadDto
+> = z.object({
+  approvalId: z.string(),
+  toolCallId: z.string(),
+  name: z.string(),
+  input: z.record(z.any()).optional(),
+});
+
+export function toolApprovalRequestPayloadDtoToJSON(
+  toolApprovalRequestPayloadDto: ToolApprovalRequestPayloadDto,
+): string {
+  return JSON.stringify(
+    ToolApprovalRequestPayloadDto$outboundSchema.parse(
+      toolApprovalRequestPayloadDto,
+    ),
+  );
+}