finnhub_ruby 1.1.11 → 1.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 887ccfa4be052b78b027b7a389128310365222765cd7bfee47740c83d6d3e22a
-  data.tar.gz: 95ee3425f9777f58cb12cad609c491bebb6b01cbbef5b6f6cabca2d4dd109f44
+  metadata.gz: 673dff85fca4569468c9266af247714554296a6417f18caa8fb652de5cd35ca3
+  data.tar.gz: '06890889ff4f66e2c4675ff20b7d9912dcaccff1172d28b6093c47e2f1e892df'
 SHA512:
-  metadata.gz: 8225eea9a2bd4790c0290b299cf176c21c48c3c1a4fb2a3c2daab585b4b68ac2e937c043f26ef4f3ebb0db36b27dcfba6e54c8537562d91b298cdabdd9809e25
-  data.tar.gz: d46aefa594bd4363c4a2fd061b2f9e9c42b96c58c85465f467331f98fe4518f55215d5d4119f1f7a4408643bc777e5bb33c336c19f36ff9441e1e265acafa82e
+  metadata.gz: d30aefb33b9d6fc51c68fa17cea7fb700da02491e1280491f847664d8b337365168eac933cf27725cb4488094a08e0d68d4bbf454dfe1d43f6740e8e42acc563
+  data.tar.gz: b2f491a4a784874ef91512b8384ac1d855ff03780a4ffad62e045aa23fd69229a3157cadb1ebe8df093ce94fe7c3eeac5fbd8a13ef9c0dba90a86b1f1bcdad90

data/README.md

@@ -1,7 +1,7 @@
 # finnhub-ruby
 - API documentation: https://finnhub.io/docs/api
 - API version: 1.0.0
-- Package version: 1.1.11
+- Package version: 1.1.12
 
 ## Installation
 https://rubygems.org/gems/finnhub_ruby
@@ -13,7 +13,7 @@ gem install finnhub_ruby
 or in your Gemfile
 
 ```ruby
-gem 'finnhub_ruby', '~> 1.1.11'
+gem 'finnhub_ruby', '~> 1.1.12'
 ```
 
 ## Getting Started
@@ -67,7 +67,6 @@ puts(finnhub_client.company_eps_estimates('AMZN', {freq: 'quarterly'}))
 puts(finnhub_client.company_executive('AAPL'))
 
 # Company News
-# Need to use _from instead of from to avoid conflict
 puts(finnhub_client.company_news('AAPL', "2020-06-01", "2020-06-10"))
 
 # Company Peers
@@ -251,6 +250,10 @@ puts(finnhub_client.company_ebitda_estimates('AAPL', {freq: 'quarterly'}))
 
 # EBIT Estimates
 puts(finnhub_client.company_ebit_estimates('TSLA', {freq: 'quarterly'}))
+
+# USPTO
+puts(finnhub_client.stock_uspto_patent('NVDA', "2020-06-01", "2021-06-10"))
+
 ```
 
 ## License

data/docs/DefaultApi.md

@@ -71,6 +71,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
 | [**stock_splits**](DefaultApi.md#stock_splits) | **GET** /stock/split | Splits |
 | [**stock_symbols**](DefaultApi.md#stock_symbols) | **GET** /stock/symbol | Stock Symbol |
 | [**stock_tick**](DefaultApi.md#stock_tick) | **GET** /stock/tick | Tick Data |
+| [**stock_uspto_patent**](DefaultApi.md#stock_uspto_patent) | **GET** /stock/uspto-patent | USPTO Patents |
 | [**supply_chain_relationships**](DefaultApi.md#supply_chain_relationships) | **GET** /stock/supply-chain | Supply Chain Relationships |
 | [**support_resistance**](DefaultApi.md#support_resistance) | **GET** /scan/support-resistance | Support/Resistance |
 | [**symbol_search**](DefaultApi.md#symbol_search) | **GET** /search | Symbol Lookup |
@@ -3091,7 +3092,7 @@ end
 
 International Filings
 
-List filings for international companies which covers 95%+ of global market cap. Limit to 250 documents at a time. These are the documents we use to source our fundamental data.
+List filings for international companies. Limit to 250 documents at a time. These are the documents we use to source our fundamental data.
 
 ### Examples
 
@@ -5013,6 +5014,81 @@ end
 - **Accept**: application/json
 
 
+## stock_uspto_patent
+
+> <UsptoPatentResult> stock_uspto_patent(symbol, from, to)
+
+USPTO Patents
+
+List USPTO patents for companies. Limit to 250 records per API call.
+
+### Examples
+
+```ruby
+require 'time'
+require 'finnhub_ruby'
+# setup authorization
+FinnhubRuby.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['api_key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['api_key'] = 'Bearer'
+end
+
+api_instance = FinnhubRuby::DefaultApi.new
+symbol = 'symbol_example' # String | Symbol.
+from = Date.parse('2013-10-20') # Date | From date <code>YYYY-MM-DD</code>.
+to = Date.parse('2013-10-20') # Date | To date <code>YYYY-MM-DD</code>.
+
+begin
+  # USPTO Patents
+  result = api_instance.stock_uspto_patent(symbol, from, to)
+  p result
+rescue FinnhubRuby::ApiError => e
+  puts "Error when calling DefaultApi->stock_uspto_patent: #{e}"
+end
+```
+
+#### Using the stock_uspto_patent_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UsptoPatentResult>, Integer, Hash)> stock_uspto_patent_with_http_info(symbol, from, to)
+
+```ruby
+begin
+  # USPTO Patents
+  data, status_code, headers = api_instance.stock_uspto_patent_with_http_info(symbol, from, to)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UsptoPatentResult>
+rescue FinnhubRuby::ApiError => e
+  puts "Error when calling DefaultApi->stock_uspto_patent_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol. |  |
+| **from** | **Date** | From date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;. |  |
+| **to** | **Date** | To date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;. |  |
+
+### Return type
+
+[**UsptoPatentResult**](UsptoPatentResult.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## supply_chain_relationships
 
 > <SupplyChainRelationships> supply_chain_relationships(symbol)

data/docs/StockSymbol.md

@@ -10,7 +10,10 @@
 | **type** | **String** | Security type. | [optional] |
 | **mic** | **String** | Primary exchange's MIC. | [optional] |
 | **figi** | **String** | FIGI identifier. | [optional] |
+| **share_class_figi** | **String** | Global Share Class FIGI. | [optional] |
 | **currency** | **String** | Price's currency. This might be different from the reporting currency of fundamental data. | [optional] |
+| **symbol2** | **String** | Alternative ticker for exchanges with multiple tickers for 1 stock such as BSE. | [optional] |
+| **isin** | **String** | ISIN. This field is only available for EU stocks and selected Asian markets. Entitlement from Finnhub is required to access this field. | [optional] |
 
 ## Example
 
@@ -24,7 +27,10 @@ instance = FinnhubRuby::StockSymbol.new(
   type: null,
   mic: null,
   figi: null,
-  currency: null
+  share_class_figi: null,
+  currency: null,
+  symbol2: null,
+  isin: null
 )
 ```
 

data/docs/UsptoPatent.md

@@ -0,0 +1,34 @@
+# FinnhubRuby::UsptoPatent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **application_number** | **String** | Application Number. | [optional] |
+| **company_filing_name** | **Array<String>** | Array of companies' name on the patent. | [optional] |
+| **filing_date** | **String** | Filing date. | [optional] |
+| **description** | **String** | Description. | [optional] |
+| **filing_status** | **String** | Filing status. | [optional] |
+| **patent_number** | **String** | Patent number. | [optional] |
+| **publication_date** | **String** | Filing date. | [optional] |
+| **patent_type** | **String** | Patent's type. | [optional] |
+| **url** | **String** | URL of the original article. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::UsptoPatent.new(
+  application_number: null,
+  company_filing_name: null,
+  filing_date: null,
+  description: null,
+  filing_status: null,
+  patent_number: null,
+  publication_date: null,
+  patent_type: null,
+  url: null
+)
+```
+

data/docs/UsptoPatentResult.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::UsptoPatentResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol. | [optional] |
+| **data** | [**Array<UsptoPatent>**](UsptoPatent.md) | Array of patents. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::UsptoPatentResult.new(
+  symbol: null,
+  data: null
+)
+```
+

data/lib/finnhub_ruby/api/default_api.rb

@@ -2738,7 +2738,7 @@ module FinnhubRuby
     end
 
     # International Filings
-    # List filings for international companies which covers 95%+ of global market cap. Limit to 250 documents at a time. These are the documents we use to source our fundamental data.
+    # List filings for international companies. Limit to 250 documents at a time. These are the documents we use to source our fundamental data.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :symbol Symbol. Leave empty to list latest filings.
     # @option opts [String] :country Filter by country using country's 2-letter code.
@@ -2749,7 +2749,7 @@ module FinnhubRuby
     end
 
     # International Filings
-    # List filings for international companies which covers 95%+ of global market cap. Limit to 250 documents at a time. These are the documents we use to source our fundamental data.
+    # List filings for international companies. Limit to 250 documents at a time. These are the documents we use to source our fundamental data.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :symbol Symbol. Leave empty to list latest filings.
     # @option opts [String] :country Filter by country using country's 2-letter code.
@@ -4534,6 +4534,84 @@ module FinnhubRuby
       return data, status_code, headers
     end
 
+    # USPTO Patents
+    # List USPTO patents for companies. Limit to 250 records per API call.
+    # @param symbol [String] Symbol.
+    # @param from [Date] From date <code>YYYY-MM-DD</code>.
+    # @param to [Date] To date <code>YYYY-MM-DD</code>.
+    # @param [Hash] opts the optional parameters
+    # @return [UsptoPatentResult]
+    def stock_uspto_patent(symbol, from, to, opts = {})
+      data, _status_code, _headers = stock_uspto_patent_with_http_info(symbol, from, to, opts)
+      data
+    end
+
+    # USPTO Patents
+    # List USPTO patents for companies. Limit to 250 records per API call.
+    # @param symbol [String] Symbol.
+    # @param from [Date] From date <code>YYYY-MM-DD</code>.
+    # @param to [Date] To date <code>YYYY-MM-DD</code>.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UsptoPatentResult, Integer, Hash)>] UsptoPatentResult data, response status code and response headers
+    def stock_uspto_patent_with_http_info(symbol, from, to, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.stock_uspto_patent ...'
+      end
+      # verify the required parameter 'symbol' is set
+      if @api_client.config.client_side_validation && symbol.nil?
+        fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.stock_uspto_patent"
+      end
+      # verify the required parameter 'from' is set
+      if @api_client.config.client_side_validation && from.nil?
+        fail ArgumentError, "Missing the required parameter 'from' when calling DefaultApi.stock_uspto_patent"
+      end
+      # verify the required parameter 'to' is set
+      if @api_client.config.client_side_validation && to.nil?
+        fail ArgumentError, "Missing the required parameter 'to' when calling DefaultApi.stock_uspto_patent"
+      end
+      # resource path
+      local_var_path = '/stock/uspto-patent'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'symbol'] = symbol
+      query_params[:'from'] = from
+      query_params[:'to'] = to
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'UsptoPatentResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.stock_uspto_patent",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#stock_uspto_patent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Supply Chain Relationships
     # <p>This endpoint provides an overall map of public companies' key customers and suppliers. The data offers a deeper look into a company's supply chain and how products are created. The data will help investors manage risk, limit exposure or generate alpha-generating ideas and trading insights.</p><p>We currently cover data for S&P500 and Nasdaq 100 companies.</p>
     # @param symbol [String] Symbol.

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
+
+    # Filing 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

data/lib/finnhub_ruby/models/uspto_patent_result.rb

@@ -0,0 +1,231 @@
+=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 UsptoPatentResult
+    # Symbol.
+    attr_accessor :symbol
+
+    # Array of patents.
+    attr_accessor :data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'symbol' => :'symbol',
+        :'data' => :'data'
+      }
+    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',
+        :'data' => :'Array<UsptoPatent>'
+      }
+    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::UsptoPatentResult` 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::UsptoPatentResult`. 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?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = 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 &&
+          symbol == o.symbol &&
+          data == o.data
+    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, data].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/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.2.1
 =end
 
 module FinnhubRuby
-  VERSION = '1.1.11'
+  VERSION = '1.1.12'
 end

data/lib/finnhub_ruby.rb

@@ -128,6 +128,8 @@ require 'finnhub_ruby/models/transcript_participant'
 require 'finnhub_ruby/models/trend'
 require 'finnhub_ruby/models/twitter_sentiment_content'
 require 'finnhub_ruby/models/upgrade_downgrade'
+require 'finnhub_ruby/models/uspto_patent'
+require 'finnhub_ruby/models/uspto_patent_result'
 
 # APIs
 require 'finnhub_ruby/api/default_api'

data/spec/models/uspto_patent_result_spec.rb

@@ -0,0 +1,40 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for FinnhubRuby::UsptoPatentResult
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe FinnhubRuby::UsptoPatentResult do
+  let(:instance) { FinnhubRuby::UsptoPatentResult.new }
+
+  describe 'test an instance of UsptoPatentResult' do
+    it 'should create an instance of UsptoPatentResult' do
+      expect(instance).to be_instance_of(FinnhubRuby::UsptoPatentResult)
+    end
+  end
+  describe 'test attribute "symbol"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "data"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/uspto_patent_spec.rb

@@ -0,0 +1,82 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for FinnhubRuby::UsptoPatent
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe FinnhubRuby::UsptoPatent do
+  let(:instance) { FinnhubRuby::UsptoPatent.new }
+
+  describe 'test an instance of UsptoPatent' do
+    it 'should create an instance of UsptoPatent' do
+      expect(instance).to be_instance_of(FinnhubRuby::UsptoPatent)
+    end
+  end
+  describe 'test attribute "application_number"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "company_filing_name"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "filing_date"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "description"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "filing_status"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "patent_number"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "publication_date"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "patent_type"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "url"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finnhub_ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.11
+  version: 1.1.12
 platform: ruby
 authors:
 - OpenAPI-Generator
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-27 00:00:00.000000000 Z
+date: 2022-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -175,7 +175,10 @@ files:
 - docs/Trend.md
 - docs/TwitterSentimentContent.md
 - docs/UpgradeDowngrade.md
+- docs/UsptoPatent.md
+- docs/UsptoPatentResult.md
 - finnhub_ruby-1.1.10.gem
+- finnhub_ruby-1.1.11.gem
 - finnhub_ruby-1.1.7.gem
 - finnhub_ruby-1.1.8.gem
 - finnhub_ruby-1.1.9.gem
@@ -314,6 +317,8 @@ files:
 - lib/finnhub_ruby/models/trend.rb
 - lib/finnhub_ruby/models/twitter_sentiment_content.rb
 - lib/finnhub_ruby/models/upgrade_downgrade.rb
+- lib/finnhub_ruby/models/uspto_patent.rb
+- lib/finnhub_ruby/models/uspto_patent_result.rb
 - lib/finnhub_ruby/version.rb
 - release.sh
 - spec/api/default_api_spec.rb
@@ -432,6 +437,8 @@ files:
 - spec/models/trend_spec.rb
 - spec/models/twitter_sentiment_content_spec.rb
 - spec/models/upgrade_downgrade_spec.rb
+- spec/models/uspto_patent_result_spec.rb
+- spec/models/uspto_patent_spec.rb
 - spec/spec_helper.rb
 homepage: https://openapi-generator.tech
 licenses:
@@ -567,7 +574,9 @@ test_files:
 - spec/models/dividends_spec.rb
 - spec/models/transcript_content_spec.rb
 - spec/models/international_filing_spec.rb
+- spec/models/uspto_patent_result_spec.rb
 - spec/models/reddit_sentiment_content_spec.rb
+- spec/models/uspto_patent_spec.rb
 - spec/models/fund_ownership_spec.rb
 - spec/models/sec_sentiment_analysis_spec.rb
 - spec/models/twitter_sentiment_content_spec.rb