@novu/api 3.17.1 → 3.18.1

package/src/models/components/createagentrequestdto.ts

@@ -0,0 +1,68 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+import {
+  ManagedRuntimeDto,
+  ManagedRuntimeDto$Outbound,
+  ManagedRuntimeDto$outboundSchema,
+} from "./managedruntimedto.js";
+
+export const Runtime = {
+  SelfHosted: "self-hosted",
+  Managed: "managed",
+} as const;
+export type Runtime = ClosedEnum<typeof Runtime>;
+
+export type CreateAgentRequestDto = {
+  /**
+   * Required when not adopting an existing managed agent (i.e. when managedRuntime.externalAgentId is absent). Optional in adopt mode where the name is resolved from the provider.
+   */
+  name: string;
+  /**
+   * Required when not adopting an existing managed agent. Auto-generated from the provider agent name when omitted in adopt mode.
+   */
+  identifier: string;
+  description?: string | undefined;
+  active?: boolean | undefined;
+  runtime?: Runtime | undefined;
+  managedRuntime?: ManagedRuntimeDto | undefined;
+};
+
+/** @internal */
+export const Runtime$outboundSchema: z.ZodNativeEnum<typeof Runtime> = z
+  .nativeEnum(Runtime);
+
+/** @internal */
+export type CreateAgentRequestDto$Outbound = {
+  name: string;
+  identifier: string;
+  description?: string | undefined;
+  active: boolean;
+  runtime?: string | undefined;
+  managedRuntime?: ManagedRuntimeDto$Outbound | undefined;
+};
+
+/** @internal */
+export const CreateAgentRequestDto$outboundSchema: z.ZodType<
+  CreateAgentRequestDto$Outbound,
+  z.ZodTypeDef,
+  CreateAgentRequestDto
+> = z.object({
+  name: z.string(),
+  identifier: z.string(),
+  description: z.string().optional(),
+  active: z.boolean().default(true),
+  runtime: Runtime$outboundSchema.optional(),
+  managedRuntime: ManagedRuntimeDto$outboundSchema.optional(),
+});
+
+export function createAgentRequestDtoToJSON(
+  createAgentRequestDto: CreateAgentRequestDto,
+): string {
+  return JSON.stringify(
+    CreateAgentRequestDto$outboundSchema.parse(createAgentRequestDto),
+  );
+}

package/src/models/components/createlineuserendpointdto.ts

@@ -0,0 +1,147 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  LineUserEndpointDto,
+  LineUserEndpointDto$Outbound,
+  LineUserEndpointDto$outboundSchema,
+} from "./lineuserendpointdto.js";
+
+/**
+ * Rich context object with id and optional data
+ */
+export type CreateLineUserEndpointDtoContext2 = {
+  id: string;
+  /**
+   * Optional additional context data
+   */
+  data?: { [k: string]: any } | undefined;
+};
+
+export type CreateLineUserEndpointDtoContext =
+  | CreateLineUserEndpointDtoContext2
+  | string;
+
+export type CreateLineUserEndpointDto = {
+  /**
+   * The unique identifier for the channel endpoint. If not provided, one will be generated automatically.
+   */
+  identifier?: string | undefined;
+  /**
+   * The subscriber ID to which the channel endpoint is linked
+   */
+  subscriberId: string;
+  context?:
+    | { [k: string]: CreateLineUserEndpointDtoContext2 | string }
+    | undefined;
+  /**
+   * The identifier of the integration to use for this channel endpoint.
+   */
+  integrationIdentifier: string;
+  /**
+   * The identifier of the channel connection to use for this channel endpoint.
+   */
+  connectionIdentifier?: string | undefined;
+  /**
+   * Type of channel endpoint
+   */
+  type: "line_user";
+  /**
+   * LINE user endpoint data
+   */
+  endpoint: LineUserEndpointDto;
+};
+
+/** @internal */
+export type CreateLineUserEndpointDtoContext2$Outbound = {
+  id: string;
+  data?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const CreateLineUserEndpointDtoContext2$outboundSchema: z.ZodType<
+  CreateLineUserEndpointDtoContext2$Outbound,
+  z.ZodTypeDef,
+  CreateLineUserEndpointDtoContext2
+> = z.object({
+  id: z.string(),
+  data: z.record(z.any()).optional(),
+});
+
+export function createLineUserEndpointDtoContext2ToJSON(
+  createLineUserEndpointDtoContext2: CreateLineUserEndpointDtoContext2,
+): string {
+  return JSON.stringify(
+    CreateLineUserEndpointDtoContext2$outboundSchema.parse(
+      createLineUserEndpointDtoContext2,
+    ),
+  );
+}
+
+/** @internal */
+export type CreateLineUserEndpointDtoContext$Outbound =
+  | CreateLineUserEndpointDtoContext2$Outbound
+  | string;
+
+/** @internal */
+export const CreateLineUserEndpointDtoContext$outboundSchema: z.ZodType<
+  CreateLineUserEndpointDtoContext$Outbound,
+  z.ZodTypeDef,
+  CreateLineUserEndpointDtoContext
+> = z.union([
+  z.lazy(() => CreateLineUserEndpointDtoContext2$outboundSchema),
+  z.string(),
+]);
+
+export function createLineUserEndpointDtoContextToJSON(
+  createLineUserEndpointDtoContext: CreateLineUserEndpointDtoContext,
+): string {
+  return JSON.stringify(
+    CreateLineUserEndpointDtoContext$outboundSchema.parse(
+      createLineUserEndpointDtoContext,
+    ),
+  );
+}
+
+/** @internal */
+export type CreateLineUserEndpointDto$Outbound = {
+  identifier?: string | undefined;
+  subscriberId: string;
+  context?:
+    | { [k: string]: CreateLineUserEndpointDtoContext2$Outbound | string }
+    | undefined;
+  integrationIdentifier: string;
+  connectionIdentifier?: string | undefined;
+  type: "line_user";
+  endpoint: LineUserEndpointDto$Outbound;
+};
+
+/** @internal */
+export const CreateLineUserEndpointDto$outboundSchema: z.ZodType<
+  CreateLineUserEndpointDto$Outbound,
+  z.ZodTypeDef,
+  CreateLineUserEndpointDto
+> = z.object({
+  identifier: z.string().optional(),
+  subscriberId: z.string(),
+  context: z.record(
+    z.union([
+      z.lazy(() => CreateLineUserEndpointDtoContext2$outboundSchema),
+      z.string(),
+    ]),
+  ).optional(),
+  integrationIdentifier: z.string(),
+  connectionIdentifier: z.string().optional(),
+  type: z.literal("line_user"),
+  endpoint: LineUserEndpointDto$outboundSchema,
+});
+
+export function createLineUserEndpointDtoToJSON(
+  createLineUserEndpointDto: CreateLineUserEndpointDto,
+): string {
+  return JSON.stringify(
+    CreateLineUserEndpointDto$outboundSchema.parse(createLineUserEndpointDto),
+  );
+}

package/src/models/components/createwebexpersonendpointdto.ts

@@ -0,0 +1,149 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  WebexPersonEndpointDto,
+  WebexPersonEndpointDto$Outbound,
+  WebexPersonEndpointDto$outboundSchema,
+} from "./webexpersonendpointdto.js";
+
+/**
+ * Rich context object with id and optional data
+ */
+export type CreateWebexPersonEndpointDtoContext2 = {
+  id: string;
+  /**
+   * Optional additional context data
+   */
+  data?: { [k: string]: any } | undefined;
+};
+
+export type CreateWebexPersonEndpointDtoContext =
+  | CreateWebexPersonEndpointDtoContext2
+  | string;
+
+export type CreateWebexPersonEndpointDto = {
+  /**
+   * The unique identifier for the channel endpoint. If not provided, one will be generated automatically.
+   */
+  identifier?: string | undefined;
+  /**
+   * The subscriber ID to which the channel endpoint is linked
+   */
+  subscriberId: string;
+  context?:
+    | { [k: string]: CreateWebexPersonEndpointDtoContext2 | string }
+    | undefined;
+  /**
+   * The identifier of the integration to use for this channel endpoint.
+   */
+  integrationIdentifier: string;
+  /**
+   * The identifier of the channel connection to use for this Webex endpoint.
+   */
+  connectionIdentifier?: string | undefined;
+  /**
+   * Type of channel endpoint
+   */
+  type: "webex_person";
+  /**
+   * Webex person endpoint data. Provide exactly one of personId or personEmail.
+   */
+  endpoint: WebexPersonEndpointDto;
+};
+
+/** @internal */
+export type CreateWebexPersonEndpointDtoContext2$Outbound = {
+  id: string;
+  data?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const CreateWebexPersonEndpointDtoContext2$outboundSchema: z.ZodType<
+  CreateWebexPersonEndpointDtoContext2$Outbound,
+  z.ZodTypeDef,
+  CreateWebexPersonEndpointDtoContext2
+> = z.object({
+  id: z.string(),
+  data: z.record(z.any()).optional(),
+});
+
+export function createWebexPersonEndpointDtoContext2ToJSON(
+  createWebexPersonEndpointDtoContext2: CreateWebexPersonEndpointDtoContext2,
+): string {
+  return JSON.stringify(
+    CreateWebexPersonEndpointDtoContext2$outboundSchema.parse(
+      createWebexPersonEndpointDtoContext2,
+    ),
+  );
+}
+
+/** @internal */
+export type CreateWebexPersonEndpointDtoContext$Outbound =
+  | CreateWebexPersonEndpointDtoContext2$Outbound
+  | string;
+
+/** @internal */
+export const CreateWebexPersonEndpointDtoContext$outboundSchema: z.ZodType<
+  CreateWebexPersonEndpointDtoContext$Outbound,
+  z.ZodTypeDef,
+  CreateWebexPersonEndpointDtoContext
+> = z.union([
+  z.lazy(() => CreateWebexPersonEndpointDtoContext2$outboundSchema),
+  z.string(),
+]);
+
+export function createWebexPersonEndpointDtoContextToJSON(
+  createWebexPersonEndpointDtoContext: CreateWebexPersonEndpointDtoContext,
+): string {
+  return JSON.stringify(
+    CreateWebexPersonEndpointDtoContext$outboundSchema.parse(
+      createWebexPersonEndpointDtoContext,
+    ),
+  );
+}
+
+/** @internal */
+export type CreateWebexPersonEndpointDto$Outbound = {
+  identifier?: string | undefined;
+  subscriberId: string;
+  context?: {
+    [k: string]: CreateWebexPersonEndpointDtoContext2$Outbound | string;
+  } | undefined;
+  integrationIdentifier: string;
+  connectionIdentifier?: string | undefined;
+  type: "webex_person";
+  endpoint: WebexPersonEndpointDto$Outbound;
+};
+
+/** @internal */
+export const CreateWebexPersonEndpointDto$outboundSchema: z.ZodType<
+  CreateWebexPersonEndpointDto$Outbound,
+  z.ZodTypeDef,
+  CreateWebexPersonEndpointDto
+> = z.object({
+  identifier: z.string().optional(),
+  subscriberId: z.string(),
+  context: z.record(
+    z.union([
+      z.lazy(() => CreateWebexPersonEndpointDtoContext2$outboundSchema),
+      z.string(),
+    ]),
+  ).optional(),
+  integrationIdentifier: z.string(),
+  connectionIdentifier: z.string().optional(),
+  type: z.literal("webex_person"),
+  endpoint: WebexPersonEndpointDto$outboundSchema,
+});
+
+export function createWebexPersonEndpointDtoToJSON(
+  createWebexPersonEndpointDto: CreateWebexPersonEndpointDto,
+): string {
+  return JSON.stringify(
+    CreateWebexPersonEndpointDto$outboundSchema.parse(
+      createWebexPersonEndpointDto,
+    ),
+  );
+}

package/src/models/components/createwebexroomendpointdto.ts

@@ -0,0 +1,147 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  WebexRoomEndpointDto,
+  WebexRoomEndpointDto$Outbound,
+  WebexRoomEndpointDto$outboundSchema,
+} from "./webexroomendpointdto.js";
+
+/**
+ * Rich context object with id and optional data
+ */
+export type CreateWebexRoomEndpointDtoContext2 = {
+  id: string;
+  /**
+   * Optional additional context data
+   */
+  data?: { [k: string]: any } | undefined;
+};
+
+export type CreateWebexRoomEndpointDtoContext =
+  | CreateWebexRoomEndpointDtoContext2
+  | string;
+
+export type CreateWebexRoomEndpointDto = {
+  /**
+   * The unique identifier for the channel endpoint. If not provided, one will be generated automatically.
+   */
+  identifier?: string | undefined;
+  /**
+   * The subscriber ID to which the channel endpoint is linked
+   */
+  subscriberId: string;
+  context?:
+    | { [k: string]: CreateWebexRoomEndpointDtoContext2 | string }
+    | undefined;
+  /**
+   * The identifier of the integration to use for this channel endpoint.
+   */
+  integrationIdentifier: string;
+  /**
+   * The identifier of the channel connection to use for this Webex endpoint.
+   */
+  connectionIdentifier?: string | undefined;
+  /**
+   * Type of channel endpoint
+   */
+  type: "webex_room";
+  /**
+   * Webex room endpoint data
+   */
+  endpoint: WebexRoomEndpointDto;
+};
+
+/** @internal */
+export type CreateWebexRoomEndpointDtoContext2$Outbound = {
+  id: string;
+  data?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const CreateWebexRoomEndpointDtoContext2$outboundSchema: z.ZodType<
+  CreateWebexRoomEndpointDtoContext2$Outbound,
+  z.ZodTypeDef,
+  CreateWebexRoomEndpointDtoContext2
+> = z.object({
+  id: z.string(),
+  data: z.record(z.any()).optional(),
+});
+
+export function createWebexRoomEndpointDtoContext2ToJSON(
+  createWebexRoomEndpointDtoContext2: CreateWebexRoomEndpointDtoContext2,
+): string {
+  return JSON.stringify(
+    CreateWebexRoomEndpointDtoContext2$outboundSchema.parse(
+      createWebexRoomEndpointDtoContext2,
+    ),
+  );
+}
+
+/** @internal */
+export type CreateWebexRoomEndpointDtoContext$Outbound =
+  | CreateWebexRoomEndpointDtoContext2$Outbound
+  | string;
+
+/** @internal */
+export const CreateWebexRoomEndpointDtoContext$outboundSchema: z.ZodType<
+  CreateWebexRoomEndpointDtoContext$Outbound,
+  z.ZodTypeDef,
+  CreateWebexRoomEndpointDtoContext
+> = z.union([
+  z.lazy(() => CreateWebexRoomEndpointDtoContext2$outboundSchema),
+  z.string(),
+]);
+
+export function createWebexRoomEndpointDtoContextToJSON(
+  createWebexRoomEndpointDtoContext: CreateWebexRoomEndpointDtoContext,
+): string {
+  return JSON.stringify(
+    CreateWebexRoomEndpointDtoContext$outboundSchema.parse(
+      createWebexRoomEndpointDtoContext,
+    ),
+  );
+}
+
+/** @internal */
+export type CreateWebexRoomEndpointDto$Outbound = {
+  identifier?: string | undefined;
+  subscriberId: string;
+  context?: {
+    [k: string]: CreateWebexRoomEndpointDtoContext2$Outbound | string;
+  } | undefined;
+  integrationIdentifier: string;
+  connectionIdentifier?: string | undefined;
+  type: "webex_room";
+  endpoint: WebexRoomEndpointDto$Outbound;
+};
+
+/** @internal */
+export const CreateWebexRoomEndpointDto$outboundSchema: z.ZodType<
+  CreateWebexRoomEndpointDto$Outbound,
+  z.ZodTypeDef,
+  CreateWebexRoomEndpointDto
+> = z.object({
+  identifier: z.string().optional(),
+  subscriberId: z.string(),
+  context: z.record(
+    z.union([
+      z.lazy(() => CreateWebexRoomEndpointDtoContext2$outboundSchema),
+      z.string(),
+    ]),
+  ).optional(),
+  integrationIdentifier: z.string(),
+  connectionIdentifier: z.string().optional(),
+  type: z.literal("webex_room"),
+  endpoint: WebexRoomEndpointDto$outboundSchema,
+});
+
+export function createWebexRoomEndpointDtoToJSON(
+  createWebexRoomEndpointDto: CreateWebexRoomEndpointDto,
+): string {
+  return JSON.stringify(
+    CreateWebexRoomEndpointDto$outboundSchema.parse(createWebexRoomEndpointDto),
+  );
+}

package/src/models/components/credentialsdto.ts

@@ -60,6 +60,10 @@ export type CredentialsDto = {
   signingSecret?: string | undefined;
   outboundIntegrationId?: string | undefined;
   outboundConnectedAt?: string | undefined;
+  /**
+   * ISO timestamp marking Layer-2 What's next completion (Connected badge + guide hide). WhatsApp Business: stamped on post-connect Access Token rotation or manual confirm.
+   */
+  whatsNextCompletedAt?: string | undefined;
   useFromAddressOverride?: boolean | undefined;
   fromAddressOverride?: string | undefined;
   /**
@@ -164,6 +168,7 @@ export const CredentialsDto$inboundSchema: z.ZodType<
   signingSecret: z.string().optional(),
   outboundIntegrationId: z.string().optional(),
   outboundConnectedAt: z.string().optional(),
+  whatsNextCompletedAt: z.string().optional(),
   useFromAddressOverride: z.boolean().optional(),
   fromAddressOverride: z.string().optional(),
   emailSlugPrefix: z.string().optional(),
@@ -226,6 +231,7 @@ export type CredentialsDto$Outbound = {
   signingSecret?: string | undefined;
   outboundIntegrationId?: string | undefined;
   outboundConnectedAt?: string | undefined;
+  whatsNextCompletedAt?: string | undefined;
   useFromAddressOverride?: boolean | undefined;
   fromAddressOverride?: string | undefined;
   emailSlugPrefix?: string | undefined;
@@ -289,6 +295,7 @@ export const CredentialsDto$outboundSchema: z.ZodType<
   signingSecret: z.string().optional(),
   outboundIntegrationId: z.string().optional(),
   outboundConnectedAt: z.string().optional(),
+  whatsNextCompletedAt: z.string().optional(),
   useFromAddressOverride: z.boolean().optional(),
   fromAddressOverride: z.string().optional(),
   emailSlugPrefix: z.string().optional(),

package/src/models/components/deletemessagepayloaddto.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type DeleteMessagePayloadDto = {
+  /**
+   * Platform message id to delete. Removes the rendered message only — history is preserved.
+   */
+  messageId: string;
+};
+
+/** @internal */
+export type DeleteMessagePayloadDto$Outbound = {
+  messageId: string;
+};
+
+/** @internal */
+export const DeleteMessagePayloadDto$outboundSchema: z.ZodType<
+  DeleteMessagePayloadDto$Outbound,
+  z.ZodTypeDef,
+  DeleteMessagePayloadDto
+> = z.object({
+  messageId: z.string(),
+});
+
+export function deleteMessagePayloadDtoToJSON(
+  deleteMessagePayloadDto: DeleteMessagePayloadDto,
+): string {
+  return JSON.stringify(
+    DeleteMessagePayloadDto$outboundSchema.parse(deleteMessagePayloadDto),
+  );
+}

package/src/models/components/editpayloaddto.ts

@@ -0,0 +1,90 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  CardReplyContentDto,
+  CardReplyContentDto$Outbound,
+  CardReplyContentDto$outboundSchema,
+} from "./cardreplycontentdto.js";
+import {
+  MarkdownReplyContentDto,
+  MarkdownReplyContentDto$Outbound,
+  MarkdownReplyContentDto$outboundSchema,
+} from "./markdownreplycontentdto.js";
+import {
+  ToolApprovalCardReplyContentDto,
+  ToolApprovalCardReplyContentDto$Outbound,
+  ToolApprovalCardReplyContentDto$outboundSchema,
+} from "./toolapprovalcardreplycontentdto.js";
+
+/**
+ * Replacement content. Exactly one of markdown, card, or toolApprovalCard.
+ */
+export type Content =
+  | MarkdownReplyContentDto
+  | CardReplyContentDto
+  | ToolApprovalCardReplyContentDto;
+
+export type EditPayloadDto = {
+  /**
+   * Platform message id of the message to edit.
+   */
+  messageId: string;
+  /**
+   * Replacement content. Exactly one of markdown, card, or toolApprovalCard.
+   */
+  content:
+    | MarkdownReplyContentDto
+    | CardReplyContentDto
+    | ToolApprovalCardReplyContentDto;
+};
+
+/** @internal */
+export type Content$Outbound =
+  | MarkdownReplyContentDto$Outbound
+  | CardReplyContentDto$Outbound
+  | ToolApprovalCardReplyContentDto$Outbound;
+
+/** @internal */
+export const Content$outboundSchema: z.ZodType<
+  Content$Outbound,
+  z.ZodTypeDef,
+  Content
+> = z.union([
+  MarkdownReplyContentDto$outboundSchema,
+  CardReplyContentDto$outboundSchema,
+  ToolApprovalCardReplyContentDto$outboundSchema,
+]);
+
+export function contentToJSON(content: Content): string {
+  return JSON.stringify(Content$outboundSchema.parse(content));
+}
+
+/** @internal */
+export type EditPayloadDto$Outbound = {
+  messageId: string;
+  content:
+    | MarkdownReplyContentDto$Outbound
+    | CardReplyContentDto$Outbound
+    | ToolApprovalCardReplyContentDto$Outbound;
+};
+
+/** @internal */
+export const EditPayloadDto$outboundSchema: z.ZodType<
+  EditPayloadDto$Outbound,
+  z.ZodTypeDef,
+  EditPayloadDto
+> = z.object({
+  messageId: z.string(),
+  content: z.union([
+    MarkdownReplyContentDto$outboundSchema,
+    CardReplyContentDto$outboundSchema,
+    ToolApprovalCardReplyContentDto$outboundSchema,
+  ]),
+});
+
+export function editPayloadDtoToJSON(editPayloadDto: EditPayloadDto): string {
+  return JSON.stringify(EditPayloadDto$outboundSchema.parse(editPayloadDto));
+}