Class: Intrinio::StockPriceInterval

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

Overview

Open, close, high, low, volume, average price, and change ratio for a particular interval

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StockPriceInterval

Initializes the object

Parameters:

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

    Model attributes in the form of hash



174
175
176
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
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/stock_price_interval.rb', line 174

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#ask_change_percent ⇒ Object

The ratio of the close to open ask difference, in percent.



88
89
90
 
# File 'lib/intrinio-sdk/models/stock_price_interval.rb', line 88

def ask_change_percent
  @ask_change_percent
end

#ask_close ⇒ Object

The last ask price from the interval.



76
77
78
 
# File 'lib/intrinio-sdk/models/stock_price_interval.rb', line 76

def ask_close
  @ask_close
end

#ask_first_time ⇒ Object

The timestamp that represents the first ask time from the interval span.



82
83
84
 
# File 'lib/intrinio-sdk/models/stock_price_interval.rb', line 82

def ask_first_time
  @ask_first_time
end

#ask_high ⇒ Object

The highest ask price from the interval.



70
71
72
 
# File 'lib/intrinio-sdk/models/stock_price_interval.rb', line 70

def ask_high
  @ask_high
end

#ask_last_time ⇒ Object

The timestamp that represents the last ask time from the interval span.



85
86
87
 
# File 'lib/intrinio-sdk/models/stock_price_interval.rb', line 85

def ask_last_time
  @ask_last_time
end

#ask_low ⇒ Object

The lowest ask price from the interval.



73
74
75
 
# File 'lib/intrinio-sdk/models/stock_price_interval.rb', line 73

def ask_low
  @ask_low
end

#ask_open ⇒ Object

The first ask price from the interval.



79
80
81
 
# File 'lib/intrinio-sdk/models/stock_price_interval.rb', line 79

def ask_open
  @ask_open
end

#average ⇒ Object

The average trade price of an individual stock during the interval.



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

def average
  @average
end

#bid_change_percent ⇒ Object

The ratio of the close to open bid difference, in percent.



67
68
69
 
# File 'lib/intrinio-sdk/models/stock_price_interval.rb', line 67

def bid_change_percent
  @bid_change_percent
end

#bid_close ⇒ Object

The last bid price from the interval.



55
56
57
 
# File 'lib/intrinio-sdk/models/stock_price_interval.rb', line 55

def bid_close
  @bid_close
end

#bid_first_time ⇒ Object

The timestamp that represents the first bid time from the interval span.



61
62
63
 
# File 'lib/intrinio-sdk/models/stock_price_interval.rb', line 61

def bid_first_time
  @bid_first_time
end

#bid_high ⇒ Object

The highest bid price from the interval.



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

def bid_high
  @bid_high
end

#bid_last_time ⇒ Object

The timestamp that represents the last bid time from the interval span.



64
65
66
 
# File 'lib/intrinio-sdk/models/stock_price_interval.rb', line 64

def bid_last_time
  @bid_last_time
end

#bid_low ⇒ Object

The lowest bid price from the interval.



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

def bid_low
  @bid_low
end

#bid_open ⇒ Object

The first bid price from the interval.



58
59
60
 
# File 'lib/intrinio-sdk/models/stock_price_interval.rb', line 58

def bid_open
  @bid_open
end

#change ⇒ Object

The change ratio from open to close. ((Close - Open)/Open).



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

def change
  @change
end

#close ⇒ Object

The last traded price during the period



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

def close
  @close
end

#close_time ⇒ Object

The timestamp that represents the end of the interval span.



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

def close_time
  @close_time
end

#high ⇒ Object

The highest price over the span of the period



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

def high
  @high
end

#interval ⇒ Object

The size of the interval.



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

def interval
  @interval
end

#low ⇒ Object

The lowest price over the span of the period



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

def low
  @low
end

#open ⇒ Object

The first traded price during the period



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

def open
  @open
end

#time ⇒ Object

The timestamp that represents the start of the interval span.



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

def time
  @time
end

#volume ⇒ Object

The number of shares exchanged during the period



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

def volume
  @volume
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/intrinio-sdk/models/stock_price_interval.rb', line 113

def self.attribute_map
  {
    :'time' => :'time',
    :'open' => :'open',
    :'close' => :'close',
    :'high' => :'high',
    :'low' => :'low',
    :'volume' => :'volume',
    :'close_time' => :'close_time',
    :'interval' => :'interval',
    :'average' => :'average',
    :'change' => :'change',
    :'bid_high' => :'bid_high',
    :'bid_low' => :'bid_low',
    :'bid_close' => :'bid_close',
    :'bid_open' => :'bid_open',
    :'bid_first_time' => :'bid_first_time',
    :'bid_last_time' => :'bid_last_time',
    :'bid_change_percent' => :'bid_change_percent',
    :'ask_high' => :'ask_high',
    :'ask_low' => :'ask_low',
    :'ask_close' => :'ask_close',
    :'ask_open' => :'ask_open',
    :'ask_first_time' => :'ask_first_time',
    :'ask_last_time' => :'ask_last_time',
    :'ask_change_percent' => :'ask_change_percent'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
169
170
 
# File 'lib/intrinio-sdk/models/stock_price_interval.rb', line 143

def self.swagger_types
  {
    :'time' => :'DateTime',
    :'open' => :'Float',
    :'close' => :'Float',
    :'high' => :'Float',
    :'low' => :'Float',
    :'volume' => :'Float',
    :'close_time' => :'DateTime',
    :'interval' => :'String',
    :'average' => :'Float',
    :'change' => :'Float',
    :'bid_high' => :'Float',
    :'bid_low' => :'Float',
    :'bid_close' => :'Float',
    :'bid_open' => :'Float',
    :'bid_first_time' => :'DateTime',
    :'bid_last_time' => :'DateTime',
    :'bid_change_percent' => :'Float',
    :'ask_high' => :'Float',
    :'ask_low' => :'Float',
    :'ask_close' => :'Float',
    :'ask_open' => :'Float',
    :'ask_first_time' => :'DateTime',
    :'ask_last_time' => :'DateTime',
    :'ask_change_percent' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/intrinio-sdk/models/stock_price_interval.rb', line 305

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      time == o.time &&
      open == o.open &&
      close == o.close &&
      high == o.high &&
      low == o.low &&
      volume == o.volume &&
      close_time == o.close_time &&
      interval == o.interval &&
      average == o.average &&
      change == o.change &&
      bid_high == o.bid_high &&
      bid_low == o.bid_low &&
      bid_close == o.bid_close &&
      bid_open == o.bid_open &&
      bid_first_time == o.bid_first_time &&
      bid_last_time == o.bid_last_time &&
      bid_change_percent == o.bid_change_percent &&
      ask_high == o.ask_high &&
      ask_low == o.ask_low &&
      ask_close == o.ask_close &&
      ask_open == o.ask_open &&
      ask_first_time == o.ask_first_time &&
      ask_last_time == o.ask_last_time &&
      ask_change_percent == o.ask_change_percent
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



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/intrinio-sdk/models/stock_price_interval.rb', line 370

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



436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/intrinio-sdk/models/stock_price_interval.rb', line 436

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



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/intrinio-sdk/models/stock_price_interval.rb', line 349

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


336
337
338
 
# File 'lib/intrinio-sdk/models/stock_price_interval.rb', line 336

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



342
343
344
 
# File 'lib/intrinio-sdk/models/stock_price_interval.rb', line 342

def hash
  [time, open, close, high, low, volume, close_time, interval, average, change, bid_high, bid_low, bid_close, bid_open, bid_first_time, bid_last_time, bid_change_percent, ask_high, ask_low, ask_close, ask_open, ask_first_time, ask_last_time, ask_change_percent].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



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

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



416
417
418
 
# File 'lib/intrinio-sdk/models/stock_price_interval.rb', line 416

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



422
423
424
425
426
427
428
429
430
 
# File 'lib/intrinio-sdk/models/stock_price_interval.rb', line 422

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



410
411
412
 
# File 'lib/intrinio-sdk/models/stock_price_interval.rb', line 410

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



287
288
289
290
291
 
# File 'lib/intrinio-sdk/models/stock_price_interval.rb', line 287

def valid?
  interval_validator = EnumAttributeValidator.new('String', ["SixtyMinute", "ThirtyMinute", "FifteenMinute", "TenMinute", "FiveMinute", "OneMinute"])
  return false unless interval_validator.valid?(@interval)
  return true
end