class Atrium::Holding

Attributes

account_guid[RW]
cost_basis[RW]
created_at[RW]
currency_code[RW]
cusip[RW]
daily_change[RW]
description[RW]
guid[RW]
holding_type[RW]
market_value[RW]
member_guid[RW]
purchase_price[RW]
shares[RW]
symbol[RW]
updated_at[RW]
user_guid[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/atrium-ruby/models/holding.rb, line 46
def self.attribute_map
  {
    :'account_guid' => :'account_guid',
    :'cost_basis' => :'cost_basis',
    :'created_at' => :'created_at',
    :'currency_code' => :'currency_code',
    :'cusip' => :'cusip',
    :'daily_change' => :'daily_change',
    :'description' => :'description',
    :'guid' => :'guid',
    :'holding_type' => :'holding_type',
    :'market_value' => :'market_value',
    :'member_guid' => :'member_guid',
    :'purchase_price' => :'purchase_price',
    :'shares' => :'shares',
    :'symbol' => :'symbol',
    :'updated_at' => :'updated_at',
    :'user_guid' => :'user_guid'
  }
end
mx_types() click to toggle source

Attribute type mapping.

# File lib/atrium-ruby/models/holding.rb, line 68
def self.mx_types
  {
    :'account_guid' => :'String',
    :'cost_basis' => :'Float',
    :'created_at' => :'String',
    :'currency_code' => :'String',
    :'cusip' => :'String',
    :'daily_change' => :'Float',
    :'description' => :'String',
    :'guid' => :'String',
    :'holding_type' => :'String',
    :'market_value' => :'Float',
    :'member_guid' => :'String',
    :'purchase_price' => :'Float',
    :'shares' => :'Float',
    :'symbol' => :'String',
    :'updated_at' => :'String',
    :'user_guid' => :'String'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/atrium-ruby/models/holding.rb, line 91
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'account_guid')
    self.account_guid = attributes[:'account_guid']
  end

  if attributes.has_key?(:'cost_basis')
    self.cost_basis = attributes[:'cost_basis']
  end

  if attributes.has_key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.has_key?(:'currency_code')
    self.currency_code = attributes[:'currency_code']
  end

  if attributes.has_key?(:'cusip')
    self.cusip = attributes[:'cusip']
  end

  if attributes.has_key?(:'daily_change')
    self.daily_change = attributes[:'daily_change']
  end

  if attributes.has_key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.has_key?(:'guid')
    self.guid = attributes[:'guid']
  end

  if attributes.has_key?(:'holding_type')
    self.holding_type = attributes[:'holding_type']
  end

  if attributes.has_key?(:'market_value')
    self.market_value = attributes[:'market_value']
  end

  if attributes.has_key?(:'member_guid')
    self.member_guid = attributes[:'member_guid']
  end

  if attributes.has_key?(:'purchase_price')
    self.purchase_price = attributes[:'purchase_price']
  end

  if attributes.has_key?(:'shares')
    self.shares = attributes[:'shares']
  end

  if attributes.has_key?(:'symbol')
    self.symbol = attributes[:'symbol']
  end

  if attributes.has_key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  end

  if attributes.has_key?(:'user_guid')
    self.user_guid = attributes[:'user_guid']
  end
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/atrium-ruby/models/holding.rb, line 177
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      account_guid == o.account_guid &&
      cost_basis == o.cost_basis &&
      created_at == o.created_at &&
      currency_code == o.currency_code &&
      cusip == o.cusip &&
      daily_change == o.daily_change &&
      description == o.description &&
      guid == o.guid &&
      holding_type == o.holding_type &&
      market_value == o.market_value &&
      member_guid == o.member_guid &&
      purchase_price == o.purchase_price &&
      shares == o.shares &&
      symbol == o.symbol &&
      updated_at == o.updated_at &&
      user_guid == o.user_guid
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/atrium-ruby/models/holding.rb, line 234
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = Atrium.const_get(type).new
    temp_model.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/atrium-ruby/models/holding.rb, line 300
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/atrium-ruby/models/holding.rb, line 213
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.mx_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

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

# File lib/atrium-ruby/models/holding.rb, line 200
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/atrium-ruby/models/holding.rb, line 206
def hash
  [account_guid, cost_basis, created_at, currency_code, cusip, daily_change, description, guid, holding_type, market_value, member_guid, purchase_price, shares, symbol, updated_at, user_guid].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/atrium-ruby/models/holding.rb, line 164
def list_invalid_properties
  invalid_properties = Array.new
  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/atrium-ruby/models/holding.rb, line 280
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/atrium-ruby/models/holding.rb, line 286
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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/atrium-ruby/models/holding.rb, line 274
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/atrium-ruby/models/holding.rb, line 171
def valid?
  true
end