@novu/api 3.17.1 → 3.18.1

package/src/sdk/agents.ts

@@ -0,0 +1,186 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { agentsCreate } from "../funcs/agentsCreate.js";
+import { agentsDelete } from "../funcs/agentsDelete.js";
+import { agentsList } from "../funcs/agentsList.js";
+import { agentsRetrieve } from "../funcs/agentsRetrieve.js";
+import { agentsSendReply } from "../funcs/agentsSendReply.js";
+import { agentsUpdate } from "../funcs/agentsUpdate.js";
+import { agentsUpdateBridge } from "../funcs/agentsUpdateBridge.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { NovuIntegrations } from "./novuintegrations.js";
+
+export class Agents extends ClientSDK {
+  private _integrations?: NovuIntegrations;
+  get integrations(): NovuIntegrations {
+    return (this._integrations ??= new NovuIntegrations(this._options));
+  }
+
+  /**
+   * Create an agent
+   *
+   * @remarks
+   * Create an agent scoped to the current environment. The identifier must be unique per environment. Set `runtime` to `managed` and supply `managedRuntime` to provision a provider-hosted agent brain.
+   */
+  async create(
+    createAgentRequestDto: components.CreateAgentRequestDto,
+    novuAnalyticsSource: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.AgentsControllerCreateAgentResponse> {
+    return unwrapAsync(agentsCreate(
+      this,
+      createAgentRequestDto,
+      novuAnalyticsSource,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * List all agents
+   *
+   * @remarks
+   * Retrieve a cursor-paginated list of agents for the current environment. Use **after**, **before**, **limit**, **orderBy**, and **orderDirection** query parameters.
+   */
+  async list(
+    request: operations.AgentsControllerListAgentsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.AgentsControllerListAgentsResponse> {
+    return unwrapAsync(agentsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Send an agent reply
+   *
+   * @remarks
+   * Send a message or side-effect into an existing agent conversation from your backend.
+   *
+   * Use this endpoint when you are not using `@novu/framework` (for example Python, Go, PHP, .NET, or Java SDKs),
+   * or when a server process outside the bridge needs to post into a live conversation.
+   *
+   * **Message actions**
+   * - `reply` — markdown, interactive card, or tool-approval card (optional `files`)
+   * - `edit` — update a previously delivered message in place
+   * - `deleteMessages` — remove rendered platform messages (history is kept)
+   * - `addReactions` — add emoji reactions to existing messages
+   *
+   * **Turn control**
+   * - `typing` — `{ status?: string }` to set status, or `"stop"` to clear
+   * - `resolve` — mark the conversation resolved (optionally with a final reply)
+   * - `error: true` — report a customer-runtime failure (cannot combine with other actions)
+   *
+   * **Signals & tools**
+   * - `signals` — metadata set/delete/clear, or trigger a Novu workflow
+   * - `toolResults` — persist tool outputs into conversation history
+   * - `toolApprovalRequest` — ledger a gated tool call (pair with an approval card reply)
+   *
+   * Returns `{ data: { messageId, platformThreadId } }` when a reply or edit is delivered;
+   * otherwise `{ data: null }`.
+   */
+  async sendReply(
+    agentReplyPayloadDto: components.AgentReplyPayloadDto,
+    agentId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.AgentReplyControllerHandleAgentReplyHandlerResponse> {
+    return unwrapAsync(agentsSendReply(
+      this,
+      agentReplyPayloadDto,
+      agentId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve an agent
+   *
+   * @remarks
+   * Retrieve an agent by its external identifier (not the internal MongoDB id).
+   */
+  async retrieve(
+    identifier: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.AgentsControllerGetAgentResponse> {
+    return unwrapAsync(agentsRetrieve(
+      this,
+      identifier,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Update an agent
+   *
+   * @remarks
+   * Update an agent by its external identifier.
+   */
+  async update(
+    updateAgentRequestDto: components.UpdateAgentRequestDto,
+    identifier: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.AgentsControllerUpdateAgentResponse> {
+    return unwrapAsync(agentsUpdate(
+      this,
+      updateAgentRequestDto,
+      identifier,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Delete an agent
+   *
+   * @remarks
+   * Delete an agent by identifier and remove all agent-integration links. For managed-runtime agents, pass `deleteFromProvider=true` to also archive the agent on the provider side (e.g. Anthropic). By default only the Novu record is deleted and the provider agent is left intact.
+   */
+  async delete(
+    identifier: string,
+    deleteFromProvider: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.AgentsControllerDeleteAgentResponse | undefined> {
+    return unwrapAsync(agentsDelete(
+      this,
+      identifier,
+      deleteFromProvider,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Update an agent bridge
+   *
+   * @remarks
+   * Update the bridge URL configuration for an agent. Used by the CLI to register dev tunnel URLs. Refuses to activate dev bridges on production environments.
+   */
+  async updateBridge(
+    updateAgentBridgeRequestDto: components.UpdateAgentBridgeRequestDto,
+    identifier: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.AgentsControllerUpdateAgentBridgeResponse> {
+    return unwrapAsync(agentsUpdateBridge(
+      this,
+      updateAgentBridgeRequestDto,
+      identifier,
+      idempotencyKey,
+      options,
+    ));
+  }
+}

package/src/sdk/integrations.ts

@@ -214,7 +214,7 @@ export class Integrations extends ClientSDK {
    * Generate OAuth URL for a workspace/tenant connection
    *
    * @remarks
-   * Generate an OAuth URL that creates a workspace or tenant-level channel connection (Slack workspace install or MS Teams admin consent).
+   * Generate an OAuth URL that creates a workspace or tenant-level channel connection (Slack workspace install, MS Teams admin consent, or Webex integration authorization).
    *     The generated URL expires after 5 minutes.
    */
   async generateConnectOAuthUrl(
@@ -254,7 +254,7 @@ export class Integrations extends ClientSDK {
    * Generate OAuth URL to link a subscriber user identity
    *
    * @remarks
-   * Generate an OAuth URL that links a specific subscriber to their chat identity (Slack user ID or MS Teams user OID).
+   * Generate an OAuth URL that links a specific subscriber to their chat identity (Slack user ID, MS Teams user OID, or Webex person).
    *     The generated URL expires after 5 minutes.
    */
   async generateLinkUserOAuthUrl(
@@ -278,7 +278,7 @@ export class Integrations extends ClientSDK {
    *
    * @remarks
    * **Deprecated** — use `POST /integrations/channel-connections/oauth` (connect) or `POST /integrations/channel-endpoints/oauth` (link_user) instead.
-   *     Generate an OAuth URL for chat integrations like Slack and MS Teams.
+   *     Generate an OAuth URL for chat integrations like Slack, MS Teams, and Webex.
    *     This URL allows subscribers to authorize the integration, enabling the system to send messages
    *     through their chat workspace. The generated URL expires after 5 minutes.
    *

package/src/sdk/novuintegrations.ts

@@ -0,0 +1,100 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { agentsIntegrationsCreate } from "../funcs/agentsIntegrationsCreate.js";
+import { agentsIntegrationsDelete } from "../funcs/agentsIntegrationsDelete.js";
+import { agentsIntegrationsList } from "../funcs/agentsIntegrationsList.js";
+import { agentsIntegrationsUpdate } from "../funcs/agentsIntegrationsUpdate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class NovuIntegrations extends ClientSDK {
+  /**
+   * Create an agent integration
+   *
+   * @remarks
+   * Create a link between an agent (by identifier) and an integration (by integration **identifier**, not the internal _id).
+   */
+  async create(
+    addAgentIntegrationRequestDto: components.AddAgentIntegrationRequestDto,
+    identifier: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    operations.AgentIntegrationsControllerAddAgentIntegrationResponse
+  > {
+    return unwrapAsync(agentsIntegrationsCreate(
+      this,
+      addAgentIntegrationRequestDto,
+      identifier,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * List agent integrations
+   *
+   * @remarks
+   * Retrieve integration links for an agent identified by its external identifier. Supports cursor pagination via **after**, **before**, **limit**, **orderBy**, and **orderDirection**.
+   */
+  async list(
+    request: operations.AgentIntegrationsControllerListAgentIntegrationsRequest,
+    options?: RequestOptions,
+  ): Promise<
+    operations.AgentIntegrationsControllerListAgentIntegrationsResponse
+  > {
+    return unwrapAsync(agentsIntegrationsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update an agent integration
+   *
+   * @remarks
+   * Update which integration a link points to (by integration **identifier**, not the internal _id).
+   */
+  async update(
+    request:
+      operations.AgentIntegrationsControllerUpdateAgentIntegrationRequest,
+    options?: RequestOptions,
+  ): Promise<
+    operations.AgentIntegrationsControllerUpdateAgentIntegrationResponse
+  > {
+    return unwrapAsync(agentsIntegrationsUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete an agent integration
+   *
+   * @remarks
+   * Delete a specific agent-integration link by its document id.
+   */
+  async delete(
+    identifier: string,
+    agentIntegrationId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    | operations.AgentIntegrationsControllerRemoveAgentIntegrationResponse
+    | undefined
+  > {
+    return unwrapAsync(agentsIntegrationsDelete(
+      this,
+      identifier,
+      agentIntegrationId,
+      idempotencyKey,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -11,6 +11,7 @@ import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 import { Activity } from "./activity.js";
+import { Agents } from "./agents.js";
 import { ChannelConnections } from "./channelconnections.js";
 import { ChannelEndpoints } from "./channelendpoints.js";
 import { Contexts } from "./contexts.js";
@@ -67,6 +68,11 @@ export class Novu extends ClientSDK {
     return (this._workflows ??= new Workflows(this._options));
   }
 
+  private _agents?: Agents;
+  get agents(): Agents {
+    return (this._agents ??= new Agents(this._options));
+  }
+
   private _channelConnections?: ChannelConnections;
   get channelConnections(): ChannelConnections {
     return (this._channelConnections ??= new ChannelConnections(this._options));