onfido 4.6.0 → 5.1.0

data/lib/onfido/models/webhook_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
 
@@ -27,13 +27,33 @@ module Onfido
     # Webhook version used to control the payload object when sending webhooks.
     attr_accessor :payload_version
 
+    # Determines if the webhook will fetch OAuth access tokens to send in the Authorization header.
+    attr_accessor :oauth_enabled
+
+    # The url to fetch the OAuth access token using client credentials grant.
+    attr_accessor :oauth_server_url
+
+    # The client id to authenticate the client credentials grant.
+    attr_accessor :oauth_server_client_id
+
+    # The client secret to authenticate the client credentials grant.
+    attr_accessor :oauth_server_client_secret
+
+    # The scopes to be sent when requesting the access token.
+    attr_accessor :oauth_server_scope
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'enabled' => :'enabled',
         :'events' => :'events',
         :'environments' => :'environments',
-        :'payload_version' => :'payload_version'
+        :'payload_version' => :'payload_version',
+        :'oauth_enabled' => :'oauth_enabled',
+        :'oauth_server_url' => :'oauth_server_url',
+        :'oauth_server_client_id' => :'oauth_server_client_id',
+        :'oauth_server_client_secret' => :'oauth_server_client_secret',
+        :'oauth_server_scope' => :'oauth_server_scope'
       }
     end
 
@@ -48,7 +68,12 @@ module Onfido
         :'enabled' => :'Boolean',
         :'events' => :'Array<WebhookEventType>',
         :'environments' => :'Array<String>',
-        :'payload_version' => :'Integer'
+        :'payload_version' => :'Integer',
+        :'oauth_enabled' => :'Boolean',
+        :'oauth_server_url' => :'String',
+        :'oauth_server_client_id' => :'String',
+        :'oauth_server_client_secret' => :'String',
+        :'oauth_server_scope' => :'String'
       }
     end
 
@@ -92,6 +117,26 @@ module Onfido
       if attributes.key?(:'payload_version')
         self.payload_version = attributes[:'payload_version']
       end
+
+      if attributes.key?(:'oauth_enabled')
+        self.oauth_enabled = attributes[:'oauth_enabled']
+      end
+
+      if attributes.key?(:'oauth_server_url')
+        self.oauth_server_url = attributes[:'oauth_server_url']
+      end
+
+      if attributes.key?(:'oauth_server_client_id')
+        self.oauth_server_client_id = attributes[:'oauth_server_client_id']
+      end
+
+      if attributes.key?(:'oauth_server_client_secret')
+        self.oauth_server_client_secret = attributes[:'oauth_server_client_secret']
+      end
+
+      if attributes.key?(:'oauth_server_scope')
+        self.oauth_server_scope = attributes[:'oauth_server_scope']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -117,7 +162,12 @@ module Onfido
           enabled == o.enabled &&
           events == o.events &&
           environments == o.environments &&
-          payload_version == o.payload_version
+          payload_version == o.payload_version &&
+          oauth_enabled == o.oauth_enabled &&
+          oauth_server_url == o.oauth_server_url &&
+          oauth_server_client_id == o.oauth_server_client_id &&
+          oauth_server_client_secret == o.oauth_server_client_secret &&
+          oauth_server_scope == o.oauth_server_scope
     end
 
     # @see the `==` method
@@ -129,7 +179,7 @@ module Onfido
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [enabled, events, environments, payload_version].hash
+      [enabled, events, environments, payload_version, oauth_enabled, oauth_server_url, oauth_server_client_id, oauth_server_client_secret, oauth_server_scope].hash
     end
 
     # Builds the object from hash

data/lib/onfido/models/webhook_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/webhook_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
 
@@ -27,6 +27,21 @@ module Onfido
     # Webhook version used to control the payload object when sending webhooks.
     attr_accessor :payload_version
 
+    # Determines if the webhook will fetch OAuth access tokens to send in the Authorization header.
+    attr_accessor :oauth_enabled
+
+    # The url to fetch the OAuth access token using client credentials grant.
+    attr_accessor :oauth_server_url
+
+    # The client id to authenticate the client credentials grant.
+    attr_accessor :oauth_server_client_id
+
+    # The client secret to authenticate the client credentials grant.
+    attr_accessor :oauth_server_client_secret
+
+    # The scopes to be sent when requesting the access token.
+    attr_accessor :oauth_server_scope
+
     # The url that will listen to notifications (must be https).
     attr_accessor :url
 
@@ -37,6 +52,11 @@ module Onfido
         :'events' => :'events',
         :'environments' => :'environments',
         :'payload_version' => :'payload_version',
+        :'oauth_enabled' => :'oauth_enabled',
+        :'oauth_server_url' => :'oauth_server_url',
+        :'oauth_server_client_id' => :'oauth_server_client_id',
+        :'oauth_server_client_secret' => :'oauth_server_client_secret',
+        :'oauth_server_scope' => :'oauth_server_scope',
         :'url' => :'url'
       }
     end
@@ -53,6 +73,11 @@ module Onfido
         :'events' => :'Array<WebhookEventType>',
         :'environments' => :'Array<String>',
         :'payload_version' => :'Integer',
+        :'oauth_enabled' => :'Boolean',
+        :'oauth_server_url' => :'String',
+        :'oauth_server_client_id' => :'String',
+        :'oauth_server_client_secret' => :'String',
+        :'oauth_server_scope' => :'String',
         :'url' => :'String'
       }
     end
@@ -106,6 +131,26 @@ module Onfido
         self.payload_version = attributes[:'payload_version']
       end
 
+      if attributes.key?(:'oauth_enabled')
+        self.oauth_enabled = attributes[:'oauth_enabled']
+      end
+
+      if attributes.key?(:'oauth_server_url')
+        self.oauth_server_url = attributes[:'oauth_server_url']
+      end
+
+      if attributes.key?(:'oauth_server_client_id')
+        self.oauth_server_client_id = attributes[:'oauth_server_client_id']
+      end
+
+      if attributes.key?(:'oauth_server_client_secret')
+        self.oauth_server_client_secret = attributes[:'oauth_server_client_secret']
+      end
+
+      if attributes.key?(:'oauth_server_scope')
+        self.oauth_server_scope = attributes[:'oauth_server_scope']
+      end
+
       if attributes.key?(:'url')
         self.url = attributes[:'url']
       end
@@ -135,6 +180,11 @@ module Onfido
           events == o.events &&
           environments == o.environments &&
           payload_version == o.payload_version &&
+          oauth_enabled == o.oauth_enabled &&
+          oauth_server_url == o.oauth_server_url &&
+          oauth_server_client_id == o.oauth_server_client_id &&
+          oauth_server_client_secret == o.oauth_server_client_secret &&
+          oauth_server_scope == o.oauth_server_scope &&
           url == o.url
     end
 
@@ -147,7 +197,7 @@ module Onfido
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [enabled, events, environments, payload_version, url].hash
+      [enabled, events, environments, payload_version, oauth_enabled, oauth_server_url, oauth_server_client_id, oauth_server_client_secret, oauth_server_scope, url].hash
     end
 
     # Builds the object from hash

data/lib/onfido/models/webhooks_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/webhooks_resend_item.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/workflow_run.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/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.9.0
+Generator version: 7.11.0
 
 =end
 

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.9.0
+Generator version: 7.11.0
 
 =end
 

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.9.0
+Generator version: 7.11.0
 
 =end
 

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.9.0
+Generator version: 7.11.0
 
 =end
 

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.9.0
+Generator version: 7.11.0
 
 =end
 

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.9.0
+Generator version: 7.11.0
 
 =end
 

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.9.0
+Generator version: 7.11.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.9.0
+Generator version: 7.11.0
 
 =end
 
 module Onfido
-  VERSION = '4.6.0'
+  VERSION = '5.1.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.9.0
+Generator version: 7.11.0
 
 =end
 
@@ -23,6 +23,7 @@ require 'onfido/models/address_shared'
 require 'onfido/models/addresses_list'
 require 'onfido/models/applicant'
 require 'onfido/models/applicant_builder'
+require 'onfido/models/applicant_consent'
 require 'onfido/models/applicant_consent_builder'
 require 'onfido/models/applicant_consent_name'
 require 'onfido/models/applicant_create'
@@ -44,12 +45,13 @@ 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_breakdown_device'
-require 'onfido/models/device_intelligence_breakdown_breakdown_device_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_report'
 require 'onfido/models/document'
 require 'onfido/models/document_breakdown'
@@ -95,10 +97,11 @@ require 'onfido/models/document_properties_address_lines'
 require 'onfido/models/document_properties_barcode_inner'
 require 'onfido/models/document_properties_document_classification'
 require 'onfido/models/document_properties_document_numbers_inner'
-require 'onfido/models/document_properties_driving_licence_information'
+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_report'
+require 'onfido/models/document_report_shared'
 require 'onfido/models/document_response'
 require 'onfido/models/document_shared'
 require 'onfido/models/document_types'

data/onfido.gemspec

@@ -8,7 +8,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/spec/integrations/applicant_spec.rb

@@ -80,6 +80,34 @@ describe Onfido::Applicant do
       expect(updated_applicant.dob).to eq Date.parse('1968-04-08')
     end
 
+    it 'lists applicant consents' do
+      new_applicant_data = Onfido::ApplicantUpdater.new(
+        'consents' => [{
+                         'name' => Onfido::ApplicantConsentName::PRIVACY_NOTICES_READ,
+                         'granted' => true
+                       },
+                       {
+                         'name' => Onfido::ApplicantConsentName::SSN_VERIFICATION,
+                         'granted' => true
+                       },
+                       {
+                         'name' => Onfido::ApplicantConsentName::PHONE_NUMBER_VERIFICATION,
+                         'granted' => true
+                       }]
+      )
+      onfido_api.update_applicant(applicant_id, new_applicant_data)
+
+      expected_consents = [
+        have_attributes(name: "phone_number_verification", granted: true),
+        have_attributes(name: "privacy_notices_read", granted: true),
+        have_attributes(name: "ssn_verification", granted: true)
+      ]
+
+      consents = onfido_api.find_applicant_consents(applicant_id)
+      expect(consents).to contain_exactly(*expected_consents)
+
+    end
+
     it 'deletes an applicant' do
       onfido_api.delete_applicant(applicant_id)
 

data/spec/integrations/document_spec.rb

@@ -34,13 +34,25 @@ describe Onfido::Document do
     end
 
     it 'cannot download an inexistent document' do
-      inexistent_document_id = '00000000-0000-0000-0000-000000000000'
-
       expect {
         onfido_api.download_document(inexistent_document_id)
       }.to raise_error(Onfido::ApiError) { |e|
         expect(e.code).to eq(404)
       }
     end
+
+    it 'downloads an NFC face' do
+      file = onfido_api.download_nfc_face(nfc_face_id)
+
+      expect(file.size).to be > 0
+    end
+
+    it 'cannot download an inexistent NFC face' do
+      expect {
+        onfido_api.download_nfc_face(inexistent_document_id)
+      }.to raise_error(Onfido::ApiError) { |e|
+        expect(e.code).to eq(404)
+      }
+    end
   end
 end

data/spec/integrations/report_schema_spec.rb

@@ -58,5 +58,38 @@ describe Onfido::Report do
       expect(report.properties.barcode[0]).to be_an_instance_of Onfido::DocumentPropertiesBarcodeInner
       expect(report.properties.barcode[0].document_type).to eq("driving_licence")
     end
+
+    it 'schema of Document With Driving Lincence Information report is valid' do
+      report_id = onfido_api.create_check(
+        Onfido::CheckBuilder.new(
+          applicant_id: applicant_id,
+          document_ids: [document_id],
+          report_names: [Onfido::ReportName::DOCUMENT_WITH_DRIVING_LICENCE_INFORMATION],
+      )).report_ids[0]
+
+      report = repeat_request_until_status_changes(
+        Onfido::ReportStatus::COMPLETE
+      ) { onfido_api.find_report(report_id) }
+
+      expect(report).to be_an_instance_of Onfido::DocumentWithDrivingLicenceInformationReport
+      expect(report.properties.driving_licence_information).not_to be_nil
+    end
+
+    it 'schema of Device Intelligence report is valid' do
+      report_id = onfido_api.create_check(
+        Onfido::CheckBuilder.new(
+          applicant_id: applicant_id,
+          document_ids: [document_id],
+          report_names: [Onfido::ReportName::DEVICE_INTELLIGENCE],
+      )).report_ids[0]
+
+      report = repeat_request_until_status_changes(
+        Onfido::ReportStatus::COMPLETE
+      ) { onfido_api.find_report(report_id) }
+
+      expect(report).to be_an_instance_of Onfido::DeviceIntelligenceReport
+      expect(report.breakdown).not_to be_nil
+      expect(report.properties).not_to be_nil
+    end
   end
 end

data/spec/shared_contexts/with_document.rb

@@ -10,4 +10,8 @@ RSpec.shared_context 'with document', shared_context: :metadata do
 
   let(:document) { onfido_api.upload_document(Onfido::DocumentTypes::PASSPORT, applicant_id, document_file) }
   let!(:document_id) { document.id }
+
+  let(:nfc_face_id) { 'cc2dc25f-2df6-4f8f-a5aa-60f49cef9b3c' }
+
+  let(:inexistent_document_id) { '00000000-0000-0000-0000-000000000000' }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onfido
 version: !ruby/object:Gem::Version
-  version: 4.6.0
+  version: 5.1.0
 platform: ruby
 authors:
 - OpenAPI-Generator
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-24 00:00:00.000000000 Z
+date: 2025-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -144,6 +144,7 @@ files:
 - lib/onfido/models/addresses_list.rb
 - lib/onfido/models/applicant.rb
 - lib/onfido/models/applicant_builder.rb
+- lib/onfido/models/applicant_consent.rb
 - lib/onfido/models/applicant_consent_builder.rb
 - lib/onfido/models/applicant_consent_name.rb
 - lib/onfido/models/applicant_create.rb
@@ -165,12 +166,13 @@ files:
 - lib/onfido/models/country_codes.rb
 - lib/onfido/models/device_intelligence_breakdown.rb
 - lib/onfido/models/device_intelligence_breakdown_breakdown.rb
-- lib/onfido/models/device_intelligence_breakdown_breakdown_device.rb
-- lib/onfido/models/device_intelligence_breakdown_breakdown_device_breakdown.rb
+- lib/onfido/models/device_intelligence_breakdown_device.rb
+- lib/onfido/models/device_intelligence_breakdown_device_breakdown.rb
 - lib/onfido/models/device_intelligence_breakdown_properties.rb
 - lib/onfido/models/device_intelligence_breakdown_properties_device.rb
 - lib/onfido/models/device_intelligence_breakdown_properties_geolocation.rb
 - lib/onfido/models/device_intelligence_breakdown_properties_ip.rb
+- lib/onfido/models/device_intelligence_properties.rb
 - lib/onfido/models/device_intelligence_report.rb
 - lib/onfido/models/document.rb
 - lib/onfido/models/document_breakdown.rb
@@ -216,10 +218,11 @@ files:
 - lib/onfido/models/document_properties_barcode_inner.rb
 - lib/onfido/models/document_properties_document_classification.rb
 - lib/onfido/models/document_properties_document_numbers_inner.rb
-- lib/onfido/models/document_properties_driving_licence_information.rb
+- lib/onfido/models/document_properties_driving_licence_information_item.rb
 - lib/onfido/models/document_properties_extracted_data.rb
 - lib/onfido/models/document_properties_nfc.rb
 - lib/onfido/models/document_report.rb
+- lib/onfido/models/document_report_shared.rb
 - lib/onfido/models/document_response.rb
 - lib/onfido/models/document_shared.rb
 - lib/onfido/models/document_types.rb
@@ -487,33 +490,33 @@ 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/motion_capture_spec.rb
+- spec/integrations/id_photo_spec.rb
+- spec/integrations/check_spec.rb
+- spec/integrations/live_photo_spec.rb
+- spec/integrations/watchlist_monitor_spec.rb
+- spec/integrations/workflow_run_output_spec.rb
+- spec/integrations/media/sample_photo.png
+- spec/integrations/media/sample_driving_licence.png
 - spec/integrations/live_video_spec.rb
 - spec/integrations/document_spec.rb
-- spec/integrations/live_photo_spec.rb
-- spec/integrations/report_schema_spec.rb
-- spec/integrations/qualified_electronic_signature_spec.rb
-- spec/integrations/motion_capture_spec.rb
-- spec/integrations/tasks_spec.rb
-- spec/integrations/workflow_run_spec.rb
 - spec/integrations/webhook_spec.rb
-- spec/integrations/report_spec.rb
+- spec/integrations/applicant_spec.rb
 - spec/integrations/address_picker_spec.rb
-- spec/integrations/check_spec.rb
+- spec/integrations/workflow_run_spec.rb
+- spec/integrations/qualified_electronic_signature_spec.rb
+- spec/integrations/report_schema_spec.rb
 - spec/integrations/sdk_token_spec.rb
+- spec/integrations/tasks_spec.rb
+- spec/integrations/report_spec.rb
 - spec/integrations/extraction_spec.rb
-- spec/integrations/workflow_run_output_spec.rb
-- spec/integrations/applicant_spec.rb
-- spec/integrations/media/sample_photo.png
-- spec/integrations/media/sample_driving_licence.png
-- spec/integrations/id_photo_spec.rb
-- spec/integrations/watchlist_monitor_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_workflow_run.rb
+- spec/media/studio_webhook_event_with_list_in_output.json
 - spec/shared_contexts/with_applicant.rb
-- spec/shared_contexts/with_live_photo.rb
-- spec/shared_contexts/with_document.rb
 - spec/shared_contexts/with_check.rb
+- spec/shared_contexts/with_workflow_run.rb
 - spec/shared_contexts/with_onfido.rb
+- spec/shared_contexts/with_live_photo.rb
+- spec/shared_contexts/with_document.rb
 - spec/spec_helper.rb
 - spec/studio_webhook_event_verifier_spec.rb