@onfido/api 3.0.0 → 3.2.0

package/README.md

@@ -8,6 +8,9 @@ This library is only for use on the backend, as it uses Onfido API tokens which
 
 This version uses Onfido API v3.6. Refer to our [API versioning guide](https://developers.onfido.com/guide/api-versioning-policy#client-libraries) for details of which client library versions use which versions of the API.
 
+[![npm version](https://badge.fury.io/js/@onfido%2Fapi.svg)](https://badge.fury.io/js/@onfido%2Fapi)
+![Build Status](https://github.com/onfido/onfido-node/actions/workflows/node.yml/badge.svg)
+
 ## Installation & Usage
 
 ### Installation
@@ -32,7 +35,7 @@ Require the package:
 const {
   DefaultApi,
   Configuration,
-  WebhookEventVerifier,
+  WebhookEventVerifier
 } = require("@onfido/api");
 const { isAxiosError } = require("axios");
 ```
@@ -44,7 +47,7 @@ import {
   DefaultApi,
   Configuration,
   Region,
-  WebhookEventVerifier,
+  WebhookEventVerifier
 } from "@onfido/api";
 import { isAxiosError } from "axios";
 ```
@@ -56,8 +59,8 @@ const onfido = new DefaultApi(
   new Configuration({
     apiToken: process.env.ONFIDO_API_TOKEN,
     region: Region.EU, // Supports Region.EU, Region.US and Region.CA
-    baseOptions: { timeout: 60_000 }, // Additional Axios options (timeout, etc.)
-  }),
+    baseOptions: { timeout: 60_000 } // Additional Axios options (timeout, etc.)
+  })
 );
 ```
 
@@ -75,8 +78,8 @@ Using `async`/`await` (in an `async function`):
       last_name: "Doe",
       location: {
         ip_address: "127.0.0.1",
-        country_of_residence: "GBR",
-      },
+        country_of_residence: "GBR"
+      }
     });
 
     // ...
@@ -151,7 +154,7 @@ For some common types of streams, like instances of `fs.ReadStream`, you can pro
 onfido.uploadDocument(
   "passport",
   "<APPLICANT_ID>",
-  fs.createReadStream("path/to/passport.png"),
+  fs.createReadStream("path/to/passport.png")
 );
 ```
 
@@ -162,7 +165,8 @@ Webhook events payload needs to be verified before it can be accessed. Library a
 ```js
 (async () => {
   try {
-    const verifier = new WebhookEventVerifier("_ABC123abc...3ABC123_");
+    const token = process.env.ONFIDO_WEBHOOK_SECRET_TOKEN;
+    const verifier = new WebhookEventVerifier(token);
     const signature = "a0...760e";
 
     const event = verifier.readPayload(`{"payload":{"r...3"}}`, signature);
@@ -174,24 +178,46 @@ Webhook events payload needs to be verified before it can be accessed. Library a
 })();
 ```
 
+### Recommendations
+
+#### Do not use square bracket syntax
+
+Except for accessing Task object's outputs, retain from using the square bracket syntax (i.e. `[]`) to access not defined properties to avoid breaking changes when these fields will appear.
+
 ## Contributing
 
-This library is automatically generated using [OpenAPI Generator](https://openapi-generator.tech) - version: 7.5.0; therefore all the contributions, except tests files, should target [Onfido OpenAPI specification repository](https://github.com/onfido/onfido-openapi-spec/tree/master) instead of this repository.
+This library is automatically generated using [OpenAPI Generator](https://openapi-generator.tech) (version: 7.6.0); therefore all the contributions, except tests files, should target [Onfido OpenAPI specification repository](https://github.com/onfido/onfido-openapi-spec/tree/master) instead of this repository.
 
 For contributions to the tests instead, please follow the steps below:
 
-1. [Fork](<https://github.com/onfido/onfido-node/fork>) repository
+1. [Fork](https://github.com/onfido/onfido-node/fork) repository
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Make your changes
 4. Commit your changes (`git commit -am 'Add some feature'`)
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create a new Pull Request
 
+## Versioning policy
+
+[Semantic Versioning](https://semver.org) policy is used for library versioning, following guidelines and limitations below:
+
+- MAJOR versions (x.0.0) might:
+  - target a new API version
+  - include non-backward compatible change
+- MINOR versions (0.x.0) might:
+  - add a new functionality, non-mandatory parameter or property
+  - deprecate an old functionality
+  - include non-backward compatible change to a functionality which is:
+    - labelled as alpha or beta
+    - completely broken and not usable
+- PATCH version (0.0.x) might:
+  - fix a bug
+  - include backward compatible changes only
+
 ## More documentation
 
 More documentation and code examples can be found at <https://documentation.onfido.com>.
 
 ## Support
 
-Should you encounter any technical issues during integration, please contact Onfido's Customer Support team
-via the [Customer Experience Portal](https://public.support.onfido.com/) which also includes support documentation.
+Should you encounter any technical issues during integration, please contact Onfido's Customer Support team via the [Customer Experience Portal](https://public.support.onfido.com/) which also includes support documentation.