class Intrinio::ZacksAnalystRatingSnapshot

A snapshot of ratings data compared with previous timeframes. This includes mean percentiles for comparing one security to the universe of securities covered by Zacks analyst ratings, at a specific point in time.

Attributes

buys[RW]

The number of analysts recommending Buy.

holds[RW]

The number of analysts recommending Hold.

mean[RW]

The mean (average) weighing of analyst recommendations, from 1 (strong buy) to 5 (strong sell).

percentile[RW]

The percentile of the mean, derived by comparing to all securities rated by analysts as of the rating date, ranging 0.0 (strong buy) to 1.0 (strong sell).

rating_date[RW]

The date of the latest rating for the snapshot timeframe. This is the effective date of the ratings data.

sells[RW]

The number of analysts recommending Sell.

snapshot_date[RW]

The date of the snapshot, when data was recorded.

strong_buys[RW]

The number of analysts recommending Strong Buy.

strong_sells[RW]

The number of analysts recommending Strong Sell.

total[RW]

The total number of analysts recommendations.

type[RW]

The snapshot type, signifying the age of the ratings data from the snapshot date.

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_analyst_rating_snapshot.rb, line 53
def self.attribute_map
  {
    :'type' => :'type',
    :'snapshot_date' => :'snapshot_date',
    :'rating_date' => :'rating_date',
    :'mean' => :'mean',
    :'percentile' => :'percentile',
    :'strong_buys' => :'strong_buys',
    :'buys' => :'buys',
    :'holds' => :'holds',
    :'sells' => :'sells',
    :'strong_sells' => :'strong_sells',
    :'total' => :'total'
  }
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_analyst_rating_snapshot.rb, line 88
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?(:'type')
    self.type = attributes[:'type']
  end

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

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

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

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

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/intrinio-sdk/models/zacks_analyst_rating_snapshot.rb, line 70
def self.swagger_types
  {
    :'type' => :'String',
    :'snapshot_date' => :'Date',
    :'rating_date' => :'Date',
    :'mean' => :'Float',
    :'percentile' => :'Float',
    :'strong_buys' => :'Integer',
    :'buys' => :'Integer',
    :'holds' => :'Integer',
    :'sells' => :'Integer',
    :'strong_sells' => :'Integer',
    :'total' => :'Integer'
  }
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_analyst_rating_snapshot.rb, line 155
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      snapshot_date == o.snapshot_date &&
      rating_date == o.rating_date &&
      mean == o.mean &&
      percentile == o.percentile &&
      strong_buys == o.strong_buys &&
      buys == o.buys &&
      holds == o.holds &&
      sells == o.sells &&
      strong_sells == o.strong_sells &&
      total == o.total
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_analyst_rating_snapshot.rb, line 207
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_analyst_rating_snapshot.rb, line 273
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_analyst_rating_snapshot.rb, line 186
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_analyst_rating_snapshot.rb, line 173
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_analyst_rating_snapshot.rb, line 179
def hash
  [type, snapshot_date, rating_date, mean, percentile, strong_buys, buys, holds, sells, strong_sells, total].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_analyst_rating_snapshot.rb, line 142
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_analyst_rating_snapshot.rb, line 253
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_analyst_rating_snapshot.rb, line 259
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_analyst_rating_snapshot.rb, line 247
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_analyst_rating_snapshot.rb, line 149
def valid?
  return true
end