onfido 3.4.0 → 4.6.0

data/lib/onfido/models/{workflow_run_shared_link.rb → 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.6.0
+Generator version: 7.9.0
 
 =end
 
@@ -14,8 +14,7 @@ require 'date'
 require 'time'
 
 module Onfido
-  # Object for the configuration of the Workflow Run link.
-  class WorkflowRunSharedLink
+  class WorkflowRunLink
     # Link to access the Workflow Run without the need to integrate with Onfido's SDKs.
     attr_accessor :url
 
@@ -83,6 +82,10 @@ module Onfido
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'completed_redirect_url',
+        :'expired_redirect_url',
+        :'expires_at',
+        :'language'
       ])
     end
 
@@ -90,13 +93,13 @@ module Onfido
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `Onfido::WorkflowRunSharedLink` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Onfido::WorkflowRunLink` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       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::WorkflowRunSharedLink`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          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
         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.6.0
+Generator version: 7.9.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.6.0
+Generator version: 7.9.0
 
 =end
 
@@ -33,6 +33,7 @@ module Onfido
     # The reasons the Workflow Run outcome was reached. Configurable when creating the Workflow version.
     attr_accessor :reasons
 
+    # Error object. Only set when the Workflow Run status is 'error'.
     attr_accessor :error
 
     # Client token to use when loading this workflow run in the Onfido SDK.
@@ -85,10 +86,10 @@ module Onfido
         :'id' => :'String',
         :'workflow_version_id' => :'Integer',
         :'dashboard_url' => :'String',
-        :'status' => :'String',
+        :'status' => :'WorkflowRunStatus',
         :'output' => :'Object',
         :'reasons' => :'Array<String>',
-        :'error' => :'WorkflowRunResponseError',
+        :'error' => :'WorkflowRunError',
         :'sdk_token' => :'String'
       }
     end
@@ -169,21 +170,9 @@ module Onfido
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @id.nil?
-      status_validator = EnumAttributeValidator.new('String', ["awaiting_input", "processing", "abandoned", "error", "approved", "review", "declined", "unknown_default_open_api"])
-      return false unless status_validator.valid?(@status)
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] status Object to be assigned
-    def status=(status)
-      validator = EnumAttributeValidator.new('String', ["awaiting_input", "processing", "abandoned", "error", "approved", "review", "declined", "unknown_default_open_api"])
-      unless validator.valid?(status)
-        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
-      end
-      @status = status
-    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.6.0
+Generator version: 7.9.0
 
 =end
 
@@ -27,6 +27,7 @@ module Onfido
     # Customer-provided user identifier.
     attr_accessor :customer_user_id
 
+    # Object for the configuration of the Workflow Run link.
     attr_accessor :link
 
     # The date and time when the Workflow Run was created.
@@ -60,7 +61,7 @@ module Onfido
         :'workflow_id' => :'String',
         :'tags' => :'Array<String>',
         :'customer_user_id' => :'String',
-        :'link' => :'WorkflowRunSharedLink',
+        :'link' => :'WorkflowRunLink',
         :'created_at' => :'Time',
         :'updated_at' => :'Time'
       }

data/lib/onfido/models/workflow_run_status.rb

@@ -0,0 +1,47 @@
+=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.9.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Onfido
+  class WorkflowRunStatus
+    PROCESSING = "processing".freeze
+    AWAITING_INPUT = "awaiting_input".freeze
+    AWAITING_CLIENT_INPUT = "awaiting_client_input".freeze
+    APPROVED = "approved".freeze
+    DECLINED = "declined".freeze
+    REVIEW = "review".freeze
+    ABANDONED = "abandoned".freeze
+    ERROR = "error".freeze
+    UNKNOWN_DEFAULT_OPEN_API = "unknown_default_open_api".freeze
+
+    def self.all_vars
+      @all_vars ||= [PROCESSING, AWAITING_INPUT, AWAITING_CLIENT_INPUT, APPROVED, DECLINED, REVIEW, ABANDONED, ERROR, UNKNOWN_DEFAULT_OPEN_API].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if WorkflowRunStatus.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #WorkflowRunStatus"
+    end
+  end
+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.6.0
+Generator version: 7.9.0
 
 =end
 
 module Onfido
-  VERSION = '3.4.0'
+  VERSION = '4.6.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.6.0
+Generator version: 7.9.0
 
 =end
 
@@ -23,6 +23,8 @@ require 'onfido/models/address_shared'
 require 'onfido/models/addresses_list'
 require 'onfido/models/applicant'
 require 'onfido/models/applicant_builder'
+require 'onfido/models/applicant_consent_builder'
+require 'onfido/models/applicant_consent_name'
 require 'onfido/models/applicant_create'
 require 'onfido/models/applicant_request'
 require 'onfido/models/applicant_response'
@@ -35,11 +37,10 @@ require 'onfido/models/check_builder'
 require 'onfido/models/check_request'
 require 'onfido/models/check_response'
 require 'onfido/models/check_shared'
+require 'onfido/models/check_status'
 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'
@@ -150,6 +151,8 @@ 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_report_media'
+require 'onfido/models/facial_similarity_report_shared'
 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'
@@ -283,8 +286,11 @@ require 'onfido/models/webhook'
 require 'onfido/models/webhook_builder'
 require 'onfido/models/webhook_create'
 require 'onfido/models/webhook_event'
+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_type'
 require 'onfido/models/webhook_event_type'
 require 'onfido/models/webhook_resend'
 require 'onfido/models/webhook_response'
@@ -295,11 +301,12 @@ 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_error'
+require 'onfido/models/workflow_run_link'
 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'
+require 'onfido/models/workflow_run_status'
 
 # APIs
 require 'onfido/api/default_api'

data/onfido.gemspec

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

data/spec/{webhook_event_verifier_spec.rb → classic_webhook_event_verifier_spec.rb}

@@ -15,13 +15,13 @@ describe Onfido::WebhookEventVerifier do
     it "returns the decoded event payload" do
       expected_payload = JSON.parse(event_body)["payload"]
       expected_webhook_event = Onfido::WebhookEvent.new({ payload: Onfido::WebhookEventPayload.build_from_hash(expected_payload) })
-      
+
       webhook_event = subject.read_payload(event_body, sig)
       expect(webhook_event.payload).to eq(expected_webhook_event.payload)
-      expect(webhook_event.payload.resource_type).to eq('check')
-      expect(webhook_event.payload.action).to eq('check.completed')
+      expect(webhook_event.payload.resource_type).to eq(Onfido::WebhookEventResourceType::CHECK)
+      expect(webhook_event.payload.action).to eq(Onfido::WebhookEventType::CHECK_COMPLETED)
       expect(webhook_event.payload.object.id).to eq('f2302f45-227d-413d-ad61-09ec077a086a')
-      expect(webhook_event.payload.object.status).to eq('complete')
+      expect(webhook_event.payload.object.status).to eq(Onfido::WebhookEventObjectStatus::COMPLETE)
       expect(webhook_event.payload.object.completed_at_iso8601).to eq(Time.parse('2024-04-04T09:21:21Z'))
       expect(webhook_event.payload.object.href).to eq('https://api.onfido.com/v3.6/checks/f2302f45-227d-413d-ad61-09ec077a086a')
     end

data/spec/integrations/applicant_spec.rb

@@ -27,7 +27,11 @@ describe Onfido::Applicant do
         'location' => {
           'ip_address' => '127.0.0.1',
           'country_of_residence' => 'GBR'
-        }
+        },
+        'consents' => [{
+          'name' => Onfido::ApplicantConsentName::PRIVACY_NOTICES_READ,
+          'granted' => true
+        }]
       }
 
       applicant = onfido_api.create_applicant(params)

data/spec/integrations/check_spec.rb

@@ -11,7 +11,7 @@ describe Onfido::Check do
       expect(check).to be_an_instance_of Onfido::Check
       expect(check.applicant_id).to eq applicant_id
       expect(check.report_ids.size).to eq 2
-      expect(check.status).to eq 'in_progress'
+      expect(check.status).to eq Onfido::CheckStatus::IN_PROGRESS
     end
 
     context 'consider check' do
@@ -47,7 +47,7 @@ describe Onfido::Check do
           us_driving_licence: us_driving_licence_builder,
         })
       end
-    
+
       it 'creates a driving licence check' do
         expect(check).not_to be_nil
         expect(check).to be_an_instance_of Onfido::Check
@@ -65,9 +65,9 @@ describe Onfido::Check do
 
     it 'finds a check' do
       get_check = onfido_api.find_check(check_id)
-      
+
       expect(get_check).to be_an_instance_of(Onfido::Check)
-      expect(get_check.id).to eq check_id      
+      expect(get_check.id).to eq check_id
     end
 
     it 'restarts a check' do

data/spec/integrations/document_spec.rb

@@ -35,7 +35,7 @@ describe Onfido::Document do
 
     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|

data/spec/integrations/qualified_electronic_signature_spec.rb

@@ -27,7 +27,7 @@ describe Onfido::WorkflowRun do
   let!(:workflow_run_id) { workflow_run.id }
 
   let(:file_id) do
-    task = onfido_api.list_tasks(workflow_run_id)[0]
+    task = onfido_api.list_tasks(workflow_run_id)[1]
 
     output = repeat_request_until_task_output_changes(
       max_retries = 10,

data/spec/integrations/report_schema_spec.rb

@@ -41,5 +41,22 @@ describe Onfido::Report do
 
       expect(facial_similarity_report).to be_an_instance_of Onfido::FacialSimilarityPhotoReport
     end
+
+    it 'schema of Document With Address 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_ADDRESS_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::DocumentWithAddressInformationReport
+      expect(report.properties.barcode[0]).to be_an_instance_of Onfido::DocumentPropertiesBarcodeInner
+      expect(report.properties.barcode[0].document_type).to eq("driving_licence")
+    end
   end
 end

data/spec/integrations/report_spec.rb

@@ -23,13 +23,15 @@ describe Onfido::Report do
     end
 
     it 'finds a report' do
-      get_document_report = onfido_api.find_report(document_report_id)
+      get_document_report = repeat_request_until_status_changes(Onfido::ReportStatus::COMPLETE) {
+        onfido_api.find_report(document_report_id)
+      }
       get_identity_report = onfido_api.find_report(identity_report_id)
 
       expect(get_document_report).to be_an_instance_of Onfido::DocumentReport
       expect(get_document_report.id).to eq document_report_id
       expect(get_document_report.name).to eq Onfido::ReportName::DOCUMENT
-      expect(get_document_report.status).to eq Onfido::ReportStatus::AWAITING_DATA
+      expect(get_document_report.status).to eq Onfido::ReportStatus::COMPLETE
 
       expect(get_identity_report).to be_an_instance_of Onfido::IdentityEnhancedReport
       expect(get_identity_report.id).to eq identity_report_id

data/spec/integrations/workflow_run_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../shared_contexts/with_workflow_run'
+require 'zip'
 
 describe Onfido::WorkflowRun do
   describe 'Workflow run' do
@@ -9,7 +10,7 @@ describe Onfido::WorkflowRun do
     it 'creates a workflow run' do
       expect(workflow_run).to be_an_instance_of Onfido::WorkflowRun
       expect(workflow_run.applicant_id).to eq applicant_id
-      expect(workflow_run.status).to eq 'awaiting_input'
+      expect(workflow_run.status).to eq Onfido::WorkflowRunStatus::AWAITING_INPUT
     end
 
     context 'workflow run with custom inputs' do
@@ -24,11 +25,11 @@ describe Onfido::WorkflowRun do
           }
         })
       end
-      
+
       it 'creates a workflow run with custom inputs' do
         expect(workflow_run).to be_an_instance_of Onfido::WorkflowRun
         expect(workflow_run.workflow_id).to eq workflow_id
-        expect(workflow_run.status).to eq 'approved'
+        expect(workflow_run.status).to eq Onfido::WorkflowRunStatus::APPROVED
       end
     end
 
@@ -79,6 +80,16 @@ describe Onfido::WorkflowRun do
 
         expect(file.size).to be > 0
       end
+
+      it 'downloads an evidence folder' do
+        file = repeat_request_unti_http_code_changes do
+          onfido_api.download_evidence_folder(workflow_run_id)
+        end
+
+        Zip::File.open(file.path) do |zip|
+          expect(zip.entries.size).to be > 0
+        end
+      end
     end
   end
 end

data/spec/media/studio_webhook_event_with_list_in_output.json

@@ -0,0 +1,31 @@
+{
+  "payload": {
+    "resource_type": "workflow_task",
+    "action": "workflow_task.completed",
+    "object": {
+      "id": "document_photo_5c229",
+      "task_spec_id": "document_photo_5c229",
+      "task_def_id": "upload_document_photo",
+      "workflow_run_id": "b48fdff9-66a1-405d-9912-54780799bd68",
+      "status": "completed",
+      "completed_at_iso8601": "2024-12-18T18:13:10Z",
+      "href": "https://api.eu.onfido.com/v3.6/workflow_runs/b48fdff9-66a1-405d-9912-54780799bd68/tasks/document_photo_5c229"
+    },
+    "resource": {
+      "updated_at": "2024-12-18T18:13:10Z",
+      "output": [
+        {
+          "type": "document_photo",
+          "id": "7af75a3a-ba34-4aa5-9e3e-096c9f56256b",
+          "checksum_sha256": "hiwV2PLmeQZzeySPGGwVL48sxVXcyfpXy9LDl1u3lWU="
+        }
+      ],
+      "created_at": "2024-12-18T18:12:44Z",
+      "task_def_id": "upload_document_photo",
+      "input": {},
+      "workflow_run_id": "b48fdff9-66a1-405d-9912-54780799bd68",
+      "task_def_version": null,
+      "id": "document_photo_5c229"
+    }
+  }
+}