@novu/api 0.5.0 → 0.6.1

package/docs/sdks/novu/README.md

@@ -10,9 +10,9 @@ Novu Documentation
 ### Available Operations
 
 * [trigger](#trigger) - Trigger event
-* [triggerBulk](#triggerbulk) - Bulk trigger event
-* [triggerBroadcast](#triggerbroadcast) - Broadcast event to all
 * [cancel](#cancel) - Cancel triggered event
+* [triggerBroadcast](#triggerbroadcast) - Broadcast event to all
+* [triggerBulk](#triggerbulk) - Bulk trigger event
 
 ## trigger
 
@@ -131,11 +131,11 @@ run();
 | errors.ErrorDto                        | 500                                    | application/json                       |
 | errors.SDKError                        | 4XX, 5XX                               | \*/\*                                  |
 
-## triggerBulk
+## cancel
 
 
-      Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API.
-      The bulk API is limited to 100 events per request.
+    Using a previously generated transactionId during the event trigger,
+     will cancel any active or pending workflows. This is useful to cancel active digests, delays etc...
     
 
 ### Example Usage
@@ -148,71 +148,7 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.triggerBulk({
-    events: [
-      {
-        workflowId: "workflow_identifier",
-        payload: {
-          "comment_id": "string",
-          "post": {
-            "text": "string",
-          },
-        },
-        overrides: {
-          "fcm": {
-            "data": {
-              "key": "value",
-            },
-          },
-        },
-        to: {
-          subscriberId: "<id>",
-        },
-      },
-      {
-        workflowId: "workflow_identifier",
-        payload: {
-          "comment_id": "string",
-          "post": {
-            "text": "string",
-          },
-        },
-        overrides: {
-          "fcm": {
-            "data": {
-              "key": "value",
-            },
-          },
-        },
-        to: [
-          {
-            topicKey: "<value>",
-            type: "Subscriber",
-          },
-        ],
-      },
-      {
-        workflowId: "workflow_identifier",
-        payload: {
-          "comment_id": "string",
-          "post": {
-            "text": "string",
-          },
-        },
-        overrides: {
-          "fcm": {
-            "data": {
-              "key": "value",
-            },
-          },
-        },
-        to: [
-          "SUBSCRIBER_ID",
-          "SUBSCRIBER_ID",
-        ],
-      },
-    ],
-  });
+  const result = await novu.cancel("<id>");
 
   // Handle the result
   console.log(result);
@@ -227,7 +163,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { triggerBulk } from "@novu/api/funcs/triggerBulk.js";
+import { cancel } from "@novu/api/funcs/cancel.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -236,71 +172,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await triggerBulk(novu, {
-    events: [
-      {
-        workflowId: "workflow_identifier",
-        payload: {
-          "comment_id": "string",
-          "post": {
-            "text": "string",
-          },
-        },
-        overrides: {
-          "fcm": {
-            "data": {
-              "key": "value",
-            },
-          },
-        },
-        to: {
-          subscriberId: "<id>",
-        },
-      },
-      {
-        workflowId: "workflow_identifier",
-        payload: {
-          "comment_id": "string",
-          "post": {
-            "text": "string",
-          },
-        },
-        overrides: {
-          "fcm": {
-            "data": {
-              "key": "value",
-            },
-          },
-        },
-        to: [
-          {
-            topicKey: "<value>",
-            type: "Subscriber",
-          },
-        ],
-      },
-      {
-        workflowId: "workflow_identifier",
-        payload: {
-          "comment_id": "string",
-          "post": {
-            "text": "string",
-          },
-        },
-        overrides: {
-          "fcm": {
-            "data": {
-              "key": "value",
-            },
-          },
-        },
-        to: [
-          "SUBSCRIBER_ID",
-          "SUBSCRIBER_ID",
-        ],
-      },
-    ],
-  });
+  const res = await cancel(novu, "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -319,7 +191,7 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `bulkTriggerEventDto`                                                                                                                                                          | [components.BulkTriggerEventDto](../../models/components/bulktriggereventdto.md)                                                                                               | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `transactionId`                                                                                                                                                                | *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. |
@@ -327,7 +199,7 @@ run();
 
 ### Response
 
-**Promise\<[operations.EventsControllerTriggerBulkResponse](../../models/operations/eventscontrollertriggerbulkresponse.md)\>**
+**Promise\<[operations.EventsControllerCancelResponse](../../models/operations/eventscontrollercancelresponse.md)\>**
 
 ### Errors
 
@@ -433,11 +305,11 @@ run();
 | errors.ErrorDto                        | 500                                    | application/json                       |
 | errors.SDKError                        | 4XX, 5XX                               | \*/\*                                  |
 
-## cancel
+## triggerBulk
 
 
-    Using a previously generated transactionId during the event trigger,
-     will cancel any active or pending workflows. This is useful to cancel active digests, delays etc...
+      Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API.
+      The bulk API is limited to 100 events per request.
     
 
 ### Example Usage
@@ -450,7 +322,71 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.cancel("<id>");
+  const result = await novu.triggerBulk({
+    events: [
+      {
+        workflowId: "workflow_identifier",
+        payload: {
+          "comment_id": "string",
+          "post": {
+            "text": "string",
+          },
+        },
+        overrides: {
+          "fcm": {
+            "data": {
+              "key": "value",
+            },
+          },
+        },
+        to: {
+          subscriberId: "<id>",
+        },
+      },
+      {
+        workflowId: "workflow_identifier",
+        payload: {
+          "comment_id": "string",
+          "post": {
+            "text": "string",
+          },
+        },
+        overrides: {
+          "fcm": {
+            "data": {
+              "key": "value",
+            },
+          },
+        },
+        to: [
+          {
+            topicKey: "<value>",
+            type: "Subscriber",
+          },
+        ],
+      },
+      {
+        workflowId: "workflow_identifier",
+        payload: {
+          "comment_id": "string",
+          "post": {
+            "text": "string",
+          },
+        },
+        overrides: {
+          "fcm": {
+            "data": {
+              "key": "value",
+            },
+          },
+        },
+        to: [
+          "SUBSCRIBER_ID",
+          "SUBSCRIBER_ID",
+        ],
+      },
+    ],
+  });
 
   // Handle the result
   console.log(result);
@@ -465,7 +401,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { cancel } from "@novu/api/funcs/cancel.js";
+import { triggerBulk } from "@novu/api/funcs/triggerBulk.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -474,7 +410,71 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await cancel(novu, "<id>");
+  const res = await triggerBulk(novu, {
+    events: [
+      {
+        workflowId: "workflow_identifier",
+        payload: {
+          "comment_id": "string",
+          "post": {
+            "text": "string",
+          },
+        },
+        overrides: {
+          "fcm": {
+            "data": {
+              "key": "value",
+            },
+          },
+        },
+        to: {
+          subscriberId: "<id>",
+        },
+      },
+      {
+        workflowId: "workflow_identifier",
+        payload: {
+          "comment_id": "string",
+          "post": {
+            "text": "string",
+          },
+        },
+        overrides: {
+          "fcm": {
+            "data": {
+              "key": "value",
+            },
+          },
+        },
+        to: [
+          {
+            topicKey: "<value>",
+            type: "Subscriber",
+          },
+        ],
+      },
+      {
+        workflowId: "workflow_identifier",
+        payload: {
+          "comment_id": "string",
+          "post": {
+            "text": "string",
+          },
+        },
+        overrides: {
+          "fcm": {
+            "data": {
+              "key": "value",
+            },
+          },
+        },
+        to: [
+          "SUBSCRIBER_ID",
+          "SUBSCRIBER_ID",
+        ],
+      },
+    ],
+  });
 
   if (!res.ok) {
     throw res.error;
@@ -493,7 +493,7 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `transactionId`                                                                                                                                                                | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `bulkTriggerEventDto`                                                                                                                                                          | [components.BulkTriggerEventDto](../../models/components/bulktriggereventdto.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. |
@@ -501,7 +501,7 @@ run();
 
 ### Response
 
-**Promise\<[operations.EventsControllerCancelResponse](../../models/operations/eventscontrollercancelresponse.md)\>**
+**Promise\<[operations.EventsControllerTriggerBulkResponse](../../models/operations/eventscontrollertriggerbulkresponse.md)\>**
 
 ### Errors
 

package/docs/sdks/novumessages/README.md

@@ -5,13 +5,13 @@
 
 ### Available Operations
 
-* [markAllAs](#markallas) - Mark a subscriber messages as seen, read, unseen or unread
-* [markAll](#markall) - Marks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed.
 * [updateAsSeen](#updateasseen) - Mark message action as seen
+* [markAll](#markall) - Marks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed.
+* [markAllAs](#markallas) - Mark a subscriber messages as seen, read, unseen or unread
 
-## markAllAs
+## updateAsSeen
 
-Mark a subscriber messages as seen, read, unseen or unread
+Mark message action as seen
 
 ### Example Usage
 
@@ -23,10 +23,14 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.subscribers.messages.markAllAs({
+  const result = await novu.subscribers.messages.updateAsSeen({
     messageId: "<id>",
-    markAs: "unread",
-  }, "<id>");
+    type: "<value>",
+    subscriberId: "<id>",
+    markMessageActionAsSeenDto: {
+      status: "done",
+    },
+  });
 
   // Handle the result
   console.log(result);
@@ -41,7 +45,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { subscribersMessagesMarkAllAs } from "@novu/api/funcs/subscribersMessagesMarkAllAs.js";
+import { subscribersMessagesUpdateAsSeen } from "@novu/api/funcs/subscribersMessagesUpdateAsSeen.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -50,10 +54,14 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await subscribersMessagesMarkAllAs(novu, {
+  const res = await subscribersMessagesUpdateAsSeen(novu, {
     messageId: "<id>",
-    markAs: "unread",
-  }, "<id>");
+    type: "<value>",
+    subscriberId: "<id>",
+    markMessageActionAsSeenDto: {
+      status: "done",
+    },
+  });
 
   if (!res.ok) {
     throw res.error;
@@ -72,16 +80,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `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                                                                                                                                              |
+| `request`                                                                                                                                                                      | [operations.SubscribersV1ControllerMarkActionAsSeenRequest](../../models/operations/subscribersv1controllermarkactionasseenrequest.md)                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[operations.SubscribersV1ControllerMarkMessagesAsResponse](../../models/operations/subscribersv1controllermarkmessagesasresponse.md)\>**
+**Promise\<[operations.SubscribersV1ControllerMarkActionAsSeenResponse](../../models/operations/subscribersv1controllermarkactionasseenresponse.md)\>**
 
 ### Errors
 
@@ -175,9 +181,9 @@ run();
 | errors.ErrorDto                        | 500                                    | application/json                       |
 | errors.SDKError                        | 4XX, 5XX                               | \*/\*                                  |
 
-## updateAsSeen
+## markAllAs
 
-Mark message action as seen
+Mark a subscriber messages as seen, read, unseen or unread
 
 ### Example Usage
 
@@ -189,14 +195,10 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.subscribers.messages.updateAsSeen({
+  const result = await novu.subscribers.messages.markAllAs({
     messageId: "<id>",
-    type: "<value>",
-    subscriberId: "<id>",
-    markMessageActionAsSeenDto: {
-      status: "done",
-    },
-  });
+    markAs: "unread",
+  }, "<id>");
 
   // Handle the result
   console.log(result);
@@ -211,7 +213,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { subscribersMessagesUpdateAsSeen } from "@novu/api/funcs/subscribersMessagesUpdateAsSeen.js";
+import { subscribersMessagesMarkAllAs } from "@novu/api/funcs/subscribersMessagesMarkAllAs.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -220,14 +222,10 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await subscribersMessagesUpdateAsSeen(novu, {
+  const res = await subscribersMessagesMarkAllAs(novu, {
     messageId: "<id>",
-    type: "<value>",
-    subscriberId: "<id>",
-    markMessageActionAsSeenDto: {
-      status: "done",
-    },
-  });
+    markAs: "unread",
+  }, "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -246,14 +244,16 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.SubscribersV1ControllerMarkActionAsSeenRequest](../../models/operations/subscribersv1controllermarkactionasseenrequest.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.                                                                                                               |
 
 ### Response
 
-**Promise\<[operations.SubscribersV1ControllerMarkActionAsSeenResponse](../../models/operations/subscribersv1controllermarkactionasseenresponse.md)\>**
+**Promise\<[operations.SubscribersV1ControllerMarkMessagesAsResponse](../../models/operations/subscribersv1controllermarkmessagesasresponse.md)\>**
 
 ### Errors