@novu/api 0.3.0 → 2.6.6

package/README.md

@@ -1,11 +1,19 @@
-<div align="center">
-  <img src="https://raw.githubusercontent.com/novuhq/novu-ts/HEAD/assets/banner.png" width="500">
-  <p>Novu is an open-source notification infrastructure.</p>
-  <a href="https://docs.novu.co/api-reference/overview"><img src="https://img.shields.io/static/v1?label=Docs&message=API Ref&color=000000&style=for-the-badge" /></a>
-  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge" /></a>
+# @novu/api
+
+Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@novu/api* API.
+
+<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>
 
 
+<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.
+
 <!-- Start Summary [summary] -->
 ## Summary
 
@@ -17,17 +25,19 @@ 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)
@@ -38,30 +48,42 @@ 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 @novu/api
+npm add <UNSET>
+# Install optional peer dependencies if you plan to use React hooks
+npm add @tanstack/react-query react react-dom
 ```
 
 ### PNPM
 
 ```bash
-pnpm add @novu/api
+pnpm add <UNSET>
+# Install optional peer dependencies if you plan to use React hooks
+pnpm add @tanstack/react-query react react-dom
 ```
 
 ### Bun
 
 ```bash
-bun add @novu/api
+bun add <UNSET>
+# Install optional peer dependencies if you plan to use React hooks
+bun add @tanstack/react-query react react-dom
 ```
 
 ### Yarn
 
 ```bash
-yarn add @novu/api zod
+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.
@@ -83,7 +105,9 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -121,7 +145,9 @@ run();
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -205,7 +231,9 @@ run();
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -233,7 +261,9 @@ run();
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -248,6 +278,58 @@ 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 |
+
+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",
+  },
+});
+
+async function run() {
+  const result = await novu.trigger({
+    workflowId: "workflow_identifier",
+    payload: {
+      "comment_id": "string",
+      "post": {
+        "text": "string",
+      },
+    },
+    overrides: {
+      "fcm": {
+        "data": {
+          "key": "value",
+        },
+      },
+    },
+    to: {
+      subscriberId: "<id>",
+    },
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+
+```
+<!-- End Authentication [security] -->
+
 <!-- Start Available Resources and Operations [operations] -->
 ## Available Resources and Operations
 
@@ -345,6 +427,20 @@ run();
 * [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)
+* [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)
+
 </details>
 <!-- End Available Resources and Operations [operations] -->
 
@@ -409,10 +505,104 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`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)
 
 </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
 
@@ -429,7 +619,9 @@ Here's an example of one such pagination call:
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -446,6 +638,111 @@ run();
 ```
 <!-- End Pagination [pagination] -->
 
+<!-- Start Retries [retries] -->
+## Retries
+
+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({
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
+});
+
+async function run() {
+  const result = await novu.trigger({
+    workflowId: "workflow_identifier",
+    payload: {
+      "comment_id": "string",
+      "post": {
+        "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,
+    },
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+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:
+```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",
+  },
+});
+
+async function run() {
+  const result = await novu.trigger({
+    workflowId: "workflow_identifier",
+    payload: {
+      "comment_id": "string",
+      "post": {
+        "text": "string",
+      },
+    },
+    overrides: {
+      "fcm": {
+        "data": {
+          "key": "value",
+        },
+      },
+    },
+    to: {
+      subscriberId: "<id>",
+    },
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+
+```
+<!-- End Retries [retries] -->
+
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
@@ -470,7 +767,9 @@ import {
 } from "@novu/api/models/errors";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -560,10 +859,10 @@ In some rare cases, the SDK can fail to get a response from the server or even m
 
 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` |             |
+| #   | Server                   |
+| --- | ------------------------ |
+| 0   | `https://api.novu.co`    |
+| 1   | `https://eu.api.novu.co` |
 
 #### Example
 
@@ -572,7 +871,9 @@ import { Novu } from "@novu/api";
 
 const novu = new Novu({
   serverIdx: 1,
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -612,7 +913,9 @@ import { Novu } from "@novu/api";
 
 const novu = new Novu({
   serverURL: "https://api.novu.co",
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -694,156 +997,6 @@ const sdk = new Novu({ httpClient });
 ```
 <!-- End Custom HTTP Client [http-client] -->
 
-<!-- Start Authentication [security] -->
-## Authentication
-
-### Per-Client Security Schemes
-
-This SDK supports the following security scheme globally:
-
-| 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({
-  secretKey: "YOUR_SECRET_KEY_HERE",
-});
-
-async function run() {
-  const result = await novu.trigger({
-    workflowId: "workflow_identifier",
-    payload: {
-      "comment_id": "string",
-      "post": {
-        "text": "string",
-      },
-    },
-    overrides: {
-      "fcm": {
-        "data": {
-          "key": "value",
-        },
-      },
-    },
-    to: {
-      subscriberId: "<id>",
-    },
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-
-```
-<!-- End Authentication [security] -->
-
-<!-- Start Retries [retries] -->
-## Retries
-
-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({
-  secretKey: "YOUR_SECRET_KEY_HERE",
-});
-
-async function run() {
-  const result = await novu.trigger({
-    workflowId: "workflow_identifier",
-    payload: {
-      "comment_id": "string",
-      "post": {
-        "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,
-    },
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-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:
-```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,
-  },
-  secretKey: "YOUR_SECRET_KEY_HERE",
-});
-
-async function run() {
-  const result = await novu.trigger({
-    workflowId: "workflow_identifier",
-    payload: {
-      "comment_id": "string",
-      "post": {
-        "text": "string",
-      },
-    },
-    overrides: {
-      "fcm": {
-        "data": {
-          "key": "value",
-        },
-      },
-    },
-    to: {
-      subscriberId: "<id>",
-    },
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-
-```
-<!-- End Retries [retries] -->
-
 <!-- Start Debugging [debug] -->
 ## Debugging
 
@@ -873,7 +1026,7 @@ looking for the latest version.
 
 ## Contributions
 
-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!
+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. 
 
-### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
+### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=@novu/api&utm_campaign=typescript)