class Plaid::InvestmentsTransactionsOverride
Specify the list of investments transactions on the account.
Attributes
Either a valid ‘iso_currency_code` or `unofficial_currency_code`
Posting date for the transaction. Must be formatted as an [ISO 8601](wikipedia.org/wiki/ISO_8601) date.
The combined value of all fees applied to this transaction.
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. Must be positive if the type is a buy and negative if the type is a sell.
The type of the investment transaction. Possible values are: ‘buy`: Buying an investment `sell`: Selling an investment `cash`: Activity
that modifies a cash position `fee`: A fee on the account `transfer`: Activity
that modifies a position, but not through buy/sell activity e.g. options exercise, portfolio transfer
Public Class Methods
Source
# File lib/plaid/models/investments_transactions_override.rb, line 57 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/investments_transactions_override.rb, line 43 def self.attribute_map { :'date' => :'date', :'name' => :'name', :'quantity' => :'quantity', :'price' => :'price', :'fees' => :'fees', :'type' => :'type', :'currency' => :'currency', :'security' => :'security' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/investments_transactions_override.rb, line 202 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/investments_transactions_override.rb, line 83 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::InvestmentsTransactionsOverride` 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::InvestmentsTransactionsOverride`. 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?(:'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?(:'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?(:'currency') self.currency = attributes[:'currency'] end if attributes.key?(:'security') self.security = attributes[:'security'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/investments_transactions_override.rb, line 76 def self.openapi_nullable Set.new([ ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/investments_transactions_override.rb, line 62 def self.openapi_types { :'date' => :'Date', :'name' => :'String', :'quantity' => :'Float', :'price' => :'Float', :'fees' => :'Float', :'type' => :'String', :'currency' => :'String', :'security' => :'SecurityOverride' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/investments_transactions_override.rb, line 174 def ==(o) return true if self.equal?(o) self.class == o.class && date == o.date && name == o.name && quantity == o.quantity && price == o.price && fees == o.fees && type == o.type && currency == o.currency && security == o.security end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/investments_transactions_override.rb, line 233 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/investments_transactions_override.rb, line 304 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/investments_transactions_override.rb, line 209 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/investments_transactions_override.rb, line 189 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/investments_transactions_override.rb, line 195 def hash [date, name, quantity, price, fees, type, currency, security].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/investments_transactions_override.rb, line 131 def list_invalid_properties invalid_properties = Array.new 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 @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 @currency.nil? invalid_properties.push('invalid value for "currency", currency 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/investments_transactions_override.rb, line 286 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/investments_transactions_override.rb, line 274 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/investments_transactions_override.rb, line 162 def valid? return false if @date.nil? return false if @name.nil? return false if @quantity.nil? return false if @price.nil? return false if @type.nil? return false if @currency.nil? true end
Check to see if the all the properties in the model are valid @return true if the model is valid