finnhub_ruby 1.1.17 → 1.1.19

data/lib/finnhub_ruby/models/congressional_transaction.rb

@@ -0,0 +1,309 @@
+=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 CongressionalTransaction
+    # Transaction amount from.
+    attr_accessor :amount_from
+
+    # Transaction amount to.
+    attr_accessor :amount_to
+
+    # Asset name.
+    attr_accessor :asset_name
+
+    # Filing date.
+    attr_accessor :filing_date
+
+    # Name of the representative.
+    attr_accessor :name
+
+    # Owner Type.
+    attr_accessor :owner_type
+
+    # Position.
+    attr_accessor :position
+
+    # Symbol.
+    attr_accessor :symbol
+
+    # Transaction date.
+    attr_accessor :transaction_date
+
+    # Transaction type <code>Sale</code> or <code>Purchase</code>.
+    attr_accessor :transaction_type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'amount_from' => :'amountFrom',
+        :'amount_to' => :'amountTo',
+        :'asset_name' => :'assetName',
+        :'filing_date' => :'filingDate',
+        :'name' => :'name',
+        :'owner_type' => :'ownerType',
+        :'position' => :'position',
+        :'symbol' => :'symbol',
+        :'transaction_date' => :'transactionDate',
+        :'transaction_type' => :'transactionType'
+      }
+    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
+      {
+        :'amount_from' => :'Float',
+        :'amount_to' => :'Float',
+        :'asset_name' => :'String',
+        :'filing_date' => :'String',
+        :'name' => :'String',
+        :'owner_type' => :'String',
+        :'position' => :'String',
+        :'symbol' => :'String',
+        :'transaction_date' => :'String',
+        :'transaction_type' => :'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::CongressionalTransaction` 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::CongressionalTransaction`. 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?(:'amount_from')
+        self.amount_from = attributes[:'amount_from']
+      end
+
+      if attributes.key?(:'amount_to')
+        self.amount_to = attributes[:'amount_to']
+      end
+
+      if attributes.key?(:'asset_name')
+        self.asset_name = attributes[:'asset_name']
+      end
+
+      if attributes.key?(:'filing_date')
+        self.filing_date = attributes[:'filing_date']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'owner_type')
+        self.owner_type = attributes[:'owner_type']
+      end
+
+      if attributes.key?(:'position')
+        self.position = attributes[:'position']
+      end
+
+      if attributes.key?(:'symbol')
+        self.symbol = attributes[:'symbol']
+      end
+
+      if attributes.key?(:'transaction_date')
+        self.transaction_date = attributes[:'transaction_date']
+      end
+
+      if attributes.key?(:'transaction_type')
+        self.transaction_type = attributes[:'transaction_type']
+      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 &&
+          amount_from == o.amount_from &&
+          amount_to == o.amount_to &&
+          asset_name == o.asset_name &&
+          filing_date == o.filing_date &&
+          name == o.name &&
+          owner_type == o.owner_type &&
+          position == o.position &&
+          symbol == o.symbol &&
+          transaction_date == o.transaction_date &&
+          transaction_type == o.transaction_type
+    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
+      [amount_from, amount_to, asset_name, filing_date, name, owner_type, position, symbol, transaction_date, transaction_type].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/dividends.rb

@@ -39,6 +39,9 @@ module FinnhubRuby
     # Currency.
     attr_accessor :currency
 
+    # <p>Dividend frequency. Can be 1 of the following values:</p><ul> <li><code>0: Annually</code></li> <li><code>1: Monthly</code></li> <li><code>2: Quarterly</code></li> <li><code>3: Semi-annually</code></li> <li><code>4: Other/Unknown</code></li> <li><code>5: Bimonthly</code></li> <li><code>6: Trimesterly</code></li> <li><code>7: Weekly</code></li> </ul>
+    attr_accessor :freq
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -49,7 +52,8 @@ module FinnhubRuby
         :'pay_date' => :'payDate',
         :'record_date' => :'recordDate',
         :'declaration_date' => :'declarationDate',
-        :'currency' => :'currency'
+        :'currency' => :'currency',
+        :'freq' => :'freq'
       }
     end
 
@@ -68,7 +72,8 @@ module FinnhubRuby
         :'pay_date' => :'Date',
         :'record_date' => :'Date',
         :'declaration_date' => :'Date',
-        :'currency' => :'String'
+        :'currency' => :'String',
+        :'freq' => :'String'
       }
     end
 
@@ -124,6 +129,10 @@ module FinnhubRuby
       if attributes.key?(:'currency')
         self.currency = attributes[:'currency']
       end
+
+      if attributes.key?(:'freq')
+        self.freq = attributes[:'freq']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -151,7 +160,8 @@ module FinnhubRuby
           pay_date == o.pay_date &&
           record_date == o.record_date &&
           declaration_date == o.declaration_date &&
-          currency == o.currency
+          currency == o.currency &&
+          freq == o.freq
     end
 
     # @see the `==` method
@@ -163,7 +173,7 @@ module FinnhubRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [symbol, date, amount, adjusted_amount, pay_date, record_date, declaration_date, currency].hash
+      [symbol, date, amount, adjusted_amount, pay_date, record_date, declaration_date, currency, freq].hash
     end
 
     # Builds the object from hash

data/lib/finnhub_ruby/models/document_response.rb

@@ -0,0 +1,271 @@
+=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 DocumentResponse
+    # AlphaResearch internal document id.
+    attr_accessor :document_id
+
+    # Title for this document.
+    attr_accessor :title
+
+    # Number of hit in this document
+    attr_accessor :hits
+
+    # Link to render this document
+    attr_accessor :url
+
+    # Format of this document (can be html or pdf)
+    attr_accessor :format
+
+    # Highlighted excerpts for this document
+    attr_accessor :excerpts
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'document_id' => :'documentId',
+        :'title' => :'title',
+        :'hits' => :'hits',
+        :'url' => :'url',
+        :'format' => :'format',
+        :'excerpts' => :'excerpts'
+      }
+    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
+      {
+        :'document_id' => :'String',
+        :'title' => :'String',
+        :'hits' => :'String',
+        :'url' => :'String',
+        :'format' => :'String',
+        :'excerpts' => :'Array<ExcerptResponse>'
+      }
+    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::DocumentResponse` 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::DocumentResponse`. 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?(:'document_id')
+        self.document_id = attributes[:'document_id']
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'hits')
+        self.hits = attributes[:'hits']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'format')
+        self.format = attributes[:'format']
+      end
+
+      if attributes.key?(:'excerpts')
+        if (value = attributes[:'excerpts']).is_a?(Array)
+          self.excerpts = value
+        end
+      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 &&
+          document_id == o.document_id &&
+          title == o.title &&
+          hits == o.hits &&
+          url == o.url &&
+          format == o.format &&
+          excerpts == o.excerpts
+    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
+      [document_id, title, hits, url, format, excerpts].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/earning_result.rb

@@ -33,6 +33,12 @@ module FinnhubRuby
     # Company symbol.
     attr_accessor :symbol
 
+    # Earnings year.
+    attr_accessor :year
+
+    # Earnings quarter.
+    attr_accessor :quarter
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -41,7 +47,9 @@ module FinnhubRuby
         :'surprise' => :'surprise',
         :'surprise_percent' => :'surprisePercent',
         :'period' => :'period',
-        :'symbol' => :'symbol'
+        :'symbol' => :'symbol',
+        :'year' => :'year',
+        :'quarter' => :'quarter'
       }
     end
 
@@ -58,7 +66,9 @@ module FinnhubRuby
         :'surprise' => :'Float',
         :'surprise_percent' => :'Float',
         :'period' => :'Date',
-        :'symbol' => :'String'
+        :'symbol' => :'String',
+        :'year' => :'Integer',
+        :'quarter' => :'Integer'
       }
     end
 
@@ -106,6 +116,14 @@ module FinnhubRuby
       if attributes.key?(:'symbol')
         self.symbol = attributes[:'symbol']
       end
+
+      if attributes.key?(:'year')
+        self.year = attributes[:'year']
+      end
+
+      if attributes.key?(:'quarter')
+        self.quarter = attributes[:'quarter']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -131,7 +149,9 @@ module FinnhubRuby
           surprise == o.surprise &&
           surprise_percent == o.surprise_percent &&
           period == o.period &&
-          symbol == o.symbol
+          symbol == o.symbol &&
+          year == o.year &&
+          quarter == o.quarter
     end
 
     # @see the `==` method
@@ -143,7 +163,7 @@ module FinnhubRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [actual, estimate, surprise, surprise_percent, period, symbol].hash
+      [actual, estimate, surprise, surprise_percent, period, symbol, year, quarter].hash
     end
 
     # Builds the object from hash