finnhub_ruby 1.1.2 → 1.1.4

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 (237) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +42 -12
  3. data/docs/AggregateIndicators.md +10 -9
  4. data/docs/BasicFinancials.md +14 -11
  5. data/docs/BreakdownItem.md +20 -0
  6. data/docs/Company.md +20 -19
  7. data/docs/CompanyExecutive.md +10 -9
  8. data/docs/CompanyNewsStatistics.md +12 -11
  9. data/docs/CompanyProfile.md +62 -61
  10. data/docs/CompanyProfile2.md +30 -29
  11. data/docs/CountryMetadata.md +18 -17
  12. data/docs/CovidInfo.md +14 -13
  13. data/docs/CryptoCandles.md +20 -19
  14. data/docs/CryptoSymbol.md +12 -11
  15. data/docs/DefaultApi.md +2927 -891
  16. data/docs/Development.md +16 -13
  17. data/docs/Dividends.md +22 -21
  18. data/docs/Dividends2Basic.md +20 -0
  19. data/docs/ETFCountryExposureData.md +10 -9
  20. data/docs/ETFHoldingsData.md +20 -11
  21. data/docs/ETFProfileData.md +52 -0
  22. data/docs/ETFSectorExposureData.md +10 -9
  23. data/docs/ETFsCountryExposure.md +10 -9
  24. data/docs/ETFsHoldings.md +14 -9
  25. data/docs/ETFsProfile.md +10 -9
  26. data/docs/ETFsSectorExposure.md +20 -0
  27. data/docs/EarningEstimate.md +16 -15
  28. data/docs/EarningRelease.md +24 -23
  29. data/docs/EarningResult.md +18 -13
  30. data/docs/EarningsCalendar.md +8 -7
  31. data/docs/EarningsCallTranscripts.md +24 -23
  32. data/docs/EarningsCallTranscriptsList.md +10 -9
  33. data/docs/EarningsEstimates.md +12 -11
  34. data/docs/EconomicCalendar.md +8 -7
  35. data/docs/EconomicCode.md +14 -13
  36. data/docs/EconomicData.md +10 -9
  37. data/docs/EconomicEvent.md +22 -21
  38. data/docs/Estimate.md +16 -15
  39. data/docs/FDAComitteeMeeting.md +24 -0
  40. data/docs/Filing.md +22 -21
  41. data/docs/FilingSentiment.md +34 -0
  42. data/docs/FinancialStatements.md +10 -9
  43. data/docs/FinancialsAsReported.md +12 -11
  44. data/docs/ForexCandles.md +20 -19
  45. data/docs/ForexSymbol.md +12 -11
  46. data/docs/Forexrates.md +10 -9
  47. data/docs/FundOwnership.md +10 -9
  48. data/docs/HistoricalNBBO.md +40 -0
  49. data/docs/IPOCalendar.md +8 -7
  50. data/docs/IPOEvent.md +22 -21
  51. data/docs/IndexHistoricalConstituent.md +12 -11
  52. data/docs/Indicator.md +12 -11
  53. data/docs/IndicesConstituents.md +10 -9
  54. data/docs/IndicesHistoricalConstituents.md +10 -9
  55. data/docs/InsiderTransactions.md +20 -0
  56. data/docs/InternationalFiling.md +34 -0
  57. data/docs/InvestmentThemePortfolio.md +18 -0
  58. data/docs/InvestmentThemesThematicInvesting.md +20 -0
  59. data/docs/Investor.md +14 -13
  60. data/docs/KeyCustomersSuppliers.md +24 -0
  61. data/docs/LastBidAsk.md +16 -15
  62. data/docs/MajorPressReleases.md +20 -0
  63. data/docs/MutualFundCountryExposureData.md +20 -0
  64. data/docs/MutualFundSectorExposure.md +20 -0
  65. data/docs/MutualFundSectorExposureData.md +20 -0
  66. data/docs/MutualFundsCountryExposure.md +20 -0
  67. data/docs/MutualFundsHoldings.md +24 -0
  68. data/docs/MutualFundsProfile.md +20 -0
  69. data/docs/News.md +24 -23
  70. data/docs/NewsSentiment.md +18 -17
  71. data/docs/Ownership.md +20 -0
  72. data/docs/PatternRecognition.md +8 -7
  73. data/docs/PriceTarget.md +18 -17
  74. data/docs/Quote.md +20 -15
  75. data/docs/RecommendationTrend.md +20 -19
  76. data/docs/RedditSentimentContent.md +30 -0
  77. data/docs/Report.md +28 -27
  78. data/docs/RevenueBreakdown.md +22 -0
  79. data/docs/RevenueEstimates.md +12 -11
  80. data/docs/SECSentimentAnalysis.md +24 -0
  81. data/docs/Sentiment.md +10 -9
  82. data/docs/SimilarityIndex.md +12 -11
  83. data/docs/SocialSentiment.md +22 -0
  84. data/docs/Split.md +14 -13
  85. data/docs/Stock.md +14 -15
  86. data/docs/StockCandles.md +20 -19
  87. data/docs/StockTranscripts.md +16 -15
  88. data/docs/SupplyChainRelationships.md +20 -0
  89. data/docs/SupportResistance.md +8 -7
  90. data/docs/SymbolLookup.md +20 -0
  91. data/docs/TechnicalAnalysis.md +10 -9
  92. data/docs/TickData.md +24 -21
  93. data/docs/Transactions.md +30 -0
  94. data/docs/TranscriptContent.md +12 -9
  95. data/docs/TranscriptParticipant.md +12 -9
  96. data/docs/Trend.md +10 -9
  97. data/docs/TwitterSentimentContent.md +30 -0
  98. data/docs/UpgradeDowngrade.md +18 -17
  99. data/finnhub_ruby.gemspec +7 -8
  100. data/lib/finnhub_ruby.rb +32 -7
  101. data/lib/finnhub_ruby/api/default_api.rb +1514 -466
  102. data/lib/finnhub_ruby/api_client.rb +52 -49
  103. data/lib/finnhub_ruby/api_error.rb +1 -1
  104. data/lib/finnhub_ruby/configuration.rb +39 -10
  105. data/lib/finnhub_ruby/models/aggregate_indicators.rb +19 -7
  106. data/lib/finnhub_ruby/models/basic_financials.rb +29 -8
  107. data/lib/finnhub_ruby/models/breakdown_item.rb +228 -0
  108. data/lib/finnhub_ruby/models/company.rb +19 -7
  109. data/lib/finnhub_ruby/models/company_executive.rb +19 -7
  110. data/lib/finnhub_ruby/models/company_news_statistics.rb +19 -7
  111. data/lib/finnhub_ruby/models/company_profile.rb +19 -7
  112. data/lib/finnhub_ruby/models/company_profile2.rb +19 -7
  113. data/lib/finnhub_ruby/models/country_metadata.rb +19 -7
  114. data/lib/finnhub_ruby/models/covid_info.rb +20 -8
  115. data/lib/finnhub_ruby/models/crypto_candles.rb +19 -7
  116. data/lib/finnhub_ruby/models/crypto_symbol.rb +19 -7
  117. data/lib/finnhub_ruby/models/development.rb +34 -12
  118. data/lib/finnhub_ruby/models/dividends.rb +19 -7
  119. data/lib/finnhub_ruby/models/dividends2_basic.rb +231 -0
  120. data/lib/finnhub_ruby/models/earning_estimate.rb +20 -8
  121. data/lib/finnhub_ruby/models/earning_release.rb +20 -8
  122. data/lib/finnhub_ruby/models/earning_result.rb +40 -8
  123. data/lib/finnhub_ruby/models/earnings_calendar.rb +19 -7
  124. data/lib/finnhub_ruby/models/earnings_call_transcripts.rb +20 -8
  125. data/lib/finnhub_ruby/models/earnings_call_transcripts_list.rb +19 -7
  126. data/lib/finnhub_ruby/models/earnings_estimates.rb +19 -7
  127. data/lib/finnhub_ruby/models/economic_calendar.rb +19 -7
  128. data/lib/finnhub_ruby/models/economic_code.rb +19 -7
  129. data/lib/finnhub_ruby/models/economic_data.rb +19 -7
  130. data/lib/finnhub_ruby/models/economic_event.rb +19 -7
  131. data/lib/finnhub_ruby/models/estimate.rb +20 -8
  132. data/lib/finnhub_ruby/models/etf_country_exposure_data.rb +20 -8
  133. data/lib/finnhub_ruby/models/etf_holdings_data.rb +63 -11
  134. data/lib/finnhub_ruby/models/etf_profile_data.rb +389 -0
  135. data/lib/finnhub_ruby/models/etf_sector_exposure_data.rb +20 -8
  136. data/lib/finnhub_ruby/models/etfs_country_exposure.rb +231 -0
  137. data/lib/finnhub_ruby/models/etfs_holdings.rb +251 -0
  138. data/lib/finnhub_ruby/models/etfs_profile.rb +228 -0
  139. data/lib/finnhub_ruby/models/etfs_sector_exposure.rb +231 -0
  140. data/lib/finnhub_ruby/models/fda_comittee_meeting.rb +249 -0
  141. data/lib/finnhub_ruby/models/filing.rb +21 -9
  142. data/lib/finnhub_ruby/models/filing_sentiment.rb +299 -0
  143. data/lib/finnhub_ruby/models/financial_statements.rb +19 -7
  144. data/lib/finnhub_ruby/models/financials_as_reported.rb +19 -7
  145. data/lib/finnhub_ruby/models/forex_candles.rb +19 -7
  146. data/lib/finnhub_ruby/models/forex_symbol.rb +19 -7
  147. data/lib/finnhub_ruby/models/forexrates.rb +19 -7
  148. data/lib/finnhub_ruby/models/fund_ownership.rb +19 -7
  149. data/lib/finnhub_ruby/models/historical_nbbo.rb +345 -0
  150. data/lib/finnhub_ruby/models/index_historical_constituent.rb +19 -7
  151. data/lib/finnhub_ruby/models/indicator.rb +19 -7
  152. data/lib/finnhub_ruby/models/indices_constituents.rb +19 -7
  153. data/lib/finnhub_ruby/models/indices_historical_constituents.rb +19 -7
  154. data/lib/finnhub_ruby/models/insider_transactions.rb +231 -0
  155. data/lib/finnhub_ruby/models/international_filing.rb +299 -0
  156. data/lib/finnhub_ruby/models/investment_theme_portfolio.rb +219 -0
  157. data/lib/finnhub_ruby/models/investment_themes_thematic_investing.rb +231 -0
  158. data/lib/finnhub_ruby/models/investor.rb +19 -7
  159. data/lib/finnhub_ruby/models/ipo_calendar.rb +19 -7
  160. data/lib/finnhub_ruby/models/ipo_event.rb +19 -7
  161. data/lib/finnhub_ruby/models/key_customers_suppliers.rb +249 -0
  162. data/lib/finnhub_ruby/models/last_bid_ask.rb +19 -7
  163. data/lib/finnhub_ruby/models/major_press_releases.rb +231 -0
  164. data/lib/finnhub_ruby/models/mutual_fund_country_exposure_data.rb +229 -0
  165. data/lib/finnhub_ruby/models/mutual_fund_sector_exposure.rb +231 -0
  166. data/lib/finnhub_ruby/models/mutual_fund_sector_exposure_data.rb +229 -0
  167. data/lib/finnhub_ruby/models/mutual_funds_country_exposure.rb +231 -0
  168. data/lib/finnhub_ruby/models/mutual_funds_holdings.rb +251 -0
  169. data/lib/finnhub_ruby/models/mutual_funds_profile.rb +228 -0
  170. data/lib/finnhub_ruby/models/news.rb +19 -7
  171. data/lib/finnhub_ruby/models/news_sentiment.rb +19 -7
  172. data/lib/finnhub_ruby/models/ownership.rb +231 -0
  173. data/lib/finnhub_ruby/models/pattern_recognition.rb +19 -7
  174. data/lib/finnhub_ruby/models/price_target.rb +20 -8
  175. data/lib/finnhub_ruby/models/quote.rb +43 -11
  176. data/lib/finnhub_ruby/models/recommendation_trend.rb +19 -7
  177. data/lib/finnhub_ruby/models/reddit_sentiment_content.rb +279 -0
  178. data/lib/finnhub_ruby/models/report.rb +23 -11
  179. data/lib/finnhub_ruby/models/revenue_breakdown.rb +241 -0
  180. data/lib/finnhub_ruby/models/revenue_estimates.rb +19 -7
  181. data/lib/finnhub_ruby/models/sec_sentiment_analysis.rb +248 -0
  182. data/lib/finnhub_ruby/models/sentiment.rb +19 -7
  183. data/lib/finnhub_ruby/models/similarity_index.rb +19 -7
  184. data/lib/finnhub_ruby/models/social_sentiment.rb +243 -0
  185. data/lib/finnhub_ruby/models/split.rb +19 -7
  186. data/lib/finnhub_ruby/models/stock.rb +23 -21
  187. data/lib/finnhub_ruby/models/stock_candles.rb +19 -7
  188. data/lib/finnhub_ruby/models/stock_transcripts.rb +20 -8
  189. data/lib/finnhub_ruby/models/supply_chain_relationships.rb +231 -0
  190. data/lib/finnhub_ruby/models/support_resistance.rb +19 -7
  191. data/lib/finnhub_ruby/models/symbol_lookup.rb +231 -0
  192. data/lib/finnhub_ruby/models/technical_analysis.rb +19 -7
  193. data/lib/finnhub_ruby/models/tick_data.rb +36 -12
  194. data/lib/finnhub_ruby/models/transactions.rb +279 -0
  195. data/lib/finnhub_ruby/models/transcript_content.rb +33 -11
  196. data/lib/finnhub_ruby/models/transcript_participant.rb +33 -11
  197. data/lib/finnhub_ruby/models/trend.rb +19 -7
  198. data/lib/finnhub_ruby/models/twitter_sentiment_content.rb +279 -0
  199. data/lib/finnhub_ruby/models/upgrade_downgrade.rb +19 -7
  200. data/lib/finnhub_ruby/version.rb +2 -2
  201. data/release.sh +1 -1
  202. data/spec/api_client_spec.rb +1 -1
  203. data/spec/configuration_spec.rb +1 -1
  204. data/spec/models/breakdown_item_spec.rb +40 -0
  205. data/spec/models/dividends2_basic_spec.rb +40 -0
  206. data/spec/models/etf_profile_data_spec.rb +136 -0
  207. data/spec/models/etfs_country_exposure_spec.rb +40 -0
  208. data/spec/models/etfs_holdings_spec.rb +52 -0
  209. data/spec/models/etfs_profile_spec.rb +40 -0
  210. data/spec/models/etfs_sector_exposure_spec.rb +40 -0
  211. data/spec/models/fda_comittee_meeting_spec.rb +52 -0
  212. data/spec/models/filing_sentiment_spec.rb +82 -0
  213. data/spec/models/historical_nbbo_spec.rb +100 -0
  214. data/spec/models/insider_transactions_spec.rb +40 -0
  215. data/spec/models/international_filing_spec.rb +82 -0
  216. data/spec/models/investment_theme_portfolio_spec.rb +34 -0
  217. data/spec/models/investment_themes_thematic_investing_spec.rb +40 -0
  218. data/spec/models/key_customers_suppliers_spec.rb +52 -0
  219. data/spec/models/major_press_releases_spec.rb +40 -0
  220. data/spec/models/mutual_fund_country_exposure_data_spec.rb +40 -0
  221. data/spec/models/mutual_fund_sector_exposure_data_spec.rb +40 -0
  222. data/spec/models/mutual_fund_sector_exposure_spec.rb +40 -0
  223. data/spec/models/mutual_funds_country_exposure_spec.rb +40 -0
  224. data/spec/models/mutual_funds_holdings_spec.rb +52 -0
  225. data/spec/models/mutual_funds_profile_spec.rb +40 -0
  226. data/spec/models/ownership_spec.rb +40 -0
  227. data/spec/models/reddit_sentiment_content_spec.rb +70 -0
  228. data/spec/models/revenue_breakdown_spec.rb +46 -0
  229. data/spec/models/sec_sentiment_analysis_spec.rb +52 -0
  230. data/spec/models/social_sentiment_spec.rb +46 -0
  231. data/spec/models/supply_chain_relationships_spec.rb +40 -0
  232. data/spec/models/symbol_lookup_spec.rb +40 -0
  233. data/spec/models/transactions_spec.rb +70 -0
  234. data/spec/models/twitter_sentiment_content_spec.rb +70 -0
  235. data/spec/spec_helper.rb +1 -1
  236. metadata +129 -29
  237. data/test.rb +0 -157
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 03b4f036da13874d02dce82fe8620103e5ddc8434cac7380fee5a1ab6ead4ee1
4
- data.tar.gz: f8cd880646d1b79a97b18007bc1dde08f7cad20efd1f2a61cf8327e2e409c294
3
+ metadata.gz: 20efe6cf4420cf9bfb0d2d61fd48f9256d00539da914853d4ab1ac134dc548b8
4
+ data.tar.gz: 2cea9bd76b843880b2bf181a7c70b14e26173f7bc8adca639b2a27d0e6a46dad
5
5
  SHA512:
6
- metadata.gz: 30846c760b942085a9f6b825792a02d9f8edf0561ac30bb786d493bf3d030947deaf3433c92fd3d431cd205b510079c8a42413b91c960af1a169b397768c86d4
7
- data.tar.gz: 81e20e75a2cadd5da24782ac1b60b9542622be78e536a922b794d8643b67310c9e0c559ccacb28db4015281f5dc2c485c140395c5b70af24ce7929083c54a552
6
+ metadata.gz: 50964318c135b04aaf0b0f070335f0d49ab12484139e89cfdf064d26094e4ed23384420e9040e38948824ed634537ec93fda2151267b6a10b7ec1ee966c4e87f
7
+ data.tar.gz: f067d63596f9244449ede1f4008bb15774109ebe34f174bd77f1835fa421806fd48672be0b5e2eef51ac16bceb10a4f72c23239c23698b3d206c8c2ba42f0590
data/README.md CHANGED
@@ -1,7 +1,7 @@
1
- # finnhub-python
1
+ # finnhub-ruby
2
2
  - API documentation: https://finnhub.io/docs/api
3
3
  - API version: 1.0.0
4
- - Package version: 1.1.2
4
+ - Package version: 1.1.4
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.2'
16
+ gem 'finnhub_ruby', '~> 1.1.4'
17
17
  ```
18
18
 
19
19
  ## Getting Started
@@ -22,11 +22,13 @@ gem 'finnhub_ruby', '~> 1.1.2'
22
22
  require 'finnhub_ruby'
23
23
 
24
24
  FinnhubRuby.configure do |config|
25
- config.api_key['token'] = 'YOUR API KEY'
25
+ config.api_key['api_key'] = 'YOUR API KEY'
26
26
  end
27
27
 
28
28
  finnhub_client = FinnhubRuby::DefaultApi.new
29
29
 
30
+ finnhub_client = FinnhubRuby::DefaultApi.new
31
+
30
32
  # Stock candles
31
33
  puts(finnhub_client.stock_candles('AAPL', 'D', 1590988249, 1591852249))
32
34
 
@@ -97,16 +99,16 @@ puts(finnhub_client.forex_symbols('OANDA'))
97
99
  puts(finnhub_client.fund_ownership('AMZN', {limit: 5}))
98
100
 
99
101
  # General news
100
- puts(finnhub_client.general_news('forex', {min_id: 0}))
102
+ puts(finnhub_client.market_news('forex', {min_id: 0}))
101
103
 
102
104
  # Investors ownership
103
- puts(finnhub_client.investors_ownership('AAPL', {limit: 5}))
105
+ puts(finnhub_client.ownership('AAPL', {limit: 5}))
104
106
 
105
107
  # IPO calendar
106
108
  puts(finnhub_client.ipo_calendar("2020-05-01", "2020-06-01"))
107
109
 
108
- # Major developments
109
- puts(finnhub_client.major_developments('AAPL', {from: "2020-01-01", to: "2020-12-31"}))
110
+ # Press Releases
111
+ puts(finnhub_client.press_releases('AAPL', {from: "2020-01-01", to: "2020-12-31"}))
110
112
 
111
113
  # News sentiment
112
114
  puts(finnhub_client.news_sentiment('AAPL'))
@@ -127,7 +129,7 @@ puts(finnhub_client.recommendation_trends('AAPL'))
127
129
  puts(finnhub_client.stock_dividends('KO', '2019-01-01', '2020-01-01'))
128
130
 
129
131
  # Transcripts
130
- puts(finnhub_client.transcripts('AAPL_162777'))
132
+ puts(finnhub_client.earnings_call_transcripts_api('AAPL_162777'))
131
133
 
132
134
  # Transcripts list
133
135
  puts(finnhub_client.transcripts_list('AAPL'))
@@ -166,16 +168,44 @@ puts(finnhub_client.indices_constituents("^GSPC"))
166
168
  puts(finnhub_client.indices_historical_constituents("^GSPC"))
167
169
 
168
170
  # ETFs Profile
169
- puts(finnhub_client.etfs_profile('SPY'))
171
+ puts(finnhub_client.etfs_profile({symbol:'SPY'}))
170
172
 
171
173
  # ETFs Holdings
172
- puts(finnhub_client.etfs_holdings('SPY'))
174
+ puts(finnhub_client.etfs_holdings({symbol:'SPY'}))
173
175
 
174
176
  # ETFs Industry Exposure
175
- puts(finnhub_client.etfs_industry_exposure('SPY'))
177
+ puts(finnhub_client.etfs_sector_exposure('SPY'))
176
178
 
177
179
  # ETFs Country Exposure
178
180
  puts(finnhub_client.etfs_country_exposure('SPY'))
181
+
182
+ # Mutual Fund Profile
183
+ puts(finnhub_client.mutual_fund_profile({symbol:'VTSAX'}))
184
+
185
+ # Mutual Fund Holdings
186
+ puts(finnhub_client.mutual_fund_holdings({symbol:'VTSAX'}))
187
+
188
+ # Mutual Fund Industry Exposure
189
+ puts(finnhub_client.mutual_fund_sector_exposure('VTSAX'))
190
+
191
+ # Mutual Fund Country Exposure
192
+ puts(finnhub_client.mutual_fund_country_exposure('VTSAX'))
193
+
194
+ # Insider Transactions
195
+ puts(finnhub_client.insider_transactions('AAPL'))
196
+
197
+ # Revenue breakdown
198
+ puts(finnhub_client.revenue_breakdown({symbol:'AAPL'}))
199
+
200
+ # Social Sentiment
201
+ puts(finnhub_client.social_sentiment('GME'))
202
+
203
+ # Investment theme
204
+ puts(finnhub_client.investment_themes_thematic_investing('financialExchangesData'))
205
+
206
+ # Supply chain
207
+ puts(finnhub_client.supply_chain_relationships('AAPL'))
208
+
179
209
  ```
180
210
 
181
211
  ## License
data/docs/AggregateIndicators.md CHANGED
@@ -2,18 +2,19 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **technical_analysis** | [**TechnicalAnalysis**](TechnicalAnalysis.md) | | [optional]
8
- **trend** | [**Trend**](Trend.md) | | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **technical_analysis** | [**TechnicalAnalysis**](TechnicalAnalysis.md) | | [optional] |
8
+ | **trend** | [**Trend**](Trend.md) | | [optional] |
9
9
 
10
- ## Code Sample
10
+ ## Example
11
11
 
12
12
  ```ruby
13
- require 'FinnhubRuby'
13
+ require 'finnhub_ruby'
14
14
 
15
- instance = FinnhubRuby::AggregateIndicators.new(technical_analysis: null,
16
- trend: null)
15
+ instance = FinnhubRuby::AggregateIndicators.new(
16
+ technical_analysis: null,
17
+ trend: null
18
+ )
17
19
  ```
18
20
 
19
-
data/docs/BasicFinancials.md CHANGED
@@ -2,20 +2,23 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **symbol** | **String** | Symbol of the company. | [optional]
8
- **metric_type** | **String** | Metric type. | [optional]
9
- **metric** | [**Object**](.md) | | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **symbol** | **String** | Symbol of the company. | [optional] |
8
+ | **metric_type** | **String** | Metric type. | [optional] |
9
+ | **series** | **Object** | | [optional] |
10
+ | **metric** | **Object** | | [optional] |
10
11
 
11
- ## Code Sample
12
+ ## Example
12
13
 
13
14
  ```ruby
14
- require 'FinnhubRuby'
15
+ require 'finnhub_ruby'
15
16
 
16
- instance = FinnhubRuby::BasicFinancials.new(symbol: null,
17
- metric_type: null,
18
- metric: null)
17
+ instance = FinnhubRuby::BasicFinancials.new(
18
+ symbol: null,
19
+ metric_type: null,
20
+ series: null,
21
+ metric: null
22
+ )
19
23
  ```
20
24
 
21
-
data/docs/BreakdownItem.md ADDED
@@ -0,0 +1,20 @@
1
+ # FinnhubRuby::BreakdownItem
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **access_number** | **String** | Access number of the report from which the data is sourced. | [optional] |
8
+ | **breakdown** | **Object** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'finnhub_ruby'
14
+
15
+ instance = FinnhubRuby::BreakdownItem.new(
16
+ access_number: null,
17
+ breakdown: null
18
+ )
19
+ ```
20
+
data/docs/Company.md CHANGED
@@ -2,28 +2,29 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **name** | **String** | Executive name | [optional]
8
- **age** | **Integer** | Age | [optional]
9
- **title** | **String** | Title | [optional]
10
- **since** | **String** | Year appointed | [optional]
11
- **sex** | **String** | Sex | [optional]
12
- **compensation** | **Integer** | Total compensation | [optional]
13
- **currency** | **String** | Compensation currency | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Executive name | [optional] |
8
+ | **age** | **Integer** | Age | [optional] |
9
+ | **title** | **String** | Title | [optional] |
10
+ | **since** | **String** | Year appointed | [optional] |
11
+ | **sex** | **String** | Sex | [optional] |
12
+ | **compensation** | **Integer** | Total compensation | [optional] |
13
+ | **currency** | **String** | Compensation currency | [optional] |
14
14
 
15
- ## Code Sample
15
+ ## Example
16
16
 
17
17
  ```ruby
18
- require 'FinnhubRuby'
18
+ require 'finnhub_ruby'
19
19
 
20
- instance = FinnhubRuby::Company.new(name: null,
21
- age: null,
22
- title: null,
23
- since: null,
24
- sex: null,
25
- compensation: null,
26
- currency: null)
20
+ instance = FinnhubRuby::Company.new(
21
+ name: null,
22
+ age: null,
23
+ title: null,
24
+ since: null,
25
+ sex: null,
26
+ compensation: null,
27
+ currency: null
28
+ )
27
29
  ```
28
30
 
29
-
data/docs/CompanyExecutive.md CHANGED
@@ -2,18 +2,19 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **symbol** | **String** | Company symbol. | [optional]
8
- **executive** | **Array<Object>** | Array of company's executives and members of the Board. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **symbol** | **String** | Company symbol. | [optional] |
8
+ | **executive** | **Array<Object>** | Array of company's executives and members of the Board. | [optional] |
9
9
 
10
- ## Code Sample
10
+ ## Example
11
11
 
12
12
  ```ruby
13
- require 'FinnhubRuby'
13
+ require 'finnhub_ruby'
14
14
 
15
- instance = FinnhubRuby::CompanyExecutive.new(symbol: null,
16
- executive: null)
15
+ instance = FinnhubRuby::CompanyExecutive.new(
16
+ symbol: null,
17
+ executive: null
18
+ )
17
19
  ```
18
20
 
19
-
data/docs/CompanyNewsStatistics.md CHANGED
@@ -2,20 +2,21 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **articles_in_last_week** | **Integer** | | [optional]
8
- **buzz** | **Float** | | [optional]
9
- **weekly_average** | **Float** | | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **articles_in_last_week** | **Integer** | | [optional] |
8
+ | **buzz** | **Float** | | [optional] |
9
+ | **weekly_average** | **Float** | | [optional] |
10
10
 
11
- ## Code Sample
11
+ ## Example
12
12
 
13
13
  ```ruby
14
- require 'FinnhubRuby'
14
+ require 'finnhub_ruby'
15
15
 
16
- instance = FinnhubRuby::CompanyNewsStatistics.new(articles_in_last_week: null,
17
- buzz: null,
18
- weekly_average: null)
16
+ instance = FinnhubRuby::CompanyNewsStatistics.new(
17
+ articles_in_last_week: null,
18
+ buzz: null,
19
+ weekly_average: null
20
+ )
19
21
  ```
20
22
 
21
-
data/docs/CompanyProfile.md CHANGED
@@ -2,70 +2,71 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **address** | **String** | Address of company's headquarter. | [optional]
8
- **city** | **String** | City of company's headquarter. | [optional]
9
- **country** | **String** | Country of company's headquarter. | [optional]
10
- **currency** | **String** | Currency used in company filings. | [optional]
11
- **cusip** | **String** | CUSIP number. | [optional]
12
- **sedol** | **String** | Sedol number. | [optional]
13
- **description** | **String** | Company business summary. | [optional]
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]
19
- **isin** | **String** | ISIN number. | [optional]
20
- **naics_national_industry** | **String** | NAICS national industry. | [optional]
21
- **naics** | **String** | NAICS industry. | [optional]
22
- **naics_sector** | **String** | NAICS sector. | [optional]
23
- **naics_subsector** | **String** | NAICS subsector. | [optional]
24
- **name** | **String** | Company name. | [optional]
25
- **phone** | **String** | Company phone number. | [optional]
26
- **state** | **String** | State of company's headquarter. | [optional]
27
- **ticker** | **String** | Company symbol/ticker as used on the listed exchange. | [optional]
28
- **weburl** | **String** | Company website. | [optional]
29
- **ipo** | **Date** | IPO date. | [optional]
30
- **market_capitalization** | **Float** | Market Capitalization. | [optional]
31
- **share_outstanding** | **Float** | Number of oustanding shares. | [optional]
32
- **employee_total** | **Integer** | Number of employee. | [optional]
33
- **logo** | **String** | Logo image. | [optional]
34
- **finnhub_industry** | **String** | Finnhub industry classification. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **address** | **String** | Address of company's headquarter. | [optional] |
8
+ | **city** | **String** | City of company's headquarter. | [optional] |
9
+ | **country** | **String** | Country of company's headquarter. | [optional] |
10
+ | **currency** | **String** | Currency used in company filings. | [optional] |
11
+ | **cusip** | **String** | CUSIP number. | [optional] |
12
+ | **sedol** | **String** | Sedol number. | [optional] |
13
+ | **description** | **String** | Company business summary. | [optional] |
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] |
19
+ | **isin** | **String** | ISIN number. | [optional] |
20
+ | **naics_national_industry** | **String** | NAICS national industry. | [optional] |
21
+ | **naics** | **String** | NAICS industry. | [optional] |
22
+ | **naics_sector** | **String** | NAICS sector. | [optional] |
23
+ | **naics_subsector** | **String** | NAICS subsector. | [optional] |
24
+ | **name** | **String** | Company name. | [optional] |
25
+ | **phone** | **String** | Company phone number. | [optional] |
26
+ | **state** | **String** | State of company's headquarter. | [optional] |
27
+ | **ticker** | **String** | Company symbol/ticker as used on the listed exchange. | [optional] |
28
+ | **weburl** | **String** | Company website. | [optional] |
29
+ | **ipo** | **Date** | IPO date. | [optional] |
30
+ | **market_capitalization** | **Float** | Market Capitalization. | [optional] |
31
+ | **share_outstanding** | **Float** | Number of oustanding shares. | [optional] |
32
+ | **employee_total** | **Integer** | Number of employee. | [optional] |
33
+ | **logo** | **String** | Logo image. | [optional] |
34
+ | **finnhub_industry** | **String** | Finnhub industry classification. | [optional] |
35
35
 
36
- ## Code Sample
36
+ ## Example
37
37
 
38
38
  ```ruby
39
- require 'FinnhubRuby'
39
+ require 'finnhub_ruby'
40
40
 
41
- instance = FinnhubRuby::CompanyProfile.new(address: null,
42
- city: null,
43
- country: null,
44
- currency: null,
45
- cusip: null,
46
- sedol: null,
47
- description: null,
48
- exchange: null,
49
- ggroup: null,
50
- gind: null,
51
- gsector: null,
52
- gsubind: null,
53
- isin: null,
54
- naics_national_industry: null,
55
- naics: null,
56
- naics_sector: null,
57
- naics_subsector: null,
58
- name: null,
59
- phone: null,
60
- state: null,
61
- ticker: null,
62
- weburl: null,
63
- ipo: null,
64
- market_capitalization: null,
65
- share_outstanding: null,
66
- employee_total: null,
67
- logo: null,
68
- finnhub_industry: null)
41
+ instance = FinnhubRuby::CompanyProfile.new(
42
+ address: null,
43
+ city: null,
44
+ country: null,
45
+ currency: null,
46
+ cusip: null,
47
+ sedol: null,
48
+ description: null,
49
+ exchange: null,
50
+ ggroup: null,
51
+ gind: null,
52
+ gsector: null,
53
+ gsubind: null,
54
+ isin: null,
55
+ naics_national_industry: null,
56
+ naics: null,
57
+ naics_sector: null,
58
+ naics_subsector: null,
59
+ name: null,
60
+ phone: null,
61
+ state: null,
62
+ ticker: null,
63
+ weburl: null,
64
+ ipo: null,
65
+ market_capitalization: null,
66
+ share_outstanding: null,
67
+ employee_total: null,
68
+ logo: null,
69
+ finnhub_industry: null
70
+ )
69
71
  ```
70
72
 
71
-