@novu/api 2.6.6 → 3.11.0

package/README.md

@@ -1,18 +1,33 @@
-# @novu/api
+<!-- speakeasy-ignore-start -->
+
+<div align="center">
+  <a href="https://novu.co?utm_source=github" target="_blank">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/2233092/213641039-220ac15f-f367-4d13-9eaf-56e79433b8c1.png">
+    <img alt="Novu Logo" src="https://user-images.githubusercontent.com/2233092/213641043-3bbb3f21-3c53-4e67-afe5-755aeb222159.png" width="280"/>
+  </picture>
+  </a>
+</div>
 
-Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@novu/api* API.
+<br/>
 
-<div align="left">
-    <a href="https://www.speakeasy.com/?utm_source=@novu/api&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
-    <a href="https://opensource.org/licenses/MIT">
-        <img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
-    </a>
-</div>
+<p align="center">
+   <a href="https://www.producthunt.com/products/novu">
+    <img src="https://img.shields.io/badge/Product%20Hunt-Golden%20Kitty%20Award%202023-yellow" alt="Product Hunt">
+  </a>
+  <a href="https://news.ycombinator.com/item?id=38419513"><img src="https://img.shields.io/badge/Hacker%20News-%231-%23FF6600" alt="Hacker News"></a>
+  <a href="https://www.npmjs.com/package/@novu/node">
+    <img src="https://img.shields.io/npm/dm/@novu/node" alt="npm downloads">
+  </a>
+</p>
 
+<h1 align="center">The &lt;Inbox /&gt; infrastructure for modern products</h1>
+
+<div align="center">
+The notification platform that turns complex multi-channel delivery into a single <Inbox /> component. Built for developers, designed for growth, powered by open source.
+</div>
 
-<br /><br />
-> [!IMPORTANT]
-> This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/novu/novu). Delete this section before > publishing to a package manager.
+<!-- speakeasy-ignore-end -->
 
 <!-- Start Summary [summary] -->
 ## Summary
@@ -25,19 +40,16 @@ For more information about the API: [Novu Documentation](https://docs.novu.co)
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents
 <!-- $toc-max-depth=2 -->
-* [@novu/api](#novuapi)
   * [SDK Installation](#sdk-installation)
   * [Requirements](#requirements)
   * [SDK Example Usage](#sdk-example-usage)
-  * [Authentication](#authentication)
   * [Available Resources and Operations](#available-resources-and-operations)
   * [Standalone functions](#standalone-functions)
-  * [React hooks with TanStack Query](#react-hooks-with-tanstack-query)
-  * [Pagination](#pagination)
-  * [Retries](#retries)
   * [Error Handling](#error-handling)
   * [Server Selection](#server-selection)
   * [Custom HTTP Client](#custom-http-client)
+  * [Authentication](#authentication)
+  * [Retries](#retries)
   * [Debugging](#debugging)
 * [Development](#development)
   * [Maturity](#maturity)
@@ -48,45 +60,30 @@ For more information about the API: [Novu Documentation](https://docs.novu.co)
 <!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
-> [!TIP]
-> To finish publishing your SDK to npm and others you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
-
-
 The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
 
 ### NPM
 
 ```bash
-npm add <UNSET>
-# Install optional peer dependencies if you plan to use React hooks
-npm add @tanstack/react-query react react-dom
+npm add @novu/api
 ```
 
 ### PNPM
 
 ```bash
-pnpm add <UNSET>
-# Install optional peer dependencies if you plan to use React hooks
-pnpm add @tanstack/react-query react react-dom
+pnpm add @novu/api
 ```
 
 ### Bun
 
 ```bash
-bun add <UNSET>
-# Install optional peer dependencies if you plan to use React hooks
-bun add @tanstack/react-query react react-dom
+bun add @novu/api
 ```
 
 ### Yarn
 
 ```bash
-yarn add <UNSET> zod
-# Install optional peer dependencies if you plan to use React hooks
-yarn add @tanstack/react-query react react-dom
-
-# Note that Yarn does not install peer dependencies automatically. You will need
-# to install zod as shown above.
+yarn add @novu/api
 ```
 <!-- End SDK Installation [installation] -->
 
@@ -105,9 +102,7 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  security: {
-    secretKey: "YOUR_SECRET_KEY_HERE",
-  },
+  secretKey: "YOUR_SECRET_KEY_HERE",
 });
 
 async function run() {
@@ -119,19 +114,14 @@ async function run() {
         "text": "string",
       },
     },
-    overrides: {
-      "fcm": {
-        "data": {
-          "key": "value",
-        },
-      },
-    },
-    to: {
-      subscriberId: "<id>",
+    overrides: {},
+    to: "SUBSCRIBER_ID",
+    actor: "<value>",
+    context: {
+      "key": "org-acme",
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -139,85 +129,18 @@ run();
 
 ```
 
-### Trigger Notification Events in Bulk
+### Cancel Triggered Event
 
 ```typescript
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  security: {
-    secretKey: "YOUR_SECRET_KEY_HERE",
-  },
+  secretKey: "YOUR_SECRET_KEY_HERE",
 });
 
 async function run() {
-  const result = await novu.triggerBulk({
-    events: [
-      {
-        workflowId: "workflow_identifier",
-        payload: {
-          "comment_id": "string",
-          "post": {
-            "text": "string",
-          },
-        },
-        overrides: {
-          "fcm": {
-            "data": {
-              "key": "value",
-            },
-          },
-        },
-        to: {
-          subscriberId: "<id>",
-        },
-      },
-      {
-        workflowId: "workflow_identifier",
-        payload: {
-          "comment_id": "string",
-          "post": {
-            "text": "string",
-          },
-        },
-        overrides: {
-          "fcm": {
-            "data": {
-              "key": "value",
-            },
-          },
-        },
-        to: [
-          {
-            topicKey: "<value>",
-            type: "Subscriber",
-          },
-        ],
-      },
-      {
-        workflowId: "workflow_identifier",
-        payload: {
-          "comment_id": "string",
-          "post": {
-            "text": "string",
-          },
-        },
-        overrides: {
-          "fcm": {
-            "data": {
-              "key": "value",
-            },
-          },
-        },
-        to: [
-          "SUBSCRIBER_ID",
-          "SUBSCRIBER_ID",
-        ],
-      },
-    ],
-  });
+  const result = await novu.cancel("<id>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -231,9 +154,7 @@ run();
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  security: {
-    secretKey: "YOUR_SECRET_KEY_HERE",
-  },
+  secretKey: "YOUR_SECRET_KEY_HERE",
 });
 
 async function run() {
@@ -245,9 +166,27 @@ async function run() {
         "text": "string",
       },
     },
+    overrides: {
+      additionalProperties: {
+        "fcm": {
+          "data": {
+            "key": "value",
+          },
+        },
+      },
+    },
+    actor: {
+      firstName: "John",
+      lastName: "Doe",
+      email: "john.doe@example.com",
+      phone: "+1234567890",
+      avatar: "https://example.com/avatar.jpg",
+      locale: "en-US",
+      timezone: "America/New_York",
+      subscriberId: "<id>",
+    },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -255,80 +194,61 @@ run();
 
 ```
 
-### Cancel Triggered Event
-
-```typescript
-import { Novu } from "@novu/api";
-
-const novu = new Novu({
-  security: {
-    secretKey: "YOUR_SECRET_KEY_HERE",
-  },
-});
-
-async function run() {
-  const result = await novu.cancel("<id>");
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-
-```
-<!-- End SDK Example Usage [usage] -->
-
-<!-- Start Authentication [security] -->
-## Authentication
-
-### Per-Client Security Schemes
-
-This SDK supports the following security schemes globally:
-
-| Name         | Type   | Scheme      |
-| ------------ | ------ | ----------- |
-| `secretKey`  | apiKey | API key     |
-| `bearerAuth` | http   | HTTP Bearer |
+### Trigger Notification Events in Bulk
 
-You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
 ```typescript
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  security: {
-    secretKey: "YOUR_SECRET_KEY_HERE",
-  },
+  secretKey: "YOUR_SECRET_KEY_HERE",
 });
 
 async function run() {
-  const result = await novu.trigger({
-    workflowId: "workflow_identifier",
-    payload: {
-      "comment_id": "string",
-      "post": {
-        "text": "string",
+  const result = await novu.triggerBulk({
+    events: [
+      {
+        workflowId: "workflow_identifier",
+        payload: {
+          "comment_id": "string",
+          "post": {
+            "text": "string",
+          },
+        },
+        overrides: {},
+        to: "SUBSCRIBER_ID",
       },
-    },
-    overrides: {
-      "fcm": {
-        "data": {
-          "key": "value",
+      {
+        workflowId: "workflow_identifier",
+        payload: {
+          "comment_id": "string",
+          "post": {
+            "text": "string",
+          },
         },
+        overrides: {},
+        to: "SUBSCRIBER_ID",
       },
-    },
-    to: {
-      subscriberId: "<id>",
-    },
+      {
+        workflowId: "workflow_identifier",
+        payload: {
+          "comment_id": "string",
+          "post": {
+            "text": "string",
+          },
+        },
+        overrides: {},
+        to: "SUBSCRIBER_ID",
+      },
+    ],
   });
 
-  // Handle the result
   console.log(result);
 }
 
 run();
 
 ```
-<!-- End Authentication [security] -->
+<!-- End SDK Example Usage [usage] -->
 
 <!-- Start Available Resources and Operations [operations] -->
 ## Available Resources and Operations
@@ -336,110 +256,154 @@ run();
 <details open>
 <summary>Available methods</summary>
 
-### [integrations](docs/sdks/integrations/README.md)
+### [activity](docs/sdks/activity/README.md)
+
+* [track](docs/sdks/activity/README.md#track) - Track activity and engagement events
 
-* [list](docs/sdks/integrations/README.md#list) - Get integrations
-* [create](docs/sdks/integrations/README.md#create) - Create integration
-* [listActive](docs/sdks/integrations/README.md#listactive) - Get active integrations
-* [update](docs/sdks/integrations/README.md#update) - Update integration
-* [delete](docs/sdks/integrations/README.md#delete) - Delete integration
-* [setAsPrimary](docs/sdks/integrations/README.md#setasprimary) - Set integration as primary
+### [contexts](docs/sdks/contexts/README.md)
 
-#### [integrations.webhooks](docs/sdks/webhooks/README.md)
+* [create](docs/sdks/contexts/README.md#create) - Create a context
+* [list](docs/sdks/contexts/README.md#list) - List all contexts
+* [update](docs/sdks/contexts/README.md#update) - Update a context
+* [retrieve](docs/sdks/contexts/README.md#retrieve) - Retrieve a context
+* [delete](docs/sdks/contexts/README.md#delete) - Delete a context
 
-* [retrieve](docs/sdks/webhooks/README.md#retrieve) - Get webhook support status for provider
+### [environments](docs/sdks/environments/README.md)
+
+* [getTags](docs/sdks/environments/README.md#gettags) - Get 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
+* [delete](docs/sdks/environments/README.md#delete) - Delete an environment
+
+### [integrations](docs/sdks/integrations/README.md)
+
+* [list](docs/sdks/integrations/README.md#list) - List all integrations
+* [create](docs/sdks/integrations/README.md#create) - Create an integration
+* [update](docs/sdks/integrations/README.md#update) - Update an integration
+* [delete](docs/sdks/integrations/README.md#delete) - Delete an integration
+* [integrationsControllerAutoConfigureIntegration](docs/sdks/integrations/README.md#integrationscontrollerautoconfigureintegration) - Auto-configure an integration for inbound webhooks
+* [setAsPrimary](docs/sdks/integrations/README.md#setasprimary) - Update integration as primary
+* [listActive](docs/sdks/integrations/README.md#listactive) - List active integrations
+
+### [layouts](docs/sdks/layouts/README.md)
+
+* [create](docs/sdks/layouts/README.md#create) - Create a layout
+* [list](docs/sdks/layouts/README.md#list) - List all layouts
+* [update](docs/sdks/layouts/README.md#update) - Update a layout
+* [retrieve](docs/sdks/layouts/README.md#retrieve) - Retrieve a layout
+* [delete](docs/sdks/layouts/README.md#delete) - Delete a layout
+* [duplicate](docs/sdks/layouts/README.md#duplicate) - Duplicate a layout
+* [generatePreview](docs/sdks/layouts/README.md#generatepreview) - Generate layout preview
+* [usage](docs/sdks/layouts/README.md#usage) - Get layout usage
 
 ### [messages](docs/sdks/messages/README.md)
 
-* [retrieve](docs/sdks/messages/README.md#retrieve) - Get messages
-* [delete](docs/sdks/messages/README.md#delete) - Delete message
+* [retrieve](docs/sdks/messages/README.md#retrieve) - List all messages
+* [delete](docs/sdks/messages/README.md#delete) - Delete a message
 * [deleteByTransactionId](docs/sdks/messages/README.md#deletebytransactionid) - Delete messages by transactionId
 
 ### [notifications](docs/sdks/notifications/README.md)
 
-* [list](docs/sdks/notifications/README.md#list) - Get notifications
-* [retrieve](docs/sdks/notifications/README.md#retrieve) - Get notification
-
-#### [notifications.stats](docs/sdks/stats/README.md)
-
-* [retrieve](docs/sdks/stats/README.md#retrieve) - Get notification statistics
-* [graph](docs/sdks/stats/README.md#graph) - Get notification graph statistics
+* [list](docs/sdks/notifications/README.md#list) - List all events
+* [retrieve](docs/sdks/notifications/README.md#retrieve) - Retrieve an event
 
 ### [Novu SDK](docs/sdks/novu/README.md)
 
 * [trigger](docs/sdks/novu/README.md#trigger) - Trigger event
-* [triggerBulk](docs/sdks/novu/README.md#triggerbulk) - Bulk trigger event
-* [triggerBroadcast](docs/sdks/novu/README.md#triggerbroadcast) - Broadcast event to all
 * [cancel](docs/sdks/novu/README.md#cancel) - Cancel triggered event
+* [triggerBroadcast](docs/sdks/novu/README.md#triggerbroadcast) - Broadcast event to all
+* [triggerBulk](docs/sdks/novu/README.md#triggerbulk) - Bulk trigger event
 
 ### [subscribers](docs/sdks/subscribers/README.md)
 
-* [list](docs/sdks/subscribers/README.md#list) - Get subscribers
+* [search](docs/sdks/subscribers/README.md#search) - Search subscribers
+* [create](docs/sdks/subscribers/README.md#create) - Create a subscriber
+* [retrieve](docs/sdks/subscribers/README.md#retrieve) - Retrieve a subscriber
+* [patch](docs/sdks/subscribers/README.md#patch) - Update a subscriber
+* [delete](docs/sdks/subscribers/README.md#delete) - Delete a subscriber
 * [createBulk](docs/sdks/subscribers/README.md#createbulk) - Bulk create subscribers
-* [search](docs/sdks/subscribers/README.md#search) - Search for subscribers
-* [create](docs/sdks/subscribers/README.md#create) - Create subscriber
-* [retrieve](docs/sdks/subscribers/README.md#retrieve) - Get subscriber
-* [patch](docs/sdks/subscribers/README.md#patch) - Patch subscriber
-* [delete](docs/sdks/subscribers/README.md#delete) - Delete subscriber
-
-#### [subscribers.authentication](docs/sdks/authentication/README.md)
-
-* [chatAccessOauthCallBack](docs/sdks/authentication/README.md#chataccessoauthcallback) - Handle providers oauth redirect
-* [chatAccessOauth](docs/sdks/authentication/README.md#chataccessoauth) - Handle chat oauth
 
 #### [subscribers.credentials](docs/sdks/credentials/README.md)
 
-* [update](docs/sdks/credentials/README.md#update) - Update subscriber credentials
-* [append](docs/sdks/credentials/README.md#append) - Modify subscriber credentials
-* [delete](docs/sdks/credentials/README.md#delete) - Delete subscriber credentials by providerId
+* [update](docs/sdks/credentials/README.md#update) - Update provider credentials
+* [append](docs/sdks/credentials/README.md#append) - Upsert provider credentials
+* [delete](docs/sdks/credentials/README.md#delete) - Delete provider credentials
 
 #### [subscribers.messages](docs/sdks/novumessages/README.md)
 
-* [markAllAs](docs/sdks/novumessages/README.md#markallas) - Mark a subscriber messages as seen, read, unseen or unread
-* [markAll](docs/sdks/novumessages/README.md#markall) - Marks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed.
-* [updateAsSeen](docs/sdks/novumessages/README.md#updateasseen) - Mark message action as seen
+* [updateAsSeen](docs/sdks/novumessages/README.md#updateasseen) - Update notification action status
+* [markAll](docs/sdks/novumessages/README.md#markall) - Update all notifications state
+* [markAllAs](docs/sdks/novumessages/README.md#markallas) - Update notifications state
 
 #### [subscribers.notifications](docs/sdks/novunotifications/README.md)
 
-* [feed](docs/sdks/novunotifications/README.md#feed) - Get in-app notification feed for a particular subscriber
-* [unseenCount](docs/sdks/novunotifications/README.md#unseencount) - Get the unseen in-app notifications count for subscribers feed
+* [feed](docs/sdks/novunotifications/README.md#feed) - Retrieve subscriber notifications
+* [unseenCount](docs/sdks/novunotifications/README.md#unseencount) - Retrieve unseen notifications count
 
 #### [subscribers.preferences](docs/sdks/preferences/README.md)
 
-* [list](docs/sdks/preferences/README.md#list) - Get subscriber preferences
-* [update](docs/sdks/preferences/README.md#update) - Update subscriber global or workflow specific preferences
+* [list](docs/sdks/preferences/README.md#list) - Retrieve subscriber preferences
+* [update](docs/sdks/preferences/README.md#update) - Update subscriber preferences
+* [bulkUpdate](docs/sdks/preferences/README.md#bulkupdate) - Bulk update subscriber preferences
 
 #### [subscribers.properties](docs/sdks/properties/README.md)
 
 * [updateOnlineFlag](docs/sdks/properties/README.md#updateonlineflag) - Update subscriber online status
 
+#### [subscribers.topics](docs/sdks/novutopics/README.md)
+
+* [list](docs/sdks/novutopics/README.md#list) - Retrieve subscriber subscriptions
+
 ### [topics](docs/sdks/topics/README.md)
 
-* [create](docs/sdks/topics/README.md#create) - Topic creation
-* [list](docs/sdks/topics/README.md#list) - Get topic list filtered 
-* [delete](docs/sdks/topics/README.md#delete) - Delete topic
-* [retrieve](docs/sdks/topics/README.md#retrieve) - Get topic
-* [rename](docs/sdks/topics/README.md#rename) - Rename a topic
+* [list](docs/sdks/topics/README.md#list) - List all topics
+* [create](docs/sdks/topics/README.md#create) - Create a topic
+* [get](docs/sdks/topics/README.md#get) - Retrieve a topic
+* [update](docs/sdks/topics/README.md#update) - Update a topic
+* [delete](docs/sdks/topics/README.md#delete) - Delete a topic
 
 #### [topics.subscribers](docs/sdks/novusubscribers/README.md)
 
-* [assign](docs/sdks/novusubscribers/README.md#assign) - Subscribers addition
 * [retrieve](docs/sdks/novusubscribers/README.md#retrieve) - Check topic subscriber
-* [remove](docs/sdks/novusubscribers/README.md#remove) - Subscribers removal
+
+#### [topics.subscriptions](docs/sdks/subscriptions/README.md)
+
+* [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
+
+### [translations](docs/sdks/translations/README.md)
+
+* [create](docs/sdks/translations/README.md#create) - Create a translation
+* [retrieve](docs/sdks/translations/README.md#retrieve) - Retrieve a translation
+* [delete](docs/sdks/translations/README.md#delete) - Delete a translation
+* [upload](docs/sdks/translations/README.md#upload) - Upload translation files
+
+#### [translations.groups](docs/sdks/groups/README.md)
+
+* [delete](docs/sdks/groups/README.md#delete) - Delete a translation group
+* [retrieve](docs/sdks/groups/README.md#retrieve) - Retrieve a translation group
+
+#### [translations.master](docs/sdks/master/README.md)
+
+* [retrieve](docs/sdks/master/README.md#retrieve) - Retrieve master translations JSON
+* [import](docs/sdks/master/README.md#import) - Import master translations JSON
+* [upload](docs/sdks/master/README.md#upload) - Upload master translations JSON file
 
 ### [workflows](docs/sdks/workflows/README.md)
 
-* [create](docs/sdks/workflows/README.md#create)
-* [workflowControllerSearchWorkflows](docs/sdks/workflows/README.md#workflowcontrollersearchworkflows)
-* [workflowControllerSync](docs/sdks/workflows/README.md#workflowcontrollersync)
-* [update](docs/sdks/workflows/README.md#update)
-* [retrieve](docs/sdks/workflows/README.md#retrieve)
-* [delete](docs/sdks/workflows/README.md#delete)
-* [workflowControllerPatchWorkflow](docs/sdks/workflows/README.md#workflowcontrollerpatchworkflow)
-* [workflowControllerGeneratePreview](docs/sdks/workflows/README.md#workflowcontrollergeneratepreview)
-* [getStepData](docs/sdks/workflows/README.md#getstepdata)
-* [workflowControllerPatchWorkflowStepData](docs/sdks/workflows/README.md#workflowcontrollerpatchworkflowstepdata)
-* [getWorkflowTestData](docs/sdks/workflows/README.md#getworkflowtestdata)
+* [create](docs/sdks/workflows/README.md#create) - Create a workflow
+* [list](docs/sdks/workflows/README.md#list) - List all workflows
+* [update](docs/sdks/workflows/README.md#update) - Update a workflow
+* [get](docs/sdks/workflows/README.md#get) - Retrieve a workflow
+* [delete](docs/sdks/workflows/README.md#delete) - Delete a workflow
+* [patch](docs/sdks/workflows/README.md#patch) - Update a workflow
+* [sync](docs/sdks/workflows/README.md#sync) - Sync a workflow
+
+#### [workflows.steps](docs/sdks/steps/README.md)
+
+* [retrieve](docs/sdks/steps/README.md#retrieve) - Retrieve workflow step
 
 </details>
 <!-- End Available Resources and Operations [operations] -->
@@ -459,198 +423,205 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 
 <summary>Available standalone functions</summary>
 
+- [`activityTrack`](docs/sdks/activity/README.md#track) - Track activity and engagement events
 - [`cancel`](docs/sdks/novu/README.md#cancel) - Cancel triggered event
-- [`integrationsCreate`](docs/sdks/integrations/README.md#create) - Create integration
-- [`integrationsDelete`](docs/sdks/integrations/README.md#delete) - Delete integration
-- [`integrationsList`](docs/sdks/integrations/README.md#list) - Get integrations
-- [`integrationsListActive`](docs/sdks/integrations/README.md#listactive) - Get active integrations
-- [`integrationsSetAsPrimary`](docs/sdks/integrations/README.md#setasprimary) - Set integration as primary
-- [`integrationsUpdate`](docs/sdks/integrations/README.md#update) - Update integration
-- [`integrationsWebhooksRetrieve`](docs/sdks/webhooks/README.md#retrieve) - Get webhook support status for provider
-- [`messagesDelete`](docs/sdks/messages/README.md#delete) - Delete message
+- [`contextsCreate`](docs/sdks/contexts/README.md#create) - Create a context
+- [`contextsDelete`](docs/sdks/contexts/README.md#delete) - Delete a context
+- [`contextsList`](docs/sdks/contexts/README.md#list) - List all contexts
+- [`contextsRetrieve`](docs/sdks/contexts/README.md#retrieve) - Retrieve a context
+- [`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
+- [`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
+- [`integrationsDelete`](docs/sdks/integrations/README.md#delete) - Delete an integration
+- [`integrationsIntegrationsControllerAutoConfigureIntegration`](docs/sdks/integrations/README.md#integrationscontrollerautoconfigureintegration) - Auto-configure an integration for inbound webhooks
+- [`integrationsList`](docs/sdks/integrations/README.md#list) - List all integrations
+- [`integrationsListActive`](docs/sdks/integrations/README.md#listactive) - List active integrations
+- [`integrationsSetAsPrimary`](docs/sdks/integrations/README.md#setasprimary) - Update integration as primary
+- [`integrationsUpdate`](docs/sdks/integrations/README.md#update) - Update an integration
+- [`layoutsCreate`](docs/sdks/layouts/README.md#create) - Create a layout
+- [`layoutsDelete`](docs/sdks/layouts/README.md#delete) - Delete a layout
+- [`layoutsDuplicate`](docs/sdks/layouts/README.md#duplicate) - Duplicate a layout
+- [`layoutsGeneratePreview`](docs/sdks/layouts/README.md#generatepreview) - Generate layout preview
+- [`layoutsList`](docs/sdks/layouts/README.md#list) - List all layouts
+- [`layoutsRetrieve`](docs/sdks/layouts/README.md#retrieve) - Retrieve a layout
+- [`layoutsUpdate`](docs/sdks/layouts/README.md#update) - Update a layout
+- [`layoutsUsage`](docs/sdks/layouts/README.md#usage) - Get layout usage
+- [`messagesDelete`](docs/sdks/messages/README.md#delete) - Delete a message
 - [`messagesDeleteByTransactionId`](docs/sdks/messages/README.md#deletebytransactionid) - Delete messages by transactionId
-- [`messagesRetrieve`](docs/sdks/messages/README.md#retrieve) - Get messages
-- [`notificationsList`](docs/sdks/notifications/README.md#list) - Get notifications
-- [`notificationsRetrieve`](docs/sdks/notifications/README.md#retrieve) - Get notification
-- [`notificationsStatsGraph`](docs/sdks/stats/README.md#graph) - Get notification graph statistics
-- [`notificationsStatsRetrieve`](docs/sdks/stats/README.md#retrieve) - Get notification statistics
-- [`subscribersAuthenticationChatAccessOauth`](docs/sdks/authentication/README.md#chataccessoauth) - Handle chat oauth
-- [`subscribersAuthenticationChatAccessOauthCallBack`](docs/sdks/authentication/README.md#chataccessoauthcallback) - Handle providers oauth redirect
-- [`subscribersCreate`](docs/sdks/subscribers/README.md#create) - Create subscriber
+- [`messagesRetrieve`](docs/sdks/messages/README.md#retrieve) - List all messages
+- [`notificationsList`](docs/sdks/notifications/README.md#list) - List all events
+- [`notificationsRetrieve`](docs/sdks/notifications/README.md#retrieve) - Retrieve an event
+- [`subscribersCreate`](docs/sdks/subscribers/README.md#create) - Create a subscriber
 - [`subscribersCreateBulk`](docs/sdks/subscribers/README.md#createbulk) - Bulk create subscribers
-- [`subscribersCredentialsAppend`](docs/sdks/credentials/README.md#append) - Modify subscriber credentials
-- [`subscribersCredentialsDelete`](docs/sdks/credentials/README.md#delete) - Delete subscriber credentials by providerId
-- [`subscribersCredentialsUpdate`](docs/sdks/credentials/README.md#update) - Update subscriber credentials
-- [`subscribersDelete`](docs/sdks/subscribers/README.md#delete) - Delete subscriber
-- [`subscribersList`](docs/sdks/subscribers/README.md#list) - Get subscribers
-- [`subscribersMessagesMarkAll`](docs/sdks/novumessages/README.md#markall) - Marks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed.
-- [`subscribersMessagesMarkAllAs`](docs/sdks/novumessages/README.md#markallas) - Mark a subscriber messages as seen, read, unseen or unread
-- [`subscribersMessagesUpdateAsSeen`](docs/sdks/novumessages/README.md#updateasseen) - Mark message action as seen
-- [`subscribersNotificationsFeed`](docs/sdks/novunotifications/README.md#feed) - Get in-app notification feed for a particular subscriber
-- [`subscribersNotificationsUnseenCount`](docs/sdks/novunotifications/README.md#unseencount) - Get the unseen in-app notifications count for subscribers feed
-- [`subscribersPatch`](docs/sdks/subscribers/README.md#patch) - Patch subscriber
-- [`subscribersPreferencesList`](docs/sdks/preferences/README.md#list) - Get subscriber preferences
-- [`subscribersPreferencesUpdate`](docs/sdks/preferences/README.md#update) - Update subscriber global or workflow specific preferences
+- [`subscribersCredentialsAppend`](docs/sdks/credentials/README.md#append) - Upsert provider credentials
+- [`subscribersCredentialsDelete`](docs/sdks/credentials/README.md#delete) - Delete provider credentials
+- [`subscribersCredentialsUpdate`](docs/sdks/credentials/README.md#update) - Update provider credentials
+- [`subscribersDelete`](docs/sdks/subscribers/README.md#delete) - Delete a subscriber
+- [`subscribersMessagesMarkAll`](docs/sdks/novumessages/README.md#markall) - Update all notifications state
+- [`subscribersMessagesMarkAllAs`](docs/sdks/novumessages/README.md#markallas) - Update notifications state
+- [`subscribersMessagesUpdateAsSeen`](docs/sdks/novumessages/README.md#updateasseen) - Update notification action status
+- [`subscribersNotificationsFeed`](docs/sdks/novunotifications/README.md#feed) - Retrieve subscriber notifications
+- [`subscribersNotificationsUnseenCount`](docs/sdks/novunotifications/README.md#unseencount) - Retrieve unseen notifications count
+- [`subscribersPatch`](docs/sdks/subscribers/README.md#patch) - Update a subscriber
+- [`subscribersPreferencesBulkUpdate`](docs/sdks/preferences/README.md#bulkupdate) - Bulk update subscriber preferences
+- [`subscribersPreferencesList`](docs/sdks/preferences/README.md#list) - Retrieve subscriber preferences
+- [`subscribersPreferencesUpdate`](docs/sdks/preferences/README.md#update) - Update subscriber preferences
 - [`subscribersPropertiesUpdateOnlineFlag`](docs/sdks/properties/README.md#updateonlineflag) - Update subscriber online status
-- [`subscribersRetrieve`](docs/sdks/subscribers/README.md#retrieve) - Get subscriber
-- [`subscribersSearch`](docs/sdks/subscribers/README.md#search) - Search for subscribers
-- [`topicsCreate`](docs/sdks/topics/README.md#create) - Topic creation
-- [`topicsDelete`](docs/sdks/topics/README.md#delete) - Delete topic
-- [`topicsList`](docs/sdks/topics/README.md#list) - Get topic list filtered 
-- [`topicsRename`](docs/sdks/topics/README.md#rename) - Rename a topic
-- [`topicsRetrieve`](docs/sdks/topics/README.md#retrieve) - Get topic
-- [`topicsSubscribersAssign`](docs/sdks/novusubscribers/README.md#assign) - Subscribers addition
-- [`topicsSubscribersRemove`](docs/sdks/novusubscribers/README.md#remove) - Subscribers removal
+- [`subscribersRetrieve`](docs/sdks/subscribers/README.md#retrieve) - Retrieve a subscriber
+- [`subscribersSearch`](docs/sdks/subscribers/README.md#search) - Search subscribers
+- [`subscribersTopicsList`](docs/sdks/novutopics/README.md#list) - Retrieve subscriber subscriptions
+- [`topicsCreate`](docs/sdks/topics/README.md#create) - Create a topic
+- [`topicsDelete`](docs/sdks/topics/README.md#delete) - Delete a topic
+- [`topicsGet`](docs/sdks/topics/README.md#get) - Retrieve a topic
+- [`topicsList`](docs/sdks/topics/README.md#list) - List all topics
 - [`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
+- [`topicsSubscriptionsList`](docs/sdks/subscriptions/README.md#list) - List topic subscriptions
+- [`topicsUpdate`](docs/sdks/topics/README.md#update) - Update a topic
+- [`translationsCreate`](docs/sdks/translations/README.md#create) - Create a translation
+- [`translationsDelete`](docs/sdks/translations/README.md#delete) - Delete a translation
+- [`translationsGroupsDelete`](docs/sdks/groups/README.md#delete) - Delete a translation group
+- [`translationsGroupsRetrieve`](docs/sdks/groups/README.md#retrieve) - Retrieve a translation group
+- [`translationsMasterImport`](docs/sdks/master/README.md#import) - Import master translations JSON
+- [`translationsMasterRetrieve`](docs/sdks/master/README.md#retrieve) - Retrieve master translations JSON
+- [`translationsMasterUpload`](docs/sdks/master/README.md#upload) - Upload master translations JSON file
+- [`translationsRetrieve`](docs/sdks/translations/README.md#retrieve) - Retrieve a translation
+- [`translationsUpload`](docs/sdks/translations/README.md#upload) - Upload translation files
 - [`trigger`](docs/sdks/novu/README.md#trigger) - Trigger event
 - [`triggerBroadcast`](docs/sdks/novu/README.md#triggerbroadcast) - Broadcast event to all
 - [`triggerBulk`](docs/sdks/novu/README.md#triggerbulk) - Bulk trigger event
-- [`workflowsCreate`](docs/sdks/workflows/README.md#create)
-- [`workflowsDelete`](docs/sdks/workflows/README.md#delete)
-- [`workflowsGetStepData`](docs/sdks/workflows/README.md#getstepdata)
-- [`workflowsGetWorkflowTestData`](docs/sdks/workflows/README.md#getworkflowtestdata)
-- [`workflowsRetrieve`](docs/sdks/workflows/README.md#retrieve)
-- [`workflowsUpdate`](docs/sdks/workflows/README.md#update)
-- [`workflowsWorkflowControllerGeneratePreview`](docs/sdks/workflows/README.md#workflowcontrollergeneratepreview)
-- [`workflowsWorkflowControllerPatchWorkflow`](docs/sdks/workflows/README.md#workflowcontrollerpatchworkflow)
-- [`workflowsWorkflowControllerPatchWorkflowStepData`](docs/sdks/workflows/README.md#workflowcontrollerpatchworkflowstepdata)
-- [`workflowsWorkflowControllerSearchWorkflows`](docs/sdks/workflows/README.md#workflowcontrollersearchworkflows)
-- [`workflowsWorkflowControllerSync`](docs/sdks/workflows/README.md#workflowcontrollersync)
+- [`workflowsCreate`](docs/sdks/workflows/README.md#create) - Create a workflow
+- [`workflowsDelete`](docs/sdks/workflows/README.md#delete) - Delete a workflow
+- [`workflowsGet`](docs/sdks/workflows/README.md#get) - Retrieve a workflow
+- [`workflowsList`](docs/sdks/workflows/README.md#list) - List all workflows
+- [`workflowsPatch`](docs/sdks/workflows/README.md#patch) - Update a workflow
+- [`workflowsStepsRetrieve`](docs/sdks/steps/README.md#retrieve) - Retrieve workflow step
+- [`workflowsSync`](docs/sdks/workflows/README.md#sync) - Sync a workflow
+- [`workflowsUpdate`](docs/sdks/workflows/README.md#update) - Update a workflow
 
 </details>
 <!-- End Standalone functions [standalone-funcs] -->
 
-<!-- Start React hooks with TanStack Query [react-query] -->
-## React hooks with TanStack Query
-
-React hooks built on [TanStack Query][tanstack-query] are included in this SDK.
-These hooks and the utility functions provided alongside them can be used to
-build rich applications that pull data from the API using one of the most
-popular asynchronous state management library.
-
-[tanstack-query]: https://tanstack.com/query/v5/docs/framework/react/overview
-
-To learn about this feature and how to get started, check
-[REACT_QUERY.md](./REACT_QUERY.md).
-
-> [!WARNING]
->
-> This feature is currently in **preview** and is subject to breaking changes
-> within the current major version of the SDK as we gather user feedback on it.
-
-<details>
-
-<summary>Available React hooks</summary>
-
-- [`useCancelMutation`](docs/sdks/novu/README.md#cancel) - Cancel triggered event
-- [`useIntegrationsCreateMutation`](docs/sdks/integrations/README.md#create) - Create integration
-- [`useIntegrationsDeleteMutation`](docs/sdks/integrations/README.md#delete) - Delete integration
-- [`useIntegrationsList`](docs/sdks/integrations/README.md#list) - Get integrations
-- [`useIntegrationsListActive`](docs/sdks/integrations/README.md#listactive) - Get active integrations
-- [`useIntegrationsSetAsPrimaryMutation`](docs/sdks/integrations/README.md#setasprimary) - Set integration as primary
-- [`useIntegrationsUpdateMutation`](docs/sdks/integrations/README.md#update) - Update integration
-- [`useIntegrationsWebhooksRetrieve`](docs/sdks/webhooks/README.md#retrieve) - Get webhook support status for provider
-- [`useMessagesDeleteByTransactionIdMutation`](docs/sdks/messages/README.md#deletebytransactionid) - Delete messages by transactionId
-- [`useMessagesDeleteMutation`](docs/sdks/messages/README.md#delete) - Delete message
-- [`useMessagesRetrieve`](docs/sdks/messages/README.md#retrieve) - Get messages
-- [`useNotificationsList`](docs/sdks/notifications/README.md#list) - Get notifications
-- [`useNotificationsRetrieve`](docs/sdks/notifications/README.md#retrieve) - Get notification
-- [`useNotificationsStatsGraph`](docs/sdks/stats/README.md#graph) - Get notification graph statistics
-- [`useNotificationsStatsRetrieve`](docs/sdks/stats/README.md#retrieve) - Get notification statistics
-- [`useSubscribersAuthenticationChatAccessOauth`](docs/sdks/authentication/README.md#chataccessoauth) - Handle chat oauth
-- [`useSubscribersAuthenticationChatAccessOauthCallBack`](docs/sdks/authentication/README.md#chataccessoauthcallback) - Handle providers oauth redirect
-- [`useSubscribersCreateBulkMutation`](docs/sdks/subscribers/README.md#createbulk) - Bulk create subscribers
-- [`useSubscribersCreateMutation`](docs/sdks/subscribers/README.md#create) - Create subscriber
-- [`useSubscribersCredentialsAppendMutation`](docs/sdks/credentials/README.md#append) - Modify subscriber credentials
-- [`useSubscribersCredentialsDeleteMutation`](docs/sdks/credentials/README.md#delete) - Delete subscriber credentials by providerId
-- [`useSubscribersCredentialsUpdateMutation`](docs/sdks/credentials/README.md#update) - Update subscriber credentials
-- [`useSubscribersDeleteMutation`](docs/sdks/subscribers/README.md#delete) - Delete subscriber
-- [`useSubscribersList`](docs/sdks/subscribers/README.md#list) - Get subscribers
-- [`useSubscribersMessagesMarkAllAsMutation`](docs/sdks/novumessages/README.md#markallas) - Mark a subscriber messages as seen, read, unseen or unread
-- [`useSubscribersMessagesMarkAllMutation`](docs/sdks/novumessages/README.md#markall) - Marks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed.
-- [`useSubscribersMessagesUpdateAsSeenMutation`](docs/sdks/novumessages/README.md#updateasseen) - Mark message action as seen
-- [`useSubscribersNotificationsFeed`](docs/sdks/novunotifications/README.md#feed) - Get in-app notification feed for a particular subscriber
-- [`useSubscribersNotificationsUnseenCount`](docs/sdks/novunotifications/README.md#unseencount) - Get the unseen in-app notifications count for subscribers feed
-- [`useSubscribersPatchMutation`](docs/sdks/subscribers/README.md#patch) - Patch subscriber
-- [`useSubscribersPreferencesList`](docs/sdks/preferences/README.md#list) - Get subscriber preferences
-- [`useSubscribersPreferencesUpdateMutation`](docs/sdks/preferences/README.md#update) - Update subscriber global or workflow specific preferences
-- [`useSubscribersPropertiesUpdateOnlineFlagMutation`](docs/sdks/properties/README.md#updateonlineflag) - Update subscriber online status
-- [`useSubscribersRetrieve`](docs/sdks/subscribers/README.md#retrieve) - Get subscriber
-- [`useSubscribersSearch`](docs/sdks/subscribers/README.md#search) - Search for subscribers
-- [`useTopicsCreateMutation`](docs/sdks/topics/README.md#create) - Topic creation
-- [`useTopicsDeleteMutation`](docs/sdks/topics/README.md#delete) - Delete topic
-- [`useTopicsList`](docs/sdks/topics/README.md#list) - Get topic list filtered 
-- [`useTopicsRenameMutation`](docs/sdks/topics/README.md#rename) - Rename a topic
-- [`useTopicsRetrieve`](docs/sdks/topics/README.md#retrieve) - Get topic
-- [`useTopicsSubscribersAssignMutation`](docs/sdks/novusubscribers/README.md#assign) - Subscribers addition
-- [`useTopicsSubscribersRemoveMutation`](docs/sdks/novusubscribers/README.md#remove) - Subscribers removal
-- [`useTopicsSubscribersRetrieve`](docs/sdks/novusubscribers/README.md#retrieve) - Check topic subscriber
-- [`useTriggerBroadcastMutation`](docs/sdks/novu/README.md#triggerbroadcast) - Broadcast event to all
-- [`useTriggerBulkMutation`](docs/sdks/novu/README.md#triggerbulk) - Bulk trigger event
-- [`useTriggerMutation`](docs/sdks/novu/README.md#trigger) - Trigger event
-- [`useWorkflowsCreateMutation`](docs/sdks/workflows/README.md#create)
-- [`useWorkflowsDeleteMutation`](docs/sdks/workflows/README.md#delete)
-- [`useWorkflowsGetStepData`](docs/sdks/workflows/README.md#getstepdata)
-- [`useWorkflowsGetWorkflowTestData`](docs/sdks/workflows/README.md#getworkflowtestdata)
-- [`useWorkflowsRetrieve`](docs/sdks/workflows/README.md#retrieve)
-- [`useWorkflowsUpdateMutation`](docs/sdks/workflows/README.md#update)
-- [`useWorkflowsWorkflowControllerGeneratePreviewMutation`](docs/sdks/workflows/README.md#workflowcontrollergeneratepreview)
-- [`useWorkflowsWorkflowControllerPatchWorkflowMutation`](docs/sdks/workflows/README.md#workflowcontrollerpatchworkflow)
-- [`useWorkflowsWorkflowControllerPatchWorkflowStepDataMutation`](docs/sdks/workflows/README.md#workflowcontrollerpatchworkflowstepdata)
-- [`useWorkflowsWorkflowControllerSearchWorkflows`](docs/sdks/workflows/README.md#workflowcontrollersearchworkflows)
-- [`useWorkflowsWorkflowControllerSyncMutation`](docs/sdks/workflows/README.md#workflowcontrollersync)
-
-</details>
-<!-- End React hooks with TanStack Query [react-query] -->
-
-<!-- Start Pagination [pagination] -->
-## Pagination
-
-Some of the endpoints in this SDK support pagination. To use pagination, you
-make your SDK calls as usual, but the returned response object will also be an
-async iterable that can be consumed using the [`for await...of`][for-await-of]
-syntax.
+<!-- Start Error Handling [errors] -->
+## Error Handling
 
-[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
+[`NovuError`](./src/models/errors/novuerror.ts) is the base class for all HTTP error responses. It has the following properties:
 
-Here's an example of one such pagination call:
+| Property            | Type       | Description                                                                             |
+| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
+| `error.message`     | `string`   | Error message                                                                           |
+| `error.statusCode`  | `number`   | HTTP response status code eg `404`                                                      |
+| `error.headers`     | `Headers`  | HTTP response headers                                                                   |
+| `error.body`        | `string`   | HTTP body. Can be empty string if no body is returned.                                  |
+| `error.rawResponse` | `Response` | Raw HTTP response                                                                       |
+| `error.data$`       |            | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
 
+### Example
 ```typescript
 import { Novu } from "@novu/api";
+import * as errors from "@novu/api/models/errors";
 
 const novu = new Novu({
-  security: {
-    secretKey: "YOUR_SECRET_KEY_HERE",
-  },
+  secretKey: "YOUR_SECRET_KEY_HERE",
 });
 
 async function run() {
-  const result = await novu.subscribers.list();
+  try {
+    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",
+      },
+    });
 
-  for await (const page of result) {
-    // Handle the page
-    console.log(page);
+    console.log(result);
+  } catch (error) {
+    // The base class for HTTP error responses
+    if (error instanceof errors.NovuError) {
+      console.log(error.message);
+      console.log(error.statusCode);
+      console.log(error.body);
+      console.log(error.headers);
+
+      // Depending on the method different errors may be thrown
+      if (error instanceof errors.PayloadValidationExceptionDto) {
+        console.log(error.data$.statusCode); // number
+        console.log(error.data$.timestamp); // string
+        console.log(error.data$.path); // string
+        console.log(error.data$.message); // errors.PayloadValidationExceptionDtoMessage
+        console.log(error.data$.ctx); // { [k: string]: any }
+      }
+    }
   }
 }
 
 run();
 
 ```
-<!-- End Pagination [pagination] -->
 
-<!-- Start Retries [retries] -->
-## Retries
+### Error Classes
+**Primary errors:**
+* [`NovuError`](./src/models/errors/novuerror.ts): The base class for HTTP error responses.
+  * [`ErrorDto`](./src/models/errors/errordto.ts): *
+  * [`ValidationErrorDto`](./src/models/errors/validationerrordto.ts): Unprocessable Entity. Status code `422`. *
 
-Some of the endpoints in this SDK support retries.  If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API.  However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
+<details><summary>Less common errors (9)</summary>
+
+<br />
+
+**Network errors:**
+* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
+* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
+* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
+* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
+* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
+
+
+**Inherit from [`NovuError`](./src/models/errors/novuerror.ts)**:
+* [`PayloadValidationExceptionDto`](./src/models/errors/payloadvalidationexceptiondto.ts): Status code `400`. Applicable to 3 of 80 methods.*
+* [`SubscriberResponseDto`](./src/models/errors/subscriberresponsedto.ts): Created. Status code `409`. Applicable to 1 of 80 methods.*
+* [`TopicResponseDto`](./src/models/errors/topicresponsedto.ts): OK. Status code `409`. Applicable to 1 of 80 methods.*
+* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
+
+</details>
+
+\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
+<!-- End Error Handling [errors] -->
+
+<!-- Start Server Selection [server] -->
+## Server Selection
+
+### Select Server by Index
+
+You can override the default server globally by passing a server index to the `serverIdx: number` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
+
+| #   | Server                   | Description |
+| --- | ------------------------ | ----------- |
+| 0   | `https://api.novu.co`    |             |
+| 1   | `https://eu.api.novu.co` |             |
+
+#### Example
 
-To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
 ```typescript
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  security: {
-    secretKey: "YOUR_SECRET_KEY_HERE",
-  },
+  serverIdx: 0,
+  secretKey: "YOUR_SECRET_KEY_HERE",
 });
 
 async function run() {
@@ -662,30 +633,14 @@ async function run() {
         "text": "string",
       },
     },
-    overrides: {
-      "fcm": {
-        "data": {
-          "key": "value",
-        },
-      },
-    },
-    to: {
-      subscriberId: "<id>",
-    },
-  }, {
-    retries: {
-      strategy: "backoff",
-      backoff: {
-        initialInterval: 1,
-        maxInterval: 50,
-        exponent: 1.1,
-        maxElapsedTime: 100,
-      },
-      retryConnectionErrors: false,
+    overrides: {},
+    to: "SUBSCRIBER_ID",
+    actor: "<value>",
+    context: {
+      "key": "org-acme",
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -693,24 +648,15 @@ run();
 
 ```
 
-If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
+### Override Server URL Per-Client
+
+The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
 ```typescript
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  retryConfig: {
-    strategy: "backoff",
-    backoff: {
-      initialInterval: 1,
-      maxInterval: 50,
-      exponent: 1.1,
-      maxElapsedTime: 100,
-    },
-    retryConnectionErrors: false,
-  },
-  security: {
-    secretKey: "YOUR_SECRET_KEY_HERE",
-  },
+  serverURL: "https://eu.api.novu.co",
+  secretKey: "YOUR_SECRET_KEY_HERE",
 });
 
 async function run() {
@@ -722,158 +668,88 @@ async function run() {
         "text": "string",
       },
     },
-    overrides: {
-      "fcm": {
-        "data": {
-          "key": "value",
-        },
-      },
-    },
-    to: {
-      subscriberId: "<id>",
+    overrides: {},
+    to: "SUBSCRIBER_ID",
+    actor: "<value>",
+    context: {
+      "key": "org-acme",
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
 run();
 
 ```
-<!-- End Retries [retries] -->
+<!-- End Server Selection [server] -->
 
-<!-- Start Error Handling [errors] -->
-## Error Handling
+<!-- Start Custom HTTP Client [http-client] -->
+## Custom HTTP Client
 
-Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `trigger` method may throw the following errors:
+The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
+[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This
+client is a thin wrapper around `fetch` and provides the ability to attach hooks
+around the request lifecycle that can be used to modify the request or handle
+errors and response.
 
-| Error Type                | Status Code                            | Content Type     |
-| ------------------------- | -------------------------------------- | ---------------- |
-| errors.ErrorDto           | 414                                    | application/json |
-| errors.ErrorDto           | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
-| errors.ValidationErrorDto | 422                                    | application/json |
-| errors.ErrorDto           | 500                                    | application/json |
-| errors.SDKError           | 4XX, 5XX                               | \*/\*            |
+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.
 
-If the method throws an error and it is not captured by the known errors, it will default to throwing a `SDKError`.
+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:
 
 ```typescript
 import { Novu } from "@novu/api";
-import {
-  ErrorDto,
-  SDKValidationError,
-  ValidationErrorDto,
-} from "@novu/api/models/errors";
-
-const novu = new Novu({
-  security: {
-    secretKey: "YOUR_SECRET_KEY_HERE",
-  },
-});
-
-async function run() {
-  let result;
-  try {
-    result = await novu.trigger({
-      workflowId: "workflow_identifier",
-      payload: {
-        "comment_id": "string",
-        "post": {
-          "text": "string",
-        },
-      },
-      overrides: {
-        "fcm": {
-          "data": {
-            "key": "value",
-          },
-        },
-      },
-      to: {
-        subscriberId: "<id>",
-      },
-    });
+import { HTTPClient } from "@novu/api/lib/http";
 
-    // Handle the result
-    console.log(result);
-  } catch (err) {
-    switch (true) {
-      // The server response does not match the expected SDK schema
-      case (err instanceof SDKValidationError): {
-        // Pretty-print will provide a human-readable multi-line error message
-        console.error(err.pretty());
-        // Raw value may also be inspected
-        console.error(err.rawValue);
-        return;
-      }
-      case (err instanceof ErrorDto): {
-        // Handle err.data$: ErrorDtoData
-        console.error(err);
-        return;
-      }
-      case (err instanceof ErrorDto): {
-        // Handle err.data$: ErrorDtoData
-        console.error(err);
-        return;
-      }
-      case (err instanceof ValidationErrorDto): {
-        // Handle err.data$: ValidationErrorDtoData
-        console.error(err);
-        return;
-      }
-      case (err instanceof ErrorDto): {
-        // Handle err.data$: ErrorDtoData
-        console.error(err);
-        return;
-      }
-      default: {
-        // Other errors such as network errors, see HTTPClientErrors for more details
-        throw err;
-      }
-    }
+const httpClient = new HTTPClient({
+  // fetcher takes a function that has the same signature as native `fetch`.
+  fetcher: (request) => {
+    return fetch(request);
   }
-}
-
-run();
+});
 
-```
+httpClient.addHook("beforeRequest", (request) => {
+  const nextRequest = new Request(request, {
+    signal: request.signal || AbortSignal.timeout(5000)
+  });
 
-Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.
+  nextRequest.headers.set("x-custom-header", "custom value");
 
-In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the `models/errors/httpclienterrors.ts` module:
+  return nextRequest;
+});
 
-| HTTP Client Error                                    | Description                                          |
-| ---------------------------------------------------- | ---------------------------------------------------- |
-| RequestAbortedError                                  | HTTP request was aborted by the client               |
-| RequestTimeoutError                                  | HTTP request timed out due to an AbortSignal signal  |
-| ConnectionError                                      | HTTP client was unable to make a request to a server |
-| InvalidRequestError                                  | Any input used to create a request is invalid        |
-| UnexpectedClientError                                | Unrecognised or unexpected error                     |
-<!-- End Error Handling [errors] -->
+httpClient.addHook("requestError", (error, request) => {
+  console.group("Request Error");
+  console.log("Reason:", `${error}`);
+  console.log("Endpoint:", `${request.method} ${request.url}`);
+  console.groupEnd();
+});
 
-<!-- Start Server Selection [server] -->
-## Server Selection
+const sdk = new Novu({ httpClient: httpClient });
+```
+<!-- End Custom HTTP Client [http-client] -->
 
-### Select Server by Index
+<!-- Start Authentication [security] -->
+## Authentication
 
-You can override the default server globally by passing a server index to the `serverIdx: number` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
+### Per-Client Security Schemes
 
-| #   | Server                   |
-| --- | ------------------------ |
-| 0   | `https://api.novu.co`    |
-| 1   | `https://eu.api.novu.co` |
+This SDK supports the following security scheme globally:
 
-#### Example
+| Name        | Type   | Scheme  |
+| ----------- | ------ | ------- |
+| `secretKey` | apiKey | API key |
 
+To authenticate with the API the `secretKey` parameter must be set when initializing the SDK client instance. For example:
 ```typescript
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  serverIdx: 1,
-  security: {
-    secretKey: "YOUR_SECRET_KEY_HERE",
-  },
+  secretKey: "YOUR_SECRET_KEY_HERE",
 });
 
 async function run() {
@@ -885,37 +761,33 @@ async function run() {
         "text": "string",
       },
     },
-    overrides: {
-      "fcm": {
-        "data": {
-          "key": "value",
-        },
-      },
-    },
-    to: {
-      subscriberId: "<id>",
+    overrides: {},
+    to: "SUBSCRIBER_ID",
+    actor: "<value>",
+    context: {
+      "key": "org-acme",
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
 run();
 
 ```
+<!-- End Authentication [security] -->
 
-### Override Server URL Per-Client
+<!-- Start Retries [retries] -->
+## Retries
 
-The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
+Some of the endpoints in this SDK support retries.  If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API.  However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
+
+To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
 ```typescript
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  serverURL: "https://api.novu.co",
-  security: {
-    secretKey: "YOUR_SECRET_KEY_HERE",
-  },
+  secretKey: "YOUR_SECRET_KEY_HERE",
 });
 
 async function run() {
@@ -927,75 +799,74 @@ async function run() {
         "text": "string",
       },
     },
-    overrides: {
-      "fcm": {
-        "data": {
-          "key": "value",
-        },
-      },
+    overrides: {},
+    to: "SUBSCRIBER_ID",
+    actor: "<value>",
+    context: {
+      "key": "org-acme",
     },
-    to: {
-      subscriberId: "<id>",
+  }, {
+    retries: {
+      strategy: "backoff",
+      backoff: {
+        initialInterval: 1,
+        maxInterval: 50,
+        exponent: 1.1,
+        maxElapsedTime: 100,
+      },
+      retryConnectionErrors: false,
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
 run();
 
 ```
-<!-- End Server Selection [server] -->
-
-<!-- Start Custom HTTP Client [http-client] -->
-## Custom HTTP Client
-
-The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
-[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This
-client is a thin wrapper around `fetch` and provides the ability to attach hooks
-around the request lifecycle that can be used to modify the request or handle
-errors and response.
-
-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:
 
+If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
 ```typescript
 import { Novu } from "@novu/api";
-import { HTTPClient } from "@novu/api/lib/http";
 
-const httpClient = new HTTPClient({
-  // fetcher takes a function that has the same signature as native `fetch`.
-  fetcher: (request) => {
-    return fetch(request);
-  }
+const novu = new Novu({
+  retryConfig: {
+    strategy: "backoff",
+    backoff: {
+      initialInterval: 1,
+      maxInterval: 50,
+      exponent: 1.1,
+      maxElapsedTime: 100,
+    },
+    retryConnectionErrors: false,
+  },
+  secretKey: "YOUR_SECRET_KEY_HERE",
 });
 
-httpClient.addHook("beforeRequest", (request) => {
-  const nextRequest = new Request(request, {
-    signal: request.signal || AbortSignal.timeout(5000)
+async function run() {
+  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",
+    },
   });
 
-  nextRequest.headers.set("x-custom-header", "custom value");
-
-  return nextRequest;
-});
+  console.log(result);
+}
 
-httpClient.addHook("requestError", (error, request) => {
-  console.group("Request Error");
-  console.log("Reason:", `${error}`);
-  console.log("Endpoint:", `${request.method} ${request.url}`);
-  console.groupEnd();
-});
+run();
 
-const sdk = new Novu({ httpClient });
 ```
-<!-- End Custom HTTP Client [http-client] -->
+<!-- End Retries [retries] -->
 
 <!-- Start Debugging [debug] -->
 ## Debugging
@@ -1026,7 +897,7 @@ looking for the latest version.
 
 ## Contributions
 
-While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. 
-We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. 
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
 
-### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=@novu/api&utm_campaign=typescript)
+### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)