class

Plaid::LiabilityOverride

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

Used to configure Sandbox test data for the Liabilities product

Constructors

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

new(*, _type : String | Nil = nil, purchase_apr : Float64 | Nil = nil, cash_apr : Float64 | Nil = nil, balance_transfer_apr : Float64 | Nil = nil, special_apr : Float64 | Nil = nil, last_payment_amount : Float64 | Nil = nil, minimum_payment_amount : Float64 | Nil = nil, is_overdue : Bool | Nil = nil, origination_date : Time | Nil = nil, principal : Float64 | Nil = nil, nominal_apr : Float64 | Nil = nil, interest_capitalization_grace_period_months : Float64 | Nil = nil, repayment_model : StudentLoanRepaymentModel | Nil = nil, expected_payoff_date : Time | Nil = nil, guarantor : String | Nil = nil, is_federal : Bool | Nil = nil, loan_name : String | Nil = nil, loan_status : StudentLoanStatus | Nil = nil, payment_reference_number : String | Nil = nil, pslf_status : PSLFStatus | Nil = nil, repayment_plan_description : String | Nil = nil, repayment_plan_type : String | Nil = nil, sequence_number : String | Nil = nil, servicer_address : Address | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

_type

The type of the liability object, either credit or student. Mortgages are not currently supported in the custom Sandbox.

_type=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] _type Object to be assigned

balance_transfer_apr

The balance transfer APR percentage value. Can only be set if type is credit.

balance_transfer_apr=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] balance_transfer_apr Object to be assigned

cash_apr

The cash APR percentage value. Can only be set if type is credit.

cash_apr=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] cash_apr Object to be assigned

expected_payoff_date

Override the expected_payoff_date field. Can only be set if type is student.

expected_payoff_date=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] expected_payoff_date Object to be assigned

guarantor

Override the guarantor field. Can only be set if type is student.

guarantor=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] guarantor Object to be assigned

hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

interest_capitalization_grace_period_months

If set, interest capitalization begins at the given number of months after loan origination. By default interest is never capitalized. Can only be set if type is student.

interest_capitalization_grace_period_months=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] interest_capitalization_grace_period_months Object to be assigned

is_federal

Override the is_federal field. Can only be set if type is student.

is_federal=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] is_federal Object to be assigned

is_overdue

Override the is_overdue field

is_overdue=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] is_overdue Object to be assigned

last_payment_amount

Override the last_payment_amount field. Can only be set if type is credit.

last_payment_amount=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] last_payment_amount Object to be assigned

list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

loan_name

Override the loan_name field. Can only be set if type is student.

loan_name=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] loan_name Object to be assigned

loan_status

loan_status=(new_value : StudentLoanStatus | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] loan_status Object to be assigned

minimum_payment_amount

Override the minimum_payment_amount field. Can only be set if type is credit or student.

minimum_payment_amount=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] minimum_payment_amount Object to be assigned

nominal_apr

The interest rate on the loan as a percentage. Can only be set if type is student.

nominal_apr=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] nominal_apr Object to be assigned

origination_date

The date on which the loan was initially lent, in ISO 8601 (YYYY-MM-DD) format. Can only be set if type is student.

origination_date=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] origination_date Object to be assigned

payment_reference_number

Override the payment_reference_number field. Can only be set if type is student.

payment_reference_number=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] payment_reference_number Object to be assigned

principal

The original loan principal. Can only be set if type is student.

principal=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] principal Object to be assigned

pslf_status

pslf_status=(new_value : PSLFStatus | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] pslf_status Object to be assigned

purchase_apr

The purchase APR percentage value. For simplicity, this is the only interest rate used to calculate interest charges. Can only be set if type is credit.

purchase_apr=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] purchase_apr Object to be assigned

repayment_model

repayment_model=(new_value : StudentLoanRepaymentModel | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] repayment_model Object to be assigned

repayment_plan_description

Override the repayment_plan.description field. Can only be set if type is student.

repayment_plan_description=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] repayment_plan_description Object to be assigned

repayment_plan_type

Override the repayment_plan.type field. Can only be set if type is student. Possible values are: \"extended graduated\", \"extended standard\", \"graduated\", \"income-contingent repayment\", \"income-based repayment\", \"interest only\", \"other\", \"pay as you earn\", \"revised pay as you earn\", \"standard\", or \"saving on a valuable education\".

repayment_plan_type=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] repayment_plan_type Object to be assigned

sequence_number

Override the sequence_number field. Can only be set if type is student.

sequence_number=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] sequence_number Object to be assigned

servicer_address

servicer_address=(new_value : Address | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] servicer_address Object to be assigned

special_apr

The special APR percentage value. Can only be set if type is credit.

special_apr=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] special_apr Object to be assigned

valid?

Check to see if the all the properties in the model are valid @return true if the model is valid