onfido 3.4.0 → 4.0.0

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.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.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'
@@ -283,8 +284,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 +299,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/workflow_run_spec.rb

@@ -9,7 +9,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 +24,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
 

data/spec/shared_contexts/with_check.rb

@@ -10,6 +10,7 @@ RSpec.shared_context 'with check', shared_context: :metadata do
       applicant_id: applicant_id,
       document_ids: [document_id],
       report_names: [Onfido::ReportName::DOCUMENT, Onfido::ReportName::IDENTITY_ENHANCED],
+      privacy_notices_read_consent_given: true
     })
   end
 

data/spec/shared_contexts/with_document.rb

@@ -8,6 +8,6 @@ RSpec.shared_context 'with document', shared_context: :metadata do
   let(:document_file_name) { 'sample_driving_licence.png' }
   let(:document_file) { File.open("spec/integrations/media/#{document_file_name}") }
 
-  let(:document) { onfido_api.upload_document('passport', applicant_id, document_file) }
+  let(:document) { onfido_api.upload_document(Onfido::DocumentTypes::PASSPORT, applicant_id, document_file) }
   let!(:document_id) { document.id }
 end

data/spec/studio_webhook_event_verifier_spec.rb

@@ -0,0 +1,39 @@
+require 'onfido/webhook_event_verifier'
+require 'spec_helper'
+
+describe Onfido::WebhookEventVerifier do
+  subject { described_class.new('YKOC6mkBxi6yK2zlUIrLMvsJMFEZObP5') }
+  describe "#read_payload" do
+    let(:event_body) { '{"payload":{"resource_type":"workflow_task","action":"workflow_task.started","object":{"id":"profile_1eb92","task_spec_id":"profile_1eb92","task_def_id":"profile_data","workflow_run_id":"bc77c6e5-753a-4580-96a6-aaed3e5a8d19","status":"started","started_at_iso8601":"2024-07-10T12:49:09Z","href":"https://api.eu.onfido.com/v3.6/workflow_runs/bc77c6e5-753a-4580-96a6-aaed3e5a8d19/tasks/profile_1eb92"},"resource":{"created_at":"2024-07-10T12:49:09Z","id":"profile_1eb92","workflow_run_id":"bc77c6e5-753a-4580-96a6-aaed3e5a8d19","updated_at":"2024-07-10T12:49:09Z","input":{},"task_def_version":null,"task_def_id":"profile_data","output":null}}}' }
+    let(:sig) { "c95a5b785484f6fa1bc25f381b5595d66bf85cb442eefb06aa007802ee6a4dfa" }
+    it "raises an exception when the signature is invalid" do
+      expect do
+        subject.read_payload(event_body, "c95a5b785484f6fa1bc25f381b5595d66bf85cb442eefb06aa007802ee6a4dfb")
+      end.to raise_error(Onfido::OnfidoInvalidSignatureError, "Invalid signature for webhook event")
+    end
+
+    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(Onfido::WebhookEventResourceType::WORKFLOW_TASK)
+      expect(webhook_event.payload.action).to eq(Onfido::WebhookEventType::WORKFLOW_TASK_STARTED)
+
+      expect(webhook_event.payload.object.id).to eq('profile_1eb92')
+      expect(webhook_event.payload.object.status).to eq(Onfido::WebhookEventObjectStatus::STARTED)
+      expect(webhook_event.payload.object.started_at_iso8601).to eq(Time.parse('2024-07-10T12:49:09Z'))
+      expect(webhook_event.payload.object.href).to eq('https://api.eu.onfido.com/v3.6/workflow_runs/bc77c6e5-753a-4580-96a6-aaed3e5a8d19/tasks/profile_1eb92')
+
+      expect(webhook_event.payload.resource.created_at).to eq(Time.parse('2024-07-10T12:49:09Z'))
+      expect(webhook_event.payload.resource.id).to eq('profile_1eb92')
+      expect(webhook_event.payload.resource.workflow_run_id).to eq('bc77c6e5-753a-4580-96a6-aaed3e5a8d19')
+      expect(webhook_event.payload.resource.updated_at).to eq(Time.parse('2024-07-10T12:49:09Z'))
+      expect(webhook_event.payload.resource.input).to eq({})
+      expect(webhook_event.payload.resource.task_def_version).to eq(nil)
+      expect(webhook_event.payload.resource.task_def_id).to eq('profile_data')
+      expect(webhook_event.payload.resource.output).to eq(nil)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onfido
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 4.0.0
 platform: ruby
 authors:
 - OpenAPI-Generator
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-20 00:00:00.000000000 Z
+date: 2024-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -130,6 +130,7 @@ files:
 - CHANGELOG.md
 - Gemfile
 - LICENSE
+- MIGRATION.md
 - README.md
 - Rakefile
 - lib/onfido.rb
@@ -143,6 +144,8 @@ files:
 - lib/onfido/models/addresses_list.rb
 - lib/onfido/models/applicant.rb
 - lib/onfido/models/applicant_builder.rb
+- lib/onfido/models/applicant_consent_builder.rb
+- lib/onfido/models/applicant_consent_name.rb
 - lib/onfido/models/applicant_create.rb
 - lib/onfido/models/applicant_request.rb
 - lib/onfido/models/applicant_response.rb
@@ -155,11 +158,10 @@ files:
 - lib/onfido/models/check_request.rb
 - lib/onfido/models/check_response.rb
 - lib/onfido/models/check_shared.rb
+- lib/onfido/models/check_status.rb
 - lib/onfido/models/checks_list.rb
 - lib/onfido/models/complete_task_builder.rb
 - lib/onfido/models/complete_task_data_builder.rb
-- lib/onfido/models/consent_item.rb
-- lib/onfido/models/consents_builder.rb
 - lib/onfido/models/country_codes.rb
 - lib/onfido/models/device_intelligence_breakdown.rb
 - lib/onfido/models/device_intelligence_breakdown_breakdown.rb
@@ -403,8 +405,11 @@ files:
 - lib/onfido/models/webhook_builder.rb
 - lib/onfido/models/webhook_create.rb
 - lib/onfido/models/webhook_event.rb
+- lib/onfido/models/webhook_event_object_status.rb
 - lib/onfido/models/webhook_event_payload.rb
 - lib/onfido/models/webhook_event_payload_object.rb
+- lib/onfido/models/webhook_event_payload_resource.rb
+- lib/onfido/models/webhook_event_resource_type.rb
 - lib/onfido/models/webhook_event_type.rb
 - lib/onfido/models/webhook_resend.rb
 - lib/onfido/models/webhook_response.rb
@@ -415,14 +420,16 @@ files:
 - lib/onfido/models/webhooks_resend_item.rb
 - lib/onfido/models/workflow_run.rb
 - lib/onfido/models/workflow_run_builder.rb
+- lib/onfido/models/workflow_run_error.rb
+- lib/onfido/models/workflow_run_link.rb
 - lib/onfido/models/workflow_run_request.rb
 - lib/onfido/models/workflow_run_response.rb
-- lib/onfido/models/workflow_run_response_error.rb
 - lib/onfido/models/workflow_run_shared.rb
-- lib/onfido/models/workflow_run_shared_link.rb
+- lib/onfido/models/workflow_run_status.rb
 - lib/onfido/version.rb
 - lib/onfido/webhook_event_verifier.rb
 - onfido.gemspec
+- spec/classic_webhook_event_verifier_spec.rb
 - spec/integrations/address_picker_spec.rb
 - spec/integrations/applicant_spec.rb
 - spec/integrations/check_spec.rb
@@ -450,7 +457,7 @@ files:
 - spec/shared_contexts/with_onfido.rb
 - spec/shared_contexts/with_workflow_run.rb
 - spec/spec_helper.rb
-- spec/webhook_event_verifier_spec.rb
+- spec/studio_webhook_event_verifier_spec.rb
 homepage: https://github.com/onfido/onfido-ruby
 licenses:
 - MIT
@@ -475,31 +482,32 @@ signing_key:
 specification_version: 4
 summary: The official Ruby library for integrating with the Onfido API.
 test_files:
-- spec/integrations/document_spec.rb
-- spec/integrations/qualified_electronic_signature_spec.rb
-- spec/integrations/workflow_run_output_spec.rb
-- spec/integrations/check_spec.rb
-- spec/integrations/watchlist_monitor_spec.rb
-- spec/integrations/applicant_spec.rb
-- spec/integrations/media/sample_driving_licence.png
-- spec/integrations/media/sample_photo.png
+- spec/classic_webhook_event_verifier_spec.rb
+- spec/integrations/sdk_token_spec.rb
 - spec/integrations/tasks_spec.rb
-- spec/integrations/live_video_spec.rb
 - spec/integrations/motion_capture_spec.rb
-- spec/integrations/sdk_token_spec.rb
 - spec/integrations/workflow_run_spec.rb
-- spec/integrations/extraction_spec.rb
+- spec/integrations/check_spec.rb
+- spec/integrations/live_video_spec.rb
+- spec/integrations/webhook_spec.rb
+- spec/integrations/workflow_run_output_spec.rb
+- spec/integrations/applicant_spec.rb
 - spec/integrations/address_picker_spec.rb
+- spec/integrations/watchlist_monitor_spec.rb
 - spec/integrations/id_photo_spec.rb
+- spec/integrations/qualified_electronic_signature_spec.rb
 - spec/integrations/report_schema_spec.rb
-- spec/integrations/webhook_spec.rb
 - spec/integrations/live_photo_spec.rb
 - spec/integrations/report_spec.rb
+- spec/integrations/document_spec.rb
+- spec/integrations/media/sample_photo.png
+- spec/integrations/media/sample_driving_licence.png
+- spec/integrations/extraction_spec.rb
+- spec/shared_contexts/with_document.rb
 - spec/shared_contexts/with_check.rb
 - spec/shared_contexts/with_live_photo.rb
-- spec/shared_contexts/with_document.rb
-- spec/shared_contexts/with_onfido.rb
 - spec/shared_contexts/with_workflow_run.rb
 - spec/shared_contexts/with_applicant.rb
+- spec/shared_contexts/with_onfido.rb
 - spec/spec_helper.rb
-- spec/webhook_event_verifier_spec.rb
+- spec/studio_webhook_event_verifier_spec.rb