class FinnhubRuby::ETFProfileData
Attributes
Asset Class.
AUM.
30-day average volume.
CUSIP.
ETF's description.
ETF domicile.
ETF issuer.
Expense ratio.
Inception date.
Investment Segment.
ISIN.
Name
P/B.
P/E.
Tracking Index.
ETF's website.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/finnhub_ruby/models/etf_profile_data.rb, line 97 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/finnhub_ruby/models/etf_profile_data.rb, line 73 def self.attribute_map { :'name' => :'name', :'asset_class' => :'assetClass', :'investment_segment' => :'investmentSegment', :'aum' => :'aum', :'nav' => :'nav', :'nav_currency' => :'navCurrency', :'expense_ratio' => :'expenseRatio', :'tracking_index' => :'trackingIndex', :'etf_company' => :'etfCompany', :'domicile' => :'domicile', :'inception_date' => :'inceptionDate', :'website' => :'website', :'isin' => :'isin', :'cusip' => :'cusip', :'price_to_earnings' => :'priceToEarnings', :'price_to_book' => :'priceToBook', :'avg_volume' => :'avgVolume', :'description' => :'description' } 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/etf_profile_data.rb, line 272 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/etf_profile_data.rb, line 133 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `FinnhubRuby::ETFProfileData` 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::ETFProfileData`. 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?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'asset_class') self.asset_class = attributes[:'asset_class'] end if attributes.key?(:'investment_segment') self.investment_segment = attributes[:'investment_segment'] end if attributes.key?(:'aum') self.aum = attributes[:'aum'] end if attributes.key?(:'nav') self.nav = attributes[:'nav'] end if attributes.key?(:'nav_currency') self.nav_currency = attributes[:'nav_currency'] end if attributes.key?(:'expense_ratio') self.expense_ratio = attributes[:'expense_ratio'] end if attributes.key?(:'tracking_index') self.tracking_index = attributes[:'tracking_index'] end if attributes.key?(:'etf_company') self.etf_company = attributes[:'etf_company'] end if attributes.key?(:'domicile') self.domicile = attributes[:'domicile'] end if attributes.key?(:'inception_date') self.inception_date = attributes[:'inception_date'] end if attributes.key?(:'website') self.website = attributes[:'website'] end if attributes.key?(:'isin') self.isin = attributes[:'isin'] end if attributes.key?(:'cusip') self.cusip = attributes[:'cusip'] end if attributes.key?(:'price_to_earnings') self.price_to_earnings = attributes[:'price_to_earnings'] end if attributes.key?(:'price_to_book') self.price_to_book = attributes[:'price_to_book'] end if attributes.key?(:'avg_volume') self.avg_volume = attributes[:'avg_volume'] end if attributes.key?(:'description') self.description = attributes[:'description'] end end
List of attributes with nullable: true
# File lib/finnhub_ruby/models/etf_profile_data.rb, line 126 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/finnhub_ruby/models/etf_profile_data.rb, line 102 def self.openapi_types { :'name' => :'String', :'asset_class' => :'String', :'investment_segment' => :'String', :'aum' => :'Float', :'nav' => :'Float', :'nav_currency' => :'String', :'expense_ratio' => :'Float', :'tracking_index' => :'String', :'etf_company' => :'String', :'domicile' => :'String', :'inception_date' => :'Date', :'website' => :'String', :'isin' => :'String', :'cusip' => :'String', :'price_to_earnings' => :'Float', :'price_to_book' => :'Float', :'avg_volume' => :'Float', :'description' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/finnhub_ruby/models/etf_profile_data.rb, line 234 def ==(o) return true if self.equal?(o) self.class == o.class && name == o.name && asset_class == o.asset_class && investment_segment == o.investment_segment && aum == o.aum && nav == o.nav && nav_currency == o.nav_currency && expense_ratio == o.expense_ratio && tracking_index == o.tracking_index && etf_company == o.etf_company && domicile == o.domicile && inception_date == o.inception_date && website == o.website && isin == o.isin && cusip == o.cusip && price_to_earnings == o.price_to_earnings && price_to_book == o.price_to_book && avg_volume == o.avg_volume && description == o.description 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/etf_profile_data.rb, line 302 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/etf_profile_data.rb, line 373 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/etf_profile_data.rb, line 279 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/etf_profile_data.rb, line 259 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/finnhub_ruby/models/etf_profile_data.rb, line 265 def hash [name, asset_class, investment_segment, aum, nav, nav_currency, expense_ratio, tracking_index, etf_company, domicile, inception_date, website, isin, cusip, price_to_earnings, price_to_book, avg_volume, description].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/etf_profile_data.rb, line 221 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/etf_profile_data.rb, line 355 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/etf_profile_data.rb, line 343 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/etf_profile_data.rb, line 228 def valid? true end