class

Plaid::Enrichments

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

A grouping of the Plaid produced transaction enrichment fields.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, counterparties : Array(Counterparty) | Nil = nil, location : Location | Nil = nil, logo_url : String | Nil = nil, merchant_name : String | Nil = nil, payment_channel : Plaid::PaymentChannel | Nil = nil, personal_finance_category : PersonalFinanceCategory | Nil = nil, personal_finance_category_icon_url : String | Nil = nil, website : String | Nil = nil, check_number : String | Nil = nil, entity_id : String | Nil = nil, legacy_category_id : String | Nil = nil, legacy_category : Array(String) | Nil = nil, recurrence : Recurrence | 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

check_number

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

Source
check_number=(new_value : String | Nil)

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

Source
check_number_present=(check_number_present : Bool)
Source
check_number_present?
Source
counterparties

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

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

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

Source
entity_id

A unique, stable, Plaid-generated ID that maps to the primary counterparty.

Source
entity_id=(new_value : String | Nil)

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

Source
entity_id_present=(entity_id_present : Bool)
Source
entity_id_present?
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

legacy_category

A hierarchical array of the legacy categories to which this transaction belongs. For a full list of legacy categories, see /categories/get. We recommend using the personal_finance_category for transaction categorization to obtain the best results.

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

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

Source
legacy_category_id

The ID of the legacy category to which this transaction belongs. For a full list of legacy categories, see /categories/get. We recommend using the personal_finance_category for transaction categorization to obtain the best results.

Source
legacy_category_id=(new_value : String | Nil)

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

Source
legacy_category_id_present=(legacy_category_id_present : Bool)
Source
legacy_category_id_present?
Source
list_invalid_properties

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

Source
location
Source
location=(new_value : Location | Nil)

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

Source
logo_url

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

Source
logo_url=(new_value : String | Nil)

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

Source
merchant_name

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

Source
merchant_name=(new_value : String | Nil)

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

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

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

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

Source
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

Source
recurrence
Source
recurrence=(new_value : Recurrence | Nil)

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

Source
recurrence_present=(recurrence_present : Bool)
Source
recurrence_present?
Source
valid?

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

Source
website

The website associated with this transaction.

Source
website=(new_value : String | Nil)

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

Source