onfido 3.4.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80a6064074cd1701caabe2b1a709b23c64b38063a8b74a857021fe4c924b8f3e
-  data.tar.gz: b0d29ec09c5009095de47d40159af85a00d774e2ee94ffbfe5eb70a7914800e1
+  metadata.gz: d96d6906170b9be6731106168f61d6da039f67f8f65e7202274ef3259e645172
+  data.tar.gz: daf83bf07548dcba4da864e17c03b768aaf86b4d68bce658c4b2164d30ad6407
 SHA512:
-  metadata.gz: 6bfd5c166e29f1e4a417f667308fae843736d8cc237ad205d265ff7127c39fe500f02aefd60ed4ec071230dfde6427ea931ce5e97fd914c680b8c7a5c7e22ae8
-  data.tar.gz: 8cad9cd387ff988a6a8aaf23c67f6a5119d224d036d0de37494a895320c9ae7584510a4ffeaba69d5ae73e2b0273c6ba2dc7eda2a354a0bca795fcffc402be26
+  metadata.gz: 05a2d8051fbffeed8e82da41ab88a118477baf3e6214f62fc1c8a5327979dea2fa29a73e4cf0909acb833fa41cb0e5adf8a11cb46a44d297bf3a4b9d51f14276
+  data.tar.gz: fa62c445cae9183851eff0acaa5efff06a9a76abce6e216516ad872ed75cdd01ff125098b42b8697212b8e212d06de9fa8c4eecda7b6d90d145a14c02124010c

data/CHANGELOG.md

@@ -1,5 +1,48 @@
 # Changelog
 
+## v4.5.0 8th January 2025
+
+- Release based on Onfido OpenAPI spec version [v4.5.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v4.5.0):
+  - [STUDIO-4305] Add download evidence folder path
+
+## v4.4.0 20th December 2024
+
+- Release based on Onfido OpenAPI spec version [v4.4.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v4.4.0):
+  - [CAT-1593] Fix missing webhook type and evidence folder webhook
+  - [CAT-1590] Allow any type for the workflow task output
+
+## v4.3.0 27th November 2024
+
+- Release based on Onfido OpenAPI spec version [v4.3.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v4.3.0):
+  - [CAT-1581] Revert "[CAT-1528] Fix barcode field in document properties object"
+
+## v4.2.0 19th November 2024
+
+- Release based on Onfido OpenAPI spec version [v4.2.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v4.2.0):
+  - feat: add new fields to facial similarity report objects
+  - [CAT-1552] Add missing document types
+
+## v4.1.0 8th November 2024
+
+- Release based on Onfido OpenAPI spec version [v4.1.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v4.1.0):
+  - [CAT-1528] Fix barcode field in document properties object
+
+## v4.0.0 24th October 2024
+
+- Release based on Onfido OpenAPI spec version [v4.0.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v4.0.0):
+  - [CAT-1379] Add a few missing properties
+  - [CAT-1447] Fix applicant consents
+  - [CAT-1379] Fix check creation, remove some deprecated properties and deprecate others
+  - Use document-type enum for document upload
+  - [CAT-1306] Add webhooks event resource
+  - Upgrade OpenAPI generator to v7.9.0 (was v7.6.0)
+  - [Migration Guide](MIGRATION.md#upgrading-from-3x-to-4x)
+
+## v3.4.0 20th September 2024
+
+- Release based on Onfido OpenAPI spec version [v3.5.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v3.5.0):
+  - [CAT-1376] Add record item object definition for watchlist enhanced properties field
+
 ## v3.3.1 22nd August 2024
 
 - Release based on Onfido OpenAPI spec version [v3.3.1](https://github.com/onfido/onfido-openapi-spec/releases/tag/v3.3.1):

data/Gemfile

@@ -6,6 +6,7 @@ group :development, :test do
   gem 'rake', '~> 13.0.1'
   gem 'pry-byebug'
   gem 'rubocop', '~> 0.66.0'
+  gem 'rubyzip', '~> 2.3.2'
 end
 
 gem "faraday-follow_redirects", "~> 0.3.0"

data/MIGRATION.md

@@ -0,0 +1,30 @@
+# Migration Guide
+
+## Upgrading from 3.x to 4.x
+
+### Core Resources
+
+- Applicants
+  - Replace broken `ConsentsBuilder` object with a list of `ApplicantConsentBuilder` ones
+- Workflow Runs
+  - Rename `WorkflowRunSharedLink` object into `WorkflowRunLink`
+  - Define `WorkflowRunStatus` enum for storing status information
+  - Rename `WorkflowRunResponseError` object into `WorkflowRunError`
+- Documents
+  - Reuse already existent `DocumentTypes` enum when uploading documents
+
+### Other Endpoints
+
+- Webhooks
+  - Define `WebhookEventObjectStatus` enum to collect webhook event object's status
+  - Define `WebhookEventResourceType` enum to collect webhhok event resource's type
+  - Define `WebhookEventPayloadResource` object to store webhook payload's contents
+- Checks
+  - Define `CheckStatus` enum 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`
+
+### OpenAPI generator
+
+- Version upgraded from 7.6.0 to 7.9.0

data/README.md

@@ -2,7 +2,7 @@
 
 The official Ruby library for integrating with the Onfido API.
 
-Documentation can be found at <https://documentation.onfido.com>.
+Refer to the documentation at <https://documentation.onfido.com>.
 
 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.
 
@@ -14,7 +14,7 @@ This version uses Onfido API v3.6. Refer to our [API versioning guide](https://d
 ### Installation
 
 ```ruby
-gem onfido, '~> 3.4.0'
+gem onfido, '~> 4.6.0'
 ```
 
 Configure with your API token, region and optional timeout (default value is 30):
@@ -42,7 +42,7 @@ applicant = onfido_api.create_applicant(
 )
 ```
 
-Documentation and code examples can be found at https://documentation.onfido.com
+Documentation and code examples can be found at <https://documentation.onfido.com>.
 
 ## Error Handling
 
@@ -65,7 +65,7 @@ end
 
 ### Webhook event verification
 
-Webhook events payload needs to be verified before it can be accessed. Library allows to easily decode the payload and verify its signature before returning it as an object for user convenience:
+Webhook events payload needs to be verified before it can be accessed. Verifying webhook payloads is crucial for security reasons, as it ensures that the payloads are indeed from Onfido and have not been tampered with. The library allows you to easily decode the payload and verify its signature before returning it as an object for user convenience:
 
 ```ruby
   require 'onfido/webhook_event_verifier'
@@ -86,37 +86,39 @@ Webhook events payload needs to be verified before it can be accessed. Library a
 
 ## 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.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.
 
 For contributions to the tests instead, please follow the steps below:
 
-1. [Fork](https://github.com/onfido/onfido-ruby/fork) repository
+1. Fork the [repository](https://github.com/onfido/onfido-ruby/fork)
 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'`)
+4. Commit your changes (`git commit -am 'Add detailed description of the 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:
+Versioning helps manage changes and ensures compatibility across different versions of the library.
 
-- MAJOR versions (x.0.0) might:
+[Semantic Versioning](https://semver.org) policy is used for library versioning, following the guidelines and limitations outlined below:
+
+- MAJOR versions (x.0.0) may:
   - target a new API version
   - include non-backward compatible change
-- MINOR versions (0.x.0) might:
+- MINOR versions (0.x.0) may:
   - 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:
+- PATCH version (0.0.x) will:
   - fix a bug
   - include backward compatible changes only
 
 ## More documentation
 
-More documentation and code examples can be found at <https://documentation.onfido.com>.
+Additional documentation and code examples can be found at <https://documentation.onfido.com>.
 
 ## Support