Class: Intrinio::OptionUnusualTrade

Inherits:
Object
  • Object
show all
Defined in:
lib/intrinio-sdk/models/option_unusual_trade.rb

Overview

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.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OptionUnusualTrade

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/intrinio-sdk/models/option_unusual_trade.rb', line 109

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

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

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

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

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

end

Instance Attribute Details

#ask_at_execution ⇒ Object

Ask price at execution



40
41
42
 
# File 'lib/intrinio-sdk/models/option_unusual_trade.rb', line 40

def ask_at_execution
  @ask_at_execution
end

#average_price ⇒ Object

The average premium paid per option contract



34
35
36
 
# File 'lib/intrinio-sdk/models/option_unusual_trade.rb', line 34

def average_price
  @average_price
end

#bid_at_execution ⇒ Object

Bid price at execution



43
44
45
 
# File 'lib/intrinio-sdk/models/option_unusual_trade.rb', line 43

def bid_at_execution
  @bid_at_execution
end

#contract ⇒ Object

The option contract symbol



37
38
39
 
# File 'lib/intrinio-sdk/models/option_unusual_trade.rb', line 37

def contract
  @contract
end

#sentiment ⇒ Object

Bullish, Bearish, or Neutral Sentiment is estimated based on whether the trade was executed at the bid, ask, or mark price.



46
47
48
 
# File 'lib/intrinio-sdk/models/option_unusual_trade.rb', line 46

def sentiment
  @sentiment
end

#symbol ⇒ Object

The underlying option security symbol for the trade



19
20
21
 
# File 'lib/intrinio-sdk/models/option_unusual_trade.rb', line 19

def symbol
  @symbol
end

#timestamp ⇒ Object

The UTC timestamp of order placement



22
23
24
 
# File 'lib/intrinio-sdk/models/option_unusual_trade.rb', line 22

def timestamp
  @timestamp
end

#total_size ⇒ Object

The total number of contracts involved in a single transaction



31
32
33
 
# File 'lib/intrinio-sdk/models/option_unusual_trade.rb', line 31

def total_size
  @total_size
end

#total_value ⇒ Object

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



28
29
30
 
# File 'lib/intrinio-sdk/models/option_unusual_trade.rb', line 28

def total_value
  @total_value
end

#type ⇒ Object

The type of unusual trade



25
26
27
 
# File 'lib/intrinio-sdk/models/option_unusual_trade.rb', line 25

def type
  @type
end

#underlying_price_at_execution ⇒ Object

Price of the underlying security at execution of trade



49
50
51
 
# File 'lib/intrinio-sdk/models/option_unusual_trade.rb', line 49

def underlying_price_at_execution
  @underlying_price_at_execution
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/intrinio-sdk/models/option_unusual_trade.rb', line 74

def self.attribute_map
  {
    :'symbol' => :'symbol',
    :'timestamp' => :'timestamp',
    :'type' => :'type',
    :'total_value' => :'total_value',
    :'total_size' => :'total_size',
    :'average_price' => :'average_price',
    :'contract' => :'contract',
    :'ask_at_execution' => :'ask_at_execution',
    :'bid_at_execution' => :'bid_at_execution',
    :'sentiment' => :'sentiment',
    :'underlying_price_at_execution' => :'underlying_price_at_execution'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/intrinio-sdk/models/option_unusual_trade.rb', line 91

def self.swagger_types
  {
    :'symbol' => :'String',
    :'timestamp' => :'Date',
    :'type' => :'String',
    :'total_value' => :'Float',
    :'total_size' => :'Float',
    :'average_price' => :'Float',
    :'contract' => :'String',
    :'ask_at_execution' => :'Float',
    :'bid_at_execution' => :'Float',
    :'sentiment' => :'String',
    :'underlying_price_at_execution' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/intrinio-sdk/models/option_unusual_trade.rb', line 188

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 &&
      ask_at_execution == o.ask_at_execution &&
      bid_at_execution == o.bid_at_execution &&
      sentiment == o.sentiment &&
      underlying_price_at_execution == o.underlying_price_at_execution
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/intrinio-sdk/models/option_unusual_trade.rb', line 240

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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/intrinio-sdk/models/option_unusual_trade.rb', line 306

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/intrinio-sdk/models/option_unusual_trade.rb', line 219

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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


206
207
208
 
# File 'lib/intrinio-sdk/models/option_unusual_trade.rb', line 206

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



212
213
214
 
# File 'lib/intrinio-sdk/models/option_unusual_trade.rb', line 212

def hash
  [symbol, timestamp, type, total_value, total_size, average_price, contract, ask_at_execution, bid_at_execution, sentiment, underlying_price_at_execution].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



163
164
165
166
 
# File 'lib/intrinio-sdk/models/option_unusual_trade.rb', line 163

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



286
287
288
 
# File 'lib/intrinio-sdk/models/option_unusual_trade.rb', line 286

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



292
293
294
295
296
297
298
299
300
 
# File 'lib/intrinio-sdk/models/option_unusual_trade.rb', line 292

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



280
281
282
 
# File 'lib/intrinio-sdk/models/option_unusual_trade.rb', line 280

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



170
171
172
173
174
 
# File 'lib/intrinio-sdk/models/option_unusual_trade.rb', line 170

def valid?
  sentiment_validator = EnumAttributeValidator.new('String', ["bullish", "bearish", "neutral"])
  return false unless sentiment_validator.valid?(@sentiment)
  return true
end