onfido 2.6.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74a5e178fa210205846555dbb0f870b21830bae9a44bbf36bd2f095f4c12bc7e
-  data.tar.gz: 605d4d740f4a73db842ca05592d34d1170e565ccbc5ee2c580a1f131968673fa
+  metadata.gz: 38b8a8f0808cfd6cd4df9d3853705ae0b432136e28d8a0cd8712c353f61a2063
+  data.tar.gz: c205a16862973f2bfe582aae44e58f4aa6d36ebd31647535e7151104b798f8ee
 SHA512:
-  metadata.gz: e31930f8a4e9a856e72753420801ada047f159ae6444648440cde21008270f068ccce793974c5361cd26f538ec51b52ceb2a76ea63af2249629e8d27c056ca8f
-  data.tar.gz: 03dd7a20bb4d1e6fcad6b1f9a3a79c1238bc2e966395f35bb4509ce5987f10eb1d602a2327f19a15bad558be1491d9f3f2137022785909352a5c028f8c9f6e99
+  metadata.gz: 30a055206b8ac359f93f45584edd9a751390f381bc11caabdee05cf5b13f06c71a79388753ec6e680672c274b1fd08604334af75b9c4465cfab651d7e6f36e36
+  data.tar.gz: 5a887ab3f679946ce049ad3b4ba4bf874c31f641d437019df2093fe8f734ebebc29f6cca15b2b730ac47d14480e1ce239107ac5a6ce3fa639a71c8c78494b373

data/.github/workflows/gem-push.yml

@@ -15,9 +15,9 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6.x
+        ruby-version: 2.6
 
     - name: Publish to RubyGems
       run: |

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## v2.8.0, 24 January 2023
+
+- Updated to use API v3.6, for more details please see our [release notes](https://developers.onfido.com/release-notes#api-v36).
+- Add Monitor support
+
+## v2.7.0, 22 November 2022
+
+- Added support for [Workflow Runs](https://documentation.onfido.com/#workflow-runs)
+
 ## v2.6.0, 22 November 2022
 
 - Added support for [Monitors](https://documentation.onfido.com/#monitors)

data/README.md

@@ -7,7 +7,7 @@ The official Ruby library for integrating with the Onfido API.
 
 Documentation can be found at https://documentation.onfido.com
 
-This version uses Onfido API v3.5 and is compatible with Ruby 2.4 onwards. Refer to our [API versioning guide](https://developers.onfido.com/guide/api-versioning-policy#client-libraries) for details of which client library versions use which versions of the API.
+This version uses Onfido API v3.6 and is compatible with Ruby 2.4 onwards. Refer to our [API versioning guide](https://developers.onfido.com/guide/api-versioning-policy#client-libraries) for details of which client library versions use which versions of the API.
 
 ## Installation
 

data/lib/onfido/api.rb

@@ -54,6 +54,10 @@ module Onfido
       @extraction ||= Onfido::Extraction.new(options)
     end
 
+    def workflow_run
+      @workflow_run ||= Onfido::WorkflowRun.new(options)
+    end
+
     private
 
     attr_reader :options

data/lib/onfido/options.rb

@@ -32,7 +32,7 @@ module Onfido
     attr_reader :api_key, :open_timeout, :read_timeout
 
     def base_url
-      @unknown_api_url || "https://api.#{@region}.onfido.com/v3.5/"
+      @unknown_api_url || "https://api.#{@region}.onfido.com/v3.6/"
     end
   end
 end

data/lib/onfido/resource.rb

@@ -29,6 +29,10 @@ module Onfido
       handle_request { rest_client[path].put(payload.to_json, ADDITIONAL_HEADERS) }
     end
 
+    def patch(path:, payload: nil)
+      handle_request { rest_client[path].patch(payload.to_json, ADDITIONAL_HEADERS) }
+    end
+
     def delete(path:)
       handle_request { rest_client[path].delete(ADDITIONAL_HEADERS) }
     end
@@ -141,5 +145,9 @@ module Onfido
       raise ArgumentError, 'File must be a `File`-like object which responds to ' \
                            '`#read` and `#path`'
     end
+
+    def stringify_query_params(hashed_params)
+      URI.encode_www_form_component(hashed_params.map{ |k,v| "#{k}=#{v}" }.join("&"))
+    end
   end
 end

data/lib/onfido/resources/monitor.rb

@@ -20,5 +20,13 @@ module Onfido
     def destroy(monitor_id)
       delete(path: "watchlist_monitors/#{monitor_id}")
     end
+
+    def list_matches(monitor_id)
+      get(path: "watchlist_monitors/#{monitor_id}/matches")
+    end
+
+    def set_match_status(monitor_id, **payload)
+      patch(path: "watchlist_monitors/#{monitor_id}/matches", payload: payload)
+    end
   end
 end

data/lib/onfido/resources/workflow_run.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Onfido
+  class WorkflowRun < Resource
+    def create(payload)
+      post(path: 'workflow_runs', payload: payload)
+    end
+
+    def find(workflow_run_id)
+      get(path: "workflow_runs/#{workflow_run_id}")
+    end
+
+    def all(query_params = {})
+      get(path: "workflow_runs?#{stringify_query_params(query_params)}")
+    end
+  end
+end

data/lib/onfido/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Onfido
-  VERSION = '2.6.0'
+  VERSION = '2.8.0'
 end

data/lib/onfido.rb

@@ -25,6 +25,7 @@ require 'onfido/resources/motion_capture'
 require 'onfido/resources/report'
 require 'onfido/resources/sdk_token'
 require 'onfido/resources/webhook'
+require 'onfido/resources/workflow_run'
 
 module Onfido
 end

data/spec/integrations/applicant_spec.rb

@@ -39,7 +39,7 @@ describe Onfido::Applicant do
 
     it 'serializes the payload correctly' do
       WebMock.after_request do |request_signature, _response|
-        if request_signature.uri.path == 'v3.5/applicants'
+        if request_signature.uri.path == 'v3.6/applicants'
           expect(Rack::Utils.parse_nested_query(request_signature.body))
             .to eq(params)
         end

data/spec/integrations/monitor_spec.rb

@@ -34,7 +34,67 @@ describe Onfido::Monitor do
     end
   end
 
-  it 'returns success code' do
-    expect { monitor.destroy(monitor_id) }.not_to raise_error
+  describe '#destroy' do
+    it 'returns success code' do
+      expect { monitor.destroy(monitor_id) }.not_to raise_error
+    end
+  end
+
+  describe '#list_matches' do
+    subject(:list_matches) { monitor.list_matches(monitor_id) }
+
+    it do
+      is_expected
+        .to include('matches' => [hash_including('id' => anything, 'enabled' => true), anything])
+    end
+
+    context 'when the monitor_id does not exist' do
+      let(:monitor_id) { '00000000-c6b8-4c1e-a383-21efa241ce1e' }
+
+      it 'raises an error' do
+        expect { list_matches }.to raise_error(Onfido::RequestError, /404/)
+      end
+    end
+  end
+
+  describe '#set_match_status' do
+    subject(:set_match_status) { monitor.set_match_status(monitor_id, **payload) }
+
+    let(:payload) do
+      {
+        disabled: ['925e47d3-9e21-48d4-b570-9564c4282cec'],
+        enabled: ['37afcacb-5ff0-4b09-831d-5bcc672ca1fb']
+      }
+    end
+
+    it do
+      is_expected
+        .to include('matches' => [hash_including('id' => anything, 'enabled' => true), anything])
+    end
+
+    context 'when a match id is both in enabled and disabled' do
+      before { payload[:disabled] << payload[:enabled][0] }
+
+      it 'raises an error' do
+        expect { set_match_status }
+          .to raise_error(
+            an_instance_of(Onfido::RequestError).and(having_attributes(response_code: 422))
+          )
+      end
+    end
+
+    context 'when not passing any enabled or disabled ids' do
+      let(:payload) { {} }
+
+      it { is_expected.to be_nil }
+    end
+
+    context 'when the monitor_id does not exist' do
+      let(:monitor_id) { '00000000-c6b8-4c1e-a383-21efa241ce1e' }
+
+      it 'raises an error' do
+        expect { set_match_status }.to raise_error(Onfido::RequestError, /404/)
+      end
+    end
   end
 end

data/spec/integrations/workflow_run_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+describe Onfido::WorkflowRun do
+  include_context 'fake onfido api'
+
+  subject(:workflow_run) { onfido.workflow_run }
+
+  let(:workflow_run_id) { 'fcb73186-0733-4f6f-9c57-d9d5ef979443' }
+  let(:params) do
+    {
+      'a' => 'b'
+    }
+  end
+
+  describe '#create' do
+    it 'serializes the payload correctly' do
+      WebMock.after_request do |request_signature, _response|
+        if request_signature.uri.path == 'v3.6/workflow_run'
+          expect(Rack::Utils.parse_nested_query(request_signature.body))
+            .to eq(params)
+        end
+      end
+    end
+
+    it 'creates a workflow run' do
+      response = workflow_run.create(params)
+      expect(response['id']).not_to be_nil
+    end
+  end
+
+  describe '#find' do
+    it 'returns the workflow run' do
+      response = workflow_run.find(workflow_run_id)
+
+      expect(response['id']).to eq(workflow_run_id)
+    end
+  end
+
+  describe '#all' do
+    it 'returns the workflow runs' do
+      response = workflow_run.all({ page: 1, sort: "asc" })
+
+      expect(response.count).to eq(2)
+    end
+  end
+end

data/spec/onfido/options_spec.rb

@@ -26,7 +26,7 @@ describe Onfido::Options do
     end
 
     it 'configures with region' do
-      expect(rest_client.url).to eq 'https://api.us.onfido.com/v3.5/'
+      expect(rest_client.url).to eq 'https://api.us.onfido.com/v3.6/'
     end
 
     it 'configures with timeouts' do

data/spec/support/fake_onfido_api.rb

@@ -19,32 +19,32 @@ class FakeOnfidoAPI < Sinatra::Base # rubocop:disable Metrics/ClassLength
     end
   end
 
-  get '/v3.5/addresses/pick' do
+  get '/v3.6/addresses/pick' do
     json_response(200, 'addresses.json')
   end
 
-  post '/v3.5/applicants' do
+  post '/v3.6/applicants' do
     json_response(201, 'applicant.json')
   end
 
-  put '/v3.5/applicants/:id' do
+  put '/v3.6/applicants/:id' do
     json_response(200, 'applicant.json')
   end
 
-  get '/v3.5/applicants/:id' do
+  get '/v3.6/applicants/:id' do
     json_response(200, 'applicant.json')
   end
 
-  get '/v3.5/applicants' do
+  get '/v3.6/applicants' do
     response = json_response(200, 'applicants.json')
     { applicants: JSON.parse(response)['applicants'][pagination_range] }.to_json
   end
 
-  delete '/v3.5/applicants/:id' do
+  delete '/v3.6/applicants/:id' do
     status 204
   end
 
-  post '/v3.5/applicants/:id/restore' do
+  post '/v3.6/applicants/:id/restore' do
     if params['id'] == 'a2fb9c62-ab10-4898-a8ec-342c4b552ad5'
       json_response(422, 'not_scheduled_for_deletion_error.json')
     else
@@ -52,37 +52,37 @@ class FakeOnfidoAPI < Sinatra::Base # rubocop:disable Metrics/ClassLength
     end
   end
 
-  post '/v3.5/documents' do
+  post '/v3.6/documents' do
     json_response(201, 'document.json')
   end
 
-  post '/v3.5/extractions' do
+  post '/v3.6/extractions' do
     json_response(201, 'extraction.json')
   end
 
-  get '/v3.5/documents/:id' do
+  get '/v3.6/documents/:id' do
     json_response(200, 'document.json')
   end
 
-  get '/v3.5/documents' do
+  get '/v3.6/documents' do
     json_response(200, 'documents.json')
   end
 
-  get '/v3.5/documents/:id/download' do
+  get '/v3.6/documents/:id/download' do
     status 200
     content_type 'application/octet-stream'
     "\x01\x02\x03" # acts as binary file data
   end
 
-  post '/v3.5/live_photos' do
+  post '/v3.6/live_photos' do
     json_response(201, 'live_photo.json')
   end
 
-  get '/v3.5/live_photos/:id' do
+  get '/v3.6/live_photos/:id' do
     json_response(200, 'live_photo.json')
   end
 
-  get '/v3.5/live_photos' do
+  get '/v3.6/live_photos' do
     if params['applicant_id'] == '1030303-123123-123123'
       json_response(200, 'live_photos.json')
     else
@@ -90,17 +90,17 @@ class FakeOnfidoAPI < Sinatra::Base # rubocop:disable Metrics/ClassLength
     end
   end
 
-  get '/v3.5/live_photos/:id/download' do
+  get '/v3.6/live_photos/:id/download' do
     status 200
     content_type 'image/jpeg'
     "\x01\x02\x03" # acts as binary file data
   end
 
-  get '/v3.5/live_videos/:id' do
+  get '/v3.6/live_videos/:id' do
     json_response(200, 'live_video.json')
   end
 
-  get '/v3.5/live_videos' do
+  get '/v3.6/live_videos' do
     if params['applicant_id'] == '1030303-123123-123123'
       json_response(200, 'live_videos.json')
     else
@@ -108,21 +108,21 @@ class FakeOnfidoAPI < Sinatra::Base # rubocop:disable Metrics/ClassLength
     end
   end
 
-  get '/v3.5/live_videos/:id/download' do
+  get '/v3.6/live_videos/:id/download' do
     status 200
     content_type 'video/quicktime'
     "\x01\x02\x03" # acts as binary file data
   end
 
-  post '/v3.5/watchlist_monitors' do
+  post '/v3.6/watchlist_monitors' do
     json_response(201, 'monitor.json')
   end
 
-  get '/v3.5/watchlist_monitors/:id' do
+  get '/v3.6/watchlist_monitors/:id' do
     json_response(200, 'monitor.json')
   end
 
-  get '/v3.5/watchlist_monitors' do
+  get '/v3.6/watchlist_monitors' do
     if params['applicant_id'] == '1030303-123123-123123'
       json_response(200, 'monitors.json')
     else
@@ -130,15 +130,40 @@ class FakeOnfidoAPI < Sinatra::Base # rubocop:disable Metrics/ClassLength
     end
   end
 
-  delete '/v3.5/watchlist_monitors/:id' do
+  delete '/v3.6/watchlist_monitors/:id' do
     status 204
   end
 
-  get '/v3.5/motion_captures/:id' do
+  get '/v3.6/watchlist_monitors/:monitor_id/matches' do
+    if params['monitor_id'] == '2748c4fc-c6b8-4c1e-a383-21efa241ce1e'
+      json_response(200, 'monitor_matches.json')
+    else
+      status 404
+    end
+  end
+
+  patch '/v3.6/watchlist_monitors/:monitor_id/matches' do
+    if params['monitor_id'] == '2748c4fc-c6b8-4c1e-a383-21efa241ce1e'
+      enabled, disabled = params.values_at('enabled', 'disabled')
+      if enabled&.any? || disabled&.any?
+        if (enabled.to_a & disabled.to_a).any?
+          json_response(422, '4xx_response.json')
+        else
+          json_response(200, 'monitor_matches.json')
+        end
+      else
+        status 204
+      end
+    else
+      status 404
+    end
+  end
+
+  get '/v3.6/motion_captures/:id' do
     json_response(200, 'motion_capture.json')
   end
 
-  get '/v3.5/motion_captures' do
+  get '/v3.6/motion_captures' do
     if params['applicant_id'] == '1030303-123123-123123'
       json_response(200, 'motion_captures.json')
     else
@@ -146,85 +171,97 @@ class FakeOnfidoAPI < Sinatra::Base # rubocop:disable Metrics/ClassLength
     end
   end
 
-  get '/v3.5/motion_captures/:id/download' do
+  get '/v3.6/motion_captures/:id/download' do
     status 200
     content_type 'video/mp4'
     "\x01\x02\x03" # acts as binary file data
   end
 
-  get '/v3.5/motion_captures/:id/frame' do
+  get '/v3.6/motion_captures/:id/frame' do
     status 200
     content_type 'image/jpeg'
     "\x01\x02\x03" # acts as binary file data
   end
 
-  post '/v3.5/checks' do
+  post '/v3.6/checks' do
     params['applicant_id'].nil? ? status(422) : json_response(201, 'check.json')
   end
 
-  get '/v3.5/checks/:id' do
+  get '/v3.6/checks/:id' do
     json_response(200, 'check.json')
   end
 
-  get '/v3.5/checks' do
+  get '/v3.6/checks' do
     json_response(200, 'checks.json')
   end
 
-  post '/v3.5/checks/:id/resume' do
+  post '/v3.6/checks/:id/resume' do
     status 204 # no_content
   end
 
-  get '/v3.5/checks/:id/download' do
+  get '/v3.6/checks/:id/download' do
     status 200
     content_type 'application/pdf'
     "\x01\x02\x03" # acts as binary file data
   end
 
-  get '/v3.5/reports' do
+  get '/v3.6/reports' do
     json_response(200, 'reports.json')
   end
 
-  get '/v3.5/reports/:id' do
+  get '/v3.6/reports/:id' do
     json_response(200, 'report.json')
   end
 
-  post '/v3.5/reports/:id/resume' do
+  post '/v3.6/reports/:id/resume' do
     status 204
   end
 
-  post '/v3.5/reports/:id/cancel' do
+  post '/v3.6/reports/:id/cancel' do
     status 204
   end
 
-  post '/v3.5/sdk_token' do
+  post '/v3.6/sdk_token' do
     json_response(201, 'sdk_token.json')
   end
 
-  post '/v3.5/webhooks' do
+  post '/v3.6/webhooks' do
     json_response(201, 'webhook.json')
   end
 
-  get '/v3.5/webhooks/:id' do
+  get '/v3.6/webhooks/:id' do
     json_response(200, 'webhook.json')
   end
 
-  delete '/v3.5/webhooks/:id' do
+  delete '/v3.6/webhooks/:id' do
     status 204
   end
 
-  get '/v3.5/webhooks' do
+  get '/v3.6/webhooks' do
     json_response(200, 'webhooks.json')
   end
 
-  get '/v3.5/4xx_response' do
+  post '/v3.6/workflow_runs' do
+    json_response(201, 'workflow_run.json')
+  end
+
+  get '/v3.6/workflow_runs/:id' do
+    json_response(200, 'workflow_run.json')
+  end
+
+  get '/v3.6/workflow_runs' do
+    json_response(200, 'workflow_runs.json')
+  end
+
+  get '/v3.6/4xx_response' do
     json_response(422, '4xx_response.json')
   end
 
-  get '/v3.5/unexpected_error_format' do
+  get '/v3.6/unexpected_error_format' do
     json_response(400, 'unexpected_error_format.json')
   end
 
-  get '/v3.5/unparseable_response' do
+  get '/v3.6/unparseable_response' do
     content_type :json
     status 504
     ''

data/spec/support/fixtures/applicant.json

@@ -7,7 +7,7 @@
   "last_name":"Bing",
   "email":"chandler_bing_6@friends.com",
   "dob":"1968-04-08",
-  "href":"/v3.5/applicants/61f659cb-c90b-4067-808a-6136b5c01351",
+  "href":"/v3.6/applicants/61f659cb-c90b-4067-808a-6136b5c01351",
   "id_numbers":[],
   "address": {
     "flat_number":"4",

data/spec/support/fixtures/check.json

@@ -1,7 +1,7 @@
 {
   "id": "8546921-123123-123123",
   "created_at": "2019-05-23T13:50:33Z",
-  "href": "/v3.5/checks/8546921-123123-123123",
+  "href": "/v3.6/checks/8546921-123123-123123",
   "applicant_provides_data": "false",
   "status": "in_progress",
   "result": "pending",

data/spec/support/fixtures/checks.json

@@ -3,7 +3,7 @@
         {
             "id": "8546921-123123-123123",
             "created_at": "2019-11-23T13:50:33Z",
-            "href": "/v3.5/checks/8546921-123123-123123",
+            "href": "/v3.6/checks/8546921-123123-123123",
             "applicant_provides_data": "false",
             "status": "in_progress",
             "result": "pending",

data/spec/support/fixtures/document.json

@@ -1,7 +1,7 @@
 {
   "id": "7568415-123123-123123",
   "created_at": "2019-11-23 13:50:33Z",
-  "href": "/v3.5/documents/7568415-123123-123123",
+  "href": "/v3.6/documents/7568415-123123-123123",
   "file_name": "passport.jpg",
   "file_type": "png",
   "file_size": 282870,

data/spec/support/fixtures/documents.json

@@ -3,7 +3,7 @@
     {
       "id": "7568415-123123-123123",
       "created_at": "2019-11-23 13:50:33Z",
-      "href": "/v3.5/documents/7568415-123123-123123",
+      "href": "/v3.6/documents/7568415-123123-123123",
       "file_name": "passport.jpg",
       "file_type": "png",
       "file_size": 282870,
@@ -12,7 +12,7 @@
     {
       "id": "121122-123123-123123",
       "created_at": "2019-11-23 13:50:40Z",
-      "href": "/v3.5/documents/7568415-123123-123123",
+      "href": "/v3.6/documents/7568415-123123-123123",
       "file_name": "driving_licence.png",
       "file_type": "png",
       "file_size": 282870,

data/spec/support/fixtures/live_photo.json

@@ -4,6 +4,6 @@
   "file_name": "onfido_captured_image.jpg",
   "file_type": "image/jpeg",
   "file_size": 47544,
-  "href": "/v3.5/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1",
-  "download_href": "/v3.5/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1/download"
+  "href": "/v3.6/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1",
+  "download_href": "/v3.6/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1/download"
 }

data/spec/support/fixtures/live_photos.json

@@ -6,8 +6,8 @@
       "file_name": "onfido_captured_image.jpg",
       "file_type": "image/jpeg",
       "file_size": 47544,
-      "href": "/v3.5/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1",
-      "download_href": "/v3.5/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1/download"
+      "href": "/v3.6/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1",
+      "download_href": "/v3.6/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1/download"
     },
     {
         "id": "5134c12a-555a-1234-5e12-9d34fcbc11ba",
@@ -15,8 +15,8 @@
         "file_name": "onfido_captured_image.jpg",
         "file_type": "image/jpeg",
         "file_size": 47544,
-        "href": "/v3.5/live_photos/5134c12a-555a-1234-5e12-9d34fcbc11ba",
-        "download_href": "/v3.5/live_photos/5134c12a-555a-1234-5e12-9d34fcbc11ba/download"
+        "href": "/v3.6/live_photos/5134c12a-555a-1234-5e12-9d34fcbc11ba",
+        "download_href": "/v3.6/live_photos/5134c12a-555a-1234-5e12-9d34fcbc11ba/download"
       }
   ]
 }

data/spec/support/fixtures/live_video.json

@@ -18,6 +18,6 @@
   "file_name" : "output-29-05-2018_11_00_24.mov",
   "file_type" : "video/quicktime",
   "file_size" : 3348421,
-  "href" : "/v3.5/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01",
-  "download_href" : "/v3.5/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01/download"
+  "href" : "/v3.6/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01",
+  "download_href" : "/v3.6/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01/download"
 }

data/spec/support/fixtures/live_videos.json

@@ -16,11 +16,11 @@
         }
       ],
       "created_at": "2019-11-29T09:00:39Z",
-      "download_href": "/v3.5/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01/download",
+      "download_href": "/v3.6/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01/download",
       "file_name": "output-29-11-2019_11_00_24.mov",
       "file_size": 3348421,
       "file_type": "video/quicktime",
-      "href": "/v3.5/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01",
+      "href": "/v3.6/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01",
       "id": "c9701e9b-83aa-442f-995b-20320ee8fb01"
     }
   ]

data/spec/support/fixtures/monitor_matches.json

@@ -0,0 +1,12 @@
+{
+  "matches": [
+    {
+      "id": "37afcacb-5ff0-4b09-831d-5bcc672ca1fb",
+      "enabled": true
+    },
+    {
+      "id": "925e47d3-9e21-48d4-b570-9564c4282cec",
+      "enabled": false
+    }
+  ]
+}

data/spec/support/fixtures/motion_capture.json

@@ -4,6 +4,6 @@
   "file_name" : "motion_capture.mp4",
   "file_type" : "video/mp4",
   "file_size" : 2437112,
-  "href" : "/v3.5/motion_captures/b1ae05b7-fb12-47c3-971c-311b56fc8de6",
-  "download_href" : "/v3.5/motion_captures/b1ae05b7-fb12-47c3-971c-311b56fc8de6/download"
+  "href" : "/v3.6/motion_captures/b1ae05b7-fb12-47c3-971c-311b56fc8de6",
+  "download_href" : "/v3.6/motion_captures/b1ae05b7-fb12-47c3-971c-311b56fc8de6/download"
 }

data/spec/support/fixtures/motion_captures.json

@@ -6,8 +6,8 @@
       "file_name" : "motion_capture.mp4",
       "file_type" : "video/mp4",
       "file_size" : 2437112,
-      "href" : "/v3.5/motion_captures/b1ae05b7-fb12-47c3-971c-311b56fc8de6",
-      "download_href" : "/v3.5/motion_captures/b1ae05b7-fb12-47c3-971c-311b56fc8de6/download"
+      "href" : "/v3.6/motion_captures/b1ae05b7-fb12-47c3-971c-311b56fc8de6",
+      "download_href" : "/v3.6/motion_captures/b1ae05b7-fb12-47c3-971c-311b56fc8de6/download"
     }
   ]
 }

data/spec/support/fixtures/report.json

@@ -4,7 +4,7 @@
   "created_at": "2019-11-23T13:50:45Z",
   "status": "in_progress",
   "result": "pending",
-  "href": "/v3.5/reports/6951786-123123-422221",
+  "href": "/v3.6/reports/6951786-123123-422221",
   "breakdown": {},
   "properties": {}
 }

data/spec/support/fixtures/reports.json

@@ -6,7 +6,7 @@
       "created_at": "2019-11-23T13:50:45Z",
       "status": "in_progress",
       "result": "pending",
-      "href": "/v3.5/reports/6951786-123123-422221",
+      "href": "/v3.6/reports/6951786-123123-422221",
       "breakdown": {},
       "properties": {}
     },
@@ -16,7 +16,7 @@
       "created_at": "2019-11-23T13:50:45Z",
       "status": "in_progress",
       "result": "pending",
-      "href": "/v3.5/reports/6951786-123123-316712",
+      "href": "/v3.6/reports/6951786-123123-316712",
       "breakdown": {},
       "properties": {}
     }

data/spec/support/fixtures/webhook.json

@@ -3,7 +3,7 @@
   "url": "https://webhookendpoint.url",
   "token": "yV85IsmuYwmjQGlZ",
   "enabled": true,
-  "href": "/v3.5/webhooks/fcb73186-0733-4f6f-9c57-d9d5ef979443",
+  "href": "/v3.6/webhooks/fcb73186-0733-4f6f-9c57-d9d5ef979443",
   "environments": [
     "live"
   ],

data/spec/support/fixtures/webhooks.json

@@ -4,7 +4,7 @@
       "id": "dd0a89e4-d44e-417a-aec4-01137d01ae59",
       "url": "https://demo.com",
       "enabled":false,
-      "href": "/v3.5/webhooks/dd0a89e4-d44e-417a-aec4-01137d01ae59",
+      "href": "/v3.6/webhooks/dd0a89e4-d44e-417a-aec4-01137d01ae59",
       "environments": [
         "live"
       ],
@@ -18,7 +18,7 @@
       "id": "bfc727a8-f7bf-4073-b123-ed70a70f58e5",
       "url": "https://demo2.com",
       "enabled": true,
-      "href": "/v3.5/webhooks/bfc727a8-f7bf-4073-b123-ed70a70f58e5",
+      "href": "/v3.6/webhooks/bfc727a8-f7bf-4073-b123-ed70a70f58e5",
       "environments": [
         "live"
       ],

data/spec/support/fixtures/workflow_run.json

@@ -0,0 +1,20 @@
+{
+  "id": "fcb73186-0733-4f6f-9c57-d9d5ef979443",
+  "applicant_id": "fcb73186-0733-4f6f-9c57-d9d5ef979443",
+  "workflow_id": "fcb73186-0733-4f6f-9c57-d9d5ef979443",
+  "workflow_version_id": 11,
+  "status": "approved",
+  "dashboard_url":"https://dashboard.onfido.com/results/fcb73186-0733-4f6f-9c57-d9d5ef979443",
+  "output": {"prop1": "val_1", "prop2": 10}, 
+  "reasons": ["reason_1", "reason_2"],
+  "error": null,
+  "created_at": "2022-06-28T15:39:42Z",
+  "updated_at": "2022-07-28T15:40:42Z",
+  "link": {
+      "completed_redirect_url": "https://example.onfido.com",
+      "expired_redirect_url": "https://example.onfido.com",
+      "expires_at": "2022-10-17T14:40:50Z",
+      "language": "en_US",
+      "url": "https://eu.onfido.app/l/fcb73186-0733-4f6f-9c57-d9d5ef979443"
+  }
+}

data/spec/support/fixtures/workflow_runs.json

@@ -0,0 +1,42 @@
+[
+  {
+    "id": "fcb73186-0733-4f6f-9c57-d9d5ef979443",
+    "applicant_id": "fcb73186-0733-4f6f-9c57-d9d5ef979443",
+    "workflow_id": "fcb73186-0733-4f6f-9c57-d9d5ef979443",
+    "workflow_version_id": 11,
+    "status": "approved",
+    "dashboard_url":"https://dashboard.onfido.com/results/fcb73186-0733-4f6f-9c57-d9d5ef979443",
+    "output": {"prop1": "val_1", "prop2": 10}, 
+    "reasons": ["reason_1", "reason_2"],
+    "error": null,
+    "created_at": "2022-06-28T15:39:42Z",
+    "updated_at": "2022-07-28T15:40:42Z",
+    "link": {
+        "completed_redirect_url": "https://example.onfido.com",
+        "expired_redirect_url": "https://example.onfido.com",
+        "expires_at": "2022-10-17T14:40:50Z",
+        "language": "en_US",
+        "url": "https://eu.onfido.app/l/fcb73186-0733-4f6f-9c57-d9d5ef979443"
+    }
+  },
+  {
+    "id": "fcb73186-0733-4f6f-9c57-d9d5ef979463",
+    "applicant_id": "fcb73186-0733-4f6f-9c57-d9d5ef979443",
+    "workflow_id": "fcb73186-0733-4f6f-9c57-d9d5ef979443",
+    "workflow_version_id": 11,
+    "status": "approved",
+    "dashboard_url":"https://dashboard.onfido.com/results/fcb73186-0733-4f6f-9c57-d9d5ef979443",
+    "output": {"prop1": "val_1", "prop2": 10}, 
+    "reasons": ["reason_1", "reason_2"],
+    "error": null,
+    "created_at": "2022-06-28T15:39:42Z",
+    "updated_at": "2022-07-28T15:40:42Z",
+    "link": {
+        "completed_redirect_url": "https://example.onfido.com",
+        "expired_redirect_url": "https://example.onfido.com",
+        "expires_at": "2022-10-17T14:40:50Z",
+        "language": "en_US",
+        "url": "https://eu.onfido.app/l/fcb73186-0733-4f6f-9c57-d9d5ef979443"
+    }
+  }
+]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onfido
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Onfido
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-02 00:00:00.000000000 Z
+date: 2023-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -146,6 +146,7 @@ files:
 - lib/onfido/resources/report.rb
 - lib/onfido/resources/sdk_token.rb
 - lib/onfido/resources/webhook.rb
+- lib/onfido/resources/workflow_run.rb
 - lib/onfido/version.rb
 - onfido.gemspec
 - spec/integrations/address_spec.rb
@@ -161,6 +162,7 @@ files:
 - spec/integrations/resource_spec.rb
 - spec/integrations/sdk_token_spec.rb
 - spec/integrations/webhook_spec.rb
+- spec/integrations/workflow_run_spec.rb
 - spec/onfido/api_spec.rb
 - spec/onfido/connection_error_spec.rb
 - spec/onfido/options_spec.rb
@@ -181,6 +183,7 @@ files:
 - spec/support/fixtures/live_video.json
 - spec/support/fixtures/live_videos.json
 - spec/support/fixtures/monitor.json
+- spec/support/fixtures/monitor_matches.json
 - spec/support/fixtures/monitors.json
 - spec/support/fixtures/motion_capture.json
 - spec/support/fixtures/motion_captures.json
@@ -191,6 +194,8 @@ files:
 - spec/support/fixtures/unexpected_error_format.json
 - spec/support/fixtures/webhook.json
 - spec/support/fixtures/webhooks.json
+- spec/support/fixtures/workflow_run.json
+- spec/support/fixtures/workflow_runs.json
 homepage: http://github.com/onfido/onfido-ruby
 licenses:
 - MIT
@@ -228,6 +233,7 @@ test_files:
 - spec/integrations/resource_spec.rb
 - spec/integrations/sdk_token_spec.rb
 - spec/integrations/webhook_spec.rb
+- spec/integrations/workflow_run_spec.rb
 - spec/onfido/api_spec.rb
 - spec/onfido/connection_error_spec.rb
 - spec/onfido/options_spec.rb
@@ -248,6 +254,7 @@ test_files:
 - spec/support/fixtures/live_video.json
 - spec/support/fixtures/live_videos.json
 - spec/support/fixtures/monitor.json
+- spec/support/fixtures/monitor_matches.json
 - spec/support/fixtures/monitors.json
 - spec/support/fixtures/motion_capture.json
 - spec/support/fixtures/motion_captures.json
@@ -258,3 +265,5 @@ test_files:
 - spec/support/fixtures/unexpected_error_format.json
 - spec/support/fixtures/webhook.json
 - spec/support/fixtures/webhooks.json
+- spec/support/fixtures/workflow_run.json
+- spec/support/fixtures/workflow_runs.json