Class: ThePlaidApi::SingleDocumentRiskSignal

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/the_plaid_api/models/single_document_risk_signal.rb

Overview

Object containing all risk signals and relevant metadata for a single document

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(document_reference:, risk_signals:, risk_summary:, additional_properties: nil) ⇒ SingleDocumentRiskSignal

Returns a new instance of SingleDocumentRiskSignal.



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/the_plaid_api/models/single_document_risk_signal.rb', line 45

def initialize(document_reference:, risk_signals:, risk_summary:,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @document_reference = document_reference
  @risk_signals = risk_signals
  @risk_summary = risk_summary
  @additional_properties = additional_properties
end

Instance Attribute Details

#document_reference ⇒ RiskSignalDocumentReference

Object containing metadata for the document

Returns:



15
16
17
 
# File 'lib/the_plaid_api/models/single_document_risk_signal.rb', line 15

def document_reference
  @document_reference
end

#risk_signals ⇒ Array[DocumentRiskSignal]

Array of attributes that indicate whether or not there is fraud risk with a document

Returns:



20
21
22
 
# File 'lib/the_plaid_api/models/single_document_risk_signal.rb', line 20

def risk_signals
  @risk_signals
end

#risk_summary ⇒ DocumentRiskSummary

A summary across all risk signals associated with a document

Returns:



24
25
26
 
# File 'lib/the_plaid_api/models/single_document_risk_signal.rb', line 24

def risk_summary
  @risk_summary
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/the_plaid_api/models/single_document_risk_signal.rb', line 57

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  document_reference = RiskSignalDocumentReference.from_hash(hash['document_reference']) if
    hash['document_reference']
  # Parameter is an array, so we need to iterate through it
  risk_signals = nil
  unless hash['risk_signals'].nil?
    risk_signals = []
    hash['risk_signals'].each do |structure|
      risk_signals << (DocumentRiskSignal.from_hash(structure) if structure)
    end
  end

  risk_signals = nil unless hash.key?('risk_signals')
  risk_summary = DocumentRiskSummary.from_hash(hash['risk_summary']) if hash['risk_summary']

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  SingleDocumentRiskSignal.new(document_reference: document_reference,
                               risk_signals: risk_signals,
                               risk_summary: risk_summary,
                               additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



27
28
29
30
31
32
33
 
# File 'lib/the_plaid_api/models/single_document_risk_signal.rb', line 27

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['document_reference'] = 'document_reference'
  @_hash['risk_signals'] = 'risk_signals'
  @_hash['risk_summary'] = 'risk_summary'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



41
42
43
 
# File 'lib/the_plaid_api/models/single_document_risk_signal.rb', line 41

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



36
37
38
 
# File 'lib/the_plaid_api/models/single_document_risk_signal.rb', line 36

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



97
98
99
100
101
102
 
# File 'lib/the_plaid_api/models/single_document_risk_signal.rb', line 97

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} document_reference: #{@document_reference.inspect}, risk_signals:"\
  " #{@risk_signals.inspect}, risk_summary: #{@risk_summary.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



90
91
92
93
94
 
# File 'lib/the_plaid_api/models/single_document_risk_signal.rb', line 90

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} document_reference: #{@document_reference}, risk_signals: #{@risk_signals},"\
  " risk_summary: #{@risk_summary}, additional_properties: #{@additional_properties}>"
end