x-twitter-scraper 0.11.0 → 0.12.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 (729) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +31 -0
  3. data/README.md +1 -1
  4. data/lib/x_twitter_scraper/client.rb +4 -0
  5. data/lib/x_twitter_scraper/internal/stream.rb +34 -0
  6. data/lib/x_twitter_scraper/internal/type/base_model.rb +2 -0
  7. data/lib/x_twitter_scraper/internal/type/converter.rb +2 -0
  8. data/lib/x_twitter_scraper/internal/type/union.rb +6 -2
  9. data/lib/x_twitter_scraper/models/activity_export_params.rb +113 -0
  10. data/lib/x_twitter_scraper/models/activity_list_params.rb +107 -0
  11. data/lib/x_twitter_scraper/models/activity_list_response.rb +13 -0
  12. data/lib/x_twitter_scraper/models/activity_log_row.rb +123 -0
  13. data/lib/x_twitter_scraper/models/activity_record.rb +489 -0
  14. data/lib/x_twitter_scraper/models/activity_retrieve_params.rb +27 -0
  15. data/lib/x_twitter_scraper/models/audited_follower.rb +114 -0
  16. data/lib/x_twitter_scraper/models/batch_user_tweets.rb +84 -0
  17. data/lib/x_twitter_scraper/models/broadcast.rb +261 -0
  18. data/lib/x_twitter_scraper/models/community.rb +957 -0
  19. data/lib/x_twitter_scraper/models/community_analytics.rb +89 -0
  20. data/lib/x_twitter_scraper/models/community_analytics_metric.rb +30 -0
  21. data/lib/x_twitter_scraper/models/community_banner.rb +126 -0
  22. data/lib/x_twitter_scraper/models/community_member_preview.rb +38 -0
  23. data/lib/x_twitter_scraper/models/community_note.rb +257 -0
  24. data/lib/x_twitter_scraper/models/community_note_entity.rb +83 -0
  25. data/lib/x_twitter_scraper/models/community_notes_contributor.rb +64 -0
  26. data/lib/x_twitter_scraper/models/community_notes_note_counts.rb +46 -0
  27. data/lib/x_twitter_scraper/models/community_notes_rating_counts.rb +54 -0
  28. data/lib/x_twitter_scraper/models/community_notes_rating_outcome.rb +38 -0
  29. data/lib/x_twitter_scraper/models/community_page.rb +38 -0
  30. data/lib/x_twitter_scraper/models/community_topic.rb +57 -0
  31. data/lib/x_twitter_scraper/models/event_stream_params.rb +55 -0
  32. data/lib/x_twitter_scraper/models/extraction_cancel_params.rb +27 -0
  33. data/lib/x_twitter_scraper/models/extraction_cancel_response.rb +27 -0
  34. data/lib/x_twitter_scraper/models/follower_audit.rb +300 -0
  35. data/lib/x_twitter_scraper/models/follower_class.rb +23 -0
  36. data/lib/x_twitter_scraper/models/follower_value_count.rb +35 -0
  37. data/lib/x_twitter_scraper/models/football_box_score.rb +73 -0
  38. data/lib/x_twitter_scraper/models/football_drive.rb +122 -0
  39. data/lib/x_twitter_scraper/models/football_fumble_stats.rb +38 -0
  40. data/lib/x_twitter_scraper/models/football_odds.rb +38 -0
  41. data/lib/x_twitter_scraper/models/football_passing_stats.rb +94 -0
  42. data/lib/x_twitter_scraper/models/football_period.rb +54 -0
  43. data/lib/x_twitter_scraper/models/football_play.rb +279 -0
  44. data/lib/x_twitter_scraper/models/football_play_detail.rb +134 -0
  45. data/lib/x_twitter_scraper/models/football_player.rb +196 -0
  46. data/lib/x_twitter_scraper/models/football_player_prop.rb +66 -0
  47. data/lib/x_twitter_scraper/models/football_player_stats.rb +372 -0
  48. data/lib/x_twitter_scraper/models/football_plays.rb +81 -0
  49. data/lib/x_twitter_scraper/models/football_prop_category.rb +46 -0
  50. data/lib/x_twitter_scraper/models/football_props.rb +66 -0
  51. data/lib/x_twitter_scraper/models/football_quarter.rb +46 -0
  52. data/lib/x_twitter_scraper/models/football_return_stats.rb +54 -0
  53. data/lib/x_twitter_scraper/models/football_roster.rb +65 -0
  54. data/lib/x_twitter_scraper/models/football_roster_team.rb +30 -0
  55. data/lib/x_twitter_scraper/models/football_rushing_stats.rb +54 -0
  56. data/lib/x_twitter_scraper/models/football_schedule.rb +49 -0
  57. data/lib/x_twitter_scraper/models/football_schedule_game.rb +131 -0
  58. data/lib/x_twitter_scraper/models/football_schedule_period.rb +22 -0
  59. data/lib/x_twitter_scraper/models/football_scoreboard.rb +209 -0
  60. data/lib/x_twitter_scraper/models/football_side.rb +38 -0
  61. data/lib/x_twitter_scraper/models/football_team_box.rb +38 -0
  62. data/lib/x_twitter_scraper/models/football_team_score.rb +30 -0
  63. data/lib/x_twitter_scraper/models/football_team_totals.rb +128 -0
  64. data/lib/x_twitter_scraper/models/hashflag.rb +89 -0
  65. data/lib/x_twitter_scraper/models/job.rb +194 -0
  66. data/lib/x_twitter_scraper/models/job_account.rb +87 -0
  67. data/lib/x_twitter_scraper/models/job_company.rb +38 -0
  68. data/lib/x_twitter_scraper/models/job_location.rb +30 -0
  69. data/lib/x_twitter_scraper/models/job_locations.rb +30 -0
  70. data/lib/x_twitter_scraper/models/monitor_upsert_by_username_params.rb +44 -0
  71. data/lib/x_twitter_scraper/models/monitor_upsert_by_username_response.rb +116 -0
  72. data/lib/x_twitter_scraper/models/monitors/post_create_params.rb +55 -0
  73. data/lib/x_twitter_scraper/models/monitors/post_delete_params.rb +28 -0
  74. data/lib/x_twitter_scraper/models/monitors/post_delete_response.rb +37 -0
  75. data/lib/x_twitter_scraper/models/monitors/post_list_params.rb +38 -0
  76. data/lib/x_twitter_scraper/models/monitors/post_list_response.rb +44 -0
  77. data/lib/x_twitter_scraper/models/monitors/post_retrieve_metrics_params.rb +36 -0
  78. data/lib/x_twitter_scraper/models/monitors/post_retrieve_params.rb +28 -0
  79. data/lib/x_twitter_scraper/models/monitors/post_update_params.rb +52 -0
  80. data/lib/x_twitter_scraper/models/news_version.rb +46 -0
  81. data/lib/x_twitter_scraper/models/paginated_community_notes.rb +37 -0
  82. data/lib/x_twitter_scraper/models/paginated_jobs.rb +37 -0
  83. data/lib/x_twitter_scraper/models/paginated_lists.rb +37 -0
  84. data/lib/x_twitter_scraper/models/paginated_user_ids.rb +38 -0
  85. data/lib/x_twitter_scraper/models/place.rb +116 -0
  86. data/lib/x_twitter_scraper/models/place_search_result.rb +124 -0
  87. data/lib/x_twitter_scraper/models/post_engagement_metrics.rb +62 -0
  88. data/lib/x_twitter_scraper/models/post_event_type.rb +31 -0
  89. data/lib/x_twitter_scraper/models/post_metric_point.rb +29 -0
  90. data/lib/x_twitter_scraper/models/post_metric_reading.rb +29 -0
  91. data/lib/x_twitter_scraper/models/post_metrics.rb +68 -0
  92. data/lib/x_twitter_scraper/models/post_monitor.rb +322 -0
  93. data/lib/x_twitter_scraper/models/post_monitor_metrics.rb +103 -0
  94. data/lib/x_twitter_scraper/models/profile_translation.rb +64 -0
  95. data/lib/x_twitter_scraper/models/resolved_link.rb +31 -0
  96. data/lib/x_twitter_scraper/models/search_suggestion_cashtag.rb +102 -0
  97. data/lib/x_twitter_scraper/models/search_suggestion_hashtag.rb +46 -0
  98. data/lib/x_twitter_scraper/models/search_suggestion_topic.rb +46 -0
  99. data/lib/x_twitter_scraper/models/search_suggestion_user.rb +174 -0
  100. data/lib/x_twitter_scraper/models/search_suggestions.rb +63 -0
  101. data/lib/x_twitter_scraper/models/shadowban_report.rb +833 -0
  102. data/lib/x_twitter_scraper/models/shadowban_verdict.rb +22 -0
  103. data/lib/x_twitter_scraper/models/space.rb +254 -0
  104. data/lib/x_twitter_scraper/models/space_participant.rb +116 -0
  105. data/lib/x_twitter_scraper/models/space_sharing.rb +54 -0
  106. data/lib/x_twitter_scraper/models/sports_game_audience.rb +195 -0
  107. data/lib/x_twitter_scraper/models/sports_game_posts.rb +152 -0
  108. data/lib/x_twitter_scraper/models/sports_team.rb +192 -0
  109. data/lib/x_twitter_scraper/models/sports_team_game.rb +78 -0
  110. data/lib/x_twitter_scraper/models/subtitle_track.rb +106 -0
  111. data/lib/x_twitter_scraper/models/trend_location.rb +77 -0
  112. data/lib/x_twitter_scraper/models/tweet_embed.rb +71 -0
  113. data/lib/x_twitter_scraper/models/tweet_entities.rb +56 -0
  114. data/lib/x_twitter_scraper/models/tweet_hashtag.rb +36 -0
  115. data/lib/x_twitter_scraper/models/tweet_insights.rb +111 -0
  116. data/lib/x_twitter_scraper/models/tweet_smart_tag.rb +64 -0
  117. data/lib/x_twitter_scraper/models/tweet_subtitles.rb +30 -0
  118. data/lib/x_twitter_scraper/models/tweet_symbol.rb +43 -0
  119. data/lib/x_twitter_scraper/models/tweet_translation.rb +56 -0
  120. data/lib/x_twitter_scraper/models/tweet_url_entity.rb +42 -0
  121. data/lib/x_twitter_scraper/models/tweet_user_mention.rb +42 -0
  122. data/lib/x_twitter_scraper/models/user_affiliate_label.rb +75 -0
  123. data/lib/x_twitter_scraper/models/user_auxiliary_label.rb +49 -0
  124. data/lib/x_twitter_scraper/models/user_highlights_info.rb +28 -0
  125. data/lib/x_twitter_scraper/models/user_identity_verification.rb +45 -0
  126. data/lib/x_twitter_scraper/models/user_insights.rb +229 -0
  127. data/lib/x_twitter_scraper/models/user_live_status.rb +48 -0
  128. data/lib/x_twitter_scraper/models/webhook_create_telegram_link_params.rb +26 -0
  129. data/lib/x_twitter_scraper/models/webhook_create_telegram_link_response.rb +29 -0
  130. data/lib/x_twitter_scraper/models/x/broadcast_retrieve_params.rb +53 -0
  131. data/lib/x_twitter_scraper/models/x/broadcast_retrieve_response.rb +23 -0
  132. data/lib/x_twitter_scraper/models/x/communities/media_list_params.rb +414 -0
  133. data/lib/x_twitter_scraper/models/x/community_find_params.rb +72 -0
  134. data/lib/x_twitter_scraper/models/x/community_list_popular_params.rb +81 -0
  135. data/lib/x_twitter_scraper/models/x/community_list_suggested_params.rb +54 -0
  136. data/lib/x_twitter_scraper/models/x/community_list_suggested_response.rb +39 -0
  137. data/lib/x_twitter_scraper/models/x/community_list_topics_params.rb +54 -0
  138. data/lib/x_twitter_scraper/models/x/community_list_topics_response.rb +39 -0
  139. data/lib/x_twitter_scraper/models/x/community_note_list_contributor_deleted_notes_params.rb +72 -0
  140. data/lib/x_twitter_scraper/models/x/community_note_list_contributor_notes_params.rb +72 -0
  141. data/lib/x_twitter_scraper/models/x/community_note_retrieve_contributor_params.rb +53 -0
  142. data/lib/x_twitter_scraper/models/x/community_note_retrieve_contributor_response.rb +25 -0
  143. data/lib/x_twitter_scraper/models/x/community_retrieve_analytics_params.rb +54 -0
  144. data/lib/x_twitter_scraper/models/x/community_search_members_params.rb +209 -0
  145. data/lib/x_twitter_scraper/models/x/dm_delete_message_params.rb +71 -0
  146. data/lib/x_twitter_scraper/models/x/job_list_locations_params.rb +62 -0
  147. data/lib/x_twitter_scraper/models/x/job_retrieve_params.rb +53 -0
  148. data/lib/x_twitter_scraper/models/x/job_retrieve_response.rb +25 -0
  149. data/lib/x_twitter_scraper/models/x/job_search_params.rb +127 -0
  150. data/lib/x_twitter_scraper/models/x/list_retrieve_params.rb +52 -0
  151. data/lib/x_twitter_scraper/models/x/list_retrieve_response.rb +23 -0
  152. data/lib/x_twitter_scraper/models/x/list_retrieve_search_params.rb +72 -0
  153. data/lib/x_twitter_scraper/models/x/space_retrieve_params.rb +52 -0
  154. data/lib/x_twitter_scraper/models/x/space_retrieve_replay_params.rb +52 -0
  155. data/lib/x_twitter_scraper/models/x/space_retrieve_replay_response.rb +52 -0
  156. data/lib/x_twitter_scraper/models/x/space_retrieve_response.rb +23 -0
  157. data/lib/x_twitter_scraper/models/x/space_search_params.rb +96 -0
  158. data/lib/x_twitter_scraper/models/x/space_search_response.rb +39 -0
  159. data/lib/x_twitter_scraper/models/x/sport_list_games_params.rb +91 -0
  160. data/lib/x_twitter_scraper/models/x/sport_list_posts_params.rb +112 -0
  161. data/lib/x_twitter_scraper/models/x/sport_retrieve_audience_params.rb +72 -0
  162. data/lib/x_twitter_scraper/models/x/sport_retrieve_box_score_params.rb +72 -0
  163. data/lib/x_twitter_scraper/models/x/sport_retrieve_player_props_params.rb +72 -0
  164. data/lib/x_twitter_scraper/models/x/sport_retrieve_plays_params.rb +72 -0
  165. data/lib/x_twitter_scraper/models/x/sport_retrieve_roster_params.rb +72 -0
  166. data/lib/x_twitter_scraper/models/x/sport_retrieve_scoreboard_params.rb +72 -0
  167. data/lib/x_twitter_scraper/models/x/tweet_check_repost_params.rb +59 -0
  168. data/lib/x_twitter_scraper/models/x/tweet_check_repost_response.rb +69 -0
  169. data/lib/x_twitter_scraper/models/x/tweet_embed_params.rb +98 -0
  170. data/lib/x_twitter_scraper/models/x/tweet_embed_response.rb +23 -0
  171. data/lib/x_twitter_scraper/models/x/tweet_get_hidden_replies_params.rb +412 -0
  172. data/lib/x_twitter_scraper/models/x/tweet_get_insights_params.rb +55 -0
  173. data/lib/x_twitter_scraper/models/x/tweet_get_insights_response.rb +24 -0
  174. data/lib/x_twitter_scraper/models/x/tweet_get_retweeter_ids_params.rb +51 -0
  175. data/lib/x_twitter_scraper/models/x/tweet_get_subtitles_params.rb +55 -0
  176. data/lib/x_twitter_scraper/models/x/tweet_get_subtitles_response.rb +23 -0
  177. data/lib/x_twitter_scraper/models/x/tweet_list_top_params.rb +124 -0
  178. data/lib/x_twitter_scraper/models/x/tweet_resolve_links_params.rb +54 -0
  179. data/lib/x_twitter_scraper/models/x/tweet_resolve_links_response.rb +33 -0
  180. data/lib/x_twitter_scraper/models/x/tweet_translate_params.rb +64 -0
  181. data/lib/x_twitter_scraper/models/x/tweet_translate_response.rb +25 -0
  182. data/lib/x_twitter_scraper/models/x/tweets/bookmark_create_params.rb +66 -0
  183. data/lib/x_twitter_scraper/models/x/tweets/bookmark_delete_params.rb +66 -0
  184. data/lib/x_twitter_scraper/models/x/user_retrieve_affiliates_params.rb +217 -0
  185. data/lib/x_twitter_scraper/models/x/user_retrieve_articles_params.rb +412 -0
  186. data/lib/x_twitter_scraper/models/x/user_retrieve_batch_response.rb +18 -1
  187. data/lib/x_twitter_scraper/models/x/user_retrieve_batch_tweets_params.rb +74 -0
  188. data/lib/x_twitter_scraper/models/x/user_retrieve_follower_audit_params.rb +65 -0
  189. data/lib/x_twitter_scraper/models/x/user_retrieve_follower_audit_response.rb +24 -0
  190. data/lib/x_twitter_scraper/models/x/user_retrieve_follower_ids_params.rb +46 -0
  191. data/lib/x_twitter_scraper/models/x/user_retrieve_following_ids_params.rb +46 -0
  192. data/lib/x_twitter_scraper/models/x/user_retrieve_highlights_params.rb +412 -0
  193. data/lib/x_twitter_scraper/models/x/user_retrieve_insights_params.rb +66 -0
  194. data/lib/x_twitter_scraper/models/x/user_retrieve_insights_response.rb +33 -0
  195. data/lib/x_twitter_scraper/models/x/user_retrieve_list_memberships_params.rb +71 -0
  196. data/lib/x_twitter_scraper/models/x/user_retrieve_lists_params.rb +71 -0
  197. data/lib/x_twitter_scraper/models/x/user_retrieve_live_params.rb +54 -0
  198. data/lib/x_twitter_scraper/models/x/user_retrieve_shadowban_params.rb +65 -0
  199. data/lib/x_twitter_scraper/models/x/user_retrieve_similar_params.rb +217 -0
  200. data/lib/x_twitter_scraper/models/x/user_retrieve_subscriptions_params.rb +217 -0
  201. data/lib/x_twitter_scraper/models/x/user_translate_bio_params.rb +63 -0
  202. data/lib/x_twitter_scraper/models/x/user_translate_bio_response.rb +31 -0
  203. data/lib/x_twitter_scraper/models/x/users/block_create_params.rb +65 -0
  204. data/lib/x_twitter_scraper/models/x/users/block_delete_params.rb +65 -0
  205. data/lib/x_twitter_scraper/models/x/users/mute_create_params.rb +65 -0
  206. data/lib/x_twitter_scraper/models/x/users/mute_delete_params.rb +65 -0
  207. data/lib/x_twitter_scraper/models/x_autocomplete_search_params.rb +73 -0
  208. data/lib/x_twitter_scraper/models/x_get_hashflags_params.rb +69 -0
  209. data/lib/x_twitter_scraper/models/x_get_hashflags_response.rb +44 -0
  210. data/lib/x_twitter_scraper/models/x_get_news_story_versions_params.rb +51 -0
  211. data/lib/x_twitter_scraper/models/x_get_news_story_versions_response.rb +36 -0
  212. data/lib/x_twitter_scraper/models/x_get_trend_locations_params.rb +91 -0
  213. data/lib/x_twitter_scraper/models/x_get_trend_locations_response.rb +44 -0
  214. data/lib/x_twitter_scraper/models/x_get_trends_history_params.rb +129 -0
  215. data/lib/x_twitter_scraper/models/x_get_trends_history_response.rb +161 -0
  216. data/lib/x_twitter_scraper/models/x_list.rb +118 -0
  217. data/lib/x_twitter_scraper/models/x_list_banner.rb +152 -0
  218. data/lib/x_twitter_scraper/models/x_search_places_params.rb +61 -0
  219. data/lib/x_twitter_scraper/models/x_search_places_response.rb +44 -0
  220. data/lib/x_twitter_scraper/models.rb +234 -0
  221. data/lib/x_twitter_scraper/resources/activity.rb +122 -0
  222. data/lib/x_twitter_scraper/resources/events.rb +42 -0
  223. data/lib/x_twitter_scraper/resources/extractions.rb +20 -0
  224. data/lib/x_twitter_scraper/resources/monitors/posts.rb +175 -0
  225. data/lib/x_twitter_scraper/resources/monitors.rb +35 -0
  226. data/lib/x_twitter_scraper/resources/webhooks.rb +28 -0
  227. data/lib/x_twitter_scraper/resources/x/broadcasts.rb +49 -0
  228. data/lib/x_twitter_scraper/resources/x/communities/media.rb +126 -0
  229. data/lib/x_twitter_scraper/resources/x/communities.rb +226 -0
  230. data/lib/x_twitter_scraper/resources/x/community_notes.rb +115 -0
  231. data/lib/x_twitter_scraper/resources/x/dm.rb +38 -0
  232. data/lib/x_twitter_scraper/resources/x/jobs.rb +124 -0
  233. data/lib/x_twitter_scraper/resources/x/lists.rb +62 -0
  234. data/lib/x_twitter_scraper/resources/x/spaces.rb +114 -0
  235. data/lib/x_twitter_scraper/resources/x/sports.rb +296 -0
  236. data/lib/x_twitter_scraper/resources/x/tweets/bookmark.rb +83 -0
  237. data/lib/x_twitter_scraper/resources/x/tweets.rb +363 -0
  238. data/lib/x_twitter_scraper/resources/x/users/block.rb +83 -0
  239. data/lib/x_twitter_scraper/resources/x/users/mute.rb +83 -0
  240. data/lib/x_twitter_scraper/resources/x/users.rb +743 -0
  241. data/lib/x_twitter_scraper/resources/x.rb +234 -0
  242. data/lib/x_twitter_scraper/version.rb +1 -1
  243. data/lib/x_twitter_scraper.rb +222 -0
  244. data/rbi/x_twitter_scraper/client.rbi +3 -0
  245. data/rbi/x_twitter_scraper/internal/stream.rbi +38 -0
  246. data/rbi/x_twitter_scraper/models/activity_export_params.rbi +236 -0
  247. data/rbi/x_twitter_scraper/models/activity_list_params.rbi +206 -0
  248. data/rbi/x_twitter_scraper/models/activity_list_response.rbi +17 -0
  249. data/rbi/x_twitter_scraper/models/activity_log_row.rbi +150 -0
  250. data/rbi/x_twitter_scraper/models/activity_record.rbi +1008 -0
  251. data/rbi/x_twitter_scraper/models/activity_retrieve_params.rbi +49 -0
  252. data/rbi/x_twitter_scraper/models/audited_follower.rbi +138 -0
  253. data/rbi/x_twitter_scraper/models/batch_user_tweets.rbi +115 -0
  254. data/rbi/x_twitter_scraper/models/broadcast.rbi +398 -0
  255. data/rbi/x_twitter_scraper/models/community.rbi +1492 -0
  256. data/rbi/x_twitter_scraper/models/community_analytics.rbi +179 -0
  257. data/rbi/x_twitter_scraper/models/community_analytics_metric.rbi +42 -0
  258. data/rbi/x_twitter_scraper/models/community_banner.rbi +224 -0
  259. data/rbi/x_twitter_scraper/models/community_member_preview.rbi +66 -0
  260. data/rbi/x_twitter_scraper/models/community_note.rbi +407 -0
  261. data/rbi/x_twitter_scraper/models/community_note_entity.rbi +157 -0
  262. data/rbi/x_twitter_scraper/models/community_notes_contributor.rbi +114 -0
  263. data/rbi/x_twitter_scraper/models/community_notes_note_counts.rbi +80 -0
  264. data/rbi/x_twitter_scraper/models/community_notes_rating_counts.rbi +107 -0
  265. data/rbi/x_twitter_scraper/models/community_notes_rating_outcome.rbi +65 -0
  266. data/rbi/x_twitter_scraper/models/community_page.rbi +67 -0
  267. data/rbi/x_twitter_scraper/models/community_topic.rbi +103 -0
  268. data/rbi/x_twitter_scraper/models/event_stream_params.rbi +121 -0
  269. data/rbi/x_twitter_scraper/models/extraction_cancel_params.rbi +49 -0
  270. data/rbi/x_twitter_scraper/models/extraction_cancel_response.rbi +33 -0
  271. data/rbi/x_twitter_scraper/models/follower_audit.rbi +565 -0
  272. data/rbi/x_twitter_scraper/models/follower_class.rbi +37 -0
  273. data/rbi/x_twitter_scraper/models/follower_value_count.rbi +42 -0
  274. data/rbi/x_twitter_scraper/models/football_box_score.rbi +152 -0
  275. data/rbi/x_twitter_scraper/models/football_drive.rbi +155 -0
  276. data/rbi/x_twitter_scraper/models/football_fumble_stats.rbi +60 -0
  277. data/rbi/x_twitter_scraper/models/football_odds.rbi +60 -0
  278. data/rbi/x_twitter_scraper/models/football_passing_stats.rbi +116 -0
  279. data/rbi/x_twitter_scraper/models/football_period.rbi +76 -0
  280. data/rbi/x_twitter_scraper/models/football_play.rbi +420 -0
  281. data/rbi/x_twitter_scraper/models/football_play_detail.rbi +231 -0
  282. data/rbi/x_twitter_scraper/models/football_player.rbi +276 -0
  283. data/rbi/x_twitter_scraper/models/football_player_prop.rbi +86 -0
  284. data/rbi/x_twitter_scraper/models/football_player_stats.rbi +643 -0
  285. data/rbi/x_twitter_scraper/models/football_plays.rbi +157 -0
  286. data/rbi/x_twitter_scraper/models/football_prop_category.rbi +75 -0
  287. data/rbi/x_twitter_scraper/models/football_props.rbi +135 -0
  288. data/rbi/x_twitter_scraper/models/football_quarter.rbi +75 -0
  289. data/rbi/x_twitter_scraper/models/football_return_stats.rbi +76 -0
  290. data/rbi/x_twitter_scraper/models/football_roster.rbi +139 -0
  291. data/rbi/x_twitter_scraper/models/football_roster_team.rbi +46 -0
  292. data/rbi/x_twitter_scraper/models/football_rushing_stats.rbi +76 -0
  293. data/rbi/x_twitter_scraper/models/football_schedule.rbi +117 -0
  294. data/rbi/x_twitter_scraper/models/football_schedule_game.rbi +215 -0
  295. data/rbi/x_twitter_scraper/models/football_schedule_period.rbi +34 -0
  296. data/rbi/x_twitter_scraper/models/football_scoreboard.rbi +343 -0
  297. data/rbi/x_twitter_scraper/models/football_side.rbi +60 -0
  298. data/rbi/x_twitter_scraper/models/football_team_box.rbi +77 -0
  299. data/rbi/x_twitter_scraper/models/football_team_score.rbi +48 -0
  300. data/rbi/x_twitter_scraper/models/football_team_totals.rbi +252 -0
  301. data/rbi/x_twitter_scraper/models/hashflag.rbi +144 -0
  302. data/rbi/x_twitter_scraper/models/job.rbi +276 -0
  303. data/rbi/x_twitter_scraper/models/job_account.rbi +129 -0
  304. data/rbi/x_twitter_scraper/models/job_company.rbi +56 -0
  305. data/rbi/x_twitter_scraper/models/job_location.rbi +40 -0
  306. data/rbi/x_twitter_scraper/models/job_locations.rbi +59 -0
  307. data/rbi/x_twitter_scraper/models/monitor_upsert_by_username_params.rbi +83 -0
  308. data/rbi/x_twitter_scraper/models/monitor_upsert_by_username_response.rbi +195 -0
  309. data/rbi/x_twitter_scraper/models/monitors/post_create_params.rbi +104 -0
  310. data/rbi/x_twitter_scraper/models/monitors/post_delete_params.rbi +49 -0
  311. data/rbi/x_twitter_scraper/models/monitors/post_delete_response.rbi +54 -0
  312. data/rbi/x_twitter_scraper/models/monitors/post_list_params.rbi +70 -0
  313. data/rbi/x_twitter_scraper/models/monitors/post_list_response.rbi +74 -0
  314. data/rbi/x_twitter_scraper/models/monitors/post_retrieve_metrics_params.rbi +63 -0
  315. data/rbi/x_twitter_scraper/models/monitors/post_retrieve_params.rbi +49 -0
  316. data/rbi/x_twitter_scraper/models/monitors/post_update_params.rbi +98 -0
  317. data/rbi/x_twitter_scraper/models/news_version.rbi +63 -0
  318. data/rbi/x_twitter_scraper/models/paginated_community_notes.rbi +63 -0
  319. data/rbi/x_twitter_scraper/models/paginated_jobs.rbi +59 -0
  320. data/rbi/x_twitter_scraper/models/paginated_lists.rbi +61 -0
  321. data/rbi/x_twitter_scraper/models/paginated_user_ids.rbi +58 -0
  322. data/rbi/x_twitter_scraper/models/place.rbi +166 -0
  323. data/rbi/x_twitter_scraper/models/place_search_result.rbi +191 -0
  324. data/rbi/x_twitter_scraper/models/post_engagement_metrics.rbi +84 -0
  325. data/rbi/x_twitter_scraper/models/post_event_type.rbi +80 -0
  326. data/rbi/x_twitter_scraper/models/post_metric_point.rbi +41 -0
  327. data/rbi/x_twitter_scraper/models/post_metric_reading.rbi +41 -0
  328. data/rbi/x_twitter_scraper/models/post_metrics.rbi +130 -0
  329. data/rbi/x_twitter_scraper/models/post_monitor.rbi +573 -0
  330. data/rbi/x_twitter_scraper/models/post_monitor_metrics.rbi +239 -0
  331. data/rbi/x_twitter_scraper/models/profile_translation.rbi +92 -0
  332. data/rbi/x_twitter_scraper/models/resolved_link.rbi +47 -0
  333. data/rbi/x_twitter_scraper/models/search_suggestion_cashtag.rbi +154 -0
  334. data/rbi/x_twitter_scraper/models/search_suggestion_hashtag.rbi +77 -0
  335. data/rbi/x_twitter_scraper/models/search_suggestion_topic.rbi +77 -0
  336. data/rbi/x_twitter_scraper/models/search_suggestion_user.rbi +278 -0
  337. data/rbi/x_twitter_scraper/models/search_suggestions.rbi +125 -0
  338. data/rbi/x_twitter_scraper/models/shadowban_report.rbi +2216 -0
  339. data/rbi/x_twitter_scraper/models/shadowban_verdict.rbi +36 -0
  340. data/rbi/x_twitter_scraper/models/space.rbi +375 -0
  341. data/rbi/x_twitter_scraper/models/space_participant.rbi +173 -0
  342. data/rbi/x_twitter_scraper/models/space_sharing.rbi +93 -0
  343. data/rbi/x_twitter_scraper/models/sports_game_audience.rbi +428 -0
  344. data/rbi/x_twitter_scraper/models/sports_game_posts.rbi +284 -0
  345. data/rbi/x_twitter_scraper/models/sports_team.rbi +314 -0
  346. data/rbi/x_twitter_scraper/models/sports_team_game.rbi +110 -0
  347. data/rbi/x_twitter_scraper/models/subtitle_track.rbi +161 -0
  348. data/rbi/x_twitter_scraper/models/trend_location.rbi +98 -0
  349. data/rbi/x_twitter_scraper/models/tweet_embed.rbi +100 -0
  350. data/rbi/x_twitter_scraper/models/tweet_entities.rbi +122 -0
  351. data/rbi/x_twitter_scraper/models/tweet_hashtag.rbi +62 -0
  352. data/rbi/x_twitter_scraper/models/tweet_insights.rbi +139 -0
  353. data/rbi/x_twitter_scraper/models/tweet_smart_tag.rbi +143 -0
  354. data/rbi/x_twitter_scraper/models/tweet_subtitles.rbi +59 -0
  355. data/rbi/x_twitter_scraper/models/tweet_symbol.rbi +74 -0
  356. data/rbi/x_twitter_scraper/models/tweet_translation.rbi +84 -0
  357. data/rbi/x_twitter_scraper/models/tweet_url_entity.rbi +67 -0
  358. data/rbi/x_twitter_scraper/models/tweet_user_mention.rbi +64 -0
  359. data/rbi/x_twitter_scraper/models/user_affiliate_label.rbi +125 -0
  360. data/rbi/x_twitter_scraper/models/user_auxiliary_label.rbi +81 -0
  361. data/rbi/x_twitter_scraper/models/user_highlights_info.rbi +48 -0
  362. data/rbi/x_twitter_scraper/models/user_identity_verification.rbi +78 -0
  363. data/rbi/x_twitter_scraper/models/user_insights.rbi +315 -0
  364. data/rbi/x_twitter_scraper/models/user_live_status.rbi +77 -0
  365. data/rbi/x_twitter_scraper/models/webhook_create_telegram_link_params.rbi +62 -0
  366. data/rbi/x_twitter_scraper/models/webhook_create_telegram_link_response.rbi +40 -0
  367. data/rbi/x_twitter_scraper/models/x/broadcast_retrieve_params.rbi +92 -0
  368. data/rbi/x_twitter_scraper/models/x/broadcast_retrieve_response.rbi +47 -0
  369. data/rbi/x_twitter_scraper/models/x/communities/media_list_params.rbi +751 -0
  370. data/rbi/x_twitter_scraper/models/x/community_find_params.rbi +120 -0
  371. data/rbi/x_twitter_scraper/models/x/community_list_popular_params.rbi +136 -0
  372. data/rbi/x_twitter_scraper/models/x/community_list_suggested_params.rbi +97 -0
  373. data/rbi/x_twitter_scraper/models/x/community_list_suggested_response.rbi +72 -0
  374. data/rbi/x_twitter_scraper/models/x/community_list_topics_params.rbi +97 -0
  375. data/rbi/x_twitter_scraper/models/x/community_list_topics_response.rbi +72 -0
  376. data/rbi/x_twitter_scraper/models/x/community_note_list_contributor_deleted_notes_params.rbi +120 -0
  377. data/rbi/x_twitter_scraper/models/x/community_note_list_contributor_notes_params.rbi +120 -0
  378. data/rbi/x_twitter_scraper/models/x/community_note_retrieve_contributor_params.rbi +92 -0
  379. data/rbi/x_twitter_scraper/models/x/community_note_retrieve_contributor_response.rbi +57 -0
  380. data/rbi/x_twitter_scraper/models/x/community_retrieve_analytics_params.rbi +94 -0
  381. data/rbi/x_twitter_scraper/models/x/community_search_members_params.rbi +306 -0
  382. data/rbi/x_twitter_scraper/models/x/dm_delete_message_params.rbi +109 -0
  383. data/rbi/x_twitter_scraper/models/x/job_list_locations_params.rbi +105 -0
  384. data/rbi/x_twitter_scraper/models/x/job_retrieve_params.rbi +92 -0
  385. data/rbi/x_twitter_scraper/models/x/job_retrieve_response.rbi +47 -0
  386. data/rbi/x_twitter_scraper/models/x/job_search_params.rbi +200 -0
  387. data/rbi/x_twitter_scraper/models/x/list_retrieve_params.rbi +90 -0
  388. data/rbi/x_twitter_scraper/models/x/list_retrieve_response.rbi +43 -0
  389. data/rbi/x_twitter_scraper/models/x/list_retrieve_search_params.rbi +120 -0
  390. data/rbi/x_twitter_scraper/models/x/space_retrieve_params.rbi +90 -0
  391. data/rbi/x_twitter_scraper/models/x/space_retrieve_replay_params.rbi +90 -0
  392. data/rbi/x_twitter_scraper/models/x/space_retrieve_replay_response.rbi +111 -0
  393. data/rbi/x_twitter_scraper/models/x/space_retrieve_response.rbi +43 -0
  394. data/rbi/x_twitter_scraper/models/x/space_search_params.rbi +196 -0
  395. data/rbi/x_twitter_scraper/models/x/space_search_response.rbi +67 -0
  396. data/rbi/x_twitter_scraper/models/x/sport_list_games_params.rbi +181 -0
  397. data/rbi/x_twitter_scraper/models/x/sport_list_posts_params.rbi +242 -0
  398. data/rbi/x_twitter_scraper/models/x/sport_retrieve_audience_params.rbi +150 -0
  399. data/rbi/x_twitter_scraper/models/x/sport_retrieve_box_score_params.rbi +150 -0
  400. data/rbi/x_twitter_scraper/models/x/sport_retrieve_player_props_params.rbi +147 -0
  401. data/rbi/x_twitter_scraper/models/x/sport_retrieve_plays_params.rbi +150 -0
  402. data/rbi/x_twitter_scraper/models/x/sport_retrieve_roster_params.rbi +147 -0
  403. data/rbi/x_twitter_scraper/models/x/sport_retrieve_scoreboard_params.rbi +150 -0
  404. data/rbi/x_twitter_scraper/models/x/tweet_check_repost_params.rbi +96 -0
  405. data/rbi/x_twitter_scraper/models/x/tweet_check_repost_response.rbi +90 -0
  406. data/rbi/x_twitter_scraper/models/x/tweet_embed_params.rbi +185 -0
  407. data/rbi/x_twitter_scraper/models/x/tweet_embed_response.rbi +43 -0
  408. data/rbi/x_twitter_scraper/models/x/tweet_get_hidden_replies_params.rbi +749 -0
  409. data/rbi/x_twitter_scraper/models/x/tweet_get_insights_params.rbi +96 -0
  410. data/rbi/x_twitter_scraper/models/x/tweet_get_insights_response.rbi +49 -0
  411. data/rbi/x_twitter_scraper/models/x/tweet_get_retweeter_ids_params.rbi +88 -0
  412. data/rbi/x_twitter_scraper/models/x/tweet_get_subtitles_params.rbi +96 -0
  413. data/rbi/x_twitter_scraper/models/x/tweet_get_subtitles_response.rbi +51 -0
  414. data/rbi/x_twitter_scraper/models/x/tweet_list_top_params.rbi +281 -0
  415. data/rbi/x_twitter_scraper/models/x/tweet_resolve_links_params.rbi +94 -0
  416. data/rbi/x_twitter_scraper/models/x/tweet_resolve_links_response.rbi +61 -0
  417. data/rbi/x_twitter_scraper/models/x/tweet_translate_params.rbi +106 -0
  418. data/rbi/x_twitter_scraper/models/x/tweet_translate_response.rbi +55 -0
  419. data/rbi/x_twitter_scraper/models/x/tweets/bookmark_create_params.rbi +105 -0
  420. data/rbi/x_twitter_scraper/models/x/tweets/bookmark_delete_params.rbi +105 -0
  421. data/rbi/x_twitter_scraper/models/x/user_retrieve_affiliates_params.rbi +320 -0
  422. data/rbi/x_twitter_scraper/models/x/user_retrieve_articles_params.rbi +749 -0
  423. data/rbi/x_twitter_scraper/models/x/user_retrieve_batch_response.rbi +18 -0
  424. data/rbi/x_twitter_scraper/models/x/user_retrieve_batch_tweets_params.rbi +127 -0
  425. data/rbi/x_twitter_scraper/models/x/user_retrieve_follower_audit_params.rbi +111 -0
  426. data/rbi/x_twitter_scraper/models/x/user_retrieve_follower_audit_response.rbi +49 -0
  427. data/rbi/x_twitter_scraper/models/x/user_retrieve_follower_ids_params.rbi +78 -0
  428. data/rbi/x_twitter_scraper/models/x/user_retrieve_following_ids_params.rbi +78 -0
  429. data/rbi/x_twitter_scraper/models/x/user_retrieve_highlights_params.rbi +749 -0
  430. data/rbi/x_twitter_scraper/models/x/user_retrieve_insights_params.rbi +113 -0
  431. data/rbi/x_twitter_scraper/models/x/user_retrieve_insights_response.rbi +63 -0
  432. data/rbi/x_twitter_scraper/models/x/user_retrieve_list_memberships_params.rbi +118 -0
  433. data/rbi/x_twitter_scraper/models/x/user_retrieve_lists_params.rbi +118 -0
  434. data/rbi/x_twitter_scraper/models/x/user_retrieve_live_params.rbi +94 -0
  435. data/rbi/x_twitter_scraper/models/x/user_retrieve_shadowban_params.rbi +111 -0
  436. data/rbi/x_twitter_scraper/models/x/user_retrieve_similar_params.rbi +320 -0
  437. data/rbi/x_twitter_scraper/models/x/user_retrieve_subscriptions_params.rbi +320 -0
  438. data/rbi/x_twitter_scraper/models/x/user_translate_bio_params.rbi +104 -0
  439. data/rbi/x_twitter_scraper/models/x/user_translate_bio_response.rbi +67 -0
  440. data/rbi/x_twitter_scraper/models/x/users/block_create_params.rbi +103 -0
  441. data/rbi/x_twitter_scraper/models/x/users/block_delete_params.rbi +103 -0
  442. data/rbi/x_twitter_scraper/models/x/users/mute_create_params.rbi +103 -0
  443. data/rbi/x_twitter_scraper/models/x/users/mute_delete_params.rbi +103 -0
  444. data/rbi/x_twitter_scraper/models/x_autocomplete_search_params.rbi +124 -0
  445. data/rbi/x_twitter_scraper/models/x_get_hashflags_params.rbi +119 -0
  446. data/rbi/x_twitter_scraper/models/x_get_hashflags_response.rbi +76 -0
  447. data/rbi/x_twitter_scraper/models/x_get_news_story_versions_params.rbi +90 -0
  448. data/rbi/x_twitter_scraper/models/x_get_news_story_versions_response.rbi +65 -0
  449. data/rbi/x_twitter_scraper/models/x_get_trend_locations_params.rbi +191 -0
  450. data/rbi/x_twitter_scraper/models/x_get_trend_locations_response.rbi +76 -0
  451. data/rbi/x_twitter_scraper/models/x_get_trends_history_params.rbi +209 -0
  452. data/rbi/x_twitter_scraper/models/x_get_trends_history_response.rbi +295 -0
  453. data/rbi/x_twitter_scraper/models/x_list.rbi +179 -0
  454. data/rbi/x_twitter_scraper/models/x_list_banner.rbi +291 -0
  455. data/rbi/x_twitter_scraper/models/x_search_places_params.rbi +105 -0
  456. data/rbi/x_twitter_scraper/models/x_search_places_response.rbi +76 -0
  457. data/rbi/x_twitter_scraper/models.rbi +239 -0
  458. data/rbi/x_twitter_scraper/resources/activity.rbi +114 -0
  459. data/rbi/x_twitter_scraper/resources/events.rbi +36 -0
  460. data/rbi/x_twitter_scraper/resources/extractions.rbi +15 -0
  461. data/rbi/x_twitter_scraper/resources/monitors/posts.rbi +144 -0
  462. data/rbi/x_twitter_scraper/resources/monitors.rbi +30 -0
  463. data/rbi/x_twitter_scraper/resources/webhooks.rbi +20 -0
  464. data/rbi/x_twitter_scraper/resources/x/broadcasts.rbi +51 -0
  465. data/rbi/x_twitter_scraper/resources/x/communities/media.rbi +178 -0
  466. data/rbi/x_twitter_scraper/resources/x/communities.rbi +275 -0
  467. data/rbi/x_twitter_scraper/resources/x/community_notes.rbi +133 -0
  468. data/rbi/x_twitter_scraper/resources/x/dm.rbi +39 -0
  469. data/rbi/x_twitter_scraper/resources/x/jobs.rbi +150 -0
  470. data/rbi/x_twitter_scraper/resources/x/lists.rbi +70 -0
  471. data/rbi/x_twitter_scraper/resources/x/spaces.rbi +129 -0
  472. data/rbi/x_twitter_scraper/resources/x/sports.rbi +332 -0
  473. data/rbi/x_twitter_scraper/resources/x/tweets/bookmark.rbi +93 -0
  474. data/rbi/x_twitter_scraper/resources/x/tweets.rbi +457 -0
  475. data/rbi/x_twitter_scraper/resources/x/users/block.rbi +91 -0
  476. data/rbi/x_twitter_scraper/resources/x/users/mute.rbi +91 -0
  477. data/rbi/x_twitter_scraper/resources/x/users.rbi +966 -0
  478. data/rbi/x_twitter_scraper/resources/x.rbi +286 -0
  479. data/sig/x_twitter_scraper/client.rbs +2 -0
  480. data/sig/x_twitter_scraper/internal/stream.rbs +21 -0
  481. data/sig/x_twitter_scraper/models/activity_export_params.rbs +108 -0
  482. data/sig/x_twitter_scraper/models/activity_list_params.rbs +106 -0
  483. data/sig/x_twitter_scraper/models/activity_list_response.rbs +12 -0
  484. data/sig/x_twitter_scraper/models/activity_log_row.rbs +95 -0
  485. data/sig/x_twitter_scraper/models/activity_record.rbs +448 -0
  486. data/sig/x_twitter_scraper/models/activity_retrieve_params.rbs +27 -0
  487. data/sig/x_twitter_scraper/models/audited_follower.rbs +95 -0
  488. data/sig/x_twitter_scraper/models/batch_user_tweets.rbs +59 -0
  489. data/sig/x_twitter_scraper/models/broadcast.rbs +245 -0
  490. data/sig/x_twitter_scraper/models/community.rbs +868 -0
  491. data/sig/x_twitter_scraper/models/community_analytics.rbs +71 -0
  492. data/sig/x_twitter_scraper/models/community_analytics_metric.rbs +19 -0
  493. data/sig/x_twitter_scraper/models/community_banner.rbs +118 -0
  494. data/sig/x_twitter_scraper/models/community_member_preview.rbs +34 -0
  495. data/sig/x_twitter_scraper/models/community_note.rbs +231 -0
  496. data/sig/x_twitter_scraper/models/community_note_entity.rbs +89 -0
  497. data/sig/x_twitter_scraper/models/community_notes_contributor.rbs +63 -0
  498. data/sig/x_twitter_scraper/models/community_notes_note_counts.rbs +47 -0
  499. data/sig/x_twitter_scraper/models/community_notes_rating_counts.rbs +58 -0
  500. data/sig/x_twitter_scraper/models/community_notes_rating_outcome.rbs +36 -0
  501. data/sig/x_twitter_scraper/models/community_page.rbs +34 -0
  502. data/sig/x_twitter_scraper/models/community_topic.rbs +46 -0
  503. data/sig/x_twitter_scraper/models/event_stream_params.rbs +58 -0
  504. data/sig/x_twitter_scraper/models/extraction_cancel_params.rbs +27 -0
  505. data/sig/x_twitter_scraper/models/extraction_cancel_response.rbs +19 -0
  506. data/sig/x_twitter_scraper/models/follower_audit.rbs +264 -0
  507. data/sig/x_twitter_scraper/models/follower_class.rbs +22 -0
  508. data/sig/x_twitter_scraper/models/follower_value_count.rbs +22 -0
  509. data/sig/x_twitter_scraper/models/football_box_score.rbs +60 -0
  510. data/sig/x_twitter_scraper/models/football_drive.rbs +84 -0
  511. data/sig/x_twitter_scraper/models/football_fumble_stats.rbs +34 -0
  512. data/sig/x_twitter_scraper/models/football_odds.rbs +26 -0
  513. data/sig/x_twitter_scraper/models/football_passing_stats.rbs +69 -0
  514. data/sig/x_twitter_scraper/models/football_period.rbs +44 -0
  515. data/sig/x_twitter_scraper/models/football_play.rbs +203 -0
  516. data/sig/x_twitter_scraper/models/football_play_detail.rbs +103 -0
  517. data/sig/x_twitter_scraper/models/football_player.rbs +143 -0
  518. data/sig/x_twitter_scraper/models/football_player_prop.rbs +49 -0
  519. data/sig/x_twitter_scraper/models/football_player_stats.rbs +330 -0
  520. data/sig/x_twitter_scraper/models/football_plays.rbs +65 -0
  521. data/sig/x_twitter_scraper/models/football_prop_category.rbs +39 -0
  522. data/sig/x_twitter_scraper/models/football_props.rbs +54 -0
  523. data/sig/x_twitter_scraper/models/football_quarter.rbs +39 -0
  524. data/sig/x_twitter_scraper/models/football_return_stats.rbs +44 -0
  525. data/sig/x_twitter_scraper/models/football_roster.rbs +54 -0
  526. data/sig/x_twitter_scraper/models/football_roster_team.rbs +19 -0
  527. data/sig/x_twitter_scraper/models/football_rushing_stats.rbs +44 -0
  528. data/sig/x_twitter_scraper/models/football_schedule.rbs +45 -0
  529. data/sig/x_twitter_scraper/models/football_schedule_game.rbs +101 -0
  530. data/sig/x_twitter_scraper/models/football_schedule_period.rbs +17 -0
  531. data/sig/x_twitter_scraper/models/football_scoreboard.rbs +152 -0
  532. data/sig/x_twitter_scraper/models/football_side.rbs +30 -0
  533. data/sig/x_twitter_scraper/models/football_team_box.rbs +34 -0
  534. data/sig/x_twitter_scraper/models/football_team_score.rbs +19 -0
  535. data/sig/x_twitter_scraper/models/football_team_totals.rbs +88 -0
  536. data/sig/x_twitter_scraper/models/hashflag.rbs +71 -0
  537. data/sig/x_twitter_scraper/models/job.rbs +173 -0
  538. data/sig/x_twitter_scraper/models/job_account.rbs +78 -0
  539. data/sig/x_twitter_scraper/models/job_company.rbs +25 -0
  540. data/sig/x_twitter_scraper/models/job_location.rbs +19 -0
  541. data/sig/x_twitter_scraper/models/job_locations.rbs +29 -0
  542. data/sig/x_twitter_scraper/models/monitor_upsert_by_username_params.rbs +42 -0
  543. data/sig/x_twitter_scraper/models/monitor_upsert_by_username_response.rbs +95 -0
  544. data/sig/x_twitter_scraper/models/monitors/post_create_params.rbs +55 -0
  545. data/sig/x_twitter_scraper/models/monitors/post_delete_params.rbs +29 -0
  546. data/sig/x_twitter_scraper/models/monitors/post_delete_response.rbs +32 -0
  547. data/sig/x_twitter_scraper/models/monitors/post_list_params.rbs +38 -0
  548. data/sig/x_twitter_scraper/models/monitors/post_list_response.rbs +43 -0
  549. data/sig/x_twitter_scraper/models/monitors/post_retrieve_metrics_params.rbs +36 -0
  550. data/sig/x_twitter_scraper/models/monitors/post_retrieve_params.rbs +29 -0
  551. data/sig/x_twitter_scraper/models/monitors/post_update_params.rbs +55 -0
  552. data/sig/x_twitter_scraper/models/news_version.rbs +34 -0
  553. data/sig/x_twitter_scraper/models/paginated_community_notes.rbs +34 -0
  554. data/sig/x_twitter_scraper/models/paginated_jobs.rbs +34 -0
  555. data/sig/x_twitter_scraper/models/paginated_lists.rbs +34 -0
  556. data/sig/x_twitter_scraper/models/paginated_user_ids.rbs +30 -0
  557. data/sig/x_twitter_scraper/models/place.rbs +88 -0
  558. data/sig/x_twitter_scraper/models/place_search_result.rbs +93 -0
  559. data/sig/x_twitter_scraper/models/post_engagement_metrics.rbs +49 -0
  560. data/sig/x_twitter_scraper/models/post_event_type.rbs +36 -0
  561. data/sig/x_twitter_scraper/models/post_metric_point.rbs +19 -0
  562. data/sig/x_twitter_scraper/models/post_metric_reading.rbs +19 -0
  563. data/sig/x_twitter_scraper/models/post_metrics.rbs +49 -0
  564. data/sig/x_twitter_scraper/models/post_monitor.rbs +270 -0
  565. data/sig/x_twitter_scraper/models/post_monitor_metrics.rbs +93 -0
  566. data/sig/x_twitter_scraper/models/profile_translation.rbs +51 -0
  567. data/sig/x_twitter_scraper/models/resolved_link.rbs +21 -0
  568. data/sig/x_twitter_scraper/models/search_suggestion_cashtag.rbs +94 -0
  569. data/sig/x_twitter_scraper/models/search_suggestion_hashtag.rbs +40 -0
  570. data/sig/x_twitter_scraper/models/search_suggestion_topic.rbs +40 -0
  571. data/sig/x_twitter_scraper/models/search_suggestion_user.rbs +156 -0
  572. data/sig/x_twitter_scraper/models/search_suggestions.rbs +49 -0
  573. data/sig/x_twitter_scraper/models/shadowban_report.rbs +730 -0
  574. data/sig/x_twitter_scraper/models/shadowban_verdict.rbs +19 -0
  575. data/sig/x_twitter_scraper/models/space.rbs +220 -0
  576. data/sig/x_twitter_scraper/models/space_participant.rbs +106 -0
  577. data/sig/x_twitter_scraper/models/space_sharing.rbs +58 -0
  578. data/sig/x_twitter_scraper/models/sports_game_audience.rbs +151 -0
  579. data/sig/x_twitter_scraper/models/sports_game_posts.rbs +131 -0
  580. data/sig/x_twitter_scraper/models/sports_team.rbs +124 -0
  581. data/sig/x_twitter_scraper/models/sports_team_game.rbs +59 -0
  582. data/sig/x_twitter_scraper/models/subtitle_track.rbs +83 -0
  583. data/sig/x_twitter_scraper/models/support/attachment_download_params.rbs +4 -0
  584. data/sig/x_twitter_scraper/models/trend_location.rbs +59 -0
  585. data/sig/x_twitter_scraper/models/tweet_analysis_page.rbs +4 -0
  586. data/sig/x_twitter_scraper/models/tweet_embed.rbs +58 -0
  587. data/sig/x_twitter_scraper/models/tweet_entities.rbs +73 -0
  588. data/sig/x_twitter_scraper/models/tweet_hashtag.rbs +40 -0
  589. data/sig/x_twitter_scraper/models/tweet_insights.rbs +79 -0
  590. data/sig/x_twitter_scraper/models/tweet_smart_tag.rbs +74 -0
  591. data/sig/x_twitter_scraper/models/tweet_subtitles.rbs +29 -0
  592. data/sig/x_twitter_scraper/models/tweet_symbol.rbs +49 -0
  593. data/sig/x_twitter_scraper/models/tweet_translation.rbs +46 -0
  594. data/sig/x_twitter_scraper/models/tweet_url_entity.rbs +47 -0
  595. data/sig/x_twitter_scraper/models/tweet_user_mention.rbs +45 -0
  596. data/sig/x_twitter_scraper/models/user_affiliate_label.rbs +77 -0
  597. data/sig/x_twitter_scraper/models/user_auxiliary_label.rbs +54 -0
  598. data/sig/x_twitter_scraper/models/user_highlights_info.rbs +27 -0
  599. data/sig/x_twitter_scraper/models/user_identity_verification.rbs +47 -0
  600. data/sig/x_twitter_scraper/models/user_insights.rbs +163 -0
  601. data/sig/x_twitter_scraper/models/user_live_status.rbs +39 -0
  602. data/sig/x_twitter_scraper/models/webhook_create_telegram_link_params.rbs +32 -0
  603. data/sig/x_twitter_scraper/models/webhook_create_telegram_link_response.rbs +20 -0
  604. data/sig/x_twitter_scraper/models/x/account_connection_attempt_retrieve_params.rbs +4 -0
  605. data/sig/x_twitter_scraper/models/x/account_connection_attempt_retrieve_response.rbs +4 -0
  606. data/sig/x_twitter_scraper/models/x/broadcast_retrieve_params.rbs +42 -0
  607. data/sig/x_twitter_scraper/models/x/broadcast_retrieve_response.rbs +20 -0
  608. data/sig/x_twitter_scraper/models/x/communities/media_list_params.rbs +373 -0
  609. data/sig/x_twitter_scraper/models/x/community_find_params.rbs +60 -0
  610. data/sig/x_twitter_scraper/models/x/community_list_popular_params.rbs +69 -0
  611. data/sig/x_twitter_scraper/models/x/community_list_suggested_params.rbs +44 -0
  612. data/sig/x_twitter_scraper/models/x/community_list_suggested_response.rbs +38 -0
  613. data/sig/x_twitter_scraper/models/x/community_list_topics_params.rbs +44 -0
  614. data/sig/x_twitter_scraper/models/x/community_list_topics_response.rbs +38 -0
  615. data/sig/x_twitter_scraper/models/x/community_note_list_contributor_deleted_notes_params.rbs +60 -0
  616. data/sig/x_twitter_scraper/models/x/community_note_list_contributor_notes_params.rbs +60 -0
  617. data/sig/x_twitter_scraper/models/x/community_note_retrieve_contributor_params.rbs +42 -0
  618. data/sig/x_twitter_scraper/models/x/community_note_retrieve_contributor_response.rbs +24 -0
  619. data/sig/x_twitter_scraper/models/x/community_retrieve_analytics_params.rbs +42 -0
  620. data/sig/x_twitter_scraper/models/x/community_search_members_params.rbs +177 -0
  621. data/sig/x_twitter_scraper/models/x/dm_delete_message_params.rbs +54 -0
  622. data/sig/x_twitter_scraper/models/x/job_list_locations_params.rbs +48 -0
  623. data/sig/x_twitter_scraper/models/x/job_retrieve_params.rbs +42 -0
  624. data/sig/x_twitter_scraper/models/x/job_retrieve_response.rbs +19 -0
  625. data/sig/x_twitter_scraper/models/x/job_search_params.rbs +102 -0
  626. data/sig/x_twitter_scraper/models/x/list_retrieve_followers_response.rbs +4 -0
  627. data/sig/x_twitter_scraper/models/x/list_retrieve_members_response.rbs +4 -0
  628. data/sig/x_twitter_scraper/models/x/list_retrieve_params.rbs +42 -0
  629. data/sig/x_twitter_scraper/models/x/list_retrieve_response.rbs +19 -0
  630. data/sig/x_twitter_scraper/models/x/list_retrieve_search_params.rbs +60 -0
  631. data/sig/x_twitter_scraper/models/x/space_retrieve_params.rbs +42 -0
  632. data/sig/x_twitter_scraper/models/x/space_retrieve_replay_params.rbs +42 -0
  633. data/sig/x_twitter_scraper/models/x/space_retrieve_replay_response.rbs +48 -0
  634. data/sig/x_twitter_scraper/models/x/space_retrieve_response.rbs +19 -0
  635. data/sig/x_twitter_scraper/models/x/space_search_params.rbs +82 -0
  636. data/sig/x_twitter_scraper/models/x/space_search_response.rbs +36 -0
  637. data/sig/x_twitter_scraper/models/x/sport_list_games_params.rbs +78 -0
  638. data/sig/x_twitter_scraper/models/x/sport_list_posts_params.rbs +96 -0
  639. data/sig/x_twitter_scraper/models/x/sport_retrieve_audience_params.rbs +62 -0
  640. data/sig/x_twitter_scraper/models/x/sport_retrieve_box_score_params.rbs +62 -0
  641. data/sig/x_twitter_scraper/models/x/sport_retrieve_player_props_params.rbs +61 -0
  642. data/sig/x_twitter_scraper/models/x/sport_retrieve_plays_params.rbs +62 -0
  643. data/sig/x_twitter_scraper/models/x/sport_retrieve_roster_params.rbs +61 -0
  644. data/sig/x_twitter_scraper/models/x/sport_retrieve_scoreboard_params.rbs +62 -0
  645. data/sig/x_twitter_scraper/models/x/tweet_analysis_params.rbs +4 -0
  646. data/sig/x_twitter_scraper/models/x/tweet_check_repost_params.rbs +46 -0
  647. data/sig/x_twitter_scraper/models/x/tweet_check_repost_response.rbs +56 -0
  648. data/sig/x_twitter_scraper/models/x/tweet_embed_params.rbs +87 -0
  649. data/sig/x_twitter_scraper/models/x/tweet_embed_response.rbs +19 -0
  650. data/sig/x_twitter_scraper/models/x/tweet_get_hidden_replies_params.rbs +371 -0
  651. data/sig/x_twitter_scraper/models/x/tweet_get_insights_params.rbs +42 -0
  652. data/sig/x_twitter_scraper/models/x/tweet_get_insights_response.rbs +22 -0
  653. data/sig/x_twitter_scraper/models/x/tweet_get_replies_response.rbs +4 -0
  654. data/sig/x_twitter_scraper/models/x/tweet_get_retweeter_ids_params.rbs +42 -0
  655. data/sig/x_twitter_scraper/models/x/tweet_get_subtitles_params.rbs +42 -0
  656. data/sig/x_twitter_scraper/models/x/tweet_get_subtitles_response.rbs +22 -0
  657. data/sig/x_twitter_scraper/models/x/tweet_list_top_params.rbs +115 -0
  658. data/sig/x_twitter_scraper/models/x/tweet_resolve_links_params.rbs +42 -0
  659. data/sig/x_twitter_scraper/models/x/tweet_resolve_links_response.rbs +31 -0
  660. data/sig/x_twitter_scraper/models/x/tweet_search_response.rbs +4 -0
  661. data/sig/x_twitter_scraper/models/x/tweet_translate_params.rbs +46 -0
  662. data/sig/x_twitter_scraper/models/x/tweet_translate_response.rbs +24 -0
  663. data/sig/x_twitter_scraper/models/x/tweets/bookmark_create_params.rbs +51 -0
  664. data/sig/x_twitter_scraper/models/x/tweets/bookmark_delete_params.rbs +51 -0
  665. data/sig/x_twitter_scraper/models/x/user_retrieve_affiliates_params.rbs +186 -0
  666. data/sig/x_twitter_scraper/models/x/user_retrieve_articles_params.rbs +371 -0
  667. data/sig/x_twitter_scraper/models/x/user_retrieve_batch_response.rbs +10 -0
  668. data/sig/x_twitter_scraper/models/x/user_retrieve_batch_tweets_params.rbs +62 -0
  669. data/sig/x_twitter_scraper/models/x/user_retrieve_follower_audit_params.rbs +48 -0
  670. data/sig/x_twitter_scraper/models/x/user_retrieve_follower_audit_response.rbs +20 -0
  671. data/sig/x_twitter_scraper/models/x/user_retrieve_follower_ids_params.rbs +42 -0
  672. data/sig/x_twitter_scraper/models/x/user_retrieve_followers_response.rbs +4 -0
  673. data/sig/x_twitter_scraper/models/x/user_retrieve_following_ids_params.rbs +42 -0
  674. data/sig/x_twitter_scraper/models/x/user_retrieve_following_response.rbs +4 -0
  675. data/sig/x_twitter_scraper/models/x/user_retrieve_highlights_params.rbs +371 -0
  676. data/sig/x_twitter_scraper/models/x/user_retrieve_insights_params.rbs +48 -0
  677. data/sig/x_twitter_scraper/models/x/user_retrieve_insights_response.rbs +30 -0
  678. data/sig/x_twitter_scraper/models/x/user_retrieve_list_memberships_params.rbs +60 -0
  679. data/sig/x_twitter_scraper/models/x/user_retrieve_lists_params.rbs +60 -0
  680. data/sig/x_twitter_scraper/models/x/user_retrieve_live_params.rbs +42 -0
  681. data/sig/x_twitter_scraper/models/x/user_retrieve_shadowban_params.rbs +48 -0
  682. data/sig/x_twitter_scraper/models/x/user_retrieve_similar_params.rbs +186 -0
  683. data/sig/x_twitter_scraper/models/x/user_retrieve_subscriptions_params.rbs +186 -0
  684. data/sig/x_twitter_scraper/models/x/user_retrieve_verified_followers_response.rbs +4 -0
  685. data/sig/x_twitter_scraper/models/x/user_translate_bio_params.rbs +46 -0
  686. data/sig/x_twitter_scraper/models/x/user_translate_bio_response.rbs +33 -0
  687. data/sig/x_twitter_scraper/models/x/users/block_create_params.rbs +51 -0
  688. data/sig/x_twitter_scraper/models/x/users/block_delete_params.rbs +51 -0
  689. data/sig/x_twitter_scraper/models/x/users/mute_create_params.rbs +51 -0
  690. data/sig/x_twitter_scraper/models/x/users/mute_delete_params.rbs +51 -0
  691. data/sig/x_twitter_scraper/models/x_autocomplete_search_params.rbs +52 -0
  692. data/sig/x_twitter_scraper/models/x_get_hashflags_params.rbs +60 -0
  693. data/sig/x_twitter_scraper/models/x_get_hashflags_response.rbs +41 -0
  694. data/sig/x_twitter_scraper/models/x_get_news_story_versions_params.rbs +40 -0
  695. data/sig/x_twitter_scraper/models/x_get_news_story_versions_response.rbs +34 -0
  696. data/sig/x_twitter_scraper/models/x_get_trend_locations_params.rbs +82 -0
  697. data/sig/x_twitter_scraper/models/x_get_trend_locations_response.rbs +41 -0
  698. data/sig/x_twitter_scraper/models/x_get_trends_history_params.rbs +102 -0
  699. data/sig/x_twitter_scraper/models/x_get_trends_history_response.rbs +149 -0
  700. data/sig/x_twitter_scraper/models/x_list.rbs +112 -0
  701. data/sig/x_twitter_scraper/models/x_list_banner.rbs +157 -0
  702. data/sig/x_twitter_scraper/models/x_search_places_params.rbs +46 -0
  703. data/sig/x_twitter_scraper/models/x_search_places_response.rbs +41 -0
  704. data/sig/x_twitter_scraper/models.rbs +234 -0
  705. data/sig/x_twitter_scraper/resources/activity.rbs +38 -0
  706. data/sig/x_twitter_scraper/resources/events.rbs +7 -0
  707. data/sig/x_twitter_scraper/resources/extractions.rbs +5 -0
  708. data/sig/x_twitter_scraper/resources/monitors/posts.rbs +51 -0
  709. data/sig/x_twitter_scraper/resources/monitors.rbs +9 -0
  710. data/sig/x_twitter_scraper/resources/support/attachments.rbs +4 -0
  711. data/sig/x_twitter_scraper/resources/webhooks.rbs +5 -0
  712. data/sig/x_twitter_scraper/resources/x/account_connection_attempts.rbs +4 -0
  713. data/sig/x_twitter_scraper/resources/x/analysis.rbs +4 -0
  714. data/sig/x_twitter_scraper/resources/x/broadcasts.rbs +20 -0
  715. data/sig/x_twitter_scraper/resources/x/communities/media.rbs +60 -0
  716. data/sig/x_twitter_scraper/resources/x/communities.rbs +68 -0
  717. data/sig/x_twitter_scraper/resources/x/community_notes.rbs +38 -0
  718. data/sig/x_twitter_scraper/resources/x/dm.rbs +9 -0
  719. data/sig/x_twitter_scraper/resources/x/jobs.rbs +43 -0
  720. data/sig/x_twitter_scraper/resources/x/lists.rbs +16 -0
  721. data/sig/x_twitter_scraper/resources/x/spaces.rbs +37 -0
  722. data/sig/x_twitter_scraper/resources/x/sports.rbs +82 -0
  723. data/sig/x_twitter_scraper/resources/x/tweets/bookmark.rbs +31 -0
  724. data/sig/x_twitter_scraper/resources/x/tweets.rbs +114 -0
  725. data/sig/x_twitter_scraper/resources/x/users/block.rbs +31 -0
  726. data/sig/x_twitter_scraper/resources/x/users/mute.rbs +31 -0
  727. data/sig/x_twitter_scraper/resources/x/users.rbs +255 -0
  728. data/sig/x_twitter_scraper/resources/x.rbs +68 -0
  729. metadata +668 -2
@@ -12,6 +12,12 @@ module XTwitterScraper
12
12
  sig { returns(XTwitterScraper::Resources::X::Users::Follow) }
13
13
  attr_reader :follow
14
14
 
15
+ sig { returns(XTwitterScraper::Resources::X::Users::Block) }
16
+ attr_reader :block
17
+
18
+ sig { returns(XTwitterScraper::Resources::X::Users::Mute) }
19
+ attr_reader :mute
20
+
15
21
  # Get user profile with follower counts & verification
16
22
  sig do
17
23
  params(
@@ -1642,6 +1648,966 @@ module XTwitterScraper
1642
1648
  )
1643
1649
  end
1644
1650
 
1651
+ # Returns the newest posts of users named by user ID, username or profile link, in
1652
+ # the order named. Send ids or usernames, not both. Each post costs 1 credit. A
1653
+ # user in unavailable_ids or unprocessed_ids costs nothing.
1654
+ sig do
1655
+ params(
1656
+ ids: String,
1657
+ usernames: String,
1658
+ page_size: Integer,
1659
+ fields: String,
1660
+ omit: String,
1661
+ request_options: XTwitterScraper::RequestOptions::OrHash
1662
+ ).returns(XTwitterScraper::Models::BatchUserTweets)
1663
+ end
1664
+ def retrieve_batch_tweets(
1665
+ # Comma-separated numeric IDs of the users to read posts from. Xquik reads any
1666
+ # other entry as a username, with or without @, so IDs and usernames can mix.
1667
+ # Xquik ignores duplicates and keeps the first-seen order, IDs before usernames. A
1668
+ # longer URL fails at the edge before Xquik reads it.
1669
+ ids: nil,
1670
+ # Comma-separated X usernames, with or without @, or profile links such as
1671
+ # x.com/nasa, in place of ids. A name in another case is the same account. A
1672
+ # number is a user ID. A longer URL fails at the edge before Xquik reads it.
1673
+ usernames: nil,
1674
+ # Posts per user (1-300, default 20). A low credit balance can return fewer. Its
1675
+ # aliases are limit, count, max_results, maxItems, max_items & per_page.
1676
+ page_size: nil,
1677
+ # Fields to keep in each row, comma-separated. Use dots for nested fields, such as
1678
+ # author.username. A list keeps the field in each item. Case & underscores do not
1679
+ # matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics
1680
+ # always stay. An unknown name answers 400 unknown_field with the valid names,
1681
+ # before any read. The price stays the same. SDK row types then hold only the
1682
+ # named fields. A longer URL fails at the edge before Xquik reads it. Pick only
1683
+ # the fields you need with `fields` & `omit`.
1684
+ fields: nil,
1685
+ # Fields to drop from each row, comma-separated. It takes the same names as
1686
+ # fields. With fields, it drops from the kept fields. A longer URL fails at the
1687
+ # edge before Xquik reads it.
1688
+ omit: nil,
1689
+ request_options: {}
1690
+ )
1691
+ end
1692
+
1693
+ # Returns the accounts an organization lists as its affiliates, in X's order. An
1694
+ # account without affiliates returns an empty list.
1695
+ sig do
1696
+ params(
1697
+ id: String,
1698
+ cursor: String,
1699
+ page_size: Integer,
1700
+ min_followers: Integer,
1701
+ max_followers: Integer,
1702
+ min_following: Integer,
1703
+ max_following: Integer,
1704
+ min_statuses: Integer,
1705
+ max_statuses: Integer,
1706
+ min_account_age_days: Integer,
1707
+ verified_only: T::Boolean,
1708
+ blue_verified_only: T::Boolean,
1709
+ verified_type: String,
1710
+ has_website: T::Boolean,
1711
+ has_location: T::Boolean,
1712
+ has_email: T::Boolean,
1713
+ business_email_only: T::Boolean,
1714
+ email_domains: String,
1715
+ bio_contains: String,
1716
+ location_contains: String,
1717
+ username_contains: String,
1718
+ fields: String,
1719
+ omit: String,
1720
+ request_options: XTwitterScraper::RequestOptions::OrHash
1721
+ ).returns(XTwitterScraper::Models::PaginatedUsers)
1722
+ end
1723
+ def retrieve_affiliates(
1724
+ id,
1725
+ # Pagination cursor for collection results. Also read as next_cursor, next_token,
1726
+ # pagination_token or continuation_token.
1727
+ cursor: nil,
1728
+ # Profiles to request from this page. A page holds up to 10,000, so a larger
1729
+ # pageSize gets the largest page. Default 200. Source, filters or credits can
1730
+ # return fewer. Follow next_cursor for more pages. Its aliases are limit, count,
1731
+ # max_results, maxItems, max_items & per_page.
1732
+ page_size: nil,
1733
+ # Minimum follower count. Profiles the filter drops cost nothing.
1734
+ min_followers: nil,
1735
+ # Maximum follower count. A profile without a count passes.
1736
+ max_followers: nil,
1737
+ # Profiles must follow at least this many accounts.
1738
+ min_following: nil,
1739
+ # Profiles may follow at most this many accounts.
1740
+ max_following: nil,
1741
+ # Minimum post count. minPosts is also accepted.
1742
+ min_statuses: nil,
1743
+ # Maximum post count. maxPosts is also accepted.
1744
+ max_statuses: nil,
1745
+ # Minimum account age in whole days.
1746
+ min_account_age_days: nil,
1747
+ # Only return verified profiles.
1748
+ verified_only: nil,
1749
+ # Only return profiles X marks as blue verified. X marks many business &
1750
+ # government accounts blue too. Use verifiedType for 1 badge type.
1751
+ blue_verified_only: nil,
1752
+ # Match the verification type exactly, ignoring case.
1753
+ verified_type: nil,
1754
+ # Only return profiles with a website.
1755
+ has_website: nil,
1756
+ # Only return profiles with a location.
1757
+ has_location: nil,
1758
+ # Only return profiles that publish an email.
1759
+ has_email: nil,
1760
+ # Only return profiles that publish an email outside free webmail, such as Gmail.
1761
+ business_email_only: nil,
1762
+ # Only return profiles with an email at one of these domains. Separate domains
1763
+ # with commas. Subdomains match.
1764
+ email_domains: nil,
1765
+ # Match any comma-separated or line-separated bio term, ignoring case.
1766
+ bio_contains: nil,
1767
+ # Match a location substring, ignoring case.
1768
+ location_contains: nil,
1769
+ # Match a username substring, ignoring case.
1770
+ username_contains: nil,
1771
+ # Fields to keep in each row, comma-separated. Use dots for nested fields, such as
1772
+ # author.username. A list keeps the field in each item. Case & underscores do not
1773
+ # matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics
1774
+ # always stay. An unknown name answers 400 unknown_field with the valid names,
1775
+ # before any read. The price stays the same. SDK row types then hold only the
1776
+ # named fields. A longer URL fails at the edge before Xquik reads it. Pick only
1777
+ # the fields you need with `fields` & `omit`.
1778
+ fields: nil,
1779
+ # Fields to drop from each row, comma-separated. It takes the same names as
1780
+ # fields. With fields, it drops from the kept fields. A longer URL fails at the
1781
+ # edge before Xquik reads it.
1782
+ omit: nil,
1783
+ request_options: {}
1784
+ )
1785
+ end
1786
+
1787
+ # Returns the posts on the user's Articles tab, newest first. Each post's
1788
+ # `article` holds the Article's ID, title, preview, cover & dates. Read the full
1789
+ # text with GET /x/articles/{tweetId}.
1790
+ sig do
1791
+ params(
1792
+ id: String,
1793
+ cursor: String,
1794
+ page_size: Integer,
1795
+ from_user: String,
1796
+ to_user: String,
1797
+ mentioning: String,
1798
+ language: String,
1799
+ since_date: Date,
1800
+ until_date: Date,
1801
+ media_type:
1802
+ XTwitterScraper::Models::X::UserRetrieveArticlesParams::MediaType::OrSymbol,
1803
+ min_likes: Integer,
1804
+ min_retweets: Integer,
1805
+ min_replies: Integer,
1806
+ min_quotes: Integer,
1807
+ min_views: Integer,
1808
+ min_bookmarks: Integer,
1809
+ max_faves: Integer,
1810
+ max_retweets: Integer,
1811
+ max_replies: Integer,
1812
+ max_quotes: Integer,
1813
+ blue_verified_only: T::Boolean,
1814
+ since_id: String,
1815
+ max_id: String,
1816
+ within_time: String,
1817
+ native_retweets: T::Boolean,
1818
+ verified_only: T::Boolean,
1819
+ replies:
1820
+ XTwitterScraper::Models::X::UserRetrieveArticlesParams::Replies::OrSymbol,
1821
+ retweets:
1822
+ XTwitterScraper::Models::X::UserRetrieveArticlesParams::Retweets::OrSymbol,
1823
+ quotes:
1824
+ XTwitterScraper::Models::X::UserRetrieveArticlesParams::Quotes::OrSymbol,
1825
+ exact_phrase: String,
1826
+ exclude_words: String,
1827
+ any_words: String,
1828
+ hashtags: String,
1829
+ cashtags: String,
1830
+ url: String,
1831
+ conversation_id: String,
1832
+ in_reply_to_tweet_id: String,
1833
+ quotes_of_tweet_id: String,
1834
+ retweets_of_tweet_id: String,
1835
+ fields: String,
1836
+ omit: String,
1837
+ request_options: XTwitterScraper::RequestOptions::OrHash
1838
+ ).returns(XTwitterScraper::Models::PaginatedTweets)
1839
+ end
1840
+ def retrieve_articles(
1841
+ id,
1842
+ # Pagination cursor for collection results. Also read as next_cursor, next_token,
1843
+ # pagination_token or continuation_token.
1844
+ cursor: nil,
1845
+ # Items per page. A page holds up to 10,000, so a larger pageSize gets the largest
1846
+ # page. Default 20. Source, filters or credits can return fewer. Follow
1847
+ # next_cursor for more pages. Its aliases are limit, count, max_results, maxItems,
1848
+ # max_items & per_page.
1849
+ page_size: nil,
1850
+ # Filter by author username. Account searches include all of the account's posts &
1851
+ # reposts.
1852
+ from_user: nil,
1853
+ # Filter replies sent to a username.
1854
+ to_user: nil,
1855
+ # Filter tweets mentioning a username.
1856
+ mentioning: nil,
1857
+ # Filter by language. Its alias is `lang`. Language filters work for every
1858
+ # language X tags.
1859
+ language: nil,
1860
+ # Start date in YYYY-MM-DD format, as a UTC day. A date means one thing in any
1861
+ # common form.
1862
+ since_date: nil,
1863
+ # End date in YYYY-MM-DD format, as a UTC day, inclusive, so its own posts count.
1864
+ until_date: nil,
1865
+ # Filter media. Its aliases are has_video & has_media.
1866
+ media_type: nil,
1867
+ # Minimum likes. Its aliases are minFaves, min_likes & min_faves.
1868
+ min_likes: nil,
1869
+ # Minimum retweets threshold.
1870
+ min_retweets: nil,
1871
+ # Minimum replies threshold.
1872
+ min_replies: nil,
1873
+ # Minimum quote count threshold.
1874
+ min_quotes: nil,
1875
+ # Minimum view count threshold.
1876
+ min_views: nil,
1877
+ # Minimum bookmark count threshold.
1878
+ min_bookmarks: nil,
1879
+ # Maximum likes threshold. maxLikes & max_likes also work.
1880
+ max_faves: nil,
1881
+ # Maximum retweets threshold.
1882
+ max_retweets: nil,
1883
+ # Maximum replies threshold.
1884
+ max_replies: nil,
1885
+ # Maximum quotes threshold.
1886
+ max_quotes: nil,
1887
+ # Only return tweets from Blue-verified authors.
1888
+ blue_verified_only: nil,
1889
+ # Return Tweets whose IDs exceed this ID. Searches accept `since_id` & `max_id`
1890
+ # bounds.
1891
+ since_id: nil,
1892
+ # Return Tweets at or below this ID.
1893
+ max_id: nil,
1894
+ # Keeps Tweets from a recent window, such as 90m or 7d. Use a whole number & s, m,
1895
+ # h or d.
1896
+ within_time: nil,
1897
+ # Only return native reposts.
1898
+ native_retweets: nil,
1899
+ # Only return tweets from verified authors.
1900
+ verified_only: nil,
1901
+ # Reply mode. Exclude keeps own-thread replies.
1902
+ replies: nil,
1903
+ # Only when the caller requests a repost mode.
1904
+ retweets: nil,
1905
+ # Only when the caller requests a quote mode.
1906
+ quotes: nil,
1907
+ # Match this exact phrase, word for word.
1908
+ exact_phrase: nil,
1909
+ # Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
1910
+ exclude_words: nil,
1911
+ # Words or quoted phrases where any one can match. Separate with spaces, commas,
1912
+ # or lines.
1913
+ any_words: nil,
1914
+ # Hashtags separated by spaces, commas, or lines.
1915
+ hashtags: nil,
1916
+ # Cashtags separated by spaces, commas, or lines.
1917
+ cashtags: nil,
1918
+ # URL substring or domain filter.
1919
+ url: nil,
1920
+ # Conversation ID filter.
1921
+ conversation_id: nil,
1922
+ # Only replies to this tweet ID.
1923
+ in_reply_to_tweet_id: nil,
1924
+ # Only quotes of this tweet ID.
1925
+ quotes_of_tweet_id: nil,
1926
+ # Only retweets of this tweet ID.
1927
+ retweets_of_tweet_id: nil,
1928
+ # Fields to keep in each row, comma-separated. Use dots for nested fields, such as
1929
+ # author.username. A list keeps the field in each item. Case & underscores do not
1930
+ # matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics
1931
+ # always stay. An unknown name answers 400 unknown_field with the valid names,
1932
+ # before any read. The price stays the same. SDK row types then hold only the
1933
+ # named fields. A longer URL fails at the edge before Xquik reads it. Pick only
1934
+ # the fields you need with `fields` & `omit`.
1935
+ fields: nil,
1936
+ # Fields to drop from each row, comma-separated. It takes the same names as
1937
+ # fields. With fields, it drops from the kept fields. A longer URL fails at the
1938
+ # edge before Xquik reads it.
1939
+ omit: nil,
1940
+ request_options: {}
1941
+ )
1942
+ end
1943
+
1944
+ # Reads the newest followers of a public account & returns a follower audit. It
1945
+ # gives each follower 1 class with its score & signals, then adds coverage, a
1946
+ # quality score, signal counts, arrival bands, join cohorts, countries, top
1947
+ # followers & the account's engagement. Each follower read costs 1 credit, and the
1948
+ # engagement adds 1 credit. Signals come from public profiles, so a real person
1949
+ # can match. Older followers may differ from the newest ones.
1950
+ sig do
1951
+ params(
1952
+ id: String,
1953
+ limit: Integer,
1954
+ fields: String,
1955
+ omit: String,
1956
+ request_options: XTwitterScraper::RequestOptions::OrHash
1957
+ ).returns(
1958
+ XTwitterScraper::Models::X::UserRetrieveFollowerAuditResponse
1959
+ )
1960
+ end
1961
+ def retrieve_follower_audit(
1962
+ # User ID, username with or without @, or URL-encoded profile URL, such as
1963
+ # x.com/nasa or x.com/i/user/11348282. A number is a user ID. Writes look up a
1964
+ # username's ID before sending. Anything else gets 400 `invalid_user_id`.
1965
+ id,
1966
+ # Most followers to read, newest first. Left out, a read takes up to 200 and a low
1967
+ # balance reads fewer. A very long read returns what it finished, & coverage shows
1968
+ # how many. Its aliases are pageSize, count, max_results, maxItems, max_items &
1969
+ # per_page.
1970
+ limit: nil,
1971
+ # Fields to keep in each row, comma-separated. Use dots for nested fields, such as
1972
+ # author.username. A list keeps the field in each item. Case & underscores do not
1973
+ # matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics
1974
+ # always stay. An unknown name answers 400 unknown_field with the valid names,
1975
+ # before any read. The price stays the same. SDK row types then hold only the
1976
+ # named fields. A longer URL fails at the edge before Xquik reads it. Pick only
1977
+ # the fields you need with `fields` & `omit`.
1978
+ fields: nil,
1979
+ # Fields to drop from each row, comma-separated. It takes the same names as
1980
+ # fields. With fields, it drops from the kept fields. A longer URL fails at the
1981
+ # edge before Xquik reads it.
1982
+ omit: nil,
1983
+ request_options: {}
1984
+ )
1985
+ end
1986
+
1987
+ # Returns the user IDs of the selected user's followers, newest first, up to 5,000
1988
+ # a page. Use it when you need IDs only. Each ID costs 1 credit.
1989
+ sig do
1990
+ params(
1991
+ id: String,
1992
+ cursor: String,
1993
+ page_size: Integer,
1994
+ request_options: XTwitterScraper::RequestOptions::OrHash
1995
+ ).returns(XTwitterScraper::Models::PaginatedUserIds)
1996
+ end
1997
+ def retrieve_follower_ids(
1998
+ id,
1999
+ # Pagination cursor for collection results. Also read as next_cursor, next_token,
2000
+ # pagination_token or continuation_token.
2001
+ cursor: nil,
2002
+ # User IDs to request from this page (1-5000, default 5000). A low credit balance
2003
+ # can return fewer. Follow next_cursor for more pages. Its aliases are limit,
2004
+ # count, max_results, maxItems, max_items & per_page.
2005
+ page_size: nil,
2006
+ request_options: {}
2007
+ )
2008
+ end
2009
+
2010
+ # Returns the user IDs of the accounts the selected user follows, newest first, up
2011
+ # to 5,000 a page. Use it when you need IDs only. Each ID costs 1 credit.
2012
+ sig do
2013
+ params(
2014
+ id: String,
2015
+ cursor: String,
2016
+ page_size: Integer,
2017
+ request_options: XTwitterScraper::RequestOptions::OrHash
2018
+ ).returns(XTwitterScraper::Models::PaginatedUserIds)
2019
+ end
2020
+ def retrieve_following_ids(
2021
+ id,
2022
+ # Pagination cursor for collection results. Also read as next_cursor, next_token,
2023
+ # pagination_token or continuation_token.
2024
+ cursor: nil,
2025
+ # User IDs to request from this page (1-5000, default 5000). A low credit balance
2026
+ # can return fewer. Follow next_cursor for more pages. Its aliases are limit,
2027
+ # count, max_results, maxItems, max_items & per_page.
2028
+ page_size: nil,
2029
+ request_options: {}
2030
+ )
2031
+ end
2032
+
2033
+ # Returns the posts on the user's Highlights tab, in X's order. An account without
2034
+ # highlights returns an empty list.
2035
+ sig do
2036
+ params(
2037
+ id: String,
2038
+ cursor: String,
2039
+ page_size: Integer,
2040
+ from_user: String,
2041
+ to_user: String,
2042
+ mentioning: String,
2043
+ language: String,
2044
+ since_date: Date,
2045
+ until_date: Date,
2046
+ media_type:
2047
+ XTwitterScraper::Models::X::UserRetrieveHighlightsParams::MediaType::OrSymbol,
2048
+ min_likes: Integer,
2049
+ min_retweets: Integer,
2050
+ min_replies: Integer,
2051
+ min_quotes: Integer,
2052
+ min_views: Integer,
2053
+ min_bookmarks: Integer,
2054
+ max_faves: Integer,
2055
+ max_retweets: Integer,
2056
+ max_replies: Integer,
2057
+ max_quotes: Integer,
2058
+ blue_verified_only: T::Boolean,
2059
+ since_id: String,
2060
+ max_id: String,
2061
+ within_time: String,
2062
+ native_retweets: T::Boolean,
2063
+ verified_only: T::Boolean,
2064
+ replies:
2065
+ XTwitterScraper::Models::X::UserRetrieveHighlightsParams::Replies::OrSymbol,
2066
+ retweets:
2067
+ XTwitterScraper::Models::X::UserRetrieveHighlightsParams::Retweets::OrSymbol,
2068
+ quotes:
2069
+ XTwitterScraper::Models::X::UserRetrieveHighlightsParams::Quotes::OrSymbol,
2070
+ exact_phrase: String,
2071
+ exclude_words: String,
2072
+ any_words: String,
2073
+ hashtags: String,
2074
+ cashtags: String,
2075
+ url: String,
2076
+ conversation_id: String,
2077
+ in_reply_to_tweet_id: String,
2078
+ quotes_of_tweet_id: String,
2079
+ retweets_of_tweet_id: String,
2080
+ fields: String,
2081
+ omit: String,
2082
+ request_options: XTwitterScraper::RequestOptions::OrHash
2083
+ ).returns(XTwitterScraper::Models::PaginatedTweets)
2084
+ end
2085
+ def retrieve_highlights(
2086
+ id,
2087
+ # Pagination cursor for collection results. Also read as next_cursor, next_token,
2088
+ # pagination_token or continuation_token.
2089
+ cursor: nil,
2090
+ # Items per page. A page holds up to 10,000, so a larger pageSize gets the largest
2091
+ # page. Default 20. Source, filters or credits can return fewer. Follow
2092
+ # next_cursor for more pages. Its aliases are limit, count, max_results, maxItems,
2093
+ # max_items & per_page.
2094
+ page_size: nil,
2095
+ # Filter by author username. Account searches include all of the account's posts &
2096
+ # reposts.
2097
+ from_user: nil,
2098
+ # Filter replies sent to a username.
2099
+ to_user: nil,
2100
+ # Filter tweets mentioning a username.
2101
+ mentioning: nil,
2102
+ # Filter by language. Its alias is `lang`. Language filters work for every
2103
+ # language X tags.
2104
+ language: nil,
2105
+ # Start date in YYYY-MM-DD format, as a UTC day. A date means one thing in any
2106
+ # common form.
2107
+ since_date: nil,
2108
+ # End date in YYYY-MM-DD format, as a UTC day, inclusive, so its own posts count.
2109
+ until_date: nil,
2110
+ # Filter media. Its aliases are has_video & has_media.
2111
+ media_type: nil,
2112
+ # Minimum likes. Its aliases are minFaves, min_likes & min_faves.
2113
+ min_likes: nil,
2114
+ # Minimum retweets threshold.
2115
+ min_retweets: nil,
2116
+ # Minimum replies threshold.
2117
+ min_replies: nil,
2118
+ # Minimum quote count threshold.
2119
+ min_quotes: nil,
2120
+ # Minimum view count threshold.
2121
+ min_views: nil,
2122
+ # Minimum bookmark count threshold.
2123
+ min_bookmarks: nil,
2124
+ # Maximum likes threshold. maxLikes & max_likes also work.
2125
+ max_faves: nil,
2126
+ # Maximum retweets threshold.
2127
+ max_retweets: nil,
2128
+ # Maximum replies threshold.
2129
+ max_replies: nil,
2130
+ # Maximum quotes threshold.
2131
+ max_quotes: nil,
2132
+ # Only return tweets from Blue-verified authors.
2133
+ blue_verified_only: nil,
2134
+ # Return Tweets whose IDs exceed this ID. Searches accept `since_id` & `max_id`
2135
+ # bounds.
2136
+ since_id: nil,
2137
+ # Return Tweets at or below this ID.
2138
+ max_id: nil,
2139
+ # Keeps Tweets from a recent window, such as 90m or 7d. Use a whole number & s, m,
2140
+ # h or d.
2141
+ within_time: nil,
2142
+ # Only return native reposts.
2143
+ native_retweets: nil,
2144
+ # Only return tweets from verified authors.
2145
+ verified_only: nil,
2146
+ # Reply mode. Exclude keeps own-thread replies.
2147
+ replies: nil,
2148
+ # Only when the caller requests a repost mode.
2149
+ retweets: nil,
2150
+ # Only when the caller requests a quote mode.
2151
+ quotes: nil,
2152
+ # Match this exact phrase, word for word.
2153
+ exact_phrase: nil,
2154
+ # Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
2155
+ exclude_words: nil,
2156
+ # Words or quoted phrases where any one can match. Separate with spaces, commas,
2157
+ # or lines.
2158
+ any_words: nil,
2159
+ # Hashtags separated by spaces, commas, or lines.
2160
+ hashtags: nil,
2161
+ # Cashtags separated by spaces, commas, or lines.
2162
+ cashtags: nil,
2163
+ # URL substring or domain filter.
2164
+ url: nil,
2165
+ # Conversation ID filter.
2166
+ conversation_id: nil,
2167
+ # Only replies to this tweet ID.
2168
+ in_reply_to_tweet_id: nil,
2169
+ # Only quotes of this tweet ID.
2170
+ quotes_of_tweet_id: nil,
2171
+ # Only retweets of this tweet ID.
2172
+ retweets_of_tweet_id: nil,
2173
+ # Fields to keep in each row, comma-separated. Use dots for nested fields, such as
2174
+ # author.username. A list keeps the field in each item. Case & underscores do not
2175
+ # matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics
2176
+ # always stay. An unknown name answers 400 unknown_field with the valid names,
2177
+ # before any read. The price stays the same. SDK row types then hold only the
2178
+ # named fields. A longer URL fails at the edge before Xquik reads it. Pick only
2179
+ # the fields you need with `fields` & `omit`.
2180
+ fields: nil,
2181
+ # Fields to drop from each row, comma-separated. It takes the same names as
2182
+ # fields. With fields, it drops from the kept fields. A longer URL fails at the
2183
+ # edge before Xquik reads it.
2184
+ omit: nil,
2185
+ request_options: {}
2186
+ )
2187
+ end
2188
+
2189
+ # Returns engagement insights for 1 profile. They are engagement rate, averages
2190
+ # per post and posting rate, from its counts and its most recent posts. It reads
2191
+ # 20 posts unless limit names another number. Reposts and the pinned post stay out
2192
+ # of the averages. Each report costs 1 credit, whatever it reads.
2193
+ sig do
2194
+ params(
2195
+ id: String,
2196
+ limit: Integer,
2197
+ fields: String,
2198
+ omit: String,
2199
+ request_options: XTwitterScraper::RequestOptions::OrHash
2200
+ ).returns(XTwitterScraper::Models::X::UserRetrieveInsightsResponse)
2201
+ end
2202
+ def retrieve_insights(
2203
+ # User ID, username with or without @, or URL-encoded profile URL, such as
2204
+ # x.com/nasa or x.com/i/user/11348282. A number is a user ID. Writes look up a
2205
+ # username's ID before sending. Anything else gets 400 `invalid_user_id`.
2206
+ id,
2207
+ # Recent posts to read for the averages and rates. The read stops at this count,
2208
+ # at the account's oldest post or after about 40 seconds. `sample.read` says how
2209
+ # many it read, and `sample.posts` how many of those the averages used.
2210
+ # `pageSize`, `count`, `max_results`, `maxItems`, `max_items` & `per_page` are
2211
+ # accepted aliases.
2212
+ limit: nil,
2213
+ # Fields to keep in each row, comma-separated. Use dots for nested fields, such as
2214
+ # author.username. A list keeps the field in each item. Case & underscores do not
2215
+ # matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics
2216
+ # always stay. An unknown name answers 400 unknown_field with the valid names,
2217
+ # before any read. The price stays the same. SDK row types then hold only the
2218
+ # named fields. A longer URL fails at the edge before Xquik reads it. Pick only
2219
+ # the fields you need with `fields` & `omit`.
2220
+ fields: nil,
2221
+ # Fields to drop from each row, comma-separated. It takes the same names as
2222
+ # fields. With fields, it drops from the kept fields. A longer URL fails at the
2223
+ # edge before Xquik reads it.
2224
+ omit: nil,
2225
+ request_options: {}
2226
+ )
2227
+ end
2228
+
2229
+ # Returns the public X Lists that include the selected user, as the profile's List
2230
+ # memberships page shows them. Each List costs 1 credit. A protected account
2231
+ # answers 403.
2232
+ sig do
2233
+ params(
2234
+ id: String,
2235
+ cursor: String,
2236
+ page_size: Integer,
2237
+ fields: String,
2238
+ omit: String,
2239
+ request_options: XTwitterScraper::RequestOptions::OrHash
2240
+ ).returns(XTwitterScraper::Models::PaginatedLists)
2241
+ end
2242
+ def retrieve_list_memberships(
2243
+ id,
2244
+ # Pagination cursor for collection results. Also read as next_cursor, next_token,
2245
+ # pagination_token or continuation_token.
2246
+ cursor: nil,
2247
+ # Items per page. A page holds up to 10,000, so a larger pageSize gets the largest
2248
+ # page. Default 20. Source, filters or credits can return fewer. Follow
2249
+ # next_cursor for more pages. Its aliases are limit, count, max_results, maxItems,
2250
+ # max_items & per_page.
2251
+ page_size: nil,
2252
+ # Fields to keep in each row, comma-separated. Use dots for nested fields, such as
2253
+ # author.username. A list keeps the field in each item. Case & underscores do not
2254
+ # matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics
2255
+ # always stay. An unknown name answers 400 unknown_field with the valid names,
2256
+ # before any read. The price stays the same. SDK row types then hold only the
2257
+ # named fields. A longer URL fails at the edge before Xquik reads it. Pick only
2258
+ # the fields you need with `fields` & `omit`.
2259
+ fields: nil,
2260
+ # Fields to drop from each row, comma-separated. It takes the same names as
2261
+ # fields. With fields, it drops from the kept fields. A longer URL fails at the
2262
+ # edge before Xquik reads it.
2263
+ omit: nil,
2264
+ request_options: {}
2265
+ )
2266
+ end
2267
+
2268
+ # Returns the public X Lists the selected user created, in X's order, as the
2269
+ # profile's Lists tab shows them. Each List costs 1 credit. A protected account
2270
+ # answers 403.
2271
+ sig do
2272
+ params(
2273
+ id: String,
2274
+ cursor: String,
2275
+ page_size: Integer,
2276
+ fields: String,
2277
+ omit: String,
2278
+ request_options: XTwitterScraper::RequestOptions::OrHash
2279
+ ).returns(XTwitterScraper::Models::PaginatedLists)
2280
+ end
2281
+ def retrieve_lists(
2282
+ id,
2283
+ # Pagination cursor for collection results. Also read as next_cursor, next_token,
2284
+ # pagination_token or continuation_token.
2285
+ cursor: nil,
2286
+ # Items per page. A page holds up to 10,000, so a larger pageSize gets the largest
2287
+ # page. Default 20. Source, filters or credits can return fewer. Follow
2288
+ # next_cursor for more pages. Its aliases are limit, count, max_results, maxItems,
2289
+ # max_items & per_page.
2290
+ page_size: nil,
2291
+ # Fields to keep in each row, comma-separated. Use dots for nested fields, such as
2292
+ # author.username. A list keeps the field in each item. Case & underscores do not
2293
+ # matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics
2294
+ # always stay. An unknown name answers 400 unknown_field with the valid names,
2295
+ # before any read. The price stays the same. SDK row types then hold only the
2296
+ # named fields. A longer URL fails at the edge before Xquik reads it. Pick only
2297
+ # the fields you need with `fields` & `omit`.
2298
+ fields: nil,
2299
+ # Fields to drop from each row, comma-separated. It takes the same names as
2300
+ # fields. With fields, it drops from the kept fields. A longer URL fails at the
2301
+ # edge before Xquik reads it.
2302
+ omit: nil,
2303
+ request_options: {}
2304
+ )
2305
+ end
2306
+
2307
+ # Says whether 1 user is broadcasting live video on X right now, with their latest
2308
+ # broadcast, live or ended. Each check costs 1 credit.
2309
+ sig do
2310
+ params(
2311
+ id: String,
2312
+ fields: String,
2313
+ omit: String,
2314
+ request_options: XTwitterScraper::RequestOptions::OrHash
2315
+ ).returns(XTwitterScraper::Models::UserLiveStatus)
2316
+ end
2317
+ def retrieve_live(
2318
+ # User ID, username with or without @, or URL-encoded profile URL, such as
2319
+ # x.com/nasa or x.com/i/user/11348282. A number is a user ID. Writes look up a
2320
+ # username's ID before sending. Anything else gets 400 `invalid_user_id`.
2321
+ id,
2322
+ # Fields to keep in each row, comma-separated. Use dots for nested fields, such as
2323
+ # author.username. A list keeps the field in each item. Case & underscores do not
2324
+ # matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics
2325
+ # always stay. An unknown name answers 400 unknown_field with the valid names,
2326
+ # before any read. The price stays the same. SDK row types then hold only the
2327
+ # named fields. A longer URL fails at the edge before Xquik reads it. Pick only
2328
+ # the fields you need with `fields` & `omit`.
2329
+ fields: nil,
2330
+ # Fields to drop from each row, comma-separated. It takes the same names as
2331
+ # fields. With fields, it drops from the kept fields. A longer URL fails at the
2332
+ # edge before Xquik reads it.
2333
+ omit: nil,
2334
+ request_options: {}
2335
+ )
2336
+ end
2337
+
2338
+ # Checks 1 X account for a search ban, a search suggestion ban, reply deboosting &
2339
+ # a reply lock. It also tests timeline visibility & early engagement, reads the
2340
+ # sensitive flag & the countries that withhold the account, and says if the
2341
+ # account is active, protected or suspended. Each check answers pass, fail or
2342
+ # unknown, with its reason & what it read. `overall` sums up the checks, and
2343
+ # `checkedAt` holds the time of the check. The reply checks and the engagement
2344
+ # check answer pass or unknown, since X ranks replies for each viewer and a drop
2345
+ # alone proves nothing. A protected account skips the checks that need public
2346
+ # posts, and a suspended account gets the account check only. Each profile, post,
2347
+ # suggestion & reply in the answer costs 1 credit. The timeline, engagement &
2348
+ # reply checks read the account's 20 most recent posts unless `limit` names
2349
+ # another number. Shadowban checks show if X search lists an account, with each
2350
+ # post they read.
2351
+ sig do
2352
+ params(
2353
+ id: String,
2354
+ limit: Integer,
2355
+ fields: String,
2356
+ omit: String,
2357
+ request_options: XTwitterScraper::RequestOptions::OrHash
2358
+ ).returns(XTwitterScraper::Models::ShadowbanReport)
2359
+ end
2360
+ def retrieve_shadowban(
2361
+ # User ID, username with or without @, or URL-encoded profile URL, such as
2362
+ # x.com/nasa or x.com/i/user/11348282. A number is a user ID. Writes look up a
2363
+ # username's ID before sending. Anything else gets 400 `invalid_user_id`.
2364
+ id,
2365
+ # Recent posts to read for the timeline, engagement & reply checks. The read stops
2366
+ # at this count, at the account's oldest post or after about 40 seconds.
2367
+ # `pageSize`, `count`, `max_results`, `maxItems`, `max_items` & `per_page` are
2368
+ # accepted aliases.
2369
+ limit: nil,
2370
+ # Fields to keep in each row, comma-separated. Use dots for nested fields, such as
2371
+ # author.username. A list keeps the field in each item. Case & underscores do not
2372
+ # matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics
2373
+ # always stay. An unknown name answers 400 unknown_field with the valid names,
2374
+ # before any read. The price stays the same. SDK row types then hold only the
2375
+ # named fields. A longer URL fails at the edge before Xquik reads it. Pick only
2376
+ # the fields you need with `fields` & `omit`.
2377
+ fields: nil,
2378
+ # Fields to drop from each row, comma-separated. It takes the same names as
2379
+ # fields. With fields, it drops from the kept fields. A longer URL fails at the
2380
+ # edge before Xquik reads it.
2381
+ omit: nil,
2382
+ request_options: {}
2383
+ )
2384
+ end
2385
+
2386
+ # Returns the public accounts X lists as similar to the selected user, in X's
2387
+ # order. Each account costs 1 credit. Similar-account lists come back fuller.
2388
+ sig do
2389
+ params(
2390
+ id: String,
2391
+ cursor: String,
2392
+ page_size: Integer,
2393
+ min_followers: Integer,
2394
+ max_followers: Integer,
2395
+ min_following: Integer,
2396
+ max_following: Integer,
2397
+ min_statuses: Integer,
2398
+ max_statuses: Integer,
2399
+ min_account_age_days: Integer,
2400
+ verified_only: T::Boolean,
2401
+ blue_verified_only: T::Boolean,
2402
+ verified_type: String,
2403
+ has_website: T::Boolean,
2404
+ has_location: T::Boolean,
2405
+ has_email: T::Boolean,
2406
+ business_email_only: T::Boolean,
2407
+ email_domains: String,
2408
+ bio_contains: String,
2409
+ location_contains: String,
2410
+ username_contains: String,
2411
+ fields: String,
2412
+ omit: String,
2413
+ request_options: XTwitterScraper::RequestOptions::OrHash
2414
+ ).returns(XTwitterScraper::Models::PaginatedUsers)
2415
+ end
2416
+ def retrieve_similar(
2417
+ id,
2418
+ # Pagination cursor for collection results. Also read as next_cursor, next_token,
2419
+ # pagination_token or continuation_token.
2420
+ cursor: nil,
2421
+ # Profiles to request from this page. A page holds up to 10,000, so a larger
2422
+ # pageSize gets the largest page. Default 200. Source, filters or credits can
2423
+ # return fewer. Follow next_cursor for more pages. Its aliases are limit, count,
2424
+ # max_results, maxItems, max_items & per_page.
2425
+ page_size: nil,
2426
+ # Minimum follower count. Profiles the filter drops cost nothing.
2427
+ min_followers: nil,
2428
+ # Maximum follower count. A profile without a count passes.
2429
+ max_followers: nil,
2430
+ # Profiles must follow at least this many accounts.
2431
+ min_following: nil,
2432
+ # Profiles may follow at most this many accounts.
2433
+ max_following: nil,
2434
+ # Minimum post count. minPosts is also accepted.
2435
+ min_statuses: nil,
2436
+ # Maximum post count. maxPosts is also accepted.
2437
+ max_statuses: nil,
2438
+ # Minimum account age in whole days.
2439
+ min_account_age_days: nil,
2440
+ # Only return verified profiles.
2441
+ verified_only: nil,
2442
+ # Only return profiles X marks as blue verified. X marks many business &
2443
+ # government accounts blue too. Use verifiedType for 1 badge type.
2444
+ blue_verified_only: nil,
2445
+ # Match the verification type exactly, ignoring case.
2446
+ verified_type: nil,
2447
+ # Only return profiles with a website.
2448
+ has_website: nil,
2449
+ # Only return profiles with a location.
2450
+ has_location: nil,
2451
+ # Only return profiles that publish an email.
2452
+ has_email: nil,
2453
+ # Only return profiles that publish an email outside free webmail, such as Gmail.
2454
+ business_email_only: nil,
2455
+ # Only return profiles with an email at one of these domains. Separate domains
2456
+ # with commas. Subdomains match.
2457
+ email_domains: nil,
2458
+ # Match any comma-separated or line-separated bio term, ignoring case.
2459
+ bio_contains: nil,
2460
+ # Match a location substring, ignoring case.
2461
+ location_contains: nil,
2462
+ # Match a username substring, ignoring case.
2463
+ username_contains: nil,
2464
+ # Fields to keep in each row, comma-separated. Use dots for nested fields, such as
2465
+ # author.username. A list keeps the field in each item. Case & underscores do not
2466
+ # matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics
2467
+ # always stay. An unknown name answers 400 unknown_field with the valid names,
2468
+ # before any read. The price stays the same. SDK row types then hold only the
2469
+ # named fields. A longer URL fails at the edge before Xquik reads it. Pick only
2470
+ # the fields you need with `fields` & `omit`.
2471
+ fields: nil,
2472
+ # Fields to drop from each row, comma-separated. It takes the same names as
2473
+ # fields. With fields, it drops from the kept fields. A longer URL fails at the
2474
+ # edge before Xquik reads it.
2475
+ omit: nil,
2476
+ request_options: {}
2477
+ )
2478
+ end
2479
+
2480
+ # Returns the creators the selected user subscribes to, in X's order. An account
2481
+ # that hides its subscriptions returns an empty list.
2482
+ sig do
2483
+ params(
2484
+ id: String,
2485
+ cursor: String,
2486
+ page_size: Integer,
2487
+ min_followers: Integer,
2488
+ max_followers: Integer,
2489
+ min_following: Integer,
2490
+ max_following: Integer,
2491
+ min_statuses: Integer,
2492
+ max_statuses: Integer,
2493
+ min_account_age_days: Integer,
2494
+ verified_only: T::Boolean,
2495
+ blue_verified_only: T::Boolean,
2496
+ verified_type: String,
2497
+ has_website: T::Boolean,
2498
+ has_location: T::Boolean,
2499
+ has_email: T::Boolean,
2500
+ business_email_only: T::Boolean,
2501
+ email_domains: String,
2502
+ bio_contains: String,
2503
+ location_contains: String,
2504
+ username_contains: String,
2505
+ fields: String,
2506
+ omit: String,
2507
+ request_options: XTwitterScraper::RequestOptions::OrHash
2508
+ ).returns(XTwitterScraper::Models::PaginatedUsers)
2509
+ end
2510
+ def retrieve_subscriptions(
2511
+ id,
2512
+ # Pagination cursor for collection results. Also read as next_cursor, next_token,
2513
+ # pagination_token or continuation_token.
2514
+ cursor: nil,
2515
+ # Profiles to request from this page. A page holds up to 10,000, so a larger
2516
+ # pageSize gets the largest page. Default 200. Source, filters or credits can
2517
+ # return fewer. Follow next_cursor for more pages. Its aliases are limit, count,
2518
+ # max_results, maxItems, max_items & per_page.
2519
+ page_size: nil,
2520
+ # Minimum follower count. Profiles the filter drops cost nothing.
2521
+ min_followers: nil,
2522
+ # Maximum follower count. A profile without a count passes.
2523
+ max_followers: nil,
2524
+ # Profiles must follow at least this many accounts.
2525
+ min_following: nil,
2526
+ # Profiles may follow at most this many accounts.
2527
+ max_following: nil,
2528
+ # Minimum post count. minPosts is also accepted.
2529
+ min_statuses: nil,
2530
+ # Maximum post count. maxPosts is also accepted.
2531
+ max_statuses: nil,
2532
+ # Minimum account age in whole days.
2533
+ min_account_age_days: nil,
2534
+ # Only return verified profiles.
2535
+ verified_only: nil,
2536
+ # Only return profiles X marks as blue verified. X marks many business &
2537
+ # government accounts blue too. Use verifiedType for 1 badge type.
2538
+ blue_verified_only: nil,
2539
+ # Match the verification type exactly, ignoring case.
2540
+ verified_type: nil,
2541
+ # Only return profiles with a website.
2542
+ has_website: nil,
2543
+ # Only return profiles with a location.
2544
+ has_location: nil,
2545
+ # Only return profiles that publish an email.
2546
+ has_email: nil,
2547
+ # Only return profiles that publish an email outside free webmail, such as Gmail.
2548
+ business_email_only: nil,
2549
+ # Only return profiles with an email at one of these domains. Separate domains
2550
+ # with commas. Subdomains match.
2551
+ email_domains: nil,
2552
+ # Match any comma-separated or line-separated bio term, ignoring case.
2553
+ bio_contains: nil,
2554
+ # Match a location substring, ignoring case.
2555
+ location_contains: nil,
2556
+ # Match a username substring, ignoring case.
2557
+ username_contains: nil,
2558
+ # Fields to keep in each row, comma-separated. Use dots for nested fields, such as
2559
+ # author.username. A list keeps the field in each item. Case & underscores do not
2560
+ # matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics
2561
+ # always stay. An unknown name answers 400 unknown_field with the valid names,
2562
+ # before any read. The price stays the same. SDK row types then hold only the
2563
+ # named fields. A longer URL fails at the edge before Xquik reads it. Pick only
2564
+ # the fields you need with `fields` & `omit`.
2565
+ fields: nil,
2566
+ # Fields to drop from each row, comma-separated. It takes the same names as
2567
+ # fields. With fields, it drops from the kept fields. A longer URL fails at the
2568
+ # edge before Xquik reads it.
2569
+ omit: nil,
2570
+ request_options: {}
2571
+ )
2572
+ end
2573
+
2574
+ # Returns X's own translation of 1 profile's bio into the language you pick, with
2575
+ # the links, mentions, and tags X places in the translated text. A profile without
2576
+ # a bio returns translation null & a message, free of charge. Posts & bios can be
2577
+ # translated into your language.
2578
+ sig do
2579
+ params(
2580
+ id: String,
2581
+ language: String,
2582
+ fields: String,
2583
+ omit: String,
2584
+ request_options: XTwitterScraper::RequestOptions::OrHash
2585
+ ).returns(XTwitterScraper::Models::X::UserTranslateBioResponse)
2586
+ end
2587
+ def translate_bio(
2588
+ # User ID, username with or without @, or URL-encoded profile URL, such as
2589
+ # x.com/nasa or x.com/i/user/11348282. A number is a user ID. Writes look up a
2590
+ # username's ID before sending. Anything else gets 400 `invalid_user_id`.
2591
+ id,
2592
+ # Language code to translate into, such as `es`, `tr`, `pt-br`, or `zh-tw`. Upper
2593
+ # and lower case both work.
2594
+ language:,
2595
+ # Fields to keep in each row, comma-separated. Use dots for nested fields, such as
2596
+ # author.username. A list keeps the field in each item. Case & underscores do not
2597
+ # matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics
2598
+ # always stay. An unknown name answers 400 unknown_field with the valid names,
2599
+ # before any read. The price stays the same. SDK row types then hold only the
2600
+ # named fields. A longer URL fails at the edge before Xquik reads it. Pick only
2601
+ # the fields you need with `fields` & `omit`.
2602
+ fields: nil,
2603
+ # Fields to drop from each row, comma-separated. It takes the same names as
2604
+ # fields. With fields, it drops from the kept fields. A longer URL fails at the
2605
+ # edge before Xquik reads it.
2606
+ omit: nil,
2607
+ request_options: {}
2608
+ )
2609
+ end
2610
+
1645
2611
  # @api private
1646
2612
  sig do
1647
2613
  params(client: XTwitterScraper::Client).returns(T.attached_class)