@novu/api 0.0.1-alpha.160 → 0.0.1-alpha.161

package/README.md

@@ -412,7 +412,7 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.subscribers.list({});
+  const result = await novu.subscribers.list();
 
   for await (const page of result) {
     // Handle the page

package/docs/sdks/credentials/README.md

@@ -24,14 +24,11 @@ const novu = new Novu({
 
 async function run() {
   const result = await novu.subscribers.credentials.update({
-    subscriberId: "<id>",
-    updateSubscriberChannelRequestDto: {
-      providerId: "pushpad",
-      credentials: {
-        webhookUrl: "https://example.com/webhook",
-      },
+    providerId: "pushpad",
+    credentials: {
+      webhookUrl: "https://example.com/webhook",
     },
-  });
+  }, "<id>");
 
   // Handle the result
   console.log(result);
@@ -56,14 +53,11 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await subscribersCredentialsUpdate(novu, {
-    subscriberId: "<id>",
-    updateSubscriberChannelRequestDto: {
-      providerId: "pushpad",
-      credentials: {
-        webhookUrl: "https://example.com/webhook",
-      },
+    providerId: "pushpad",
+    credentials: {
+      webhookUrl: "https://example.com/webhook",
     },
-  });
+  }, "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -82,7 +76,9 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.SubscribersControllerUpdateSubscriberChannelRequest](../../models/operations/subscriberscontrollerupdatesubscriberchannelrequest.md)                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `subscriberId`                                                                                                                                                                 | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `updateSubscriberChannelRequestDto`                                                                                                                                            | [components.UpdateSubscriberChannelRequestDto](../../models/components/updatesubscriberchannelrequestdto.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.                                                                                                               |
@@ -116,14 +112,11 @@ const novu = new Novu({
 
 async function run() {
   const result = await novu.subscribers.credentials.append({
-    subscriberId: "<id>",
-    updateSubscriberChannelRequestDto: {
-      providerId: "zulip",
-      credentials: {
-        webhookUrl: "https://example.com/webhook",
-      },
+    providerId: "zulip",
+    credentials: {
+      webhookUrl: "https://example.com/webhook",
     },
-  });
+  }, "<id>");
 
   // Handle the result
   console.log(result);
@@ -148,14 +141,11 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await subscribersCredentialsAppend(novu, {
-    subscriberId: "<id>",
-    updateSubscriberChannelRequestDto: {
-      providerId: "zulip",
-      credentials: {
-        webhookUrl: "https://example.com/webhook",
-      },
+    providerId: "zulip",
+    credentials: {
+      webhookUrl: "https://example.com/webhook",
     },
-  });
+  }, "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -174,7 +164,9 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.SubscribersControllerModifySubscriberChannelRequest](../../models/operations/subscriberscontrollermodifysubscriberchannelrequest.md)                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `subscriberId`                                                                                                                                                                 | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `updateSubscriberChannelRequestDto`                                                                                                                                            | [components.UpdateSubscriberChannelRequestDto](../../models/components/updatesubscriberchannelrequestdto.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.                                                                                                               |
@@ -205,10 +197,7 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.subscribers.credentials.delete({
-    subscriberId: "<id>",
-    providerId: "<id>",
-  });
+  const result = await novu.subscribers.credentials.delete("<id>", "<id>");
 
   // Handle the result
   console.log(result);
@@ -232,10 +221,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await subscribersCredentialsDelete(novu, {
-    subscriberId: "<id>",
-    providerId: "<id>",
-  });
+  const res = await subscribersCredentialsDelete(novu, "<id>", "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -254,7 +240,9 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.SubscribersControllerDeleteSubscriberCredentialsRequest](../../models/operations/subscriberscontrollerdeletesubscribercredentialsrequest.md)                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `subscriberId`                                                                                                                                                                 | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `providerId`                                                                                                                                                                   | *string*                                                                                                                                                                       | :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.                                                                                                               |

package/docs/sdks/integrations/README.md

@@ -258,10 +258,7 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.integrations.update({
-    integrationId: "<id>",
-    updateIntegrationRequestDto: {},
-  });
+  const result = await novu.integrations.update({}, "<id>");
 
   // Handle the result
   console.log(result);
@@ -285,10 +282,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await integrationsUpdate(novu, {
-    integrationId: "<id>",
-    updateIntegrationRequestDto: {},
-  });
+  const res = await integrationsUpdate(novu, {}, "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -307,7 +301,9 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.IntegrationsControllerUpdateIntegrationByIdRequest](../../models/operations/integrationscontrollerupdateintegrationbyidrequest.md)                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `integrationId`                                                                                                                                                                | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `updateIntegrationRequestDto`                                                                                                                                                  | [components.UpdateIntegrationRequestDto](../../models/components/updateintegrationrequestdto.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.                                                                                                               |

package/docs/sdks/messages/README.md

@@ -175,9 +175,7 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.messages.deleteByTransactionId({
-    transactionId: "<id>",
-  });
+  const result = await novu.messages.deleteByTransactionId("<id>");
 
   // Handle the result
   console.log(result);
@@ -201,9 +199,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await messagesDeleteByTransactionId(novu, {
-    transactionId: "<id>",
-  });
+  const res = await messagesDeleteByTransactionId(novu, "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -222,7 +218,9 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.MessagesControllerDeleteMessagesByTransactionIdRequest](../../models/operations/messagescontrollerdeletemessagesbytransactionidrequest.md)                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `transactionId`                                                                                                                                                                | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `idempotencyKey`                                                                                                                                                               | *string*                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                             | A header for idempotency purposes                                                                                                                                              |
+| `channel`                                                                                                                                                                      | [operations.Channel](../../models/operations/channel.md)                                                                                                                       | :heavy_minus_sign:                                                                                                                                                             | The channel of the message to be deleted                                                                                                                                       |
 | `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.                                                                                                               |

package/docs/sdks/novumessages/README.md

@@ -24,12 +24,9 @@ const novu = new Novu({
 
 async function run() {
   const result = await novu.subscribers.messages.markAllAs({
-    subscriberId: "<id>",
-    messageMarkAsRequestDto: {
-      messageId: "<value>",
-      markAs: "read",
-    },
-  });
+    messageId: "<value>",
+    markAs: "read",
+  }, "<id>");
 
   // Handle the result
   console.log(result);
@@ -54,12 +51,9 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await subscribersMessagesMarkAllAs(novu, {
-    subscriberId: "<id>",
-    messageMarkAsRequestDto: {
-      messageId: "<value>",
-      markAs: "read",
-    },
-  });
+    messageId: "<value>",
+    markAs: "read",
+  }, "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -78,7 +72,9 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.SubscribersControllerMarkMessagesAsRequest](../../models/operations/subscriberscontrollermarkmessagesasrequest.md)                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `subscriberId`                                                                                                                                                                 | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `messageMarkAsRequestDto`                                                                                                                                                      | [components.MessageMarkAsRequestDto](../../models/components/messagemarkasrequestdto.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.                                                                                                               |
@@ -110,11 +106,8 @@ const novu = new Novu({
 
 async function run() {
   const result = await novu.subscribers.messages.markAll({
-    subscriberId: "<id>",
-    markAllMessageAsRequestDto: {
-      markAs: "seen",
-    },
-  });
+    markAs: "seen",
+  }, "<id>");
 
   // Handle the result
   console.log(result);
@@ -139,11 +132,8 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await subscribersMessagesMarkAll(novu, {
-    subscriberId: "<id>",
-    markAllMessageAsRequestDto: {
-      markAs: "seen",
-    },
-  });
+    markAs: "seen",
+  }, "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -162,7 +152,9 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.SubscribersControllerMarkAllUnreadAsReadRequest](../../models/operations/subscriberscontrollermarkallunreadasreadrequest.md)                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `subscriberId`                                                                                                                                                                 | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `markAllMessageAsRequestDto`                                                                                                                                                   | [components.MarkAllMessageAsRequestDto](../../models/components/markallmessageasrequestdto.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.                                                                                                               |

package/docs/sdks/novusubscribers/README.md

@@ -24,15 +24,12 @@ const novu = new Novu({
 
 async function run() {
   const result = await novu.topics.subscribers.assign({
-    topicKey: "<value>",
-    addSubscribersRequestDto: {
-      subscribers: [
-        "<value>",
-        "<value>",
-        "<value>",
-      ],
-    },
-  });
+    subscribers: [
+      "<value>",
+      "<value>",
+      "<value>",
+    ],
+  }, "<value>");
 
   // Handle the result
   console.log(result);
@@ -57,15 +54,12 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await topicsSubscribersAssign(novu, {
-    topicKey: "<value>",
-    addSubscribersRequestDto: {
-      subscribers: [
-        "<value>",
-        "<value>",
-        "<value>",
-      ],
-    },
-  });
+    subscribers: [
+      "<value>",
+      "<value>",
+      "<value>",
+    ],
+  }, "<value>");
 
   if (!res.ok) {
     throw res.error;
@@ -84,7 +78,9 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.TopicsControllerAssignRequest](../../models/operations/topicscontrollerassignrequest.md)                                                                           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `topicKey`                                                                                                                                                                     | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | The topic key                                                                                                                                                                  |
+| `addSubscribersRequestDto`                                                                                                                                                     | [components.AddSubscribersRequestDto](../../models/components/addsubscribersrequestdto.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.                                                                                                               |
@@ -115,10 +111,7 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.topics.subscribers.retrieve({
-    externalSubscriberId: "<id>",
-    topicKey: "<value>",
-  });
+  const result = await novu.topics.subscribers.retrieve("<id>", "<value>");
 
   // Handle the result
   console.log(result);
@@ -142,10 +135,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await topicsSubscribersRetrieve(novu, {
-    externalSubscriberId: "<id>",
-    topicKey: "<value>",
-  });
+  const res = await topicsSubscribersRetrieve(novu, "<id>", "<value>");
 
   if (!res.ok) {
     throw res.error;
@@ -164,7 +154,9 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.TopicsControllerGetTopicSubscriberRequest](../../models/operations/topicscontrollergettopicsubscriberrequest.md)                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `externalSubscriberId`                                                                                                                                                         | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | The external subscriber id                                                                                                                                                     |
+| `topicKey`                                                                                                                                                                     | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | The topic key                                                                                                                                                                  |
+| `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.                                                                                                               |
@@ -196,14 +188,11 @@ const novu = new Novu({
 
 async function run() {
   const result = await novu.topics.subscribers.remove({
-    topicKey: "<value>",
-    removeSubscribersRequestDto: {
-      subscribers: [
-        "<value>",
-        "<value>",
-      ],
-    },
-  });
+    subscribers: [
+      "<value>",
+      "<value>",
+    ],
+  }, "<value>");
 
   // Handle the result
   console.log(result);
@@ -228,14 +217,11 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await topicsSubscribersRemove(novu, {
-    topicKey: "<value>",
-    removeSubscribersRequestDto: {
-      subscribers: [
-        "<value>",
-        "<value>",
-      ],
-    },
-  });
+    subscribers: [
+      "<value>",
+      "<value>",
+    ],
+  }, "<value>");
 
   if (!res.ok) {
     throw res.error;
@@ -254,7 +240,9 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.TopicsControllerRemoveSubscribersRequest](../../models/operations/topicscontrollerremovesubscribersrequest.md)                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `topicKey`                                                                                                                                                                     | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | The topic key                                                                                                                                                                  |
+| `removeSubscribersRequestDto`                                                                                                                                                  | [components.RemoveSubscribersRequestDto](../../models/components/removesubscribersrequestdto.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.                                                                                                               |

package/docs/sdks/preferences/README.md

@@ -24,9 +24,7 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.subscribers.preferences.list({
-    subscriberId: "<id>",
-  });
+  const result = await novu.subscribers.preferences.list("<id>");
 
   // Handle the result
   console.log(result);
@@ -50,9 +48,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await subscribersPreferencesList(novu, {
-    subscriberId: "<id>",
-  });
+  const res = await subscribersPreferencesList(novu, "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -71,7 +67,9 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.SubscribersControllerListSubscriberPreferencesRequest](../../models/operations/subscriberscontrollerlistsubscriberpreferencesrequest.md)                           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `subscriberId`                                                                                                                                                                 | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `idempotencyKey`                                                                                                                                                               | *string*                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                             | A header for idempotency purposes                                                                                                                                              |
+| `includeInactiveChannels`                                                                                                                                                      | *boolean*                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                             | A flag which specifies if the inactive workflow channels should be included in the retrieved preferences. Default is true                                                      |
 | `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.                                                                                                               |
@@ -102,10 +100,7 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.subscribers.preferences.updateGlobal({
-    subscriberId: "<id>",
-    updateSubscriberGlobalPreferencesRequestDto: {},
-  });
+  const result = await novu.subscribers.preferences.updateGlobal({}, "<id>");
 
   // Handle the result
   console.log(result);
@@ -129,10 +124,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await subscribersPreferencesUpdateGlobal(novu, {
-    subscriberId: "<id>",
-    updateSubscriberGlobalPreferencesRequestDto: {},
-  });
+  const res = await subscribersPreferencesUpdateGlobal(novu, {}, "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -151,7 +143,9 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.SubscribersControllerUpdateSubscriberGlobalPreferencesRequest](../../models/operations/subscriberscontrollerupdatesubscriberglobalpreferencesrequest.md)           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `subscriberId`                                                                                                                                                                 | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `updateSubscriberGlobalPreferencesRequestDto`                                                                                                                                  | [components.UpdateSubscriberGlobalPreferencesRequestDto](../../models/components/updatesubscriberglobalpreferencesrequestdto.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.                                                                                                               |