finnhub_ruby 1.1.17 → 1.1.19

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

@@ -10,7 +10,7 @@
 | **aum** | **Float** | AUM. | [optional] |
 | **nav** | **Float** | NAV. | [optional] |
 | **nav_currency** | **String** | NAV currency. | [optional] |
-| **expense_ratio** | **Float** | Expense ratio. | [optional] |
+| **expense_ratio** | **Float** | Expense ratio. For non-US funds, this is the <a href=\"https://www.esma.europa.eu/sites/default/files/library/2015/11/09_1028_final_kid_ongoing_charges_methodology_for_publication_u_2_.pdf\" target=\"_blank\">KID ongoing charges<a/>. | [optional] |
 | **tracking_index** | **String** | Tracking Index. | [optional] |
 | **etf_company** | **String** | ETF issuer. | [optional] |
 | **domicile** | **String** | ETF domicile. | [optional] |
@@ -22,6 +22,9 @@
 | **price_to_book** | **Float** | P/B. | [optional] |
 | **avg_volume** | **Float** | 30-day average volume. | [optional] |
 | **description** | **String** | ETF's description. | [optional] |
+| **is_inverse** | **Boolean** | Whether the ETF is inverse | [optional] |
+| **is_leveraged** | **Boolean** | Whether the ETF is leveraged | [optional] |
+| **leverage_factor** | **Float** | Leverage factor. | [optional] |
 
 ## Example
 
@@ -46,7 +49,10 @@ instance = FinnhubRuby::ETFProfileData.new(
   price_to_earnings: null,
   price_to_book: null,
   avg_volume: null,
-  description: null
+  description: null,
+  is_inverse: null,
+  is_leveraged: null,
+  leverage_factor: 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** | Earnings year. | [optional] |
+| **quarter** | **Integer** | Earnings 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/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 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] |
+
+## 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/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/InstitutionalOwnership.md

@@ -0,0 +1,22 @@
+# FinnhubRuby::InstitutionalOwnership
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol. | [optional] |
+| **cusip** | **String** | Cusip. | [optional] |
+| **data** | [**Array<InstitutionalOwnershipGroup>**](InstitutionalOwnershipGroup.md) | Array of institutional investors. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::InstitutionalOwnership.new(
+  symbol: null,
+  cusip: null,
+  data: null
+)
+```
+

data/docs/InstitutionalOwnershipGroup.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::InstitutionalOwnershipGroup
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **report_date** | **String** | Report date. | [optional] |
+| **ownership** | [**Array<InstitutionalOwnershipInfo>**](InstitutionalOwnershipInfo.md) | Array of institutional investors. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::InstitutionalOwnershipGroup.new(
+  report_date: null,
+  ownership: null
+)
+```
+

data/docs/InstitutionalOwnershipInfo.md

@@ -0,0 +1,36 @@
+# FinnhubRuby::InstitutionalOwnershipInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cik** | **String** | Investor's company CIK. | [optional] |
+| **name** | **String** | Firm's name. | [optional] |
+| **put_call** | **String** | <code>put</code> or <code>call</code> for options. | [optional] |
+| **change** | **Float** | Number of shares change. | [optional] |
+| **no_voting** | **Float** | Number of shares with no voting rights. | [optional] |
+| **percentage** | **Float** | Percentage of portfolio. | [optional] |
+| **share** | **Float** | News score. | [optional] |
+| **shared_voting** | **Float** | Number of shares with shared voting rights. | [optional] |
+| **sole_voting** | **Float** | Number of shares with sole voting rights. | [optional] |
+| **value** | **Float** | Position value. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::InstitutionalOwnershipInfo.new(
+  cik: null,
+  name: null,
+  put_call: null,
+  change: null,
+  no_voting: null,
+  percentage: null,
+  share: null,
+  shared_voting: null,
+  sole_voting: null,
+  value: null
+)
+```
+

data/docs/InstitutionalPortfolio.md

@@ -0,0 +1,22 @@
+# FinnhubRuby::InstitutionalPortfolio
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Investor's name. | [optional] |
+| **cik** | **String** | CIK. | [optional] |
+| **data** | [**Array<InstitutionalPortfolioGroup>**](InstitutionalPortfolioGroup.md) | Array of positions. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::InstitutionalPortfolio.new(
+  name: null,
+  cik: null,
+  data: null
+)
+```
+

data/docs/InstitutionalPortfolioGroup.md

@@ -0,0 +1,22 @@
+# FinnhubRuby::InstitutionalPortfolioGroup
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **report_date** | **String** | Report date. | [optional] |
+| **filing_date** | **String** | Filing date. | [optional] |
+| **portfolio** | [**Array<InstitutionalPortfolioInfo>**](InstitutionalPortfolioInfo.md) | Array of positions. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::InstitutionalPortfolioGroup.new(
+  report_date: null,
+  filing_date: null,
+  portfolio: null
+)
+```
+

data/docs/InstitutionalPortfolioInfo.md

@@ -0,0 +1,38 @@
+# FinnhubRuby::InstitutionalPortfolioInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol. | [optional] |
+| **cusip** | **String** | CUSIP. | [optional] |
+| **name** | **String** | Position's name. | [optional] |
+| **put_call** | **String** | <code>put</code> or <code>call</code> for options. | [optional] |
+| **change** | **Float** | Number of shares change. | [optional] |
+| **no_voting** | **Float** | Number of shares with no voting rights. | [optional] |
+| **percentage** | **Float** | Percentage of portfolio. | [optional] |
+| **share** | **Float** | Number of shares. | [optional] |
+| **shared_voting** | **Float** | Number of shares with shared voting rights. | [optional] |
+| **sole_voting** | **Float** | Number of shares with sole voting rights. | [optional] |
+| **value** | **Float** | Position value. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::InstitutionalPortfolioInfo.new(
+  symbol: null,
+  cusip: null,
+  name: null,
+  put_call: null,
+  change: null,
+  no_voting: null,
+  percentage: null,
+  share: null,
+  shared_voting: null,
+  sole_voting: null,
+  value: null
+)
+```
+

data/docs/InstitutionalProfile.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::InstitutionalProfile
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cik** | **String** | CIK. | [optional] |
+| **data** | [**Array<InstitutionalProfileInfo>**](InstitutionalProfileInfo.md) | Array of investors. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::InstitutionalProfile.new(
+  cik: null,
+  data: null
+)
+```
+

data/docs/InstitutionalProfileInfo.md

@@ -0,0 +1,28 @@
+# FinnhubRuby::InstitutionalProfileInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cik** | **String** | Investor's company CIK. | [optional] |
+| **firm_type** | **String** | Firm type. | [optional] |
+| **manager** | **String** | Manager. | [optional] |
+| **philosophy** | **String** | Investing philosophy. | [optional] |
+| **profile** | **String** | Profile info. | [optional] |
+| **profile_img** | **String** | Profile image. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::InstitutionalProfileInfo.new(
+  cik: null,
+  firm_type: null,
+  manager: null,
+  philosophy: null,
+  profile: null,
+  profile_img: null
+)
+```
+

data/docs/IsinChange.md

@@ -0,0 +1,22 @@
+# FinnhubRuby::IsinChange
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from_date** | **String** | From date. | [optional] |
+| **to_date** | **String** | To date. | [optional] |
+| **data** | [**Array<IsinChangeInfo>**](IsinChangeInfo.md) | Array of ISIN change events. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::IsinChange.new(
+  from_date: null,
+  to_date: null,
+  data: null
+)
+```
+

data/docs/IsinChangeInfo.md

@@ -0,0 +1,22 @@
+# FinnhubRuby::IsinChangeInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **at_date** | **String** | Event's date. | [optional] |
+| **old_isin** | **String** | Old ISIN. | [optional] |
+| **new_isin** | **String** | New ISIN. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::IsinChangeInfo.new(
+  at_date: null,
+  old_isin: null,
+  new_isin: 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/PriceMetrics.md

@@ -0,0 +1,22 @@
+# FinnhubRuby::PriceMetrics
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol of the company. | [optional] |
+| **at_date** | **String** | Data date. | [optional] |
+| **data** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::PriceMetrics.new(
+  symbol: null,
+  at_date: null,
+  data: null
+)
+```
+

data/docs/SearchBody.md

@@ -0,0 +1,60 @@
+# FinnhubRuby::SearchBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **query** | **String** | Search query |  |
+| **isins** | **String** | List of isin to search, comma separated (Max: 50). | [optional] |
+| **cusips** | **String** | List of cusip to search, comma separated (Max: 50). | [optional] |
+| **ciks** | **String** | List of SEC Center Index Key to search, comma separated (Max: 50). | [optional] |
+| **sedar_ids** | **String** | List of SEDAR issuer number to search, comma separated (Max: 50). | [optional] |
+| **ch_ids** | **String** | List of Companies House number to search, comma separated (Max: 50). | [optional] |
+| **symbols** | **String** | List of symbols to search, comma separated (Max: 50). | [optional] |
+| **sedols** | **String** | List of sedols to search, comma separated (Max: 50). | [optional] |
+| **sources** | **String** | List of sources to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values. | [optional] |
+| **forms** | **String** | List of forms to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values. | [optional] |
+| **gics** | **String** | List of gics to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values. | [optional] |
+| **naics** | **String** | List of sources to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values. | [optional] |
+| **exhibits** | **String** | List of exhibits to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values. | [optional] |
+| **exchanges** | **String** | List of exchanges to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values. | [optional] |
+| **countries** | **String** | List of sources to search, comma separated (Max: 50). Look at <code>/filter</code> endpoint to see all available values. | [optional] |
+| **acts** | **String** | List of SEC's exchanges act to search, comma separated. Look at <code>/filter</code> endpoint to see all available values. | [optional] |
+| **caps** | **String** | List of market capitalization to search, comma separated. Look at <code>/filter</code> endpoint to see all available values. | [optional] |
+| **from_date** | **String** | Search from date in format: YYYY-MM-DD, default from the last 2 years | [optional] |
+| **to_date** | **String** | Search to date in format: YYYY-MM-DD, default to today | [optional] |
+| **page** | **String** | Use for pagination, default to page 1 | [optional] |
+| **sort** | **String** | Sort result by, default: sortMostRecent. Look at <code>/filter</code> endpoint to see all available values. | [optional] |
+| **highlighted** | **Boolean** | Enable highlight in returned filings. If enabled, only return 10 results each time | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::SearchBody.new(
+  query: null,
+  isins: null,
+  cusips: null,
+  ciks: null,
+  sedar_ids: null,
+  ch_ids: null,
+  symbols: null,
+  sedols: null,
+  sources: null,
+  forms: null,
+  gics: null,
+  naics: null,
+  exhibits: null,
+  exchanges: null,
+  countries: null,
+  acts: null,
+  caps: null,
+  from_date: null,
+  to_date: null,
+  page: null,
+  sort: null,
+  highlighted: null
+)
+```
+