finnhub_ruby 1.1.2 → 1.1.7

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<BreakdownItem>**](BreakdownItem.md) | 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<RevenueEstimatesInfo>**](RevenueEstimatesInfo.md) | 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/RevenueEstimatesInfo.md

@@ -0,0 +1,26 @@
+# FinnhubRuby::RevenueEstimatesInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **revenue_avg** | **Float** | Average revenue estimates including Finnhub's proprietary estimates. | [optional] |
+| **revenue_high** | **Float** | Highest estimate. | [optional] |
+| **revenue_low** | **Float** | Lowest estimate. | [optional] |
+| **number_analysts** | **Integer** | Number of Analysts. | [optional] |
+| **period** | **Date** | Period. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::RevenueEstimatesInfo.new(
+  revenue_avg: null,
+  revenue_high: null,
+  revenue_low: null,
+  number_analysts: null,
+  period: 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** | **Float** |  | [optional] |
+| **bullish_percent** | **Float** |  | [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<SimilarityIndexInfo>**](SimilarityIndexInfo.md) | 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
+)
 ```
 
-

data/docs/SimilarityIndexInfo.md

@@ -0,0 +1,40 @@
+# FinnhubRuby::SimilarityIndexInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cik** | **String** | CIK. | [optional] |
+| **item1** | **Float** | Cosine similarity of Item 1 (Business). This number is only available for Annual reports. | [optional] |
+| **item1a** | **Float** | Cosine similarity of Item 1A (Risk Factors). This number is available for both Annual and Quarterly reports. | [optional] |
+| **item2** | **Float** | Cosine similarity of Item 2 (Management’s Discussion and Analysis of Financial Condition and Results of Operations). This number is only available for Quarterly reports. | [optional] |
+| **item7** | **Float** | Cosine similarity of Item 7 (Management’s Discussion and Analysis of Financial Condition and Results of Operations). This number is only available for Annual reports. | [optional] |
+| **item7a** | **Float** | Cosine similarity of Item 7A (Quantitative and Qualitative Disclosures About Market Risk). This number is only available for Annual reports. | [optional] |
+| **access_number** | **String** | Access number. | [optional] |
+| **form** | **String** | Form type. | [optional] |
+| **filed_date** | **String** | Filed date <code>%Y-%m-%d %H:%M:%S</code>. | [optional] |
+| **accepted_date** | **String** | Accepted date <code>%Y-%m-%d %H:%M:%S</code>. | [optional] |
+| **report_url** | **String** | Report's URL. | [optional] |
+| **filing_url** | **String** | Filing's URL. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::SimilarityIndexInfo.new(
+  cik: null,
+  item1: null,
+  item1a: null,
+  item2: null,
+  item7: null,
+  item7a: null,
+  access_number: null,
+  form: null,
+  filed_date: null,
+  accepted_date: null,
+  report_url: null,
+  filing_url: null
+)
+```
+

data/docs/SocialSentiment.md

@@ -0,0 +1,22 @@
+# FinnhubRuby::SocialSentiment
+
+## Properties
+
+| 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] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::SocialSentiment.new(
+  symbol: null,
+  reddit: null,
+  twitter: null
+)
+```
+

data/docs/Split.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**symbol** | **String** | Symbol. | [optional] 
-**date** | **Date** | Split date. | [optional] 
-**from_factor** | **Float** | From factor. | [optional] 
-**to_factor** | **Float** | To factor. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol. | [optional] |
+| **date** | **Date** | Split date. | [optional] |
+| **from_factor** | **Float** | From factor. | [optional] |
+| **to_factor** | **Float** | To factor. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'FinnhubRuby'
+require 'finnhub_ruby'
 
-instance = FinnhubRuby::Split.new(symbol: null,
-                                 date: null,
-                                 from_factor: null,
-                                 to_factor: null)
+instance = FinnhubRuby::Split.new(
+  symbol: null,
+  date: null,
+  from_factor: null,
+  to_factor: null
+)
 ```
 
-

data/docs/StockCandles.md

@@ -2,28 +2,29 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**o** | **Array<Float>** | List of open prices for returned candles. | [optional] 
-**h** | **Array<Float>** | List of high prices for returned candles. | [optional] 
-**l** | **Array<Float>** | List of low prices for returned candles. | [optional] 
-**c** | **Array<Float>** | List of close prices for returned candles. | [optional] 
-**v** | **Array<Float>** | List of volume data for returned candles. | [optional] 
-**t** | **Array<Integer>** | List of timestamp for returned candles. | [optional] 
-**s** | **String** | Status of the response. This field can either be ok or no_data. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **o** | **Array<Float>** | List of open prices for returned candles. | [optional] |
+| **h** | **Array<Float>** | List of high prices for returned candles. | [optional] |
+| **l** | **Array<Float>** | List of low prices for returned candles. | [optional] |
+| **c** | **Array<Float>** | List of close prices for returned candles. | [optional] |
+| **v** | **Array<Float>** | List of volume data for returned candles. | [optional] |
+| **t** | **Array<Integer>** | List of timestamp for returned candles. | [optional] |
+| **s** | **String** | Status of the response. This field can either be ok or no_data. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'FinnhubRuby'
+require 'finnhub_ruby'
 
-instance = FinnhubRuby::StockCandles.new(o: null,
-                                 h: null,
-                                 l: null,
-                                 c: null,
-                                 v: null,
-                                 t: null,
-                                 s: null)
+instance = FinnhubRuby::StockCandles.new(
+  o: null,
+  h: null,
+  l: null,
+  c: null,
+  v: null,
+  t: null,
+  s: null
+)
 ```
 
-

data/docs/StockSymbol.md

@@ -0,0 +1,30 @@
+# FinnhubRuby::StockSymbol
+
+## 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>/stock/candle</code> endpoint. | [optional] |
+| **type** | **String** | Security type. | [optional] |
+| **mic** | **String** | Primary exchange's MIC. | [optional] |
+| **figi** | **String** | FIGI identifier. | [optional] |
+| **currency** | **String** | Price's currency. This might be different from the reporting currency of fundamental data. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::StockSymbol.new(
+  description: null,
+  display_symbol: null,
+  symbol: null,
+  type: null,
+  mic: null,
+  figi: null,
+  currency: null
+)
+```
+

data/docs/StockTranscripts.md

@@ -2,24 +2,25 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | Transcript's ID used to get the <a href=\"#transcripts\">full transcript</a>. | [optional] 
-**title** | **String** | Title. | [optional] 
-**time** | **DateTime** | Time of the event. | [optional] 
-**year** | **Integer** | Year of earnings result in the case of earnings call transcript. | [optional] 
-**quarter** | **Integer** | Quarter of earnings result in the case of earnings call transcript. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Transcript's ID used to get the <a href=\"#transcripts\">full transcript</a>. | [optional] |
+| **title** | **String** | Title. | [optional] |
+| **time** | **String** | Time of the event. | [optional] |
+| **year** | **Integer** | Year of earnings result in the case of earnings call transcript. | [optional] |
+| **quarter** | **Integer** | Quarter of earnings result in the case of earnings call transcript. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'FinnhubRuby'
+require 'finnhub_ruby'
 
-instance = FinnhubRuby::StockTranscripts.new(id: null,
-                                 title: null,
-                                 time: null,
-                                 year: null,
-                                 quarter: null)
+instance = FinnhubRuby::StockTranscripts.new(
+  id: null,
+  title: null,
+  time: null,
+  year: null,
+  quarter: null
+)
 ```
 
-

data/docs/SupplyChainRelationships.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::SupplyChainRelationships
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | symbol | [optional] |
+| **data** | [**Array<KeyCustomersSuppliers>**](KeyCustomersSuppliers.md) | Key customers and suppliers. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::SupplyChainRelationships.new(
+  symbol: null,
+  data: null
+)
+```
+

data/docs/SupportResistance.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**levels** | **Array<Float>** | Array of support and resistance levels. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **levels** | **Array<Float>** | Array of support and resistance levels. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'FinnhubRuby'
+require 'finnhub_ruby'
 
-instance = FinnhubRuby::SupportResistance.new(levels: null)
+instance = FinnhubRuby::SupportResistance.new(
+  levels: null
+)
 ```
 
-