class Intrinio::StockPriceSummary

The summary of a stock price for a security on a given date.

Attributes

adj_close[RW]

The price at the end of the period, adjusted for splits and dividends

adj_high[RW]

The highest price over the span of the period, adjusted for splits and dividends

adj_low[RW]

The lowest price over the span of the period, adjusted for splits and dividends

adj_open[RW]

The price at the beginning of the period, adjusted for splits and dividends

adj_volume[RW]

The number of shares exchanged during the period, adjusted for splits and dividends

change[RW]

The difference in price from the last price for this frequency

close[RW]

The price at the end of the period

date[RW]

The calendar date that the stock price represents. For non-daily stock prices, this represents the last day in the period (end of the week, month, quarter, year, etc)

dividend[RW]

The dividend amount, if a dividend was paid.

factor[RW]

The factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices.

fifty_two_week_high[RW]

The 52 week high price (daily only)

fifty_two_week_low[RW]

The 52 week low price (daily only)

frequency[RW]

The type of period that the stock price represents

high[RW]

The highest price over the span of the period

intraperiod[RW]

If true, the stock price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period

low[RW]

The lowest price over the span of the period

open[RW]

The price at the beginning of the period

percent_change[RW]

The percent difference in price from the last price for this frequency

split_ratio[RW]

The ratio of the stock split, if a stock split occurred.

volume[RW]

The number of shares exchanged during the period

Public Class Methods

attribute_map() click to toggle source

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

# File lib/intrinio-sdk/models/stock_price_summary.rb, line 101
def self.attribute_map
  {
    :'date' => :'date',
    :'intraperiod' => :'intraperiod',
    :'frequency' => :'frequency',
    :'open' => :'open',
    :'high' => :'high',
    :'low' => :'low',
    :'close' => :'close',
    :'volume' => :'volume',
    :'adj_open' => :'adj_open',
    :'adj_high' => :'adj_high',
    :'adj_low' => :'adj_low',
    :'adj_close' => :'adj_close',
    :'adj_volume' => :'adj_volume',
    :'factor' => :'factor',
    :'split_ratio' => :'split_ratio',
    :'dividend' => :'dividend',
    :'change' => :'change',
    :'percent_change' => :'percent_change',
    :'fifty_two_week_high' => :'fifty_two_week_high',
    :'fifty_two_week_low' => :'fifty_two_week_low'
  }
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/stock_price_summary.rb, line 154
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?(:'date')
    self.date = attributes[:'date']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/intrinio-sdk/models/stock_price_summary.rb, line 127
def self.swagger_types
  {
    :'date' => :'Date',
    :'intraperiod' => :'BOOLEAN',
    :'frequency' => :'String',
    :'open' => :'Float',
    :'high' => :'Float',
    :'low' => :'Float',
    :'close' => :'Float',
    :'volume' => :'Float',
    :'adj_open' => :'Float',
    :'adj_high' => :'Float',
    :'adj_low' => :'Float',
    :'adj_close' => :'Float',
    :'adj_volume' => :'Float',
    :'factor' => :'Float',
    :'split_ratio' => :'Float',
    :'dividend' => :'Float',
    :'change' => :'Float',
    :'percent_change' => :'Float',
    :'fifty_two_week_high' => :'Float',
    :'fifty_two_week_low' => :'Float'
  }
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/stock_price_summary.rb, line 269
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      date == o.date &&
      intraperiod == o.intraperiod &&
      frequency == o.frequency &&
      open == o.open &&
      high == o.high &&
      low == o.low &&
      close == o.close &&
      volume == o.volume &&
      adj_open == o.adj_open &&
      adj_high == o.adj_high &&
      adj_low == o.adj_low &&
      adj_close == o.adj_close &&
      adj_volume == o.adj_volume &&
      factor == o.factor &&
      split_ratio == o.split_ratio &&
      dividend == o.dividend &&
      change == o.change &&
      percent_change == o.percent_change &&
      fifty_two_week_high == o.fifty_two_week_high &&
      fifty_two_week_low == o.fifty_two_week_low
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/stock_price_summary.rb, line 330
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/stock_price_summary.rb, line 396
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/stock_price_summary.rb, line 309
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/stock_price_summary.rb, line 296
def eql?(o)
  self == o
end
frequency=(frequency) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] frequency Object to be assigned

# File lib/intrinio-sdk/models/stock_price_summary.rb, line 259
def frequency=(frequency)
  validator = EnumAttributeValidator.new('String', ["daily", "weekly", "monthly", "quarterly", "yearly"])
  unless validator.valid?(frequency)
    fail ArgumentError, "invalid value for 'frequency', must be one of #{validator.allowable_values}."
  end
  @frequency = frequency
end
hash() click to toggle source

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

# File lib/intrinio-sdk/models/stock_price_summary.rb, line 302
def hash
  [date, intraperiod, frequency, open, high, low, close, volume, adj_open, adj_high, adj_low, adj_close, adj_volume, factor, split_ratio, dividend, change, percent_change, fifty_two_week_high, fifty_two_week_low].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/stock_price_summary.rb, line 244
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/stock_price_summary.rb, line 376
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/stock_price_summary.rb, line 382
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/stock_price_summary.rb, line 370
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/stock_price_summary.rb, line 251
def valid?
  frequency_validator = EnumAttributeValidator.new('String', ["daily", "weekly", "monthly", "quarterly", "yearly"])
  return false unless frequency_validator.valid?(@frequency)
  return true
end