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

package/docs/sdks/novu/README.md

@@ -9,16 +9,17 @@ Novu Documentation
 
 ### Available Operations
 
-* [cancel](#cancel) - Cancel triggered event
 * [trigger](#trigger) - Trigger event
-* [triggerBroadcast](#triggerbroadcast) - Broadcast event to all
 * [triggerBulk](#triggerbulk) - Bulk trigger event
+* [triggerBroadcast](#triggerbroadcast) - Broadcast event to all
+* [cancel](#cancel) - Cancel triggered event
 
-## cancel
+## trigger
 
 
-    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...
+    Trigger event is the main (and only) way to send notifications to subscribers. 
+    The trigger identifier is used to match the particular workflow associated with it. 
+    Additional information can be passed according the body interface below.
     
 
 ### Example Usage
@@ -31,10 +32,22 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.cancel("<value>");
+  const result = await novu.trigger({
+    name: "workflow_identifier",
+    to: [
+      {
+        topicKey: "<value>",
+        type: "Topic",
+      },
+      {
+        topicKey: "<value>",
+        type: "Topic",
+      },
+    ],
+  });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -46,7 +59,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 { trigger } from "@novu/api/funcs/trigger.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -55,7 +68,19 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await cancel(novu, "<value>");
+  const res = await trigger(novu, {
+    name: "workflow_identifier",
+    to: [
+      {
+        topicKey: "<value>",
+        type: "Topic",
+      },
+      {
+        topicKey: "<value>",
+        type: "Topic",
+      },
+    ],
+  });
 
   if (!res.ok) {
     throw res.error;
@@ -64,7 +89,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -74,28 +99,27 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `transactionId`                                                                                                                                                                | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `request`                                                                                                                                                                      | [components.TriggerEventRequestDto](../../models/components/triggereventrequestdto.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.DataBooleanDto](../../models/components/databooleandto.md)\>**
+**Promise\<[operations.EventsControllerTriggerResponse](../../models/operations/eventscontrollertriggerresponse.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         | \*/\*            |
 
-## trigger
+## triggerBulk
 
 
-    Trigger event is the main (and only) way to send notifications to subscribers. 
-    The trigger identifier is used to match the particular workflow associated with it. 
-    Additional information can be passed according the body interface below.
+      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
@@ -108,20 +132,44 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.trigger({
-    name: "workflow_identifier",
-    overrides: {},
-    payload: {},
-    to: [
+  const result = await novu.triggerBulk({
+    events: [
       {
-        topicKey: "<value>",
-        type: "Topic",
+        name: "workflow_identifier",
+        to: [
+          {
+            topicKey: "<value>",
+            type: "Topic",
+          },
+          {
+            subscriberId: "<id>",
+          },
+        ],
+      },
+      {
+        name: "workflow_identifier",
+        to: [
+          "SUBSCRIBER_ID",
+        ],
+      },
+      {
+        name: "workflow_identifier",
+        to: [
+          {
+            topicKey: "<value>",
+            type: "Topic",
+          },
+          {
+            topicKey: "<value>",
+            type: "Topic",
+          },
+        ],
       },
     ],
   });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -133,7 +181,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { trigger } from "@novu/api/funcs/trigger.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.
@@ -142,14 +190,38 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await trigger(novu, {
-    name: "workflow_identifier",
-    overrides: {},
-    payload: {},
-    to: [
+  const res = await triggerBulk(novu, {
+    events: [
       {
-        topicKey: "<value>",
-        type: "Topic",
+        name: "workflow_identifier",
+        to: [
+          {
+            topicKey: "<value>",
+            type: "Topic",
+          },
+          {
+            subscriberId: "<id>",
+          },
+        ],
+      },
+      {
+        name: "workflow_identifier",
+        to: [
+          "SUBSCRIBER_ID",
+        ],
+      },
+      {
+        name: "workflow_identifier",
+        to: [
+          {
+            topicKey: "<value>",
+            type: "Topic",
+          },
+          {
+            topicKey: "<value>",
+            type: "Topic",
+          },
+        ],
       },
     ],
   });
@@ -161,7 +233,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -171,25 +243,26 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.TriggerEventRequestDto](../../models/components/triggereventrequestdto.md)                                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [components.BulkTriggerEventDto](../../models/components/bulktriggereventdto.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.TriggerEventResponseDto](../../models/components/triggereventresponsedto.md)\>**
+**Promise\<[operations.EventsControllerTriggerBulkResponse](../../models/operations/eventscontrollertriggerbulkresponse.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         | \*/\*            |
 
 ## triggerBroadcast
 
 Trigger a broadcast event to all existing subscribers, could be used to send announcements, etc.
+
       In the future could be used to trigger events to a subset of subscribers based on defined filters.
 
 ### Example Usage
@@ -204,12 +277,16 @@ const novu = new Novu({
 async function run() {
   const result = await novu.triggerBroadcast({
     name: "<value>",
-    overrides: {},
-    payload: {},
+    payload: {
+      "comment_id": "string",
+      "post": {
+        "text": "string",
+      },
+    },
   });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -232,8 +309,12 @@ const novu = new NovuCore({
 async function run() {
   const res = await triggerBroadcast(novu, {
     name: "<value>",
-    overrides: {},
-    payload: {},
+    payload: {
+      "comment_id": "string",
+      "post": {
+        "text": "string",
+      },
+    },
   });
 
   if (!res.ok) {
@@ -243,7 +324,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -260,20 +341,20 @@ run();
 
 ### Response
 
-**Promise\<[components.TriggerEventResponseDto](../../models/components/triggereventresponsedto.md)\>**
+**Promise\<[operations.EventsControllerBroadcastEventToAllResponse](../../models/operations/eventscontrollerbroadcasteventtoallresponse.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         | \*/\*            |
 
-## 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
@@ -286,14 +367,10 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.triggerBulk({
-    events: [
-  
-    ],
-  });
+  const result = await novu.cancel("<id>");
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -305,7 +382,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.
@@ -314,11 +391,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await triggerBulk(novu, {
-    events: [
-  
-    ],
-  });
+  const res = await cancel(novu, "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -327,7 +400,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -337,17 +410,18 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.BulkTriggerEventDto](../../models/components/bulktriggereventdto.md)                                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `transactionId`                                                                                                                                                                | *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\<[components.TriggerEventResponseDto[]](../../models/.md)\>**
+**Promise\<[operations.EventsControllerCancelResponse](../../models/operations/eventscontrollercancelresponse.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         | \*/\*            |