Class: Intrinio::ZacksSalesSurprise

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

Overview

Zacks Sales Surprises are pre-earnings release consensus sales estimates from analysts for thousands of stocks. Zack’s storied research team aggregates and validates the estimates and compares these estimates to non-GAAP sales reported by the company, providing the amount and percent surprise on release. Each Sales Surprise includes metadata about the corresponding Security.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ZacksSalesSurprise

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/intrinio-sdk/models/zacks_sales_surprise.rb', line 118

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#actual_reported_code ⇒ Object

The code cooresponding to the earnings release BTO = BEFORE THE OPEN | DTM = DURING THE MARKET | AMC = AFTER MARKET CLOSE



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

def actual_reported_code
  @actual_reported_code
end

#actual_reported_date ⇒ Object

The actual report date for the earnings release



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

def actual_reported_date
  @actual_reported_date
end

#actual_reported_desc ⇒ Object

The description for the type of earnings release



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

def actual_reported_desc
  @actual_reported_desc
end

#actual_reported_time ⇒ Object

The actual report time for the earnings release



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

def actual_reported_time
  @actual_reported_time
end

#calendar_quarter ⇒ Object

The closest calendar quarter for the company’s fiscal year



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

def calendar_quarter
  @calendar_quarter
end

#calendar_year ⇒ Object

The closest calendar year for the company’s fiscal year



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

def calendar_year
  @calendar_year
end

#fiscal_quarter ⇒ Object

The company’s fiscal quarter for the reported period



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

def fiscal_quarter
  @fiscal_quarter
end

#fiscal_year ⇒ Object

The company’s fiscal year for the reported period



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

def fiscal_year
  @fiscal_year
end

#id ⇒ Object

The Intrinio ID for the record



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

def id
  @id
end

#last_rev_date ⇒ Object

The last revision date for the analyst estimates



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

def last_rev_date
  @last_rev_date
end

#sales_actual ⇒ Object

The actual Non-GAAP sales figure released by the company, interpreted by Zacks.



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

def sales_actual
  @sales_actual
end

#sales_actual_gaap ⇒ Object

The actual GAAP sales figured released by the company



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

def sales_actual_gaap
  @sales_actual_gaap
end

#sales_actual_zacks_adj ⇒ Object

The adjustments Zacks made to get to Non-GAAP sales to reconcile with GAAP sales.



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

def sales_actual_zacks_adj
  @sales_actual_zacks_adj
end

#sales_amount_diff ⇒ Object

The sales surprise amount difference



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

def sales_amount_diff
  @sales_amount_diff
end

#sales_mean_estimate ⇒ Object

The pre-earnings release mean sales estimate for the company sales_count_estimate; the pre-earnings release number of estimates by analysts



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

def sales_mean_estimate
  @sales_mean_estimate
end

#sales_percent_diff ⇒ Object

The sales surprise percent difference



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

def sales_percent_diff
  @sales_percent_diff
end

#sales_std_dev_estimate ⇒ Object

The pre-earnings release standard deviation of sales estimates



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

def sales_std_dev_estimate
  @sales_std_dev_estimate
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/intrinio-sdk/models/zacks_sales_surprise.rb', line 71

def self.attribute_map
  {
    :'id' => :'id',
    :'fiscal_year' => :'fiscal_year',
    :'fiscal_quarter' => :'fiscal_quarter',
    :'calendar_year' => :'calendar_year',
    :'calendar_quarter' => :'calendar_quarter',
    :'actual_reported_date' => :'actual_reported_date',
    :'actual_reported_time' => :'actual_reported_time',
    :'actual_reported_code' => :'actual_reported_code',
    :'actual_reported_desc' => :'actual_reported_desc',
    :'last_rev_date' => :'last_rev_date',
    :'sales_actual' => :'sales_actual',
    :'sales_actual_zacks_adj' => :'sales_actual_zacks_adj',
    :'sales_actual_gaap' => :'sales_actual_gaap',
    :'sales_mean_estimate' => :'sales_mean_estimate',
    :'sales_amount_diff' => :'sales_amount_diff',
    :'sales_percent_diff' => :'sales_percent_diff',
    :'sales_std_dev_estimate' => :'sales_std_dev_estimate'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'id' => :'String',
    :'fiscal_year' => :'Float',
    :'fiscal_quarter' => :'String',
    :'calendar_year' => :'Float',
    :'calendar_quarter' => :'String',
    :'actual_reported_date' => :'Date',
    :'actual_reported_time' => :'String',
    :'actual_reported_code' => :'String',
    :'actual_reported_desc' => :'String',
    :'last_rev_date' => :'Date',
    :'sales_actual' => :'Float',
    :'sales_actual_zacks_adj' => :'Float',
    :'sales_actual_gaap' => :'Float',
    :'sales_mean_estimate' => :'Float',
    :'sales_amount_diff' => :'Float',
    :'sales_percent_diff' => :'Float',
    :'sales_std_dev_estimate' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/intrinio-sdk/models/zacks_sales_surprise.rb', line 209

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      fiscal_year == o.fiscal_year &&
      fiscal_quarter == o.fiscal_quarter &&
      calendar_year == o.calendar_year &&
      calendar_quarter == o.calendar_quarter &&
      actual_reported_date == o.actual_reported_date &&
      actual_reported_time == o.actual_reported_time &&
      actual_reported_code == o.actual_reported_code &&
      actual_reported_desc == o.actual_reported_desc &&
      last_rev_date == o.last_rev_date &&
      sales_actual == o.sales_actual &&
      sales_actual_zacks_adj == o.sales_actual_zacks_adj &&
      sales_actual_gaap == o.sales_actual_gaap &&
      sales_mean_estimate == o.sales_mean_estimate &&
      sales_amount_diff == o.sales_amount_diff &&
      sales_percent_diff == o.sales_percent_diff &&
      sales_std_dev_estimate == o.sales_std_dev_estimate
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



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
297
298
299
300
301
302
303
 
# File 'lib/intrinio-sdk/models/zacks_sales_surprise.rb', line 267

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



333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/intrinio-sdk/models/zacks_sales_surprise.rb', line 333

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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/intrinio-sdk/models/zacks_sales_surprise.rb', line 246

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


233
234
235
 
# File 'lib/intrinio-sdk/models/zacks_sales_surprise.rb', line 233

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



239
240
241
 
# File 'lib/intrinio-sdk/models/zacks_sales_surprise.rb', line 239

def hash
  [id, fiscal_year, fiscal_quarter, calendar_year, calendar_quarter, actual_reported_date, actual_reported_time, actual_reported_code, actual_reported_desc, last_rev_date, sales_actual, sales_actual_zacks_adj, sales_actual_gaap, sales_mean_estimate, sales_amount_diff, sales_percent_diff, sales_std_dev_estimate].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



196
197
198
199
 
# File 'lib/intrinio-sdk/models/zacks_sales_surprise.rb', line 196

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



313
314
315
 
# File 'lib/intrinio-sdk/models/zacks_sales_surprise.rb', line 313

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



319
320
321
322
323
324
325
326
327
 
# File 'lib/intrinio-sdk/models/zacks_sales_surprise.rb', line 319

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



307
308
309
 
# File 'lib/intrinio-sdk/models/zacks_sales_surprise.rb', line 307

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



203
204
205
 
# File 'lib/intrinio-sdk/models/zacks_sales_surprise.rb', line 203

def valid?
  return true
end