Class: ThePlaidApi::PayrollRiskSignalsItem

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

Overview

Object containing fraud risk data pertaining to the Item linked as part of the verification.

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(item_id:, verification_risk_signals:, additional_properties: nil) ⇒ PayrollRiskSignalsItem

Returns a new instance of PayrollRiskSignalsItem.



40
41
42
43
44
45
46
47
48
 
# File 'lib/the_plaid_api/models/payroll_risk_signals_item.rb', line 40

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

  @item_id = item_id
  @verification_risk_signals = verification_risk_signals
  @additional_properties = additional_properties
end

Instance Attribute Details

#item_id ⇒ String

The ‘item_id` of the Item associated with this webhook, warning, or error

Returns:

  • (String) 


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

def item_id
  @item_id
end

#verification_risk_signals ⇒ Array[DocumentRiskSignalsObject]

Array of payroll income document authenticity data retrieved for each of the user’s accounts.

Returns:



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

def verification_risk_signals
  @verification_risk_signals
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



51
52
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
 
# File 'lib/the_plaid_api/models/payroll_risk_signals_item.rb', line 51

def self.from_hash(hash)
  return nil unless hash

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

  verification_risk_signals = nil unless hash.key?('verification_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.
  PayrollRiskSignalsItem.new(item_id: item_id,
                             verification_risk_signals: verification_risk_signals,
                             additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

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

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



31
32
33
 
# File 'lib/the_plaid_api/models/payroll_risk_signals_item.rb', line 31

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



88
89
90
91
92
 
# File 'lib/the_plaid_api/models/payroll_risk_signals_item.rb', line 88

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



81
82
83
84
85
 
# File 'lib/the_plaid_api/models/payroll_risk_signals_item.rb', line 81

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