finnhub_ruby 1.1.4 → 1.1.8

data/docs/MutualFundHoldingsData.md

@@ -0,0 +1,30 @@
+# FinnhubRuby::MutualFundHoldingsData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol description | [optional] |
+| **name** | **String** | Security name | [optional] |
+| **isin** | **String** | ISIN. | [optional] |
+| **cusip** | **String** | CUSIP. | [optional] |
+| **share** | **Float** | Number of shares. | [optional] |
+| **percent** | **Float** | Portfolio's percent | [optional] |
+| **value** | **Float** | Market value | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::MutualFundHoldingsData.new(
+  symbol: null,
+  name: null,
+  isin: null,
+  cusip: null,
+  share: null,
+  percent: null,
+  value: null
+)
+```
+

data/docs/{MutualFundsProfile.md → MutualFundProfile.md}

@@ -1,18 +1,18 @@
-# FinnhubRuby::MutualFundsProfile
+# FinnhubRuby::MutualFundProfile
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **symbol** | **String** | Symbol. | [optional] |
-| **profile** | [**ETFProfileData**](ETFProfileData.md) |  | [optional] |
+| **profile** | [**MutualFundProfileData**](MutualFundProfileData.md) |  | [optional] |
 
 ## Example
 
 ```ruby
 require 'finnhub_ruby'
 
-instance = FinnhubRuby::MutualFundsProfile.new(
+instance = FinnhubRuby::MutualFundProfile.new(
   symbol: null,
   profile: null
 )

data/docs/MutualFundProfileData.md

@@ -0,0 +1,58 @@
+# FinnhubRuby::MutualFundProfileData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name | [optional] |
+| **category** | **String** | Fund's category. | [optional] |
+| **investment_segment** | **String** | Investment Segment. | [optional] |
+| **total_nav** | **Float** | NAV. | [optional] |
+| **expense_ratio** | **Float** | Expense ratio. | [optional] |
+| **benchmark** | **String** | Index benchmark. | [optional] |
+| **inception_date** | **Date** | Inception date. | [optional] |
+| **description** | **String** | Fund's description. | [optional] |
+| **fund_family** | **String** | Fund Family. | [optional] |
+| **manager** | **String** | Fund's managers. | [optional] |
+| **status** | **String** | Status. | [optional] |
+| **beta** | **Float** | Beta. | [optional] |
+| **deferred_load** | **Float** | Deferred load. | [optional] |
+| **fee12b1** | **Float** | 12B-1 fee. | [optional] |
+| **front_load** | **Float** | Front Load. | [optional] |
+| **ira_min_investment** | **Float** | IRA minimum investment. | [optional] |
+| **isin** | **String** | ISIN. | [optional] |
+| **cusip** | **String** | CUSIP. | [optional] |
+| **max_redemption_fee** | **Float** | Max redemption fee. | [optional] |
+| **standard_min_investment** | **Float** | Minimum investment for standard accounts. | [optional] |
+| **turnover** | **Float** | Turnover. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::MutualFundProfileData.new(
+  name: null,
+  category: null,
+  investment_segment: null,
+  total_nav: null,
+  expense_ratio: null,
+  benchmark: null,
+  inception_date: null,
+  description: null,
+  fund_family: null,
+  manager: null,
+  status: null,
+  beta: null,
+  deferred_load: null,
+  fee12b1: null,
+  front_load: null,
+  ira_min_investment: null,
+  isin: null,
+  cusip: null,
+  max_redemption_fee: null,
+  standard_min_investment: null,
+  turnover: null
+)
+```
+

data/docs/MutualFundSectorExposure.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **symbol** | **String** | Mutual symbol. | [optional] |
-| **sector_exposure** | **Array<Object>** | Array of sector and exposure levels. | [optional] |
+| **sector_exposure** | [**Array<MutualFundSectorExposureData>**](MutualFundSectorExposureData.md) | Array of sector and exposure levels. | [optional] |
 
 ## Example
 

data/docs/Ownership.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **symbol** | **String** | Symbol of the company. | [optional] |
-| **ownership** | **Array<Object>** | Array of investors with detailed information about their holdings. | [optional] |
+| **ownership** | [**Array<OwnershipInfo>**](OwnershipInfo.md) | Array of investors with detailed information about their holdings. | [optional] |
 
 ## Example
 

data/docs/{Investor.md → OwnershipInfo.md}

@@ -1,4 +1,4 @@
-# FinnhubRuby::Investor
+# FinnhubRuby::OwnershipInfo
 
 ## Properties
 
@@ -14,7 +14,7 @@
 ```ruby
 require 'finnhub_ruby'
 
-instance = FinnhubRuby::Investor.new(
+instance = FinnhubRuby::OwnershipInfo.new(
   name: null,
   share: null,
   change: null,

data/docs/{MajorPressReleases.md → PressRelease.md}

@@ -1,18 +1,18 @@
-# FinnhubRuby::MajorPressReleases
+# FinnhubRuby::PressRelease
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **symbol** | **String** | Company symbol. | [optional] |
-| **major_development** | **Array<Object>** | Array of major developments. | [optional] |
+| **major_development** | [**Array<Development>**](Development.md) | Array of major developments. | [optional] |
 
 ## Example
 
 ```ruby
 require 'finnhub_ruby'
 
-instance = FinnhubRuby::MajorPressReleases.new(
+instance = FinnhubRuby::PressRelease.new(
   symbol: null,
   major_development: null
 )

data/docs/PriceTarget.md

@@ -9,7 +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] |
-| **last_updated** | **Time** | Updated time of the data | [optional] |
+| **last_updated** | **String** | Updated time of the data | [optional] |
 
 ## Example
 

data/docs/RedditSentimentContent.md

@@ -10,7 +10,7 @@
 | **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] |
+| **at_time** | **String** | Period. | [optional] |
 
 ## Example
 

data/docs/Report.md

@@ -10,10 +10,10 @@
 | **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] |
+| **start_date** | **String** | Period start date <code>%Y-%m-%d %H:%M:%S</code>. | [optional] |
+| **end_date** | **String** | Period end date <code>%Y-%m-%d %H:%M:%S</code>. | [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** | **Object** |  | [optional] |
 
 ## Example

data/docs/RevenueBreakdown.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **symbol** | **String** | Symbol | [optional] |
 | **cik** | **String** | CIK | [optional] |
-| **data** | **Array<Object>** | Array of revenue breakdown over multiple periods. | [optional] |
+| **data** | [**Array<BreakdownItem>**](BreakdownItem.md) | Array of revenue breakdown over multiple periods. | [optional] |
 
 ## Example
 

data/docs/RevenueEstimates.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **data** | **Array<Object>** | List of estimates | [optional] |
+| **data** | [**Array<RevenueEstimatesInfo>**](RevenueEstimatesInfo.md) | List of estimates | [optional] |
 | **freq** | **String** | Frequency: annual or quarterly. | [optional] |
 | **symbol** | **String** | Company symbol. | [optional] |
 

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/Sentiment.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **bearish_percent** | **Integer** |  | [optional] |
-| **bullish_percent** | **Integer** |  | [optional] |
+| **bearish_percent** | **Float** |  | [optional] |
+| **bullish_percent** | **Float** |  | [optional] |
 
 ## Example
 

data/docs/SimilarityIndex.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **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] |
+| **similarity** | [**Array<SimilarityIndexInfo>**](SimilarityIndexInfo.md) | Array of filings with its cosine similarity compared to the same report of the previous year. | [optional] |
 
 ## Example
 

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

@@ -5,8 +5,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **symbol** | **String** | Company symbol. | [optional] |
-| **reddit** | **Array<Object>** | Reddit sentiment. | [optional] |
-| **twitter** | **Array<Object>** | Twitter sentiment. | [optional] |
+| **reddit** | [**Array<RedditSentimentContent>**](RedditSentimentContent.md) | Reddit sentiment. | [optional] |
+| **twitter** | [**Array<TwitterSentimentContent>**](TwitterSentimentContent.md) | Twitter sentiment. | [optional] |
 
 ## Example
 

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

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | Transcript's ID used to get the <a href=\"#transcripts\">full transcript</a>. | [optional] |
 | **title** | **String** | Title. | [optional] |
-| **time** | **Time** | Time of the event. | [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] |
 

data/docs/SupplyChainRelationships.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **symbol** | **String** | symbol | [optional] |
-| **data** | **Array<Object>** | Key customers and suppliers. | [optional] |
+| **data** | [**Array<KeyCustomersSuppliers>**](KeyCustomersSuppliers.md) | Key customers and suppliers. | [optional] |
 
 ## Example
 

data/docs/SymbolLookup.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **result** | **Array<Object>** | Array of search results. | [optional] |
+| **result** | [**Array<SymbolLookupInfo>**](SymbolLookupInfo.md) | Array of search results. | [optional] |
 | **count** | **Integer** | Number of results. | [optional] |
 
 ## Example

data/docs/{Stock.md → SymbolLookupInfo.md}

@@ -1,4 +1,4 @@
-# FinnhubRuby::Stock
+# FinnhubRuby::SymbolLookupInfo
 
 ## Properties
 
@@ -14,7 +14,7 @@
 ```ruby
 require 'finnhub_ruby'
 
-instance = FinnhubRuby::Stock.new(
+instance = FinnhubRuby::SymbolLookupInfo.new(
   description: null,
   display_symbol: null,
   symbol: null,

data/docs/TickData.md

@@ -12,7 +12,7 @@
 | **p** | **Array<Float>** | List of price data. | [optional] |
 | **t** | **Array<Integer>** | List of timestamp in UNIX ms. | [optional] |
 | **x** | **Array<String>** | List of venues/exchanges. A list of exchange codes can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1Tj53M1svmr-hfEtbk6_NpVR1yAyGLMaH6ByYU6CG0ZY/edit?usp=sharing\",>here</a> | [optional] |
-| **c** | **Array<Array<NULL_SCHEMA_ERR>>** | List of trade conditions. A comprehensive list of trade conditions code can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1PUxiSWPHSODbaTaoL2Vef6DgU-yFtlRGZf19oBb9Hp0/edit?usp=sharing\">here</a> | [optional] |
+| **c** | **Array<Array<String>>** | List of trade conditions. A comprehensive list of trade conditions code can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1PUxiSWPHSODbaTaoL2Vef6DgU-yFtlRGZf19oBb9Hp0/edit?usp=sharing\">here</a> | [optional] |
 
 ## Example
 

data/docs/Transactions.md

@@ -10,7 +10,7 @@
 | **filing_date** | **Date** | Filing date. | [optional] |
 | **transaction_date** | **Date** | Transaction date. | [optional] |
 | **transaction_price** | **Float** | Average transaction price. | [optional] |
-| **transaction_code** | **Date** | Transaction code. A list of codes and their meanings can be found <a href=\"https://www.sec.gov/about/forms/form4data.pdf\" target=\"_blank\" rel=\"noopener\">here</a>. | [optional] |
+| **transaction_code** | **String** | Transaction code. A list of codes and their meanings can be found <a href=\"https://www.sec.gov/about/forms/form4data.pdf\" target=\"_blank\" rel=\"noopener\">here</a>. | [optional] |
 
 ## Example
 

data/docs/TwitterSentimentContent.md

@@ -10,7 +10,7 @@
 | **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] |
+| **at_time** | **String** | Period. | [optional] |
 
 ## Example