Class: Plaid::MortgageLiability

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/models/mortgage_liability.rb

Overview

Contains details about a mortgage account.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MortgageLiability

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/plaid/models/mortgage_liability.rb', line 159

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

The ID of the account that this liability belongs to.



20
21
22
 
# File 'lib/plaid/models/mortgage_liability.rb', line 20

def 
  @account_id
end

#account_number ⇒ Object

The account number of the loan.



23
24
25
 
# File 'lib/plaid/models/mortgage_liability.rb', line 23

def 
  @account_number
end

#current_late_fee ⇒ Object

The current outstanding amount charged for late payment.



26
27
28
 
# File 'lib/plaid/models/mortgage_liability.rb', line 26

def current_late_fee
  @current_late_fee
end

#escrow_balance ⇒ Object

Total amount held in escrow to pay taxes and insurance on behalf of the borrower.



29
30
31
 
# File 'lib/plaid/models/mortgage_liability.rb', line 29

def escrow_balance
  @escrow_balance
end

#has_pmi ⇒ Object

Indicates whether the borrower has private mortgage insurance in effect.



32
33
34
 
# File 'lib/plaid/models/mortgage_liability.rb', line 32

def has_pmi
  @has_pmi
end

#has_prepayment_penalty ⇒ Object

Indicates whether the borrower will pay a penalty for early payoff of mortgage.



35
36
37
 
# File 'lib/plaid/models/mortgage_liability.rb', line 35

def has_prepayment_penalty
  @has_prepayment_penalty
end

#interest_rate ⇒ Object

Returns the value of attribute interest_rate.



37
38
39
 
# File 'lib/plaid/models/mortgage_liability.rb', line 37

def interest_rate
  @interest_rate
end

#last_payment_amount ⇒ Object

The amount of the last payment.



40
41
42
 
# File 'lib/plaid/models/mortgage_liability.rb', line 40

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](wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).



43
44
45
 
# File 'lib/plaid/models/mortgage_liability.rb', line 43

def last_payment_date
  @last_payment_date
end

#loan_term ⇒ Object

Full duration of mortgage as at origination (e.g. ‘10 year`).



49
50
51
 
# File 'lib/plaid/models/mortgage_liability.rb', line 49

def loan_term
  @loan_term
end

#loan_type_description ⇒ Object

Description of the type of loan, for example ‘conventional`, `fixed`, or `variable`. This field is provided directly from the loan servicer and does not have an enumerated set of possible values.



46
47
48
 
# File 'lib/plaid/models/mortgage_liability.rb', line 46

def loan_type_description
  @loan_type_description
end

#maturity_date ⇒ Object

Original date on which mortgage is due in full. Dates are returned in an [ISO 8601](wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).



52
53
54
 
# File 'lib/plaid/models/mortgage_liability.rb', line 52

def maturity_date
  @maturity_date
end

#next_monthly_payment ⇒ Object

The amount of the next payment.



55
56
57
 
# File 'lib/plaid/models/mortgage_liability.rb', line 55

def next_monthly_payment
  @next_monthly_payment
end

#next_payment_due_date ⇒ Object

The due date for the next payment. Dates are returned in an [ISO 8601](wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).



58
59
60
 
# File 'lib/plaid/models/mortgage_liability.rb', line 58

def next_payment_due_date
  @next_payment_due_date
end

#origination_date ⇒ Object

The date on which the loan was initially lent. Dates are returned in an [ISO 8601](wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).



61
62
63
 
# File 'lib/plaid/models/mortgage_liability.rb', line 61

def origination_date
  @origination_date
end

#origination_principal_amount ⇒ Object

The original principal balance of the mortgage.



64
65
66
 
# File 'lib/plaid/models/mortgage_liability.rb', line 64

def origination_principal_amount
  @origination_principal_amount
end

#past_due_amount ⇒ Object

Amount of loan (principal + interest) past due for payment.



67
68
69
 
# File 'lib/plaid/models/mortgage_liability.rb', line 67

def past_due_amount
  @past_due_amount
end

#property_address ⇒ Object

Returns the value of attribute property_address.



69
70
71
 
# File 'lib/plaid/models/mortgage_liability.rb', line 69

def property_address
  @property_address
end

#ytd_interest_paid ⇒ Object

The year to date (YTD) interest paid.



72
73
74
 
# File 'lib/plaid/models/mortgage_liability.rb', line 72

def ytd_interest_paid
  @ytd_interest_paid
end

#ytd_principal_paid ⇒ Object

The YTD principal paid.



75
76
77
 
# File 'lib/plaid/models/mortgage_liability.rb', line 75

def ytd_principal_paid
  @ytd_principal_paid
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



104
105
106
 
# File 'lib/plaid/models/mortgage_liability.rb', line 104

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/plaid/models/mortgage_liability.rb', line 78

def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'account_number' => :'account_number',
    :'current_late_fee' => :'current_late_fee',
    :'escrow_balance' => :'escrow_balance',
    :'has_pmi' => :'has_pmi',
    :'has_prepayment_penalty' => :'has_prepayment_penalty',
    :'interest_rate' => :'interest_rate',
    :'last_payment_amount' => :'last_payment_amount',
    :'last_payment_date' => :'last_payment_date',
    :'loan_type_description' => :'loan_type_description',
    :'loan_term' => :'loan_term',
    :'maturity_date' => :'maturity_date',
    :'next_monthly_payment' => :'next_monthly_payment',
    :'next_payment_due_date' => :'next_payment_due_date',
    :'origination_date' => :'origination_date',
    :'origination_principal_amount' => :'origination_principal_amount',
    :'past_due_amount' => :'past_due_amount',
    :'property_address' => :'property_address',
    :'ytd_interest_paid' => :'ytd_interest_paid',
    :'ytd_principal_paid' => :'ytd_principal_paid'
  }
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



323
324
325
 
# File 'lib/plaid/models/mortgage_liability.rb', line 323

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/plaid/models/mortgage_liability.rb', line 135

def self.openapi_nullable
  Set.new([
    :'account_number',
    :'current_late_fee',
    :'escrow_balance',
    :'has_pmi',
    :'has_prepayment_penalty',
    :'last_payment_amount',
    :'last_payment_date',
    :'loan_type_description',
    :'loan_term',
    :'maturity_date',
    :'next_monthly_payment',
    :'next_payment_due_date',
    :'origination_date',
    :'origination_principal_amount',
    :'past_due_amount',
    :'ytd_interest_paid',
    :'ytd_principal_paid'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/plaid/models/mortgage_liability.rb', line 109

def self.openapi_types
  {
    :'account_id' => :'String',
    :'account_number' => :'String',
    :'current_late_fee' => :'Float',
    :'escrow_balance' => :'Float',
    :'has_pmi' => :'Boolean',
    :'has_prepayment_penalty' => :'Boolean',
    :'interest_rate' => :'MortgageInterestRate',
    :'last_payment_amount' => :'Float',
    :'last_payment_date' => :'Date',
    :'loan_type_description' => :'String',
    :'loan_term' => :'String',
    :'maturity_date' => :'Date',
    :'next_monthly_payment' => :'Float',
    :'next_payment_due_date' => :'Date',
    :'origination_date' => :'Date',
    :'origination_principal_amount' => :'Float',
    :'past_due_amount' => :'Float',
    :'property_address' => :'MortgagePropertyAddress',
    :'ytd_interest_paid' => :'Float',
    :'ytd_principal_paid' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
       == o. &&
      current_late_fee == o.current_late_fee &&
      escrow_balance == o.escrow_balance &&
      has_pmi == o.has_pmi &&
      has_prepayment_penalty == o.has_prepayment_penalty &&
      interest_rate == o.interest_rate &&
      last_payment_amount == o.last_payment_amount &&
      last_payment_date == o.last_payment_date &&
      loan_type_description == o.loan_type_description &&
      loan_term == o.loan_term &&
      maturity_date == o.maturity_date &&
      next_monthly_payment == o.next_monthly_payment &&
      next_payment_due_date == o.next_payment_due_date &&
      origination_date == o.origination_date &&
      origination_principal_amount == o.origination_principal_amount &&
      past_due_amount == o.past_due_amount &&
      property_address == o.property_address &&
      ytd_interest_paid == o.ytd_interest_paid &&
      ytd_principal_paid == o.ytd_principal_paid
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



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
390
391
 
# File 'lib/plaid/models/mortgage_liability.rb', line 354

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



425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/plaid/models/mortgage_liability.rb', line 425

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



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/plaid/models/mortgage_liability.rb', line 330

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


310
311
312
 
# File 'lib/plaid/models/mortgage_liability.rb', line 310

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



316
317
318
 
# File 'lib/plaid/models/mortgage_liability.rb', line 316

def hash
  [, , current_late_fee, escrow_balance, has_pmi, has_prepayment_penalty, interest_rate, last_payment_amount, last_payment_date, loan_type_description, loan_term, maturity_date, next_monthly_payment, next_payment_due_date, origination_date, origination_principal_amount, past_due_amount, property_address, ytd_interest_paid, ytd_principal_paid].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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/plaid/models/mortgage_liability.rb', line 255

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

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

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



401
402
403
 
# File 'lib/plaid/models/mortgage_liability.rb', line 401

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



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

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



395
396
397
 
# File 'lib/plaid/models/mortgage_liability.rb', line 395

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



274
275
276
277
278
279
 
# File 'lib/plaid/models/mortgage_liability.rb', line 274

def valid?
  return false if @account_id.nil?
  return false if @interest_rate.nil?
  return false if @property_address.nil?
  true
end