class Plaid::Holding
A securities holding at an institution.
Attributes
The Plaid
‘account_id` associated with the holding.
The total cost basis of the holding (e.g., the total amount spent to acquire all assets currently in the holding).
The last price given by the institution for this security.
The date at which ‘institution_price` was current.
Date and time at which ‘institution_price` was current, in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ). 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).
The value of the holding, as reported by the institution.
The ISO-4217 currency code of the holding. Always ‘null` if `unofficial_currency_code` is non-`null`.
The total quantity of the asset held, as reported by the financial institution. If the security is an option, ‘quantity` will reflect the total number of options (typically the number of contracts multiplied by 100), not the number of contracts.
The Plaid
‘security_id` associated with the holding. Security
data is not specific to a user’s account; any user who held the same security at the same financial institution at the same time would have identical security data. The ‘security_id` for the same security will typically be the same across different institutions, but this is not guaranteed. The `security_id` does not typically change, but may change if inherent details of the security change due to a corporate action, for example, in the event of a ticker symbol change or CUSIP change.
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.
The total quantity of vested assets held, as reported by the financial institution. Vested assets are only associated with [equities](plaid.com/docs/api/products/investments/#investments-holdings-get-response-securities-type).
The value of the vested holdings as reported by the institution.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/plaid/models/holding.rb, line 74 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/plaid/models/holding.rb, line 56 def self.attribute_map { :'account_id' => :'account_id', :'security_id' => :'security_id', :'institution_price' => :'institution_price', :'institution_price_as_of' => :'institution_price_as_of', :'institution_price_datetime' => :'institution_price_datetime', :'institution_value' => :'institution_value', :'cost_basis' => :'cost_basis', :'quantity' => :'quantity', :'iso_currency_code' => :'iso_currency_code', :'unofficial_currency_code' => :'unofficial_currency_code', :'vested_quantity' => :'vested_quantity', :'vested_value' => :'vested_value' } 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/holding.rb, line 245 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/holding.rb, line 111 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::Holding` 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::Holding`. 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?(:'security_id') self.security_id = attributes[:'security_id'] end if attributes.key?(:'institution_price') self.institution_price = attributes[:'institution_price'] end if attributes.key?(:'institution_price_as_of') self.institution_price_as_of = attributes[:'institution_price_as_of'] end if attributes.key?(:'institution_price_datetime') self.institution_price_datetime = attributes[:'institution_price_datetime'] end if attributes.key?(:'institution_value') self.institution_value = attributes[:'institution_value'] end if attributes.key?(:'cost_basis') self.cost_basis = attributes[:'cost_basis'] end if attributes.key?(:'quantity') self.quantity = attributes[:'quantity'] 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?(:'vested_quantity') self.vested_quantity = attributes[:'vested_quantity'] end if attributes.key?(:'vested_value') self.vested_value = attributes[:'vested_value'] end end
List of attributes with nullable: true
# File lib/plaid/models/holding.rb, line 97 def self.openapi_nullable Set.new([ :'institution_price_as_of', :'institution_price_datetime', :'cost_basis', :'iso_currency_code', :'unofficial_currency_code', :'vested_quantity', :'vested_value' ]) end
Attribute type mapping.
# File lib/plaid/models/holding.rb, line 79 def self.openapi_types { :'account_id' => :'String', :'security_id' => :'String', :'institution_price' => :'Float', :'institution_price_as_of' => :'Date', :'institution_price_datetime' => :'Time', :'institution_value' => :'Float', :'cost_basis' => :'Float', :'quantity' => :'Float', :'iso_currency_code' => :'String', :'unofficial_currency_code' => :'String', :'vested_quantity' => :'Float', :'vested_value' => :'Float' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/plaid/models/holding.rb, line 213 def ==(o) return true if self.equal?(o) self.class == o.class && account_id == o.account_id && security_id == o.security_id && institution_price == o.institution_price && institution_price_as_of == o.institution_price_as_of && institution_price_datetime == o.institution_price_datetime && institution_value == o.institution_value && cost_basis == o.cost_basis && quantity == o.quantity && iso_currency_code == o.iso_currency_code && unofficial_currency_code == o.unofficial_currency_code && vested_quantity == o.vested_quantity && vested_value == o.vested_value 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/holding.rb, line 276 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/holding.rb, line 347 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/holding.rb, line 252 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/holding.rb, line 232 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/plaid/models/holding.rb, line 238 def hash [account_id, security_id, institution_price, institution_price_as_of, institution_price_datetime, institution_value, cost_basis, quantity, iso_currency_code, unofficial_currency_code, vested_quantity, vested_value].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/holding.rb, line 175 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 @security_id.nil? invalid_properties.push('invalid value for "security_id", security_id cannot be nil.') end if @institution_price.nil? invalid_properties.push('invalid value for "institution_price", institution_price cannot be nil.') end if @institution_value.nil? invalid_properties.push('invalid value for "institution_value", institution_value cannot be nil.') end if @quantity.nil? invalid_properties.push('invalid value for "quantity", quantity 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/holding.rb, line 329 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/holding.rb, line 317 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/holding.rb, line 202 def valid? return false if @account_id.nil? return false if @security_id.nil? return false if @institution_price.nil? return false if @institution_value.nil? return false if @quantity.nil? true end