class Plaid::AssetReportInvestmentHolding

A securities holding at an institution.

Attributes

account_id[RW]

The Plaid ‘account_id` associated with the holding.

cost_basis[RW]

The original total value of the holding. This field is calculated by Plaid as the sum of the purchase price of all of the shares in the holding.

institution_price[RW]

The last price given by the institution for this security.

institution_price_as_of[RW]

The date at which ‘institution_price` was current.

institution_value[RW]

The value of the holding, as reported by the institution.

iso_currency_code[RW]

The ISO-4217 currency code of the holding. Always ‘null` if `unofficial_currency_code` is non-`null`.

quantity[RW]

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.

security_id[RW]

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.

ticker_symbol[RW]

The holding’s trading symbol for publicly traded holdings, and otherwise a short identifier if available.

unofficial_currency_code[RW]

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

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/plaid/models/asset_report_investment_holding.rb, line 66
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/plaid/models/asset_report_investment_holding.rb, line 50
def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'security_id' => :'security_id',
    :'ticker_symbol' => :'ticker_symbol',
    :'institution_price' => :'institution_price',
    :'institution_price_as_of' => :'institution_price_as_of',
    :'institution_value' => :'institution_value',
    :'cost_basis' => :'cost_basis',
    :'quantity' => :'quantity',
    :'iso_currency_code' => :'iso_currency_code',
    :'unofficial_currency_code' => :'unofficial_currency_code'
  }
end
build_from_hash(attributes) click to toggle source

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_investment_holding.rb, line 223
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/plaid/models/asset_report_investment_holding.rb, line 99
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::AssetReportInvestmentHolding` 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::AssetReportInvestmentHolding`. 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?(:'ticker_symbol')
    self.ticker_symbol = attributes[:'ticker_symbol']
  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_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
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/plaid/models/asset_report_investment_holding.rb, line 87
def self.openapi_nullable
  Set.new([
    :'ticker_symbol',
    :'institution_price_as_of',
    :'cost_basis',
    :'iso_currency_code',
    :'unofficial_currency_code'
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/plaid/models/asset_report_investment_holding.rb, line 71
def self.openapi_types
  {
    :'account_id' => :'String',
    :'security_id' => :'String',
    :'ticker_symbol' => :'String',
    :'institution_price' => :'Float',
    :'institution_price_as_of' => :'Date',
    :'institution_value' => :'Float',
    :'cost_basis' => :'Float',
    :'quantity' => :'Float',
    :'iso_currency_code' => :'String',
    :'unofficial_currency_code' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/plaid/models/asset_report_investment_holding.rb, line 193
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      account_id == o.account_id &&
      security_id == o.security_id &&
      ticker_symbol == o.ticker_symbol &&
      institution_price == o.institution_price &&
      institution_price_as_of == o.institution_price_as_of &&
      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
end
_deserialize(type, value) click to toggle source

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_investment_holding.rb, line 254
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
_to_hash(value) click to toggle source

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_investment_holding.rb, line 325
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
build_from_hash(attributes) click to toggle source

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_investment_holding.rb, line 230
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
eql?(o) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/plaid/models/asset_report_investment_holding.rb, line 210
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/plaid/models/asset_report_investment_holding.rb, line 216
def hash
  [account_id, security_id, ticker_symbol, institution_price, institution_price_as_of, institution_value, cost_basis, quantity, iso_currency_code, unofficial_currency_code].hash
end
list_invalid_properties() click to toggle source

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_investment_holding.rb, line 155
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
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/plaid/models/asset_report_investment_holding.rb, line 301
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/plaid/models/asset_report_investment_holding.rb, line 307
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/plaid/models/asset_report_investment_holding.rb, line 295
def to_s
  to_hash.to_s
end
valid?() click to toggle source

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_investment_holding.rb, line 182
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