finnhub_ruby 1.0.0

data/docs/Development.md

@@ -0,0 +1,23 @@
+# FinnhubRuby::Development
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**symbol** | **String** | Company symbol. | [optional] 
+**datetime** | **DateTime** | Published time in <code>YYYY-MM-DD HH:MM:SS</code> format. | [optional] 
+**headline** | **String** | Development headline. | [optional] 
+**description** | **String** | Development description. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::Development.new(symbol: null,
+                                 datetime: null,
+                                 headline: null,
+                                 description: null)
+```
+
+

data/docs/Dividends.md

@@ -0,0 +1,31 @@
+# FinnhubRuby::Dividends
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**symbol** | **String** | Symbol. | [optional] 
+**date** | **Date** | Ex-Dividend date. | [optional] 
+**amount** | **Float** | Amount in local currency. | [optional] 
+**adjusted_amount** | **Float** | Adjusted dividend. | [optional] 
+**pay_date** | **Date** | Pay date. | [optional] 
+**record_date** | **Date** | Record date. | [optional] 
+**declaration_date** | **Date** | Declaration date. | [optional] 
+**currency** | **String** | Currency. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::Dividends.new(symbol: null,
+                                 date: null,
+                                 amount: null,
+                                 adjusted_amount: null,
+                                 pay_date: null,
+                                 record_date: null,
+                                 declaration_date: null,
+                                 currency: null)
+```
+
+

data/docs/EarningEstimate.md

@@ -0,0 +1,25 @@
+# FinnhubRuby::EarningEstimate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**eps_avg** | **Float** | Average EPS estimates. | [optional] 
+**eps_high** | **Float** | Highest estimate. | [optional] 
+**eps_low** | **Float** | Lowest estimate. | [optional] 
+**number_analysts** | **Integer** | Number of Analysts. | [optional] 
+**period** | **Date** | Period. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::EarningEstimate.new(eps_avg: null,
+                                 eps_high: null,
+                                 eps_low: null,
+                                 number_analysts: null,
+                                 period: null)
+```
+
+

data/docs/EarningRelease.md

@@ -0,0 +1,33 @@
+# FinnhubRuby::EarningRelease
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**symbol** | **String** | Symbol. | [optional] 
+**date** | **Date** | Date. | [optional] 
+**hour** | **String** | Indicates whether the earnings is announced before market open(<code>bmo</code>), after market close(<code>amc</code>), or during market hour(<code>dmh</code>). | [optional] 
+**year** | **Integer** | Earnings year. | [optional] 
+**quarter** | **Integer** | Earnings quarter. | [optional] 
+**eps_estimate** | **Float** | EPS estimate. | [optional] 
+**eps_actual** | **Float** | EPS actual. | [optional] 
+**revenue_estimate** | **Integer** | Revenue estimate. | [optional] 
+**revenue_actual** | **Integer** | Revenue actual. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::EarningRelease.new(symbol: null,
+                                 date: null,
+                                 hour: null,
+                                 year: null,
+                                 quarter: null,
+                                 eps_estimate: null,
+                                 eps_actual: null,
+                                 revenue_estimate: null,
+                                 revenue_actual: null)
+```
+
+

data/docs/EarningResult.md

@@ -0,0 +1,23 @@
+# FinnhubRuby::EarningResult
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**actual** | **Float** | Actual earning result. | [optional] 
+**estimate** | **Float** | Estimated earning. | [optional] 
+**period** | **Date** | Reported period. | [optional] 
+**symbol** | **String** | Company symbol. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::EarningResult.new(actual: null,
+                                 estimate: null,
+                                 period: null,
+                                 symbol: null)
+```
+
+

data/docs/EarningsCalendar.md

@@ -0,0 +1,17 @@
+# FinnhubRuby::EarningsCalendar
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**earnings_calendar** | **Array<Object>** | Array of earnings release. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::EarningsCalendar.new(earnings_calendar: null)
+```
+
+

data/docs/EarningsCallTranscripts.md

@@ -0,0 +1,33 @@
+# FinnhubRuby::EarningsCallTranscripts
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**symbol** | **String** | Company symbol. | [optional] 
+**transcript** | **Array<Object>** | Transcript content. | [optional] 
+**participant** | **Array<Object>** | Participant list | [optional] 
+**audio** | **String** | Audio link. | [optional] 
+**id** | **String** | Transcript's ID. | [optional] 
+**title** | **String** | Title. | [optional] 
+**time** | **DateTime** | 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] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::EarningsCallTranscripts.new(symbol: null,
+                                 transcript: null,
+                                 participant: null,
+                                 audio: null,
+                                 id: null,
+                                 title: null,
+                                 time: null,
+                                 year: null,
+                                 quarter: null)
+```
+
+

data/docs/EarningsCallTranscriptsList.md

@@ -0,0 +1,19 @@
+# FinnhubRuby::EarningsCallTranscriptsList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**symbol** | **String** | Company symbol. | [optional] 
+**transcripts** | **Array<Object>** | Array of transcripts' metadata | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::EarningsCallTranscriptsList.new(symbol: null,
+                                 transcripts: null)
+```
+
+

data/docs/EarningsEstimates.md

@@ -0,0 +1,21 @@
+# FinnhubRuby::EarningsEstimates
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | **Array<Object>** | List of estimates | [optional] 
+**freq** | **String** | Frequency: annual or quarterly. | [optional] 
+**symbol** | **String** | Company symbol. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::EarningsEstimates.new(data: null,
+                                 freq: null,
+                                 symbol: null)
+```
+
+

data/docs/EconomicCalendar.md

@@ -0,0 +1,17 @@
+# FinnhubRuby::EconomicCalendar
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**economic_calendar** | **Array<Object>** | Array of economic events. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::EconomicCalendar.new(economic_calendar: null)
+```
+
+

data/docs/EconomicCode.md

@@ -0,0 +1,23 @@
+# FinnhubRuby::EconomicCode
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | Finnhub economic code used to get historical data | [optional] 
+**country** | **String** | Country | [optional] 
+**name** | **String** | Indicator name | [optional] 
+**unit** | **String** | Unit | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::EconomicCode.new(code: null,
+                                 country: null,
+                                 name: null,
+                                 unit: null)
+```
+
+

data/docs/EconomicData.md

@@ -0,0 +1,19 @@
+# FinnhubRuby::EconomicData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | **Array<Object>** | Array of economic data for requested code. | [optional] 
+**code** | **String** | Finnhub economic code | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::EconomicData.new(data: null,
+                                 code: null)
+```
+
+

data/docs/EconomicEvent.md

@@ -0,0 +1,31 @@
+# FinnhubRuby::EconomicEvent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**actual** | **Float** | Actual release | [optional] 
+**prev** | **Float** | Previous release | [optional] 
+**country** | **String** | Country | [optional] 
+**unit** | **String** | Unit | [optional] 
+**estimate** | **Float** | Estimate | [optional] 
+**event** | **String** | Event | [optional] 
+**impact** | **String** | Impact level | [optional] 
+**time** | **String** | Release time | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::EconomicEvent.new(actual: null,
+                                 prev: null,
+                                 country: null,
+                                 unit: null,
+                                 estimate: null,
+                                 event: null,
+                                 impact: null,
+                                 time: null)
+```
+
+

data/docs/Estimate.md

@@ -0,0 +1,25 @@
+# FinnhubRuby::Estimate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**revenue_avg** | **Integer** | Average revenue estimates. | [optional] 
+**revenue_high** | **Integer** | Highest estimate. | [optional] 
+**revenue_low** | **Integer** | Lowest estimate. | [optional] 
+**number_analysts** | **Integer** | Number of Analysts. | [optional] 
+**period** | **Date** | Period. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::Estimate.new(revenue_avg: null,
+                                 revenue_high: null,
+                                 revenue_low: null,
+                                 number_analysts: null,
+                                 period: null)
+```
+
+

data/docs/Filing.md

@@ -0,0 +1,31 @@
+# FinnhubRuby::Filing
+
+## 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] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+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/FinancialStatements.md

@@ -0,0 +1,19 @@
+# FinnhubRuby::FinancialStatements
+
+## 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] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::FinancialStatements.new(symbol: null,
+                                 financials: null)
+```
+
+

data/docs/FinancialsAsReported.md

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

data/docs/ForexCandles.md

@@ -0,0 +1,29 @@
+# FinnhubRuby::ForexCandles
+
+## 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] 
+
+## Code Sample
+
+```ruby
+require 'FinnhubRuby'
+
+instance = FinnhubRuby::ForexCandles.new(o: null,
+                                 h: null,
+                                 l: null,
+                                 c: null,
+                                 v: null,
+                                 t: null,
+                                 s: null)
+```
+
+