Merge pull request #76 from onfido/release-upgrade

Refresh onfido-php after onfido-openapi-spec update (db5a1b5)

.markdownlint.json

@@ -0,0 +1,3 @@
+{
+  "MD024": false
+}

.openapi-generator/VERSION

@@ -1 +1 @@
-7.9.0
+7.11.0

.release.json

@@ -1,9 +1,9 @@
 {
   "source": {
     "repo_url": "https://github.com/onfido/onfido-openapi-spec",
-    "short_sha": "0eec622",
-    "long_sha": "0eec6225e66b9f905dac23fe4eb18a1584517f64",
-    "version": ""
+    "short_sha": "db5a1b5",
+    "long_sha": "db5a1b59681fa467b324b4116de24d88d56d7452",
+    "version": "v5.0.0"
   },
   "release": "v9.0.0"
 }

MIGRATION.md

@@ -1,11 +1,41 @@
 # Migration Guide
 
+This guide provides detailed instructions on how to upgrade between different
+major versions of the client library.
+
+It covers changes in core resources, other endpoints, and the OpenAPI generator,
+ensuring a smooth transition between versions.
+
+## Upgrading from 8.x to 9.x
+
+### Core Resources
+
+- Documents
+  - Allow any string as `file_type`
+
+### Other Endpoints
+
+- Webhooks
+  - Drop `WORKFLOW_SIGNED_EVIDENCE_FILE_CREATED` enum value from `WebhookEventType`
+   enum
+  - Make `href` property in `WebhookEventPayloadObject` optional
+- Reports
+  - Allow the deprecated `records` property in `WatchlistAml` and
+   `WatchlistStandard` reports to be any object, and not just a string
+  - Remove `documents` property (incl. `getDocuments()` accessors) from all
+    reports except Document and Facial Similarity reports
+
+### OpenAPI generator
+
+- Version upgraded from `7.9.0` to `7.11.0`
+
 ## Upgrading from 7.x to 8.x
 
 ### Core Resources
 
 - Applicants
-  - Replace broken `ConsentsBuilder` object with a list of `ApplicantConsentBuilder` ones
+  - Replace broken `ConsentsBuilder` object with a list of `ApplicantConsentBuilder`
+    ones
 - Workflow Runs
   - Rename `WorkflowRunSharedLink` object into `WorkflowRunLink`
   - Define `WorkflowRunStatus` enum for storing status information
@@ -22,9 +52,13 @@
 - Checks
   - Rename `Check::Status*` enum into `CheckStatus::*` for accessing checks status
 - Reports
-  - Remove properties from `DeviceIntelligenceBreakdownPropertiesDevice` object: `true_os`, `os_anomaly`, `rooted` and `remote_software`
-  - Remove properties from `DeviceIntelligenceBreakdownPropertiesIp` object: `vpn_detection`, `proxy_detection` and `type`
-  - Deprecate `records` object from `WatchlistStandardProperties` and `WatchlistAmlProperties` objects (includes `WatchlistPepsOnly` and `WatchlistSanctionsOnly` ones)
+  - Remove properties from `DeviceIntelligenceBreakdownPropertiesDevice` object:
+    `true_os`, `os_anomaly`, `rooted` and `remote_software`
+  - Remove properties from `DeviceIntelligenceBreakdownPropertiesIp` object:
+    `vpn_detection`, `proxy_detection` and `type`
+  - Deprecate `records` object from `WatchlistStandardProperties` and
+    `WatchlistAmlProperties` objects (includes `WatchlistPepsOnly` and
+    `WatchlistSanctionsOnly` ones)
 
 ### OpenAPI generator
 

README.md

@@ -114,7 +114,7 @@ Except for accessing Task object's outputs, avoid using the square bracket synta
 
 ## Contributing
 
-This library is automatically generated using [OpenAPI Generator](https://openapi-generator.tech) (version: 7.9.0); therefore, all contributions (except test files) should target the [Onfido OpenAPI specification repository](https://github.com/onfido/onfido-openapi-spec/tree/master) instead of this repository. Please follow the contribution guidelines provided in the OpenAPI specification repository.
+This library is automatically generated using [OpenAPI Generator](https://openapi-generator.tech) (version: 7.11.0); therefore, all contributions (except test files) should target the [Onfido OpenAPI specification repository](https://github.com/onfido/onfido-openapi-spec/tree/master) instead of this repository. Please follow the contribution guidelines provided in the OpenAPI specification repository.
 
 For contributions to the tests instead, please follow the steps below:
 

lib/ApiException.php

@@ -16,7 +16,7 @@
  *
  * The version of the OpenAPI document: v3.6
  * Generated by: https://openapi-generator.tech
- * Generator version: 7.9.0
+ * Generator version: 7.11.0
  */
 
 /**

lib/Configuration.php

@@ -16,7 +16,7 @@
  *
  * The version of the OpenAPI document: v3.6
  * Generated by: https://openapi-generator.tech
- * Generator version: 7.9.0
+ * Generator version: 7.11.0
  */
 
 /**
@@ -469,7 +469,7 @@ public function getHostSettings()
     * @param array|null $variables    hash of variable and the corresponding value (optional)
     * @return string URL based on host settings
     */
-    public static function getHostString(array $hostSettings, $hostIndex, array $variables = null)
+    public static function getHostString(array $hostSettings, $hostIndex, ?array $variables = null)
     {
         if (null === $variables) {
             $variables = [];

lib/HeaderSelector.php

@@ -16,7 +16,7 @@
  *
  * The version of the OpenAPI document: v3.6
  * Generated by: https://openapi-generator.tech
- * Generator version: 7.9.0
+ * Generator version: 7.11.0
  */
 
 /**

lib/Model/Address.php

@@ -17,7 +17,7 @@
  *
  * The version of the OpenAPI document: v3.6
  * Generated by: https://openapi-generator.tech
- * Generator version: 7.9.0
+ * Generator version: 7.11.0
  */
 
 /**
@@ -305,10 +305,10 @@ public function getModelName()
     /**
      * Constructor
      *
-     * @param mixed[] $data Associated array of property values
+     * @param mixed[]|null $data Associated array of property values
      *                      initializing the model
      */
-    public function __construct(array $data = null)
+    public function __construct(?array $data = null)
     {
         $this->setIfExists('flat_number', $data ?? [], null);
         $this->setIfExists('building_number', $data ?? [], null);
@@ -832,7 +832,6 @@ public function toHeaderValue()
     {
         return json_encode(ObjectSerializer::sanitizeForSerialization($this));
     }
-
 }
 
 

lib/Model/AddressBuilder.php

@@ -17,7 +17,7 @@
  *
  * The version of the OpenAPI document: v3.6
  * Generated by: https://openapi-generator.tech
- * Generator version: 7.9.0
+ * Generator version: 7.11.0
  */
 
 /**
@@ -305,10 +305,10 @@ public function getModelName()
     /**
      * Constructor
      *
-     * @param mixed[] $data Associated array of property values
+     * @param mixed[]|null $data Associated array of property values
      *                      initializing the model
      */
-    public function __construct(array $data = null)
+    public function __construct(?array $data = null)
     {
         $this->setIfExists('flat_number', $data ?? [], null);
         $this->setIfExists('building_number', $data ?? [], null);
@@ -832,7 +832,6 @@ public function toHeaderValue()
     {
         return json_encode(ObjectSerializer::sanitizeForSerialization($this));
     }
-
 }
 
 

lib/Model/AddressShared.php

@@ -17,7 +17,7 @@
  *
  * The version of the OpenAPI document: v3.6
  * Generated by: https://openapi-generator.tech
- * Generator version: 7.9.0
+ * Generator version: 7.11.0
  */
 
 /**
@@ -305,10 +305,10 @@ public function getModelName()
     /**
      * Constructor
      *
-     * @param mixed[] $data Associated array of property values
+     * @param mixed[]|null $data Associated array of property values
      *                      initializing the model
      */
-    public function __construct(array $data = null)
+    public function __construct(?array $data = null)
     {
         $this->setIfExists('flat_number', $data ?? [], null);
         $this->setIfExists('building_number', $data ?? [], null);
@@ -832,7 +832,6 @@ public function toHeaderValue()
     {
         return json_encode(ObjectSerializer::sanitizeForSerialization($this));
     }
-
 }
 
 

lib/Model/AddressesList.php

@@ -17,7 +17,7 @@
  *
  * The version of the OpenAPI document: v3.6
  * Generated by: https://openapi-generator.tech
- * Generator version: 7.9.0
+ * Generator version: 7.11.0
  */
 
 /**
@@ -239,10 +239,10 @@ public function getModelName()
     /**
      * Constructor
      *
-     * @param mixed[] $data Associated array of property values
+     * @param mixed[]|null $data Associated array of property values
      *                      initializing the model
      */
-    public function __construct(array $data = null)
+    public function __construct(?array $data = null)
     {
         $this->setIfExists('addresses', $data ?? [], null);
     }
@@ -404,7 +404,6 @@ public function toHeaderValue()
     {
         return json_encode(ObjectSerializer::sanitizeForSerialization($this));
     }
-
 }
 
 

lib/Model/Applicant.php

@@ -17,7 +17,7 @@
  *
  * The version of the OpenAPI document: v3.6
  * Generated by: https://openapi-generator.tech
- * Generator version: 7.9.0
+ * Generator version: 7.11.0
  */
 
 /**
@@ -311,10 +311,10 @@ public function getModelName()
     /**
      * Constructor
      *
-     * @param mixed[] $data Associated array of property values
+     * @param mixed[]|null $data Associated array of property values
      *                      initializing the model
      */
-    public function __construct(array $data = null)
+    public function __construct(?array $data = null)
     {
         $this->setIfExists('email', $data ?? [], null);
         $this->setIfExists('dob', $data ?? [], null);
@@ -833,7 +833,6 @@ public function toHeaderValue()
     {
         return json_encode(ObjectSerializer::sanitizeForSerialization($this));
     }
-
 }
 
 

lib/Model/ApplicantBuilder.php

@@ -17,7 +17,7 @@
  *
  * The version of the OpenAPI document: v3.6
  * Generated by: https://openapi-generator.tech
- * Generator version: 7.9.0
+ * Generator version: 7.11.0
  */
 
 /**
@@ -287,10 +287,10 @@ public function getModelName()
     /**
      * Constructor
      *
-     * @param mixed[] $data Associated array of property values
+     * @param mixed[]|null $data Associated array of property values
      *                      initializing the model
      */
-    public function __construct(array $data = null)
+    public function __construct(?array $data = null)
     {
         $this->setIfExists('email', $data ?? [], null);
         $this->setIfExists('dob', $data ?? [], null);
@@ -700,7 +700,6 @@ public function toHeaderValue()
     {
         return json_encode(ObjectSerializer::sanitizeForSerialization($this));
     }
-
 }
 
 

lib/Model/ApplicantConsentBuilder.php

@@ -17,7 +17,7 @@
  *
  * The version of the OpenAPI document: v3.6
  * Generated by: https://openapi-generator.tech
- * Generator version: 7.9.0
+ * Generator version: 7.11.0
  */
 
 /**
@@ -245,10 +245,10 @@ public function getModelName()
     /**
      * Constructor
      *
-     * @param mixed[] $data Associated array of property values
+     * @param mixed[]|null $data Associated array of property values
      *                      initializing the model
      */
-    public function __construct(array $data = null)
+    public function __construct(?array $data = null)
     {
         $this->setIfExists('name', $data ?? [], null);
         $this->setIfExists('granted', $data ?? [], null);
@@ -444,7 +444,6 @@ public function toHeaderValue()
     {
         return json_encode(ObjectSerializer::sanitizeForSerialization($this));
     }
-
 }
 
 

lib/Model/ApplicantConsentName.php

@@ -17,7 +17,7 @@
  *
  * The version of the OpenAPI document: v3.6
  * Generated by: https://openapi-generator.tech
- * Generator version: 7.9.0
+ * Generator version: 7.11.0
  */
 
 /**

lib/Model/ApplicantCreate.php

@@ -17,7 +17,7 @@
  *
  * The version of the OpenAPI document: v3.6
  * Generated by: https://openapi-generator.tech
- * Generator version: 7.9.0
+ * Generator version: 7.11.0
  */
 
 /**
@@ -245,10 +245,10 @@ public function getModelName()
     /**
      * Constructor
      *
-     * @param mixed[] $data Associated array of property values
+     * @param mixed[]|null $data Associated array of property values
      *                      initializing the model
      */
-    public function __construct(array $data = null)
+    public function __construct(?array $data = null)
     {
         $this->setIfExists('first_name', $data ?? [], null);
         $this->setIfExists('last_name', $data ?? [], null);
@@ -462,7 +462,6 @@ public function toHeaderValue()
     {
         return json_encode(ObjectSerializer::sanitizeForSerialization($this));
     }
-
 }