onfido 2.9.0 → 3.0.0

data/lib/onfido.rb

@@ -1,31 +1,315 @@
-# frozen_string_literal: true
+=begin
+#Onfido API v3.6
 
-require 'json'
-require 'rack'
-require 'rest-client'
-require 'openssl'
+#The Onfido API (v3.6)
 
+The version of the OpenAPI document: v3.6
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.6.0
+
+=end
+
+# Common files
+require 'onfido/api_client'
+require 'onfido/api_error'
 require 'onfido/version'
-require 'onfido/errors/onfido_error'
-require 'onfido/errors/request_error'
-require 'onfido/errors/server_error'
-require 'onfido/errors/connection_error'
-require 'onfido/api'
-require 'onfido/options'
-require 'onfido/resource'
-require 'onfido/resources/address'
-require 'onfido/resources/applicant'
-require 'onfido/resources/check'
-require 'onfido/resources/document'
-require 'onfido/resources/extraction'
-require 'onfido/resources/live_photo'
-require 'onfido/resources/live_video'
-require 'onfido/resources/monitor'
-require 'onfido/resources/motion_capture'
-require 'onfido/resources/report'
-require 'onfido/resources/sdk_token'
-require 'onfido/resources/webhook'
-require 'onfido/resources/workflow_run'
+require 'onfido/configuration'
+
+# Models
+require 'onfido/models/address'
+require 'onfido/models/address_builder'
+require 'onfido/models/address_shared'
+require 'onfido/models/addresses_list'
+require 'onfido/models/applicant'
+require 'onfido/models/applicant_builder'
+require 'onfido/models/applicant_create'
+require 'onfido/models/applicant_request'
+require 'onfido/models/applicant_response'
+require 'onfido/models/applicant_shared'
+require 'onfido/models/applicant_update'
+require 'onfido/models/applicant_updater'
+require 'onfido/models/applicants_list'
+require 'onfido/models/check'
+require 'onfido/models/check_builder'
+require 'onfido/models/check_request'
+require 'onfido/models/check_response'
+require 'onfido/models/check_shared'
+require 'onfido/models/checks_list'
+require 'onfido/models/complete_task_builder'
+require 'onfido/models/complete_task_data_builder'
+require 'onfido/models/consent_item'
+require 'onfido/models/consents_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_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_report'
+require 'onfido/models/document'
+require 'onfido/models/document_breakdown'
+require 'onfido/models/document_breakdown_age_validation'
+require 'onfido/models/document_breakdown_age_validation_breakdown'
+require 'onfido/models/document_breakdown_compromised_document'
+require 'onfido/models/document_breakdown_compromised_document_breakdown'
+require 'onfido/models/document_breakdown_data_comparison'
+require 'onfido/models/document_breakdown_data_comparison_breakdown'
+require 'onfido/models/document_breakdown_data_comparison_breakdown_issuing_country'
+require 'onfido/models/document_breakdown_data_consistency'
+require 'onfido/models/document_breakdown_data_consistency_breakdown'
+require 'onfido/models/document_breakdown_data_validation'
+require 'onfido/models/document_breakdown_data_validation_breakdown'
+require 'onfido/models/document_breakdown_data_validation_breakdown_document_expiration'
+require 'onfido/models/document_breakdown_data_validation_breakdown_expiry_date'
+require 'onfido/models/document_breakdown_image_integrity'
+require 'onfido/models/document_breakdown_image_integrity_breakdown'
+require 'onfido/models/document_breakdown_image_integrity_breakdown_colour_picture'
+require 'onfido/models/document_breakdown_image_integrity_breakdown_conclusive_document_quality'
+require 'onfido/models/document_breakdown_image_integrity_breakdown_image_quality'
+require 'onfido/models/document_breakdown_image_integrity_breakdown_supported_document'
+require 'onfido/models/document_breakdown_issuing_authority'
+require 'onfido/models/document_breakdown_issuing_authority_breakdown'
+require 'onfido/models/document_breakdown_issuing_authority_breakdown_nfc_active_authentication'
+require 'onfido/models/document_breakdown_issuing_authority_breakdown_nfc_passive_authentication'
+require 'onfido/models/document_breakdown_police_record'
+require 'onfido/models/document_breakdown_visual_authenticity'
+require 'onfido/models/document_breakdown_visual_authenticity_breakdown'
+require 'onfido/models/document_breakdown_visual_authenticity_breakdown_digital_tampering'
+require 'onfido/models/document_breakdown_visual_authenticity_breakdown_face_detection'
+require 'onfido/models/document_breakdown_visual_authenticity_breakdown_fonts'
+require 'onfido/models/document_breakdown_visual_authenticity_breakdown_original_document_present'
+require 'onfido/models/document_breakdown_visual_authenticity_breakdown_other'
+require 'onfido/models/document_breakdown_visual_authenticity_breakdown_picture_face_integrity'
+require 'onfido/models/document_breakdown_visual_authenticity_breakdown_security_features'
+require 'onfido/models/document_breakdown_visual_authenticity_breakdown_template'
+require 'onfido/models/document_cdq_reasons'
+require 'onfido/models/document_iq_reasons'
+require 'onfido/models/document_odp_reasons'
+require 'onfido/models/document_properties'
+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_extracted_data'
+require 'onfido/models/document_properties_nfc'
+require 'onfido/models/document_report'
+require 'onfido/models/document_response'
+require 'onfido/models/document_shared'
+require 'onfido/models/document_types'
+require 'onfido/models/document_video_report'
+require 'onfido/models/document_video_with_address_information_report'
+require 'onfido/models/document_with_address_information_report'
+require 'onfido/models/document_with_driver_verification_report'
+require 'onfido/models/document_with_driver_verification_report_all_of_properties'
+require 'onfido/models/document_with_driver_verification_report_all_of_properties_all_of_passenger_vehicle'
+require 'onfido/models/document_with_driver_verification_report_all_of_properties_all_of_vehicle_class_details_inner'
+require 'onfido/models/document_with_driving_licence_information_report'
+require 'onfido/models/documents_list'
+require 'onfido/models/error'
+require 'onfido/models/error1'
+require 'onfido/models/error_properties'
+require 'onfido/models/error_properties1'
+require 'onfido/models/extract_request'
+require 'onfido/models/extraction'
+require 'onfido/models/extraction_document_classification'
+require 'onfido/models/extraction_extracted_data'
+require 'onfido/models/facial_similarity_motion_breakdown'
+require 'onfido/models/facial_similarity_motion_breakdown_face_comparison'
+require 'onfido/models/facial_similarity_motion_breakdown_image_integrity'
+require 'onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown'
+require 'onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown_face_detected'
+require 'onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown_source_integrity'
+require 'onfido/models/facial_similarity_motion_breakdown_visual_authenticity'
+require 'onfido/models/facial_similarity_motion_breakdown_visual_authenticity_breakdown'
+require 'onfido/models/facial_similarity_motion_breakdown_visual_authenticity_breakdown_spoofing_detection'
+require 'onfido/models/facial_similarity_motion_properties'
+require 'onfido/models/facial_similarity_motion_report'
+require 'onfido/models/facial_similarity_photo_breakdown'
+require 'onfido/models/facial_similarity_photo_breakdown_face_comparison'
+require 'onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown'
+require 'onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown_face_match'
+require 'onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown_face_match_properties'
+require 'onfido/models/facial_similarity_photo_breakdown_image_integrity'
+require 'onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown'
+require 'onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown_face_detected'
+require 'onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown_source_integrity'
+require 'onfido/models/facial_similarity_photo_breakdown_visual_authenticity'
+require 'onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown'
+require 'onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown_spoofing_detection'
+require 'onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown_spoofing_detection_properties'
+require 'onfido/models/facial_similarity_photo_fully_auto_breakdown'
+require 'onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity'
+require 'onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity_breakdown'
+require 'onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity_breakdown_source_integrity'
+require 'onfido/models/facial_similarity_photo_fully_auto_properties'
+require 'onfido/models/facial_similarity_photo_fully_auto_report'
+require 'onfido/models/facial_similarity_photo_properties'
+require 'onfido/models/facial_similarity_photo_report'
+require 'onfido/models/facial_similarity_video_breakdown'
+require 'onfido/models/facial_similarity_video_breakdown_face_comparison'
+require 'onfido/models/facial_similarity_video_breakdown_image_integrity'
+require 'onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown'
+require 'onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown_face_detected'
+require 'onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown_source_integrity'
+require 'onfido/models/facial_similarity_video_breakdown_visual_authenticity'
+require 'onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown'
+require 'onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown_liveness_detected'
+require 'onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown_spoofing_detection'
+require 'onfido/models/facial_similarity_video_properties'
+require 'onfido/models/facial_similarity_video_report'
+require 'onfido/models/id_number'
+require 'onfido/models/id_photo'
+require 'onfido/models/id_photo_response'
+require 'onfido/models/id_photos_list'
+require 'onfido/models/identity_enhanced_breakdown'
+require 'onfido/models/identity_enhanced_breakdown_address'
+require 'onfido/models/identity_enhanced_breakdown_address_breakdown'
+require 'onfido/models/identity_enhanced_breakdown_address_breakdown_credit_agencies'
+require 'onfido/models/identity_enhanced_breakdown_address_breakdown_credit_agencies_properties'
+require 'onfido/models/identity_enhanced_breakdown_address_breakdown_telephone_database'
+require 'onfido/models/identity_enhanced_breakdown_address_breakdown_voting_register'
+require 'onfido/models/identity_enhanced_breakdown_date_of_birth'
+require 'onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown'
+require 'onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown_credit_agencies'
+require 'onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown_voting_register'
+require 'onfido/models/identity_enhanced_breakdown_mortality'
+require 'onfido/models/identity_enhanced_breakdown_sources'
+require 'onfido/models/identity_enhanced_breakdown_sources_breakdown'
+require 'onfido/models/identity_enhanced_breakdown_sources_breakdown_total_sources'
+require 'onfido/models/identity_enhanced_breakdown_sources_breakdown_total_sources_properties'
+require 'onfido/models/identity_enhanced_properties'
+require 'onfido/models/identity_enhanced_properties_matched_addresses_inner'
+require 'onfido/models/identity_enhanced_report'
+require 'onfido/models/india_pan_report'
+require 'onfido/models/india_pan_report_all_of_breakdown'
+require 'onfido/models/india_pan_report_all_of_breakdown_device'
+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/known_faces_breakdown'
+require 'onfido/models/known_faces_breakdown_image_integrity'
+require 'onfido/models/known_faces_breakdown_previously_seen_faces'
+require 'onfido/models/known_faces_properties'
+require 'onfido/models/known_faces_properties_matches_inner'
+require 'onfido/models/known_faces_report'
+require 'onfido/models/live_photo'
+require 'onfido/models/live_photo_response'
+require 'onfido/models/live_photos_list'
+require 'onfido/models/live_video'
+require 'onfido/models/live_videos_list'
+require 'onfido/models/location'
+require 'onfido/models/location_builder'
+require 'onfido/models/location_shared'
+require 'onfido/models/motion_capture'
+require 'onfido/models/motion_captures_list'
+require 'onfido/models/photo_auto_reasons'
+require 'onfido/models/photo_reasons'
+require 'onfido/models/proof_of_address_breakdown'
+require 'onfido/models/proof_of_address_breakdown_data_comparison'
+require 'onfido/models/proof_of_address_breakdown_data_comparison_breakdown'
+require 'onfido/models/proof_of_address_breakdown_document_classification'
+require 'onfido/models/proof_of_address_breakdown_document_classification_breakdown'
+require 'onfido/models/proof_of_address_breakdown_image_integrity'
+require 'onfido/models/proof_of_address_breakdown_image_integrity_breakdown'
+require 'onfido/models/proof_of_address_properties'
+require 'onfido/models/proof_of_address_report'
+require 'onfido/models/repeat_attempts_list'
+require 'onfido/models/repeat_attempts_list_repeat_attempts_inner'
+require 'onfido/models/report'
+require 'onfido/models/report_document'
+require 'onfido/models/report_name'
+require 'onfido/models/report_result'
+require 'onfido/models/report_shared'
+require 'onfido/models/report_status'
+require 'onfido/models/report_sub_result'
+require 'onfido/models/reports_list'
+require 'onfido/models/results_feedback'
+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/task'
+require 'onfido/models/task_item'
+require 'onfido/models/timeline_file_reference'
+require 'onfido/models/us_driving_licence_breakdown'
+require 'onfido/models/us_driving_licence_breakdown_address'
+require 'onfido/models/us_driving_licence_breakdown_address_breakdown'
+require 'onfido/models/us_driving_licence_breakdown_document'
+require 'onfido/models/us_driving_licence_breakdown_document_breakdown'
+require 'onfido/models/us_driving_licence_breakdown_personal'
+require 'onfido/models/us_driving_licence_breakdown_personal_breakdown'
+require 'onfido/models/us_driving_licence_builder'
+require 'onfido/models/us_driving_licence_report'
+require 'onfido/models/us_driving_licence_shared'
+require 'onfido/models/video_reasons'
+require 'onfido/models/watchlist_aml_breakdown'
+require 'onfido/models/watchlist_aml_breakdown_adverse_media'
+require 'onfido/models/watchlist_aml_breakdown_legal_and_regulatory_warnings'
+require 'onfido/models/watchlist_aml_breakdown_politically_exposed_person'
+require 'onfido/models/watchlist_aml_breakdown_sanction'
+require 'onfido/models/watchlist_aml_properties'
+require 'onfido/models/watchlist_aml_report'
+require 'onfido/models/watchlist_enhanced_breakdown'
+require 'onfido/models/watchlist_enhanced_properties'
+require 'onfido/models/watchlist_enhanced_report'
+require 'onfido/models/watchlist_monitor'
+require 'onfido/models/watchlist_monitor_builder'
+require 'onfido/models/watchlist_monitor_match'
+require 'onfido/models/watchlist_monitor_matches_list'
+require 'onfido/models/watchlist_monitor_matches_updater'
+require 'onfido/models/watchlist_monitor_response'
+require 'onfido/models/watchlist_monitor_shared'
+require 'onfido/models/watchlist_monitors_list'
+require 'onfido/models/watchlist_peps_only_report'
+require 'onfido/models/watchlist_sanctions_only_report'
+require 'onfido/models/watchlist_standard_breakdown'
+require 'onfido/models/watchlist_standard_properties'
+require 'onfido/models/watchlist_standard_report'
+require 'onfido/models/webhook'
+require 'onfido/models/webhook_builder'
+require 'onfido/models/webhook_create'
+require 'onfido/models/webhook_event'
+require 'onfido/models/webhook_event_payload'
+require 'onfido/models/webhook_event_payload_object'
+require 'onfido/models/webhook_event_type'
+require 'onfido/models/webhook_resend'
+require 'onfido/models/webhook_response'
+require 'onfido/models/webhook_shared'
+require 'onfido/models/webhook_update'
+require 'onfido/models/webhook_updater'
+require 'onfido/models/webhooks_list'
+require 'onfido/models/webhooks_resend_item'
+require 'onfido/models/workflow_run'
+require 'onfido/models/workflow_run_builder'
+require 'onfido/models/workflow_run_request'
+require 'onfido/models/workflow_run_response'
+require 'onfido/models/workflow_run_response_error'
+require 'onfido/models/workflow_run_shared'
+require 'onfido/models/workflow_run_shared_link'
+
+# APIs
+require 'onfido/api/default_api'
 
 module Onfido
+  class << self
+    # Customize default settings for the SDK using block.
+    #   Onfido.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
 end

data/onfido.gemspec

@@ -1,34 +1,43 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'onfido/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'onfido'
-  spec.version       = Onfido::VERSION
-  spec.authors       = ['Onfido']
-  spec.email         = ['engineering@onfido.com']
-  spec.summary       = 'A wrapper for Onfido API'
-  spec.description   = "A thin wrapper for Onfido's API. This gem only supports "\
-                       "v3 of the Onfido API. Refer to Onfido's "\
-                       'API documentation for details of the expected '\
-                       'requests and responses.'
-  spec.homepage      = 'http://github.com/onfido/onfido-ruby'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.4.0'
-
-  spec.add_development_dependency 'rspec', '~> 3.1'
-  spec.add_development_dependency 'rspec-its', '~> 1.2'
-  spec.add_development_dependency 'rubocop', '~> 1.11'
-  spec.add_development_dependency 'sinatra', '~> 1.4'
-  spec.add_development_dependency 'webmock', '~> 3.0'
-
-  spec.add_dependency 'rack', '>= 1.6.0'
-  spec.add_dependency 'rest-client', '~> 2.0'
+# -*- encoding: utf-8 -*-
+
+=begin
+#Onfido API v3.6
+
+#The Onfido API (v3.6)
+
+The version of the OpenAPI document: v3.6
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.6.0
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "onfido/version"
+
+Gem::Specification.new do |s|
+  s.name        = "onfido"
+  s.version     = Onfido::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["OpenAPI-Generator"]
+  s.email       = [""]
+  s.homepage    = "https://github.com/onfido/onfido-ruby"
+  s.summary     = "The official Ruby library for integrating with the Onfido API."
+  s.description = "Ruby Library for the Onfido API"
+  s.license     = "MIT"
+  s.required_ruby_version = ">= 2.7"
+  s.metadata    = {}
+
+  s.add_runtime_dependency 'faraday', '>= 1.0.1', '< 3.0'
+  s.add_runtime_dependency 'faraday-multipart'
+  s.add_runtime_dependency 'marcel'
+  s.add_runtime_dependency 'openssl'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'rspec-its', '~> 1.2'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
 end

data/spec/integrations/address_picker_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative '../shared_contexts/with_onfido'
+
+describe Onfido::Address do
+  describe 'Address picker' do
+    include_context 'with onfido'
+
+    it 'finds an address based on post code' do
+      post_code = 'S2 2DF'
+      addresses_with_post_code = onfido_api.find_addresses(post_code).addresses
+
+      expect(addresses_with_post_code[0].postcode).to eq post_code
+    end
+  end
+end

data/spec/integrations/applicant_spec.rb

@@ -1,116 +1,94 @@
 # frozen_string_literal: true
 
-describe Onfido::Applicant do
-  include_context 'fake onfido api'
-
-  subject(:applicant) { onfido.applicant }
-
-  let(:applicant_id) { '61f659cb-c90b-4067-808a-6136b5c01351' }
-  let(:params) do
-    {
-      'title' => 'Mr',
-      'first_name' => 'Chandler',
-      'last_name' => 'Bing',
-      'middle_name' => 'Muriel',
-      'dob' => '1968-04-08',
-      'email' => 'chandler_bing_6@friends.com',
-      'address' => {
-        'flat_number' => '4',
-        'building_number' => '100',
-        'building_name' => 'Awesome Building',
-        'street' => 'Main Street',
-        'sub_street' => 'A sub street',
-        'town' => 'London',
-        'postcode' => 'SW4 6EH',
-        'country' => 'GBR'
-      },
-      'location' => {
-        'ip_address' => '127.0.0.1',
-        'country_of_residence' => 'GBR'
-      },
-      'phone_number' => '910100100'
-    }
-  end
-
-  describe '#create' do
-    # Need to find a better way of testing that the request is not malformed.
-    # Currently this runs for every feature spec. The fact that it's under here
-    # is only for semantic reasons
+require_relative '../shared_contexts/with_applicant'
 
-    it 'serializes the payload correctly' do
-      WebMock.after_request do |request_signature, _response|
-        if request_signature.uri.path == 'v3.6/applicants'
-          expect(Rack::Utils.parse_nested_query(request_signature.body))
-            .to eq(params)
-        end
-      end
-    end
+describe Onfido::Applicant do
+  describe 'Applicants' do
+    include_context 'with applicant'
 
     it 'creates an applicant' do
-      response = applicant.create(params)
-      expect(response['id']).not_to be_nil
+      params = {
+        'title' => 'Mr',
+        'first_name' => 'Chandler',
+        'last_name' => 'Bing',
+        'middle_name' => 'Muriel',
+        'dob' => '1968-04-08',
+        'email' => 'chandler_bing_6@friends.com',
+        'address' => {
+          'flat_number' => '4',
+          'building_number' => '100',
+          'building_name' => 'Awesome Building',
+          'street' => 'Main Street',
+          'sub_street' => 'A sub street',
+          'town' => 'London',
+          'postcode' => 'SW4 6EH',
+          'country' => 'GBR'
+        },
+        'location' => {
+          'ip_address' => '127.0.0.1',
+          'country_of_residence' => 'GBR'
+        }
+      }
+
+      applicant = onfido_api.create_applicant(params)
+      expect(applicant.id).not_to be_nil
+      expect(applicant.first_name).to eq 'Chandler'
+      expect(applicant.last_name).to eq 'Bing'
+      expect(applicant.email).to eq 'chandler_bing_6@friends.com'
+      expect(applicant.dob).to eq Date.parse('1968-04-08')
+      expect(applicant.address.flat_number).to eq '4'
+      expect(applicant.address.building_number).to eq '100'
+      expect(applicant.address.building_name).to eq 'Awesome Building'
+      expect(applicant.address.street).to eq 'Main Street'
+      expect(applicant.address.sub_street).to eq 'A sub street'
+      expect(applicant.address.town).to eq 'London'
+      expect(applicant.address.postcode).to eq 'SW4 6EH'
+      expect(applicant.address.country).to eq 'GBR'
+      expect(applicant.location.ip_address).to eq '127.0.0.1'
+      expect(applicant.location.country_of_residence).to eq 'GBR'
     end
-  end
 
-  describe '#update' do
-    it 'updates an applicant' do
-      response = applicant.update(applicant_id, params)
+    it 'lists applicants' do
+      list_of_applicants = onfido_api.list_applicants()
 
-      expect(response['id']).to eq(applicant_id)
+      expect(list_of_applicants).to be_an_instance_of Onfido::ApplicantsList
+      expect(list_of_applicants.applicants.size).to be > 0
     end
-  end
 
-  describe '#find' do
-    it 'returns the applicant' do
-      response = applicant.find(applicant_id)
+    it 'finds an applicant' do
+      applicant = onfido_api.find_applicant(applicant_id)
 
-      expect(response['id']).to eq(applicant_id)
+      expect(applicant).to be_an_instance_of Onfido::Applicant
+      expect(applicant.id).to eq applicant_id
+      expect(applicant.first_name).to eq 'Test'
+      expect(applicant.last_name).to eq 'Applicant'
     end
-  end
-
-  describe '#destroy' do
-    it 'returns success code' do
-      expect { applicant.destroy(applicant_id) }.not_to raise_error
-    end
-  end
-
-  describe '#all' do
-    context 'with the default page and per page params' do
-      it 'returns all the applicants' do
-        response = applicant.all
 
-        expect(response['applicants'].size).to eq(2)
-      end
+    it 'updates an applicant' do
+      new_applicant_data = Onfido::ApplicantUpdater.new(
+        first_name: 'Jane',
+        last_name: 'Doe',
+        dob: '1968-04-08'
+      )
+      updated_applicant = onfido_api.update_applicant(applicant_id, new_applicant_data)
+      expect(updated_applicant.first_name).to eq 'Jane'
+      expect(updated_applicant.last_name).to eq 'Doe'
+      expect(updated_applicant.dob).to eq Date.parse('1968-04-08')
     end
 
-    context 'with specific range of results for a page' do
-      it 'returns the specified applicants' do
-        response = applicant.all(page: 1, per_page: 1)
+    it 'deletes an applicant' do
+      onfido_api.delete_applicant(applicant_id)
 
-        expect(response['applicants'].size).to eq(1)
-      end
+      expect {
+        onfido_api.find_applicant(applicant_id)
+      }.to raise_error(Onfido::ApiError) { |e|
+        expect(e.code).to eq(410)
+      }
     end
-  end
-
-  describe '#restore' do
-    context 'an applicant scheduled for deletion' do
-      it 'returns nil' do
-        expect(applicant.restore(applicant_id)).to be_nil
-      end
-    end
-
-    context 'an applicant not scheduled for deletion' do
-      it 'returns an error' do
-        applicant_id = 'a2fb9c62-ab10-4898-a8ec-342c4b552ad5'
 
-        expect { applicant.restore(applicant_id) }.to raise_error do |error|
-          expect(error).to be_a(Onfido::RequestError)
-          expect(error.message).to eq('There was a validation error on this request')
-          expect(error.fields).to eq(
-            'Applicant a2fb9c62-ab10-4898-a8ec-342c4b552ad5 is not scheduled for deletion'
-          )
-        end
-      end
+    it 'restores an applicant' do
+      onfido_api.delete_applicant(applicant_id)
+      onfido_api.restore_applicant(applicant_id)
     end
   end
 end