class Intrinio::ZacksInstitutionalHolding

Returns a list of all ownership interests and the value of their interests sourced from Zacks.

Attributes

as_of_date[RW]

Quarter end date listed in the most recent 13F report filed by the institution

company[RW]
historical_holdings[RW]
last_sec_filing_date[RW]

The date of the latest SEC filing

last_sec_filing_shares[RW]

The

last_sec_filing_type[RW]

The report type of the latest SEC filing

market_value[RW]

Market value of shares outstanding held of the stock listed

market_value_change[RW]

Change in market value shares of the stock listed

owner[RW]
shared_held_percent[RW]

Percent of shares outstanding held of the stock by the institution listed

shares_change[RW]

Change in shares of the stock held by the institution listed

shares_change_percent[RW]

Percentage change in shares of the stock held by the institution listed

shares_held[RW]

Number of shares of the stock listed

Public Class Methods

attribute_map() click to toggle source

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

# File lib/intrinio-sdk/models/zacks_institutional_holding.rb, line 56
def self.attribute_map
  {
    :'company' => :'company',
    :'owner' => :'owner',
    :'as_of_date' => :'as_of_date',
    :'shares_held' => :'shares_held',
    :'shared_held_percent' => :'shared_held_percent',
    :'shares_change' => :'shares_change',
    :'shares_change_percent' => :'shares_change_percent',
    :'market_value' => :'market_value',
    :'market_value_change' => :'market_value_change',
    :'last_sec_filing_type' => :'last_sec_filing_type',
    :'last_sec_filing_date' => :'last_sec_filing_date',
    :'last_sec_filing_shares' => :'last_sec_filing_shares',
    :'historical_holdings' => :'historical_holdings'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/intrinio-sdk/models/zacks_institutional_holding.rb, line 95
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?(:'company')
    self.company = attributes[:'company']
  end

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'historical_holdings')
    if (value = attributes[:'historical_holdings']).is_a?(Array)
      self.historical_holdings = value
    end
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/intrinio-sdk/models/zacks_institutional_holding.rb, line 75
def self.swagger_types
  {
    :'company' => :'ZacksInstitutionalHoldingCompanySummary',
    :'owner' => :'ZacksInstitutionalHoldingOwnerSummary',
    :'as_of_date' => :'Date',
    :'shares_held' => :'Float',
    :'shared_held_percent' => :'Float',
    :'shares_change' => :'Float',
    :'shares_change_percent' => :'Float',
    :'market_value' => :'Float',
    :'market_value_change' => :'Float',
    :'last_sec_filing_type' => :'String',
    :'last_sec_filing_date' => :'Date',
    :'last_sec_filing_shares' => :'Float',
    :'historical_holdings' => :'Array<ZacksInstitutionalHoldingHistoricalSummary>'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/intrinio-sdk/models/zacks_institutional_holding.rb, line 172
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      company == o.company &&
      owner == o.owner &&
      as_of_date == o.as_of_date &&
      shares_held == o.shares_held &&
      shared_held_percent == o.shared_held_percent &&
      shares_change == o.shares_change &&
      shares_change_percent == o.shares_change_percent &&
      market_value == o.market_value &&
      market_value_change == o.market_value_change &&
      last_sec_filing_type == o.last_sec_filing_type &&
      last_sec_filing_date == o.last_sec_filing_date &&
      last_sec_filing_shares == o.last_sec_filing_shares &&
      historical_holdings == o.historical_holdings
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/intrinio-sdk/models/zacks_institutional_holding.rb, line 226
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 = Intrinio.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/intrinio-sdk/models/zacks_institutional_holding.rb, line 292
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/intrinio-sdk/models/zacks_institutional_holding.rb, line 205
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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/intrinio-sdk/models/zacks_institutional_holding.rb, line 192
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/intrinio-sdk/models/zacks_institutional_holding.rb, line 198
def hash
  [company, owner, as_of_date, shares_held, shared_held_percent, shares_change, shares_change_percent, market_value, market_value_change, last_sec_filing_type, last_sec_filing_date, last_sec_filing_shares, historical_holdings].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/intrinio-sdk/models/zacks_institutional_holding.rb, line 159
def list_invalid_properties
  invalid_properties = Array.new
  return 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/intrinio-sdk/models/zacks_institutional_holding.rb, line 272
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/intrinio-sdk/models/zacks_institutional_holding.rb, line 278
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/intrinio-sdk/models/zacks_institutional_holding.rb, line 266
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/intrinio-sdk/models/zacks_institutional_holding.rb, line 166
def valid?
  return true
end