Class: Yoti::Sandbox::DocScan::Request::Recommendation

Inherits:
Object
  • Object
show all
Defined in:
lib/yoti_sandbox/doc_scan/request/check/report/recommendation.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(value, reason, recovery_suggestion) ⇒ Recommendation

Returns a new instance of Recommendation.

Parameters:

  • value (String)
  • reason (String)
  • recovery_suggestion (String) 


13
14
15
16
17
18
19
20
21
22
 
# File 'lib/yoti_sandbox/doc_scan/request/check/report/recommendation.rb', line 13

def initialize(value, reason, recovery_suggestion)
  Validation.assert_is_a(String, value, 'value')
  @value = value

  Validation.assert_is_a(String, reason, 'reason', true)
  @reason = reason

  Validation.assert_is_a(String, recovery_suggestion, 'recovery_suggestion', true)
  @recovery_suggestion = recovery_suggestion
end

Class Method Details

.builder ⇒ RecommendationBuilder

Returns:



39
40
41
 
# File 'lib/yoti_sandbox/doc_scan/request/check/report/recommendation.rb', line 39

def self.builder
  RecommendationBuilder.new
end

Instance Method Details

#as_json(*_args) ⇒ Object 



24
25
26
27
28
29
30
 
# File 'lib/yoti_sandbox/doc_scan/request/check/report/recommendation.rb', line 24

def as_json(*_args)
  {
    value: @value,
    reason: @reason,
    recovery_suggestion: @recovery_suggestion
  }.compact
end

#to_json(*_args) ⇒ Object 



32
33
34
 
# File 'lib/yoti_sandbox/doc_scan/request/check/report/recommendation.rb', line 32

def to_json(*_args)
  as_json.to_json
end