onfido 5.2.0 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9d1b25944b1a8260f459e08ea5fa12d445303f25066e75736c3d305ec77b52f
-  data.tar.gz: 700a5d91654fe610c6b95f206edf1d85366e06dd24ce9ff84fd95c8e89cc6cb1
+  metadata.gz: 9a49203489e843d3f2358f39b3b12968476e869f998abc6039c67d8f74a780f4
+  data.tar.gz: 69d0b65c65fb24410a0fcfb151fec42aef818a9b48fda1fcd0246d5941ee9e8e
 SHA512:
-  metadata.gz: 93a5c47f5302b73dd9666f85741c7c199731e9d6bb703b169d2dd3ec02521fac1fb1c5b1e0ee2402fe279e4e4d66b026ddc591e756dcf2d3da6c59a6c2ee589d
-  data.tar.gz: 683b92367a3e2ca427c7dbebbb5847927f45d61437786d78dd916d323e42fcebf78966196dc779a32998a6179ec3b49c1a089fb2dd9437c0856b4b9b80bcd9ae
+  metadata.gz: 904a4f1343dda90bbe5c556dba5cfb407fa48279deb4b1bc631f705c80b356aed32d75f834448707cf9357359c9be759319036a9c1fe96f2127e241307c5325e
+  data.tar.gz: fece926f4d700d55ef99fbda9344b03742c8bf81f6d2a05112577cf7a2142d5f7d7e0220f41f7e6cd56a9ede3cb734101256b566f31c5f1cb17bf0142d012072

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## v5.3.0 11th July 2025
+
+- Release based on Onfido OpenAPI spec version [v5.3.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v5.3.0):
+- Release based on Onfido OpenAPI spec version [v5.3.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v5.3.0):
+  - [DEXTV2-9494] Add manual_transmission_restriction to document with driver verification report
+
+## v5.2.0 5th June 2025
+
+- Release based on Onfido OpenAPI spec version [v5.2.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v5.2.0):
+  - [BIO-7260] Add report configuration (including use_case) to checks
+
 ## v5.1.1 19th May 2025
 
 - Release based on Onfido OpenAPI spec version [v5.1.1](https://github.com/onfido/onfido-openapi-spec/releases/tag/v5.1.1):

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', '~> 5.2.0'
+gem 'onfido', '~> 5.4.0'
 ```
 
 Configure with your API token, region and optional timeout (default value is 30):

data/lib/onfido/api/default_api.rb

@@ -754,6 +754,77 @@ module Onfido
       return data, status_code, headers
     end
 
+    # Retrieves the signed document or signing transaction receipt
+    # Retrieves the signed document or signing transaction receipt depending on the id provided. 
+    # @param workflow_run_id [String] The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+    # @param id [String] The unique identifier of the file which you want to retrieve.
+    # @param [Hash] opts the optional parameters
+    # @return [File]
+    def download_aes_document(workflow_run_id, id, opts = {})
+      data, _status_code, _headers = download_aes_document_with_http_info(workflow_run_id, id, opts)
+      data
+    end
+
+    # Retrieves the signed document or signing transaction receipt
+    # Retrieves the signed document or signing transaction receipt depending on the id provided. 
+    # @param workflow_run_id [String] The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+    # @param id [String] The unique identifier of the file which you want to retrieve.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
+    def download_aes_document_with_http_info(workflow_run_id, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.download_aes_document ...'
+      end
+      # verify the required parameter 'workflow_run_id' is set
+      if @api_client.config.client_side_validation && workflow_run_id.nil?
+        fail ArgumentError, "Missing the required parameter 'workflow_run_id' when calling DefaultApi.download_aes_document"
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling DefaultApi.download_aes_document"
+      end
+      # resource path
+      local_var_path = '/advanced_electronic_signature/documents'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'workflow_run_id'] = workflow_run_id
+      query_params[:'id'] = id
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/pdf', '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_aes_document",
+        :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_aes_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Download check
     # Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF. 
     # @param check_id [String] 

data/lib/onfido/api_client.rb

@@ -35,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/5.2.0"
+      @user_agent = "onfido-ruby/5.4.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/onfido/models/document_with_driver_verification_report_all_of_properties.rb

@@ -117,6 +117,9 @@ module Onfido
     # Comma-separated vehicle classes that the user is qualified for
     attr_accessor :raw_vehicle_classes
 
+    # True if the user is not qualified to drive a manual transmission
+    attr_accessor :manual_transmission_restriction
+
     # Detailed classes/categories information
     attr_accessor :vehicle_class_details
 
@@ -196,6 +199,7 @@ module Onfido
         :'restricted_licence' => :'restricted_licence',
         :'raw_licence_category' => :'raw_licence_category',
         :'raw_vehicle_classes' => :'raw_vehicle_classes',
+        :'manual_transmission_restriction' => :'manual_transmission_restriction',
         :'vehicle_class_details' => :'vehicle_class_details',
         :'passenger_vehicle' => :'passenger_vehicle'
       }
@@ -258,6 +262,7 @@ module Onfido
         :'restricted_licence' => :'Boolean',
         :'raw_licence_category' => :'String',
         :'raw_vehicle_classes' => :'String',
+        :'manual_transmission_restriction' => :'Boolean',
         :'vehicle_class_details' => :'Array<DocumentWithDriverVerificationReportAllOfPropertiesAllOfVehicleClassDetailsInner>',
         :'passenger_vehicle' => :'DocumentWithDriverVerificationReportAllOfPropertiesAllOfPassengerVehicle'
       }
@@ -493,6 +498,10 @@ module Onfido
         self.raw_vehicle_classes = attributes[:'raw_vehicle_classes']
       end
 
+      if attributes.key?(:'manual_transmission_restriction')
+        self.manual_transmission_restriction = attributes[:'manual_transmission_restriction']
+      end
+
       if attributes.key?(:'vehicle_class_details')
         if (value = attributes[:'vehicle_class_details']).is_a?(Array)
           self.vehicle_class_details = value
@@ -609,6 +618,7 @@ module Onfido
           restricted_licence == o.restricted_licence &&
           raw_licence_category == o.raw_licence_category &&
           raw_vehicle_classes == o.raw_vehicle_classes &&
+          manual_transmission_restriction == o.manual_transmission_restriction &&
           vehicle_class_details == o.vehicle_class_details &&
           passenger_vehicle == o.passenger_vehicle
     end
@@ -622,7 +632,7 @@ module Onfido
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [date_of_birth, date_of_expiry, personal_number, document_numbers, document_type, first_name, middle_name, last_name, gender, issuing_country, nationality, issuing_state, issuing_date, categorisation, mrz_line1, mrz_line2, mrz_line3, address, place_of_birth, spouse_name, widow_name, alias_name, issuing_authority, remarks, civil_state, expatriation, father_name, mother_name, religion, type_of_permit, version_number, document_subtype, profession, security_document_number, tax_number, nist_identity_evidence_strength, has_issuance_confirmation, real_id_compliance, security_tier, address_lines, barcode, nfc, driving_licence_information, document_classification, extracted_data, drivers_licence, restricted_licence, raw_licence_category, raw_vehicle_classes, vehicle_class_details, passenger_vehicle].hash
+      [date_of_birth, date_of_expiry, personal_number, document_numbers, document_type, first_name, middle_name, last_name, gender, issuing_country, nationality, issuing_state, issuing_date, categorisation, mrz_line1, mrz_line2, mrz_line3, address, place_of_birth, spouse_name, widow_name, alias_name, issuing_authority, remarks, civil_state, expatriation, father_name, mother_name, religion, type_of_permit, version_number, document_subtype, profession, security_document_number, tax_number, nist_identity_evidence_strength, has_issuance_confirmation, real_id_compliance, security_tier, address_lines, barcode, nfc, driving_licence_information, document_classification, extracted_data, drivers_licence, restricted_licence, raw_licence_category, raw_vehicle_classes, manual_transmission_restriction, vehicle_class_details, passenger_vehicle].hash
     end
 
     # Builds the object from hash

data/lib/onfido/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.11.0
 =end
 
 module Onfido
-  VERSION = '5.2.0'
+  VERSION = '5.4.0'
 end

data/spec/integrations/advanced_electronic_signature_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative '../shared_contexts/with_workflow_run'
+
+describe Onfido::WorkflowRun do
+  include_context 'with applicant'
+
+  let(:workflow_id) { '9554c27e-9886-4052-992d-816467d97d24' }
+
+  let(:workflow_run_builder) do
+    Onfido::WorkflowRunBuilder.new({
+      applicant_id: applicant_id,
+      workflow_id: workflow_id,
+      custom_data: {
+        face_result: "clear",
+        doc_result: "clear",
+        transaction_id: "995bf84c-d708-4977-8b88-d4b66bebdaf6",
+      }
+    })
+  end
+
+  let(:workflow_run) { onfido_api.create_workflow_run(workflow_run_builder) }
+  let!(:workflow_run_id) { workflow_run.id }
+
+  def get_task_output(workflow_run_id, task_index = 1)
+    task = onfido_api.list_tasks(workflow_run_id)[task_index]
+
+    repeat_request_until_task_output_changes(
+      max_retries = 10,
+      interval = 3
+    ) { onfido_api.find_task(workflow_run_id, task.id) }.output
+  end
+
+  let(:signed_document_file_id) do
+    get_task_output(workflow_run_id)[:properties][:signed_documents][0][:id]
+  end
+
+  let(:transaction_receipt_file_id) do
+    get_task_output(workflow_run_id)[:properties][:receipt_document][:id]
+  end
+
+  describe 'Workflow run' do
+    it 'downloads aes documents' do
+      signed_document = onfido_api.download_aes_document(workflow_run_id, signed_document_file_id)
+      expect(signed_document.size).to eq 13264
+
+      transaction_receipt = onfido_api.download_aes_document(workflow_run_id, transaction_receipt_file_id)
+      expect(transaction_receipt.size).to eq 13264
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onfido
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.4.0
 platform: ruby
 authors:
 - OpenAPI-Generator
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-05 00:00:00.000000000 Z
+date: 2025-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -438,6 +438,7 @@ files:
 - onfido.gemspec
 - spec/classic_webhook_event_verifier_spec.rb
 - spec/integrations/address_picker_spec.rb
+- spec/integrations/advanced_electronic_signature_spec.rb
 - spec/integrations/applicant_spec.rb
 - spec/integrations/check_spec.rb
 - spec/integrations/document_spec.rb
@@ -493,34 +494,35 @@ specification_version: 4
 summary: The official Ruby library for integrating with the Onfido API.
 test_files:
 - spec/classic_webhook_event_verifier_spec.rb
+- spec/integrations/address_picker_spec.rb
 - spec/integrations/report_schema_spec.rb
-- spec/integrations/extraction_spec.rb
+- spec/integrations/media/sample_photo.png
+- spec/integrations/media/sample_driving_licence.png
+- spec/integrations/tasks_spec.rb
+- spec/integrations/document_spec.rb
+- spec/integrations/live_video_spec.rb
 - spec/integrations/workflow_run_spec.rb
-- spec/integrations/live_photo_spec.rb
-- spec/integrations/watchlist_monitor_spec.rb
+- spec/integrations/webhook_spec.rb
+- spec/integrations/id_photo_spec.rb
+- spec/integrations/applicant_spec.rb
 - spec/integrations/sdk_token_spec.rb
-- spec/integrations/document_spec.rb
-- spec/integrations/tasks_spec.rb
-- spec/integrations/media/sample_driving_licence.png
-- spec/integrations/media/sample_photo.png
 - spec/integrations/workflow_run_output_spec.rb
-- spec/integrations/id_photo_spec.rb
-- spec/integrations/address_picker_spec.rb
-- spec/integrations/live_video_spec.rb
+- spec/integrations/watchlist_monitor_spec.rb
 - spec/integrations/qualified_electronic_signature_spec.rb
+- spec/integrations/extraction_spec.rb
+- spec/integrations/motion_capture_spec.rb
+- spec/integrations/advanced_electronic_signature_spec.rb
 - spec/integrations/report_spec.rb
+- spec/integrations/live_photo_spec.rb
 - spec/integrations/check_spec.rb
-- spec/integrations/webhook_spec.rb
-- spec/integrations/applicant_spec.rb
-- spec/integrations/motion_capture_spec.rb
 - spec/media/studio_webhook_event_with_list_in_output.json
 - spec/media/studio_webhook_event_with_object_in_output.json
 - spec/shared_contexts/with_check.rb
+- spec/shared_contexts/with_document.rb
 - spec/shared_contexts/with_applicant.rb
-- spec/shared_contexts/with_live_photo.rb
-- spec/shared_contexts/with_onfido.rb
 - spec/shared_contexts/with_workflow_run.rb
-- spec/shared_contexts/with_document.rb
+- spec/shared_contexts/with_onfido.rb
+- spec/shared_contexts/with_live_photo.rb
 - spec/shared_examples/file_examples.rb
 - spec/spec_helper.rb
 - spec/studio_webhook_event_verifier_spec.rb