finnhub_ruby 1.1.11 → 1.1.14

data/lib/finnhub_ruby/models/insider_sentiments_data.rb

@@ -0,0 +1,259 @@
+=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 InsiderSentimentsData
+    # Symbol.
+    attr_accessor :symbol
+
+    # Year.
+    attr_accessor :year
+
+    # Month.
+    attr_accessor :month
+
+    # Net buying/selling from all insiders' transactions.
+    attr_accessor :change
+
+    # Monthly share purchase ratio.
+    attr_accessor :mspr
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'symbol' => :'symbol',
+        :'year' => :'year',
+        :'month' => :'month',
+        :'change' => :'change',
+        :'mspr' => :'mspr'
+      }
+    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',
+        :'year' => :'Integer',
+        :'month' => :'Integer',
+        :'change' => :'Integer',
+        :'mspr' => :'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::InsiderSentimentsData` 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::InsiderSentimentsData`. 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?(:'year')
+        self.year = attributes[:'year']
+      end
+
+      if attributes.key?(:'month')
+        self.month = attributes[:'month']
+      end
+
+      if attributes.key?(:'change')
+        self.change = attributes[:'change']
+      end
+
+      if attributes.key?(:'mspr')
+        self.mspr = attributes[:'mspr']
+      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 &&
+          year == o.year &&
+          month == o.month &&
+          change == o.change &&
+          mspr == o.mspr
+    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, year, month, change, mspr].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/stock_symbol.rb

@@ -33,9 +33,18 @@ module FinnhubRuby
     # FIGI identifier.
     attr_accessor :figi
 
+    # Global Share Class FIGI.
+    attr_accessor :share_class_figi
+
     # Price's currency. This might be different from the reporting currency of fundamental data.
     attr_accessor :currency
 
+    # Alternative ticker for exchanges with multiple tickers for 1 stock such as BSE.
+    attr_accessor :symbol2
+
+    # ISIN. This field is only available for EU stocks and selected Asian markets. Entitlement from Finnhub is required to access this field.
+    attr_accessor :isin
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -45,7 +54,10 @@ module FinnhubRuby
         :'type' => :'type',
         :'mic' => :'mic',
         :'figi' => :'figi',
-        :'currency' => :'currency'
+        :'share_class_figi' => :'shareClassFIGI',
+        :'currency' => :'currency',
+        :'symbol2' => :'symbol2',
+        :'isin' => :'isin'
       }
     end
 
@@ -63,7 +75,10 @@ module FinnhubRuby
         :'type' => :'String',
         :'mic' => :'String',
         :'figi' => :'String',
-        :'currency' => :'String'
+        :'share_class_figi' => :'String',
+        :'currency' => :'String',
+        :'symbol2' => :'String',
+        :'isin' => :'String'
       }
     end
 
@@ -112,9 +127,21 @@ module FinnhubRuby
         self.figi = attributes[:'figi']
       end
 
+      if attributes.key?(:'share_class_figi')
+        self.share_class_figi = attributes[:'share_class_figi']
+      end
+
       if attributes.key?(:'currency')
         self.currency = attributes[:'currency']
       end
+
+      if attributes.key?(:'symbol2')
+        self.symbol2 = attributes[:'symbol2']
+      end
+
+      if attributes.key?(:'isin')
+        self.isin = attributes[:'isin']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -141,7 +168,10 @@ module FinnhubRuby
           type == o.type &&
           mic == o.mic &&
           figi == o.figi &&
-          currency == o.currency
+          share_class_figi == o.share_class_figi &&
+          currency == o.currency &&
+          symbol2 == o.symbol2 &&
+          isin == o.isin
     end
 
     # @see the `==` method
@@ -153,7 +183,7 @@ module FinnhubRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [description, display_symbol, symbol, type, mic, figi, currency].hash
+      [description, display_symbol, symbol, type, mic, figi, share_class_figi, currency, symbol2, isin].hash
     end
 
     # Builds the object from hash

data/lib/finnhub_ruby/models/uspto_patent.rb

@@ -0,0 +1,301 @@
+=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 UsptoPatent
+    # Application Number.
+    attr_accessor :application_number
+
+    # Array of companies' name on the patent.
+    attr_accessor :company_filing_name
+
+    # Filing date.
+    attr_accessor :filing_date
+
+    # Description.
+    attr_accessor :description
+
+    # Filing status.
+    attr_accessor :filing_status
+
+    # Patent number.
+    attr_accessor :patent_number
+
+    # Publication date.
+    attr_accessor :publication_date
+
+    # Patent's type.
+    attr_accessor :patent_type
+
+    # URL of the original article.
+    attr_accessor :url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'application_number' => :'applicationNumber',
+        :'company_filing_name' => :'companyFilingName',
+        :'filing_date' => :'filingDate',
+        :'description' => :'description',
+        :'filing_status' => :'filingStatus',
+        :'patent_number' => :'patentNumber',
+        :'publication_date' => :'publicationDate',
+        :'patent_type' => :'patentType',
+        :'url' => :'url'
+      }
+    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
+      {
+        :'application_number' => :'String',
+        :'company_filing_name' => :'Array<String>',
+        :'filing_date' => :'String',
+        :'description' => :'String',
+        :'filing_status' => :'String',
+        :'patent_number' => :'String',
+        :'publication_date' => :'String',
+        :'patent_type' => :'String',
+        :'url' => :'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::UsptoPatent` 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::UsptoPatent`. 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?(:'application_number')
+        self.application_number = attributes[:'application_number']
+      end
+
+      if attributes.key?(:'company_filing_name')
+        if (value = attributes[:'company_filing_name']).is_a?(Array)
+          self.company_filing_name = value
+        end
+      end
+
+      if attributes.key?(:'filing_date')
+        self.filing_date = attributes[:'filing_date']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'filing_status')
+        self.filing_status = attributes[:'filing_status']
+      end
+
+      if attributes.key?(:'patent_number')
+        self.patent_number = attributes[:'patent_number']
+      end
+
+      if attributes.key?(:'publication_date')
+        self.publication_date = attributes[:'publication_date']
+      end
+
+      if attributes.key?(:'patent_type')
+        self.patent_type = attributes[:'patent_type']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      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 &&
+          application_number == o.application_number &&
+          company_filing_name == o.company_filing_name &&
+          filing_date == o.filing_date &&
+          description == o.description &&
+          filing_status == o.filing_status &&
+          patent_number == o.patent_number &&
+          publication_date == o.publication_date &&
+          patent_type == o.patent_type &&
+          url == o.url
+    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
+      [application_number, company_filing_name, filing_date, description, filing_status, patent_number, publication_date, patent_type, url].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