@novu/api 0.0.1-alpha.100 → 0.0.1-alpha.105

package/README.md

@@ -415,28 +415,23 @@ run();
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-All SDK methods return a response object or throw an error. By default, an API error will throw a `errors.SDKError`.
+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:
 
-If a HTTP request fails, an operation my also throw an error from the `models/errors/httpclienterrors.ts` module:
+| Error Type                | Status Code   | Content Type     |
+| ------------------------- | ------------- | ---------------- |
+| errors.ErrorDto           | 400, 404, 409 | application/json |
+| errors.ValidationErrorDto | 422           | application/json |
+| errors.SDKError           | 4XX, 5XX      | \*/\*            |
 
-| HTTP Client Error                                    | Description                                          |
-| ---------------------------------------------------- | ---------------------------------------------------- |
-| RequestAbortedError                                  | HTTP request was aborted by the client               |
-| RequestTimeoutError                                  | HTTP request timed out due to an AbortSignal signal  |
-| ConnectionError                                      | HTTP client was unable to make a request to a server |
-| InvalidRequestError                                  | Any input used to create a request is invalid        |
-| UnexpectedClientError                                | Unrecognised or unexpected error                     |
-
-In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. For example, the `trigger` method may throw the following errors:
-
-| Error Type      | Status Code   | Content Type     |
-| --------------- | ------------- | ---------------- |
-| errors.ErrorDto | 400, 404, 409 | 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 { ErrorDto, SDKValidationError } from "@novu/api/models/errors";
+import {
+  ErrorDto,
+  SDKValidationError,
+  ValidationErrorDto,
+} from "@novu/api/models/errors";
 
 const novu = new Novu({
   apiKey: "<YOUR_API_KEY_HERE>",
@@ -463,8 +458,9 @@ async function run() {
     console.log(result);
   } catch (err) {
     switch (true) {
+      // The server response does not match the expected SDK schema
       case (err instanceof SDKValidationError): {
-        // Validation errors can be pretty-printed
+        // Pretty-print will provide a human-readable multi-line error message
         console.error(err.pretty());
         // Raw value may also be inspected
         console.error(err.rawValue);
@@ -475,7 +471,13 @@ async function run() {
         console.error(err);
         return;
       }
+      case (err instanceof ValidationErrorDto): {
+        // Handle err.data$: ValidationErrorDtoData
+        console.error(err);
+        return;
+      }
       default: {
+        // Other errors such as network errors, see HTTPClientErrors for more details
         throw err;
       }
     }
@@ -486,7 +488,17 @@ run();
 
 ```
 
-Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
+Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.
+
+In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the `models/errors/httpclienterrors.ts` module:
+
+| HTTP Client Error                                    | Description                                          |
+| ---------------------------------------------------- | ---------------------------------------------------- |
+| RequestAbortedError                                  | HTTP request was aborted by the client               |
+| RequestTimeoutError                                  | HTTP request timed out due to an AbortSignal signal  |
+| ConnectionError                                      | HTTP client was unable to make a request to a server |
+| InvalidRequestError                                  | Any input used to create a request is invalid        |
+| UnexpectedClientError                                | Unrecognised or unexpected error                     |
 <!-- End Error Handling [errors] -->
 
 <!-- Start Server Selection [server] -->

package/docs/sdks/authentication/README.md

@@ -88,10 +88,11 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |
 
 ## chatAccessOauth
 
@@ -171,7 +172,8 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |

package/docs/sdks/credentials/README.md

@@ -88,10 +88,11 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |
 
 ## append
 
@@ -174,10 +175,11 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |
 
 ## delete
 
@@ -248,7 +250,8 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |

package/docs/sdks/integrations/README.md

@@ -82,10 +82,11 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |
 
 ## create
 
@@ -161,10 +162,11 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |
 
 ## listActive
 
@@ -233,10 +235,11 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |
 
 ## update
 
@@ -307,10 +310,11 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 409         | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 409                  | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |
 
 ## delete
 
@@ -380,10 +384,11 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |
 
 ## setAsPrimary
 
@@ -453,7 +458,8 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 409         | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 409                  | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |

package/docs/sdks/messages/README.md

@@ -80,10 +80,11 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |
 
 ## delete
 
@@ -153,10 +154,11 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |
 
 ## deleteByTransactionId
 
@@ -227,7 +229,8 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |

package/docs/sdks/notifications/README.md

@@ -110,10 +110,11 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |
 
 ## retrieve
 
@@ -183,7 +184,8 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |

package/docs/sdks/novu/README.md

@@ -110,10 +110,11 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |
 
 ## triggerBulk
 
@@ -254,10 +255,11 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |
 
 ## triggerBroadcast
 
@@ -345,10 +347,11 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |
 
 ## cancel
 
@@ -421,7 +424,8 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |

package/docs/sdks/novumessages/README.md

@@ -84,10 +84,11 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |
 
 ## markAll
 
@@ -162,10 +163,11 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |
 
 ## updateAsSeen
 
@@ -249,7 +251,8 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |

package/docs/sdks/novunotifications/README.md

@@ -82,10 +82,11 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |
 
 ## unseenCount
 
@@ -163,7 +164,8 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |

package/docs/sdks/novusubscribers/README.md

@@ -90,10 +90,11 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |
 
 ## retrieve
 
@@ -164,10 +165,11 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |
 
 ## remove
 
@@ -248,7 +250,8 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |

package/docs/sdks/preferences/README.md

@@ -79,10 +79,11 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |
 
 ## updateGlobal
 
@@ -153,10 +154,11 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |
 
 ## retrieveByLevel
 
@@ -232,10 +234,11 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |
 
 ## update
 
@@ -313,7 +316,8 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |

package/docs/sdks/properties/README.md

@@ -80,7 +80,8 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |

package/docs/sdks/stats/README.md

@@ -75,10 +75,11 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |
 
 ## graph
 
@@ -148,7 +149,8 @@ run();
 
 ### Errors
 
-| Error Type       | Status Code      | Content Type     |
-| ---------------- | ---------------- | ---------------- |
-| errors.ErrorDto  | 400, 404, 409    | application/json |
-| errors.SDKError  | 4XX, 5XX         | \*/\*            |
+| Error Type                | Status Code               | Content Type              |
+| ------------------------- | ------------------------- | ------------------------- |
+| errors.ErrorDto           | 400, 404, 409             | application/json          |
+| errors.ValidationErrorDto | 422                       | application/json          |
+| errors.SDKError           | 4XX, 5XX                  | \*/\*                     |