Class: Intrinio::OptionPriceRealtime

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

Overview

An option price contains price information for a specific options contract.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OptionPriceRealtime

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
160
161
162
163
164
165
166
167
168
 
# File 'lib/intrinio-sdk/models/option_price_realtime.rb', line 114

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?(:'last')
    self.last = attributes[:'last']
  end

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#ask ⇒ Object

The price of the top ask order



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

def ask
  @ask
end

#ask_size ⇒ Object

The size of the top ask order



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

def ask_size
  @ask_size
end

#ask_timestamp ⇒ Object

The timestamp of the top ask order



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

def ask_timestamp
  @ask_timestamp
end

#bid ⇒ Object

The price of the top bid order



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

def bid
  @bid
end

#bid_size ⇒ Object

The size of the top bid order



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

def bid_size
  @bid_size
end

#bid_timestamp ⇒ Object

The time of the top bid order



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

def bid_timestamp
  @bid_timestamp
end

#exercise_style ⇒ Object

The exercise style of the option. ("A" = "American", "E" = "European")



52
53
54
 
# File 'lib/intrinio-sdk/models/option_price_realtime.rb', line 52

def exercise_style
  @exercise_style
end

#last ⇒ Object

The price of the last trade



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

def last
  @last
end

#last_size ⇒ Object

The size of the last trade



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

def last_size
  @last_size
end

#last_timestamp ⇒ Object

The time of the last trade



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

def last_timestamp
  @last_timestamp
end

#open_interest ⇒ Object

The total number of this options contract that are still open.



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

def open_interest
  @open_interest
end

#volume ⇒ Object

The cumulative volume of this options contract that traded that day.



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

def volume
  @volume
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/intrinio-sdk/models/option_price_realtime.rb', line 77

def self.attribute_map
  {
    :'last' => :'last',
    :'last_size' => :'last_size',
    :'last_timestamp' => :'last_timestamp',
    :'volume' => :'volume',
    :'ask' => :'ask',
    :'ask_size' => :'ask_size',
    :'ask_timestamp' => :'ask_timestamp',
    :'bid' => :'bid',
    :'bid_size' => :'bid_size',
    :'bid_timestamp' => :'bid_timestamp',
    :'open_interest' => :'open_interest',
    :'exercise_style' => :'exercise_style'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/intrinio-sdk/models/option_price_realtime.rb', line 95

def self.swagger_types
  {
    :'last' => :'Float',
    :'last_size' => :'Integer',
    :'last_timestamp' => :'DateTime',
    :'volume' => :'Integer',
    :'ask' => :'Float',
    :'ask_size' => :'Integer',
    :'ask_timestamp' => :'DateTime',
    :'bid' => :'Float',
    :'bid_size' => :'Integer',
    :'bid_timestamp' => :'DateTime',
    :'open_interest' => :'Integer',
    :'exercise_style' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/intrinio-sdk/models/option_price_realtime.rb', line 197

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      last == o.last &&
      last_size == o.last_size &&
      last_timestamp == o.last_timestamp &&
      volume == o.volume &&
      ask == o.ask &&
      ask_size == o.ask_size &&
      ask_timestamp == o.ask_timestamp &&
      bid == o.bid &&
      bid_size == o.bid_size &&
      bid_timestamp == o.bid_timestamp &&
      open_interest == o.open_interest &&
      exercise_style == o.exercise_style
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



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
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/intrinio-sdk/models/option_price_realtime.rb', line 250

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



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/intrinio-sdk/models/option_price_realtime.rb', line 316

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



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/intrinio-sdk/models/option_price_realtime.rb', line 229

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


216
217
218
 
# File 'lib/intrinio-sdk/models/option_price_realtime.rb', line 216

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



222
223
224
 
# File 'lib/intrinio-sdk/models/option_price_realtime.rb', line 222

def hash
  [last, last_size, last_timestamp, volume, ask, ask_size, ask_timestamp, bid, bid_size, bid_timestamp, open_interest, exercise_style].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



172
173
174
175
 
# File 'lib/intrinio-sdk/models/option_price_realtime.rb', line 172

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



296
297
298
 
# File 'lib/intrinio-sdk/models/option_price_realtime.rb', line 296

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



302
303
304
305
306
307
308
309
310
 
# File 'lib/intrinio-sdk/models/option_price_realtime.rb', line 302

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



290
291
292
 
# File 'lib/intrinio-sdk/models/option_price_realtime.rb', line 290

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



179
180
181
182
183
 
# File 'lib/intrinio-sdk/models/option_price_realtime.rb', line 179

def valid?
  exercise_style_validator = EnumAttributeValidator.new('String', ["A", "E"])
  return false unless exercise_style_validator.valid?(@exercise_style)
  return true
end