finnhub_ruby 1.1.2 → 1.1.4

data/docs/NewsSentiment.md

@@ -2,26 +2,27 @@
 
 ## 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] 
+| 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
+## Example
 
 ```ruby
-require 'FinnhubRuby'
+require 'finnhub_ruby'
 
-instance = FinnhubRuby::NewsSentiment.new(buzz: null,
-                                 company_news_score: null,
-                                 sector_average_bullish_percent: null,
-                                 sector_average_news_score: null,
-                                 sentiment: null,
-                                 symbol: null)
+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/Ownership.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::Ownership
+
+## 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] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::Ownership.new(
+  symbol: null,
+  ownership: null
+)
+```
+

data/docs/PatternRecognition.md

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

data/docs/PriceTarget.md

@@ -2,26 +2,27 @@
 
 ## 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] 
+| 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** | **Time** | Updated time of the data | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'FinnhubRuby'
+require 'finnhub_ruby'
 
-instance = FinnhubRuby::PriceTarget.new(symbol: null,
-                                 target_high: null,
-                                 target_low: null,
-                                 target_mean: null,
-                                 target_median: null,
-                                 last_updated: null)
+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

@@ -2,24 +2,29 @@
 
 ## 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] 
+| 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] |
+| **d** | **Float** | Change | [optional] |
+| **dp** | **Float** | Percent change | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'FinnhubRuby'
+require 'finnhub_ruby'
 
-instance = FinnhubRuby::Quote.new(o: null,
-                                 h: null,
-                                 l: null,
-                                 c: null,
-                                 pc: null)
+instance = FinnhubRuby::Quote.new(
+  o: null,
+  h: null,
+  l: null,
+  c: null,
+  pc: null,
+  d: null,
+  dp: null
+)
 ```
 
-

data/docs/RecommendationTrend.md

@@ -2,28 +2,29 @@
 
 ## 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] 
+| 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
+## Example
 
 ```ruby
-require 'FinnhubRuby'
+require 'finnhub_ruby'
 
-instance = FinnhubRuby::RecommendationTrend.new(symbol: null,
-                                 buy: null,
-                                 hold: null,
-                                 period: null,
-                                 sell: null,
-                                 strong_buy: null,
-                                 strong_sell: null)
+instance = FinnhubRuby::RecommendationTrend.new(
+  symbol: null,
+  buy: null,
+  hold: null,
+  period: null,
+  sell: null,
+  strong_buy: null,
+  strong_sell: null
+)
 ```
 
-

data/docs/RedditSentimentContent.md

@@ -0,0 +1,30 @@
+# FinnhubRuby::RedditSentimentContent
+
+## 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** | **Time** | Period. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::RedditSentimentContent.new(
+  mention: null,
+  positive_mention: null,
+  negative_mention: null,
+  positive_score: null,
+  negative_score: null,
+  score: null,
+  at_time: null
+)
+```
+

data/docs/Report.md

@@ -2,36 +2,37 @@
 
 ## 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] 
+| 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** | **Time** | Period start date <code>%Y-%m-%d %H:%M:%S</code>. | [optional] |
+| **end_date** | **Time** | Period end date <code>%Y-%m-%d %H:%M:%S</code>. | [optional] |
+| **filed_date** | **Time** | Filed date <code>%Y-%m-%d %H:%M:%S</code>. | [optional] |
+| **accepted_date** | **Time** | Accepted date <code>%Y-%m-%d %H:%M:%S</code>. | [optional] |
+| **report** | **Object** |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'FinnhubRuby'
+require 'finnhub_ruby'
 
-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)
+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/RevenueBreakdown.md

@@ -0,0 +1,22 @@
+# FinnhubRuby::RevenueBreakdown
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol | [optional] |
+| **cik** | **String** | CIK | [optional] |
+| **data** | **Array<Object>** | Array of revenue breakdown over multiple periods. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::RevenueBreakdown.new(
+  symbol: null,
+  cik: null,
+  data: null
+)
+```
+

data/docs/RevenueEstimates.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | **Array<Object>** | List of estimates | [optional] 
-**freq** | **String** | Frequency: annual or quarterly. | [optional] 
-**symbol** | **String** | Company symbol. | [optional] 
+| 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
+## Example
 
 ```ruby
-require 'FinnhubRuby'
+require 'finnhub_ruby'
 
-instance = FinnhubRuby::RevenueEstimates.new(data: null,
-                                 freq: null,
-                                 symbol: null)
+instance = FinnhubRuby::RevenueEstimates.new(
+  data: null,
+  freq: null,
+  symbol: null
+)
 ```
 
-

data/docs/SECSentimentAnalysis.md

@@ -0,0 +1,24 @@
+# FinnhubRuby::SECSentimentAnalysis
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_number** | **String** | Access number. | [optional] |
+| **symbol** | **String** | Symbol. | [optional] |
+| **cik** | **String** | CIK. | [optional] |
+| **sentiment** | [**FilingSentiment**](FilingSentiment.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::SECSentimentAnalysis.new(
+  access_number: null,
+  symbol: null,
+  cik: null,
+  sentiment: null
+)
+```
+

data/docs/Sentiment.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**bearish_percent** | **Integer** |  | [optional] 
-**bullish_percent** | **Integer** |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bearish_percent** | **Integer** |  | [optional] |
+| **bullish_percent** | **Integer** |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'FinnhubRuby'
+require 'finnhub_ruby'
 
-instance = FinnhubRuby::Sentiment.new(bearish_percent: null,
-                                 bullish_percent: null)
+instance = FinnhubRuby::Sentiment.new(
+  bearish_percent: null,
+  bullish_percent: null
+)
 ```
 
-

data/docs/SimilarityIndex.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**symbol** | **String** | Symbol. | [optional] 
-**cik** | **String** | CIK. | [optional] 
-**similarity** | **Array<Object>** | Array of filings with its cosine similarity compared to the same report of the previous year. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol. | [optional] |
+| **cik** | **String** | CIK. | [optional] |
+| **similarity** | **Array<Object>** | Array of filings with its cosine similarity compared to the same report of the previous year. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'FinnhubRuby'
+require 'finnhub_ruby'
 
-instance = FinnhubRuby::SimilarityIndex.new(symbol: null,
-                                 cik: null,
-                                 similarity: null)
+instance = FinnhubRuby::SimilarityIndex.new(
+  symbol: null,
+  cik: null,
+  similarity: null
+)
 ```
 
-