yoti_sandbox 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3dca617f8f85c6d5f3f8cab50bbbaed9d25d02400fe57d92fa79e96741910460
-  data.tar.gz: 5ff037daed4c3c10499c2fdb707359ee12fb8f498806f207842009a9012ec138
+  metadata.gz: 50664707d70da0ad9d28f183b68074c795f74ef59c05dbf4fbd1a0cef280d819
+  data.tar.gz: 6bae10a1f1675592f178d9ae1f47fdf3992196f1480a03e6a736b177a7638ea9
 SHA512:
-  metadata.gz: cd19939c2a54cb656244b367c75ab362cd931aaf533f324c3b5c309c8ed61a5fc44d310f49f1295ccea98f70aa392e4276ffa4f3edfc2776603d61324168ee59
-  data.tar.gz: 2702371dbc5dd6caf8ddfce5c7eaf06d110f217d314d2c402ece5d5d87b63430eb1a52ffb98427e47ead8eadd4984ae3b5fa04ede3845e3daf10fefaa6134362
+  metadata.gz: fe42559fa4b25d2a3f5d239471bfe86a0f1b59e00cb6c4bcb52cd895b52f2e2a4bf8087ce710d50be5514cf745e804204e245dac7f8bdf1dccf6157c9092efa1
+  data.tar.gz: 8de1edf888b5ede3604532ed62dd4210f7a55aa3de899c79062fefa980c37bd7d1ebf4045a40e9d879b5c87e83b3f2331d79985d7ecc447c1224a28f836afef7

data/Gemfile

@@ -2,7 +2,7 @@ source 'https://rubygems.org'
 
 gem 'guard'
 gem 'guard-rspec'
-gem 'rubocop'
+gem 'rubocop', '~> 1.1', require: false
 gem 'rubocop-performance'
 
 gemspec

data/lib/yoti_sandbox/doc_scan.rb

@@ -12,9 +12,14 @@ require_relative 'doc_scan/request/check/document_authenticity_check'
 require_relative 'doc_scan/request/check/id_document_comparison_check'
 require_relative 'doc_scan/request/check/document_face_match_check'
 require_relative 'doc_scan/request/check/document_text_data_check'
+require_relative 'doc_scan/request/check/supplementary_document_text_data_check'
 require_relative 'doc_scan/request/check/liveness_check'
 require_relative 'doc_scan/request/check/zoom_liveness_check'
 require_relative 'doc_scan/request/check/report/breakdown'
 require_relative 'doc_scan/request/check/report/recommendation'
 require_relative 'doc_scan/request/check/report/detail'
 require_relative 'doc_scan/request/task/document_text_data_extraction_task'
+require_relative 'doc_scan/request/task/supplementary_document_text_data_extraction_task'
+require_relative 'doc_scan/request/task/document_id_photo'
+require_relative 'doc_scan/request/task/text_data_extraction_recommendation'
+require_relative 'doc_scan/request/task/text_data_extraction_reason'

data/lib/yoti_sandbox/doc_scan/request/check/check.rb

@@ -9,7 +9,7 @@ module Yoti
           # @param [CheckResult] result
           #
           def initialize(result)
-            raise(TypeError, "#{self.class} cannot be instantiated") if self.class == Check
+            raise(TypeError, "#{self.class} cannot be instantiated") if instance_of?(Check)
 
             Validation.assert_is_a(CheckResult, result, 'result')
             @result = result

data/lib/yoti_sandbox/doc_scan/request/check/document_check.rb

@@ -10,7 +10,7 @@ module Yoti
           # @param [DocumentFilter] document_filter
           #
           def initialize(result, document_filter)
-            raise(TypeError, "#{self.class} cannot be instantiated") if self.class == DocumentCheck
+            raise(TypeError, "#{self.class} cannot be instantiated") if instance_of?(DocumentCheck)
 
             super(result)
 
@@ -27,7 +27,7 @@ module Yoti
 
         class DocumentCheckBuilder < CheckBuilder
           def initialize
-            raise(TypeError, "#{self.class} cannot be instantiated") if self.class == DocumentCheckBuilder
+            raise(TypeError, "#{self.class} cannot be instantiated") if instance_of?(DocumentCheckBuilder)
 
             super
           end

data/lib/yoti_sandbox/doc_scan/request/check/document_text_data_check.rb

@@ -18,13 +18,15 @@ module Yoti
         class DocumentTextDataCheckResult < CheckResult
           #
           # @param [CheckReport] report
-          # @param [Hash] document_fields
+          # @param [Hash,nil] document_fields
           #
           def initialize(report, document_fields)
             super(report)
 
-            Validation.assert_is_a(Hash, document_fields, 'document_fields')
-            document_fields.each { |_k, v| Validation.assert_respond_to(:to_json, v, 'document_fields value') }
+            unless document_fields.nil?
+              Validation.assert_is_a(Hash, document_fields, 'document_fields')
+              document_fields.each { |_k, v| Validation.assert_respond_to(:to_json, v, 'document_fields value') }
+            end
             @document_fields = document_fields
           end
 
@@ -36,12 +38,6 @@ module Yoti
         end
 
         class DocumentTextDataCheckBuilder < DocumentCheckBuilder
-          def initialize
-            super
-
-            @document_fields = {}
-          end
-
           #
           # @param [String] key
           # @param [#to_json] value
@@ -51,6 +47,7 @@ module Yoti
           def with_document_field(key, value)
             Validation.assert_is_a(String, key, 'key')
             Validation.assert_respond_to(:to_json, value, 'value')
+            @document_fields ||= {}
             @document_fields[key] = value
             self
           end

data/lib/yoti_sandbox/doc_scan/request/check/liveness_check.rb

@@ -10,7 +10,7 @@ module Yoti
           # @param [String] liveness_type
           #
           def initialize(result, liveness_type)
-            raise(TypeError, "#{self.class} cannot be instantiated") if self.class == LivenessCheck
+            raise(TypeError, "#{self.class} cannot be instantiated") if instance_of?(LivenessCheck)
 
             super(result)
 

data/lib/yoti_sandbox/doc_scan/request/check/supplementary_document_text_data_check.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class SupplementaryDocumentTextDataCheck < DocumentCheck
+          #
+          # @return [SupplementaryDocumentTextDataCheckBuilder]
+          #
+          def self.builder
+            SupplementaryDocumentTextDataCheckBuilder.new
+          end
+        end
+
+        class SupplementaryDocumentTextDataCheckResult < CheckResult
+          #
+          # @param [CheckReport] report
+          # @param [Hash,nil] document_fields
+          #
+          def initialize(report, document_fields)
+            super(report)
+
+            unless document_fields.nil?
+              Validation.assert_is_a(Hash, document_fields, 'document_fields')
+              document_fields.each { |_k, v| Validation.assert_respond_to(:to_json, v, 'document_fields value') }
+            end
+            @document_fields = document_fields
+          end
+
+          def as_json(*_args)
+            super.merge(
+              document_fields: @document_fields
+            ).compact
+          end
+        end
+
+        class SupplementaryDocumentTextDataCheckBuilder < DocumentCheckBuilder
+          #
+          # @param [String] key
+          # @param [#to_json] value
+          #
+          # @return [self]
+          #
+          def with_document_field(key, value)
+            Validation.assert_is_a(String, key, 'key')
+            Validation.assert_respond_to(:to_json, value, 'value')
+            @document_fields ||= {}
+            @document_fields[key] = value
+            self
+          end
+
+          #
+          # @param [Hash] document_fields
+          #
+          # @return [self]
+          #
+          def with_document_fields(document_fields)
+            Validation.assert_is_a(Hash, document_fields, 'document_fields')
+            @document_fields = document_fields
+            self
+          end
+
+          #
+          # @return [SupplementaryDocumentTextDataCheck]
+          #
+          def build
+            report = CheckReport.new(@recommendation, @breakdowns)
+            result = SupplementaryDocumentTextDataCheckResult.new(report, @document_fields)
+            SupplementaryDocumentTextDataCheck.new(result, @document_filter)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti_sandbox/doc_scan/request/check_reports.rb

@@ -19,7 +19,8 @@ module Yoti
             liveness_checks,
             document_face_match_checks,
             async_report_delay,
-            id_document_comparison_checks = nil
+            id_document_comparison_checks = nil,
+            supplementary_document_text_data_checks = nil
           )
             Validation.assert_is_a(Array, document_text_data_checks, 'document_text_data_checks')
             @document_text_data_checks = document_text_data_checks
@@ -38,6 +39,14 @@ module Yoti
 
             Validation.assert_is_a(Array, id_document_comparison_checks, 'id_document_comparison_checks', true)
             @id_document_comparison_checks = id_document_comparison_checks
+
+            Validation.assert_is_a(
+              Array,
+              supplementary_document_text_data_checks,
+              'supplementary_document_text_data_checks',
+              true
+            )
+            @supplementary_document_text_data_checks = supplementary_document_text_data_checks
           end
 
           def self.builder
@@ -55,6 +64,7 @@ module Yoti
               ID_DOCUMENT_FACE_MATCH: @document_face_match_checks,
               LIVENESS: @liveness_checks,
               ID_DOCUMENT_COMPARISON: @id_document_comparison_checks,
+              SUPPLEMENTARY_DOCUMENT_TEXT_DATA_CHECK: @supplementary_document_text_data_checks,
               async_report_delay: @async_report_delay
             }.compact
           end
@@ -67,6 +77,7 @@ module Yoti
             @document_authenticity_checks = []
             @document_face_match_checks = []
             @id_document_comparison_checks = []
+            @supplementary_document_text_data_checks = []
           end
 
           #
@@ -135,6 +146,21 @@ module Yoti
             self
           end
 
+          #
+          # @param [SupplementaryDocumentTextDataCheck] supplementary_document_text_data_check
+          #
+          # @return [self]
+          #
+          def with_supplementary_document_text_data_check(supplementary_document_text_data_check)
+            Validation.assert_is_a(
+              SupplementaryDocumentTextDataCheck,
+              supplementary_document_text_data_check,
+              'supplementary_document_text_data_check'
+            )
+            @supplementary_document_text_data_checks << supplementary_document_text_data_check
+            self
+          end
+
           #
           # @return [CheckReports]
           #
@@ -145,7 +171,8 @@ module Yoti
               @liveness_checks,
               @document_face_match_checks,
               @async_report_delay,
-              @id_document_comparison_checks
+              @id_document_comparison_checks,
+              @supplementary_document_text_data_checks
             )
           end
         end

data/lib/yoti_sandbox/doc_scan/request/task/document_id_photo.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'base64'
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class DocumentIdPhoto
+          #
+          # @param [String] content_type
+          # @param [bin] data
+          #
+          def initialize(content_type, data)
+            Validation.assert_is_a(String, content_type, 'content_type')
+            @content_type = content_type
+
+            @data = data
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            {
+              content_type: @content_type,
+              data: Base64.strict_encode64(@data)
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti_sandbox/doc_scan/request/task/document_text_data_extraction_task.rb

@@ -12,8 +12,6 @@ module Yoti
           # @param [DocumentFilter] document_filter
           #
           def initialize(result, document_filter)
-            raise(TypeError, "#{self.class} cannot be instantiated") if self.class == DocumentCheck
-
             Validation.assert_is_a(DocumentTextDataExtractionTaskResult, result, 'result')
             @result = result
 
@@ -43,12 +41,31 @@ module Yoti
 
         class DocumentTextDataExtractionTaskResult
           #
-          # @param [Hash] document_fields
-          #
-          def initialize(document_fields)
-            Validation.assert_is_a(Hash, document_fields, 'document_fields')
-            document_fields.each { |_k, v| Validation.assert_respond_to(:to_json, v, 'document_fields value') }
+          # @param [Hash,nil] document_fields
+          # @param [DocumentIdPhoto,nil] document_id_photo
+          # @param [String,nil] detected_country
+          # @param [TextDataExtractionRecommendation,nil] recommendation
+          #
+          def initialize(
+            document_fields,
+            document_id_photo = nil,
+            detected_country = nil,
+            recommendation = nil
+          )
+            unless document_fields.nil?
+              Validation.assert_is_a(Hash, document_fields, 'document_fields')
+              document_fields.each { |_k, v| Validation.assert_respond_to(:to_json, v, 'document_fields value') }
+            end
             @document_fields = document_fields
+
+            Validation.assert_is_a(DocumentIdPhoto, document_id_photo, 'document_id_photo', true)
+            @document_id_photo = document_id_photo
+
+            Validation.assert_is_a(String, detected_country, 'detected_country', true)
+            @detected_country = detected_country
+
+            Validation.assert_is_a(TextDataExtractionRecommendation, recommendation, 'recommendation', true)
+            @recommendation = recommendation
           end
 
           def to_json(*_args)
@@ -57,16 +74,15 @@ module Yoti
 
           def as_json(*_args)
             {
-              document_fields: @document_fields
-            }
+              document_fields: @document_fields,
+              document_id_photo: @document_id_photo,
+              detected_country: @detected_country,
+              recommendation: @recommendation
+            }.compact
           end
         end
 
         class DocumentTextDataExtractionTaskBuilder
-          def initialize
-            @document_fields = {}
-          end
-
           #
           # @param [String] key
           # @param [#to_json] value
@@ -76,6 +92,7 @@ module Yoti
           def with_document_field(key, value)
             Validation.assert_is_a(String, key, 'key')
             Validation.assert_respond_to(:to_json, value, 'value')
+            @document_fields ||= {}
             @document_fields[key] = value
             self
           end
@@ -101,11 +118,49 @@ module Yoti
             self
           end
 
+          #
+          # @param [String] content_type
+          # @param [bin] data
+          #
+          # @return [self]
+          #
+          def with_document_id_photo(content_type, data)
+            @document_id_photo = DocumentIdPhoto.new(content_type, data)
+            self
+          end
+
+          #
+          # @param [TextDataExtractionRecommendation] recommendation
+          #
+          # @return [self]
+          #
+          def with_recommendation(recommendation)
+            Validation.assert_is_a(TextDataExtractionRecommendation, recommendation, 'recommendation')
+            @recommendation = recommendation
+            self
+          end
+
+          #
+          # @param [String] detected_country
+          #
+          # @return [self]
+          #
+          def with_detected_country(detected_country)
+            Validation.assert_is_a(String, detected_country, 'detected_country')
+            @detected_country = detected_country
+            self
+          end
+
           #
           # @return [DocumentTextDataExtractionTask]
           #
           def build
-            result = DocumentTextDataExtractionTaskResult.new(@document_fields)
+            result = DocumentTextDataExtractionTaskResult.new(
+              @document_fields,
+              @document_id_photo,
+              @detected_country,
+              @recommendation
+            )
             DocumentTextDataExtractionTask.new(result, @document_filter)
           end
         end

data/lib/yoti_sandbox/doc_scan/request/task/supplementary_document_text_data_extraction_task.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class SupplementaryDocumentTextDataExtractionTask
+          #
+          # @param [SupplementaryDocumentTextDataExtractionTaskResult] result
+          # @param [DocumentFilter] document_filter
+          #
+          def initialize(result, document_filter)
+            Validation.assert_is_a(SupplementaryDocumentTextDataExtractionTaskResult, result, 'result')
+            @result = result
+
+            Validation.assert_is_a(DocumentFilter, document_filter, 'document_filter', true)
+            @document_filter = document_filter
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            json = {
+              result: @result.as_json
+            }
+            json[:document_filter] = @document_filter.as_json unless @document_filter.nil?
+            json
+          end
+
+          #
+          # @return [SupplementaryDocumentTextDataExtractionTaskBuilder]
+          #
+          def self.builder
+            SupplementaryDocumentTextDataExtractionTaskBuilder.new
+          end
+        end
+
+        class SupplementaryDocumentTextDataExtractionTaskResult
+          #
+          # @param [Hash,nil] document_fields
+          # @param [String,nil] detected_country
+          # @param [TextDataExtractionRecommendation,nil] recommendation
+          #
+          def initialize(
+            document_fields,
+            detected_country = nil,
+            recommendation = nil
+          )
+            unless document_fields.nil?
+              Validation.assert_is_a(Hash, document_fields, 'document_fields')
+              document_fields.each { |_k, v| Validation.assert_respond_to(:to_json, v, 'document_fields value') }
+            end
+            @document_fields = document_fields
+
+            Validation.assert_is_a(String, detected_country, 'detected_country', true)
+            @detected_country = detected_country
+
+            Validation.assert_is_a(TextDataExtractionRecommendation, recommendation, 'recommendation', true)
+            @recommendation = recommendation
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            {
+              document_fields: @document_fields,
+              detected_country: @detected_country,
+              recommendation: @recommendation
+            }.compact
+          end
+        end
+
+        class SupplementaryDocumentTextDataExtractionTaskBuilder
+          #
+          # @param [String] key
+          # @param [#to_json] value
+          #
+          # @return [self]
+          #
+          def with_document_field(key, value)
+            Validation.assert_is_a(String, key, 'key')
+            Validation.assert_respond_to(:to_json, value, 'value')
+            @document_fields ||= {}
+            @document_fields[key] = value
+            self
+          end
+
+          #
+          # @param [Hash] document_fields
+          #
+          # @return [self]
+          #
+          def with_document_fields(document_fields)
+            Validation.assert_is_a(Hash, document_fields, 'document_fields')
+            @document_fields = document_fields
+            self
+          end
+
+          #
+          # @param [DocumentFilter] document_filter
+          #
+          # @return [self]
+          #
+          def with_document_filter(document_filter)
+            @document_filter = document_filter
+            self
+          end
+
+          #
+          # @param [TextDataExtractionRecommendation] recommendation
+          #
+          # @return [self]
+          #
+          def with_recommendation(recommendation)
+            Validation.assert_is_a(TextDataExtractionRecommendation, recommendation, 'recommendation')
+            @recommendation = recommendation
+            self
+          end
+
+          #
+          # @param [String] detected_country
+          #
+          # @return [self]
+          #
+          def with_detected_country(detected_country)
+            Validation.assert_is_a(String, detected_country, 'detected_country')
+            @detected_country = detected_country
+            self
+          end
+
+          #
+          # @return [SupplementaryDocumentTextDataExtractionTask]
+          #
+          def build
+            result = SupplementaryDocumentTextDataExtractionTaskResult.new(
+              @document_fields,
+              @detected_country,
+              @recommendation
+            )
+            SupplementaryDocumentTextDataExtractionTask.new(result, @document_filter)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti_sandbox/doc_scan/request/task/text_data_extraction_reason.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class TextDataExtractionReason
+          #
+          # @param [String] value
+          # @param [String] detail
+          #
+          def initialize(value, detail)
+            Validation.assert_is_a(String, value, 'value')
+            @value = value
+
+            Validation.assert_is_a(String, detail, 'detail', true)
+            @detail = detail
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            {
+              value: @value,
+              detail: @detail
+            }.compact
+          end
+
+          #
+          # @return [TextDataExtractionReasonBuilder]
+          #
+          def self.builder
+            TextDataExtractionReasonBuilder.new
+          end
+        end
+
+        class TextDataExtractionReasonBuilder
+          #
+          # @return [self]
+          #
+          def for_quality
+            @value = 'QUALITY'
+            self
+          end
+
+          #
+          # @return [self]
+          #
+          def for_user_error
+            @value = 'USER_ERROR'
+            self
+          end
+
+          #
+          # @param [String] detail
+          #
+          # @return [self]
+          #
+          def with_detail(detail)
+            @detail = detail
+            self
+          end
+
+          #
+          # @return [TextDataExtractionReason]
+          #
+          def build
+            TextDataExtractionReason.new(@value, @detail)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti_sandbox/doc_scan/request/task/text_data_extraction_recommendation.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class TextDataExtractionRecommendation
+          #
+          # @param [String] value
+          # @param [TextDataExtractionReason] reason
+          #
+          def initialize(value, reason)
+            Validation.assert_is_a(String, value, 'value')
+            @value = value
+
+            Validation.assert_is_a(TextDataExtractionReason, reason, 'reason', true)
+            @reason = reason
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            {
+              value: @value,
+              reason: @reason
+            }.compact
+          end
+
+          #
+          # @return [TextDataExtractionRecommendationBuilder]
+          #
+          def self.builder
+            TextDataExtractionRecommendationBuilder.new
+          end
+        end
+
+        class TextDataExtractionRecommendationBuilder
+          #
+          # @return [self]
+          #
+          def for_progress
+            @value = 'PROGRESS'
+            self
+          end
+
+          #
+          # @return [self]
+          #
+          def for_should_try_again
+            @value = 'SHOULD_TRY_AGAIN'
+            self
+          end
+
+          #
+          # @return [self]
+          #
+          def for_must_try_again
+            @value = 'MUST_TRY_AGAIN'
+            self
+          end
+
+          #
+          # @param [TextDataExtractionReason] reason
+          #
+          # @return [self]
+          #
+          def with_reason(reason)
+            @reason = reason
+            self
+          end
+
+          #
+          # @return [TextDataExtractionRecommendation]
+          #
+          def build
+            TextDataExtractionRecommendation.new(@value, @reason)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti_sandbox/doc_scan/request/task_results.rb

@@ -7,14 +7,25 @@ module Yoti
         class TaskResults
           #
           # @param [Array<DocumentTextDataExtractionTask>] document_text_data_extraction_tasks
+          # @param [Array<SupplementaryDocumentTextDataExtractionTask>] supplementary_document_text_data_extraction_tasks
           #
-          def initialize(document_text_data_extraction_tasks)
+          def initialize(
+            document_text_data_extraction_tasks,
+            supplementary_document_text_data_extraction_tasks
+          )
             Validation.assert_is_a(
               Array,
               document_text_data_extraction_tasks,
               'document_text_data_extraction_tasks'
             )
             @document_text_data_extraction_tasks = document_text_data_extraction_tasks
+
+            Validation.assert_is_a(
+              Array,
+              supplementary_document_text_data_extraction_tasks,
+              'supplementary_document_text_data_extraction_tasks'
+            )
+            @supplementary_document_text_data_extraction_tasks = supplementary_document_text_data_extraction_tasks
           end
 
           def self.builder
@@ -27,7 +38,8 @@ module Yoti
 
           def as_json(*_args)
             {
-              Yoti::DocScan::Constants::ID_DOCUMENT_TEXT_DATA_EXTRACTION => @document_text_data_extraction_tasks
+              ID_DOCUMENT_TEXT_DATA_EXTRACTION: @document_text_data_extraction_tasks,
+              SUPPLEMENTARY_DOCUMENT_TEXT_DATA_EXTRACTION: @supplementary_document_text_data_extraction_tasks
             }
           end
         end
@@ -35,6 +47,7 @@ module Yoti
         class TaskResultsBuilder
           def initialize
             @document_text_data_extraction_tasks = []
+            @supplementary_document_text_data_extraction_tasks = []
           end
 
           #
@@ -52,11 +65,29 @@ module Yoti
             self
           end
 
+          #
+          # @param [SupplementaryDocumentTextDataExtractionTask] supplementary_document_text_data_extraction_task
+          #
+          # @return [self]
+          #
+          def with_supplementary_document_text_data_extraction_task(supplementary_document_text_data_extraction_task)
+            Validation.assert_is_a(
+              SupplementaryDocumentTextDataExtractionTask,
+              supplementary_document_text_data_extraction_task,
+              'supplementary_document_text_data_extraction_task'
+            )
+            @supplementary_document_text_data_extraction_tasks << supplementary_document_text_data_extraction_task
+            self
+          end
+
           #
           # @return [TaskResults]
           #
           def build
-            TaskResults.new(@document_text_data_extraction_tasks)
+            TaskResults.new(
+              @document_text_data_extraction_tasks,
+              @supplementary_document_text_data_extraction_tasks
+            )
           end
         end
       end

data/lib/yoti_sandbox/profile/extra_data.rb

@@ -41,7 +41,7 @@ module Yoti
         # @param [#as_json] value
         #
         def initialize(type, value)
-          raise(TypeError, "#{self.class} cannot be instantiated") if self.class == DataEntry
+          raise(TypeError, "#{self.class} cannot be instantiated") if instance_of?(DataEntry)
 
           Validation.assert_is_a(String, type, 'type')
           @type = type

data/yoti_sandbox.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'yoti_sandbox'
-  spec.version       = '1.3.0'
+  spec.version       = '1.4.0'
   spec.authors       = ['Yoti']
   spec.email         = ['websdk@yoti.com']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yoti_sandbox
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Yoti
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-22 00:00:00.000000000 Z
+date: 2020-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yoti
@@ -148,11 +148,16 @@ files:
 - lib/yoti_sandbox/doc_scan/request/check/report/breakdown.rb
 - lib/yoti_sandbox/doc_scan/request/check/report/detail.rb
 - lib/yoti_sandbox/doc_scan/request/check/report/recommendation.rb
+- lib/yoti_sandbox/doc_scan/request/check/supplementary_document_text_data_check.rb
 - lib/yoti_sandbox/doc_scan/request/check/zoom_liveness_check.rb
 - lib/yoti_sandbox/doc_scan/request/check_reports.rb
 - lib/yoti_sandbox/doc_scan/request/document_filter.rb
 - lib/yoti_sandbox/doc_scan/request/response_config.rb
+- lib/yoti_sandbox/doc_scan/request/task/document_id_photo.rb
 - lib/yoti_sandbox/doc_scan/request/task/document_text_data_extraction_task.rb
+- lib/yoti_sandbox/doc_scan/request/task/supplementary_document_text_data_extraction_task.rb
+- lib/yoti_sandbox/doc_scan/request/task/text_data_extraction_reason.rb
+- lib/yoti_sandbox/doc_scan/request/task/text_data_extraction_recommendation.rb
 - lib/yoti_sandbox/doc_scan/request/task_results.rb
 - lib/yoti_sandbox/profile.rb
 - lib/yoti_sandbox/profile/age_verification.rb