@novu/api 3.18.0 → 3.18.2

package/src/models/components/toolresultdto.ts

@@ -0,0 +1,67 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * JSON-serializable tool output (or the execution-denied marker).
+ */
+export type Output = {};
+
+export type ToolResultDto = {
+  /**
+   * Id of the tool call this result resolves.
+   */
+  toolCallId: string;
+  /**
+   * Name of the tool that produced this result.
+   */
+  toolName?: string | undefined;
+  /**
+   * JSON-serializable tool output (or the execution-denied marker).
+   */
+  output?: Output | undefined;
+  /**
+   * Human-readable preview for the display timeline.
+   */
+  preview?: string | undefined;
+};
+
+/** @internal */
+export type Output$Outbound = {};
+
+/** @internal */
+export const Output$outboundSchema: z.ZodType<
+  Output$Outbound,
+  z.ZodTypeDef,
+  Output
+> = z.object({});
+
+export function outputToJSON(output: Output): string {
+  return JSON.stringify(Output$outboundSchema.parse(output));
+}
+
+/** @internal */
+export type ToolResultDto$Outbound = {
+  toolCallId: string;
+  toolName?: string | undefined;
+  output?: Output$Outbound | undefined;
+  preview?: string | undefined;
+};
+
+/** @internal */
+export const ToolResultDto$outboundSchema: z.ZodType<
+  ToolResultDto$Outbound,
+  z.ZodTypeDef,
+  ToolResultDto
+> = z.object({
+  toolCallId: z.string(),
+  toolName: z.string().optional(),
+  output: z.lazy(() => Output$outboundSchema).optional(),
+  preview: z.string().optional(),
+});
+
+export function toolResultDtoToJSON(toolResultDto: ToolResultDto): string {
+  return JSON.stringify(ToolResultDto$outboundSchema.parse(toolResultDto));
+}

package/src/models/components/triggereventrequestdto.ts

@@ -101,7 +101,7 @@ export type To1 = TopicPayloadDto | SubscriberPayloadDto | string;
 /**
  * The recipients list of people who will receive the notification. Maximum number of recipients can be 100.
  */
-export type To =
+export type TriggerEventRequestDtoTo =
   | TopicPayloadDto
   | SubscriberPayloadDto
   | Array<TopicPayloadDto | SubscriberPayloadDto | string>
@@ -151,6 +151,10 @@ export type TriggerEventRequestDto = {
    *       This data will also be available when fetching the notifications feed from the API to display certain parts of the UI.
    */
   payload?: { [k: string]: any } | undefined;
+  /**
+   * Optional Bridge Endpoint URL used to route this trigger to a specific Bridge application. Useful during local development when multiple engineers share an organization: set this to your personal tunnel URL from `npx novu@latest dev` (for example via NOVU_BRIDGE_URL) so app-fired triggers hit your machine instead of the environment's synced Bridge URL. Must be a publicly reachable https URL — private or localhost addresses are rejected.
+   */
+  bridgeUrl?: string | undefined;
   /**
    * This could be used to override provider specific configurations
    */
@@ -260,29 +264,36 @@ export function to1ToJSON(to1: To1): string {
 }
 
 /** @internal */
-export type To$Outbound =
+export type TriggerEventRequestDtoTo$Outbound =
   | TopicPayloadDto$Outbound
   | SubscriberPayloadDto$Outbound
   | Array<TopicPayloadDto$Outbound | SubscriberPayloadDto$Outbound | string>
   | string;
 
 /** @internal */
-export const To$outboundSchema: z.ZodType<To$Outbound, z.ZodTypeDef, To> = z
-  .union([
-    TopicPayloadDto$outboundSchema,
-    SubscriberPayloadDto$outboundSchema,
-    z.array(
-      z.union([
-        TopicPayloadDto$outboundSchema,
-        SubscriberPayloadDto$outboundSchema,
-        z.string(),
-      ]),
-    ),
-    z.string(),
-  ]);
+export const TriggerEventRequestDtoTo$outboundSchema: z.ZodType<
+  TriggerEventRequestDtoTo$Outbound,
+  z.ZodTypeDef,
+  TriggerEventRequestDtoTo
+> = z.union([
+  TopicPayloadDto$outboundSchema,
+  SubscriberPayloadDto$outboundSchema,
+  z.array(
+    z.union([
+      TopicPayloadDto$outboundSchema,
+      SubscriberPayloadDto$outboundSchema,
+      z.string(),
+    ]),
+  ),
+  z.string(),
+]);
 
-export function toToJSON(to: To): string {
-  return JSON.stringify(To$outboundSchema.parse(to));
+export function triggerEventRequestDtoToToJSON(
+  triggerEventRequestDtoTo: TriggerEventRequestDtoTo,
+): string {
+  return JSON.stringify(
+    TriggerEventRequestDtoTo$outboundSchema.parse(triggerEventRequestDtoTo),
+  );
 }
 
 /** @internal */
@@ -368,6 +379,7 @@ export function triggerEventRequestDtoContextToJSON(
 export type TriggerEventRequestDto$Outbound = {
   name: string;
   payload?: { [k: string]: any } | undefined;
+  bridgeUrl?: string | undefined;
   overrides?: Overrides$Outbound | undefined;
   to:
     | TopicPayloadDto$Outbound
@@ -390,6 +402,7 @@ export const TriggerEventRequestDto$outboundSchema: z.ZodType<
 > = z.object({
   workflowId: z.string(),
   payload: z.record(z.any()).optional(),
+  bridgeUrl: z.string().optional(),
   overrides: z.lazy(() => Overrides$outboundSchema).optional(),
   to: z.union([
     TopicPayloadDto$outboundSchema,

package/src/models/components/triggersignaldto.ts

@@ -0,0 +1,111 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const TriggerSignalDtoType = {
+  Trigger: "trigger",
+} as const;
+export type TriggerSignalDtoType = ClosedEnum<typeof TriggerSignalDtoType>;
+
+export type To3 = string | { [k: string]: any };
+
+/**
+ * Recipient(s). Accepts a subscriberId string, subscriber object, topic object, or an array of those. When omitted, Novu falls back to the conversation subscriber.
+ */
+export type To =
+  | string
+  | { [k: string]: any }
+  | Array<string | { [k: string]: any }>;
+
+export type TriggerSignalDto = {
+  type: TriggerSignalDtoType;
+  /**
+   * Workflow identifier (same string used with `events.trigger`).
+   */
+  workflowId: string;
+  /**
+   * Recipient(s). Accepts a subscriberId string, subscriber object, topic object, or an array of those. When omitted, Novu falls back to the conversation subscriber.
+   */
+  to?:
+    | string
+    | { [k: string]: any }
+    | Array<string | { [k: string]: any }>
+    | undefined;
+  /**
+   * Arbitrary payload forwarded to the workflow.
+   */
+  payload?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const TriggerSignalDtoType$outboundSchema: z.ZodNativeEnum<
+  typeof TriggerSignalDtoType
+> = z.nativeEnum(TriggerSignalDtoType);
+
+/** @internal */
+export type To3$Outbound = string | { [k: string]: any };
+
+/** @internal */
+export const To3$outboundSchema: z.ZodType<To3$Outbound, z.ZodTypeDef, To3> = z
+  .union([z.string(), z.record(z.any())]);
+
+export function to3ToJSON(to3: To3): string {
+  return JSON.stringify(To3$outboundSchema.parse(to3));
+}
+
+/** @internal */
+export type To$Outbound =
+  | string
+  | { [k: string]: any }
+  | Array<string | { [k: string]: any }>;
+
+/** @internal */
+export const To$outboundSchema: z.ZodType<To$Outbound, z.ZodTypeDef, To> = z
+  .union([
+    z.string(),
+    z.record(z.any()),
+    z.array(z.union([z.string(), z.record(z.any())])),
+  ]);
+
+export function toToJSON(to: To): string {
+  return JSON.stringify(To$outboundSchema.parse(to));
+}
+
+/** @internal */
+export type TriggerSignalDto$Outbound = {
+  type: string;
+  workflowId: string;
+  to?:
+    | string
+    | { [k: string]: any }
+    | Array<string | { [k: string]: any }>
+    | undefined;
+  payload?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const TriggerSignalDto$outboundSchema: z.ZodType<
+  TriggerSignalDto$Outbound,
+  z.ZodTypeDef,
+  TriggerSignalDto
+> = z.object({
+  type: TriggerSignalDtoType$outboundSchema,
+  workflowId: z.string(),
+  to: z.union([
+    z.string(),
+    z.record(z.any()),
+    z.array(z.union([z.string(), z.record(z.any())])),
+  ]).optional(),
+  payload: z.record(z.any()).optional(),
+});
+
+export function triggerSignalDtoToJSON(
+  triggerSignalDto: TriggerSignalDto,
+): string {
+  return JSON.stringify(
+    TriggerSignalDto$outboundSchema.parse(triggerSignalDto),
+  );
+}

package/src/models/components/typingstatusdto.ts

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type TypingStatusDto = {
+  /**
+   * Status text shown while the agent works. Omit for the default "Thinking…".
+   */
+  status?: string | undefined;
+};
+
+/** @internal */
+export type TypingStatusDto$Outbound = {
+  status?: string | undefined;
+};
+
+/** @internal */
+export const TypingStatusDto$outboundSchema: z.ZodType<
+  TypingStatusDto$Outbound,
+  z.ZodTypeDef,
+  TypingStatusDto
+> = z.object({
+  status: z.string().optional(),
+});
+
+export function typingStatusDtoToJSON(
+  typingStatusDto: TypingStatusDto,
+): string {
+  return JSON.stringify(TypingStatusDto$outboundSchema.parse(typingStatusDto));
+}

package/src/models/components/updateagentbridgerequestdto.ts

@@ -0,0 +1,48 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type UpdateAgentBridgeRequestDto = {
+  /**
+   * Production bridge URL for this agent
+   */
+  bridgeUrl?: string | undefined;
+  /**
+   * Development bridge URL (set by npx novu dev)
+   */
+  devBridgeUrl?: string | undefined;
+  /**
+   * Whether the dev bridge override is active
+   */
+  devBridgeActive?: boolean | undefined;
+};
+
+/** @internal */
+export type UpdateAgentBridgeRequestDto$Outbound = {
+  bridgeUrl?: string | undefined;
+  devBridgeUrl?: string | undefined;
+  devBridgeActive?: boolean | undefined;
+};
+
+/** @internal */
+export const UpdateAgentBridgeRequestDto$outboundSchema: z.ZodType<
+  UpdateAgentBridgeRequestDto$Outbound,
+  z.ZodTypeDef,
+  UpdateAgentBridgeRequestDto
+> = z.object({
+  bridgeUrl: z.string().optional(),
+  devBridgeUrl: z.string().optional(),
+  devBridgeActive: z.boolean().optional(),
+});
+
+export function updateAgentBridgeRequestDtoToJSON(
+  updateAgentBridgeRequestDto: UpdateAgentBridgeRequestDto,
+): string {
+  return JSON.stringify(
+    UpdateAgentBridgeRequestDto$outboundSchema.parse(
+      updateAgentBridgeRequestDto,
+    ),
+  );
+}

package/src/models/components/updateagentintegrationrequestdto.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type UpdateAgentIntegrationRequestDto = {
+  /**
+   * The integration identifier this link should point to (not the internal document _id).
+   */
+  integrationIdentifier: string;
+};
+
+/** @internal */
+export type UpdateAgentIntegrationRequestDto$Outbound = {
+  integrationIdentifier: string;
+};
+
+/** @internal */
+export const UpdateAgentIntegrationRequestDto$outboundSchema: z.ZodType<
+  UpdateAgentIntegrationRequestDto$Outbound,
+  z.ZodTypeDef,
+  UpdateAgentIntegrationRequestDto
+> = z.object({
+  integrationIdentifier: z.string(),
+});
+
+export function updateAgentIntegrationRequestDtoToJSON(
+  updateAgentIntegrationRequestDto: UpdateAgentIntegrationRequestDto,
+): string {
+  return JSON.stringify(
+    UpdateAgentIntegrationRequestDto$outboundSchema.parse(
+      updateAgentIntegrationRequestDto,
+    ),
+  );
+}

package/src/models/components/updateagentrequestdto.ts

@@ -0,0 +1,63 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  AgentBehaviorDto,
+  AgentBehaviorDto$Outbound,
+  AgentBehaviorDto$outboundSchema,
+} from "./agentbehaviordto.js";
+
+export type UpdateAgentRequestDto = {
+  name?: string | undefined;
+  description?: string | undefined;
+  active?: boolean | undefined;
+  behavior?: AgentBehaviorDto | undefined;
+  /**
+   * Production bridge URL for this agent
+   */
+  bridgeUrl?: string | undefined;
+  /**
+   * Development bridge URL (set by npx novu dev)
+   */
+  devBridgeUrl?: string | undefined;
+  /**
+   * Whether the dev bridge override is active
+   */
+  devBridgeActive?: boolean | undefined;
+};
+
+/** @internal */
+export type UpdateAgentRequestDto$Outbound = {
+  name?: string | undefined;
+  description?: string | undefined;
+  active?: boolean | undefined;
+  behavior?: AgentBehaviorDto$Outbound | undefined;
+  bridgeUrl?: string | undefined;
+  devBridgeUrl?: string | undefined;
+  devBridgeActive?: boolean | undefined;
+};
+
+/** @internal */
+export const UpdateAgentRequestDto$outboundSchema: z.ZodType<
+  UpdateAgentRequestDto$Outbound,
+  z.ZodTypeDef,
+  UpdateAgentRequestDto
+> = z.object({
+  name: z.string().optional(),
+  description: z.string().optional(),
+  active: z.boolean().optional(),
+  behavior: AgentBehaviorDto$outboundSchema.optional(),
+  bridgeUrl: z.string().optional(),
+  devBridgeUrl: z.string().optional(),
+  devBridgeActive: z.boolean().optional(),
+});
+
+export function updateAgentRequestDtoToJSON(
+  updateAgentRequestDto: UpdateAgentRequestDto,
+): string {
+  return JSON.stringify(
+    UpdateAgentRequestDto$outboundSchema.parse(updateAgentRequestDto),
+  );
+}

package/src/models/components/updatechannelendpointrequestdto.ts

@@ -18,6 +18,16 @@ import {
   SlackUserEndpointDto$Outbound,
   SlackUserEndpointDto$outboundSchema,
 } from "./slackuserendpointdto.js";
+import {
+  WebexPersonEndpointDto,
+  WebexPersonEndpointDto$Outbound,
+  WebexPersonEndpointDto$outboundSchema,
+} from "./webexpersonendpointdto.js";
+import {
+  WebexRoomEndpointDto,
+  WebexRoomEndpointDto$Outbound,
+  WebexRoomEndpointDto$outboundSchema,
+} from "./webexroomendpointdto.js";
 import {
   WebhookEndpointDto,
   WebhookEndpointDto$Outbound,
@@ -31,7 +41,9 @@ export type UpdateChannelEndpointRequestDtoEndpoint =
   | SlackChannelEndpointDto
   | SlackUserEndpointDto
   | WebhookEndpointDto
-  | PhoneEndpointDto;
+  | PhoneEndpointDto
+  | WebexRoomEndpointDto
+  | WebexPersonEndpointDto;
 
 export type UpdateChannelEndpointRequestDto = {
   /**
@@ -41,7 +53,9 @@ export type UpdateChannelEndpointRequestDto = {
     | SlackChannelEndpointDto
     | SlackUserEndpointDto
     | WebhookEndpointDto
-    | PhoneEndpointDto;
+    | PhoneEndpointDto
+    | WebexRoomEndpointDto
+    | WebexPersonEndpointDto;
 };
 
 /** @internal */
@@ -49,7 +63,9 @@ export type UpdateChannelEndpointRequestDtoEndpoint$Outbound =
   | SlackChannelEndpointDto$Outbound
   | SlackUserEndpointDto$Outbound
   | WebhookEndpointDto$Outbound
-  | PhoneEndpointDto$Outbound;
+  | PhoneEndpointDto$Outbound
+  | WebexRoomEndpointDto$Outbound
+  | WebexPersonEndpointDto$Outbound;
 
 /** @internal */
 export const UpdateChannelEndpointRequestDtoEndpoint$outboundSchema: z.ZodType<
@@ -61,6 +77,8 @@ export const UpdateChannelEndpointRequestDtoEndpoint$outboundSchema: z.ZodType<
   SlackUserEndpointDto$outboundSchema,
   WebhookEndpointDto$outboundSchema,
   PhoneEndpointDto$outboundSchema,
+  WebexRoomEndpointDto$outboundSchema,
+  WebexPersonEndpointDto$outboundSchema,
 ]);
 
 export function updateChannelEndpointRequestDtoEndpointToJSON(
@@ -80,7 +98,9 @@ export type UpdateChannelEndpointRequestDto$Outbound = {
     | SlackChannelEndpointDto$Outbound
     | SlackUserEndpointDto$Outbound
     | WebhookEndpointDto$Outbound
-    | PhoneEndpointDto$Outbound;
+    | PhoneEndpointDto$Outbound
+    | WebexRoomEndpointDto$Outbound
+    | WebexPersonEndpointDto$Outbound;
 };
 
 /** @internal */
@@ -94,6 +114,8 @@ export const UpdateChannelEndpointRequestDto$outboundSchema: z.ZodType<
     SlackUserEndpointDto$outboundSchema,
     WebhookEndpointDto$outboundSchema,
     PhoneEndpointDto$outboundSchema,
+    WebexRoomEndpointDto$outboundSchema,
+    WebexPersonEndpointDto$outboundSchema,
   ]),
 });
 

package/src/models/components/webexpersonendpointdto.ts

@@ -0,0 +1,61 @@
+/*
+ * 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 WebexPersonEndpointDto = {
+  /**
+   * Webex person ID. Provide exactly one of personId or personEmail.
+   */
+  personId?: string | undefined;
+  /**
+   * Webex person email. Provide exactly one of personId or personEmail.
+   */
+  personEmail?: string | undefined;
+};
+
+/** @internal */
+export const WebexPersonEndpointDto$inboundSchema: z.ZodType<
+  WebexPersonEndpointDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  personId: z.string().optional(),
+  personEmail: z.string().optional(),
+});
+/** @internal */
+export type WebexPersonEndpointDto$Outbound = {
+  personId?: string | undefined;
+  personEmail?: string | undefined;
+};
+
+/** @internal */
+export const WebexPersonEndpointDto$outboundSchema: z.ZodType<
+  WebexPersonEndpointDto$Outbound,
+  z.ZodTypeDef,
+  WebexPersonEndpointDto
+> = z.object({
+  personId: z.string().optional(),
+  personEmail: z.string().optional(),
+});
+
+export function webexPersonEndpointDtoToJSON(
+  webexPersonEndpointDto: WebexPersonEndpointDto,
+): string {
+  return JSON.stringify(
+    WebexPersonEndpointDto$outboundSchema.parse(webexPersonEndpointDto),
+  );
+}
+export function webexPersonEndpointDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<WebexPersonEndpointDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WebexPersonEndpointDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WebexPersonEndpointDto' from JSON`,
+  );
+}

package/src/models/components/webexroomendpointdto.ts

@@ -0,0 +1,61 @@
+/*
+ * 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 WebexRoomEndpointDto = {
+  /**
+   * Webex room ID
+   */
+  roomId: string;
+  /**
+   * Optional Webex parent message ID for threaded replies
+   */
+  parentId?: string | undefined;
+};
+
+/** @internal */
+export const WebexRoomEndpointDto$inboundSchema: z.ZodType<
+  WebexRoomEndpointDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  roomId: z.string(),
+  parentId: z.string().optional(),
+});
+/** @internal */
+export type WebexRoomEndpointDto$Outbound = {
+  roomId: string;
+  parentId?: string | undefined;
+};
+
+/** @internal */
+export const WebexRoomEndpointDto$outboundSchema: z.ZodType<
+  WebexRoomEndpointDto$Outbound,
+  z.ZodTypeDef,
+  WebexRoomEndpointDto
+> = z.object({
+  roomId: z.string(),
+  parentId: z.string().optional(),
+});
+
+export function webexRoomEndpointDtoToJSON(
+  webexRoomEndpointDto: WebexRoomEndpointDto,
+): string {
+  return JSON.stringify(
+    WebexRoomEndpointDto$outboundSchema.parse(webexRoomEndpointDto),
+  );
+}
+export function webexRoomEndpointDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<WebexRoomEndpointDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WebexRoomEndpointDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WebexRoomEndpointDto' from JSON`,
+  );
+}

package/src/models/components/workflowpreferencerequestdto.ts

@@ -10,7 +10,7 @@ export type WorkflowPreferenceRequestDto = {
    */
   enabled?: boolean | undefined;
   /**
-   * Optional condition using JSON Logic rules
+   * Optional JSON Logic condition evaluated at fan-out time against trigger payload, subscriber profile, actor, and context (for example, `{ "var": "payload.tier" }`, `{ "var": "subscriber.data.plan" }`, or `{ "var": "actor.data.role" }`)
    */
   condition?: { [k: string]: any } | undefined;
   /**