@novu/api 0.0.1-alpha.11 → 0.0.1-alpha.25

package/docs/sdks/messages/README.md

@@ -8,13 +8,13 @@ A message in Novu represents a notification delivered to a recipient on a partic
 
 ### Available Operations
 
+* [retrieve](#retrieve) - Get messages
 * [delete](#delete) - Delete message
 * [deleteByTransactionId](#deletebytransactionid) - Delete messages by transactionId
-* [retrieve](#retrieve) - Get messages
 
-## delete
+## retrieve
 
-Deletes a message entity from the Novu platform
+Returns a list of messages, could paginate using the `page` query parameter
 
 ### Example Usage
 
@@ -26,10 +26,10 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.messages.delete("<value>");
-  
+  const result = await novu.messages.retrieve({});
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -41,7 +41,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { messagesDelete } from "@novu/api/funcs/messagesDelete.js";
+import { messagesRetrieve } from "@novu/api/funcs/messagesRetrieve.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -50,7 +50,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await messagesDelete(novu, "<value>");
+  const res = await messagesRetrieve(novu, {});
 
   if (!res.ok) {
     throw res.error;
@@ -59,7 +59,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -69,25 +69,24 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `messageId`                                                                                                                                                                    | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `request`                                                                                                                                                                      | [operations.MessagesControllerGetMessagesRequest](../../models/operations/messagescontrollergetmessagesrequest.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.DeleteMessageResponseDto](../../models/components/deletemessageresponsedto.md)\>**
+**Promise\<[operations.MessagesControllerGetMessagesResponse](../../models/operations/messagescontrollergetmessagesresponse.md)\>**
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
+## delete
 
-## deleteByTransactionId
-
-Deletes messages entity from the Novu platform using TransactionId of message
+Deletes a message entity from the Novu platform
 
 ### Example Usage
 
@@ -99,7 +98,10 @@ const novu = new Novu({
 });
 
 async function run() {
-  await novu.messages.deleteByTransactionId("<value>");
+  const result = await novu.messages.delete("<id>");
+
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -111,7 +113,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { messagesDeleteByTransactionId } from "@novu/api/funcs/messagesDeleteByTransactionId.js";
+import { messagesDelete } from "@novu/api/funcs/messagesDelete.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -120,7 +122,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await messagesDeleteByTransactionId(novu, "<value>");
+  const res = await messagesDelete(novu, "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -128,7 +130,8 @@ async function run() {
 
   const { value: result } = res;
 
-  
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -138,26 +141,24 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `transactionId`                                                                                                                                                                | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
-| `channel`                                                                                                                                                                      | [operations.Channel](../../models/operations/channel.md)                                                                                                                       | :heavy_minus_sign:                                                                                                                                                             | The channel of the message to be deleted                                                                                                                                       |
+| `messageId`                                                                                                                                                                    | *string*                                                                                                                                                                       | :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\<void\>**
+**Promise\<[operations.MessagesControllerDeleteMessageResponse](../../models/operations/messagescontrollerdeletemessageresponse.md)\>**
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
-## retrieve
+## deleteByTransactionId
 
-Returns a list of messages, could paginate using the `page` query parameter
+Deletes messages entity from the Novu platform using TransactionId of message
 
 ### Example Usage
 
@@ -169,10 +170,10 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.messages.retrieve({});
-  
+  const result = await novu.messages.deleteByTransactionId("<id>");
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -184,7 +185,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { messagesRetrieve } from "@novu/api/funcs/messagesRetrieve.js";
+import { messagesDeleteByTransactionId } from "@novu/api/funcs/messagesDeleteByTransactionId.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -193,7 +194,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await messagesRetrieve(novu, {});
+  const res = await messagesDeleteByTransactionId(novu, "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -202,7 +203,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -212,17 +213,18 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.MessagesControllerGetMessagesRequest](../../models/operations/messagescontrollergetmessagesrequest.md)                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `transactionId`                                                                                                                                                                | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `channel`                                                                                                                                                                      | [operations.QueryParamChannel](../../models/operations/queryparamchannel.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.                                                                                                               |
 
 ### Response
 
-**Promise\<[components.ActivitiesResponseDto](../../models/components/activitiesresponsedto.md)\>**
+**Promise\<[operations.MessagesControllerDeleteMessagesByTransactionIdResponse](../../models/operations/messagescontrollerdeletemessagesbytransactionidresponse.md)\>**
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+| errors.SDKError | 4XX, 5XX        | \*/\*           |

package/docs/sdks/notifications/README.md

@@ -24,7 +24,9 @@ const novu = new Novu({
 async function run() {
   const result = await novu.notifications.list({
     channels: [
+      "sms",
       "chat",
+      "in_app",
     ],
     templates: [
       "<value>",
@@ -35,11 +37,12 @@ async function run() {
     search: "<value>",
     subscriberIds: [
       "<value>",
+      "<value>",
     ],
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -63,6 +66,8 @@ async function run() {
   const res = await notificationsList(novu, {
     channels: [
       "sms",
+      "chat",
+      "in_app",
     ],
     templates: [
       "<value>",
@@ -73,6 +78,7 @@ async function run() {
     search: "<value>",
     subscriberIds: [
       "<value>",
+      "<value>",
     ],
   });
 
@@ -83,7 +89,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -100,14 +106,13 @@ run();
 
 ### Response
 
-**Promise\<[components.ActivitiesResponseDto](../../models/components/activitiesresponsedto.md)\>**
+**Promise\<[operations.NotificationsControllerListNotificationsResponse](../../models/operations/notificationscontrollerlistnotificationsresponse.md)\>**
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
 ## retrieve
 
@@ -123,10 +128,10 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.notifications.retrieve("<value>");
-  
+  const result = await novu.notifications.retrieve("<id>");
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -147,7 +152,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await notificationsRetrieve(novu, "<value>");
+  const res = await notificationsRetrieve(novu, "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -156,7 +161,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -173,10 +178,10 @@ run();
 
 ### Response
 
-**Promise\<[components.ActivityNotificationResponseDto](../../models/components/activitynotificationresponsedto.md)\>**
+**Promise\<[operations.NotificationsControllerGetNotificationResponse](../../models/operations/notificationscontrollergetnotificationresponse.md)\>**
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+| errors.SDKError | 4XX, 5XX        | \*/\*           |