finnhub_ruby 1.1.17 → 1.1.19

data/lib/finnhub_ruby/models/etf_holdings_data.rb

@@ -36,6 +36,9 @@ module FinnhubRuby
     # Market value
     attr_accessor :value
 
+    # Asset type. Can be 1 of the following values: <code>Equity</code>, <code>ETP</code>, <code>Fund</code>, <code>Bond</code>, <code>Other</code> or empty.
+    attr_accessor :asset_type
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -45,7 +48,8 @@ module FinnhubRuby
         :'cusip' => :'cusip',
         :'share' => :'share',
         :'percent' => :'percent',
-        :'value' => :'value'
+        :'value' => :'value',
+        :'asset_type' => :'assetType'
       }
     end
 
@@ -63,7 +67,8 @@ module FinnhubRuby
         :'cusip' => :'String',
         :'share' => :'Float',
         :'percent' => :'Float',
-        :'value' => :'Float'
+        :'value' => :'Float',
+        :'asset_type' => :'String'
       }
     end
 
@@ -115,6 +120,10 @@ module FinnhubRuby
       if attributes.key?(:'value')
         self.value = attributes[:'value']
       end
+
+      if attributes.key?(:'asset_type')
+        self.asset_type = attributes[:'asset_type']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -141,7 +150,8 @@ module FinnhubRuby
           cusip == o.cusip &&
           share == o.share &&
           percent == o.percent &&
-          value == o.value
+          value == o.value &&
+          asset_type == o.asset_type
     end
 
     # @see the `==` method
@@ -153,7 +163,7 @@ module FinnhubRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [symbol, name, isin, cusip, share, percent, value].hash
+      [symbol, name, isin, cusip, share, percent, value, asset_type].hash
     end
 
     # Builds the object from hash

data/lib/finnhub_ruby/models/etf_profile_data.rb

@@ -33,7 +33,7 @@ module FinnhubRuby
     # NAV currency.
     attr_accessor :nav_currency
 
-    # Expense ratio.
+    # Expense ratio. For non-US funds, this is the <a href=\"https://www.esma.europa.eu/sites/default/files/library/2015/11/09_1028_final_kid_ongoing_charges_methodology_for_publication_u_2_.pdf\" target=\"_blank\">KID ongoing charges<a/>.
     attr_accessor :expense_ratio
 
     # Tracking Index.
@@ -69,6 +69,15 @@ module FinnhubRuby
     # ETF's description.
     attr_accessor :description
 
+    # Whether the ETF is inverse
+    attr_accessor :is_inverse
+
+    # Whether the ETF is leveraged
+    attr_accessor :is_leveraged
+
+    # Leverage factor.
+    attr_accessor :leverage_factor
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -89,7 +98,10 @@ module FinnhubRuby
         :'price_to_earnings' => :'priceToEarnings',
         :'price_to_book' => :'priceToBook',
         :'avg_volume' => :'avgVolume',
-        :'description' => :'description'
+        :'description' => :'description',
+        :'is_inverse' => :'isInverse',
+        :'is_leveraged' => :'isLeveraged',
+        :'leverage_factor' => :'leverageFactor'
       }
     end
 
@@ -118,7 +130,10 @@ module FinnhubRuby
         :'price_to_earnings' => :'Float',
         :'price_to_book' => :'Float',
         :'avg_volume' => :'Float',
-        :'description' => :'String'
+        :'description' => :'String',
+        :'is_inverse' => :'Boolean',
+        :'is_leveraged' => :'Boolean',
+        :'leverage_factor' => :'Float'
       }
     end
 
@@ -214,6 +229,18 @@ module FinnhubRuby
       if attributes.key?(:'description')
         self.description = attributes[:'description']
       end
+
+      if attributes.key?(:'is_inverse')
+        self.is_inverse = attributes[:'is_inverse']
+      end
+
+      if attributes.key?(:'is_leveraged')
+        self.is_leveraged = attributes[:'is_leveraged']
+      end
+
+      if attributes.key?(:'leverage_factor')
+        self.leverage_factor = attributes[:'leverage_factor']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -251,7 +278,10 @@ module FinnhubRuby
           price_to_earnings == o.price_to_earnings &&
           price_to_book == o.price_to_book &&
           avg_volume == o.avg_volume &&
-          description == o.description
+          description == o.description &&
+          is_inverse == o.is_inverse &&
+          is_leveraged == o.is_leveraged &&
+          leverage_factor == o.leverage_factor
     end
 
     # @see the `==` method
@@ -263,7 +293,7 @@ module FinnhubRuby
     # 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
+      [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, is_inverse, is_leveraged, leverage_factor].hash
     end
 
     # Builds the object from hash

data/lib/finnhub_ruby/models/excerpt_response.rb

@@ -0,0 +1,249 @@
+=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.1
+
+=end
+
+require 'date'
+require 'time'
+
+module FinnhubRuby
+  class ExcerptResponse
+    # Highlighted content
+    attr_accessor :content
+
+    # Location of the content in the rendered document
+    attr_accessor :snippet_id
+
+    # Start offset of highlighted content
+    attr_accessor :start_offset
+
+    # End offset of highlighted content
+    attr_accessor :end_offset
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'content' => :'content',
+        :'snippet_id' => :'snippetId',
+        :'start_offset' => :'startOffset',
+        :'end_offset' => :'endOffset'
+      }
+    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
+      {
+        :'content' => :'String',
+        :'snippet_id' => :'String',
+        :'start_offset' => :'String',
+        :'end_offset' => :'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::ExcerptResponse` 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::ExcerptResponse`. 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?(:'content')
+        self.content = attributes[:'content']
+      end
+
+      if attributes.key?(:'snippet_id')
+        self.snippet_id = attributes[:'snippet_id']
+      end
+
+      if attributes.key?(:'start_offset')
+        self.start_offset = attributes[:'start_offset']
+      end
+
+      if attributes.key?(:'end_offset')
+        self.end_offset = attributes[:'end_offset']
+      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 &&
+          content == o.content &&
+          snippet_id == o.snippet_id &&
+          start_offset == o.start_offset &&
+          end_offset == o.end_offset
+    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
+      [content, snippet_id, start_offset, end_offset].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