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
@@ -16,6 +16,9 @@ module XTwitterScraper
16
16
  # @return [XTwitterScraper::Resources::X::Tweets::Retweet]
17
17
  attr_reader :retweet
18
18
 
19
+ # @return [XTwitterScraper::Resources::X::Tweets::Bookmark]
20
+ attr_reader :bookmark
21
+
19
22
  # Create tweet
20
23
  #
21
24
  # @overload create(account:, idempotency_key:, community_id: nil, is_note_tweet: nil, media: nil, media_ids: nil, reply_to_tweet_id: nil, text: nil, request_options: {})
@@ -1003,6 +1006,365 @@ module XTwitterScraper
1003
1006
  )
1004
1007
  end
1005
1008
 
1009
+ # Returns where each t.co link leads, as X's own redirect says. Xquik reads the
1010
+ # redirect and never visits the target site. A link t.co does not have comes back
1011
+ # without `resolvedUrl` and costs nothing. A link X does not answer for in time
1012
+ # comes back in `unprocessedUrls`, free. Each resolved link costs 1 credit.
1013
+ #
1014
+ # @overload resolve_links(urls:, fields: nil, omit: nil, request_options: {})
1015
+ #
1016
+ # @param urls [String] Links of the form `https://t.co/Xe1nm2pkSX`, separated by commas, as many as the URL holds. Any other link is refused. A link sent twice counts once. A longer URL fails at the edge before Xquik reads it.
1017
+ #
1018
+ # @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`.
1019
+ #
1020
+ # @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.
1021
+ #
1022
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
1023
+ #
1024
+ # @return [XTwitterScraper::Models::X::TweetResolveLinksResponse]
1025
+ #
1026
+ # @see XTwitterScraper::Models::X::TweetResolveLinksParams
1027
+ def resolve_links(params)
1028
+ parsed, options = XTwitterScraper::Models::X::TweetResolveLinksParams.dump_request(params)
1029
+ query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
1030
+ @client.request(
1031
+ method: :get,
1032
+ path: "x/links/resolve",
1033
+ query: query,
1034
+ model: XTwitterScraper::Models::X::TweetResolveLinksResponse,
1035
+ options: options
1036
+ )
1037
+ end
1038
+
1039
+ # Returns the tweets X ranks highest by 1 metric over the last day, week or month.
1040
+ # Covers all of X unless you pick a country or a language. Pages hold up to 20
1041
+ # tweets, and the list ends at 100. Each tweet costs 1 credit. Top tweet lists
1042
+ # come back reliably.
1043
+ #
1044
+ # @overload list_top(metric: nil, window: nil, country: nil, language: nil, cursor: nil, page_size: nil, fields: nil, omit: nil, request_options: {})
1045
+ #
1046
+ # @param metric [Symbol, XTwitterScraper::Models::X::TweetListTopParams::Metric] What to rank tweets by. Defaults to likes. Singular names work too, such as like.
1047
+ #
1048
+ # @param window [Symbol, XTwitterScraper::Models::X::TweetListTopParams::Window] How far back to look. Defaults to day. Also takes 24h, 7d, 30d, daily, weekly and monthly.
1049
+ #
1050
+ # @param country [String] Only tweets from 1 country, as a 2- or 3-letter ISO 3166 code, such as US or USA. Send country or language, not both.
1051
+ #
1052
+ # @param language [String] Only tweets in 1 language, as a 2-letter code, such as en. Send country or language, not both.
1053
+ #
1054
+ # @param cursor [String] Pagination cursor for collection results. Also read as next_cursor, next_token, pagination_token or continuation_token.
1055
+ #
1056
+ # @param page_size [Integer] Items per page (1-100, 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.
1057
+ #
1058
+ # @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`.
1059
+ #
1060
+ # @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.
1061
+ #
1062
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
1063
+ #
1064
+ # @return [XTwitterScraper::Models::PaginatedTweets]
1065
+ #
1066
+ # @see XTwitterScraper::Models::X::TweetListTopParams
1067
+ def list_top(params = {})
1068
+ parsed, options = XTwitterScraper::Models::X::TweetListTopParams.dump_request(params)
1069
+ query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
1070
+ @client.request(
1071
+ method: :get,
1072
+ path: "x/tweets/top",
1073
+ query: query,
1074
+ model: XTwitterScraper::Models::PaginatedTweets,
1075
+ options: options
1076
+ )
1077
+ end
1078
+
1079
+ # Returns the HTML that X gives websites to embed 1 public tweet, with the tweet's
1080
+ # link and author.
1081
+ #
1082
+ # @overload embed(id, theme: nil, hide_media: nil, hide_thread: nil, omit_script: nil, fields: nil, omit: nil, request_options: {})
1083
+ #
1084
+ # @param id [String] Tweet ID or URL-encoded tweet URL, such as x.com/nasa/status/20. Takes x.com & twitter.com links with or without https://, www., mobile., a query or a fragment, & /i/status or /i/web/status links. Anything else gets 400 `invalid_tweet_id`.
1085
+ #
1086
+ # @param theme [Symbol, XTwitterScraper::Models::X::TweetEmbedParams::Theme] Color theme of the embed. X uses light when left out.
1087
+ #
1088
+ # @param hide_media [Boolean] Set `true` to leave photos, videos, and link cards out.
1089
+ #
1090
+ # @param hide_thread [Boolean] Set `true` to leave the tweet this one replies to out.
1091
+ #
1092
+ # @param omit_script [Boolean] Set `true` to leave the widget script tag out, for pages that load it once themselves.
1093
+ #
1094
+ # @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`.
1095
+ #
1096
+ # @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.
1097
+ #
1098
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
1099
+ #
1100
+ # @return [XTwitterScraper::Models::X::TweetEmbedResponse]
1101
+ #
1102
+ # @see XTwitterScraper::Models::X::TweetEmbedParams
1103
+ def embed(id, params = {})
1104
+ parsed, options = XTwitterScraper::Models::X::TweetEmbedParams.dump_request(params)
1105
+ query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
1106
+ @client.request(
1107
+ method: :get,
1108
+ path: ["x/tweets/%1$s/embed", id],
1109
+ query: query,
1110
+ model: XTwitterScraper::Models::X::TweetEmbedResponse,
1111
+ options: options
1112
+ )
1113
+ end
1114
+
1115
+ # Returns the replies the post's author hid, oldest first, with the replies to
1116
+ # them. A post without hidden replies returns an empty list.
1117
+ #
1118
+ # @overload get_hidden_replies(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: {})
1119
+ #
1120
+ # @param id [String]
1121
+ #
1122
+ # @param cursor [String] Pagination cursor for collection results. Also read as next_cursor, next_token, pagination_token or continuation_token.
1123
+ #
1124
+ # @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.
1125
+ #
1126
+ # @param from_user [String] Filter by author username. Account searches include all of the account's posts & reposts.
1127
+ #
1128
+ # @param to_user [String] Filter replies sent to a username.
1129
+ #
1130
+ # @param mentioning [String] Filter tweets mentioning a username.
1131
+ #
1132
+ # @param language [String] Filter by language. Its alias is `lang`. Language filters work for every language X tags.
1133
+ #
1134
+ # @param since_date [Date] Start date in YYYY-MM-DD format, as a UTC day. A date means one thing in any common form.
1135
+ #
1136
+ # @param until_date [Date] End date in YYYY-MM-DD format, as a UTC day, inclusive, so its own posts count.
1137
+ #
1138
+ # @param media_type [Symbol, XTwitterScraper::Models::X::TweetGetHiddenRepliesParams::MediaType] Filter media. Its aliases are has_video & has_media.
1139
+ #
1140
+ # @param min_likes [Integer] Minimum likes. Its aliases are minFaves, min_likes & min_faves.
1141
+ #
1142
+ # @param min_retweets [Integer] Minimum retweets threshold.
1143
+ #
1144
+ # @param min_replies [Integer] Minimum replies threshold.
1145
+ #
1146
+ # @param min_quotes [Integer] Minimum quote count threshold.
1147
+ #
1148
+ # @param min_views [Integer] Minimum view count threshold.
1149
+ #
1150
+ # @param min_bookmarks [Integer] Minimum bookmark count threshold.
1151
+ #
1152
+ # @param max_faves [Integer] Maximum likes threshold. maxLikes & max_likes also work.
1153
+ #
1154
+ # @param max_retweets [Integer] Maximum retweets threshold.
1155
+ #
1156
+ # @param max_replies [Integer] Maximum replies threshold.
1157
+ #
1158
+ # @param max_quotes [Integer] Maximum quotes threshold.
1159
+ #
1160
+ # @param blue_verified_only [Boolean] Only return tweets from Blue-verified authors.
1161
+ #
1162
+ # @param since_id [String] Return Tweets whose IDs exceed this ID. Searches accept `since_id` & `max_id` bounds.
1163
+ #
1164
+ # @param max_id [String] Return Tweets at or below this ID.
1165
+ #
1166
+ # @param within_time [String] Keeps Tweets from a recent window, such as 90m or 7d. Use a whole number & s, m, h or d.
1167
+ #
1168
+ # @param native_retweets [Boolean] Only return native reposts.
1169
+ #
1170
+ # @param verified_only [Boolean] Only return tweets from verified authors.
1171
+ #
1172
+ # @param replies [Symbol, XTwitterScraper::Models::X::TweetGetHiddenRepliesParams::Replies] Reply mode. Exclude keeps own-thread replies.
1173
+ #
1174
+ # @param retweets [Symbol, XTwitterScraper::Models::X::TweetGetHiddenRepliesParams::Retweets] Only when the caller requests a repost mode.
1175
+ #
1176
+ # @param quotes [Symbol, XTwitterScraper::Models::X::TweetGetHiddenRepliesParams::Quotes] Only when the caller requests a quote mode.
1177
+ #
1178
+ # @param exact_phrase [String] Match this exact phrase, word for word.
1179
+ #
1180
+ # @param exclude_words [String] Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
1181
+ #
1182
+ # @param any_words [String] Words or quoted phrases where any one can match. Separate with spaces, commas, or lines.
1183
+ #
1184
+ # @param hashtags [String] Hashtags separated by spaces, commas, or lines.
1185
+ #
1186
+ # @param cashtags [String] Cashtags separated by spaces, commas, or lines.
1187
+ #
1188
+ # @param url [String] URL substring or domain filter.
1189
+ #
1190
+ # @param conversation_id [String] Conversation ID filter.
1191
+ #
1192
+ # @param in_reply_to_tweet_id [String] Only replies to this tweet ID.
1193
+ #
1194
+ # @param quotes_of_tweet_id [String] Only quotes of this tweet ID.
1195
+ #
1196
+ # @param retweets_of_tweet_id [String] Only retweets of this tweet ID.
1197
+ #
1198
+ # @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`.
1199
+ #
1200
+ # @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.
1201
+ #
1202
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
1203
+ #
1204
+ # @return [XTwitterScraper::Models::PaginatedTweets]
1205
+ #
1206
+ # @see XTwitterScraper::Models::X::TweetGetHiddenRepliesParams
1207
+ def get_hidden_replies(id, params = {})
1208
+ parsed, options = XTwitterScraper::Models::X::TweetGetHiddenRepliesParams.dump_request(params)
1209
+ query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
1210
+ @client.request(
1211
+ method: :get,
1212
+ path: ["x/tweets/%1$s/hidden-replies", id],
1213
+ query: query,
1214
+ model: XTwitterScraper::Models::PaginatedTweets,
1215
+ options: options
1216
+ )
1217
+ end
1218
+
1219
+ # Returns engagement insights for 1 tweet. They are engagements per hour since it
1220
+ # went up, per view and per follower of its author, and how far it spread. Each
1221
+ # report costs 1 credit, whatever it reads.
1222
+ #
1223
+ # @overload get_insights(id, fields: nil, omit: nil, request_options: {})
1224
+ #
1225
+ # @param id [String] Tweet ID or URL-encoded tweet URL, such as x.com/nasa/status/20. Takes x.com & twitter.com links with or without https://, www., mobile., a query or a fragment, & /i/status or /i/web/status links. Anything else gets 400 `invalid_tweet_id`.
1226
+ #
1227
+ # @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`.
1228
+ #
1229
+ # @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.
1230
+ #
1231
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
1232
+ #
1233
+ # @return [XTwitterScraper::Models::X::TweetGetInsightsResponse]
1234
+ #
1235
+ # @see XTwitterScraper::Models::X::TweetGetInsightsParams
1236
+ def get_insights(id, params = {})
1237
+ parsed, options = XTwitterScraper::Models::X::TweetGetInsightsParams.dump_request(params)
1238
+ query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
1239
+ @client.request(
1240
+ method: :get,
1241
+ path: ["x/tweets/%1$s/insights", id],
1242
+ query: query,
1243
+ model: XTwitterScraper::Models::X::TweetGetInsightsResponse,
1244
+ options: options
1245
+ )
1246
+ end
1247
+
1248
+ # Returns the user IDs of a post's reposters, in the order & pages of
1249
+ # /x/tweets/{id}/retweeters. Use it when you need IDs only. Each ID costs 1
1250
+ # credit. A post nobody reposted returns an empty list for free.
1251
+ #
1252
+ # @overload get_retweeter_ids(id, cursor: nil, page_size: nil, request_options: {})
1253
+ #
1254
+ # @param id [String] Tweet ID or URL-encoded tweet URL, such as x.com/nasa/status/20. Takes x.com & twitter.com links with or without https://, www., mobile., a query or a fragment, & /i/status or /i/web/status links. Anything else gets 400 `invalid_tweet_id`.
1255
+ #
1256
+ # @param cursor [String] Pagination cursor for collection results. Also read as next_cursor, next_token, pagination_token or continuation_token.
1257
+ #
1258
+ # @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.
1259
+ #
1260
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
1261
+ #
1262
+ # @return [XTwitterScraper::Models::PaginatedUserIds]
1263
+ #
1264
+ # @see XTwitterScraper::Models::X::TweetGetRetweeterIdsParams
1265
+ def get_retweeter_ids(id, params = {})
1266
+ parsed, options = XTwitterScraper::Models::X::TweetGetRetweeterIdsParams.dump_request(params)
1267
+ query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
1268
+ @client.request(
1269
+ method: :get,
1270
+ path: ["x/tweets/%1$s/retweeter-ids", id],
1271
+ query: query,
1272
+ model: XTwitterScraper::Models::PaginatedUserIds,
1273
+ options: options
1274
+ )
1275
+ end
1276
+
1277
+ # Returns whether 1 account reposted the post. It finds recent reposts. An older
1278
+ # repost can return false, with complete false. Each check costs 1 credit.
1279
+ #
1280
+ # @overload check_repost(id, user:, fields: nil, omit: nil, request_options: {})
1281
+ #
1282
+ # @param id [String]
1283
+ #
1284
+ # @param user [String] User ID, username with or without @, or profile URL.
1285
+ #
1286
+ # @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`.
1287
+ #
1288
+ # @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.
1289
+ #
1290
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
1291
+ #
1292
+ # @return [XTwitterScraper::Models::X::TweetCheckRepostResponse]
1293
+ #
1294
+ # @see XTwitterScraper::Models::X::TweetCheckRepostParams
1295
+ def check_repost(id, params)
1296
+ parsed, options = XTwitterScraper::Models::X::TweetCheckRepostParams.dump_request(params)
1297
+ query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
1298
+ @client.request(
1299
+ method: :get,
1300
+ path: ["x/tweets/%1$s/retweeters/check", id],
1301
+ query: query,
1302
+ model: XTwitterScraper::Models::X::TweetCheckRepostResponse,
1303
+ options: options
1304
+ )
1305
+ end
1306
+
1307
+ # Returns the caption tracks of 1 public tweet's videos. Each track has its
1308
+ # language, name, timed cues, and full text. A tweet without video, or a video
1309
+ # without captions, returns no track and costs nothing. Video subtitles come with
1310
+ # timed cues.
1311
+ #
1312
+ # @overload get_subtitles(id, fields: nil, omit: nil, request_options: {})
1313
+ #
1314
+ # @param id [String] Tweet ID or URL-encoded tweet URL, such as x.com/nasa/status/20. Takes x.com & twitter.com links with or without https://, www., mobile., a query or a fragment, & /i/status or /i/web/status links. Anything else gets 400 `invalid_tweet_id`.
1315
+ #
1316
+ # @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`.
1317
+ #
1318
+ # @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.
1319
+ #
1320
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
1321
+ #
1322
+ # @return [XTwitterScraper::Models::X::TweetGetSubtitlesResponse]
1323
+ #
1324
+ # @see XTwitterScraper::Models::X::TweetGetSubtitlesParams
1325
+ def get_subtitles(id, params = {})
1326
+ parsed, options = XTwitterScraper::Models::X::TweetGetSubtitlesParams.dump_request(params)
1327
+ query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
1328
+ @client.request(
1329
+ method: :get,
1330
+ path: ["x/tweets/%1$s/subtitles", id],
1331
+ query: query,
1332
+ model: XTwitterScraper::Models::X::TweetGetSubtitlesResponse,
1333
+ options: options
1334
+ )
1335
+ end
1336
+
1337
+ # Returns X's own translation of 1 public tweet into the language you pick, with
1338
+ # the links, mentions, and tags X places in the translated text. Posts & bios can
1339
+ # be translated into your language.
1340
+ #
1341
+ # @overload translate(id, language:, fields: nil, omit: nil, request_options: {})
1342
+ #
1343
+ # @param id [String] Tweet ID or URL-encoded tweet URL, such as x.com/nasa/status/20. Takes x.com & twitter.com links with or without https://, www., mobile., a query or a fragment, & /i/status or /i/web/status links. Anything else gets 400 `invalid_tweet_id`.
1344
+ #
1345
+ # @param language [String] Language code to translate into, such as `en`, `tr`, `pt-br`, or `zh-tw`. Upper and lower case both work.
1346
+ #
1347
+ # @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`.
1348
+ #
1349
+ # @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.
1350
+ #
1351
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
1352
+ #
1353
+ # @return [XTwitterScraper::Models::X::TweetTranslateResponse]
1354
+ #
1355
+ # @see XTwitterScraper::Models::X::TweetTranslateParams
1356
+ def translate(id, params)
1357
+ parsed, options = XTwitterScraper::Models::X::TweetTranslateParams.dump_request(params)
1358
+ query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
1359
+ @client.request(
1360
+ method: :get,
1361
+ path: ["x/tweets/%1$s/translation", id],
1362
+ query: query,
1363
+ model: XTwitterScraper::Models::X::TweetTranslateResponse,
1364
+ options: options
1365
+ )
1366
+ end
1367
+
1006
1368
  # @api private
1007
1369
  #
1008
1370
  # @param client [XTwitterScraper::Client]
@@ -1010,6 +1372,7 @@ module XTwitterScraper
1010
1372
  @client = client
1011
1373
  @like = XTwitterScraper::Resources::X::Tweets::Like.new(client: client)
1012
1374
  @retweet = XTwitterScraper::Resources::X::Tweets::Retweet.new(client: client)
1375
+ @bookmark = XTwitterScraper::Resources::X::Tweets::Bookmark.new(client: client)
1013
1376
  end
1014
1377
  end
1015
1378
  end
@@ -0,0 +1,83 @@
1
+ # SPDX-FileCopyrightText: 2026 Xquik contributors
2
+ #
3
+ # SPDX-License-Identifier: Apache-2.0
4
+
5
+ # frozen_string_literal: true
6
+
7
+ module XTwitterScraper
8
+ module Resources
9
+ class X
10
+ class Users
11
+ class Block
12
+ # Unblocks a user through a connected X account.
13
+ #
14
+ # @overload delete(id, account:, idempotency_key:, prefer: nil, request_options: {})
15
+ #
16
+ # @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`.
17
+ #
18
+ # @param account [String] X account identifier (@username or account ID)
19
+ #
20
+ # @param idempotency_key [String] Use 1 unique value per intended write. Reuse it only for an identical retry. A matching retry returns the first answer again, with `idempotent: true` added. It keeps the first status, body & Retry-After. It sends nothing to X & charges nothing. While the first request runs, a retry returns 202 & the action. Different input returns 409. Protection lasts at least 90 days. Retrying a write is safe with an idempotency key. A retry with an API key at its monthly budget gets 403 `api_key_budget_reached`.
21
+ #
22
+ # @param prefer [String] A long write answers 202 with a status link, then lands on X. `wait=<seconds>` asks for the answer within that many seconds, up to 85. If the write is still running then, the API answers 202 with Location. Poll Location until `terminal` is true, and don't send the write again.
23
+ #
24
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
25
+ #
26
+ # @return [XTwitterScraper::Models::X::WriteActionRetrieveResponse]
27
+ #
28
+ # @see XTwitterScraper::Models::X::Users::BlockDeleteParams
29
+ def delete(id, params)
30
+ parsed, options = XTwitterScraper::Models::X::Users::BlockDeleteParams.dump_request(params)
31
+ header_params = {idempotency_key: "idempotency-key", prefer: "prefer"}
32
+ @client.request(
33
+ method: :delete,
34
+ path: ["x/users/%1$s/block", id],
35
+ headers: parsed.slice(*header_params.keys).transform_keys(header_params),
36
+ body: parsed.except(*header_params.keys),
37
+ model: XTwitterScraper::Models::X::WriteActionRetrieveResponse,
38
+ options: options
39
+ )
40
+ end
41
+
42
+ # Blocks a user through a connected X account. X removes follows both ways, and
43
+ # unblocking doesn't restore them.
44
+ #
45
+ # @overload create(id, account:, idempotency_key:, prefer: nil, request_options: {})
46
+ #
47
+ # @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`.
48
+ #
49
+ # @param account [String] X account identifier (@username or account ID)
50
+ #
51
+ # @param idempotency_key [String] Use 1 unique value per intended write. Reuse it only for an identical retry. A matching retry returns the first answer again, with `idempotent: true` added. It keeps the first status, body & Retry-After. It sends nothing to X & charges nothing. While the first request runs, a retry returns 202 & the action. Different input returns 409. Protection lasts at least 90 days. Retrying a write is safe with an idempotency key. A retry with an API key at its monthly budget gets 403 `api_key_budget_reached`.
52
+ #
53
+ # @param prefer [String] A long write answers 202 with a status link, then lands on X. `wait=<seconds>` asks for the answer within that many seconds, up to 85. If the write is still running then, the API answers 202 with Location. Poll Location until `terminal` is true, and don't send the write again.
54
+ #
55
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
56
+ #
57
+ # @return [XTwitterScraper::Models::X::WriteActionRetrieveResponse]
58
+ #
59
+ # @see XTwitterScraper::Models::X::Users::BlockCreateParams
60
+ def create(id, params)
61
+ parsed, options = XTwitterScraper::Models::X::Users::BlockCreateParams.dump_request(params)
62
+ header_params = {idempotency_key: "idempotency-key", prefer: "prefer"}
63
+ @client.request(
64
+ method: :post,
65
+ path: ["x/users/%1$s/block", id],
66
+ headers: parsed.slice(*header_params.keys).transform_keys(header_params),
67
+ body: parsed.except(*header_params.keys),
68
+ model: XTwitterScraper::Models::X::WriteActionRetrieveResponse,
69
+ options: options
70
+ )
71
+ end
72
+
73
+ # @api private
74
+ #
75
+ # @param client [XTwitterScraper::Client]
76
+ def initialize(client:)
77
+ @client = client
78
+ end
79
+ end
80
+ end
81
+ end
82
+ end
83
+ end
@@ -0,0 +1,83 @@
1
+ # SPDX-FileCopyrightText: 2026 Xquik contributors
2
+ #
3
+ # SPDX-License-Identifier: Apache-2.0
4
+
5
+ # frozen_string_literal: true
6
+
7
+ module XTwitterScraper
8
+ module Resources
9
+ class X
10
+ class Users
11
+ class Mute
12
+ # Unmutes a user through a connected X account.
13
+ #
14
+ # @overload delete(id, account:, idempotency_key:, prefer: nil, request_options: {})
15
+ #
16
+ # @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`.
17
+ #
18
+ # @param account [String] X account identifier (@username or account ID)
19
+ #
20
+ # @param idempotency_key [String] Use 1 unique value per intended write. Reuse it only for an identical retry. A matching retry returns the first answer again, with `idempotent: true` added. It keeps the first status, body & Retry-After. It sends nothing to X & charges nothing. While the first request runs, a retry returns 202 & the action. Different input returns 409. Protection lasts at least 90 days. Retrying a write is safe with an idempotency key. A retry with an API key at its monthly budget gets 403 `api_key_budget_reached`.
21
+ #
22
+ # @param prefer [String] A long write answers 202 with a status link, then lands on X. `wait=<seconds>` asks for the answer within that many seconds, up to 85. If the write is still running then, the API answers 202 with Location. Poll Location until `terminal` is true, and don't send the write again.
23
+ #
24
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
25
+ #
26
+ # @return [XTwitterScraper::Models::X::WriteActionRetrieveResponse]
27
+ #
28
+ # @see XTwitterScraper::Models::X::Users::MuteDeleteParams
29
+ def delete(id, params)
30
+ parsed, options = XTwitterScraper::Models::X::Users::MuteDeleteParams.dump_request(params)
31
+ header_params = {idempotency_key: "idempotency-key", prefer: "prefer"}
32
+ @client.request(
33
+ method: :delete,
34
+ path: ["x/users/%1$s/mute", id],
35
+ headers: parsed.slice(*header_params.keys).transform_keys(header_params),
36
+ body: parsed.except(*header_params.keys),
37
+ model: XTwitterScraper::Models::X::WriteActionRetrieveResponse,
38
+ options: options
39
+ )
40
+ end
41
+
42
+ # Mutes a user through a connected X account. The user's posts leave that
43
+ # account's timelines, and X doesn't tell the user.
44
+ #
45
+ # @overload create(id, account:, idempotency_key:, prefer: nil, request_options: {})
46
+ #
47
+ # @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`.
48
+ #
49
+ # @param account [String] X account identifier (@username or account ID)
50
+ #
51
+ # @param idempotency_key [String] Use 1 unique value per intended write. Reuse it only for an identical retry. A matching retry returns the first answer again, with `idempotent: true` added. It keeps the first status, body & Retry-After. It sends nothing to X & charges nothing. While the first request runs, a retry returns 202 & the action. Different input returns 409. Protection lasts at least 90 days. Retrying a write is safe with an idempotency key. A retry with an API key at its monthly budget gets 403 `api_key_budget_reached`.
52
+ #
53
+ # @param prefer [String] A long write answers 202 with a status link, then lands on X. `wait=<seconds>` asks for the answer within that many seconds, up to 85. If the write is still running then, the API answers 202 with Location. Poll Location until `terminal` is true, and don't send the write again.
54
+ #
55
+ # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
56
+ #
57
+ # @return [XTwitterScraper::Models::X::WriteActionRetrieveResponse]
58
+ #
59
+ # @see XTwitterScraper::Models::X::Users::MuteCreateParams
60
+ def create(id, params)
61
+ parsed, options = XTwitterScraper::Models::X::Users::MuteCreateParams.dump_request(params)
62
+ header_params = {idempotency_key: "idempotency-key", prefer: "prefer"}
63
+ @client.request(
64
+ method: :post,
65
+ path: ["x/users/%1$s/mute", id],
66
+ headers: parsed.slice(*header_params.keys).transform_keys(header_params),
67
+ body: parsed.except(*header_params.keys),
68
+ model: XTwitterScraper::Models::X::WriteActionRetrieveResponse,
69
+ options: options
70
+ )
71
+ end
72
+
73
+ # @api private
74
+ #
75
+ # @param client [XTwitterScraper::Client]
76
+ def initialize(client:)
77
+ @client = client
78
+ end
79
+ end
80
+ end
81
+ end
82
+ end
83
+ end