Class: Plaid::AccountsBalanceGetResponsePaymentRiskAssessment

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb

Overview

This object provides detailed risk assessment for the requested transaction

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AccountsBalanceGetResponsePaymentRiskAssessment

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb', line 74

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::AccountsBalanceGetResponsePaymentRiskAssessment` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::AccountsBalanceGetResponsePaymentRiskAssessment`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'risk_level')
    self.risk_level = attributes[:'risk_level']
  end

  if attributes.key?(:'attributes')
    self.attributes = attributes[:'attributes']
  end

  if attributes.key?(:'score')
    self.score = attributes[:'score']
  end

  if attributes.key?(:'balance_last_updated')
    self.balance_last_updated = attributes[:'balance_last_updated']
  end

  if attributes.key?(:'risk_reasons')
    if (value = attributes[:'risk_reasons']).is_a?(Array)
      self.risk_reasons = value
    end
  end

  if attributes.key?(:'exceeds_balance_threshold')
    self.exceeds_balance_threshold = attributes[:'exceeds_balance_threshold']
  end
end

Instance Attribute Details

#attributes ⇒ Object

Returns the value of attribute attributes.



22
23
24
 
# File 'lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb', line 22

def attributes
  @attributes
end

#balance_last_updated ⇒ Object

Timestamp of the last successful balance update, in [ISO 8601](wikipedia.org/wiki/ISO_8601) format.



28
29
30
 
# File 'lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb', line 28

def balance_last_updated
  @balance_last_updated
end

#exceeds_balance_threshold ⇒ Object

This boolean field denotes if the requested ACH debit amount exceeds the calculated threshold based on either the available or current balance of the bank account. Specifically, it checks if the amount is greater than the account balance multiplied by "balance_threshold_percentage"/100. In cases where available_balance is not accessible, current_balance is used. This field is particularly useful for clients handling indirect items who lack direct access to raw balance data.



34
35
36
 
# File 'lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb', line 34

def exceeds_balance_threshold
  @exceeds_balance_threshold
end

#risk_level ⇒ Object

A five-tier risk assessment for the transaction, based on the probability of ACH returns, measured by the incident rate.



20
21
22
 
# File 'lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb', line 20

def risk_level
  @risk_level
end

#risk_reasons ⇒ Object

An array of objects, each representing a specific reason contributing to the risk assessment of an ACH transaction. This field is particularly useful for understanding risk factors affecting the risk level assigned to a transaction classified as “high”, “medium-high”, and “medium” risk.



31
32
33
 
# File 'lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb', line 31

def risk_reasons
  @risk_reasons
end

#score ⇒ Object

A risk score ranging from 1-99, reflecting the likelihood of ACH debit return. A higher score indicates a greater risk of return, often due to overdrawn accounts or account ineligibility to receive ACH transactions. Typical return codes include "R01", "R02", "R03", "R04", "R06", "R08", "R09", "R13", "R16", "R17", "R20", "R23", etc., with a turnaround of 2 banking days.



25
26
27
 
# File 'lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb', line 25

def score
  @score
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



49
50
51
 
# File 'lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb', line 49

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb', line 37

def self.attribute_map
  {
    :'risk_level' => :'risk_level',
    :'attributes' => :'attributes',
    :'score' => :'score',
    :'balance_last_updated' => :'balance_last_updated',
    :'risk_reasons' => :'risk_reasons',
    :'exceeds_balance_threshold' => :'exceeds_balance_threshold'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



181
182
183
 
# File 'lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb', line 181

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



66
67
68
69
70
 
# File 'lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb', line 66

def self.openapi_nullable
  Set.new([
    :'score',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb', line 54

def self.openapi_types
  {
    :'risk_level' => :'String',
    :'attributes' => :'BalancePlusAttributes',
    :'score' => :'Integer',
    :'balance_last_updated' => :'Time',
    :'risk_reasons' => :'Array<RiskReason>',
    :'exceeds_balance_threshold' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



155
156
157
158
159
160
161
162
163
164
 
# File 'lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb', line 155

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      risk_level == o.risk_level &&
      attributes == o.attributes &&
      score == o.score &&
      balance_last_updated == o.balance_last_updated &&
      risk_reasons == o.risk_reasons &&
      exceeds_balance_threshold == o.exceeds_balance_threshold
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb', line 212

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Plaid.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb', line 283

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb', line 188

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


168
169
170
 
# File 'lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb', line 168

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



174
175
176
 
# File 'lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb', line 174

def hash
  [risk_level, attributes, score, balance_last_updated, risk_reasons, exceeds_balance_threshold].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb', line 116

def list_invalid_properties
  invalid_properties = Array.new
  if !@score.nil? && @score > 99
    invalid_properties.push('invalid value for "score", must be smaller than or equal to 99.')
  end

  if !@score.nil? && @score < 1
    invalid_properties.push('invalid value for "score", must be greater than or equal to 1.')
  end


  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



259
260
261
 
# File 'lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb', line 259

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb', line 265

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



253
254
255
 
# File 'lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb', line 253

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



132
133
134
135
136
 
# File 'lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb', line 132

def valid?
  return false if !@score.nil? && @score > 99
  return false if !@score.nil? && @score < 1
  true
end