finnhub_ruby 1.1.7 → 1.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15ba3be70fe2664addf3a249f9b4074234d80b21c48830995b21337928d86fdb
-  data.tar.gz: 0e37b5b3831c051be068ee9e0da640e03feb696fb94d6012f260671bb2265ac2
+  metadata.gz: 30d3bc7aee90a7d7aa1679fefc232458e9681cb90240381b21cac6851116f8bb
+  data.tar.gz: ead3196677192f69af95c29591faef8aa7e63206389d98565bdddd934dd6c9ae
 SHA512:
-  metadata.gz: 5aec2b83a75b9cb170683ace2fbd27156c841a1e0e232c3af18c118e06dfd28cb1b3eb153c15b146aa3a006182ade2b5e91168b299a6e99ac9adea26958b6116
-  data.tar.gz: ad3f505f2afb53046cf21c589598e9f2ce50d03df099ecb8c4cb005e1a58d58ad691bba9665f976108c0fdedcbb2d9418cf7f48d1c0353219cd2d26d2de1a6ad
+  metadata.gz: bb000372cb7719457c08da2f8488ad6d10503eac8fe3851eba71d8f9a3e3a77f35a4623d2d4a65a19a0c28625b4894ea1b62377fe2daf03825fbab959e40584a
+  data.tar.gz: 00ba23b45e29b9d879be159cdbc355ce48925a185dea9a50c26a5180fa1df839c1480f776bcfcbc511e2f7a19eb885925e2477fabf398cf748150abb51af26d6

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.6
+- Package version: 1.1.8
 
 ## 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.6'
+gem 'finnhub_ruby', '~> 1.1.8'
 ```
 
 ## Getting Started
@@ -27,17 +27,35 @@ end
 
 finnhub_client = FinnhubRuby::DefaultApi.new
 
-# Stock candles
-puts(finnhub_client.stock_candles('AAPL', 'D', 1590988249, 1591852249))
+# Similarity Index
+puts(finnhub_client.similarity_index({symbol: 'AAPL'}))
 
 # Stock symbols
 puts(finnhub_client.stock_symbols('US'))
 
+#Symbol search
+puts(finnhub_client.symbol_search('AAPL'))
+
+# Tick Data
+puts(finnhub_client.stock_tick('NFLX', '2020-03-25', 500, 0))
+
+# NBBO
+puts(finnhub_client.stock_nbbo('NFLX', '2020-03-25', 500, 0))
+
+#Bid ask
+puts(finnhub_client.stock_bidask('AAPL'))
+
+# Forex all pairs
+puts(finnhub_client.forex_rates({base: 'USD'}))
+
+# Stock candles
+puts(finnhub_client.stock_candles('AAPL', 'D', 1590988249, 1591852249))
+
 # Aggregate Indicators
 puts(finnhub_client.aggregate_indicator('AAPL', 'D'))
 
 # Basic financials
-puts(finnhub_client.company_basic_financials('AAPL', 'margin'))
+puts(finnhub_client.company_basic_financials('AAPL', 'all'))
 
 # Earnings surprises
 puts(finnhub_client.company_earnings('TSLA', {limit: 5}))
@@ -75,12 +93,24 @@ puts(finnhub_client.crypto_exchanges())
 # Crypto symbols
 puts(finnhub_client.crypto_symbols('BINANCE'))
 
+# Economic code
+puts(finnhub_client.economic_code())
+
 # Economic data
 puts(finnhub_client.economic_data('MA-USA-656880'))
 
+# Economic calendar
+puts(finnhub_client.economic_calendar())
+
 # Filings
 puts(finnhub_client.filings({symbol: 'AAPL', from: "2020-01-01", to: "2020-06-11"}))
 
+# International Filings
+puts(finnhub_client.international_filings({symbol: 'AC.TO'}))
+
+# Filings Sentiment
+puts(finnhub_client.filings_sentiment('0000320193-20-000052', {}))
+
 # Financials
 puts(finnhub_client.financials('AAPL', 'bs', 'annual'))
 
@@ -90,9 +120,6 @@ puts(finnhub_client.financials_reported({symbol: 'AAPL', freq: 'annual'}))
 # Forex exchanges
 puts(finnhub_client.forex_exchanges())
 
-# Forex all pairs
-puts(finnhub_client.forex_rates({base: 'USD'}))
-
 # Forex symbols
 puts(finnhub_client.forex_symbols('OANDA'))
 
@@ -129,6 +156,9 @@ puts(finnhub_client.recommendation_trends('AAPL'))
 # Stock dividends
 puts(finnhub_client.stock_dividends('KO', '2019-01-01', '2020-01-01'))
 
+# Stock basic dividends
+puts(finnhub_client.stock_basic_dividends('KO'))
+
 # Transcripts
 puts(finnhub_client.transcripts('AAPL_162777'))
 
@@ -156,12 +186,6 @@ puts(finnhub_client.forex_candles('OANDA:EUR_USD', 'D', 1590988249, 1591852249))
 # Crypto Candles
 puts(finnhub_client.crypto_candles('BINANCE:BTCUSDT', 'D', 1590988249, 1591852249))
 
-# Tick Data
-puts(finnhub_client.stock_tick('AAPL', '2020-03-25', 500, 0))
-
-# NBBO
-puts(finnhub_client.stock_nbbo('NFLX', '2020-03-25', 50, 0))
-
 # Technical Indicator
 puts(finnhub_client.technical_indicator("AAPL", 'D', 1583098857, 1584308457, 'rsi', {"timeperiod": 3}))
 
@@ -210,6 +234,12 @@ puts(finnhub_client.investment_themes('financialExchangesData'))
 # Supply chain
 puts(finnhub_client.supply_chain_relationships('AAPL'))
 
+# FDA calendar
+puts(finnhub_client.fda_committee_meeting_calendar())
+
+# Company ESG
+puts(finnhub_client.company_esg_score('AAPL'))
+
 ```
 
 ## License

data/docs/CompanyESG.md

@@ -0,0 +1,28 @@
+# FinnhubRuby::CompanyESG
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | symbol | [optional] |
+| **total_esg_score** | **Float** | Total ESG Score | [optional] |
+| **environment_score** | **Float** | symbol | [optional] |
+| **governance_score** | **Float** | symbol | [optional] |
+| **social_score** | **Float** | symbol | [optional] |
+| **data** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::CompanyESG.new(
+  symbol: null,
+  total_esg_score: null,
+  environment_score: null,
+  governance_score: null,
+  social_score: null,
+  data: null
+)
+```
+

data/docs/DefaultApi.md

@@ -8,6 +8,7 @@ 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_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 |
 | [**company_news**](DefaultApi.md#company_news) | **GET** /company-news | Company News |
 | [**company_peers**](DefaultApi.md#company_peers) | **GET** /stock/peers | Peers |
@@ -371,6 +372,77 @@ end
 - **Accept**: application/json
 
 
+## company_esg_score
+
+> <CompanyESG> company_esg_score(symbol)
+
+Company ESG Scores
+
+<p>This endpoint provides ESG scores and important indicators for 1000+ global companies. The data is collected through company's public ESG disclosure and public sources.</p><p>Our ESG scoring models takes into account more than 150 different inputs to calculate the level of ESG risks and how well a company is managing them. A higher score means lower ESG risk or better ESG management. ESG scores are in the the range of 0-100. Some key indicators might contain letter-grade score from C- to A+ with C- is the lowest score and A+ is the highest score.</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.
+
+begin
+  # Company ESG Scores
+  result = api_instance.company_esg_score(symbol)
+  p result
+rescue FinnhubRuby::ApiError => e
+  puts "Error when calling DefaultApi->company_esg_score: #{e}"
+end
+```
+
+#### Using the company_esg_score_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CompanyESG>, Integer, Hash)> company_esg_score_with_http_info(symbol)
+
+```ruby
+begin
+  # Company ESG Scores
+  data, status_code, headers = api_instance.company_esg_score_with_http_info(symbol)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CompanyESG>
+rescue FinnhubRuby::ApiError => e
+  puts "Error when calling DefaultApi->company_esg_score_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol. |  |
+
+### Return type
+
+[**CompanyESG**](CompanyESG.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## company_executive
 
 > <CompanyExecutive> company_executive(symbol)

data/docs/KeyCustomersSuppliers.md

@@ -8,6 +8,12 @@
 | **name** | **String** | Name | [optional] |
 | **customer** | **Boolean** | Whether the company is a customer. | [optional] |
 | **supplier** | **Boolean** | Whether the company is a supplier | [optional] |
+| **one_month_correlation** | **Float** | 1-month price correlation | [optional] |
+| **one_year_correlation** | **Float** | 1-year price correlation | [optional] |
+| **six_month_correlation** | **Float** | 6-month price correlation | [optional] |
+| **three_month_correlation** | **Float** | 3-month price correlation | [optional] |
+| **two_week_correlation** | **Float** | 2-week price correlation | [optional] |
+| **two_year_correlation** | **Float** | 2-year price correlation | [optional] |
 
 ## Example
 
@@ -18,7 +24,13 @@ instance = FinnhubRuby::KeyCustomersSuppliers.new(
   symbol: null,
   name: null,
   customer: null,
-  supplier: null
+  supplier: null,
+  one_month_correlation: null,
+  one_year_correlation: null,
+  six_month_correlation: null,
+  three_month_correlation: null,
+  two_week_correlation: null,
+  two_year_correlation: null
 )
 ```
 

data/finnhub_ruby.gemspec

@@ -8,7 +8,7 @@
 The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.0
+OpenAPI Generator version: 5.2.1
 
 =end
 

data/lib/finnhub_ruby.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.0
+OpenAPI Generator version: 5.2.1
 
 =end
 
@@ -21,6 +21,7 @@ require 'finnhub_ruby/models/aggregate_indicators'
 require 'finnhub_ruby/models/basic_financials'
 require 'finnhub_ruby/models/breakdown_item'
 require 'finnhub_ruby/models/company'
+require 'finnhub_ruby/models/company_esg'
 require 'finnhub_ruby/models/company_executive'
 require 'finnhub_ruby/models/company_news'
 require 'finnhub_ruby/models/company_news_statistics'

data/lib/finnhub_ruby/api/default_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.0
+OpenAPI Generator version: 5.2.1
 
 =end
 
@@ -295,6 +295,70 @@ module FinnhubRuby
       return data, status_code, headers
     end
 
+    # Company ESG Scores
+    # <p>This endpoint provides ESG scores and important indicators for 1000+ global companies. The data is collected through company's public ESG disclosure and public sources.</p><p>Our ESG scoring models takes into account more than 150 different inputs to calculate the level of ESG risks and how well a company is managing them. A higher score means lower ESG risk or better ESG management. ESG scores are in the the range of 0-100. Some key indicators might contain letter-grade score from C- to A+ with C- is the lowest score and A+ is the highest score.</p>
+    # @param symbol [String] Symbol.
+    # @param [Hash] opts the optional parameters
+    # @return [CompanyESG]
+    def company_esg_score(symbol, opts = {})
+      data, _status_code, _headers = company_esg_score_with_http_info(symbol, opts)
+      data
+    end
+
+    # Company ESG Scores
+    # &lt;p&gt;This endpoint provides ESG scores and important indicators for 1000+ global companies. The data is collected through company&#39;s public ESG disclosure and public sources.&lt;/p&gt;&lt;p&gt;Our ESG scoring models takes into account more than 150 different inputs to calculate the level of ESG risks and how well a company is managing them. A higher score means lower ESG risk or better ESG management. ESG scores are in the the range of 0-100. Some key indicators might contain letter-grade score from C- to A+ with C- is the lowest score and A+ is the highest score.&lt;/p&gt;
+    # @param symbol [String] Symbol.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CompanyESG, Integer, Hash)>] CompanyESG data, response status code and response headers
+    def company_esg_score_with_http_info(symbol, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.company_esg_score ...'
+      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_esg_score"
+      end
+      # resource path
+      local_var_path = '/stock/esg'
+
+      # 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] || 'CompanyESG'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.company_esg_score",
+        :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_esg_score\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Company Executive
     # Get a list of company's executives and members of the Board.
     # @param symbol [String] Symbol of the company: AAPL.

data/lib/finnhub_ruby/api_client.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.0
+OpenAPI Generator version: 5.2.1
 
 =end
 

data/lib/finnhub_ruby/api_error.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.0
+OpenAPI Generator version: 5.2.1
 
 =end
 

data/lib/finnhub_ruby/configuration.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.0
+OpenAPI Generator version: 5.2.1
 
 =end
 

data/lib/finnhub_ruby/models/aggregate_indicators.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.0
+OpenAPI Generator version: 5.2.1
 
 =end
 

data/lib/finnhub_ruby/models/basic_financials.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.0
+OpenAPI Generator version: 5.2.1
 
 =end
 

data/lib/finnhub_ruby/models/breakdown_item.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.0
+OpenAPI Generator version: 5.2.1
 
 =end