intrinio-sdk 5.20.0 → 6.21.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (596) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +24 -2
  3. data/docs/ApiResponseESGCompanies.md +24 -0
  4. data/docs/ApiResponseESGCompanyComprehensiveRatingHistory.md +28 -0
  5. data/docs/ApiResponseESGCompanyRatingHistory.md +28 -0
  6. data/docs/ApiResponseESGLatest.md +24 -0
  7. data/docs/ApiResponseESGLatestComprehensive.md +24 -0
  8. data/docs/CompanyApi.md +11 -11
  9. data/docs/ESGApi.md +432 -0
  10. data/docs/ESGCompanySummary.md +25 -0
  11. data/docs/ESGComprehensiveRating.md +58 -0
  12. data/docs/ESGComprehensiveRatingWithCompany.md +62 -0
  13. data/docs/ESGRating.md +24 -0
  14. data/docs/ESGRatingWithCompany.md +28 -0
  15. data/docs/ETFHolding.md +2 -1
  16. data/docs/ETFsApi.md +6 -6
  17. data/docs/FilingApi.md +10 -8
  18. data/docs/FundamentalsApi.md +103 -4
  19. data/docs/IndexApi.md +5 -3
  20. data/docs/OptionSnapshotGroup.md +21 -0
  21. data/docs/OptionSnapshotsResult.md +23 -0
  22. data/docs/OptionStatsRealtime.md +1 -0
  23. data/docs/OptionsApi.md +98 -13
  24. data/docs/OwnersApi.md +2 -2
  25. data/docs/SecurityApi.md +115 -34
  26. data/docs/SecuritySnapshotGroup.md +21 -0
  27. data/docs/SecuritySnapshotsResult.md +23 -0
  28. data/docs/StockExchangeApi.md +2 -0
  29. data/docs/TechnicalApi.md +31 -31
  30. data/git_push.sh +0 -0
  31. data/intrinio-sdk.gemspec +1 -1
  32. data/lib/intrinio-sdk/api/bulk_downloads_api.rb +1 -1
  33. data/lib/intrinio-sdk/api/company_api.rb +23 -23
  34. data/lib/intrinio-sdk/api/data_point_api.rb +1 -1
  35. data/lib/intrinio-sdk/api/data_tag_api.rb +1 -1
  36. data/lib/intrinio-sdk/api/esg_api.rb +335 -0
  37. data/lib/intrinio-sdk/api/et_fs_api.rb +13 -13
  38. data/lib/intrinio-sdk/api/filing_api.rb +19 -23
  39. data/lib/intrinio-sdk/api/forex_api.rb +1 -1
  40. data/lib/intrinio-sdk/api/fundamentals_api.rb +95 -9
  41. data/lib/intrinio-sdk/api/historical_data_api.rb +1 -1
  42. data/lib/intrinio-sdk/api/index_api.rb +11 -11
  43. data/lib/intrinio-sdk/api/insider_transaction_filings_api.rb +1 -1
  44. data/lib/intrinio-sdk/api/municipality_api.rb +1 -1
  45. data/lib/intrinio-sdk/api/options_api.rb +84 -25
  46. data/lib/intrinio-sdk/api/owners_api.rb +3 -3
  47. data/lib/intrinio-sdk/api/security_api.rb +119 -69
  48. data/lib/intrinio-sdk/api/stock_exchange_api.rb +4 -1
  49. data/lib/intrinio-sdk/api/technical_api.rb +63 -63
  50. data/lib/intrinio-sdk/api/zacks_api.rb +1 -1
  51. data/lib/intrinio-sdk/api_client.rb +1 -1
  52. data/lib/intrinio-sdk/api_error.rb +1 -1
  53. data/lib/intrinio-sdk/configuration.rb +1 -1
  54. data/lib/intrinio-sdk/models/accumulation_distribution_index_technical_value.rb +1 -1
  55. data/lib/intrinio-sdk/models/api_response_bulk_download_links.rb +1 -1
  56. data/lib/intrinio-sdk/models/api_response_companies.rb +1 -1
  57. data/lib/intrinio-sdk/models/api_response_companies_search.rb +1 -1
  58. data/lib/intrinio-sdk/models/api_response_company_answers.rb +1 -1
  59. data/lib/intrinio-sdk/models/api_response_company_filings.rb +1 -1
  60. data/lib/intrinio-sdk/models/api_response_company_fundamentals.rb +1 -1
  61. data/lib/intrinio-sdk/models/api_response_company_historical_data.rb +1 -1
  62. data/lib/intrinio-sdk/models/api_response_company_insider_transaction_filings.rb +1 -1
  63. data/lib/intrinio-sdk/models/api_response_company_news.rb +1 -1
  64. data/lib/intrinio-sdk/models/api_response_company_recognize.rb +1 -1
  65. data/lib/intrinio-sdk/models/api_response_company_securities.rb +1 -1
  66. data/lib/intrinio-sdk/models/api_response_company_shares_outstanding.rb +1 -1
  67. data/lib/intrinio-sdk/models/api_response_data_tags.rb +1 -1
  68. data/lib/intrinio-sdk/models/api_response_data_tags_search.rb +1 -1
  69. data/lib/intrinio-sdk/models/api_response_economic_index_historical_data.rb +1 -1
  70. data/lib/intrinio-sdk/models/api_response_economic_indices.rb +1 -1
  71. data/lib/intrinio-sdk/models/api_response_economic_indices_search.rb +1 -1
  72. data/lib/intrinio-sdk/models/api_response_esg_companies.rb +200 -0
  73. data/lib/intrinio-sdk/models/api_response_esg_company_comprehensive_rating_history.rb +209 -0
  74. data/lib/intrinio-sdk/models/api_response_esg_company_rating_history.rb +209 -0
  75. data/lib/intrinio-sdk/models/api_response_esg_latest.rb +200 -0
  76. data/lib/intrinio-sdk/models/api_response_esg_latest_comprehensive.rb +200 -0
  77. data/lib/intrinio-sdk/models/api_response_et_fs.rb +1 -1
  78. data/lib/intrinio-sdk/models/api_response_etf_holdings.rb +1 -1
  79. data/lib/intrinio-sdk/models/api_response_filing_answers.rb +1 -1
  80. data/lib/intrinio-sdk/models/api_response_filing_fundamentals.rb +1 -1
  81. data/lib/intrinio-sdk/models/api_response_filing_notes.rb +1 -1
  82. data/lib/intrinio-sdk/models/api_response_filing_notes_search.rb +1 -1
  83. data/lib/intrinio-sdk/models/api_response_filings.rb +1 -1
  84. data/lib/intrinio-sdk/models/api_response_forex_currencies.rb +1 -1
  85. data/lib/intrinio-sdk/models/api_response_forex_pairs.rb +1 -1
  86. data/lib/intrinio-sdk/models/api_response_forex_prices.rb +1 -1
  87. data/lib/intrinio-sdk/models/api_response_historical_data.rb +1 -1
  88. data/lib/intrinio-sdk/models/api_response_initial_public_offerings.rb +1 -1
  89. data/lib/intrinio-sdk/models/api_response_insider_transaction_filings.rb +1 -1
  90. data/lib/intrinio-sdk/models/api_response_municipalities.rb +1 -1
  91. data/lib/intrinio-sdk/models/api_response_municipalitiy_financials.rb +1 -1
  92. data/lib/intrinio-sdk/models/api_response_news.rb +1 -1
  93. data/lib/intrinio-sdk/models/api_response_option_prices.rb +1 -1
  94. data/lib/intrinio-sdk/models/api_response_options.rb +1 -1
  95. data/lib/intrinio-sdk/models/api_response_options_chain.rb +1 -1
  96. data/lib/intrinio-sdk/models/api_response_options_chain_eod.rb +1 -1
  97. data/lib/intrinio-sdk/models/api_response_options_chain_realtime.rb +1 -1
  98. data/lib/intrinio-sdk/models/api_response_options_expirations.rb +1 -1
  99. data/lib/intrinio-sdk/models/api_response_options_price_realtime.rb +1 -1
  100. data/lib/intrinio-sdk/models/api_response_options_prices_batch_realtime.rb +1 -1
  101. data/lib/intrinio-sdk/models/api_response_options_prices_eod.rb +1 -1
  102. data/lib/intrinio-sdk/models/api_response_options_realtime.rb +1 -1
  103. data/lib/intrinio-sdk/models/api_response_options_stats_realtime.rb +1 -1
  104. data/lib/intrinio-sdk/models/api_response_options_tickers.rb +1 -1
  105. data/lib/intrinio-sdk/models/api_response_options_unusual_activity.rb +1 -1
  106. data/lib/intrinio-sdk/models/api_response_owner_insider_transaction_filings.rb +1 -1
  107. data/lib/intrinio-sdk/models/api_response_owner_institutional_holdings.rb +1 -1
  108. data/lib/intrinio-sdk/models/api_response_owners.rb +1 -1
  109. data/lib/intrinio-sdk/models/api_response_reported_financials.rb +1 -1
  110. data/lib/intrinio-sdk/models/api_response_securities.rb +1 -1
  111. data/lib/intrinio-sdk/models/api_response_securities_search.rb +1 -1
  112. data/lib/intrinio-sdk/models/api_response_security_accumulation_distribution_index.rb +1 -1
  113. data/lib/intrinio-sdk/models/api_response_security_average_daily_trading_volume.rb +1 -1
  114. data/lib/intrinio-sdk/models/api_response_security_average_directional_index.rb +1 -1
  115. data/lib/intrinio-sdk/models/api_response_security_average_true_range.rb +1 -1
  116. data/lib/intrinio-sdk/models/api_response_security_awesome_oscillator.rb +1 -1
  117. data/lib/intrinio-sdk/models/api_response_security_bollinger_bands.rb +1 -1
  118. data/lib/intrinio-sdk/models/api_response_security_chaikin_money_flow.rb +1 -1
  119. data/lib/intrinio-sdk/models/api_response_security_commodity_channel_index.rb +1 -1
  120. data/lib/intrinio-sdk/models/api_response_security_detrended_price_oscillator.rb +1 -1
  121. data/lib/intrinio-sdk/models/api_response_security_donchian_channel.rb +1 -1
  122. data/lib/intrinio-sdk/models/api_response_security_ease_of_movement.rb +1 -1
  123. data/lib/intrinio-sdk/models/api_response_security_force_index.rb +1 -1
  124. data/lib/intrinio-sdk/models/api_response_security_historical_data.rb +1 -1
  125. data/lib/intrinio-sdk/models/api_response_security_ichimoku_kinko_hyo.rb +1 -1
  126. data/lib/intrinio-sdk/models/api_response_security_institutional_ownership.rb +1 -1
  127. data/lib/intrinio-sdk/models/api_response_security_interval_prices.rb +1 -1
  128. data/lib/intrinio-sdk/models/api_response_security_intraday_prices.rb +1 -1
  129. data/lib/intrinio-sdk/models/api_response_security_keltner_channel.rb +1 -1
  130. data/lib/intrinio-sdk/models/api_response_security_know_sure_thing.rb +1 -1
  131. data/lib/intrinio-sdk/models/api_response_security_mass_index.rb +1 -1
  132. data/lib/intrinio-sdk/models/api_response_security_money_flow_index.rb +1 -1
  133. data/lib/intrinio-sdk/models/api_response_security_moving_average_convergence_divergence.rb +1 -1
  134. data/lib/intrinio-sdk/models/api_response_security_negative_volume_index.rb +1 -1
  135. data/lib/intrinio-sdk/models/api_response_security_on_balance_volume.rb +1 -1
  136. data/lib/intrinio-sdk/models/api_response_security_on_balance_volume_mean.rb +1 -1
  137. data/lib/intrinio-sdk/models/api_response_security_relative_strength_index.rb +1 -1
  138. data/lib/intrinio-sdk/models/api_response_security_simple_moving_average.rb +1 -1
  139. data/lib/intrinio-sdk/models/api_response_security_stochastic_oscillator.rb +1 -1
  140. data/lib/intrinio-sdk/models/api_response_security_stock_price_adjustments.rb +1 -1
  141. data/lib/intrinio-sdk/models/api_response_security_stock_prices.rb +1 -1
  142. data/lib/intrinio-sdk/models/api_response_security_triple_exponential_average.rb +1 -1
  143. data/lib/intrinio-sdk/models/api_response_security_true_strength_index.rb +1 -1
  144. data/lib/intrinio-sdk/models/api_response_security_ultimate_oscillator.rb +1 -1
  145. data/lib/intrinio-sdk/models/api_response_security_volume_price_trend.rb +1 -1
  146. data/lib/intrinio-sdk/models/api_response_security_volume_weighted_average_price.rb +1 -1
  147. data/lib/intrinio-sdk/models/api_response_security_vortex_indicator.rb +1 -1
  148. data/lib/intrinio-sdk/models/api_response_security_williams_r.rb +1 -1
  149. data/lib/intrinio-sdk/models/api_response_security_zacks_analyst_ratings.rb +1 -1
  150. data/lib/intrinio-sdk/models/api_response_security_zacks_analyst_ratings_snapshot.rb +1 -1
  151. data/lib/intrinio-sdk/models/api_response_security_zacks_eps_surprises.rb +1 -1
  152. data/lib/intrinio-sdk/models/api_response_security_zacks_sales_surprises.rb +1 -1
  153. data/lib/intrinio-sdk/models/api_response_sic_index_historical_data.rb +1 -1
  154. data/lib/intrinio-sdk/models/api_response_sic_indices.rb +1 -1
  155. data/lib/intrinio-sdk/models/api_response_sic_indices_search.rb +1 -1
  156. data/lib/intrinio-sdk/models/api_response_standardized_financials.rb +1 -1
  157. data/lib/intrinio-sdk/models/api_response_standardized_financials_dimensions.rb +1 -1
  158. data/lib/intrinio-sdk/models/api_response_stock_exchange_realtime_stock_prices.rb +1 -1
  159. data/lib/intrinio-sdk/models/api_response_stock_exchange_securities.rb +1 -1
  160. data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_price_adjustments.rb +1 -1
  161. data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_prices.rb +1 -1
  162. data/lib/intrinio-sdk/models/api_response_stock_exchanges.rb +1 -1
  163. data/lib/intrinio-sdk/models/api_response_stock_market_index_historical_data.rb +1 -1
  164. data/lib/intrinio-sdk/models/api_response_stock_market_indices.rb +1 -1
  165. data/lib/intrinio-sdk/models/api_response_stock_market_indices_search.rb +1 -1
  166. data/lib/intrinio-sdk/models/api_response_zacks_analyst_ratings.rb +1 -1
  167. data/lib/intrinio-sdk/models/api_response_zacks_eps_estimates.rb +1 -1
  168. data/lib/intrinio-sdk/models/api_response_zacks_eps_growth_rates.rb +1 -1
  169. data/lib/intrinio-sdk/models/api_response_zacks_eps_surprises.rb +1 -1
  170. data/lib/intrinio-sdk/models/api_response_zacks_etf_holdings.rb +1 -1
  171. data/lib/intrinio-sdk/models/api_response_zacks_institutional_holding_companies.rb +1 -1
  172. data/lib/intrinio-sdk/models/api_response_zacks_institutional_holding_owners.rb +1 -1
  173. data/lib/intrinio-sdk/models/api_response_zacks_institutional_holdings.rb +1 -1
  174. data/lib/intrinio-sdk/models/api_response_zacks_long_term_growth_rates.rb +1 -1
  175. data/lib/intrinio-sdk/models/api_response_zacks_sales_surprises.rb +1 -1
  176. data/lib/intrinio-sdk/models/api_response_zacks_target_price_consensuses.rb +1 -1
  177. data/lib/intrinio-sdk/models/average_daily_trading_volume_technical_value.rb +1 -1
  178. data/lib/intrinio-sdk/models/average_directional_index_technical_value.rb +1 -1
  179. data/lib/intrinio-sdk/models/average_true_range_technical_value.rb +1 -1
  180. data/lib/intrinio-sdk/models/awesome_oscillator_technical_value.rb +1 -1
  181. data/lib/intrinio-sdk/models/bollinger_bands_technical_value.rb +1 -1
  182. data/lib/intrinio-sdk/models/bulk_download_links.rb +1 -1
  183. data/lib/intrinio-sdk/models/bulk_download_summary.rb +1 -1
  184. data/lib/intrinio-sdk/models/chaikin_money_flow_technical_value.rb +1 -1
  185. data/lib/intrinio-sdk/models/commodity_channel_index_technical_value.rb +1 -1
  186. data/lib/intrinio-sdk/models/company.rb +1 -1
  187. data/lib/intrinio-sdk/models/company_filing.rb +1 -1
  188. data/lib/intrinio-sdk/models/company_initial_public_offering.rb +1 -1
  189. data/lib/intrinio-sdk/models/company_news.rb +1 -1
  190. data/lib/intrinio-sdk/models/company_news_summary.rb +1 -1
  191. data/lib/intrinio-sdk/models/company_shares_outstanding.rb +1 -1
  192. data/lib/intrinio-sdk/models/company_summary.rb +1 -1
  193. data/lib/intrinio-sdk/models/data_tag.rb +1 -1
  194. data/lib/intrinio-sdk/models/data_tag_summary.rb +1 -1
  195. data/lib/intrinio-sdk/models/detrended_price_oscillator_technical_value.rb +1 -1
  196. data/lib/intrinio-sdk/models/dividend_record.rb +1 -1
  197. data/lib/intrinio-sdk/models/donchian_channel_technical_value.rb +1 -1
  198. data/lib/intrinio-sdk/models/earnings_record.rb +1 -1
  199. data/lib/intrinio-sdk/models/ease_of_movement_technical_value.rb +1 -1
  200. data/lib/intrinio-sdk/models/economic_index.rb +1 -1
  201. data/lib/intrinio-sdk/models/economic_index_summary.rb +1 -1
  202. data/lib/intrinio-sdk/models/esg_company_summary.rb +239 -0
  203. data/lib/intrinio-sdk/models/esg_comprehensive_rating.rb +569 -0
  204. data/lib/intrinio-sdk/models/esg_comprehensive_rating_with_company.rb +578 -0
  205. data/lib/intrinio-sdk/models/esg_rating.rb +229 -0
  206. data/lib/intrinio-sdk/models/esg_rating_with_company.rb +238 -0
  207. data/lib/intrinio-sdk/models/etf.rb +1 -1
  208. data/lib/intrinio-sdk/models/etf_analytics.rb +1 -1
  209. data/lib/intrinio-sdk/models/etf_holding.rb +13 -3
  210. data/lib/intrinio-sdk/models/etf_stats.rb +1 -1
  211. data/lib/intrinio-sdk/models/etf_summary.rb +1 -1
  212. data/lib/intrinio-sdk/models/filing.rb +1 -1
  213. data/lib/intrinio-sdk/models/filing_note.rb +1 -1
  214. data/lib/intrinio-sdk/models/filing_note_filing.rb +1 -1
  215. data/lib/intrinio-sdk/models/filing_note_summary.rb +1 -1
  216. data/lib/intrinio-sdk/models/filing_summary.rb +1 -1
  217. data/lib/intrinio-sdk/models/force_index_technical_value.rb +1 -1
  218. data/lib/intrinio-sdk/models/forex_currency.rb +1 -1
  219. data/lib/intrinio-sdk/models/forex_pair.rb +1 -1
  220. data/lib/intrinio-sdk/models/forex_price.rb +1 -1
  221. data/lib/intrinio-sdk/models/fundamental.rb +1 -1
  222. data/lib/intrinio-sdk/models/fundamental_summary.rb +1 -1
  223. data/lib/intrinio-sdk/models/historical_data.rb +1 -1
  224. data/lib/intrinio-sdk/models/ichimoku_kinko_hyo_technical_value.rb +1 -1
  225. data/lib/intrinio-sdk/models/insider_transaction.rb +1 -1
  226. data/lib/intrinio-sdk/models/insider_transaction_filing.rb +1 -1
  227. data/lib/intrinio-sdk/models/institutional_holding.rb +1 -1
  228. data/lib/intrinio-sdk/models/institutional_ownership.rb +1 -1
  229. data/lib/intrinio-sdk/models/intraday_stock_price.rb +1 -1
  230. data/lib/intrinio-sdk/models/keltner_channel_technical_value.rb +1 -1
  231. data/lib/intrinio-sdk/models/know_sure_thing_technical_value.rb +1 -1
  232. data/lib/intrinio-sdk/models/mass_index_technical_value.rb +1 -1
  233. data/lib/intrinio-sdk/models/money_flow_index_technical_value.rb +1 -1
  234. data/lib/intrinio-sdk/models/moving_average_convergence_divergence_technical_value.rb +1 -1
  235. data/lib/intrinio-sdk/models/municipality.rb +1 -1
  236. data/lib/intrinio-sdk/models/municipality_financial.rb +1 -1
  237. data/lib/intrinio-sdk/models/negative_volume_index_technical_value.rb +1 -1
  238. data/lib/intrinio-sdk/models/on_balance_volume_mean_technical_value.rb +1 -1
  239. data/lib/intrinio-sdk/models/on_balance_volume_technical_value.rb +1 -1
  240. data/lib/intrinio-sdk/models/option.rb +1 -1
  241. data/lib/intrinio-sdk/models/option_chain.rb +1 -1
  242. data/lib/intrinio-sdk/models/option_chain_eod.rb +1 -1
  243. data/lib/intrinio-sdk/models/option_chain_realtime.rb +1 -1
  244. data/lib/intrinio-sdk/models/option_contracts_list.rb +1 -1
  245. data/lib/intrinio-sdk/models/option_eod.rb +1 -1
  246. data/lib/intrinio-sdk/models/option_factors_realtime.rb +1 -1
  247. data/lib/intrinio-sdk/models/option_price.rb +1 -1
  248. data/lib/intrinio-sdk/models/option_price_batch_realtime.rb +1 -1
  249. data/lib/intrinio-sdk/models/option_price_eod.rb +1 -1
  250. data/lib/intrinio-sdk/models/option_price_realtime.rb +1 -1
  251. data/lib/intrinio-sdk/models/option_realtime.rb +1 -1
  252. data/lib/intrinio-sdk/models/option_snapshot_group.rb +201 -0
  253. data/lib/intrinio-sdk/models/option_snapshots_result.rb +191 -0
  254. data/lib/intrinio-sdk/models/option_stats_realtime.rb +15 -5
  255. data/lib/intrinio-sdk/models/option_unusual_trade.rb +1 -1
  256. data/lib/intrinio-sdk/models/owner.rb +1 -1
  257. data/lib/intrinio-sdk/models/owner_summary.rb +1 -1
  258. data/lib/intrinio-sdk/models/realtime_stock_price.rb +1 -1
  259. data/lib/intrinio-sdk/models/realtime_stock_price_security.rb +1 -1
  260. data/lib/intrinio-sdk/models/relative_strength_index_technical_value.rb +1 -1
  261. data/lib/intrinio-sdk/models/reported_financial.rb +1 -1
  262. data/lib/intrinio-sdk/models/reported_financial_dimension.rb +1 -1
  263. data/lib/intrinio-sdk/models/reported_tag.rb +1 -1
  264. data/lib/intrinio-sdk/models/security.rb +1 -1
  265. data/lib/intrinio-sdk/models/security_screen_clause.rb +1 -1
  266. data/lib/intrinio-sdk/models/security_screen_group.rb +1 -1
  267. data/lib/intrinio-sdk/models/security_screen_result.rb +1 -1
  268. data/lib/intrinio-sdk/models/security_screen_result_data.rb +1 -1
  269. data/lib/intrinio-sdk/models/security_snapshot_group.rb +201 -0
  270. data/lib/intrinio-sdk/models/security_snapshots_result.rb +191 -0
  271. data/lib/intrinio-sdk/models/security_summary.rb +1 -1
  272. data/lib/intrinio-sdk/models/sic_index.rb +1 -1
  273. data/lib/intrinio-sdk/models/simple_moving_average_technical_value.rb +1 -1
  274. data/lib/intrinio-sdk/models/standardized_financial.rb +1 -1
  275. data/lib/intrinio-sdk/models/standardized_financials_dimension.rb +1 -1
  276. data/lib/intrinio-sdk/models/stochastic_oscillator_technical_value.rb +1 -1
  277. data/lib/intrinio-sdk/models/stock_exchange.rb +1 -1
  278. data/lib/intrinio-sdk/models/stock_market_index.rb +1 -1
  279. data/lib/intrinio-sdk/models/stock_market_index_summary.rb +1 -1
  280. data/lib/intrinio-sdk/models/stock_price.rb +1 -1
  281. data/lib/intrinio-sdk/models/stock_price_adjustment.rb +1 -1
  282. data/lib/intrinio-sdk/models/stock_price_adjustment_summary.rb +1 -1
  283. data/lib/intrinio-sdk/models/stock_price_interval.rb +1 -1
  284. data/lib/intrinio-sdk/models/stock_price_summary.rb +1 -1
  285. data/lib/intrinio-sdk/models/technical_indicator.rb +1 -1
  286. data/lib/intrinio-sdk/models/thea_entity_answer.rb +1 -1
  287. data/lib/intrinio-sdk/models/thea_source_document.rb +1 -1
  288. data/lib/intrinio-sdk/models/triple_exponential_average_technical_value.rb +1 -1
  289. data/lib/intrinio-sdk/models/true_strength_index_technical_value.rb +1 -1
  290. data/lib/intrinio-sdk/models/ultimate_oscillator_technical_value.rb +1 -1
  291. data/lib/intrinio-sdk/models/volume_price_trend_technical_value.rb +1 -1
  292. data/lib/intrinio-sdk/models/volume_weighted_average_price_value.rb +1 -1
  293. data/lib/intrinio-sdk/models/vortex_indicator_technical_value.rb +1 -1
  294. data/lib/intrinio-sdk/models/williams_r_technical_value.rb +1 -1
  295. data/lib/intrinio-sdk/models/zacks_analyst_rating.rb +1 -1
  296. data/lib/intrinio-sdk/models/zacks_analyst_rating_snapshot.rb +1 -1
  297. data/lib/intrinio-sdk/models/zacks_analyst_rating_summary.rb +1 -1
  298. data/lib/intrinio-sdk/models/zacks_eps_estimate.rb +1 -1
  299. data/lib/intrinio-sdk/models/zacks_eps_growth_rate.rb +1 -1
  300. data/lib/intrinio-sdk/models/zacks_eps_surprise.rb +1 -1
  301. data/lib/intrinio-sdk/models/zacks_eps_surprise_summary.rb +1 -1
  302. data/lib/intrinio-sdk/models/zacks_etf_holding.rb +1 -1
  303. data/lib/intrinio-sdk/models/zacks_institutional_holding.rb +1 -1
  304. data/lib/intrinio-sdk/models/zacks_institutional_holding_company_detail.rb +1 -1
  305. data/lib/intrinio-sdk/models/zacks_institutional_holding_company_summary.rb +1 -1
  306. data/lib/intrinio-sdk/models/zacks_institutional_holding_historical_summary.rb +1 -1
  307. data/lib/intrinio-sdk/models/zacks_institutional_holding_owner_detail.rb +1 -1
  308. data/lib/intrinio-sdk/models/zacks_institutional_holding_owner_summary.rb +1 -1
  309. data/lib/intrinio-sdk/models/zacks_long_term_growth_rate.rb +1 -1
  310. data/lib/intrinio-sdk/models/zacks_sales_surprise.rb +1 -1
  311. data/lib/intrinio-sdk/models/zacks_sales_surprise_summary.rb +1 -1
  312. data/lib/intrinio-sdk/models/zacks_target_price_consensus.rb +1 -1
  313. data/lib/intrinio-sdk/version.rb +2 -2
  314. data/lib/intrinio-sdk.rb +16 -1
  315. data/spec/api/bulk_downloads_api_spec.rb +1 -1
  316. data/spec/api/company_api_spec.rb +12 -12
  317. data/spec/api/data_point_api_spec.rb +1 -1
  318. data/spec/api/data_tag_api_spec.rb +1 -1
  319. data/spec/api/esg_api_spec.rb +107 -0
  320. data/spec/api/et_fs_api_spec.rb +7 -7
  321. data/spec/api/filing_api_spec.rb +8 -8
  322. data/spec/api/forex_api_spec.rb +1 -1
  323. data/spec/api/fundamentals_api_spec.rb +26 -5
  324. data/spec/api/historical_data_api_spec.rb +1 -1
  325. data/spec/api/index_api_spec.rb +6 -6
  326. data/spec/api/insider_transaction_filings_api_spec.rb +1 -1
  327. data/spec/api/municipality_api_spec.rb +1 -1
  328. data/spec/api/options_api_spec.rb +27 -13
  329. data/spec/api/owners_api_spec.rb +2 -2
  330. data/spec/api/security_api_spec.rb +47 -35
  331. data/spec/api/stock_exchange_api_spec.rb +2 -1
  332. data/spec/api/technical_api_spec.rb +32 -32
  333. data/spec/api/zacks_api_spec.rb +1 -1
  334. data/spec/api_client_spec.rb +1 -1
  335. data/spec/configuration_spec.rb +1 -1
  336. data/spec/models/accumulation_distribution_index_technical_value_spec.rb +1 -1
  337. data/spec/models/api_response_bulk_download_links_spec.rb +1 -1
  338. data/spec/models/api_response_companies_search_spec.rb +1 -1
  339. data/spec/models/api_response_companies_spec.rb +1 -1
  340. data/spec/models/api_response_company_answers_spec.rb +1 -1
  341. data/spec/models/api_response_company_filings_spec.rb +1 -1
  342. data/spec/models/api_response_company_fundamentals_spec.rb +1 -1
  343. data/spec/models/api_response_company_historical_data_spec.rb +1 -1
  344. data/spec/models/api_response_company_insider_transaction_filings_spec.rb +1 -1
  345. data/spec/models/api_response_company_news_spec.rb +1 -1
  346. data/spec/models/api_response_company_recognize_spec.rb +1 -1
  347. data/spec/models/api_response_company_securities_spec.rb +1 -1
  348. data/spec/models/api_response_company_shares_outstanding_spec.rb +1 -1
  349. data/spec/models/api_response_data_tags_search_spec.rb +1 -1
  350. data/spec/models/api_response_data_tags_spec.rb +1 -1
  351. data/spec/models/api_response_economic_index_historical_data_spec.rb +1 -1
  352. data/spec/models/api_response_economic_indices_search_spec.rb +1 -1
  353. data/spec/models/api_response_economic_indices_spec.rb +1 -1
  354. data/spec/models/api_response_esg_companies_spec.rb +48 -0
  355. data/spec/models/api_response_esg_company_comprehensive_rating_history_spec.rb +54 -0
  356. data/spec/models/api_response_esg_company_rating_history_spec.rb +54 -0
  357. data/spec/models/api_response_esg_latest_comprehensive_spec.rb +48 -0
  358. data/spec/models/api_response_esg_latest_spec.rb +48 -0
  359. data/spec/models/api_response_et_fs_spec.rb +1 -1
  360. data/spec/models/api_response_etf_holdings_spec.rb +1 -1
  361. data/spec/models/api_response_filing_answers_spec.rb +1 -1
  362. data/spec/models/api_response_filing_fundamentals_spec.rb +1 -1
  363. data/spec/models/api_response_filing_notes_search_spec.rb +1 -1
  364. data/spec/models/api_response_filing_notes_spec.rb +1 -1
  365. data/spec/models/api_response_filings_spec.rb +1 -1
  366. data/spec/models/api_response_forex_currencies_spec.rb +1 -1
  367. data/spec/models/api_response_forex_pairs_spec.rb +1 -1
  368. data/spec/models/api_response_forex_prices_spec.rb +1 -1
  369. data/spec/models/api_response_historical_data_spec.rb +1 -1
  370. data/spec/models/api_response_initial_public_offerings_spec.rb +1 -1
  371. data/spec/models/api_response_insider_transaction_filings_spec.rb +1 -1
  372. data/spec/models/api_response_municipalities_spec.rb +1 -1
  373. data/spec/models/api_response_municipalitiy_financials_spec.rb +1 -1
  374. data/spec/models/api_response_news_spec.rb +1 -1
  375. data/spec/models/api_response_option_prices_spec.rb +1 -1
  376. data/spec/models/api_response_options_chain_eod_spec.rb +1 -1
  377. data/spec/models/api_response_options_chain_realtime_spec.rb +1 -1
  378. data/spec/models/api_response_options_chain_spec.rb +1 -1
  379. data/spec/models/api_response_options_expirations_spec.rb +1 -1
  380. data/spec/models/api_response_options_price_realtime_spec.rb +1 -1
  381. data/spec/models/api_response_options_prices_batch_realtime_spec.rb +1 -1
  382. data/spec/models/api_response_options_prices_eod_spec.rb +1 -1
  383. data/spec/models/api_response_options_realtime_spec.rb +1 -1
  384. data/spec/models/api_response_options_spec.rb +1 -1
  385. data/spec/models/api_response_options_stats_realtime_spec.rb +1 -1
  386. data/spec/models/api_response_options_tickers_spec.rb +1 -1
  387. data/spec/models/api_response_options_unusual_activity_spec.rb +1 -1
  388. data/spec/models/api_response_owner_insider_transaction_filings_spec.rb +1 -1
  389. data/spec/models/api_response_owner_institutional_holdings_spec.rb +1 -1
  390. data/spec/models/api_response_owners_spec.rb +1 -1
  391. data/spec/models/api_response_reported_financials_spec.rb +1 -1
  392. data/spec/models/api_response_securities_search_spec.rb +1 -1
  393. data/spec/models/api_response_securities_spec.rb +1 -1
  394. data/spec/models/api_response_security_accumulation_distribution_index_spec.rb +1 -1
  395. data/spec/models/api_response_security_average_daily_trading_volume_spec.rb +1 -1
  396. data/spec/models/api_response_security_average_directional_index_spec.rb +1 -1
  397. data/spec/models/api_response_security_average_true_range_spec.rb +1 -1
  398. data/spec/models/api_response_security_awesome_oscillator_spec.rb +1 -1
  399. data/spec/models/api_response_security_bollinger_bands_spec.rb +1 -1
  400. data/spec/models/api_response_security_chaikin_money_flow_spec.rb +1 -1
  401. data/spec/models/api_response_security_commodity_channel_index_spec.rb +1 -1
  402. data/spec/models/api_response_security_detrended_price_oscillator_spec.rb +1 -1
  403. data/spec/models/api_response_security_donchian_channel_spec.rb +1 -1
  404. data/spec/models/api_response_security_ease_of_movement_spec.rb +1 -1
  405. data/spec/models/api_response_security_force_index_spec.rb +1 -1
  406. data/spec/models/api_response_security_historical_data_spec.rb +1 -1
  407. data/spec/models/api_response_security_ichimoku_kinko_hyo_spec.rb +1 -1
  408. data/spec/models/api_response_security_institutional_ownership_spec.rb +1 -1
  409. data/spec/models/api_response_security_interval_prices_spec.rb +1 -1
  410. data/spec/models/api_response_security_intraday_prices_spec.rb +1 -1
  411. data/spec/models/api_response_security_keltner_channel_spec.rb +1 -1
  412. data/spec/models/api_response_security_know_sure_thing_spec.rb +1 -1
  413. data/spec/models/api_response_security_mass_index_spec.rb +1 -1
  414. data/spec/models/api_response_security_money_flow_index_spec.rb +1 -1
  415. data/spec/models/api_response_security_moving_average_convergence_divergence_spec.rb +1 -1
  416. data/spec/models/api_response_security_negative_volume_index_spec.rb +1 -1
  417. data/spec/models/api_response_security_on_balance_volume_mean_spec.rb +1 -1
  418. data/spec/models/api_response_security_on_balance_volume_spec.rb +1 -1
  419. data/spec/models/api_response_security_relative_strength_index_spec.rb +1 -1
  420. data/spec/models/api_response_security_simple_moving_average_spec.rb +1 -1
  421. data/spec/models/api_response_security_stochastic_oscillator_spec.rb +1 -1
  422. data/spec/models/api_response_security_stock_price_adjustments_spec.rb +1 -1
  423. data/spec/models/api_response_security_stock_prices_spec.rb +1 -1
  424. data/spec/models/api_response_security_triple_exponential_average_spec.rb +1 -1
  425. data/spec/models/api_response_security_true_strength_index_spec.rb +1 -1
  426. data/spec/models/api_response_security_ultimate_oscillator_spec.rb +1 -1
  427. data/spec/models/api_response_security_volume_price_trend_spec.rb +1 -1
  428. data/spec/models/api_response_security_volume_weighted_average_price_spec.rb +1 -1
  429. data/spec/models/api_response_security_vortex_indicator_spec.rb +1 -1
  430. data/spec/models/api_response_security_williams_r_spec.rb +1 -1
  431. data/spec/models/api_response_security_zacks_analyst_ratings_snapshot_spec.rb +1 -1
  432. data/spec/models/api_response_security_zacks_analyst_ratings_spec.rb +1 -1
  433. data/spec/models/api_response_security_zacks_eps_surprises_spec.rb +1 -1
  434. data/spec/models/api_response_security_zacks_sales_surprises_spec.rb +1 -1
  435. data/spec/models/api_response_sic_index_historical_data_spec.rb +1 -1
  436. data/spec/models/api_response_sic_indices_search_spec.rb +1 -1
  437. data/spec/models/api_response_sic_indices_spec.rb +1 -1
  438. data/spec/models/api_response_standardized_financials_dimensions_spec.rb +1 -1
  439. data/spec/models/api_response_standardized_financials_spec.rb +1 -1
  440. data/spec/models/api_response_stock_exchange_realtime_stock_prices_spec.rb +1 -1
  441. data/spec/models/api_response_stock_exchange_securities_spec.rb +1 -1
  442. data/spec/models/api_response_stock_exchange_stock_price_adjustments_spec.rb +1 -1
  443. data/spec/models/api_response_stock_exchange_stock_prices_spec.rb +1 -1
  444. data/spec/models/api_response_stock_exchanges_spec.rb +1 -1
  445. data/spec/models/api_response_stock_market_index_historical_data_spec.rb +1 -1
  446. data/spec/models/api_response_stock_market_indices_search_spec.rb +1 -1
  447. data/spec/models/api_response_stock_market_indices_spec.rb +1 -1
  448. data/spec/models/api_response_zacks_analyst_ratings_spec.rb +1 -1
  449. data/spec/models/api_response_zacks_eps_estimates_spec.rb +1 -1
  450. data/spec/models/api_response_zacks_eps_growth_rates_spec.rb +1 -1
  451. data/spec/models/api_response_zacks_eps_surprises_spec.rb +1 -1
  452. data/spec/models/api_response_zacks_etf_holdings_spec.rb +1 -1
  453. data/spec/models/api_response_zacks_institutional_holding_companies_spec.rb +1 -1
  454. data/spec/models/api_response_zacks_institutional_holding_owners_spec.rb +1 -1
  455. data/spec/models/api_response_zacks_institutional_holdings_spec.rb +1 -1
  456. data/spec/models/api_response_zacks_long_term_growth_rates_spec.rb +1 -1
  457. data/spec/models/api_response_zacks_sales_surprises_spec.rb +1 -1
  458. data/spec/models/api_response_zacks_target_price_consensuses_spec.rb +1 -1
  459. data/spec/models/average_daily_trading_volume_technical_value_spec.rb +1 -1
  460. data/spec/models/average_directional_index_technical_value_spec.rb +1 -1
  461. data/spec/models/average_true_range_technical_value_spec.rb +1 -1
  462. data/spec/models/awesome_oscillator_technical_value_spec.rb +1 -1
  463. data/spec/models/bollinger_bands_technical_value_spec.rb +1 -1
  464. data/spec/models/bulk_download_links_spec.rb +1 -1
  465. data/spec/models/bulk_download_summary_spec.rb +1 -1
  466. data/spec/models/chaikin_money_flow_technical_value_spec.rb +1 -1
  467. data/spec/models/commodity_channel_index_technical_value_spec.rb +1 -1
  468. data/spec/models/company_filing_spec.rb +1 -1
  469. data/spec/models/company_initial_public_offering_spec.rb +1 -1
  470. data/spec/models/company_news_spec.rb +1 -1
  471. data/spec/models/company_news_summary_spec.rb +1 -1
  472. data/spec/models/company_shares_outstanding_spec.rb +1 -1
  473. data/spec/models/company_spec.rb +1 -1
  474. data/spec/models/company_summary_spec.rb +1 -1
  475. data/spec/models/data_tag_spec.rb +1 -1
  476. data/spec/models/data_tag_summary_spec.rb +1 -1
  477. data/spec/models/detrended_price_oscillator_technical_value_spec.rb +1 -1
  478. data/spec/models/dividend_record_spec.rb +1 -1
  479. data/spec/models/donchian_channel_technical_value_spec.rb +1 -1
  480. data/spec/models/earnings_record_spec.rb +1 -1
  481. data/spec/models/ease_of_movement_technical_value_spec.rb +1 -1
  482. data/spec/models/economic_index_spec.rb +1 -1
  483. data/spec/models/economic_index_summary_spec.rb +1 -1
  484. data/spec/models/esg_company_summary_spec.rb +72 -0
  485. data/spec/models/esg_comprehensive_rating_spec.rb +270 -0
  486. data/spec/models/esg_comprehensive_rating_with_company_spec.rb +276 -0
  487. data/spec/models/esg_rating_spec.rb +66 -0
  488. data/spec/models/esg_rating_with_company_spec.rb +72 -0
  489. data/spec/models/etf_analytics_spec.rb +1 -1
  490. data/spec/models/etf_holding_spec.rb +7 -1
  491. data/spec/models/etf_spec.rb +1 -1
  492. data/spec/models/etf_stats_spec.rb +1 -1
  493. data/spec/models/etf_summary_spec.rb +1 -1
  494. data/spec/models/filing_note_filing_spec.rb +1 -1
  495. data/spec/models/filing_note_spec.rb +1 -1
  496. data/spec/models/filing_note_summary_spec.rb +1 -1
  497. data/spec/models/filing_spec.rb +1 -1
  498. data/spec/models/filing_summary_spec.rb +1 -1
  499. data/spec/models/force_index_technical_value_spec.rb +1 -1
  500. data/spec/models/forex_currency_spec.rb +1 -1
  501. data/spec/models/forex_pair_spec.rb +1 -1
  502. data/spec/models/forex_price_spec.rb +1 -1
  503. data/spec/models/fundamental_spec.rb +1 -1
  504. data/spec/models/fundamental_summary_spec.rb +1 -1
  505. data/spec/models/historical_data_spec.rb +1 -1
  506. data/spec/models/ichimoku_kinko_hyo_technical_value_spec.rb +1 -1
  507. data/spec/models/insider_transaction_filing_spec.rb +1 -1
  508. data/spec/models/insider_transaction_spec.rb +1 -1
  509. data/spec/models/institutional_holding_spec.rb +1 -1
  510. data/spec/models/institutional_ownership_spec.rb +1 -1
  511. data/spec/models/intraday_stock_price_spec.rb +1 -1
  512. data/spec/models/keltner_channel_technical_value_spec.rb +1 -1
  513. data/spec/models/know_sure_thing_technical_value_spec.rb +1 -1
  514. data/spec/models/mass_index_technical_value_spec.rb +1 -1
  515. data/spec/models/money_flow_index_technical_value_spec.rb +1 -1
  516. data/spec/models/moving_average_convergence_divergence_technical_value_spec.rb +1 -1
  517. data/spec/models/municipality_financial_spec.rb +1 -1
  518. data/spec/models/municipality_spec.rb +1 -1
  519. data/spec/models/negative_volume_index_technical_value_spec.rb +1 -1
  520. data/spec/models/on_balance_volume_mean_technical_value_spec.rb +1 -1
  521. data/spec/models/on_balance_volume_technical_value_spec.rb +1 -1
  522. data/spec/models/option_chain_eod_spec.rb +1 -1
  523. data/spec/models/option_chain_realtime_spec.rb +1 -1
  524. data/spec/models/option_chain_spec.rb +1 -1
  525. data/spec/models/option_contracts_list_spec.rb +1 -1
  526. data/spec/models/option_eod_spec.rb +1 -1
  527. data/spec/models/option_factors_realtime_spec.rb +1 -1
  528. data/spec/models/option_price_batch_realtime_spec.rb +1 -1
  529. data/spec/models/option_price_eod_spec.rb +1 -1
  530. data/spec/models/option_price_realtime_spec.rb +1 -1
  531. data/spec/models/option_price_spec.rb +1 -1
  532. data/spec/models/option_realtime_spec.rb +1 -1
  533. data/spec/models/option_snapshot_group_spec.rb +48 -0
  534. data/spec/models/option_snapshots_result_spec.rb +42 -0
  535. data/spec/models/option_spec.rb +1 -1
  536. data/spec/models/option_stats_realtime_spec.rb +7 -1
  537. data/spec/models/option_unusual_trade_spec.rb +1 -1
  538. data/spec/models/owner_spec.rb +1 -1
  539. data/spec/models/owner_summary_spec.rb +1 -1
  540. data/spec/models/realtime_stock_price_security_spec.rb +1 -1
  541. data/spec/models/realtime_stock_price_spec.rb +1 -1
  542. data/spec/models/relative_strength_index_technical_value_spec.rb +1 -1
  543. data/spec/models/reported_financial_dimension_spec.rb +1 -1
  544. data/spec/models/reported_financial_spec.rb +1 -1
  545. data/spec/models/reported_tag_spec.rb +1 -1
  546. data/spec/models/security_screen_clause_spec.rb +1 -1
  547. data/spec/models/security_screen_group_spec.rb +1 -1
  548. data/spec/models/security_screen_result_data_spec.rb +1 -1
  549. data/spec/models/security_screen_result_spec.rb +1 -1
  550. data/spec/models/security_snapshot_group_spec.rb +48 -0
  551. data/spec/models/security_snapshots_result_spec.rb +42 -0
  552. data/spec/models/security_spec.rb +1 -1
  553. data/spec/models/security_summary_spec.rb +1 -1
  554. data/spec/models/sic_index_spec.rb +1 -1
  555. data/spec/models/simple_moving_average_technical_value_spec.rb +1 -1
  556. data/spec/models/standardized_financial_spec.rb +1 -1
  557. data/spec/models/standardized_financials_dimension_spec.rb +1 -1
  558. data/spec/models/stochastic_oscillator_technical_value_spec.rb +1 -1
  559. data/spec/models/stock_exchange_spec.rb +1 -1
  560. data/spec/models/stock_market_index_spec.rb +1 -1
  561. data/spec/models/stock_market_index_summary_spec.rb +1 -1
  562. data/spec/models/stock_price_adjustment_spec.rb +1 -1
  563. data/spec/models/stock_price_adjustment_summary_spec.rb +1 -1
  564. data/spec/models/stock_price_interval_spec.rb +1 -1
  565. data/spec/models/stock_price_spec.rb +1 -1
  566. data/spec/models/stock_price_summary_spec.rb +1 -1
  567. data/spec/models/technical_indicator_spec.rb +1 -1
  568. data/spec/models/thea_entity_answer_spec.rb +1 -1
  569. data/spec/models/thea_source_document_spec.rb +1 -1
  570. data/spec/models/triple_exponential_average_technical_value_spec.rb +1 -1
  571. data/spec/models/true_strength_index_technical_value_spec.rb +1 -1
  572. data/spec/models/ultimate_oscillator_technical_value_spec.rb +1 -1
  573. data/spec/models/volume_price_trend_technical_value_spec.rb +1 -1
  574. data/spec/models/volume_weighted_average_price_value_spec.rb +1 -1
  575. data/spec/models/vortex_indicator_technical_value_spec.rb +1 -1
  576. data/spec/models/williams_r_technical_value_spec.rb +1 -1
  577. data/spec/models/zacks_analyst_rating_snapshot_spec.rb +1 -1
  578. data/spec/models/zacks_analyst_rating_spec.rb +1 -1
  579. data/spec/models/zacks_analyst_rating_summary_spec.rb +1 -1
  580. data/spec/models/zacks_eps_estimate_spec.rb +1 -1
  581. data/spec/models/zacks_eps_growth_rate_spec.rb +1 -1
  582. data/spec/models/zacks_eps_surprise_spec.rb +1 -1
  583. data/spec/models/zacks_eps_surprise_summary_spec.rb +1 -1
  584. data/spec/models/zacks_etf_holding_spec.rb +1 -1
  585. data/spec/models/zacks_institutional_holding_company_detail_spec.rb +1 -1
  586. data/spec/models/zacks_institutional_holding_company_summary_spec.rb +1 -1
  587. data/spec/models/zacks_institutional_holding_historical_summary_spec.rb +1 -1
  588. data/spec/models/zacks_institutional_holding_owner_detail_spec.rb +1 -1
  589. data/spec/models/zacks_institutional_holding_owner_summary_spec.rb +1 -1
  590. data/spec/models/zacks_institutional_holding_spec.rb +1 -1
  591. data/spec/models/zacks_long_term_growth_rate_spec.rb +1 -1
  592. data/spec/models/zacks_sales_surprise_spec.rb +1 -1
  593. data/spec/models/zacks_sales_surprise_summary_spec.rb +1 -1
  594. data/spec/models/zacks_target_price_consensus_spec.rb +1 -1
  595. data/spec/spec_helper.rb +1 -1
  596. metadata +62 -2
@@ -0,0 +1,335 @@
1
+ =begin
2
+ #Intrinio API
3
+
4
+ #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://docs.intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
5
+
6
+ OpenAPI spec version: 2.29.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: unset
10
+
11
+ =end
12
+
13
+ require "uri"
14
+
15
+ module Intrinio
16
+ class ESGApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+
23
+ # ESG Companies
24
+ #
25
+ # @param [Hash] opts the optional parameters
26
+ # @option opts [String] :country
27
+ # @option opts [String] :industry
28
+ # @option opts [String] :ticker
29
+ # @option opts [Integer] :page_size The number of results to return (default to 100)
30
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
31
+ # @return [ApiResponseESGCompanies]
32
+ def get_esg_companies(opts = {})
33
+ data, _status_code, _headers = get_esg_companies_with_http_info(opts)
34
+ return data
35
+ end
36
+
37
+ # ESG Companies
38
+ #
39
+ # @param [Hash] opts the optional parameters
40
+ # @option opts [String] :country
41
+ # @option opts [String] :industry
42
+ # @option opts [String] :ticker
43
+ # @option opts [Integer] :page_size The number of results to return
44
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
45
+ # @return [Array<(ApiResponseESGCompanies, Fixnum, Hash)>] ApiResponseESGCompanies data, response status code and response headers
46
+ def get_esg_companies_with_http_info(opts = {})
47
+ if @api_client.config.debugging
48
+ @api_client.config.logger.debug "Calling API: ESGApi.get_esg_companies ..."
49
+ end
50
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
51
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ESGApi.get_esg_companies, must be smaller than or equal to 10000.'
52
+ end
53
+
54
+ # resource path
55
+ local_var_path = "/esg/companies"
56
+
57
+ # query parameters
58
+ query_params = {}
59
+ query_params[:'country'] = opts[:'country'] if !opts[:'country'].nil?
60
+ query_params[:'industry'] = opts[:'industry'] if !opts[:'industry'].nil?
61
+ query_params[:'ticker'] = opts[:'ticker'] if !opts[:'ticker'].nil?
62
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
63
+ query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
64
+
65
+ # header parameters
66
+ header_params = {}
67
+ # HTTP header 'Accept' (if needed)
68
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
69
+
70
+ # form parameters
71
+ form_params = {}
72
+
73
+ # http body (model)
74
+ post_body = nil
75
+ auth_names = ['ApiKeyAuth']
76
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
77
+ :header_params => header_params,
78
+ :query_params => query_params,
79
+ :form_params => form_params,
80
+ :body => post_body,
81
+ :auth_names => auth_names,
82
+ :return_type => 'ApiResponseESGCompanies')
83
+ if @api_client.config.debugging
84
+ @api_client.config.logger.debug "API called: ESGApi#get_esg_companies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
85
+ end
86
+ return data, status_code, headers
87
+ end
88
+
89
+ # ESG Company Comprehensive Ratings History
90
+ #
91
+ # @param identifier ISIN, Intrinio ID, or Ticker
92
+ # @param [Hash] opts the optional parameters
93
+ # @option opts [Integer] :page_size The number of results to return (default to 100)
94
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
95
+ # @return [ApiResponseESGCompanyComprehensiveRatingHistory]
96
+ def get_esg_company_comprehensive_ratings(identifier, opts = {})
97
+ data, _status_code, _headers = get_esg_company_comprehensive_ratings_with_http_info(identifier, opts)
98
+ return data
99
+ end
100
+
101
+ # ESG Company Comprehensive Ratings History
102
+ #
103
+ # @param identifier ISIN, Intrinio ID, or Ticker
104
+ # @param [Hash] opts the optional parameters
105
+ # @option opts [Integer] :page_size The number of results to return
106
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
107
+ # @return [Array<(ApiResponseESGCompanyComprehensiveRatingHistory, Fixnum, Hash)>] ApiResponseESGCompanyComprehensiveRatingHistory data, response status code and response headers
108
+ def get_esg_company_comprehensive_ratings_with_http_info(identifier, opts = {})
109
+ if @api_client.config.debugging
110
+ @api_client.config.logger.debug "Calling API: ESGApi.get_esg_company_comprehensive_ratings ..."
111
+ end
112
+ # verify the required parameter 'identifier' is set
113
+ if @api_client.config.client_side_validation && identifier.nil?
114
+ fail ArgumentError, "Missing the required parameter 'identifier' when calling ESGApi.get_esg_company_comprehensive_ratings"
115
+ end
116
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
117
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ESGApi.get_esg_company_comprehensive_ratings, must be smaller than or equal to 10000.'
118
+ end
119
+
120
+ # resource path
121
+ local_var_path = "/esg/{identifier}/comprehensive".sub('{' + 'identifier' + '}', identifier.to_s)
122
+
123
+ # query parameters
124
+ query_params = {}
125
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
126
+ query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
127
+
128
+ # header parameters
129
+ header_params = {}
130
+ # HTTP header 'Accept' (if needed)
131
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
132
+
133
+ # form parameters
134
+ form_params = {}
135
+
136
+ # http body (model)
137
+ post_body = nil
138
+ auth_names = ['ApiKeyAuth']
139
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
140
+ :header_params => header_params,
141
+ :query_params => query_params,
142
+ :form_params => form_params,
143
+ :body => post_body,
144
+ :auth_names => auth_names,
145
+ :return_type => 'ApiResponseESGCompanyComprehensiveRatingHistory')
146
+ if @api_client.config.debugging
147
+ @api_client.config.logger.debug "API called: ESGApi#get_esg_company_comprehensive_ratings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
148
+ end
149
+ return data, status_code, headers
150
+ end
151
+
152
+ # ESG Company Ratings History
153
+ #
154
+ # @param identifier ISIN, Intrinio ID, or Ticker
155
+ # @param [Hash] opts the optional parameters
156
+ # @option opts [Integer] :page_size The number of results to return (default to 100)
157
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
158
+ # @return [ApiResponseESGCompanyRatingHistory]
159
+ def get_esg_company_ratings(identifier, opts = {})
160
+ data, _status_code, _headers = get_esg_company_ratings_with_http_info(identifier, opts)
161
+ return data
162
+ end
163
+
164
+ # ESG Company Ratings History
165
+ #
166
+ # @param identifier ISIN, Intrinio ID, or Ticker
167
+ # @param [Hash] opts the optional parameters
168
+ # @option opts [Integer] :page_size The number of results to return
169
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
170
+ # @return [Array<(ApiResponseESGCompanyRatingHistory, Fixnum, Hash)>] ApiResponseESGCompanyRatingHistory data, response status code and response headers
171
+ def get_esg_company_ratings_with_http_info(identifier, opts = {})
172
+ if @api_client.config.debugging
173
+ @api_client.config.logger.debug "Calling API: ESGApi.get_esg_company_ratings ..."
174
+ end
175
+ # verify the required parameter 'identifier' is set
176
+ if @api_client.config.client_side_validation && identifier.nil?
177
+ fail ArgumentError, "Missing the required parameter 'identifier' when calling ESGApi.get_esg_company_ratings"
178
+ end
179
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
180
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ESGApi.get_esg_company_ratings, must be smaller than or equal to 10000.'
181
+ end
182
+
183
+ # resource path
184
+ local_var_path = "/esg/{identifier}".sub('{' + 'identifier' + '}', identifier.to_s)
185
+
186
+ # query parameters
187
+ query_params = {}
188
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
189
+ query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
190
+
191
+ # header parameters
192
+ header_params = {}
193
+ # HTTP header 'Accept' (if needed)
194
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
195
+
196
+ # form parameters
197
+ form_params = {}
198
+
199
+ # http body (model)
200
+ post_body = nil
201
+ auth_names = ['ApiKeyAuth']
202
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
203
+ :header_params => header_params,
204
+ :query_params => query_params,
205
+ :form_params => form_params,
206
+ :body => post_body,
207
+ :auth_names => auth_names,
208
+ :return_type => 'ApiResponseESGCompanyRatingHistory')
209
+ if @api_client.config.debugging
210
+ @api_client.config.logger.debug "API called: ESGApi#get_esg_company_ratings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
211
+ end
212
+ return data, status_code, headers
213
+ end
214
+
215
+ # ESG Latest
216
+ #
217
+ # @param [Hash] opts the optional parameters
218
+ # @option opts [String] :country
219
+ # @option opts [Integer] :page_size The number of results to return (default to 100)
220
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
221
+ # @return [ApiResponseESGLatest]
222
+ def get_esg_latest(opts = {})
223
+ data, _status_code, _headers = get_esg_latest_with_http_info(opts)
224
+ return data
225
+ end
226
+
227
+ # ESG Latest
228
+ #
229
+ # @param [Hash] opts the optional parameters
230
+ # @option opts [String] :country
231
+ # @option opts [Integer] :page_size The number of results to return
232
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
233
+ # @return [Array<(ApiResponseESGLatest, Fixnum, Hash)>] ApiResponseESGLatest data, response status code and response headers
234
+ def get_esg_latest_with_http_info(opts = {})
235
+ if @api_client.config.debugging
236
+ @api_client.config.logger.debug "Calling API: ESGApi.get_esg_latest ..."
237
+ end
238
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
239
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ESGApi.get_esg_latest, must be smaller than or equal to 10000.'
240
+ end
241
+
242
+ # resource path
243
+ local_var_path = "/esg"
244
+
245
+ # query parameters
246
+ query_params = {}
247
+ query_params[:'country'] = opts[:'country'] if !opts[:'country'].nil?
248
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
249
+ query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
250
+
251
+ # header parameters
252
+ header_params = {}
253
+ # HTTP header 'Accept' (if needed)
254
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
255
+
256
+ # form parameters
257
+ form_params = {}
258
+
259
+ # http body (model)
260
+ post_body = nil
261
+ auth_names = ['ApiKeyAuth']
262
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
263
+ :header_params => header_params,
264
+ :query_params => query_params,
265
+ :form_params => form_params,
266
+ :body => post_body,
267
+ :auth_names => auth_names,
268
+ :return_type => 'ApiResponseESGLatest')
269
+ if @api_client.config.debugging
270
+ @api_client.config.logger.debug "API called: ESGApi#get_esg_latest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
271
+ end
272
+ return data, status_code, headers
273
+ end
274
+
275
+ # ESG Latest Comprehensive
276
+ #
277
+ # @param [Hash] opts the optional parameters
278
+ # @option opts [String] :country
279
+ # @option opts [Integer] :page_size The number of results to return (default to 100)
280
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
281
+ # @return [ApiResponseESGLatestComprehensive]
282
+ def get_esg_latest_comprehensive(opts = {})
283
+ data, _status_code, _headers = get_esg_latest_comprehensive_with_http_info(opts)
284
+ return data
285
+ end
286
+
287
+ # ESG Latest Comprehensive
288
+ #
289
+ # @param [Hash] opts the optional parameters
290
+ # @option opts [String] :country
291
+ # @option opts [Integer] :page_size The number of results to return
292
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
293
+ # @return [Array<(ApiResponseESGLatestComprehensive, Fixnum, Hash)>] ApiResponseESGLatestComprehensive data, response status code and response headers
294
+ def get_esg_latest_comprehensive_with_http_info(opts = {})
295
+ if @api_client.config.debugging
296
+ @api_client.config.logger.debug "Calling API: ESGApi.get_esg_latest_comprehensive ..."
297
+ end
298
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
299
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ESGApi.get_esg_latest_comprehensive, must be smaller than or equal to 10000.'
300
+ end
301
+
302
+ # resource path
303
+ local_var_path = "/esg/comprehensive"
304
+
305
+ # query parameters
306
+ query_params = {}
307
+ query_params[:'country'] = opts[:'country'] if !opts[:'country'].nil?
308
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
309
+ query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
310
+
311
+ # header parameters
312
+ header_params = {}
313
+ # HTTP header 'Accept' (if needed)
314
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
315
+
316
+ # form parameters
317
+ form_params = {}
318
+
319
+ # http body (model)
320
+ post_body = nil
321
+ auth_names = ['ApiKeyAuth']
322
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
323
+ :header_params => header_params,
324
+ :query_params => query_params,
325
+ :form_params => form_params,
326
+ :body => post_body,
327
+ :auth_names => auth_names,
328
+ :return_type => 'ApiResponseESGLatestComprehensive')
329
+ if @api_client.config.debugging
330
+ @api_client.config.logger.debug "API called: ESGApi#get_esg_latest_comprehensive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
331
+ end
332
+ return data, status_code, headers
333
+ end
334
+ end
335
+ end
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://docs.intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
5
5
 
6
- OpenAPI spec version: 2.27.5
6
+ OpenAPI spec version: 2.29.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: unset
@@ -21,7 +21,7 @@ module Intrinio
21
21
  end
22
22
 
23
23
  # All ETFs
24
- # Returns a list of Exchange Traded Funds (ETFs) sourced from FirstBridge
24
+ # Returns a list of all currently listed ETFs, with relevant identification information including the ETF Name, Ticker, FIGI Ticker, and Exchange MIC for further usage with our ETF Metadata, Holdings, Stats, and Analytics offerings.
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @option opts [String] :exchange
27
27
  # @option opts [Integer] :page_size The number of results to return (default to 100)
@@ -33,7 +33,7 @@ module Intrinio
33
33
  end
34
34
 
35
35
  # All ETFs
36
- # Returns a list of Exchange Traded Funds (ETFs) sourced from FirstBridge
36
+ # Returns a list of all currently listed ETFs, with relevant identification information including the ETF Name, Ticker, FIGI Ticker, and Exchange MIC for further usage with our ETF Metadata, Holdings, Stats, and Analytics offerings.
37
37
  # @param [Hash] opts the optional parameters
38
38
  # @option opts [String] :exchange
39
39
  # @option opts [Integer] :page_size The number of results to return
@@ -81,7 +81,7 @@ module Intrinio
81
81
  end
82
82
 
83
83
  # Lookup ETF
84
- # Returns the Exchange Traded Fund (ETF) with the given identifier
84
+ # Returns classifications and reference data which consists of ~90 columns that give detailed information about an ETF. These granular details include asset class, expense ratio, index name, index weighting scheme, smart beta type and specific investment objectives.
85
85
  # @param identifier An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)
86
86
  # @param [Hash] opts the optional parameters
87
87
  # @return [ETF]
@@ -91,7 +91,7 @@ module Intrinio
91
91
  end
92
92
 
93
93
  # Lookup ETF
94
- # Returns the Exchange Traded Fund (ETF) with the given identifier
94
+ # Returns classifications and reference data which consists of ~90 columns that give detailed information about an ETF. These granular details include asset class, expense ratio, index name, index weighting scheme, smart beta type and specific investment objectives.
95
95
  # @param identifier An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)
96
96
  # @param [Hash] opts the optional parameters
97
97
  # @return [Array<(ETF, Fixnum, Hash)>] ETF data, response status code and response headers
@@ -134,7 +134,7 @@ module Intrinio
134
134
  end
135
135
 
136
136
  # ETF Analytics
137
- # Returns analytics for the Exchange Traded Fund (ETF) including volume, market cap, 52 week high, and 52 week low
137
+ # Returns latest market analytics for a specified US ETF, including volume, trailing volumen, market cap, 52 week high, and 52 week low.
138
138
  # @param identifier An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)
139
139
  # @param [Hash] opts the optional parameters
140
140
  # @return [ETFAnalytics]
@@ -144,7 +144,7 @@ module Intrinio
144
144
  end
145
145
 
146
146
  # ETF Analytics
147
- # Returns analytics for the Exchange Traded Fund (ETF) including volume, market cap, 52 week high, and 52 week low
147
+ # Returns latest market analytics for a specified US ETF, including volume, trailing volumen, market cap, 52 week high, and 52 week low.
148
148
  # @param identifier An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)
149
149
  # @param [Hash] opts the optional parameters
150
150
  # @return [Array<(ETFAnalytics, Fixnum, Hash)>] ETFAnalytics data, response status code and response headers
@@ -187,7 +187,7 @@ module Intrinio
187
187
  end
188
188
 
189
189
  # ETF Holdings
190
- # Returns the holdings sorted by weight descending and the Exchange Traded Fund (ETF) summary
190
+ # Returns holdings data that details all the constituent securities in each ETF with names, identifiers, and the weights for each security providing granular level transparency.
191
191
  # @param identifier An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)
192
192
  # @param [Hash] opts the optional parameters
193
193
  # @option opts [Integer] :page_size The number of results to return (default to 100)
@@ -199,7 +199,7 @@ module Intrinio
199
199
  end
200
200
 
201
201
  # ETF Holdings
202
- # Returns the holdings sorted by weight descending and the Exchange Traded Fund (ETF) summary
202
+ # Returns holdings data that details all the constituent securities in each ETF with names, identifiers, and the weights for each security providing granular level transparency.
203
203
  # @param identifier An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)
204
204
  # @param [Hash] opts the optional parameters
205
205
  # @option opts [Integer] :page_size The number of results to return
@@ -250,7 +250,7 @@ module Intrinio
250
250
  end
251
251
 
252
252
  # Exchange Traded Fund (ETF) stats
253
- # Returns daily stats for the Exchange Traded Fund (ETF) including net asset value, beta vs spy, returns, and volatility
253
+ # Returns comprehensive key US ETF performance statistics, including prices, NAVs, flows, returns, and much more for both trailing and calendar year periods.
254
254
  # @param identifier An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)
255
255
  # @param [Hash] opts the optional parameters
256
256
  # @return [ETFStats]
@@ -260,7 +260,7 @@ module Intrinio
260
260
  end
261
261
 
262
262
  # Exchange Traded Fund (ETF) stats
263
- # Returns daily stats for the Exchange Traded Fund (ETF) including net asset value, beta vs spy, returns, and volatility
263
+ # Returns comprehensive key US ETF performance statistics, including prices, NAVs, flows, returns, and much more for both trailing and calendar year periods.
264
264
  # @param identifier An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)
265
265
  # @param [Hash] opts the optional parameters
266
266
  # @return [Array<(ETFStats, Fixnum, Hash)>] ETFStats data, response status code and response headers
@@ -303,7 +303,7 @@ module Intrinio
303
303
  end
304
304
 
305
305
  # Search ETFs
306
- # Searches for Exchange Traded Funds (ETFs) matching the text `query`
306
+ # Accepts a string of keyword combinations, and searches across the ETF name and ticker and returns a list of ETFs with related keywords.
307
307
  # @param query
308
308
  # @param [Hash] opts the optional parameters
309
309
  # @return [ApiResponseETFs]
@@ -313,7 +313,7 @@ module Intrinio
313
313
  end
314
314
 
315
315
  # Search ETFs
316
- # Searches for Exchange Traded Funds (ETFs) matching the text &#x60;query&#x60;
316
+ # Accepts a string of keyword combinations, and searches across the ETF name and ticker and returns a list of ETFs with related keywords.
317
317
  # @param query
318
318
  # @param [Hash] opts the optional parameters
319
319
  # @return [Array<(ApiResponseETFs, Fixnum, Hash)>] ApiResponseETFs data, response status code and response headers
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://docs.intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
5
5
 
6
- OpenAPI spec version: 2.27.5
6
+ OpenAPI spec version: 2.29.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: unset
@@ -21,9 +21,9 @@ module Intrinio
21
21
  end
22
22
 
23
23
  # All Filings
24
- # Returns all Filings. Returns Filings matching parameters when supplied.
25
- # @param company Filings for the given &#x60;company&#x60; identifier (ticker, CIK, LEI, Intrinio ID)
24
+ # Returns pertinent filing reference data for a specific company filing or latest filings for all companies. Useful for tracking the latest filings submitted and updating your database accordingly with the new information.
26
25
  # @param [Hash] opts the optional parameters
26
+ # @option opts [String] :company Filings for the given &#x60;company&#x60; identifier (ticker, CIK, LEI, Intrinio ID)
27
27
  # @option opts [String] :report_type Filter by report type. Separate values with commas to return multiple The filing &lt;a href&#x3D;\&quot;https://docs.intrinio.com/documentation/sec_filing_report_types\&quot; target&#x3D;\&quot;_blank\&quot;&gt;report types&lt;/a&gt;.
28
28
  # @option opts [Date] :start_date Filed on or after the given date
29
29
  # @option opts [Date] :end_date Filed before or after the given date
@@ -33,15 +33,15 @@ module Intrinio
33
33
  # @option opts [Integer] :page_size The number of results to return (default to 100)
34
34
  # @option opts [String] :next_page Gets the next page of data from a previous API call
35
35
  # @return [ApiResponseFilings]
36
- def get_all_filings(company, opts = {})
37
- data, _status_code, _headers = get_all_filings_with_http_info(company, opts)
36
+ def get_all_filings(opts = {})
37
+ data, _status_code, _headers = get_all_filings_with_http_info(opts)
38
38
  return data
39
39
  end
40
40
 
41
41
  # All Filings
42
- # Returns all Filings. Returns Filings matching parameters when supplied.
43
- # @param company Filings for the given &#x60;company&#x60; identifier (ticker, CIK, LEI, Intrinio ID)
42
+ # Returns pertinent filing reference data for a specific company filing or latest filings for all companies. Useful for tracking the latest filings submitted and updating your database accordingly with the new information.
44
43
  # @param [Hash] opts the optional parameters
44
+ # @option opts [String] :company Filings for the given &#x60;company&#x60; identifier (ticker, CIK, LEI, Intrinio ID)
45
45
  # @option opts [String] :report_type Filter by report type. Separate values with commas to return multiple The filing &lt;a href&#x3D;\&quot;https://docs.intrinio.com/documentation/sec_filing_report_types\&quot; target&#x3D;\&quot;_blank\&quot;&gt;report types&lt;/a&gt;.
46
46
  # @option opts [Date] :start_date Filed on or after the given date
47
47
  # @option opts [Date] :end_date Filed before or after the given date
@@ -51,14 +51,10 @@ module Intrinio
51
51
  # @option opts [Integer] :page_size The number of results to return
52
52
  # @option opts [String] :next_page Gets the next page of data from a previous API call
53
53
  # @return [Array<(ApiResponseFilings, Fixnum, Hash)>] ApiResponseFilings data, response status code and response headers
54
- def get_all_filings_with_http_info(company, opts = {})
54
+ def get_all_filings_with_http_info(opts = {})
55
55
  if @api_client.config.debugging
56
56
  @api_client.config.logger.debug "Calling API: FilingApi.get_all_filings ..."
57
57
  end
58
- # verify the required parameter 'company' is set
59
- if @api_client.config.client_side_validation && company.nil?
60
- fail ArgumentError, "Missing the required parameter 'company' when calling FilingApi.get_all_filings"
61
- end
62
58
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
63
59
  fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FilingApi.get_all_filings, must be smaller than or equal to 10000.'
64
60
  end
@@ -68,7 +64,7 @@ module Intrinio
68
64
 
69
65
  # query parameters
70
66
  query_params = {}
71
- query_params[:'company'] = company
67
+ query_params[:'company'] = opts[:'company'] if !opts[:'company'].nil?
72
68
  query_params[:'report_type'] = opts[:'report_type'] if !opts[:'report_type'].nil?
73
69
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
74
70
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
@@ -103,7 +99,7 @@ module Intrinio
103
99
  end
104
100
 
105
101
  # All Filing Notes
106
- # Return all Notes from all Filings, most-recent first. Returns notes matching parameters when supplied.
102
+ # Returns a list of the latest XBRL filing note sections from the SEC 10-K and 10-Q statements. The returned Intrinio XBRL filing note ID can then be utilized with the “Filing Note by ID” endpoint to retrieve the contents of the note in HTML or text format.
107
103
  # @param [Hash] opts the optional parameters
108
104
  # @option opts [String] :company A Company identifier (Ticker, CIK, LEI, Intrinio ID)
109
105
  # @option opts [String] :report_type Notes contained in filings that match the given &lt;a href&#x3D;\&quot;https://docs.intrinio.com/documentation/sec_filing_report_types\&quot; target&#x3D;\&quot;_blank\&quot;&gt;report type&lt;/a&gt;
@@ -120,7 +116,7 @@ module Intrinio
120
116
  end
121
117
 
122
118
  # All Filing Notes
123
- # Return all Notes from all Filings, most-recent first. Returns notes matching parameters when supplied.
119
+ # Returns a list of the latest XBRL filing note sections from the SEC 10-K and 10-Q statements. The returned Intrinio XBRL filing note ID can then be utilized with the “Filing Note by ID” endpoint to retrieve the contents of the note in HTML or text format.
124
120
  # @param [Hash] opts the optional parameters
125
121
  # @option opts [String] :company A Company identifier (Ticker, CIK, LEI, Intrinio ID)
126
122
  # @option opts [String] :report_type Notes contained in filings that match the given &lt;a href&#x3D;\&quot;https://docs.intrinio.com/documentation/sec_filing_report_types\&quot; target&#x3D;\&quot;_blank\&quot;&gt;report type&lt;/a&gt;
@@ -294,7 +290,7 @@ module Intrinio
294
290
  end
295
291
 
296
292
  # All Fundamentals by Filing
297
- # Returns all Fundamentals for the SEC Filing with the given `identifier`. Returns Fundamentals matching parameters when supplied.
293
+ # Returns a list of fundamentals with unique fundamental IDs associated with a particular `Intrinio Filing ID` (if applicable) that have been updated or created as a result of a company`s latest SEC filing. Useful to ensure your database is up to date with the latest fundamentals.
298
294
  # @param identifier A Filing identifier
299
295
  # @param [Hash] opts the optional parameters
300
296
  # @option opts [String] :statement_code Filters fundamentals by statement code
@@ -311,7 +307,7 @@ module Intrinio
311
307
  end
312
308
 
313
309
  # All Fundamentals by Filing
314
- # Returns all Fundamentals for the SEC Filing with the given &#x60;identifier&#x60;. Returns Fundamentals matching parameters when supplied.
310
+ # Returns a list of fundamentals with unique fundamental IDs associated with a particular &#x60;Intrinio Filing ID&#x60; (if applicable) that have been updated or created as a result of a company&#x60;s latest SEC filing. Useful to ensure your database is up to date with the latest fundamentals.
315
311
  # @param identifier A Filing identifier
316
312
  # @param [Hash] opts the optional parameters
317
313
  # @option opts [String] :statement_code Filters fundamentals by statement code
@@ -377,7 +373,7 @@ module Intrinio
377
373
  end
378
374
 
379
375
  # Filing Html
380
- #
376
+ # Returns a SEC filing in HTML Format for a specified filing ID.
381
377
  # @param identifier A Filing identifier
382
378
  # @param [Hash] opts the optional parameters
383
379
  # @return [String]
@@ -387,7 +383,7 @@ module Intrinio
387
383
  end
388
384
 
389
385
  # Filing Html
390
- #
386
+ # Returns a SEC filing in HTML Format for a specified filing ID.
391
387
  # @param identifier A Filing identifier
392
388
  # @param [Hash] opts the optional parameters
393
389
  # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
@@ -483,7 +479,7 @@ module Intrinio
483
479
  end
484
480
 
485
481
  # Filing Note by ID
486
- #
482
+ # Returns the XBRL filing note contents in HTML or text format for a specified Intrinio XBRL filing note ID.
487
483
  # @param identifier The Intrinio ID of the filing note
488
484
  # @param [Hash] opts the optional parameters
489
485
  # @option opts [String] :content_format Returns content in html (as filed) or plain text (default to text)
@@ -494,7 +490,7 @@ module Intrinio
494
490
  end
495
491
 
496
492
  # Filing Note by ID
497
- #
493
+ # Returns the XBRL filing note contents in HTML or text format for a specified Intrinio XBRL filing note ID.
498
494
  # @param identifier The Intrinio ID of the filing note
499
495
  # @param [Hash] opts the optional parameters
500
496
  # @option opts [String] :content_format Returns content in html (as filed) or plain text
@@ -648,7 +644,7 @@ module Intrinio
648
644
  end
649
645
 
650
646
  # Search Filing Notes
651
- # Searches for Filing Notes using the `query`
647
+ # Search the XBRL note database and return a list of XBRL note sections containing text from the text query parameter passed through.
652
648
  # @param query Search for notes that contain all or parts of this text
653
649
  # @param [Hash] opts the optional parameters
654
650
  # @option opts [Date] :filing_start_date Limit search to filings on or after this date
@@ -661,7 +657,7 @@ module Intrinio
661
657
  end
662
658
 
663
659
  # Search Filing Notes
664
- # Searches for Filing Notes using the &#x60;query&#x60;
660
+ # Search the XBRL note database and return a list of XBRL note sections containing text from the text query parameter passed through.
665
661
  # @param query Search for notes that contain all or parts of this text
666
662
  # @param [Hash] opts the optional parameters
667
663
  # @option opts [Date] :filing_start_date Limit search to filings on or after this date
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://docs.intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
5
5
 
6
- OpenAPI spec version: 2.27.5
6
+ OpenAPI spec version: 2.29.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: unset