@novu/api 1.3.0 → 1.5.0

package/README.md

@@ -330,6 +330,14 @@ run();
 <details open>
 <summary>Available methods</summary>
 
+### [environments](docs/sdks/environments/README.md)
+
+* [getTags](docs/sdks/environments/README.md#gettags) - Get environment tags
+* [create](docs/sdks/environments/README.md#create) - Create an environment
+* [list](docs/sdks/environments/README.md#list) - List all environments
+* [update](docs/sdks/environments/README.md#update) - Update an environment
+* [delete](docs/sdks/environments/README.md#delete) - Delete an environment
+
 ### [integrations](docs/sdks/integrations/README.md)
 
 * [list](docs/sdks/integrations/README.md#list) - List all integrations
@@ -356,6 +364,7 @@ run();
 * [cancel](docs/sdks/novu/README.md#cancel) - Cancel triggered event
 * [triggerBroadcast](docs/sdks/novu/README.md#triggerbroadcast) - Broadcast event to all
 * [triggerBulk](docs/sdks/novu/README.md#triggerbulk) - Bulk trigger event
+* [retrieve](docs/sdks/novu/README.md#retrieve)
 
 ### [subscribers](docs/sdks/subscribers/README.md)
 
@@ -368,8 +377,8 @@ run();
 
 #### [subscribers.credentials](docs/sdks/credentials/README.md)
 
-* [update](docs/sdks/credentials/README.md#update) - Update provider credentials
-* [append](docs/sdks/credentials/README.md#append) - Upsert provider credentials
+* [update](docs/sdks/credentials/README.md#update) - Upsert provider credentials
+* [append](docs/sdks/credentials/README.md#append) - Create or Partially Update provider credentials
 * [delete](docs/sdks/credentials/README.md#delete) - Delete provider credentials
 
 #### [subscribers.messages](docs/sdks/novumessages/README.md)
@@ -414,6 +423,20 @@ run();
 * [create](docs/sdks/subscriptions/README.md#create) - Create topic subscriptions
 * [delete](docs/sdks/subscriptions/README.md#delete) - Delete topic subscriptions
 
+### [workflows](docs/sdks/workflows/README.md)
+
+* [create](docs/sdks/workflows/README.md#create) - Create a workflow
+* [list](docs/sdks/workflows/README.md#list) - List all workflows
+* [update](docs/sdks/workflows/README.md#update) - Update a workflow
+* [get](docs/sdks/workflows/README.md#get) - Retrieve a workflow
+* [delete](docs/sdks/workflows/README.md#delete) - Delete a workflow
+* [patch](docs/sdks/workflows/README.md#patch) - Update a workflow
+* [sync](docs/sdks/workflows/README.md#sync) - Sync a workflow
+
+#### [workflows.steps](docs/sdks/steps/README.md)
+
+* [retrieve](docs/sdks/steps/README.md#retrieve) - Retrieve workflow step
+
 </details>
 <!-- End Available Resources and Operations [operations] -->
 
@@ -433,6 +456,11 @@ 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
+- [`environmentsCreate`](docs/sdks/environments/README.md#create) - Create an environment
+- [`environmentsDelete`](docs/sdks/environments/README.md#delete) - Delete an environment
+- [`environmentsGetTags`](docs/sdks/environments/README.md#gettags) - Get environment tags
+- [`environmentsList`](docs/sdks/environments/README.md#list) - List all environments
+- [`environmentsUpdate`](docs/sdks/environments/README.md#update) - Update an environment
 - [`integrationsCreate`](docs/sdks/integrations/README.md#create) - Create an integration
 - [`integrationsDelete`](docs/sdks/integrations/README.md#delete) - Delete an integration
 - [`integrationsList`](docs/sdks/integrations/README.md#list) - List all integrations
@@ -444,11 +472,12 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`messagesRetrieve`](docs/sdks/messages/README.md#retrieve) - List all messages
 - [`notificationsList`](docs/sdks/notifications/README.md#list) - List all events
 - [`notificationsRetrieve`](docs/sdks/notifications/README.md#retrieve) - Retrieve an event
+- [`retrieve`](docs/sdks/novu/README.md#retrieve)
 - [`subscribersCreate`](docs/sdks/subscribers/README.md#create) - Create a subscriber
 - [`subscribersCreateBulk`](docs/sdks/subscribers/README.md#createbulk) - Bulk create subscribers
-- [`subscribersCredentialsAppend`](docs/sdks/credentials/README.md#append) - Upsert provider credentials
+- [`subscribersCredentialsAppend`](docs/sdks/credentials/README.md#append) - Create or Partially Update provider credentials
 - [`subscribersCredentialsDelete`](docs/sdks/credentials/README.md#delete) - Delete provider credentials
-- [`subscribersCredentialsUpdate`](docs/sdks/credentials/README.md#update) - Update provider credentials
+- [`subscribersCredentialsUpdate`](docs/sdks/credentials/README.md#update) - Upsert provider credentials
 - [`subscribersDelete`](docs/sdks/subscribers/README.md#delete) - Delete a subscriber
 - [`subscribersMessagesMarkAll`](docs/sdks/novumessages/README.md#markall) - Update all notifications state
 - [`subscribersMessagesMarkAllAs`](docs/sdks/novumessages/README.md#markallas) - Update notifications state
@@ -474,6 +503,14 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`trigger`](docs/sdks/novu/README.md#trigger) - Trigger event
 - [`triggerBroadcast`](docs/sdks/novu/README.md#triggerbroadcast) - Broadcast event to all
 - [`triggerBulk`](docs/sdks/novu/README.md#triggerbulk) - Bulk trigger event
+- [`workflowsCreate`](docs/sdks/workflows/README.md#create) - Create a workflow
+- [`workflowsDelete`](docs/sdks/workflows/README.md#delete) - Delete a workflow
+- [`workflowsGet`](docs/sdks/workflows/README.md#get) - Retrieve a workflow
+- [`workflowsList`](docs/sdks/workflows/README.md#list) - List all workflows
+- [`workflowsPatch`](docs/sdks/workflows/README.md#patch) - Update a workflow
+- [`workflowsStepsRetrieve`](docs/sdks/steps/README.md#retrieve) - Retrieve workflow step
+- [`workflowsSync`](docs/sdks/workflows/README.md#sync) - Sync a workflow
+- [`workflowsUpdate`](docs/sdks/workflows/README.md#update) - Update a workflow
 
 </details>
 <!-- End Standalone functions [standalone-funcs] -->
@@ -481,16 +518,15 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-This table shows properties which are common on error classes. For full details see [error classes](#error-classes).
+[`NovuError`](./src/models/errors/novuerror.ts) is the base class for all HTTP error responses. It has the following properties:
 
 | Property            | Type       | Description                                                                             |
 | ------------------- | ---------- | --------------------------------------------------------------------------------------- |
-| `error.name`        | `string`   | Error class name eg `SDKError`                                                          |
 | `error.message`     | `string`   | Error message                                                                           |
-| `error.statusCode`  | `number`   | HTTP status code eg `404`                                                               |
-| `error.contentType` | `string`   | HTTP content type eg `application/json`                                                 |
+| `error.statusCode`  | `number`   | HTTP response status code eg `404`                                                      |
+| `error.headers`     | `Headers`  | HTTP response headers                                                                   |
 | `error.body`        | `string`   | HTTP body. Can be empty string if no body is returned.                                  |
-| `error.rawResponse` | `Response` | Raw HTTP response. Access to headers and more.                                          |
+| `error.rawResponse` | `Response` | Raw HTTP response                                                                       |
 | `error.data$`       |            | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
 
 ### Example
@@ -518,22 +554,21 @@ async function run() {
 
     console.log(result);
   } catch (error) {
-    // Depending on the method different errors may be thrown
-    if (error instanceof errors.PayloadValidationExceptionDto) {
-      console.log(error.message);
-      console.log(error.data$.statusCode); // number
-      console.log(error.data$.timestamp); // string
-      console.log(error.data$.path); // string
-      console.log(error.data$.message); // errors.PayloadValidationExceptionDtoMessage
-      console.log(error.data$.ctx); // { [k: string]: any }
-    }
-
-    // Fallback error class, if no other more specific error class is matched
-    if (error instanceof errors.SDKError) {
+    // The base class for HTTP error responses
+    if (error instanceof errors.NovuError) {
       console.log(error.message);
       console.log(error.statusCode);
       console.log(error.body);
-      console.log(error.rawResponse.headers);
+      console.log(error.headers);
+
+      // Depending on the method different errors may be thrown
+      if (error instanceof errors.PayloadValidationExceptionDto) {
+        console.log(error.data$.statusCode); // number
+        console.log(error.data$.timestamp); // string
+        console.log(error.data$.path); // string
+        console.log(error.data$.message); // errors.PayloadValidationExceptionDtoMessage
+        console.log(error.data$.ctx); // { [k: string]: any }
+      }
     }
   }
 }
@@ -543,20 +578,29 @@ run();
 ```
 
 ### Error Classes
-* [`ErrorDto`](docs/models/errors/errordto.md): Generic error.
-* [`ValidationErrorDto`](docs/models/errors/validationerrordto.md): Unprocessable Entity. Status code `422`.
-* `SDKError`: The fallback error class, if no other more specific error class is matched.
-* `SDKValidationError`: Type mismatch between the data returned from the server and the structure expected by the SDK. This can also be thrown for invalid method arguments. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
-* Network errors:
-    * `ConnectionError`: HTTP client was unable to make a request to a server.
-    * `RequestTimeoutError`: HTTP request timed out due to an AbortSignal signal.
-    * `RequestAbortedError`: HTTP request was aborted by the client.
-    * `InvalidRequestError`: Any input used to create a request is invalid.
-    * `UnexpectedClientError`: Unrecognised or unexpected error.
-* Less common errors, applicable to a subset of methods:
-    * [`PayloadValidationExceptionDto`](docs/models/errors/payloadvalidationexceptiondto.md): Status code `400`. Applicable to 3 of 42 methods.*
+**Primary errors:**
+* [`NovuError`](./src/models/errors/novuerror.ts): The base class for HTTP error responses.
+  * [`ErrorDto`](./src/models/errors/errordto.ts): *
+  * [`ValidationErrorDto`](./src/models/errors/validationerrordto.ts): Unprocessable Entity. Status code `422`. *
+
+<details><summary>Less common errors (7)</summary>
+
+<br />
+
+**Network errors:**
+* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
+* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
+* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
+* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
+* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
 
 
+**Inherit from [`NovuError`](./src/models/errors/novuerror.ts)**:
+* [`PayloadValidationExceptionDto`](./src/models/errors/payloadvalidationexceptiondto.ts): Status code `400`. Applicable to 3 of 56 methods.*
+* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
+
+</details>
+
 \* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
 <!-- End Error Handling [errors] -->