x-twitter-scraper 0.3.0 → 0.4.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 (456) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +25 -0
  3. data/README.md +5 -5
  4. data/lib/x_twitter_scraper/models/api_key.rb +2 -0
  5. data/lib/x_twitter_scraper/models/api_key_list_response.rb +3 -44
  6. data/lib/x_twitter_scraper/models/delivery.rb +2 -0
  7. data/lib/x_twitter_scraper/models/draft.rb +2 -0
  8. data/lib/x_twitter_scraper/models/draft_detail.rb +3 -0
  9. data/lib/x_twitter_scraper/models/draft_list_params.rb +2 -1
  10. data/lib/x_twitter_scraper/models/draft_list_response.rb +3 -38
  11. data/lib/x_twitter_scraper/models/draw_detail.rb +2 -0
  12. data/lib/x_twitter_scraper/models/draw_export_params.rb +3 -1
  13. data/lib/x_twitter_scraper/models/draw_list_item.rb +2 -0
  14. data/lib/x_twitter_scraper/models/draw_list_params.rb +4 -3
  15. data/lib/x_twitter_scraper/models/draw_list_response.rb +3 -50
  16. data/lib/x_twitter_scraper/models/draw_retrieve_response.rb +8 -124
  17. data/lib/x_twitter_scraper/models/draw_run_response.rb +3 -32
  18. data/lib/x_twitter_scraper/models/error.rb +2 -0
  19. data/lib/x_twitter_scraper/models/event.rb +11 -18
  20. data/lib/x_twitter_scraper/models/event_detail.rb +7 -18
  21. data/lib/x_twitter_scraper/models/event_list_params.rb +10 -21
  22. data/lib/x_twitter_scraper/models/event_list_response.rb +3 -59
  23. data/lib/x_twitter_scraper/models/event_type.rb +1 -0
  24. data/lib/x_twitter_scraper/models/extraction_estimate_cost_params.rb +9 -7
  25. data/lib/x_twitter_scraper/models/extraction_export_results_params.rb +5 -1
  26. data/lib/x_twitter_scraper/models/extraction_job.rb +11 -1
  27. data/lib/x_twitter_scraper/models/extraction_list_params.rb +10 -5
  28. data/lib/x_twitter_scraper/models/extraction_list_response.rb +3 -87
  29. data/lib/x_twitter_scraper/models/extraction_retrieve_params.rb +4 -3
  30. data/lib/x_twitter_scraper/models/extraction_run_params.rb +3 -1
  31. data/lib/x_twitter_scraper/models/extraction_run_response.rb +10 -15
  32. data/lib/x_twitter_scraper/models/integration.rb +12 -32
  33. data/lib/x_twitter_scraper/models/integration_create_params.rb +8 -32
  34. data/lib/x_twitter_scraper/models/integration_delivery.rb +2 -0
  35. data/lib/x_twitter_scraper/models/integration_list_deliveries_params.rb +4 -1
  36. data/lib/x_twitter_scraper/models/integration_list_deliveries_response.rb +3 -67
  37. data/lib/x_twitter_scraper/models/integration_list_response.rb +3 -112
  38. data/lib/x_twitter_scraper/models/integration_update_params.rb +4 -19
  39. data/lib/x_twitter_scraper/models/monitor.rb +12 -17
  40. data/lib/x_twitter_scraper/models/monitor_create_params.rb +4 -19
  41. data/lib/x_twitter_scraper/models/monitor_create_response.rb +8 -17
  42. data/lib/x_twitter_scraper/models/monitor_list_response.rb +3 -60
  43. data/lib/x_twitter_scraper/models/monitor_update_params.rb +7 -19
  44. data/lib/x_twitter_scraper/models/paginated_tweets.rb +5 -96
  45. data/lib/x_twitter_scraper/models/paginated_users.rb +5 -73
  46. data/lib/x_twitter_scraper/models/radar_item.rb +2 -0
  47. data/lib/x_twitter_scraper/models/radar_retrieve_trending_topics_params.rb +20 -3
  48. data/lib/x_twitter_scraper/models/radar_retrieve_trending_topics_response.rb +3 -62
  49. data/lib/x_twitter_scraper/models/style_compare_response.rb +9 -134
  50. data/lib/x_twitter_scraper/models/style_delete_params.rb +4 -4
  51. data/lib/x_twitter_scraper/models/style_get_performance_params.rb +4 -4
  52. data/lib/x_twitter_scraper/models/style_list_response.rb +3 -32
  53. data/lib/x_twitter_scraper/models/style_profile.rb +3 -0
  54. data/lib/x_twitter_scraper/models/style_profile_summary.rb +2 -0
  55. data/lib/x_twitter_scraper/models/style_retrieve_params.rb +4 -4
  56. data/lib/x_twitter_scraper/models/style_update_params.rb +4 -4
  57. data/lib/x_twitter_scraper/models/trend_list_params.rb +2 -1
  58. data/lib/x_twitter_scraper/models/webhook.rb +11 -17
  59. data/lib/x_twitter_scraper/models/webhook_create_params.rb +4 -19
  60. data/lib/x_twitter_scraper/models/webhook_create_response.rb +8 -17
  61. data/lib/x_twitter_scraper/models/webhook_list_deliveries_response.rb +3 -56
  62. data/lib/x_twitter_scraper/models/webhook_list_response.rb +3 -54
  63. data/lib/x_twitter_scraper/models/webhook_update_params.rb +8 -19
  64. data/lib/x_twitter_scraper/models/winner.rb +2 -0
  65. data/lib/x_twitter_scraper/models/x/account_bulk_retry_params.rb +16 -0
  66. data/lib/x_twitter_scraper/models/x/account_bulk_retry_response.rb +19 -0
  67. data/lib/x_twitter_scraper/models/x/account_list_response.rb +3 -38
  68. data/lib/x_twitter_scraper/models/x/account_reauth_params.rb +4 -4
  69. data/lib/x_twitter_scraper/models/x/bookmark_list_params.rb +2 -2
  70. data/lib/x_twitter_scraper/models/x/communities/join_create_params.rb +2 -2
  71. data/lib/x_twitter_scraper/models/x/communities/join_delete_all_params.rb +2 -2
  72. data/lib/x_twitter_scraper/models/x/communities/tweet_list_by_community_params.rb +33 -0
  73. data/lib/x_twitter_scraper/models/x/communities/tweet_list_params.rb +6 -6
  74. data/lib/x_twitter_scraper/models/x/community_action_result.rb +2 -0
  75. data/lib/x_twitter_scraper/models/x/community_create_params.rb +2 -2
  76. data/lib/x_twitter_scraper/models/x/community_delete_params.rb +2 -2
  77. data/lib/x_twitter_scraper/models/x/community_retrieve_info_response.rb +6 -6
  78. data/lib/x_twitter_scraper/models/x/community_retrieve_moderators_params.rb +2 -2
  79. data/lib/x_twitter_scraper/models/x/community_retrieve_search_params.rb +2 -2
  80. data/lib/x_twitter_scraper/models/x/dm_retrieve_history_params.rb +2 -2
  81. data/lib/x_twitter_scraper/models/x/dm_send_params.rb +2 -2
  82. data/lib/x_twitter_scraper/models/x/list_retrieve_followers_params.rb +2 -2
  83. data/lib/x_twitter_scraper/models/x/list_retrieve_members_params.rb +2 -2
  84. data/lib/x_twitter_scraper/models/x/list_retrieve_tweets_params.rb +2 -2
  85. data/lib/x_twitter_scraper/models/x/media_upload_params.rb +2 -2
  86. data/lib/x_twitter_scraper/models/x/profile_update_avatar_params.rb +2 -2
  87. data/lib/x_twitter_scraper/models/x/profile_update_banner_params.rb +2 -2
  88. data/lib/x_twitter_scraper/models/x/profile_update_params.rb +2 -2
  89. data/lib/x_twitter_scraper/models/x/search_tweet.rb +20 -1
  90. data/lib/x_twitter_scraper/models/x/tweet_author.rb +2 -0
  91. data/lib/x_twitter_scraper/models/x/tweet_delete_params.rb +6 -6
  92. data/lib/x_twitter_scraper/models/x/tweet_detail.rb +109 -1
  93. data/lib/x_twitter_scraper/models/x/tweet_get_favoriters_params.rb +2 -2
  94. data/lib/x_twitter_scraper/models/x/tweet_get_quotes_params.rb +8 -8
  95. data/lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb +6 -6
  96. data/lib/x_twitter_scraper/models/x/tweet_get_retweeters_params.rb +2 -2
  97. data/lib/x_twitter_scraper/models/x/tweet_get_thread_params.rb +2 -2
  98. data/lib/x_twitter_scraper/models/x/tweet_retrieve_params.rb +4 -4
  99. data/lib/x_twitter_scraper/models/x/tweet_retrieve_response.rb +9 -100
  100. data/lib/x_twitter_scraper/models/x/tweet_search_params.rb +2 -2
  101. data/lib/x_twitter_scraper/models/x/tweets/like_create_params.rb +6 -6
  102. data/lib/x_twitter_scraper/models/x/tweets/like_delete_params.rb +6 -6
  103. data/lib/x_twitter_scraper/models/x/tweets/retweet_create_params.rb +6 -6
  104. data/lib/x_twitter_scraper/models/x/tweets/retweet_delete_params.rb +6 -6
  105. data/lib/x_twitter_scraper/models/x/user_profile.rb +3 -0
  106. data/lib/x_twitter_scraper/models/x/user_retrieve_followers_params.rb +2 -2
  107. data/lib/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rb +2 -2
  108. data/lib/x_twitter_scraper/models/x/user_retrieve_following_params.rb +4 -4
  109. data/lib/x_twitter_scraper/models/x/user_retrieve_likes_params.rb +2 -2
  110. data/lib/x_twitter_scraper/models/x/user_retrieve_media_params.rb +2 -2
  111. data/lib/x_twitter_scraper/models/x/user_retrieve_mentions_params.rb +6 -6
  112. data/lib/x_twitter_scraper/models/x/user_retrieve_params.rb +4 -4
  113. data/lib/x_twitter_scraper/models/x/user_retrieve_search_params.rb +4 -4
  114. data/lib/x_twitter_scraper/models/x/user_retrieve_tweets_params.rb +2 -2
  115. data/lib/x_twitter_scraper/models/x/user_retrieve_verified_followers_params.rb +2 -2
  116. data/lib/x_twitter_scraper/models/x/users/follow_create_params.rb +6 -6
  117. data/lib/x_twitter_scraper/models/x/users/follow_delete_all_params.rb +6 -6
  118. data/lib/x_twitter_scraper/models/x/x_account.rb +2 -0
  119. data/lib/x_twitter_scraper/models/x/x_account_detail.rb +3 -0
  120. data/lib/x_twitter_scraper/models/x_get_article_response.rb +5 -38
  121. data/lib/x_twitter_scraper/models/x_get_home_timeline_params.rb +2 -2
  122. data/lib/x_twitter_scraper/models/x_get_notifications_params.rb +2 -2
  123. data/lib/x_twitter_scraper/models/x_get_trends_response.rb +57 -0
  124. data/lib/x_twitter_scraper/resources/drafts.rb +5 -5
  125. data/lib/x_twitter_scraper/resources/draws.rb +3 -3
  126. data/lib/x_twitter_scraper/resources/events.rb +6 -6
  127. data/lib/x_twitter_scraper/resources/extractions.rb +12 -12
  128. data/lib/x_twitter_scraper/resources/integrations.rb +11 -11
  129. data/lib/x_twitter_scraper/resources/monitors.rb +6 -6
  130. data/lib/x_twitter_scraper/resources/radar.rb +1 -1
  131. data/lib/x_twitter_scraper/resources/styles.rb +22 -22
  132. data/lib/x_twitter_scraper/resources/support/tickets.rb +8 -3
  133. data/lib/x_twitter_scraper/resources/trends.rb +2 -2
  134. data/lib/x_twitter_scraper/resources/webhooks.rb +4 -4
  135. data/lib/x_twitter_scraper/resources/x/accounts.rb +24 -4
  136. data/lib/x_twitter_scraper/resources/x/bookmarks.rb +3 -3
  137. data/lib/x_twitter_scraper/resources/x/communities/join.rb +6 -6
  138. data/lib/x_twitter_scraper/resources/x/communities/tweets.rb +30 -5
  139. data/lib/x_twitter_scraper/resources/x/communities.rb +12 -12
  140. data/lib/x_twitter_scraper/resources/x/dm.rb +2 -2
  141. data/lib/x_twitter_scraper/resources/x/lists.rb +11 -11
  142. data/lib/x_twitter_scraper/resources/x/media.rb +1 -1
  143. data/lib/x_twitter_scraper/resources/x/profile.rb +3 -3
  144. data/lib/x_twitter_scraper/resources/x/tweets/like.rb +10 -10
  145. data/lib/x_twitter_scraper/resources/x/tweets/retweet.rb +10 -10
  146. data/lib/x_twitter_scraper/resources/x/tweets.rb +46 -39
  147. data/lib/x_twitter_scraper/resources/x/users/follow.rb +10 -10
  148. data/lib/x_twitter_scraper/resources/x/users.rb +45 -45
  149. data/lib/x_twitter_scraper/resources/x.rb +13 -7
  150. data/lib/x_twitter_scraper/version.rb +1 -1
  151. data/lib/x_twitter_scraper.rb +4 -28
  152. data/rbi/x_twitter_scraper/models/api_key.rbi +1 -0
  153. data/rbi/x_twitter_scraper/models/api_key_list_response.rbi +5 -78
  154. data/rbi/x_twitter_scraper/models/delivery.rbi +1 -0
  155. data/rbi/x_twitter_scraper/models/draft.rbi +1 -0
  156. data/rbi/x_twitter_scraper/models/draft_detail.rbi +1 -0
  157. data/rbi/x_twitter_scraper/models/draft_list_params.rbi +2 -0
  158. data/rbi/x_twitter_scraper/models/draft_list_response.rbi +3 -63
  159. data/rbi/x_twitter_scraper/models/draw_detail.rbi +1 -0
  160. data/rbi/x_twitter_scraper/models/draw_export_params.rbi +3 -0
  161. data/rbi/x_twitter_scraper/models/draw_list_item.rbi +1 -0
  162. data/rbi/x_twitter_scraper/models/draw_list_params.rbi +4 -2
  163. data/rbi/x_twitter_scraper/models/draw_list_response.rbi +3 -76
  164. data/rbi/x_twitter_scraper/models/draw_retrieve_response.rbi +13 -178
  165. data/rbi/x_twitter_scraper/models/draw_run_response.rbi +3 -52
  166. data/rbi/x_twitter_scraper/models/error.rbi +1 -0
  167. data/rbi/x_twitter_scraper/models/event.rbi +14 -31
  168. data/rbi/x_twitter_scraper/models/event_detail.rbi +6 -47
  169. data/rbi/x_twitter_scraper/models/event_list_params.rbi +12 -63
  170. data/rbi/x_twitter_scraper/models/event_list_response.rbi +3 -122
  171. data/rbi/x_twitter_scraper/models/event_type.rbi +1 -0
  172. data/rbi/x_twitter_scraper/models/extraction_estimate_cost_params.rbi +9 -6
  173. data/rbi/x_twitter_scraper/models/extraction_export_results_params.rbi +8 -1
  174. data/rbi/x_twitter_scraper/models/extraction_job.rbi +8 -4
  175. data/rbi/x_twitter_scraper/models/extraction_list_params.rbi +10 -2
  176. data/rbi/x_twitter_scraper/models/extraction_list_response.rbi +3 -254
  177. data/rbi/x_twitter_scraper/models/extraction_retrieve_params.rbi +4 -2
  178. data/rbi/x_twitter_scraper/models/extraction_run_params.rbi +3 -0
  179. data/rbi/x_twitter_scraper/models/extraction_run_response.rbi +12 -40
  180. data/rbi/x_twitter_scraper/models/integration.rbi +12 -81
  181. data/rbi/x_twitter_scraper/models/integration_create_params.rbi +9 -96
  182. data/rbi/x_twitter_scraper/models/integration_delivery.rbi +1 -0
  183. data/rbi/x_twitter_scraper/models/integration_list_deliveries_params.rbi +7 -1
  184. data/rbi/x_twitter_scraper/models/integration_list_deliveries_response.rbi +3 -119
  185. data/rbi/x_twitter_scraper/models/integration_list_response.rbi +3 -227
  186. data/rbi/x_twitter_scraper/models/integration_update_params.rbi +6 -74
  187. data/rbi/x_twitter_scraper/models/monitor.rbi +6 -48
  188. data/rbi/x_twitter_scraper/models/monitor_create_params.rbi +5 -62
  189. data/rbi/x_twitter_scraper/models/monitor_create_response.rbi +12 -70
  190. data/rbi/x_twitter_scraper/models/monitor_list_response.rbi +3 -141
  191. data/rbi/x_twitter_scraper/models/monitor_update_params.rbi +12 -69
  192. data/rbi/x_twitter_scraper/models/paginated_tweets.rbi +4 -169
  193. data/rbi/x_twitter_scraper/models/paginated_users.rbi +4 -120
  194. data/rbi/x_twitter_scraper/models/radar_item.rbi +1 -0
  195. data/rbi/x_twitter_scraper/models/radar_retrieve_trending_topics_params.rbi +78 -4
  196. data/rbi/x_twitter_scraper/models/radar_retrieve_trending_topics_response.rbi +3 -108
  197. data/rbi/x_twitter_scraper/models/style_compare_response.rbi +16 -259
  198. data/rbi/x_twitter_scraper/models/style_delete_params.rbi +4 -4
  199. data/rbi/x_twitter_scraper/models/style_get_performance_params.rbi +4 -4
  200. data/rbi/x_twitter_scraper/models/style_list_response.rbi +3 -54
  201. data/rbi/x_twitter_scraper/models/style_profile.rbi +1 -0
  202. data/rbi/x_twitter_scraper/models/style_profile_summary.rbi +1 -0
  203. data/rbi/x_twitter_scraper/models/style_retrieve_params.rbi +4 -4
  204. data/rbi/x_twitter_scraper/models/style_update_params.rbi +4 -4
  205. data/rbi/x_twitter_scraper/models/trend_list_params.rbi +2 -0
  206. data/rbi/x_twitter_scraper/models/webhook.rbi +13 -49
  207. data/rbi/x_twitter_scraper/models/webhook_create_params.rbi +5 -62
  208. data/rbi/x_twitter_scraper/models/webhook_create_response.rbi +12 -70
  209. data/rbi/x_twitter_scraper/models/webhook_list_deliveries_response.rbi +5 -105
  210. data/rbi/x_twitter_scraper/models/webhook_list_response.rbi +5 -134
  211. data/rbi/x_twitter_scraper/models/webhook_update_params.rbi +6 -68
  212. data/rbi/x_twitter_scraper/models/winner.rbi +1 -0
  213. data/rbi/x_twitter_scraper/models/x/account_bulk_retry_params.rbi +34 -0
  214. data/rbi/x_twitter_scraper/models/x/account_bulk_retry_response.rbi +32 -0
  215. data/rbi/x_twitter_scraper/models/x/account_list_response.rbi +3 -68
  216. data/rbi/x_twitter_scraper/models/x/account_reauth_params.rbi +4 -4
  217. data/rbi/x_twitter_scraper/models/x/bookmark_list_params.rbi +2 -2
  218. data/rbi/x_twitter_scraper/models/x/communities/join_create_params.rbi +2 -2
  219. data/rbi/x_twitter_scraper/models/x/communities/join_delete_all_params.rbi +2 -2
  220. data/rbi/x_twitter_scraper/models/x/communities/tweet_list_by_community_params.rbi +59 -0
  221. data/rbi/x_twitter_scraper/models/x/communities/tweet_list_params.rbi +6 -6
  222. data/rbi/x_twitter_scraper/models/x/community_action_result.rbi +1 -0
  223. data/rbi/x_twitter_scraper/models/x/community_create_params.rbi +2 -2
  224. data/rbi/x_twitter_scraper/models/x/community_delete_params.rbi +2 -2
  225. data/rbi/x_twitter_scraper/models/x/community_retrieve_info_response.rbi +6 -6
  226. data/rbi/x_twitter_scraper/models/x/community_retrieve_moderators_params.rbi +2 -2
  227. data/rbi/x_twitter_scraper/models/x/community_retrieve_search_params.rbi +2 -2
  228. data/rbi/x_twitter_scraper/models/x/dm_retrieve_history_params.rbi +2 -2
  229. data/rbi/x_twitter_scraper/models/x/dm_send_params.rbi +2 -2
  230. data/rbi/x_twitter_scraper/models/x/list_retrieve_followers_params.rbi +2 -2
  231. data/rbi/x_twitter_scraper/models/x/list_retrieve_members_params.rbi +2 -2
  232. data/rbi/x_twitter_scraper/models/x/list_retrieve_tweets_params.rbi +2 -2
  233. data/rbi/x_twitter_scraper/models/x/media_upload_params.rbi +2 -2
  234. data/rbi/x_twitter_scraper/models/x/profile_update_avatar_params.rbi +2 -2
  235. data/rbi/x_twitter_scraper/models/x/profile_update_banner_params.rbi +2 -2
  236. data/rbi/x_twitter_scraper/models/x/profile_update_params.rbi +2 -2
  237. data/rbi/x_twitter_scraper/models/x/search_tweet.rbi +12 -0
  238. data/rbi/x_twitter_scraper/models/x/tweet_author.rbi +1 -0
  239. data/rbi/x_twitter_scraper/models/x/tweet_delete_params.rbi +6 -6
  240. data/rbi/x_twitter_scraper/models/x/tweet_detail.rbi +195 -3
  241. data/rbi/x_twitter_scraper/models/x/tweet_get_favoriters_params.rbi +2 -2
  242. data/rbi/x_twitter_scraper/models/x/tweet_get_quotes_params.rbi +8 -8
  243. data/rbi/x_twitter_scraper/models/x/tweet_get_replies_params.rbi +6 -6
  244. data/rbi/x_twitter_scraper/models/x/tweet_get_retweeters_params.rbi +2 -2
  245. data/rbi/x_twitter_scraper/models/x/tweet_get_thread_params.rbi +2 -2
  246. data/rbi/x_twitter_scraper/models/x/tweet_retrieve_params.rbi +4 -7
  247. data/rbi/x_twitter_scraper/models/x/tweet_retrieve_response.rbi +16 -171
  248. data/rbi/x_twitter_scraper/models/x/tweet_search_params.rbi +2 -2
  249. data/rbi/x_twitter_scraper/models/x/tweets/like_create_params.rbi +6 -6
  250. data/rbi/x_twitter_scraper/models/x/tweets/like_delete_params.rbi +6 -6
  251. data/rbi/x_twitter_scraper/models/x/tweets/retweet_create_params.rbi +6 -6
  252. data/rbi/x_twitter_scraper/models/x/tweets/retweet_delete_params.rbi +6 -6
  253. data/rbi/x_twitter_scraper/models/x/user_profile.rbi +1 -0
  254. data/rbi/x_twitter_scraper/models/x/user_retrieve_followers_params.rbi +2 -2
  255. data/rbi/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rbi +2 -2
  256. data/rbi/x_twitter_scraper/models/x/user_retrieve_following_params.rbi +4 -4
  257. data/rbi/x_twitter_scraper/models/x/user_retrieve_likes_params.rbi +2 -2
  258. data/rbi/x_twitter_scraper/models/x/user_retrieve_media_params.rbi +2 -2
  259. data/rbi/x_twitter_scraper/models/x/user_retrieve_mentions_params.rbi +6 -6
  260. data/rbi/x_twitter_scraper/models/x/user_retrieve_params.rbi +4 -7
  261. data/rbi/x_twitter_scraper/models/x/user_retrieve_search_params.rbi +4 -4
  262. data/rbi/x_twitter_scraper/models/x/user_retrieve_tweets_params.rbi +2 -2
  263. data/rbi/x_twitter_scraper/models/x/user_retrieve_verified_followers_params.rbi +2 -2
  264. data/rbi/x_twitter_scraper/models/x/users/follow_create_params.rbi +6 -6
  265. data/rbi/x_twitter_scraper/models/x/users/follow_delete_all_params.rbi +6 -6
  266. data/rbi/x_twitter_scraper/models/x/x_account.rbi +1 -0
  267. data/rbi/x_twitter_scraper/models/x/x_account_detail.rbi +1 -0
  268. data/rbi/x_twitter_scraper/models/x_get_article_response.rbi +10 -71
  269. data/rbi/x_twitter_scraper/models/x_get_home_timeline_params.rbi +2 -2
  270. data/rbi/x_twitter_scraper/models/x_get_notifications_params.rbi +2 -2
  271. data/rbi/x_twitter_scraper/models/x_get_trends_response.rbi +102 -0
  272. data/rbi/x_twitter_scraper/resources/drafts.rbi +3 -2
  273. data/rbi/x_twitter_scraper/resources/draws.rbi +3 -1
  274. data/rbi/x_twitter_scraper/resources/events.rbi +6 -3
  275. data/rbi/x_twitter_scraper/resources/extractions.rbi +12 -5
  276. data/rbi/x_twitter_scraper/resources/integrations.rbi +10 -13
  277. data/rbi/x_twitter_scraper/resources/monitors.rbi +6 -6
  278. data/rbi/x_twitter_scraper/resources/radar.rbi +2 -1
  279. data/rbi/x_twitter_scraper/resources/styles.rbi +15 -15
  280. data/rbi/x_twitter_scraper/resources/support/tickets.rbi +17 -3
  281. data/rbi/x_twitter_scraper/resources/trends.rbi +2 -1
  282. data/rbi/x_twitter_scraper/resources/webhooks.rbi +5 -5
  283. data/rbi/x_twitter_scraper/resources/x/accounts.rbi +13 -3
  284. data/rbi/x_twitter_scraper/resources/x/bookmarks.rbi +2 -2
  285. data/rbi/x_twitter_scraper/resources/x/communities/join.rbi +4 -8
  286. data/rbi/x_twitter_scraper/resources/x/communities/tweets.rbi +21 -4
  287. data/rbi/x_twitter_scraper/resources/x/communities.rbi +9 -9
  288. data/rbi/x_twitter_scraper/resources/x/dm.rbi +2 -2
  289. data/rbi/x_twitter_scraper/resources/x/lists.rbi +8 -8
  290. data/rbi/x_twitter_scraper/resources/x/media.rbi +1 -1
  291. data/rbi/x_twitter_scraper/resources/x/profile.rbi +3 -3
  292. data/rbi/x_twitter_scraper/resources/x/tweets/like.rbi +8 -6
  293. data/rbi/x_twitter_scraper/resources/x/tweets/retweet.rbi +8 -6
  294. data/rbi/x_twitter_scraper/resources/x/tweets.rbi +33 -28
  295. data/rbi/x_twitter_scraper/resources/x/users/follow.rbi +6 -6
  296. data/rbi/x_twitter_scraper/resources/x/users.rbi +33 -34
  297. data/rbi/x_twitter_scraper/resources/x.rbi +11 -5
  298. data/sig/x_twitter_scraper/models/api_key_list_response.rbs +4 -53
  299. data/sig/x_twitter_scraper/models/draft_list_response.rbs +4 -45
  300. data/sig/x_twitter_scraper/models/draw_list_response.rbs +4 -53
  301. data/sig/x_twitter_scraper/models/draw_retrieve_response.rbs +8 -124
  302. data/sig/x_twitter_scraper/models/draw_run_response.rbs +4 -36
  303. data/sig/x_twitter_scraper/models/event.rbs +4 -25
  304. data/sig/x_twitter_scraper/models/event_detail.rbs +4 -25
  305. data/sig/x_twitter_scraper/models/event_list_params.rbs +6 -27
  306. data/sig/x_twitter_scraper/models/event_list_response.rbs +4 -67
  307. data/sig/x_twitter_scraper/models/extraction_list_response.rbs +4 -109
  308. data/sig/x_twitter_scraper/models/extraction_run_response.rbs +5 -15
  309. data/sig/x_twitter_scraper/models/integration.rbs +9 -40
  310. data/sig/x_twitter_scraper/models/integration_create_params.rbs +8 -39
  311. data/sig/x_twitter_scraper/models/integration_list_deliveries_response.rbs +4 -78
  312. data/sig/x_twitter_scraper/models/integration_list_response.rbs +4 -114
  313. data/sig/x_twitter_scraper/models/integration_update_params.rbs +6 -27
  314. data/sig/x_twitter_scraper/models/monitor.rbs +4 -25
  315. data/sig/x_twitter_scraper/models/monitor_create_params.rbs +4 -25
  316. data/sig/x_twitter_scraper/models/monitor_create_response.rbs +4 -25
  317. data/sig/x_twitter_scraper/models/monitor_list_response.rbs +4 -70
  318. data/sig/x_twitter_scraper/models/monitor_update_params.rbs +6 -27
  319. data/sig/x_twitter_scraper/models/paginated_tweets.rbs +4 -113
  320. data/sig/x_twitter_scraper/models/paginated_users.rbs +4 -87
  321. data/sig/x_twitter_scraper/models/radar_retrieve_trending_topics_params.rbs +30 -5
  322. data/sig/x_twitter_scraper/models/radar_retrieve_trending_topics_response.rbs +4 -70
  323. data/sig/x_twitter_scraper/models/style_compare_response.rbs +8 -154
  324. data/sig/x_twitter_scraper/models/style_delete_params.rbs +4 -4
  325. data/sig/x_twitter_scraper/models/style_get_performance_params.rbs +4 -4
  326. data/sig/x_twitter_scraper/models/style_list_response.rbs +4 -38
  327. data/sig/x_twitter_scraper/models/style_retrieve_params.rbs +4 -4
  328. data/sig/x_twitter_scraper/models/style_update_params.rbs +4 -4
  329. data/sig/x_twitter_scraper/models/webhook.rbs +4 -25
  330. data/sig/x_twitter_scraper/models/webhook_create_params.rbs +4 -28
  331. data/sig/x_twitter_scraper/models/webhook_create_response.rbs +4 -25
  332. data/sig/x_twitter_scraper/models/webhook_list_deliveries_response.rbs +4 -68
  333. data/sig/x_twitter_scraper/models/webhook_list_response.rbs +4 -69
  334. data/sig/x_twitter_scraper/models/webhook_update_params.rbs +6 -27
  335. data/sig/x_twitter_scraper/models/x/account_bulk_retry_params.rbs +19 -0
  336. data/sig/x_twitter_scraper/models/x/account_bulk_retry_response.rbs +15 -0
  337. data/sig/x_twitter_scraper/models/x/account_list_response.rbs +4 -45
  338. data/sig/x_twitter_scraper/models/x/communities/tweet_list_by_community_params.rbs +34 -0
  339. data/sig/x_twitter_scraper/models/x/search_tweet.rbs +7 -0
  340. data/sig/x_twitter_scraper/models/x/tweet_delete_params.rbs +4 -4
  341. data/sig/x_twitter_scraper/models/x/tweet_detail.rbs +108 -3
  342. data/sig/x_twitter_scraper/models/x/tweet_retrieve_params.rbs +4 -5
  343. data/sig/x_twitter_scraper/models/x/tweet_retrieve_response.rbs +10 -108
  344. data/sig/x_twitter_scraper/models/x/tweets/like_create_params.rbs +4 -4
  345. data/sig/x_twitter_scraper/models/x/tweets/like_delete_params.rbs +4 -4
  346. data/sig/x_twitter_scraper/models/x/tweets/retweet_create_params.rbs +4 -4
  347. data/sig/x_twitter_scraper/models/x/tweets/retweet_delete_params.rbs +4 -4
  348. data/sig/x_twitter_scraper/models/x/user_retrieve_params.rbs +4 -5
  349. data/sig/x_twitter_scraper/models/x/users/follow_create_params.rbs +4 -4
  350. data/sig/x_twitter_scraper/models/x/users/follow_delete_all_params.rbs +4 -4
  351. data/sig/x_twitter_scraper/models/x_get_article_response.rbs +6 -45
  352. data/sig/x_twitter_scraper/models/x_get_trends_response.rbs +63 -0
  353. data/sig/x_twitter_scraper/resources/drafts.rbs +2 -2
  354. data/sig/x_twitter_scraper/resources/events.rbs +2 -2
  355. data/sig/x_twitter_scraper/resources/integrations.rbs +6 -6
  356. data/sig/x_twitter_scraper/resources/monitors.rbs +4 -4
  357. data/sig/x_twitter_scraper/resources/radar.rbs +1 -1
  358. data/sig/x_twitter_scraper/resources/styles.rbs +7 -7
  359. data/sig/x_twitter_scraper/resources/webhooks.rbs +3 -3
  360. data/sig/x_twitter_scraper/resources/x/accounts.rbs +5 -1
  361. data/sig/x_twitter_scraper/resources/x/bookmarks.rbs +1 -1
  362. data/sig/x_twitter_scraper/resources/x/communities/join.rbs +2 -2
  363. data/sig/x_twitter_scraper/resources/x/communities/tweets.rbs +7 -1
  364. data/sig/x_twitter_scraper/resources/x/communities.rbs +3 -3
  365. data/sig/x_twitter_scraper/resources/x/lists.rbs +3 -3
  366. data/sig/x_twitter_scraper/resources/x/tweets/like.rbs +2 -2
  367. data/sig/x_twitter_scraper/resources/x/tweets/retweet.rbs +2 -2
  368. data/sig/x_twitter_scraper/resources/x/tweets.rbs +9 -9
  369. data/sig/x_twitter_scraper/resources/x/users/follow.rbs +2 -2
  370. data/sig/x_twitter_scraper/resources/x/users.rbs +12 -12
  371. data/sig/x_twitter_scraper/resources/x.rbs +4 -2
  372. metadata +17 -88
  373. data/lib/x_twitter_scraper/models/draft_create_response.rb +0 -46
  374. data/lib/x_twitter_scraper/models/draft_retrieve_response.rb +0 -46
  375. data/lib/x_twitter_scraper/models/event_retrieve_response.rb +0 -74
  376. data/lib/x_twitter_scraper/models/integration_create_response.rb +0 -114
  377. data/lib/x_twitter_scraper/models/integration_retrieve_response.rb +0 -114
  378. data/lib/x_twitter_scraper/models/integration_update_response.rb +0 -114
  379. data/lib/x_twitter_scraper/models/monitor_retrieve_response.rb +0 -62
  380. data/lib/x_twitter_scraper/models/monitor_update_response.rb +0 -62
  381. data/lib/x_twitter_scraper/models/style_analyze_response.rb +0 -69
  382. data/lib/x_twitter_scraper/models/style_retrieve_response.rb +0 -69
  383. data/lib/x_twitter_scraper/models/style_update_response.rb +0 -69
  384. data/lib/x_twitter_scraper/models/webhook_update_response.rb +0 -56
  385. data/lib/x_twitter_scraper/models/x/account_retrieve_response.rb +0 -60
  386. data/lib/x_twitter_scraper/models/x/bookmark_list_response.rb +0 -124
  387. data/lib/x_twitter_scraper/models/x/communities/join_create_response.rb +0 -32
  388. data/lib/x_twitter_scraper/models/x/communities/join_delete_all_response.rb +0 -32
  389. data/lib/x_twitter_scraper/models/x/tweet_get_favoriters_response.rb +0 -101
  390. data/lib/x_twitter_scraper/models/x/tweet_get_quotes_response.rb +0 -124
  391. data/lib/x_twitter_scraper/models/x/tweet_get_replies_response.rb +0 -124
  392. data/lib/x_twitter_scraper/models/x/tweet_get_retweeters_response.rb +0 -101
  393. data/lib/x_twitter_scraper/models/x/tweet_get_thread_response.rb +0 -124
  394. data/lib/x_twitter_scraper/models/x/tweet_search_response.rb +0 -124
  395. data/lib/x_twitter_scraper/models/x/user_retrieve_followers_you_know_response.rb +0 -101
  396. data/lib/x_twitter_scraper/models/x/user_retrieve_likes_response.rb +0 -124
  397. data/lib/x_twitter_scraper/models/x/user_retrieve_media_response.rb +0 -124
  398. data/lib/x_twitter_scraper/models/x/user_retrieve_response.rb +0 -78
  399. data/lib/x_twitter_scraper/models/x/user_retrieve_tweets_response.rb +0 -124
  400. data/lib/x_twitter_scraper/models/x_get_home_timeline_response.rb +0 -122
  401. data/rbi/x_twitter_scraper/models/draft_create_response.rbi +0 -67
  402. data/rbi/x_twitter_scraper/models/draft_retrieve_response.rbi +0 -67
  403. data/rbi/x_twitter_scraper/models/event_retrieve_response.rbi +0 -135
  404. data/rbi/x_twitter_scraper/models/integration_create_response.rbi +0 -215
  405. data/rbi/x_twitter_scraper/models/integration_retrieve_response.rbi +0 -215
  406. data/rbi/x_twitter_scraper/models/integration_update_response.rbi +0 -215
  407. data/rbi/x_twitter_scraper/models/monitor_retrieve_response.rbi +0 -134
  408. data/rbi/x_twitter_scraper/models/monitor_update_response.rbi +0 -134
  409. data/rbi/x_twitter_scraper/models/style_analyze_response.rbi +0 -120
  410. data/rbi/x_twitter_scraper/models/style_retrieve_response.rbi +0 -120
  411. data/rbi/x_twitter_scraper/models/style_update_response.rbi +0 -120
  412. data/rbi/x_twitter_scraper/models/webhook_update_response.rbi +0 -122
  413. data/rbi/x_twitter_scraper/models/x/account_retrieve_response.rbi +0 -91
  414. data/rbi/x_twitter_scraper/models/x/bookmark_list_response.rbi +0 -231
  415. data/rbi/x_twitter_scraper/models/x/communities/join_create_response.rbi +0 -50
  416. data/rbi/x_twitter_scraper/models/x/communities/join_delete_all_response.rbi +0 -50
  417. data/rbi/x_twitter_scraper/models/x/tweet_get_favoriters_response.rbi +0 -177
  418. data/rbi/x_twitter_scraper/models/x/tweet_get_quotes_response.rbi +0 -231
  419. data/rbi/x_twitter_scraper/models/x/tweet_get_replies_response.rbi +0 -231
  420. data/rbi/x_twitter_scraper/models/x/tweet_get_retweeters_response.rbi +0 -177
  421. data/rbi/x_twitter_scraper/models/x/tweet_get_thread_response.rbi +0 -231
  422. data/rbi/x_twitter_scraper/models/x/tweet_search_response.rbi +0 -229
  423. data/rbi/x_twitter_scraper/models/x/user_retrieve_followers_you_know_response.rbi +0 -177
  424. data/rbi/x_twitter_scraper/models/x/user_retrieve_likes_response.rbi +0 -233
  425. data/rbi/x_twitter_scraper/models/x/user_retrieve_media_response.rbi +0 -233
  426. data/rbi/x_twitter_scraper/models/x/user_retrieve_response.rbi +0 -124
  427. data/rbi/x_twitter_scraper/models/x/user_retrieve_tweets_response.rbi +0 -233
  428. data/rbi/x_twitter_scraper/models/x_get_home_timeline_response.rbi +0 -227
  429. data/sig/x_twitter_scraper/models/draft_create_response.rbs +0 -49
  430. data/sig/x_twitter_scraper/models/draft_retrieve_response.rbs +0 -49
  431. data/sig/x_twitter_scraper/models/event_retrieve_response.rbs +0 -73
  432. data/sig/x_twitter_scraper/models/integration_create_response.rbs +0 -109
  433. data/sig/x_twitter_scraper/models/integration_retrieve_response.rbs +0 -109
  434. data/sig/x_twitter_scraper/models/integration_update_response.rbs +0 -109
  435. data/sig/x_twitter_scraper/models/monitor_retrieve_response.rbs +0 -66
  436. data/sig/x_twitter_scraper/models/monitor_update_response.rbs +0 -66
  437. data/sig/x_twitter_scraper/models/style_analyze_response.rbs +0 -76
  438. data/sig/x_twitter_scraper/models/style_retrieve_response.rbs +0 -76
  439. data/sig/x_twitter_scraper/models/style_update_response.rbs +0 -76
  440. data/sig/x_twitter_scraper/models/webhook_update_response.rbs +0 -61
  441. data/sig/x_twitter_scraper/models/x/account_retrieve_response.rbs +0 -63
  442. data/sig/x_twitter_scraper/models/x/bookmark_list_response.rbs +0 -141
  443. data/sig/x_twitter_scraper/models/x/communities/join_create_response.rbs +0 -30
  444. data/sig/x_twitter_scraper/models/x/communities/join_delete_all_response.rbs +0 -30
  445. data/sig/x_twitter_scraper/models/x/tweet_get_favoriters_response.rbs +0 -115
  446. data/sig/x_twitter_scraper/models/x/tweet_get_quotes_response.rbs +0 -141
  447. data/sig/x_twitter_scraper/models/x/tweet_get_replies_response.rbs +0 -141
  448. data/sig/x_twitter_scraper/models/x/tweet_get_retweeters_response.rbs +0 -115
  449. data/sig/x_twitter_scraper/models/x/tweet_get_thread_response.rbs +0 -141
  450. data/sig/x_twitter_scraper/models/x/tweet_search_response.rbs +0 -141
  451. data/sig/x_twitter_scraper/models/x/user_retrieve_followers_you_know_response.rbs +0 -115
  452. data/sig/x_twitter_scraper/models/x/user_retrieve_likes_response.rbs +0 -141
  453. data/sig/x_twitter_scraper/models/x/user_retrieve_media_response.rbs +0 -141
  454. data/sig/x_twitter_scraper/models/x/user_retrieve_response.rbs +0 -88
  455. data/sig/x_twitter_scraper/models/x/user_retrieve_tweets_response.rbs +0 -141
  456. data/sig/x_twitter_scraper/models/x_get_home_timeline_response.rbs +0 -139
@@ -2,6 +2,7 @@
2
2
 
3
3
  module XTwitterScraper
4
4
  module Models
5
+ # @see XTwitterScraper::Resources::Events#retrieve
5
6
  class EventDetail < XTwitterScraper::Internal::Type::BaseModel
6
7
  # @!attribute id
7
8
  #
@@ -25,9 +26,10 @@ module XTwitterScraper
25
26
  required :occurred_at, Time, api_name: :occurredAt
26
27
 
27
28
  # @!attribute type
29
+ # Type of monitor event fired when account activity occurs.
28
30
  #
29
- # @return [Symbol, XTwitterScraper::Models::EventDetail::Type]
30
- required :type, enum: -> { XTwitterScraper::EventDetail::Type }
31
+ # @return [Symbol, XTwitterScraper::Models::EventType]
32
+ required :type, enum: -> { XTwitterScraper::EventType }
31
33
 
32
34
  # @!attribute username
33
35
  #
@@ -40,6 +42,8 @@ module XTwitterScraper
40
42
  optional :x_event_id, String, api_name: :xEventId
41
43
 
42
44
  # @!method initialize(id:, data:, monitor_id:, occurred_at:, type:, username:, x_event_id: nil)
45
+ # Full monitor event including payload data and optional X event ID.
46
+ #
43
47
  # @param id [String]
44
48
  #
45
49
  # @param data [Hash{Symbol=>Object}] Event payload — shape varies by event type (JSON)
@@ -48,26 +52,11 @@ module XTwitterScraper
48
52
  #
49
53
  # @param occurred_at [Time]
50
54
  #
51
- # @param type [Symbol, XTwitterScraper::Models::EventDetail::Type]
55
+ # @param type [Symbol, XTwitterScraper::Models::EventType] Type of monitor event fired when account activity occurs.
52
56
  #
53
57
  # @param username [String]
54
58
  #
55
59
  # @param x_event_id [String]
56
-
57
- # @see XTwitterScraper::Models::EventDetail#type
58
- module Type
59
- extend XTwitterScraper::Internal::Type::Enum
60
-
61
- TWEET_NEW = :"tweet.new"
62
- TWEET_REPLY = :"tweet.reply"
63
- TWEET_RETWEET = :"tweet.retweet"
64
- TWEET_QUOTE = :"tweet.quote"
65
- FOLLOWER_GAINED = :"follower.gained"
66
- FOLLOWER_LOST = :"follower.lost"
67
-
68
- # @!method self.values
69
- # @return [Array<Symbol>]
70
- end
71
60
  end
72
61
  end
73
62
  end
@@ -8,50 +8,39 @@ module XTwitterScraper
8
8
  include XTwitterScraper::Internal::Type::RequestParameters
9
9
 
10
10
  # @!attribute after
11
- # Cursor for pagination
11
+ # Cursor for keyset pagination
12
12
  #
13
13
  # @return [String, nil]
14
14
  optional :after, String
15
15
 
16
16
  # @!attribute event_type
17
+ # Filter events by type
17
18
  #
18
- # @return [Symbol, XTwitterScraper::Models::EventListParams::EventType, nil]
19
- optional :event_type, enum: -> { XTwitterScraper::EventListParams::EventType }
19
+ # @return [Symbol, XTwitterScraper::Models::EventType, nil]
20
+ optional :event_type, enum: -> { XTwitterScraper::EventType }
20
21
 
21
22
  # @!attribute limit
23
+ # Maximum number of items to return (1-100, default 50)
22
24
  #
23
25
  # @return [Integer, nil]
24
26
  optional :limit, Integer
25
27
 
26
28
  # @!attribute monitor_id
29
+ # Filter events by monitor ID
27
30
  #
28
31
  # @return [String, nil]
29
32
  optional :monitor_id, String
30
33
 
31
34
  # @!method initialize(after: nil, event_type: nil, limit: nil, monitor_id: nil, request_options: {})
32
- # @param after [String] Cursor for pagination
35
+ # @param after [String] Cursor for keyset pagination
33
36
  #
34
- # @param event_type [Symbol, XTwitterScraper::Models::EventListParams::EventType]
37
+ # @param event_type [Symbol, XTwitterScraper::Models::EventType] Filter events by type
35
38
  #
36
- # @param limit [Integer]
39
+ # @param limit [Integer] Maximum number of items to return (1-100, default 50)
37
40
  #
38
- # @param monitor_id [String]
41
+ # @param monitor_id [String] Filter events by monitor ID
39
42
  #
40
43
  # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
41
-
42
- module EventType
43
- extend XTwitterScraper::Internal::Type::Enum
44
-
45
- TWEET_NEW = :"tweet.new"
46
- TWEET_REPLY = :"tweet.reply"
47
- TWEET_RETWEET = :"tweet.retweet"
48
- TWEET_QUOTE = :"tweet.quote"
49
- FOLLOWER_GAINED = :"follower.gained"
50
- FOLLOWER_LOST = :"follower.lost"
51
-
52
- # @!method self.values
53
- # @return [Array<Symbol>]
54
- end
55
44
  end
56
45
  end
57
46
  end
@@ -6,9 +6,8 @@ module XTwitterScraper
6
6
  class EventListResponse < XTwitterScraper::Internal::Type::BaseModel
7
7
  # @!attribute events
8
8
  #
9
- # @return [Array<XTwitterScraper::Models::EventListResponse::Event>]
10
- required :events,
11
- -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::EventListResponse::Event] }
9
+ # @return [Array<XTwitterScraper::Models::Event>]
10
+ required :events, -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Event] }
12
11
 
13
12
  # @!attribute has_more
14
13
  #
@@ -21,64 +20,9 @@ module XTwitterScraper
21
20
  optional :next_cursor, String, api_name: :nextCursor
22
21
 
23
22
  # @!method initialize(events:, has_more:, next_cursor: nil)
24
- # @param events [Array<XTwitterScraper::Models::EventListResponse::Event>]
23
+ # @param events [Array<XTwitterScraper::Models::Event>]
25
24
  # @param has_more [Boolean]
26
25
  # @param next_cursor [String]
27
-
28
- class Event < XTwitterScraper::Internal::Type::BaseModel
29
- # @!attribute id
30
- #
31
- # @return [String]
32
- required :id, String
33
-
34
- # @!attribute data
35
- #
36
- # @return [Hash{Symbol=>Object}]
37
- required :data, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]
38
-
39
- # @!attribute monitor_id
40
- #
41
- # @return [String]
42
- required :monitor_id, String, api_name: :monitorId
43
-
44
- # @!attribute occurred_at
45
- #
46
- # @return [Time]
47
- required :occurred_at, Time, api_name: :occurredAt
48
-
49
- # @!attribute type
50
- #
51
- # @return [Symbol, XTwitterScraper::Models::EventListResponse::Event::Type]
52
- required :type, enum: -> { XTwitterScraper::Models::EventListResponse::Event::Type }
53
-
54
- # @!attribute username
55
- #
56
- # @return [String]
57
- required :username, String
58
-
59
- # @!method initialize(id:, data:, monitor_id:, occurred_at:, type:, username:)
60
- # @param id [String]
61
- # @param data [Hash{Symbol=>Object}]
62
- # @param monitor_id [String]
63
- # @param occurred_at [Time]
64
- # @param type [Symbol, XTwitterScraper::Models::EventListResponse::Event::Type]
65
- # @param username [String]
66
-
67
- # @see XTwitterScraper::Models::EventListResponse::Event#type
68
- module Type
69
- extend XTwitterScraper::Internal::Type::Enum
70
-
71
- TWEET_NEW = :"tweet.new"
72
- TWEET_REPLY = :"tweet.reply"
73
- TWEET_RETWEET = :"tweet.retweet"
74
- TWEET_QUOTE = :"tweet.quote"
75
- FOLLOWER_GAINED = :"follower.gained"
76
- FOLLOWER_LOST = :"follower.lost"
77
-
78
- # @!method self.values
79
- # @return [Array<Symbol>]
80
- end
81
- end
82
26
  end
83
27
  end
84
28
  end
@@ -2,6 +2,7 @@
2
2
 
3
3
  module XTwitterScraper
4
4
  module Models
5
+ # Type of monitor event fired when account activity occurs.
5
6
  module EventType
6
7
  extend XTwitterScraper::Internal::Type::Enum
7
8
 
@@ -8,6 +8,7 @@ module XTwitterScraper
8
8
  include XTwitterScraper::Internal::Type::RequestParameters
9
9
 
10
10
  # @!attribute tool_type
11
+ # Identifier for the extraction tool used to run a job.
11
12
  #
12
13
  # @return [Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::ToolType]
13
14
  required :tool_type,
@@ -15,19 +16,19 @@ module XTwitterScraper
15
16
  api_name: :toolType
16
17
 
17
18
  # @!attribute advanced_query
18
- # Raw advanced search query appended as-is (tweet_search_extractor)
19
+ # Raw advanced query string appended to the estimate (tweet_search_extractor)
19
20
  #
20
21
  # @return [String, nil]
21
22
  optional :advanced_query, String, api_name: :advancedQuery
22
23
 
23
24
  # @!attribute exact_phrase
24
- # Exact phrase to match (tweet_search_extractor)
25
+ # Exact phrase filter for search estimation
25
26
  #
26
27
  # @return [String, nil]
27
28
  optional :exact_phrase, String, api_name: :exactPhrase
28
29
 
29
30
  # @!attribute exclude_words
30
- # Words to exclude from results (tweet_search_extractor)
31
+ # Words excluded from estimated search results
31
32
  #
32
33
  # @return [String, nil]
33
34
  optional :exclude_words, String, api_name: :excludeWords
@@ -63,13 +64,13 @@ module XTwitterScraper
63
64
  optional :target_username, String, api_name: :targetUsername
64
65
 
65
66
  # @!method initialize(tool_type:, advanced_query: nil, exact_phrase: nil, exclude_words: nil, search_query: nil, target_community_id: nil, target_list_id: nil, target_space_id: nil, target_tweet_id: nil, target_username: nil, request_options: {})
66
- # @param tool_type [Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::ToolType]
67
+ # @param tool_type [Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::ToolType] Identifier for the extraction tool used to run a job.
67
68
  #
68
- # @param advanced_query [String] Raw advanced search query appended as-is (tweet_search_extractor)
69
+ # @param advanced_query [String] Raw advanced query string appended to the estimate (tweet_search_extractor)
69
70
  #
70
- # @param exact_phrase [String] Exact phrase to match (tweet_search_extractor)
71
+ # @param exact_phrase [String] Exact phrase filter for search estimation
71
72
  #
72
- # @param exclude_words [String] Words to exclude from results (tweet_search_extractor)
73
+ # @param exclude_words [String] Words excluded from estimated search results
73
74
  #
74
75
  # @param search_query [String]
75
76
  #
@@ -85,6 +86,7 @@ module XTwitterScraper
85
86
  #
86
87
  # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
87
88
 
89
+ # Identifier for the extraction tool used to run a job.
88
90
  module ToolType
89
91
  extend XTwitterScraper::Internal::Type::Enum
90
92
 
@@ -13,15 +13,19 @@ module XTwitterScraper
13
13
  required :id, String
14
14
 
15
15
  # @!attribute format_
16
+ # Export file format
16
17
  #
17
18
  # @return [Symbol, XTwitterScraper::Models::ExtractionExportResultsParams::Format, nil]
18
19
  optional :format_, enum: -> { XTwitterScraper::ExtractionExportResultsParams::Format }
19
20
 
20
21
  # @!method initialize(id:, format_: nil, request_options: {})
21
22
  # @param id [String]
22
- # @param format_ [Symbol, XTwitterScraper::Models::ExtractionExportResultsParams::Format]
23
+ #
24
+ # @param format_ [Symbol, XTwitterScraper::Models::ExtractionExportResultsParams::Format] Export file format
25
+ #
23
26
  # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
24
27
 
28
+ # Export file format
25
29
  module Format
26
30
  extend XTwitterScraper::Internal::Type::Enum
27
31
 
@@ -19,6 +19,7 @@ module XTwitterScraper
19
19
  required :status, enum: -> { XTwitterScraper::ExtractionJob::Status }
20
20
 
21
21
  # @!attribute tool_type
22
+ # Identifier for the extraction tool used to run a job.
22
23
  #
23
24
  # @return [Symbol, XTwitterScraper::Models::ExtractionJob::ToolType]
24
25
  required :tool_type, enum: -> { XTwitterScraper::ExtractionJob::ToolType }, api_name: :toolType
@@ -34,11 +35,18 @@ module XTwitterScraper
34
35
  optional :completed_at, Time, api_name: :completedAt
35
36
 
36
37
  # @!method initialize(id:, created_at:, status:, tool_type:, total_results:, completed_at: nil)
38
+ # Extraction job tracking status, tool type, and result count.
39
+ #
37
40
  # @param id [String]
41
+ #
38
42
  # @param created_at [Time]
43
+ #
39
44
  # @param status [Symbol, XTwitterScraper::Models::ExtractionJob::Status]
40
- # @param tool_type [Symbol, XTwitterScraper::Models::ExtractionJob::ToolType]
45
+ #
46
+ # @param tool_type [Symbol, XTwitterScraper::Models::ExtractionJob::ToolType] Identifier for the extraction tool used to run a job.
47
+ #
41
48
  # @param total_results [Integer]
49
+ #
42
50
  # @param completed_at [Time]
43
51
 
44
52
  # @see XTwitterScraper::Models::ExtractionJob#status
@@ -53,6 +61,8 @@ module XTwitterScraper
53
61
  # @return [Array<Symbol>]
54
62
  end
55
63
 
64
+ # Identifier for the extraction tool used to run a job.
65
+ #
56
66
  # @see XTwitterScraper::Models::ExtractionJob#tool_type
57
67
  module ToolType
58
68
  extend XTwitterScraper::Internal::Type::Enum
@@ -8,37 +8,41 @@ module XTwitterScraper
8
8
  include XTwitterScraper::Internal::Type::RequestParameters
9
9
 
10
10
  # @!attribute after
11
- # Cursor for pagination
11
+ # Cursor for keyset pagination
12
12
  #
13
13
  # @return [String, nil]
14
14
  optional :after, String
15
15
 
16
16
  # @!attribute limit
17
+ # Maximum number of items to return (1-100, default 50)
17
18
  #
18
19
  # @return [Integer, nil]
19
20
  optional :limit, Integer
20
21
 
21
22
  # @!attribute status
23
+ # Filter by job status
22
24
  #
23
25
  # @return [Symbol, XTwitterScraper::Models::ExtractionListParams::Status, nil]
24
26
  optional :status, enum: -> { XTwitterScraper::ExtractionListParams::Status }
25
27
 
26
28
  # @!attribute tool_type
29
+ # Filter by extraction tool type
27
30
  #
28
31
  # @return [Symbol, XTwitterScraper::Models::ExtractionListParams::ToolType, nil]
29
32
  optional :tool_type, enum: -> { XTwitterScraper::ExtractionListParams::ToolType }
30
33
 
31
34
  # @!method initialize(after: nil, limit: nil, status: nil, tool_type: nil, request_options: {})
32
- # @param after [String] Cursor for pagination
35
+ # @param after [String] Cursor for keyset pagination
33
36
  #
34
- # @param limit [Integer]
37
+ # @param limit [Integer] Maximum number of items to return (1-100, default 50)
35
38
  #
36
- # @param status [Symbol, XTwitterScraper::Models::ExtractionListParams::Status]
39
+ # @param status [Symbol, XTwitterScraper::Models::ExtractionListParams::Status] Filter by job status
37
40
  #
38
- # @param tool_type [Symbol, XTwitterScraper::Models::ExtractionListParams::ToolType]
41
+ # @param tool_type [Symbol, XTwitterScraper::Models::ExtractionListParams::ToolType] Filter by extraction tool type
39
42
  #
40
43
  # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
41
44
 
45
+ # Filter by job status
42
46
  module Status
43
47
  extend XTwitterScraper::Internal::Type::Enum
44
48
 
@@ -50,6 +54,7 @@ module XTwitterScraper
50
54
  # @return [Array<Symbol>]
51
55
  end
52
56
 
57
+ # Filter by extraction tool type
53
58
  module ToolType
54
59
  extend XTwitterScraper::Internal::Type::Enum
55
60
 
@@ -6,9 +6,8 @@ module XTwitterScraper
6
6
  class ExtractionListResponse < XTwitterScraper::Internal::Type::BaseModel
7
7
  # @!attribute extractions
8
8
  #
9
- # @return [Array<XTwitterScraper::Models::ExtractionListResponse::Extraction>]
10
- required :extractions,
11
- -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::ExtractionListResponse::Extraction] }
9
+ # @return [Array<XTwitterScraper::Models::ExtractionJob>]
10
+ required :extractions, -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::ExtractionJob] }
12
11
 
13
12
  # @!attribute has_more
14
13
  #
@@ -21,92 +20,9 @@ module XTwitterScraper
21
20
  optional :next_cursor, String, api_name: :nextCursor
22
21
 
23
22
  # @!method initialize(extractions:, has_more:, next_cursor: nil)
24
- # @param extractions [Array<XTwitterScraper::Models::ExtractionListResponse::Extraction>]
23
+ # @param extractions [Array<XTwitterScraper::Models::ExtractionJob>]
25
24
  # @param has_more [Boolean]
26
25
  # @param next_cursor [String]
27
-
28
- class Extraction < XTwitterScraper::Internal::Type::BaseModel
29
- # @!attribute id
30
- #
31
- # @return [String]
32
- required :id, String
33
-
34
- # @!attribute created_at
35
- #
36
- # @return [Time]
37
- required :created_at, Time, api_name: :createdAt
38
-
39
- # @!attribute status
40
- #
41
- # @return [Symbol, XTwitterScraper::Models::ExtractionListResponse::Extraction::Status]
42
- required :status, enum: -> { XTwitterScraper::Models::ExtractionListResponse::Extraction::Status }
43
-
44
- # @!attribute tool_type
45
- #
46
- # @return [Symbol, XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType]
47
- required :tool_type,
48
- enum: -> { XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType },
49
- api_name: :toolType
50
-
51
- # @!attribute total_results
52
- #
53
- # @return [Integer]
54
- required :total_results, Integer, api_name: :totalResults
55
-
56
- # @!attribute completed_at
57
- #
58
- # @return [Time, nil]
59
- optional :completed_at, Time, api_name: :completedAt
60
-
61
- # @!method initialize(id:, created_at:, status:, tool_type:, total_results:, completed_at: nil)
62
- # @param id [String]
63
- # @param created_at [Time]
64
- # @param status [Symbol, XTwitterScraper::Models::ExtractionListResponse::Extraction::Status]
65
- # @param tool_type [Symbol, XTwitterScraper::Models::ExtractionListResponse::Extraction::ToolType]
66
- # @param total_results [Integer]
67
- # @param completed_at [Time]
68
-
69
- # @see XTwitterScraper::Models::ExtractionListResponse::Extraction#status
70
- module Status
71
- extend XTwitterScraper::Internal::Type::Enum
72
-
73
- RUNNING = :running
74
- COMPLETED = :completed
75
- FAILED = :failed
76
-
77
- # @!method self.values
78
- # @return [Array<Symbol>]
79
- end
80
-
81
- # @see XTwitterScraper::Models::ExtractionListResponse::Extraction#tool_type
82
- module ToolType
83
- extend XTwitterScraper::Internal::Type::Enum
84
-
85
- ARTICLE_EXTRACTOR = :article_extractor
86
- COMMUNITY_EXTRACTOR = :community_extractor
87
- COMMUNITY_MODERATOR_EXPLORER = :community_moderator_explorer
88
- COMMUNITY_POST_EXTRACTOR = :community_post_extractor
89
- COMMUNITY_SEARCH = :community_search
90
- FOLLOWER_EXPLORER = :follower_explorer
91
- FOLLOWING_EXPLORER = :following_explorer
92
- LIST_FOLLOWER_EXPLORER = :list_follower_explorer
93
- LIST_MEMBER_EXTRACTOR = :list_member_extractor
94
- LIST_POST_EXTRACTOR = :list_post_extractor
95
- MENTION_EXTRACTOR = :mention_extractor
96
- PEOPLE_SEARCH = :people_search
97
- POST_EXTRACTOR = :post_extractor
98
- QUOTE_EXTRACTOR = :quote_extractor
99
- REPLY_EXTRACTOR = :reply_extractor
100
- REPOST_EXTRACTOR = :repost_extractor
101
- SPACE_EXPLORER = :space_explorer
102
- THREAD_EXTRACTOR = :thread_extractor
103
- TWEET_SEARCH_EXTRACTOR = :tweet_search_extractor
104
- VERIFIED_FOLLOWER_EXPLORER = :verified_follower_explorer
105
-
106
- # @!method self.values
107
- # @return [Array<Symbol>]
108
- end
109
- end
110
26
  end
111
27
  end
112
28
  end
@@ -13,12 +13,13 @@ module XTwitterScraper
13
13
  required :id, String
14
14
 
15
15
  # @!attribute after
16
- # Cursor for pagination
16
+ # Cursor for keyset pagination
17
17
  #
18
18
  # @return [String, nil]
19
19
  optional :after, String
20
20
 
21
21
  # @!attribute limit
22
+ # Maximum number of results to return (1-1000, default 100)
22
23
  #
23
24
  # @return [Integer, nil]
24
25
  optional :limit, Integer
@@ -26,9 +27,9 @@ module XTwitterScraper
26
27
  # @!method initialize(id:, after: nil, limit: nil, request_options: {})
27
28
  # @param id [String]
28
29
  #
29
- # @param after [String] Cursor for pagination
30
+ # @param after [String] Cursor for keyset pagination
30
31
  #
31
- # @param limit [Integer]
32
+ # @param limit [Integer] Maximum number of results to return (1-1000, default 100)
32
33
  #
33
34
  # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
34
35
  end
@@ -8,6 +8,7 @@ module XTwitterScraper
8
8
  include XTwitterScraper::Internal::Type::RequestParameters
9
9
 
10
10
  # @!attribute tool_type
11
+ # Identifier for the extraction tool used to run a job.
11
12
  #
12
13
  # @return [Symbol, XTwitterScraper::Models::ExtractionRunParams::ToolType]
13
14
  required :tool_type, enum: -> { XTwitterScraper::ExtractionRunParams::ToolType }, api_name: :toolType
@@ -61,7 +62,7 @@ module XTwitterScraper
61
62
  optional :target_username, String, api_name: :targetUsername
62
63
 
63
64
  # @!method initialize(tool_type:, advanced_query: nil, exact_phrase: nil, exclude_words: nil, search_query: nil, target_community_id: nil, target_list_id: nil, target_space_id: nil, target_tweet_id: nil, target_username: nil, request_options: {})
64
- # @param tool_type [Symbol, XTwitterScraper::Models::ExtractionRunParams::ToolType]
65
+ # @param tool_type [Symbol, XTwitterScraper::Models::ExtractionRunParams::ToolType] Identifier for the extraction tool used to run a job.
65
66
  #
66
67
  # @param advanced_query [String] Raw advanced search query appended as-is (tweet_search_extractor)
67
68
  #
@@ -83,6 +84,7 @@ module XTwitterScraper
83
84
  #
84
85
  # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
85
86
 
87
+ # Identifier for the extraction tool used to run a job.
86
88
  module ToolType
87
89
  extend XTwitterScraper::Internal::Type::Enum
88
90
 
@@ -11,31 +11,26 @@ module XTwitterScraper
11
11
 
12
12
  # @!attribute status
13
13
  #
14
- # @return [Symbol, XTwitterScraper::Models::ExtractionRunResponse::Status]
15
- required :status, enum: -> { XTwitterScraper::Models::ExtractionRunResponse::Status }
14
+ # @return [Symbol, :running]
15
+ required :status, const: :running
16
16
 
17
17
  # @!attribute tool_type
18
+ # Identifier for the extraction tool used to run a job.
18
19
  #
19
20
  # @return [Symbol, XTwitterScraper::Models::ExtractionRunResponse::ToolType]
20
21
  required :tool_type,
21
22
  enum: -> { XTwitterScraper::Models::ExtractionRunResponse::ToolType },
22
23
  api_name: :toolType
23
24
 
24
- # @!method initialize(id:, status:, tool_type:)
25
+ # @!method initialize(id:, tool_type:, status: :running)
25
26
  # @param id [String]
26
- # @param status [Symbol, XTwitterScraper::Models::ExtractionRunResponse::Status]
27
- # @param tool_type [Symbol, XTwitterScraper::Models::ExtractionRunResponse::ToolType]
28
-
29
- # @see XTwitterScraper::Models::ExtractionRunResponse#status
30
- module Status
31
- extend XTwitterScraper::Internal::Type::Enum
32
-
33
- RUNNING = :running
34
-
35
- # @!method self.values
36
- # @return [Array<Symbol>]
37
- end
27
+ #
28
+ # @param tool_type [Symbol, XTwitterScraper::Models::ExtractionRunResponse::ToolType] Identifier for the extraction tool used to run a job.
29
+ #
30
+ # @param status [Symbol, :running]
38
31
 
32
+ # Identifier for the extraction tool used to run a job.
33
+ #
39
34
  # @see XTwitterScraper::Models::ExtractionRunResponse#tool_type
40
35
  module ToolType
41
36
  extend XTwitterScraper::Internal::Type::Enum
@@ -2,6 +2,7 @@
2
2
 
3
3
  module XTwitterScraper
4
4
  module Models
5
+ # @see XTwitterScraper::Resources::Integrations#create
5
6
  class Integration < XTwitterScraper::Internal::Type::BaseModel
6
7
  # @!attribute id
7
8
  #
@@ -20,10 +21,11 @@ module XTwitterScraper
20
21
  required :created_at, Time, api_name: :createdAt
21
22
 
22
23
  # @!attribute event_types
24
+ # Array of event types to subscribe to.
23
25
  #
24
- # @return [Array<Symbol, XTwitterScraper::Models::Integration::EventType>]
26
+ # @return [Array<Symbol, XTwitterScraper::Models::EventType>]
25
27
  required :event_types,
26
- -> { XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::Integration::EventType] },
28
+ -> { XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::EventType] },
27
29
  api_name: :eventTypes
28
30
 
29
31
  # @!attribute is_active
@@ -38,8 +40,8 @@ module XTwitterScraper
38
40
 
39
41
  # @!attribute type
40
42
  #
41
- # @return [Symbol, XTwitterScraper::Models::Integration::Type]
42
- required :type, enum: -> { XTwitterScraper::Integration::Type }
43
+ # @return [Symbol, :telegram]
44
+ required :type, const: :telegram
43
45
 
44
46
  # @!attribute filters
45
47
  # Event filter rules (JSON)
@@ -62,21 +64,21 @@ module XTwitterScraper
62
64
  # @return [Boolean, nil]
63
65
  optional :silent_push, XTwitterScraper::Internal::Type::Boolean, api_name: :silentPush
64
66
 
65
- # @!method initialize(id:, config:, created_at:, event_types:, is_active:, name:, type:, filters: nil, message_template: nil, scope_all_monitors: nil, silent_push: nil)
67
+ # @!method initialize(id:, config:, created_at:, event_types:, is_active:, name:, filters: nil, message_template: nil, scope_all_monitors: nil, silent_push: nil, type: :telegram)
68
+ # Third-party integration (e.g. Telegram) subscribed to monitor events.
69
+ #
66
70
  # @param id [String]
67
71
  #
68
72
  # @param config [Hash{Symbol=>Object}] Integration config — shape varies by type (JSON)
69
73
  #
70
74
  # @param created_at [Time]
71
75
  #
72
- # @param event_types [Array<Symbol, XTwitterScraper::Models::Integration::EventType>]
76
+ # @param event_types [Array<Symbol, XTwitterScraper::Models::EventType>] Array of event types to subscribe to.
73
77
  #
74
78
  # @param is_active [Boolean]
75
79
  #
76
80
  # @param name [String]
77
81
  #
78
- # @param type [Symbol, XTwitterScraper::Models::Integration::Type]
79
- #
80
82
  # @param filters [Hash{Symbol=>Object}] Event filter rules (JSON)
81
83
  #
82
84
  # @param message_template [String]
@@ -84,30 +86,8 @@ module XTwitterScraper
84
86
  # @param scope_all_monitors [Boolean]
85
87
  #
86
88
  # @param silent_push [Boolean]
87
-
88
- module EventType
89
- extend XTwitterScraper::Internal::Type::Enum
90
-
91
- TWEET_NEW = :"tweet.new"
92
- TWEET_REPLY = :"tweet.reply"
93
- TWEET_RETWEET = :"tweet.retweet"
94
- TWEET_QUOTE = :"tweet.quote"
95
- FOLLOWER_GAINED = :"follower.gained"
96
- FOLLOWER_LOST = :"follower.lost"
97
-
98
- # @!method self.values
99
- # @return [Array<Symbol>]
100
- end
101
-
102
- # @see XTwitterScraper::Models::Integration#type
103
- module Type
104
- extend XTwitterScraper::Internal::Type::Enum
105
-
106
- TELEGRAM = :telegram
107
-
108
- # @!method self.values
109
- # @return [Array<Symbol>]
110
- end
89
+ #
90
+ # @param type [Symbol, :telegram]
111
91
  end
112
92
  end
113
93
  end