finnhub_ruby 1.1.2 → 1.1.7

data/docs/FDAComitteeMeeting.md

@@ -0,0 +1,24 @@
+# FinnhubRuby::FDAComitteeMeeting
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from_date** | **String** | Start time of the event in EST. | [optional] |
+| **to_date** | **String** | End time of the event in EST. | [optional] |
+| **event_description** | **String** | Event's description. | [optional] |
+| **url** | **String** | URL. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::FDAComitteeMeeting.new(
+  from_date: null,
+  to_date: null,
+  event_description: null,
+  url: null
+)
+```
+

data/docs/Filing.md

@@ -2,30 +2,31 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**access_number** | **String** | Access number. | [optional] 
-**symbol** | **String** | Symbol. | [optional] 
-**cik** | **String** | CIK. | [optional] 
-**form** | **String** | Form type. | [optional] 
-**filed_date** | **DateTime** | Filed date <code>%Y-%m-%d %H:%M:%S</code>. | [optional] 
-**accepted_date** | **DateTime** | 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] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_number** | **String** | Access number. | [optional] |
+| **symbol** | **String** | Symbol. | [optional] |
+| **cik** | **String** | CIK. | [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] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'FinnhubRuby'
+require 'finnhub_ruby'
 
-instance = FinnhubRuby::Filing.new(access_number: null,
-                                 symbol: null,
-                                 cik: null,
-                                 form: null,
-                                 filed_date: null,
-                                 accepted_date: null,
-                                 report_url: null,
-                                 filing_url: null)
+instance = FinnhubRuby::Filing.new(
+  access_number: null,
+  symbol: null,
+  cik: null,
+  form: null,
+  filed_date: null,
+  accepted_date: null,
+  report_url: null,
+  filing_url: null
+)
 ```
 
-

data/docs/FilingSentiment.md

@@ -0,0 +1,34 @@
+# FinnhubRuby::FilingSentiment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **negative** | **Float** | % of negative words in the filing. | [optional] |
+| **positive** | **Float** | % of positive words in the filing. | [optional] |
+| **polarity** | **Float** | % of polarity words in the filing. | [optional] |
+| **litigious** | **Float** | % of litigious words in the filing. | [optional] |
+| **uncertainty** | **Float** | % of uncertainty words in the filing. | [optional] |
+| **constraining** | **Float** | % of constraining words in the filing. | [optional] |
+| **modal_weak** | **Float** | % of modal-weak words in the filing. | [optional] |
+| **modal_strong** | **Float** | % of modal-strong words in the filing. | [optional] |
+| **modal_moderate** | **Float** | % of modal-moderate words in the filing. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::FilingSentiment.new(
+  negative: null,
+  positive: null,
+  polarity: null,
+  litigious: null,
+  uncertainty: null,
+  constraining: null,
+  modal_weak: null,
+  modal_strong: null,
+  modal_moderate: null
+)
+```
+

data/docs/FinancialStatements.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**symbol** | **String** | Symbol of the company. | [optional] 
-**financials** | **Array<Object>** | An array of map of key, value pairs containing the data for each period. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol of the company. | [optional] |
+| **financials** | **Array<Object>** | An array of map of key, value pairs containing the data for each period. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'FinnhubRuby'
+require 'finnhub_ruby'
 
-instance = FinnhubRuby::FinancialStatements.new(symbol: null,
-                                 financials: null)
+instance = FinnhubRuby::FinancialStatements.new(
+  symbol: null,
+  financials: null
+)
 ```
 
-

data/docs/FinancialsAsReported.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**symbol** | **String** | Symbol | [optional] 
-**cik** | **String** | CIK | [optional] 
-**data** | **Array<Object>** | Array of filings. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol | [optional] |
+| **cik** | **String** | CIK | [optional] |
+| **data** | [**Array<Report>**](Report.md) | Array of filings. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'FinnhubRuby'
+require 'finnhub_ruby'
 
-instance = FinnhubRuby::FinancialsAsReported.new(symbol: null,
-                                 cik: null,
-                                 data: null)
+instance = FinnhubRuby::FinancialsAsReported.new(
+  symbol: null,
+  cik: null,
+  data: null
+)
 ```
 
-

data/docs/ForexCandles.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<Float>** | 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<Float>** | 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::ForexCandles.new(o: null,
-                                 h: null,
-                                 l: null,
-                                 c: null,
-                                 v: null,
-                                 t: null,
-                                 s: null)
+instance = FinnhubRuby::ForexCandles.new(
+  o: null,
+  h: null,
+  l: null,
+  c: null,
+  v: null,
+  t: null,
+  s: null
+)
 ```
 
-

data/docs/ForexSymbol.md

@@ -2,20 +2,21 @@
 
 ## 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>/forex/candle</code> endpoint. | [optional] 
+| 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>/forex/candle</code> endpoint. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'FinnhubRuby'
+require 'finnhub_ruby'
 
-instance = FinnhubRuby::ForexSymbol.new(description: null,
-                                 display_symbol: null,
-                                 symbol: null)
+instance = FinnhubRuby::ForexSymbol.new(
+  description: null,
+  display_symbol: null,
+  symbol: null
+)
 ```
 
-

data/docs/Forexrates.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**base** | **String** | Base currency. | [optional] 
-**quote** | [**Object**](.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **base** | **String** | Base currency. | [optional] |
+| **quote** | **Object** |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'FinnhubRuby'
+require 'finnhub_ruby'
 
-instance = FinnhubRuby::Forexrates.new(base: null,
-                                 quote: null)
+instance = FinnhubRuby::Forexrates.new(
+  base: null,
+  quote: null
+)
 ```
 
-

data/docs/FundOwnership.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**symbol** | **String** | Symbol of the company. | [optional] 
-**ownership** | **Array<Object>** | Array of investors with detailed information about their holdings. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol of the company. | [optional] |
+| **ownership** | [**Array<FundOwnershipInfo>**](FundOwnershipInfo.md) | Array of investors with detailed information about their holdings. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'FinnhubRuby'
+require 'finnhub_ruby'
 
-instance = FinnhubRuby::FundOwnership.new(symbol: null,
-                                 ownership: null)
+instance = FinnhubRuby::FundOwnership.new(
+  symbol: null,
+  ownership: null
+)
 ```
 
-

data/docs/FundOwnershipInfo.md

@@ -0,0 +1,26 @@
+# FinnhubRuby::FundOwnershipInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Investor's name. | [optional] |
+| **share** | **Integer** | Number of shares held by the investor. | [optional] |
+| **change** | **Integer** | Number of share changed (net buy or sell) from the last period. | [optional] |
+| **filing_date** | **Date** | Filing date. | [optional] |
+| **portfolio_percent** | **Float** | Percent of the fund's portfolio comprised of the company's share. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::FundOwnershipInfo.new(
+  name: null,
+  share: null,
+  change: null,
+  filing_date: null,
+  portfolio_percent: null
+)
+```
+

data/docs/HistoricalNBBO.md

@@ -0,0 +1,40 @@
+# FinnhubRuby::HistoricalNBBO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **s** | **String** | Symbol. | [optional] |
+| **skip** | **Integer** | Number of ticks skipped. | [optional] |
+| **count** | **Integer** | Number of ticks returned. If <code>count</code> < <code>limit</code>, all data for that date has been returned. | [optional] |
+| **total** | **Integer** | Total number of ticks for that date. | [optional] |
+| **av** | **Array<Float>** | List of Ask volume data. | [optional] |
+| **a** | **Array<Float>** | List of Ask price data. | [optional] |
+| **ax** | **Array<String>** | List of venues/exchanges - Ask price. 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] |
+| **bv** | **Array<Float>** | List of Bid volume data. | [optional] |
+| **b** | **Array<Float>** | List of Bid price data. | [optional] |
+| **bx** | **Array<String>** | List of venues/exchanges - Bid price. 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] |
+| **t** | **Array<Integer>** | List of timestamp in UNIX ms. | [optional] |
+| **c** | **Array<Array<String>>** | List of quote conditions. A comprehensive list of quote conditions code can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1iiA6e7Osdtai0oPMOUzgAIKXCsay89dFDmsegz6OpEg/edit?usp=sharing\">here</a> | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::HistoricalNBBO.new(
+  s: null,
+  skip: null,
+  count: null,
+  total: null,
+  av: null,
+  a: null,
+  ax: null,
+  bv: null,
+  b: null,
+  bx: null,
+  t: null,
+  c: null
+)
+```
+

data/docs/IPOCalendar.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ipo_calendar** | **Array<Object>** | Array of IPO events. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ipo_calendar** | [**Array<IPOEvent>**](IPOEvent.md) | Array of IPO events. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'FinnhubRuby'
+require 'finnhub_ruby'
 
-instance = FinnhubRuby::IPOCalendar.new(ipo_calendar: null)
+instance = FinnhubRuby::IPOCalendar.new(
+  ipo_calendar: null
+)
 ```
 
-

data/docs/IPOEvent.md

@@ -2,30 +2,31 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**symbol** | **String** | Symbol. | [optional] 
-**date** | **Date** | IPO date. | [optional] 
-**exchange** | **String** | Exchange. | [optional] 
-**name** | **String** | Company's name. | [optional] 
-**status** | **String** | IPO status. Can take 1 of the following values: <code>expected</code>,<code>priced</code>,<code>withdrawn</code>,<code>filed</code> | [optional] 
-**price** | **String** | Projected price or price range. | [optional] 
-**number_of_shares** | **Integer** | Number of shares offered during the IPO. | [optional] 
-**total_shares_value** | **Integer** | Total shares value. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol. | [optional] |
+| **date** | **Date** | IPO date. | [optional] |
+| **exchange** | **String** | Exchange. | [optional] |
+| **name** | **String** | Company's name. | [optional] |
+| **status** | **String** | IPO status. Can take 1 of the following values: <code>expected</code>,<code>priced</code>,<code>withdrawn</code>,<code>filed</code> | [optional] |
+| **price** | **String** | Projected price or price range. | [optional] |
+| **number_of_shares** | **Float** | Number of shares offered during the IPO. | [optional] |
+| **total_shares_value** | **Float** | Total shares value. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'FinnhubRuby'
+require 'finnhub_ruby'
 
-instance = FinnhubRuby::IPOEvent.new(symbol: null,
-                                 date: null,
-                                 exchange: null,
-                                 name: null,
-                                 status: null,
-                                 price: null,
-                                 number_of_shares: null,
-                                 total_shares_value: null)
+instance = FinnhubRuby::IPOEvent.new(
+  symbol: null,
+  date: null,
+  exchange: null,
+  name: null,
+  status: null,
+  price: null,
+  number_of_shares: null,
+  total_shares_value: null
+)
 ```
 
-