Class: ThePlaidApi::CraPartnerInsightsUltraFicoScore

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

Overview

The calculated UltraFICO score.

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(score:, reason_code_1: SKIP, reason_code_2: SKIP, reason_code_3: SKIP, reason_code_4: SKIP, positive_reason_code_1: SKIP, positive_reason_code_2: SKIP, positive_reason_code_3: SKIP, positive_reason_code_4: SKIP, did_inquiries_adversely_affect_score: SKIP, additional_properties: nil) ⇒ CraPartnerInsightsUltraFicoScore

Returns a new instance of CraPartnerInsightsUltraFicoScore.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score.rb', line 105

def initialize(score:, reason_code_1: SKIP, reason_code_2: SKIP,
               reason_code_3: SKIP, reason_code_4: SKIP,
               positive_reason_code_1: SKIP, positive_reason_code_2: SKIP,
               positive_reason_code_3: SKIP, positive_reason_code_4: SKIP,
               did_inquiries_adversely_affect_score: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @ultrafico_score_version = '1.0'
  @score = score
  @reason_code_1 = reason_code_1 unless reason_code_1 == SKIP
  @reason_code_2 = reason_code_2 unless reason_code_2 == SKIP
  @reason_code_3 = reason_code_3 unless reason_code_3 == SKIP
  @reason_code_4 = reason_code_4 unless reason_code_4 == SKIP
  @positive_reason_code_1 = positive_reason_code_1 unless positive_reason_code_1 == SKIP
  @positive_reason_code_2 = positive_reason_code_2 unless positive_reason_code_2 == SKIP
  @positive_reason_code_3 = positive_reason_code_3 unless positive_reason_code_3 == SKIP
  @positive_reason_code_4 = positive_reason_code_4 unless positive_reason_code_4 == SKIP
  unless did_inquiries_adversely_affect_score == SKIP
    @did_inquiries_adversely_affect_score =
      did_inquiries_adversely_affect_score
  end
  @additional_properties = additional_properties
end

Instance Attribute Details

#did_inquiries_adversely_affect_score ⇒ TrueClass | FalseClass

Whether inquiries adversely affected the score but were not represented in one of the four reason codes. Sometimes referred to as the FACTA Flag.

Returns:

  • (TrueClass | FalseClass) 


55
56
57
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score.rb', line 55

def did_inquiries_adversely_affect_score
  @did_inquiries_adversely_affect_score
end

#positive_reason_code_1 ⇒ String

The first positive reason code associated with the score.

Returns:

  • (String) 


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

def positive_reason_code_1
  @positive_reason_code_1
end

#positive_reason_code_2 ⇒ String

The second positive reason code associated with the score.

Returns:

  • (String) 


42
43
44
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score.rb', line 42

def positive_reason_code_2
  @positive_reason_code_2
end

#positive_reason_code_3 ⇒ String

The third positive reason code associated with the score.

Returns:

  • (String) 


46
47
48
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score.rb', line 46

def positive_reason_code_3
  @positive_reason_code_3
end

#positive_reason_code_4 ⇒ String

The fourth positive reason code associated with the score.

Returns:

  • (String) 


50
51
52
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score.rb', line 50

def positive_reason_code_4
  @positive_reason_code_4
end

#reason_code_1 ⇒ String

The first reason code associated with the score.

Returns:

  • (String) 


22
23
24
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score.rb', line 22

def reason_code_1
  @reason_code_1
end

#reason_code_2 ⇒ String

The second reason code associated with the score.

Returns:

  • (String) 


26
27
28
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score.rb', line 26

def reason_code_2
  @reason_code_2
end

#reason_code_3 ⇒ String

The third reason code associated with the score.

Returns:

  • (String) 


30
31
32
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score.rb', line 30

def reason_code_3
  @reason_code_3
end

#reason_code_4 ⇒ String

The fourth reason code associated with the score.

Returns:

  • (String) 


34
35
36
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score.rb', line 34

def reason_code_4
  @reason_code_4
end

#score ⇒ Integer

Numeric value of the UltraFICO score.

Returns:

  • (Integer) 


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

def score
  @score
end

#ultrafico_score_version ⇒ String (readonly)

The version of the UltraFICO score.

Returns:

  • (String) 


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

def ultrafico_score_version
  @ultrafico_score_version
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score.rb', line 132

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  score = hash.key?('score') ? hash['score'] : nil
  reason_code_1 = hash.key?('reason_code_1') ? hash['reason_code_1'] : SKIP
  reason_code_2 = hash.key?('reason_code_2') ? hash['reason_code_2'] : SKIP
  reason_code_3 = hash.key?('reason_code_3') ? hash['reason_code_3'] : SKIP
  reason_code_4 = hash.key?('reason_code_4') ? hash['reason_code_4'] : SKIP
  positive_reason_code_1 =
    hash.key?('positive_reason_code_1') ? hash['positive_reason_code_1'] : SKIP
  positive_reason_code_2 =
    hash.key?('positive_reason_code_2') ? hash['positive_reason_code_2'] : SKIP
  positive_reason_code_3 =
    hash.key?('positive_reason_code_3') ? hash['positive_reason_code_3'] : SKIP
  positive_reason_code_4 =
    hash.key?('positive_reason_code_4') ? hash['positive_reason_code_4'] : SKIP
  did_inquiries_adversely_affect_score =
    hash.key?('did_inquiries_adversely_affect_score') ? hash['did_inquiries_adversely_affect_score'] : SKIP

  # 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.
  CraPartnerInsightsUltraFicoScore.new(score: score,
                                       reason_code_1: reason_code_1,
                                       reason_code_2: reason_code_2,
                                       reason_code_3: reason_code_3,
                                       reason_code_4: reason_code_4,
                                       positive_reason_code_1: positive_reason_code_1,
                                       positive_reason_code_2: positive_reason_code_2,
                                       positive_reason_code_3: positive_reason_code_3,
                                       positive_reason_code_4: positive_reason_code_4,
                                       did_inquiries_adversely_affect_score: did_inquiries_adversely_affect_score,
                                       additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score.rb', line 58

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['ultrafico_score_version'] = 'ultrafico_score_version'
  @_hash['score'] = 'score'
  @_hash['reason_code_1'] = 'reason_code_1'
  @_hash['reason_code_2'] = 'reason_code_2'
  @_hash['reason_code_3'] = 'reason_code_3'
  @_hash['reason_code_4'] = 'reason_code_4'
  @_hash['positive_reason_code_1'] = 'positive_reason_code_1'
  @_hash['positive_reason_code_2'] = 'positive_reason_code_2'
  @_hash['positive_reason_code_3'] = 'positive_reason_code_3'
  @_hash['positive_reason_code_4'] = 'positive_reason_code_4'
  @_hash['did_inquiries_adversely_affect_score'] =
    'did_inquiries_adversely_affect_score'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score.rb', line 91

def self.nullables
  %w[
    reason_code_1
    reason_code_2
    reason_code_3
    reason_code_4
    positive_reason_code_1
    positive_reason_code_2
    positive_reason_code_3
    positive_reason_code_4
    did_inquiries_adversely_affect_score
  ]
end

.optionals ⇒ Object

An array for optional fields



76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score.rb', line 76

def self.optionals
  %w[
    reason_code_1
    reason_code_2
    reason_code_3
    reason_code_4
    positive_reason_code_1
    positive_reason_code_2
    positive_reason_code_3
    positive_reason_code_4
    did_inquiries_adversely_affect_score
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score.rb', line 187

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} ultrafico_score_version: #{@ultrafico_score_version.inspect}, score:"\
  " #{@score.inspect}, reason_code_1: #{@reason_code_1.inspect}, reason_code_2:"\
  " #{@reason_code_2.inspect}, reason_code_3: #{@reason_code_3.inspect}, reason_code_4:"\
  " #{@reason_code_4.inspect}, positive_reason_code_1: #{@positive_reason_code_1.inspect},"\
  " positive_reason_code_2: #{@positive_reason_code_2.inspect}, positive_reason_code_3:"\
  " #{@positive_reason_code_3.inspect}, positive_reason_code_4:"\
  " #{@positive_reason_code_4.inspect}, did_inquiries_adversely_affect_score:"\
  " #{@did_inquiries_adversely_affect_score.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score.rb', line 174

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} ultrafico_score_version: #{@ultrafico_score_version}, score: #{@score},"\
  " reason_code_1: #{@reason_code_1}, reason_code_2: #{@reason_code_2}, reason_code_3:"\
  " #{@reason_code_3}, reason_code_4: #{@reason_code_4}, positive_reason_code_1:"\
  " #{@positive_reason_code_1}, positive_reason_code_2: #{@positive_reason_code_2},"\
  " positive_reason_code_3: #{@positive_reason_code_3}, positive_reason_code_4:"\
  " #{@positive_reason_code_4}, did_inquiries_adversely_affect_score:"\
  " #{@did_inquiries_adversely_affect_score}, additional_properties:"\
  " #{@additional_properties}>"
end