Class: FuseClient::FinancialConnectionsAccountLiability

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FinancialConnectionsAccountLiability

Initializes the object

Parameters:

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

    Model attributes in the form of hash



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
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
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 155

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#aprs ⇒ Object

The various interest rates that apply to the account. If APR data is not available, this array will be empty.



44
45
46
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 44

def aprs
  @aprs
end

#balance ⇒ Object

Returns the value of attribute balance.



39
40
41
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 39

def balance
  @balance
end

#currency ⇒ Object

The ISO-4217 currency code of the account.



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

def currency
  @currency
end

#fingerprint ⇒ Object

Uniquely identifies this account across all accounts for a single financial connection. Used for reconnection deduplication. See more information here: letsfuse.readme.io/docs/duplicate-accounts



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

def fingerprint
  @fingerprint
end

#institution ⇒ Object

Returns the value of attribute institution.



27
28
29
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 27

def institution
  @institution
end

#interest_rate_percentage ⇒ Object

The interest rate on the loan as a percentage.



47
48
49
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 47

def interest_rate_percentage
  @interest_rate_percentage
end

#last_payment_amount ⇒ Object

The amount of the last payment.



59
60
61
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 59

def last_payment_amount
  @last_payment_amount
end

#last_payment_date ⇒ Object

The date of the last payment. Dates are returned in an ISO 8601 format (YYYY-MM-DD).



56
57
58
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 56

def last_payment_date
  @last_payment_date
end

#mask ⇒ Object

The partial account number.



30
31
32
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 30

def mask
  @mask
end

#minimum_payment_amount ⇒ Object

The minimum payment required for an account. This can apply to any debt account.



62
63
64
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 62

def minimum_payment_amount
  @minimum_payment_amount
end

#name ⇒ Object

The account’s name, ie ‘My Checking’



33
34
35
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 33

def name
  @name
end

#next_payment_due_date ⇒ Object

The due date for the next payment. The due date is null if a payment is not expected.



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

def next_payment_due_date
  @next_payment_due_date
end

#origination_principal_amount ⇒ Object

The original principal balance of the loan.



50
51
52
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 50

def origination_principal_amount
  @origination_principal_amount
end

#remote_data ⇒ Object

Returns the value of attribute remote_data.



41
42
43
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 41

def remote_data
  @remote_data
end

#remote_id ⇒ Object

Remote Id of the account, ie Plaid or Teller account id



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

def remote_id
  @remote_id
end

#subtype ⇒ Object

Returns the value of attribute subtype.



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

def subtype
  @subtype
end

#type ⇒ Object

Returns the value of attribute type.



35
36
37
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 35

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



110
111
112
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 110

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 87

def self.attribute_map
  {
    :'remote_id' => :'remote_id',
    :'currency' => :'currency',
    :'fingerprint' => :'fingerprint',
    :'institution' => :'institution',
    :'mask' => :'mask',
    :'name' => :'name',
    :'type' => :'type',
    :'subtype' => :'subtype',
    :'balance' => :'balance',
    :'remote_data' => :'remote_data',
    :'aprs' => :'aprs',
    :'interest_rate_percentage' => :'interest_rate_percentage',
    :'origination_principal_amount' => :'origination_principal_amount',
    :'next_payment_due_date' => :'next_payment_due_date',
    :'last_payment_date' => :'last_payment_date',
    :'last_payment_amount' => :'last_payment_amount',
    :'minimum_payment_amount' => :'minimum_payment_amount'
  }
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



321
322
323
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 321

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



146
147
148
149
150
151
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 146

def self.openapi_all_of
  [
  :'FinancialConnectionsAccount',
  :'FinancialConnectionsAccountLiabilityAllOf'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



138
139
140
141
142
143
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 138

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

.openapi_types ⇒ Object

Attribute type mapping.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 115

def self.openapi_types
  {
    :'remote_id' => :'String',
    :'currency' => :'String',
    :'fingerprint' => :'String',
    :'institution' => :'FinancialConnectionsAccountInstitution',
    :'mask' => :'String',
    :'name' => :'String',
    :'type' => :'AccountType',
    :'subtype' => :'AccountSubtype',
    :'balance' => :'FinancialConnectionsAccountCachedBalance',
    :'remote_data' => :'Object',
    :'aprs' => :'Array<FinancialConnectionsAccountLiabilityAllOfAprs>',
    :'interest_rate_percentage' => :'Float',
    :'origination_principal_amount' => :'Float',
    :'next_payment_due_date' => :'String',
    :'last_payment_date' => :'String',
    :'last_payment_amount' => :'Float',
    :'minimum_payment_amount' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 284

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      remote_id == o.remote_id &&
      currency == o.currency &&
      fingerprint == o.fingerprint &&
      institution == o.institution &&
      mask == o.mask &&
      name == o.name &&
      type == o.type &&
      subtype == o.subtype &&
      balance == o.balance &&
      remote_data == o.remote_data &&
      aprs == o.aprs &&
      interest_rate_percentage == o.interest_rate_percentage &&
      origination_principal_amount == o.origination_principal_amount &&
      next_payment_due_date == o.next_payment_due_date &&
      last_payment_date == o.last_payment_date &&
      last_payment_amount == o.last_payment_amount &&
      minimum_payment_amount == o.minimum_payment_amount
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



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 352

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



423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 423

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



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 328

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


308
309
310
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 308

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



314
315
316
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 314

def hash
  [remote_id, currency, fingerprint, institution, mask, name, type, subtype, balance, remote_data, aprs, interest_rate_percentage, origination_principal_amount, next_payment_due_date, last_payment_date, last_payment_amount, minimum_payment_amount].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



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
266
267
268
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 241

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

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

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

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

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

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



399
400
401
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 399

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



405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 405

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



393
394
395
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 393

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



272
273
274
275
276
277
278
279
280
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 272

def valid?
  return false if @remote_id.nil?
  return false if @currency.nil?
  return false if @fingerprint.nil?
  return false if @name.nil?
  return false if @type.nil?
  return false if @balance.nil?
  true
end