finnhub_ruby 1.1.17 → 1.1.18

Sign up to get free protection for your applications and to get access to all the features.
Files changed (52) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/docs/BondTickData.md +34 -0
  4. data/docs/DefaultApi.md +543 -7
  5. data/docs/ETFProfileData.md +8 -2
  6. data/docs/InstitutionalOwnership.md +22 -0
  7. data/docs/InstitutionalOwnershipGroup.md +20 -0
  8. data/docs/InstitutionalOwnershipInfo.md +36 -0
  9. data/docs/InstitutionalPortfolio.md +22 -0
  10. data/docs/InstitutionalPortfolioGroup.md +22 -0
  11. data/docs/InstitutionalPortfolioInfo.md +38 -0
  12. data/docs/InstitutionalProfile.md +20 -0
  13. data/docs/InstitutionalProfileInfo.md +28 -0
  14. data/docs/IsinChange.md +22 -0
  15. data/docs/IsinChangeInfo.md +22 -0
  16. data/docs/PriceMetrics.md +20 -0
  17. data/docs/SymbolChange.md +22 -0
  18. data/docs/SymbolChangeInfo.md +22 -0
  19. data/finnhub_ruby-1.1.17.gem +0 -0
  20. data/lib/finnhub_ruby/api/default_api.rb +534 -4
  21. data/lib/finnhub_ruby/models/bond_tick_data.rb +311 -0
  22. data/lib/finnhub_ruby/models/etf_profile_data.rb +35 -5
  23. data/lib/finnhub_ruby/models/institutional_ownership.rb +241 -0
  24. data/lib/finnhub_ruby/models/institutional_ownership_group.rb +231 -0
  25. data/lib/finnhub_ruby/models/institutional_ownership_info.rb +309 -0
  26. data/lib/finnhub_ruby/models/institutional_portfolio.rb +241 -0
  27. data/lib/finnhub_ruby/models/institutional_portfolio_group.rb +241 -0
  28. data/lib/finnhub_ruby/models/institutional_portfolio_info.rb +319 -0
  29. data/lib/finnhub_ruby/models/institutional_profile.rb +231 -0
  30. data/lib/finnhub_ruby/models/institutional_profile_info.rb +269 -0
  31. data/lib/finnhub_ruby/models/isin_change.rb +241 -0
  32. data/lib/finnhub_ruby/models/isin_change_info.rb +239 -0
  33. data/lib/finnhub_ruby/models/price_metrics.rb +228 -0
  34. data/lib/finnhub_ruby/models/symbol_change.rb +241 -0
  35. data/lib/finnhub_ruby/models/symbol_change_info.rb +239 -0
  36. data/lib/finnhub_ruby/version.rb +1 -1
  37. data/lib/finnhub_ruby.rb +14 -0
  38. data/spec/models/bond_tick_data_spec.rb +82 -0
  39. data/spec/models/institutional_ownership_group_spec.rb +40 -0
  40. data/spec/models/institutional_ownership_info_spec.rb +88 -0
  41. data/spec/models/institutional_ownership_spec.rb +46 -0
  42. data/spec/models/institutional_portfolio_group_spec.rb +46 -0
  43. data/spec/models/institutional_portfolio_info_spec.rb +94 -0
  44. data/spec/models/institutional_portfolio_spec.rb +46 -0
  45. data/spec/models/institutional_profile_info_spec.rb +64 -0
  46. data/spec/models/institutional_profile_spec.rb +40 -0
  47. data/spec/models/isin_change_info_spec.rb +46 -0
  48. data/spec/models/isin_change_spec.rb +46 -0
  49. data/spec/models/price_metrics_spec.rb +40 -0
  50. data/spec/models/symbol_change_info_spec.rb +46 -0
  51. data/spec/models/symbol_change_spec.rb +46 -0
  52. metadata +59 -2
data/docs/InstitutionalOwnership.md ADDED
@@ -0,0 +1,22 @@
1
+ # FinnhubRuby::InstitutionalOwnership
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **symbol** | **String** | Symbol. | [optional] |
8
+ | **cusip** | **String** | Cusip. | [optional] |
9
+ | **data** | [**Array<InstitutionalOwnershipGroup>**](InstitutionalOwnershipGroup.md) | Array of institutional investors. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'finnhub_ruby'
15
+
16
+ instance = FinnhubRuby::InstitutionalOwnership.new(
17
+ symbol: null,
18
+ cusip: null,
19
+ data: null
20
+ )
21
+ ```
22
+
data/docs/InstitutionalOwnershipGroup.md ADDED
@@ -0,0 +1,20 @@
1
+ # FinnhubRuby::InstitutionalOwnershipGroup
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **report_date** | **String** | Report date. | [optional] |
8
+ | **ownership** | [**Array<InstitutionalOwnershipInfo>**](InstitutionalOwnershipInfo.md) | Array of institutional investors. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'finnhub_ruby'
14
+
15
+ instance = FinnhubRuby::InstitutionalOwnershipGroup.new(
16
+ report_date: null,
17
+ ownership: null
18
+ )
19
+ ```
20
+
data/docs/InstitutionalOwnershipInfo.md ADDED
@@ -0,0 +1,36 @@
1
+ # FinnhubRuby::InstitutionalOwnershipInfo
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **cik** | **String** | Investor's company CIK. | [optional] |
8
+ | **name** | **String** | Firm's name. | [optional] |
9
+ | **put_call** | **String** | <code>put</code> or <code>call</code> for options. | [optional] |
10
+ | **change** | **Float** | Number of shares change. | [optional] |
11
+ | **no_voting** | **Float** | Number of shares with no voting rights. | [optional] |
12
+ | **percentage** | **Float** | Percentage of portfolio. | [optional] |
13
+ | **share** | **Float** | News score. | [optional] |
14
+ | **shared_voting** | **Float** | Number of shares with shared voting rights. | [optional] |
15
+ | **sole_voting** | **Float** | Number of shares with sole voting rights. | [optional] |
16
+ | **value** | **Float** | Position value. | [optional] |
17
+
18
+ ## Example
19
+
20
+ ```ruby
21
+ require 'finnhub_ruby'
22
+
23
+ instance = FinnhubRuby::InstitutionalOwnershipInfo.new(
24
+ cik: null,
25
+ name: null,
26
+ put_call: null,
27
+ change: null,
28
+ no_voting: null,
29
+ percentage: null,
30
+ share: null,
31
+ shared_voting: null,
32
+ sole_voting: null,
33
+ value: null
34
+ )
35
+ ```
36
+
data/docs/InstitutionalPortfolio.md ADDED
@@ -0,0 +1,22 @@
1
+ # FinnhubRuby::InstitutionalPortfolio
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Investor's name. | [optional] |
8
+ | **cik** | **String** | CIK. | [optional] |
9
+ | **data** | [**Array<InstitutionalPortfolioGroup>**](InstitutionalPortfolioGroup.md) | Array of positions. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'finnhub_ruby'
15
+
16
+ instance = FinnhubRuby::InstitutionalPortfolio.new(
17
+ name: null,
18
+ cik: null,
19
+ data: null
20
+ )
21
+ ```
22
+
data/docs/InstitutionalPortfolioGroup.md ADDED
@@ -0,0 +1,22 @@
1
+ # FinnhubRuby::InstitutionalPortfolioGroup
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **report_date** | **String** | Report date. | [optional] |
8
+ | **filing_date** | **String** | Filing date. | [optional] |
9
+ | **portfolio** | [**Array<InstitutionalPortfolioInfo>**](InstitutionalPortfolioInfo.md) | Array of positions. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'finnhub_ruby'
15
+
16
+ instance = FinnhubRuby::InstitutionalPortfolioGroup.new(
17
+ report_date: null,
18
+ filing_date: null,
19
+ portfolio: null
20
+ )
21
+ ```
22
+
data/docs/InstitutionalPortfolioInfo.md ADDED
@@ -0,0 +1,38 @@
1
+ # FinnhubRuby::InstitutionalPortfolioInfo
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **symbol** | **String** | Symbol. | [optional] |
8
+ | **cusip** | **String** | CUSIP. | [optional] |
9
+ | **name** | **String** | Position's name. | [optional] |
10
+ | **put_call** | **String** | <code>put</code> or <code>call</code> for options. | [optional] |
11
+ | **change** | **Float** | Number of shares change. | [optional] |
12
+ | **no_voting** | **Float** | Number of shares with no voting rights. | [optional] |
13
+ | **percentage** | **Float** | Percentage of portfolio. | [optional] |
14
+ | **share** | **Float** | Number of shares. | [optional] |
15
+ | **shared_voting** | **Float** | Number of shares with shared voting rights. | [optional] |
16
+ | **sole_voting** | **Float** | Number of shares with sole voting rights. | [optional] |
17
+ | **value** | **Float** | Position value. | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'finnhub_ruby'
23
+
24
+ instance = FinnhubRuby::InstitutionalPortfolioInfo.new(
25
+ symbol: null,
26
+ cusip: null,
27
+ name: null,
28
+ put_call: null,
29
+ change: null,
30
+ no_voting: null,
31
+ percentage: null,
32
+ share: null,
33
+ shared_voting: null,
34
+ sole_voting: null,
35
+ value: null
36
+ )
37
+ ```
38
+
data/docs/InstitutionalProfile.md ADDED
@@ -0,0 +1,20 @@
1
+ # FinnhubRuby::InstitutionalProfile
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **cik** | **String** | CIK. | [optional] |
8
+ | **data** | [**Array<InstitutionalProfileInfo>**](InstitutionalProfileInfo.md) | Array of investors. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'finnhub_ruby'
14
+
15
+ instance = FinnhubRuby::InstitutionalProfile.new(
16
+ cik: null,
17
+ data: null
18
+ )
19
+ ```
20
+
data/docs/InstitutionalProfileInfo.md ADDED
@@ -0,0 +1,28 @@
1
+ # FinnhubRuby::InstitutionalProfileInfo
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **cik** | **String** | Investor's company CIK. | [optional] |
8
+ | **firm_type** | **String** | Firm type. | [optional] |
9
+ | **manager** | **String** | Manager. | [optional] |
10
+ | **philosophy** | **String** | Investing philosophy. | [optional] |
11
+ | **profile** | **String** | Profile info. | [optional] |
12
+ | **profile_img** | **String** | Profile image. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'finnhub_ruby'
18
+
19
+ instance = FinnhubRuby::InstitutionalProfileInfo.new(
20
+ cik: null,
21
+ firm_type: null,
22
+ manager: null,
23
+ philosophy: null,
24
+ profile: null,
25
+ profile_img: null
26
+ )
27
+ ```
28
+
data/docs/IsinChange.md ADDED
@@ -0,0 +1,22 @@
1
+ # FinnhubRuby::IsinChange
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **from_date** | **String** | From date. | [optional] |
8
+ | **to_date** | **String** | To date. | [optional] |
9
+ | **data** | [**Array<IsinChangeInfo>**](IsinChangeInfo.md) | Array of ISIN change events. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'finnhub_ruby'
15
+
16
+ instance = FinnhubRuby::IsinChange.new(
17
+ from_date: null,
18
+ to_date: null,
19
+ data: null
20
+ )
21
+ ```
22
+
data/docs/IsinChangeInfo.md ADDED
@@ -0,0 +1,22 @@
1
+ # FinnhubRuby::IsinChangeInfo
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **at_date** | **String** | Event's date. | [optional] |
8
+ | **old_isin** | **String** | Old ISIN. | [optional] |
9
+ | **new_isin** | **String** | New ISIN. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'finnhub_ruby'
15
+
16
+ instance = FinnhubRuby::IsinChangeInfo.new(
17
+ at_date: null,
18
+ old_isin: null,
19
+ new_isin: null
20
+ )
21
+ ```
22
+
data/docs/PriceMetrics.md ADDED
@@ -0,0 +1,20 @@
1
+ # FinnhubRuby::PriceMetrics
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **symbol** | **String** | Symbol of the company. | [optional] |
8
+ | **data** | **Object** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'finnhub_ruby'
14
+
15
+ instance = FinnhubRuby::PriceMetrics.new(
16
+ symbol: null,
17
+ data: null
18
+ )
19
+ ```
20
+
data/docs/SymbolChange.md ADDED
@@ -0,0 +1,22 @@
1
+ # FinnhubRuby::SymbolChange
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **from_date** | **String** | From date. | [optional] |
8
+ | **to_date** | **String** | To date. | [optional] |
9
+ | **data** | [**Array<SymbolChangeInfo>**](SymbolChangeInfo.md) | Array of symbol change events. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'finnhub_ruby'
15
+
16
+ instance = FinnhubRuby::SymbolChange.new(
17
+ from_date: null,
18
+ to_date: null,
19
+ data: null
20
+ )
21
+ ```
22
+
data/docs/SymbolChangeInfo.md ADDED
@@ -0,0 +1,22 @@
1
+ # FinnhubRuby::SymbolChangeInfo
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **at_date** | **String** | Event's date. | [optional] |
8
+ | **old_symbol** | **String** | Old symbol. | [optional] |
9
+ | **new_symbol** | **String** | New symbol. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'finnhub_ruby'
15
+
16
+ instance = FinnhubRuby::SymbolChangeInfo.new(
17
+ at_date: null,
18
+ old_symbol: null,
19
+ new_symbol: null
20
+ )
21
+ ```
22
+
data/finnhub_ruby-1.1.17.gem ADDED
Binary file