@novu/api 3.13.0 → 3.14.0

package/README.md

@@ -297,7 +297,7 @@ run();
 
 ### [Environments](docs/sdks/environments/README.md)
 
-* [getTags](docs/sdks/environments/README.md#gettags) - Get environment tags
+* [getTags](docs/sdks/environments/README.md#gettags) - List environment tags
 * [create](docs/sdks/environments/README.md#create) - Create an environment
 * [list](docs/sdks/environments/README.md#list) - List all environments
 * [update](docs/sdks/environments/README.md#update) - Update an environment
@@ -393,7 +393,7 @@ run();
 * [list](docs/sdks/subscriptions/README.md#list) - List topic subscriptions
 * [create](docs/sdks/subscriptions/README.md#create) - Create topic subscriptions
 * [delete](docs/sdks/subscriptions/README.md#delete) - Delete topic subscriptions
-* [getSubscription](docs/sdks/subscriptions/README.md#getsubscription) - Get a topic subscription
+* [getSubscription](docs/sdks/subscriptions/README.md#getsubscription) - Retrieve a topic subscription
 * [update](docs/sdks/subscriptions/README.md#update) - Update a topic subscription
 
 ### [Translations](docs/sdks/translations/README.md)
@@ -465,7 +465,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`contextsUpdate`](docs/sdks/contexts/README.md#update) - Update a context
 - [`environmentsCreate`](docs/sdks/environments/README.md#create) - Create an environment
 - [`environmentsDelete`](docs/sdks/environments/README.md#delete) - Delete an environment
-- [`environmentsGetTags`](docs/sdks/environments/README.md#gettags) - Get environment tags
+- [`environmentsGetTags`](docs/sdks/environments/README.md#gettags) - List environment tags
 - [`environmentsList`](docs/sdks/environments/README.md#list) - List all environments
 - [`environmentsUpdate`](docs/sdks/environments/README.md#update) - Update an environment
 - [`integrationsCreate`](docs/sdks/integrations/README.md#create) - Create an integration
@@ -515,7 +515,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`topicsSubscribersRetrieve`](docs/sdks/novusubscribers/README.md#retrieve) - Check topic subscriber
 - [`topicsSubscriptionsCreate`](docs/sdks/subscriptions/README.md#create) - Create topic subscriptions
 - [`topicsSubscriptionsDelete`](docs/sdks/subscriptions/README.md#delete) - Delete topic subscriptions
-- [`topicsSubscriptionsGetSubscription`](docs/sdks/subscriptions/README.md#getsubscription) - Get a topic subscription
+- [`topicsSubscriptionsGetSubscription`](docs/sdks/subscriptions/README.md#getsubscription) - Retrieve a topic subscription
 - [`topicsSubscriptionsList`](docs/sdks/subscriptions/README.md#list) - List topic subscriptions
 - [`topicsSubscriptionsUpdate`](docs/sdks/subscriptions/README.md#update) - Update a topic subscription
 - [`topicsUpdate`](docs/sdks/topics/README.md#update) - Update a topic
@@ -733,19 +733,23 @@ The `HTTPClient` constructor takes an optional `fetcher` argument that can be
 used to integrate a third-party HTTP client or when writing tests to mock out
 the HTTP client and feed in fixtures.
 
-The following example shows how to use the `"beforeRequest"` hook to to add a
-custom header and a timeout to requests and how to use the `"requestError"` hook
-to log errors:
+The following example shows how to:
+- route requests through a proxy server using [undici](https://www.npmjs.com/package/undici)'s ProxyAgent
+- use the `"beforeRequest"` hook to add a custom header and a timeout to requests
+- use the `"requestError"` hook to log errors
 
 ```typescript
 import { Novu } from "@novu/api";
+import { ProxyAgent } from "undici";
 import { HTTPClient } from "@novu/api/lib/http";
 
+const dispatcher = new ProxyAgent("http://proxy.example.com:8080");
+
 const httpClient = new HTTPClient({
-  // fetcher takes a function that has the same signature as native `fetch`.
-  fetcher: (request) => {
-    return fetch(request);
-  }
+  // 'fetcher' takes a function that has the same signature as native 'fetch'.
+  fetcher: (input, init) =>
+    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
+    fetch(input, { ...init, dispatcher } as RequestInit),
 });
 
 httpClient.addHook("beforeRequest", (request) => {
@@ -863,32 +867,36 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.trigger({
-    workflowId: "workflow_identifier",
-    payload: {
-      "comment_id": "string",
-      "post": {
-        "text": "string",
+  const result = await novu.trigger(
+    {
+      workflowId: "workflow_identifier",
+      payload: {
+        "comment_id": "string",
+        "post": {
+          "text": "string",
+        },
+      },
+      overrides: {},
+      to: "SUBSCRIBER_ID",
+      actor: "<value>",
+      context: {
+        "key": "org-acme",
       },
     },
-    overrides: {},
-    to: "SUBSCRIBER_ID",
-    actor: "<value>",
-    context: {
-      "key": "org-acme",
-    },
-  }, {
-    retries: {
-      strategy: "backoff",
-      backoff: {
-        initialInterval: 1,
-        maxInterval: 50,
-        exponent: 1.1,
-        maxElapsedTime: 100,
+    undefined,
+    {
+      retries: {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 1,
+          maxInterval: 50,
+          exponent: 1.1,
+          maxElapsedTime: 100,
+        },
+        retryConnectionErrors: false,
       },
-      retryConnectionErrors: false,
     },
-  });
+  );
 
   console.log(result);
 }

package/examples/package-lock.json

@@ -18,13 +18,13 @@
     },
     "..": {
       "name": "@novu/api",
-      "version": "3.13.0",
+      "version": "3.14.0",
       "dependencies": {
         "zod": "^3.25.0 || ^4.0.0"
       },
       "devDependencies": {
-        "@eslint/js": "^9.19.0",
-        "eslint": "^9.19.0",
+        "@eslint/js": "^9.26.0",
+        "eslint": "^9.26.0",
         "globals": "^15.14.0",
         "typescript": "~5.8.3",
         "typescript-eslint": "^8.26.0"

package/funcs/environmentsGetTags.d.ts

@@ -9,7 +9,7 @@ import * as operations from "../models/operations/index.js";
 import { APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 /**
- * Get environment tags
+ * List environment tags
  *
  * @remarks
  * Retrieve all unique tags used in workflows within the specified environment. These tags can be used for filtering workflows.

package/funcs/environmentsGetTags.js

@@ -47,7 +47,7 @@ const errors = __importStar(require("../models/errors/index.js"));
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.js");
 /**
- * Get environment tags
+ * List environment tags
  *
  * @remarks
  * Retrieve all unique tags used in workflows within the specified environment. These tags can be used for filtering workflows.

package/funcs/topicsSubscriptionsGetSubscription.d.ts

@@ -9,10 +9,10 @@ import * as operations from "../models/operations/index.js";
 import { APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 /**
- * Get a topic subscription
+ * Retrieve a topic subscription
  *
  * @remarks
- * Get a subscription by its unique identifier for a topic.
+ * Retrieve a subscription by its unique identifier for a topic.
  */
 export declare function topicsSubscriptionsGetSubscription(client: NovuCore, topicKey: string, identifier: string, idempotencyKey?: string | undefined, options?: RequestOptions): APIPromise<Result<operations.TopicsControllerGetTopicSubscriptionResponse, errors.ErrorDto | errors.ValidationErrorDto | NovuError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=topicsSubscriptionsGetSubscription.d.ts.map

package/funcs/topicsSubscriptionsGetSubscription.js

@@ -47,10 +47,10 @@ const errors = __importStar(require("../models/errors/index.js"));
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.js");
 /**
- * Get a topic subscription
+ * Retrieve a topic subscription
  *
  * @remarks
- * Get a subscription by its unique identifier for a topic.
+ * Retrieve a subscription by its unique identifier for a topic.
  */
 function topicsSubscriptionsGetSubscription(client, topicKey, identifier, idempotencyKey, options) {
     return new async_js_1.APIPromise($do(client, topicKey, identifier, idempotencyKey, options));

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@novu/api",
-  "version": "3.13.0",
+  "version": "3.14.0",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/lib/config.d.ts

@@ -30,9 +30,9 @@ export type SDKOptions = {
 export declare function serverURLFromOptions(options: SDKOptions): URL | null;
 export declare const SDK_METADATA: {
     readonly language: "typescript";
-    readonly openapiDocVersion: "3.12.0";
-    readonly sdkVersion: "3.13.0";
-    readonly genVersion: "2.801.2";
-    readonly userAgent: "speakeasy-sdk/typescript 3.13.0 2.801.2 3.12.0 @novu/api";
+    readonly openapiDocVersion: "3.13.0";
+    readonly sdkVersion: "3.14.0";
+    readonly genVersion: "2.836.5";
+    readonly userAgent: "speakeasy-sdk/typescript 3.14.0 2.836.5 3.13.0 @novu/api";
 };
 //# sourceMappingURL=config.d.ts.map

package/lib/config.js

@@ -28,9 +28,9 @@ function serverURLFromOptions(options) {
 }
 exports.SDK_METADATA = {
     language: "typescript",
-    openapiDocVersion: "3.12.0",
-    sdkVersion: "3.13.0",
-    genVersion: "2.801.2",
-    userAgent: "speakeasy-sdk/typescript 3.13.0 2.801.2 3.12.0 @novu/api",
+    openapiDocVersion: "3.13.0",
+    sdkVersion: "3.14.0",
+    genVersion: "2.836.5",
+    userAgent: "speakeasy-sdk/typescript 3.14.0 2.836.5 3.13.0 @novu/api",
 };
 //# sourceMappingURL=config.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@novu/api",
-  "version": "3.13.0",
+  "version": "3.14.0",
   "author": "Novu",
   "description": "The <Inbox /> infrastructure for modern products",
   "main": "./index.js",
@@ -18,8 +18,8 @@
     
   },
   "devDependencies": {
-    "@eslint/js": "^9.19.0",
-    "eslint": "^9.19.0",
+    "@eslint/js": "^9.26.0",
+    "eslint": "^9.26.0",
     "globals": "^15.14.0",
     "typescript": "~5.8.3",
     "typescript-eslint": "^8.26.0"

package/sdk/environments.d.ts

@@ -3,7 +3,7 @@ import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
 export declare class Environments extends ClientSDK {
     /**
-     * Get environment tags
+     * List environment tags
      *
      * @remarks
      * Retrieve all unique tags used in workflows within the specified environment. These tags can be used for filtering workflows.

package/sdk/environments.js

@@ -13,7 +13,7 @@ const sdks_js_1 = require("../lib/sdks.js");
 const fp_js_1 = require("../types/fp.js");
 class Environments extends sdks_js_1.ClientSDK {
     /**
-     * Get environment tags
+     * List environment tags
      *
      * @remarks
      * Retrieve all unique tags used in workflows within the specified environment. These tags can be used for filtering workflows.

package/sdk/subscriptions.d.ts

@@ -26,10 +26,10 @@ export declare class Subscriptions extends ClientSDK {
      */
     delete(deleteTopicSubscriptionsRequestDto: components.DeleteTopicSubscriptionsRequestDto, topicKey: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.TopicsControllerDeleteTopicSubscriptionsResponse>;
     /**
-     * Get a topic subscription
+     * Retrieve a topic subscription
      *
      * @remarks
-     * Get a subscription by its unique identifier for a topic.
+     * Retrieve a subscription by its unique identifier for a topic.
      */
     getSubscription(topicKey: string, identifier: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.TopicsControllerGetTopicSubscriptionResponse>;
     /**

package/sdk/subscriptions.js

@@ -42,10 +42,10 @@ class Subscriptions extends sdks_js_1.ClientSDK {
         return (0, fp_js_1.unwrapAsync)((0, topicsSubscriptionsDelete_js_1.topicsSubscriptionsDelete)(this, deleteTopicSubscriptionsRequestDto, topicKey, idempotencyKey, options));
     }
     /**
-     * Get a topic subscription
+     * Retrieve a topic subscription
      *
      * @remarks
-     * Get a subscription by its unique identifier for a topic.
+     * Retrieve a subscription by its unique identifier for a topic.
      */
     async getSubscription(topicKey, identifier, idempotencyKey, options) {
         return (0, fp_js_1.unwrapAsync)((0, topicsSubscriptionsGetSubscription_js_1.topicsSubscriptionsGetSubscription)(this, topicKey, identifier, idempotencyKey, options));

package/sources/json-development.json

@@ -2497,7 +2497,7 @@
       "get": {
         "operationId": "EnvironmentsController_getEnvironmentTags",
         "x-speakeasy-name-override": "getTags",
-        "summary": "Get environment tags",
+        "summary": "List environment tags",
         "description": "Retrieve all unique tags used in workflows within the specified environment. These tags can be used for filtering workflows.",
         "parameters": [
           {
@@ -15657,8 +15657,8 @@
         "operationId": "TopicsController_getTopicSubscription",
         "x-speakeasy-name-override": "getSubscription",
         "x-speakeasy-group": "Topics.Subscriptions",
-        "summary": "Get a topic subscription",
-        "description": "Get a subscription by its unique identifier for a topic.",
+        "summary": "Retrieve a topic subscription",
+        "description": "Retrieve a subscription by its unique identifier for a topic.",
         "parameters": [
           {
             "name": "topicKey",
@@ -42137,7 +42137,7 @@
   "info": {
     "title": "Novu API",
     "description": "Novu REST API. Please see https://docs.novu.co/api-reference for more details.",
-    "version": "3.12.0",
+    "version": "3.13.0",
     "contact": {
       "name": "Novu Support",
       "url": "https://discord.gg/novu",
@@ -42228,7 +42228,7 @@
         "type": "apiKey",
         "name": "Authorization",
         "in": "header",
-        "description": "API key authentication. Allowed headers-- \"Authorization: ApiKey \u003cnovu_secret_key\u003e\".",
+        "description": "API key authentication. Allowed headers-- \"Authorization: ApiKey <novu_secret_key>\".",
         "x-speakeasy-example": "YOUR_SECRET_KEY_HERE"
       }
     },
@@ -43362,7 +43362,7 @@
                 "text": "string"
               }
             },
-            "description": "The payload object is used to pass additional information that \n    could be used to render the template, or perform routing rules based on it. \n      For In-App channel, payload data are also available in \u003cInbox /\u003e",
+            "description": "The payload object is used to pass additional information that \n    could be used to render the template, or perform routing rules based on it. \n      For In-App channel, payload data are also available in <Inbox />",
             "additionalProperties": true
           },
           "overrides": {
@@ -49948,7 +49948,7 @@
                   ]
                 },
                 {
-                  "\u003e": [
+                  ">": [
                     {
                       "var": "payload.amount"
                     },
@@ -50126,7 +50126,7 @@
                   ]
                 },
                 {
-                  "\u003e": [
+                  ">": [
                     {
                       "var": "payload.amount"
                     },
@@ -50274,7 +50274,7 @@
                   ]
                 },
                 {
-                  "\u003e": [
+                  ">": [
                     {
                       "var": "payload.amount"
                     },
@@ -50426,7 +50426,7 @@
                   ]
                 },
                 {
-                  "\u003e": [
+                  ">": [
                     {
                       "var": "payload.amount"
                     },
@@ -50574,7 +50574,7 @@
                   ]
                 },
                 {
-                  "\u003e": [
+                  ">": [
                     {
                       "var": "payload.amount"
                     },
@@ -50775,7 +50775,7 @@
                   ]
                 },
                 {
-                  "\u003e": [
+                  ">": [
                     {
                       "var": "payload.amount"
                     },
@@ -50961,7 +50961,7 @@
                   ]
                 },
                 {
-                  "\u003e": [
+                  ">": [
                     {
                       "var": "payload.amount"
                     },
@@ -51299,7 +51299,7 @@
                   ]
                 },
                 {
-                  "\u003e": [
+                  ">": [
                     {
                       "var": "payload.amount"
                     },
@@ -51758,7 +51758,7 @@
           },
           "stepId": {
             "type": "string",
-            "pattern": "/^[a-zA-Z0-9]+(?:[-_][a-zA-Z0-9]+)*$/",
+            "pattern": "/^[a-zA-Z0-9]+(?:[-_.][a-zA-Z0-9]+)*$/",
             "description": "Unique identifier for the step"
           },
           "name": {
@@ -51795,7 +51795,7 @@
           },
           "stepId": {
             "type": "string",
-            "pattern": "/^[a-zA-Z0-9]+(?:[-_][a-zA-Z0-9]+)*$/",
+            "pattern": "/^[a-zA-Z0-9]+(?:[-_.][a-zA-Z0-9]+)*$/",
             "description": "Unique identifier for the step"
           },
           "name": {
@@ -51832,7 +51832,7 @@
           },
           "stepId": {
             "type": "string",
-            "pattern": "/^[a-zA-Z0-9]+(?:[-_][a-zA-Z0-9]+)*$/",
+            "pattern": "/^[a-zA-Z0-9]+(?:[-_.][a-zA-Z0-9]+)*$/",
             "description": "Unique identifier for the step"
           },
           "name": {
@@ -51869,7 +51869,7 @@
           },
           "stepId": {
             "type": "string",
-            "pattern": "/^[a-zA-Z0-9]+(?:[-_][a-zA-Z0-9]+)*$/",
+            "pattern": "/^[a-zA-Z0-9]+(?:[-_.][a-zA-Z0-9]+)*$/",
             "description": "Unique identifier for the step"
           },
           "name": {
@@ -51906,7 +51906,7 @@
           },
           "stepId": {
             "type": "string",
-            "pattern": "/^[a-zA-Z0-9]+(?:[-_][a-zA-Z0-9]+)*$/",
+            "pattern": "/^[a-zA-Z0-9]+(?:[-_.][a-zA-Z0-9]+)*$/",
             "description": "Unique identifier for the step"
           },
           "name": {
@@ -51943,7 +51943,7 @@
           },
           "stepId": {
             "type": "string",
-            "pattern": "/^[a-zA-Z0-9]+(?:[-_][a-zA-Z0-9]+)*$/",
+            "pattern": "/^[a-zA-Z0-9]+(?:[-_.][a-zA-Z0-9]+)*$/",
             "description": "Unique identifier for the step"
           },
           "name": {
@@ -51980,7 +51980,7 @@
           },
           "stepId": {
             "type": "string",
-            "pattern": "/^[a-zA-Z0-9]+(?:[-_][a-zA-Z0-9]+)*$/",
+            "pattern": "/^[a-zA-Z0-9]+(?:[-_.][a-zA-Z0-9]+)*$/",
             "description": "Unique identifier for the step"
           },
           "name": {
@@ -52017,7 +52017,7 @@
           },
           "stepId": {
             "type": "string",
-            "pattern": "/^[a-zA-Z0-9]+(?:[-_][a-zA-Z0-9]+)*$/",
+            "pattern": "/^[a-zA-Z0-9]+(?:[-_.][a-zA-Z0-9]+)*$/",
             "description": "Unique identifier for the step"
           },
           "name": {
@@ -52054,7 +52054,7 @@
           },
           "stepId": {
             "type": "string",
-            "pattern": "/^[a-zA-Z0-9]+(?:[-_][a-zA-Z0-9]+)*$/",
+            "pattern": "/^[a-zA-Z0-9]+(?:[-_.][a-zA-Z0-9]+)*$/",
             "description": "Unique identifier for the step"
           },
           "name": {
@@ -52162,7 +52162,7 @@
           },
           "workflowId": {
             "type": "string",
-            "pattern": "/^[a-zA-Z0-9]+(?:[-_][a-zA-Z0-9]+)*$/",
+            "pattern": "/^[a-zA-Z0-9]+(?:[-_.][a-zA-Z0-9]+)*$/",
             "description": "Unique identifier for the workflow"
           },
           "steps": {
@@ -52518,7 +52518,7 @@
           },
           "workflowId": {
             "type": "string",
-            "pattern": "/^[a-zA-Z0-9]+(?:[-_][a-zA-Z0-9]+)*$/",
+            "pattern": "/^[a-zA-Z0-9]+(?:[-_.][a-zA-Z0-9]+)*$/",
             "description": "Custom workflow identifier for the duplicated workflow"
           },
           "tags": {
@@ -54609,10 +54609,15 @@
           "object": {
             "type": "object",
             "description": "Current preference state"
+          },
+          "subscriberId": {
+            "type": "string",
+            "description": "Subscriber ID"
           }
         },
         "required": [
-          "object"
+          "object",
+          "subscriberId"
         ]
       },
       "WebhookMessageDtoWebhookPayloadWrapper": {

package/src/funcs/environmentsGetTags.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get environment tags
+ * List environment tags
  *
  * @remarks
  * Retrieve all unique tags used in workflows within the specified environment. These tags can be used for filtering workflows.

package/src/funcs/topicsSubscriptionsGetSubscription.ts

@@ -26,10 +26,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get a topic subscription
+ * Retrieve a topic subscription
  *
  * @remarks
- * Get a subscription by its unique identifier for a topic.
+ * Retrieve a subscription by its unique identifier for a topic.
  */
 export function topicsSubscriptionsGetSubscription(
   client: NovuCore,

package/src/lib/config.ts

@@ -58,8 +58,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "3.12.0",
-  sdkVersion: "3.13.0",
-  genVersion: "2.801.2",
-  userAgent: "speakeasy-sdk/typescript 3.13.0 2.801.2 3.12.0 @novu/api",
+  openapiDocVersion: "3.13.0",
+  sdkVersion: "3.14.0",
+  genVersion: "2.836.5",
+  userAgent: "speakeasy-sdk/typescript 3.14.0 2.836.5 3.13.0 @novu/api",
 } as const;

package/src/sdk/environments.ts

@@ -14,7 +14,7 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class Environments extends ClientSDK {
   /**
-   * Get environment tags
+   * List environment tags
    *
    * @remarks
    * Retrieve all unique tags used in workflows within the specified environment. These tags can be used for filtering workflows.

package/src/sdk/subscriptions.ts

@@ -77,10 +77,10 @@ export class Subscriptions extends ClientSDK {
   }
 
   /**
-   * Get a topic subscription
+   * Retrieve a topic subscription
    *
    * @remarks
-   * Get a subscription by its unique identifier for a topic.
+   * Retrieve a subscription by its unique identifier for a topic.
    */
   async getSubscription(
     topicKey: string,