class

Plaid::TransactionStream

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

A grouping of related transactions

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, account_id : String | Nil = nil, stream_id : String | Nil = nil, category : Array(String) | Nil = nil, category_id : String | Nil = nil, description : String | Nil = nil, merchant_name : String | Nil = nil, first_date : Time | Nil = nil, last_date : Time | Nil = nil, frequency : Plaid::RecurringTransactionFrequency | Nil = nil, transaction_ids : Array(String) | Nil = nil, average_amount : TransactionStreamAmount | Nil = nil, last_amount : TransactionStreamAmount | Nil = nil, is_active : Bool | Nil = nil, status : Plaid::TransactionStreamStatus | Nil = nil, is_user_modified : Bool | Nil = nil, personal_finance_category : PersonalFinanceCategory | Nil = nil, last_user_modified_date : Time | 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

account_id

The ID of the account to which the stream belongs

Source
account_id=(new_value : String | Nil)

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

Source
average_amount
Source
average_amount=(new_value : TransactionStreamAmount | Nil)

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

Source
category

A hierarchical array of the categories to which this transaction belongs. See Categories. All implementations are encouraged to use the new personal_finance_category instead of category. personal_finance_category provides more meaningful categorization and greater accuracy.

Source
category=(new_value : Array(String) | Nil)

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

Source
category_id

The ID of the category to which this transaction belongs. See Categories. All implementations are encouraged to use the new personal_finance_category instead of category. personal_finance_category provides more meaningful categorization and greater accuracy.

Source
category_id=(new_value : String | Nil)

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

Source
description

A description of the transaction stream.

Source
description=(new_value : String | Nil)

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

Source
first_date

The posted date of the earliest transaction in the stream.

Source
first_date=(new_value : Time | Nil)

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

Source
frequency
Source
frequency=(new_value : Plaid::RecurringTransactionFrequency | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] frequency 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

is_active

Indicates whether the transaction stream is still live.

Source
is_active=(new_value : Bool | Nil)

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

Source
is_user_modified

This will be set to true if the stream has been modified by request to a /transactions/recurring/streams endpoint. It will be false for all other streams.

Source
is_user_modified=(new_value : Bool | Nil)

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

Source
last_amount
Source
last_amount=(new_value : TransactionStreamAmount | Nil)

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

Source
last_date

The posted date of the latest transaction in the stream.

Source
last_date=(new_value : Time | Nil)

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

Source
last_user_modified_date

The date of the most recent user modification. This will only be set if is_user_modified is true.

Source
last_user_modified_date=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] last_user_modified_date 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
merchant_name

The merchant associated with the transaction stream.

Source
merchant_name=(new_value : String | Nil)

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

Source
personal_finance_category
Source
personal_finance_category=(new_value : PersonalFinanceCategory | Nil)

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

Source
personal_finance_category_present=(personal_finance_category_present : Bool)
Source
personal_finance_category_present?
Source
status
Source
status=(new_value : Plaid::TransactionStreamStatus | Nil)

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

Source
stream_id

A unique id for the stream

Source
stream_id=(new_value : String | Nil)

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

Source
transaction_ids

An array of Plaid transaction IDs belonging to the stream, sorted by posted date.

Source
transaction_ids=(new_value : Array(String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] transaction_ids 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