Class: Intrinio::StockPriceSummary

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

Overview

The summary of a stock price for a security on a given date.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StockPriceSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
169
170
171
172
173
174
175
176
177
 
# File 'lib/intrinio-sdk/models/stock_price_summary.rb', line 119

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#adj_close ⇒ Object

The price at the end of the period, adjusted for splits and dividends



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

def adj_close
  @adj_close
end

#adj_high ⇒ Object

The highest price over the span of the period, adjusted for splits and dividends



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

def adj_high
  @adj_high
end

#adj_low ⇒ Object

The lowest price over the span of the period, adjusted for splits and dividends



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

def adj_low
  @adj_low
end

#adj_open ⇒ Object

The price at the beginning of the period, adjusted for splits and dividends



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

def adj_open
  @adj_open
end

#adj_volume ⇒ Object

The number of shares exchanged during the period, adjusted for splits and dividends



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

def adj_volume
  @adj_volume
end

#close ⇒ Object

The price at the end of the period



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

def close
  @close
end

#date ⇒ Object

The calendar date that the stock price represents. For non-daily stock prices, this represents the last day in the period (end of the week, month, quarter, year, etc)



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

def date
  @date
end

#frequency ⇒ Object

The type of period that the stock price represents



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

def frequency
  @frequency
end

#high ⇒ Object

The highest price over the span of the period



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

def high
  @high
end

#intraperiod ⇒ Object

If true, the stock price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period



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

def intraperiod
  @intraperiod
end

#low ⇒ Object

The lowest price over the span of the period



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

def low
  @low
end

#open ⇒ Object

The price at the beginning of the period



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

def open
  @open
end

#volume ⇒ Object

The number of shares exchanged during the period



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

def volume
  @volume
end

Class Method Details

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/intrinio-sdk/models/stock_price_summary.rb', line 80

def self.attribute_map
  {
    :'date' => :'date',
    :'intraperiod' => :'intraperiod',
    :'frequency' => :'frequency',
    :'open' => :'open',
    :'high' => :'high',
    :'low' => :'low',
    :'close' => :'close',
    :'volume' => :'volume',
    :'adj_open' => :'adj_open',
    :'adj_high' => :'adj_high',
    :'adj_low' => :'adj_low',
    :'adj_close' => :'adj_close',
    :'adj_volume' => :'adj_volume'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/intrinio-sdk/models/stock_price_summary.rb', line 99

def self.swagger_types
  {
    :'date' => :'Date',
    :'intraperiod' => :'BOOLEAN',
    :'frequency' => :'String',
    :'open' => :'Float',
    :'high' => :'Float',
    :'low' => :'Float',
    :'close' => :'Float',
    :'volume' => :'Float',
    :'adj_open' => :'Float',
    :'adj_high' => :'Float',
    :'adj_low' => :'Float',
    :'adj_close' => :'Float',
    :'adj_volume' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/intrinio-sdk/models/stock_price_summary.rb', line 206

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      date == o.date &&
      intraperiod == o.intraperiod &&
      frequency == o.frequency &&
      open == o.open &&
      high == o.high &&
      low == o.low &&
      close == o.close &&
      volume == o.volume &&
      adj_open == o.adj_open &&
      adj_high == o.adj_high &&
      adj_low == o.adj_low &&
      adj_close == o.adj_close &&
      adj_volume == o.adj_volume
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



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
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/intrinio-sdk/models/stock_price_summary.rb', line 260

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



326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/intrinio-sdk/models/stock_price_summary.rb', line 326

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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/intrinio-sdk/models/stock_price_summary.rb', line 239

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


226
227
228
 
# File 'lib/intrinio-sdk/models/stock_price_summary.rb', line 226

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



232
233
234
 
# File 'lib/intrinio-sdk/models/stock_price_summary.rb', line 232

def hash
  [date, intraperiod, frequency, open, high, low, close, volume, adj_open, adj_high, adj_low, adj_close, adj_volume].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



181
182
183
184
 
# File 'lib/intrinio-sdk/models/stock_price_summary.rb', line 181

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



306
307
308
 
# File 'lib/intrinio-sdk/models/stock_price_summary.rb', line 306

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



312
313
314
315
316
317
318
319
320
 
# File 'lib/intrinio-sdk/models/stock_price_summary.rb', line 312

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



300
301
302
 
# File 'lib/intrinio-sdk/models/stock_price_summary.rb', line 300

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



188
189
190
191
192
 
# File 'lib/intrinio-sdk/models/stock_price_summary.rb', line 188

def valid?
  frequency_validator = EnumAttributeValidator.new('String', ["daily", "weekly", "monthly", "quarterly", "yearly"])
  return false unless frequency_validator.valid?(@frequency)
  return true
end