Class: ThePlaidApi::SignalEvaluateScores

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

Overview

Risk scoring details broken down by risk category. When using a Balance-only ruleset, this object will not be returned.

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(customer_initiated_return_risk: SKIP, bank_initiated_return_risk: SKIP, additional_properties: nil) ⇒ SignalEvaluateScores

Returns a new instance of SignalEvaluateScores.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/the_plaid_api/models/signal_evaluate_scores.rb', line 52

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

  unless customer_initiated_return_risk == SKIP
    @customer_initiated_return_risk =
      customer_initiated_return_risk
  end
  unless bank_initiated_return_risk == SKIP
    @bank_initiated_return_risk =
      bank_initiated_return_risk
  end
  @additional_properties = additional_properties
end

Instance Attribute Details

#bank_initiated_return_risk ⇒ BankInitiatedReturnRisk

The object contains a risk score and a risk tier that evaluate the transaction return risk because an account is overdrawn or because an ineligible account is used. Common return codes in this category include: “R01”, “R02”, “R03”, “R04”, “R06”, “R08”, “R09”, “R13”, “R16”, “R17”, “R20”, “R23”. These returns have a turnaround time of 2 banking days.

Returns:



28
29
30
 
# File 'lib/the_plaid_api/models/signal_evaluate_scores.rb', line 28

def bank_initiated_return_risk
  @bank_initiated_return_risk
end

#customer_initiated_return_risk ⇒ CustomerInitiatedReturnRisk

The object contains a risk score and a risk tier that evaluate the transaction return risk of an unauthorized debit. Common return codes in this category include: “R05”, “R07”, “R10”, “R11”, “R29”. These returns typically have a return time frame of up to 60 calendar days. During this period, the customer of financial institutions can dispute a transaction as unauthorized.

Returns:



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

def customer_initiated_return_risk
  @customer_initiated_return_risk
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/the_plaid_api/models/signal_evaluate_scores.rb', line 69

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  if hash['customer_initiated_return_risk']
    customer_initiated_return_risk = CustomerInitiatedReturnRisk.from_hash(hash['customer_initiated_return_risk'])
  end
  if hash['bank_initiated_return_risk']
    bank_initiated_return_risk = BankInitiatedReturnRisk.from_hash(hash['bank_initiated_return_risk'])
  end

  # 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.
  SignalEvaluateScores.new(customer_initiated_return_risk: customer_initiated_return_risk,
                           bank_initiated_return_risk: bank_initiated_return_risk,
                           additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



31
32
33
34
35
36
37
 
# File 'lib/the_plaid_api/models/signal_evaluate_scores.rb', line 31

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

.nullables ⇒ Object

An array for nullable fields



48
49
50
 
# File 'lib/the_plaid_api/models/signal_evaluate_scores.rb', line 48

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    customer_initiated_return_risk
    bank_initiated_return_risk
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



102
103
104
105
106
107
 
# File 'lib/the_plaid_api/models/signal_evaluate_scores.rb', line 102

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



94
95
96
97
98
99
 
# File 'lib/the_plaid_api/models/signal_evaluate_scores.rb', line 94

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