@novu/api 3.17.1 → 3.18.1

package/src/models/components/agentreplypayloaddto.ts

@@ -0,0 +1,297 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+import {
+  AddReactionPayloadDto,
+  AddReactionPayloadDto$Outbound,
+  AddReactionPayloadDto$outboundSchema,
+} from "./addreactionpayloaddto.js";
+import {
+  CardReplyContentDto,
+  CardReplyContentDto$Outbound,
+  CardReplyContentDto$outboundSchema,
+} from "./cardreplycontentdto.js";
+import {
+  DeleteMessagePayloadDto,
+  DeleteMessagePayloadDto$Outbound,
+  DeleteMessagePayloadDto$outboundSchema,
+} from "./deletemessagepayloaddto.js";
+import {
+  EditPayloadDto,
+  EditPayloadDto$Outbound,
+  EditPayloadDto$outboundSchema,
+} from "./editpayloaddto.js";
+import {
+  MarkdownReplyContentDto,
+  MarkdownReplyContentDto$Outbound,
+  MarkdownReplyContentDto$outboundSchema,
+} from "./markdownreplycontentdto.js";
+import {
+  MetadataClearSignalDto,
+  MetadataClearSignalDto$Outbound,
+  MetadataClearSignalDto$outboundSchema,
+} from "./metadataclearsignaldto.js";
+import {
+  MetadataDeleteSignalDto,
+  MetadataDeleteSignalDto$Outbound,
+  MetadataDeleteSignalDto$outboundSchema,
+} from "./metadatadeletesignaldto.js";
+import {
+  MetadataSetSignalDto,
+  MetadataSetSignalDto$Outbound,
+  MetadataSetSignalDto$outboundSchema,
+} from "./metadatasetsignaldto.js";
+import {
+  ResolveDto,
+  ResolveDto$Outbound,
+  ResolveDto$outboundSchema,
+} from "./resolvedto.js";
+import {
+  ToolApprovalCardReplyContentDto,
+  ToolApprovalCardReplyContentDto$Outbound,
+  ToolApprovalCardReplyContentDto$outboundSchema,
+} from "./toolapprovalcardreplycontentdto.js";
+import {
+  ToolApprovalRequestPayloadDto,
+  ToolApprovalRequestPayloadDto$Outbound,
+  ToolApprovalRequestPayloadDto$outboundSchema,
+} from "./toolapprovalrequestpayloaddto.js";
+import {
+  ToolResultDto,
+  ToolResultDto$Outbound,
+  ToolResultDto$outboundSchema,
+} from "./toolresultdto.js";
+import {
+  TriggerSignalDto,
+  TriggerSignalDto$Outbound,
+  TriggerSignalDto$outboundSchema,
+} from "./triggersignaldto.js";
+import {
+  TypingStatusDto,
+  TypingStatusDto$Outbound,
+  TypingStatusDto$outboundSchema,
+} from "./typingstatusdto.js";
+
+/**
+ * Outbound message content. Exactly one of `markdown`, `card`, or `toolApprovalCard`. Optional `files` attach to the message. Cannot be combined with `edit`.
+ */
+export type Reply =
+  | MarkdownReplyContentDto
+  | CardReplyContentDto
+  | ToolApprovalCardReplyContentDto;
+
+export type Signals =
+  | MetadataSetSignalDto
+  | MetadataDeleteSignalDto
+  | MetadataClearSignalDto
+  | TriggerSignalDto;
+
+/**
+ * Clear the typing indicator.
+ */
+export const Typing1 = {
+  Stop: "stop",
+} as const;
+/**
+ * Clear the typing indicator.
+ */
+export type Typing1 = ClosedEnum<typeof Typing1>;
+
+/**
+ * Per-turn typing/status control. Pass `{ status?: string }` to set/update the status (omit `status` for "Thinking…"), or `"stop"` to clear it. Best-effort per platform.
+ */
+export type Typing = Typing1 | TypingStatusDto;
+
+export type AgentReplyPayloadDto = {
+  /**
+   * Conversation id to reply into. Obtained from the inbound agent event / bridge payload.
+   */
+  conversationId: string;
+  /**
+   * Channel integration identifier linked to the agent for this conversation (e.g. `slack-support`).
+   */
+  integrationIdentifier: string;
+  /**
+   * Outbound message content. Exactly one of `markdown`, `card`, or `toolApprovalCard`. Optional `files` attach to the message. Cannot be combined with `edit`.
+   */
+  reply?:
+    | MarkdownReplyContentDto
+    | CardReplyContentDto
+    | ToolApprovalCardReplyContentDto
+    | undefined;
+  /**
+   * Tool-lifecycle ledger row for a gated tool call. Pair with `reply.toolApprovalCard` (or another reply shape) to deliver the approval UI.
+   */
+  toolApprovalRequest?: ToolApprovalRequestPayloadDto | undefined;
+  /**
+   * In-place edit of a previously posted agent message. Cannot be combined with reply, resolve, signals, toolResults, toolApprovalRequest, addReactions, or deleteMessages.
+   */
+  edit?: EditPayloadDto | undefined;
+  /**
+   * Mark the conversation resolved. May be combined with a final `reply`.
+   */
+  resolve?: ResolveDto | undefined;
+  /**
+   * Side-effect signals executed during this turn: conversation metadata mutations or Novu workflow triggers.
+   */
+  signals?:
+    | Array<
+      | MetadataSetSignalDto
+      | MetadataDeleteSignalDto
+      | MetadataClearSignalDto
+      | TriggerSignalDto
+    >
+    | undefined;
+  /**
+   * Tool-call outcomes to persist in conversation history (typically before the assistant reply).
+   */
+  toolResults?: Array<ToolResultDto> | undefined;
+  /**
+   * Emoji reactions to add to existing platform messages.
+   */
+  addReactions?: Array<AddReactionPayloadDto> | undefined;
+  /**
+   * Delete previously posted platform messages. Removes the rendered message only — history is preserved.
+   */
+  deleteMessages?: Array<DeleteMessagePayloadDto> | undefined;
+  /**
+   * Per-turn typing/status control. Pass `{ status?: string }` to set/update the status (omit `status` for "Thinking…"), or `"stop"` to clear it. Best-effort per platform.
+   */
+  typing?: Typing1 | TypingStatusDto | undefined;
+  /**
+   * Bridge reports that the customer runtime failed this turn. Cannot be combined with other actions. Novu delivers generic user-facing error copy.
+   */
+  error?: boolean | undefined;
+};
+
+/** @internal */
+export type Reply$Outbound =
+  | MarkdownReplyContentDto$Outbound
+  | CardReplyContentDto$Outbound
+  | ToolApprovalCardReplyContentDto$Outbound;
+
+/** @internal */
+export const Reply$outboundSchema: z.ZodType<
+  Reply$Outbound,
+  z.ZodTypeDef,
+  Reply
+> = z.union([
+  MarkdownReplyContentDto$outboundSchema,
+  CardReplyContentDto$outboundSchema,
+  ToolApprovalCardReplyContentDto$outboundSchema,
+]);
+
+export function replyToJSON(reply: Reply): string {
+  return JSON.stringify(Reply$outboundSchema.parse(reply));
+}
+
+/** @internal */
+export type Signals$Outbound =
+  | MetadataSetSignalDto$Outbound
+  | MetadataDeleteSignalDto$Outbound
+  | MetadataClearSignalDto$Outbound
+  | TriggerSignalDto$Outbound;
+
+/** @internal */
+export const Signals$outboundSchema: z.ZodType<
+  Signals$Outbound,
+  z.ZodTypeDef,
+  Signals
+> = z.union([
+  MetadataSetSignalDto$outboundSchema,
+  MetadataDeleteSignalDto$outboundSchema,
+  MetadataClearSignalDto$outboundSchema,
+  TriggerSignalDto$outboundSchema,
+]);
+
+export function signalsToJSON(signals: Signals): string {
+  return JSON.stringify(Signals$outboundSchema.parse(signals));
+}
+
+/** @internal */
+export const Typing1$outboundSchema: z.ZodNativeEnum<typeof Typing1> = z
+  .nativeEnum(Typing1);
+
+/** @internal */
+export type Typing$Outbound = string | TypingStatusDto$Outbound;
+
+/** @internal */
+export const Typing$outboundSchema: z.ZodType<
+  Typing$Outbound,
+  z.ZodTypeDef,
+  Typing
+> = z.union([Typing1$outboundSchema, TypingStatusDto$outboundSchema]);
+
+export function typingToJSON(typing: Typing): string {
+  return JSON.stringify(Typing$outboundSchema.parse(typing));
+}
+
+/** @internal */
+export type AgentReplyPayloadDto$Outbound = {
+  conversationId: string;
+  integrationIdentifier: string;
+  reply?:
+    | MarkdownReplyContentDto$Outbound
+    | CardReplyContentDto$Outbound
+    | ToolApprovalCardReplyContentDto$Outbound
+    | undefined;
+  toolApprovalRequest?: ToolApprovalRequestPayloadDto$Outbound | undefined;
+  edit?: EditPayloadDto$Outbound | undefined;
+  resolve?: ResolveDto$Outbound | undefined;
+  signals?:
+    | Array<
+      | MetadataSetSignalDto$Outbound
+      | MetadataDeleteSignalDto$Outbound
+      | MetadataClearSignalDto$Outbound
+      | TriggerSignalDto$Outbound
+    >
+    | undefined;
+  toolResults?: Array<ToolResultDto$Outbound> | undefined;
+  addReactions?: Array<AddReactionPayloadDto$Outbound> | undefined;
+  deleteMessages?: Array<DeleteMessagePayloadDto$Outbound> | undefined;
+  typing?: string | TypingStatusDto$Outbound | undefined;
+  error?: boolean | undefined;
+};
+
+/** @internal */
+export const AgentReplyPayloadDto$outboundSchema: z.ZodType<
+  AgentReplyPayloadDto$Outbound,
+  z.ZodTypeDef,
+  AgentReplyPayloadDto
+> = z.object({
+  conversationId: z.string(),
+  integrationIdentifier: z.string(),
+  reply: z.union([
+    MarkdownReplyContentDto$outboundSchema,
+    CardReplyContentDto$outboundSchema,
+    ToolApprovalCardReplyContentDto$outboundSchema,
+  ]).optional(),
+  toolApprovalRequest: ToolApprovalRequestPayloadDto$outboundSchema.optional(),
+  edit: EditPayloadDto$outboundSchema.optional(),
+  resolve: ResolveDto$outboundSchema.optional(),
+  signals: z.array(
+    z.union([
+      MetadataSetSignalDto$outboundSchema,
+      MetadataDeleteSignalDto$outboundSchema,
+      MetadataClearSignalDto$outboundSchema,
+      TriggerSignalDto$outboundSchema,
+    ]),
+  ).optional(),
+  toolResults: z.array(ToolResultDto$outboundSchema).optional(),
+  addReactions: z.array(AddReactionPayloadDto$outboundSchema).optional(),
+  deleteMessages: z.array(DeleteMessagePayloadDto$outboundSchema).optional(),
+  typing: z.union([Typing1$outboundSchema, TypingStatusDto$outboundSchema])
+    .optional(),
+  error: z.boolean().optional(),
+});
+
+export function agentReplyPayloadDtoToJSON(
+  agentReplyPayloadDto: AgentReplyPayloadDto,
+): string {
+  return JSON.stringify(
+    AgentReplyPayloadDto$outboundSchema.parse(agentReplyPayloadDto),
+  );
+}

package/src/models/components/agentresponsedto.ts

@@ -0,0 +1,146 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AgentBehaviorDto,
+  AgentBehaviorDto$inboundSchema,
+} from "./agentbehaviordto.js";
+import {
+  AgentIntegrationSummaryDto,
+  AgentIntegrationSummaryDto$inboundSchema,
+} from "./agentintegrationsummarydto.js";
+import {
+  ManagedRuntimeResponseDto,
+  ManagedRuntimeResponseDto$inboundSchema,
+} from "./managedruntimeresponsedto.js";
+
+/**
+ * Whether the agent brain is self-hosted (bridge) or managed by a third-party provider
+ */
+export const AgentResponseDtoRuntime = {
+  SelfHosted: "self-hosted",
+  Managed: "managed",
+} as const;
+/**
+ * Whether the agent brain is self-hosted (bridge) or managed by a third-party provider
+ */
+export type AgentResponseDtoRuntime = ClosedEnum<
+  typeof AgentResponseDtoRuntime
+>;
+
+/**
+ * Discovery scope of the agent. Always `public` today; reserved for the upcoming private-agents feature.
+ */
+export const Visibility = {
+  Public: "public",
+  Private: "private",
+} as const;
+/**
+ * Discovery scope of the agent. Always `public` today; reserved for the upcoming private-agents feature.
+ */
+export type Visibility = ClosedEnum<typeof Visibility>;
+
+export type AgentResponseDto = {
+  id: string;
+  name: string;
+  identifier: string;
+  description?: string | undefined;
+  behavior?: AgentBehaviorDto | undefined;
+  active: boolean;
+  /**
+   * Production bridge URL
+   */
+  bridgeUrl?: string | undefined;
+  /**
+   * Development bridge URL (set by npx novu dev)
+   */
+  devBridgeUrl?: string | undefined;
+  /**
+   * Whether the dev bridge override is active
+   */
+  devBridgeActive?: boolean | undefined;
+  /**
+   * Whether the agent brain is self-hosted (bridge) or managed by a third-party provider
+   */
+  runtime?: AgentResponseDtoRuntime | undefined;
+  /**
+   * Discovery scope of the agent. Always `public` today; reserved for the upcoming private-agents feature.
+   */
+  visibility?: Visibility | undefined;
+  /**
+   * Present when runtime is "managed". Contains provider and external identifiers.
+   */
+  managedRuntime?: ManagedRuntimeResponseDto | undefined;
+  environmentId: string;
+  organizationId: string;
+  /**
+   * Mongo user id of the user who created the agent
+   */
+  createdBy?: string | undefined;
+  createdAt: string;
+  updatedAt: string;
+  integrations?: Array<AgentIntegrationSummaryDto> | undefined;
+  /**
+   * Cloud only. `true` when the agent falls outside the organization plan agent limit (by creation order among active agents — inactive agents do not consume slots). Only plan limits produce this flag — system-capped organizations (enterprise/unlimited tiers) are never over-limit. Over-limit agents are still stored but will not respond to inbound messages until the plan is upgraded or older agents are deactivated.
+   */
+  exceedsPlanLimit?: boolean | undefined;
+};
+
+/** @internal */
+export const AgentResponseDtoRuntime$inboundSchema: z.ZodNativeEnum<
+  typeof AgentResponseDtoRuntime
+> = z.nativeEnum(AgentResponseDtoRuntime);
+
+/** @internal */
+export const Visibility$inboundSchema: z.ZodNativeEnum<typeof Visibility> = z
+  .nativeEnum(Visibility);
+
+/** @internal */
+export const AgentResponseDto$inboundSchema: z.ZodType<
+  AgentResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  name: z.string(),
+  identifier: z.string(),
+  description: z.string().optional(),
+  behavior: AgentBehaviorDto$inboundSchema.optional(),
+  active: z.boolean(),
+  bridgeUrl: z.string().optional(),
+  devBridgeUrl: z.string().optional(),
+  devBridgeActive: z.boolean().optional(),
+  runtime: AgentResponseDtoRuntime$inboundSchema.optional(),
+  visibility: Visibility$inboundSchema.optional(),
+  managedRuntime: ManagedRuntimeResponseDto$inboundSchema.optional(),
+  _environmentId: z.string(),
+  _organizationId: z.string(),
+  createdBy: z.string().optional(),
+  createdAt: z.string(),
+  updatedAt: z.string(),
+  integrations: z.array(AgentIntegrationSummaryDto$inboundSchema).optional(),
+  exceedsPlanLimit: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "_environmentId": "environmentId",
+    "_organizationId": "organizationId",
+  });
+});
+
+export function agentResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<AgentResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AgentResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AgentResponseDto' from JSON`,
+  );
+}

package/src/models/components/agentskillinputdto.ts

@@ -0,0 +1,74 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const AgentSkillInputDtoType = {
+  Anthropic: "anthropic",
+  Custom: "custom",
+} as const;
+export type AgentSkillInputDtoType = ClosedEnum<typeof AgentSkillInputDtoType>;
+
+/**
+ * Version to pin. Omit for latest.
+ */
+export type Version = {};
+
+export type AgentSkillInputDto = {
+  type: AgentSkillInputDtoType;
+  /**
+   * Skill identifier, e.g. "xlsx" or "skill_01XJ5..."
+   */
+  skillId: string;
+  /**
+   * Version to pin. Omit for latest.
+   */
+  version?: Version | null | undefined;
+};
+
+/** @internal */
+export const AgentSkillInputDtoType$outboundSchema: z.ZodNativeEnum<
+  typeof AgentSkillInputDtoType
+> = z.nativeEnum(AgentSkillInputDtoType);
+
+/** @internal */
+export type Version$Outbound = {};
+
+/** @internal */
+export const Version$outboundSchema: z.ZodType<
+  Version$Outbound,
+  z.ZodTypeDef,
+  Version
+> = z.object({});
+
+export function versionToJSON(version: Version): string {
+  return JSON.stringify(Version$outboundSchema.parse(version));
+}
+
+/** @internal */
+export type AgentSkillInputDto$Outbound = {
+  type: string;
+  skillId: string;
+  version?: Version$Outbound | null | undefined;
+};
+
+/** @internal */
+export const AgentSkillInputDto$outboundSchema: z.ZodType<
+  AgentSkillInputDto$Outbound,
+  z.ZodTypeDef,
+  AgentSkillInputDto
+> = z.object({
+  type: AgentSkillInputDtoType$outboundSchema,
+  skillId: z.string(),
+  version: z.nullable(z.lazy(() => Version$outboundSchema)).optional(),
+});
+
+export function agentSkillInputDtoToJSON(
+  agentSkillInputDto: AgentSkillInputDto,
+): string {
+  return JSON.stringify(
+    AgentSkillInputDto$outboundSchema.parse(agentSkillInputDto),
+  );
+}

package/src/models/components/agenttooldto.ts

@@ -0,0 +1,49 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export const AgentToolDtoType = {
+  Builtin: "builtin",
+  Custom: "custom",
+} as const;
+export type AgentToolDtoType = ClosedEnum<typeof AgentToolDtoType>;
+
+export type AgentToolDto = {
+  externalId: string;
+  name: string;
+  type: AgentToolDtoType;
+  description?: string | undefined;
+};
+
+/** @internal */
+export const AgentToolDtoType$inboundSchema: z.ZodNativeEnum<
+  typeof AgentToolDtoType
+> = z.nativeEnum(AgentToolDtoType);
+
+/** @internal */
+export const AgentToolDto$inboundSchema: z.ZodType<
+  AgentToolDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  externalId: z.string(),
+  name: z.string(),
+  type: AgentToolDtoType$inboundSchema,
+  description: z.string().optional(),
+});
+
+export function agentToolDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<AgentToolDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AgentToolDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AgentToolDto' from JSON`,
+  );
+}

package/src/models/components/authdto.ts

@@ -9,16 +9,25 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type AuthDto = {
   accessToken: string;
+  refreshToken?: string | undefined;
+  expiresAt?: string | undefined;
+  refreshTokenExpiresAt?: string | undefined;
 };
 
 /** @internal */
 export const AuthDto$inboundSchema: z.ZodType<AuthDto, z.ZodTypeDef, unknown> =
   z.object({
     accessToken: z.string(),
+    refreshToken: z.string().optional(),
+    expiresAt: z.string().optional(),
+    refreshTokenExpiresAt: z.string().optional(),
   });
 /** @internal */
 export type AuthDto$Outbound = {
   accessToken: string;
+  refreshToken?: string | undefined;
+  expiresAt?: string | undefined;
+  refreshTokenExpiresAt?: string | undefined;
 };
 
 /** @internal */
@@ -28,6 +37,9 @@ export const AuthDto$outboundSchema: z.ZodType<
   AuthDto
 > = z.object({
   accessToken: z.string(),
+  refreshToken: z.string().optional(),
+  expiresAt: z.string().optional(),
+  refreshTokenExpiresAt: z.string().optional(),
 });
 
 export function authDtoToJSON(authDto: AuthDto): string {

package/src/models/components/cardreplycontentdto.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 CardReplyContentDto = {
+  /**
+   * Interactive card as a Chat SDK element tree (`type: "card"`). Prefer building with `@novu/framework` Card helpers when using TypeScript.
+   */
+  card: { [k: string]: any };
+  /**
+   * Optional attachments (max 15). Supported alongside cards on platforms that allow it (e.g. WhatsApp).
+   */
+  files?: Array<FileRefDto> | undefined;
+};
+
+/** @internal */
+export type CardReplyContentDto$Outbound = {
+  card: { [k: string]: any };
+  files?: Array<FileRefDto$Outbound> | undefined;
+};
+
+/** @internal */
+export const CardReplyContentDto$outboundSchema: z.ZodType<
+  CardReplyContentDto$Outbound,
+  z.ZodTypeDef,
+  CardReplyContentDto
+> = z.object({
+  card: z.record(z.any()),
+  files: z.array(FileRefDto$outboundSchema).optional(),
+});
+
+export function cardReplyContentDtoToJSON(
+  cardReplyContentDto: CardReplyContentDto,
+): string {
+  return JSON.stringify(
+    CardReplyContentDto$outboundSchema.parse(cardReplyContentDto),
+  );
+}

package/src/models/components/chatorpushproviderenum.ts

@@ -12,6 +12,7 @@ export const ChatOrPushProviderEnum = {
   Slack: "slack",
   Discord: "discord",
   Msteams: "msteams",
+  WebexMessaging: "webex-messaging",
   Mattermost: "mattermost",
   Ryver: "ryver",
   Zulip: "zulip",
@@ -19,9 +20,11 @@ export const ChatOrPushProviderEnum = {
   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",