Class: Plaid::StudentLoan

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

Overview

Contains details about a student loan account

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StudentLoan

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/plaid/models/student_loan.rb', line 179

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

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

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

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

  if attributes.key?(:'is_overdue')
    self.is_overdue = attributes[:'is_overdue']
  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?(:'last_statement_issue_date')
    self.last_statement_issue_date = attributes[:'last_statement_issue_date']
  end

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

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

  if attributes.key?(:'minimum_payment_amount')
    self.minimum_payment_amount = attributes[:'minimum_payment_amount']
  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?(:'outstanding_interest_amount')
    self.outstanding_interest_amount = attributes[:'outstanding_interest_amount']
  end

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

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

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

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

  if attributes.key?(:'servicer_address')
    self.servicer_address = attributes[:'servicer_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/student_loan.rb', line 20

def 
  @account_id
end

#account_number ⇒ Object

The account number of the loan. For some institutions, this may be a masked version of the number (e.g., the last 4 digits instead of the entire number).



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

def 
  @account_number
end

#disbursement_dates ⇒ Object

The dates on which loaned funds were disbursed or will be disbursed. These are often in the past. Dates are returned in an [ISO 8601](wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).



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

def disbursement_dates
  @disbursement_dates
end

#expected_payoff_date ⇒ Object

The date when the student loan is expected to be paid off. Availability for this field is limited. Dates are returned in an [ISO 8601](wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).



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

def expected_payoff_date
  @expected_payoff_date
end

#guarantor ⇒ Object

The guarantor of the student loan.



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

def guarantor
  @guarantor
end

#interest_rate_percentage ⇒ Object

The interest rate on the loan as a percentage.



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

def interest_rate_percentage
  @interest_rate_percentage
end

#is_overdue ⇒ Object

‘true` if a payment is currently overdue. Availability for this field is limited.



38
39
40
 
# File 'lib/plaid/models/student_loan.rb', line 38

def is_overdue
  @is_overdue
end

#last_payment_amount ⇒ Object

The amount of the last payment.



41
42
43
 
# File 'lib/plaid/models/student_loan.rb', line 41

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



44
45
46
 
# File 'lib/plaid/models/student_loan.rb', line 44

def last_payment_date
  @last_payment_date
end

#last_statement_issue_date ⇒ Object

The date of the last statement. Dates are returned in an [ISO 8601](wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).



47
48
49
 
# File 'lib/plaid/models/student_loan.rb', line 47

def last_statement_issue_date
  @last_statement_issue_date
end

#loan_name ⇒ Object

The type of loan, e.g., "Consolidation Loans".



50
51
52
 
# File 'lib/plaid/models/student_loan.rb', line 50

def loan_name
  @loan_name
end

#loan_status ⇒ Object

Returns the value of attribute loan_status.



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

def loan_status
  @loan_status
end

#minimum_payment_amount ⇒ Object

The minimum payment due for the next billing cycle. There are some exceptions: Some institutions require a minimum payment across all loans associated with an account number. Our API presents that same minimum payment amount on each loan. The institutions that do this are: Great Lakes ( ‘ins_116861`), Firstmark (`ins_116295`), Commonbond Firstmark Services (`ins_116950`), Nelnet (`ins_116528`), EdFinancial Services (`ins_116304`), Granite State (`ins_116308`), and Oklahoma Student Loan Authority (`ins_116945`). Firstmark (`ins_116295` ) and Navient (`ins_116248`) will display as $0 if there is an autopay program in effect.



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

def minimum_payment_amount
  @minimum_payment_amount
end

#next_payment_due_date ⇒ Object

The due date for the next payment. The due date is ‘null` if a payment is not expected. A payment is not expected if `loan_status.type` is `deferment`, `in_school`, `consolidated`, `paid in full`, or `transferred`. Dates are returned in an [ISO 8601](wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).



58
59
60
 
# File 'lib/plaid/models/student_loan.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/student_loan.rb', line 61

def origination_date
  @origination_date
end

#origination_principal_amount ⇒ Object

The original principal balance of the loan.



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

def origination_principal_amount
  @origination_principal_amount
end

#outstanding_interest_amount ⇒ Object

The total dollar amount of the accrued interest balance. For Sallie Mae ( ‘ins_116944`), this amount is included in the current balance of the loan, so this field will return as `null`.



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

def outstanding_interest_amount
  @outstanding_interest_amount
end

#payment_reference_number ⇒ Object

The relevant account number that should be used to reference this loan for payments. In the majority of cases, ‘payment_reference_number` will match a`ccount_number,` but in some institutions, such as Great Lakes (`ins_116861`), it will be different.



70
71
72
 
# File 'lib/plaid/models/student_loan.rb', line 70

def payment_reference_number
  @payment_reference_number
end

#pslf_status ⇒ Object

Returns the value of attribute pslf_status.



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

def pslf_status
  @pslf_status
end

#repayment_plan ⇒ Object

Returns the value of attribute repayment_plan.



74
75
76
 
# File 'lib/plaid/models/student_loan.rb', line 74

def repayment_plan
  @repayment_plan
end

#sequence_number ⇒ Object

The sequence number of the student loan. Heartland ECSI (‘ins_116948`) does not make this field available.



77
78
79
 
# File 'lib/plaid/models/student_loan.rb', line 77

def sequence_number
  @sequence_number
end

#servicer_address ⇒ Object

Returns the value of attribute servicer_address.



79
80
81
 
# File 'lib/plaid/models/student_loan.rb', line 79

def servicer_address
  @servicer_address
end

#ytd_interest_paid ⇒ Object

The year to date (YTD) interest paid. Availability for this field is limited.



82
83
84
 
# File 'lib/plaid/models/student_loan.rb', line 82

def ytd_interest_paid
  @ytd_interest_paid
end

#ytd_principal_paid ⇒ Object

The year to date (YTD) principal paid. Availability for this field is limited.



85
86
87
 
# File 'lib/plaid/models/student_loan.rb', line 85

def ytd_principal_paid
  @ytd_principal_paid
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



118
119
120
 
# File 'lib/plaid/models/student_loan.rb', line 118

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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
 
# File 'lib/plaid/models/student_loan.rb', line 88

def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'account_number' => :'account_number',
    :'disbursement_dates' => :'disbursement_dates',
    :'expected_payoff_date' => :'expected_payoff_date',
    :'guarantor' => :'guarantor',
    :'interest_rate_percentage' => :'interest_rate_percentage',
    :'is_overdue' => :'is_overdue',
    :'last_payment_amount' => :'last_payment_amount',
    :'last_payment_date' => :'last_payment_date',
    :'last_statement_issue_date' => :'last_statement_issue_date',
    :'loan_name' => :'loan_name',
    :'loan_status' => :'loan_status',
    :'minimum_payment_amount' => :'minimum_payment_amount',
    :'next_payment_due_date' => :'next_payment_due_date',
    :'origination_date' => :'origination_date',
    :'origination_principal_amount' => :'origination_principal_amount',
    :'outstanding_interest_amount' => :'outstanding_interest_amount',
    :'payment_reference_number' => :'payment_reference_number',
    :'pslf_status' => :'pslf_status',
    :'repayment_plan' => :'repayment_plan',
    :'sequence_number' => :'sequence_number',
    :'servicer_address' => :'servicer_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



375
376
377
 
# File 'lib/plaid/models/student_loan.rb', line 375

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/plaid/models/student_loan.rb', line 153

def self.openapi_nullable
  Set.new([
    :'account_id',
    :'account_number',
    :'disbursement_dates',
    :'expected_payoff_date',
    :'guarantor',
    :'is_overdue',
    :'last_payment_amount',
    :'last_payment_date',
    :'last_statement_issue_date',
    :'loan_name',
    :'minimum_payment_amount',
    :'next_payment_due_date',
    :'origination_date',
    :'origination_principal_amount',
    :'outstanding_interest_amount',
    :'payment_reference_number',
    :'sequence_number',
    :'ytd_interest_paid',
    :'ytd_principal_paid'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/plaid/models/student_loan.rb', line 123

def self.openapi_types
  {
    :'account_id' => :'String',
    :'account_number' => :'String',
    :'disbursement_dates' => :'Array<Date>',
    :'expected_payoff_date' => :'Date',
    :'guarantor' => :'String',
    :'interest_rate_percentage' => :'Float',
    :'is_overdue' => :'Boolean',
    :'last_payment_amount' => :'Float',
    :'last_payment_date' => :'Date',
    :'last_statement_issue_date' => :'Date',
    :'loan_name' => :'String',
    :'loan_status' => :'StudentLoanStatus',
    :'minimum_payment_amount' => :'Float',
    :'next_payment_due_date' => :'Date',
    :'origination_date' => :'Date',
    :'origination_principal_amount' => :'Float',
    :'outstanding_interest_amount' => :'Float',
    :'payment_reference_number' => :'String',
    :'pslf_status' => :'PSLFStatus',
    :'repayment_plan' => :'StudentRepaymentPlan',
    :'sequence_number' => :'String',
    :'servicer_address' => :'ServicerAddressData',
    :'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



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/plaid/models/student_loan.rb', line 331

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
       == o. &&
      disbursement_dates == o.disbursement_dates &&
      expected_payoff_date == o.expected_payoff_date &&
      guarantor == o.guarantor &&
      interest_rate_percentage == o.interest_rate_percentage &&
      is_overdue == o.is_overdue &&
      last_payment_amount == o.last_payment_amount &&
      last_payment_date == o.last_payment_date &&
      last_statement_issue_date == o.last_statement_issue_date &&
      loan_name == o.loan_name &&
      loan_status == o.loan_status &&
      minimum_payment_amount == o.minimum_payment_amount &&
      next_payment_due_date == o.next_payment_due_date &&
      origination_date == o.origination_date &&
      origination_principal_amount == o.origination_principal_amount &&
      outstanding_interest_amount == o.outstanding_interest_amount &&
      payment_reference_number == o.payment_reference_number &&
      pslf_status == o.pslf_status &&
      repayment_plan == o.repayment_plan &&
      sequence_number == o.sequence_number &&
      servicer_address == o.servicer_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



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/plaid/models/student_loan.rb', line 405

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



476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/plaid/models/student_loan.rb', line 476

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



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/plaid/models/student_loan.rb', line 382

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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


362
363
364
 
# File 'lib/plaid/models/student_loan.rb', line 362

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



368
369
370
 
# File 'lib/plaid/models/student_loan.rb', line 368

def hash
  [, , disbursement_dates, expected_payoff_date, guarantor, interest_rate_percentage, is_overdue, last_payment_amount, last_payment_date, last_statement_issue_date, loan_name, loan_status, minimum_payment_amount, next_payment_due_date, origination_date, origination_principal_amount, outstanding_interest_amount, payment_reference_number, pslf_status, repayment_plan, sequence_number, servicer_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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/plaid/models/student_loan.rb', line 293

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

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

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

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

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



452
453
454
 
# File 'lib/plaid/models/student_loan.rb', line 452

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



458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/plaid/models/student_loan.rb', line 458

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



446
447
448
 
# File 'lib/plaid/models/student_loan.rb', line 446

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



320
321
322
323
324
325
326
327
 
# File 'lib/plaid/models/student_loan.rb', line 320

def valid?
  return false if @interest_rate_percentage.nil?
  return false if @loan_status.nil?
  return false if @pslf_status.nil?
  return false if @repayment_plan.nil?
  return false if @servicer_address.nil?
  true
end