Class: ThePlaidApi::IdentityDocumentUploadRiskInsights

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

Overview

Object representing fraud risk data of the uploaded document. Only provided when using Identity Document Upload with Fraud Risk enabled.

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(risk_summary: SKIP, risk_signals: SKIP, additional_properties: nil) ⇒ IdentityDocumentUploadRiskInsights

Returns a new instance of IdentityDocumentUploadRiskInsights.



42
43
44
45
46
47
48
49
50
 
# File 'lib/the_plaid_api/models/identity_document_upload_risk_insights.rb', line 42

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

  @risk_summary = risk_summary unless risk_summary == SKIP
  @risk_signals = risk_signals unless risk_signals == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#risk_signals ⇒ Array[IdentityDocumentUploadRiskSignal]

An array of risk signals.

Returns:



19
20
21
 
# File 'lib/the_plaid_api/models/identity_document_upload_risk_insights.rb', line 19

def risk_signals
  @risk_signals
end

#risk_summary ⇒ IdentityDocumentUploadRiskSummary

Risk summary of an uploaded document.

Returns:



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

def risk_summary
  @risk_summary
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



53
54
55
56
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
 
# File 'lib/the_plaid_api/models/identity_document_upload_risk_insights.rb', line 53

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  risk_summary = IdentityDocumentUploadRiskSummary.from_hash(hash['risk_summary']) if
    hash['risk_summary']
  # 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 << (IdentityDocumentUploadRiskSignal.from_hash(structure) if structure)
    end
  end

  risk_signals = SKIP unless hash.key?('risk_signals')

  # 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.
  IdentityDocumentUploadRiskInsights.new(risk_summary: risk_summary,
                                         risk_signals: risk_signals,
                                         additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



22
23
24
25
26
27
 
# File 'lib/the_plaid_api/models/identity_document_upload_risk_insights.rb', line 22

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

.nullables ⇒ Object

An array for nullable fields



38
39
40
 
# File 'lib/the_plaid_api/models/identity_document_upload_risk_insights.rb', line 38

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



30
31
32
33
34
35
 
# File 'lib/the_plaid_api/models/identity_document_upload_risk_insights.rb', line 30

def self.optionals
  %w[
    risk_summary
    risk_signals
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



91
92
93
94
95
 
# File 'lib/the_plaid_api/models/identity_document_upload_risk_insights.rb', line 91

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



84
85
86
87
88
 
# File 'lib/the_plaid_api/models/identity_document_upload_risk_insights.rb', line 84

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