@novu/api 1.2.0 → 1.4.0

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();

package/docs/sdks/novunotifications/README.md

@@ -27,7 +27,6 @@ async function run() {
     payload: "btoa(JSON.stringify({ foo: 123 })) results in base64 encoded string like eyJmb28iOjEyM30=",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -53,15 +52,12 @@ async function run() {
     subscriberId: "<id>",
     payload: "btoa(JSON.stringify({ foo: 123 })) results in base64 encoded string like eyJmb28iOjEyM30=",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("subscribersNotificationsFeed failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -108,7 +104,6 @@ async function run() {
     subscriberId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -133,15 +128,12 @@ async function run() {
   const res = await subscribersNotificationsUnseenCount(novu, {
     subscriberId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("subscribersNotificationsUnseenCount failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/novusubscribers/README.md

@@ -23,7 +23,6 @@ const novu = new Novu({
 async function run() {
   const result = await novu.topics.subscribers.retrieve("<id>", "<value>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -46,15 +45,12 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await topicsSubscribersRetrieve(novu, "<id>", "<value>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("topicsSubscribersRetrieve failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/novutopics/README.md

@@ -26,7 +26,6 @@ async function run() {
     subscriberId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -51,15 +50,12 @@ async function run() {
   const res = await subscribersTopicsList(novu, {
     subscriberId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("subscribersTopicsList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/preferences/README.md

@@ -25,7 +25,6 @@ const novu = new Novu({
 async function run() {
   const result = await novu.subscribers.preferences.list("<id>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -48,15 +47,12 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await subscribersPreferencesList(novu, "<id>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("subscribersPreferencesList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -106,7 +102,6 @@ async function run() {
     channels: {},
   }, "<id>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -131,15 +126,12 @@ async function run() {
   const res = await subscribersPreferencesUpdate(novu, {
     channels: {},
   }, "<id>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("subscribersPreferencesUpdate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/properties/README.md

@@ -25,7 +25,6 @@ async function run() {
     isOnline: false,
   }, "<id>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -50,15 +49,12 @@ async function run() {
   const res = await subscribersPropertiesUpdateOnlineFlag(novu, {
     isOnline: false,
   }, "<id>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("subscribersPropertiesUpdateOnlineFlag failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/steps/README.md

@@ -0,0 +1,82 @@
+# Steps
+(*workflows.steps*)
+
+## Overview
+
+### Available Operations
+
+* [retrieve](#retrieve) - Retrieve workflow step
+
+## retrieve
+
+Retrieves data for a specific step in a workflow
+
+### Example Usage
+
+```typescript
+import { Novu } from "@novu/api";
+
+const novu = new Novu({
+  secretKey: "YOUR_SECRET_KEY_HERE",
+});
+
+async function run() {
+  const result = await novu.workflows.steps.retrieve("<id>", "<id>");
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { NovuCore } from "@novu/api/core.js";
+import { workflowsStepsRetrieve } from "@novu/api/funcs/workflowsStepsRetrieve.js";
+
+// Use `NovuCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const novu = new NovuCore({
+  secretKey: "YOUR_SECRET_KEY_HERE",
+});
+
+async function run() {
+  const res = await workflowsStepsRetrieve(novu, "<id>", "<id>");
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("workflowsStepsRetrieve failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `workflowId`                                                                                                                                                                   | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `stepId`                                                                                                                                                                       | *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. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.WorkflowControllerGetWorkflowStepDataResponse](../../models/operations/workflowcontrollergetworkflowstepdataresponse.md)\>**
+
+### 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                               | \*/\*                                  |