class FinnhubRuby::HistoricalNBBO

Attributes

a[RW]

List of Ask price data.

av[RW]

List of Ask volume data.

ax[RW]

List of venues/exchanges - Ask price. A list of exchange codes can be found <a target="_blank" href="heredocs.google.com/spreadsheets/d/1Tj53M1svmr-hfEtbk6_NpVR1yAyGLMaH6ByYU6CG0ZY/edit?usp=sharing",>here>

b[RW]

List of Bid price data.

bv[RW]

List of Bid volume data.

count[RW]

Number of ticks returned. If count < limit, all data for that date has been returned.

s[RW]

Symbol.

skip[RW]

Number of ticks skipped.

t[RW]

List of timestamp in UNIX ms.

total[RW]

Total number of ticks for that date.

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/finnhub_ruby/models/historical_nbbo.rb, line 73
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/finnhub_ruby/models/historical_nbbo.rb, line 55
def self.attribute_map
  {
    :'s' => :'s',
    :'skip' => :'skip',
    :'count' => :'count',
    :'total' => :'total',
    :'av' => :'av',
    :'a' => :'a',
    :'ax' => :'ax',
    :'bv' => :'bv',
    :'b' => :'b',
    :'bx' => :'bx',
    :'t' => :'t',
    :'c' => :'c'
  }
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/finnhub_ruby/models/historical_nbbo.rb, line 228
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/finnhub_ruby/models/historical_nbbo.rb, line 103
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FinnhubRuby::HistoricalNBBO` 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 `FinnhubRuby::HistoricalNBBO`. 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?(:'s')
    self.s = attributes[:'s']
  end

  if attributes.key?(:'skip')
    self.skip = attributes[:'skip']
  end

  if attributes.key?(:'count')
    self.count = attributes[:'count']
  end

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

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

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

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

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

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

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

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

  if attributes.key?(:'c')
    if (value = attributes[:'c']).is_a?(Array)
      self.c = value
    end
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/finnhub_ruby/models/historical_nbbo.rb, line 96
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/finnhub_ruby/models/historical_nbbo.rb, line 78
def self.openapi_types
  {
    :'s' => :'String',
    :'skip' => :'Integer',
    :'count' => :'Integer',
    :'total' => :'Integer',
    :'av' => :'Array<Float>',
    :'a' => :'Array<Float>',
    :'ax' => :'Array<String>',
    :'bv' => :'Array<Float>',
    :'b' => :'Array<Float>',
    :'bx' => :'Array<String>',
    :'t' => :'Array<Integer>',
    :'c' => :'Array<Array<String>>'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/finnhub_ruby/models/historical_nbbo.rb, line 196
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      s == o.s &&
      skip == o.skip &&
      count == o.count &&
      total == o.total &&
      av == o.av &&
      a == o.a &&
      ax == o.ax &&
      bv == o.bv &&
      b == o.b &&
      bx == o.bx &&
      t == o.t &&
      c == o.c
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/finnhub_ruby/models/historical_nbbo.rb, line 258
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 = FinnhubRuby.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/finnhub_ruby/models/historical_nbbo.rb, line 329
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/finnhub_ruby/models/historical_nbbo.rb, line 235
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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/finnhub_ruby/models/historical_nbbo.rb, line 215
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/finnhub_ruby/models/historical_nbbo.rb, line 221
def hash
  [s, skip, count, total, av, a, ax, bv, b, bx, t, c].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/finnhub_ruby/models/historical_nbbo.rb, line 183
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/finnhub_ruby/models/historical_nbbo.rb, line 305
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/finnhub_ruby/models/historical_nbbo.rb, line 311
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/finnhub_ruby/models/historical_nbbo.rb, line 299
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/finnhub_ruby/models/historical_nbbo.rb, line 190
def valid?
  true
end