class Plaid::TransactionAllOf
Attributes
The counterparties present in the transaction. Counterparties, such as the merchant or the financial institution, are extracted by Plaid
from the raw description.
Date and time when a transaction was posted in [ISO 8601](wikipedia.org/wiki/ISO_8601) format ( ‘YYYY-MM-DDTHH:mm:ssZ` ). For the date that the transaction was initiated, rather than posted, see the `authorized_datetime` field. This field is returned for select financial institutions and comes as provided by the institution. It may contain default time values (such as 00:00:00). This field is only populated in API version 2019-05-29 and later.
A unique, stable, Plaid-generated ID that maps to the merchant. In the case of a merchant with multiple retail locations, this field will map to the broader merchant, not a specific location or store.
The channel used to make a payment. ‘online:` transactions that took place online. `in store:` transactions that were made at a physical location. `other:` transactions that relate to banks, e.g. fees or deposits. This field replaces the `transaction_type` field.
The URL of an icon associated with the primary personal finance category. The icon will always be 100×100 pixel PNG file.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/plaid/models/transaction_all_of.rb, line 81 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/plaid/models/transaction_all_of.rb, line 66 def self.attribute_map { :'authorized_date' => :'authorized_date', :'authorized_datetime' => :'authorized_datetime', :'datetime' => :'datetime', :'payment_channel' => :'payment_channel', :'personal_finance_category' => :'personal_finance_category', :'transaction_code' => :'transaction_code', :'personal_finance_category_icon_url' => :'personal_finance_category_icon_url', :'counterparties' => :'counterparties', :'merchant_entity_id' => :'merchant_entity_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/transaction_all_of.rb, line 227 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/transaction_all_of.rb, line 114 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::TransactionAllOf` 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::TransactionAllOf`. 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?(:'authorized_date') self.authorized_date = attributes[:'authorized_date'] end if attributes.key?(:'authorized_datetime') self.authorized_datetime = attributes[:'authorized_datetime'] end if attributes.key?(:'datetime') self.datetime = attributes[:'datetime'] end if attributes.key?(:'payment_channel') self.payment_channel = attributes[:'payment_channel'] end if attributes.key?(:'personal_finance_category') self.personal_finance_category = attributes[:'personal_finance_category'] end if attributes.key?(:'transaction_code') self.transaction_code = attributes[:'transaction_code'] end if attributes.key?(:'personal_finance_category_icon_url') self.personal_finance_category_icon_url = attributes[:'personal_finance_category_icon_url'] end if attributes.key?(:'counterparties') if (value = attributes[:'counterparties']).is_a?(Array) self.counterparties = value end end if attributes.key?(:'merchant_entity_id') self.merchant_entity_id = attributes[:'merchant_entity_id'] end end
List of attributes with nullable: true
# File lib/plaid/models/transaction_all_of.rb, line 101 def self.openapi_nullable Set.new([ :'authorized_date', :'authorized_datetime', :'datetime', :'personal_finance_category', :'transaction_code', :'merchant_entity_id' ]) end
Attribute type mapping.
# File lib/plaid/models/transaction_all_of.rb, line 86 def self.openapi_types { :'authorized_date' => :'Date', :'authorized_datetime' => :'Time', :'datetime' => :'Time', :'payment_channel' => :'String', :'personal_finance_category' => :'PersonalFinanceCategory', :'transaction_code' => :'TransactionCode', :'personal_finance_category_icon_url' => :'String', :'counterparties' => :'Array<TransactionCounterparty>', :'merchant_entity_id' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/plaid/models/transaction_all_of.rb, line 198 def ==(o) return true if self.equal?(o) self.class == o.class && authorized_date == o.authorized_date && authorized_datetime == o.authorized_datetime && datetime == o.datetime && payment_channel == o.payment_channel && personal_finance_category == o.personal_finance_category && transaction_code == o.transaction_code && personal_finance_category_icon_url == o.personal_finance_category_icon_url && counterparties == o.counterparties && merchant_entity_id == o.merchant_entity_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/transaction_all_of.rb, line 258 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/transaction_all_of.rb, line 329 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/transaction_all_of.rb, line 234 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/transaction_all_of.rb, line 214 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/plaid/models/transaction_all_of.rb, line 220 def hash [authorized_date, authorized_datetime, datetime, payment_channel, personal_finance_category, transaction_code, personal_finance_category_icon_url, counterparties, merchant_entity_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/transaction_all_of.rb, line 168 def list_invalid_properties invalid_properties = Array.new if @payment_channel.nil? invalid_properties.push('invalid value for "payment_channel", payment_channel cannot be nil.') end invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] payment_channel
Object to be assigned
# File lib/plaid/models/transaction_all_of.rb, line 188 def payment_channel=(payment_channel) validator = EnumAttributeValidator.new('String', ["online", "in store", "other"]) unless validator.valid?(payment_channel) fail ArgumentError, "invalid value for \"payment_channel\", must be one of #{validator.allowable_values}." end @payment_channel = payment_channel end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/plaid/models/transaction_all_of.rb, line 311 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/transaction_all_of.rb, line 299 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/transaction_all_of.rb, line 179 def valid? return false if @payment_channel.nil? payment_channel_validator = EnumAttributeValidator.new('String', ["online", "in store", "other"]) return false unless payment_channel_validator.valid?(@payment_channel) true end