Class: Intrinio::CompanyNewsSummary

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

Overview

A news article about a company

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CompanyNewsSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/intrinio-sdk/models/company_news_summary.rb', line 153

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

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

  if attributes.has_key?(:'companies')
    if (value = attributes[:'companies']).is_a?(Array)
      self.companies = value
    end
  end

  if attributes.has_key?(:'securities')
    if (value = attributes[:'securities']).is_a?(Array)
      self.securities = value
    end
  end

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

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

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

  if attributes.has_key?(:'topics')
    if (value = attributes[:'topics']).is_a?(Array)
      self.topics = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#article_sentiment ⇒ Object

The news sentiment.



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

def article_sentiment
  @article_sentiment
end

#article_sentiment_confidence ⇒ Object

The confidence score of the sentiment rating



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

def article_sentiment_confidence
  @article_sentiment_confidence
end

#business_relevance ⇒ Object

How strongly correlated the news article is to the business



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

def business_relevance
  @business_relevance
end

#companies ⇒ Object

The Companies to which the new article pertains



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

def companies
  @companies
end

#copyright ⇒ Object

The copyright of the news article



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

def copyright
  @copyright
end

#id ⇒ Object

The Intrinio ID for the news article



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

def id
  @id
end

#issuer ⇒ Object

The issuer of the story.



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

def issuer
  @issuer
end

#issuer_company ⇒ Object

The company that issued the story.



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

def issuer_company
  @issuer_company
end

#issuer_name ⇒ Object

The issuer of the story.



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

def issuer_name
  @issuer_name
end

#issuer_security ⇒ Object

The security that issued the story.



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

def issuer_security
  @issuer_security
end

#language ⇒ Object

The language code of the news article



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

def language
  @language
end

#publication_date ⇒ Object

The publication date of the news article



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

def publication_date
  @publication_date
end

#securities ⇒ Object

The Securities to which the new article pertains



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

def securities
  @securities
end

#source ⇒ Object

The news source.



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

def source
  @source
end

#spam ⇒ Object

Whether the news article is marked as spam or not



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

def spam
  @spam
end

#summary ⇒ Object

A summary of the news article



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

def summary
  @summary
end

#title ⇒ Object

The title of the news article



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

def title
  @title
end

#topics ⇒ Object

Returns the value of attribute topics.



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

def topics
  @topics
end

#url ⇒ Object

The url of the news article



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

def url
  @url
end

#word_count ⇒ Object

The word count of the news article



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

def word_count
  @word_count
end

Class Method Details

.attribute_map ⇒ Object

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



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/intrinio-sdk/models/company_news_summary.rb', line 100

def self.attribute_map
  {
    :'id' => :'id',
    :'title' => :'title',
    :'publication_date' => :'publication_date',
    :'companies' => :'companies',
    :'securities' => :'securities',
    :'url' => :'url',
    :'summary' => :'summary',
    :'source' => :'source',
    :'topics' => :'topics',
    :'copyright' => :'copyright',
    :'language' => :'language',
    :'word_count' => :'word_count',
    :'spam' => :'spam',
    :'business_relevance' => :'business_relevance',
    :'article_sentiment' => :'article_sentiment',
    :'article_sentiment_confidence' => :'article_sentiment_confidence',
    :'issuer' => :'issuer',
    :'issuer_name' => :'issuer_name',
    :'issuer_company' => :'issuer_company',
    :'issuer_security' => :'issuer_security'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/intrinio-sdk/models/company_news_summary.rb', line 126

def self.swagger_types
  {
    :'id' => :'String',
    :'title' => :'String',
    :'publication_date' => :'DateTime',
    :'companies' => :'Array<CompanySummary>',
    :'securities' => :'Array<SecuritySummary>',
    :'url' => :'String',
    :'summary' => :'String',
    :'source' => :'String',
    :'topics' => :'Array<NewsTopic>',
    :'copyright' => :'String',
    :'language' => :'String',
    :'word_count' => :'Integer',
    :'spam' => :'BOOLEAN',
    :'business_relevance' => :'Float',
    :'article_sentiment' => :'String',
    :'article_sentiment_confidence' => :'Float',
    :'issuer' => :'String',
    :'issuer_name' => :'String',
    :'issuer_company' => :'CompanySummary',
    :'issuer_security' => :'SecuritySummary'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/intrinio-sdk/models/company_news_summary.rb', line 286

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      title == o.title &&
      publication_date == o.publication_date &&
      companies == o.companies &&
      securities == o.securities &&
      url == o.url &&
      summary == o.summary &&
      source == o.source &&
      topics == o.topics &&
      copyright == o.copyright &&
      language == o.language &&
      word_count == o.word_count &&
      spam == o.spam &&
      business_relevance == o.business_relevance &&
      article_sentiment == o.article_sentiment &&
      article_sentiment_confidence == o.article_sentiment_confidence &&
      issuer == o.issuer &&
      issuer_name == o.issuer_name &&
      issuer_company == o.issuer_company &&
      issuer_security == o.issuer_security
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



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/intrinio-sdk/models/company_news_summary.rb', line 347

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



413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/intrinio-sdk/models/company_news_summary.rb', line 413

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



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

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



319
320
321
 
# File 'lib/intrinio-sdk/models/company_news_summary.rb', line 319

def hash
  [id, title, publication_date, companies, securities, url, summary, source, topics, copyright, language, word_count, spam, business_relevance, article_sentiment, article_sentiment_confidence, issuer, issuer_name, issuer_company, issuer_security].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



249
250
251
252
 
# File 'lib/intrinio-sdk/models/company_news_summary.rb', line 249

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



393
394
395
 
# File 'lib/intrinio-sdk/models/company_news_summary.rb', line 393

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



399
400
401
402
403
404
405
406
407
 
# File 'lib/intrinio-sdk/models/company_news_summary.rb', line 399

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



387
388
389
 
# File 'lib/intrinio-sdk/models/company_news_summary.rb', line 387

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



256
257
258
259
260
261
262
 
# File 'lib/intrinio-sdk/models/company_news_summary.rb', line 256

def valid?
  source_validator = EnumAttributeValidator.new('String', ["yahoo", "moody", "moody_us_news", "moody_us_press_releases"])
  return false unless source_validator.valid?(@source)
  article_sentiment_validator = EnumAttributeValidator.new('String', ["positive", "neutral", "negative"])
  return false unless article_sentiment_validator.valid?(@article_sentiment)
  return true
end