finnhub_ruby 1.1.17 → 1.1.19

data/lib/finnhub_ruby/models/filing_response.rb

@@ -0,0 +1,339 @@
+=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 FilingResponse
+    # Filing Id in Alpharesearch platform
+    attr_accessor :filing_id
+
+    # Filing title
+    attr_accessor :title
+
+    # Id of the entity submitted the filing
+    attr_accessor :filer_id
+
+    # List of symbol associate with this filing
+    attr_accessor :symbol
+
+    # Filer name
+    attr_accessor :name
+
+    # Date the filing is submitted.
+    attr_accessor :acceptance_date
+
+    # Date the filing is make available to the public
+    attr_accessor :filed_date
+
+    # Date as which the filing is reported
+    attr_accessor :report_date
+
+    # Filing Form
+    attr_accessor :form
+
+    # Amendment
+    attr_accessor :amend
+
+    # Filing Source
+    attr_accessor :source
+
+    # Estimate number of page when printing
+    attr_accessor :page_count
+
+    # Number of document in this filing
+    attr_accessor :document_count
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'filing_id' => :'filingId',
+        :'title' => :'title',
+        :'filer_id' => :'filerId',
+        :'symbol' => :'symbol',
+        :'name' => :'name',
+        :'acceptance_date' => :'acceptanceDate',
+        :'filed_date' => :'filedDate',
+        :'report_date' => :'reportDate',
+        :'form' => :'form',
+        :'amend' => :'amend',
+        :'source' => :'source',
+        :'page_count' => :'pageCount',
+        :'document_count' => :'documentCount'
+      }
+    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
+      {
+        :'filing_id' => :'String',
+        :'title' => :'String',
+        :'filer_id' => :'String',
+        :'symbol' => :'Object',
+        :'name' => :'String',
+        :'acceptance_date' => :'String',
+        :'filed_date' => :'String',
+        :'report_date' => :'String',
+        :'form' => :'String',
+        :'amend' => :'Boolean',
+        :'source' => :'String',
+        :'page_count' => :'Integer',
+        :'document_count' => :'Integer'
+      }
+    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::FilingResponse` 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::FilingResponse`. 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?(:'filing_id')
+        self.filing_id = attributes[:'filing_id']
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'filer_id')
+        self.filer_id = attributes[:'filer_id']
+      end
+
+      if attributes.key?(:'symbol')
+        self.symbol = attributes[:'symbol']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'acceptance_date')
+        self.acceptance_date = attributes[:'acceptance_date']
+      end
+
+      if attributes.key?(:'filed_date')
+        self.filed_date = attributes[:'filed_date']
+      end
+
+      if attributes.key?(:'report_date')
+        self.report_date = attributes[:'report_date']
+      end
+
+      if attributes.key?(:'form')
+        self.form = attributes[:'form']
+      end
+
+      if attributes.key?(:'amend')
+        self.amend = attributes[:'amend']
+      end
+
+      if attributes.key?(:'source')
+        self.source = attributes[:'source']
+      end
+
+      if attributes.key?(:'page_count')
+        self.page_count = attributes[:'page_count']
+      end
+
+      if attributes.key?(:'document_count')
+        self.document_count = attributes[:'document_count']
+      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 &&
+          filing_id == o.filing_id &&
+          title == o.title &&
+          filer_id == o.filer_id &&
+          symbol == o.symbol &&
+          name == o.name &&
+          acceptance_date == o.acceptance_date &&
+          filed_date == o.filed_date &&
+          report_date == o.report_date &&
+          form == o.form &&
+          amend == o.amend &&
+          source == o.source &&
+          page_count == o.page_count &&
+          document_count == o.document_count
+    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
+      [filing_id, title, filer_id, symbol, name, acceptance_date, filed_date, report_date, form, amend, source, page_count, document_count].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/in_filing_response.rb

@@ -0,0 +1,351 @@
+=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 InFilingResponse
+    # Filing Id in Alpharesearch platform
+    attr_accessor :filing_id
+
+    # Filing title
+    attr_accessor :title
+
+    # Id of the entity submitted the filing
+    attr_accessor :filer_id
+
+    # List of symbol associate with this filing
+    attr_accessor :symbol
+
+    # Filer name
+    attr_accessor :name
+
+    # Date the filing is submitted.
+    attr_accessor :acceptance_date
+
+    # Date the filing is make available to the public
+    attr_accessor :filed_date
+
+    # Date as which the filing is reported
+    attr_accessor :report_date
+
+    # Filing Form
+    attr_accessor :form
+
+    # Amendment
+    attr_accessor :amend
+
+    # Filing Source
+    attr_accessor :source
+
+    # Estimate number of page when printing
+    attr_accessor :page_count
+
+    # Number of document in this filing
+    attr_accessor :document_count
+
+    # Document for this filing.
+    attr_accessor :documents
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'filing_id' => :'filingId',
+        :'title' => :'title',
+        :'filer_id' => :'filerId',
+        :'symbol' => :'symbol',
+        :'name' => :'name',
+        :'acceptance_date' => :'acceptanceDate',
+        :'filed_date' => :'filedDate',
+        :'report_date' => :'reportDate',
+        :'form' => :'form',
+        :'amend' => :'amend',
+        :'source' => :'source',
+        :'page_count' => :'pageCount',
+        :'document_count' => :'documentCount',
+        :'documents' => :'documents'
+      }
+    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
+      {
+        :'filing_id' => :'String',
+        :'title' => :'String',
+        :'filer_id' => :'String',
+        :'symbol' => :'Object',
+        :'name' => :'String',
+        :'acceptance_date' => :'String',
+        :'filed_date' => :'String',
+        :'report_date' => :'String',
+        :'form' => :'String',
+        :'amend' => :'Boolean',
+        :'source' => :'String',
+        :'page_count' => :'Integer',
+        :'document_count' => :'Integer',
+        :'documents' => :'Array<DocumentResponse>'
+      }
+    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::InFilingResponse` 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::InFilingResponse`. 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?(:'filing_id')
+        self.filing_id = attributes[:'filing_id']
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'filer_id')
+        self.filer_id = attributes[:'filer_id']
+      end
+
+      if attributes.key?(:'symbol')
+        self.symbol = attributes[:'symbol']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'acceptance_date')
+        self.acceptance_date = attributes[:'acceptance_date']
+      end
+
+      if attributes.key?(:'filed_date')
+        self.filed_date = attributes[:'filed_date']
+      end
+
+      if attributes.key?(:'report_date')
+        self.report_date = attributes[:'report_date']
+      end
+
+      if attributes.key?(:'form')
+        self.form = attributes[:'form']
+      end
+
+      if attributes.key?(:'amend')
+        self.amend = attributes[:'amend']
+      end
+
+      if attributes.key?(:'source')
+        self.source = attributes[:'source']
+      end
+
+      if attributes.key?(:'page_count')
+        self.page_count = attributes[:'page_count']
+      end
+
+      if attributes.key?(:'document_count')
+        self.document_count = attributes[:'document_count']
+      end
+
+      if attributes.key?(:'documents')
+        if (value = attributes[:'documents']).is_a?(Array)
+          self.documents = 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 &&
+          filing_id == o.filing_id &&
+          title == o.title &&
+          filer_id == o.filer_id &&
+          symbol == o.symbol &&
+          name == o.name &&
+          acceptance_date == o.acceptance_date &&
+          filed_date == o.filed_date &&
+          report_date == o.report_date &&
+          form == o.form &&
+          amend == o.amend &&
+          source == o.source &&
+          page_count == o.page_count &&
+          document_count == o.document_count &&
+          documents == o.documents
+    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
+      [filing_id, title, filer_id, symbol, name, acceptance_date, filed_date, report_date, form, amend, source, page_count, document_count, documents].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