finnhub_ruby 1.1.2 → 1.1.7

data/docs/IndexHistoricalConstituent.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**symbol** | **String** | Symbol | [optional] 
-**action** | **String** | <code>add</code> or <code>remove</code>. | [optional] 
-**date** | **Date** | Date of joining or leaving the index. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol | [optional] |
+| **action** | **String** | <code>add</code> or <code>remove</code>. | [optional] |
+| **date** | **Date** | Date of joining or leaving the index. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'FinnhubRuby'
+require 'finnhub_ruby'
 
-instance = FinnhubRuby::IndexHistoricalConstituent.new(symbol: null,
-                                 action: null,
-                                 date: null)
+instance = FinnhubRuby::IndexHistoricalConstituent.new(
+  symbol: null,
+  action: null,
+  date: null
+)
 ```
 
-

data/docs/Indicator.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**buy** | **Integer** | Number of buy signals | [optional] 
-**neutral** | **Integer** | Number of neutral signals | [optional] 
-**sell** | **Integer** | Number of sell signals | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **buy** | **Integer** | Number of buy signals | [optional] |
+| **neutral** | **Integer** | Number of neutral signals | [optional] |
+| **sell** | **Integer** | Number of sell signals | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'FinnhubRuby'
+require 'finnhub_ruby'
 
-instance = FinnhubRuby::Indicator.new(buy: null,
-                                 neutral: null,
-                                 sell: null)
+instance = FinnhubRuby::Indicator.new(
+  buy: null,
+  neutral: null,
+  sell: null
+)
 ```
 
-

data/docs/IndicesConstituents.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**symbol** | **String** | Index's symbol. | [optional] 
-**constituents** | **Array<String>** | Array of constituents. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Index's symbol. | [optional] |
+| **constituents** | **Array<String>** | Array of constituents. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'FinnhubRuby'
+require 'finnhub_ruby'
 
-instance = FinnhubRuby::IndicesConstituents.new(symbol: null,
-                                 constituents: null)
+instance = FinnhubRuby::IndicesConstituents.new(
+  symbol: null,
+  constituents: null
+)
 ```
 
-

data/docs/IndicesHistoricalConstituents.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**symbol** | **String** | Index's symbol. | [optional] 
-**historical_constituents** | **Array<Object>** | Array of historical constituents. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Index's symbol. | [optional] |
+| **historical_constituents** | [**Array<IndexHistoricalConstituent>**](IndexHistoricalConstituent.md) | Array of historical constituents. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'FinnhubRuby'
+require 'finnhub_ruby'
 
-instance = FinnhubRuby::IndicesHistoricalConstituents.new(symbol: null,
-                                 historical_constituents: null)
+instance = FinnhubRuby::IndicesHistoricalConstituents.new(
+  symbol: null,
+  historical_constituents: null
+)
 ```
 
-

data/docs/InsiderTransactions.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::InsiderTransactions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol of the company. | [optional] |
+| **data** | [**Array<Transactions>**](Transactions.md) | Array of insider transactions. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::InsiderTransactions.new(
+  symbol: null,
+  data: null
+)
+```
+

data/docs/InternationalFiling.md

@@ -0,0 +1,34 @@
+# FinnhubRuby::InternationalFiling
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol. | [optional] |
+| **company_name** | **String** | Company name. | [optional] |
+| **filed_date** | **String** | Filed date <code>%Y-%m-%d %H:%M:%S</code>. | [optional] |
+| **category** | **String** | Category. | [optional] |
+| **title** | **String** | Document's title. | [optional] |
+| **description** | **String** | Document's description. | [optional] |
+| **url** | **String** | Url. | [optional] |
+| **language** | **String** | Language. | [optional] |
+| **country** | **String** | Country. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::InternationalFiling.new(
+  symbol: null,
+  company_name: null,
+  filed_date: null,
+  category: null,
+  title: null,
+  description: null,
+  url: null,
+  language: null,
+  country: null
+)
+```
+

data/docs/InvestmentThemePortfolio.md

@@ -0,0 +1,18 @@
+# FinnhubRuby::InvestmentThemePortfolio
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::InvestmentThemePortfolio.new(
+  symbol: null
+)
+```
+

data/docs/InvestmentThemes.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::InvestmentThemes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **theme** | **String** | Investment theme | [optional] |
+| **data** | [**Array<InvestmentThemePortfolio>**](InvestmentThemePortfolio.md) | Investment theme portfolio. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::InvestmentThemes.new(
+  theme: null,
+  data: null
+)
+```
+

data/docs/KeyCustomersSuppliers.md

@@ -0,0 +1,24 @@
+# FinnhubRuby::KeyCustomersSuppliers
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol | [optional] |
+| **name** | **String** | Name | [optional] |
+| **customer** | **Boolean** | Whether the company is a customer. | [optional] |
+| **supplier** | **Boolean** | Whether the company is a supplier | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::KeyCustomersSuppliers.new(
+  symbol: null,
+  name: null,
+  customer: null,
+  supplier: null
+)
+```
+

data/docs/LastBidAsk.md

@@ -2,24 +2,25 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**b** | **Float** | Bid price. | [optional] 
-**a** | **Float** | Ask price. | [optional] 
-**bv** | **Float** | Bid volume. | [optional] 
-**av** | **Float** | Ask volume. | [optional] 
-**t** | **Integer** | Reference UNIX timestamp in ms. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **b** | **Float** | Bid price. | [optional] |
+| **a** | **Float** | Ask price. | [optional] |
+| **bv** | **Float** | Bid volume. | [optional] |
+| **av** | **Float** | Ask volume. | [optional] |
+| **t** | **Integer** | Reference UNIX timestamp in ms. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'FinnhubRuby'
+require 'finnhub_ruby'
 
-instance = FinnhubRuby::LastBidAsk.new(b: null,
-                                 a: null,
-                                 bv: null,
-                                 av: null,
-                                 t: null)
+instance = FinnhubRuby::LastBidAsk.new(
+  b: null,
+  a: null,
+  bv: null,
+  av: null,
+  t: null
+)
 ```
 
-

data/docs/MarketNews.md

@@ -0,0 +1,34 @@
+# FinnhubRuby::MarketNews
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **category** | **String** | News category. | [optional] |
+| **datetime** | **Integer** | Published time in UNIX timestamp. | [optional] |
+| **headline** | **String** | News headline. | [optional] |
+| **id** | **Integer** | News ID. This value can be used for <code>minId</code> params to get the latest news only. | [optional] |
+| **image** | **String** | Thumbnail image URL. | [optional] |
+| **related** | **String** | Related stocks and companies mentioned in the article. | [optional] |
+| **source** | **String** | News source. | [optional] |
+| **summary** | **String** | News summary. | [optional] |
+| **url** | **String** | URL of the original article. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::MarketNews.new(
+  category: null,
+  datetime: null,
+  headline: null,
+  id: null,
+  image: null,
+  related: null,
+  source: null,
+  summary: null,
+  url: null
+)
+```
+

data/docs/MutualFundCountryExposure.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::MutualFundCountryExposure
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol. | [optional] |
+| **country_exposure** | [**Array<MutualFundCountryExposureData>**](MutualFundCountryExposureData.md) | Array of countries and and exposure levels. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::MutualFundCountryExposure.new(
+  symbol: null,
+  country_exposure: null
+)
+```
+

data/docs/MutualFundCountryExposureData.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::MutualFundCountryExposureData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **country** | **String** | Country | [optional] |
+| **exposure** | **Float** | Percent of exposure. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::MutualFundCountryExposureData.new(
+  country: null,
+  exposure: null
+)
+```
+

data/docs/MutualFundHoldings.md

@@ -0,0 +1,24 @@
+# FinnhubRuby::MutualFundHoldings
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol. | [optional] |
+| **at_date** | **Date** | Holdings update date. | [optional] |
+| **number_of_holdings** | **Integer** | Number of holdings. | [optional] |
+| **holdings** | [**Array<MutualFundHoldingsData>**](MutualFundHoldingsData.md) | Array of holdings. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::MutualFundHoldings.new(
+  symbol: null,
+  at_date: null,
+  number_of_holdings: null,
+  holdings: null
+)
+```
+

data/docs/MutualFundHoldingsData.md

@@ -0,0 +1,30 @@
+# FinnhubRuby::MutualFundHoldingsData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol description | [optional] |
+| **name** | **String** | Security name | [optional] |
+| **isin** | **String** | ISIN. | [optional] |
+| **cusip** | **String** | CUSIP. | [optional] |
+| **share** | **Float** | Number of shares. | [optional] |
+| **percent** | **Float** | Portfolio's percent | [optional] |
+| **value** | **Float** | Market value | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::MutualFundHoldingsData.new(
+  symbol: null,
+  name: null,
+  isin: null,
+  cusip: null,
+  share: null,
+  percent: null,
+  value: null
+)
+```
+

data/docs/MutualFundProfile.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::MutualFundProfile
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol. | [optional] |
+| **profile** | [**MutualFundProfileData**](MutualFundProfileData.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::MutualFundProfile.new(
+  symbol: null,
+  profile: null
+)
+```
+