finnhub_ruby 1.1.19 → 2.0.0

data/docs/ETFProfileData.md

@@ -16,6 +16,7 @@
 | **domicile** | **String** | ETF domicile. | [optional] |
 | **inception_date** | **Date** | Inception date. | [optional] |
 | **website** | **String** | ETF's website. | [optional] |
+| **logo** | **String** | Logo. | [optional] |
 | **isin** | **String** | ISIN. | [optional] |
 | **cusip** | **String** | CUSIP. | [optional] |
 | **price_to_earnings** | **Float** | P/E. | [optional] |
@@ -44,6 +45,7 @@ instance = FinnhubRuby::ETFProfileData.new(
   domicile: null,
   inception_date: null,
   website: null,
+  logo: null,
   isin: null,
   cusip: null,
   price_to_earnings: null,

data/docs/EarningResult.md

@@ -10,8 +10,8 @@
 | **surprise_percent** | **Float** | Surprise percent. | [optional] |
 | **period** | **Date** | Reported period. | [optional] |
 | **symbol** | **String** | Company symbol. | [optional] |
-| **year** | **Integer** | Earnings year. | [optional] |
-| **quarter** | **Integer** | Earnings quarter. | [optional] |
+| **year** | **Integer** | Fiscal year. | [optional] |
+| **quarter** | **Integer** | Fiscal quarter. | [optional] |
 
 ## Example
 

data/docs/EarningsEstimatesInfo.md

@@ -9,6 +9,8 @@
 | **eps_low** | **Float** | Lowest estimate. | [optional] |
 | **number_analysts** | **Integer** | Number of Analysts. | [optional] |
 | **period** | **Date** | Period. | [optional] |
+| **year** | **Integer** | Fiscal year. | [optional] |
+| **quarter** | **Integer** | Fiscal quarter. | [optional] |
 
 ## Example
 
@@ -20,7 +22,9 @@ instance = FinnhubRuby::EarningsEstimatesInfo.new(
   eps_high: null,
   eps_low: null,
   number_analysts: null,
-  period: null
+  period: null,
+  year: null,
+  quarter: null
 )
 ```
 

data/docs/EbitEstimatesInfo.md

@@ -9,6 +9,8 @@
 | **ebit_low** | **Float** | Lowest estimate. | [optional] |
 | **number_analysts** | **Integer** | Number of Analysts. | [optional] |
 | **period** | **Date** | Period. | [optional] |
+| **year** | **Integer** | Fiscal year. | [optional] |
+| **quarter** | **Integer** | Fiscal quarter. | [optional] |
 
 ## Example
 
@@ -20,7 +22,9 @@ instance = FinnhubRuby::EbitEstimatesInfo.new(
   ebit_high: null,
   ebit_low: null,
   number_analysts: null,
-  period: null
+  period: null,
+  year: null,
+  quarter: null
 )
 ```
 

data/docs/EbitdaEstimatesInfo.md

@@ -9,6 +9,8 @@
 | **ebitda_low** | **Float** | Lowest estimate. | [optional] |
 | **number_analysts** | **Integer** | Number of Analysts. | [optional] |
 | **period** | **Date** | Period. | [optional] |
+| **year** | **Integer** | Fiscal year. | [optional] |
+| **quarter** | **Integer** | Fiscal quarter. | [optional] |
 
 ## Example
 
@@ -20,7 +22,9 @@ instance = FinnhubRuby::EbitdaEstimatesInfo.new(
   ebitda_high: null,
   ebitda_low: null,
   number_analysts: null,
-  period: null
+  period: null,
+  year: null,
+  quarter: null
 )
 ```
 

data/docs/EmployeeCount.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::EmployeeCount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **at_date** | **String** | Date of the reading | [optional] |
+| **employee** | **Float** | Value | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::EmployeeCount.new(
+  at_date: null,
+  employee: null
+)
+```
+

data/docs/FilingResponse.md

@@ -10,7 +10,7 @@
 | **symbol** | **Object** | List of symbol associate with this filing | [optional] |
 | **name** | **String** | Filer name | [optional] |
 | **acceptance_date** | **String** | Date the filing is submitted. | [optional] |
-| **filed_date** | **String** | Date the filing is make available to the public | [optional] |
+| **filed_date** | **String** | Date the filing is made available to the public | [optional] |
 | **report_date** | **String** | Date as which the filing is reported | [optional] |
 | **form** | **String** | Filing Form | [optional] |
 | **amend** | **Boolean** | Amendment | [optional] |

data/docs/HistoricalCompanyESG.md

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

data/docs/HistoricalEmployeeCount.md

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

data/docs/HistoricalMarketCapData.md

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

data/docs/IndicesConstituents.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **symbol** | **String** | Index's symbol. | [optional] |
 | **constituents** | **Array<String>** | Array of constituents. | [optional] |
+| **constituents_breakdown** | [**Array<IndicesConstituentsBreakdown>**](IndicesConstituentsBreakdown.md) | Array of constituents' details. | [optional] |
 
 ## Example
 
@@ -14,7 +15,8 @@ require 'finnhub_ruby'
 
 instance = FinnhubRuby::IndicesConstituents.new(
   symbol: null,
-  constituents: null
+  constituents: null,
+  constituents_breakdown: null
 )
 ```
 

data/docs/IndicesConstituentsBreakdown.md

@@ -0,0 +1,28 @@
+# FinnhubRuby::IndicesConstituentsBreakdown
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol. | [optional] |
+| **name** | **String** | Name. | [optional] |
+| **isin** | **String** | ISIN. | [optional] |
+| **cusip** | **String** | Cusip. | [optional] |
+| **share_class_figi** | **String** | Global Share Class FIGI. | [optional] |
+| **weight** | **Float** | Weight. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::IndicesConstituentsBreakdown.new(
+  symbol: null,
+  name: null,
+  isin: null,
+  cusip: null,
+  share_class_figi: null,
+  weight: null
+)
+```
+

data/docs/MarketCapData.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::MarketCapData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **at_date** | **String** | Date of the reading | [optional] |
+| **market_capitalization** | **Float** | Value | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::MarketCapData.new(
+  at_date: null,
+  market_capitalization: null
+)
+```
+

data/docs/MarketHoliday.md

@@ -0,0 +1,22 @@
+# FinnhubRuby::MarketHoliday
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **timezone** | **String** | Timezone. | [optional] |
+| **exchange** | **String** | Exchange. | [optional] |
+| **data** | [**Array<MarketHolidayData>**](MarketHolidayData.md) | Array of holidays. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::MarketHoliday.new(
+  timezone: null,
+  exchange: null,
+  data: null
+)
+```
+

data/docs/MarketHolidayData.md

@@ -0,0 +1,22 @@
+# FinnhubRuby::MarketHolidayData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_name** | **String** | Holiday's name. | [optional] |
+| **at_date** | **String** | Date. | [optional] |
+| **trading_hour** | **String** | Trading hours for this day if the market is partially closed only. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::MarketHolidayData.new(
+  event_name: null,
+  at_date: null,
+  trading_hour: null
+)
+```
+

data/docs/MarketStatus.md

@@ -0,0 +1,28 @@
+# FinnhubRuby::MarketStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **exchange** | **String** | Exchange. | [optional] |
+| **timezone** | **String** | Timezone. | [optional] |
+| **session** | **String** | Market session. Can be 1 of the following values: <code>pre-market</code>,<code>regular</code>,<code>post-market</code> or <code>null</code> if the market is closed. | [optional] |
+| **holiday** | **String** | Holiday event. | [optional] |
+| **is_open** | **Boolean** | Whether the market is open at the moment. | [optional] |
+| **t** | **Integer** | Current timestamp. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::MarketStatus.new(
+  exchange: null,
+  timezone: null,
+  session: null,
+  holiday: null,
+  is_open: null,
+  t: null
+)
+```
+

data/docs/MutualFundProfileData.md

@@ -13,6 +13,7 @@
 | **inception_date** | **Date** | Inception date. | [optional] |
 | **description** | **String** | Fund's description. | [optional] |
 | **fund_family** | **String** | Fund Family. | [optional] |
+| **fund_company** | **String** | Fund Company. | [optional] |
 | **manager** | **String** | Fund's managers. | [optional] |
 | **status** | **String** | Status. | [optional] |
 | **beta** | **Float** | Beta. | [optional] |
@@ -47,6 +48,7 @@ instance = FinnhubRuby::MutualFundProfileData.new(
   inception_date: null,
   description: null,
   fund_family: null,
+  fund_company: null,
   manager: null,
   status: null,
   beta: null,

data/docs/PriceTarget.md

@@ -9,6 +9,7 @@
 | **target_low** | **Float** | Lowest analysts' target. | [optional] |
 | **target_mean** | **Float** | Mean of all analysts' targets. | [optional] |
 | **target_median** | **Float** | Median of all analysts' targets. | [optional] |
+| **number_analysts** | **Integer** | Number of Analysts. | [optional] |
 | **last_updated** | **String** | Updated time of the data | [optional] |
 
 ## Example
@@ -22,6 +23,7 @@ instance = FinnhubRuby::PriceTarget.new(
   target_low: null,
   target_mean: null,
   target_median: null,
+  number_analysts: null,
   last_updated: null
 )
 ```

data/docs/RevenueEstimatesInfo.md

@@ -9,6 +9,8 @@
 | **revenue_low** | **Float** | Lowest estimate. | [optional] |
 | **number_analysts** | **Integer** | Number of Analysts. | [optional] |
 | **period** | **Date** | Period. | [optional] |
+| **year** | **Integer** | Fiscal year. | [optional] |
+| **quarter** | **Integer** | Fiscal quarter. | [optional] |
 
 ## Example
 
@@ -20,7 +22,9 @@ instance = FinnhubRuby::RevenueEstimatesInfo.new(
   revenue_high: null,
   revenue_low: null,
   number_analysts: null,
-  period: null
+  period: null,
+  year: null,
+  quarter: null
 )
 ```
 

data/docs/SentimentContent.md

@@ -0,0 +1,30 @@
+# FinnhubRuby::SentimentContent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mention** | **Integer** | Number of mentions | [optional] |
+| **positive_mention** | **Integer** | Number of positive mentions | [optional] |
+| **negative_mention** | **Integer** | Number of negative mentions | [optional] |
+| **positive_score** | **Float** | Positive score. Range 0-1 | [optional] |
+| **negative_score** | **Float** | Negative score. Range 0-1 | [optional] |
+| **score** | **Float** | Final score. Range: -1 to 1 with 1 is very positive and -1 is very negative | [optional] |
+| **at_time** | **String** | Period. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::SentimentContent.new(
+  mention: null,
+  positive_mention: null,
+  negative_mention: null,
+  positive_score: null,
+  negative_score: null,
+  score: null,
+  at_time: null
+)
+```
+

data/docs/SocialSentiment.md

@@ -5,8 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **symbol** | **String** | Company symbol. | [optional] |
-| **reddit** | [**Array<RedditSentimentContent>**](RedditSentimentContent.md) | Reddit sentiment. | [optional] |
-| **twitter** | [**Array<TwitterSentimentContent>**](TwitterSentimentContent.md) | Twitter sentiment. | [optional] |
+| **data** | [**Array<SentimentContent>**](SentimentContent.md) | Sentiment data. | [optional] |
 
 ## Example
 
@@ -15,8 +14,7 @@ require 'finnhub_ruby'
 
 instance = FinnhubRuby::SocialSentiment.new(
   symbol: null,
-  reddit: null,
-  twitter: null
+  data: null
 )
 ```
 

data/finnhub_ruby.gemspec

@@ -3,7 +3,7 @@
 =begin
 #Finnhub API
 
-#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+#Ruby client for Finnhub API
 
 The version of the OpenAPI document: 1.0.0
 
@@ -19,20 +19,20 @@ Gem::Specification.new do |s|
   s.name        = "finnhub_ruby"
   s.version     = FinnhubRuby::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["OpenAPI-Generator"]
-  s.email       = [""]
-  s.homepage    = "https://openapi-generator.tech"
+  s.authors     = ["Finnhub"]
+  s.email       = ["support@finnhub.io"]
+  s.homepage    = "https://github.com/Finnhub-Stock-API/finnhub-ruby"
   s.summary     = "Finnhub API Ruby Gem"
-  s.description = "No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)"
-  s.license     = "Unlicense"
+  s.description = "Ruby client for Finnhub API. Finnhub API provides real-time stock price, crypto, and forex data."
+  s.license     = "Apache-2.0"
   s.required_ruby_version = ">= 2.4"
 
-  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.3'
 
   s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
 
-  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
-  s.test_files    = `find spec/*`.split("\n")
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.executables   = []
   s.require_paths = ["lib"]
 end

data/lib/finnhub_ruby/version.rb

@@ -1,15 +1,3 @@
-=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
-
 module FinnhubRuby
-  VERSION = '1.1.19'
-end
+  VERSION = "2.0.0"
+end