finnhub_ruby 1.1.8 → 1.1.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +18 -4
  3. data/docs/CompanyESG.md +3 -3
  4. data/docs/CompanyEarningsQualityScore.md +22 -0
  5. data/docs/CompanyEarningsQualityScoreData.md +30 -0
  6. data/docs/CompanyProfile.md +4 -4
  7. data/docs/CountryMetadata.md +5 -1
  8. data/docs/CryptoProfile.md +38 -0
  9. data/docs/DefaultApi.md +391 -10
  10. data/docs/EbitEstimates.md +22 -0
  11. data/docs/EbitEstimatesInfo.md +26 -0
  12. data/docs/EbitdaEstimates.md +22 -0
  13. data/docs/EbitdaEstimatesInfo.md +26 -0
  14. data/docs/MutualFundProfileData.md +9 -1
  15. data/docs/StockSymbol.md +7 -1
  16. data/docs/Transactions.md +2 -0
  17. data/docs/UsptoPatent.md +34 -0
  18. data/docs/UsptoPatentResult.md +20 -0
  19. data/finnhub_ruby-1.1.10.gem +0 -0
  20. data/finnhub_ruby-1.1.11.gem +0 -0
  21. data/finnhub_ruby-1.1.8.gem +0 -0
  22. data/finnhub_ruby-1.1.9.gem +0 -0
  23. data/lib/finnhub_ruby/api/default_api.rb +361 -8
  24. data/lib/finnhub_ruby/models/company_earnings_quality_score.rb +241 -0
  25. data/lib/finnhub_ruby/models/company_earnings_quality_score_data.rb +279 -0
  26. data/lib/finnhub_ruby/models/company_esg.rb +3 -3
  27. data/lib/finnhub_ruby/models/company_profile.rb +4 -4
  28. data/lib/finnhub_ruby/models/country_metadata.rb +24 -4
  29. data/lib/finnhub_ruby/models/crypto_profile.rb +319 -0
  30. data/lib/finnhub_ruby/models/ebit_estimates.rb +241 -0
  31. data/lib/finnhub_ruby/models/ebit_estimates_info.rb +259 -0
  32. data/lib/finnhub_ruby/models/ebitda_estimates.rb +241 -0
  33. data/lib/finnhub_ruby/models/ebitda_estimates_info.rb +259 -0
  34. data/lib/finnhub_ruby/models/mutual_fund_profile_data.rb +44 -4
  35. data/lib/finnhub_ruby/models/stock_symbol.rb +34 -4
  36. data/lib/finnhub_ruby/models/transactions.rb +11 -1
  37. data/lib/finnhub_ruby/models/uspto_patent.rb +301 -0
  38. data/lib/finnhub_ruby/models/uspto_patent_result.rb +231 -0
  39. data/lib/finnhub_ruby/version.rb +1 -1
  40. data/lib/finnhub_ruby.rb +9 -0
  41. data/spec/models/company_earnings_quality_score_data_spec.rb +70 -0
  42. data/spec/models/company_earnings_quality_score_spec.rb +46 -0
  43. data/spec/models/crypto_profile_spec.rb +94 -0
  44. data/spec/models/ebit_estimates_info_spec.rb +58 -0
  45. data/spec/models/ebit_estimates_spec.rb +46 -0
  46. data/spec/models/ebitda_estimates_info_spec.rb +58 -0
  47. data/spec/models/ebitda_estimates_spec.rb +46 -0
  48. data/spec/models/uspto_patent_result_spec.rb +40 -0
  49. data/spec/models/uspto_patent_spec.rb +82 -0
  50. metadata +42 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 30d3bc7aee90a7d7aa1679fefc232458e9681cb90240381b21cac6851116f8bb
4
- data.tar.gz: ead3196677192f69af95c29591faef8aa7e63206389d98565bdddd934dd6c9ae
3
+ metadata.gz: 673dff85fca4569468c9266af247714554296a6417f18caa8fb652de5cd35ca3
4
+ data.tar.gz: '06890889ff4f66e2c4675ff20b7d9912dcaccff1172d28b6093c47e2f1e892df'
5
5
  SHA512:
6
- metadata.gz: bb000372cb7719457c08da2f8488ad6d10503eac8fe3851eba71d8f9a3e3a77f35a4623d2d4a65a19a0c28625b4894ea1b62377fe2daf03825fbab959e40584a
7
- data.tar.gz: 00ba23b45e29b9d879be159cdbc355ce48925a185dea9a50c26a5180fa1df839c1480f776bcfcbc511e2f7a19eb885925e2477fabf398cf748150abb51af26d6
6
+ metadata.gz: d30aefb33b9d6fc51c68fa17cea7fb700da02491e1280491f847664d8b337365168eac933cf27725cb4488094a08e0d68d4bbf454dfe1d43f6740e8e42acc563
7
+ data.tar.gz: b2f491a4a784874ef91512b8384ac1d855ff03780a4ffad62e045aa23fd69229a3157cadb1ebe8df093ce94fe7c3eeac5fbd8a13ef9c0dba90a86b1f1bcdad90
data/README.md CHANGED
@@ -1,7 +1,7 @@
1
1
  # finnhub-ruby
2
2
  - API documentation: https://finnhub.io/docs/api
3
3
  - API version: 1.0.0
4
- - Package version: 1.1.8
4
+ - Package version: 1.1.12
5
5
 
6
6
  ## Installation
7
7
  https://rubygems.org/gems/finnhub_ruby
@@ -13,7 +13,7 @@ gem install finnhub_ruby
13
13
  or in your Gemfile
14
14
 
15
15
  ```ruby
16
- gem 'finnhub_ruby', '~> 1.1.8'
16
+ gem 'finnhub_ruby', '~> 1.1.12'
17
17
  ```
18
18
 
19
19
  ## Getting Started
@@ -67,7 +67,6 @@ puts(finnhub_client.company_eps_estimates('AMZN', {freq: 'quarterly'}))
67
67
  puts(finnhub_client.company_executive('AAPL'))
68
68
 
69
69
  # Company News
70
- # Need to use _from instead of from to avoid conflict
71
70
  puts(finnhub_client.company_news('AAPL', "2020-06-01", "2020-06-10"))
72
71
 
73
72
  # Company Peers
@@ -187,7 +186,7 @@ puts(finnhub_client.forex_candles('OANDA:EUR_USD', 'D', 1590988249, 1591852249))
187
186
  puts(finnhub_client.crypto_candles('BINANCE:BTCUSDT', 'D', 1590988249, 1591852249))
188
187
 
189
188
  # Technical Indicator
190
- puts(finnhub_client.technical_indicator("AAPL", 'D', 1583098857, 1584308457, 'rsi', {"timeperiod": 3}))
189
+ puts(finnhub_client.technical_indicator("AAPL", 'D', 1583098857, 1584308457, 'rsi', {indicator_fields:{'timeperiod': 3}}))
191
190
 
192
191
  # Indices Constituents
193
192
  puts(finnhub_client.indices_constituents("^GSPC"))
@@ -240,6 +239,21 @@ puts(finnhub_client.fda_committee_meeting_calendar())
240
239
  # Company ESG
241
240
  puts(finnhub_client.company_esg_score('AAPL'))
242
241
 
242
+ # Company Earnings Quality
243
+ puts(finnhub_client.company_earnings_quality_score('AAPL', 'quarterly'))
244
+
245
+ # Crypto Profile
246
+ puts(finnhub_client.crypto_profile('BTC'))
247
+
248
+ # EBITDA Estimates
249
+ puts(finnhub_client.company_ebitda_estimates('AAPL', {freq: 'quarterly'}))
250
+
251
+ # EBIT Estimates
252
+ puts(finnhub_client.company_ebit_estimates('TSLA', {freq: 'quarterly'}))
253
+
254
+ # USPTO
255
+ puts(finnhub_client.stock_uspto_patent('NVDA', "2020-06-01", "2021-06-10"))
256
+
243
257
  ```
244
258
 
245
259
  ## License
data/docs/CompanyESG.md CHANGED
@@ -6,9 +6,9 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **symbol** | **String** | symbol | [optional] |
8
8
  | **total_esg_score** | **Float** | Total ESG Score | [optional] |
9
- | **environment_score** | **Float** | symbol | [optional] |
10
- | **governance_score** | **Float** | symbol | [optional] |
11
- | **social_score** | **Float** | symbol | [optional] |
9
+ | **environment_score** | **Float** | Environment Score | [optional] |
10
+ | **governance_score** | **Float** | Governance Score | [optional] |
11
+ | **social_score** | **Float** | Social Score | [optional] |
12
12
  | **data** | **Object** | | [optional] |
13
13
 
14
14
  ## Example
data/docs/CompanyEarningsQualityScore.md ADDED
@@ -0,0 +1,22 @@
1
+ # FinnhubRuby::CompanyEarningsQualityScore
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **symbol** | **String** | Symbol | [optional] |
8
+ | **freq** | **String** | Frequency | [optional] |
9
+ | **data** | [**Array<CompanyEarningsQualityScoreData>**](CompanyEarningsQualityScoreData.md) | Array of earnings quality score. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'finnhub_ruby'
15
+
16
+ instance = FinnhubRuby::CompanyEarningsQualityScore.new(
17
+ symbol: null,
18
+ freq: null,
19
+ data: null
20
+ )
21
+ ```
22
+
data/docs/CompanyEarningsQualityScoreData.md ADDED
@@ -0,0 +1,30 @@
1
+ # FinnhubRuby::CompanyEarningsQualityScoreData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **period** | **String** | Period | [optional] |
8
+ | **growth** | **Float** | Growth Score | [optional] |
9
+ | **profitability** | **Float** | Profitability Score | [optional] |
10
+ | **cash_generation_capital_allocation** | **Float** | Cash Generation and Capital Allocation | [optional] |
11
+ | **leverage** | **Float** | Leverage Score | [optional] |
12
+ | **score** | **Float** | Total Score | [optional] |
13
+ | **letter_score** | **String** | Letter Score | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'finnhub_ruby'
19
+
20
+ instance = FinnhubRuby::CompanyEarningsQualityScoreData.new(
21
+ period: null,
22
+ growth: null,
23
+ profitability: null,
24
+ cash_generation_capital_allocation: null,
25
+ leverage: null,
26
+ score: null,
27
+ letter_score: null
28
+ )
29
+ ```
30
+
data/docs/CompanyProfile.md CHANGED
@@ -12,10 +12,10 @@
12
12
  | **sedol** | **String** | Sedol number. | [optional] |
13
13
  | **description** | **String** | Company business summary. | [optional] |
14
14
  | **exchange** | **String** | Listed exchange. | [optional] |
15
- | **ggroup** | **String** | GICS industry group. | [optional] |
16
- | **gind** | **String** | GICS industry. | [optional] |
17
- | **gsector** | **String** | GICS sector. | [optional] |
18
- | **gsubind** | **String** | GICS sub-industry. | [optional] |
15
+ | **ggroup** | **String** | Industry group. | [optional] |
16
+ | **gind** | **String** | Industry. | [optional] |
17
+ | **gsector** | **String** | Sector. | [optional] |
18
+ | **gsubind** | **String** | Sub-industry. | [optional] |
19
19
  | **isin** | **String** | ISIN number. | [optional] |
20
20
  | **naics_national_industry** | **String** | NAICS national industry. | [optional] |
21
21
  | **naics** | **String** | NAICS industry. | [optional] |
data/docs/CountryMetadata.md CHANGED
@@ -10,6 +10,8 @@
10
10
  | **code_no** | **String** | UN code | [optional] |
11
11
  | **currency** | **String** | Currency name | [optional] |
12
12
  | **currency_code** | **String** | Currency code | [optional] |
13
+ | **region** | **String** | Region | [optional] |
14
+ | **sub_region** | **String** | Sub-Region | [optional] |
13
15
 
14
16
  ## Example
15
17
 
@@ -22,7 +24,9 @@ instance = FinnhubRuby::CountryMetadata.new(
22
24
  code3: null,
23
25
  code_no: null,
24
26
  currency: null,
25
- currency_code: null
27
+ currency_code: null,
28
+ region: null,
29
+ sub_region: null
26
30
  )
27
31
  ```
28
32
 
data/docs/CryptoProfile.md ADDED
@@ -0,0 +1,38 @@
1
+ # FinnhubRuby::CryptoProfile
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **long_name** | **String** | Long name. | [optional] |
8
+ | **name** | **String** | Name. | [optional] |
9
+ | **description** | **String** | Description. | [optional] |
10
+ | **website** | **String** | Project's website. | [optional] |
11
+ | **market_cap** | **Float** | Market capitalization. | [optional] |
12
+ | **total_supply** | **Float** | Total supply. | [optional] |
13
+ | **max_supply** | **Float** | Max supply. | [optional] |
14
+ | **circulating_supply** | **Float** | Circulating supply. | [optional] |
15
+ | **logo** | **String** | Logo image. | [optional] |
16
+ | **launch_date** | **String** | Launch date. | [optional] |
17
+ | **proof_type** | **String** | Proof type. | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'finnhub_ruby'
23
+
24
+ instance = FinnhubRuby::CryptoProfile.new(
25
+ long_name: null,
26
+ name: null,
27
+ description: null,
28
+ website: null,
29
+ market_cap: null,
30
+ total_supply: null,
31
+ max_supply: null,
32
+ circulating_supply: null,
33
+ logo: null,
34
+ launch_date: null,
35
+ proof_type: null
36
+ )
37
+ ```
38
+