finnhub_ruby 1.1.10 → 1.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbdf62aa52f5b7d31e2134fd935b04906e61fd118678ee2d3021c58bc669424a
-  data.tar.gz: 8ec2fa32472ecff1afb17a345c6c78182b3cfdec7ea6779c03f1488789ad6f94
+  metadata.gz: 887ccfa4be052b78b027b7a389128310365222765cd7bfee47740c83d6d3e22a
+  data.tar.gz: 95ee3425f9777f58cb12cad609c491bebb6b01cbbef5b6f6cabca2d4dd109f44
 SHA512:
-  metadata.gz: 1a983fadf46c2bdeeba2b924090291cc80e31b8744aaf010d98ddf9e4e24fe48d3dd862f82962b0fbbc10150da45f3d3879291099ce0bd405f8b9682b80836f0
-  data.tar.gz: efc37d1b2179e095a91b04961a08abff5e3fc5e4e6b63921f405016c20f7d728177615ea925ecb88736b39d5bf713ae0382964b250c49f13078ba561c26f5e7c
+  metadata.gz: 8225eea9a2bd4790c0290b299cf176c21c48c3c1a4fb2a3c2daab585b4b68ac2e937c043f26ef4f3ebb0db36b27dcfba6e54c8537562d91b298cdabdd9809e25
+  data.tar.gz: d46aefa594bd4363c4a2fd061b2f9e9c42b96c58c85465f467331f98fe4518f55215d5d4119f1f7a4408643bc777e5bb33c336c19f36ff9441e1e265acafa82e

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.10
+- Package version: 1.1.11
 
 ## 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.10'
+gem 'finnhub_ruby', '~> 1.1.11'
 ```
 
 ## Getting Started
@@ -246,6 +246,11 @@ puts(finnhub_client.company_earnings_quality_score('AAPL', 'quarterly'))
 # Crypto Profile
 puts(finnhub_client.crypto_profile('BTC'))
 
+# EBITDA Estimates
+puts(finnhub_client.company_ebitda_estimates('AAPL', {freq: 'quarterly'}))
+
+# EBIT Estimates
+puts(finnhub_client.company_ebit_estimates('TSLA', {freq: 'quarterly'}))
 ```
 
 ## License

data/docs/DefaultApi.md

@@ -8,6 +8,8 @@ All URIs are relative to *https://finnhub.io/api/v1*
 | [**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 |
@@ -372,6 +374,156 @@ end
 - **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)

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/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,

data/lib/finnhub_ruby/api/default_api.rb

@@ -299,6 +299,140 @@ module FinnhubRuby
       return data, status_code, headers
     end
 
+    # EBIT Estimates
+    # Get company's ebit estimates.
+    # @param symbol [String] Symbol of the company: AAPL.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :freq Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code>
+    # @return [EbitEstimates]
+    def company_ebit_estimates(symbol, opts = {})
+      data, _status_code, _headers = company_ebit_estimates_with_http_info(symbol, opts)
+      data
+    end
+
+    # EBIT Estimates
+    # Get company's ebit estimates.
+    # @param symbol [String] Symbol of the company: AAPL.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :freq Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code>
+    # @return [Array<(EbitEstimates, Integer, Hash)>] EbitEstimates data, response status code and response headers
+    def company_ebit_estimates_with_http_info(symbol, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.company_ebit_estimates ...'
+      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.company_ebit_estimates"
+      end
+      # resource path
+      local_var_path = '/stock/ebit-estimate'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'symbol'] = symbol
+      query_params[:'freq'] = opts[:'freq'] if !opts[:'freq'].nil?
+
+      # 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] || 'EbitEstimates'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.company_ebit_estimates",
+        :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#company_ebit_estimates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # EBITDA Estimates
+    # Get company's ebitda estimates.
+    # @param symbol [String] Symbol of the company: AAPL.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :freq Can take 1 of the following values: &lt;code&gt;annual, quarterly&lt;/code&gt;. Default to &lt;code&gt;quarterly&lt;/code&gt;
+    # @return [EbitdaEstimates]
+    def company_ebitda_estimates(symbol, opts = {})
+      data, _status_code, _headers = company_ebitda_estimates_with_http_info(symbol, opts)
+      data
+    end
+
+    # EBITDA Estimates
+    # Get company&#39;s ebitda estimates.
+    # @param symbol [String] Symbol of the company: AAPL.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :freq Can take 1 of the following values: &lt;code&gt;annual, quarterly&lt;/code&gt;. Default to &lt;code&gt;quarterly&lt;/code&gt;
+    # @return [Array<(EbitdaEstimates, Integer, Hash)>] EbitdaEstimates data, response status code and response headers
+    def company_ebitda_estimates_with_http_info(symbol, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.company_ebitda_estimates ...'
+      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.company_ebitda_estimates"
+      end
+      # resource path
+      local_var_path = '/stock/ebitda-estimate'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'symbol'] = symbol
+      query_params[:'freq'] = opts[:'freq'] if !opts[:'freq'].nil?
+
+      # 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] || 'EbitdaEstimates'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.company_ebitda_estimates",
+        :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#company_ebitda_estimates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Earnings Estimates
     # Get company's EPS estimates.
     # @param symbol [String] Symbol of the company: AAPL.