onfido 5.6.0 → 6.0.0

data/lib/onfido/models/workflow_run_builder.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.11.0
+Generator version: 7.16.0
 
 =end
 
@@ -53,9 +53,14 @@ module Onfido
       }
     end
 
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
     # Returns all the JSON keys this model knows about
     def self.acceptable_attributes
-      attribute_map.values
+      acceptable_attribute_map.values
     end
 
     # Attribute type mapping.
@@ -95,9 +100,10 @@ module Onfido
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Onfido::WorkflowRunBuilder`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Onfido::WorkflowRunBuilder`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -178,6 +184,26 @@ module Onfido
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] applicant_id Value to be assigned
+    def applicant_id=(applicant_id)
+      if applicant_id.nil?
+        fail ArgumentError, 'applicant_id cannot be nil'
+      end
+
+      @applicant_id = applicant_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] workflow_id Value to be assigned
+    def workflow_id=(workflow_id)
+      if workflow_id.nil?
+        fail ArgumentError, 'workflow_id cannot be nil'
+      end
+
+      @workflow_id = workflow_id
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] tags Value to be assigned
     def tags=(tags)

data/lib/onfido/models/workflow_run_error.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.11.0
+Generator version: 7.16.0
 
 =end
 
@@ -29,9 +29,14 @@ module Onfido
       }
     end
 
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
     # Returns all the JSON keys this model knows about
     def self.acceptable_attributes
-      attribute_map.values
+      acceptable_attribute_map.values
     end
 
     # Attribute type mapping.
@@ -56,9 +61,10 @@ module Onfido
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Onfido::WorkflowRunError`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Onfido::WorkflowRunError`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }

data/lib/onfido/models/workflow_run_link.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.11.0
+Generator version: 7.16.0
 
 =end
 
@@ -63,9 +63,14 @@ module Onfido
       }
     end
 
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
     # Returns all the JSON keys this model knows about
     def self.acceptable_attributes
-      attribute_map.values
+      acceptable_attribute_map.values
     end
 
     # Attribute type mapping.
@@ -97,9 +102,10 @@ module Onfido
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Onfido::WorkflowRunLink`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Onfido::WorkflowRunLink`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }

data/lib/onfido/models/workflow_run_request.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.11.0
+Generator version: 7.16.0
 
 =end
 
@@ -25,9 +25,14 @@ module Onfido
       }
     end
 
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
     # Returns all the JSON keys this model knows about
     def self.acceptable_attributes
-      attribute_map.values
+      acceptable_attribute_map.values
     end
 
     # Attribute type mapping.
@@ -51,9 +56,10 @@ module Onfido
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Onfido::WorkflowRunRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Onfido::WorkflowRunRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }

data/lib/onfido/models/workflow_run_response.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.11.0
+Generator version: 7.16.0
 
 =end
 
@@ -75,9 +75,14 @@ module Onfido
       }
     end
 
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
     # Returns all the JSON keys this model knows about
     def self.acceptable_attributes
-      attribute_map.values
+      acceptable_attribute_map.values
     end
 
     # Attribute type mapping.
@@ -109,9 +114,10 @@ module Onfido
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Onfido::WorkflowRunResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Onfido::WorkflowRunResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -173,6 +179,16 @@ module Onfido
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/onfido/models/workflow_run_shared.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.11.0
+Generator version: 7.16.0
 
 =end
 
@@ -49,9 +49,14 @@ module Onfido
       }
     end
 
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
     # Returns all the JSON keys this model knows about
     def self.acceptable_attributes
-      attribute_map.values
+      acceptable_attribute_map.values
     end
 
     # Attribute type mapping.
@@ -82,9 +87,10 @@ module Onfido
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Onfido::WorkflowRunShared`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Onfido::WorkflowRunShared`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -159,6 +165,26 @@ module Onfido
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] applicant_id Value to be assigned
+    def applicant_id=(applicant_id)
+      if applicant_id.nil?
+        fail ArgumentError, 'applicant_id cannot be nil'
+      end
+
+      @applicant_id = applicant_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] workflow_id Value to be assigned
+    def workflow_id=(workflow_id)
+      if workflow_id.nil?
+        fail ArgumentError, 'workflow_id cannot be nil'
+      end
+
+      @workflow_id = workflow_id
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] tags Value to be assigned
     def tags=(tags)

data/lib/onfido/models/workflow_run_status.rb

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

data/lib/onfido/version.rb

@@ -6,10 +6,10 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.11.0
+Generator version: 7.16.0
 
 =end
 
 module Onfido
-  VERSION = '5.6.0'
+  VERSION = '6.0.0'
 end

data/lib/onfido.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.11.0
+Generator version: 7.16.0
 
 =end
 
@@ -44,14 +44,12 @@ require 'onfido/models/complete_task_builder'
 require 'onfido/models/complete_task_data_builder'
 require 'onfido/models/country_codes'
 require 'onfido/models/device_intelligence_breakdown'
-require 'onfido/models/device_intelligence_breakdown_breakdown'
 require 'onfido/models/device_intelligence_breakdown_device'
 require 'onfido/models/device_intelligence_breakdown_device_breakdown'
-require 'onfido/models/device_intelligence_breakdown_properties'
-require 'onfido/models/device_intelligence_breakdown_properties_device'
-require 'onfido/models/device_intelligence_breakdown_properties_geolocation'
-require 'onfido/models/device_intelligence_breakdown_properties_ip'
 require 'onfido/models/device_intelligence_properties'
+require 'onfido/models/device_intelligence_properties_device'
+require 'onfido/models/device_intelligence_properties_geolocation'
+require 'onfido/models/device_intelligence_properties_ip'
 require 'onfido/models/device_intelligence_report'
 require 'onfido/models/document'
 require 'onfido/models/document_breakdown'
@@ -100,6 +98,7 @@ require 'onfido/models/document_properties_document_numbers_inner'
 require 'onfido/models/document_properties_driving_licence_information_item'
 require 'onfido/models/document_properties_extracted_data'
 require 'onfido/models/document_properties_nfc'
+require 'onfido/models/document_properties_with_driving_licence_information'
 require 'onfido/models/document_report'
 require 'onfido/models/document_report_shared'
 require 'onfido/models/document_response'
@@ -218,6 +217,9 @@ require 'onfido/models/location_builder'
 require 'onfido/models/location_shared'
 require 'onfido/models/motion_capture'
 require 'onfido/models/motion_captures_list'
+require 'onfido/models/passkey'
+require 'onfido/models/passkey_updater'
+require 'onfido/models/passkeys_list'
 require 'onfido/models/photo_auto_reasons'
 require 'onfido/models/photo_reasons'
 require 'onfido/models/proof_of_address_breakdown'
@@ -246,6 +248,10 @@ require 'onfido/models/sdk_token'
 require 'onfido/models/sdk_token_builder'
 require 'onfido/models/sdk_token_request'
 require 'onfido/models/sdk_token_response'
+require 'onfido/models/signing_document'
+require 'onfido/models/signing_document_response'
+require 'onfido/models/signing_document_shared'
+require 'onfido/models/signing_documents_list'
 require 'onfido/models/task'
 require 'onfido/models/task_item'
 require 'onfido/models/timeline_file_reference'
@@ -299,6 +305,7 @@ require 'onfido/models/webhook_event_object_status'
 require 'onfido/models/webhook_event_payload'
 require 'onfido/models/webhook_event_payload_object'
 require 'onfido/models/webhook_event_payload_resource'
+require 'onfido/models/webhook_event_resource_status'
 require 'onfido/models/webhook_event_resource_type'
 require 'onfido/models/webhook_event_type'
 require 'onfido/models/webhook_resend'

data/onfido.gemspec

@@ -8,7 +8,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.11.0
+Generator version: 7.16.0
 
 =end
 

data/spec/integrations/media/sample_signing_document.pdf

@@ -0,0 +1,33 @@
+%PDF-1.4
+%����
+1 0 obj
+<< /Type /Catalog /Pages 2 0 R >>
+endobj
+2 0 obj
+<< /Type /Pages /Count 1 /Kids [3 0 R] >>
+endobj
+3 0 obj
+<< /Type /Page /Parent 2 0 R /MediaBox [0 0 612 792] /Contents 4 0 R /Resources << /Font << /F1 5 0 R >> >> >>
+endobj
+4 0 obj
+<< /Length 2612 >>
+stream
+BT /F1 12 Tf 72 700 Td (Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. Signing document integration test fixture. ) Tj ET
+endstream
+endobj
+5 0 obj
+<< /Type /Font /Subtype /Type1 /BaseFont /Helvetica >>
+endobj
+xref
+0 6
+0000000000 65535 f 
+0000000015 00000 n 
+0000000064 00000 n 
+0000000121 00000 n 
+0000000247 00000 n 
+0000002910 00000 n 
+trailer
+<< /Size 6 /Root 1 0 R >>
+startxref
+2980
+%%EOF

data/spec/integrations/passkey_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+require_relative '../shared_contexts/with_onfido'
+
+describe Onfido::Passkey do
+  describe 'Passkeys' do
+    include_context 'with onfido'
+
+    let(:username) { ENV.fetch('ONFIDO_SAMPLE_PASSKEY_USERNAME', 'sample-username') }
+    let(:sample_passkey_id) { ENV.fetch('ONFIDO_SAMPLE_PASSKEY_ID', '00000000-0000-0000-0000-000000000000') }
+
+    it 'lists passkeys' do
+      passkeys = onfido_api.list_passkeys(username)
+
+      expect(passkeys).to be_an_instance_of(Onfido::PasskeysList)
+      expect(passkeys.passkeys.size).to be > 0
+
+      sample_passkey = passkeys.passkeys.find { |passkey| passkey.id == sample_passkey_id } || passkeys.passkeys.first
+
+      expect(sample_passkey).to be_an_instance_of(Onfido::Passkey)
+      expect(sample_passkey.application_domain).not_to be_nil
+      expect(sample_passkey.state).not_to be_nil
+      expect(sample_passkey.created_at).not_to be_nil
+      expect(sample_passkey.to_hash).not_to be_nil
+    end
+
+    it 'finds a passkey' do
+      passkey = onfido_api.find_passkey(username, sample_passkey_id)
+
+      expect(passkey).to be_an_instance_of(Onfido::Passkey)
+      expect(passkey.id).to eq(sample_passkey_id)
+      expect(passkey.application_domain).not_to be_nil
+      expect(passkey.state).not_to be_nil
+      expect(passkey.created_at).not_to be_nil
+      expect(passkey.to_hash).not_to be_nil
+    end
+
+    it 'updates a passkey state' do
+      updated_passkey = onfido_api.update_passkey(
+        username,
+        sample_passkey_id,
+        Onfido::PasskeyUpdater.new(state: 'INACTIVE'),
+      )
+
+      expect(updated_passkey).to be_an_instance_of(Onfido::Passkey)
+      expect(updated_passkey.id).to eq(sample_passkey_id)
+      expect(updated_passkey.state).to eq('INACTIVE')
+    end
+
+    it 'deletes a passkey successfully' do
+      _, status_code, = onfido_api.delete_passkey_with_http_info(username, sample_passkey_id)
+
+      expect(status_code).to eq(204)
+    end
+
+    it 'deletes passkeys successfully' do
+      _, status_code, = onfido_api.delete_passkeys_with_http_info(username)
+
+      expect(status_code).to eq(204)
+    end
+  end
+end

data/spec/integrations/signing_document_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative '../shared_contexts/with_signing_document'
+require_relative '../shared_examples/file_examples'
+
+describe Onfido::SigningDocument do
+  describe 'Signing Documents' do
+    include_context 'with signing document'
+
+    it 'uploads a signing document' do
+      expect(signing_document).not_to be_nil
+      expect(signing_document.id).not_to be_empty
+      expect(signing_document.file_name).to eq('sample_signing_document.pdf')
+      expect(signing_document.file_type).to eq('pdf')
+      expect(signing_document.applicant_id).to eq(applicant_id)
+      expect(signing_document.href).not_to be_nil
+      expect(signing_document.download_href).not_to be_nil
+      expect(signing_document.file_size).to be > 0
+      expect(signing_document.to_hash).not_to be_nil
+    end
+
+    describe 'downloading a signing document' do
+      let(:file) { onfido_api.download_signing_document(signing_document_id) }
+
+      it_behaves_like "a valid PDF file"
+    end
+
+    it 'finds a signing document' do
+      found_document = onfido_api.find_signing_document(signing_document_id)
+
+      expect(found_document).to be_an_instance_of(Onfido::SigningDocument)
+      expect(found_document.id).to eq signing_document_id
+      expect(found_document.file_name).to eq('sample_signing_document.pdf')
+      expect(found_document.file_type).to eq('pdf')
+      expect(found_document.applicant_id).to eq(applicant_id)
+      expect(found_document.download_href).not_to be_nil
+      expect(found_document.to_hash).not_to be_nil
+    end
+
+    it 'lists signing documents' do
+      documents = onfido_api.list_signing_documents(applicant_id)
+
+      expect(documents).to be_an_instance_of(Onfido::SigningDocumentsList)
+      expect(documents.signing_documents.map(&:id)).to include(signing_document_id)
+    end
+
+    it 'cannot upload a signing document without required parameters' do
+      expect {
+        onfido_api.upload_signing_document(nil, nil)
+      }.to raise_error(ArgumentError)
+    end
+
+    it 'cannot download an inexistent signing document' do
+      expect {
+        onfido_api.download_signing_document(inexistent_signing_document_id)
+      }.to raise_error(Onfido::ApiError) { |e|
+        expect(e.code).to eq(404)
+      }
+    end
+  end
+end

data/spec/integrations/workflow_run_spec.rb

@@ -50,7 +50,11 @@ describe Onfido::WorkflowRun do
     end
 
     describe 'downloading evidence file' do
-      let(:file) { onfido_api.download_signed_evidence_file(workflow_run_id) }
+      let(:file) do
+        repeat_request_until_http_code_changes(15, 2) do
+          onfido_api.download_signed_evidence_file(workflow_run_id)
+        end
+      end
 
       it_behaves_like "a valid PDF file", 497605
     end
@@ -76,7 +80,7 @@ describe Onfido::WorkflowRun do
         end
 
         timeline_file_id = onfido_api.create_timeline_file(workflow_run_id).workflow_timeline_file_id
-        file = repeat_request_unti_http_code_changes do
+        file = repeat_request_until_http_code_changes do
           onfido_api.find_timeline_file(workflow_run_id, timeline_file_id)
         end
 
@@ -84,7 +88,7 @@ describe Onfido::WorkflowRun do
       end
 
       it 'downloads an evidence folder' do
-        file = repeat_request_unti_http_code_changes do
+        file = repeat_request_until_http_code_changes(15, 2) do
           onfido_api.download_evidence_folder(workflow_run_id)
         end
 

data/spec/shared_contexts/with_signing_document.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../shared_contexts/with_applicant'
+
+RSpec.shared_context 'with signing document', shared_context: :metadata do
+  include_context 'with applicant'
+
+  let(:signing_document_file_name) { 'sample_signing_document.pdf' }
+  let(:signing_document_file) { File.open("spec/integrations/media/#{signing_document_file_name}") }
+
+  let(:signing_document) { onfido_api.upload_signing_document(applicant_id, signing_document_file) }
+  let!(:signing_document_id) { signing_document.id }
+
+  let(:inexistent_signing_document_id) { '00000000-0000-0000-0000-000000000000' }
+end

data/spec/spec_helper.rb

@@ -106,7 +106,7 @@ def repeat_request_until_task_output_changes(max_retries = 15,
   instance
 end
 
-def repeat_request_unti_http_code_changes(max_retries = 15,
+def repeat_request_until_http_code_changes(max_retries = 15,
   interval = 1, &proc)
   # max_retries        --> how many times to retry the request
   # interval           --> how many seconds to wait until the next retry