class Intrinio::OptionUnusualTrade

A large market order that is broken into a collection of smaller orders to take advantage of all contracts and prices offered across all exchanges.

Attributes

average_price[RW]

The average premium paid per option contract

contract[RW]
symbol[RW]

The underlying option security symbol for the trade

timestamp[RW]

The UTC timestamp of order placement

total_size[RW]

The total number of contracts involved in a single transaction

total_value[RW]

The aggregated value of all option contract premiums included in the trade\

type[RW]

The type of unusual trade

Public Class Methods

attribute_map() click to toggle source

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

# File lib/intrinio-sdk/models/option_unusual_trade.rb, line 40
def self.attribute_map
  {
    :'symbol' => :'symbol',
    :'timestamp' => :'timestamp',
    :'type' => :'type',
    :'total_value' => :'total_value',
    :'total_size' => :'total_size',
    :'average_price' => :'average_price',
    :'contract' => :'contract'
  }
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/option_unusual_trade.rb, line 67
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?(:'symbol')
    self.symbol = attributes[:'symbol']
  end

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/intrinio-sdk/models/option_unusual_trade.rb, line 53
def self.swagger_types
  {
    :'symbol' => :'String',
    :'timestamp' => :'Date',
    :'type' => :'String',
    :'total_value' => :'Float',
    :'total_size' => :'Float',
    :'average_price' => :'Float',
    :'contract' => :'String'
  }
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/option_unusual_trade.rb, line 118
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      symbol == o.symbol &&
      timestamp == o.timestamp &&
      type == o.type &&
      total_value == o.total_value &&
      total_size == o.total_size &&
      average_price == o.average_price &&
      contract == o.contract
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/option_unusual_trade.rb, line 166
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/option_unusual_trade.rb, line 232
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/option_unusual_trade.rb, line 145
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/option_unusual_trade.rb, line 132
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/option_unusual_trade.rb, line 138
def hash
  [symbol, timestamp, type, total_value, total_size, average_price, contract].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/option_unusual_trade.rb, line 105
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/option_unusual_trade.rb, line 212
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/option_unusual_trade.rb, line 218
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/option_unusual_trade.rb, line 206
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/option_unusual_trade.rb, line 112
def valid?
  return true
end