@novu/api 3.12.0 → 3.13.0

package/sources/json-development.json

@@ -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",
@@ -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.12.0",
     "contact": {
       "name": "Novu Support",
       "url": "https://discord.gg/novu",
@@ -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": {

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/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.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",
 } as const;

package/src/lib/sdks.ts

@@ -304,9 +304,9 @@ export class ClientSDK {
   }
 }
 
-const jsonLikeContentTypeRE = /(application|text)\/.*?\+*json.*/;
+const jsonLikeContentTypeRE = /^(application|text)\/([^+]+\+)*json.*/;
 const jsonlLikeContentTypeRE =
-  /(application|text)\/(.*?\+*\bjsonl\b.*|.*?\+*\bx-ndjson\b.*)/;
+  /^(application|text)\/([^+]+\+)*(jsonl|x-ndjson)\b.*/;
 async function logRequest(logger: Logger | undefined, req: Request) {
   if (!logger) {
     return;

package/src/models/components/activitynotificationjobresponsedto.ts

@@ -50,7 +50,7 @@ export type ActivityNotificationJobResponseDtoType = ClosedEnum<
 /**
  * Optional payload for the job
  */
-export type ActivityNotificationJobResponseDtoPayload = {};
+export type Payload = {};
 
 export type ActivityNotificationJobResponseDto = {
   /**
@@ -80,7 +80,7 @@ export type ActivityNotificationJobResponseDto = {
   /**
    * Optional payload for the job
    */
-  payload?: ActivityNotificationJobResponseDtoPayload | undefined;
+  payload?: Payload | undefined;
   /**
    * Provider ID of the job
    */
@@ -106,25 +106,16 @@ export const ActivityNotificationJobResponseDtoType$inboundSchema:
   );
 
 /** @internal */
-export const ActivityNotificationJobResponseDtoPayload$inboundSchema: z.ZodType<
-  ActivityNotificationJobResponseDtoPayload,
-  z.ZodTypeDef,
-  unknown
-> = z.object({});
+export const Payload$inboundSchema: z.ZodType<Payload, z.ZodTypeDef, unknown> =
+  z.object({});
 
-export function activityNotificationJobResponseDtoPayloadFromJSON(
+export function payloadFromJSON(
   jsonString: string,
-): SafeParseResult<
-  ActivityNotificationJobResponseDtoPayload,
-  SDKValidationError
-> {
+): SafeParseResult<Payload, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) =>
-      ActivityNotificationJobResponseDtoPayload$inboundSchema.parse(
-        JSON.parse(x),
-      ),
-    `Failed to parse 'ActivityNotificationJobResponseDtoPayload' from JSON`,
+    (x) => Payload$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Payload' from JSON`,
   );
 }
 
@@ -142,8 +133,7 @@ export const ActivityNotificationJobResponseDto$inboundSchema: z.ZodType<
   ),
   step: ActivityNotificationStepResponseDto$inboundSchema,
   overrides: z.record(z.any()).optional(),
-  payload: z.lazy(() => ActivityNotificationJobResponseDtoPayload$inboundSchema)
-    .optional(),
+  payload: z.lazy(() => Payload$inboundSchema).optional(),
   providerId: ProvidersIdEnum$inboundSchema,
   status: z.string(),
   updatedAt: z.string().optional(),

package/src/models/components/bulkupdatesubscriberpreferencesdto.ts

@@ -9,16 +9,75 @@ import {
   BulkUpdateSubscriberPreferenceItemDto$outboundSchema,
 } from "./bulkupdatesubscriberpreferenceitemdto.js";
 
+/**
+ * Rich context object with id and optional data
+ */
+export type Context2 = {
+  id: string;
+  /**
+   * Optional additional context data
+   */
+  data?: { [k: string]: any } | undefined;
+};
+
+export type BulkUpdateSubscriberPreferencesDtoContext = Context2 | string;
+
 export type BulkUpdateSubscriberPreferencesDto = {
   /**
    * Array of workflow preferences to update (maximum 100 items)
    */
   preferences: Array<BulkUpdateSubscriberPreferenceItemDto>;
+  context?: { [k: string]: Context2 | string } | undefined;
 };
 
+/** @internal */
+export type Context2$Outbound = {
+  id: string;
+  data?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const Context2$outboundSchema: z.ZodType<
+  Context2$Outbound,
+  z.ZodTypeDef,
+  Context2
+> = z.object({
+  id: z.string(),
+  data: z.record(z.any()).optional(),
+});
+
+export function context2ToJSON(context2: Context2): string {
+  return JSON.stringify(Context2$outboundSchema.parse(context2));
+}
+
+/** @internal */
+export type BulkUpdateSubscriberPreferencesDtoContext$Outbound =
+  | Context2$Outbound
+  | string;
+
+/** @internal */
+export const BulkUpdateSubscriberPreferencesDtoContext$outboundSchema:
+  z.ZodType<
+    BulkUpdateSubscriberPreferencesDtoContext$Outbound,
+    z.ZodTypeDef,
+    BulkUpdateSubscriberPreferencesDtoContext
+  > = z.union([z.lazy(() => Context2$outboundSchema), z.string()]);
+
+export function bulkUpdateSubscriberPreferencesDtoContextToJSON(
+  bulkUpdateSubscriberPreferencesDtoContext:
+    BulkUpdateSubscriberPreferencesDtoContext,
+): string {
+  return JSON.stringify(
+    BulkUpdateSubscriberPreferencesDtoContext$outboundSchema.parse(
+      bulkUpdateSubscriberPreferencesDtoContext,
+    ),
+  );
+}
+
 /** @internal */
 export type BulkUpdateSubscriberPreferencesDto$Outbound = {
   preferences: Array<BulkUpdateSubscriberPreferenceItemDto$Outbound>;
+  context?: { [k: string]: Context2$Outbound | string } | undefined;
 };
 
 /** @internal */
@@ -28,6 +87,9 @@ export const BulkUpdateSubscriberPreferencesDto$outboundSchema: z.ZodType<
   BulkUpdateSubscriberPreferencesDto
 > = z.object({
   preferences: z.array(BulkUpdateSubscriberPreferenceItemDto$outboundSchema),
+  context: z.record(
+    z.union([z.lazy(() => Context2$outboundSchema), z.string()]),
+  ).optional(),
 });
 
 export function bulkUpdateSubscriberPreferencesDtoToJSON(