Class: Intrinio::ZacksSalesEstimate

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

Overview

Zacks consensus sales estimates from analysts for thousands of stocks. Zacks storied research team aggregates and validates the estimates. Each sales Estimate includes metadata about the corresponding Company.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ZacksSalesEstimate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#analyst_revisions_down_1m ⇒ Object

The analyst revisions going down for the period of 1 month.



69
70
71
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 69

def analyst_revisions_down_1m
  @analyst_revisions_down_1m
end

#analyst_revisions_down_1w ⇒ Object

The analyst revisions going down for the period of 1 week.



60
61
62
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 60

def analyst_revisions_down_1w
  @analyst_revisions_down_1w
end

#analyst_revisions_down_3m ⇒ Object

The analyst revisions going down for the period of 3 months.



78
79
80
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 78

def analyst_revisions_down_3m
  @analyst_revisions_down_3m
end

#analyst_revisions_percent_change_1m ⇒ Object

The analyst revisions percent change in estimate for the period of 1 month.



63
64
65
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 63

def analyst_revisions_percent_change_1m
  @analyst_revisions_percent_change_1m
end

#analyst_revisions_percent_change_1w ⇒ Object

The analyst revisions percent change in estimate for the period of 1 week.



54
55
56
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 54

def analyst_revisions_percent_change_1w
  @analyst_revisions_percent_change_1w
end

#analyst_revisions_percent_change_3m ⇒ Object

The analyst revisions percent change in estimate for the period of 3 months.



72
73
74
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 72

def analyst_revisions_percent_change_3m
  @analyst_revisions_percent_change_3m
end

#analyst_revisions_up_1m ⇒ Object

The analyst revisions going up for the period of 1 month.



66
67
68
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 66

def analyst_revisions_up_1m
  @analyst_revisions_up_1m
end

#analyst_revisions_up_1w ⇒ Object

The analyst revisions going up for the period of 1 week.



57
58
59
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 57

def analyst_revisions_up_1w
  @analyst_revisions_up_1w
end

#analyst_revisions_up_3m ⇒ Object

The analyst revisions going up for the period of 3 months.



75
76
77
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 75

def analyst_revisions_up_3m
  @analyst_revisions_up_3m
end

#calendar_period ⇒ Object

The closest calendar quarter for the company’s fiscal year



33
34
35
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 33

def calendar_period
  @calendar_period
end

#calendar_year ⇒ Object

The closest calendar year for the company’s fiscal year



30
31
32
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 30

def calendar_year
  @calendar_year
end

#company ⇒ Object

Returns the value of attribute company.



18
19
20
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 18

def company
  @company
end

#count ⇒ Object

The number of estimates for the period



36
37
38
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 36

def count
  @count
end

#date ⇒ Object

The period end date



21
22
23
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 21

def date
  @date
end

#fiscal_period ⇒ Object

The company’s fiscal quarter for the reported period



27
28
29
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 27

def fiscal_period
  @fiscal_period
end

#fiscal_year ⇒ Object

The company’s fiscal year for the reported period



24
25
26
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 24

def fiscal_year
  @fiscal_year
end

#high ⇒ Object

The sales estimate high estimate for the period



45
46
47
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 45

def high
  @high
end

#low ⇒ Object

The sales estimate low estimate for the period



48
49
50
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 48

def low
  @low
end

#mean ⇒ Object

The sales estimate mean estimate for the period



39
40
41
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 39

def mean
  @mean
end

#median ⇒ Object

The sales estimate median estimate for the period



42
43
44
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 42

def median
  @median
end

#standard_deviation ⇒ Object

The sales estimate standard deviation estimate for the period



51
52
53
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 51

def standard_deviation
  @standard_deviation
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'company' => :'company',
    :'date' => :'date',
    :'fiscal_year' => :'fiscal_year',
    :'fiscal_period' => :'fiscal_period',
    :'calendar_year' => :'calendar_year',
    :'calendar_period' => :'calendar_period',
    :'count' => :'count',
    :'mean' => :'mean',
    :'median' => :'median',
    :'high' => :'high',
    :'low' => :'low',
    :'standard_deviation' => :'standard_deviation',
    :'analyst_revisions_percent_change_1w' => :'analyst_revisions_percent_change_1w',
    :'analyst_revisions_up_1w' => :'analyst_revisions_up_1w',
    :'analyst_revisions_down_1w' => :'analyst_revisions_down_1w',
    :'analyst_revisions_percent_change_1m' => :'analyst_revisions_percent_change_1m',
    :'analyst_revisions_up_1m' => :'analyst_revisions_up_1m',
    :'analyst_revisions_down_1m' => :'analyst_revisions_down_1m',
    :'analyst_revisions_percent_change_3m' => :'analyst_revisions_percent_change_3m',
    :'analyst_revisions_up_3m' => :'analyst_revisions_up_3m',
    :'analyst_revisions_down_3m' => :'analyst_revisions_down_3m'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'company' => :'CompanySummary',
    :'date' => :'Date',
    :'fiscal_year' => :'Integer',
    :'fiscal_period' => :'String',
    :'calendar_year' => :'Integer',
    :'calendar_period' => :'String',
    :'count' => :'Integer',
    :'mean' => :'Float',
    :'median' => :'Float',
    :'high' => :'Float',
    :'low' => :'Float',
    :'standard_deviation' => :'Float',
    :'analyst_revisions_percent_change_1w' => :'Float',
    :'analyst_revisions_up_1w' => :'Float',
    :'analyst_revisions_down_1w' => :'Float',
    :'analyst_revisions_percent_change_1m' => :'Float',
    :'analyst_revisions_up_1m' => :'Float',
    :'analyst_revisions_down_1m' => :'Float',
    :'analyst_revisions_percent_change_3m' => :'Float',
    :'analyst_revisions_up_3m' => :'Float',
    :'analyst_revisions_down_3m' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      company == o.company &&
      date == o.date &&
      fiscal_year == o.fiscal_year &&
      fiscal_period == o.fiscal_period &&
      calendar_year == o.calendar_year &&
      calendar_period == o.calendar_period &&
      count == o.count &&
      mean == o.mean &&
      median == o.median &&
      high == o.high &&
      low == o.low &&
      standard_deviation == o.standard_deviation &&
      analyst_revisions_percent_change_1w == o.analyst_revisions_percent_change_1w &&
      analyst_revisions_up_1w == o.analyst_revisions_up_1w &&
      analyst_revisions_down_1w == o.analyst_revisions_down_1w &&
      analyst_revisions_percent_change_1m == o.analyst_revisions_percent_change_1m &&
      analyst_revisions_up_1m == o.analyst_revisions_up_1m &&
      analyst_revisions_down_1m == o.analyst_revisions_down_1m &&
      analyst_revisions_percent_change_3m == o.analyst_revisions_percent_change_3m &&
      analyst_revisions_up_3m == o.analyst_revisions_up_3m &&
      analyst_revisions_down_3m == o.analyst_revisions_down_3m
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



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
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 306

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



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 372

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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 285

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


272
273
274
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 272

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



278
279
280
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 278

def hash
  [company, date, fiscal_year, fiscal_period, calendar_year, calendar_period, count, mean, median, high, low, standard_deviation, analyst_revisions_percent_change_1w, analyst_revisions_up_1w, analyst_revisions_down_1w, analyst_revisions_percent_change_1m, analyst_revisions_up_1m, analyst_revisions_down_1m, analyst_revisions_percent_change_3m, analyst_revisions_up_3m, analyst_revisions_down_3m].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



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

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



352
353
354
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 352

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



358
359
360
361
362
363
364
365
366
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 358

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



346
347
348
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 346

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



238
239
240
 
# File 'lib/intrinio-sdk/models/zacks_sales_estimate.rb', line 238

def valid?
  return true
end