@novu/api 3.12.0 → 3.14.0

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": [
           {
@@ -3023,7 +3023,9 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/"
+                "type": "object",
+                "additionalProperties": true,
+                "description": "Generic webhook payload from delivery providers"
               }
             }
           }
@@ -9506,6 +9508,21 @@
               "type": "string"
             }
           },
+          {
+            "name": "contextKeys",
+            "required": false,
+            "in": "query",
+            "description": "Context keys for filtering preferences (e.g., [\"tenant:acme\"])",
+            "example": [
+              "tenant:acme"
+            ],
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          },
           {
             "name": "idempotency-key",
             "in": "header",
@@ -11052,6 +11069,22 @@
               "type": "string"
             }
           },
+          {
+            "name": "contextKeys",
+            "required": false,
+            "in": "query",
+            "description": "Filter by exact context keys, order insensitive (format: \"type:id\")",
+            "example": [
+              "tenant:org-123",
+              "region:us-east-1"
+            ],
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          },
           {
             "name": "idempotency-key",
             "in": "header",
@@ -14146,6 +14179,22 @@
               "type": "string"
             }
           },
+          {
+            "name": "contextKeys",
+            "required": false,
+            "in": "query",
+            "description": "Filter by exact context keys, order insensitive (format: \"type:id\")",
+            "example": [
+              "tenant:org-123",
+              "region:us-east-1"
+            ],
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          },
           {
             "name": "idempotency-key",
             "in": "header",
@@ -15608,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",
@@ -15668,7 +15717,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/SubscriptionResponseDto"
+                  "$ref": "#/components/schemas/SubscriptionDetailsResponseDto"
                 }
               }
             }
@@ -42088,7 +42137,7 @@
   "info": {
     "title": "Novu API",
     "description": "Novu REST API. Please see https://docs.novu.co/api-reference for more details.",
-    "version": "3.11.0",
+    "version": "3.13.0",
     "contact": {
       "name": "Novu Support",
       "url": "https://discord.gg/novu",
@@ -42179,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"
       }
     },
@@ -43313,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": {
@@ -46061,7 +46110,8 @@
         "properties": {
           "payload": {
             "type": "object",
-            "description": "Payload of the action result"
+            "description": "Payload of the action result",
+            "additionalProperties": true
           },
           "type": {
             "$ref": "#/components/schemas/ButtonTypeEnum"
@@ -47148,11 +47198,13 @@
           },
           "payload": {
             "type": "object",
-            "description": "The payload that was used to send the notification trigger"
+            "description": "The payload that was used to send the notification trigger",
+            "additionalProperties": true
           },
           "overrides": {
             "type": "object",
-            "description": "Provider specific overrides used when triggering the notification"
+            "description": "Provider specific overrides used when triggering the notification",
+            "additionalProperties": true
           },
           "contextKeys": {
             "description": "Context (single or multi) in which the message was sent",
@@ -47735,6 +47787,10 @@
                 "$ref": "#/components/schemas/SubscriberPreferencesWorkflowInfoDto"
               }
             ]
+          },
+          "updatedAt": {
+            "type": "string",
+            "description": "Timestamp when the subscriber last updated their preference. Only present if subscriber explicitly set preferences."
           }
         },
         "required": [
@@ -47926,6 +47982,40 @@
             "items": {
               "$ref": "#/components/schemas/BulkUpdateSubscriberPreferenceItemDto"
             }
+          },
+          "context": {
+            "type": "object",
+            "additionalProperties": {
+              "oneOf": [
+                {
+                  "type": "string",
+                  "description": "Simple context id",
+                  "example": "org-acme"
+                },
+                {
+                  "type": "object",
+                  "description": "Rich context object with id and optional data",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "example": "org-acme"
+                    },
+                    "data": {
+                      "type": "object",
+                      "description": "Optional additional context data",
+                      "additionalProperties": true,
+                      "example": {
+                        "name": "Acme Corp",
+                        "region": "us-east-1"
+                      }
+                    }
+                  },
+                  "required": [
+                    "id"
+                  ]
+                }
+              ]
+            }
           }
         },
         "required": [
@@ -47954,6 +48044,40 @@
                 "$ref": "#/components/schemas/ScheduleDto"
               }
             ]
+          },
+          "context": {
+            "type": "object",
+            "additionalProperties": {
+              "oneOf": [
+                {
+                  "type": "string",
+                  "description": "Simple context id",
+                  "example": "org-acme"
+                },
+                {
+                  "type": "object",
+                  "description": "Rich context object with id and optional data",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "example": "org-acme"
+                    },
+                    "data": {
+                      "type": "object",
+                      "description": "Optional additional context data",
+                      "additionalProperties": true,
+                      "example": {
+                        "name": "Acme Corp",
+                        "region": "us-east-1"
+                      }
+                    }
+                  },
+                  "required": [
+                    "id"
+                  ]
+                }
+              ]
+            }
           }
         }
       },
@@ -48033,6 +48157,17 @@
                 "$ref": "#/components/schemas/SubscriberDto"
               }
             ]
+          },
+          "contextKeys": {
+            "description": "Context keys that scope this subscription (e.g., tenant:org-a, project:proj-123)",
+            "example": [
+              "tenant:org-a",
+              "project:proj-123"
+            ],
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
           }
         },
         "required": [
@@ -48989,6 +49124,17 @@
               "$ref": "#/components/schemas/SubscriptionPreferenceDto"
             }
           },
+          "contextKeys": {
+            "description": "Context keys that scope this subscription (e.g., tenant:org-a, project:proj-123)",
+            "example": [
+              "tenant:org-a",
+              "project:proj-123"
+            ],
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
           "createdAt": {
             "type": "string",
             "description": "The creation date of the subscription",
@@ -49257,6 +49403,40 @@
             "description": "The name of the topic",
             "example": "My Topic"
           },
+          "context": {
+            "type": "object",
+            "additionalProperties": {
+              "oneOf": [
+                {
+                  "type": "string",
+                  "description": "Simple context id",
+                  "example": "org-acme"
+                },
+                {
+                  "type": "object",
+                  "description": "Rich context object with id and optional data",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "example": "org-acme"
+                    },
+                    "data": {
+                      "type": "object",
+                      "description": "Optional additional context data",
+                      "additionalProperties": true,
+                      "example": {
+                        "name": "Acme Corp",
+                        "region": "us-east-1"
+                      }
+                    }
+                  },
+                  "required": [
+                    "id"
+                  ]
+                }
+              ]
+            }
+          },
           "preferences": {
             "type": "array",
             "description": "The preferences of the topic. Can be a simple workflow ID string, workflow preference object, or group filter object",
@@ -49319,6 +49499,17 @@
               }
             ]
           },
+          "contextKeys": {
+            "description": "Context keys that scope this subscription (e.g., tenant:org-a, project:proj-123)",
+            "example": [
+              "tenant:org-a",
+              "project:proj-123"
+            ],
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
           "createdAt": {
             "type": "string",
             "description": "The creation date of the subscription",
@@ -49452,6 +49643,47 @@
           }
         }
       },
+      "SubscriptionDetailsResponseDto": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "The unique identifier of the subscription",
+            "example": "64f5e95d3d7946d80d0cb679"
+          },
+          "identifier": {
+            "type": "string",
+            "description": "The identifier of the subscription",
+            "example": "subscription-identifier"
+          },
+          "name": {
+            "type": "string",
+            "description": "The name of the subscription",
+            "example": "My Subscription"
+          },
+          "preferences": {
+            "description": "The preferences/rules for the subscription",
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/SubscriptionPreferenceDto"
+            }
+          },
+          "contextKeys": {
+            "description": "Context keys that scope this subscription (e.g., tenant:org-a, project:proj-123)",
+            "example": [
+              "tenant:org-a",
+              "project:proj-123"
+            ],
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        },
+        "required": [
+          "id"
+        ]
+      },
       "UpdateTopicSubscriptionRequestDto": {
         "type": "object",
         "properties": {
@@ -49716,7 +49948,7 @@
                   ]
                 },
                 {
-                  "\u003e": [
+                  ">": [
                     {
                       "var": "payload.amount"
                     },
@@ -49894,7 +50126,7 @@
                   ]
                 },
                 {
-                  "\u003e": [
+                  ">": [
                     {
                       "var": "payload.amount"
                     },
@@ -50042,7 +50274,7 @@
                   ]
                 },
                 {
-                  "\u003e": [
+                  ">": [
                     {
                       "var": "payload.amount"
                     },
@@ -50194,7 +50426,7 @@
                   ]
                 },
                 {
-                  "\u003e": [
+                  ">": [
                     {
                       "var": "payload.amount"
                     },
@@ -50342,7 +50574,7 @@
                   ]
                 },
                 {
-                  "\u003e": [
+                  ">": [
                     {
                       "var": "payload.amount"
                     },
@@ -50543,7 +50775,7 @@
                   ]
                 },
                 {
-                  "\u003e": [
+                  ">": [
                     {
                       "var": "payload.amount"
                     },
@@ -50729,7 +50961,7 @@
                   ]
                 },
                 {
-                  "\u003e": [
+                  ">": [
                     {
                       "var": "payload.amount"
                     },
@@ -51067,7 +51299,7 @@
                   ]
                 },
                 {
-                  "\u003e": [
+                  ">": [
                     {
                       "var": "payload.amount"
                     },
@@ -51526,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": {
@@ -51563,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": {
@@ -51600,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": {
@@ -51637,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": {
@@ -51674,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": {
@@ -51711,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": {
@@ -51748,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": {
@@ -51785,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": {
@@ -51822,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": {
@@ -51930,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": {
@@ -52286,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": {
@@ -54377,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/subscribersPreferencesList.ts

@@ -34,9 +34,7 @@ import { Result } from "../types/fp.js";
  */
 export function subscribersPreferencesList(
   client: NovuCore,
-  subscriberId: string,
-  criticality?: operations.Criticality | undefined,
-  idempotencyKey?: string | undefined,
+  request: operations.SubscribersControllerGetSubscriberPreferencesRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
@@ -55,18 +53,14 @@ export function subscribersPreferencesList(
 > {
   return new APIPromise($do(
     client,
-    subscriberId,
-    criticality,
-    idempotencyKey,
+    request,
     options,
   ));
 }
 
 async function $do(
   client: NovuCore,
-  subscriberId: string,
-  criticality?: operations.Criticality | undefined,
-  idempotencyKey?: string | undefined,
+  request: operations.SubscribersControllerGetSubscriberPreferencesRequest,
   options?: RequestOptions,
 ): Promise<
   [
@@ -86,15 +80,8 @@ async function $do(
     APICall,
   ]
 > {
-  const input: operations.SubscribersControllerGetSubscriberPreferencesRequest =
-    {
-      subscriberId: subscriberId,
-      criticality: criticality,
-      idempotencyKey: idempotencyKey,
-    };
-
   const parsed = safeParse(
-    input,
+    request,
     (value) =>
       operations
         .SubscribersControllerGetSubscriberPreferencesRequest$outboundSchema
@@ -119,6 +106,7 @@ async function $do(
   );
 
   const query = encodeFormQuery({
+    "contextKeys": payload.contextKeys,
     "criticality": payload.criticality,
   });
 

package/src/funcs/subscribersTopicsList.ts

@@ -107,6 +107,7 @@ async function $do(
   const query = encodeFormQuery({
     "after": payload.after,
     "before": payload.before,
+    "contextKeys": payload.contextKeys,
     "includeCursor": payload.includeCursor,
     "key": payload.key,
     "limit": payload.limit,

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/funcs/topicsSubscriptionsList.ts

@@ -105,6 +105,7 @@ async function $do(
   const query = encodeFormQuery({
     "after": payload.after,
     "before": payload.before,
+    "contextKeys": payload.contextKeys,
     "includeCursor": payload.includeCursor,
     "limit": payload.limit,
     "orderBy": payload.orderBy,

package/src/lib/config.ts

@@ -58,8 +58,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "3.11.0",
-  sdkVersion: "3.12.0",
-  genVersion: "2.792.0",
-  userAgent: "speakeasy-sdk/typescript 3.12.0 2.792.0 3.11.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;