@novu/api 1.2.0 → 1.4.0

package/docs/sdks/subscribers/README.md

@@ -12,7 +12,7 @@ A subscriber in Novu represents someone who should receive a message. A subscrib
 * [create](#create) - Create a subscriber
 * [retrieve](#retrieve) - Retrieve a subscriber
 * [patch](#patch) - Update a subscriber
-* [delete](#delete) - Delete subscriber
+* [delete](#delete) - Delete a subscriber
 * [createBulk](#createbulk) - Bulk create subscribers
 
 ## search
@@ -32,7 +32,6 @@ const novu = new Novu({
 async function run() {
   const result = await novu.subscribers.search({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -55,15 +54,12 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await subscribersSearch(novu, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("subscribersSearch failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -111,7 +107,6 @@ async function run() {
     subscriberId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -136,15 +131,12 @@ async function run() {
   const res = await subscribersCreate(novu, {
     subscriberId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("subscribersCreate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -176,7 +168,7 @@ run();
 
 ## retrieve
 
-Retrive a subscriber by its unique key identifier **subscriberId**. 
+Retrieve a subscriber by its unique key identifier **subscriberId**. 
     **subscriberId** field is required.
 
 ### Example Usage
@@ -191,7 +183,6 @@ const novu = new Novu({
 async function run() {
   const result = await novu.subscribers.retrieve("<id>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -214,15 +205,12 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await subscribersRetrieve(novu, "<id>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("subscribersRetrieve failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -269,7 +257,6 @@ const novu = new Novu({
 async function run() {
   const result = await novu.subscribers.patch({}, "<id>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -292,15 +279,12 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await subscribersPatch(novu, {}, "<id>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("subscribersPatch failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -333,7 +317,8 @@ run();
 
 ## delete
 
-Deletes a subscriber entity from the Novu platform along with associated messages, preferences, and topic subscriptions
+Deletes a subscriber entity from the Novu platform along with associated messages, preferences, and topic subscriptions. 
+      **subscriberId** is a required field.
 
 ### Example Usage
 
@@ -347,7 +332,6 @@ const novu = new Novu({
 async function run() {
   const result = await novu.subscribers.delete("<id>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -370,15 +354,12 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await subscribersDelete(novu, "<id>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("subscribersDelete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -432,7 +413,6 @@ async function run() {
     ],
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -461,15 +441,12 @@ async function run() {
       },
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("subscribersCreateBulk failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/subscriptions/README.md

@@ -11,7 +11,7 @@
 
 ## list
 
-List all topics that a subscriber is subscribed to.
+List all subscriptions of subscribers for a topic.
     Checkout all available filters in the query section.
 
 ### Example Usage
@@ -28,7 +28,6 @@ async function run() {
     topicKey: "<value>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -53,15 +52,12 @@ async function run() {
   const res = await topicsSubscriptionsList(novu, {
     topicKey: "<value>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("topicsSubscriptionsList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -112,7 +108,6 @@ async function run() {
     ],
   }, "<value>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -140,15 +135,12 @@ async function run() {
       "subscriberId2",
     ],
   }, "<value>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("topicsSubscriptionsCreate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -200,7 +192,6 @@ async function run() {
     ],
   }, "<value>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -228,15 +219,12 @@ async function run() {
       "subscriberId2",
     ],
   }, "<value>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("topicsSubscriptionsDelete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/topics/README.md

@@ -32,7 +32,6 @@ const novu = new Novu({
 async function run() {
   const result = await novu.topics.list({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -55,15 +54,12 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await topicsList(novu, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("topicsList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -111,7 +107,6 @@ async function run() {
     name: "Task Title",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -137,15 +132,12 @@ async function run() {
     key: "task:12345",
     name: "Task Title",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("topicsCreate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -191,7 +183,6 @@ const novu = new Novu({
 async function run() {
   const result = await novu.topics.get("<value>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -214,15 +205,12 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await topicsGet(novu, "<value>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("topicsGet failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -270,7 +258,6 @@ async function run() {
     name: "Updated Topic Name",
   }, "<value>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -295,15 +282,12 @@ async function run() {
   const res = await topicsUpdate(novu, {
     name: "Updated Topic Name",
   }, "<value>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("topicsUpdate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -351,7 +335,6 @@ const novu = new Novu({
 async function run() {
   const result = await novu.topics.delete("<value>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -374,15 +357,12 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await topicsDelete(novu, "<value>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("topicsDelete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();