finnhub_ruby 1.1.18 → 2.0.0

data/docs/Dividends.md

@@ -12,6 +12,7 @@
 | **record_date** | **Date** | Record date. | [optional] |
 | **declaration_date** | **Date** | Declaration date. | [optional] |
 | **currency** | **String** | Currency. | [optional] |
+| **freq** | **String** | <p>Dividend frequency. Can be 1 of the following values:</p><ul> <li><code>0: Annually</code></li> <li><code>1: Monthly</code></li> <li><code>2: Quarterly</code></li> <li><code>3: Semi-annually</code></li> <li><code>4: Other/Unknown</code></li> <li><code>5: Bimonthly</code></li> <li><code>6: Trimesterly</code></li> <li><code>7: Weekly</code></li> </ul> | [optional] |
 
 ## Example
 
@@ -26,7 +27,8 @@ instance = FinnhubRuby::Dividends.new(
   pay_date: null,
   record_date: null,
   declaration_date: null,
-  currency: null
+  currency: null,
+  freq: null
 )
 ```
 

data/docs/DocumentResponse.md

@@ -0,0 +1,28 @@
+# FinnhubRuby::DocumentResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **document_id** | **String** | AlphaResearch internal document id. | [optional] |
+| **title** | **String** | Title for this document. | [optional] |
+| **hits** | **String** | Number of hit in this document | [optional] |
+| **url** | **String** | Link to render this document | [optional] |
+| **format** | **String** | Format of this document (can be html or pdf) | [optional] |
+| **excerpts** | [**Array<ExcerptResponse>**](ExcerptResponse.md) | Highlighted excerpts for this document | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::DocumentResponse.new(
+  document_id: null,
+  title: null,
+  hits: null,
+  url: null,
+  format: null,
+  excerpts: null
+)
+```
+

data/docs/ETFHoldingsData.md

@@ -11,6 +11,7 @@
 | **share** | **Float** | Number of shares owned by the ETF. | [optional] |
 | **percent** | **Float** | Portfolio's percent | [optional] |
 | **value** | **Float** | Market value | [optional] |
+| **asset_type** | **String** | Asset type. Can be 1 of the following values: <code>Equity</code>, <code>ETP</code>, <code>Fund</code>, <code>Bond</code>, <code>Other</code> or empty. | [optional] |
 
 ## Example
 
@@ -24,7 +25,8 @@ instance = FinnhubRuby::ETFHoldingsData.new(
   cusip: null,
   share: null,
   percent: null,
-  value: null
+  value: null,
+  asset_type: null
 )
 ```
 

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,6 +10,8 @@
 | **surprise_percent** | **Float** | Surprise percent. | [optional] |
 | **period** | **Date** | Reported period. | [optional] |
 | **symbol** | **String** | Company symbol. | [optional] |
+| **year** | **Integer** | Fiscal year. | [optional] |
+| **quarter** | **Integer** | Fiscal quarter. | [optional] |
 
 ## Example
 
@@ -22,7 +24,9 @@ instance = FinnhubRuby::EarningResult.new(
   surprise: null,
   surprise_percent: null,
   period: null,
-  symbol: null
+  symbol: null,
+  year: null,
+  quarter: null
 )
 ```
 

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

@@ -0,0 +1,24 @@
+# FinnhubRuby::ExcerptResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content** | **String** | Highlighted content | [optional] |
+| **snippet_id** | **String** | Location of the content in the rendered document | [optional] |
+| **start_offset** | **String** | Start offset of highlighted content | [optional] |
+| **end_offset** | **String** | End offset of highlighted content | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::ExcerptResponse.new(
+  content: null,
+  snippet_id: null,
+  start_offset: null,
+  end_offset: null
+)
+```
+

data/docs/FilingResponse.md

@@ -0,0 +1,42 @@
+# FinnhubRuby::FilingResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filing_id** | **String** | Filing Id in Alpharesearch platform | [optional] |
+| **title** | **String** | Filing title | [optional] |
+| **filer_id** | **String** | Id of the entity submitted the filing | [optional] |
+| **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 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] |
+| **source** | **String** | Filing Source | [optional] |
+| **page_count** | **Integer** | Estimate number of page when printing | [optional] |
+| **document_count** | **Integer** | Number of document in this filing | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::FilingResponse.new(
+  filing_id: null,
+  title: null,
+  filer_id: null,
+  symbol: null,
+  name: null,
+  acceptance_date: null,
+  filed_date: null,
+  report_date: null,
+  form: null,
+  amend: null,
+  source: null,
+  page_count: null,
+  document_count: null
+)
+```
+

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

@@ -0,0 +1,44 @@
+# FinnhubRuby::InFilingResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filing_id** | **String** | Filing Id in Alpharesearch platform | [optional] |
+| **title** | **String** | Filing title | [optional] |
+| **filer_id** | **String** | Id of the entity submitted the filing | [optional] |
+| **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] |
+| **report_date** | **String** | Date as which the filing is reported | [optional] |
+| **form** | **String** | Filing Form | [optional] |
+| **amend** | **Boolean** | Amendment | [optional] |
+| **source** | **String** | Filing Source | [optional] |
+| **page_count** | **Integer** | Estimate number of page when printing | [optional] |
+| **document_count** | **Integer** | Number of document in this filing | [optional] |
+| **documents** | [**Array<DocumentResponse>**](DocumentResponse.md) | Document for this filing. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::InFilingResponse.new(
+  filing_id: null,
+  title: null,
+  filer_id: null,
+  symbol: null,
+  name: null,
+  acceptance_date: null,
+  filed_date: null,
+  report_date: null,
+  form: null,
+  amend: null,
+  source: null,
+  page_count: null,
+  document_count: null,
+  documents: null
+)
+```
+

data/docs/InFilingSearchBody.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::InFilingSearchBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **query** | **String** | Search query |  |
+| **filing_id** | **String** | Filing Id to search |  |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::InFilingSearchBody.new(
+  query: null,
+  filing_id: 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/MutualFundEet.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::MutualFundEet
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **isin** | **String** | ISIN. | [optional] |
+| **data** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::MutualFundEet.new(
+  isin: null,
+  data: null
+)
+```
+

data/docs/MutualFundEetPai.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::MutualFundEetPai
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **isin** | **String** | ISIN. | [optional] |
+| **data** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::MutualFundEetPai.new(
+  isin: null,
+  data: null
+)
+```
+

data/docs/MutualFundHoldingsData.md

@@ -11,6 +11,7 @@
 | **share** | **Float** | Number of shares. | [optional] |
 | **percent** | **Float** | Portfolio's percent | [optional] |
 | **value** | **Float** | Market value | [optional] |
+| **asset_type** | **String** | Asset type. Can be 1 of the following values: <code>Equity</code>, <code>ETP</code>, <code>Fund</code>, <code>Bond</code>, <code>Other</code> or empty. | [optional] |
 
 ## Example
 
@@ -24,7 +25,8 @@ instance = FinnhubRuby::MutualFundHoldingsData.new(
   cusip: null,
   share: null,
   percent: null,
-  value: null
+  value: null,
+  asset_type: 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/PriceMetrics.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **symbol** | **String** | Symbol of the company. | [optional] |
+| **at_date** | **String** | Data date. | [optional] |
 | **data** | **Object** |  | [optional] |
 
 ## Example
@@ -14,6 +15,7 @@ require 'finnhub_ruby'
 
 instance = FinnhubRuby::PriceMetrics.new(
   symbol: null,
+  at_date: null,
   data: 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
 )
 ```