@novu/api 1.1.0 → 1.3.0

package/docs/sdks/credentials/README.md

@@ -42,7 +42,6 @@ async function run() {
     },
   }, "<id>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -81,15 +80,12 @@ async function run() {
       externalUrl: "https://example.com/details",
     },
   }, "<id>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("subscribersCredentialsUpdate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -153,7 +149,6 @@ async function run() {
     },
   }, "<id>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -192,15 +187,12 @@ async function run() {
       externalUrl: "https://example.com/details",
     },
   }, "<id>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("subscribersCredentialsAppend failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -248,7 +240,6 @@ const novu = new Novu({
 async function run() {
   const result = await novu.subscribers.credentials.delete("<id>", "<id>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -271,15 +262,12 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await subscribersCredentialsDelete(novu, "<id>", "<id>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("subscribersCredentialsDelete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/integrations/README.md

@@ -31,7 +31,6 @@ const novu = new Novu({
 async function run() {
   const result = await novu.integrations.list();
 
-  // Handle the result
   console.log(result);
 }
 
@@ -54,15 +53,12 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await integrationsList(novu);
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("integrationsList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -111,7 +107,6 @@ async function run() {
     channel: "email",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -137,15 +132,12 @@ async function run() {
     providerId: "<id>",
     channel: "email",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("integrationsCreate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -192,7 +184,6 @@ const novu = new Novu({
 async function run() {
   const result = await novu.integrations.update({}, "<id>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -215,15 +206,12 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await integrationsUpdate(novu, {}, "<id>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("integrationsUpdate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -271,7 +259,6 @@ const novu = new Novu({
 async function run() {
   const result = await novu.integrations.delete("<id>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -294,15 +281,12 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await integrationsDelete(novu, "<id>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("integrationsDelete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -350,7 +334,6 @@ const novu = new Novu({
 async function run() {
   const result = await novu.integrations.setAsPrimary("<id>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -373,15 +356,12 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await integrationsSetAsPrimary(novu, "<id>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("integrationsSetAsPrimary failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -427,7 +407,6 @@ const novu = new Novu({
 async function run() {
   const result = await novu.integrations.listActive();
 
-  // Handle the result
   console.log(result);
 }
 
@@ -450,15 +429,12 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await integrationsListActive(novu);
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("integrationsListActive failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/messages/README.md

@@ -30,7 +30,6 @@ const novu = new Novu({
 async function run() {
   const result = await novu.messages.retrieve({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -53,15 +52,12 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await messagesRetrieve(novu, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("messagesRetrieve failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -107,7 +103,6 @@ const novu = new Novu({
 async function run() {
   const result = await novu.messages.delete("507f1f77bcf86cd799439011");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -130,15 +125,12 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await messagesDelete(novu, "507f1f77bcf86cd799439011");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("messagesDelete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -185,7 +177,6 @@ const novu = new Novu({
 async function run() {
   const result = await novu.messages.deleteByTransactionId("507f1f77bcf86cd799439011");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -208,15 +199,12 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await messagesDeleteByTransactionId(novu, "507f1f77bcf86cd799439011");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("messagesDeleteByTransactionId failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/notifications/README.md

@@ -27,7 +27,6 @@ const novu = new Novu({
 async function run() {
   const result = await novu.notifications.list({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -50,15 +49,12 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await notificationsList(novu, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("notificationsList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -105,7 +101,6 @@ const novu = new Novu({
 async function run() {
   const result = await novu.notifications.retrieve("<id>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -128,15 +123,12 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await notificationsRetrieve(novu, "<id>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("notificationsRetrieve failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/novu/README.md

@@ -44,7 +44,6 @@ async function run() {
     to: "SUBSCRIBER_ID",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -77,15 +76,12 @@ async function run() {
     overrides: {},
     to: "SUBSCRIBER_ID",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("trigger failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -107,13 +103,14 @@ run();
 
 ### Errors
 
-| Error Type                             | Status Code                            | Content Type                           |
-| -------------------------------------- | -------------------------------------- | -------------------------------------- |
-| errors.ErrorDto                        | 414                                    | application/json                       |
-| errors.ErrorDto                        | 400, 401, 403, 404, 405, 409, 413, 415 | application/json                       |
-| errors.ValidationErrorDto              | 422                                    | application/json                       |
-| errors.ErrorDto                        | 500                                    | application/json                       |
-| errors.SDKError                        | 4XX, 5XX                               | \*/\*                                  |
+| Error Type                           | Status Code                          | Content Type                         |
+| ------------------------------------ | ------------------------------------ | ------------------------------------ |
+| errors.PayloadValidationExceptionDto | 400                                  | application/json                     |
+| errors.ErrorDto                      | 414                                  | application/json                     |
+| errors.ErrorDto                      | 401, 403, 404, 405, 409, 413, 415    | application/json                     |
+| errors.ValidationErrorDto            | 422                                  | application/json                     |
+| errors.ErrorDto                      | 500                                  | application/json                     |
+| errors.SDKError                      | 4XX, 5XX                             | \*/\*                                |
 
 ## cancel
 
@@ -134,7 +131,6 @@ const novu = new Novu({
 async function run() {
   const result = await novu.cancel("<id>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -157,15 +153,12 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await cancel(novu, "<id>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("cancel failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -229,7 +222,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -269,15 +261,12 @@ async function run() {
       },
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("triggerBroadcast failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -299,13 +288,14 @@ run();
 
 ### Errors
 
-| Error Type                             | Status Code                            | Content Type                           |
-| -------------------------------------- | -------------------------------------- | -------------------------------------- |
-| errors.ErrorDto                        | 414                                    | application/json                       |
-| errors.ErrorDto                        | 400, 401, 403, 404, 405, 409, 413, 415 | application/json                       |
-| errors.ValidationErrorDto              | 422                                    | application/json                       |
-| errors.ErrorDto                        | 500                                    | application/json                       |
-| errors.SDKError                        | 4XX, 5XX                               | \*/\*                                  |
+| Error Type                           | Status Code                          | Content Type                         |
+| ------------------------------------ | ------------------------------------ | ------------------------------------ |
+| errors.PayloadValidationExceptionDto | 400                                  | application/json                     |
+| errors.ErrorDto                      | 414                                  | application/json                     |
+| errors.ErrorDto                      | 401, 403, 404, 405, 409, 413, 415    | application/json                     |
+| errors.ValidationErrorDto            | 422                                  | application/json                     |
+| errors.ErrorDto                      | 500                                  | application/json                     |
+| errors.SDKError                      | 4XX, 5XX                             | \*/\*                                |
 
 ## triggerBulk
 
@@ -362,7 +352,6 @@ async function run() {
     ],
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -421,15 +410,12 @@ async function run() {
       },
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("triggerBulk failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -451,10 +437,11 @@ run();
 
 ### Errors
 
-| Error Type                             | Status Code                            | Content Type                           |
-| -------------------------------------- | -------------------------------------- | -------------------------------------- |
-| errors.ErrorDto                        | 414                                    | application/json                       |
-| errors.ErrorDto                        | 400, 401, 403, 404, 405, 409, 413, 415 | application/json                       |
-| errors.ValidationErrorDto              | 422                                    | application/json                       |
-| errors.ErrorDto                        | 500                                    | application/json                       |
-| errors.SDKError                        | 4XX, 5XX                               | \*/\*                                  |
+| Error Type                           | Status Code                          | Content Type                         |
+| ------------------------------------ | ------------------------------------ | ------------------------------------ |
+| errors.PayloadValidationExceptionDto | 400                                  | application/json                     |
+| errors.ErrorDto                      | 414                                  | application/json                     |
+| errors.ErrorDto                      | 401, 403, 404, 405, 409, 413, 415    | application/json                     |
+| errors.ValidationErrorDto            | 422                                  | application/json                     |
+| errors.ErrorDto                      | 500                                  | application/json                     |
+| errors.SDKError                      | 4XX, 5XX                             | \*/\*                                |

package/docs/sdks/novumessages/README.md

@@ -33,7 +33,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -63,15 +62,12 @@ async function run() {
       status: "pending",
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("subscribersMessagesUpdateAsSeen failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -118,7 +114,6 @@ async function run() {
     markAs: "read",
   }, "<id>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -143,15 +138,12 @@ async function run() {
   const res = await subscribersMessagesMarkAll(novu, {
     markAs: "read",
   }, "<id>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("subscribersMessagesMarkAll failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -202,7 +194,6 @@ async function run() {
     markAs: "seen",
   }, "<id>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -228,15 +219,12 @@ async function run() {
     messageId: [],
     markAs: "seen",
   }, "<id>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("subscribersMessagesMarkAllAs failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();