@novu/api 1.5.0 → 1.6.0

package/docs/sdks/credentials/README.md

@@ -6,7 +6,7 @@
 ### Available Operations
 
 * [update](#update) - Upsert provider credentials
-* [append](#append) - Create or Partially Update provider credentials
+* [append](#append) - Update provider credentials
 * [delete](#delete) - Delete provider credentials
 
 ## update
@@ -16,6 +16,7 @@ Upsert credentials for a provider such as slack and push tokens.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="SubscribersV1Controller_updateSubscriberChannel" method="put" path="/v1/subscribers/{subscriberId}/credentials" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -118,11 +119,12 @@ run();
 
 ## append
 
-Create or Partially credentials for a provider such as **slack** and **FCM**. 
+Update credentials for a provider such as **slack** and **FCM**. 
       **providerId** is required field. This API creates the **deviceTokens** or replaces the existing ones.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="SubscribersV1Controller_modifySubscriberChannel" method="patch" path="/v1/subscribers/{subscriberId}/credentials" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -230,6 +232,7 @@ Delete subscriber credentials for a provider such as **slack** and **FCM** by **
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="SubscribersV1Controller_deleteSubscriberCredentials" method="delete" path="/v1/subscribers/{subscriberId}/credentials/{providerId}" -->
 ```typescript
 import { Novu } from "@novu/api";
 

package/docs/sdks/environments/README.md

@@ -20,6 +20,7 @@ Retrieve all unique tags used in workflows within the specified environment. The
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="EnvironmentsController_getEnvironmentTags" method="get" path="/v2/environments/{environmentId}/tags" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -95,6 +96,7 @@ Creates a new environment within the current organization.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="EnvironmentsControllerV1_createEnvironment" method="post" path="/v1/environments" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -177,6 +179,7 @@ This API returns a list of environments for the current organization.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="EnvironmentsControllerV1_listMyEnvironments" method="get" path="/v1/environments" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -250,6 +253,7 @@ Update an environment by its unique identifier **environmentId**.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="EnvironmentsControllerV1_updateMyEnvironment" method="put" path="/v1/environments/{environmentId}" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -325,6 +329,7 @@ Delete an environment by its unique identifier **environmentId**.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="EnvironmentsControllerV1_deleteEnvironment" method="delete" path="/v1/environments/{environmentId}" -->
 ```typescript
 import { Novu } from "@novu/api";
 

package/docs/sdks/integrations/README.md

@@ -21,6 +21,7 @@ List all the channels integrations created in the organization
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="IntegrationsController_listIntegrations" method="get" path="/v1/integrations" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -94,6 +95,7 @@ Create an integration for the current environment the user is based on the API k
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="IntegrationsController_createIntegration" method="post" path="/v1/integrations" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -174,6 +176,7 @@ Update an integration by its unique key identifier **integrationId**.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="IntegrationsController_updateIntegrationById" method="put" path="/v1/integrations/{integrationId}" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -249,6 +252,7 @@ Delete an integration by its unique key identifier **integrationId**.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="IntegrationsController_removeIntegration" method="delete" path="/v1/integrations/{integrationId}" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -324,6 +328,7 @@ Update an integration as **primary** by its unique key identifier **integrationI
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="IntegrationsController_setIntegrationAsPrimary" method="post" path="/v1/integrations/{integrationId}/set-primary" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -397,6 +402,7 @@ List all the active integrations created in the organization
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="IntegrationsController_getActiveIntegrations" method="get" path="/v1/integrations/active" -->
 ```typescript
 import { Novu } from "@novu/api";
 

package/docs/sdks/messages/README.md

@@ -20,6 +20,7 @@ List all messages for the current environment.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="MessagesController_getMessages" method="get" path="/v1/messages" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -93,6 +94,7 @@ Delete a message entity from the Novu platform by **messageId**.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="MessagesController_deleteMessage" method="delete" path="/v1/messages/{messageId}" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -167,6 +169,7 @@ Delete multiple messages from the Novu platform using **transactionId** of trigg
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="MessagesController_deleteMessagesByTransactionId" method="delete" path="/v1/messages/transaction/{transactionId}" -->
 ```typescript
 import { Novu } from "@novu/api";
 

package/docs/sdks/notifications/README.md

@@ -17,6 +17,7 @@ List all notification events (triggered events) for the current environment.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="NotificationsController_listNotifications" method="get" path="/v1/notifications" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -91,6 +92,7 @@ Retrieve an event by its unique key identifier **notificationId**.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="NotificationsController_getNotification" method="get" path="/v1/notifications/{notificationId}" -->
 ```typescript
 import { Novu } from "@novu/api";
 

package/docs/sdks/novu/README.md

@@ -13,18 +13,16 @@ Novu Documentation
 * [cancel](#cancel) - Cancel triggered event
 * [triggerBroadcast](#triggerbroadcast) - Broadcast event to all
 * [triggerBulk](#triggerbulk) - Bulk trigger event
-* [retrieve](#retrieve)
 
 ## trigger
 
 
-    Trigger event is the main (and only) way to send notifications to subscribers. 
-    The trigger identifier is used to match the particular workflow associated with it. 
-    Additional information can be passed according the body interface below.
-    
+    Trigger event is the main (and only) way to send notifications to subscribers. The trigger identifier is used to match the particular workflow associated with it. Additional information can be passed according the body interface below.
+    To prevent duplicate triggers, you can optionally pass a **transactionId** in the request body. If the same **transactionId** is used again, the trigger will be ignored. The retention period depends on your billing tier.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="EventsController_trigger" method="post" path="/v1/events/trigger" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -122,6 +120,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="EventsController_cancel" method="delete" path="/v1/events/trigger/{transactionId}" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -196,6 +195,7 @@ Trigger a broadcast event to all existing subscribers, could be used to send ann
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="EventsController_broadcastEventToAll" method="post" path="/v1/events/trigger/broadcast" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -307,6 +307,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="EventsController_triggerBulk" method="post" path="/v1/events/trigger/bulk" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -445,70 +446,4 @@ run();
 | errors.ErrorDto                      | 401, 403, 404, 405, 409, 413, 415    | application/json                     |
 | errors.ValidationErrorDto            | 422                                  | application/json                     |
 | errors.ErrorDto                      | 500                                  | application/json                     |
-| errors.SDKError                      | 4XX, 5XX                             | \*/\*                                |
-
-## retrieve
-
-### Example Usage
-
-```typescript
-import { Novu } from "@novu/api";
-
-const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
-});
-
-async function run() {
-  const result = await novu.retrieve({});
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { NovuCore } from "@novu/api/core.js";
-import { retrieve } from "@novu/api/funcs/retrieve.js";
-
-// Use `NovuCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const novu = new NovuCore({
-  secretKey: "YOUR_SECRET_KEY_HERE",
-});
-
-async function run() {
-  const res = await retrieve(novu, {});
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("retrieve failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.LogsControllerGetLogsRequest](../../models/operations/logscontrollergetlogsrequest.md)                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[operations.LogsControllerGetLogsResponseBody](../../models/operations/logscontrollergetlogsresponsebody.md)\>**
-
-### Errors
-
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4XX, 5XX        | \*/\*           |
+| errors.SDKError                      | 4XX, 5XX                             | \*/\*                                |

package/docs/sdks/novumessages/README.md

@@ -16,6 +16,7 @@ Update in-app (inbox) notification's action status by its unique key identifier
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="SubscribersV1Controller_markActionAsSeen" method="post" path="/v1/subscribers/{subscriberId}/messages/{messageId}/actions/{type}" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -102,6 +103,7 @@ Update all subscriber in-app (inbox) notifications state such as read, unread, s
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="SubscribersV1Controller_markAllUnreadAsRead" method="post" path="/v1/subscribers/{subscriberId}/messages/mark-all" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -181,6 +183,7 @@ Update subscriber's multiple in-app (inbox) notifications state such as seen, re
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="SubscribersV1Controller_markMessagesAs" method="post" path="/v1/subscribers/{subscriberId}/messages/mark-as" -->
 ```typescript
 import { Novu } from "@novu/api";
 

package/docs/sdks/novunotifications/README.md

@@ -14,6 +14,7 @@ Retrieve subscriber in-app (inbox) notifications by its unique key identifier **
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="SubscribersV1Controller_getNotificationsFeed" method="get" path="/v1/subscribers/{subscriberId}/notifications/feed" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -92,6 +93,7 @@ Retrieve unseen in-app (inbox) notifications count for a subscriber by its uniqu
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="SubscribersV1Controller_getUnseenCount" method="get" path="/v1/subscribers/{subscriberId}/notifications/unseen" -->
 ```typescript
 import { Novu } from "@novu/api";
 

package/docs/sdks/novusubscribers/README.md

@@ -13,6 +13,7 @@ Check if a subscriber belongs to a certain topic
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="TopicsV1Controller_getTopicSubscriber" method="get" path="/v1/topics/{topicKey}/subscribers/{externalSubscriberId}" -->
 ```typescript
 import { Novu } from "@novu/api";
 

package/docs/sdks/novutopics/README.md

@@ -14,6 +14,7 @@ Retrieve subscriber's topic subscriptions by its unique key identifier **subscri
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="SubscribersController_listSubscriberTopics" method="get" path="/v2/subscribers/{subscriberId}/subscriptions" -->
 ```typescript
 import { Novu } from "@novu/api";
 

package/docs/sdks/preferences/README.md

@@ -7,6 +7,7 @@
 
 * [list](#list) - Retrieve subscriber preferences
 * [update](#update) - Update subscriber preferences
+* [bulkUpdate](#bulkupdate) - Bulk update subscriber preferences
 
 ## list
 
@@ -15,6 +16,7 @@ Retrieve subscriber channel preferences by its unique key identifier **subscribe
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="SubscribersController_getSubscriberPreferences" method="get" path="/v2/subscribers/{subscriberId}/preferences" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -90,6 +92,7 @@ Update subscriber preferences by its unique key identifier **subscriberId**.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="SubscribersController_updateSubscriberPreferences" method="patch" path="/v2/subscribers/{subscriberId}/preferences" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -154,6 +157,86 @@ run();
 
 ### Errors
 
+| 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                               | \*/\*                                  |
+
+## bulkUpdate
+
+Bulk update subscriber preferences by its unique key identifier **subscriberId**. 
+    This API allows updating multiple workflow preferences in a single request.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="SubscribersController_bulkUpdateSubscriberPreferences" method="patch" path="/v2/subscribers/{subscriberId}/preferences/bulk" -->
+```typescript
+import { Novu } from "@novu/api";
+
+const novu = new Novu({
+  secretKey: "YOUR_SECRET_KEY_HERE",
+});
+
+async function run() {
+  const result = await novu.subscribers.preferences.bulkUpdate({
+    preferences: [],
+  }, "<id>");
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { NovuCore } from "@novu/api/core.js";
+import { subscribersPreferencesBulkUpdate } from "@novu/api/funcs/subscribersPreferencesBulkUpdate.js";
+
+// Use `NovuCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const novu = new NovuCore({
+  secretKey: "YOUR_SECRET_KEY_HERE",
+});
+
+async function run() {
+  const res = await subscribersPreferencesBulkUpdate(novu, {
+    preferences: [],
+  }, "<id>");
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("subscribersPreferencesBulkUpdate failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `subscriberId`                                                                                                                                                                 | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `bulkUpdateSubscriberPreferencesDto`                                                                                                                                           | [components.BulkUpdateSubscriberPreferencesDto](../../models/components/bulkupdatesubscriberpreferencesdto.md)                                                                 | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `idempotencyKey`                                                                                                                                                               | *string*                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                             | A header for idempotency purposes                                                                                                                                              |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.SubscribersControllerBulkUpdateSubscriberPreferencesResponse](../../models/operations/subscriberscontrollerbulkupdatesubscriberpreferencesresponse.md)\>**
+
+### Errors
+
 | Error Type                             | Status Code                            | Content Type                           |
 | -------------------------------------- | -------------------------------------- | -------------------------------------- |
 | errors.ErrorDto                        | 414                                    | application/json                       |

package/docs/sdks/properties/README.md

@@ -13,6 +13,7 @@ Update the subscriber online status by its unique key identifier **subscriberId*
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="SubscribersV1Controller_updateSubscriberOnlineFlag" method="patch" path="/v1/subscribers/{subscriberId}/online-status" -->
 ```typescript
 import { Novu } from "@novu/api";
 

package/docs/sdks/steps/README.md

@@ -13,6 +13,7 @@ Retrieves data for a specific step in a workflow
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="WorkflowController_getWorkflowStepData" method="get" path="/v2/workflows/{workflowId}/steps/{stepId}" -->
 ```typescript
 import { Novu } from "@novu/api";
 

package/docs/sdks/subscribers/README.md

@@ -22,6 +22,7 @@ Search subscribers by their **email**, **phone**, **subscriberId** and **name**.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="SubscribersController_searchSubscribers" method="get" path="/v2/subscribers" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -95,6 +96,7 @@ Create a subscriber with the subscriber attributes.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="SubscribersController_createSubscriber" method="post" path="/v2/subscribers" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -147,6 +149,7 @@ run();
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | `createSubscriberRequestDto`                                                                                                                                                   | [components.CreateSubscriberRequestDto](../../models/components/createsubscriberrequestdto.md)                                                                                 | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `failIfExists`                                                                                                                                                                 | *boolean*                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                             | If true, the request will fail if a subscriber with the same subscriberId already exists                                                                                       |
 | `idempotencyKey`                                                                                                                                                               | *string*                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                             | A header for idempotency purposes                                                                                                                                              |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
@@ -158,13 +161,14 @@ run();
 
 ### Errors
 
-| 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                               | \*/\*                                  |
+| Error Type                        | Status Code                       | Content Type                      |
+| --------------------------------- | --------------------------------- | --------------------------------- |
+| errors.SubscriberResponseDto      | 409                               | application/json                  |
+| errors.ErrorDto                   | 414                               | application/json                  |
+| errors.ErrorDto                   | 400, 401, 403, 404, 405, 413, 415 | application/json                  |
+| errors.ValidationErrorDto         | 422                               | application/json                  |
+| errors.ErrorDto                   | 500                               | application/json                  |
+| errors.SDKError                   | 4XX, 5XX                          | \*/\*                             |
 
 ## retrieve
 
@@ -173,6 +177,7 @@ Retrieve a subscriber by its unique key identifier **subscriberId**.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="SubscribersController_getSubscriber" method="get" path="/v2/subscribers/{subscriberId}" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -247,6 +252,7 @@ Update a subscriber by its unique key identifier **subscriberId**.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="SubscribersController_patchSubscriber" method="patch" path="/v2/subscribers/{subscriberId}" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -322,6 +328,7 @@ Deletes a subscriber entity from the Novu platform along with associated message
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="SubscribersController_removeSubscriber" method="delete" path="/v2/subscribers/{subscriberId}" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -397,6 +404,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="SubscribersV1Controller_bulkCreateSubscribers" method="post" path="/v1/subscribers/bulk" -->
 ```typescript
 import { Novu } from "@novu/api";
 

package/docs/sdks/subscriptions/README.md

@@ -16,6 +16,7 @@ List all subscriptions of subscribers for a topic.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="TopicsController_listTopicSubscriptions" method="get" path="/v2/topics/{topicKey}/subscriptions" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -93,6 +94,7 @@ This api will create subscription for subscriberIds for a topic.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="TopicsController_createTopicSubscriptions" method="post" path="/v2/topics/{topicKey}/subscriptions" -->
 ```typescript
 import { Novu } from "@novu/api";
 
@@ -177,6 +179,7 @@ Delete subscriptions for subscriberIds for a topic.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="TopicsController_deleteTopicSubscriptions" method="delete" path="/v2/topics/{topicKey}/subscriptions" -->
 ```typescript
 import { Novu } from "@novu/api";