intrinio-sdk 2.2.0 → 2.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (548) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +116 -2
  3. data/docs/ApiResponseCryptoAccumulationDistributionIndex.md +13 -0
  4. data/docs/ApiResponseCryptoAverageDailyTradingVolume.md +13 -0
  5. data/docs/ApiResponseCryptoAverageDirectionalIndex.md +13 -0
  6. data/docs/ApiResponseCryptoAverageTrueRange.md +13 -0
  7. data/docs/ApiResponseCryptoAwesomeOscillator.md +13 -0
  8. data/docs/ApiResponseCryptoBollingerBands.md +13 -0
  9. data/docs/ApiResponseCryptoChaikinMoneyFlow.md +13 -0
  10. data/docs/ApiResponseCryptoCommodityChannelIndex.md +13 -0
  11. data/docs/ApiResponseCryptoDetrendedPriceOscillator.md +13 -0
  12. data/docs/ApiResponseCryptoDonchianChannel.md +13 -0
  13. data/docs/ApiResponseCryptoEaseOfMovement.md +13 -0
  14. data/docs/ApiResponseCryptoForceIndex.md +13 -0
  15. data/docs/ApiResponseCryptoIchimokuKinkoHyo.md +13 -0
  16. data/docs/ApiResponseCryptoKeltnerChannel.md +13 -0
  17. data/docs/ApiResponseCryptoKnowSureThing.md +13 -0
  18. data/docs/ApiResponseCryptoMassIndex.md +13 -0
  19. data/docs/ApiResponseCryptoMoneyFlowIndex.md +13 -0
  20. data/docs/ApiResponseCryptoMovingAverageConvergenceDivergence.md +13 -0
  21. data/docs/ApiResponseCryptoNegativeVolumeIndex.md +13 -0
  22. data/docs/ApiResponseCryptoOnBalanceVolume.md +13 -0
  23. data/docs/ApiResponseCryptoOnBalanceVolumeMean.md +13 -0
  24. data/docs/ApiResponseCryptoRelativeStrengthIndex.md +13 -0
  25. data/docs/ApiResponseCryptoSimpleMovingAverage.md +13 -0
  26. data/docs/ApiResponseCryptoStochasticOscillator.md +13 -0
  27. data/docs/ApiResponseCryptoTripleExponentialAverage.md +13 -0
  28. data/docs/ApiResponseCryptoTrueStrengthIndex.md +13 -0
  29. data/docs/ApiResponseCryptoUltimateOscillator.md +13 -0
  30. data/docs/ApiResponseCryptoVolumePriceTrend.md +13 -0
  31. data/docs/ApiResponseCryptoVolumeWeightedAveragePrice.md +13 -0
  32. data/docs/ApiResponseCryptoVortexIndicator.md +13 -0
  33. data/docs/ApiResponseCryptoWilliamsR.md +13 -0
  34. data/docs/ApiResponseOptionsChain.md +1 -1
  35. data/docs/ApiResponseSecurityZacksAnalystRatings.md +10 -0
  36. data/docs/ApiResponseSecurityZacksAnalystRatingsSnapshot.md +9 -0
  37. data/docs/ApiResponseSecurityZacksEPSSurprises.md +10 -0
  38. data/docs/ApiResponseSecurityZacksSalesSurprises.md +10 -0
  39. data/docs/ApiResponseZacksAnalystRatings.md +9 -0
  40. data/docs/ApiResponseZacksEPSSurprises.md +9 -0
  41. data/docs/ApiResponseZacksSalesSurprises.md +9 -0
  42. data/docs/Company.md +4 -0
  43. data/docs/CompanyApi.md +240 -36
  44. data/docs/CryptoApi.md +2769 -57
  45. data/docs/CryptoPrice.md +1 -1
  46. data/docs/DataPointApi.md +44 -10
  47. data/docs/DataTagApi.md +55 -4
  48. data/docs/FilingApi.md +128 -9
  49. data/docs/ForexApi.md +57 -6
  50. data/docs/Fundamental.md +1 -1
  51. data/docs/FundamentalsApi.md +68 -0
  52. data/docs/HistoricalDataApi.md +25 -8
  53. data/docs/IndexApi.md +331 -25
  54. data/docs/MunicipalityApi.md +51 -0
  55. data/docs/OptionsApi.md +74 -6
  56. data/docs/SecurityApi.md +1108 -78
  57. data/docs/StockExchangeApi.md +117 -15
  58. data/docs/TechnicalApi.md +3121 -37
  59. data/docs/ZacksAnalystRating.md +17 -0
  60. data/docs/ZacksAnalystRatingSnapshot.md +18 -0
  61. data/docs/ZacksAnalystRatingSummary.md +16 -0
  62. data/docs/ZacksApi.md +281 -0
  63. data/docs/ZacksEPSSurprise.md +24 -0
  64. data/docs/ZacksEPSSurpriseSummary.md +23 -0
  65. data/docs/ZacksSalesSurprise.md +24 -0
  66. data/docs/ZacksSalesSurpriseSummary.md +25 -0
  67. data/intrinio-sdk.gemspec +1 -1
  68. data/lib/intrinio-sdk.rb +47 -1
  69. data/lib/intrinio-sdk/api/company_api.rb +33 -33
  70. data/lib/intrinio-sdk/api/crypto_api.rb +3108 -8
  71. data/lib/intrinio-sdk/api/data_point_api.rb +13 -13
  72. data/lib/intrinio-sdk/api/data_tag_api.rb +5 -5
  73. data/lib/intrinio-sdk/api/filing_api.rb +9 -9
  74. data/lib/intrinio-sdk/api/forex_api.rb +7 -6
  75. data/lib/intrinio-sdk/api/fundamentals_api.rb +1 -1
  76. data/lib/intrinio-sdk/api/historical_data_api.rb +9 -9
  77. data/lib/intrinio-sdk/api/index_api.rb +23 -23
  78. data/lib/intrinio-sdk/api/municipality_api.rb +1 -1
  79. data/lib/intrinio-sdk/api/options_api.rb +7 -7
  80. data/lib/intrinio-sdk/api/security_api.rb +393 -42
  81. data/lib/intrinio-sdk/api/stock_exchange_api.rb +11 -11
  82. data/lib/intrinio-sdk/api/technical_api.rb +3108 -12
  83. data/lib/intrinio-sdk/api/zacks_api.rb +393 -0
  84. data/lib/intrinio-sdk/api_client.rb +1 -1
  85. data/lib/intrinio-sdk/api_error.rb +1 -1
  86. data/lib/intrinio-sdk/configuration.rb +1 -1
  87. data/lib/intrinio-sdk/models/accumulation_distribution_index_technical_value.rb +1 -1
  88. data/lib/intrinio-sdk/models/api_response_companies.rb +1 -1
  89. data/lib/intrinio-sdk/models/api_response_companies_search.rb +1 -1
  90. data/lib/intrinio-sdk/models/api_response_company_filings.rb +1 -1
  91. data/lib/intrinio-sdk/models/api_response_company_fundamentals.rb +1 -1
  92. data/lib/intrinio-sdk/models/api_response_company_historical_data.rb +1 -1
  93. data/lib/intrinio-sdk/models/api_response_company_news.rb +1 -1
  94. data/lib/intrinio-sdk/models/api_response_company_securities.rb +1 -1
  95. data/lib/intrinio-sdk/models/api_response_crypto_accumulation_distribution_index.rb +238 -0
  96. data/lib/intrinio-sdk/models/api_response_crypto_average_daily_trading_volume.rb +238 -0
  97. data/lib/intrinio-sdk/models/api_response_crypto_average_directional_index.rb +238 -0
  98. data/lib/intrinio-sdk/models/api_response_crypto_average_true_range.rb +238 -0
  99. data/lib/intrinio-sdk/models/api_response_crypto_awesome_oscillator.rb +238 -0
  100. data/lib/intrinio-sdk/models/api_response_crypto_bollinger_bands.rb +238 -0
  101. data/lib/intrinio-sdk/models/api_response_crypto_book.rb +1 -1
  102. data/lib/intrinio-sdk/models/api_response_crypto_book_asks.rb +1 -1
  103. data/lib/intrinio-sdk/models/api_response_crypto_book_bids.rb +1 -1
  104. data/lib/intrinio-sdk/models/api_response_crypto_chaikin_money_flow.rb +238 -0
  105. data/lib/intrinio-sdk/models/api_response_crypto_commodity_channel_index.rb +238 -0
  106. data/lib/intrinio-sdk/models/api_response_crypto_currencies.rb +1 -1
  107. data/lib/intrinio-sdk/models/api_response_crypto_detrended_price_oscillator.rb +238 -0
  108. data/lib/intrinio-sdk/models/api_response_crypto_donchian_channel.rb +238 -0
  109. data/lib/intrinio-sdk/models/api_response_crypto_ease_of_movement.rb +238 -0
  110. data/lib/intrinio-sdk/models/api_response_crypto_exchanges.rb +1 -1
  111. data/lib/intrinio-sdk/models/api_response_crypto_force_index.rb +238 -0
  112. data/lib/intrinio-sdk/models/api_response_crypto_ichimoku_kinko_hyo.rb +238 -0
  113. data/lib/intrinio-sdk/models/api_response_crypto_keltner_channel.rb +238 -0
  114. data/lib/intrinio-sdk/models/api_response_crypto_know_sure_thing.rb +238 -0
  115. data/lib/intrinio-sdk/models/api_response_crypto_mass_index.rb +238 -0
  116. data/lib/intrinio-sdk/models/api_response_crypto_money_flow_index.rb +238 -0
  117. data/lib/intrinio-sdk/models/api_response_crypto_moving_average_convergence_divergence.rb +238 -0
  118. data/lib/intrinio-sdk/models/api_response_crypto_negative_volume_index.rb +238 -0
  119. data/lib/intrinio-sdk/models/api_response_crypto_on_balance_volume.rb +238 -0
  120. data/lib/intrinio-sdk/models/api_response_crypto_on_balance_volume_mean.rb +238 -0
  121. data/lib/intrinio-sdk/models/api_response_crypto_pairs.rb +1 -1
  122. data/lib/intrinio-sdk/models/api_response_crypto_prices.rb +1 -1
  123. data/lib/intrinio-sdk/models/api_response_crypto_relative_strength_index.rb +238 -0
  124. data/lib/intrinio-sdk/models/api_response_crypto_simple_moving_average.rb +238 -0
  125. data/lib/intrinio-sdk/models/api_response_crypto_snapshot.rb +1 -1
  126. data/lib/intrinio-sdk/models/api_response_crypto_stats.rb +1 -1
  127. data/lib/intrinio-sdk/models/api_response_crypto_stochastic_oscillator.rb +238 -0
  128. data/lib/intrinio-sdk/models/api_response_crypto_triple_exponential_average.rb +238 -0
  129. data/lib/intrinio-sdk/models/api_response_crypto_true_strength_index.rb +238 -0
  130. data/lib/intrinio-sdk/models/api_response_crypto_ultimate_oscillator.rb +238 -0
  131. data/lib/intrinio-sdk/models/api_response_crypto_volume_price_trend.rb +238 -0
  132. data/lib/intrinio-sdk/models/api_response_crypto_volume_weighted_average_price.rb +238 -0
  133. data/lib/intrinio-sdk/models/api_response_crypto_vortex_indicator.rb +238 -0
  134. data/lib/intrinio-sdk/models/api_response_crypto_williams_r.rb +238 -0
  135. data/lib/intrinio-sdk/models/api_response_data_tags.rb +1 -1
  136. data/lib/intrinio-sdk/models/api_response_data_tags_search.rb +1 -1
  137. data/lib/intrinio-sdk/models/api_response_economic_index_historical_data.rb +1 -1
  138. data/lib/intrinio-sdk/models/api_response_economic_indices.rb +1 -1
  139. data/lib/intrinio-sdk/models/api_response_economic_indices_search.rb +1 -1
  140. data/lib/intrinio-sdk/models/api_response_filing_notes.rb +1 -1
  141. data/lib/intrinio-sdk/models/api_response_filing_notes_search.rb +1 -1
  142. data/lib/intrinio-sdk/models/api_response_filings.rb +1 -1
  143. data/lib/intrinio-sdk/models/api_response_forex_currencies.rb +1 -1
  144. data/lib/intrinio-sdk/models/api_response_forex_pairs.rb +1 -1
  145. data/lib/intrinio-sdk/models/api_response_forex_prices.rb +1 -1
  146. data/lib/intrinio-sdk/models/api_response_historical_data.rb +1 -1
  147. data/lib/intrinio-sdk/models/api_response_municipalities.rb +1 -1
  148. data/lib/intrinio-sdk/models/api_response_municipalitiy_financials.rb +1 -1
  149. data/lib/intrinio-sdk/models/api_response_news.rb +1 -1
  150. data/lib/intrinio-sdk/models/api_response_option_prices.rb +1 -1
  151. data/lib/intrinio-sdk/models/api_response_options.rb +1 -1
  152. data/lib/intrinio-sdk/models/api_response_options_chain.rb +9 -9
  153. data/lib/intrinio-sdk/models/api_response_options_expirations.rb +1 -1
  154. data/lib/intrinio-sdk/models/api_response_reported_financials.rb +1 -1
  155. data/lib/intrinio-sdk/models/api_response_securities.rb +1 -1
  156. data/lib/intrinio-sdk/models/api_response_securities_search.rb +1 -1
  157. data/lib/intrinio-sdk/models/api_response_security_accumulation_distribution_index.rb +1 -1
  158. data/lib/intrinio-sdk/models/api_response_security_average_daily_trading_volume.rb +1 -1
  159. data/lib/intrinio-sdk/models/api_response_security_average_directional_index.rb +1 -1
  160. data/lib/intrinio-sdk/models/api_response_security_average_true_range.rb +1 -1
  161. data/lib/intrinio-sdk/models/api_response_security_awesome_oscillator.rb +1 -1
  162. data/lib/intrinio-sdk/models/api_response_security_bollinger_bands.rb +1 -1
  163. data/lib/intrinio-sdk/models/api_response_security_chaikin_money_flow.rb +1 -1
  164. data/lib/intrinio-sdk/models/api_response_security_commodity_channel_index.rb +1 -1
  165. data/lib/intrinio-sdk/models/api_response_security_detrended_price_oscillator.rb +1 -1
  166. data/lib/intrinio-sdk/models/api_response_security_donchian_channel.rb +1 -1
  167. data/lib/intrinio-sdk/models/api_response_security_ease_of_movement.rb +1 -1
  168. data/lib/intrinio-sdk/models/api_response_security_force_index.rb +1 -1
  169. data/lib/intrinio-sdk/models/api_response_security_historical_data.rb +1 -1
  170. data/lib/intrinio-sdk/models/api_response_security_ichimoku_kinko_hyo.rb +1 -1
  171. data/lib/intrinio-sdk/models/api_response_security_intraday_prices.rb +1 -1
  172. data/lib/intrinio-sdk/models/api_response_security_keltner_channel.rb +1 -1
  173. data/lib/intrinio-sdk/models/api_response_security_know_sure_thing.rb +1 -1
  174. data/lib/intrinio-sdk/models/api_response_security_mass_index.rb +1 -1
  175. data/lib/intrinio-sdk/models/api_response_security_money_flow_index.rb +1 -1
  176. data/lib/intrinio-sdk/models/api_response_security_moving_average_convergence_divergence.rb +1 -1
  177. data/lib/intrinio-sdk/models/api_response_security_negative_volume_index.rb +1 -1
  178. data/lib/intrinio-sdk/models/api_response_security_on_balance_volume.rb +1 -1
  179. data/lib/intrinio-sdk/models/api_response_security_on_balance_volume_mean.rb +1 -1
  180. data/lib/intrinio-sdk/models/api_response_security_relative_strength_index.rb +1 -1
  181. data/lib/intrinio-sdk/models/api_response_security_simple_moving_average.rb +1 -1
  182. data/lib/intrinio-sdk/models/api_response_security_stochastic_oscillator.rb +1 -1
  183. data/lib/intrinio-sdk/models/api_response_security_stock_price_adjustments.rb +1 -1
  184. data/lib/intrinio-sdk/models/api_response_security_stock_prices.rb +1 -1
  185. data/lib/intrinio-sdk/models/api_response_security_triple_exponential_average.rb +1 -1
  186. data/lib/intrinio-sdk/models/api_response_security_true_strength_index.rb +1 -1
  187. data/lib/intrinio-sdk/models/api_response_security_ultimate_oscillator.rb +1 -1
  188. data/lib/intrinio-sdk/models/api_response_security_volume_price_trend.rb +1 -1
  189. data/lib/intrinio-sdk/models/api_response_security_volume_weighted_average_price.rb +1 -1
  190. data/lib/intrinio-sdk/models/api_response_security_vortex_indicator.rb +1 -1
  191. data/lib/intrinio-sdk/models/api_response_security_williams_r.rb +1 -1
  192. data/lib/intrinio-sdk/models/api_response_security_zacks_analyst_ratings.rb +210 -0
  193. data/lib/intrinio-sdk/models/api_response_security_zacks_analyst_ratings_snapshot.rb +200 -0
  194. data/lib/intrinio-sdk/models/api_response_security_zacks_eps_surprises.rb +210 -0
  195. data/lib/intrinio-sdk/models/api_response_security_zacks_sales_surprises.rb +210 -0
  196. data/lib/intrinio-sdk/models/api_response_sic_index_historical_data.rb +1 -1
  197. data/lib/intrinio-sdk/models/api_response_sic_indices.rb +1 -1
  198. data/lib/intrinio-sdk/models/api_response_sic_indices_search.rb +1 -1
  199. data/lib/intrinio-sdk/models/api_response_standardized_financials.rb +1 -1
  200. data/lib/intrinio-sdk/models/api_response_stock_exchange_realtime_stock_prices.rb +1 -1
  201. data/lib/intrinio-sdk/models/api_response_stock_exchange_securities.rb +1 -1
  202. data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_price_adjustments.rb +1 -1
  203. data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_prices.rb +1 -1
  204. data/lib/intrinio-sdk/models/api_response_stock_exchanges.rb +1 -1
  205. data/lib/intrinio-sdk/models/api_response_stock_market_index_historical_data.rb +1 -1
  206. data/lib/intrinio-sdk/models/api_response_stock_market_indices.rb +1 -1
  207. data/lib/intrinio-sdk/models/api_response_stock_market_indices_search.rb +1 -1
  208. data/lib/intrinio-sdk/models/api_response_zacks_analyst_ratings.rb +200 -0
  209. data/lib/intrinio-sdk/models/api_response_zacks_eps_surprises.rb +201 -0
  210. data/lib/intrinio-sdk/models/api_response_zacks_sales_surprises.rb +201 -0
  211. data/lib/intrinio-sdk/models/average_daily_trading_volume_technical_value.rb +1 -1
  212. data/lib/intrinio-sdk/models/average_directional_index_technical_value.rb +1 -1
  213. data/lib/intrinio-sdk/models/average_true_range_technical_value.rb +1 -1
  214. data/lib/intrinio-sdk/models/awesome_oscillator_technical_value.rb +1 -1
  215. data/lib/intrinio-sdk/models/bollinger_bands_technical_value.rb +1 -1
  216. data/lib/intrinio-sdk/models/chaikin_money_flow_technical_value.rb +1 -1
  217. data/lib/intrinio-sdk/models/commodity_channel_index_technical_value.rb +1 -1
  218. data/lib/intrinio-sdk/models/company.rb +45 -5
  219. data/lib/intrinio-sdk/models/company_filing.rb +1 -1
  220. data/lib/intrinio-sdk/models/company_news.rb +1 -1
  221. data/lib/intrinio-sdk/models/company_news_summary.rb +1 -1
  222. data/lib/intrinio-sdk/models/company_summary.rb +1 -1
  223. data/lib/intrinio-sdk/models/crypto_ask.rb +1 -1
  224. data/lib/intrinio-sdk/models/crypto_bid.rb +1 -1
  225. data/lib/intrinio-sdk/models/crypto_book_entry.rb +1 -1
  226. data/lib/intrinio-sdk/models/crypto_currency.rb +1 -1
  227. data/lib/intrinio-sdk/models/crypto_exchange.rb +1 -1
  228. data/lib/intrinio-sdk/models/crypto_exchange_summary.rb +1 -1
  229. data/lib/intrinio-sdk/models/crypto_pair.rb +1 -1
  230. data/lib/intrinio-sdk/models/crypto_pair_summary.rb +1 -1
  231. data/lib/intrinio-sdk/models/crypto_price.rb +2 -2
  232. data/lib/intrinio-sdk/models/crypto_snapshot.rb +1 -1
  233. data/lib/intrinio-sdk/models/crypto_stat.rb +1 -1
  234. data/lib/intrinio-sdk/models/data_tag.rb +1 -1
  235. data/lib/intrinio-sdk/models/data_tag_summary.rb +1 -1
  236. data/lib/intrinio-sdk/models/detrended_price_oscillator_technical_value.rb +1 -1
  237. data/lib/intrinio-sdk/models/dividend_record.rb +1 -1
  238. data/lib/intrinio-sdk/models/donchian_channel_technical_value.rb +1 -1
  239. data/lib/intrinio-sdk/models/earnings_record.rb +1 -1
  240. data/lib/intrinio-sdk/models/ease_of_movement_technical_value.rb +1 -1
  241. data/lib/intrinio-sdk/models/economic_index.rb +1 -1
  242. data/lib/intrinio-sdk/models/economic_index_summary.rb +1 -1
  243. data/lib/intrinio-sdk/models/filing.rb +1 -1
  244. data/lib/intrinio-sdk/models/filing_note.rb +1 -1
  245. data/lib/intrinio-sdk/models/filing_note_filing.rb +1 -1
  246. data/lib/intrinio-sdk/models/filing_note_summary.rb +1 -1
  247. data/lib/intrinio-sdk/models/filing_summary.rb +1 -1
  248. data/lib/intrinio-sdk/models/force_index_technical_value.rb +1 -1
  249. data/lib/intrinio-sdk/models/forex_currency.rb +1 -1
  250. data/lib/intrinio-sdk/models/forex_pair.rb +1 -1
  251. data/lib/intrinio-sdk/models/forex_price.rb +1 -1
  252. data/lib/intrinio-sdk/models/fundamental.rb +2 -2
  253. data/lib/intrinio-sdk/models/fundamental_summary.rb +1 -1
  254. data/lib/intrinio-sdk/models/historical_data.rb +1 -1
  255. data/lib/intrinio-sdk/models/ichimoku_kinko_hyo_technical_value.rb +1 -1
  256. data/lib/intrinio-sdk/models/intraday_stock_price.rb +1 -1
  257. data/lib/intrinio-sdk/models/keltner_channel_technical_value.rb +1 -1
  258. data/lib/intrinio-sdk/models/know_sure_thing_technical_value.rb +1 -1
  259. data/lib/intrinio-sdk/models/mass_index_technical_value.rb +1 -1
  260. data/lib/intrinio-sdk/models/money_flow_index_technical_value.rb +1 -1
  261. data/lib/intrinio-sdk/models/moving_average_convergence_divergence_technical_value.rb +1 -1
  262. data/lib/intrinio-sdk/models/municipality.rb +1 -1
  263. data/lib/intrinio-sdk/models/municipality_financial.rb +1 -1
  264. data/lib/intrinio-sdk/models/negative_volume_index_technical_value.rb +1 -1
  265. data/lib/intrinio-sdk/models/on_balance_volume_mean_technical_value.rb +1 -1
  266. data/lib/intrinio-sdk/models/on_balance_volume_technical_value.rb +1 -1
  267. data/lib/intrinio-sdk/models/option.rb +1 -1
  268. data/lib/intrinio-sdk/models/option_chain.rb +1 -1
  269. data/lib/intrinio-sdk/models/option_price.rb +1 -1
  270. data/lib/intrinio-sdk/models/realtime_stock_price.rb +1 -1
  271. data/lib/intrinio-sdk/models/realtime_stock_price_security.rb +1 -1
  272. data/lib/intrinio-sdk/models/relative_strength_index_technical_value.rb +1 -1
  273. data/lib/intrinio-sdk/models/reported_financial.rb +1 -1
  274. data/lib/intrinio-sdk/models/reported_financial_dimension.rb +1 -1
  275. data/lib/intrinio-sdk/models/reported_tag.rb +1 -1
  276. data/lib/intrinio-sdk/models/security.rb +1 -1
  277. data/lib/intrinio-sdk/models/security_screen_clause.rb +1 -1
  278. data/lib/intrinio-sdk/models/security_screen_group.rb +1 -1
  279. data/lib/intrinio-sdk/models/security_screen_result.rb +1 -1
  280. data/lib/intrinio-sdk/models/security_screen_result_data.rb +1 -1
  281. data/lib/intrinio-sdk/models/security_summary.rb +1 -1
  282. data/lib/intrinio-sdk/models/sic_index.rb +1 -1
  283. data/lib/intrinio-sdk/models/simple_moving_average_technical_value.rb +1 -1
  284. data/lib/intrinio-sdk/models/standardized_financial.rb +1 -1
  285. data/lib/intrinio-sdk/models/stochastic_oscillator_technical_value.rb +1 -1
  286. data/lib/intrinio-sdk/models/stock_exchange.rb +1 -1
  287. data/lib/intrinio-sdk/models/stock_market_index.rb +1 -1
  288. data/lib/intrinio-sdk/models/stock_market_index_summary.rb +1 -1
  289. data/lib/intrinio-sdk/models/stock_price.rb +1 -1
  290. data/lib/intrinio-sdk/models/stock_price_adjustment.rb +1 -1
  291. data/lib/intrinio-sdk/models/stock_price_adjustment_summary.rb +1 -1
  292. data/lib/intrinio-sdk/models/stock_price_summary.rb +1 -1
  293. data/lib/intrinio-sdk/models/technical_indicator.rb +1 -1
  294. data/lib/intrinio-sdk/models/triple_exponential_average_technical_value.rb +1 -1
  295. data/lib/intrinio-sdk/models/true_strength_index_technical_value.rb +1 -1
  296. data/lib/intrinio-sdk/models/ultimate_oscillator_technical_value.rb +1 -1
  297. data/lib/intrinio-sdk/models/volume_price_trend_technical_value.rb +1 -1
  298. data/lib/intrinio-sdk/models/volume_weighted_average_price_value.rb +1 -1
  299. data/lib/intrinio-sdk/models/vortex_indicator_technical_value.rb +1 -1
  300. data/lib/intrinio-sdk/models/williams_r_technical_value.rb +1 -1
  301. data/lib/intrinio-sdk/models/zacks_analyst_rating.rb +279 -0
  302. data/lib/intrinio-sdk/models/zacks_analyst_rating_snapshot.rb +289 -0
  303. data/lib/intrinio-sdk/models/zacks_analyst_rating_summary.rb +269 -0
  304. data/lib/intrinio-sdk/models/zacks_eps_surprise.rb +349 -0
  305. data/lib/intrinio-sdk/models/zacks_eps_surprise_summary.rb +339 -0
  306. data/lib/intrinio-sdk/models/zacks_sales_surprise.rb +349 -0
  307. data/lib/intrinio-sdk/models/zacks_sales_surprise_summary.rb +359 -0
  308. data/lib/intrinio-sdk/version.rb +2 -2
  309. data/spec/api/company_api_spec.rb +17 -17
  310. data/spec/api/crypto_api_spec.rb +741 -4
  311. data/spec/api/data_point_api_spec.rb +7 -7
  312. data/spec/api/data_tag_api_spec.rb +3 -3
  313. data/spec/api/filing_api_spec.rb +5 -5
  314. data/spec/api/forex_api_spec.rb +3 -3
  315. data/spec/api/fundamentals_api_spec.rb +1 -1
  316. data/spec/api/historical_data_api_spec.rb +5 -5
  317. data/spec/api/index_api_spec.rb +12 -12
  318. data/spec/api/municipality_api_spec.rb +1 -1
  319. data/spec/api/options_api_spec.rb +4 -4
  320. data/spec/api/security_api_spec.rb +88 -19
  321. data/spec/api/stock_exchange_api_spec.rb +6 -6
  322. data/spec/api/technical_api_spec.rb +740 -4
  323. data/spec/api/zacks_api_spec.rb +119 -0
  324. data/spec/api_client_spec.rb +1 -1
  325. data/spec/configuration_spec.rb +1 -1
  326. data/spec/models/accumulation_distribution_index_technical_value_spec.rb +1 -1
  327. data/spec/models/api_response_companies_search_spec.rb +1 -1
  328. data/spec/models/api_response_companies_spec.rb +1 -1
  329. data/spec/models/api_response_company_filings_spec.rb +1 -1
  330. data/spec/models/api_response_company_fundamentals_spec.rb +1 -1
  331. data/spec/models/api_response_company_historical_data_spec.rb +1 -1
  332. data/spec/models/api_response_company_news_spec.rb +1 -1
  333. data/spec/models/api_response_company_securities_spec.rb +1 -1
  334. data/spec/models/api_response_crypto_accumulation_distribution_index_spec.rb +72 -0
  335. data/spec/models/api_response_crypto_average_daily_trading_volume_spec.rb +72 -0
  336. data/spec/models/api_response_crypto_average_directional_index_spec.rb +72 -0
  337. data/spec/models/api_response_crypto_average_true_range_spec.rb +72 -0
  338. data/spec/models/api_response_crypto_awesome_oscillator_spec.rb +72 -0
  339. data/spec/models/api_response_crypto_bollinger_bands_spec.rb +72 -0
  340. data/spec/models/api_response_crypto_book_asks_spec.rb +1 -1
  341. data/spec/models/api_response_crypto_book_bids_spec.rb +1 -1
  342. data/spec/models/api_response_crypto_book_spec.rb +1 -1
  343. data/spec/models/api_response_crypto_chaikin_money_flow_spec.rb +72 -0
  344. data/spec/models/api_response_crypto_commodity_channel_index_spec.rb +72 -0
  345. data/spec/models/api_response_crypto_currencies_spec.rb +1 -1
  346. data/spec/models/api_response_crypto_detrended_price_oscillator_spec.rb +72 -0
  347. data/spec/models/api_response_crypto_donchian_channel_spec.rb +72 -0
  348. data/spec/models/api_response_crypto_ease_of_movement_spec.rb +72 -0
  349. data/spec/models/api_response_crypto_exchanges_spec.rb +1 -1
  350. data/spec/models/api_response_crypto_force_index_spec.rb +72 -0
  351. data/spec/models/api_response_crypto_ichimoku_kinko_hyo_spec.rb +72 -0
  352. data/spec/models/api_response_crypto_keltner_channel_spec.rb +72 -0
  353. data/spec/models/api_response_crypto_know_sure_thing_spec.rb +72 -0
  354. data/spec/models/api_response_crypto_mass_index_spec.rb +72 -0
  355. data/spec/models/api_response_crypto_money_flow_index_spec.rb +72 -0
  356. data/spec/models/api_response_crypto_moving_average_convergence_divergence_spec.rb +72 -0
  357. data/spec/models/api_response_crypto_negative_volume_index_spec.rb +72 -0
  358. data/spec/models/api_response_crypto_on_balance_volume_mean_spec.rb +72 -0
  359. data/spec/models/api_response_crypto_on_balance_volume_spec.rb +72 -0
  360. data/spec/models/api_response_crypto_pairs_spec.rb +1 -1
  361. data/spec/models/api_response_crypto_prices_spec.rb +1 -1
  362. data/spec/models/api_response_crypto_relative_strength_index_spec.rb +72 -0
  363. data/spec/models/api_response_crypto_simple_moving_average_spec.rb +72 -0
  364. data/spec/models/api_response_crypto_snapshot_spec.rb +1 -1
  365. data/spec/models/api_response_crypto_stats_spec.rb +1 -1
  366. data/spec/models/api_response_crypto_stochastic_oscillator_spec.rb +72 -0
  367. data/spec/models/api_response_crypto_triple_exponential_average_spec.rb +72 -0
  368. data/spec/models/api_response_crypto_true_strength_index_spec.rb +72 -0
  369. data/spec/models/api_response_crypto_ultimate_oscillator_spec.rb +72 -0
  370. data/spec/models/api_response_crypto_volume_price_trend_spec.rb +72 -0
  371. data/spec/models/api_response_crypto_volume_weighted_average_price_spec.rb +72 -0
  372. data/spec/models/api_response_crypto_vortex_indicator_spec.rb +72 -0
  373. data/spec/models/api_response_crypto_williams_r_spec.rb +72 -0
  374. data/spec/models/api_response_data_tags_search_spec.rb +1 -1
  375. data/spec/models/api_response_data_tags_spec.rb +1 -1
  376. data/spec/models/api_response_economic_index_historical_data_spec.rb +1 -1
  377. data/spec/models/api_response_economic_indices_search_spec.rb +1 -1
  378. data/spec/models/api_response_economic_indices_spec.rb +1 -1
  379. data/spec/models/api_response_filing_notes_search_spec.rb +1 -1
  380. data/spec/models/api_response_filing_notes_spec.rb +1 -1
  381. data/spec/models/api_response_filings_spec.rb +1 -1
  382. data/spec/models/api_response_forex_currencies_spec.rb +1 -1
  383. data/spec/models/api_response_forex_pairs_spec.rb +1 -1
  384. data/spec/models/api_response_forex_prices_spec.rb +1 -1
  385. data/spec/models/api_response_historical_data_spec.rb +1 -1
  386. data/spec/models/api_response_municipalities_spec.rb +1 -1
  387. data/spec/models/api_response_municipalitiy_financials_spec.rb +1 -1
  388. data/spec/models/api_response_news_spec.rb +1 -1
  389. data/spec/models/api_response_option_prices_spec.rb +1 -1
  390. data/spec/models/api_response_options_chain_spec.rb +2 -2
  391. data/spec/models/api_response_options_expirations_spec.rb +1 -1
  392. data/spec/models/api_response_options_spec.rb +1 -1
  393. data/spec/models/api_response_reported_financials_spec.rb +1 -1
  394. data/spec/models/api_response_securities_search_spec.rb +1 -1
  395. data/spec/models/api_response_securities_spec.rb +1 -1
  396. data/spec/models/api_response_security_accumulation_distribution_index_spec.rb +1 -1
  397. data/spec/models/api_response_security_average_daily_trading_volume_spec.rb +1 -1
  398. data/spec/models/api_response_security_average_directional_index_spec.rb +1 -1
  399. data/spec/models/api_response_security_average_true_range_spec.rb +1 -1
  400. data/spec/models/api_response_security_awesome_oscillator_spec.rb +1 -1
  401. data/spec/models/api_response_security_bollinger_bands_spec.rb +1 -1
  402. data/spec/models/api_response_security_chaikin_money_flow_spec.rb +1 -1
  403. data/spec/models/api_response_security_commodity_channel_index_spec.rb +1 -1
  404. data/spec/models/api_response_security_detrended_price_oscillator_spec.rb +1 -1
  405. data/spec/models/api_response_security_donchian_channel_spec.rb +1 -1
  406. data/spec/models/api_response_security_ease_of_movement_spec.rb +1 -1
  407. data/spec/models/api_response_security_force_index_spec.rb +1 -1
  408. data/spec/models/api_response_security_historical_data_spec.rb +1 -1
  409. data/spec/models/api_response_security_ichimoku_kinko_hyo_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 +48 -0
  432. data/spec/models/api_response_security_zacks_analyst_ratings_spec.rb +54 -0
  433. data/spec/models/api_response_security_zacks_eps_surprises_spec.rb +54 -0
  434. data/spec/models/api_response_security_zacks_sales_surprises_spec.rb +54 -0
  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_spec.rb +1 -1
  439. data/spec/models/api_response_stock_exchange_realtime_stock_prices_spec.rb +1 -1
  440. data/spec/models/api_response_stock_exchange_securities_spec.rb +1 -1
  441. data/spec/models/api_response_stock_exchange_stock_price_adjustments_spec.rb +1 -1
  442. data/spec/models/api_response_stock_exchange_stock_prices_spec.rb +1 -1
  443. data/spec/models/api_response_stock_exchanges_spec.rb +1 -1
  444. data/spec/models/api_response_stock_market_index_historical_data_spec.rb +1 -1
  445. data/spec/models/api_response_stock_market_indices_search_spec.rb +1 -1
  446. data/spec/models/api_response_stock_market_indices_spec.rb +1 -1
  447. data/spec/models/api_response_zacks_analyst_ratings_spec.rb +48 -0
  448. data/spec/models/api_response_zacks_eps_surprises_spec.rb +48 -0
  449. data/spec/models/api_response_zacks_sales_surprises_spec.rb +48 -0
  450. data/spec/models/average_daily_trading_volume_technical_value_spec.rb +1 -1
  451. data/spec/models/average_directional_index_technical_value_spec.rb +1 -1
  452. data/spec/models/average_true_range_technical_value_spec.rb +1 -1
  453. data/spec/models/awesome_oscillator_technical_value_spec.rb +1 -1
  454. data/spec/models/bollinger_bands_technical_value_spec.rb +1 -1
  455. data/spec/models/chaikin_money_flow_technical_value_spec.rb +1 -1
  456. data/spec/models/commodity_channel_index_technical_value_spec.rb +1 -1
  457. data/spec/models/company_filing_spec.rb +1 -1
  458. data/spec/models/company_news_spec.rb +1 -1
  459. data/spec/models/company_news_summary_spec.rb +1 -1
  460. data/spec/models/company_spec.rb +25 -1
  461. data/spec/models/company_summary_spec.rb +1 -1
  462. data/spec/models/crypto_ask_spec.rb +1 -1
  463. data/spec/models/crypto_bid_spec.rb +1 -1
  464. data/spec/models/crypto_book_entry_spec.rb +1 -1
  465. data/spec/models/crypto_currency_spec.rb +1 -1
  466. data/spec/models/crypto_exchange_spec.rb +1 -1
  467. data/spec/models/crypto_exchange_summary_spec.rb +1 -1
  468. data/spec/models/crypto_pair_spec.rb +1 -1
  469. data/spec/models/crypto_pair_summary_spec.rb +1 -1
  470. data/spec/models/crypto_price_spec.rb +1 -1
  471. data/spec/models/crypto_snapshot_spec.rb +1 -1
  472. data/spec/models/crypto_stat_spec.rb +1 -1
  473. data/spec/models/data_tag_spec.rb +1 -1
  474. data/spec/models/data_tag_summary_spec.rb +1 -1
  475. data/spec/models/detrended_price_oscillator_technical_value_spec.rb +1 -1
  476. data/spec/models/dividend_record_spec.rb +1 -1
  477. data/spec/models/donchian_channel_technical_value_spec.rb +1 -1
  478. data/spec/models/earnings_record_spec.rb +1 -1
  479. data/spec/models/ease_of_movement_technical_value_spec.rb +1 -1
  480. data/spec/models/economic_index_spec.rb +1 -1
  481. data/spec/models/economic_index_summary_spec.rb +1 -1
  482. data/spec/models/filing_note_filing_spec.rb +1 -1
  483. data/spec/models/filing_note_spec.rb +1 -1
  484. data/spec/models/filing_note_summary_spec.rb +1 -1
  485. data/spec/models/filing_spec.rb +1 -1
  486. data/spec/models/filing_summary_spec.rb +1 -1
  487. data/spec/models/force_index_technical_value_spec.rb +1 -1
  488. data/spec/models/forex_currency_spec.rb +1 -1
  489. data/spec/models/forex_pair_spec.rb +1 -1
  490. data/spec/models/forex_price_spec.rb +1 -1
  491. data/spec/models/fundamental_spec.rb +1 -1
  492. data/spec/models/fundamental_summary_spec.rb +1 -1
  493. data/spec/models/historical_data_spec.rb +1 -1
  494. data/spec/models/ichimoku_kinko_hyo_technical_value_spec.rb +1 -1
  495. data/spec/models/intraday_stock_price_spec.rb +1 -1
  496. data/spec/models/keltner_channel_technical_value_spec.rb +1 -1
  497. data/spec/models/know_sure_thing_technical_value_spec.rb +1 -1
  498. data/spec/models/mass_index_technical_value_spec.rb +1 -1
  499. data/spec/models/money_flow_index_technical_value_spec.rb +1 -1
  500. data/spec/models/moving_average_convergence_divergence_technical_value_spec.rb +1 -1
  501. data/spec/models/municipality_financial_spec.rb +1 -1
  502. data/spec/models/municipality_spec.rb +1 -1
  503. data/spec/models/negative_volume_index_technical_value_spec.rb +1 -1
  504. data/spec/models/on_balance_volume_mean_technical_value_spec.rb +1 -1
  505. data/spec/models/on_balance_volume_technical_value_spec.rb +1 -1
  506. data/spec/models/option_chain_spec.rb +1 -1
  507. data/spec/models/option_price_spec.rb +1 -1
  508. data/spec/models/option_spec.rb +1 -1
  509. data/spec/models/realtime_stock_price_security_spec.rb +1 -1
  510. data/spec/models/realtime_stock_price_spec.rb +1 -1
  511. data/spec/models/relative_strength_index_technical_value_spec.rb +1 -1
  512. data/spec/models/reported_financial_dimension_spec.rb +1 -1
  513. data/spec/models/reported_financial_spec.rb +1 -1
  514. data/spec/models/reported_tag_spec.rb +1 -1
  515. data/spec/models/security_screen_clause_spec.rb +1 -1
  516. data/spec/models/security_screen_group_spec.rb +1 -1
  517. data/spec/models/security_screen_result_data_spec.rb +1 -1
  518. data/spec/models/security_screen_result_spec.rb +1 -1
  519. data/spec/models/security_spec.rb +1 -1
  520. data/spec/models/security_summary_spec.rb +1 -1
  521. data/spec/models/sic_index_spec.rb +1 -1
  522. data/spec/models/simple_moving_average_technical_value_spec.rb +1 -1
  523. data/spec/models/standardized_financial_spec.rb +1 -1
  524. data/spec/models/stochastic_oscillator_technical_value_spec.rb +1 -1
  525. data/spec/models/stock_exchange_spec.rb +1 -1
  526. data/spec/models/stock_market_index_spec.rb +1 -1
  527. data/spec/models/stock_market_index_summary_spec.rb +1 -1
  528. data/spec/models/stock_price_adjustment_spec.rb +1 -1
  529. data/spec/models/stock_price_adjustment_summary_spec.rb +1 -1
  530. data/spec/models/stock_price_spec.rb +1 -1
  531. data/spec/models/stock_price_summary_spec.rb +1 -1
  532. data/spec/models/technical_indicator_spec.rb +1 -1
  533. data/spec/models/triple_exponential_average_technical_value_spec.rb +1 -1
  534. data/spec/models/true_strength_index_technical_value_spec.rb +1 -1
  535. data/spec/models/ultimate_oscillator_technical_value_spec.rb +1 -1
  536. data/spec/models/volume_price_trend_technical_value_spec.rb +1 -1
  537. data/spec/models/volume_weighted_average_price_value_spec.rb +1 -1
  538. data/spec/models/vortex_indicator_technical_value_spec.rb +1 -1
  539. data/spec/models/williams_r_technical_value_spec.rb +1 -1
  540. data/spec/models/zacks_analyst_rating_snapshot_spec.rb +102 -0
  541. data/spec/models/zacks_analyst_rating_spec.rb +96 -0
  542. data/spec/models/zacks_analyst_rating_summary_spec.rb +90 -0
  543. data/spec/models/zacks_eps_surprise_spec.rb +138 -0
  544. data/spec/models/zacks_eps_surprise_summary_spec.rb +132 -0
  545. data/spec/models/zacks_sales_surprise_spec.rb +138 -0
  546. data/spec/models/zacks_sales_surprise_summary_spec.rb +144 -0
  547. data/spec/spec_helper.rb +1 -1
  548. metadata +186 -2
@@ -0,0 +1,349 @@
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://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.6.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.3.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module Intrinio
16
+ # Zacks Sales Surprises are pre-earnings release consensus sales estimates from analysts for thousands of stocks. Zack’s storied research team aggregates and validates the estimates and compares these estimates to non-GAAP sales reported by the company, providing the amount and percent surprise on release. Each Sales Surprise includes metadata about the corresponding Security.
17
+ class ZacksSalesSurprise
18
+ # The Intrinio ID for the record
19
+ attr_accessor :id
20
+
21
+ # The company’s fiscal year for the reported period
22
+ attr_accessor :fiscal_year
23
+
24
+ # The company’s fiscal quarter for the reported period
25
+ attr_accessor :fiscal_quarter
26
+
27
+ # The closest calendar year for the company’s fiscal year
28
+ attr_accessor :calendar_year
29
+
30
+ # The closest calendar quarter for the company’s fiscal year
31
+ attr_accessor :calendar_quarter
32
+
33
+ # The actual report date for the earnings release
34
+ attr_accessor :actual_reported_date
35
+
36
+ # The actual report time for the earnings release
37
+ attr_accessor :actual_reported_time
38
+
39
+ # The code cooresponding to the earnings release BTO = BEFORE THE OPEN | DTM = DURING THE MARKET | AMC = AFTER MARKET CLOSE
40
+ attr_accessor :actual_reported_code
41
+
42
+ # The description for the type of earnings release
43
+ attr_accessor :actual_reported_desc
44
+
45
+ # The last revision date for the analyst estimates
46
+ attr_accessor :last_rev_date
47
+
48
+ # The actual Non-GAAP sales figure released by the company, interpreted by Zacks.
49
+ attr_accessor :sales_actual
50
+
51
+ # The adjustments Zacks made to get to Non-GAAP sales to reconcile with GAAP sales.
52
+ attr_accessor :sales_actual_zacks_adj
53
+
54
+ # The actual GAAP sales figured released by the company
55
+ attr_accessor :sales_actual_gaap
56
+
57
+ # The pre-earnings release mean sales estimate for the company sales_count_estimate; the pre-earnings release number of estimates by analysts
58
+ attr_accessor :sales_mean_estimate
59
+
60
+ # The sales surprise amount difference
61
+ attr_accessor :sales_amount_diff
62
+
63
+ # The sales surprise percent difference
64
+ attr_accessor :sales_percent_diff
65
+
66
+ # The pre-earnings release standard deviation of sales estimates
67
+ attr_accessor :sales_std_dev_estimate
68
+
69
+
70
+ # Attribute mapping from ruby-style variable name to JSON key.
71
+ def self.attribute_map
72
+ {
73
+ :'id' => :'id',
74
+ :'fiscal_year' => :'fiscal_year',
75
+ :'fiscal_quarter' => :'fiscal_quarter',
76
+ :'calendar_year' => :'calendar_year',
77
+ :'calendar_quarter' => :'calendar_quarter',
78
+ :'actual_reported_date' => :'actual_reported_date',
79
+ :'actual_reported_time' => :'actual_reported_time',
80
+ :'actual_reported_code' => :'actual_reported_code',
81
+ :'actual_reported_desc' => :'actual_reported_desc',
82
+ :'last_rev_date' => :'last_rev_date',
83
+ :'sales_actual' => :'sales_actual',
84
+ :'sales_actual_zacks_adj' => :'sales_actual_zacks_adj',
85
+ :'sales_actual_gaap' => :'sales_actual_gaap',
86
+ :'sales_mean_estimate' => :'sales_mean_estimate',
87
+ :'sales_amount_diff' => :'sales_amount_diff',
88
+ :'sales_percent_diff' => :'sales_percent_diff',
89
+ :'sales_std_dev_estimate' => :'sales_std_dev_estimate'
90
+ }
91
+ end
92
+
93
+ # Attribute type mapping.
94
+ def self.swagger_types
95
+ {
96
+ :'id' => :'String',
97
+ :'fiscal_year' => :'Float',
98
+ :'fiscal_quarter' => :'String',
99
+ :'calendar_year' => :'Float',
100
+ :'calendar_quarter' => :'String',
101
+ :'actual_reported_date' => :'Date',
102
+ :'actual_reported_time' => :'String',
103
+ :'actual_reported_code' => :'String',
104
+ :'actual_reported_desc' => :'String',
105
+ :'last_rev_date' => :'Date',
106
+ :'sales_actual' => :'Float',
107
+ :'sales_actual_zacks_adj' => :'Float',
108
+ :'sales_actual_gaap' => :'Float',
109
+ :'sales_mean_estimate' => :'Float',
110
+ :'sales_amount_diff' => :'Float',
111
+ :'sales_percent_diff' => :'Float',
112
+ :'sales_std_dev_estimate' => :'Float'
113
+ }
114
+ end
115
+
116
+ # Initializes the object
117
+ # @param [Hash] attributes Model attributes in the form of hash
118
+ def initialize(attributes = {})
119
+ return unless attributes.is_a?(Hash)
120
+
121
+ # convert string to symbol for hash key
122
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
123
+
124
+ if attributes.has_key?(:'id')
125
+ self.id = attributes[:'id']
126
+ end
127
+
128
+ if attributes.has_key?(:'fiscal_year')
129
+ self.fiscal_year = attributes[:'fiscal_year']
130
+ end
131
+
132
+ if attributes.has_key?(:'fiscal_quarter')
133
+ self.fiscal_quarter = attributes[:'fiscal_quarter']
134
+ end
135
+
136
+ if attributes.has_key?(:'calendar_year')
137
+ self.calendar_year = attributes[:'calendar_year']
138
+ end
139
+
140
+ if attributes.has_key?(:'calendar_quarter')
141
+ self.calendar_quarter = attributes[:'calendar_quarter']
142
+ end
143
+
144
+ if attributes.has_key?(:'actual_reported_date')
145
+ self.actual_reported_date = attributes[:'actual_reported_date']
146
+ end
147
+
148
+ if attributes.has_key?(:'actual_reported_time')
149
+ self.actual_reported_time = attributes[:'actual_reported_time']
150
+ end
151
+
152
+ if attributes.has_key?(:'actual_reported_code')
153
+ self.actual_reported_code = attributes[:'actual_reported_code']
154
+ end
155
+
156
+ if attributes.has_key?(:'actual_reported_desc')
157
+ self.actual_reported_desc = attributes[:'actual_reported_desc']
158
+ end
159
+
160
+ if attributes.has_key?(:'last_rev_date')
161
+ self.last_rev_date = attributes[:'last_rev_date']
162
+ end
163
+
164
+ if attributes.has_key?(:'sales_actual')
165
+ self.sales_actual = attributes[:'sales_actual']
166
+ end
167
+
168
+ if attributes.has_key?(:'sales_actual_zacks_adj')
169
+ self.sales_actual_zacks_adj = attributes[:'sales_actual_zacks_adj']
170
+ end
171
+
172
+ if attributes.has_key?(:'sales_actual_gaap')
173
+ self.sales_actual_gaap = attributes[:'sales_actual_gaap']
174
+ end
175
+
176
+ if attributes.has_key?(:'sales_mean_estimate')
177
+ self.sales_mean_estimate = attributes[:'sales_mean_estimate']
178
+ end
179
+
180
+ if attributes.has_key?(:'sales_amount_diff')
181
+ self.sales_amount_diff = attributes[:'sales_amount_diff']
182
+ end
183
+
184
+ if attributes.has_key?(:'sales_percent_diff')
185
+ self.sales_percent_diff = attributes[:'sales_percent_diff']
186
+ end
187
+
188
+ if attributes.has_key?(:'sales_std_dev_estimate')
189
+ self.sales_std_dev_estimate = attributes[:'sales_std_dev_estimate']
190
+ end
191
+
192
+ end
193
+
194
+ # Show invalid properties with the reasons. Usually used together with valid?
195
+ # @return Array for valid properties with the reasons
196
+ def list_invalid_properties
197
+ invalid_properties = Array.new
198
+ return invalid_properties
199
+ end
200
+
201
+ # Check to see if the all the properties in the model are valid
202
+ # @return true if the model is valid
203
+ def valid?
204
+ return true
205
+ end
206
+
207
+ # Checks equality by comparing each attribute.
208
+ # @param [Object] Object to be compared
209
+ def ==(o)
210
+ return true if self.equal?(o)
211
+ self.class == o.class &&
212
+ id == o.id &&
213
+ fiscal_year == o.fiscal_year &&
214
+ fiscal_quarter == o.fiscal_quarter &&
215
+ calendar_year == o.calendar_year &&
216
+ calendar_quarter == o.calendar_quarter &&
217
+ actual_reported_date == o.actual_reported_date &&
218
+ actual_reported_time == o.actual_reported_time &&
219
+ actual_reported_code == o.actual_reported_code &&
220
+ actual_reported_desc == o.actual_reported_desc &&
221
+ last_rev_date == o.last_rev_date &&
222
+ sales_actual == o.sales_actual &&
223
+ sales_actual_zacks_adj == o.sales_actual_zacks_adj &&
224
+ sales_actual_gaap == o.sales_actual_gaap &&
225
+ sales_mean_estimate == o.sales_mean_estimate &&
226
+ sales_amount_diff == o.sales_amount_diff &&
227
+ sales_percent_diff == o.sales_percent_diff &&
228
+ sales_std_dev_estimate == o.sales_std_dev_estimate
229
+ end
230
+
231
+ # @see the `==` method
232
+ # @param [Object] Object to be compared
233
+ def eql?(o)
234
+ self == o
235
+ end
236
+
237
+ # Calculates hash code according to all attributes.
238
+ # @return [Fixnum] Hash code
239
+ def hash
240
+ [id, fiscal_year, fiscal_quarter, calendar_year, calendar_quarter, actual_reported_date, actual_reported_time, actual_reported_code, actual_reported_desc, last_rev_date, sales_actual, sales_actual_zacks_adj, sales_actual_gaap, sales_mean_estimate, sales_amount_diff, sales_percent_diff, sales_std_dev_estimate].hash
241
+ end
242
+
243
+ # Builds the object from hash
244
+ # @param [Hash] attributes Model attributes in the form of hash
245
+ # @return [Object] Returns the model itself
246
+ def build_from_hash(attributes)
247
+ return nil unless attributes.is_a?(Hash)
248
+ self.class.swagger_types.each_pair do |key, type|
249
+ if type =~ /\AArray<(.*)>/i
250
+ # check to ensure the input is an array given that the the attribute
251
+ # is documented as an array but the input is not
252
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
253
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
254
+ end
255
+ elsif !attributes[self.class.attribute_map[key]].nil?
256
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
257
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
258
+ end
259
+
260
+ self
261
+ end
262
+
263
+ # Deserializes the data based on type
264
+ # @param string type Data type
265
+ # @param string value Value to be deserialized
266
+ # @return [Object] Deserialized data
267
+ def _deserialize(type, value)
268
+ case type.to_sym
269
+ when :DateTime
270
+ DateTime.parse(value)
271
+ when :Date
272
+ Date.parse(value)
273
+ when :String
274
+ value.to_s
275
+ when :Integer
276
+ value.to_i
277
+ when :Float
278
+ value.to_f
279
+ when :BOOLEAN
280
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
281
+ true
282
+ else
283
+ false
284
+ end
285
+ when :Object
286
+ # generic object (usually a Hash), return directly
287
+ value
288
+ when /\AArray<(?<inner_type>.+)>\z/
289
+ inner_type = Regexp.last_match[:inner_type]
290
+ value.map { |v| _deserialize(inner_type, v) }
291
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
292
+ k_type = Regexp.last_match[:k_type]
293
+ v_type = Regexp.last_match[:v_type]
294
+ {}.tap do |hash|
295
+ value.each do |k, v|
296
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
297
+ end
298
+ end
299
+ else # model
300
+ temp_model = Intrinio.const_get(type).new
301
+ temp_model.build_from_hash(value)
302
+ end
303
+ end
304
+
305
+ # Returns the string representation of the object
306
+ # @return [String] String presentation of the object
307
+ def to_s
308
+ to_hash.to_s
309
+ end
310
+
311
+ # to_body is an alias to to_hash (backward compatibility)
312
+ # @return [Hash] Returns the object in the form of hash
313
+ def to_body
314
+ to_hash
315
+ end
316
+
317
+ # Returns the object in the form of hash
318
+ # @return [Hash] Returns the object in the form of hash
319
+ def to_hash
320
+ hash = {}
321
+ self.class.attribute_map.each_pair do |attr, param|
322
+ value = self.send(attr)
323
+ next if value.nil?
324
+ hash[param] = _to_hash(value)
325
+ end
326
+ hash
327
+ end
328
+
329
+ # Outputs non-array value in the form of hash
330
+ # For object, use to_hash. Otherwise, just return the value
331
+ # @param [Object] value Any valid value
332
+ # @return [Hash] Returns the value in the form of hash
333
+ def _to_hash(value)
334
+ if value.is_a?(Array)
335
+ value.compact.map{ |v| _to_hash(v) }
336
+ elsif value.is_a?(Hash)
337
+ {}.tap do |hash|
338
+ value.each { |k, v| hash[k] = _to_hash(v) }
339
+ end
340
+ elsif value.respond_to? :to_hash
341
+ value.to_hash
342
+ else
343
+ value
344
+ end
345
+ end
346
+
347
+ end
348
+
349
+ end
@@ -0,0 +1,359 @@
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://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.6.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.3.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module Intrinio
16
+ # Zacks Sales Surprises are pre-earnings release consensus sales estimates from analysts for thousands of stocks. Zack’s storied research team aggregates and validates the estimates and compares these estimates to non-GAAP sales reported by the company, providing the amount and percent surprise on release.
17
+ class ZacksSalesSurpriseSummary
18
+ # The Intrinio ID for the record
19
+ attr_accessor :id
20
+
21
+ # The company’s fiscal year for the reported period
22
+ attr_accessor :fiscal_year
23
+
24
+ # The company’s fiscal quarter for the reported period
25
+ attr_accessor :fiscal_quarter
26
+
27
+ # The closest calendar year for the company’s fiscal year
28
+ attr_accessor :calendar_year
29
+
30
+ # The closest calendar quarter for the company’s fiscal year
31
+ attr_accessor :calendar_quarter
32
+
33
+ # The actual report date for the earnings release
34
+ attr_accessor :actual_reported_date
35
+
36
+ # The actual report time for the earnings release
37
+ attr_accessor :actual_reported_time
38
+
39
+ # The code cooresponding to the earnings release BTO = BEFORE THE OPEN | DTM = DURING THE MARKET | AMC = AFTER MARKET CLOSE
40
+ attr_accessor :actual_reported_code
41
+
42
+ # The description for the type of earnings release
43
+ attr_accessor :actual_reported_desc
44
+
45
+ # The last revision date for the analyst estimates
46
+ attr_accessor :last_rev_date
47
+
48
+ # The actual Non-GAAP sales figure released by the company, interpreted by Zacks.
49
+ attr_accessor :sales_actual
50
+
51
+ # The adjustments Zacks made to get to Non-GAAP sales to reconcile with GAAP sales.
52
+ attr_accessor :sales_actual_zacks_adj
53
+
54
+ # The actual GAAP sales figured released by the company
55
+ attr_accessor :sales_actual_gaap
56
+
57
+ # The pre-earnings release mean sales estimate for the company sales_count_estimate; the pre-earnings release number of estimates by analysts
58
+ attr_accessor :sales_mean_estimate
59
+
60
+ # The sales surprise amount difference
61
+ attr_accessor :sales_amount_diff
62
+
63
+ # The sales surprise percent difference
64
+ attr_accessor :sales_percent_diff
65
+
66
+ # The pre-earnings release standard deviation of sales estimates
67
+ attr_accessor :sales_std_dev_estimate
68
+
69
+ # The Security of the Zacks Sales Surprise
70
+ attr_accessor :security
71
+
72
+
73
+ # Attribute mapping from ruby-style variable name to JSON key.
74
+ def self.attribute_map
75
+ {
76
+ :'id' => :'id',
77
+ :'fiscal_year' => :'fiscal_year',
78
+ :'fiscal_quarter' => :'fiscal_quarter',
79
+ :'calendar_year' => :'calendar_year',
80
+ :'calendar_quarter' => :'calendar_quarter',
81
+ :'actual_reported_date' => :'actual_reported_date',
82
+ :'actual_reported_time' => :'actual_reported_time',
83
+ :'actual_reported_code' => :'actual_reported_code',
84
+ :'actual_reported_desc' => :'actual_reported_desc',
85
+ :'last_rev_date' => :'last_rev_date',
86
+ :'sales_actual' => :'sales_actual',
87
+ :'sales_actual_zacks_adj' => :'sales_actual_zacks_adj',
88
+ :'sales_actual_gaap' => :'sales_actual_gaap',
89
+ :'sales_mean_estimate' => :'sales_mean_estimate',
90
+ :'sales_amount_diff' => :'sales_amount_diff',
91
+ :'sales_percent_diff' => :'sales_percent_diff',
92
+ :'sales_std_dev_estimate' => :'sales_std_dev_estimate',
93
+ :'security' => :'security'
94
+ }
95
+ end
96
+
97
+ # Attribute type mapping.
98
+ def self.swagger_types
99
+ {
100
+ :'id' => :'String',
101
+ :'fiscal_year' => :'Float',
102
+ :'fiscal_quarter' => :'String',
103
+ :'calendar_year' => :'Float',
104
+ :'calendar_quarter' => :'String',
105
+ :'actual_reported_date' => :'Date',
106
+ :'actual_reported_time' => :'String',
107
+ :'actual_reported_code' => :'String',
108
+ :'actual_reported_desc' => :'String',
109
+ :'last_rev_date' => :'Date',
110
+ :'sales_actual' => :'Float',
111
+ :'sales_actual_zacks_adj' => :'Float',
112
+ :'sales_actual_gaap' => :'Float',
113
+ :'sales_mean_estimate' => :'Float',
114
+ :'sales_amount_diff' => :'Float',
115
+ :'sales_percent_diff' => :'Float',
116
+ :'sales_std_dev_estimate' => :'Float',
117
+ :'security' => :'SecuritySummary'
118
+ }
119
+ end
120
+
121
+ # Initializes the object
122
+ # @param [Hash] attributes Model attributes in the form of hash
123
+ def initialize(attributes = {})
124
+ return unless attributes.is_a?(Hash)
125
+
126
+ # convert string to symbol for hash key
127
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
128
+
129
+ if attributes.has_key?(:'id')
130
+ self.id = attributes[:'id']
131
+ end
132
+
133
+ if attributes.has_key?(:'fiscal_year')
134
+ self.fiscal_year = attributes[:'fiscal_year']
135
+ end
136
+
137
+ if attributes.has_key?(:'fiscal_quarter')
138
+ self.fiscal_quarter = attributes[:'fiscal_quarter']
139
+ end
140
+
141
+ if attributes.has_key?(:'calendar_year')
142
+ self.calendar_year = attributes[:'calendar_year']
143
+ end
144
+
145
+ if attributes.has_key?(:'calendar_quarter')
146
+ self.calendar_quarter = attributes[:'calendar_quarter']
147
+ end
148
+
149
+ if attributes.has_key?(:'actual_reported_date')
150
+ self.actual_reported_date = attributes[:'actual_reported_date']
151
+ end
152
+
153
+ if attributes.has_key?(:'actual_reported_time')
154
+ self.actual_reported_time = attributes[:'actual_reported_time']
155
+ end
156
+
157
+ if attributes.has_key?(:'actual_reported_code')
158
+ self.actual_reported_code = attributes[:'actual_reported_code']
159
+ end
160
+
161
+ if attributes.has_key?(:'actual_reported_desc')
162
+ self.actual_reported_desc = attributes[:'actual_reported_desc']
163
+ end
164
+
165
+ if attributes.has_key?(:'last_rev_date')
166
+ self.last_rev_date = attributes[:'last_rev_date']
167
+ end
168
+
169
+ if attributes.has_key?(:'sales_actual')
170
+ self.sales_actual = attributes[:'sales_actual']
171
+ end
172
+
173
+ if attributes.has_key?(:'sales_actual_zacks_adj')
174
+ self.sales_actual_zacks_adj = attributes[:'sales_actual_zacks_adj']
175
+ end
176
+
177
+ if attributes.has_key?(:'sales_actual_gaap')
178
+ self.sales_actual_gaap = attributes[:'sales_actual_gaap']
179
+ end
180
+
181
+ if attributes.has_key?(:'sales_mean_estimate')
182
+ self.sales_mean_estimate = attributes[:'sales_mean_estimate']
183
+ end
184
+
185
+ if attributes.has_key?(:'sales_amount_diff')
186
+ self.sales_amount_diff = attributes[:'sales_amount_diff']
187
+ end
188
+
189
+ if attributes.has_key?(:'sales_percent_diff')
190
+ self.sales_percent_diff = attributes[:'sales_percent_diff']
191
+ end
192
+
193
+ if attributes.has_key?(:'sales_std_dev_estimate')
194
+ self.sales_std_dev_estimate = attributes[:'sales_std_dev_estimate']
195
+ end
196
+
197
+ if attributes.has_key?(:'security')
198
+ self.security = attributes[:'security']
199
+ end
200
+
201
+ end
202
+
203
+ # Show invalid properties with the reasons. Usually used together with valid?
204
+ # @return Array for valid properties with the reasons
205
+ def list_invalid_properties
206
+ invalid_properties = Array.new
207
+ return invalid_properties
208
+ end
209
+
210
+ # Check to see if the all the properties in the model are valid
211
+ # @return true if the model is valid
212
+ def valid?
213
+ return true
214
+ end
215
+
216
+ # Checks equality by comparing each attribute.
217
+ # @param [Object] Object to be compared
218
+ def ==(o)
219
+ return true if self.equal?(o)
220
+ self.class == o.class &&
221
+ id == o.id &&
222
+ fiscal_year == o.fiscal_year &&
223
+ fiscal_quarter == o.fiscal_quarter &&
224
+ calendar_year == o.calendar_year &&
225
+ calendar_quarter == o.calendar_quarter &&
226
+ actual_reported_date == o.actual_reported_date &&
227
+ actual_reported_time == o.actual_reported_time &&
228
+ actual_reported_code == o.actual_reported_code &&
229
+ actual_reported_desc == o.actual_reported_desc &&
230
+ last_rev_date == o.last_rev_date &&
231
+ sales_actual == o.sales_actual &&
232
+ sales_actual_zacks_adj == o.sales_actual_zacks_adj &&
233
+ sales_actual_gaap == o.sales_actual_gaap &&
234
+ sales_mean_estimate == o.sales_mean_estimate &&
235
+ sales_amount_diff == o.sales_amount_diff &&
236
+ sales_percent_diff == o.sales_percent_diff &&
237
+ sales_std_dev_estimate == o.sales_std_dev_estimate &&
238
+ security == o.security
239
+ end
240
+
241
+ # @see the `==` method
242
+ # @param [Object] Object to be compared
243
+ def eql?(o)
244
+ self == o
245
+ end
246
+
247
+ # Calculates hash code according to all attributes.
248
+ # @return [Fixnum] Hash code
249
+ def hash
250
+ [id, fiscal_year, fiscal_quarter, calendar_year, calendar_quarter, actual_reported_date, actual_reported_time, actual_reported_code, actual_reported_desc, last_rev_date, sales_actual, sales_actual_zacks_adj, sales_actual_gaap, sales_mean_estimate, sales_amount_diff, sales_percent_diff, sales_std_dev_estimate, security].hash
251
+ end
252
+
253
+ # Builds the object from hash
254
+ # @param [Hash] attributes Model attributes in the form of hash
255
+ # @return [Object] Returns the model itself
256
+ def build_from_hash(attributes)
257
+ return nil unless attributes.is_a?(Hash)
258
+ self.class.swagger_types.each_pair do |key, type|
259
+ if type =~ /\AArray<(.*)>/i
260
+ # check to ensure the input is an array given that the the attribute
261
+ # is documented as an array but the input is not
262
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
263
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
264
+ end
265
+ elsif !attributes[self.class.attribute_map[key]].nil?
266
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
267
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
268
+ end
269
+
270
+ self
271
+ end
272
+
273
+ # Deserializes the data based on type
274
+ # @param string type Data type
275
+ # @param string value Value to be deserialized
276
+ # @return [Object] Deserialized data
277
+ def _deserialize(type, value)
278
+ case type.to_sym
279
+ when :DateTime
280
+ DateTime.parse(value)
281
+ when :Date
282
+ Date.parse(value)
283
+ when :String
284
+ value.to_s
285
+ when :Integer
286
+ value.to_i
287
+ when :Float
288
+ value.to_f
289
+ when :BOOLEAN
290
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
291
+ true
292
+ else
293
+ false
294
+ end
295
+ when :Object
296
+ # generic object (usually a Hash), return directly
297
+ value
298
+ when /\AArray<(?<inner_type>.+)>\z/
299
+ inner_type = Regexp.last_match[:inner_type]
300
+ value.map { |v| _deserialize(inner_type, v) }
301
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
302
+ k_type = Regexp.last_match[:k_type]
303
+ v_type = Regexp.last_match[:v_type]
304
+ {}.tap do |hash|
305
+ value.each do |k, v|
306
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
307
+ end
308
+ end
309
+ else # model
310
+ temp_model = Intrinio.const_get(type).new
311
+ temp_model.build_from_hash(value)
312
+ end
313
+ end
314
+
315
+ # Returns the string representation of the object
316
+ # @return [String] String presentation of the object
317
+ def to_s
318
+ to_hash.to_s
319
+ end
320
+
321
+ # to_body is an alias to to_hash (backward compatibility)
322
+ # @return [Hash] Returns the object in the form of hash
323
+ def to_body
324
+ to_hash
325
+ end
326
+
327
+ # Returns the object in the form of hash
328
+ # @return [Hash] Returns the object in the form of hash
329
+ def to_hash
330
+ hash = {}
331
+ self.class.attribute_map.each_pair do |attr, param|
332
+ value = self.send(attr)
333
+ next if value.nil?
334
+ hash[param] = _to_hash(value)
335
+ end
336
+ hash
337
+ end
338
+
339
+ # Outputs non-array value in the form of hash
340
+ # For object, use to_hash. Otherwise, just return the value
341
+ # @param [Object] value Any valid value
342
+ # @return [Hash] Returns the value in the form of hash
343
+ def _to_hash(value)
344
+ if value.is_a?(Array)
345
+ value.compact.map{ |v| _to_hash(v) }
346
+ elsif value.is_a?(Hash)
347
+ {}.tap do |hash|
348
+ value.each { |k, v| hash[k] = _to_hash(v) }
349
+ end
350
+ elsif value.respond_to? :to_hash
351
+ value.to_hash
352
+ else
353
+ value
354
+ end
355
+ end
356
+
357
+ end
358
+
359
+ end