finnhub_ruby 1.1.18 → 1.1.19

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/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

@@ -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/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
+)
+```
+

data/docs/SearchFilter.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::SearchFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Filter id, use with respective field in search query body. | [optional] |
+| **name** | **String** | Display name. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::SearchFilter.new(
+  id: null,
+  name: null
+)
+```
+

data/docs/SearchResponse.md

@@ -0,0 +1,24 @@
+# FinnhubRuby::SearchResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** | Total filing matched your search criteria. | [optional] |
+| **took** | **Integer** | Time took to execute your search query on our server, value in ms. | [optional] |
+| **page** | **Integer** | Current search page | [optional] |
+| **filings** | [**Array<FilingResponse>**](FilingResponse.md) | Filing match your search criteria. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::SearchResponse.new(
+  count: null,
+  took: null,
+  page: null,
+  filings: null
+)
+```
+