@novu/api 0.0.1-alpha.10 → 0.0.1-alpha.100

package/docs/sdks/subscribers/README.md

@@ -8,16 +8,16 @@ A subscriber in Novu represents someone who should receive a message. A subscrib
 
 ### Available Operations
 
-* [create](#create) - Create subscriber
-* [createBulk](#createbulk) - Bulk create subscribers
-* [delete](#delete) - Delete subscriber
 * [list](#list) - Get subscribers
+* [create](#create) - Create subscriber
 * [retrieve](#retrieve) - Get subscriber
 * [update](#update) - Update subscriber
+* [delete](#delete) - Delete subscriber
+* [createBulk](#createbulk) - Bulk create subscribers
 
-## create
+## list
 
-Creates a subscriber entity, in the Novu platform. The subscriber will be later used to receive notifications, and access notification feeds. Communication credentials such as email, phone number, and 3 rd party credentials i.e slack tokens could be later associated to this entity.
+Returns a list of subscribers, could paginated using the `page` and `limit` query parameter
 
 ### Example Usage
 
@@ -29,12 +29,12 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.subscribers.create({
-    subscriberId: "<value>",
-  });
+  const result = await novu.subscribers.list();
 
-  // Handle the result
-  console.log(result)
+  for await (const page of result) {
+    // Handle the page
+    console.log(page);
+  }
 }
 
 run();
@@ -46,7 +46,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { subscribersCreate } from "@novu/api/funcs/subscribersCreate.js";
+import { subscribersList } from "@novu/api/funcs/subscribersList.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -55,9 +55,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await subscribersCreate(novu, {
-    subscriberId: "<value>",
-  });
+  const res = await subscribersList(novu);
 
   if (!res.ok) {
     throw res.error;
@@ -65,8 +63,10 @@ async function run() {
 
   const { value: result } = res;
 
-  // Handle the result
-  console.log(result)
+  for await (const page of result) {
+    // Handle the page
+    console.log(page);
+  }
 }
 
 run();
@@ -76,28 +76,26 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.CreateSubscriberRequestDto](../../models/components/createsubscriberrequestdto.md)                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `page`                                                                                                                                                                         | *number*                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `limit`                                                                                                                                                                        | *number*                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                             | N/A                                                                                                                                                                            |
 | `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\<[components.SubscriberResponseDto](../../models/components/subscriberresponsedto.md)\>**
+**Promise\<[operations.SubscribersControllerListSubscribersResponse](../../models/operations/subscriberscontrollerlistsubscribersresponse.md)\>**
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
-
-## createBulk
+| Error Type       | Status Code      | Content Type     |
+| ---------------- | ---------------- | ---------------- |
+| errors.ErrorDto  | 400, 404, 409    | application/json |
+| errors.SDKError  | 4XX, 5XX         | \*/\*            |
 
+## create
 
-      Using this endpoint you can create multiple subscribers at once, to avoid multiple calls to the API.
-      The bulk API is limited to 500 subscribers per request.
-    
+Creates a subscriber entity, in the Novu platform. The subscriber will be later used to receive notifications, and access notification feeds. Communication credentials such as email, phone number, and 3 rd party credentials i.e slack tokens could be later associated to this entity.
 
 ### Example Usage
 
@@ -109,13 +107,12 @@ const novu = new Novu({
 });
 
 async function run() {
-  await novu.subscribers.createBulk({
-    subscribers: [
-      "<value>",
-    ],
+  const result = await novu.subscribers.create({
+    subscriberId: "<id>",
   });
 
-  
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -127,7 +124,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { subscribersCreateBulk } from "@novu/api/funcs/subscribersCreateBulk.js";
+import { subscribersCreate } from "@novu/api/funcs/subscribersCreate.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -136,10 +133,8 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await subscribersCreateBulk(novu, {
-    subscribers: [
-      "<value>",
-    ],
+  const res = await subscribersCreate(novu, {
+    subscriberId: "<id>",
   });
 
   if (!res.ok) {
@@ -148,7 +143,8 @@ async function run() {
 
   const { value: result } = res;
 
-  
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -158,25 +154,25 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.BulkSubscriberCreateDto](../../models/components/bulksubscribercreatedto.md)                                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [components.CreateSubscriberRequestDto](../../models/components/createsubscriberrequestdto.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\<void\>**
+**Promise\<[operations.SubscribersControllerCreateSubscriberResponse](../../models/operations/subscriberscontrollercreatesubscriberresponse.md)\>**
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| Error Type       | Status Code      | Content Type     |
+| ---------------- | ---------------- | ---------------- |
+| errors.ErrorDto  | 400, 404, 409    | application/json |
+| errors.SDKError  | 4XX, 5XX         | \*/\*            |
 
-## delete
+## retrieve
 
-Deletes a subscriber entity from the Novu platform
+Get subscriber by your internal id used to identify the subscriber
 
 ### Example Usage
 
@@ -188,10 +184,10 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.subscribers.delete("<value>");
+  const result = await novu.subscribers.retrieve("<id>");
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -203,7 +199,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { subscribersDelete } from "@novu/api/funcs/subscribersDelete.js";
+import { subscribersRetrieve } from "@novu/api/funcs/subscribersRetrieve.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -212,7 +208,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await subscribersDelete(novu, "<value>");
+  const res = await subscribersRetrieve(novu, "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -221,7 +217,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -232,24 +228,25 @@ run();
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | `subscriberId`                                                                                                                                                                 | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `includeTopics`                                                                                                                                                                | *boolean*                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                             | Includes the topics associated with the subscriber                                                                                                                             |
 | `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\<[components.DeleteSubscriberResponseDto](../../models/components/deletesubscriberresponsedto.md)\>**
+**Promise\<[operations.SubscribersControllerGetSubscriberResponse](../../models/operations/subscriberscontrollergetsubscriberresponse.md)\>**
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| Error Type       | Status Code      | Content Type     |
+| ---------------- | ---------------- | ---------------- |
+| errors.ErrorDto  | 400, 404, 409    | application/json |
+| errors.SDKError  | 4XX, 5XX         | \*/\*            |
 
-## list
+## update
 
-Returns a list of subscribers, could paginated using the `page` and `limit` query parameter
+Used to update the subscriber entity with new information
 
 ### Example Usage
 
@@ -261,12 +258,10 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.subscribers.list();
+  const result = await novu.subscribers.update({}, "<id>");
 
-  for await (const page of result) {
-    // Handle the page
-    console.log(page);
-  }
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -278,7 +273,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { subscribersList } from "@novu/api/funcs/subscribersList.js";
+import { subscribersUpdate } from "@novu/api/funcs/subscribersUpdate.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -287,7 +282,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await subscribersList(novu);
+  const res = await subscribersUpdate(novu, {}, "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -295,10 +290,8 @@ async function run() {
 
   const { value: result } = res;
 
-  for await (const page of result) {
-    // Handle the page
-    console.log(page);
-  }
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -308,26 +301,26 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `page`                                                                                                                                                                         | *number*                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                             | N/A                                                                                                                                                                            |
-| `limit`                                                                                                                                                                        | *number*                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `subscriberId`                                                                                                                                                                 | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `updateSubscriberRequestDto`                                                                                                                                                   | [components.UpdateSubscriberRequestDto](../../models/components/updatesubscriberrequestdto.md)                                                                                 | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
 | `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.SubscribersControllerListSubscribersResponse](../../models/operations/subscriberscontrollerlistsubscribersresponse.md)\>**
+**Promise\<[operations.SubscribersControllerUpdateSubscriberResponse](../../models/operations/subscriberscontrollerupdatesubscriberresponse.md)\>**
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| Error Type       | Status Code      | Content Type     |
+| ---------------- | ---------------- | ---------------- |
+| errors.ErrorDto  | 400, 404, 409    | application/json |
+| errors.SDKError  | 4XX, 5XX         | \*/\*            |
 
-## retrieve
+## delete
 
-Get subscriber by your internal id used to identify the subscriber
+Deletes a subscriber entity from the Novu platform
 
 ### Example Usage
 
@@ -339,10 +332,10 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.subscribers.retrieve("<value>");
+  const result = await novu.subscribers.delete("<id>");
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -354,7 +347,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { subscribersRetrieve } from "@novu/api/funcs/subscribersRetrieve.js";
+import { subscribersDelete } from "@novu/api/funcs/subscribersDelete.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -363,7 +356,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await subscribersRetrieve(novu, "<value>");
+  const res = await subscribersDelete(novu, "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -372,7 +365,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -389,18 +382,21 @@ run();
 
 ### Response
 
-**Promise\<[components.SubscriberResponseDto](../../models/components/subscriberresponsedto.md)\>**
+**Promise\<[operations.SubscribersControllerRemoveSubscriberResponse](../../models/operations/subscriberscontrollerremovesubscriberresponse.md)\>**
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+| Error Type       | Status Code      | Content Type     |
+| ---------------- | ---------------- | ---------------- |
+| errors.ErrorDto  | 400, 404, 409    | application/json |
+| errors.SDKError  | 4XX, 5XX         | \*/\*            |
 
+## createBulk
 
-## update
 
-Used to update the subscriber entity with new information
+      Using this endpoint you can create multiple subscribers at once, to avoid multiple calls to the API.
+      The bulk API is limited to 500 subscribers per request.
+    
 
 ### Example Usage
 
@@ -412,10 +408,14 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.subscribers.update("<value>", {});
+  const result = await novu.subscribers.createBulk({
+    subscribers: [
+      "<value>",
+    ],
+  });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -427,7 +427,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { subscribersUpdate } from "@novu/api/funcs/subscribersUpdate.js";
+import { subscribersCreateBulk } from "@novu/api/funcs/subscribersCreateBulk.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -436,7 +436,11 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await subscribersUpdate(novu, "<value>", {});
+  const res = await subscribersCreateBulk(novu, {
+    subscribers: [
+      "<value>",
+    ],
+  });
 
   if (!res.ok) {
     throw res.error;
@@ -445,7 +449,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -455,18 +459,18 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `subscriberId`                                                                                                                                                                 | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
-| `updateSubscriberRequestDto`                                                                                                                                                   | [components.UpdateSubscriberRequestDto](../../models/components/updatesubscriberrequestdto.md)                                                                                 | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `request`                                                                                                                                                                      | [components.BulkSubscriberCreateDto](../../models/components/bulksubscribercreatedto.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\<[components.SubscriberResponseDto](../../models/components/subscriberresponsedto.md)\>**
+**Promise\<[operations.SubscribersControllerBulkCreateSubscribersResponse](../../models/operations/subscriberscontrollerbulkcreatesubscribersresponse.md)\>**
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+| Error Type       | Status Code      | Content Type     |
+| ---------------- | ---------------- | ---------------- |
+| errors.ErrorDto  | 400, 404, 409    | application/json |
+| errors.SDKError  | 4XX, 5XX         | \*/\*            |