class Plaid::InvestmentTransaction
A transaction within an investment account.
Attributes
The ‘account_id` of the account against which this transaction posted.
The complete value of the transaction. Positive values when cash is debited, e.g. purchases of stock; negative values when cash is credited, e.g. sales of stock. Treatment remains the same for cash-only movements unassociated with securities.
A legacy field formerly used internally by Plaid
to identify certain canceled transactions.
The [ISO 8601](wikipedia.org/wiki/ISO_8601) posting date for the transaction.
The combined value of all fees applied to this transaction
The ISO-4217 currency code of the transaction. Always ‘null` if `unofficial_currency_code` is non-`null`.
The institution’s description of the transaction.
The price of the security at which this transaction occurred.
The number of units of the security involved in this transaction. Positive for buy transactions; negative for sell transactions.
The ‘security_id` to which this transaction is related.
The unofficial currency code associated with the holding. 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 `iso_currency_code`s.
Public Class Methods
Source
# File lib/plaid/models/investment_transaction.rb, line 102 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/investment_transaction.rb, line 82 def self.attribute_map { :'investment_transaction_id' => :'investment_transaction_id', :'cancel_transaction_id' => :'cancel_transaction_id', :'account_id' => :'account_id', :'security_id' => :'security_id', :'date' => :'date', :'name' => :'name', :'quantity' => :'quantity', :'amount' => :'amount', :'price' => :'price', :'fees' => :'fees', :'type' => :'type', :'subtype' => :'subtype', :'iso_currency_code' => :'iso_currency_code', :'unofficial_currency_code' => :'unofficial_currency_code' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/investment_transaction.rb, line 303 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/investment_transaction.rb, line 139 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::InvestmentTransaction` 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::InvestmentTransaction`. 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?(:'investment_transaction_id') self.investment_transaction_id = attributes[:'investment_transaction_id'] end if attributes.key?(:'cancel_transaction_id') self.cancel_transaction_id = attributes[:'cancel_transaction_id'] end if attributes.key?(:'account_id') self.account_id = attributes[:'account_id'] end if attributes.key?(:'security_id') self.security_id = attributes[:'security_id'] end if attributes.key?(:'date') self.date = attributes[:'date'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'quantity') self.quantity = attributes[:'quantity'] end if attributes.key?(:'amount') self.amount = attributes[:'amount'] end if attributes.key?(:'price') self.price = attributes[:'price'] end if attributes.key?(:'fees') self.fees = attributes[:'fees'] end if attributes.key?(:'type') self.type = attributes[:'type'] end if attributes.key?(:'subtype') self.subtype = attributes[:'subtype'] 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 end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/investment_transaction.rb, line 127 def self.openapi_nullable Set.new([ :'cancel_transaction_id', :'security_id', :'fees', :'iso_currency_code', :'unofficial_currency_code' ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/investment_transaction.rb, line 107 def self.openapi_types { :'investment_transaction_id' => :'String', :'cancel_transaction_id' => :'String', :'account_id' => :'String', :'security_id' => :'String', :'date' => :'Date', :'name' => :'String', :'quantity' => :'Float', :'amount' => :'Float', :'price' => :'Float', :'fees' => :'Float', :'type' => :'InvestmentTransactionType', :'subtype' => :'InvestmentTransactionSubtype', :'iso_currency_code' => :'String', :'unofficial_currency_code' => :'String' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/investment_transaction.rb, line 269 def ==(o) return true if self.equal?(o) self.class == o.class && investment_transaction_id == o.investment_transaction_id && cancel_transaction_id == o.cancel_transaction_id && account_id == o.account_id && security_id == o.security_id && date == o.date && name == o.name && quantity == o.quantity && amount == o.amount && price == o.price && fees == o.fees && type == o.type && subtype == o.subtype && iso_currency_code == o.iso_currency_code && unofficial_currency_code == o.unofficial_currency_code end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/investment_transaction.rb, line 334 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/plaid/models/investment_transaction.rb, line 405 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
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
Source
# File lib/plaid/models/investment_transaction.rb, line 310 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/investment_transaction.rb, line 290 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/investment_transaction.rb, line 296 def hash [investment_transaction_id, cancel_transaction_id, account_id, security_id, date, name, quantity, amount, price, fees, type, subtype, iso_currency_code, unofficial_currency_code].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/investment_transaction.rb, line 211 def list_invalid_properties invalid_properties = Array.new if @investment_transaction_id.nil? invalid_properties.push('invalid value for "investment_transaction_id", investment_transaction_id cannot be nil.') end if @account_id.nil? invalid_properties.push('invalid value for "account_id", account_id cannot be nil.') end if @date.nil? invalid_properties.push('invalid value for "date", date cannot be nil.') end if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @quantity.nil? invalid_properties.push('invalid value for "quantity", quantity cannot be nil.') end if @amount.nil? invalid_properties.push('invalid value for "amount", amount cannot be nil.') end if @price.nil? invalid_properties.push('invalid value for "price", price cannot be nil.') end if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end if @subtype.nil? invalid_properties.push('invalid value for "subtype", subtype cannot be nil.') end invalid_properties end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Source
Source
# File lib/plaid/models/investment_transaction.rb, line 387 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 object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/plaid/models/investment_transaction.rb, line 375 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/plaid/models/investment_transaction.rb, line 254 def valid? return false if @investment_transaction_id.nil? return false if @account_id.nil? return false if @date.nil? return false if @name.nil? return false if @quantity.nil? return false if @amount.nil? return false if @price.nil? return false if @type.nil? return false if @subtype.nil? true end
Check to see if the all the properties in the model are valid @return true if the model is valid