finnhub_ruby 1.1.9 → 1.1.13

data/lib/finnhub_ruby/api/default_api.rb

@@ -231,7 +231,7 @@ module FinnhubRuby
     # 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>
     # @param symbol [String] Symbol.
-    # @param freq [String] Frequency. Currently only support &lt;code&gt;quarterly&lt;/code&gt;
+    # @param freq [String] Frequency. Currently support &lt;code&gt;annual&lt;/code&gt; and &lt;code&gt;quarterly&lt;/code&gt;
     # @param [Hash] opts the optional parameters
     # @return [CompanyEarningsQualityScore]
     def company_earnings_quality_score(symbol, freq, opts = {})
@@ -242,7 +242,7 @@ module FinnhubRuby
     # Company Earnings Quality Score
     # &lt;p&gt;This endpoint provides Earnings Quality Score for global companies.&lt;/p&gt;&lt;p&gt; Earnings quality refers to the extent to which current earnings predict future earnings. \&quot;High-quality\&quot; earnings are expected to persist, while \&quot;low-quality\&quot; earnings do not. A higher score means a higher earnings quality&lt;/p&gt;&lt;p&gt;Finnhub uses a proprietary model which takes into consideration 4 criteria:&lt;/p&gt; &lt;ul style&#x3D;\&quot;list-style-type: unset; margin-left: 30px;\&quot;&gt;&lt;li&gt;Profitability&lt;/li&gt;&lt;li&gt;Growth&lt;/li&gt;&lt;li&gt;Cash Generation &amp; Capital Allocation&lt;/li&gt;&lt;li&gt;Leverage&lt;/li&gt;&lt;/ul&gt;&lt;br/&gt;&lt;p&gt;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.&lt;/p&gt;
     # @param symbol [String] Symbol.
-    # @param freq [String] Frequency. Currently only support &lt;code&gt;quarterly&lt;/code&gt;
+    # @param freq [String] Frequency. Currently support &lt;code&gt;annual&lt;/code&gt; and &lt;code&gt;quarterly&lt;/code&gt;
     # @param [Hash] opts the optional parameters
     # @return [Array<(CompanyEarningsQualityScore, Integer, Hash)>] CompanyEarningsQualityScore data, response status code and response headers
     def company_earnings_quality_score_with_http_info(symbol, freq, opts = {})
@@ -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: &lt;code&gt;annual, quarterly&lt;/code&gt;. Default to &lt;code&gt;quarterly&lt;/code&gt;
+    # @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&#39;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: &lt;code&gt;annual, quarterly&lt;/code&gt;. Default to &lt;code&gt;quarterly&lt;/code&gt;
+    # @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.
@@ -1091,6 +1225,70 @@ module FinnhubRuby
       return data, status_code, headers
     end
 
+    # Crypto Profile
+    # Get crypto's profile.
+    # @param symbol [String] Crypto symbol such as BTC or ETH.
+    # @param [Hash] opts the optional parameters
+    # @return [CryptoProfile]
+    def crypto_profile(symbol, opts = {})
+      data, _status_code, _headers = crypto_profile_with_http_info(symbol, opts)
+      data
+    end
+
+    # Crypto Profile
+    # Get crypto&#39;s profile.
+    # @param symbol [String] Crypto symbol such as BTC or ETH.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CryptoProfile, Integer, Hash)>] CryptoProfile data, response status code and response headers
+    def crypto_profile_with_http_info(symbol, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.crypto_profile ...'
+      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.crypto_profile"
+      end
+      # resource path
+      local_var_path = '/crypto/profile'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'symbol'] = symbol
+
+      # 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] || 'CryptoProfile'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.crypto_profile",
+        :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#crypto_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Crypto Symbol
     # List supported crypto symbols by exchange
     # @param exchange [String] Exchange you want to get the list of symbols from.
@@ -1227,6 +1425,8 @@ module FinnhubRuby
     # Economic Calendar
     # <p>Get recent and upcoming economic releases.</p><p>Historical events and surprises are available for Enterprise clients.</p>
     # @param [Hash] opts the optional parameters
+    # @option opts [Date] :from From date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;.
+    # @option opts [Date] :to To date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;.
     # @return [EconomicCalendar]
     def economic_calendar(opts = {})
       data, _status_code, _headers = economic_calendar_with_http_info(opts)
@@ -1236,6 +1436,8 @@ module FinnhubRuby
     # Economic Calendar
     # &lt;p&gt;Get recent and upcoming economic releases.&lt;/p&gt;&lt;p&gt;Historical events and surprises are available for Enterprise clients.&lt;/p&gt;
     # @param [Hash] opts the optional parameters
+    # @option opts [Date] :from From date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;.
+    # @option opts [Date] :to To date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;.
     # @return [Array<(EconomicCalendar, Integer, Hash)>] EconomicCalendar data, response status code and response headers
     def economic_calendar_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -1246,6 +1448,8 @@ module FinnhubRuby
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
+      query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -2148,6 +2352,7 @@ module FinnhubRuby
     # Get rates for all forex pairs. Ideal for currency conversion
     # @param [Hash] opts the optional parameters
     # @option opts [String] :base Base currency. Default to EUR.
+    # @option opts [String] :date Date. Leave blank to get the latest data.
     # @return [Forexrates]
     def forex_rates(opts = {})
       data, _status_code, _headers = forex_rates_with_http_info(opts)
@@ -2158,6 +2363,7 @@ module FinnhubRuby
     # Get rates for all forex pairs. Ideal for currency conversion
     # @param [Hash] opts the optional parameters
     # @option opts [String] :base Base currency. Default to EUR.
+    # @option opts [String] :date Date. Leave blank to get the latest data.
     # @return [Array<(Forexrates, Integer, Hash)>] Forexrates data, response status code and response headers
     def forex_rates_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -2169,6 +2375,7 @@ module FinnhubRuby
       # query parameters
       query_params = opts[:query_params] || {}
       query_params[:'base'] = opts[:'base'] if !opts[:'base'].nil?
+      query_params[:'date'] = opts[:'date'] if !opts[:'date'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -2465,7 +2672,7 @@ module FinnhubRuby
 
     # Insider Transactions
     # Company insider transactions data sourced from <code>Form 3,4,5</code>. This endpoint only covers US companies at the moment. Limit to 100 transactions per API call.
-    # @param symbol [String] Symbol of the company: AAPL.
+    # @param symbol [String] Symbol of the company: AAPL. Leave this param blank to get the latest transactions.
     # @param [Hash] opts the optional parameters
     # @option opts [Date] :from From date: 2020-03-15.
     # @option opts [Date] :to To date: 2020-03-16.
@@ -2477,7 +2684,7 @@ module FinnhubRuby
 
     # Insider Transactions
     # Company insider transactions data sourced from &lt;code&gt;Form 3,4,5&lt;/code&gt;. This endpoint only covers US companies at the moment. Limit to 100 transactions per API call.
-    # @param symbol [String] Symbol of the company: AAPL.
+    # @param symbol [String] Symbol of the company: AAPL. Leave this param blank to get the latest transactions.
     # @param [Hash] opts the optional parameters
     # @option opts [Date] :from From date: 2020-03-15.
     # @option opts [Date] :to To date: 2020-03-16.
@@ -2534,7 +2741,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&#39;s 2-letter code.
@@ -2545,7 +2752,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&#39;s 2-letter code.
@@ -4330,6 +4537,162 @@ 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 &lt;code&gt;YYYY-MM-DD&lt;/code&gt;.
+    # @param to [Date] To date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;.
+    # @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 &lt;code&gt;YYYY-MM-DD&lt;/code&gt;.
+    # @param to [Date] To date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;.
+    # @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
+
+    # H1-B Visa Application
+    # Get a list of H1-B and Permanent visa applications for companies from the DOL. The data is updated quarterly.
+    # @param symbol [String] Symbol.
+    # @param from [Date] From date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;. Filter on the &lt;code&gt;beginDate&lt;/code&gt; column.
+    # @param to [Date] To date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;. Filter on the &lt;code&gt;beginDate&lt;/code&gt; column.
+    # @param [Hash] opts the optional parameters
+    # @return [VisaApplicationResult]
+    def stock_visa_application(symbol, from, to, opts = {})
+      data, _status_code, _headers = stock_visa_application_with_http_info(symbol, from, to, opts)
+      data
+    end
+
+    # H1-B Visa Application
+    # Get a list of H1-B and Permanent visa applications for companies from the DOL. The data is updated quarterly.
+    # @param symbol [String] Symbol.
+    # @param from [Date] From date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;. Filter on the &lt;code&gt;beginDate&lt;/code&gt; column.
+    # @param to [Date] To date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;. Filter on the &lt;code&gt;beginDate&lt;/code&gt; column.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(VisaApplicationResult, Integer, Hash)>] VisaApplicationResult data, response status code and response headers
+    def stock_visa_application_with_http_info(symbol, from, to, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.stock_visa_application ...'
+      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_visa_application"
+      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_visa_application"
+      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_visa_application"
+      end
+      # resource path
+      local_var_path = '/stock/visa-application'
+
+      # 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] || 'VisaApplicationResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.stock_visa_application",
+        :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_visa_application\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.