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



149
150
151
152
153
154
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
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 149

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?(:'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.



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

def aprs
  @aprs
end

#balance ⇒ Object

Returns the value of attribute balance.



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

def balance
  @balance
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



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

def fingerprint
  @fingerprint
end

#institution ⇒ Object

Returns the value of attribute institution.



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

def institution
  @institution
end

#interest_rate_percentage ⇒ Object

The interest rate on the loan as a percentage.



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

def interest_rate_percentage
  @interest_rate_percentage
end

#last_payment_amount ⇒ Object

The amount of the last payment.



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

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).



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

def last_payment_date
  @last_payment_date
end

#mask ⇒ Object

The partial account number.



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

def mask
  @mask
end

#minimum_payment_amount ⇒ Object

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



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

def minimum_payment_amount
  @minimum_payment_amount
end

#name ⇒ Object

The account’s name, ie ‘My Checking’



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

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.



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

def next_payment_due_date
  @next_payment_due_date
end

#origination_principal_amount ⇒ Object

The original principal balance of the loan.



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

def origination_principal_amount
  @origination_principal_amount
end

#remote_data ⇒ Object

Returns the value of attribute remote_data.



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

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.



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

def subtype
  @subtype
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



106
107
108
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 106

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'remote_id' => :'remote_id',
    :'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



305
306
307
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 305

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



133
134
135
136
137
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 133

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

.openapi_types ⇒ Object

Attribute type mapping.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 111

def self.openapi_types
  {
    :'remote_id' => :'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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 269

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      remote_id == o.remote_id &&
      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



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 336

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



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

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



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 312

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


292
293
294
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 292

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



298
299
300
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 298

def hash
  [remote_id, 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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 231

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 @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



383
384
385
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 383

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



389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 389

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



377
378
379
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 377

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



258
259
260
261
262
263
264
265
 
# File 'lib/fuse_client/models/financial_connections_account_liability.rb', line 258

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