class

Plaid::Enhancements

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

A grouping of the Plaid produced transaction enhancement fields.

Constructors

new(pull : JSON::PullParser)

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

new(*, payment_channel : Plaid::PaymentChannel | Nil = nil, category_id : String | Nil = nil, category : Array(String) | Nil = nil, location : Location | Nil = nil, merchant_name : String | Nil = nil, website : String | Nil = nil, logo_url : String | Nil = nil, check_number : String | Nil = nil, personal_finance_category : PersonalFinanceCategory | Nil = nil, personal_finance_category_icon_url : String | Nil = nil, counterparties : Array(Counterparty) | 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

category

A hierarchical array of the categories to which this transaction belongs. For a full list of categories, see /categories/get.

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

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

category_id

The ID of the category to which this transaction belongs. For a full list of categories, see /categories/get.

category_id=(new_value : String | Nil)

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

check_number

The check number of the transaction. This field is only populated for check transactions.

check_number=(new_value : String | Nil)

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

check_number_present=(check_number_present : Bool)

check_number_present?

counterparties

The counterparties present in the transaction. Counterparties, such as the merchant or the financial institution, are extracted by Plaid from the raw description.

counterparties=(new_value : Array(Counterparty) | Nil)

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

list_invalid_properties

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

location

location=(new_value : Location | Nil)

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

logo_url

The URL of a logo associated with this transaction, if available. The logo will always be 100×100 pixel PNG file.

logo_url=(new_value : String | Nil)

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

logo_url_present=(logo_url_present : Bool)

logo_url_present?

merchant_name

The name of the primary counterparty, such as the merchant or the financial institution, as extracted by Plaid from the raw description.

merchant_name=(new_value : String | Nil)

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

merchant_name_present=(merchant_name_present : Bool)

merchant_name_present?

payment_channel

payment_channel=(new_value : Plaid::PaymentChannel | Nil)

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

personal_finance_category

personal_finance_category=(new_value : PersonalFinanceCategory | Nil)

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

personal_finance_category_icon_url

The URL of an icon associated with the primary personal finance category. The icon will always be 100×100 pixel PNG file.

personal_finance_category_icon_url=(new_value : String | Nil)

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

personal_finance_category_present=(personal_finance_category_present : Bool)

personal_finance_category_present?

valid?

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

website

The website associated with this transaction, if available.

website=(new_value : String | Nil)

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

website_present=(website_present : Bool)

website_present?