finnhub_ruby 1.1.2 → 1.1.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (346) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +46 -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/CompanyNews.md +34 -0
  9. data/docs/CompanyNewsStatistics.md +12 -11
  10. data/docs/CompanyProfile.md +62 -61
  11. data/docs/CompanyProfile2.md +30 -29
  12. data/docs/CountryMetadata.md +18 -17
  13. data/docs/CovidInfo.md +14 -13
  14. data/docs/CryptoCandles.md +20 -19
  15. data/docs/CryptoSymbol.md +12 -11
  16. data/docs/DefaultApi.md +2996 -895
  17. data/docs/Development.md +16 -13
  18. data/docs/Dividends.md +22 -21
  19. data/docs/Dividends2.md +20 -0
  20. data/docs/Dividends2Info.md +20 -0
  21. data/docs/ETFCountryExposureData.md +10 -9
  22. data/docs/ETFHoldingsData.md +20 -11
  23. data/docs/ETFProfileData.md +52 -0
  24. data/docs/ETFSectorExposureData.md +10 -9
  25. data/docs/ETFsCountryExposure.md +10 -9
  26. data/docs/ETFsHoldings.md +14 -9
  27. data/docs/ETFsProfile.md +10 -9
  28. data/docs/ETFsSectorExposure.md +20 -0
  29. data/docs/EarningEstimate.md +16 -15
  30. data/docs/EarningRelease.md +24 -23
  31. data/docs/EarningResult.md +18 -13
  32. data/docs/EarningsCalendar.md +8 -7
  33. data/docs/EarningsCallTranscripts.md +24 -23
  34. data/docs/EarningsCallTranscriptsList.md +10 -9
  35. data/docs/EarningsEstimates.md +12 -11
  36. data/docs/EarningsEstimatesInfo.md +26 -0
  37. data/docs/EconomicCalendar.md +8 -7
  38. data/docs/EconomicCode.md +14 -13
  39. data/docs/EconomicData.md +10 -9
  40. data/docs/EconomicDataInfo.md +20 -0
  41. data/docs/EconomicEvent.md +22 -21
  42. data/docs/Estimate.md +16 -15
  43. data/docs/FDAComitteeMeeting.md +24 -0
  44. data/docs/Filing.md +22 -21
  45. data/docs/FilingSentiment.md +34 -0
  46. data/docs/FinancialStatements.md +10 -9
  47. data/docs/FinancialsAsReported.md +12 -11
  48. data/docs/ForexCandles.md +20 -19
  49. data/docs/ForexSymbol.md +12 -11
  50. data/docs/Forexrates.md +10 -9
  51. data/docs/FundOwnership.md +10 -9
  52. data/docs/FundOwnershipInfo.md +26 -0
  53. data/docs/HistoricalNBBO.md +40 -0
  54. data/docs/IPOCalendar.md +8 -7
  55. data/docs/IPOEvent.md +22 -21
  56. data/docs/IndexHistoricalConstituent.md +12 -11
  57. data/docs/Indicator.md +12 -11
  58. data/docs/IndicesConstituents.md +10 -9
  59. data/docs/IndicesHistoricalConstituents.md +10 -9
  60. data/docs/InsiderTransactions.md +20 -0
  61. data/docs/InternationalFiling.md +34 -0
  62. data/docs/InvestmentThemePortfolio.md +18 -0
  63. data/docs/InvestmentThemes.md +20 -0
  64. data/docs/KeyCustomersSuppliers.md +24 -0
  65. data/docs/LastBidAsk.md +16 -15
  66. data/docs/MarketNews.md +34 -0
  67. data/docs/MutualFundCountryExposure.md +20 -0
  68. data/docs/MutualFundCountryExposureData.md +20 -0
  69. data/docs/MutualFundHoldings.md +24 -0
  70. data/docs/MutualFundHoldingsData.md +30 -0
  71. data/docs/MutualFundProfile.md +20 -0
  72. data/docs/MutualFundProfileData.md +58 -0
  73. data/docs/MutualFundSectorExposure.md +20 -0
  74. data/docs/MutualFundSectorExposureData.md +20 -0
  75. data/docs/NewsSentiment.md +18 -17
  76. data/docs/Ownership.md +20 -0
  77. data/docs/OwnershipInfo.md +24 -0
  78. data/docs/PatternRecognition.md +8 -7
  79. data/docs/PressRelease.md +20 -0
  80. data/docs/PriceTarget.md +18 -17
  81. data/docs/Quote.md +20 -15
  82. data/docs/RecommendationTrend.md +20 -19
  83. data/docs/RedditSentimentContent.md +30 -0
  84. data/docs/Report.md +28 -27
  85. data/docs/RevenueBreakdown.md +22 -0
  86. data/docs/RevenueEstimates.md +12 -11
  87. data/docs/RevenueEstimatesInfo.md +26 -0
  88. data/docs/SECSentimentAnalysis.md +24 -0
  89. data/docs/Sentiment.md +10 -9
  90. data/docs/SimilarityIndex.md +12 -11
  91. data/docs/SimilarityIndexInfo.md +40 -0
  92. data/docs/SocialSentiment.md +22 -0
  93. data/docs/Split.md +14 -13
  94. data/docs/StockCandles.md +20 -19
  95. data/docs/StockSymbol.md +30 -0
  96. data/docs/StockTranscripts.md +16 -15
  97. data/docs/SupplyChainRelationships.md +20 -0
  98. data/docs/SupportResistance.md +8 -7
  99. data/docs/SymbolLookup.md +20 -0
  100. data/docs/SymbolLookupInfo.md +24 -0
  101. data/docs/TechnicalAnalysis.md +10 -9
  102. data/docs/TickData.md +24 -21
  103. data/docs/Transactions.md +30 -0
  104. data/docs/TranscriptContent.md +12 -9
  105. data/docs/TranscriptParticipant.md +12 -9
  106. data/docs/Trend.md +10 -9
  107. data/docs/TwitterSentimentContent.md +30 -0
  108. data/docs/UpgradeDowngrade.md +18 -17
  109. data/finnhub_ruby.gemspec +7 -8
  110. data/lib/finnhub_ruby.rb +45 -12
  111. data/lib/finnhub_ruby/api/default_api.rb +1545 -443
  112. data/lib/finnhub_ruby/api_client.rb +52 -49
  113. data/lib/finnhub_ruby/api_error.rb +1 -1
  114. data/lib/finnhub_ruby/configuration.rb +39 -10
  115. data/lib/finnhub_ruby/models/aggregate_indicators.rb +19 -7
  116. data/lib/finnhub_ruby/models/basic_financials.rb +29 -8
  117. data/lib/finnhub_ruby/models/breakdown_item.rb +228 -0
  118. data/lib/finnhub_ruby/models/company.rb +19 -7
  119. data/lib/finnhub_ruby/models/company_executive.rb +20 -8
  120. data/lib/finnhub_ruby/models/company_news.rb +299 -0
  121. data/lib/finnhub_ruby/models/company_news_statistics.rb +19 -7
  122. data/lib/finnhub_ruby/models/company_profile.rb +20 -8
  123. data/lib/finnhub_ruby/models/company_profile2.rb +19 -7
  124. data/lib/finnhub_ruby/models/country_metadata.rb +19 -7
  125. data/lib/finnhub_ruby/models/covid_info.rb +20 -8
  126. data/lib/finnhub_ruby/models/crypto_candles.rb +19 -7
  127. data/lib/finnhub_ruby/models/crypto_symbol.rb +19 -7
  128. data/lib/finnhub_ruby/models/development.rb +34 -12
  129. data/lib/finnhub_ruby/models/dividends.rb +19 -7
  130. data/lib/finnhub_ruby/models/dividends2.rb +231 -0
  131. data/lib/finnhub_ruby/models/dividends2_basic.rb +231 -0
  132. data/lib/finnhub_ruby/models/dividends2_info.rb +229 -0
  133. data/lib/finnhub_ruby/models/earning_estimate.rb +20 -8
  134. data/lib/finnhub_ruby/models/earning_release.rb +22 -10
  135. data/lib/finnhub_ruby/models/earning_result.rb +40 -8
  136. data/lib/finnhub_ruby/models/earnings_calendar.rb +20 -8
  137. data/lib/finnhub_ruby/models/earnings_call_transcripts.rb +22 -10
  138. data/lib/finnhub_ruby/models/earnings_call_transcripts_list.rb +20 -8
  139. data/lib/finnhub_ruby/models/earnings_estimates.rb +20 -8
  140. data/lib/finnhub_ruby/models/earnings_estimates_info.rb +259 -0
  141. data/lib/finnhub_ruby/models/economic_calendar.rb +20 -8
  142. data/lib/finnhub_ruby/models/economic_code.rb +19 -7
  143. data/lib/finnhub_ruby/models/economic_data.rb +20 -8
  144. data/lib/finnhub_ruby/models/economic_data_info.rb +229 -0
  145. data/lib/finnhub_ruby/models/economic_event.rb +19 -7
  146. data/lib/finnhub_ruby/models/estimate.rb +20 -8
  147. data/lib/finnhub_ruby/models/etf_country_exposure_data.rb +20 -8
  148. data/lib/finnhub_ruby/models/etf_holdings_data.rb +63 -11
  149. data/lib/finnhub_ruby/models/etf_profile_data.rb +389 -0
  150. data/lib/finnhub_ruby/models/etf_sector_exposure_data.rb +20 -8
  151. data/lib/finnhub_ruby/models/etfs_country_exposure.rb +231 -0
  152. data/lib/finnhub_ruby/models/etfs_holdings.rb +251 -0
  153. data/lib/finnhub_ruby/models/etfs_profile.rb +228 -0
  154. data/lib/finnhub_ruby/models/etfs_sector_exposure.rb +231 -0
  155. data/lib/finnhub_ruby/models/fda_comittee_meeting.rb +249 -0
  156. data/lib/finnhub_ruby/models/filing.rb +21 -9
  157. data/lib/finnhub_ruby/models/filing_sentiment.rb +299 -0
  158. data/lib/finnhub_ruby/models/financial_statements.rb +19 -7
  159. data/lib/finnhub_ruby/models/financials_as_reported.rb +20 -8
  160. data/lib/finnhub_ruby/models/forex_candles.rb +19 -7
  161. data/lib/finnhub_ruby/models/forex_symbol.rb +19 -7
  162. data/lib/finnhub_ruby/models/forexrates.rb +19 -7
  163. data/lib/finnhub_ruby/models/fund_ownership.rb +20 -8
  164. data/lib/finnhub_ruby/models/fund_ownership_info.rb +259 -0
  165. data/lib/finnhub_ruby/models/historical_nbbo.rb +345 -0
  166. data/lib/finnhub_ruby/models/index_historical_constituent.rb +19 -7
  167. data/lib/finnhub_ruby/models/indicator.rb +19 -7
  168. data/lib/finnhub_ruby/models/indices_constituents.rb +19 -7
  169. data/lib/finnhub_ruby/models/indices_historical_constituents.rb +20 -8
  170. data/lib/finnhub_ruby/models/insider_transactions.rb +231 -0
  171. data/lib/finnhub_ruby/models/international_filing.rb +299 -0
  172. data/lib/finnhub_ruby/models/investment_theme_portfolio.rb +219 -0
  173. data/lib/finnhub_ruby/models/investment_themes.rb +231 -0
  174. data/lib/finnhub_ruby/models/investment_themes_thematic_investing.rb +231 -0
  175. data/lib/finnhub_ruby/models/investor.rb +19 -7
  176. data/lib/finnhub_ruby/models/ipo_calendar.rb +20 -8
  177. data/lib/finnhub_ruby/models/ipo_event.rb +21 -9
  178. data/lib/finnhub_ruby/models/key_customers_suppliers.rb +249 -0
  179. data/lib/finnhub_ruby/models/last_bid_ask.rb +19 -7
  180. data/lib/finnhub_ruby/models/major_press_releases.rb +231 -0
  181. data/lib/finnhub_ruby/models/market_news.rb +299 -0
  182. data/lib/finnhub_ruby/models/mutual_fund_country_exposure.rb +231 -0
  183. data/lib/finnhub_ruby/models/mutual_fund_country_exposure_data.rb +229 -0
  184. data/lib/finnhub_ruby/models/mutual_fund_holdings.rb +251 -0
  185. data/lib/finnhub_ruby/models/mutual_fund_holdings_data.rb +279 -0
  186. data/lib/finnhub_ruby/models/mutual_fund_profile.rb +228 -0
  187. data/lib/finnhub_ruby/models/mutual_fund_profile_data.rb +419 -0
  188. data/lib/finnhub_ruby/models/mutual_fund_sector_exposure.rb +231 -0
  189. data/lib/finnhub_ruby/models/mutual_fund_sector_exposure_data.rb +229 -0
  190. data/lib/finnhub_ruby/models/mutual_funds_country_exposure.rb +231 -0
  191. data/lib/finnhub_ruby/models/mutual_funds_holdings.rb +251 -0
  192. data/lib/finnhub_ruby/models/mutual_funds_profile.rb +228 -0
  193. data/lib/finnhub_ruby/models/news.rb +19 -7
  194. data/lib/finnhub_ruby/models/news_sentiment.rb +19 -7
  195. data/lib/finnhub_ruby/models/ownership.rb +231 -0
  196. data/lib/finnhub_ruby/models/ownership_info.rb +249 -0
  197. data/lib/finnhub_ruby/models/pattern_recognition.rb +19 -7
  198. data/lib/finnhub_ruby/models/press_release.rb +231 -0
  199. data/lib/finnhub_ruby/models/price_target.rb +20 -8
  200. data/lib/finnhub_ruby/models/quote.rb +43 -11
  201. data/lib/finnhub_ruby/models/recommendation_trend.rb +19 -7
  202. data/lib/finnhub_ruby/models/reddit_sentiment_content.rb +279 -0
  203. data/lib/finnhub_ruby/models/report.rb +23 -11
  204. data/lib/finnhub_ruby/models/revenue_breakdown.rb +241 -0
  205. data/lib/finnhub_ruby/models/revenue_estimates.rb +20 -8
  206. data/lib/finnhub_ruby/models/revenue_estimates_info.rb +259 -0
  207. data/lib/finnhub_ruby/models/sec_sentiment_analysis.rb +248 -0
  208. data/lib/finnhub_ruby/models/sentiment.rb +21 -9
  209. data/lib/finnhub_ruby/models/similarity_index.rb +20 -8
  210. data/lib/finnhub_ruby/models/similarity_index_info.rb +329 -0
  211. data/lib/finnhub_ruby/models/social_sentiment.rb +243 -0
  212. data/lib/finnhub_ruby/models/split.rb +19 -7
  213. data/lib/finnhub_ruby/models/stock.rb +23 -21
  214. data/lib/finnhub_ruby/models/stock_candles.rb +19 -7
  215. data/lib/finnhub_ruby/models/stock_symbol.rb +279 -0
  216. data/lib/finnhub_ruby/models/stock_transcripts.rb +20 -8
  217. data/lib/finnhub_ruby/models/supply_chain_relationships.rb +231 -0
  218. data/lib/finnhub_ruby/models/support_resistance.rb +19 -7
  219. data/lib/finnhub_ruby/models/symbol_lookup.rb +231 -0
  220. data/lib/finnhub_ruby/models/symbol_lookup_info.rb +249 -0
  221. data/lib/finnhub_ruby/models/technical_analysis.rb +19 -7
  222. data/lib/finnhub_ruby/models/tick_data.rb +36 -12
  223. data/lib/finnhub_ruby/models/transactions.rb +279 -0
  224. data/lib/finnhub_ruby/models/transcript_content.rb +33 -11
  225. data/lib/finnhub_ruby/models/transcript_participant.rb +33 -11
  226. data/lib/finnhub_ruby/models/trend.rb +19 -7
  227. data/lib/finnhub_ruby/models/twitter_sentiment_content.rb +279 -0
  228. data/lib/finnhub_ruby/models/upgrade_downgrade.rb +19 -7
  229. data/lib/finnhub_ruby/version.rb +2 -2
  230. data/release.sh +12 -2
  231. data/spec/api_client_spec.rb +1 -1
  232. data/spec/configuration_spec.rb +1 -1
  233. data/spec/models/aggregate_indicators_spec.rb +4 -11
  234. data/spec/models/basic_financials_spec.rb +10 -11
  235. data/spec/models/breakdown_item_spec.rb +40 -0
  236. data/spec/models/company_executive_spec.rb +4 -11
  237. data/spec/models/{news_spec.rb → company_news_spec.rb} +7 -14
  238. data/spec/models/company_news_statistics_spec.rb +4 -11
  239. data/spec/models/company_profile2_spec.rb +4 -11
  240. data/spec/models/company_profile_spec.rb +4 -11
  241. data/spec/models/company_spec.rb +4 -11
  242. data/spec/models/country_metadata_spec.rb +4 -11
  243. data/spec/models/covid_info_spec.rb +4 -11
  244. data/spec/models/crypto_candles_spec.rb +4 -11
  245. data/spec/models/crypto_symbol_spec.rb +4 -11
  246. data/spec/models/development_spec.rb +10 -11
  247. data/spec/models/dividends2_info_spec.rb +40 -0
  248. data/spec/models/dividends2_spec.rb +40 -0
  249. data/spec/models/dividends_spec.rb +4 -11
  250. data/spec/models/earning_estimate_spec.rb +4 -11
  251. data/spec/models/earning_release_spec.rb +4 -11
  252. data/spec/models/earning_result_spec.rb +16 -11
  253. data/spec/models/earnings_calendar_spec.rb +4 -11
  254. data/spec/models/earnings_call_transcripts_list_spec.rb +4 -11
  255. data/spec/models/earnings_call_transcripts_spec.rb +4 -11
  256. data/spec/models/earnings_estimates_info_spec.rb +58 -0
  257. data/spec/models/earnings_estimates_spec.rb +4 -11
  258. data/spec/models/economic_calendar_spec.rb +4 -11
  259. data/spec/models/economic_code_spec.rb +4 -11
  260. data/spec/models/economic_data_info_spec.rb +40 -0
  261. data/spec/models/economic_data_spec.rb +4 -11
  262. data/spec/models/economic_event_spec.rb +4 -11
  263. data/spec/models/estimate_spec.rb +4 -11
  264. data/spec/models/etf_country_exposure_data_spec.rb +4 -11
  265. data/spec/models/etf_holdings_data_spec.rb +28 -11
  266. data/spec/models/etf_profile_data_spec.rb +136 -0
  267. data/spec/models/etf_sector_exposure_data_spec.rb +4 -11
  268. data/spec/models/{et_fs_country_exposure_spec.rb → etfs_country_exposure_spec.rb} +4 -11
  269. data/spec/models/{et_fs_holdings_spec.rb → etfs_holdings_spec.rb} +16 -11
  270. data/spec/models/{et_fs_profile_spec.rb → etfs_profile_spec.rb} +4 -11
  271. data/spec/models/{et_fs_industry_exposure_spec.rb → etfs_sector_exposure_spec.rb} +7 -14
  272. data/spec/models/fda_comittee_meeting_spec.rb +52 -0
  273. data/spec/models/filing_sentiment_spec.rb +82 -0
  274. data/spec/models/filing_spec.rb +4 -11
  275. data/spec/models/financial_statements_spec.rb +4 -11
  276. data/spec/models/financials_as_reported_spec.rb +4 -11
  277. data/spec/models/forex_candles_spec.rb +4 -11
  278. data/spec/models/forex_symbol_spec.rb +4 -11
  279. data/spec/models/forexrates_spec.rb +4 -11
  280. data/spec/models/fund_ownership_info_spec.rb +58 -0
  281. data/spec/models/fund_ownership_spec.rb +4 -11
  282. data/spec/models/historical_nbbo_spec.rb +100 -0
  283. data/spec/models/index_historical_constituent_spec.rb +4 -11
  284. data/spec/models/indicator_spec.rb +4 -11
  285. data/spec/models/indices_constituents_spec.rb +4 -11
  286. data/spec/models/indices_historical_constituents_spec.rb +4 -11
  287. data/spec/models/insider_transactions_spec.rb +40 -0
  288. data/spec/models/international_filing_spec.rb +82 -0
  289. data/spec/models/investment_theme_portfolio_spec.rb +34 -0
  290. data/spec/models/investment_themes_spec.rb +40 -0
  291. data/spec/models/ipo_calendar_spec.rb +4 -11
  292. data/spec/models/ipo_event_spec.rb +4 -11
  293. data/spec/models/key_customers_suppliers_spec.rb +52 -0
  294. data/spec/models/last_bid_ask_spec.rb +4 -11
  295. data/spec/models/market_news_spec.rb +82 -0
  296. data/spec/models/mutual_fund_country_exposure_data_spec.rb +40 -0
  297. data/spec/models/mutual_fund_country_exposure_spec.rb +40 -0
  298. data/spec/models/mutual_fund_holdings_data_spec.rb +70 -0
  299. data/spec/models/mutual_fund_holdings_spec.rb +52 -0
  300. data/spec/models/mutual_fund_profile_data_spec.rb +154 -0
  301. data/spec/models/mutual_fund_profile_spec.rb +40 -0
  302. data/spec/models/mutual_fund_sector_exposure_data_spec.rb +40 -0
  303. data/spec/models/mutual_fund_sector_exposure_spec.rb +40 -0
  304. data/spec/models/news_sentiment_spec.rb +4 -11
  305. data/spec/models/{investor_spec.rb → ownership_info_spec.rb} +7 -14
  306. data/spec/models/{investors_ownership_spec.rb → ownership_spec.rb} +7 -14
  307. data/spec/models/pattern_recognition_spec.rb +4 -11
  308. data/spec/models/{major_developments_spec.rb → press_release_spec.rb} +7 -14
  309. data/spec/models/price_target_spec.rb +4 -11
  310. data/spec/models/quote_spec.rb +16 -11
  311. data/spec/models/recommendation_trend_spec.rb +4 -11
  312. data/spec/models/reddit_sentiment_content_spec.rb +70 -0
  313. data/spec/models/report_spec.rb +4 -11
  314. data/spec/models/revenue_breakdown_spec.rb +46 -0
  315. data/spec/models/revenue_estimates_info_spec.rb +58 -0
  316. data/spec/models/revenue_estimates_spec.rb +4 -11
  317. data/spec/models/sec_sentiment_analysis_spec.rb +52 -0
  318. data/spec/models/sentiment_spec.rb +4 -11
  319. data/spec/models/similarity_index_info_spec.rb +100 -0
  320. data/spec/models/similarity_index_spec.rb +4 -11
  321. data/spec/models/social_sentiment_spec.rb +46 -0
  322. data/spec/models/split_spec.rb +4 -11
  323. data/spec/models/stock_candles_spec.rb +4 -11
  324. data/spec/models/stock_symbol_spec.rb +70 -0
  325. data/spec/models/stock_transcripts_spec.rb +4 -11
  326. data/spec/models/supply_chain_relationships_spec.rb +40 -0
  327. data/spec/models/support_resistance_spec.rb +4 -11
  328. data/spec/models/{stock_spec.rb → symbol_lookup_info_spec.rb} +7 -20
  329. data/spec/models/symbol_lookup_spec.rb +40 -0
  330. data/spec/models/technical_analysis_spec.rb +4 -11
  331. data/spec/models/tick_data_spec.rb +10 -11
  332. data/spec/models/transactions_spec.rb +70 -0
  333. data/spec/models/transcript_content_spec.rb +10 -11
  334. data/spec/models/transcript_participant_spec.rb +10 -11
  335. data/spec/models/trend_spec.rb +4 -11
  336. data/spec/models/twitter_sentiment_content_spec.rb +70 -0
  337. data/spec/models/upgrade_downgrade_spec.rb +4 -11
  338. data/spec/spec_helper.rb +1 -1
  339. metadata +187 -53
  340. data/docs/ETFsIndustryExposure.md +0 -19
  341. data/docs/Investor.md +0 -23
  342. data/docs/InvestorsOwnership.md +0 -19
  343. data/docs/MajorDevelopments.md +0 -19
  344. data/docs/News.md +0 -33
  345. data/docs/Stock.md +0 -25
  346. data/test.rb +0 -157
data/docs/EarningRelease.md CHANGED
@@ -2,32 +2,33 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **symbol** | **String** | Symbol. | [optional]
8
- **date** | **Date** | Date. | [optional]
9
- **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]
10
- **year** | **Integer** | Earnings year. | [optional]
11
- **quarter** | **Integer** | Earnings quarter. | [optional]
12
- **eps_estimate** | **Float** | EPS estimate. | [optional]
13
- **eps_actual** | **Float** | EPS actual. | [optional]
14
- **revenue_estimate** | **Integer** | Revenue estimate. | [optional]
15
- **revenue_actual** | **Integer** | Revenue actual. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **symbol** | **String** | Symbol. | [optional] |
8
+ | **date** | **Date** | Date. | [optional] |
9
+ | **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] |
10
+ | **year** | **Integer** | Earnings year. | [optional] |
11
+ | **quarter** | **Integer** | Earnings quarter. | [optional] |
12
+ | **eps_estimate** | **Float** | EPS estimate. | [optional] |
13
+ | **eps_actual** | **Float** | EPS actual. | [optional] |
14
+ | **revenue_estimate** | **Float** | Revenue estimate including Finnhub's proprietary estimates. | [optional] |
15
+ | **revenue_actual** | **Float** | Revenue actual. | [optional] |
16
16
 
17
- ## Code Sample
17
+ ## Example
18
18
 
19
19
  ```ruby
20
- require 'FinnhubRuby'
20
+ require 'finnhub_ruby'
21
21
 
22
- instance = FinnhubRuby::EarningRelease.new(symbol: null,
23
- date: null,
24
- hour: null,
25
- year: null,
26
- quarter: null,
27
- eps_estimate: null,
28
- eps_actual: null,
29
- revenue_estimate: null,
30
- revenue_actual: null)
22
+ instance = FinnhubRuby::EarningRelease.new(
23
+ symbol: null,
24
+ date: null,
25
+ hour: null,
26
+ year: null,
27
+ quarter: null,
28
+ eps_estimate: null,
29
+ eps_actual: null,
30
+ revenue_estimate: null,
31
+ revenue_actual: null
32
+ )
31
33
  ```
32
34
 
33
-
data/docs/EarningResult.md CHANGED
@@ -2,22 +2,27 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **actual** | **Float** | Actual earning result. | [optional]
8
- **estimate** | **Float** | Estimated earning. | [optional]
9
- **period** | **Date** | Reported period. | [optional]
10
- **symbol** | **String** | Company symbol. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **actual** | **Float** | Actual earning result. | [optional] |
8
+ | **estimate** | **Float** | Estimated earning. | [optional] |
9
+ | **surprise** | **Float** | Surprise - The difference between actual and estimate. | [optional] |
10
+ | **surprise_percent** | **Float** | Surprise percent. | [optional] |
11
+ | **period** | **Date** | Reported period. | [optional] |
12
+ | **symbol** | **String** | Company symbol. | [optional] |
11
13
 
12
- ## Code Sample
14
+ ## Example
13
15
 
14
16
  ```ruby
15
- require 'FinnhubRuby'
17
+ require 'finnhub_ruby'
16
18
 
17
- instance = FinnhubRuby::EarningResult.new(actual: null,
18
- estimate: null,
19
- period: null,
20
- symbol: null)
19
+ instance = FinnhubRuby::EarningResult.new(
20
+ actual: null,
21
+ estimate: null,
22
+ surprise: null,
23
+ surprise_percent: null,
24
+ period: null,
25
+ symbol: null
26
+ )
21
27
  ```
22
28
 
23
-
data/docs/EarningsCalendar.md CHANGED
@@ -2,16 +2,17 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **earnings_calendar** | **Array<Object>** | Array of earnings release. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **earnings_calendar** | [**Array<EarningRelease>**](EarningRelease.md) | Array of earnings release. | [optional] |
8
8
 
9
- ## Code Sample
9
+ ## Example
10
10
 
11
11
  ```ruby
12
- require 'FinnhubRuby'
12
+ require 'finnhub_ruby'
13
13
 
14
- instance = FinnhubRuby::EarningsCalendar.new(earnings_calendar: null)
14
+ instance = FinnhubRuby::EarningsCalendar.new(
15
+ earnings_calendar: null
16
+ )
15
17
  ```
16
18
 
17
-
data/docs/EarningsCallTranscripts.md CHANGED
@@ -2,32 +2,33 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **symbol** | **String** | Company symbol. | [optional]
8
- **transcript** | **Array<Object>** | Transcript content. | [optional]
9
- **participant** | **Array<Object>** | Participant list | [optional]
10
- **audio** | **String** | Audio link. | [optional]
11
- **id** | **String** | Transcript's ID. | [optional]
12
- **title** | **String** | Title. | [optional]
13
- **time** | **DateTime** | Time of the event. | [optional]
14
- **year** | **Integer** | Year of earnings result in the case of earnings call transcript. | [optional]
15
- **quarter** | **Integer** | Quarter of earnings result in the case of earnings call transcript. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **symbol** | **String** | Company symbol. | [optional] |
8
+ | **transcript** | [**Array<TranscriptContent>**](TranscriptContent.md) | Transcript content. | [optional] |
9
+ | **participant** | [**Array<TranscriptParticipant>**](TranscriptParticipant.md) | Participant list | [optional] |
10
+ | **audio** | **String** | Audio link. | [optional] |
11
+ | **id** | **String** | Transcript's ID. | [optional] |
12
+ | **title** | **String** | Title. | [optional] |
13
+ | **time** | **String** | Time of the event. | [optional] |
14
+ | **year** | **Integer** | Year of earnings result in the case of earnings call transcript. | [optional] |
15
+ | **quarter** | **Integer** | Quarter of earnings result in the case of earnings call transcript. | [optional] |
16
16
 
17
- ## Code Sample
17
+ ## Example
18
18
 
19
19
  ```ruby
20
- require 'FinnhubRuby'
20
+ require 'finnhub_ruby'
21
21
 
22
- instance = FinnhubRuby::EarningsCallTranscripts.new(symbol: null,
23
- transcript: null,
24
- participant: null,
25
- audio: null,
26
- id: null,
27
- title: null,
28
- time: null,
29
- year: null,
30
- quarter: null)
22
+ instance = FinnhubRuby::EarningsCallTranscripts.new(
23
+ symbol: null,
24
+ transcript: null,
25
+ participant: null,
26
+ audio: null,
27
+ id: null,
28
+ title: null,
29
+ time: null,
30
+ year: null,
31
+ quarter: null
32
+ )
31
33
  ```
32
34
 
33
-
data/docs/EarningsCallTranscriptsList.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
- **transcripts** | **Array<Object>** | Array of transcripts' metadata | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **symbol** | **String** | Company symbol. | [optional] |
8
+ | **transcripts** | [**Array<StockTranscripts>**](StockTranscripts.md) | Array of transcripts' metadata | [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::EarningsCallTranscriptsList.new(symbol: null,
16
- transcripts: null)
15
+ instance = FinnhubRuby::EarningsCallTranscriptsList.new(
16
+ symbol: null,
17
+ transcripts: null
18
+ )
17
19
  ```
18
20
 
19
-
data/docs/EarningsEstimates.md CHANGED
@@ -2,20 +2,21 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **data** | **Array<Object>** | List of estimates | [optional]
8
- **freq** | **String** | Frequency: annual or quarterly. | [optional]
9
- **symbol** | **String** | Company symbol. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Array<EarningsEstimatesInfo>**](EarningsEstimatesInfo.md) | List of estimates | [optional] |
8
+ | **freq** | **String** | Frequency: annual or quarterly. | [optional] |
9
+ | **symbol** | **String** | Company symbol. | [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::EarningsEstimates.new(data: null,
17
- freq: null,
18
- symbol: null)
16
+ instance = FinnhubRuby::EarningsEstimates.new(
17
+ data: null,
18
+ freq: null,
19
+ symbol: null
20
+ )
19
21
  ```
20
22
 
21
-
data/docs/EarningsEstimatesInfo.md ADDED
@@ -0,0 +1,26 @@
1
+ # FinnhubRuby::EarningsEstimatesInfo
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **eps_avg** | **Float** | Average EPS estimates including Finnhub's proprietary estimates. | [optional] |
8
+ | **eps_high** | **Float** | Highest estimate. | [optional] |
9
+ | **eps_low** | **Float** | Lowest estimate. | [optional] |
10
+ | **number_analysts** | **Integer** | Number of Analysts. | [optional] |
11
+ | **period** | **Date** | Period. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'finnhub_ruby'
17
+
18
+ instance = FinnhubRuby::EarningsEstimatesInfo.new(
19
+ eps_avg: null,
20
+ eps_high: null,
21
+ eps_low: null,
22
+ number_analysts: null,
23
+ period: null
24
+ )
25
+ ```
26
+
data/docs/EconomicCalendar.md CHANGED
@@ -2,16 +2,17 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **economic_calendar** | **Array<Object>** | Array of economic events. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **economic_calendar** | [**Array<EconomicEvent>**](EconomicEvent.md) | Array of economic events. | [optional] |
8
8
 
9
- ## Code Sample
9
+ ## Example
10
10
 
11
11
  ```ruby
12
- require 'FinnhubRuby'
12
+ require 'finnhub_ruby'
13
13
 
14
- instance = FinnhubRuby::EconomicCalendar.new(economic_calendar: null)
14
+ instance = FinnhubRuby::EconomicCalendar.new(
15
+ economic_calendar: null
16
+ )
15
17
  ```
16
18
 
17
-
data/docs/EconomicCode.md CHANGED
@@ -2,22 +2,23 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **code** | **String** | Finnhub economic code used to get historical data | [optional]
8
- **country** | **String** | Country | [optional]
9
- **name** | **String** | Indicator name | [optional]
10
- **unit** | **String** | Unit | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **code** | **String** | Finnhub economic code used to get historical data | [optional] |
8
+ | **country** | **String** | Country | [optional] |
9
+ | **name** | **String** | Indicator name | [optional] |
10
+ | **unit** | **String** | Unit | [optional] |
11
11
 
12
- ## Code Sample
12
+ ## Example
13
13
 
14
14
  ```ruby
15
- require 'FinnhubRuby'
15
+ require 'finnhub_ruby'
16
16
 
17
- instance = FinnhubRuby::EconomicCode.new(code: null,
18
- country: null,
19
- name: null,
20
- unit: null)
17
+ instance = FinnhubRuby::EconomicCode.new(
18
+ code: null,
19
+ country: null,
20
+ name: null,
21
+ unit: null
22
+ )
21
23
  ```
22
24
 
23
-
data/docs/EconomicData.md CHANGED
@@ -2,18 +2,19 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **data** | **Array<Object>** | Array of economic data for requested code. | [optional]
8
- **code** | **String** | Finnhub economic code | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Array<EconomicDataInfo>**](EconomicDataInfo.md) | Array of economic data for requested code. | [optional] |
8
+ | **code** | **String** | Finnhub economic code | [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::EconomicData.new(data: null,
16
- code: null)
15
+ instance = FinnhubRuby::EconomicData.new(
16
+ data: null,
17
+ code: null
18
+ )
17
19
  ```
18
20
 
19
-
data/docs/EconomicDataInfo.md ADDED
@@ -0,0 +1,20 @@
1
+ # FinnhubRuby::EconomicDataInfo
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **date** | **String** | Date of the reading | [optional] |
8
+ | **value** | **Float** | Value | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'finnhub_ruby'
14
+
15
+ instance = FinnhubRuby::EconomicDataInfo.new(
16
+ date: null,
17
+ value: null
18
+ )
19
+ ```
20
+
data/docs/EconomicEvent.md CHANGED
@@ -2,30 +2,31 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **actual** | **Float** | Actual release | [optional]
8
- **prev** | **Float** | Previous release | [optional]
9
- **country** | **String** | Country | [optional]
10
- **unit** | **String** | Unit | [optional]
11
- **estimate** | **Float** | Estimate | [optional]
12
- **event** | **String** | Event | [optional]
13
- **impact** | **String** | Impact level | [optional]
14
- **time** | **String** | Release time | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **actual** | **Float** | Actual release | [optional] |
8
+ | **prev** | **Float** | Previous release | [optional] |
9
+ | **country** | **String** | Country | [optional] |
10
+ | **unit** | **String** | Unit | [optional] |
11
+ | **estimate** | **Float** | Estimate | [optional] |
12
+ | **event** | **String** | Event | [optional] |
13
+ | **impact** | **String** | Impact level | [optional] |
14
+ | **time** | **String** | Release time | [optional] |
15
15
 
16
- ## Code Sample
16
+ ## Example
17
17
 
18
18
  ```ruby
19
- require 'FinnhubRuby'
19
+ require 'finnhub_ruby'
20
20
 
21
- instance = FinnhubRuby::EconomicEvent.new(actual: null,
22
- prev: null,
23
- country: null,
24
- unit: null,
25
- estimate: null,
26
- event: null,
27
- impact: null,
28
- time: null)
21
+ instance = FinnhubRuby::EconomicEvent.new(
22
+ actual: null,
23
+ prev: null,
24
+ country: null,
25
+ unit: null,
26
+ estimate: null,
27
+ event: null,
28
+ impact: null,
29
+ time: null
30
+ )
29
31
  ```
30
32
 
31
-
data/docs/Estimate.md CHANGED
@@ -2,24 +2,25 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **revenue_avg** | **Integer** | Average revenue estimates. | [optional]
8
- **revenue_high** | **Integer** | Highest estimate. | [optional]
9
- **revenue_low** | **Integer** | Lowest estimate. | [optional]
10
- **number_analysts** | **Integer** | Number of Analysts. | [optional]
11
- **period** | **Date** | Period. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **revenue_avg** | **Integer** | Average revenue estimates including Finnhub's proprietary estimates. | [optional] |
8
+ | **revenue_high** | **Integer** | Highest estimate. | [optional] |
9
+ | **revenue_low** | **Integer** | Lowest estimate. | [optional] |
10
+ | **number_analysts** | **Integer** | Number of Analysts. | [optional] |
11
+ | **period** | **Date** | Period. | [optional] |
12
12
 
13
- ## Code Sample
13
+ ## Example
14
14
 
15
15
  ```ruby
16
- require 'FinnhubRuby'
16
+ require 'finnhub_ruby'
17
17
 
18
- instance = FinnhubRuby::Estimate.new(revenue_avg: null,
19
- revenue_high: null,
20
- revenue_low: null,
21
- number_analysts: null,
22
- period: null)
18
+ instance = FinnhubRuby::Estimate.new(
19
+ revenue_avg: null,
20
+ revenue_high: null,
21
+ revenue_low: null,
22
+ number_analysts: null,
23
+ period: null
24
+ )
23
25
  ```
24
26
 
25
-