onfido 6.2.0 → 6.3.0

data/lib/onfido/models/webhook_create.rb

@@ -15,12 +15,16 @@ require 'time'
 
 module Onfido
   class WebhookCreate
+    # Name of the webhook.
+    attr_accessor :name
+
     # The url that will listen to notifications (must be https).
     attr_accessor :url
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'name' => :'name',
         :'url' => :'url'
       }
     end
@@ -38,6 +42,7 @@ module Onfido
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'name' => :'String',
         :'url' => :'String'
       }
     end
@@ -64,6 +69,10 @@ module Onfido
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
       if attributes.key?(:'url')
         self.url = attributes[:'url']
       else
@@ -106,6 +115,7 @@ module Onfido
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          name == o.name &&
           url == o.url
     end
 
@@ -118,7 +128,7 @@ module Onfido
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [url].hash
+      [name, url].hash
     end
 
     # Builds the object from hash

data/lib/onfido/models/webhook_response.rb

@@ -18,6 +18,9 @@ module Onfido
     # The unique identifier of the webhook.
     attr_accessor :id
 
+    # Name of the webhook.
+    attr_accessor :name
+
     # The url that will listen to notifications (must be https).
     attr_accessor :url
 
@@ -31,6 +34,7 @@ module Onfido
     def self.attribute_map
       {
         :'id' => :'id',
+        :'name' => :'name',
         :'url' => :'url',
         :'token' => :'token',
         :'href' => :'href'
@@ -51,6 +55,7 @@ module Onfido
     def self.openapi_types
       {
         :'id' => :'String',
+        :'name' => :'String',
         :'url' => :'String',
         :'token' => :'String',
         :'href' => :'String'
@@ -85,6 +90,10 @@ module Onfido
         self.id = nil
       end
 
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
       if attributes.key?(:'url')
         self.url = attributes[:'url']
       end
@@ -134,6 +143,7 @@ module Onfido
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
+          name == o.name &&
           url == o.url &&
           token == o.token &&
           href == o.href
@@ -148,7 +158,7 @@ module Onfido
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, url, token, href].hash
+      [id, name, url, token, href].hash
     end
 
     # Builds the object from hash

data/lib/onfido/models/webhook_update.rb

@@ -15,12 +15,16 @@ require 'time'
 
 module Onfido
   class WebhookUpdate
+    # Name of the webhook.
+    attr_accessor :name
+
     # The url that will listen to notifications (must be https).
     attr_accessor :url
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'name' => :'name',
         :'url' => :'url'
       }
     end
@@ -38,6 +42,7 @@ module Onfido
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'name' => :'String',
         :'url' => :'String'
       }
     end
@@ -64,6 +69,10 @@ module Onfido
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
       if attributes.key?(:'url')
         self.url = attributes[:'url']
       end
@@ -89,6 +98,7 @@ module Onfido
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          name == o.name &&
           url == o.url
     end
 
@@ -101,7 +111,7 @@ module Onfido
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [url].hash
+      [name, url].hash
     end
 
     # Builds the object from hash

data/lib/onfido/models/webhook_updater.rb

@@ -42,6 +42,9 @@ module Onfido
     # The scopes to be sent when requesting the access token.
     attr_accessor :oauth_server_scope
 
+    # Name of the webhook.
+    attr_accessor :name
+
     # The url that will listen to notifications (must be https).
     attr_accessor :url
 
@@ -57,6 +60,7 @@ module Onfido
         :'oauth_server_client_id' => :'oauth_server_client_id',
         :'oauth_server_client_secret' => :'oauth_server_client_secret',
         :'oauth_server_scope' => :'oauth_server_scope',
+        :'name' => :'name',
         :'url' => :'url'
       }
     end
@@ -83,6 +87,7 @@ module Onfido
         :'oauth_server_client_id' => :'String',
         :'oauth_server_client_secret' => :'String',
         :'oauth_server_scope' => :'String',
+        :'name' => :'String',
         :'url' => :'String'
       }
     end
@@ -157,6 +162,10 @@ module Onfido
         self.oauth_server_scope = attributes[:'oauth_server_scope']
       end
 
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
       if attributes.key?(:'url')
         self.url = attributes[:'url']
       end
@@ -191,6 +200,7 @@ module Onfido
           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 &&
+          name == o.name &&
           url == o.url
     end
 
@@ -203,7 +213,7 @@ module Onfido
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [enabled, events, environments, payload_version, oauth_enabled, oauth_server_url, oauth_server_client_id, oauth_server_client_secret, oauth_server_scope, url].hash
+      [enabled, events, environments, payload_version, oauth_enabled, oauth_server_url, oauth_server_client_id, oauth_server_client_secret, oauth_server_scope, name, url].hash
     end
 
     # Builds the object from hash

data/lib/onfido/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.16.0
 =end
 
 module Onfido
-  VERSION = '6.2.0'
+  VERSION = '6.3.0'
 end

data/lib/onfido.rb

@@ -33,6 +33,11 @@ require 'onfido/models/applicant_shared'
 require 'onfido/models/applicant_update'
 require 'onfido/models/applicant_updater'
 require 'onfido/models/applicants_list'
+require 'onfido/models/biometric_token'
+require 'onfido/models/biometric_token_data'
+require 'onfido/models/biometric_token_response'
+require 'onfido/models/biometric_token_updater'
+require 'onfido/models/biometric_tokens_response'
 require 'onfido/models/check'
 require 'onfido/models/check_builder'
 require 'onfido/models/check_request'
@@ -201,6 +206,10 @@ require 'onfido/models/india_pan_report_all_of_breakdown_device_breakdown'
 require 'onfido/models/india_pan_report_all_of_breakdown_device_breakdown_pan_valid'
 require 'onfido/models/india_pan_report_all_of_properties'
 require 'onfido/models/india_pan_report_all_of_properties_device'
+require 'onfido/models/invalidated_biometric_token_response'
+require 'onfido/models/invalidated_biometric_token_summary'
+require 'onfido/models/invalidated_biometric_token_summary_deleted_items'
+require 'onfido/models/invalidated_biometric_tokens_response'
 require 'onfido/models/known_faces_breakdown'
 require 'onfido/models/known_faces_breakdown_image_integrity'
 require 'onfido/models/known_faces_breakdown_previously_seen_faces'
@@ -255,6 +264,7 @@ require 'onfido/models/signing_documents_list'
 require 'onfido/models/task'
 require 'onfido/models/task_item'
 require 'onfido/models/timeline_file_reference'
+require 'onfido/models/updated_biometric_token_response'
 require 'onfido/models/us_driving_licence_breakdown'
 require 'onfido/models/us_driving_licence_breakdown_address'
 require 'onfido/models/us_driving_licence_breakdown_address_breakdown'
@@ -284,6 +294,23 @@ require 'onfido/models/watchlist_enhanced_properties_records_inner_event_inner'
 require 'onfido/models/watchlist_enhanced_properties_records_inner_event_inner_source'
 require 'onfido/models/watchlist_enhanced_properties_records_inner_source_inner'
 require 'onfido/models/watchlist_enhanced_report'
+require 'onfido/models/watchlist_mesh_added_mentions'
+require 'onfido/models/watchlist_mesh_alert_risk'
+require 'onfido/models/watchlist_mesh_alert_risk1'
+require 'onfido/models/watchlist_mesh_associate'
+require 'onfido/models/watchlist_mesh_date_value'
+require 'onfido/models/watchlist_mesh_field'
+require 'onfido/models/watchlist_mesh_image'
+require 'onfido/models/watchlist_mesh_lists'
+require 'onfido/models/watchlist_mesh_media'
+require 'onfido/models/watchlist_mesh_name'
+require 'onfido/models/watchlist_mesh_pep'
+require 'onfido/models/watchlist_mesh_person'
+require 'onfido/models/watchlist_mesh_profile'
+require 'onfido/models/watchlist_mesh_risk_decision'
+require 'onfido/models/watchlist_mesh_risk_detail'
+require 'onfido/models/watchlist_mesh_risk_indicators'
+require 'onfido/models/watchlist_mesh_sanctions'
 require 'onfido/models/watchlist_monitor'
 require 'onfido/models/watchlist_monitor_builder'
 require 'onfido/models/watchlist_monitor_match'

data/spec/integrations/biometric_token_spec.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+require_relative '../shared_contexts/with_onfido'
+
+describe Onfido::BiometricToken do
+  describe 'Biometric tokens' do
+    include_context 'with onfido'
+
+    let(:biometric_workflow_id) { 'b79dcf69-41a0-412d-b803-d1a618730f72' }
+    let(:customer_user_id) { "test-user-id-#{SecureRandom.uuid}" }
+    let(:unique_suffix) { SecureRandom.hex(4) }
+    let(:applicant_builder) do
+      Onfido::ApplicantBuilder.new(
+        first_name: "First#{unique_suffix}",
+        last_name: "Last#{unique_suffix}",
+        email: "first.last.#{unique_suffix}@example.com",
+        consents: [
+          Onfido::ApplicantConsentBuilder.new(
+            name: Onfido::ApplicantConsentName::PRIVACY_NOTICES_READ,
+            granted: true,
+          ),
+        ],
+      )
+    end
+    let(:applicant_id) { onfido_api.create_applicant(applicant_builder).id }
+    let(:live_photo_file) { File.open('spec/integrations/media/sample_photo.png') }
+    let(:live_photo) do
+      onfido_api.upload_live_photo(
+        applicant_id: applicant_id,
+        file: live_photo_file,
+      )
+    end
+    let(:workflow_run_builder) do
+      Onfido::WorkflowRunBuilder.new(
+        applicant_id: applicant_id,
+        workflow_id: biometric_workflow_id,
+        customer_user_id: customer_user_id,
+        custom_data: {
+          media_ids: [
+            {
+              id: live_photo.id,
+            },
+          ],
+        },
+      )
+    end
+    let(:workflow_run) { onfido_api.create_workflow_run(workflow_run_builder) }
+    let(:biometric_tokens) do
+      created_workflow_run = workflow_run
+
+      expect(created_workflow_run.customer_user_id).to eq(customer_user_id)
+
+      repeat_request_until_biometric_tokens_created(customer_user_id)
+    end
+    let(:biometric_token) { biometric_tokens.biometric_tokens.first }
+    let(:biometric_token_id) { biometric_token.uuid }
+
+    def repeat_request_until_biometric_tokens_created(user_id, max_retries = 10, interval = 3)
+      attempts = 0
+
+      loop do
+        response = onfido_api.list_biometric_tokens(user_id)
+        return response if response.biometric_tokens.any?
+
+        raise 'Biometric tokens were not created in time' if attempts >= max_retries
+
+        attempts += 1
+        sleep(interval)
+      end
+    end
+
+    it 'lists biometric tokens' do
+      expect(biometric_tokens).to be_an_instance_of(Onfido::BiometricTokensResponse)
+      expect(biometric_tokens.biometric_tokens.length).to be > 0
+      expect(biometric_token.uuid).not_to be_nil
+      expect(biometric_token.data.status).not_to be_nil
+    end
+
+    it 'finds a biometric token' do
+      biometric_token_response = onfido_api.find_biometric_token(customer_user_id, biometric_token_id)
+
+      expect(biometric_token_response).to be_an_instance_of(Onfido::BiometricTokenResponse)
+      expect(biometric_token_response.biometric_token.uuid).to eq(biometric_token_id)
+      expect(biometric_token_response.biometric_token.data.status).not_to be_nil
+    end
+
+    it 'updates a biometric token status' do
+      approved_status = 'approved'
+
+      updated_biometric_token = onfido_api.update_biometric_token(
+        customer_user_id,
+        biometric_token_id,
+        Onfido::BiometricTokenUpdater.new(status: approved_status),
+      )
+
+      expect(updated_biometric_token).to be_an_instance_of(Onfido::UpdatedBiometricTokenResponse)
+      expect(updated_biometric_token.biometric_token.uuid).to eq(biometric_token_id)
+      expect(updated_biometric_token.biometric_token.data.status).to eq(approved_status)
+    end
+
+    it 'invalidates a biometric token successfully' do
+      invalidated_biometric_token, status_code, = onfido_api.invalidate_biometric_token_with_http_info(
+        customer_user_id,
+        biometric_token_id,
+        debug_return_type: 'Object',
+      )
+
+      expect(invalidated_biometric_token).to be_a(Hash)
+      expect(status_code).to eq(200)
+    end
+
+    it 'invalidates biometric tokens successfully' do
+      invalidated_biometric_tokens, status_code, = onfido_api.invalidate_biometric_tokens_with_http_info(customer_user_id)
+
+      expect(invalidated_biometric_tokens).to be_an_instance_of(Onfido::InvalidatedBiometricTokensResponse)
+      expect(invalidated_biometric_tokens.biometric_tokens.deleted_items.count).to eq(0)
+      expect(status_code).to eq(200)
+    end
+  end
+end

data/spec/integrations/document_spec.rb

@@ -43,7 +43,14 @@ describe Onfido::Document do
     end
 
     describe 'downloading an NFC face' do
-      let(:file) { onfido_api.download_nfc_face(nfc_face_id) }
+      let(:nfc_document) do
+        onfido_api.upload_document(
+          Onfido::DocumentTypes::PASSPORT,
+          applicant_id,
+          File.open('spec/integrations/media/nfc_data.json')
+        )
+      end
+      let(:file) { onfido_api.download_nfc_face(nfc_document.id) }
 
       it_behaves_like "a valid PNG file", 471345
     end