class FinnhubRuby::CompanyProfile
Attributes
Address of company's headquarter.
City of company's headquarter.
Country of company's headquarter.
Currency used in company filings.
CUSIP number.
Company
business summary.
Number of employee.
Listed exchange.
Finnhub industry classification.
GICS industry group.
GICS industry.
GICS sector.
GICS sub-industry.
IPO date.
ISIN number.
Logo image.
Market Capitalization.
NAICS industry.
NAICS national industry.
NAICS sector.
NAICS subsector.
Company
name.
Company
phone number.
Sedol number.
State of company's headquarter.
Company
symbol/ticker as used on the listed exchange.
Company
website.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/finnhub_ruby/models/company_profile.rb, line 137 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/finnhub_ruby/models/company_profile.rb, line 103 def self.attribute_map { :'address' => :'address', :'city' => :'city', :'country' => :'country', :'currency' => :'currency', :'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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/finnhub_ruby/models/company_profile.rb, line 372 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/finnhub_ruby/models/company_profile.rb, line 183 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?(:'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.logo = attributes[:'logo'] end if attributes.key?(:'finnhub_industry') self.finnhub_industry = attributes[:'finnhub_industry'] end end
List of attributes with nullable: true
# File lib/finnhub_ruby/models/company_profile.rb, line 176 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/finnhub_ruby/models/company_profile.rb, line 142 def self.openapi_types { :'address' => :'String', :'city' => :'String', :'country' => :'String', :'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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/finnhub_ruby/models/company_profile.rb, line 324 def ==(o) return true if self.equal?(o) self.class == o.class && address == o.address && city == o.city && country == o.country && currency == o.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 && logo == o.logo && finnhub_industry == o.finnhub_industry end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/finnhub_ruby/models/company_profile.rb, line 402 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/finnhub_ruby/models/company_profile.rb, line 473 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/finnhub_ruby/models/company_profile.rb, line 379 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
@see the `==` method @param [Object] Object to be compared
# File lib/finnhub_ruby/models/company_profile.rb, line 359 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/finnhub_ruby/models/company_profile.rb, line 365 def hash [address, city, country, 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, logo, finnhub_industry].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/finnhub_ruby/models/company_profile.rb, line 311 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/finnhub_ruby/models/company_profile.rb, line 455 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/finnhub_ruby/models/company_profile.rb, line 443 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/finnhub_ruby/models/company_profile.rb, line 318 def valid? true end