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
  # @return [XTwitterScraper::Resources::X::Users::Follow]
13
13
  attr_reader :follow
14
14
 
15
+ # @return [XTwitterScraper::Resources::X::Users::Block]
16
+ attr_reader :block
17
+
18
+ # @return [XTwitterScraper::Resources::X::Users::Mute]
19
+ attr_reader :mute
20
+
15
21
  # Get user profile with follower counts & verification
16
22
  #
17
23
  # @overload retrieve(id, fields: nil, omit: nil, request_options: {})
@@ -1431,12 +1437,749 @@ module XTwitterScraper
1431
1437
  )
1432
1438
  end
1433
1439
 
1440
+ # Returns the newest posts of users named by user ID, username or profile link, in
1441
+ # the order named. Send ids or usernames, not both. Each post costs 1 credit. A
1442
+ # user in unavailable_ids or unprocessed_ids costs nothing.
1443
+ #
1444
+ # @overload retrieve_batch_tweets(ids: nil, usernames: nil, page_size: nil, fields: nil, omit: nil, request_options: {})
1445
+ #
1446
+ # @param ids [String] Comma-separated numeric IDs of the users to read posts from. Xquik reads any other entry as a username, with or without @, so IDs and usernames can mix. Xquik ignores duplicates and keeps the first-seen order, IDs before usernames. A longer URL fails at the edge before Xquik reads it.
1447
+ #
1448
+ # @param usernames [String] Comma-separated X usernames, with or without @, or profile links such as x.com/nasa, in place of ids. A name in another case is the same account. A number is a user ID. A longer URL fails at the edge before Xquik reads it.
1449
+ #
1450
+ # @param page_size [Integer] Posts per user (1-300, default 20). A low credit balance can return fewer. Its aliases are limit, count, max_results, maxItems, max_items & per_page.
1451
+ #
1452
+ # @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
1453
+ #
1454
+ # @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
1455
+ #
1456
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
1457
+ #
1458
+ # @return [XTwitterScraper::Models::BatchUserTweets]
1459
+ #
1460
+ # @see XTwitterScraper::Models::X::UserRetrieveBatchTweetsParams
1461
+ def retrieve_batch_tweets(params = {})
1462
+ parsed, options = XTwitterScraper::Models::X::UserRetrieveBatchTweetsParams.dump_request(params)
1463
+ query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
1464
+ @client.request(
1465
+ method: :get,
1466
+ path: "x/users/batch/tweets",
1467
+ query: query,
1468
+ model: XTwitterScraper::Models::BatchUserTweets,
1469
+ options: options
1470
+ )
1471
+ end
1472
+
1473
+ # Returns the accounts an organization lists as its affiliates, in X's order. An
1474
+ # account without affiliates returns an empty list.
1475
+ #
1476
+ # @overload retrieve_affiliates(id, cursor: nil, page_size: nil, min_followers: nil, max_followers: nil, min_following: nil, max_following: nil, min_statuses: nil, max_statuses: nil, min_account_age_days: nil, verified_only: nil, blue_verified_only: nil, verified_type: nil, has_website: nil, has_location: nil, has_email: nil, business_email_only: nil, email_domains: nil, bio_contains: nil, location_contains: nil, username_contains: nil, fields: nil, omit: nil, request_options: {})
1477
+ #
1478
+ # @param id [String]
1479
+ #
1480
+ # @param cursor [String] Pagination cursor for collection results. Also read as next_cursor, next_token, pagination_token or continuation_token.
1481
+ #
1482
+ # @param page_size [Integer] Profiles to request from this page. A page holds up to 10,000, so a larger pageSize gets the largest page. Default 200. Source, filters or credits can return fewer. Follow next_cursor for more pages. Its aliases are limit, count, max_results, maxItems, max_items & per_page.
1483
+ #
1484
+ # @param min_followers [Integer] Minimum follower count. Profiles the filter drops cost nothing.
1485
+ #
1486
+ # @param max_followers [Integer] Maximum follower count. A profile without a count passes.
1487
+ #
1488
+ # @param min_following [Integer] Profiles must follow at least this many accounts.
1489
+ #
1490
+ # @param max_following [Integer] Profiles may follow at most this many accounts.
1491
+ #
1492
+ # @param min_statuses [Integer] Minimum post count. minPosts is also accepted.
1493
+ #
1494
+ # @param max_statuses [Integer] Maximum post count. maxPosts is also accepted.
1495
+ #
1496
+ # @param min_account_age_days [Integer] Minimum account age in whole days.
1497
+ #
1498
+ # @param verified_only [Boolean] Only return verified profiles.
1499
+ #
1500
+ # @param blue_verified_only [Boolean] Only return profiles X marks as blue verified. X marks many business & government accounts blue too. Use verifiedType for 1 badge type.
1501
+ #
1502
+ # @param verified_type [String] Match the verification type exactly, ignoring case.
1503
+ #
1504
+ # @param has_website [Boolean] Only return profiles with a website.
1505
+ #
1506
+ # @param has_location [Boolean] Only return profiles with a location.
1507
+ #
1508
+ # @param has_email [Boolean] Only return profiles that publish an email.
1509
+ #
1510
+ # @param business_email_only [Boolean] Only return profiles that publish an email outside free webmail, such as Gmail.
1511
+ #
1512
+ # @param email_domains [String] Only return profiles with an email at one of these domains. Separate domains with commas. Subdomains match.
1513
+ #
1514
+ # @param bio_contains [String] Match any comma-separated or line-separated bio term, ignoring case.
1515
+ #
1516
+ # @param location_contains [String] Match a location substring, ignoring case.
1517
+ #
1518
+ # @param username_contains [String] Match a username substring, ignoring case.
1519
+ #
1520
+ # @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
1521
+ #
1522
+ # @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
1523
+ #
1524
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
1525
+ #
1526
+ # @return [XTwitterScraper::Models::PaginatedUsers]
1527
+ #
1528
+ # @see XTwitterScraper::Models::X::UserRetrieveAffiliatesParams
1529
+ def retrieve_affiliates(id, params = {})
1530
+ parsed, options = XTwitterScraper::Models::X::UserRetrieveAffiliatesParams.dump_request(params)
1531
+ query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
1532
+ @client.request(
1533
+ method: :get,
1534
+ path: ["x/users/%1$s/affiliates", id],
1535
+ query: query,
1536
+ model: XTwitterScraper::Models::PaginatedUsers,
1537
+ options: options
1538
+ )
1539
+ end
1540
+
1541
+ # Returns the posts on the user's Articles tab, newest first. Each post's
1542
+ # `article` holds the Article's ID, title, preview, cover & dates. Read the full
1543
+ # text with GET /x/articles/{tweetId}.
1544
+ #
1545
+ # @overload retrieve_articles(id, cursor: nil, page_size: nil, from_user: nil, to_user: nil, mentioning: nil, language: nil, since_date: nil, until_date: nil, media_type: nil, min_likes: nil, min_retweets: nil, min_replies: nil, min_quotes: nil, min_views: nil, min_bookmarks: nil, max_faves: nil, max_retweets: nil, max_replies: nil, max_quotes: nil, blue_verified_only: nil, since_id: nil, max_id: nil, within_time: nil, native_retweets: nil, verified_only: nil, replies: nil, retweets: nil, quotes: nil, exact_phrase: nil, exclude_words: nil, any_words: nil, hashtags: nil, cashtags: nil, url: nil, conversation_id: nil, in_reply_to_tweet_id: nil, quotes_of_tweet_id: nil, retweets_of_tweet_id: nil, fields: nil, omit: nil, request_options: {})
1546
+ #
1547
+ # @param id [String]
1548
+ #
1549
+ # @param cursor [String] Pagination cursor for collection results. Also read as next_cursor, next_token, pagination_token or continuation_token.
1550
+ #
1551
+ # @param page_size [Integer] Items per page. A page holds up to 10,000, so a larger pageSize gets the largest page. Default 20. Source, filters or credits can return fewer. Follow next_cursor for more pages. Its aliases are limit, count, max_results, maxItems, max_items & per_page.
1552
+ #
1553
+ # @param from_user [String] Filter by author username. Account searches include all of the account's posts & reposts.
1554
+ #
1555
+ # @param to_user [String] Filter replies sent to a username.
1556
+ #
1557
+ # @param mentioning [String] Filter tweets mentioning a username.
1558
+ #
1559
+ # @param language [String] Filter by language. Its alias is `lang`. Language filters work for every language X tags.
1560
+ #
1561
+ # @param since_date [Date] Start date in YYYY-MM-DD format, as a UTC day. A date means one thing in any common form.
1562
+ #
1563
+ # @param until_date [Date] End date in YYYY-MM-DD format, as a UTC day, inclusive, so its own posts count.
1564
+ #
1565
+ # @param media_type [Symbol, XTwitterScraper::Models::X::UserRetrieveArticlesParams::MediaType] Filter media. Its aliases are has_video & has_media.
1566
+ #
1567
+ # @param min_likes [Integer] Minimum likes. Its aliases are minFaves, min_likes & min_faves.
1568
+ #
1569
+ # @param min_retweets [Integer] Minimum retweets threshold.
1570
+ #
1571
+ # @param min_replies [Integer] Minimum replies threshold.
1572
+ #
1573
+ # @param min_quotes [Integer] Minimum quote count threshold.
1574
+ #
1575
+ # @param min_views [Integer] Minimum view count threshold.
1576
+ #
1577
+ # @param min_bookmarks [Integer] Minimum bookmark count threshold.
1578
+ #
1579
+ # @param max_faves [Integer] Maximum likes threshold. maxLikes & max_likes also work.
1580
+ #
1581
+ # @param max_retweets [Integer] Maximum retweets threshold.
1582
+ #
1583
+ # @param max_replies [Integer] Maximum replies threshold.
1584
+ #
1585
+ # @param max_quotes [Integer] Maximum quotes threshold.
1586
+ #
1587
+ # @param blue_verified_only [Boolean] Only return tweets from Blue-verified authors.
1588
+ #
1589
+ # @param since_id [String] Return Tweets whose IDs exceed this ID. Searches accept `since_id` & `max_id` bounds.
1590
+ #
1591
+ # @param max_id [String] Return Tweets at or below this ID.
1592
+ #
1593
+ # @param within_time [String] Keeps Tweets from a recent window, such as 90m or 7d. Use a whole number & s, m, h or d.
1594
+ #
1595
+ # @param native_retweets [Boolean] Only return native reposts.
1596
+ #
1597
+ # @param verified_only [Boolean] Only return tweets from verified authors.
1598
+ #
1599
+ # @param replies [Symbol, XTwitterScraper::Models::X::UserRetrieveArticlesParams::Replies] Reply mode. Exclude keeps own-thread replies.
1600
+ #
1601
+ # @param retweets [Symbol, XTwitterScraper::Models::X::UserRetrieveArticlesParams::Retweets] Only when the caller requests a repost mode.
1602
+ #
1603
+ # @param quotes [Symbol, XTwitterScraper::Models::X::UserRetrieveArticlesParams::Quotes] Only when the caller requests a quote mode.
1604
+ #
1605
+ # @param exact_phrase [String] Match this exact phrase, word for word.
1606
+ #
1607
+ # @param exclude_words [String] Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
1608
+ #
1609
+ # @param any_words [String] Words or quoted phrases where any one can match. Separate with spaces, commas, or lines.
1610
+ #
1611
+ # @param hashtags [String] Hashtags separated by spaces, commas, or lines.
1612
+ #
1613
+ # @param cashtags [String] Cashtags separated by spaces, commas, or lines.
1614
+ #
1615
+ # @param url [String] URL substring or domain filter.
1616
+ #
1617
+ # @param conversation_id [String] Conversation ID filter.
1618
+ #
1619
+ # @param in_reply_to_tweet_id [String] Only replies to this tweet ID.
1620
+ #
1621
+ # @param quotes_of_tweet_id [String] Only quotes of this tweet ID.
1622
+ #
1623
+ # @param retweets_of_tweet_id [String] Only retweets of this tweet ID.
1624
+ #
1625
+ # @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
1626
+ #
1627
+ # @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
1628
+ #
1629
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
1630
+ #
1631
+ # @return [XTwitterScraper::Models::PaginatedTweets]
1632
+ #
1633
+ # @see XTwitterScraper::Models::X::UserRetrieveArticlesParams
1634
+ def retrieve_articles(id, params = {})
1635
+ parsed, options = XTwitterScraper::Models::X::UserRetrieveArticlesParams.dump_request(params)
1636
+ query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
1637
+ @client.request(
1638
+ method: :get,
1639
+ path: ["x/users/%1$s/articles", id],
1640
+ query: query,
1641
+ model: XTwitterScraper::Models::PaginatedTweets,
1642
+ options: options
1643
+ )
1644
+ end
1645
+
1646
+ # Reads the newest followers of a public account & returns a follower audit. It
1647
+ # gives each follower 1 class with its score & signals, then adds coverage, a
1648
+ # quality score, signal counts, arrival bands, join cohorts, countries, top
1649
+ # followers & the account's engagement. Each follower read costs 1 credit, and the
1650
+ # engagement adds 1 credit. Signals come from public profiles, so a real person
1651
+ # can match. Older followers may differ from the newest ones.
1652
+ #
1653
+ # @overload retrieve_follower_audit(id, limit: nil, fields: nil, omit: nil, request_options: {})
1654
+ #
1655
+ # @param id [String] User ID, username with or without @, or URL-encoded profile URL, such as x.com/nasa or x.com/i/user/11348282. A number is a user ID. Writes look up a username's ID before sending. Anything else gets 400 `invalid_user_id`.
1656
+ #
1657
+ # @param limit [Integer] Most followers to read, newest first. Left out, a read takes up to 200 and a low balance reads fewer. A very long read returns what it finished, & coverage shows how many. Its aliases are pageSize, count, max_results, maxItems, max_items & per_page.
1658
+ #
1659
+ # @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
1660
+ #
1661
+ # @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
1662
+ #
1663
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
1664
+ #
1665
+ # @return [XTwitterScraper::Models::X::UserRetrieveFollowerAuditResponse]
1666
+ #
1667
+ # @see XTwitterScraper::Models::X::UserRetrieveFollowerAuditParams
1668
+ def retrieve_follower_audit(id, params = {})
1669
+ parsed, options = XTwitterScraper::Models::X::UserRetrieveFollowerAuditParams.dump_request(params)
1670
+ query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
1671
+ @client.request(
1672
+ method: :get,
1673
+ path: ["x/users/%1$s/follower-audit", id],
1674
+ query: query,
1675
+ model: XTwitterScraper::Models::X::UserRetrieveFollowerAuditResponse,
1676
+ options: options
1677
+ )
1678
+ end
1679
+
1680
+ # Returns the user IDs of the selected user's followers, newest first, up to 5,000
1681
+ # a page. Use it when you need IDs only. Each ID costs 1 credit.
1682
+ #
1683
+ # @overload retrieve_follower_ids(id, cursor: nil, page_size: nil, request_options: {})
1684
+ #
1685
+ # @param id [String]
1686
+ #
1687
+ # @param cursor [String] Pagination cursor for collection results. Also read as next_cursor, next_token, pagination_token or continuation_token.
1688
+ #
1689
+ # @param page_size [Integer] User IDs to request from this page (1-5000, default 5000). A low credit balance can return fewer. Follow next_cursor for more pages. Its aliases are limit, count, max_results, maxItems, max_items & per_page.
1690
+ #
1691
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
1692
+ #
1693
+ # @return [XTwitterScraper::Models::PaginatedUserIds]
1694
+ #
1695
+ # @see XTwitterScraper::Models::X::UserRetrieveFollowerIdsParams
1696
+ def retrieve_follower_ids(id, params = {})
1697
+ parsed, options = XTwitterScraper::Models::X::UserRetrieveFollowerIdsParams.dump_request(params)
1698
+ query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
1699
+ @client.request(
1700
+ method: :get,
1701
+ path: ["x/users/%1$s/follower-ids", id],
1702
+ query: query,
1703
+ model: XTwitterScraper::Models::PaginatedUserIds,
1704
+ options: options
1705
+ )
1706
+ end
1707
+
1708
+ # Returns the user IDs of the accounts the selected user follows, newest first, up
1709
+ # to 5,000 a page. Use it when you need IDs only. Each ID costs 1 credit.
1710
+ #
1711
+ # @overload retrieve_following_ids(id, cursor: nil, page_size: nil, request_options: {})
1712
+ #
1713
+ # @param id [String]
1714
+ #
1715
+ # @param cursor [String] Pagination cursor for collection results. Also read as next_cursor, next_token, pagination_token or continuation_token.
1716
+ #
1717
+ # @param page_size [Integer] User IDs to request from this page (1-5000, default 5000). A low credit balance can return fewer. Follow next_cursor for more pages. Its aliases are limit, count, max_results, maxItems, max_items & per_page.
1718
+ #
1719
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
1720
+ #
1721
+ # @return [XTwitterScraper::Models::PaginatedUserIds]
1722
+ #
1723
+ # @see XTwitterScraper::Models::X::UserRetrieveFollowingIdsParams
1724
+ def retrieve_following_ids(id, params = {})
1725
+ parsed, options = XTwitterScraper::Models::X::UserRetrieveFollowingIdsParams.dump_request(params)
1726
+ query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
1727
+ @client.request(
1728
+ method: :get,
1729
+ path: ["x/users/%1$s/following-ids", id],
1730
+ query: query,
1731
+ model: XTwitterScraper::Models::PaginatedUserIds,
1732
+ options: options
1733
+ )
1734
+ end
1735
+
1736
+ # Returns the posts on the user's Highlights tab, in X's order. An account without
1737
+ # highlights returns an empty list.
1738
+ #
1739
+ # @overload retrieve_highlights(id, cursor: nil, page_size: nil, from_user: nil, to_user: nil, mentioning: nil, language: nil, since_date: nil, until_date: nil, media_type: nil, min_likes: nil, min_retweets: nil, min_replies: nil, min_quotes: nil, min_views: nil, min_bookmarks: nil, max_faves: nil, max_retweets: nil, max_replies: nil, max_quotes: nil, blue_verified_only: nil, since_id: nil, max_id: nil, within_time: nil, native_retweets: nil, verified_only: nil, replies: nil, retweets: nil, quotes: nil, exact_phrase: nil, exclude_words: nil, any_words: nil, hashtags: nil, cashtags: nil, url: nil, conversation_id: nil, in_reply_to_tweet_id: nil, quotes_of_tweet_id: nil, retweets_of_tweet_id: nil, fields: nil, omit: nil, request_options: {})
1740
+ #
1741
+ # @param id [String]
1742
+ #
1743
+ # @param cursor [String] Pagination cursor for collection results. Also read as next_cursor, next_token, pagination_token or continuation_token.
1744
+ #
1745
+ # @param page_size [Integer] Items per page. A page holds up to 10,000, so a larger pageSize gets the largest page. Default 20. Source, filters or credits can return fewer. Follow next_cursor for more pages. Its aliases are limit, count, max_results, maxItems, max_items & per_page.
1746
+ #
1747
+ # @param from_user [String] Filter by author username. Account searches include all of the account's posts & reposts.
1748
+ #
1749
+ # @param to_user [String] Filter replies sent to a username.
1750
+ #
1751
+ # @param mentioning [String] Filter tweets mentioning a username.
1752
+ #
1753
+ # @param language [String] Filter by language. Its alias is `lang`. Language filters work for every language X tags.
1754
+ #
1755
+ # @param since_date [Date] Start date in YYYY-MM-DD format, as a UTC day. A date means one thing in any common form.
1756
+ #
1757
+ # @param until_date [Date] End date in YYYY-MM-DD format, as a UTC day, inclusive, so its own posts count.
1758
+ #
1759
+ # @param media_type [Symbol, XTwitterScraper::Models::X::UserRetrieveHighlightsParams::MediaType] Filter media. Its aliases are has_video & has_media.
1760
+ #
1761
+ # @param min_likes [Integer] Minimum likes. Its aliases are minFaves, min_likes & min_faves.
1762
+ #
1763
+ # @param min_retweets [Integer] Minimum retweets threshold.
1764
+ #
1765
+ # @param min_replies [Integer] Minimum replies threshold.
1766
+ #
1767
+ # @param min_quotes [Integer] Minimum quote count threshold.
1768
+ #
1769
+ # @param min_views [Integer] Minimum view count threshold.
1770
+ #
1771
+ # @param min_bookmarks [Integer] Minimum bookmark count threshold.
1772
+ #
1773
+ # @param max_faves [Integer] Maximum likes threshold. maxLikes & max_likes also work.
1774
+ #
1775
+ # @param max_retweets [Integer] Maximum retweets threshold.
1776
+ #
1777
+ # @param max_replies [Integer] Maximum replies threshold.
1778
+ #
1779
+ # @param max_quotes [Integer] Maximum quotes threshold.
1780
+ #
1781
+ # @param blue_verified_only [Boolean] Only return tweets from Blue-verified authors.
1782
+ #
1783
+ # @param since_id [String] Return Tweets whose IDs exceed this ID. Searches accept `since_id` & `max_id` bounds.
1784
+ #
1785
+ # @param max_id [String] Return Tweets at or below this ID.
1786
+ #
1787
+ # @param within_time [String] Keeps Tweets from a recent window, such as 90m or 7d. Use a whole number & s, m, h or d.
1788
+ #
1789
+ # @param native_retweets [Boolean] Only return native reposts.
1790
+ #
1791
+ # @param verified_only [Boolean] Only return tweets from verified authors.
1792
+ #
1793
+ # @param replies [Symbol, XTwitterScraper::Models::X::UserRetrieveHighlightsParams::Replies] Reply mode. Exclude keeps own-thread replies.
1794
+ #
1795
+ # @param retweets [Symbol, XTwitterScraper::Models::X::UserRetrieveHighlightsParams::Retweets] Only when the caller requests a repost mode.
1796
+ #
1797
+ # @param quotes [Symbol, XTwitterScraper::Models::X::UserRetrieveHighlightsParams::Quotes] Only when the caller requests a quote mode.
1798
+ #
1799
+ # @param exact_phrase [String] Match this exact phrase, word for word.
1800
+ #
1801
+ # @param exclude_words [String] Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
1802
+ #
1803
+ # @param any_words [String] Words or quoted phrases where any one can match. Separate with spaces, commas, or lines.
1804
+ #
1805
+ # @param hashtags [String] Hashtags separated by spaces, commas, or lines.
1806
+ #
1807
+ # @param cashtags [String] Cashtags separated by spaces, commas, or lines.
1808
+ #
1809
+ # @param url [String] URL substring or domain filter.
1810
+ #
1811
+ # @param conversation_id [String] Conversation ID filter.
1812
+ #
1813
+ # @param in_reply_to_tweet_id [String] Only replies to this tweet ID.
1814
+ #
1815
+ # @param quotes_of_tweet_id [String] Only quotes of this tweet ID.
1816
+ #
1817
+ # @param retweets_of_tweet_id [String] Only retweets of this tweet ID.
1818
+ #
1819
+ # @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
1820
+ #
1821
+ # @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
1822
+ #
1823
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
1824
+ #
1825
+ # @return [XTwitterScraper::Models::PaginatedTweets]
1826
+ #
1827
+ # @see XTwitterScraper::Models::X::UserRetrieveHighlightsParams
1828
+ def retrieve_highlights(id, params = {})
1829
+ parsed, options = XTwitterScraper::Models::X::UserRetrieveHighlightsParams.dump_request(params)
1830
+ query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
1831
+ @client.request(
1832
+ method: :get,
1833
+ path: ["x/users/%1$s/highlights", id],
1834
+ query: query,
1835
+ model: XTwitterScraper::Models::PaginatedTweets,
1836
+ options: options
1837
+ )
1838
+ end
1839
+
1840
+ # Returns engagement insights for 1 profile. They are engagement rate, averages
1841
+ # per post and posting rate, from its counts and its most recent posts. It reads
1842
+ # 20 posts unless limit names another number. Reposts and the pinned post stay out
1843
+ # of the averages. Each report costs 1 credit, whatever it reads.
1844
+ #
1845
+ # @overload retrieve_insights(id, limit: nil, fields: nil, omit: nil, request_options: {})
1846
+ #
1847
+ # @param id [String] User ID, username with or without @, or URL-encoded profile URL, such as x.com/nasa or x.com/i/user/11348282. A number is a user ID. Writes look up a username's ID before sending. Anything else gets 400 `invalid_user_id`.
1848
+ #
1849
+ # @param limit [Integer] Recent posts to read for the averages and rates. The read stops at this count, at the account's oldest post or after about 40 seconds. `sample.read` says how many it read, and `sample.posts` how many of those the averages used. `pageSize`, `count`, `max_results`, `maxItems`, `max_items` & `per_page` are accepted aliases.
1850
+ #
1851
+ # @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
1852
+ #
1853
+ # @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
1854
+ #
1855
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
1856
+ #
1857
+ # @return [XTwitterScraper::Models::X::UserRetrieveInsightsResponse]
1858
+ #
1859
+ # @see XTwitterScraper::Models::X::UserRetrieveInsightsParams
1860
+ def retrieve_insights(id, params = {})
1861
+ parsed, options = XTwitterScraper::Models::X::UserRetrieveInsightsParams.dump_request(params)
1862
+ query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
1863
+ @client.request(
1864
+ method: :get,
1865
+ path: ["x/users/%1$s/insights", id],
1866
+ query: query,
1867
+ model: XTwitterScraper::Models::X::UserRetrieveInsightsResponse,
1868
+ options: options
1869
+ )
1870
+ end
1871
+
1872
+ # Returns the public X Lists that include the selected user, as the profile's List
1873
+ # memberships page shows them. Each List costs 1 credit. A protected account
1874
+ # answers 403.
1875
+ #
1876
+ # @overload retrieve_list_memberships(id, cursor: nil, page_size: nil, fields: nil, omit: nil, request_options: {})
1877
+ #
1878
+ # @param id [String]
1879
+ #
1880
+ # @param cursor [String] Pagination cursor for collection results. Also read as next_cursor, next_token, pagination_token or continuation_token.
1881
+ #
1882
+ # @param page_size [Integer] Items per page. A page holds up to 10,000, so a larger pageSize gets the largest page. Default 20. Source, filters or credits can return fewer. Follow next_cursor for more pages. Its aliases are limit, count, max_results, maxItems, max_items & per_page.
1883
+ #
1884
+ # @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
1885
+ #
1886
+ # @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
1887
+ #
1888
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
1889
+ #
1890
+ # @return [XTwitterScraper::Models::PaginatedLists]
1891
+ #
1892
+ # @see XTwitterScraper::Models::X::UserRetrieveListMembershipsParams
1893
+ def retrieve_list_memberships(id, params = {})
1894
+ parsed, options = XTwitterScraper::Models::X::UserRetrieveListMembershipsParams.dump_request(params)
1895
+ query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
1896
+ @client.request(
1897
+ method: :get,
1898
+ path: ["x/users/%1$s/list-memberships", id],
1899
+ query: query,
1900
+ model: XTwitterScraper::Models::PaginatedLists,
1901
+ options: options
1902
+ )
1903
+ end
1904
+
1905
+ # Returns the public X Lists the selected user created, in X's order, as the
1906
+ # profile's Lists tab shows them. Each List costs 1 credit. A protected account
1907
+ # answers 403.
1908
+ #
1909
+ # @overload retrieve_lists(id, cursor: nil, page_size: nil, fields: nil, omit: nil, request_options: {})
1910
+ #
1911
+ # @param id [String]
1912
+ #
1913
+ # @param cursor [String] Pagination cursor for collection results. Also read as next_cursor, next_token, pagination_token or continuation_token.
1914
+ #
1915
+ # @param page_size [Integer] Items per page. A page holds up to 10,000, so a larger pageSize gets the largest page. Default 20. Source, filters or credits can return fewer. Follow next_cursor for more pages. Its aliases are limit, count, max_results, maxItems, max_items & per_page.
1916
+ #
1917
+ # @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
1918
+ #
1919
+ # @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
1920
+ #
1921
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
1922
+ #
1923
+ # @return [XTwitterScraper::Models::PaginatedLists]
1924
+ #
1925
+ # @see XTwitterScraper::Models::X::UserRetrieveListsParams
1926
+ def retrieve_lists(id, params = {})
1927
+ parsed, options = XTwitterScraper::Models::X::UserRetrieveListsParams.dump_request(params)
1928
+ query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
1929
+ @client.request(
1930
+ method: :get,
1931
+ path: ["x/users/%1$s/lists", id],
1932
+ query: query,
1933
+ model: XTwitterScraper::Models::PaginatedLists,
1934
+ options: options
1935
+ )
1936
+ end
1937
+
1938
+ # Says whether 1 user is broadcasting live video on X right now, with their latest
1939
+ # broadcast, live or ended. Each check costs 1 credit.
1940
+ #
1941
+ # @overload retrieve_live(id, fields: nil, omit: nil, request_options: {})
1942
+ #
1943
+ # @param id [String] User ID, username with or without @, or URL-encoded profile URL, such as x.com/nasa or x.com/i/user/11348282. A number is a user ID. Writes look up a username's ID before sending. Anything else gets 400 `invalid_user_id`.
1944
+ #
1945
+ # @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
1946
+ #
1947
+ # @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
1948
+ #
1949
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
1950
+ #
1951
+ # @return [XTwitterScraper::Models::UserLiveStatus]
1952
+ #
1953
+ # @see XTwitterScraper::Models::X::UserRetrieveLiveParams
1954
+ def retrieve_live(id, params = {})
1955
+ parsed, options = XTwitterScraper::Models::X::UserRetrieveLiveParams.dump_request(params)
1956
+ query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
1957
+ @client.request(
1958
+ method: :get,
1959
+ path: ["x/users/%1$s/live", id],
1960
+ query: query,
1961
+ model: XTwitterScraper::Models::UserLiveStatus,
1962
+ options: options
1963
+ )
1964
+ end
1965
+
1966
+ # Checks 1 X account for a search ban, a search suggestion ban, reply deboosting &
1967
+ # a reply lock. It also tests timeline visibility & early engagement, reads the
1968
+ # sensitive flag & the countries that withhold the account, and says if the
1969
+ # account is active, protected or suspended. Each check answers pass, fail or
1970
+ # unknown, with its reason & what it read. `overall` sums up the checks, and
1971
+ # `checkedAt` holds the time of the check. The reply checks and the engagement
1972
+ # check answer pass or unknown, since X ranks replies for each viewer and a drop
1973
+ # alone proves nothing. A protected account skips the checks that need public
1974
+ # posts, and a suspended account gets the account check only. Each profile, post,
1975
+ # suggestion & reply in the answer costs 1 credit. The timeline, engagement &
1976
+ # reply checks read the account's 20 most recent posts unless `limit` names
1977
+ # another number. Shadowban checks show if X search lists an account, with each
1978
+ # post they read.
1979
+ #
1980
+ # @overload retrieve_shadowban(id, limit: nil, fields: nil, omit: nil, request_options: {})
1981
+ #
1982
+ # @param id [String] User ID, username with or without @, or URL-encoded profile URL, such as x.com/nasa or x.com/i/user/11348282. A number is a user ID. Writes look up a username's ID before sending. Anything else gets 400 `invalid_user_id`.
1983
+ #
1984
+ # @param limit [Integer] Recent posts to read for the timeline, engagement & reply checks. The read stops at this count, at the account's oldest post or after about 40 seconds. `pageSize`, `count`, `max_results`, `maxItems`, `max_items` & `per_page` are accepted aliases.
1985
+ #
1986
+ # @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
1987
+ #
1988
+ # @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
1989
+ #
1990
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
1991
+ #
1992
+ # @return [XTwitterScraper::Models::ShadowbanReport]
1993
+ #
1994
+ # @see XTwitterScraper::Models::X::UserRetrieveShadowbanParams
1995
+ def retrieve_shadowban(id, params = {})
1996
+ parsed, options = XTwitterScraper::Models::X::UserRetrieveShadowbanParams.dump_request(params)
1997
+ query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
1998
+ @client.request(
1999
+ method: :get,
2000
+ path: ["x/users/%1$s/shadowban", id],
2001
+ query: query,
2002
+ model: XTwitterScraper::Models::ShadowbanReport,
2003
+ options: options
2004
+ )
2005
+ end
2006
+
2007
+ # Returns the public accounts X lists as similar to the selected user, in X's
2008
+ # order. Each account costs 1 credit. Similar-account lists come back fuller.
2009
+ #
2010
+ # @overload retrieve_similar(id, cursor: nil, page_size: nil, min_followers: nil, max_followers: nil, min_following: nil, max_following: nil, min_statuses: nil, max_statuses: nil, min_account_age_days: nil, verified_only: nil, blue_verified_only: nil, verified_type: nil, has_website: nil, has_location: nil, has_email: nil, business_email_only: nil, email_domains: nil, bio_contains: nil, location_contains: nil, username_contains: nil, fields: nil, omit: nil, request_options: {})
2011
+ #
2012
+ # @param id [String]
2013
+ #
2014
+ # @param cursor [String] Pagination cursor for collection results. Also read as next_cursor, next_token, pagination_token or continuation_token.
2015
+ #
2016
+ # @param page_size [Integer] Profiles to request from this page. A page holds up to 10,000, so a larger pageSize gets the largest page. Default 200. Source, filters or credits can return fewer. Follow next_cursor for more pages. Its aliases are limit, count, max_results, maxItems, max_items & per_page.
2017
+ #
2018
+ # @param min_followers [Integer] Minimum follower count. Profiles the filter drops cost nothing.
2019
+ #
2020
+ # @param max_followers [Integer] Maximum follower count. A profile without a count passes.
2021
+ #
2022
+ # @param min_following [Integer] Profiles must follow at least this many accounts.
2023
+ #
2024
+ # @param max_following [Integer] Profiles may follow at most this many accounts.
2025
+ #
2026
+ # @param min_statuses [Integer] Minimum post count. minPosts is also accepted.
2027
+ #
2028
+ # @param max_statuses [Integer] Maximum post count. maxPosts is also accepted.
2029
+ #
2030
+ # @param min_account_age_days [Integer] Minimum account age in whole days.
2031
+ #
2032
+ # @param verified_only [Boolean] Only return verified profiles.
2033
+ #
2034
+ # @param blue_verified_only [Boolean] Only return profiles X marks as blue verified. X marks many business & government accounts blue too. Use verifiedType for 1 badge type.
2035
+ #
2036
+ # @param verified_type [String] Match the verification type exactly, ignoring case.
2037
+ #
2038
+ # @param has_website [Boolean] Only return profiles with a website.
2039
+ #
2040
+ # @param has_location [Boolean] Only return profiles with a location.
2041
+ #
2042
+ # @param has_email [Boolean] Only return profiles that publish an email.
2043
+ #
2044
+ # @param business_email_only [Boolean] Only return profiles that publish an email outside free webmail, such as Gmail.
2045
+ #
2046
+ # @param email_domains [String] Only return profiles with an email at one of these domains. Separate domains with commas. Subdomains match.
2047
+ #
2048
+ # @param bio_contains [String] Match any comma-separated or line-separated bio term, ignoring case.
2049
+ #
2050
+ # @param location_contains [String] Match a location substring, ignoring case.
2051
+ #
2052
+ # @param username_contains [String] Match a username substring, ignoring case.
2053
+ #
2054
+ # @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
2055
+ #
2056
+ # @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
2057
+ #
2058
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
2059
+ #
2060
+ # @return [XTwitterScraper::Models::PaginatedUsers]
2061
+ #
2062
+ # @see XTwitterScraper::Models::X::UserRetrieveSimilarParams
2063
+ def retrieve_similar(id, params = {})
2064
+ parsed, options = XTwitterScraper::Models::X::UserRetrieveSimilarParams.dump_request(params)
2065
+ query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
2066
+ @client.request(
2067
+ method: :get,
2068
+ path: ["x/users/%1$s/similar", id],
2069
+ query: query,
2070
+ model: XTwitterScraper::Models::PaginatedUsers,
2071
+ options: options
2072
+ )
2073
+ end
2074
+
2075
+ # Returns the creators the selected user subscribes to, in X's order. An account
2076
+ # that hides its subscriptions returns an empty list.
2077
+ #
2078
+ # @overload retrieve_subscriptions(id, cursor: nil, page_size: nil, min_followers: nil, max_followers: nil, min_following: nil, max_following: nil, min_statuses: nil, max_statuses: nil, min_account_age_days: nil, verified_only: nil, blue_verified_only: nil, verified_type: nil, has_website: nil, has_location: nil, has_email: nil, business_email_only: nil, email_domains: nil, bio_contains: nil, location_contains: nil, username_contains: nil, fields: nil, omit: nil, request_options: {})
2079
+ #
2080
+ # @param id [String]
2081
+ #
2082
+ # @param cursor [String] Pagination cursor for collection results. Also read as next_cursor, next_token, pagination_token or continuation_token.
2083
+ #
2084
+ # @param page_size [Integer] Profiles to request from this page. A page holds up to 10,000, so a larger pageSize gets the largest page. Default 200. Source, filters or credits can return fewer. Follow next_cursor for more pages. Its aliases are limit, count, max_results, maxItems, max_items & per_page.
2085
+ #
2086
+ # @param min_followers [Integer] Minimum follower count. Profiles the filter drops cost nothing.
2087
+ #
2088
+ # @param max_followers [Integer] Maximum follower count. A profile without a count passes.
2089
+ #
2090
+ # @param min_following [Integer] Profiles must follow at least this many accounts.
2091
+ #
2092
+ # @param max_following [Integer] Profiles may follow at most this many accounts.
2093
+ #
2094
+ # @param min_statuses [Integer] Minimum post count. minPosts is also accepted.
2095
+ #
2096
+ # @param max_statuses [Integer] Maximum post count. maxPosts is also accepted.
2097
+ #
2098
+ # @param min_account_age_days [Integer] Minimum account age in whole days.
2099
+ #
2100
+ # @param verified_only [Boolean] Only return verified profiles.
2101
+ #
2102
+ # @param blue_verified_only [Boolean] Only return profiles X marks as blue verified. X marks many business & government accounts blue too. Use verifiedType for 1 badge type.
2103
+ #
2104
+ # @param verified_type [String] Match the verification type exactly, ignoring case.
2105
+ #
2106
+ # @param has_website [Boolean] Only return profiles with a website.
2107
+ #
2108
+ # @param has_location [Boolean] Only return profiles with a location.
2109
+ #
2110
+ # @param has_email [Boolean] Only return profiles that publish an email.
2111
+ #
2112
+ # @param business_email_only [Boolean] Only return profiles that publish an email outside free webmail, such as Gmail.
2113
+ #
2114
+ # @param email_domains [String] Only return profiles with an email at one of these domains. Separate domains with commas. Subdomains match.
2115
+ #
2116
+ # @param bio_contains [String] Match any comma-separated or line-separated bio term, ignoring case.
2117
+ #
2118
+ # @param location_contains [String] Match a location substring, ignoring case.
2119
+ #
2120
+ # @param username_contains [String] Match a username substring, ignoring case.
2121
+ #
2122
+ # @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
2123
+ #
2124
+ # @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
2125
+ #
2126
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
2127
+ #
2128
+ # @return [XTwitterScraper::Models::PaginatedUsers]
2129
+ #
2130
+ # @see XTwitterScraper::Models::X::UserRetrieveSubscriptionsParams
2131
+ def retrieve_subscriptions(id, params = {})
2132
+ parsed, options = XTwitterScraper::Models::X::UserRetrieveSubscriptionsParams.dump_request(params)
2133
+ query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
2134
+ @client.request(
2135
+ method: :get,
2136
+ path: ["x/users/%1$s/subscriptions", id],
2137
+ query: query,
2138
+ model: XTwitterScraper::Models::PaginatedUsers,
2139
+ options: options
2140
+ )
2141
+ end
2142
+
2143
+ # Returns X's own translation of 1 profile's bio into the language you pick, with
2144
+ # the links, mentions, and tags X places in the translated text. A profile without
2145
+ # a bio returns translation null & a message, free of charge. Posts & bios can be
2146
+ # translated into your language.
2147
+ #
2148
+ # @overload translate_bio(id, language:, fields: nil, omit: nil, request_options: {})
2149
+ #
2150
+ # @param id [String] User ID, username with or without @, or URL-encoded profile URL, such as x.com/nasa or x.com/i/user/11348282. A number is a user ID. Writes look up a username's ID before sending. Anything else gets 400 `invalid_user_id`.
2151
+ #
2152
+ # @param language [String] Language code to translate into, such as `es`, `tr`, `pt-br`, or `zh-tw`. Upper and lower case both work.
2153
+ #
2154
+ # @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
2155
+ #
2156
+ # @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
2157
+ #
2158
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
2159
+ #
2160
+ # @return [XTwitterScraper::Models::X::UserTranslateBioResponse]
2161
+ #
2162
+ # @see XTwitterScraper::Models::X::UserTranslateBioParams
2163
+ def translate_bio(id, params)
2164
+ parsed, options = XTwitterScraper::Models::X::UserTranslateBioParams.dump_request(params)
2165
+ query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
2166
+ @client.request(
2167
+ method: :get,
2168
+ path: ["x/users/%1$s/translation", id],
2169
+ query: query,
2170
+ model: XTwitterScraper::Models::X::UserTranslateBioResponse,
2171
+ options: options
2172
+ )
2173
+ end
2174
+
1434
2175
  # @api private
1435
2176
  #
1436
2177
  # @param client [XTwitterScraper::Client]
1437
2178
  def initialize(client:)
1438
2179
  @client = client
1439
2180
  @follow = XTwitterScraper::Resources::X::Users::Follow.new(client: client)
2181
+ @block = XTwitterScraper::Resources::X::Users::Block.new(client: client)
2182
+ @mute = XTwitterScraper::Resources::X::Users::Mute.new(client: client)
1440
2183
  end
1441
2184
  end
1442
2185
  end