onfido 4.5.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 845613bbd6b1c405918b78dfb34fafc8830394f9bba7cb0814baedcdb8fdabf2
-  data.tar.gz: 0c08e45e9909662f8ac95d9c2e5f89edaae9d8857353f700c6cc72b52969def5
+  metadata.gz: dc79ec450f18e140b4d190ad2d68e2480a4bdacc24818ee605223e3dce3749c0
+  data.tar.gz: 0abfee9a6b0aec0849a0c98caf001775fb9dfd5fcaa04727bf55411a50e91f1d
 SHA512:
-  metadata.gz: 7e591ea9e0f915f4e9b9b57edec45d6cfb7aeb245b56f2a639bf580978c832390f0b0c199ca43f7d52e8daa6ad753647086237c657b5cc2ea24b1489cabb8d67
-  data.tar.gz: cb8f330edba0390745729eb7dd9f9acb583669e7e896d9fe9bab7d650d5f0dc0888fae33d35a450e3bc995cc9d407a0594a82aa9b828b7248473a306e3a552f3
+  metadata.gz: ee17ead11fb1487cf688a5f54818e5fbe3d0049090c3c5cd072a4c82225bac2d2e7e482eb6995e0cd3b596afcd90799d1e92905dfd7840ecd619f581bc6f6510
+  data.tar.gz: c6c2de626f28cd9eb007554753356889a087aa8d911d6ad260429a3fe20b018a5ebd78cae1765f573fbd3e88e801745cec9cd88b4000dd47c0743a231a85da78

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## v4.6.0 24th January 2025
+
+- Release based on Onfido OpenAPI spec version [v4.6.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v4.6.0):
+  - [STUDIO-4308] Add driving_license to id_number enum
+  - [CAT-1634] Add proxy configuration support to Java client library
+  - Update README files (including templated ones)
+  - Add customer_user_id in the webhook event resource
+- test: wait for evidence folder to be available
+
+## 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):

data/MIGRATION.md

@@ -1,5 +1,34 @@
 # 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 4.x to 5.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 from all reports except Document and
+    Facial Similarity reports
+
+### OpenAPI generator
+
+- Version upgraded from `7.9.0` to `7.11.0`
+
 ## Upgrading from 3.x to 4.x
 
 ### Core Resources

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, '~> 4.5.0'
+gem onfido, '~> 5.0.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.9.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.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:
 
-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
 

data/lib/onfido/api/default_api.rb

@@ -6,7 +6,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
 
 =end
 
@@ -1384,6 +1384,69 @@ module Onfido
       return data, status_code, headers
     end
 
+    # Download NFC face
+    # Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image. 
+    # @param document_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [File]
+    def download_nfc_face(document_id, opts = {})
+      data, _status_code, _headers = download_nfc_face_with_http_info(document_id, opts)
+      data
+    end
+
+    # Download NFC face
+    # Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image. 
+    # @param document_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
+    def download_nfc_face_with_http_info(document_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.download_nfc_face ...'
+      end
+      # verify the required parameter 'document_id' is set
+      if @api_client.config.client_side_validation && document_id.nil?
+        fail ArgumentError, "Missing the required parameter 'document_id' when calling DefaultApi.download_nfc_face"
+      end
+      # resource path
+      local_var_path = '/documents/{document_id}/nfc_face'.sub('{' + 'document_id' + '}', CGI.escape(document_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['*/*', 'application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'File'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['Token']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.download_nfc_face",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#download_nfc_face\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Retrieves the signed document or application form
     # Retrieves the signed document or application form depending on the file_id provided. 
     # @param workflow_run_id [String] The unique identifier of the Workflow Run for which you want to retrieve the signed document.
@@ -3447,6 +3510,7 @@ module Onfido
     # @option opts [Time] :created_at_gt A ISO-8601 date to filter results with a created date greater than (after) the one provided.
     # @option opts [Time] :created_at_lt A ISO-8601 date to filter results with a created date less than (before) the one provided.
     # @option opts [String] :sort A string with the value &#39;desc&#39; or &#39;asc&#39; that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to &#39;desc&#39;. (default to 'desc')
+    # @option opts [String] :applicant_id the applicant&#39;s id.
     # @return [Array<WorkflowRun>]
     def list_workflow_runs(opts = {})
       data, _status_code, _headers = list_workflow_runs_with_http_info(opts)
@@ -3461,6 +3525,7 @@ module Onfido
     # @option opts [Time] :created_at_gt A ISO-8601 date to filter results with a created date greater than (after) the one provided.
     # @option opts [Time] :created_at_lt A ISO-8601 date to filter results with a created date less than (before) the one provided.
     # @option opts [String] :sort A string with the value &#39;desc&#39; or &#39;asc&#39; that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to &#39;desc&#39;. (default to 'desc')
+    # @option opts [String] :applicant_id the applicant&#39;s id.
     # @return [Array<(Array<WorkflowRun>, Integer, Hash)>] Array<WorkflowRun> data, response status code and response headers
     def list_workflow_runs_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -3480,6 +3545,7 @@ module Onfido
       query_params[:'created_at_gt'] = opts[:'created_at_gt'] if !opts[:'created_at_gt'].nil?
       query_params[:'created_at_lt'] = opts[:'created_at_lt'] if !opts[:'created_at_lt'].nil?
       query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+      query_params[:'applicant_id'] = opts[:'applicant_id'] if !opts[:'applicant_id'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -4164,10 +4230,6 @@ module Onfido
       if @api_client.config.client_side_validation && file.nil?
         fail ArgumentError, "Missing the required parameter 'file' when calling DefaultApi.upload_document"
       end
-      allowable_values = ["jpg", "jpeg", "png", "pdf", "unknown_default_open_api"]
-      if @api_client.config.client_side_validation && opts[:'file_type'] && !allowable_values.include?(opts[:'file_type'])
-        fail ArgumentError, "invalid value for \"file_type\", must be one of #{allowable_values}"
-      end
       allowable_values = ["front", "back", "unknown_default_open_api"]
       if @api_client.config.client_side_validation && opts[:'side'] && !allowable_values.include?(opts[:'side'])
         fail ArgumentError, "invalid value for \"side\", must be one of #{allowable_values}"

data/lib/onfido/api_client.rb

@@ -6,7 +6,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
 
 =end
 
@@ -19,6 +19,7 @@ require 'faraday'
 require 'faraday/multipart' if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.0')
 require 'marcel'
 
+require 'pathname'  
 
 module Onfido
   class ApiClient
@@ -34,7 +35,7 @@ module Onfido
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "onfido-ruby/4.5.0"
+      @user_agent = "onfido-ruby/5.0.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/onfido/api_error.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/configuration.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/address.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/address_builder.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/address_shared.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/addresses_list.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/applicant.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/applicant_builder.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/applicant_consent_builder.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/applicant_consent_name.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/applicant_create.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/applicant_request.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/applicant_response.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/applicant_shared.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/applicant_update.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/applicant_updater.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/applicants_list.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/check.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/check_builder.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/check_request.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/check_response.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/check_shared.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/check_status.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/checks_list.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/complete_task_builder.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/complete_task_data_builder.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/country_codes.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/device_intelligence_breakdown.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/device_intelligence_breakdown_breakdown.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/device_intelligence_breakdown_breakdown_device.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/device_intelligence_breakdown_breakdown_device_breakdown.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/device_intelligence_breakdown_properties.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/device_intelligence_breakdown_properties_device.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/device_intelligence_breakdown_properties_geolocation.rb

@@ -6,7 +6,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
 
 =end
 

data/lib/onfido/models/device_intelligence_breakdown_properties_ip.rb

@@ -6,7 +6,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
 
 =end