finnhub_ruby 1.0.1 → 1.1.6

data/lib/finnhub_ruby/models/etf_holdings_data.rb

@@ -0,0 +1,279 @@
+=begin
+#Finnhub API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.2.0
+
+=end
+
+require 'date'
+require 'time'
+
+module FinnhubRuby
+  class ETFHoldingsData
+    # Symbol description
+    attr_accessor :symbol
+
+    # Security name
+    attr_accessor :name
+
+    # ISIN.
+    attr_accessor :isin
+
+    # CUSIP.
+    attr_accessor :cusip
+
+    # Number of shares owned by the ETF.
+    attr_accessor :share
+
+    # Portfolio's percent
+    attr_accessor :percent
+
+    # Market value
+    attr_accessor :value
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'symbol' => :'symbol',
+        :'name' => :'name',
+        :'isin' => :'isin',
+        :'cusip' => :'cusip',
+        :'share' => :'share',
+        :'percent' => :'percent',
+        :'value' => :'value'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'symbol' => :'String',
+        :'name' => :'String',
+        :'isin' => :'String',
+        :'cusip' => :'String',
+        :'share' => :'Float',
+        :'percent' => :'Float',
+        :'value' => :'Float'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `FinnhubRuby::ETFHoldingsData` 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::ETFHoldingsData`. 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?(:'symbol')
+        self.symbol = attributes[:'symbol']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'isin')
+        self.isin = attributes[:'isin']
+      end
+
+      if attributes.key?(:'cusip')
+        self.cusip = attributes[:'cusip']
+      end
+
+      if attributes.key?(:'share')
+        self.share = attributes[:'share']
+      end
+
+      if attributes.key?(:'percent')
+        self.percent = attributes[:'percent']
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          symbol == o.symbol &&
+          name == o.name &&
+          isin == o.isin &&
+          cusip == o.cusip &&
+          share == o.share &&
+          percent == o.percent &&
+          value == o.value
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [symbol, name, isin, cusip, share, percent, value].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # 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
+    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
+
+  end
+
+end

data/lib/finnhub_ruby/models/etf_profile_data.rb

@@ -0,0 +1,389 @@
+=begin
+#Finnhub API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.2.0
+
+=end
+
+require 'date'
+require 'time'
+
+module FinnhubRuby
+  class ETFProfileData
+    # Name
+    attr_accessor :name
+
+    # Asset Class.
+    attr_accessor :asset_class
+
+    # Investment Segment.
+    attr_accessor :investment_segment
+
+    # AUM.
+    attr_accessor :aum
+
+    # NAV.
+    attr_accessor :nav
+
+    # NAV currency.
+    attr_accessor :nav_currency
+
+    # Expense ratio.
+    attr_accessor :expense_ratio
+
+    # Tracking Index.
+    attr_accessor :tracking_index
+
+    # ETF issuer.
+    attr_accessor :etf_company
+
+    # ETF domicile.
+    attr_accessor :domicile
+
+    # Inception date.
+    attr_accessor :inception_date
+
+    # ETF's website.
+    attr_accessor :website
+
+    # ISIN.
+    attr_accessor :isin
+
+    # CUSIP.
+    attr_accessor :cusip
+
+    # P/E.
+    attr_accessor :price_to_earnings
+
+    # P/B.
+    attr_accessor :price_to_book
+
+    # 30-day average volume.
+    attr_accessor :avg_volume
+
+    # ETF's description.
+    attr_accessor :description
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    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
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    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
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    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
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    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
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    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
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # 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
+    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
+
+  end
+
+end