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
@@ -0,0 +1,1492 @@
1
+ # SPDX-FileCopyrightText: 2026 Xquik contributors
2
+ #
3
+ # SPDX-License-Identifier: Apache-2.0
4
+
5
+ # typed: strong
6
+
7
+ module XTwitterScraper
8
+ module Models
9
+ class Community < XTwitterScraper::Internal::Type::BaseModel
10
+ OrHash =
11
+ T.type_alias do
12
+ T.any(
13
+ XTwitterScraper::Models::Community,
14
+ XTwitterScraper::Internal::AnyHash
15
+ )
16
+ end
17
+
18
+ # Unique community identifier
19
+ sig { returns(String) }
20
+ attr_accessor :id
21
+
22
+ # Display name of the community
23
+ sig { returns(String) }
24
+ attr_accessor :name
25
+
26
+ # About text for the community
27
+ sig { returns(T.nilable(String)) }
28
+ attr_reader :description
29
+
30
+ sig { params(description: String).void }
31
+ attr_writer :description
32
+
33
+ # Total member count
34
+ sig { returns(Integer) }
35
+ attr_accessor :member_count
36
+
37
+ # Total moderator count
38
+ sig { returns(T.nilable(Integer)) }
39
+ attr_reader :moderator_count
40
+
41
+ sig { params(moderator_count: Integer).void }
42
+ attr_writer :moderator_count
43
+
44
+ # Whether the community is marked sensitive
45
+ sig { returns(T::Boolean) }
46
+ attr_accessor :is_nsfw
47
+
48
+ # Primary topic. Its id is absent when X lists the community in a keyword or topic
49
+ # result.
50
+ sig do
51
+ returns(T.nilable(XTwitterScraper::Models::Community::PrimaryTopic))
52
+ end
53
+ attr_reader :primary_topic
54
+
55
+ sig do
56
+ params(
57
+ primary_topic:
58
+ XTwitterScraper::Models::Community::PrimaryTopic::OrHash
59
+ ).void
60
+ end
61
+ attr_writer :primary_topic
62
+
63
+ # Community creation timestamp
64
+ sig { returns(T.nilable(String)) }
65
+ attr_reader :created_at
66
+
67
+ sig { params(created_at: String).void }
68
+ attr_writer :created_at
69
+
70
+ # Join policy (open or restricted)
71
+ sig { returns(T.nilable(String)) }
72
+ attr_reader :join_policy
73
+
74
+ sig { params(join_policy: String).void }
75
+ attr_writer :join_policy
76
+
77
+ # Invitation policy
78
+ sig { returns(T.nilable(String)) }
79
+ attr_reader :invites_policy
80
+
81
+ sig { params(invites_policy: String).void }
82
+ attr_writer :invites_policy
83
+
84
+ # What the community asks a user who joins
85
+ sig { returns(T.nilable(String)) }
86
+ attr_reader :question
87
+
88
+ sig { params(question: String).void }
89
+ attr_writer :question
90
+
91
+ # Community rules
92
+ sig do
93
+ returns(T.nilable(T::Array[XTwitterScraper::Models::Community::Rule]))
94
+ end
95
+ attr_reader :rules
96
+
97
+ sig do
98
+ params(
99
+ rules: T::Array[XTwitterScraper::Models::Community::Rule::OrHash]
100
+ ).void
101
+ end
102
+ attr_writer :rules
103
+
104
+ # Tags X finds the community by
105
+ sig { returns(T.nilable(T::Array[String])) }
106
+ attr_reader :search_tags
107
+
108
+ sig { params(search_tags: T::Array[String]).void }
109
+ attr_writer :search_tags
110
+
111
+ # The creator's public profile, or the ID, username and badge alone when X sends
112
+ # no profile
113
+ sig { returns(T.nilable(XTwitterScraper::Models::Community::Creator)) }
114
+ attr_reader :creator
115
+
116
+ sig do
117
+ params(
118
+ creator: XTwitterScraper::Models::Community::Creator::OrHash
119
+ ).void
120
+ end
121
+ attr_writer :creator
122
+
123
+ # Public X profile.
124
+ sig { returns(T.nilable(XTwitterScraper::Models::UserProfile)) }
125
+ attr_reader :admin
126
+
127
+ sig { params(admin: XTwitterScraper::Models::UserProfile::OrHash).void }
128
+ attr_writer :admin
129
+
130
+ # The members X previews beside the member count. A keyword or topic result gives
131
+ # each member's ID & picture only.
132
+ sig do
133
+ returns(
134
+ T.nilable(
135
+ T::Array[
136
+ XTwitterScraper::Models::Community::MembersFacepile::Variants
137
+ ]
138
+ )
139
+ )
140
+ end
141
+ attr_reader :members_facepile
142
+
143
+ sig do
144
+ params(
145
+ members_facepile:
146
+ T::Array[
147
+ T.any(
148
+ XTwitterScraper::Models::UserProfile::OrHash,
149
+ XTwitterScraper::Models::CommunityMemberPreview::OrHash
150
+ )
151
+ ]
152
+ ).void
153
+ end
154
+ attr_writer :members_facepile
155
+
156
+ # Community banner image URL
157
+ sig { returns(T.nilable(String)) }
158
+ attr_reader :banner_url
159
+
160
+ sig { params(banner_url: String).void }
161
+ attr_writer :banner_url
162
+
163
+ # The banner X shows for a community, with its size & colors.
164
+ sig { returns(T.nilable(XTwitterScraper::Models::CommunityBanner)) }
165
+ attr_reader :banner
166
+
167
+ sig do
168
+ params(banner: XTwitterScraper::Models::CommunityBanner::OrHash).void
169
+ end
170
+ attr_writer :banner
171
+
172
+ sig do
173
+ params(
174
+ id: String,
175
+ name: String,
176
+ member_count: Integer,
177
+ is_nsfw: T::Boolean,
178
+ description: String,
179
+ moderator_count: Integer,
180
+ primary_topic:
181
+ XTwitterScraper::Models::Community::PrimaryTopic::OrHash,
182
+ created_at: String,
183
+ join_policy: String,
184
+ invites_policy: String,
185
+ question: String,
186
+ rules: T::Array[XTwitterScraper::Models::Community::Rule::OrHash],
187
+ search_tags: T::Array[String],
188
+ creator: XTwitterScraper::Models::Community::Creator::OrHash,
189
+ admin: XTwitterScraper::Models::UserProfile::OrHash,
190
+ members_facepile:
191
+ T::Array[
192
+ T.any(
193
+ XTwitterScraper::Models::UserProfile::OrHash,
194
+ XTwitterScraper::Models::CommunityMemberPreview::OrHash
195
+ )
196
+ ],
197
+ banner_url: String,
198
+ banner: XTwitterScraper::Models::CommunityBanner::OrHash
199
+ ).returns(T.attached_class)
200
+ end
201
+ def self.new(
202
+ # Unique community identifier
203
+ id:,
204
+ # Display name of the community
205
+ name:,
206
+ # Total member count
207
+ member_count:,
208
+ # Whether the community is marked sensitive
209
+ is_nsfw:,
210
+ # About text for the community
211
+ description: nil,
212
+ # Total moderator count
213
+ moderator_count: nil,
214
+ # Primary topic. Its id is absent when X lists the community in a keyword or topic
215
+ # result.
216
+ primary_topic: nil,
217
+ # Community creation timestamp
218
+ created_at: nil,
219
+ # Join policy (open or restricted)
220
+ join_policy: nil,
221
+ # Invitation policy
222
+ invites_policy: nil,
223
+ # What the community asks a user who joins
224
+ question: nil,
225
+ # Community rules
226
+ rules: nil,
227
+ # Tags X finds the community by
228
+ search_tags: nil,
229
+ # The creator's public profile, or the ID, username and badge alone when X sends
230
+ # no profile
231
+ creator: nil,
232
+ # Public X profile.
233
+ admin: nil,
234
+ # The members X previews beside the member count. A keyword or topic result gives
235
+ # each member's ID & picture only.
236
+ members_facepile: nil,
237
+ # Community banner image URL
238
+ banner_url: nil,
239
+ # The banner X shows for a community, with its size & colors.
240
+ banner: nil
241
+ )
242
+ end
243
+
244
+ sig do
245
+ override.returns(
246
+ {
247
+ id: String,
248
+ name: String,
249
+ description: String,
250
+ member_count: Integer,
251
+ moderator_count: Integer,
252
+ is_nsfw: T::Boolean,
253
+ primary_topic: XTwitterScraper::Models::Community::PrimaryTopic,
254
+ created_at: String,
255
+ join_policy: String,
256
+ invites_policy: String,
257
+ question: String,
258
+ rules: T::Array[XTwitterScraper::Models::Community::Rule],
259
+ search_tags: T::Array[String],
260
+ creator: XTwitterScraper::Models::Community::Creator,
261
+ admin: XTwitterScraper::Models::UserProfile,
262
+ members_facepile:
263
+ T::Array[
264
+ XTwitterScraper::Models::Community::MembersFacepile::Variants
265
+ ],
266
+ banner_url: String,
267
+ banner: XTwitterScraper::Models::CommunityBanner
268
+ }
269
+ )
270
+ end
271
+ def to_hash
272
+ end
273
+
274
+ class PrimaryTopic < XTwitterScraper::Internal::Type::BaseModel
275
+ OrHash =
276
+ T.type_alias do
277
+ T.any(
278
+ XTwitterScraper::Models::Community::PrimaryTopic,
279
+ XTwitterScraper::Internal::AnyHash
280
+ )
281
+ end
282
+
283
+ # Topic ID that /x/communities/popular takes
284
+ sig { returns(T.nilable(String)) }
285
+ attr_reader :id
286
+
287
+ sig { params(id: String).void }
288
+ attr_writer :id
289
+
290
+ # Topic name X shows on the community
291
+ sig { returns(String) }
292
+ attr_accessor :name
293
+
294
+ sig { params(name: String, id: String).returns(T.attached_class) }
295
+ def self.new(
296
+ # Topic name X shows on the community
297
+ name:,
298
+ # Topic ID that /x/communities/popular takes
299
+ id: nil
300
+ )
301
+ end
302
+
303
+ sig { override.returns({ id: String, name: String }) }
304
+ def to_hash
305
+ end
306
+ end
307
+
308
+ class Rule < XTwitterScraper::Internal::Type::BaseModel
309
+ OrHash =
310
+ T.type_alias do
311
+ T.any(
312
+ XTwitterScraper::Models::Community::Rule,
313
+ XTwitterScraper::Internal::AnyHash
314
+ )
315
+ end
316
+
317
+ # Rule ID
318
+ sig { returns(T.nilable(String)) }
319
+ attr_reader :id
320
+
321
+ sig { params(id: String).void }
322
+ attr_writer :id
323
+
324
+ # Rule title
325
+ sig { returns(T.nilable(String)) }
326
+ attr_reader :name
327
+
328
+ sig { params(name: String).void }
329
+ attr_writer :name
330
+
331
+ # What the rule asks of members
332
+ sig { returns(T.nilable(String)) }
333
+ attr_reader :description
334
+
335
+ sig { params(description: String).void }
336
+ attr_writer :description
337
+
338
+ sig do
339
+ params(id: String, name: String, description: String).returns(
340
+ T.attached_class
341
+ )
342
+ end
343
+ def self.new(
344
+ # Rule ID
345
+ id: nil,
346
+ # Rule title
347
+ name: nil,
348
+ # What the rule asks of members
349
+ description: nil
350
+ )
351
+ end
352
+
353
+ sig do
354
+ override.returns({ id: String, name: String, description: String })
355
+ end
356
+ def to_hash
357
+ end
358
+ end
359
+
360
+ class Creator < XTwitterScraper::Internal::Type::BaseModel
361
+ OrHash =
362
+ T.type_alias do
363
+ T.any(
364
+ XTwitterScraper::Models::Community::Creator,
365
+ XTwitterScraper::Internal::AnyHash
366
+ )
367
+ end
368
+
369
+ sig { returns(String) }
370
+ attr_accessor :id
371
+
372
+ sig { returns(String) }
373
+ attr_accessor :username
374
+
375
+ sig { returns(T.nilable(String)) }
376
+ attr_reader :name
377
+
378
+ sig { params(name: String).void }
379
+ attr_writer :name
380
+
381
+ sig { returns(T.nilable(String)) }
382
+ attr_reader :description
383
+
384
+ sig { params(description: String).void }
385
+ attr_writer :description
386
+
387
+ # Omitted when X sends no count, as for the account that first posted reused
388
+ # media.
389
+ sig { returns(T.nilable(Integer)) }
390
+ attr_reader :followers
391
+
392
+ sig { params(followers: Integer).void }
393
+ attr_writer :followers
394
+
395
+ sig { returns(T.nilable(Integer)) }
396
+ attr_reader :following
397
+
398
+ sig { params(following: Integer).void }
399
+ attr_writer :following
400
+
401
+ sig { returns(T::Boolean) }
402
+ attr_accessor :verified
403
+
404
+ # Whether X shows a blue verification badge
405
+ sig { returns(T.nilable(T::Boolean)) }
406
+ attr_reader :is_blue_verified
407
+
408
+ sig { params(is_blue_verified: T::Boolean).void }
409
+ attr_writer :is_blue_verified
410
+
411
+ # Whether X marks the profile as verified
412
+ sig { returns(T.nilable(T::Boolean)) }
413
+ attr_reader :is_verified
414
+
415
+ sig { params(is_verified: T::Boolean).void }
416
+ attr_writer :is_verified
417
+
418
+ # Profile picture at 48 px, as X sends it.
419
+ sig { returns(T.nilable(String)) }
420
+ attr_reader :profile_picture
421
+
422
+ sig { params(profile_picture: String).void }
423
+ attr_writer :profile_picture
424
+
425
+ # The same profile picture at full size, as the account uploaded it. Download this
426
+ # one for the image.
427
+ sig { returns(T.nilable(String)) }
428
+ attr_reader :profile_picture_original
429
+
430
+ sig { params(profile_picture_original: String).void }
431
+ attr_writer :profile_picture_original
432
+
433
+ sig { returns(T.nilable(String)) }
434
+ attr_reader :cover_picture
435
+
436
+ sig { params(cover_picture: String).void }
437
+ attr_writer :cover_picture
438
+
439
+ # Original X profile banner field when available
440
+ sig { returns(T.nilable(String)) }
441
+ attr_reader :profile_banner_url
442
+
443
+ sig { params(profile_banner_url: String).void }
444
+ attr_writer :profile_banner_url
445
+
446
+ # Account owner's public profile location text
447
+ sig { returns(T.nilable(String)) }
448
+ attr_reader :location
449
+
450
+ sig { params(location: String).void }
451
+ attr_writer :location
452
+
453
+ # Null when X shows no label.
454
+ sig { returns(T.nilable(XTwitterScraper::Models::AccountBasedIn)) }
455
+ attr_reader :account_based_in
456
+
457
+ sig do
458
+ params(
459
+ account_based_in:
460
+ T.nilable(XTwitterScraper::Models::AccountBasedIn::OrHash)
461
+ ).void
462
+ end
463
+ attr_writer :account_based_in
464
+
465
+ # True when X withheld accountBasedIn from this read. Retry later.
466
+ sig { returns(T.nilable(T::Boolean)) }
467
+ attr_reader :account_based_in_unavailable
468
+
469
+ sig { params(account_based_in_unavailable: T::Boolean).void }
470
+ attr_writer :account_based_in_unavailable
471
+
472
+ # False when X notes accountBasedIn may be inaccurate.
473
+ sig { returns(T.nilable(T::Boolean)) }
474
+ attr_reader :account_based_in_accurate
475
+
476
+ sig { params(account_based_in_accurate: T::Boolean).void }
477
+ attr_writer :account_based_in_accurate
478
+
479
+ # How the account first connected to X.
480
+ sig { returns(T.nilable(String)) }
481
+ attr_reader :connected_via
482
+
483
+ sig { params(connected_via: String).void }
484
+ attr_writer :connected_via
485
+
486
+ # False when X notes that country may be inaccurate.
487
+ sig { returns(T.nilable(T::Boolean)) }
488
+ attr_reader :connected_via_accurate
489
+
490
+ sig { params(connected_via_accurate: T::Boolean).void }
491
+ attr_writer :connected_via_accurate
492
+
493
+ # Handle of the organization X shows the account is affiliated with, from its
494
+ # About page.
495
+ sig { returns(T.nilable(String)) }
496
+ attr_reader :affiliate_username
497
+
498
+ sig { params(affiliate_username: String).void }
499
+ attr_writer :affiliate_username
500
+
501
+ # First email the account publishes on its profile, lowercased. Omitted when it
502
+ # publishes none.
503
+ sig { returns(T.nilable(String)) }
504
+ attr_reader :email
505
+
506
+ sig { params(email: String).void }
507
+ attr_writer :email
508
+
509
+ # Emails, phone numbers & links the account publishes on its own profile. Omitted
510
+ # when it publishes none.
511
+ sig { returns(T.nilable(XTwitterScraper::Models::ProfileContactInfo)) }
512
+ attr_reader :contact_info
513
+
514
+ sig do
515
+ params(
516
+ contact_info: XTwitterScraper::Models::ProfileContactInfo::OrHash
517
+ ).void
518
+ end
519
+ attr_writer :contact_info
520
+
521
+ # How often the account changed its username.
522
+ sig do
523
+ returns(
524
+ T.nilable(
525
+ XTwitterScraper::Models::Community::Creator::UsernameChanges
526
+ )
527
+ )
528
+ end
529
+ attr_reader :username_changes
530
+
531
+ sig do
532
+ params(
533
+ username_changes:
534
+ XTwitterScraper::Models::Community::Creator::UsernameChanges::OrHash
535
+ ).void
536
+ end
537
+ attr_writer :username_changes
538
+
539
+ # The parts of the birthday the account made public.
540
+ sig do
541
+ returns(
542
+ T.nilable(XTwitterScraper::Models::Community::Creator::Birthdate)
543
+ )
544
+ end
545
+ attr_reader :birthdate
546
+
547
+ sig do
548
+ params(
549
+ birthdate:
550
+ XTwitterScraper::Models::Community::Creator::Birthdate::OrHash
551
+ ).void
552
+ end
553
+ attr_writer :birthdate
554
+
555
+ # UTC repost time with includeRetweetTimestamp. Null when Xquik found no repost
556
+ # time. Otherwise omitted.
557
+ sig { returns(T.nilable(Time)) }
558
+ attr_reader :retweeted_at
559
+
560
+ sig { params(retweeted_at: T.nilable(Time)).void }
561
+ attr_writer :retweeted_at
562
+
563
+ # Account creation time.
564
+ sig { returns(T.nilable(String)) }
565
+ attr_reader :created_at
566
+
567
+ sig { params(created_at: String).void }
568
+ attr_writer :created_at
569
+
570
+ sig { returns(T.nilable(Integer)) }
571
+ attr_reader :statuses_count
572
+
573
+ sig { params(statuses_count: Integer).void }
574
+ attr_writer :statuses_count
575
+
576
+ sig { returns(T.nilable(Integer)) }
577
+ attr_reader :media_count
578
+
579
+ sig { params(media_count: Integer).void }
580
+ attr_writer :media_count
581
+
582
+ # Whether the profile protects its posts
583
+ sig { returns(T.nilable(T::Boolean)) }
584
+ attr_reader :protected
585
+
586
+ sig { params(protected: T::Boolean).void }
587
+ attr_writer :protected
588
+
589
+ sig { returns(T.nilable(String)) }
590
+ attr_reader :url
591
+
592
+ sig { params(url: String).void }
593
+ attr_writer :url
594
+
595
+ sig { returns(T.nilable(Integer)) }
596
+ attr_reader :favourites_count
597
+
598
+ sig { params(favourites_count: Integer).void }
599
+ attr_writer :favourites_count
600
+
601
+ sig { returns(T.nilable(T::Boolean)) }
602
+ attr_reader :has_custom_timelines
603
+
604
+ sig { params(has_custom_timelines: T::Boolean).void }
605
+ attr_writer :has_custom_timelines
606
+
607
+ sig { returns(T.nilable(T::Boolean)) }
608
+ attr_reader :is_translator
609
+
610
+ sig { params(is_translator: T::Boolean).void }
611
+ attr_writer :is_translator
612
+
613
+ sig { returns(T.nilable(T::Array[String])) }
614
+ attr_reader :withheld_in_countries
615
+
616
+ sig { params(withheld_in_countries: T::Array[String]).void }
617
+ attr_writer :withheld_in_countries
618
+
619
+ # Whether X withholds a post or user
620
+ sig { returns(T.nilable(String)) }
621
+ attr_reader :withheld_scope
622
+
623
+ sig { params(withheld_scope: String).void }
624
+ attr_writer :withheld_scope
625
+
626
+ sig { returns(T.nilable(T::Boolean)) }
627
+ attr_reader :possibly_sensitive
628
+
629
+ sig { params(possibly_sensitive: T::Boolean).void }
630
+ attr_writer :possibly_sensitive
631
+
632
+ # Professional metadata with category display settings
633
+ sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
634
+ attr_reader :professional
635
+
636
+ sig { params(professional: T::Hash[Symbol, T.anything]).void }
637
+ attr_writer :professional
638
+
639
+ # Public profile bio translation returned by X
640
+ sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
641
+ attr_reader :grok_translated_bio
642
+
643
+ sig { params(grok_translated_bio: T::Hash[Symbol, T.anything]).void }
644
+ attr_writer :grok_translated_bio
645
+
646
+ sig { returns(T.nilable(T::Array[String])) }
647
+ attr_reader :pinned_tweet_ids
648
+
649
+ sig { params(pinned_tweet_ids: T::Array[String]).void }
650
+ attr_writer :pinned_tweet_ids
651
+
652
+ sig { returns(T.nilable(T::Boolean)) }
653
+ attr_reader :is_automated
654
+
655
+ sig { params(is_automated: T::Boolean).void }
656
+ attr_writer :is_automated
657
+
658
+ sig { returns(T.nilable(String)) }
659
+ attr_reader :automated_by
660
+
661
+ sig { params(automated_by: String).void }
662
+ attr_writer :automated_by
663
+
664
+ sig { returns(T.nilable(T::Boolean)) }
665
+ attr_reader :unavailable
666
+
667
+ sig { params(unavailable: T::Boolean).void }
668
+ attr_writer :unavailable
669
+
670
+ sig { returns(T.nilable(String)) }
671
+ attr_reader :unavailable_reason
672
+
673
+ sig { params(unavailable_reason: String).void }
674
+ attr_writer :unavailable_reason
675
+
676
+ sig { returns(T.nilable(String)) }
677
+ attr_reader :verified_type
678
+
679
+ sig { params(verified_type: String).void }
680
+ attr_writer :verified_type
681
+
682
+ # Organization affiliation label shown on an X profile.
683
+ sig { returns(T.nilable(XTwitterScraper::Models::UserAffiliateLabel)) }
684
+ attr_reader :affiliates_highlighted_label
685
+
686
+ sig do
687
+ params(
688
+ affiliates_highlighted_label:
689
+ XTwitterScraper::Models::UserAffiliateLabel::OrHash
690
+ ).void
691
+ end
692
+ attr_writer :affiliates_highlighted_label
693
+
694
+ # Whole number from 0.
695
+ sig { returns(T.nilable(Integer)) }
696
+ attr_reader :business_account_affiliates_count
697
+
698
+ sig { params(business_account_affiliates_count: Integer).void }
699
+ attr_writer :business_account_affiliates_count
700
+
701
+ # Whole number from 0.
702
+ sig { returns(T.nilable(Integer)) }
703
+ attr_reader :creator_subscriptions_count
704
+
705
+ sig { params(creator_subscriptions_count: Integer).void }
706
+ attr_writer :creator_subscriptions_count
707
+
708
+ sig { returns(T.nilable(T::Boolean)) }
709
+ attr_reader :has_graduated_access
710
+
711
+ sig { params(has_graduated_access: T::Boolean).void }
712
+ attr_writer :has_graduated_access
713
+
714
+ sig { returns(T.nilable(T::Boolean)) }
715
+ attr_reader :has_hidden_subscriptions_on_profile
716
+
717
+ sig { params(has_hidden_subscriptions_on_profile: T::Boolean).void }
718
+ attr_writer :has_hidden_subscriptions_on_profile
719
+
720
+ # Profile highlight availability and count metadata.
721
+ sig { returns(T.nilable(XTwitterScraper::Models::UserHighlightsInfo)) }
722
+ attr_reader :highlights_info
723
+
724
+ sig do
725
+ params(
726
+ highlights_info: XTwitterScraper::Models::UserHighlightsInfo::OrHash
727
+ ).void
728
+ end
729
+ attr_writer :highlights_info
730
+
731
+ # Identity verification X shows on the profile & its About page.
732
+ sig do
733
+ returns(T.nilable(XTwitterScraper::Models::UserIdentityVerification))
734
+ end
735
+ attr_reader :identity_verification
736
+
737
+ sig do
738
+ params(
739
+ identity_verification:
740
+ XTwitterScraper::Models::UserIdentityVerification::OrHash
741
+ ).void
742
+ end
743
+ attr_writer :identity_verification
744
+
745
+ sig { returns(T.nilable(T::Boolean)) }
746
+ attr_reader :is_profile_translatable
747
+
748
+ sig { params(is_profile_translatable: T::Boolean).void }
749
+ attr_writer :is_profile_translatable
750
+
751
+ sig { returns(T.nilable(String)) }
752
+ attr_reader :parody_commentary_fan_label
753
+
754
+ sig { params(parody_commentary_fan_label: String).void }
755
+ attr_writer :parody_commentary_fan_label
756
+
757
+ sig { returns(T.nilable(String)) }
758
+ attr_reader :profile_description_language
759
+
760
+ sig { params(profile_description_language: String).void }
761
+ attr_writer :profile_description_language
762
+
763
+ sig { returns(T.nilable(String)) }
764
+ attr_reader :profile_image_shape
765
+
766
+ sig { params(profile_image_shape: String).void }
767
+ attr_writer :profile_image_shape
768
+
769
+ sig { returns(T.nilable(String)) }
770
+ attr_reader :profile_interstitial_type
771
+
772
+ sig { params(profile_interstitial_type: String).void }
773
+ attr_writer :profile_interstitial_type
774
+
775
+ sig { returns(T.nilable(T::Boolean)) }
776
+ attr_reader :profile_sort_enabled
777
+
778
+ sig { params(profile_sort_enabled: T::Boolean).void }
779
+ attr_writer :profile_sort_enabled
780
+
781
+ sig { returns(T.nilable(String)) }
782
+ attr_reader :profile_translator_type
783
+
784
+ sig { params(profile_translator_type: String).void }
785
+ attr_writer :profile_translator_type
786
+
787
+ # Handle x.com sends this profile's visitors to, such as the new handle of a
788
+ # renamed account whose old handle now holds a placeholder. Missing when x.com
789
+ # shows the profile itself.
790
+ sig { returns(T.nilable(String)) }
791
+ attr_reader :redirects_to_username
792
+
793
+ sig { params(redirects_to_username: String).void }
794
+ attr_writer :redirects_to_username
795
+
796
+ sig { returns(T.nilable(T::Boolean)) }
797
+ attr_reader :super_follow_eligible
798
+
799
+ sig { params(super_follow_eligible: T::Boolean).void }
800
+ attr_writer :super_follow_eligible
801
+
802
+ # Whether X marks the subscription profile as active.
803
+ sig { returns(T.nilable(T::Boolean)) }
804
+ attr_reader :super_follows_user_profile_active
805
+
806
+ sig { params(super_follows_user_profile_active: T::Boolean).void }
807
+ attr_writer :super_follows_user_profile_active
808
+
809
+ # Public payment and creator-support handles shown on X.
810
+ sig { returns(T.nilable(XTwitterScraper::Models::UserTipJar)) }
811
+ attr_reader :tip_jar
812
+
813
+ sig do
814
+ params(tip_jar: XTwitterScraper::Models::UserTipJar::OrHash).void
815
+ end
816
+ attr_writer :tip_jar
817
+
818
+ # Public lists that include the profile.
819
+ sig { returns(T.nilable(Integer)) }
820
+ attr_reader :listed_count
821
+
822
+ sig { params(listed_count: Integer).void }
823
+ attr_writer :listed_count
824
+
825
+ # Followers X counts as fast followers.
826
+ sig { returns(T.nilable(Integer)) }
827
+ attr_reader :fast_followers_count
828
+
829
+ sig { params(fast_followers_count: Integer).void }
830
+ attr_writer :fast_followers_count
831
+
832
+ # Followers minus fast followers.
833
+ sig { returns(T.nilable(Integer)) }
834
+ attr_reader :normal_followers_count
835
+
836
+ sig { params(normal_followers_count: Integer).void }
837
+ attr_writer :normal_followers_count
838
+
839
+ # Whether the profile keeps X's default theme.
840
+ sig { returns(T.nilable(T::Boolean)) }
841
+ attr_reader :default_profile
842
+
843
+ sig { params(default_profile: T::Boolean).void }
844
+ attr_writer :default_profile
845
+
846
+ # Whether the profile keeps X's default avatar.
847
+ sig { returns(T.nilable(T::Boolean)) }
848
+ attr_reader :default_profile_image
849
+
850
+ sig { params(default_profile_image: T::Boolean).void }
851
+ attr_writer :default_profile_image
852
+
853
+ # Whether the profile filled X's extended fields, such as a birth date. True or
854
+ # false.
855
+ sig { returns(T.nilable(T::Boolean)) }
856
+ attr_reader :has_extended_profile
857
+
858
+ sig { params(has_extended_profile: T::Boolean).void }
859
+ attr_writer :has_extended_profile
860
+
861
+ # Whether the account turned on X's translation of its posts. True or false.
862
+ sig { returns(T.nilable(T::Boolean)) }
863
+ attr_reader :is_translation_enabled
864
+
865
+ sig { params(is_translation_enabled: T::Boolean).void }
866
+ attr_writer :is_translation_enabled
867
+
868
+ # Whether the profile may add a location to posts.
869
+ sig { returns(T.nilable(T::Boolean)) }
870
+ attr_reader :geo_enabled
871
+
872
+ sig { params(geo_enabled: T::Boolean).void }
873
+ attr_writer :geo_enabled
874
+
875
+ # The account's X Ads type. `none` for an account without ads, or
876
+ # `promotable_user` for one that may run them.
877
+ sig { returns(T.nilable(String)) }
878
+ attr_reader :advertiser_account_type
879
+
880
+ sig { params(advertiser_account_type: String).void }
881
+ attr_writer :advertiser_account_type
882
+
883
+ # X Ads services the account uses, such as `analytics`, `media_studio` or `smb`.
884
+ # Empty for an account without ads.
885
+ sig { returns(T.nilable(T::Array[String])) }
886
+ attr_reader :advertiser_account_service_levels
887
+
888
+ sig { params(advertiser_account_service_levels: T::Array[String]).void }
889
+ attr_writer :advertiser_account_service_levels
890
+
891
+ # Whether X treats the profile as a business profile. `none` or `enabled`.
892
+ sig { returns(T.nilable(String)) }
893
+ attr_reader :business_profile_state
894
+
895
+ sig { params(business_profile_state: String).void }
896
+ attr_writer :business_profile_state
897
+
898
+ # Accounts subscribed to the profile's paid Subscriptions. 0 when it has none.
899
+ sig { returns(T.nilable(Integer)) }
900
+ attr_reader :subscribers_count
901
+
902
+ sig { params(subscribers_count: Integer).void }
903
+ attr_writer :subscribers_count
904
+
905
+ # X's text on why the profile is verified, with its links.
906
+ sig do
907
+ returns(
908
+ T.nilable(
909
+ XTwitterScraper::Models::Community::Creator::VerificationReason
910
+ )
911
+ )
912
+ end
913
+ attr_reader :verification_reason
914
+
915
+ sig do
916
+ params(
917
+ verification_reason:
918
+ XTwitterScraper::Models::Community::Creator::VerificationReason::OrHash
919
+ ).void
920
+ end
921
+ attr_writer :verification_reason
922
+
923
+ # Community role when returned by community member reads
924
+ sig { returns(T.nilable(String)) }
925
+ attr_reader :community_role
926
+
927
+ sig { params(community_role: String).void }
928
+ attr_writer :community_role
929
+
930
+ # Structured profile bio with entity annotations
931
+ sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
932
+ attr_reader :profile_bio
933
+
934
+ sig { params(profile_bio: T::Hash[Symbol, T.anything]).void }
935
+ attr_writer :profile_bio
936
+
937
+ sig do
938
+ params(
939
+ id: String,
940
+ username: String,
941
+ verified: T::Boolean,
942
+ name: String,
943
+ description: String,
944
+ followers: Integer,
945
+ following: Integer,
946
+ is_blue_verified: T::Boolean,
947
+ is_verified: T::Boolean,
948
+ profile_picture: String,
949
+ profile_picture_original: String,
950
+ cover_picture: String,
951
+ profile_banner_url: String,
952
+ location: String,
953
+ account_based_in:
954
+ T.nilable(XTwitterScraper::Models::AccountBasedIn::OrHash),
955
+ account_based_in_unavailable: T::Boolean,
956
+ account_based_in_accurate: T::Boolean,
957
+ connected_via: String,
958
+ connected_via_accurate: T::Boolean,
959
+ affiliate_username: String,
960
+ email: String,
961
+ contact_info: XTwitterScraper::Models::ProfileContactInfo::OrHash,
962
+ username_changes:
963
+ XTwitterScraper::Models::Community::Creator::UsernameChanges::OrHash,
964
+ birthdate:
965
+ XTwitterScraper::Models::Community::Creator::Birthdate::OrHash,
966
+ retweeted_at: T.nilable(Time),
967
+ created_at: String,
968
+ statuses_count: Integer,
969
+ media_count: Integer,
970
+ protected: T::Boolean,
971
+ url: String,
972
+ favourites_count: Integer,
973
+ has_custom_timelines: T::Boolean,
974
+ is_translator: T::Boolean,
975
+ withheld_in_countries: T::Array[String],
976
+ withheld_scope: String,
977
+ possibly_sensitive: T::Boolean,
978
+ professional: T::Hash[Symbol, T.anything],
979
+ grok_translated_bio: T::Hash[Symbol, T.anything],
980
+ pinned_tweet_ids: T::Array[String],
981
+ is_automated: T::Boolean,
982
+ automated_by: String,
983
+ unavailable: T::Boolean,
984
+ unavailable_reason: String,
985
+ verified_type: String,
986
+ affiliates_highlighted_label:
987
+ XTwitterScraper::Models::UserAffiliateLabel::OrHash,
988
+ business_account_affiliates_count: Integer,
989
+ creator_subscriptions_count: Integer,
990
+ has_graduated_access: T::Boolean,
991
+ has_hidden_subscriptions_on_profile: T::Boolean,
992
+ highlights_info:
993
+ XTwitterScraper::Models::UserHighlightsInfo::OrHash,
994
+ identity_verification:
995
+ XTwitterScraper::Models::UserIdentityVerification::OrHash,
996
+ is_profile_translatable: T::Boolean,
997
+ parody_commentary_fan_label: String,
998
+ profile_description_language: String,
999
+ profile_image_shape: String,
1000
+ profile_interstitial_type: String,
1001
+ profile_sort_enabled: T::Boolean,
1002
+ profile_translator_type: String,
1003
+ redirects_to_username: String,
1004
+ super_follow_eligible: T::Boolean,
1005
+ super_follows_user_profile_active: T::Boolean,
1006
+ tip_jar: XTwitterScraper::Models::UserTipJar::OrHash,
1007
+ listed_count: Integer,
1008
+ fast_followers_count: Integer,
1009
+ normal_followers_count: Integer,
1010
+ default_profile: T::Boolean,
1011
+ default_profile_image: T::Boolean,
1012
+ has_extended_profile: T::Boolean,
1013
+ is_translation_enabled: T::Boolean,
1014
+ geo_enabled: T::Boolean,
1015
+ advertiser_account_type: String,
1016
+ advertiser_account_service_levels: T::Array[String],
1017
+ business_profile_state: String,
1018
+ subscribers_count: Integer,
1019
+ verification_reason:
1020
+ XTwitterScraper::Models::Community::Creator::VerificationReason::OrHash,
1021
+ community_role: String,
1022
+ profile_bio: T::Hash[Symbol, T.anything]
1023
+ ).returns(T.attached_class)
1024
+ end
1025
+ def self.new(
1026
+ id:,
1027
+ username:,
1028
+ verified:,
1029
+ name: nil,
1030
+ description: nil,
1031
+ # Omitted when X sends no count, as for the account that first posted reused
1032
+ # media.
1033
+ followers: nil,
1034
+ following: nil,
1035
+ # Whether X shows a blue verification badge
1036
+ is_blue_verified: nil,
1037
+ # Whether X marks the profile as verified
1038
+ is_verified: nil,
1039
+ # Profile picture at 48 px, as X sends it.
1040
+ profile_picture: nil,
1041
+ # The same profile picture at full size, as the account uploaded it. Download this
1042
+ # one for the image.
1043
+ profile_picture_original: nil,
1044
+ cover_picture: nil,
1045
+ # Original X profile banner field when available
1046
+ profile_banner_url: nil,
1047
+ # Account owner's public profile location text
1048
+ location: nil,
1049
+ # Null when X shows no label.
1050
+ account_based_in: nil,
1051
+ # True when X withheld accountBasedIn from this read. Retry later.
1052
+ account_based_in_unavailable: nil,
1053
+ # False when X notes accountBasedIn may be inaccurate.
1054
+ account_based_in_accurate: nil,
1055
+ # How the account first connected to X.
1056
+ connected_via: nil,
1057
+ # False when X notes that country may be inaccurate.
1058
+ connected_via_accurate: nil,
1059
+ # Handle of the organization X shows the account is affiliated with, from its
1060
+ # About page.
1061
+ affiliate_username: nil,
1062
+ # First email the account publishes on its profile, lowercased. Omitted when it
1063
+ # publishes none.
1064
+ email: nil,
1065
+ # Emails, phone numbers & links the account publishes on its own profile. Omitted
1066
+ # when it publishes none.
1067
+ contact_info: nil,
1068
+ # How often the account changed its username.
1069
+ username_changes: nil,
1070
+ # The parts of the birthday the account made public.
1071
+ birthdate: nil,
1072
+ # UTC repost time with includeRetweetTimestamp. Null when Xquik found no repost
1073
+ # time. Otherwise omitted.
1074
+ retweeted_at: nil,
1075
+ # Account creation time.
1076
+ created_at: nil,
1077
+ statuses_count: nil,
1078
+ media_count: nil,
1079
+ # Whether the profile protects its posts
1080
+ protected: nil,
1081
+ url: nil,
1082
+ favourites_count: nil,
1083
+ has_custom_timelines: nil,
1084
+ is_translator: nil,
1085
+ withheld_in_countries: nil,
1086
+ # Whether X withholds a post or user
1087
+ withheld_scope: nil,
1088
+ possibly_sensitive: nil,
1089
+ # Professional metadata with category display settings
1090
+ professional: nil,
1091
+ # Public profile bio translation returned by X
1092
+ grok_translated_bio: nil,
1093
+ pinned_tweet_ids: nil,
1094
+ is_automated: nil,
1095
+ automated_by: nil,
1096
+ unavailable: nil,
1097
+ unavailable_reason: nil,
1098
+ verified_type: nil,
1099
+ # Organization affiliation label shown on an X profile.
1100
+ affiliates_highlighted_label: nil,
1101
+ # Whole number from 0.
1102
+ business_account_affiliates_count: nil,
1103
+ # Whole number from 0.
1104
+ creator_subscriptions_count: nil,
1105
+ has_graduated_access: nil,
1106
+ has_hidden_subscriptions_on_profile: nil,
1107
+ # Profile highlight availability and count metadata.
1108
+ highlights_info: nil,
1109
+ # Identity verification X shows on the profile & its About page.
1110
+ identity_verification: nil,
1111
+ is_profile_translatable: nil,
1112
+ parody_commentary_fan_label: nil,
1113
+ profile_description_language: nil,
1114
+ profile_image_shape: nil,
1115
+ profile_interstitial_type: nil,
1116
+ profile_sort_enabled: nil,
1117
+ profile_translator_type: nil,
1118
+ # Handle x.com sends this profile's visitors to, such as the new handle of a
1119
+ # renamed account whose old handle now holds a placeholder. Missing when x.com
1120
+ # shows the profile itself.
1121
+ redirects_to_username: nil,
1122
+ super_follow_eligible: nil,
1123
+ # Whether X marks the subscription profile as active.
1124
+ super_follows_user_profile_active: nil,
1125
+ # Public payment and creator-support handles shown on X.
1126
+ tip_jar: nil,
1127
+ # Public lists that include the profile.
1128
+ listed_count: nil,
1129
+ # Followers X counts as fast followers.
1130
+ fast_followers_count: nil,
1131
+ # Followers minus fast followers.
1132
+ normal_followers_count: nil,
1133
+ # Whether the profile keeps X's default theme.
1134
+ default_profile: nil,
1135
+ # Whether the profile keeps X's default avatar.
1136
+ default_profile_image: nil,
1137
+ # Whether the profile filled X's extended fields, such as a birth date. True or
1138
+ # false.
1139
+ has_extended_profile: nil,
1140
+ # Whether the account turned on X's translation of its posts. True or false.
1141
+ is_translation_enabled: nil,
1142
+ # Whether the profile may add a location to posts.
1143
+ geo_enabled: nil,
1144
+ # The account's X Ads type. `none` for an account without ads, or
1145
+ # `promotable_user` for one that may run them.
1146
+ advertiser_account_type: nil,
1147
+ # X Ads services the account uses, such as `analytics`, `media_studio` or `smb`.
1148
+ # Empty for an account without ads.
1149
+ advertiser_account_service_levels: nil,
1150
+ # Whether X treats the profile as a business profile. `none` or `enabled`.
1151
+ business_profile_state: nil,
1152
+ # Accounts subscribed to the profile's paid Subscriptions. 0 when it has none.
1153
+ subscribers_count: nil,
1154
+ # X's text on why the profile is verified, with its links.
1155
+ verification_reason: nil,
1156
+ # Community role when returned by community member reads
1157
+ community_role: nil,
1158
+ # Structured profile bio with entity annotations
1159
+ profile_bio: nil
1160
+ )
1161
+ end
1162
+
1163
+ sig do
1164
+ override.returns(
1165
+ {
1166
+ id: String,
1167
+ username: String,
1168
+ name: String,
1169
+ description: String,
1170
+ followers: Integer,
1171
+ following: Integer,
1172
+ verified: T::Boolean,
1173
+ is_blue_verified: T::Boolean,
1174
+ is_verified: T::Boolean,
1175
+ profile_picture: String,
1176
+ profile_picture_original: String,
1177
+ cover_picture: String,
1178
+ profile_banner_url: String,
1179
+ location: String,
1180
+ account_based_in: XTwitterScraper::Models::AccountBasedIn,
1181
+ account_based_in_unavailable: T::Boolean,
1182
+ account_based_in_accurate: T::Boolean,
1183
+ connected_via: String,
1184
+ connected_via_accurate: T::Boolean,
1185
+ affiliate_username: String,
1186
+ email: String,
1187
+ contact_info: XTwitterScraper::Models::ProfileContactInfo,
1188
+ username_changes:
1189
+ XTwitterScraper::Models::Community::Creator::UsernameChanges,
1190
+ birthdate: XTwitterScraper::Models::Community::Creator::Birthdate,
1191
+ retweeted_at: Time,
1192
+ created_at: String,
1193
+ statuses_count: Integer,
1194
+ media_count: Integer,
1195
+ protected: T::Boolean,
1196
+ url: String,
1197
+ favourites_count: Integer,
1198
+ has_custom_timelines: T::Boolean,
1199
+ is_translator: T::Boolean,
1200
+ withheld_in_countries: T::Array[String],
1201
+ withheld_scope: String,
1202
+ possibly_sensitive: T::Boolean,
1203
+ professional: T::Hash[Symbol, T.anything],
1204
+ grok_translated_bio: T::Hash[Symbol, T.anything],
1205
+ pinned_tweet_ids: T::Array[String],
1206
+ is_automated: T::Boolean,
1207
+ automated_by: String,
1208
+ unavailable: T::Boolean,
1209
+ unavailable_reason: String,
1210
+ verified_type: String,
1211
+ affiliates_highlighted_label:
1212
+ XTwitterScraper::Models::UserAffiliateLabel,
1213
+ business_account_affiliates_count: Integer,
1214
+ creator_subscriptions_count: Integer,
1215
+ has_graduated_access: T::Boolean,
1216
+ has_hidden_subscriptions_on_profile: T::Boolean,
1217
+ highlights_info: XTwitterScraper::Models::UserHighlightsInfo,
1218
+ identity_verification:
1219
+ XTwitterScraper::Models::UserIdentityVerification,
1220
+ is_profile_translatable: T::Boolean,
1221
+ parody_commentary_fan_label: String,
1222
+ profile_description_language: String,
1223
+ profile_image_shape: String,
1224
+ profile_interstitial_type: String,
1225
+ profile_sort_enabled: T::Boolean,
1226
+ profile_translator_type: String,
1227
+ redirects_to_username: String,
1228
+ super_follow_eligible: T::Boolean,
1229
+ super_follows_user_profile_active: T::Boolean,
1230
+ tip_jar: XTwitterScraper::Models::UserTipJar,
1231
+ listed_count: Integer,
1232
+ fast_followers_count: Integer,
1233
+ normal_followers_count: Integer,
1234
+ default_profile: T::Boolean,
1235
+ default_profile_image: T::Boolean,
1236
+ has_extended_profile: T::Boolean,
1237
+ is_translation_enabled: T::Boolean,
1238
+ geo_enabled: T::Boolean,
1239
+ advertiser_account_type: String,
1240
+ advertiser_account_service_levels: T::Array[String],
1241
+ business_profile_state: String,
1242
+ subscribers_count: Integer,
1243
+ verification_reason:
1244
+ XTwitterScraper::Models::Community::Creator::VerificationReason,
1245
+ community_role: String,
1246
+ profile_bio: T::Hash[Symbol, T.anything]
1247
+ }
1248
+ )
1249
+ end
1250
+ def to_hash
1251
+ end
1252
+
1253
+ class UsernameChanges < XTwitterScraper::Internal::Type::BaseModel
1254
+ OrHash =
1255
+ T.type_alias do
1256
+ T.any(
1257
+ XTwitterScraper::Models::Community::Creator::UsernameChanges,
1258
+ XTwitterScraper::Internal::AnyHash
1259
+ )
1260
+ end
1261
+
1262
+ # Whole number from 0.
1263
+ sig { returns(Integer) }
1264
+ attr_accessor :count
1265
+
1266
+ # Time of the latest change, omitted when there is none.
1267
+ sig { returns(T.nilable(Time)) }
1268
+ attr_reader :last_changed_at
1269
+
1270
+ sig { params(last_changed_at: Time).void }
1271
+ attr_writer :last_changed_at
1272
+
1273
+ sig do
1274
+ params(count: Integer, last_changed_at: Time).returns(
1275
+ T.attached_class
1276
+ )
1277
+ end
1278
+ def self.new(
1279
+ # Whole number from 0.
1280
+ count:,
1281
+ # Time of the latest change, omitted when there is none.
1282
+ last_changed_at: nil
1283
+ )
1284
+ end
1285
+
1286
+ sig { override.returns({ count: Integer, last_changed_at: Time }) }
1287
+ def to_hash
1288
+ end
1289
+ end
1290
+
1291
+ class Birthdate < XTwitterScraper::Internal::Type::BaseModel
1292
+ OrHash =
1293
+ T.type_alias do
1294
+ T.any(
1295
+ XTwitterScraper::Models::Community::Creator::Birthdate,
1296
+ XTwitterScraper::Internal::AnyHash
1297
+ )
1298
+ end
1299
+
1300
+ sig { returns(T.nilable(Integer)) }
1301
+ attr_reader :day
1302
+
1303
+ sig { params(day: Integer).void }
1304
+ attr_writer :day
1305
+
1306
+ sig { returns(T.nilable(Integer)) }
1307
+ attr_reader :month
1308
+
1309
+ sig { params(month: Integer).void }
1310
+ attr_writer :month
1311
+
1312
+ sig { returns(T.nilable(Integer)) }
1313
+ attr_reader :year
1314
+
1315
+ sig { params(year: Integer).void }
1316
+ attr_writer :year
1317
+
1318
+ sig do
1319
+ params(day: Integer, month: Integer, year: Integer).returns(
1320
+ T.attached_class
1321
+ )
1322
+ end
1323
+ def self.new(day: nil, month: nil, year: nil)
1324
+ end
1325
+
1326
+ sig do
1327
+ override.returns({ day: Integer, month: Integer, year: Integer })
1328
+ end
1329
+ def to_hash
1330
+ end
1331
+ end
1332
+
1333
+ class VerificationReason < XTwitterScraper::Internal::Type::BaseModel
1334
+ OrHash =
1335
+ T.type_alias do
1336
+ T.any(
1337
+ XTwitterScraper::Models::Community::Creator::VerificationReason,
1338
+ XTwitterScraper::Internal::AnyHash
1339
+ )
1340
+ end
1341
+
1342
+ sig { returns(T.nilable(String)) }
1343
+ attr_reader :text
1344
+
1345
+ sig { params(text: String).void }
1346
+ attr_writer :text
1347
+
1348
+ # Links inside the text, by character range.
1349
+ sig do
1350
+ returns(
1351
+ T.nilable(
1352
+ T::Array[
1353
+ XTwitterScraper::Models::Community::Creator::VerificationReason::Entity
1354
+ ]
1355
+ )
1356
+ )
1357
+ end
1358
+ attr_reader :entities
1359
+
1360
+ sig do
1361
+ params(
1362
+ entities:
1363
+ T::Array[
1364
+ XTwitterScraper::Models::Community::Creator::VerificationReason::Entity::OrHash
1365
+ ]
1366
+ ).void
1367
+ end
1368
+ attr_writer :entities
1369
+
1370
+ sig do
1371
+ params(
1372
+ text: String,
1373
+ entities:
1374
+ T::Array[
1375
+ XTwitterScraper::Models::Community::Creator::VerificationReason::Entity::OrHash
1376
+ ]
1377
+ ).returns(T.attached_class)
1378
+ end
1379
+ def self.new(
1380
+ text: nil,
1381
+ # Links inside the text, by character range.
1382
+ entities: nil
1383
+ )
1384
+ end
1385
+
1386
+ sig do
1387
+ override.returns(
1388
+ {
1389
+ text: String,
1390
+ entities:
1391
+ T::Array[
1392
+ XTwitterScraper::Models::Community::Creator::VerificationReason::Entity
1393
+ ]
1394
+ }
1395
+ )
1396
+ end
1397
+ def to_hash
1398
+ end
1399
+
1400
+ class Entity < XTwitterScraper::Internal::Type::BaseModel
1401
+ OrHash =
1402
+ T.type_alias do
1403
+ T.any(
1404
+ XTwitterScraper::Models::Community::Creator::VerificationReason::Entity,
1405
+ XTwitterScraper::Internal::AnyHash
1406
+ )
1407
+ end
1408
+
1409
+ # Whole number from 0.
1410
+ sig { returns(T.nilable(Integer)) }
1411
+ attr_reader :from_index
1412
+
1413
+ sig { params(from_index: Integer).void }
1414
+ attr_writer :from_index
1415
+
1416
+ # Whole number from 0.
1417
+ sig { returns(T.nilable(Integer)) }
1418
+ attr_reader :to_index
1419
+
1420
+ sig { params(to_index: Integer).void }
1421
+ attr_writer :to_index
1422
+
1423
+ sig { returns(T.nilable(String)) }
1424
+ attr_reader :url
1425
+
1426
+ sig { params(url: String).void }
1427
+ attr_writer :url
1428
+
1429
+ sig { returns(T.nilable(String)) }
1430
+ attr_reader :url_type
1431
+
1432
+ sig { params(url_type: String).void }
1433
+ attr_writer :url_type
1434
+
1435
+ sig do
1436
+ params(
1437
+ from_index: Integer,
1438
+ to_index: Integer,
1439
+ url: String,
1440
+ url_type: String
1441
+ ).returns(T.attached_class)
1442
+ end
1443
+ def self.new(
1444
+ # Whole number from 0.
1445
+ from_index: nil,
1446
+ # Whole number from 0.
1447
+ to_index: nil,
1448
+ url: nil,
1449
+ url_type: nil
1450
+ )
1451
+ end
1452
+
1453
+ sig do
1454
+ override.returns(
1455
+ {
1456
+ from_index: Integer,
1457
+ to_index: Integer,
1458
+ url: String,
1459
+ url_type: String
1460
+ }
1461
+ )
1462
+ end
1463
+ def to_hash
1464
+ end
1465
+ end
1466
+ end
1467
+ end
1468
+
1469
+ module MembersFacepile
1470
+ extend XTwitterScraper::Internal::Type::Union
1471
+
1472
+ Variants =
1473
+ T.type_alias do
1474
+ T.any(
1475
+ XTwitterScraper::Models::UserProfile,
1476
+ XTwitterScraper::Models::CommunityMemberPreview
1477
+ )
1478
+ end
1479
+
1480
+ sig do
1481
+ override.returns(
1482
+ T::Array[
1483
+ XTwitterScraper::Models::Community::MembersFacepile::Variants
1484
+ ]
1485
+ )
1486
+ end
1487
+ def self.variants
1488
+ end
1489
+ end
1490
+ end
1491
+ end
1492
+ end