@novu/api 1.2.0 → 1.3.0

package/sources/json-development.json

@@ -1060,7 +1060,7 @@
         "operationId": "SubscribersController_getSubscriber",
         "x-speakeasy-name-override": "retrieve",
         "summary": "Retrieve a subscriber",
-        "description": "Retrive a subscriber by its unique key identifier **subscriberId**. \n    **subscriberId** field is required.",
+        "description": "Retrieve a subscriber by its unique key identifier **subscriberId**. \n    **subscriberId** field is required.",
         "parameters": [
           {
             "name": "subscriberId",
@@ -2033,8 +2033,8 @@
       "delete": {
         "operationId": "SubscribersController_removeSubscriber",
         "x-speakeasy-name-override": "delete",
-        "summary": "Delete subscriber",
-        "description": "Deletes a subscriber entity from the Novu platform along with associated messages, preferences, and topic subscriptions",
+        "summary": "Delete a subscriber",
+        "description": "Deletes a subscriber entity from the Novu platform along with associated messages, preferences, and topic subscriptions. \n      **subscriberId** is a required field.",
         "parameters": [
           {
             "name": "subscriberId",
@@ -6580,7 +6580,7 @@
         "operationId": "TopicsController_listTopicSubscriptions",
         "x-speakeasy-group": "Topics.Subscriptions",
         "summary": "List topic subscriptions",
-        "description": "List all topics that a subscriber is subscribed to.\n    Checkout all available filters in the query section.",
+        "description": "List all subscriptions of subscribers for a topic.\n    Checkout all available filters in the query section.",
         "parameters": [
           {
             "name": "topicKey",
@@ -8182,7 +8182,7 @@
             }
           },
           "400": {
-            "description": "Bad Request",
+            "description": "Payload validation failed - returned when payload does not match the workflow schema",
             "headers": {
               "Content-Type": {
                 "$ref": "#/components/headers/Content-Type"
@@ -8209,7 +8209,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/ErrorDto"
+                  "$ref": "#/components/schemas/PayloadValidationExceptionDto"
                 }
               }
             }
@@ -9193,7 +9193,7 @@
             }
           },
           "400": {
-            "description": "Bad Request",
+            "description": "Payload validation failed - returned when payload does not match the workflow schema",
             "headers": {
               "Content-Type": {
                 "$ref": "#/components/headers/Content-Type"
@@ -9220,7 +9220,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/ErrorDto"
+                  "$ref": "#/components/schemas/PayloadValidationExceptionDto"
                 }
               }
             }
@@ -9686,7 +9686,7 @@
             }
           },
           "400": {
-            "description": "Bad Request",
+            "description": "Payload validation failed - returned when any event payload does not match the workflow schema",
             "headers": {
               "Content-Type": {
                 "$ref": "#/components/headers/Content-Type"
@@ -9713,7 +9713,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/ErrorDto"
+                  "$ref": "#/components/schemas/PayloadValidationExceptionDto"
                 }
               }
             }
@@ -21499,6 +21499,195 @@
           "color"
         ]
       },
+      "PayloadValidationErrorDto": {
+        "type": "object",
+        "properties": {
+          "field": {
+            "type": "string",
+            "description": "Field path that failed validation",
+            "example": "user.name"
+          },
+          "message": {
+            "type": "string",
+            "description": "Validation error message",
+            "example": "must have required property 'name'"
+          },
+          "value": {
+            "description": "The actual value that failed validation",
+            "oneOf": [
+              {
+                "type": "string",
+                "nullable": true
+              },
+              {
+                "type": "number"
+              },
+              {
+                "type": "boolean"
+              },
+              {
+                "type": "object",
+                "nullable": true
+              },
+              {
+                "type": "array",
+                "items": {
+                  "anyOf": [
+                    {
+                      "type": "string",
+                      "nullable": true
+                    },
+                    {
+                      "type": "number"
+                    },
+                    {
+                      "type": "boolean"
+                    },
+                    {
+                      "type": "object",
+                      "additionalProperties": true
+                    }
+                  ]
+                }
+              }
+            ],
+            "example": {
+              "age": 25
+            }
+          },
+          "schemaPath": {
+            "type": "string",
+            "description": "JSON Schema path where the validation failed",
+            "example": "#/required"
+          }
+        },
+        "required": [
+          "field",
+          "message"
+        ]
+      },
+      "PayloadValidationExceptionDto": {
+        "type": "object",
+        "properties": {
+          "statusCode": {
+            "type": "number",
+            "description": "HTTP status code of the error response.",
+            "example": 404
+          },
+          "timestamp": {
+            "type": "string",
+            "description": "Timestamp of when the error occurred.",
+            "example": "2024-12-12T13:00:00Z"
+          },
+          "path": {
+            "type": "string",
+            "description": "The path where the error occurred.",
+            "example": "/api/v1/resource"
+          },
+          "message": {
+            "description": "Value that failed validation",
+            "oneOf": [
+              {
+                "type": "string",
+                "nullable": true
+              },
+              {
+                "type": "number"
+              },
+              {
+                "type": "boolean"
+              },
+              {
+                "type": "object",
+                "nullable": true
+              },
+              {
+                "type": "array",
+                "items": {
+                  "anyOf": [
+                    {
+                      "type": "string",
+                      "nullable": true
+                    },
+                    {
+                      "type": "number"
+                    },
+                    {
+                      "type": "boolean"
+                    },
+                    {
+                      "type": "object",
+                      "additionalProperties": true
+                    }
+                  ]
+                }
+              }
+            ],
+            "example": "xx xx xx "
+          },
+          "ctx": {
+            "type": "object",
+            "description": "Optional context object for additional error details.",
+            "additionalProperties": true,
+            "example": {
+              "workflowId": "some_wf_id",
+              "stepId": "some_wf_id"
+            }
+          },
+          "errorId": {
+            "type": "string",
+            "description": "Optional unique identifier for the error, useful for tracking using Sentry and \n      New Relic, only available for 500.",
+            "example": "abc123"
+          },
+          "type": {
+            "type": "string",
+            "description": "Type identifier for payload validation errors",
+            "example": "PAYLOAD_VALIDATION_ERROR"
+          },
+          "errors": {
+            "description": "Array of detailed validation errors",
+            "example": [
+              {
+                "field": "user.name",
+                "message": "must have required property 'name'",
+                "value": {
+                  "age": 25
+                },
+                "schemaPath": "#/required"
+              }
+            ],
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/PayloadValidationErrorDto"
+            }
+          },
+          "schema": {
+            "type": "object",
+            "description": "The JSON schema that was used for validation",
+            "example": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "type": "string"
+                },
+                "age": {
+                  "type": "number"
+                }
+              },
+              "required": [
+                "name"
+              ]
+            }
+          }
+        },
+        "required": [
+          "statusCode",
+          "timestamp",
+          "path",
+          "type",
+          "errors"
+        ]
+      },
       "TriggerEventResponseDto": {
         "type": "object",
         "properties": {
@@ -23111,10 +23300,6 @@
           "credentials": {
             "$ref": "#/components/schemas/CredentialsDto"
           },
-          "removeNovuBranding": {
-            "type": "boolean",
-            "description": "If true, the Novu branding will be removed from the Inbox component"
-          },
           "check": {
             "type": "boolean"
           },
@@ -23897,7 +24082,6 @@
           "_id",
           "_templateId",
           "_environmentId",
-          "_messageTemplateId",
           "_organizationId",
           "_notificationId",
           "_subscriberId",
@@ -26094,6 +26278,20 @@
             "type": "string",
             "description": "Timestamp of the last workflow trigger",
             "nullable": true
+          },
+          "payloadSchema": {
+            "type": "object",
+            "description": "The payload JSON Schema for the workflow",
+            "nullable": true
+          },
+          "payloadExample": {
+            "type": "object",
+            "description": "Generated payload example based on the payload schema",
+            "nullable": true
+          },
+          "validatePayload": {
+            "type": "boolean",
+            "description": "Whether payload schema validation is enabled"
           }
         },
         "required": [
@@ -26743,6 +26941,12 @@
               }
             ]
           },
+          "schema": {
+            "type": "object",
+            "nullable": true,
+            "description": "The payload schema that was used to generate the preview payload example",
+            "additionalProperties": true
+          },
           "result": {
             "description": "Preview result",
             "oneOf": [
@@ -26893,6 +27097,14 @@
             "items": {
               "type": "string"
             }
+          },
+          "payloadSchema": {
+            "type": "object",
+            "description": "The payload JSON Schema for the workflow"
+          },
+          "validatePayload": {
+            "type": "boolean",
+            "description": "Enable or disable payload schema validation"
           }
         }
       },
@@ -27203,37 +27415,6 @@
           "payload"
         ]
       },
-      "GetWebhookPortalTokenResponseDto": {
-        "type": "object",
-        "properties": {
-          "url": {
-            "type": "string"
-          },
-          "token": {
-            "type": "string"
-          },
-          "appId": {
-            "type": "string"
-          }
-        },
-        "required": [
-          "url",
-          "token",
-          "appId"
-        ]
-      },
-      "CreateWebhookPortalResponseDto": {
-        "type": "object",
-        "properties": {
-          "appId": {
-            "type": "string",
-            "description": "The webhook portal application ID"
-          }
-        },
-        "required": [
-          "appId"
-        ]
-      },
       "WebhookUpdatedWorkflowDto": {
         "type": "object",
         "properties": {

package/src/funcs/cancel.ts

@@ -41,9 +41,7 @@ export function cancel(
   Result<
     operations.EventsControllerCancelResponse,
     | errors.ErrorDto
-    | errors.ErrorDto
     | errors.ValidationErrorDto
-    | errors.ErrorDto
     | SDKError
     | SDKValidationError
     | UnexpectedClientError
@@ -71,9 +69,7 @@ async function $do(
     Result<
       operations.EventsControllerCancelResponse,
       | errors.ErrorDto
-      | errors.ErrorDto
       | errors.ValidationErrorDto
-      | errors.ErrorDto
       | SDKError
       | SDKValidationError
       | UnexpectedClientError
@@ -125,6 +121,7 @@ async function $do(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "EventsController_cancel",
     oAuth2Scopes: [],
@@ -155,6 +152,7 @@ async function $do(
     path: path,
     headers: headers,
     body: body,
+    userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
@@ -196,9 +194,7 @@ async function $do(
   const [result] = await M.match<
     operations.EventsControllerCancelResponse,
     | errors.ErrorDto
-    | errors.ErrorDto
     | errors.ValidationErrorDto
-    | errors.ErrorDto
     | SDKError
     | SDKValidationError
     | UnexpectedClientError

package/src/funcs/integrationsCreate.ts

@@ -41,9 +41,7 @@ export function integrationsCreate(
   Result<
     operations.IntegrationsControllerCreateIntegrationResponse,
     | errors.ErrorDto
-    | errors.ErrorDto
     | errors.ValidationErrorDto
-    | errors.ErrorDto
     | SDKError
     | SDKValidationError
     | UnexpectedClientError
@@ -71,9 +69,7 @@ async function $do(
     Result<
       operations.IntegrationsControllerCreateIntegrationResponse,
       | errors.ErrorDto
-      | errors.ErrorDto
       | errors.ValidationErrorDto
-      | errors.ErrorDto
       | SDKError
       | SDKValidationError
       | UnexpectedClientError
@@ -122,6 +118,7 @@ async function $do(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "IntegrationsController_createIntegration",
     oAuth2Scopes: [],
@@ -152,6 +149,7 @@ async function $do(
     path: path,
     headers: headers,
     body: body,
+    userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
@@ -193,9 +191,7 @@ async function $do(
   const [result] = await M.match<
     operations.IntegrationsControllerCreateIntegrationResponse,
     | errors.ErrorDto
-    | errors.ErrorDto
     | errors.ValidationErrorDto
-    | errors.ErrorDto
     | SDKError
     | SDKValidationError
     | UnexpectedClientError

package/src/funcs/integrationsDelete.ts

@@ -40,9 +40,7 @@ export function integrationsDelete(
   Result<
     operations.IntegrationsControllerRemoveIntegrationResponse,
     | errors.ErrorDto
-    | errors.ErrorDto
     | errors.ValidationErrorDto
-    | errors.ErrorDto
     | SDKError
     | SDKValidationError
     | UnexpectedClientError
@@ -70,9 +68,7 @@ async function $do(
     Result<
       operations.IntegrationsControllerRemoveIntegrationResponse,
       | errors.ErrorDto
-      | errors.ErrorDto
       | errors.ValidationErrorDto
-      | errors.ErrorDto
       | SDKError
       | SDKValidationError
       | UnexpectedClientError
@@ -125,6 +121,7 @@ async function $do(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "IntegrationsController_removeIntegration",
     oAuth2Scopes: [],
@@ -155,6 +152,7 @@ async function $do(
     path: path,
     headers: headers,
     body: body,
+    userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
@@ -196,9 +194,7 @@ async function $do(
   const [result] = await M.match<
     operations.IntegrationsControllerRemoveIntegrationResponse,
     | errors.ErrorDto
-    | errors.ErrorDto
     | errors.ValidationErrorDto
-    | errors.ErrorDto
     | SDKError
     | SDKValidationError
     | UnexpectedClientError

package/src/funcs/integrationsList.ts

@@ -38,9 +38,7 @@ export function integrationsList(
   Result<
     operations.IntegrationsControllerListIntegrationsResponse,
     | errors.ErrorDto
-    | errors.ErrorDto
     | errors.ValidationErrorDto
-    | errors.ErrorDto
     | SDKError
     | SDKValidationError
     | UnexpectedClientError
@@ -66,9 +64,7 @@ async function $do(
     Result<
       operations.IntegrationsControllerListIntegrationsResponse,
       | errors.ErrorDto
-      | errors.ErrorDto
       | errors.ValidationErrorDto
-      | errors.ErrorDto
       | SDKError
       | SDKValidationError
       | UnexpectedClientError
@@ -113,6 +109,7 @@ async function $do(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "IntegrationsController_listIntegrations",
     oAuth2Scopes: [],
@@ -143,6 +140,7 @@ async function $do(
     path: path,
     headers: headers,
     body: body,
+    userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
@@ -184,9 +182,7 @@ async function $do(
   const [result] = await M.match<
     operations.IntegrationsControllerListIntegrationsResponse,
     | errors.ErrorDto
-    | errors.ErrorDto
     | errors.ValidationErrorDto
-    | errors.ErrorDto
     | SDKError
     | SDKValidationError
     | UnexpectedClientError

package/src/funcs/integrationsListActive.ts

@@ -38,9 +38,7 @@ export function integrationsListActive(
   Result<
     operations.IntegrationsControllerGetActiveIntegrationsResponse,
     | errors.ErrorDto
-    | errors.ErrorDto
     | errors.ValidationErrorDto
-    | errors.ErrorDto
     | SDKError
     | SDKValidationError
     | UnexpectedClientError
@@ -66,9 +64,7 @@ async function $do(
     Result<
       operations.IntegrationsControllerGetActiveIntegrationsResponse,
       | errors.ErrorDto
-      | errors.ErrorDto
       | errors.ValidationErrorDto
-      | errors.ErrorDto
       | SDKError
       | SDKValidationError
       | UnexpectedClientError
@@ -114,6 +110,7 @@ async function $do(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "IntegrationsController_getActiveIntegrations",
     oAuth2Scopes: [],
@@ -144,6 +141,7 @@ async function $do(
     path: path,
     headers: headers,
     body: body,
+    userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
@@ -185,9 +183,7 @@ async function $do(
   const [result] = await M.match<
     operations.IntegrationsControllerGetActiveIntegrationsResponse,
     | errors.ErrorDto
-    | errors.ErrorDto
     | errors.ValidationErrorDto
-    | errors.ErrorDto
     | SDKError
     | SDKValidationError
     | UnexpectedClientError

package/src/funcs/integrationsSetAsPrimary.ts

@@ -41,9 +41,7 @@ export function integrationsSetAsPrimary(
   Result<
     operations.IntegrationsControllerSetIntegrationAsPrimaryResponse,
     | errors.ErrorDto
-    | errors.ErrorDto
     | errors.ValidationErrorDto
-    | errors.ErrorDto
     | SDKError
     | SDKValidationError
     | UnexpectedClientError
@@ -71,9 +69,7 @@ async function $do(
     Result<
       operations.IntegrationsControllerSetIntegrationAsPrimaryResponse,
       | errors.ErrorDto
-      | errors.ErrorDto
       | errors.ValidationErrorDto
-      | errors.ErrorDto
       | SDKError
       | SDKValidationError
       | UnexpectedClientError
@@ -130,6 +126,7 @@ async function $do(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "IntegrationsController_setIntegrationAsPrimary",
     oAuth2Scopes: [],
@@ -160,6 +157,7 @@ async function $do(
     path: path,
     headers: headers,
     body: body,
+    userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
@@ -201,9 +199,7 @@ async function $do(
   const [result] = await M.match<
     operations.IntegrationsControllerSetIntegrationAsPrimaryResponse,
     | errors.ErrorDto
-    | errors.ErrorDto
     | errors.ValidationErrorDto
-    | errors.ErrorDto
     | SDKError
     | SDKValidationError
     | UnexpectedClientError

package/src/funcs/integrationsUpdate.ts

@@ -42,9 +42,7 @@ export function integrationsUpdate(
   Result<
     operations.IntegrationsControllerUpdateIntegrationByIdResponse,
     | errors.ErrorDto
-    | errors.ErrorDto
     | errors.ValidationErrorDto
-    | errors.ErrorDto
     | SDKError
     | SDKValidationError
     | UnexpectedClientError
@@ -74,9 +72,7 @@ async function $do(
     Result<
       operations.IntegrationsControllerUpdateIntegrationByIdResponse,
       | errors.ErrorDto
-      | errors.ErrorDto
       | errors.ValidationErrorDto
-      | errors.ErrorDto
       | SDKError
       | SDKValidationError
       | UnexpectedClientError
@@ -134,6 +130,7 @@ async function $do(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "IntegrationsController_updateIntegrationById",
     oAuth2Scopes: [],
@@ -164,6 +161,7 @@ async function $do(
     path: path,
     headers: headers,
     body: body,
+    userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
@@ -205,9 +203,7 @@ async function $do(
   const [result] = await M.match<
     operations.IntegrationsControllerUpdateIntegrationByIdResponse,
     | errors.ErrorDto
-    | errors.ErrorDto
     | errors.ValidationErrorDto
-    | errors.ErrorDto
     | SDKError
     | SDKValidationError
     | UnexpectedClientError