finnhub_ruby 1.1.8 → 1.1.12

data/docs/DefaultApi.md

@@ -7,6 +7,9 @@ All URIs are relative to *https://finnhub.io/api/v1*
 | [**aggregate_indicator**](DefaultApi.md#aggregate_indicator) | **GET** /scan/technical-indicator | Aggregate Indicators |
 | [**company_basic_financials**](DefaultApi.md#company_basic_financials) | **GET** /stock/metric | Basic Financials |
 | [**company_earnings**](DefaultApi.md#company_earnings) | **GET** /stock/earnings | Earnings Surprises |
+| [**company_earnings_quality_score**](DefaultApi.md#company_earnings_quality_score) | **GET** /stock/earnings-quality-score | Company Earnings Quality Score |
+| [**company_ebit_estimates**](DefaultApi.md#company_ebit_estimates) | **GET** /stock/ebit-estimate | EBIT Estimates |
+| [**company_ebitda_estimates**](DefaultApi.md#company_ebitda_estimates) | **GET** /stock/ebitda-estimate | EBITDA Estimates |
 | [**company_eps_estimates**](DefaultApi.md#company_eps_estimates) | **GET** /stock/eps-estimate | Earnings Estimates |
 | [**company_esg_score**](DefaultApi.md#company_esg_score) | **GET** /stock/esg | Company ESG Scores |
 | [**company_executive**](DefaultApi.md#company_executive) | **GET** /stock/executive | Company Executive |
@@ -19,6 +22,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
 | [**covid19**](DefaultApi.md#covid19) | **GET** /covid19/us | COVID-19 |
 | [**crypto_candles**](DefaultApi.md#crypto_candles) | **GET** /crypto/candle | Crypto Candles |
 | [**crypto_exchanges**](DefaultApi.md#crypto_exchanges) | **GET** /crypto/exchange | Crypto Exchanges |
+| [**crypto_profile**](DefaultApi.md#crypto_profile) | **GET** /crypto/profile | Crypto Profile |
 | [**crypto_symbols**](DefaultApi.md#crypto_symbols) | **GET** /crypto/symbol | Crypto Symbol |
 | [**earnings_calendar**](DefaultApi.md#earnings_calendar) | **GET** /calendar/earnings | Earnings Calendar |
 | [**economic_calendar**](DefaultApi.md#economic_calendar) | **GET** /calendar/economic | Economic Calendar |
@@ -67,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 |
@@ -297,6 +302,229 @@ end
 - **Accept**: application/json
 
 
+## company_earnings_quality_score
+
+> <CompanyEarningsQualityScore> company_earnings_quality_score(symbol, freq)
+
+Company Earnings Quality Score
+
+<p>This endpoint provides Earnings Quality Score for global companies.</p><p> Earnings quality refers to the extent to which current earnings predict future earnings. \"High-quality\" earnings are expected to persist, while \"low-quality\" earnings do not. A higher score means a higher earnings quality</p><p>Finnhub uses a proprietary model which takes into consideration 4 criteria:</p> <ul style=\"list-style-type: unset; margin-left: 30px;\"><li>Profitability</li><li>Growth</li><li>Cash Generation & Capital Allocation</li><li>Leverage</li></ul><br/><p>We then compare the metrics of each company in each category against its peers in the same industry to gauge how quality its earnings is.</p>
+
+### 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.
+freq = 'freq_example' # String | Frequency. Currently support <code>annual</code> and <code>quarterly</code>
+
+begin
+  # Company Earnings Quality Score
+  result = api_instance.company_earnings_quality_score(symbol, freq)
+  p result
+rescue FinnhubRuby::ApiError => e
+  puts "Error when calling DefaultApi->company_earnings_quality_score: #{e}"
+end
+```
+
+#### Using the company_earnings_quality_score_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CompanyEarningsQualityScore>, Integer, Hash)> company_earnings_quality_score_with_http_info(symbol, freq)
+
+```ruby
+begin
+  # Company Earnings Quality Score
+  data, status_code, headers = api_instance.company_earnings_quality_score_with_http_info(symbol, freq)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CompanyEarningsQualityScore>
+rescue FinnhubRuby::ApiError => e
+  puts "Error when calling DefaultApi->company_earnings_quality_score_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol. |  |
+| **freq** | **String** | Frequency. Currently support &lt;code&gt;annual&lt;/code&gt; and &lt;code&gt;quarterly&lt;/code&gt; |  |
+
+### Return type
+
+[**CompanyEarningsQualityScore**](CompanyEarningsQualityScore.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## company_ebit_estimates
+
+> <EbitEstimates> company_ebit_estimates(symbol, opts)
+
+EBIT Estimates
+
+Get company's ebit estimates.
+
+### 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 of the company: AAPL.
+opts = {
+  freq: 'freq_example' # String | Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code>
+}
+
+begin
+  # EBIT Estimates
+  result = api_instance.company_ebit_estimates(symbol, opts)
+  p result
+rescue FinnhubRuby::ApiError => e
+  puts "Error when calling DefaultApi->company_ebit_estimates: #{e}"
+end
+```
+
+#### Using the company_ebit_estimates_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EbitEstimates>, Integer, Hash)> company_ebit_estimates_with_http_info(symbol, opts)
+
+```ruby
+begin
+  # EBIT Estimates
+  data, status_code, headers = api_instance.company_ebit_estimates_with_http_info(symbol, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EbitEstimates>
+rescue FinnhubRuby::ApiError => e
+  puts "Error when calling DefaultApi->company_ebit_estimates_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol of the company: AAPL. |  |
+| **freq** | **String** | Can take 1 of the following values: &lt;code&gt;annual, quarterly&lt;/code&gt;. Default to &lt;code&gt;quarterly&lt;/code&gt; | [optional] |
+
+### Return type
+
+[**EbitEstimates**](EbitEstimates.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## company_ebitda_estimates
+
+> <EbitdaEstimates> company_ebitda_estimates(symbol, opts)
+
+EBITDA Estimates
+
+Get company's ebitda estimates.
+
+### 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 of the company: AAPL.
+opts = {
+  freq: 'freq_example' # String | Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code>
+}
+
+begin
+  # EBITDA Estimates
+  result = api_instance.company_ebitda_estimates(symbol, opts)
+  p result
+rescue FinnhubRuby::ApiError => e
+  puts "Error when calling DefaultApi->company_ebitda_estimates: #{e}"
+end
+```
+
+#### Using the company_ebitda_estimates_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EbitdaEstimates>, Integer, Hash)> company_ebitda_estimates_with_http_info(symbol, opts)
+
+```ruby
+begin
+  # EBITDA Estimates
+  data, status_code, headers = api_instance.company_ebitda_estimates_with_http_info(symbol, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EbitdaEstimates>
+rescue FinnhubRuby::ApiError => e
+  puts "Error when calling DefaultApi->company_ebitda_estimates_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol of the company: AAPL. |  |
+| **freq** | **String** | Can take 1 of the following values: &lt;code&gt;annual, quarterly&lt;/code&gt;. Default to &lt;code&gt;quarterly&lt;/code&gt; | [optional] |
+
+### Return type
+
+[**EbitdaEstimates**](EbitdaEstimates.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## company_eps_estimates
 
 > <EarningsEstimates> company_eps_estimates(symbol, opts)
@@ -595,7 +823,7 @@ end
 
 Peers
 
-Get company peers. Return a list of peers in the same country and GICS sub-industry
+Get company peers. Return a list of peers in the same country and sub-industry
 
 ### Examples
 
@@ -1170,6 +1398,77 @@ This endpoint does not need any parameter.
 - **Accept**: application/json
 
 
+## crypto_profile
+
+> <CryptoProfile> crypto_profile(symbol)
+
+Crypto Profile
+
+Get crypto's profile.
+
+### 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 | Crypto symbol such as BTC or ETH.
+
+begin
+  # Crypto Profile
+  result = api_instance.crypto_profile(symbol)
+  p result
+rescue FinnhubRuby::ApiError => e
+  puts "Error when calling DefaultApi->crypto_profile: #{e}"
+end
+```
+
+#### Using the crypto_profile_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CryptoProfile>, Integer, Hash)> crypto_profile_with_http_info(symbol)
+
+```ruby
+begin
+  # Crypto Profile
+  data, status_code, headers = api_instance.crypto_profile_with_http_info(symbol)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CryptoProfile>
+rescue FinnhubRuby::ApiError => e
+  puts "Error when calling DefaultApi->crypto_profile_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Crypto symbol such as BTC or ETH. |  |
+
+### Return type
+
+[**CryptoProfile**](CryptoProfile.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## crypto_symbols
 
 > <Array<CryptoSymbol>> crypto_symbols(exchange)
@@ -1322,7 +1621,7 @@ end
 
 ## economic_calendar
 
-> <EconomicCalendar> economic_calendar
+> <EconomicCalendar> economic_calendar(opts)
 
 Economic Calendar
 
@@ -1342,10 +1641,14 @@ FinnhubRuby.configure do |config|
 end
 
 api_instance = FinnhubRuby::DefaultApi.new
+opts = {
+  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
   # Economic Calendar
-  result = api_instance.economic_calendar
+  result = api_instance.economic_calendar(opts)
   p result
 rescue FinnhubRuby::ApiError => e
   puts "Error when calling DefaultApi->economic_calendar: #{e}"
@@ -1356,12 +1659,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<EconomicCalendar>, Integer, Hash)> economic_calendar_with_http_info
+> <Array(<EconomicCalendar>, Integer, Hash)> economic_calendar_with_http_info(opts)
 
 ```ruby
 begin
   # Economic Calendar
-  data, status_code, headers = api_instance.economic_calendar_with_http_info
+  data, status_code, headers = api_instance.economic_calendar_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <EconomicCalendar>
@@ -1372,7 +1675,10 @@ end
 
 ### Parameters
 
-This endpoint does not need any parameter.
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from** | **Date** | From date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;. | [optional] |
+| **to** | **Date** | To date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;. | [optional] |
 
 ### Return type
 
@@ -2725,7 +3031,7 @@ FinnhubRuby.configure do |config|
 end
 
 api_instance = FinnhubRuby::DefaultApi.new
-symbol = 'symbol_example' # String | Symbol of the company: AAPL.
+symbol = 'symbol_example' # String | Symbol of the company: AAPL. Leave this param blank to get the latest transactions.
 opts = {
   from: Date.parse('2013-10-20'), # Date | From date: 2020-03-15.
   to: Date.parse('2013-10-20') # Date | To date: 2020-03-16.
@@ -2762,7 +3068,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **symbol** | **String** | Symbol of the company: AAPL. |  |
+| **symbol** | **String** | Symbol of the company: AAPL. Leave this param blank to get the latest transactions. |  |
 | **from** | **Date** | From date: 2020-03-15. | [optional] |
 | **to** | **Date** | To date: 2020-03-16. | [optional] |
 
@@ -2786,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
 
@@ -4637,7 +4943,7 @@ end
 
 Tick Data
 
-<p>Get historical tick data for global exchanges. You can send the request directly to our tick server at <a href=\"https://tick.finnhub.io/\">https://tick.finnhub.io/</a> with the same path and parameters or get redirected there if you call our main server.</p><p>For US market, you can visit our bulk download page in the Dashboard <a target=\"_blank\" href=\"/dashboard/download\",>here</a> to speed up the download process.</p><p>Note that for Nasdaq Nordic and Baltic, you need to use ISIN instead of symbol to query tick data. </p><table class=\"table table-hover\">   <thead>     <tr>       <th>Exchange</th>       <th>Segment</th>       <th>Delay</th>     </tr>   </thead>   <tbody>     <tr>       <td class=\"text-blue\">US CTA/UTP</th>       <td>Full SIP</td>       <td>15 minute</td>     </tr>     <tr>       <td class=\"text-blue\">TSX</th>       <td><ul><li>TSX</li><li>TSX Venture</li><li>Index</li></ul></td>       <td>End-of-day</td>     </tr>     <tr>       <td class=\"text-blue\">LSE</th>       <td><ul><li>London Stock Exchange (L)</li><li>LSE International (L)</li><li>LSE European (L)</li></ul></td>       <td>15 minute</td>     </tr>     <tr>       <td class=\"text-blue\">Euronext</th>       <td><ul> <li>Euronext Paris (PA)</li> <li>Euronext Amsterdam (AS)</li> <li>Euronext Lisbon (LS)</li> <li>Euronext Brussels (BR)</li> <li>Euronext Oslo (OL)</li> <li>Euronext London (LN)</li> <li>Euronext Dublin (IR)</li> <li>Index</li> <li>Warrant</li></ul></td>       <td>End-of-day</td>     </tr>     <tr>       <td class=\"text-blue\">Deutsche Börse</th>       <td><ul> <li>Frankfurt (F)</li> <li>Xetra (DE)</li> <li>Duesseldorf (DU)</li> <li>Hamburg (HM)</li> <li>Berlin (BE)</li> <li>Hanover (HA)</li> <li>Stoxx (SX)</li> <li>TradeGate (TG)</li> <li>Zertifikate (SC)</li> <li>Index</li> <li>Warrant</li></ul></td>       <td>End-of-day</td>     </tr>     <tr>       <td class=\"text-blue\">Nasdaq Nordic & Baltic</th>       <td> <ul> <li>Copenhagen (CO)</li> <li>Stockholm (ST)</li> <li>Helsinki (HE)</li> <li>Iceland (IC)</li> <li>Riga (RG)</li> <li>Tallinn (TL)</li> <li>Vilnius(VS)</li> <li>Fixed Income</li> <li>Derivatives</li> <li>Commodities</li></ul></td>       <td>End-of-day</td>     </tr>   </tbody> </table>
+<p>Get historical tick data for global exchanges. You can send the request directly to our tick server at <a href=\"https://tick.finnhub.io/\">https://tick.finnhub.io/</a> with the same path and parameters or get redirected there if you call our main server.</p><p>For US market, you can visit our bulk download page in the Dashboard <a target=\"_blank\" href=\"/dashboard/download\",>here</a> to speed up the download process.</p><table class=\"table table-hover\">   <thead>     <tr>       <th>Exchange</th>       <th>Segment</th>       <th>Delay</th>     </tr>   </thead>   <tbody>     <tr>       <td class=\"text-blue\">US CTA/UTP</th>       <td>Full SIP</td>       <td>15 minute</td>     </tr>     <tr>       <td class=\"text-blue\">TSX</th>       <td><ul><li>TSX</li><li>TSX Venture</li><li>Index</li></ul></td>       <td>End-of-day</td>     </tr>     <tr>       <td class=\"text-blue\">LSE</th>       <td><ul><li>London Stock Exchange (L)</li><li>LSE International (L)</li><li>LSE European (L)</li></ul></td>       <td>15 minute</td>     </tr>     <tr>       <td class=\"text-blue\">Euronext</th>       <td><ul> <li>Euronext Paris (PA)</li> <li>Euronext Amsterdam (AS)</li> <li>Euronext Lisbon (LS)</li> <li>Euronext Brussels (BR)</li> <li>Euronext Oslo (OL)</li> <li>Euronext London (LN)</li> <li>Euronext Dublin (IR)</li> <li>Index</li> <li>Warrant</li></ul></td>       <td>End-of-day</td>     </tr>     <tr>       <td class=\"text-blue\">Deutsche Börse</th>       <td><ul> <li>Frankfurt (F)</li> <li>Xetra (DE)</li> <li>Duesseldorf (DU)</li> <li>Hamburg (HM)</li> <li>Berlin (BE)</li> <li>Hanover (HA)</li> <li>Stoxx (SX)</li> <li>TradeGate (TG)</li> <li>Zertifikate (SC)</li> <li>Index</li> <li>Warrant</li></ul></td>       <td>End-of-day</td>     </tr>     <tr>       <td class=\"text-blue\">Nasdaq Nordic & Baltic</th>       <td> <ul> <li>Copenhagen (CO)</li> <li>Stockholm (ST)</li> <li>Helsinki (HE)</li> <li>Iceland (IC)</li> <li>Riga (RG)</li> <li>Tallinn (TL)</li> <li>Vilnius(VS)</li> <li>Fixed Income</li> <li>Derivatives</li> <li>Commodities</li></ul></td>       <td>End-of-day</td>     </tr>   </tbody> </table>
 
 ### Examples
 
@@ -4708,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/EbitEstimates.md

@@ -0,0 +1,22 @@
+# FinnhubRuby::EbitEstimates
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<EbitEstimatesInfo>**](EbitEstimatesInfo.md) | List of estimates | [optional] |
+| **freq** | **String** | Frequency: annual or quarterly. | [optional] |
+| **symbol** | **String** | Company symbol. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::EbitEstimates.new(
+  data: null,
+  freq: null,
+  symbol: null
+)
+```
+

data/docs/EbitEstimatesInfo.md

@@ -0,0 +1,26 @@
+# FinnhubRuby::EbitEstimatesInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ebit_avg** | **Float** | Average EBIT estimates including Finnhub's proprietary estimates. | [optional] |
+| **ebit_high** | **Float** | Highest estimate. | [optional] |
+| **ebit_low** | **Float** | Lowest estimate. | [optional] |
+| **number_analysts** | **Integer** | Number of Analysts. | [optional] |
+| **period** | **Date** | Period. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::EbitEstimatesInfo.new(
+  ebit_avg: null,
+  ebit_high: null,
+  ebit_low: null,
+  number_analysts: null,
+  period: null
+)
+```
+

data/docs/EbitdaEstimates.md

@@ -0,0 +1,22 @@
+# FinnhubRuby::EbitdaEstimates
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<EbitdaEstimatesInfo>**](EbitdaEstimatesInfo.md) | List of estimates | [optional] |
+| **freq** | **String** | Frequency: annual or quarterly. | [optional] |
+| **symbol** | **String** | Company symbol. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::EbitdaEstimates.new(
+  data: null,
+  freq: null,
+  symbol: null
+)
+```
+

data/docs/EbitdaEstimatesInfo.md

@@ -0,0 +1,26 @@
+# FinnhubRuby::EbitdaEstimatesInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ebitda_avg** | **Float** | Average EBITDA estimates including Finnhub's proprietary estimates. | [optional] |
+| **ebitda_high** | **Float** | Highest estimate. | [optional] |
+| **ebitda_low** | **Float** | Lowest estimate. | [optional] |
+| **number_analysts** | **Integer** | Number of Analysts. | [optional] |
+| **period** | **Date** | Period. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::EbitdaEstimatesInfo.new(
+  ebitda_avg: null,
+  ebitda_high: null,
+  ebitda_low: null,
+  number_analysts: null,
+  period: null
+)
+```
+

data/docs/MutualFundProfileData.md

@@ -25,6 +25,10 @@
 | **max_redemption_fee** | **Float** | Max redemption fee. | [optional] |
 | **standard_min_investment** | **Float** | Minimum investment for standard accounts. | [optional] |
 | **turnover** | **Float** | Turnover. | [optional] |
+| **series_id** | **String** | Fund's series ID. This field can be used to group multiple share classes into 1 unique fund. | [optional] |
+| **series_name** | **String** | Fund's series name. | [optional] |
+| **class_id** | **String** | Class ID. | [optional] |
+| **class_name** | **String** | Class name. | [optional] |
 
 ## Example
 
@@ -52,7 +56,11 @@ instance = FinnhubRuby::MutualFundProfileData.new(
   cusip: null,
   max_redemption_fee: null,
   standard_min_investment: null,
-  turnover: null
+  turnover: null,
+  series_id: null,
+  series_name: null,
+  class_id: null,
+  class_name: null
 )
 ```
 

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/Transactions.md

@@ -4,6 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol. | [optional] |
 | **name** | **String** | Insider's name. | [optional] |
 | **share** | **Integer** | Number of shares held after the transaction. | [optional] |
 | **change** | **Integer** | Number of share changed from the last period. A positive value suggests a <code>BUY</code> transaction. A negative value suggests a <code>SELL</code> transaction. | [optional] |
@@ -18,6 +19,7 @@
 require 'finnhub_ruby'
 
 instance = FinnhubRuby::Transactions.new(
+  symbol: null,
   name: null,
   share: null,
   change: null,