Class: Yoti::DocScan::Session::Create::RequestedTask

Inherits:
Object
  • Object
show all
Defined in:
lib/yoti/doc_scan/session/create/requested_task.rb

Overview

Requests creation of a Task to be performed on each document

Instance Method Summary collapse

Constructor Details

#initialize(type, config) ⇒ RequestedTask

Returns a new instance of RequestedTask.

Parameters:

  • type (String) —

    The type of the Task to create

  • config (#as_json) —

    Configuration to apply to the Task

Raises:

  • (TypeError) 


15
16
17
18
19
20
21
22
23
 
# File 'lib/yoti/doc_scan/session/create/requested_task.rb', line 15

def initialize(type, config)
  raise(TypeError, "#{self.class} cannot be instantiated") if instance_of?(RequestedTask)

  Validation.assert_is_a(String, type, 'type')
  @type = type

  Validation.assert_respond_to(:as_json, config, 'config')
  @config = config
end

Instance Method Details

#as_json(*_args) ⇒ Object 



29
30
31
32
33
34
 
# File 'lib/yoti/doc_scan/session/create/requested_task.rb', line 29

def as_json(*_args)
  {
    type: @type,
    config: @config.as_json
  }
end

#to_json(*_args) ⇒ Object 



25
26
27
 
# File 'lib/yoti/doc_scan/session/create/requested_task.rb', line 25

def to_json(*_args)
  as_json.to_json
end