Class: FuseClient::FinanceScore

Inherits:
Object
  • Object
show all
Defined in:
lib/fuse_client/models/finance_score.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FinanceScore

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
113
114
115
116
117
118
 
# File 'lib/fuse_client/models/finance_score.rb', line 78

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FuseClient::FinanceScore` 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 `FuseClient::FinanceScore`. 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?(:'value')
    self.value = attributes[:'value']
  end

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

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

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

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

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

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

Instance Attribute Details

#activity_age_score ⇒ Object

This measures the regularity of a user’s financial activity over a period of time. A lower score suggests limited activity, while a higher score is indicative of regular daily transactions over a long period of time.



28
29
30
 
# File 'lib/fuse_client/models/finance_score.rb', line 28

def activity_age_score
  @activity_age_score
end

#expense_stability_score ⇒ Object

This assesses the consistency of a user’s monthly spending. A lower score indicates variable monthly expenditure, while a higher score represents consistent spending habits.



25
26
27
 
# File 'lib/fuse_client/models/finance_score.rb', line 25

def expense_stability_score
  @expense_stability_score
end

#income_score ⇒ Object

This evaluates the stability of a user’s income. A lower score suggests inconsistent or low income, while a higher score represents high, consistent income.



31
32
33
 
# File 'lib/fuse_client/models/finance_score.rb', line 31

def income_score
  @income_score
end

#loan_payments_score ⇒ Object

This evaluates a user’s loan repayment behaviour. A lower score is assigned to those without loan payments, while a higher score denotes consistent loan payments, such as a mortgage.



34
35
36
 
# File 'lib/fuse_client/models/finance_score.rb', line 34

def loan_payments_score
  @loan_payments_score
end

#repayments_score ⇒ Object

This quantifies a user’s ability to repay debts. A lower score corresponds to missed payments, while a higher score signifies consistent debt repayment.



37
38
39
 
# File 'lib/fuse_client/models/finance_score.rb', line 37

def repayments_score
  @repayments_score
end

#savings_score ⇒ Object

This quantifies a user’s monthly savings habits. A lower score represents minimal savings, while a higher score indicates a user who consistently sets aside a substantial portion of their income.



22
23
24
 
# File 'lib/fuse_client/models/finance_score.rb', line 22

def savings_score
  @savings_score
end

#value ⇒ Object

The likelihood of a credit default. A higher score implies lower risk. The finance score and all finance score metrics are values between 0 and 1. This value is calculated by the weighted sum of the metrics below.



19
20
21
 
# File 'lib/fuse_client/models/finance_score.rb', line 19

def value
  @value
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



53
54
55
 
# File 'lib/fuse_client/models/finance_score.rb', line 53

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/fuse_client/models/finance_score.rb', line 40

def self.attribute_map
  {
    :'value' => :'value',
    :'savings_score' => :'savings_score',
    :'expense_stability_score' => :'expense_stability_score',
    :'activity_age_score' => :'activity_age_score',
    :'income_score' => :'income_score',
    :'loan_payments_score' => :'loan_payments_score',
    :'repayments_score' => :'repayments_score'
  }
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



197
198
199
 
# File 'lib/fuse_client/models/finance_score.rb', line 197

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



71
72
73
74
 
# File 'lib/fuse_client/models/finance_score.rb', line 71

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/fuse_client/models/finance_score.rb', line 58

def self.openapi_types
  {
    :'value' => :'Float',
    :'savings_score' => :'Float',
    :'expense_stability_score' => :'Float',
    :'activity_age_score' => :'Float',
    :'income_score' => :'Float',
    :'loan_payments_score' => :'Float',
    :'repayments_score' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/fuse_client/models/finance_score.rb', line 170

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      value == o.value &&
      savings_score == o.savings_score &&
      expense_stability_score == o.expense_stability_score &&
      activity_age_score == o.activity_age_score &&
      income_score == o.income_score &&
      loan_payments_score == o.loan_payments_score &&
      repayments_score == o.repayments_score
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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/fuse_client/models/finance_score.rb', line 228

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 = FuseClient.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



299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/fuse_client/models/finance_score.rb', line 299

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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/fuse_client/models/finance_score.rb', line 204

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


184
185
186
 
# File 'lib/fuse_client/models/finance_score.rb', line 184

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



190
191
192
 
# File 'lib/fuse_client/models/finance_score.rb', line 190

def hash
  [value, savings_score, expense_stability_score, activity_age_score, income_score, loan_payments_score, repayments_score].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



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/fuse_client/models/finance_score.rb', line 122

def list_invalid_properties
  invalid_properties = Array.new
  if @value.nil?
    invalid_properties.push('invalid value for "value", value cannot be nil.')
  end

  if @savings_score.nil?
    invalid_properties.push('invalid value for "savings_score", savings_score cannot be nil.')
  end

  if @expense_stability_score.nil?
    invalid_properties.push('invalid value for "expense_stability_score", expense_stability_score cannot be nil.')
  end

  if @activity_age_score.nil?
    invalid_properties.push('invalid value for "activity_age_score", activity_age_score cannot be nil.')
  end

  if @income_score.nil?
    invalid_properties.push('invalid value for "income_score", income_score cannot be nil.')
  end

  if @loan_payments_score.nil?
    invalid_properties.push('invalid value for "loan_payments_score", loan_payments_score cannot be nil.')
  end

  if @repayments_score.nil?
    invalid_properties.push('invalid value for "repayments_score", repayments_score cannot be nil.')
  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



275
276
277
 
# File 'lib/fuse_client/models/finance_score.rb', line 275

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



281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/fuse_client/models/finance_score.rb', line 281

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



269
270
271
 
# File 'lib/fuse_client/models/finance_score.rb', line 269

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



157
158
159
160
161
162
163
164
165
166
 
# File 'lib/fuse_client/models/finance_score.rb', line 157

def valid?
  return false if @value.nil?
  return false if @savings_score.nil?
  return false if @expense_stability_score.nil?
  return false if @activity_age_score.nil?
  return false if @income_score.nil?
  return false if @loan_payments_score.nil?
  return false if @repayments_score.nil?
  true
end