Upgrade after onfido-openapi-spec change 38a8740

.release.json

@@ -0,0 +1,9 @@
+{
+  "source": {
+    "repo_url": "https://github.com/onfido/onfido-openapi-spec",
+    "short_sha": "38a8740",
+    "long_sha": "38a87401552386cb0b17aae28385c5e2f4af7bfc",
+    "version": ""
+  },
+  "release": "v4.0.0"
+}

README.md

@@ -175,9 +175,15 @@ 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.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.
+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:
 
@@ -188,11 +194,27 @@ For contributions to the tests instead, please follow the steps below:
 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.

api.ts

@@ -4830,6 +4830,19 @@ export interface FacialSimilarityMotionBreakdownVisualAuthenticityBreakdownSpoof
      */
     'properties'?: FacialSimilarityPhotoBreakdownVisualAuthenticityBreakdownSpoofingDetectionProperties;
 }
+/**
+ * 
+ * @export
+ * @interface FacialSimilarityMotionProperties
+ */
+export interface FacialSimilarityMotionProperties {
+    /**
+     * A floating point number between 0 and 1. The closer the score is to 0, the more likely it is to be a spoof (i.e. videos of digital screens, masks or print-outs). Conversely, the closer it is to 1, the less likely it is to be a spoof. 
+     * @type {number}
+     * @memberof FacialSimilarityMotionProperties
+     */
+    'score'?: number;
+}
 /**
  * 
  * @export
@@ -4896,6 +4909,12 @@ export interface FacialSimilarityMotionReport {
      * @memberof FacialSimilarityMotionReport
      */
     'breakdown'?: FacialSimilarityMotionBreakdown;
+    /**
+     * 
+     * @type {FacialSimilarityMotionProperties}
+     * @memberof FacialSimilarityMotionReport
+     */
+    'properties'?: FacialSimilarityMotionProperties;
 }
 
 
@@ -5216,6 +5235,19 @@ export interface FacialSimilarityPhotoFullyAutoBreakdownImageIntegrityBreakdownS
      */
     'properties'?: PhotoAutoReasons;
 }
+/**
+ * 
+ * @export
+ * @interface FacialSimilarityPhotoFullyAutoProperties
+ */
+export interface FacialSimilarityPhotoFullyAutoProperties {
+    /**
+     * A floating point number between 0 and 1. The closer the score is to 0, the more likely it is to be a spoof (i.e. photos of printed photos, or photos of digital screens). Conversely, the closer it is to 1, the less likely it is to be a spoof. 
+     * @type {number}
+     * @memberof FacialSimilarityPhotoFullyAutoProperties
+     */
+    'score'?: number;
+}
 /**
  * 
  * @export
@@ -5282,9 +5314,28 @@ export interface FacialSimilarityPhotoFullyAutoReport {
      * @memberof FacialSimilarityPhotoFullyAutoReport
      */
     'breakdown'?: FacialSimilarityPhotoFullyAutoBreakdown;
+    /**
+     * 
+     * @type {FacialSimilarityPhotoFullyAutoProperties}
+     * @memberof FacialSimilarityPhotoFullyAutoReport
+     */
+    'properties'?: FacialSimilarityPhotoFullyAutoProperties;
 }
 
 
+/**
+ * 
+ * @export
+ * @interface FacialSimilarityPhotoProperties
+ */
+export interface FacialSimilarityPhotoProperties {
+    /**
+     * A floating point number between 0 and 1. The closer the score is to 0, the more likely it is to be a spoof (i.e. photos of printed photos, or photos of digital screens). Conversely, the closer it is to 1, the less likely it is to be a spoof. 
+     * @type {number}
+     * @memberof FacialSimilarityPhotoProperties
+     */
+    'score'?: number;
+}
 /**
  * 
  * @export
@@ -5351,6 +5402,12 @@ export interface FacialSimilarityPhotoReport {
      * @memberof FacialSimilarityPhotoReport
      */
     'breakdown'?: FacialSimilarityPhotoBreakdown;
+    /**
+     * 
+     * @type {FacialSimilarityPhotoProperties}
+     * @memberof FacialSimilarityPhotoReport
+     */
+    'properties'?: FacialSimilarityPhotoProperties;
 }
 
 
@@ -5550,6 +5607,19 @@ export interface FacialSimilarityVideoBreakdownVisualAuthenticityBreakdownSpoofi
      */
     'properties'?: FacialSimilarityPhotoBreakdownVisualAuthenticityBreakdownSpoofingDetectionProperties;
 }
+/**
+ * 
+ * @export
+ * @interface FacialSimilarityVideoProperties
+ */
+export interface FacialSimilarityVideoProperties {
+    /**
+     * A floating point number between 0 and 1. The closer the score is to 0, the more likely it is to be a spoof (i.e. videos of digital screens, masks or print-outs). Conversely, the closer it is to 1, the less likely it is to be a spoof. 
+     * @type {number}
+     * @memberof FacialSimilarityVideoProperties
+     */
+    'score'?: number;
+}
 /**
  * 
  * @export
@@ -5616,6 +5686,12 @@ export interface FacialSimilarityVideoReport {
      * @memberof FacialSimilarityVideoReport
      */
     'breakdown'?: FacialSimilarityVideoBreakdown;
+    /**
+     * 
+     * @type {FacialSimilarityVideoProperties}
+     * @memberof FacialSimilarityVideoReport
+     */
+    'properties'?: FacialSimilarityVideoProperties;
 }