finnhub_ruby 1.0.0

data/docs/ForexSymbol.md

@@ -0,0 +1,21 @@
+# FinnhubRuby::ForexSymbol
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | Symbol description | [optional] 
+**display_symbol** | **String** | Display symbol name. | [optional] 
+**symbol** | **String** | Unique symbol used to identify this symbol used in <code>/forex/candle</code> endpoint. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::ForexSymbol.new(description: null,
+                                 display_symbol: null,
+                                 symbol: null)
+```
+
+

data/docs/Forexrates.md

@@ -0,0 +1,19 @@
+# FinnhubRuby::Forexrates
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**base** | **String** | Base currency. | [optional] 
+**quote** | [**Object**](.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::Forexrates.new(base: null,
+                                 quote: null)
+```
+
+

data/docs/FundOwnership.md

@@ -0,0 +1,19 @@
+# FinnhubRuby::FundOwnership
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**symbol** | **String** | Symbol of the company. | [optional] 
+**ownership** | **Array<Object>** | Array of investors with detailed information about their holdings. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::FundOwnership.new(symbol: null,
+                                 ownership: null)
+```
+
+

data/docs/IPOCalendar.md

@@ -0,0 +1,17 @@
+# FinnhubRuby::IPOCalendar
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ipo_calendar** | **Array<Object>** | Array of IPO events. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::IPOCalendar.new(ipo_calendar: null)
+```
+
+

data/docs/IPOEvent.md

@@ -0,0 +1,31 @@
+# FinnhubRuby::IPOEvent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**symbol** | **String** | Symbol. | [optional] 
+**date** | **Date** | IPO date. | [optional] 
+**exchange** | **String** | Exchange. | [optional] 
+**name** | **String** | Company's name. | [optional] 
+**status** | **String** | IPO status. Can take 1 of the following values: <code>expected</code>,<code>priced</code>,<code>withdrawn</code>,<code>filed</code> | [optional] 
+**price** | **String** | Projected price or price range. | [optional] 
+**number_of_shares** | **Integer** | Number of shares offered during the IPO. | [optional] 
+**total_shares_value** | **Integer** | Total shares value. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::IPOEvent.new(symbol: null,
+                                 date: null,
+                                 exchange: null,
+                                 name: null,
+                                 status: null,
+                                 price: null,
+                                 number_of_shares: null,
+                                 total_shares_value: null)
+```
+
+

data/docs/Indicator.md

@@ -0,0 +1,21 @@
+# FinnhubRuby::Indicator
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**buy** | **Integer** | Number of buy signals | [optional] 
+**neutral** | **Integer** | Number of neutral signals | [optional] 
+**sell** | **Integer** | Number of sell signals | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::Indicator.new(buy: null,
+                                 neutral: null,
+                                 sell: null)
+```
+
+

data/docs/Investor.md

@@ -0,0 +1,23 @@
+# FinnhubRuby::Investor
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Investor's name. | [optional] 
+**share** | **Integer** | Number of shares held by the investor. | [optional] 
+**change** | **Integer** | Number of share changed (net buy or sell) from the last period. | [optional] 
+**filing_date** | **Date** | Filing date. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::Investor.new(name: null,
+                                 share: null,
+                                 change: null,
+                                 filing_date: null)
+```
+
+

data/docs/InvestorsOwnership.md

@@ -0,0 +1,19 @@
+# FinnhubRuby::InvestorsOwnership
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**symbol** | **String** | Symbol of the company. | [optional] 
+**ownership** | **Array<Object>** | Array of investors with detailed information about their holdings. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::InvestorsOwnership.new(symbol: null,
+                                 ownership: null)
+```
+
+

data/docs/LastBidAsk.md

@@ -0,0 +1,25 @@
+# FinnhubRuby::LastBidAsk
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**b** | **Float** | Bid price. | [optional] 
+**a** | **Float** | Ask price. | [optional] 
+**bv** | **Float** | Bid volume. | [optional] 
+**av** | **Float** | Ask volume. | [optional] 
+**t** | **Integer** | Reference UNIX timestamp in ms. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::LastBidAsk.new(b: null,
+                                 a: null,
+                                 bv: null,
+                                 av: null,
+                                 t: null)
+```
+
+

data/docs/MajorDevelopments.md

@@ -0,0 +1,19 @@
+# FinnhubRuby::MajorDevelopments
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**symbol** | **String** | Company symbol. | [optional] 
+**major_development** | **Array<Object>** | Array of major developments. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::MajorDevelopments.new(symbol: null,
+                                 major_development: null)
+```
+
+

data/docs/News.md

@@ -0,0 +1,33 @@
+# FinnhubRuby::News
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**category** | **String** | News category. | [optional] 
+**datetime** | **Integer** | Published time in UNIX timestamp. | [optional] 
+**headline** | **String** | News headline. | [optional] 
+**id** | **Integer** | News ID. This value can be used for <code>minId</code> params to get the latest news only. | [optional] 
+**image** | **String** | Thumbnail image URL. | [optional] 
+**related** | **String** | Related stocks and companies mentioned in the article. | [optional] 
+**source** | **String** | News source. | [optional] 
+**summary** | **String** | News summary. | [optional] 
+**url** | **String** | URL of the original article. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::News.new(category: null,
+                                 datetime: null,
+                                 headline: null,
+                                 id: null,
+                                 image: null,
+                                 related: null,
+                                 source: null,
+                                 summary: null,
+                                 url: null)
+```
+
+

data/docs/NewsSentiment.md

@@ -0,0 +1,27 @@
+# FinnhubRuby::NewsSentiment
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**buzz** | [**CompanyNewsStatistics**](CompanyNewsStatistics.md) |  | [optional] 
+**company_news_score** | **Float** | News score. | [optional] 
+**sector_average_bullish_percent** | **Float** | Sector average bullish percent. | [optional] 
+**sector_average_news_score** | **Float** | Sectore average score. | [optional] 
+**sentiment** | [**Sentiment**](Sentiment.md) |  | [optional] 
+**symbol** | **String** | Requested symbol. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::NewsSentiment.new(buzz: null,
+                                 company_news_score: null,
+                                 sector_average_bullish_percent: null,
+                                 sector_average_news_score: null,
+                                 sentiment: null,
+                                 symbol: null)
+```
+
+

data/docs/PatternRecognition.md

@@ -0,0 +1,17 @@
+# FinnhubRuby::PatternRecognition
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**points** | **Array<Object>** | Array of patterns. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::PatternRecognition.new(points: null)
+```
+
+

data/docs/PriceTarget.md

@@ -0,0 +1,27 @@
+# FinnhubRuby::PriceTarget
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**symbol** | **String** | Company symbol. | [optional] 
+**target_high** | **Float** | Highes analysts' target. | [optional] 
+**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] 
+**last_updated** | **DateTime** | Updated time of the data | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::PriceTarget.new(symbol: null,
+                                 target_high: null,
+                                 target_low: null,
+                                 target_mean: null,
+                                 target_median: null,
+                                 last_updated: null)
+```
+
+

data/docs/Quote.md

@@ -0,0 +1,25 @@
+# FinnhubRuby::Quote
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**o** | **Float** | Open price of the day | [optional] 
+**h** | **Float** | High price of the day | [optional] 
+**l** | **Float** | Low price of the day | [optional] 
+**c** | **Float** | Current price | [optional] 
+**pc** | **Float** | Previous close price | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::Quote.new(o: null,
+                                 h: null,
+                                 l: null,
+                                 c: null,
+                                 pc: null)
+```
+
+

data/docs/RecommendationTrend.md

@@ -0,0 +1,29 @@
+# FinnhubRuby::RecommendationTrend
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**symbol** | **String** | Company symbol. | [optional] 
+**buy** | **Integer** | Number of recommendations that fall into the Buy category | [optional] 
+**hold** | **Integer** | Number of recommendations that fall into the Hold category | [optional] 
+**period** | **String** | Updated period | [optional] 
+**sell** | **Integer** | Number of recommendations that fall into the Sell category | [optional] 
+**strong_buy** | **Integer** | Number of recommendations that fall into the Strong Buy category | [optional] 
+**strong_sell** | **Integer** | Number of recommendations that fall into the Strong Sell category | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::RecommendationTrend.new(symbol: null,
+                                 buy: null,
+                                 hold: null,
+                                 period: null,
+                                 sell: null,
+                                 strong_buy: null,
+                                 strong_sell: null)
+```
+
+

data/docs/Report.md

@@ -0,0 +1,37 @@
+# FinnhubRuby::Report
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**access_number** | **String** | Access number. | [optional] 
+**symbol** | **String** | Symbol. | [optional] 
+**cik** | **String** | CIK. | [optional] 
+**year** | **Integer** | Year. | [optional] 
+**quarter** | **Integer** | Quarter. | [optional] 
+**form** | **String** | Form type. | [optional] 
+**start_date** | **DateTime** | Period start date <code>%Y-%m-%d %H:%M:%S</code>. | [optional] 
+**end_date** | **DateTime** | Period end date <code>%Y-%m-%d %H:%M:%S</code>. | [optional] 
+**filed_date** | **DateTime** | Filed date <code>%Y-%m-%d %H:%M:%S</code>. | [optional] 
+**accepted_date** | **DateTime** | Accepted date <code>%Y-%m-%d %H:%M:%S</code>. | [optional] 
+**report** | [**Object**](.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::Report.new(access_number: null,
+                                 symbol: null,
+                                 cik: null,
+                                 year: null,
+                                 quarter: null,
+                                 form: null,
+                                 start_date: null,
+                                 end_date: null,
+                                 filed_date: null,
+                                 accepted_date: null,
+                                 report: null)
+```
+
+

data/docs/RevenueEstimates.md

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