Class: ThePlaidApi::DocumentRiskSignalsObject

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

Overview

Object containing fraud risk data for a set of income documents.

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(account_id:, single_document_risk_signals:, multi_document_risk_signals:, additional_properties: nil) ⇒ DocumentRiskSignalsObject

Returns a new instance of DocumentRiskSignalsObject.



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

def initialize(account_id:, single_document_risk_signals:,
               multi_document_risk_signals:, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @account_id = 
  @single_document_risk_signals = single_document_risk_signals
  @multi_document_risk_signals = multi_document_risk_signals
  @additional_properties = additional_properties
end

Instance Attribute Details

#account_id ⇒ String

ID of the payroll provider account.

Returns:

  • (String) 


14
15
16
 
# File 'lib/the_plaid_api/models/document_risk_signals_object.rb', line 14

def 
  @account_id
end

#multi_document_risk_signals ⇒ Array[MultiDocumentRiskSignal]

Array of risk signals computed from a set of uploaded documents and the associated documents’ metadata

Returns:



23
24
25
 
# File 'lib/the_plaid_api/models/document_risk_signals_object.rb', line 23

def multi_document_risk_signals
  @multi_document_risk_signals
end

#single_document_risk_signals ⇒ Array[SingleDocumentRiskSignal]

Array of document metadata and associated risk signals per document

Returns:



18
19
20
 
# File 'lib/the_plaid_api/models/document_risk_signals_object.rb', line 18

def single_document_risk_signals
  @single_document_risk_signals
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
88
89
90
91
92
93
94
95
96
 
# File 'lib/the_plaid_api/models/document_risk_signals_object.rb', line 58

def self.from_hash(hash)
  return nil unless hash

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

  single_document_risk_signals = nil unless hash.key?('single_document_risk_signals')
  # Parameter is an array, so we need to iterate through it
  multi_document_risk_signals = nil
  unless hash['multi_document_risk_signals'].nil?
    multi_document_risk_signals = []
    hash['multi_document_risk_signals'].each do |structure|
      multi_document_risk_signals << (MultiDocumentRiskSignal.from_hash(structure) if structure)
    end
  end

  multi_document_risk_signals = nil unless hash.key?('multi_document_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.
  DocumentRiskSignalsObject.new(account_id: ,
                                single_document_risk_signals: single_document_risk_signals,
                                multi_document_risk_signals: multi_document_risk_signals,
                                additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['account_id'] = 'account_id'
  @_hash['single_document_risk_signals'] = 'single_document_risk_signals'
  @_hash['multi_document_risk_signals'] = 'multi_document_risk_signals'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



40
41
42
43
44
 
# File 'lib/the_plaid_api/models/document_risk_signals_object.rb', line 40

def self.nullables
  %w[
    account_id
  ]
end

.optionals ⇒ Object

An array for optional fields



35
36
37
 
# File 'lib/the_plaid_api/models/document_risk_signals_object.rb', line 35

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



107
108
109
110
111
112
113
 
# File 'lib/the_plaid_api/models/document_risk_signals_object.rb', line 107

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



99
100
101
102
103
104
 
# File 'lib/the_plaid_api/models/document_risk_signals_object.rb', line 99

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