@greensecurity/javascript-sdk 0.35.55 → 0.36.2

package/README.md

@@ -294,6 +294,7 @@ run();
 * [getCurrentUser](docs/sdks/users/README.md#getcurrentuser) - Get current user
 * [getUserById](docs/sdks/users/README.md#getuserbyid) - Get user by id
 * [postAuthenticate](docs/sdks/users/README.md#postauthenticate) - Logs user into the system
+* [rotateApiKey](docs/sdks/users/README.md#rotateapikey) - Rotate API key
 * [magiclink](docs/sdks/users/README.md#magiclink) - Magic link
 * [passwordResetRequest](docs/sdks/users/README.md#passwordresetrequest) - Password reset request
 * [password](docs/sdks/users/README.md#password) - Password reset
@@ -392,6 +393,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`usersPassword`](docs/sdks/users/README.md#password) - Password reset
 - [`usersPasswordResetRequest`](docs/sdks/users/README.md#passwordresetrequest) - Password reset request
 - [`usersPostAuthenticate`](docs/sdks/users/README.md#postauthenticate) - Logs user into the system
+- [`usersRotateApiKey`](docs/sdks/users/README.md#rotateapikey) - Rotate API key
 - [`vendorsAcceptVendorCredential`](docs/sdks/vendors/README.md#acceptvendorcredential) - Accept vendor credential
 - [`vendorsAddVendorCredentialFile`](docs/sdks/vendors/README.md#addvendorcredentialfile) - Add vendor credential file
 - [`vendorsAddVendorManagedByCompany`](docs/sdks/vendors/README.md#addvendormanagedbycompany) - Add vendor managed by company
@@ -481,6 +483,7 @@ To learn about this feature and how to get started, check
 - [`useUsersPasswordMutation`](docs/sdks/users/README.md#password) - Password reset
 - [`useUsersPasswordResetRequestMutation`](docs/sdks/users/README.md#passwordresetrequest) - Password reset request
 - [`useUsersPostAuthenticateMutation`](docs/sdks/users/README.md#postauthenticate) - Logs user into the system
+- [`useUsersRotateApiKeyMutation`](docs/sdks/users/README.md#rotateapikey) - Rotate API key
 - [`useVendorsAcceptVendorCredentialMutation`](docs/sdks/vendors/README.md#acceptvendorcredential) - Accept vendor credential
 - [`useVendorsAddVendorCredentialFileMutation`](docs/sdks/vendors/README.md#addvendorcredentialfile) - Add vendor credential file
 - [`useVendorsAddVendorManagedByCompanyMutation`](docs/sdks/vendors/README.md#addvendormanagedbycompany) - Add vendor managed by company
@@ -646,16 +649,15 @@ run();
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-This table shows properties which are common on error classes. For full details see [error classes](#error-classes).
+[`GreenSecurityError`](./src/models/errors/greensecurityerror.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 `APIError`                                                          |
 | `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
@@ -678,20 +680,19 @@ async function run() {
 
     console.log(result);
   } catch (error) {
-    // Depending on the method different errors may be thrown
-    if (error instanceof errors.ApiErrorResponse) {
-      console.log(error.message);
-      console.log(error.data$.error); // string
-      console.log(error.data$.success); // boolean
-      console.log(error.data$.code); // number
-    }
-
-    // Fallback error class, if no other more specific error class is matched
-    if (error instanceof errors.APIError) {
+    // The base class for HTTP error responses
+    if (error instanceof errors.GreenSecurityError) {
       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.ApiErrorResponse) {
+        console.log(error.data$.error); // string
+        console.log(error.data$.success); // boolean
+        console.log(error.data$.code); // number
+      }
     }
   }
 }
@@ -701,15 +702,26 @@ run();
 ```
 
 ### Error Classes
-* [`ApiErrorResponse`](docs/models/errors/apierrorresponse.md): Green Security uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Stripe’s servers (these are rare).  Some 4xx errors that could be handled programmatically (e.g., invalid input) include an error description that briefly explains the error reported.
-* `APIError`: 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.
+**Primary errors:**
+* [`GreenSecurityError`](./src/models/errors/greensecurityerror.ts): The base class for HTTP error responses.
+  * [`ApiErrorResponse`](docs/models/errors/apierrorresponse.md): Green Security uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Stripe’s servers (these are rare).  Some 4xx errors that could be handled programmatically (e.g., invalid input) include an error description that briefly explains the error reported.
+
+<details><summary>Less common errors (6)</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 [`GreenSecurityError`](./src/models/errors/greensecurityerror.ts)**:
+* [`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>
 <!-- End Error Handling [errors] -->
 
 <!-- Start Server Selection [server] -->