class Plaid::AssetReportTransaction
A transaction on the asset report
Attributes
The ID of the account in which this transaction occurred.
The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts.
The settled value of the transaction, denominated in the transaction’s currency, as stated in ‘iso_currency_code` or `unofficial_currency_code`. Positive values when money moves out of the account; negative values when money moves in. For example, debit card purchases are positive; credit card payments, direct deposits, and refunds are negative.
A hierarchical array of the categories to which this transaction belongs. For a full list of categories, see [‘/categories/get`](plaid.com/docs/api/products/transactions/#categoriesget). This field will only appear in an Asset
Report with Insights.
The ID of the category to which this transaction belongs. For a full list of categories, see [‘/categories/get`](plaid.com/docs/api/products/transactions/#categoriesget). This field will only appear in an Asset
Report with Insights.
The check number of the transaction. This field is only populated for check transactions.
For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted. Both dates are returned in an [ISO 8601](wikipedia.org/wiki/ISO_8601) format ( ‘YYYY-MM-DD` ).
The date on which the transaction took place, in IS0 8601 format.
A unique identifier for an income source.
The ISO-4217 currency code of the transaction. Always ‘null` if `unofficial_currency_code` is non-null.
The merchant name, as enriched by Plaid
from the ‘name` field. This is typically a more human-readable version of the merchant counterparty in the transaction. For some bank transactions (such as checks or account transfers) where there is no meaningful merchant name, this value will be `null`.
The merchant name or transaction description. This field will only appear in an Asset
Report with Insights.
The string returned by the financial institution to describe the transaction.
When ‘true`, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled.
The ID of a posted transaction’s associated pending transaction, where applicable.
The unique ID of the transaction. Like all Plaid
identifiers, the ‘transaction_id` is case sensitive.
The unofficial currency code associated with the transaction. Always ‘null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the [currency code schema](plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `unofficial_currency_code`s.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/plaid/models/asset_report_transaction.rb, line 128 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/plaid/models/asset_report_transaction.rb, line 101 def self.attribute_map { :'account_id' => :'account_id', :'amount' => :'amount', :'iso_currency_code' => :'iso_currency_code', :'unofficial_currency_code' => :'unofficial_currency_code', :'original_description' => :'original_description', :'category' => :'category', :'category_id' => :'category_id', :'credit_category' => :'credit_category', :'check_number' => :'check_number', :'date' => :'date', :'date_transacted' => :'date_transacted', :'location' => :'location', :'name' => :'name', :'merchant_name' => :'merchant_name', :'payment_meta' => :'payment_meta', :'pending' => :'pending', :'pending_transaction_id' => :'pending_transaction_id', :'account_owner' => :'account_owner', :'transaction_id' => :'transaction_id', :'transaction_type' => :'transaction_type', :'income_source_id' => :'income_source_id' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/plaid/models/asset_report_transaction.rb, line 359 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/plaid/models/asset_report_transaction.rb, line 178 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::AssetReportTransaction` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::AssetReportTransaction`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'account_id') self.account_id = attributes[:'account_id'] end if attributes.key?(:'amount') self.amount = attributes[:'amount'] end if attributes.key?(:'iso_currency_code') self.iso_currency_code = attributes[:'iso_currency_code'] end if attributes.key?(:'unofficial_currency_code') self.unofficial_currency_code = attributes[:'unofficial_currency_code'] end if attributes.key?(:'original_description') self.original_description = attributes[:'original_description'] end if attributes.key?(:'category') if (value = attributes[:'category']).is_a?(Array) self.category = value end end if attributes.key?(:'category_id') self.category_id = attributes[:'category_id'] end if attributes.key?(:'credit_category') self.credit_category = attributes[:'credit_category'] end if attributes.key?(:'check_number') self.check_number = attributes[:'check_number'] end if attributes.key?(:'date') self.date = attributes[:'date'] end if attributes.key?(:'date_transacted') self.date_transacted = attributes[:'date_transacted'] end if attributes.key?(:'location') self.location = attributes[:'location'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'merchant_name') self.merchant_name = attributes[:'merchant_name'] end if attributes.key?(:'payment_meta') self.payment_meta = attributes[:'payment_meta'] end if attributes.key?(:'pending') self.pending = attributes[:'pending'] end if attributes.key?(:'pending_transaction_id') self.pending_transaction_id = attributes[:'pending_transaction_id'] end if attributes.key?(:'account_owner') self.account_owner = attributes[:'account_owner'] end if attributes.key?(:'transaction_id') self.transaction_id = attributes[:'transaction_id'] end if attributes.key?(:'transaction_type') self.transaction_type = attributes[:'transaction_type'] end if attributes.key?(:'income_source_id') self.income_source_id = attributes[:'income_source_id'] end end
List of attributes with nullable: true
# File lib/plaid/models/asset_report_transaction.rb, line 160 def self.openapi_nullable Set.new([ :'iso_currency_code', :'unofficial_currency_code', :'original_description', :'category', :'category_id', :'credit_category', :'check_number', :'date_transacted', :'merchant_name', :'pending_transaction_id', :'account_owner', ]) end
Attribute type mapping.
# File lib/plaid/models/asset_report_transaction.rb, line 133 def self.openapi_types { :'account_id' => :'String', :'amount' => :'Float', :'iso_currency_code' => :'String', :'unofficial_currency_code' => :'String', :'original_description' => :'String', :'category' => :'Array<String>', :'category_id' => :'String', :'credit_category' => :'CreditCategory', :'check_number' => :'String', :'date' => :'Date', :'date_transacted' => :'String', :'location' => :'Location', :'name' => :'String', :'merchant_name' => :'String', :'payment_meta' => :'PaymentMeta', :'pending' => :'Boolean', :'pending_transaction_id' => :'String', :'account_owner' => :'String', :'transaction_id' => :'String', :'transaction_type' => :'AssetReportTransactionType', :'income_source_id' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/plaid/models/asset_report_transaction.rb, line 318 def ==(o) return true if self.equal?(o) self.class == o.class && account_id == o.account_id && amount == o.amount && iso_currency_code == o.iso_currency_code && unofficial_currency_code == o.unofficial_currency_code && original_description == o.original_description && category == o.category && category_id == o.category_id && credit_category == o.credit_category && check_number == o.check_number && date == o.date && date_transacted == o.date_transacted && location == o.location && name == o.name && merchant_name == o.merchant_name && payment_meta == o.payment_meta && pending == o.pending && pending_transaction_id == o.pending_transaction_id && account_owner == o.account_owner && transaction_id == o.transaction_id && transaction_type == o.transaction_type && income_source_id == o.income_source_id end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/plaid/models/asset_report_transaction.rb, line 390 def _deserialize(type, value) case type.to_sym when :Time Time.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model # models (e.g. Pet) or oneOf klass = Plaid.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/plaid/models/asset_report_transaction.rb, line 461 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/plaid/models/asset_report_transaction.rb, line 366 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) self.class.openapi_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) elsif type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end end self end
@see the ‘==` method @param [Object] Object to be compared
# File lib/plaid/models/asset_report_transaction.rb, line 346 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/plaid/models/asset_report_transaction.rb, line 352 def hash [account_id, amount, iso_currency_code, unofficial_currency_code, original_description, category, category_id, credit_category, check_number, date, date_transacted, location, name, merchant_name, payment_meta, pending, pending_transaction_id, account_owner, transaction_id, transaction_type, income_source_id].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/plaid/models/asset_report_transaction.rb, line 280 def list_invalid_properties invalid_properties = Array.new if @account_id.nil? invalid_properties.push('invalid value for "account_id", account_id cannot be nil.') end if @amount.nil? invalid_properties.push('invalid value for "amount", amount cannot be nil.') end if @date.nil? invalid_properties.push('invalid value for "date", date cannot be nil.') end if @pending.nil? invalid_properties.push('invalid value for "pending", pending cannot be nil.') end if @transaction_id.nil? invalid_properties.push('invalid value for "transaction_id", transaction_id cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/plaid/models/asset_report_transaction.rb, line 443 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/plaid/models/asset_report_transaction.rb, line 431 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/plaid/models/asset_report_transaction.rb, line 307 def valid? return false if @account_id.nil? return false if @amount.nil? return false if @date.nil? return false if @pending.nil? return false if @transaction_id.nil? true end