onfido 4.6.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d96d6906170b9be6731106168f61d6da039f67f8f65e7202274ef3259e645172
-  data.tar.gz: daf83bf07548dcba4da864e17c03b768aaf86b4d68bce658c4b2164d30ad6407
+  metadata.gz: dc79ec450f18e140b4d190ad2d68e2480a4bdacc24818ee605223e3dce3749c0
+  data.tar.gz: 0abfee9a6b0aec0849a0c98caf001775fb9dfd5fcaa04727bf55411a50e91f1d
 SHA512:
-  metadata.gz: 05a2d8051fbffeed8e82da41ab88a118477baf3e6214f62fc1c8a5327979dea2fa29a73e4cf0909acb833fa41cb0e5adf8a11cb46a44d297bf3a4b9d51f14276
-  data.tar.gz: fa62c445cae9183851eff0acaa5efff06a9a76abce6e216516ad872ed75cdd01ff125098b42b8697212b8e212d06de9fa8c4eecda7b6d90d145a14c02124010c
+  metadata.gz: ee17ead11fb1487cf688a5f54818e5fbe3d0049090c3c5cd072a4c82225bac2d2e7e482eb6995e0cd3b596afcd90799d1e92905dfd7840ecd619f581bc6f6510
+  data.tar.gz: c6c2de626f28cd9eb007554753356889a087aa8d911d6ad260429a3fe20b018a5ebd78cae1765f573fbd3e88e801745cec9cd88b4000dd47c0743a231a85da78

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # 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):

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

@@ -14,7 +14,7 @@ This version uses Onfido API v3.6. Refer to our [API versioning guide](https://d
 ### Installation
 
 ```ruby
-gem onfido, '~> 4.6.0'
+gem onfido, '~> 5.0.0'
 ```
 
 Configure with your API token, region and optional timeout (default value is 30):
@@ -86,7 +86,7 @@ Webhook events payload needs to be verified before it can be accessed. Verifying
 
 ## 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:
 

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.6.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
 

data/lib/onfido/models/device_intelligence_report.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
 
@@ -33,9 +33,6 @@ module Onfido
     # The ID of the check to which the report belongs. Read-only.
     attr_accessor :check_id
 
-    # Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
-    attr_accessor :documents
-
     attr_accessor :name
 
     attr_accessor :breakdown
@@ -72,7 +69,6 @@ module Onfido
         :'result' => :'result',
         :'sub_result' => :'sub_result',
         :'check_id' => :'check_id',
-        :'documents' => :'documents',
         :'name' => :'name',
         :'breakdown' => :'breakdown'
       }
@@ -93,7 +89,6 @@ module Onfido
         :'result' => :'ReportResult',
         :'sub_result' => :'ReportSubResult',
         :'check_id' => :'String',
-        :'documents' => :'Array<ReportDocument>',
         :'name' => :'ReportName',
         :'breakdown' => :'DeviceIntelligenceBreakdown'
       }
@@ -157,12 +152,6 @@ module Onfido
         self.check_id = attributes[:'check_id']
       end
 
-      if attributes.key?(:'documents')
-        if (value = attributes[:'documents']).is_a?(Array)
-          self.documents = value
-        end
-      end
-
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       else
@@ -211,7 +200,6 @@ module Onfido
           result == o.result &&
           sub_result == o.sub_result &&
           check_id == o.check_id &&
-          documents == o.documents &&
           name == o.name &&
           breakdown == o.breakdown
     end
@@ -225,7 +213,7 @@ module Onfido
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created_at, href, status, result, sub_result, check_id, documents, name, breakdown].hash
+      [id, created_at, href, status, result, sub_result, check_id, name, breakdown].hash
     end
 
     # Builds the object from hash