Class: FinnhubRuby::CompanyProfile

Inherits:
Object
  • Object
show all
Defined in:
lib/finnhub_ruby/models/company_profile.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CompanyProfile

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 193

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FinnhubRuby::CompanyProfile` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `FinnhubRuby::CompanyProfile`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'address')
    self.address = attributes[:'address']
  end

  if attributes.key?(:'city')
    self.city = attributes[:'city']
  end

  if attributes.key?(:'country')
    self.country = attributes[:'country']
  end

  if attributes.key?(:'currency')
    self.currency = attributes[:'currency']
  end

  if attributes.key?(:'estimate_currency')
    self.estimate_currency = attributes[:'estimate_currency']
  end

  if attributes.key?(:'market_cap_currency')
    self.market_cap_currency = attributes[:'market_cap_currency']
  end

  if attributes.key?(:'cusip')
    self.cusip = attributes[:'cusip']
  end

  if attributes.key?(:'sedol')
    self.sedol = attributes[:'sedol']
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'exchange')
    self.exchange = attributes[:'exchange']
  end

  if attributes.key?(:'ggroup')
    self.ggroup = attributes[:'ggroup']
  end

  if attributes.key?(:'gind')
    self.gind = attributes[:'gind']
  end

  if attributes.key?(:'gsector')
    self.gsector = attributes[:'gsector']
  end

  if attributes.key?(:'gsubind')
    self.gsubind = attributes[:'gsubind']
  end

  if attributes.key?(:'isin')
    self.isin = attributes[:'isin']
  end

  if attributes.key?(:'naics_national_industry')
    self.naics_national_industry = attributes[:'naics_national_industry']
  end

  if attributes.key?(:'naics')
    self.naics = attributes[:'naics']
  end

  if attributes.key?(:'naics_sector')
    self.naics_sector = attributes[:'naics_sector']
  end

  if attributes.key?(:'naics_subsector')
    self.naics_subsector = attributes[:'naics_subsector']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'phone')
    self.phone = attributes[:'phone']
  end

  if attributes.key?(:'state')
    self.state = attributes[:'state']
  end

  if attributes.key?(:'ticker')
    self.ticker = attributes[:'ticker']
  end

  if attributes.key?(:'weburl')
    self.weburl = attributes[:'weburl']
  end

  if attributes.key?(:'ipo')
    self.ipo = attributes[:'ipo']
  end

  if attributes.key?(:'market_capitalization')
    self.market_capitalization = attributes[:'market_capitalization']
  end

  if attributes.key?(:'share_outstanding')
    self.share_outstanding = attributes[:'share_outstanding']
  end

  if attributes.key?(:'employee_total')
    self.employee_total = attributes[:'employee_total']
  end

  if attributes.key?(:'logo')
    self. = attributes[:'logo']
  end

  if attributes.key?(:'finnhub_industry')
    self.finnhub_industry = attributes[:'finnhub_industry']
  end
end

Instance Attribute Details

#address ⇒ Object

Address of company’s headquarter.



19
20
21
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 19

def address
  @address
end

#city ⇒ Object

City of company’s headquarter.



22
23
24
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 22

def city
  @city
end

#country ⇒ Object

Country of company’s headquarter.



25
26
27
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 25

def country
  @country
end

#currency ⇒ Object

Currency used in company filings and financials.



28
29
30
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 28

def currency
  @currency
end

#cusip ⇒ Object

CUSIP number.



37
38
39
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 37

def cusip
  @cusip
end

#description ⇒ Object

Company business summary.



43
44
45
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 43

def description
  @description
end

#employee_total ⇒ Object

Number of employee.



100
101
102
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 100

def employee_total
  @employee_total
end

#estimate_currency ⇒ Object

Currency used in Estimates data.



31
32
33
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 31

def estimate_currency
  @estimate_currency
end

#exchange ⇒ Object

Listed exchange.



46
47
48
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 46

def exchange
  @exchange
end

#finnhub_industry ⇒ Object

Finnhub industry classification.



106
107
108
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 106

def finnhub_industry
  @finnhub_industry
end

#ggroup ⇒ Object

Industry group.



49
50
51
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 49

def ggroup
  @ggroup
end

#gind ⇒ Object

Industry.



52
53
54
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 52

def gind
  @gind
end

#gsector ⇒ Object

Sector.



55
56
57
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 55

def gsector
  @gsector
end

#gsubind ⇒ Object

Sub-industry.



58
59
60
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 58

def gsubind
  @gsubind
end

#ipo ⇒ Object

IPO date.



91
92
93
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 91

def ipo
  @ipo
end

#isin ⇒ Object

ISIN number.



61
62
63
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 61

def isin
  @isin
end

#logo ⇒ Object

Logo image.



103
104
105
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 103

def 
  @logo
end

#market_cap_currency ⇒ Object

Currency used in market capitalization.



34
35
36
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 34

def market_cap_currency
  @market_cap_currency
end

#market_capitalization ⇒ Object

Market Capitalization.



94
95
96
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 94

def market_capitalization
  @market_capitalization
end

#naics ⇒ Object

NAICS industry.



67
68
69
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 67

def naics
  @naics
end

#naics_national_industry ⇒ Object

NAICS national industry.



64
65
66
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 64

def naics_national_industry
  @naics_national_industry
end

#naics_sector ⇒ Object

NAICS sector.



70
71
72
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 70

def naics_sector
  @naics_sector
end

#naics_subsector ⇒ Object

NAICS subsector.



73
74
75
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 73

def naics_subsector
  @naics_subsector
end

#name ⇒ Object

Company name.



76
77
78
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 76

def name
  @name
end

#phone ⇒ Object

Company phone number.



79
80
81
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 79

def phone
  @phone
end

#sedol ⇒ Object

Sedol number.



40
41
42
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 40

def sedol
  @sedol
end

#share_outstanding ⇒ Object

Number of oustanding shares.



97
98
99
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 97

def share_outstanding
  @share_outstanding
end

#state ⇒ Object

State of company’s headquarter.



82
83
84
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 82

def state
  @state
end

#ticker ⇒ Object

Company symbol/ticker as used on the listed exchange.



85
86
87
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 85

def ticker
  @ticker
end

#weburl ⇒ Object

Company website.



88
89
90
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 88

def weburl
  @weburl
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



145
146
147
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 145

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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
134
135
136
137
138
139
140
141
142
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 109

def self.attribute_map
  {
    :'address' => :'address',
    :'city' => :'city',
    :'country' => :'country',
    :'currency' => :'currency',
    :'estimate_currency' => :'estimateCurrency',
    :'market_cap_currency' => :'marketCapCurrency',
    :'cusip' => :'cusip',
    :'sedol' => :'sedol',
    :'description' => :'description',
    :'exchange' => :'exchange',
    :'ggroup' => :'ggroup',
    :'gind' => :'gind',
    :'gsector' => :'gsector',
    :'gsubind' => :'gsubind',
    :'isin' => :'isin',
    :'naics_national_industry' => :'naicsNationalIndustry',
    :'naics' => :'naics',
    :'naics_sector' => :'naicsSector',
    :'naics_subsector' => :'naicsSubsector',
    :'name' => :'name',
    :'phone' => :'phone',
    :'state' => :'state',
    :'ticker' => :'ticker',
    :'weburl' => :'weburl',
    :'ipo' => :'ipo',
    :'market_capitalization' => :'marketCapitalization',
    :'share_outstanding' => :'shareOutstanding',
    :'employee_total' => :'employeeTotal',
    :'logo' => :'logo',
    :'finnhub_industry' => :'finnhubIndustry'
  }
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



392
393
394
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 392

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



186
187
188
189
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 186

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 150

def self.openapi_types
  {
    :'address' => :'String',
    :'city' => :'String',
    :'country' => :'String',
    :'currency' => :'String',
    :'estimate_currency' => :'String',
    :'market_cap_currency' => :'String',
    :'cusip' => :'String',
    :'sedol' => :'String',
    :'description' => :'String',
    :'exchange' => :'String',
    :'ggroup' => :'String',
    :'gind' => :'String',
    :'gsector' => :'String',
    :'gsubind' => :'String',
    :'isin' => :'String',
    :'naics_national_industry' => :'String',
    :'naics' => :'String',
    :'naics_sector' => :'String',
    :'naics_subsector' => :'String',
    :'name' => :'String',
    :'phone' => :'String',
    :'state' => :'String',
    :'ticker' => :'String',
    :'weburl' => :'String',
    :'ipo' => :'Date',
    :'market_capitalization' => :'Float',
    :'share_outstanding' => :'Float',
    :'employee_total' => :'Float',
    :'logo' => :'String',
    :'finnhub_industry' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



342
343
344
345
346
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
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 342

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address == o.address &&
      city == o.city &&
      country == o.country &&
      currency == o.currency &&
      estimate_currency == o.estimate_currency &&
      market_cap_currency == o.market_cap_currency &&
      cusip == o.cusip &&
      sedol == o.sedol &&
      description == o.description &&
      exchange == o.exchange &&
      ggroup == o.ggroup &&
      gind == o.gind &&
      gsector == o.gsector &&
      gsubind == o.gsubind &&
      isin == o.isin &&
      naics_national_industry == o.naics_national_industry &&
      naics == o.naics &&
      naics_sector == o.naics_sector &&
      naics_subsector == o.naics_subsector &&
      name == o.name &&
      phone == o.phone &&
      state == o.state &&
      ticker == o.ticker &&
      weburl == o.weburl &&
      ipo == o.ipo &&
      market_capitalization == o.market_capitalization &&
      share_outstanding == o.share_outstanding &&
      employee_total == o.employee_total &&
       == o. &&
      finnhub_industry == o.finnhub_industry
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



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 422

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = FinnhubRuby.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 493

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



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 399

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


379
380
381
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 379

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



385
386
387
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 385

def hash
  [address, city, country, currency, estimate_currency, market_cap_currency, cusip, sedol, description, exchange, ggroup, gind, gsector, gsubind, isin, naics_national_industry, naics, naics_sector, naics_subsector, name, phone, state, ticker, weburl, ipo, market_capitalization, share_outstanding, employee_total, , finnhub_industry].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



329
330
331
332
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 329

def list_invalid_properties
  invalid_properties = Array.new
  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



469
470
471
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 469

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



475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 475

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



463
464
465
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 463

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



336
337
338
 
# File 'lib/finnhub_ruby/models/company_profile.rb', line 336

def valid?
  true
end