Class: Yoti::Sandbox::DocScan::Request::DocumentCheck

Inherits:

Check

• Object
• Check
• Yoti::Sandbox::DocScan::Request::DocumentCheck

Defined in:

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

Direct Known Subclasses

DocumentAuthenticityCheck, DocumentFaceMatchCheck, DocumentTextDataCheck, SupplementaryDocumentTextDataCheck

Instance Method Summary

• #as_json(*_args) ⇒ Object
• #initialize(result, document_filter) ⇒ DocumentCheck constructor

  A new instance of DocumentCheck.

Methods inherited from Check

#to_json

Constructor Details

#initialize(result, document_filter) ⇒ DocumentCheck

Returns a new instance of DocumentCheck.

Parameters:

• result (CheckResult)
• document_filter (DocumentFilter)

Raises:

• (TypeError)

# File 'lib/yoti_sandbox/doc_scan/request/check/document_check.rb', line 12

def initialize(result, document_filter)
  raise(TypeError, "#{self.class} cannot be instantiated") if instance_of?(DocumentCheck)

  super(result)

  Validation.assert_is_a(DocumentFilter, document_filter, 'document_filter', true)
  @document_filter = document_filter
end

Instance Method Details

#as_json(*_args) ⇒ Object

# File 'lib/yoti_sandbox/doc_scan/request/check/document_check.rb', line 21

def as_json(*_args)
  json = super
  json[:document_filter] = @document_filter.as_json unless @document_filter.nil?
  json
end