Class: Intrinio::OptionsAggregate

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

Overview

Total aggregated open interest and volume for the ticker

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OptionsAggregate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/intrinio-sdk/models/options_aggregate.rb', line 73

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#contract_count ⇒ Object

Total number of active contracts for the ticker



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

def contract_count
  @contract_count
end

#date ⇒ Object

The date of the data.



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

def date
  @date
end

#put_call_volume_ratio ⇒ Object

Total put volume to total call volume ratio for the ticker



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

def put_call_volume_ratio
  @put_call_volume_ratio
end

#ticker ⇒ Object

The ticker symbol of the Security for the Option.



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

def ticker
  @ticker
end

#total_call_volume ⇒ Object

Total call volume for the ticker



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

def total_call_volume
  @total_call_volume
end

#total_open_interest ⇒ Object

Total open interest for the ticker



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

def total_open_interest
  @total_open_interest
end

#total_put_volume ⇒ Object

Total put volume for the ticker



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

def total_put_volume
  @total_put_volume
end

#total_volume ⇒ Object

Total volume for the ticker



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

def total_volume
  @total_volume
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/intrinio-sdk/models/options_aggregate.rb', line 44

def self.attribute_map
  {
    :'ticker' => :'ticker',
    :'date' => :'date',
    :'total_open_interest' => :'total_open_interest',
    :'total_volume' => :'total_volume',
    :'total_put_volume' => :'total_put_volume',
    :'total_call_volume' => :'total_call_volume',
    :'put_call_volume_ratio' => :'put_call_volume_ratio',
    :'contract_count' => :'contract_count'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/intrinio-sdk/models/options_aggregate.rb', line 58

def self.swagger_types
  {
    :'ticker' => :'String',
    :'date' => :'String',
    :'total_open_interest' => :'Integer',
    :'total_volume' => :'Integer',
    :'total_put_volume' => :'Integer',
    :'total_call_volume' => :'Integer',
    :'put_call_volume_ratio' => :'Float',
    :'contract_count' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/intrinio-sdk/models/options_aggregate.rb', line 128

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      ticker == o.ticker &&
      date == o.date &&
      total_open_interest == o.total_open_interest &&
      total_volume == o.total_volume &&
      total_put_volume == o.total_put_volume &&
      total_call_volume == o.total_call_volume &&
      put_call_volume_ratio == o.put_call_volume_ratio &&
      contract_count == o.contract_count
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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/intrinio-sdk/models/options_aggregate.rb', line 177

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



243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/intrinio-sdk/models/options_aggregate.rb', line 243

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



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/intrinio-sdk/models/options_aggregate.rb', line 156

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


143
144
145
 
# File 'lib/intrinio-sdk/models/options_aggregate.rb', line 143

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



149
150
151
 
# File 'lib/intrinio-sdk/models/options_aggregate.rb', line 149

def hash
  [ticker, date, total_open_interest, total_volume, total_put_volume, total_call_volume, put_call_volume_ratio, contract_count].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



115
116
117
118
 
# File 'lib/intrinio-sdk/models/options_aggregate.rb', line 115

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



223
224
225
 
# File 'lib/intrinio-sdk/models/options_aggregate.rb', line 223

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



229
230
231
232
233
234
235
236
237
 
# File 'lib/intrinio-sdk/models/options_aggregate.rb', line 229

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



217
218
219
 
# File 'lib/intrinio-sdk/models/options_aggregate.rb', line 217

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



122
123
124
 
# File 'lib/intrinio-sdk/models/options_aggregate.rb', line 122

def valid?
  return true
end