@novu/api 3.14.4 → 3.15.1-rc.1

package/src/sdk/environmentvariables.ts

@@ -58,13 +58,13 @@ export class EnvironmentVariables extends ClientSDK {
   }
 
   /**
-   * Retrieve a variable
+   * Get environment variable
    *
    * @remarks
-   * Returns a single environment variable by id. Secret values are masked.
+   * Returns a single environment variable by key. Secret values are masked.
    */
   async retrieve(
-    variableId: string,
+    variableKey: string,
     idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<
@@ -72,7 +72,7 @@ export class EnvironmentVariables extends ClientSDK {
   > {
     return unwrapAsync(environmentVariablesRetrieve(
       this,
-      variableId,
+      variableKey,
       idempotencyKey,
       options,
     ));
@@ -87,7 +87,7 @@ export class EnvironmentVariables extends ClientSDK {
   async update(
     updateEnvironmentVariableRequestDto:
       components.UpdateEnvironmentVariableRequestDto,
-    variableId: string,
+    variableKey: string,
     idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<
@@ -96,20 +96,20 @@ export class EnvironmentVariables extends ClientSDK {
     return unwrapAsync(environmentVariablesUpdate(
       this,
       updateEnvironmentVariableRequestDto,
-      variableId,
+      variableKey,
       idempotencyKey,
       options,
     ));
   }
 
   /**
-   * Delete a variable
+   * Delete environment variable
    *
    * @remarks
-   * Deletes an environment variable by id.
+   * Deletes an environment variable by key.
    */
   async delete(
-    variableId: string,
+    variableKey: string,
     idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<
@@ -118,7 +118,7 @@ export class EnvironmentVariables extends ClientSDK {
   > {
     return unwrapAsync(environmentVariablesDelete(
       this,
-      variableId,
+      variableKey,
       idempotencyKey,
       options,
     ));
@@ -131,7 +131,7 @@ export class EnvironmentVariables extends ClientSDK {
    * Returns the workflows that reference this environment variable via `{{env.KEY}}` in their step controls. **variableId** is required.
    */
   async usage(
-    variableId: string,
+    variableKey: string,
     idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<
@@ -139,7 +139,7 @@ export class EnvironmentVariables extends ClientSDK {
   > {
     return unwrapAsync(environmentVariablesUsage(
       this,
-      variableId,
+      variableKey,
       idempotencyKey,
       options,
     ));

package/src/sdk/integrations.ts

@@ -5,6 +5,8 @@
 import { integrationsCreate } from "../funcs/integrationsCreate.js";
 import { integrationsDelete } from "../funcs/integrationsDelete.js";
 import { integrationsGenerateChatOAuthUrl } from "../funcs/integrationsGenerateChatOAuthUrl.js";
+import { integrationsGenerateConnectOAuthUrl } from "../funcs/integrationsGenerateConnectOAuthUrl.js";
+import { integrationsGenerateLinkUserOAuthUrl } from "../funcs/integrationsGenerateLinkUserOAuthUrl.js";
 import { integrationsIntegrationsControllerAutoConfigureIntegration } from "../funcs/integrationsIntegrationsControllerAutoConfigureIntegration.js";
 import { integrationsList } from "../funcs/integrationsList.js";
 import { integrationsListActive } from "../funcs/integrationsListActive.js";
@@ -157,13 +159,60 @@ 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).
+   *     The generated URL expires after 5 minutes.
+   */
+  async generateConnectOAuthUrl(
+    generateConnectOauthUrlRequestDto:
+      components.GenerateConnectOauthUrlRequestDto,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.IntegrationsControllerGenerateConnectOAuthUrlResponse> {
+    return unwrapAsync(integrationsGenerateConnectOAuthUrl(
+      this,
+      generateConnectOauthUrlRequestDto,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * 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).
+   *     The generated URL expires after 5 minutes.
+   */
+  async generateLinkUserOAuthUrl(
+    generateLinkUserOauthUrlRequestDto:
+      components.GenerateLinkUserOauthUrlRequestDto,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    operations.IntegrationsControllerGenerateLinkUserOAuthUrlResponse
+  > {
+    return unwrapAsync(integrationsGenerateLinkUserOAuthUrl(
+      this,
+      generateLinkUserOauthUrlRequestDto,
+      idempotencyKey,
+      options,
+    ));
+  }
+
   /**
    * Generate chat OAuth URL
    *
    * @remarks
-   * Generate an OAuth URL for chat integrations like Slack and MS Teams.
+   * **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.
    *     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.
+   *
+   * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   async generateChatOAuthUrl(
     generateChatOauthUrlRequestDto: components.GenerateChatOauthUrlRequestDto,

package/src/sdk/routes.ts

@@ -0,0 +1,144 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { domainsRoutesCreate } from "../funcs/domainsRoutesCreate.js";
+import { domainsRoutesDelete } from "../funcs/domainsRoutesDelete.js";
+import { domainsRoutesList } from "../funcs/domainsRoutesList.js";
+import { domainsRoutesRetrieve } from "../funcs/domainsRoutesRetrieve.js";
+import { domainsRoutesTest } from "../funcs/domainsRoutesTest.js";
+import { domainsRoutesUpdate } from "../funcs/domainsRoutesUpdate.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 Routes extends ClientSDK {
+  /**
+   * List routes for a domain
+   *
+   * @remarks
+   * Returns a paginated list of routes attached to the domain. Optionally filter by an agent identifier to find routes pointing to a specific agent.
+   */
+  async list(
+    request: operations.DomainsControllerListDomainRoutesRequest,
+    options?: RequestOptions,
+  ): Promise<operations.DomainsControllerListDomainRoutesResponse> {
+    return unwrapAsync(domainsRoutesList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create a route
+   *
+   * @remarks
+   * Creates a route on the domain that forwards inbound mail addressed to `<address>@<domain>` to either a webhook or an agent. Each address on a domain may only have a single route.
+   */
+  async create(
+    domainRouteDto: components.DomainRouteDto,
+    domain: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.DomainsControllerCreateDomainRouteResponse> {
+    return unwrapAsync(domainsRoutesCreate(
+      this,
+      domainRouteDto,
+      domain,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a route by address
+   *
+   * @remarks
+   * Returns the route bound to `<address>@<domain>`. Use `*` as the address to retrieve the wildcard route for the domain.
+   */
+  async retrieve(
+    domain: string,
+    address: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.DomainsControllerGetDomainRouteResponse> {
+    return unwrapAsync(domainsRoutesRetrieve(
+      this,
+      domain,
+      address,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Update a route
+   *
+   * @remarks
+   * Updates the destination of the route bound to `<address>@<domain>`. The address itself is the resource identity and cannot be changed; delete and recreate the route to rename it.
+   */
+  async update(
+    updateDomainRouteDto: components.UpdateDomainRouteDto,
+    domain: string,
+    address: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.DomainsControllerUpdateDomainRouteResponse> {
+    return unwrapAsync(domainsRoutesUpdate(
+      this,
+      updateDomainRouteDto,
+      domain,
+      address,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a route
+   *
+   * @remarks
+   * Removes the route bound to `<address>@<domain>`. Inbound mail for that address will no longer be processed.
+   */
+  async delete(
+    domain: string,
+    address: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    operations.DomainsControllerDeleteDomainRouteResponse | undefined
+  > {
+    return unwrapAsync(domainsRoutesDelete(
+      this,
+      domain,
+      address,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Test an inbound route
+   *
+   * @remarks
+   * Sends a synthetic inbound email through the same delivery path as production (outbound webhooks for webhook routes, signed HTTP to the agent for agent routes). Use `dryRun: true` to preview the payload without delivering.
+   */
+  async test(
+    testDomainRouteDto: components.TestDomainRouteDto,
+    domain: string,
+    address: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.DomainsControllerTestDomainRouteResponse> {
+    return unwrapAsync(domainsRoutesTest(
+      this,
+      testDomainRouteDto,
+      domain,
+      address,
+      idempotencyKey,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -14,6 +14,7 @@ import { Activity } from "./activity.js";
 import { ChannelConnections } from "./channelconnections.js";
 import { ChannelEndpoints } from "./channelendpoints.js";
 import { Contexts } from "./contexts.js";
+import { Domains } from "./domains.js";
 import { Environments } from "./environments.js";
 import { EnvironmentVariables } from "./environmentvariables.js";
 import { Integrations } from "./integrations.js";
@@ -76,6 +77,11 @@ export class Novu extends ClientSDK {
     return (this._channelEndpoints ??= new ChannelEndpoints(this._options));
   }
 
+  private _domains?: Domains;
+  get domains(): Domains {
+    return (this._domains ??= new Domains(this._options));
+  }
+
   private _environmentVariables?: EnvironmentVariables;
   get environmentVariables(): EnvironmentVariables {
     return (this._environmentVariables ??= new EnvironmentVariables(