@novu/api 0.0.1-alpha.9 → 0.0.1-alpha.92

package/README.md

@@ -6,9 +6,40 @@
 </div>
 
 
+<!-- Start Summary [summary] -->
+## Summary
+
+Novu API: Novu REST API. Please see https://docs.novu.co/api-reference for more details.
+
+For more information about the API: [Novu Documentation](https://docs.novu.co)
+<!-- End Summary [summary] -->
+
+<!-- Start Table of Contents [toc] -->
+## Table of Contents
+<!-- $toc-max-depth=2 -->
+  * [SDK Installation](#sdk-installation)
+  * [Requirements](#requirements)
+  * [SDK Example Usage](#sdk-example-usage)
+  * [Available Resources and Operations](#available-resources-and-operations)
+  * [Standalone functions](#standalone-functions)
+  * [Pagination](#pagination)
+  * [Error Handling](#error-handling)
+  * [Server Selection](#server-selection)
+  * [Custom HTTP Client](#custom-http-client)
+  * [Authentication](#authentication)
+  * [Retries](#retries)
+  * [Debugging](#debugging)
+* [Development](#development)
+  * [Maturity](#maturity)
+  * [Contributions](#contributions)
+
+<!-- End Table of Contents [toc] -->
+
 <!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
+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
@@ -52,214 +83,302 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-    apiKey: "<YOUR_API_KEY_HERE>",
+  apiKey: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await novu.trigger({
+    name: "workflow_identifier",
+    to: [
+      {
+        topicKey: "<value>",
+        type: "Topic",
+      },
+      {
+        topicKey: "<value>",
+        type: "Topic",
+      },
+    ],
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+
+```
+
+### Trigger Notification Events in Bulk
+
+```typescript
+import { Novu } from "@novu/api";
+
+const novu = new Novu({
+  apiKey: "<YOUR_API_KEY_HERE>",
 });
 
 async function run() {
-    const result = await novu.trigger({
+  const result = await novu.triggerBulk({
+    events: [
+      {
         name: "workflow_identifier",
-        overrides: {},
-        payload: {},
         to: [
-            {
-                topicKey: "topic_key",
-                type: "Topic",
-            },
+          {
+            topicKey: "<value>",
+            type: "Topic",
+          },
+          {
+            subscriberId: "<id>",
+          },
         ],
-    });
+      },
+      {
+        name: "workflow_identifier",
+        to: [
+          "SUBSCRIBER_ID",
+        ],
+      },
+      {
+        name: "workflow_identifier",
+        to: [
+          {
+            topicKey: "<value>",
+            type: "Topic",
+          },
+          {
+            topicKey: "<value>",
+            type: "Topic",
+          },
+        ],
+      },
+    ],
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
 
 ```
-<!-- End SDK Example Usage [usage] -->
 
-<!-- Start Available Resources and Operations [operations] -->
-## Available Resources and Operations
+### Broadcast Event to All
 
-### [Novu SDK](docs/sdks/novu/README.md)
+```typescript
+import { Novu } from "@novu/api";
 
-* [trigger](docs/sdks/novu/README.md#trigger) - Trigger event
+const novu = new Novu({
+  apiKey: "<YOUR_API_KEY_HERE>",
+});
 
-### [changes](docs/sdks/changes/README.md)
+async function run() {
+  const result = await novu.triggerBroadcast({
+    name: "<value>",
+    payload: {
+      "comment_id": "string",
+      "post": {
+        "text": "string",
+      },
+    },
+  });
 
-* [apply](docs/sdks/changes/README.md#apply) - Apply change
-* [applyBulk](docs/sdks/changes/README.md#applybulk) - Apply changes
-* [count](docs/sdks/changes/README.md#count) - Get changes count
-* [retrieve](docs/sdks/changes/README.md#retrieve) - Get changes
+  // Handle the result
+  console.log(result);
+}
 
-### [environments](docs/sdks/environments/README.md)
+run();
 
-* [list](docs/sdks/environments/README.md#list) - Get environments
-* [retrieve](docs/sdks/environments/README.md#retrieve) - Get current environment
+```
 
-### [environments.apiKeys](docs/sdks/apikeys/README.md)
+### Cancel Triggered Event
 
-* [list](docs/sdks/apikeys/README.md#list) - Get api keys
-* [regenerate](docs/sdks/apikeys/README.md#regenerate) - Regenerate api keys
+```typescript
+import { Novu } from "@novu/api";
 
-### [events](docs/sdks/events/README.md)
+const novu = new Novu({
+  apiKey: "<YOUR_API_KEY_HERE>",
+});
 
-* [cancel](docs/sdks/events/README.md#cancel) - Cancel triggered event
-* [triggerBroadcast](docs/sdks/events/README.md#triggerbroadcast) - Broadcast event to all
-* [triggerBulk](docs/sdks/events/README.md#triggerbulk) - Bulk trigger event
+async function run() {
+  const result = await novu.cancel("<id>");
 
-### [executionDetails](docs/sdks/executiondetails/README.md)
+  // Handle the result
+  console.log(result);
+}
 
-* [retrieve](docs/sdks/executiondetails/README.md#retrieve) - Get execution details
+run();
 
-### [feeds](docs/sdks/feeds/README.md)
+```
+<!-- End SDK Example Usage [usage] -->
 
-* [create](docs/sdks/feeds/README.md#create) - Create feed
-* [delete](docs/sdks/feeds/README.md#delete) - Delete feed
-* [retrieve](docs/sdks/feeds/README.md#retrieve) - Get feeds
+<!-- Start Available Resources and Operations [operations] -->
+## Available Resources and Operations
+
+<details open>
+<summary>Available methods</summary>
 
 ### [integrations](docs/sdks/integrations/README.md)
 
-* [create](docs/sdks/integrations/README.md#create) - Create integration
-* [delete](docs/sdks/integrations/README.md#delete) - Delete integration
 * [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
-* [setAsPrimary](docs/sdks/integrations/README.md#setasprimary) - Set integration as primary
 * [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
 
-### [integrations.webhooks](docs/sdks/webhooks/README.md)
+#### [integrations.webhooks](docs/sdks/webhooks/README.md)
 
 * [retrieve](docs/sdks/webhooks/README.md#retrieve) - Get webhook support status for provider
 
-### [layouts](docs/sdks/layouts/README.md)
-
-* [create](docs/sdks/layouts/README.md#create) - Layout creation
-* [delete](docs/sdks/layouts/README.md#delete) - Delete layout
-* [list](docs/sdks/layouts/README.md#list) - Filter layouts
-* [retrieve](docs/sdks/layouts/README.md#retrieve) - Get layout
-* [setAsDefault](docs/sdks/layouts/README.md#setasdefault) - Set default layout
-* [update](docs/sdks/layouts/README.md#update) - Update a layout
-
 ### [messages](docs/sdks/messages/README.md)
 
+* [retrieve](docs/sdks/messages/README.md#retrieve) - Get messages
 * [delete](docs/sdks/messages/README.md#delete) - Delete message
 * [deleteByTransactionId](docs/sdks/messages/README.md#deletebytransactionid) - Delete messages by transactionId
-* [retrieve](docs/sdks/messages/README.md#retrieve) - Get messages
-
-### [workflowGroups](docs/sdks/workflowgroups/README.md)
-
-* [create](docs/sdks/workflowgroups/README.md#create) - Create workflow group
-* [delete](docs/sdks/workflowgroups/README.md#delete) - Delete workflow group
-* [list](docs/sdks/workflowgroups/README.md#list) - Get workflow groups
-* [retrieve](docs/sdks/workflowgroups/README.md#retrieve) - Get workflow group
-* [update](docs/sdks/workflowgroups/README.md#update) - Update workflow group
 
 ### [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)
+#### [notifications.stats](docs/sdks/stats/README.md)
 
-* [graph](docs/sdks/stats/README.md#graph) - Get notification graph statistics
 * [retrieve](docs/sdks/stats/README.md#retrieve) - Get notification statistics
+* [graph](docs/sdks/stats/README.md#graph) - Get notification graph statistics
 
-### [organizations](docs/sdks/organizations/README.md)
-
-* [create](docs/sdks/organizations/README.md#create) - Create an organization
-* [list](docs/sdks/organizations/README.md#list) - Fetch all organizations
-* [rename](docs/sdks/organizations/README.md#rename) - Rename organization name
-* [retrieve](docs/sdks/organizations/README.md#retrieve) - Fetch current organization details
-
-### [organizations.branding](docs/sdks/branding/README.md)
-
-* [update](docs/sdks/branding/README.md#update) - Update organization branding details
-
-### [organizations.members](docs/sdks/members/README.md)
+### [Novu SDK](docs/sdks/novu/README.md)
 
-* [delete](docs/sdks/members/README.md#delete) - Remove a member from organization using memberId
-* [list](docs/sdks/members/README.md#list) - Fetch all members of current organizations
+* [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
 
 ### [subscribers](docs/sdks/subscribers/README.md)
 
-* [create](docs/sdks/subscribers/README.md#create) - Create subscriber
-* [createBulk](docs/sdks/subscribers/README.md#createbulk) - Bulk create subscribers
-* [delete](docs/sdks/subscribers/README.md#delete) - Delete subscriber
 * [list](docs/sdks/subscribers/README.md#list) - Get subscribers
+* [create](docs/sdks/subscribers/README.md#create) - Create subscriber
 * [retrieve](docs/sdks/subscribers/README.md#retrieve) - Get subscriber
 * [update](docs/sdks/subscribers/README.md#update) - Update subscriber
+* [delete](docs/sdks/subscribers/README.md#delete) - Delete subscriber
+* [createBulk](docs/sdks/subscribers/README.md#createbulk) - Bulk create subscribers
 
-### [subscribers.credentials](docs/sdks/credentials/README.md)
+#### [subscribers.authentication](docs/sdks/authentication/README.md)
 
-* [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 subscriber credentials
+* [chatAccessOauthCallBack](docs/sdks/authentication/README.md#chataccessoauthcallback) - Handle providers oauth redirect
+* [chatAccessOauth](docs/sdks/authentication/README.md#chataccessoauth) - Handle chat oauth
 
-### [subscribers.authentication](docs/sdks/authentication/README.md)
+#### [subscribers.credentials](docs/sdks/credentials/README.md)
 
-* [chatAccessOauth](docs/sdks/authentication/README.md#chataccessoauth) - Handle chat oauth
-* [chatAccessOauthCallBack](docs/sdks/authentication/README.md#chataccessoauthcallback) - Handle providers oauth redirect
+* [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
 
-### [subscribers.messages](docs/sdks/novumessages/README.md)
+#### [subscribers.messages](docs/sdks/novumessages/README.md)
 
-* [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.
 * [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
 
-### [subscribers.notifications](docs/sdks/novunotifications/README.md)
+#### [subscribers.notifications](docs/sdks/novunotifications/README.md)
 
-* [retrieve](docs/sdks/novunotifications/README.md#retrieve) - Get in-app notification feed for a particular subscriber
+* [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
 
-### [subscribers.properties](docs/sdks/properties/README.md)
-
-* [updateOnlineFlag](docs/sdks/properties/README.md#updateonlineflag) - Update subscriber online status
-
-### [subscribers.preferences](docs/sdks/preferences/README.md)
+#### [subscribers.preferences](docs/sdks/preferences/README.md)
 
 * [list](docs/sdks/preferences/README.md#list) - Get subscriber preferences
+* [updateGlobal](docs/sdks/preferences/README.md#updateglobal) - Update subscriber global preferences
 * [retrieveByLevel](docs/sdks/preferences/README.md#retrievebylevel) - Get subscriber preferences by level
 * [update](docs/sdks/preferences/README.md#update) - Update subscriber preference
-* [updateGlobal](docs/sdks/preferences/README.md#updateglobal) - Update subscriber global preferences
 
-### [tenants](docs/sdks/tenants/README.md)
+#### [subscribers.properties](docs/sdks/properties/README.md)
 
-* [create](docs/sdks/tenants/README.md#create) - Create tenant
-* [delete](docs/sdks/tenants/README.md#delete) - Delete tenant
-* [list](docs/sdks/tenants/README.md#list) - Get tenants
-* [retrieve](docs/sdks/tenants/README.md#retrieve) - Get tenant
-* [update](docs/sdks/tenants/README.md#update) - Update tenant
+* [updateOnlineFlag](docs/sdks/properties/README.md#updateonlineflag) - Update subscriber online status
 
 ### [topics](docs/sdks/topics/README.md)
 
 * [create](docs/sdks/topics/README.md#create) - Topic creation
-* [delete](docs/sdks/topics/README.md#delete) - Delete topic
 * [list](docs/sdks/topics/README.md#list) - Filter topics
-* [rename](docs/sdks/topics/README.md#rename) - Rename a topic
+* [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
 
-### [topics.subscribers](docs/sdks/novusubscribers/README.md)
+#### [topics.subscribers](docs/sdks/novusubscribers/README.md)
 
 * [assign](docs/sdks/novusubscribers/README.md#assign) - Subscribers addition
-* [delete](docs/sdks/novusubscribers/README.md#delete) - Subscribers removal
 * [retrieve](docs/sdks/novusubscribers/README.md#retrieve) - Check topic subscriber
+* [remove](docs/sdks/novusubscribers/README.md#remove) - Subscribers removal
 
-### [workflows](docs/sdks/workflows/README.md)
-
-* [create](docs/sdks/workflows/README.md#create) - Create workflow
-* [delete](docs/sdks/workflows/README.md#delete) - Delete workflow
-* [list](docs/sdks/workflows/README.md#list) - Get workflows
-* [retrieve](docs/sdks/workflows/README.md#retrieve) - Get workflow
-* [update](docs/sdks/workflows/README.md#update) - Update workflow
-
-### [workflows.variables](docs/sdks/variables/README.md)
-
-* [retrieve](docs/sdks/variables/README.md#retrieve) - Get available variables
-
-### [workflows.status](docs/sdks/status/README.md)
-
-* [update](docs/sdks/status/README.md#update) - Update workflow status
+</details>
 <!-- End Available Resources and Operations [operations] -->
 
+<!-- Start Standalone functions [standalone-funcs] -->
+## Standalone functions
+
+All the methods listed above are available as standalone functions. These
+functions are ideal for use in applications running in the browser, serverless
+runtimes or other environments where application bundle size is a primary
+concern. When using a bundler to build your application, all unused
+functionality will be either excluded from the final bundle or tree-shaken away.
+
+To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
+
+<details>
+
+<summary>Available standalone functions</summary>
+
+- [`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
+- [`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
+- [`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
+- [`subscribersPreferencesList`](docs/sdks/preferences/README.md#list) - Get subscriber preferences
+- [`subscribersPreferencesRetrieveByLevel`](docs/sdks/preferences/README.md#retrievebylevel) - Get subscriber preferences by level
+- [`subscribersPreferencesUpdate`](docs/sdks/preferences/README.md#update) - Update subscriber preference
+- [`subscribersPreferencesUpdateGlobal`](docs/sdks/preferences/README.md#updateglobal) - Update subscriber global preferences
+- [`subscribersPropertiesUpdateOnlineFlag`](docs/sdks/properties/README.md#updateonlineflag) - Update subscriber online status
+- [`subscribersRetrieve`](docs/sdks/subscribers/README.md#retrieve) - Get subscriber
+- [`subscribersUpdate`](docs/sdks/subscribers/README.md#update) - Update subscriber
+- [`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) - Filter topics
+- [`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
+- [`topicsSubscribersRetrieve`](docs/sdks/novusubscribers/README.md#retrieve) - Check topic subscriber
+- [`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
+
+</details>
+<!-- End Standalone functions [standalone-funcs] -->
+
 <!-- Start Pagination [pagination] -->
 ## Pagination
 
@@ -276,15 +395,16 @@ Here's an example of one such pagination call:
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-    apiKey: "<YOUR_API_KEY_HERE>",
+  apiKey: "<YOUR_API_KEY_HERE>",
 });
 
 async function run() {
-    const result = await novu.subscribers.list(7685.78, 10);
+  const result = await novu.subscribers.list();
 
-    for await (const page of result) {
-        // handle page
-    }
+  for await (const page of result) {
+    // Handle the page
+    console.log(page);
+  }
 }
 
 run();
@@ -295,59 +415,72 @@ run();
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
+All SDK methods return a response object or throw an error. By default, an API error will throw a `errors.SDKError`.
+
+If a HTTP request fails, an operation my also throw an error from the `models/errors/httpclienterrors.ts` module:
 
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+| 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                     |
 
-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 string since validation errors can list many issues and the plain error string may be difficult read when debugging. 
+In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. For example, the `trigger` method may throw the following errors:
 
+| Error Type      | Status Code | Content Type |
+| --------------- | ----------- | ------------ |
+| errors.SDKError | 4XX, 5XX    | \*/\*        |
 
 ```typescript
 import { Novu } from "@novu/api";
 import { SDKValidationError } from "@novu/api/models/errors";
 
 const novu = new Novu({
-    apiKey: "<YOUR_API_KEY_HERE>",
+  apiKey: "<YOUR_API_KEY_HERE>",
 });
 
 async function run() {
-    let result;
-    try {
-        result = await novu.trigger({
-            name: "workflow_identifier",
-            overrides: {},
-            payload: {},
-            to: [
-                {
-                    topicKey: "topic_key",
-                    type: "Topic",
-                },
-            ],
-        });
-    } catch (err) {
-        switch (true) {
-            case err instanceof SDKValidationError: {
-                // Validation errors can be pretty-printed
-                console.error(err.pretty());
-                // Raw value may also be inspected
-                console.error(err.rawValue);
-                return;
-            }
-            default: {
-                throw err;
-            }
-        }
-    }
+  let result;
+  try {
+    result = await novu.trigger({
+      name: "workflow_identifier",
+      to: [
+        {
+          topicKey: "<value>",
+          type: "Topic",
+        },
+        {
+          topicKey: "<value>",
+          type: "Topic",
+        },
+      ],
+    });
 
     // Handle the result
     console.log(result);
+  } catch (err) {
+    switch (true) {
+      case (err instanceof SDKValidationError): {
+        // Validation errors can be pretty-printed
+        console.error(err.pretty());
+        // Raw value may also be inspected
+        console.error(err.rawValue);
+        return;
+      }
+      default: {
+        throw err;
+      }
+    }
+  }
 }
 
 run();
 
 ```
+
+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 string since validation errors can list many issues and the plain error string may be difficult read when debugging.
 <!-- End Error Handling [errors] -->
 
 <!-- Start Server Selection [server] -->
@@ -355,70 +488,74 @@ run();
 
 ### Select Server by Index
 
-You can override the default server globally by passing a server index to the `serverIdx` 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:
+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                   |
+| --- | ------------------------ |
+| 0   | `https://api.novu.co`    |
+| 1   | `https://eu.api.novu.co` |
 
-| # | Server | Variables |
-| - | ------ | --------- |
-| 0 | `https://api.novu.co` | None |
-| 1 | `https://eu.api.novu.co` | None |
+#### Example
 
 ```typescript
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-    serverIdx: 1,
-    apiKey: "<YOUR_API_KEY_HERE>",
+  serverIdx: 1,
+  apiKey: "<YOUR_API_KEY_HERE>",
 });
 
 async function run() {
-    const result = await novu.trigger({
-        name: "workflow_identifier",
-        overrides: {},
-        payload: {},
-        to: [
-            {
-                topicKey: "topic_key",
-                type: "Topic",
-            },
-        ],
-    });
+  const result = await novu.trigger({
+    name: "workflow_identifier",
+    to: [
+      {
+        topicKey: "<value>",
+        type: "Topic",
+      },
+      {
+        topicKey: "<value>",
+        type: "Topic",
+      },
+    ],
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
 
 ```
 
-
 ### Override Server URL Per-Client
 
-The default server can also be overridden globally by passing a URL to the `serverURL` optional parameter when initializing the SDK client instance. For example:
-
+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({
-    serverURL: "https://api.novu.co",
-    apiKey: "<YOUR_API_KEY_HERE>",
+  serverURL: "https://api.novu.co",
+  apiKey: "<YOUR_API_KEY_HERE>",
 });
 
 async function run() {
-    const result = await novu.trigger({
-        name: "workflow_identifier",
-        overrides: {},
-        payload: {},
-        to: [
-            {
-                topicKey: "topic_key",
-                type: "Topic",
-            },
-        ],
-    });
+  const result = await novu.trigger({
+    name: "workflow_identifier",
+    to: [
+      {
+        topicKey: "<value>",
+        type: "Topic",
+      },
+      {
+        topicKey: "<value>",
+        type: "Topic",
+      },
+    ],
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -482,33 +619,35 @@ const sdk = new Novu({ httpClient });
 
 This SDK supports the following security scheme globally:
 
-| Name     | Type     | Scheme   |
-| -------- | -------- | -------- |
-| `apiKey` | apiKey   | API key  |
+| Name     | Type   | Scheme  |
+| -------- | ------ | ------- |
+| `apiKey` | apiKey | API key |
 
 To authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example:
 ```typescript
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-    apiKey: "<YOUR_API_KEY_HERE>",
+  apiKey: "<YOUR_API_KEY_HERE>",
 });
 
 async function run() {
-    const result = await novu.trigger({
-        name: "workflow_identifier",
-        overrides: {},
-        payload: {},
-        to: [
-            {
-                topicKey: "topic_key",
-                type: "Topic",
-            },
-        ],
-    });
+  const result = await novu.trigger({
+    name: "workflow_identifier",
+    to: [
+      {
+        topicKey: "<value>",
+        type: "Topic",
+      },
+      {
+        topicKey: "<value>",
+        type: "Topic",
+      },
+    ],
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -526,38 +665,37 @@ To change the default retry strategy for a single API call, simply provide a ret
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-    apiKey: "<YOUR_API_KEY_HERE>",
+  apiKey: "<YOUR_API_KEY_HERE>",
 });
 
 async function run() {
-    const result = await novu.trigger(
-        {
-            name: "workflow_identifier",
-            overrides: {},
-            payload: {},
-            to: [
-                {
-                    topicKey: "topic_key",
-                    type: "Topic",
-                },
-            ],
-        },
-        {
-            retries: {
-                strategy: "backoff",
-                backoff: {
-                    initialInterval: 1,
-                    maxInterval: 50,
-                    exponent: 1.1,
-                    maxElapsedTime: 100,
-                },
-                retryConnectionErrors: false,
-            },
-        }
-    );
+  const result = await novu.trigger({
+    name: "workflow_identifier",
+    to: [
+      {
+        topicKey: "<value>",
+        type: "Topic",
+      },
+      {
+        topicKey: "<value>",
+        type: "Topic",
+      },
+    ],
+  }, {
+    retries: {
+      strategy: "backoff",
+      backoff: {
+        initialInterval: 1,
+        maxInterval: 50,
+        exponent: 1.1,
+        maxElapsedTime: 100,
+      },
+      retryConnectionErrors: false,
+    },
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -569,34 +707,36 @@ If you'd like to override the default retry strategy for all operations that sup
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-    retryConfig: {
-        strategy: "backoff",
-        backoff: {
-            initialInterval: 1,
-            maxInterval: 50,
-            exponent: 1.1,
-            maxElapsedTime: 100,
-        },
-        retryConnectionErrors: false,
+  retryConfig: {
+    strategy: "backoff",
+    backoff: {
+      initialInterval: 1,
+      maxInterval: 50,
+      exponent: 1.1,
+      maxElapsedTime: 100,
     },
-    apiKey: "<YOUR_API_KEY_HERE>",
+    retryConnectionErrors: false,
+  },
+  apiKey: "<YOUR_API_KEY_HERE>",
 });
 
 async function run() {
-    const result = await novu.trigger({
-        name: "workflow_identifier",
-        overrides: {},
-        payload: {},
-        to: [
-            {
-                topicKey: "topic_key",
-                type: "Topic",
-            },
-        ],
-    });
+  const result = await novu.trigger({
+    name: "workflow_identifier",
+    to: [
+      {
+        topicKey: "<value>",
+        type: "Topic",
+      },
+      {
+        topicKey: "<value>",
+        type: "Topic",
+      },
+    ],
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -604,6 +744,23 @@ run();
 ```
 <!-- End Retries [retries] -->
 
+<!-- Start Debugging [debug] -->
+## Debugging
+
+You can setup your SDK to emit debug logs for SDK requests and responses.
+
+You can pass a logger that matches `console`'s interface as an SDK option.
+
+> [!WARNING]
+> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
+
+```typescript
+import { Novu } from "@novu/api";
+
+const sdk = new Novu({ debugLogger: console });
+```
+<!-- End Debugging [debug] -->
+
 <!-- Placeholder for Future Speakeasy SDK Sections -->
 
 # Development