@novu/api 0.0.5 → 0.1.1

package/FUNCTIONS.md

@@ -32,16 +32,23 @@ const novu = new NovuCore({
 async function run() {
   const res = await trigger(novu, {
     name: "workflow_identifier",
-    to: [
-      {
-        topicKey: "<value>",
-        type: "Topic",
+    payload: {
+      "comment_id": "string",
+      "post": {
+        "text": "string",
       },
-      {
-        topicKey: "<value>",
-        type: "Topic",
+    },
+    bridgeUrl: "https://example.com/bridge",
+    overrides: {
+      "fcm": {
+        "data": {
+          "key": "value",
+        },
       },
-    ],
+    },
+    to: {
+      subscriberId: "<id>",
+    },
   });
 
   switch (true) {

package/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-  <img src="https://github.com/speakeasy-sdks/novu-ts/assets/68016351/dabaa829-32c8-451b-b912-0fa1d10300bd" width="500">
+  <img src="https://raw.githubusercontent.com/novuhq/novu-ts/HEAD/assets/banner.png" width="500">
   <p>Novu is an open-source notification infrastructure.</p>
   <a href="https://docs.novu.co/api-reference/overview"><img src="https://img.shields.io/static/v1?label=Docs&message=API Ref&color=000000&style=for-the-badge" /></a>
   <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge" /></a>
@@ -89,16 +89,23 @@ const novu = new Novu({
 async function run() {
   const result = await novu.trigger({
     name: "workflow_identifier",
-    to: [
-      {
-        topicKey: "<value>",
-        type: "Topic",
+    payload: {
+      "comment_id": "string",
+      "post": {
+        "text": "string",
       },
-      {
-        topicKey: "<value>",
-        type: "Topic",
+    },
+    bridgeUrl: "https://example.com/bridge",
+    overrides: {
+      "fcm": {
+        "data": {
+          "key": "value",
+        },
       },
-    ],
+    },
+    to: {
+      subscriberId: "<id>",
+    },
   });
 
   // Handle the result
@@ -123,31 +130,66 @@ async function run() {
     events: [
       {
         name: "workflow_identifier",
-        to: [
-          {
-            topicKey: "<value>",
-            type: "Topic",
+        payload: {
+          "comment_id": "string",
+          "post": {
+            "text": "string",
           },
-          {
-            subscriberId: "<id>",
+        },
+        bridgeUrl: "https://example.com/bridge",
+        overrides: {
+          "fcm": {
+            "data": {
+              "key": "value",
+            },
           },
-        ],
-      },
-      {
-        name: "workflow_identifier",
-        to: [],
+        },
+        to: {
+          subscriberId: "<id>",
+        },
       },
       {
         name: "workflow_identifier",
+        payload: {
+          "comment_id": "string",
+          "post": {
+            "text": "string",
+          },
+        },
+        bridgeUrl: "https://example.com/bridge",
+        overrides: {
+          "fcm": {
+            "data": {
+              "key": "value",
+            },
+          },
+        },
         to: [
           {
             topicKey: "<value>",
-            type: "Topic",
+            type: "Subscriber",
           },
-          {
-            topicKey: "<value>",
-            type: "Topic",
+        ],
+      },
+      {
+        name: "workflow_identifier",
+        payload: {
+          "comment_id": "string",
+          "post": {
+            "text": "string",
+          },
+        },
+        bridgeUrl: "https://example.com/bridge",
+        overrides: {
+          "fcm": {
+            "data": {
+              "key": "value",
+            },
           },
+        },
+        to: [
+          "SUBSCRIBER_ID",
+          "SUBSCRIBER_ID",
         ],
       },
     ],
@@ -247,13 +289,12 @@ run();
 
 ### [Novu SDK](docs/sdks/novu/README.md)
 
-* [healthControllerHealthCheck](docs/sdks/novu/README.md#healthcontrollerhealthcheck)
-* [testIdempotency](docs/sdks/novu/README.md#testidempotency)
-* [generateRandomNumber](docs/sdks/novu/README.md#generaterandomnumber)
 * [trigger](docs/sdks/novu/README.md#trigger) - Trigger event
 * [triggerBulk](docs/sdks/novu/README.md#triggerbulk) - Bulk trigger event
 * [triggerBroadcast](docs/sdks/novu/README.md#triggerbroadcast) - Broadcast event to all
 * [cancel](docs/sdks/novu/README.md#cancel) - Cancel triggered event
+* [supportControllerFetchUserOrganizations](docs/sdks/novu/README.md#supportcontrollerfetchuserorganizations)
+* [create](docs/sdks/novu/README.md#create)
 
 ### [subscribers](docs/sdks/subscribers/README.md)
 
@@ -330,8 +371,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 <summary>Available standalone functions</summary>
 
 - [`cancel`](docs/sdks/novu/README.md#cancel) - Cancel triggered event
-- [`generateRandomNumber`](docs/sdks/novu/README.md#generaterandomnumber)
-- [`healthControllerHealthCheck`](docs/sdks/novu/README.md#healthcontrollerhealthcheck)
+- [`create`](docs/sdks/novu/README.md#create)
 - [`integrationsCreate`](docs/sdks/integrations/README.md#create) - Create integration
 - [`integrationsDelete`](docs/sdks/integrations/README.md#delete) - Delete integration
 - [`integrationsList`](docs/sdks/integrations/README.md#list) - Get integrations
@@ -367,7 +407,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`subscribersPropertiesUpdateOnlineFlag`](docs/sdks/properties/README.md#updateonlineflag) - Update subscriber online status
 - [`subscribersRetrieve`](docs/sdks/subscribers/README.md#retrieve) - Get subscriber
 - [`subscribersUpdate`](docs/sdks/subscribers/README.md#update) - Update subscriber
-- [`testIdempotency`](docs/sdks/novu/README.md#testidempotency)
+- [`supportControllerFetchUserOrganizations`](docs/sdks/novu/README.md#supportcontrollerfetchuserorganizations)
 - [`topicsCreate`](docs/sdks/topics/README.md#create) - Topic creation
 - [`topicsDelete`](docs/sdks/topics/README.md#delete) - Delete topic
 - [`topicsList`](docs/sdks/topics/README.md#list) - Get topic list filtered 
@@ -403,7 +443,7 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.subscribers.list();
+  const result = await novu.subscribers.list(10);
 
   for await (const page of result) {
     // Handle the page
@@ -419,20 +459,24 @@ run();
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `healthControllerHealthCheck` method may throw the following errors:
+Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `trigger` method may throw the following errors:
 
-| Error Type                                     | Status Code | Content Type     |
-| ---------------------------------------------- | ----------- | ---------------- |
-| errors.HealthControllerHealthCheckResponseBody | 503         | application/json |
-| errors.SDKError                                | 4XX, 5XX    | \*/\*            |
+| Error Type                | Status Code                            | Content Type     |
+| ------------------------- | -------------------------------------- | ---------------- |
+| errors.ErrorDto           | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
+| errors.ErrorDto           | 414                                    | application/json |
+| errors.ValidationErrorDto | 422                                    | application/json |
+| errors.ErrorDto           | 500                                    | application/json |
+| errors.SDKError           | 4XX, 5XX                               | \*/\*            |
 
 If the method throws an error and it is not captured by the known errors, it will default to throwing a `SDKError`.
 
 ```typescript
 import { Novu } from "@novu/api";
 import {
-  HealthControllerHealthCheckResponseBody,
+  ErrorDto,
   SDKValidationError,
+  ValidationErrorDto,
 } from "@novu/api/models/errors";
 
 const novu = new Novu({
@@ -442,7 +486,26 @@ const novu = new Novu({
 async function run() {
   let result;
   try {
-    result = await novu.healthControllerHealthCheck();
+    result = await novu.trigger({
+      name: "workflow_identifier",
+      payload: {
+        "comment_id": "string",
+        "post": {
+          "text": "string",
+        },
+      },
+      bridgeUrl: "https://example.com/bridge",
+      overrides: {
+        "fcm": {
+          "data": {
+            "key": "value",
+          },
+        },
+      },
+      to: {
+        subscriberId: "<id>",
+      },
+    });
 
     // Handle the result
     console.log(result);
@@ -456,8 +519,23 @@ async function run() {
         console.error(err.rawValue);
         return;
       }
-      case (err instanceof HealthControllerHealthCheckResponseBody): {
-        // Handle err.data$: HealthControllerHealthCheckResponseBodyData
+      case (err instanceof ErrorDto): {
+        // Handle err.data$: ErrorDtoData
+        console.error(err);
+        return;
+      }
+      case (err instanceof ErrorDto): {
+        // Handle err.data$: ErrorDtoData
+        console.error(err);
+        return;
+      }
+      case (err instanceof ValidationErrorDto): {
+        // Handle err.data$: ValidationErrorDtoData
+        console.error(err);
+        return;
+      }
+      case (err instanceof ErrorDto): {
+        // Handle err.data$: ErrorDtoData
         console.error(err);
         return;
       }
@@ -509,7 +587,26 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.healthControllerHealthCheck();
+  const result = await novu.trigger({
+    name: "workflow_identifier",
+    payload: {
+      "comment_id": "string",
+      "post": {
+        "text": "string",
+      },
+    },
+    bridgeUrl: "https://example.com/bridge",
+    overrides: {
+      "fcm": {
+        "data": {
+          "key": "value",
+        },
+      },
+    },
+    to: {
+      subscriberId: "<id>",
+    },
+  });
 
   // Handle the result
   console.log(result);
@@ -531,7 +628,26 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.healthControllerHealthCheck();
+  const result = await novu.trigger({
+    name: "workflow_identifier",
+    payload: {
+      "comment_id": "string",
+      "post": {
+        "text": "string",
+      },
+    },
+    bridgeUrl: "https://example.com/bridge",
+    overrides: {
+      "fcm": {
+        "data": {
+          "key": "value",
+        },
+      },
+    },
+    to: {
+      subscriberId: "<id>",
+    },
+  });
 
   // Handle the result
   console.log(result);
@@ -611,7 +727,26 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.healthControllerHealthCheck();
+  const result = await novu.trigger({
+    name: "workflow_identifier",
+    payload: {
+      "comment_id": "string",
+      "post": {
+        "text": "string",
+      },
+    },
+    bridgeUrl: "https://example.com/bridge",
+    overrides: {
+      "fcm": {
+        "data": {
+          "key": "value",
+        },
+      },
+    },
+    to: {
+      subscriberId: "<id>",
+    },
+  });
 
   // Handle the result
   console.log(result);
@@ -636,7 +771,26 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.healthControllerHealthCheck({
+  const result = await novu.trigger({
+    name: "workflow_identifier",
+    payload: {
+      "comment_id": "string",
+      "post": {
+        "text": "string",
+      },
+    },
+    bridgeUrl: "https://example.com/bridge",
+    overrides: {
+      "fcm": {
+        "data": {
+          "key": "value",
+        },
+      },
+    },
+    to: {
+      subscriberId: "<id>",
+    },
+  }, {
     retries: {
       strategy: "backoff",
       backoff: {
@@ -676,7 +830,26 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.healthControllerHealthCheck();
+  const result = await novu.trigger({
+    name: "workflow_identifier",
+    payload: {
+      "comment_id": "string",
+      "post": {
+        "text": "string",
+      },
+    },
+    bridgeUrl: "https://example.com/bridge",
+    overrides: {
+      "fcm": {
+        "data": {
+          "key": "value",
+        },
+      },
+    },
+    to: {
+      subscriberId: "<id>",
+    },
+  });
 
   // Handle the result
   console.log(result);

package/docs/sdks/credentials/README.md

@@ -27,6 +27,17 @@ async function run() {
     providerId: "pushpad",
     credentials: {
       webhookUrl: "https://example.com/webhook",
+      channel: "general",
+      deviceTokens: [
+        "token1",
+        "token2",
+        "token3",
+      ],
+      alertUid: "12345-abcde",
+      title: "Critical Alert",
+      imageUrl: "https://example.com/image.png",
+      state: "resolved",
+      externalUrl: "https://example.com/details",
     },
   }, "<id>");
 
@@ -56,6 +67,17 @@ async function run() {
     providerId: "pushpad",
     credentials: {
       webhookUrl: "https://example.com/webhook",
+      channel: "general",
+      deviceTokens: [
+        "token1",
+        "token2",
+        "token3",
+      ],
+      alertUid: "12345-abcde",
+      title: "Critical Alert",
+      imageUrl: "https://example.com/image.png",
+      state: "resolved",
+      externalUrl: "https://example.com/details",
     },
   }, "<id>");
 
@@ -116,6 +138,17 @@ async function run() {
     providerId: "zulip",
     credentials: {
       webhookUrl: "https://example.com/webhook",
+      channel: "general",
+      deviceTokens: [
+        "token1",
+        "token2",
+        "token3",
+      ],
+      alertUid: "12345-abcde",
+      title: "Critical Alert",
+      imageUrl: "https://example.com/image.png",
+      state: "resolved",
+      externalUrl: "https://example.com/details",
     },
   }, "<id>");
 
@@ -145,6 +178,17 @@ async function run() {
     providerId: "zulip",
     credentials: {
       webhookUrl: "https://example.com/webhook",
+      channel: "general",
+      deviceTokens: [
+        "token1",
+        "token2",
+        "token3",
+      ],
+      alertUid: "12345-abcde",
+      title: "Critical Alert",
+      imageUrl: "https://example.com/image.png",
+      state: "resolved",
+      externalUrl: "https://example.com/details",
     },
   }, "<id>");
 

package/docs/sdks/messages/README.md

@@ -26,7 +26,10 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.messages.retrieve({});
+  const result = await novu.messages.retrieve({
+    page: 0,
+    limit: 10,
+  });
 
   // Handle the result
   console.log(result);
@@ -50,7 +53,10 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await messagesRetrieve(novu, {});
+  const res = await messagesRetrieve(novu, {
+    page: 0,
+    limit: 10,
+  });
 
   if (!res.ok) {
     throw res.error;

package/docs/sdks/notifications/README.md

@@ -23,22 +23,7 @@ const novu = new Novu({
 
 async function run() {
   const result = await novu.notifications.list({
-    channels: [
-      "sms",
-      "chat",
-      "in_app",
-    ],
-    templates: [
-
-    ],
-    emails: [
-
-    ],
-    search: "<value>",
-    subscriberIds: [
-      "<value>",
-      "<value>",
-    ],
+    page: 0,
   });
 
   // Handle the result
@@ -64,22 +49,7 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await notificationsList(novu, {
-    channels: [
-      "sms",
-      "chat",
-      "in_app",
-    ],
-    templates: [
-  
-    ],
-    emails: [
-  
-    ],
-    search: "<value>",
-    subscriberIds: [
-      "<value>",
-      "<value>",
-    ],
+    page: 0,
   });
 
   if (!res.ok) {