class

Plaid::InflowModel

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

The inflow_model allows you to model a test account that receives regular income or make regular payments on a loan. Any transactions generated by the inflow_model will appear in addition to randomly generated test data or transactions specified by override_accounts.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, _type : String | Nil = nil, income_amount : Float64 | Nil = nil, payment_day_of_month : Float64 | Nil = nil, transaction_name : String | Nil = nil, statement_day_of_month : String | Nil = nil)

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

Source

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

Inflow model. One of the following: none: No income monthly-income: Income occurs once per month monthly-balance-payment: Pays off the balance on a liability account at the given statement day of month. monthly-interest-only-payment: Makes an interest-only payment on a liability account at the given statement day of month. Note that account types supported by Liabilities will accrue interest in the Sandbox. The types impacted are account type credit with subtype credit or paypal, and account type loan with subtype student or mortgage.

Source
_type=(new_value : String | Nil)

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

Source
hash(hasher)

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

income_amount

Amount of income per month. This value is required if type is monthly-income.

Source
income_amount=(new_value : Float64 | Nil)

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

Source
list_invalid_properties

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

Source
payment_day_of_month

Number between 1 and 28, or last meaning the last day of the month. The day of the month on which the income transaction will appear. The name of the income transaction. This field is required if type is monthly-income, monthly-balance-payment or monthly-interest-only-payment.

Source
payment_day_of_month=(new_value : Float64 | Nil)

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

Source
statement_day_of_month

Number between 1 and 28, or last meaning the last day of the month. The day of the month on which the balance is calculated for the next payment. The name of the income transaction. This field is required if type is monthly-balance-payment or monthly-interest-only-payment.

Source
statement_day_of_month=(new_value : String | Nil)

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

Source
transaction_name

The name of the income transaction. This field is required if type is monthly-income, monthly-balance-payment or monthly-interest-only-payment.

Source
transaction_name=(new_value : String | Nil)

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

Source
valid?

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

Source