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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +31 -0
- data/README.md +1 -1
- data/lib/x_twitter_scraper/client.rb +4 -0
- data/lib/x_twitter_scraper/internal/stream.rb +34 -0
- data/lib/x_twitter_scraper/internal/type/base_model.rb +2 -0
- data/lib/x_twitter_scraper/internal/type/converter.rb +2 -0
- data/lib/x_twitter_scraper/internal/type/union.rb +6 -2
- data/lib/x_twitter_scraper/models/activity_export_params.rb +113 -0
- data/lib/x_twitter_scraper/models/activity_list_params.rb +107 -0
- data/lib/x_twitter_scraper/models/activity_list_response.rb +13 -0
- data/lib/x_twitter_scraper/models/activity_log_row.rb +123 -0
- data/lib/x_twitter_scraper/models/activity_record.rb +489 -0
- data/lib/x_twitter_scraper/models/activity_retrieve_params.rb +27 -0
- data/lib/x_twitter_scraper/models/audited_follower.rb +114 -0
- data/lib/x_twitter_scraper/models/batch_user_tweets.rb +84 -0
- data/lib/x_twitter_scraper/models/broadcast.rb +261 -0
- data/lib/x_twitter_scraper/models/community.rb +957 -0
- data/lib/x_twitter_scraper/models/community_analytics.rb +89 -0
- data/lib/x_twitter_scraper/models/community_analytics_metric.rb +30 -0
- data/lib/x_twitter_scraper/models/community_banner.rb +126 -0
- data/lib/x_twitter_scraper/models/community_member_preview.rb +38 -0
- data/lib/x_twitter_scraper/models/community_note.rb +257 -0
- data/lib/x_twitter_scraper/models/community_note_entity.rb +83 -0
- data/lib/x_twitter_scraper/models/community_notes_contributor.rb +64 -0
- data/lib/x_twitter_scraper/models/community_notes_note_counts.rb +46 -0
- data/lib/x_twitter_scraper/models/community_notes_rating_counts.rb +54 -0
- data/lib/x_twitter_scraper/models/community_notes_rating_outcome.rb +38 -0
- data/lib/x_twitter_scraper/models/community_page.rb +38 -0
- data/lib/x_twitter_scraper/models/community_topic.rb +57 -0
- data/lib/x_twitter_scraper/models/event_stream_params.rb +55 -0
- data/lib/x_twitter_scraper/models/extraction_cancel_params.rb +27 -0
- data/lib/x_twitter_scraper/models/extraction_cancel_response.rb +27 -0
- data/lib/x_twitter_scraper/models/follower_audit.rb +300 -0
- data/lib/x_twitter_scraper/models/follower_class.rb +23 -0
- data/lib/x_twitter_scraper/models/follower_value_count.rb +35 -0
- data/lib/x_twitter_scraper/models/football_box_score.rb +73 -0
- data/lib/x_twitter_scraper/models/football_drive.rb +122 -0
- data/lib/x_twitter_scraper/models/football_fumble_stats.rb +38 -0
- data/lib/x_twitter_scraper/models/football_odds.rb +38 -0
- data/lib/x_twitter_scraper/models/football_passing_stats.rb +94 -0
- data/lib/x_twitter_scraper/models/football_period.rb +54 -0
- data/lib/x_twitter_scraper/models/football_play.rb +279 -0
- data/lib/x_twitter_scraper/models/football_play_detail.rb +134 -0
- data/lib/x_twitter_scraper/models/football_player.rb +196 -0
- data/lib/x_twitter_scraper/models/football_player_prop.rb +66 -0
- data/lib/x_twitter_scraper/models/football_player_stats.rb +372 -0
- data/lib/x_twitter_scraper/models/football_plays.rb +81 -0
- data/lib/x_twitter_scraper/models/football_prop_category.rb +46 -0
- data/lib/x_twitter_scraper/models/football_props.rb +66 -0
- data/lib/x_twitter_scraper/models/football_quarter.rb +46 -0
- data/lib/x_twitter_scraper/models/football_return_stats.rb +54 -0
- data/lib/x_twitter_scraper/models/football_roster.rb +65 -0
- data/lib/x_twitter_scraper/models/football_roster_team.rb +30 -0
- data/lib/x_twitter_scraper/models/football_rushing_stats.rb +54 -0
- data/lib/x_twitter_scraper/models/football_schedule.rb +49 -0
- data/lib/x_twitter_scraper/models/football_schedule_game.rb +131 -0
- data/lib/x_twitter_scraper/models/football_schedule_period.rb +22 -0
- data/lib/x_twitter_scraper/models/football_scoreboard.rb +209 -0
- data/lib/x_twitter_scraper/models/football_side.rb +38 -0
- data/lib/x_twitter_scraper/models/football_team_box.rb +38 -0
- data/lib/x_twitter_scraper/models/football_team_score.rb +30 -0
- data/lib/x_twitter_scraper/models/football_team_totals.rb +128 -0
- data/lib/x_twitter_scraper/models/hashflag.rb +89 -0
- data/lib/x_twitter_scraper/models/job.rb +194 -0
- data/lib/x_twitter_scraper/models/job_account.rb +87 -0
- data/lib/x_twitter_scraper/models/job_company.rb +38 -0
- data/lib/x_twitter_scraper/models/job_location.rb +30 -0
- data/lib/x_twitter_scraper/models/job_locations.rb +30 -0
- data/lib/x_twitter_scraper/models/monitor_upsert_by_username_params.rb +44 -0
- data/lib/x_twitter_scraper/models/monitor_upsert_by_username_response.rb +116 -0
- data/lib/x_twitter_scraper/models/monitors/post_create_params.rb +55 -0
- data/lib/x_twitter_scraper/models/monitors/post_delete_params.rb +28 -0
- data/lib/x_twitter_scraper/models/monitors/post_delete_response.rb +37 -0
- data/lib/x_twitter_scraper/models/monitors/post_list_params.rb +38 -0
- data/lib/x_twitter_scraper/models/monitors/post_list_response.rb +44 -0
- data/lib/x_twitter_scraper/models/monitors/post_retrieve_metrics_params.rb +36 -0
- data/lib/x_twitter_scraper/models/monitors/post_retrieve_params.rb +28 -0
- data/lib/x_twitter_scraper/models/monitors/post_update_params.rb +52 -0
- data/lib/x_twitter_scraper/models/news_version.rb +46 -0
- data/lib/x_twitter_scraper/models/paginated_community_notes.rb +37 -0
- data/lib/x_twitter_scraper/models/paginated_jobs.rb +37 -0
- data/lib/x_twitter_scraper/models/paginated_lists.rb +37 -0
- data/lib/x_twitter_scraper/models/paginated_user_ids.rb +38 -0
- data/lib/x_twitter_scraper/models/place.rb +116 -0
- data/lib/x_twitter_scraper/models/place_search_result.rb +124 -0
- data/lib/x_twitter_scraper/models/post_engagement_metrics.rb +62 -0
- data/lib/x_twitter_scraper/models/post_event_type.rb +31 -0
- data/lib/x_twitter_scraper/models/post_metric_point.rb +29 -0
- data/lib/x_twitter_scraper/models/post_metric_reading.rb +29 -0
- data/lib/x_twitter_scraper/models/post_metrics.rb +68 -0
- data/lib/x_twitter_scraper/models/post_monitor.rb +322 -0
- data/lib/x_twitter_scraper/models/post_monitor_metrics.rb +103 -0
- data/lib/x_twitter_scraper/models/profile_translation.rb +64 -0
- data/lib/x_twitter_scraper/models/resolved_link.rb +31 -0
- data/lib/x_twitter_scraper/models/search_suggestion_cashtag.rb +102 -0
- data/lib/x_twitter_scraper/models/search_suggestion_hashtag.rb +46 -0
- data/lib/x_twitter_scraper/models/search_suggestion_topic.rb +46 -0
- data/lib/x_twitter_scraper/models/search_suggestion_user.rb +174 -0
- data/lib/x_twitter_scraper/models/search_suggestions.rb +63 -0
- data/lib/x_twitter_scraper/models/shadowban_report.rb +833 -0
- data/lib/x_twitter_scraper/models/shadowban_verdict.rb +22 -0
- data/lib/x_twitter_scraper/models/space.rb +254 -0
- data/lib/x_twitter_scraper/models/space_participant.rb +116 -0
- data/lib/x_twitter_scraper/models/space_sharing.rb +54 -0
- data/lib/x_twitter_scraper/models/sports_game_audience.rb +195 -0
- data/lib/x_twitter_scraper/models/sports_game_posts.rb +152 -0
- data/lib/x_twitter_scraper/models/sports_team.rb +192 -0
- data/lib/x_twitter_scraper/models/sports_team_game.rb +78 -0
- data/lib/x_twitter_scraper/models/subtitle_track.rb +106 -0
- data/lib/x_twitter_scraper/models/trend_location.rb +77 -0
- data/lib/x_twitter_scraper/models/tweet_embed.rb +71 -0
- data/lib/x_twitter_scraper/models/tweet_entities.rb +56 -0
- data/lib/x_twitter_scraper/models/tweet_hashtag.rb +36 -0
- data/lib/x_twitter_scraper/models/tweet_insights.rb +111 -0
- data/lib/x_twitter_scraper/models/tweet_smart_tag.rb +64 -0
- data/lib/x_twitter_scraper/models/tweet_subtitles.rb +30 -0
- data/lib/x_twitter_scraper/models/tweet_symbol.rb +43 -0
- data/lib/x_twitter_scraper/models/tweet_translation.rb +56 -0
- data/lib/x_twitter_scraper/models/tweet_url_entity.rb +42 -0
- data/lib/x_twitter_scraper/models/tweet_user_mention.rb +42 -0
- data/lib/x_twitter_scraper/models/user_affiliate_label.rb +75 -0
- data/lib/x_twitter_scraper/models/user_auxiliary_label.rb +49 -0
- data/lib/x_twitter_scraper/models/user_highlights_info.rb +28 -0
- data/lib/x_twitter_scraper/models/user_identity_verification.rb +45 -0
- data/lib/x_twitter_scraper/models/user_insights.rb +229 -0
- data/lib/x_twitter_scraper/models/user_live_status.rb +48 -0
- data/lib/x_twitter_scraper/models/webhook_create_telegram_link_params.rb +26 -0
- data/lib/x_twitter_scraper/models/webhook_create_telegram_link_response.rb +29 -0
- data/lib/x_twitter_scraper/models/x/broadcast_retrieve_params.rb +53 -0
- data/lib/x_twitter_scraper/models/x/broadcast_retrieve_response.rb +23 -0
- data/lib/x_twitter_scraper/models/x/communities/media_list_params.rb +414 -0
- data/lib/x_twitter_scraper/models/x/community_find_params.rb +72 -0
- data/lib/x_twitter_scraper/models/x/community_list_popular_params.rb +81 -0
- data/lib/x_twitter_scraper/models/x/community_list_suggested_params.rb +54 -0
- data/lib/x_twitter_scraper/models/x/community_list_suggested_response.rb +39 -0
- data/lib/x_twitter_scraper/models/x/community_list_topics_params.rb +54 -0
- data/lib/x_twitter_scraper/models/x/community_list_topics_response.rb +39 -0
- data/lib/x_twitter_scraper/models/x/community_note_list_contributor_deleted_notes_params.rb +72 -0
- data/lib/x_twitter_scraper/models/x/community_note_list_contributor_notes_params.rb +72 -0
- data/lib/x_twitter_scraper/models/x/community_note_retrieve_contributor_params.rb +53 -0
- data/lib/x_twitter_scraper/models/x/community_note_retrieve_contributor_response.rb +25 -0
- data/lib/x_twitter_scraper/models/x/community_retrieve_analytics_params.rb +54 -0
- data/lib/x_twitter_scraper/models/x/community_search_members_params.rb +209 -0
- data/lib/x_twitter_scraper/models/x/dm_delete_message_params.rb +71 -0
- data/lib/x_twitter_scraper/models/x/job_list_locations_params.rb +62 -0
- data/lib/x_twitter_scraper/models/x/job_retrieve_params.rb +53 -0
- data/lib/x_twitter_scraper/models/x/job_retrieve_response.rb +25 -0
- data/lib/x_twitter_scraper/models/x/job_search_params.rb +127 -0
- data/lib/x_twitter_scraper/models/x/list_retrieve_params.rb +52 -0
- data/lib/x_twitter_scraper/models/x/list_retrieve_response.rb +23 -0
- data/lib/x_twitter_scraper/models/x/list_retrieve_search_params.rb +72 -0
- data/lib/x_twitter_scraper/models/x/space_retrieve_params.rb +52 -0
- data/lib/x_twitter_scraper/models/x/space_retrieve_replay_params.rb +52 -0
- data/lib/x_twitter_scraper/models/x/space_retrieve_replay_response.rb +52 -0
- data/lib/x_twitter_scraper/models/x/space_retrieve_response.rb +23 -0
- data/lib/x_twitter_scraper/models/x/space_search_params.rb +96 -0
- data/lib/x_twitter_scraper/models/x/space_search_response.rb +39 -0
- data/lib/x_twitter_scraper/models/x/sport_list_games_params.rb +91 -0
- data/lib/x_twitter_scraper/models/x/sport_list_posts_params.rb +112 -0
- data/lib/x_twitter_scraper/models/x/sport_retrieve_audience_params.rb +72 -0
- data/lib/x_twitter_scraper/models/x/sport_retrieve_box_score_params.rb +72 -0
- data/lib/x_twitter_scraper/models/x/sport_retrieve_player_props_params.rb +72 -0
- data/lib/x_twitter_scraper/models/x/sport_retrieve_plays_params.rb +72 -0
- data/lib/x_twitter_scraper/models/x/sport_retrieve_roster_params.rb +72 -0
- data/lib/x_twitter_scraper/models/x/sport_retrieve_scoreboard_params.rb +72 -0
- data/lib/x_twitter_scraper/models/x/tweet_check_repost_params.rb +59 -0
- data/lib/x_twitter_scraper/models/x/tweet_check_repost_response.rb +69 -0
- data/lib/x_twitter_scraper/models/x/tweet_embed_params.rb +98 -0
- data/lib/x_twitter_scraper/models/x/tweet_embed_response.rb +23 -0
- data/lib/x_twitter_scraper/models/x/tweet_get_hidden_replies_params.rb +412 -0
- data/lib/x_twitter_scraper/models/x/tweet_get_insights_params.rb +55 -0
- data/lib/x_twitter_scraper/models/x/tweet_get_insights_response.rb +24 -0
- data/lib/x_twitter_scraper/models/x/tweet_get_retweeter_ids_params.rb +51 -0
- data/lib/x_twitter_scraper/models/x/tweet_get_subtitles_params.rb +55 -0
- data/lib/x_twitter_scraper/models/x/tweet_get_subtitles_response.rb +23 -0
- data/lib/x_twitter_scraper/models/x/tweet_list_top_params.rb +124 -0
- data/lib/x_twitter_scraper/models/x/tweet_resolve_links_params.rb +54 -0
- data/lib/x_twitter_scraper/models/x/tweet_resolve_links_response.rb +33 -0
- data/lib/x_twitter_scraper/models/x/tweet_translate_params.rb +64 -0
- data/lib/x_twitter_scraper/models/x/tweet_translate_response.rb +25 -0
- data/lib/x_twitter_scraper/models/x/tweets/bookmark_create_params.rb +66 -0
- data/lib/x_twitter_scraper/models/x/tweets/bookmark_delete_params.rb +66 -0
- data/lib/x_twitter_scraper/models/x/user_retrieve_affiliates_params.rb +217 -0
- data/lib/x_twitter_scraper/models/x/user_retrieve_articles_params.rb +412 -0
- data/lib/x_twitter_scraper/models/x/user_retrieve_batch_response.rb +18 -1
- data/lib/x_twitter_scraper/models/x/user_retrieve_batch_tweets_params.rb +74 -0
- data/lib/x_twitter_scraper/models/x/user_retrieve_follower_audit_params.rb +65 -0
- data/lib/x_twitter_scraper/models/x/user_retrieve_follower_audit_response.rb +24 -0
- data/lib/x_twitter_scraper/models/x/user_retrieve_follower_ids_params.rb +46 -0
- data/lib/x_twitter_scraper/models/x/user_retrieve_following_ids_params.rb +46 -0
- data/lib/x_twitter_scraper/models/x/user_retrieve_highlights_params.rb +412 -0
- data/lib/x_twitter_scraper/models/x/user_retrieve_insights_params.rb +66 -0
- data/lib/x_twitter_scraper/models/x/user_retrieve_insights_response.rb +33 -0
- data/lib/x_twitter_scraper/models/x/user_retrieve_list_memberships_params.rb +71 -0
- data/lib/x_twitter_scraper/models/x/user_retrieve_lists_params.rb +71 -0
- data/lib/x_twitter_scraper/models/x/user_retrieve_live_params.rb +54 -0
- data/lib/x_twitter_scraper/models/x/user_retrieve_shadowban_params.rb +65 -0
- data/lib/x_twitter_scraper/models/x/user_retrieve_similar_params.rb +217 -0
- data/lib/x_twitter_scraper/models/x/user_retrieve_subscriptions_params.rb +217 -0
- data/lib/x_twitter_scraper/models/x/user_translate_bio_params.rb +63 -0
- data/lib/x_twitter_scraper/models/x/user_translate_bio_response.rb +31 -0
- data/lib/x_twitter_scraper/models/x/users/block_create_params.rb +65 -0
- data/lib/x_twitter_scraper/models/x/users/block_delete_params.rb +65 -0
- data/lib/x_twitter_scraper/models/x/users/mute_create_params.rb +65 -0
- data/lib/x_twitter_scraper/models/x/users/mute_delete_params.rb +65 -0
- data/lib/x_twitter_scraper/models/x_autocomplete_search_params.rb +73 -0
- data/lib/x_twitter_scraper/models/x_get_hashflags_params.rb +69 -0
- data/lib/x_twitter_scraper/models/x_get_hashflags_response.rb +44 -0
- data/lib/x_twitter_scraper/models/x_get_news_story_versions_params.rb +51 -0
- data/lib/x_twitter_scraper/models/x_get_news_story_versions_response.rb +36 -0
- data/lib/x_twitter_scraper/models/x_get_trend_locations_params.rb +91 -0
- data/lib/x_twitter_scraper/models/x_get_trend_locations_response.rb +44 -0
- data/lib/x_twitter_scraper/models/x_get_trends_history_params.rb +129 -0
- data/lib/x_twitter_scraper/models/x_get_trends_history_response.rb +161 -0
- data/lib/x_twitter_scraper/models/x_list.rb +118 -0
- data/lib/x_twitter_scraper/models/x_list_banner.rb +152 -0
- data/lib/x_twitter_scraper/models/x_search_places_params.rb +61 -0
- data/lib/x_twitter_scraper/models/x_search_places_response.rb +44 -0
- data/lib/x_twitter_scraper/models.rb +234 -0
- data/lib/x_twitter_scraper/resources/activity.rb +122 -0
- data/lib/x_twitter_scraper/resources/events.rb +42 -0
- data/lib/x_twitter_scraper/resources/extractions.rb +20 -0
- data/lib/x_twitter_scraper/resources/monitors/posts.rb +175 -0
- data/lib/x_twitter_scraper/resources/monitors.rb +35 -0
- data/lib/x_twitter_scraper/resources/webhooks.rb +28 -0
- data/lib/x_twitter_scraper/resources/x/broadcasts.rb +49 -0
- data/lib/x_twitter_scraper/resources/x/communities/media.rb +126 -0
- data/lib/x_twitter_scraper/resources/x/communities.rb +226 -0
- data/lib/x_twitter_scraper/resources/x/community_notes.rb +115 -0
- data/lib/x_twitter_scraper/resources/x/dm.rb +38 -0
- data/lib/x_twitter_scraper/resources/x/jobs.rb +124 -0
- data/lib/x_twitter_scraper/resources/x/lists.rb +62 -0
- data/lib/x_twitter_scraper/resources/x/spaces.rb +114 -0
- data/lib/x_twitter_scraper/resources/x/sports.rb +296 -0
- data/lib/x_twitter_scraper/resources/x/tweets/bookmark.rb +83 -0
- data/lib/x_twitter_scraper/resources/x/tweets.rb +363 -0
- data/lib/x_twitter_scraper/resources/x/users/block.rb +83 -0
- data/lib/x_twitter_scraper/resources/x/users/mute.rb +83 -0
- data/lib/x_twitter_scraper/resources/x/users.rb +743 -0
- data/lib/x_twitter_scraper/resources/x.rb +234 -0
- data/lib/x_twitter_scraper/version.rb +1 -1
- data/lib/x_twitter_scraper.rb +222 -0
- data/rbi/x_twitter_scraper/client.rbi +3 -0
- data/rbi/x_twitter_scraper/internal/stream.rbi +38 -0
- data/rbi/x_twitter_scraper/models/activity_export_params.rbi +236 -0
- data/rbi/x_twitter_scraper/models/activity_list_params.rbi +206 -0
- data/rbi/x_twitter_scraper/models/activity_list_response.rbi +17 -0
- data/rbi/x_twitter_scraper/models/activity_log_row.rbi +150 -0
- data/rbi/x_twitter_scraper/models/activity_record.rbi +1008 -0
- data/rbi/x_twitter_scraper/models/activity_retrieve_params.rbi +49 -0
- data/rbi/x_twitter_scraper/models/audited_follower.rbi +138 -0
- data/rbi/x_twitter_scraper/models/batch_user_tweets.rbi +115 -0
- data/rbi/x_twitter_scraper/models/broadcast.rbi +398 -0
- data/rbi/x_twitter_scraper/models/community.rbi +1492 -0
- data/rbi/x_twitter_scraper/models/community_analytics.rbi +179 -0
- data/rbi/x_twitter_scraper/models/community_analytics_metric.rbi +42 -0
- data/rbi/x_twitter_scraper/models/community_banner.rbi +224 -0
- data/rbi/x_twitter_scraper/models/community_member_preview.rbi +66 -0
- data/rbi/x_twitter_scraper/models/community_note.rbi +407 -0
- data/rbi/x_twitter_scraper/models/community_note_entity.rbi +157 -0
- data/rbi/x_twitter_scraper/models/community_notes_contributor.rbi +114 -0
- data/rbi/x_twitter_scraper/models/community_notes_note_counts.rbi +80 -0
- data/rbi/x_twitter_scraper/models/community_notes_rating_counts.rbi +107 -0
- data/rbi/x_twitter_scraper/models/community_notes_rating_outcome.rbi +65 -0
- data/rbi/x_twitter_scraper/models/community_page.rbi +67 -0
- data/rbi/x_twitter_scraper/models/community_topic.rbi +103 -0
- data/rbi/x_twitter_scraper/models/event_stream_params.rbi +121 -0
- data/rbi/x_twitter_scraper/models/extraction_cancel_params.rbi +49 -0
- data/rbi/x_twitter_scraper/models/extraction_cancel_response.rbi +33 -0
- data/rbi/x_twitter_scraper/models/follower_audit.rbi +565 -0
- data/rbi/x_twitter_scraper/models/follower_class.rbi +37 -0
- data/rbi/x_twitter_scraper/models/follower_value_count.rbi +42 -0
- data/rbi/x_twitter_scraper/models/football_box_score.rbi +152 -0
- data/rbi/x_twitter_scraper/models/football_drive.rbi +155 -0
- data/rbi/x_twitter_scraper/models/football_fumble_stats.rbi +60 -0
- data/rbi/x_twitter_scraper/models/football_odds.rbi +60 -0
- data/rbi/x_twitter_scraper/models/football_passing_stats.rbi +116 -0
- data/rbi/x_twitter_scraper/models/football_period.rbi +76 -0
- data/rbi/x_twitter_scraper/models/football_play.rbi +420 -0
- data/rbi/x_twitter_scraper/models/football_play_detail.rbi +231 -0
- data/rbi/x_twitter_scraper/models/football_player.rbi +276 -0
- data/rbi/x_twitter_scraper/models/football_player_prop.rbi +86 -0
- data/rbi/x_twitter_scraper/models/football_player_stats.rbi +643 -0
- data/rbi/x_twitter_scraper/models/football_plays.rbi +157 -0
- data/rbi/x_twitter_scraper/models/football_prop_category.rbi +75 -0
- data/rbi/x_twitter_scraper/models/football_props.rbi +135 -0
- data/rbi/x_twitter_scraper/models/football_quarter.rbi +75 -0
- data/rbi/x_twitter_scraper/models/football_return_stats.rbi +76 -0
- data/rbi/x_twitter_scraper/models/football_roster.rbi +139 -0
- data/rbi/x_twitter_scraper/models/football_roster_team.rbi +46 -0
- data/rbi/x_twitter_scraper/models/football_rushing_stats.rbi +76 -0
- data/rbi/x_twitter_scraper/models/football_schedule.rbi +117 -0
- data/rbi/x_twitter_scraper/models/football_schedule_game.rbi +215 -0
- data/rbi/x_twitter_scraper/models/football_schedule_period.rbi +34 -0
- data/rbi/x_twitter_scraper/models/football_scoreboard.rbi +343 -0
- data/rbi/x_twitter_scraper/models/football_side.rbi +60 -0
- data/rbi/x_twitter_scraper/models/football_team_box.rbi +77 -0
- data/rbi/x_twitter_scraper/models/football_team_score.rbi +48 -0
- data/rbi/x_twitter_scraper/models/football_team_totals.rbi +252 -0
- data/rbi/x_twitter_scraper/models/hashflag.rbi +144 -0
- data/rbi/x_twitter_scraper/models/job.rbi +276 -0
- data/rbi/x_twitter_scraper/models/job_account.rbi +129 -0
- data/rbi/x_twitter_scraper/models/job_company.rbi +56 -0
- data/rbi/x_twitter_scraper/models/job_location.rbi +40 -0
- data/rbi/x_twitter_scraper/models/job_locations.rbi +59 -0
- data/rbi/x_twitter_scraper/models/monitor_upsert_by_username_params.rbi +83 -0
- data/rbi/x_twitter_scraper/models/monitor_upsert_by_username_response.rbi +195 -0
- data/rbi/x_twitter_scraper/models/monitors/post_create_params.rbi +104 -0
- data/rbi/x_twitter_scraper/models/monitors/post_delete_params.rbi +49 -0
- data/rbi/x_twitter_scraper/models/monitors/post_delete_response.rbi +54 -0
- data/rbi/x_twitter_scraper/models/monitors/post_list_params.rbi +70 -0
- data/rbi/x_twitter_scraper/models/monitors/post_list_response.rbi +74 -0
- data/rbi/x_twitter_scraper/models/monitors/post_retrieve_metrics_params.rbi +63 -0
- data/rbi/x_twitter_scraper/models/monitors/post_retrieve_params.rbi +49 -0
- data/rbi/x_twitter_scraper/models/monitors/post_update_params.rbi +98 -0
- data/rbi/x_twitter_scraper/models/news_version.rbi +63 -0
- data/rbi/x_twitter_scraper/models/paginated_community_notes.rbi +63 -0
- data/rbi/x_twitter_scraper/models/paginated_jobs.rbi +59 -0
- data/rbi/x_twitter_scraper/models/paginated_lists.rbi +61 -0
- data/rbi/x_twitter_scraper/models/paginated_user_ids.rbi +58 -0
- data/rbi/x_twitter_scraper/models/place.rbi +166 -0
- data/rbi/x_twitter_scraper/models/place_search_result.rbi +191 -0
- data/rbi/x_twitter_scraper/models/post_engagement_metrics.rbi +84 -0
- data/rbi/x_twitter_scraper/models/post_event_type.rbi +80 -0
- data/rbi/x_twitter_scraper/models/post_metric_point.rbi +41 -0
- data/rbi/x_twitter_scraper/models/post_metric_reading.rbi +41 -0
- data/rbi/x_twitter_scraper/models/post_metrics.rbi +130 -0
- data/rbi/x_twitter_scraper/models/post_monitor.rbi +573 -0
- data/rbi/x_twitter_scraper/models/post_monitor_metrics.rbi +239 -0
- data/rbi/x_twitter_scraper/models/profile_translation.rbi +92 -0
- data/rbi/x_twitter_scraper/models/resolved_link.rbi +47 -0
- data/rbi/x_twitter_scraper/models/search_suggestion_cashtag.rbi +154 -0
- data/rbi/x_twitter_scraper/models/search_suggestion_hashtag.rbi +77 -0
- data/rbi/x_twitter_scraper/models/search_suggestion_topic.rbi +77 -0
- data/rbi/x_twitter_scraper/models/search_suggestion_user.rbi +278 -0
- data/rbi/x_twitter_scraper/models/search_suggestions.rbi +125 -0
- data/rbi/x_twitter_scraper/models/shadowban_report.rbi +2216 -0
- data/rbi/x_twitter_scraper/models/shadowban_verdict.rbi +36 -0
- data/rbi/x_twitter_scraper/models/space.rbi +375 -0
- data/rbi/x_twitter_scraper/models/space_participant.rbi +173 -0
- data/rbi/x_twitter_scraper/models/space_sharing.rbi +93 -0
- data/rbi/x_twitter_scraper/models/sports_game_audience.rbi +428 -0
- data/rbi/x_twitter_scraper/models/sports_game_posts.rbi +284 -0
- data/rbi/x_twitter_scraper/models/sports_team.rbi +314 -0
- data/rbi/x_twitter_scraper/models/sports_team_game.rbi +110 -0
- data/rbi/x_twitter_scraper/models/subtitle_track.rbi +161 -0
- data/rbi/x_twitter_scraper/models/trend_location.rbi +98 -0
- data/rbi/x_twitter_scraper/models/tweet_embed.rbi +100 -0
- data/rbi/x_twitter_scraper/models/tweet_entities.rbi +122 -0
- data/rbi/x_twitter_scraper/models/tweet_hashtag.rbi +62 -0
- data/rbi/x_twitter_scraper/models/tweet_insights.rbi +139 -0
- data/rbi/x_twitter_scraper/models/tweet_smart_tag.rbi +143 -0
- data/rbi/x_twitter_scraper/models/tweet_subtitles.rbi +59 -0
- data/rbi/x_twitter_scraper/models/tweet_symbol.rbi +74 -0
- data/rbi/x_twitter_scraper/models/tweet_translation.rbi +84 -0
- data/rbi/x_twitter_scraper/models/tweet_url_entity.rbi +67 -0
- data/rbi/x_twitter_scraper/models/tweet_user_mention.rbi +64 -0
- data/rbi/x_twitter_scraper/models/user_affiliate_label.rbi +125 -0
- data/rbi/x_twitter_scraper/models/user_auxiliary_label.rbi +81 -0
- data/rbi/x_twitter_scraper/models/user_highlights_info.rbi +48 -0
- data/rbi/x_twitter_scraper/models/user_identity_verification.rbi +78 -0
- data/rbi/x_twitter_scraper/models/user_insights.rbi +315 -0
- data/rbi/x_twitter_scraper/models/user_live_status.rbi +77 -0
- data/rbi/x_twitter_scraper/models/webhook_create_telegram_link_params.rbi +62 -0
- data/rbi/x_twitter_scraper/models/webhook_create_telegram_link_response.rbi +40 -0
- data/rbi/x_twitter_scraper/models/x/broadcast_retrieve_params.rbi +92 -0
- data/rbi/x_twitter_scraper/models/x/broadcast_retrieve_response.rbi +47 -0
- data/rbi/x_twitter_scraper/models/x/communities/media_list_params.rbi +751 -0
- data/rbi/x_twitter_scraper/models/x/community_find_params.rbi +120 -0
- data/rbi/x_twitter_scraper/models/x/community_list_popular_params.rbi +136 -0
- data/rbi/x_twitter_scraper/models/x/community_list_suggested_params.rbi +97 -0
- data/rbi/x_twitter_scraper/models/x/community_list_suggested_response.rbi +72 -0
- data/rbi/x_twitter_scraper/models/x/community_list_topics_params.rbi +97 -0
- data/rbi/x_twitter_scraper/models/x/community_list_topics_response.rbi +72 -0
- data/rbi/x_twitter_scraper/models/x/community_note_list_contributor_deleted_notes_params.rbi +120 -0
- data/rbi/x_twitter_scraper/models/x/community_note_list_contributor_notes_params.rbi +120 -0
- data/rbi/x_twitter_scraper/models/x/community_note_retrieve_contributor_params.rbi +92 -0
- data/rbi/x_twitter_scraper/models/x/community_note_retrieve_contributor_response.rbi +57 -0
- data/rbi/x_twitter_scraper/models/x/community_retrieve_analytics_params.rbi +94 -0
- data/rbi/x_twitter_scraper/models/x/community_search_members_params.rbi +306 -0
- data/rbi/x_twitter_scraper/models/x/dm_delete_message_params.rbi +109 -0
- data/rbi/x_twitter_scraper/models/x/job_list_locations_params.rbi +105 -0
- data/rbi/x_twitter_scraper/models/x/job_retrieve_params.rbi +92 -0
- data/rbi/x_twitter_scraper/models/x/job_retrieve_response.rbi +47 -0
- data/rbi/x_twitter_scraper/models/x/job_search_params.rbi +200 -0
- data/rbi/x_twitter_scraper/models/x/list_retrieve_params.rbi +90 -0
- data/rbi/x_twitter_scraper/models/x/list_retrieve_response.rbi +43 -0
- data/rbi/x_twitter_scraper/models/x/list_retrieve_search_params.rbi +120 -0
- data/rbi/x_twitter_scraper/models/x/space_retrieve_params.rbi +90 -0
- data/rbi/x_twitter_scraper/models/x/space_retrieve_replay_params.rbi +90 -0
- data/rbi/x_twitter_scraper/models/x/space_retrieve_replay_response.rbi +111 -0
- data/rbi/x_twitter_scraper/models/x/space_retrieve_response.rbi +43 -0
- data/rbi/x_twitter_scraper/models/x/space_search_params.rbi +196 -0
- data/rbi/x_twitter_scraper/models/x/space_search_response.rbi +67 -0
- data/rbi/x_twitter_scraper/models/x/sport_list_games_params.rbi +181 -0
- data/rbi/x_twitter_scraper/models/x/sport_list_posts_params.rbi +242 -0
- data/rbi/x_twitter_scraper/models/x/sport_retrieve_audience_params.rbi +150 -0
- data/rbi/x_twitter_scraper/models/x/sport_retrieve_box_score_params.rbi +150 -0
- data/rbi/x_twitter_scraper/models/x/sport_retrieve_player_props_params.rbi +147 -0
- data/rbi/x_twitter_scraper/models/x/sport_retrieve_plays_params.rbi +150 -0
- data/rbi/x_twitter_scraper/models/x/sport_retrieve_roster_params.rbi +147 -0
- data/rbi/x_twitter_scraper/models/x/sport_retrieve_scoreboard_params.rbi +150 -0
- data/rbi/x_twitter_scraper/models/x/tweet_check_repost_params.rbi +96 -0
- data/rbi/x_twitter_scraper/models/x/tweet_check_repost_response.rbi +90 -0
- data/rbi/x_twitter_scraper/models/x/tweet_embed_params.rbi +185 -0
- data/rbi/x_twitter_scraper/models/x/tweet_embed_response.rbi +43 -0
- data/rbi/x_twitter_scraper/models/x/tweet_get_hidden_replies_params.rbi +749 -0
- data/rbi/x_twitter_scraper/models/x/tweet_get_insights_params.rbi +96 -0
- data/rbi/x_twitter_scraper/models/x/tweet_get_insights_response.rbi +49 -0
- data/rbi/x_twitter_scraper/models/x/tweet_get_retweeter_ids_params.rbi +88 -0
- data/rbi/x_twitter_scraper/models/x/tweet_get_subtitles_params.rbi +96 -0
- data/rbi/x_twitter_scraper/models/x/tweet_get_subtitles_response.rbi +51 -0
- data/rbi/x_twitter_scraper/models/x/tweet_list_top_params.rbi +281 -0
- data/rbi/x_twitter_scraper/models/x/tweet_resolve_links_params.rbi +94 -0
- data/rbi/x_twitter_scraper/models/x/tweet_resolve_links_response.rbi +61 -0
- data/rbi/x_twitter_scraper/models/x/tweet_translate_params.rbi +106 -0
- data/rbi/x_twitter_scraper/models/x/tweet_translate_response.rbi +55 -0
- data/rbi/x_twitter_scraper/models/x/tweets/bookmark_create_params.rbi +105 -0
- data/rbi/x_twitter_scraper/models/x/tweets/bookmark_delete_params.rbi +105 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_affiliates_params.rbi +320 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_articles_params.rbi +749 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_batch_response.rbi +18 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_batch_tweets_params.rbi +127 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_follower_audit_params.rbi +111 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_follower_audit_response.rbi +49 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_follower_ids_params.rbi +78 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_following_ids_params.rbi +78 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_highlights_params.rbi +749 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_insights_params.rbi +113 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_insights_response.rbi +63 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_list_memberships_params.rbi +118 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_lists_params.rbi +118 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_live_params.rbi +94 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_shadowban_params.rbi +111 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_similar_params.rbi +320 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_subscriptions_params.rbi +320 -0
- data/rbi/x_twitter_scraper/models/x/user_translate_bio_params.rbi +104 -0
- data/rbi/x_twitter_scraper/models/x/user_translate_bio_response.rbi +67 -0
- data/rbi/x_twitter_scraper/models/x/users/block_create_params.rbi +103 -0
- data/rbi/x_twitter_scraper/models/x/users/block_delete_params.rbi +103 -0
- data/rbi/x_twitter_scraper/models/x/users/mute_create_params.rbi +103 -0
- data/rbi/x_twitter_scraper/models/x/users/mute_delete_params.rbi +103 -0
- data/rbi/x_twitter_scraper/models/x_autocomplete_search_params.rbi +124 -0
- data/rbi/x_twitter_scraper/models/x_get_hashflags_params.rbi +119 -0
- data/rbi/x_twitter_scraper/models/x_get_hashflags_response.rbi +76 -0
- data/rbi/x_twitter_scraper/models/x_get_news_story_versions_params.rbi +90 -0
- data/rbi/x_twitter_scraper/models/x_get_news_story_versions_response.rbi +65 -0
- data/rbi/x_twitter_scraper/models/x_get_trend_locations_params.rbi +191 -0
- data/rbi/x_twitter_scraper/models/x_get_trend_locations_response.rbi +76 -0
- data/rbi/x_twitter_scraper/models/x_get_trends_history_params.rbi +209 -0
- data/rbi/x_twitter_scraper/models/x_get_trends_history_response.rbi +295 -0
- data/rbi/x_twitter_scraper/models/x_list.rbi +179 -0
- data/rbi/x_twitter_scraper/models/x_list_banner.rbi +291 -0
- data/rbi/x_twitter_scraper/models/x_search_places_params.rbi +105 -0
- data/rbi/x_twitter_scraper/models/x_search_places_response.rbi +76 -0
- data/rbi/x_twitter_scraper/models.rbi +239 -0
- data/rbi/x_twitter_scraper/resources/activity.rbi +114 -0
- data/rbi/x_twitter_scraper/resources/events.rbi +36 -0
- data/rbi/x_twitter_scraper/resources/extractions.rbi +15 -0
- data/rbi/x_twitter_scraper/resources/monitors/posts.rbi +144 -0
- data/rbi/x_twitter_scraper/resources/monitors.rbi +30 -0
- data/rbi/x_twitter_scraper/resources/webhooks.rbi +20 -0
- data/rbi/x_twitter_scraper/resources/x/broadcasts.rbi +51 -0
- data/rbi/x_twitter_scraper/resources/x/communities/media.rbi +178 -0
- data/rbi/x_twitter_scraper/resources/x/communities.rbi +275 -0
- data/rbi/x_twitter_scraper/resources/x/community_notes.rbi +133 -0
- data/rbi/x_twitter_scraper/resources/x/dm.rbi +39 -0
- data/rbi/x_twitter_scraper/resources/x/jobs.rbi +150 -0
- data/rbi/x_twitter_scraper/resources/x/lists.rbi +70 -0
- data/rbi/x_twitter_scraper/resources/x/spaces.rbi +129 -0
- data/rbi/x_twitter_scraper/resources/x/sports.rbi +332 -0
- data/rbi/x_twitter_scraper/resources/x/tweets/bookmark.rbi +93 -0
- data/rbi/x_twitter_scraper/resources/x/tweets.rbi +457 -0
- data/rbi/x_twitter_scraper/resources/x/users/block.rbi +91 -0
- data/rbi/x_twitter_scraper/resources/x/users/mute.rbi +91 -0
- data/rbi/x_twitter_scraper/resources/x/users.rbi +966 -0
- data/rbi/x_twitter_scraper/resources/x.rbi +286 -0
- data/sig/x_twitter_scraper/client.rbs +2 -0
- data/sig/x_twitter_scraper/internal/stream.rbs +21 -0
- data/sig/x_twitter_scraper/models/activity_export_params.rbs +108 -0
- data/sig/x_twitter_scraper/models/activity_list_params.rbs +106 -0
- data/sig/x_twitter_scraper/models/activity_list_response.rbs +12 -0
- data/sig/x_twitter_scraper/models/activity_log_row.rbs +95 -0
- data/sig/x_twitter_scraper/models/activity_record.rbs +448 -0
- data/sig/x_twitter_scraper/models/activity_retrieve_params.rbs +27 -0
- data/sig/x_twitter_scraper/models/audited_follower.rbs +95 -0
- data/sig/x_twitter_scraper/models/batch_user_tweets.rbs +59 -0
- data/sig/x_twitter_scraper/models/broadcast.rbs +245 -0
- data/sig/x_twitter_scraper/models/community.rbs +868 -0
- data/sig/x_twitter_scraper/models/community_analytics.rbs +71 -0
- data/sig/x_twitter_scraper/models/community_analytics_metric.rbs +19 -0
- data/sig/x_twitter_scraper/models/community_banner.rbs +118 -0
- data/sig/x_twitter_scraper/models/community_member_preview.rbs +34 -0
- data/sig/x_twitter_scraper/models/community_note.rbs +231 -0
- data/sig/x_twitter_scraper/models/community_note_entity.rbs +89 -0
- data/sig/x_twitter_scraper/models/community_notes_contributor.rbs +63 -0
- data/sig/x_twitter_scraper/models/community_notes_note_counts.rbs +47 -0
- data/sig/x_twitter_scraper/models/community_notes_rating_counts.rbs +58 -0
- data/sig/x_twitter_scraper/models/community_notes_rating_outcome.rbs +36 -0
- data/sig/x_twitter_scraper/models/community_page.rbs +34 -0
- data/sig/x_twitter_scraper/models/community_topic.rbs +46 -0
- data/sig/x_twitter_scraper/models/event_stream_params.rbs +58 -0
- data/sig/x_twitter_scraper/models/extraction_cancel_params.rbs +27 -0
- data/sig/x_twitter_scraper/models/extraction_cancel_response.rbs +19 -0
- data/sig/x_twitter_scraper/models/follower_audit.rbs +264 -0
- data/sig/x_twitter_scraper/models/follower_class.rbs +22 -0
- data/sig/x_twitter_scraper/models/follower_value_count.rbs +22 -0
- data/sig/x_twitter_scraper/models/football_box_score.rbs +60 -0
- data/sig/x_twitter_scraper/models/football_drive.rbs +84 -0
- data/sig/x_twitter_scraper/models/football_fumble_stats.rbs +34 -0
- data/sig/x_twitter_scraper/models/football_odds.rbs +26 -0
- data/sig/x_twitter_scraper/models/football_passing_stats.rbs +69 -0
- data/sig/x_twitter_scraper/models/football_period.rbs +44 -0
- data/sig/x_twitter_scraper/models/football_play.rbs +203 -0
- data/sig/x_twitter_scraper/models/football_play_detail.rbs +103 -0
- data/sig/x_twitter_scraper/models/football_player.rbs +143 -0
- data/sig/x_twitter_scraper/models/football_player_prop.rbs +49 -0
- data/sig/x_twitter_scraper/models/football_player_stats.rbs +330 -0
- data/sig/x_twitter_scraper/models/football_plays.rbs +65 -0
- data/sig/x_twitter_scraper/models/football_prop_category.rbs +39 -0
- data/sig/x_twitter_scraper/models/football_props.rbs +54 -0
- data/sig/x_twitter_scraper/models/football_quarter.rbs +39 -0
- data/sig/x_twitter_scraper/models/football_return_stats.rbs +44 -0
- data/sig/x_twitter_scraper/models/football_roster.rbs +54 -0
- data/sig/x_twitter_scraper/models/football_roster_team.rbs +19 -0
- data/sig/x_twitter_scraper/models/football_rushing_stats.rbs +44 -0
- data/sig/x_twitter_scraper/models/football_schedule.rbs +45 -0
- data/sig/x_twitter_scraper/models/football_schedule_game.rbs +101 -0
- data/sig/x_twitter_scraper/models/football_schedule_period.rbs +17 -0
- data/sig/x_twitter_scraper/models/football_scoreboard.rbs +152 -0
- data/sig/x_twitter_scraper/models/football_side.rbs +30 -0
- data/sig/x_twitter_scraper/models/football_team_box.rbs +34 -0
- data/sig/x_twitter_scraper/models/football_team_score.rbs +19 -0
- data/sig/x_twitter_scraper/models/football_team_totals.rbs +88 -0
- data/sig/x_twitter_scraper/models/hashflag.rbs +71 -0
- data/sig/x_twitter_scraper/models/job.rbs +173 -0
- data/sig/x_twitter_scraper/models/job_account.rbs +78 -0
- data/sig/x_twitter_scraper/models/job_company.rbs +25 -0
- data/sig/x_twitter_scraper/models/job_location.rbs +19 -0
- data/sig/x_twitter_scraper/models/job_locations.rbs +29 -0
- data/sig/x_twitter_scraper/models/monitor_upsert_by_username_params.rbs +42 -0
- data/sig/x_twitter_scraper/models/monitor_upsert_by_username_response.rbs +95 -0
- data/sig/x_twitter_scraper/models/monitors/post_create_params.rbs +55 -0
- data/sig/x_twitter_scraper/models/monitors/post_delete_params.rbs +29 -0
- data/sig/x_twitter_scraper/models/monitors/post_delete_response.rbs +32 -0
- data/sig/x_twitter_scraper/models/monitors/post_list_params.rbs +38 -0
- data/sig/x_twitter_scraper/models/monitors/post_list_response.rbs +43 -0
- data/sig/x_twitter_scraper/models/monitors/post_retrieve_metrics_params.rbs +36 -0
- data/sig/x_twitter_scraper/models/monitors/post_retrieve_params.rbs +29 -0
- data/sig/x_twitter_scraper/models/monitors/post_update_params.rbs +55 -0
- data/sig/x_twitter_scraper/models/news_version.rbs +34 -0
- data/sig/x_twitter_scraper/models/paginated_community_notes.rbs +34 -0
- data/sig/x_twitter_scraper/models/paginated_jobs.rbs +34 -0
- data/sig/x_twitter_scraper/models/paginated_lists.rbs +34 -0
- data/sig/x_twitter_scraper/models/paginated_user_ids.rbs +30 -0
- data/sig/x_twitter_scraper/models/place.rbs +88 -0
- data/sig/x_twitter_scraper/models/place_search_result.rbs +93 -0
- data/sig/x_twitter_scraper/models/post_engagement_metrics.rbs +49 -0
- data/sig/x_twitter_scraper/models/post_event_type.rbs +36 -0
- data/sig/x_twitter_scraper/models/post_metric_point.rbs +19 -0
- data/sig/x_twitter_scraper/models/post_metric_reading.rbs +19 -0
- data/sig/x_twitter_scraper/models/post_metrics.rbs +49 -0
- data/sig/x_twitter_scraper/models/post_monitor.rbs +270 -0
- data/sig/x_twitter_scraper/models/post_monitor_metrics.rbs +93 -0
- data/sig/x_twitter_scraper/models/profile_translation.rbs +51 -0
- data/sig/x_twitter_scraper/models/resolved_link.rbs +21 -0
- data/sig/x_twitter_scraper/models/search_suggestion_cashtag.rbs +94 -0
- data/sig/x_twitter_scraper/models/search_suggestion_hashtag.rbs +40 -0
- data/sig/x_twitter_scraper/models/search_suggestion_topic.rbs +40 -0
- data/sig/x_twitter_scraper/models/search_suggestion_user.rbs +156 -0
- data/sig/x_twitter_scraper/models/search_suggestions.rbs +49 -0
- data/sig/x_twitter_scraper/models/shadowban_report.rbs +730 -0
- data/sig/x_twitter_scraper/models/shadowban_verdict.rbs +19 -0
- data/sig/x_twitter_scraper/models/space.rbs +220 -0
- data/sig/x_twitter_scraper/models/space_participant.rbs +106 -0
- data/sig/x_twitter_scraper/models/space_sharing.rbs +58 -0
- data/sig/x_twitter_scraper/models/sports_game_audience.rbs +151 -0
- data/sig/x_twitter_scraper/models/sports_game_posts.rbs +131 -0
- data/sig/x_twitter_scraper/models/sports_team.rbs +124 -0
- data/sig/x_twitter_scraper/models/sports_team_game.rbs +59 -0
- data/sig/x_twitter_scraper/models/subtitle_track.rbs +83 -0
- data/sig/x_twitter_scraper/models/support/attachment_download_params.rbs +4 -0
- data/sig/x_twitter_scraper/models/trend_location.rbs +59 -0
- data/sig/x_twitter_scraper/models/tweet_analysis_page.rbs +4 -0
- data/sig/x_twitter_scraper/models/tweet_embed.rbs +58 -0
- data/sig/x_twitter_scraper/models/tweet_entities.rbs +73 -0
- data/sig/x_twitter_scraper/models/tweet_hashtag.rbs +40 -0
- data/sig/x_twitter_scraper/models/tweet_insights.rbs +79 -0
- data/sig/x_twitter_scraper/models/tweet_smart_tag.rbs +74 -0
- data/sig/x_twitter_scraper/models/tweet_subtitles.rbs +29 -0
- data/sig/x_twitter_scraper/models/tweet_symbol.rbs +49 -0
- data/sig/x_twitter_scraper/models/tweet_translation.rbs +46 -0
- data/sig/x_twitter_scraper/models/tweet_url_entity.rbs +47 -0
- data/sig/x_twitter_scraper/models/tweet_user_mention.rbs +45 -0
- data/sig/x_twitter_scraper/models/user_affiliate_label.rbs +77 -0
- data/sig/x_twitter_scraper/models/user_auxiliary_label.rbs +54 -0
- data/sig/x_twitter_scraper/models/user_highlights_info.rbs +27 -0
- data/sig/x_twitter_scraper/models/user_identity_verification.rbs +47 -0
- data/sig/x_twitter_scraper/models/user_insights.rbs +163 -0
- data/sig/x_twitter_scraper/models/user_live_status.rbs +39 -0
- data/sig/x_twitter_scraper/models/webhook_create_telegram_link_params.rbs +32 -0
- data/sig/x_twitter_scraper/models/webhook_create_telegram_link_response.rbs +20 -0
- data/sig/x_twitter_scraper/models/x/account_connection_attempt_retrieve_params.rbs +4 -0
- data/sig/x_twitter_scraper/models/x/account_connection_attempt_retrieve_response.rbs +4 -0
- data/sig/x_twitter_scraper/models/x/broadcast_retrieve_params.rbs +42 -0
- data/sig/x_twitter_scraper/models/x/broadcast_retrieve_response.rbs +20 -0
- data/sig/x_twitter_scraper/models/x/communities/media_list_params.rbs +373 -0
- data/sig/x_twitter_scraper/models/x/community_find_params.rbs +60 -0
- data/sig/x_twitter_scraper/models/x/community_list_popular_params.rbs +69 -0
- data/sig/x_twitter_scraper/models/x/community_list_suggested_params.rbs +44 -0
- data/sig/x_twitter_scraper/models/x/community_list_suggested_response.rbs +38 -0
- data/sig/x_twitter_scraper/models/x/community_list_topics_params.rbs +44 -0
- data/sig/x_twitter_scraper/models/x/community_list_topics_response.rbs +38 -0
- data/sig/x_twitter_scraper/models/x/community_note_list_contributor_deleted_notes_params.rbs +60 -0
- data/sig/x_twitter_scraper/models/x/community_note_list_contributor_notes_params.rbs +60 -0
- data/sig/x_twitter_scraper/models/x/community_note_retrieve_contributor_params.rbs +42 -0
- data/sig/x_twitter_scraper/models/x/community_note_retrieve_contributor_response.rbs +24 -0
- data/sig/x_twitter_scraper/models/x/community_retrieve_analytics_params.rbs +42 -0
- data/sig/x_twitter_scraper/models/x/community_search_members_params.rbs +177 -0
- data/sig/x_twitter_scraper/models/x/dm_delete_message_params.rbs +54 -0
- data/sig/x_twitter_scraper/models/x/job_list_locations_params.rbs +48 -0
- data/sig/x_twitter_scraper/models/x/job_retrieve_params.rbs +42 -0
- data/sig/x_twitter_scraper/models/x/job_retrieve_response.rbs +19 -0
- data/sig/x_twitter_scraper/models/x/job_search_params.rbs +102 -0
- data/sig/x_twitter_scraper/models/x/list_retrieve_followers_response.rbs +4 -0
- data/sig/x_twitter_scraper/models/x/list_retrieve_members_response.rbs +4 -0
- data/sig/x_twitter_scraper/models/x/list_retrieve_params.rbs +42 -0
- data/sig/x_twitter_scraper/models/x/list_retrieve_response.rbs +19 -0
- data/sig/x_twitter_scraper/models/x/list_retrieve_search_params.rbs +60 -0
- data/sig/x_twitter_scraper/models/x/space_retrieve_params.rbs +42 -0
- data/sig/x_twitter_scraper/models/x/space_retrieve_replay_params.rbs +42 -0
- data/sig/x_twitter_scraper/models/x/space_retrieve_replay_response.rbs +48 -0
- data/sig/x_twitter_scraper/models/x/space_retrieve_response.rbs +19 -0
- data/sig/x_twitter_scraper/models/x/space_search_params.rbs +82 -0
- data/sig/x_twitter_scraper/models/x/space_search_response.rbs +36 -0
- data/sig/x_twitter_scraper/models/x/sport_list_games_params.rbs +78 -0
- data/sig/x_twitter_scraper/models/x/sport_list_posts_params.rbs +96 -0
- data/sig/x_twitter_scraper/models/x/sport_retrieve_audience_params.rbs +62 -0
- data/sig/x_twitter_scraper/models/x/sport_retrieve_box_score_params.rbs +62 -0
- data/sig/x_twitter_scraper/models/x/sport_retrieve_player_props_params.rbs +61 -0
- data/sig/x_twitter_scraper/models/x/sport_retrieve_plays_params.rbs +62 -0
- data/sig/x_twitter_scraper/models/x/sport_retrieve_roster_params.rbs +61 -0
- data/sig/x_twitter_scraper/models/x/sport_retrieve_scoreboard_params.rbs +62 -0
- data/sig/x_twitter_scraper/models/x/tweet_analysis_params.rbs +4 -0
- data/sig/x_twitter_scraper/models/x/tweet_check_repost_params.rbs +46 -0
- data/sig/x_twitter_scraper/models/x/tweet_check_repost_response.rbs +56 -0
- data/sig/x_twitter_scraper/models/x/tweet_embed_params.rbs +87 -0
- data/sig/x_twitter_scraper/models/x/tweet_embed_response.rbs +19 -0
- data/sig/x_twitter_scraper/models/x/tweet_get_hidden_replies_params.rbs +371 -0
- data/sig/x_twitter_scraper/models/x/tweet_get_insights_params.rbs +42 -0
- data/sig/x_twitter_scraper/models/x/tweet_get_insights_response.rbs +22 -0
- data/sig/x_twitter_scraper/models/x/tweet_get_replies_response.rbs +4 -0
- data/sig/x_twitter_scraper/models/x/tweet_get_retweeter_ids_params.rbs +42 -0
- data/sig/x_twitter_scraper/models/x/tweet_get_subtitles_params.rbs +42 -0
- data/sig/x_twitter_scraper/models/x/tweet_get_subtitles_response.rbs +22 -0
- data/sig/x_twitter_scraper/models/x/tweet_list_top_params.rbs +115 -0
- data/sig/x_twitter_scraper/models/x/tweet_resolve_links_params.rbs +42 -0
- data/sig/x_twitter_scraper/models/x/tweet_resolve_links_response.rbs +31 -0
- data/sig/x_twitter_scraper/models/x/tweet_search_response.rbs +4 -0
- data/sig/x_twitter_scraper/models/x/tweet_translate_params.rbs +46 -0
- data/sig/x_twitter_scraper/models/x/tweet_translate_response.rbs +24 -0
- data/sig/x_twitter_scraper/models/x/tweets/bookmark_create_params.rbs +51 -0
- data/sig/x_twitter_scraper/models/x/tweets/bookmark_delete_params.rbs +51 -0
- data/sig/x_twitter_scraper/models/x/user_retrieve_affiliates_params.rbs +186 -0
- data/sig/x_twitter_scraper/models/x/user_retrieve_articles_params.rbs +371 -0
- data/sig/x_twitter_scraper/models/x/user_retrieve_batch_response.rbs +10 -0
- data/sig/x_twitter_scraper/models/x/user_retrieve_batch_tweets_params.rbs +62 -0
- data/sig/x_twitter_scraper/models/x/user_retrieve_follower_audit_params.rbs +48 -0
- data/sig/x_twitter_scraper/models/x/user_retrieve_follower_audit_response.rbs +20 -0
- data/sig/x_twitter_scraper/models/x/user_retrieve_follower_ids_params.rbs +42 -0
- data/sig/x_twitter_scraper/models/x/user_retrieve_followers_response.rbs +4 -0
- data/sig/x_twitter_scraper/models/x/user_retrieve_following_ids_params.rbs +42 -0
- data/sig/x_twitter_scraper/models/x/user_retrieve_following_response.rbs +4 -0
- data/sig/x_twitter_scraper/models/x/user_retrieve_highlights_params.rbs +371 -0
- data/sig/x_twitter_scraper/models/x/user_retrieve_insights_params.rbs +48 -0
- data/sig/x_twitter_scraper/models/x/user_retrieve_insights_response.rbs +30 -0
- data/sig/x_twitter_scraper/models/x/user_retrieve_list_memberships_params.rbs +60 -0
- data/sig/x_twitter_scraper/models/x/user_retrieve_lists_params.rbs +60 -0
- data/sig/x_twitter_scraper/models/x/user_retrieve_live_params.rbs +42 -0
- data/sig/x_twitter_scraper/models/x/user_retrieve_shadowban_params.rbs +48 -0
- data/sig/x_twitter_scraper/models/x/user_retrieve_similar_params.rbs +186 -0
- data/sig/x_twitter_scraper/models/x/user_retrieve_subscriptions_params.rbs +186 -0
- data/sig/x_twitter_scraper/models/x/user_retrieve_verified_followers_response.rbs +4 -0
- data/sig/x_twitter_scraper/models/x/user_translate_bio_params.rbs +46 -0
- data/sig/x_twitter_scraper/models/x/user_translate_bio_response.rbs +33 -0
- data/sig/x_twitter_scraper/models/x/users/block_create_params.rbs +51 -0
- data/sig/x_twitter_scraper/models/x/users/block_delete_params.rbs +51 -0
- data/sig/x_twitter_scraper/models/x/users/mute_create_params.rbs +51 -0
- data/sig/x_twitter_scraper/models/x/users/mute_delete_params.rbs +51 -0
- data/sig/x_twitter_scraper/models/x_autocomplete_search_params.rbs +52 -0
- data/sig/x_twitter_scraper/models/x_get_hashflags_params.rbs +60 -0
- data/sig/x_twitter_scraper/models/x_get_hashflags_response.rbs +41 -0
- data/sig/x_twitter_scraper/models/x_get_news_story_versions_params.rbs +40 -0
- data/sig/x_twitter_scraper/models/x_get_news_story_versions_response.rbs +34 -0
- data/sig/x_twitter_scraper/models/x_get_trend_locations_params.rbs +82 -0
- data/sig/x_twitter_scraper/models/x_get_trend_locations_response.rbs +41 -0
- data/sig/x_twitter_scraper/models/x_get_trends_history_params.rbs +102 -0
- data/sig/x_twitter_scraper/models/x_get_trends_history_response.rbs +149 -0
- data/sig/x_twitter_scraper/models/x_list.rbs +112 -0
- data/sig/x_twitter_scraper/models/x_list_banner.rbs +157 -0
- data/sig/x_twitter_scraper/models/x_search_places_params.rbs +46 -0
- data/sig/x_twitter_scraper/models/x_search_places_response.rbs +41 -0
- data/sig/x_twitter_scraper/models.rbs +234 -0
- data/sig/x_twitter_scraper/resources/activity.rbs +38 -0
- data/sig/x_twitter_scraper/resources/events.rbs +7 -0
- data/sig/x_twitter_scraper/resources/extractions.rbs +5 -0
- data/sig/x_twitter_scraper/resources/monitors/posts.rbs +51 -0
- data/sig/x_twitter_scraper/resources/monitors.rbs +9 -0
- data/sig/x_twitter_scraper/resources/support/attachments.rbs +4 -0
- data/sig/x_twitter_scraper/resources/webhooks.rbs +5 -0
- data/sig/x_twitter_scraper/resources/x/account_connection_attempts.rbs +4 -0
- data/sig/x_twitter_scraper/resources/x/analysis.rbs +4 -0
- data/sig/x_twitter_scraper/resources/x/broadcasts.rbs +20 -0
- data/sig/x_twitter_scraper/resources/x/communities/media.rbs +60 -0
- data/sig/x_twitter_scraper/resources/x/communities.rbs +68 -0
- data/sig/x_twitter_scraper/resources/x/community_notes.rbs +38 -0
- data/sig/x_twitter_scraper/resources/x/dm.rbs +9 -0
- data/sig/x_twitter_scraper/resources/x/jobs.rbs +43 -0
- data/sig/x_twitter_scraper/resources/x/lists.rbs +16 -0
- data/sig/x_twitter_scraper/resources/x/spaces.rbs +37 -0
- data/sig/x_twitter_scraper/resources/x/sports.rbs +82 -0
- data/sig/x_twitter_scraper/resources/x/tweets/bookmark.rbs +31 -0
- data/sig/x_twitter_scraper/resources/x/tweets.rbs +114 -0
- data/sig/x_twitter_scraper/resources/x/users/block.rbs +31 -0
- data/sig/x_twitter_scraper/resources/x/users/mute.rbs +31 -0
- data/sig/x_twitter_scraper/resources/x/users.rbs +255 -0
- data/sig/x_twitter_scraper/resources/x.rbs +68 -0
- metadata +668 -2
|
@@ -16,6 +16,9 @@ module XTwitterScraper
|
|
|
16
16
|
# @return [XTwitterScraper::Resources::X::Communities::Tweets]
|
|
17
17
|
attr_reader :tweets
|
|
18
18
|
|
|
19
|
+
# @return [XTwitterScraper::Resources::X::Communities::Media]
|
|
20
|
+
attr_reader :media
|
|
21
|
+
|
|
19
22
|
# Create community
|
|
20
23
|
#
|
|
21
24
|
# @overload create(account:, name:, idempotency_key:, description: nil, request_options: {})
|
|
@@ -413,6 +416,228 @@ module XTwitterScraper
|
|
|
413
416
|
)
|
|
414
417
|
end
|
|
415
418
|
|
|
419
|
+
# Returns the communities X finds for a keyword, in X's order. Each community
|
|
420
|
+
# costs 1 credit. To search the tweets in Communities, use /x/communities/search.
|
|
421
|
+
#
|
|
422
|
+
# @overload find(q:, cursor: nil, page_size: nil, fields: nil, omit: nil, request_options: {})
|
|
423
|
+
#
|
|
424
|
+
# @param q [String] Keyword to find communities by, such as ai. Alias query. Xquik's cap is 4,096 characters.
|
|
425
|
+
#
|
|
426
|
+
# @param cursor [String] Pagination cursor for collection results. Also read as next_cursor, next_token, pagination_token or continuation_token.
|
|
427
|
+
#
|
|
428
|
+
# @param page_size [Integer] Items per page (1-100, default 20). Source, filters or credits can return fewer. Follow next_cursor for more pages. Its aliases are limit, count, max_results, maxItems, max_items & per_page.
|
|
429
|
+
#
|
|
430
|
+
# @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
|
|
431
|
+
#
|
|
432
|
+
# @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
|
|
433
|
+
#
|
|
434
|
+
# @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
435
|
+
#
|
|
436
|
+
# @return [XTwitterScraper::Models::CommunityPage]
|
|
437
|
+
#
|
|
438
|
+
# @see XTwitterScraper::Models::X::CommunityFindParams
|
|
439
|
+
def find(params)
|
|
440
|
+
parsed, options = XTwitterScraper::Models::X::CommunityFindParams.dump_request(params)
|
|
441
|
+
query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
|
|
442
|
+
@client.request(
|
|
443
|
+
method: :get,
|
|
444
|
+
path: "x/communities/find",
|
|
445
|
+
query: query,
|
|
446
|
+
model: XTwitterScraper::Models::CommunityPage,
|
|
447
|
+
options: options
|
|
448
|
+
)
|
|
449
|
+
end
|
|
450
|
+
|
|
451
|
+
# Returns the communities X ranks highest under a topic or subtopic. Name it by
|
|
452
|
+
# topicId or by topic name from /x/communities/topics. Each community costs 1
|
|
453
|
+
# credit. A missing or unknown topic returns invalid_community_topic & lists the
|
|
454
|
+
# topic names.
|
|
455
|
+
#
|
|
456
|
+
# @overload list_popular(topic_id: nil, topic: nil, cursor: nil, page_size: nil, fields: nil, omit: nil, request_options: {})
|
|
457
|
+
#
|
|
458
|
+
# @param topic_id [String] Topic or subtopic ID from /x/communities/topics, such as 301. Wins over topic. X can add topics, so Xquik takes up to 280 characters, the most a post holds.
|
|
459
|
+
#
|
|
460
|
+
# @param topic [String] Topic or subtopic name in any case, such as technology. Send this or topicId. X can add topics, so Xquik takes up to 280 characters, the most a post holds.
|
|
461
|
+
#
|
|
462
|
+
# @param cursor [String] Pagination cursor for collection results. Also read as next_cursor, next_token, pagination_token or continuation_token.
|
|
463
|
+
#
|
|
464
|
+
# @param page_size [Integer] Items per page (1-100, default 20). Source, filters or credits can return fewer. Follow next_cursor for more pages. Its aliases are limit, count, max_results, maxItems, max_items & per_page.
|
|
465
|
+
#
|
|
466
|
+
# @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
|
|
467
|
+
#
|
|
468
|
+
# @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
|
|
469
|
+
#
|
|
470
|
+
# @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
471
|
+
#
|
|
472
|
+
# @return [XTwitterScraper::Models::CommunityPage]
|
|
473
|
+
#
|
|
474
|
+
# @see XTwitterScraper::Models::X::CommunityListPopularParams
|
|
475
|
+
def list_popular(params = {})
|
|
476
|
+
parsed, options = XTwitterScraper::Models::X::CommunityListPopularParams.dump_request(params)
|
|
477
|
+
query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
|
|
478
|
+
@client.request(
|
|
479
|
+
method: :get,
|
|
480
|
+
path: "x/communities/popular",
|
|
481
|
+
query: query,
|
|
482
|
+
model: XTwitterScraper::Models::CommunityPage,
|
|
483
|
+
options: options
|
|
484
|
+
)
|
|
485
|
+
end
|
|
486
|
+
|
|
487
|
+
# Returns the communities X suggests, with their full public fields. X picks them
|
|
488
|
+
# per request, so 2 calls can differ. An empty list is free. Each community costs
|
|
489
|
+
# 1 credit.
|
|
490
|
+
#
|
|
491
|
+
# @overload list_suggested(limit: nil, fields: nil, omit: nil, request_options: {})
|
|
492
|
+
#
|
|
493
|
+
# @param limit [Integer] Maximum communities to return. Omit it for every suggestion. A low credit balance can return fewer. Aliases pageSize, count, max_results, maxItems, max_items & per_page.
|
|
494
|
+
#
|
|
495
|
+
# @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
|
|
496
|
+
#
|
|
497
|
+
# @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
|
|
498
|
+
#
|
|
499
|
+
# @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
500
|
+
#
|
|
501
|
+
# @return [XTwitterScraper::Models::X::CommunityListSuggestedResponse]
|
|
502
|
+
#
|
|
503
|
+
# @see XTwitterScraper::Models::X::CommunityListSuggestedParams
|
|
504
|
+
def list_suggested(params = {})
|
|
505
|
+
parsed, options = XTwitterScraper::Models::X::CommunityListSuggestedParams.dump_request(params)
|
|
506
|
+
query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
|
|
507
|
+
@client.request(
|
|
508
|
+
method: :get,
|
|
509
|
+
path: "x/communities/suggested",
|
|
510
|
+
query: query,
|
|
511
|
+
model: XTwitterScraper::Models::X::CommunityListSuggestedResponse,
|
|
512
|
+
options: options
|
|
513
|
+
)
|
|
514
|
+
end
|
|
515
|
+
|
|
516
|
+
# Returns the community topics with their subtopics. Pass an ID as topicId, or a
|
|
517
|
+
# name as topic, to /x/communities/popular. Each top-level topic costs 1 credit,
|
|
518
|
+
# its subtopics included.
|
|
519
|
+
#
|
|
520
|
+
# @overload list_topics(limit: nil, fields: nil, omit: nil, request_options: {})
|
|
521
|
+
#
|
|
522
|
+
# @param limit [Integer] Maximum topics to return. Omit it for every topic. A low credit balance can return fewer. Aliases pageSize, count, max_results, maxItems, max_items & per_page.
|
|
523
|
+
#
|
|
524
|
+
# @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
|
|
525
|
+
#
|
|
526
|
+
# @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
|
|
527
|
+
#
|
|
528
|
+
# @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
529
|
+
#
|
|
530
|
+
# @return [XTwitterScraper::Models::X::CommunityListTopicsResponse]
|
|
531
|
+
#
|
|
532
|
+
# @see XTwitterScraper::Models::X::CommunityListTopicsParams
|
|
533
|
+
def list_topics(params = {})
|
|
534
|
+
parsed, options = XTwitterScraper::Models::X::CommunityListTopicsParams.dump_request(params)
|
|
535
|
+
query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
|
|
536
|
+
@client.request(
|
|
537
|
+
method: :get,
|
|
538
|
+
path: "x/communities/topics",
|
|
539
|
+
query: query,
|
|
540
|
+
model: XTwitterScraper::Models::X::CommunityListTopicsResponse,
|
|
541
|
+
options: options
|
|
542
|
+
)
|
|
543
|
+
end
|
|
544
|
+
|
|
545
|
+
# Returns community activity for X's latest period. Includes likes, new members,
|
|
546
|
+
# posts, replies & unique posters. Each metric has a count and a changePercent.
|
|
547
|
+
# Each request costs 1 credit.
|
|
548
|
+
#
|
|
549
|
+
# @overload retrieve_analytics(id, fields: nil, omit: nil, request_options: {})
|
|
550
|
+
#
|
|
551
|
+
# @param id [String] X Community ID, or the URL-encoded Community link, such as x.com/i/communities/1500000000000000000. Another value gets a free 400 `invalid_community_id` before X is read.
|
|
552
|
+
#
|
|
553
|
+
# @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
|
|
554
|
+
#
|
|
555
|
+
# @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
|
|
556
|
+
#
|
|
557
|
+
# @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
558
|
+
#
|
|
559
|
+
# @return [XTwitterScraper::Models::CommunityAnalytics]
|
|
560
|
+
#
|
|
561
|
+
# @see XTwitterScraper::Models::X::CommunityRetrieveAnalyticsParams
|
|
562
|
+
def retrieve_analytics(id, params = {})
|
|
563
|
+
parsed, options = XTwitterScraper::Models::X::CommunityRetrieveAnalyticsParams.dump_request(params)
|
|
564
|
+
query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
|
|
565
|
+
@client.request(
|
|
566
|
+
method: :get,
|
|
567
|
+
path: ["x/communities/%1$s/analytics", id],
|
|
568
|
+
query: query,
|
|
569
|
+
model: XTwitterScraper::Models::CommunityAnalytics,
|
|
570
|
+
options: options
|
|
571
|
+
)
|
|
572
|
+
end
|
|
573
|
+
|
|
574
|
+
# Finds a community's members by name or username, each with its role. An answer
|
|
575
|
+
# holds up to 10 members. Each member costs 1 credit. An answer without members is
|
|
576
|
+
# free.
|
|
577
|
+
#
|
|
578
|
+
# @overload search_members(id, q:, min_followers: nil, max_followers: nil, min_following: nil, max_following: nil, min_statuses: nil, max_statuses: nil, min_account_age_days: nil, verified_only: nil, blue_verified_only: nil, verified_type: nil, has_website: nil, has_location: nil, has_email: nil, business_email_only: nil, email_domains: nil, bio_contains: nil, location_contains: nil, username_contains: nil, fields: nil, omit: nil, request_options: {})
|
|
579
|
+
#
|
|
580
|
+
# @param id [String] X Community ID, or the URL-encoded Community link, such as x.com/i/communities/1500000000000000000. Another value gets a free 400 `invalid_community_id` before X is read.
|
|
581
|
+
#
|
|
582
|
+
# @param q [String] Name or username to find members by, such as marckohlbrugge. A leading @ is dropped. Alias query. Xquik's cap is 4,096 characters.
|
|
583
|
+
#
|
|
584
|
+
# @param min_followers [Integer] Minimum follower count. Profiles the filter drops cost nothing.
|
|
585
|
+
#
|
|
586
|
+
# @param max_followers [Integer] Maximum follower count. A profile without a count passes.
|
|
587
|
+
#
|
|
588
|
+
# @param min_following [Integer] Profiles must follow at least this many accounts.
|
|
589
|
+
#
|
|
590
|
+
# @param max_following [Integer] Profiles may follow at most this many accounts.
|
|
591
|
+
#
|
|
592
|
+
# @param min_statuses [Integer] Minimum post count. minPosts is also accepted.
|
|
593
|
+
#
|
|
594
|
+
# @param max_statuses [Integer] Maximum post count. maxPosts is also accepted.
|
|
595
|
+
#
|
|
596
|
+
# @param min_account_age_days [Integer] Minimum account age in whole days.
|
|
597
|
+
#
|
|
598
|
+
# @param verified_only [Boolean] Only return verified profiles.
|
|
599
|
+
#
|
|
600
|
+
# @param blue_verified_only [Boolean] Only return profiles X marks as blue verified. X marks many business & government accounts blue too. Use verifiedType for 1 badge type.
|
|
601
|
+
#
|
|
602
|
+
# @param verified_type [String] Match the verification type exactly, ignoring case.
|
|
603
|
+
#
|
|
604
|
+
# @param has_website [Boolean] Only return profiles with a website.
|
|
605
|
+
#
|
|
606
|
+
# @param has_location [Boolean] Only return profiles with a location.
|
|
607
|
+
#
|
|
608
|
+
# @param has_email [Boolean] Only return profiles that publish an email.
|
|
609
|
+
#
|
|
610
|
+
# @param business_email_only [Boolean] Only return profiles that publish an email outside free webmail, such as Gmail.
|
|
611
|
+
#
|
|
612
|
+
# @param email_domains [String] Only return profiles with an email at one of these domains. Separate domains with commas. Subdomains match.
|
|
613
|
+
#
|
|
614
|
+
# @param bio_contains [String] Match any comma-separated or line-separated bio term, ignoring case.
|
|
615
|
+
#
|
|
616
|
+
# @param location_contains [String] Match a location substring, ignoring case.
|
|
617
|
+
#
|
|
618
|
+
# @param username_contains [String] Match a username substring, ignoring case.
|
|
619
|
+
#
|
|
620
|
+
# @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
|
|
621
|
+
#
|
|
622
|
+
# @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
|
|
623
|
+
#
|
|
624
|
+
# @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
625
|
+
#
|
|
626
|
+
# @return [XTwitterScraper::Models::PaginatedUsers]
|
|
627
|
+
#
|
|
628
|
+
# @see XTwitterScraper::Models::X::CommunitySearchMembersParams
|
|
629
|
+
def search_members(id, params)
|
|
630
|
+
parsed, options = XTwitterScraper::Models::X::CommunitySearchMembersParams.dump_request(params)
|
|
631
|
+
query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
|
|
632
|
+
@client.request(
|
|
633
|
+
method: :get,
|
|
634
|
+
path: ["x/communities/%1$s/members/search", id],
|
|
635
|
+
query: query,
|
|
636
|
+
model: XTwitterScraper::Models::PaginatedUsers,
|
|
637
|
+
options: options
|
|
638
|
+
)
|
|
639
|
+
end
|
|
640
|
+
|
|
416
641
|
# @api private
|
|
417
642
|
#
|
|
418
643
|
# @param client [XTwitterScraper::Client]
|
|
@@ -420,6 +645,7 @@ module XTwitterScraper
|
|
|
420
645
|
@client = client
|
|
421
646
|
@join = XTwitterScraper::Resources::X::Communities::Join.new(client: client)
|
|
422
647
|
@tweets = XTwitterScraper::Resources::X::Communities::Tweets.new(client: client)
|
|
648
|
+
@media = XTwitterScraper::Resources::X::Communities::Media.new(client: client)
|
|
423
649
|
end
|
|
424
650
|
end
|
|
425
651
|
end
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
# SPDX-FileCopyrightText: 2026 Xquik contributors
|
|
2
|
+
#
|
|
3
|
+
# SPDX-License-Identifier: Apache-2.0
|
|
4
|
+
|
|
5
|
+
# frozen_string_literal: true
|
|
6
|
+
|
|
7
|
+
module XTwitterScraper
|
|
8
|
+
module Resources
|
|
9
|
+
class X
|
|
10
|
+
class CommunityNotes
|
|
11
|
+
# Returns 1 Community Notes contributor by the alias X gives them. Includes note
|
|
12
|
+
# counts by rating, rating counts & the deleted notes count. Each lookup costs 1
|
|
13
|
+
# credit.
|
|
14
|
+
#
|
|
15
|
+
# @overload retrieve_contributor(alias_, fields: nil, omit: nil, request_options: {})
|
|
16
|
+
#
|
|
17
|
+
# @param alias_ [String] Community Notes contributor alias, or the URL-encoded contributor URL, such as x.com/i/communitynotes/u/ardent-beach-friarbird. Any letter case works.
|
|
18
|
+
#
|
|
19
|
+
# @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
|
|
20
|
+
#
|
|
21
|
+
# @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
|
|
22
|
+
#
|
|
23
|
+
# @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
24
|
+
#
|
|
25
|
+
# @return [XTwitterScraper::Models::X::CommunityNoteRetrieveContributorResponse]
|
|
26
|
+
#
|
|
27
|
+
# @see XTwitterScraper::Models::X::CommunityNoteRetrieveContributorParams
|
|
28
|
+
def retrieve_contributor(alias_, params = {})
|
|
29
|
+
parsed, options = XTwitterScraper::Models::X::CommunityNoteRetrieveContributorParams.dump_request(params)
|
|
30
|
+
query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
|
|
31
|
+
@client.request(
|
|
32
|
+
method: :get,
|
|
33
|
+
path: ["x/community-notes/contributors/%1$s", alias_],
|
|
34
|
+
query: query,
|
|
35
|
+
model: XTwitterScraper::Models::X::CommunityNoteRetrieveContributorResponse,
|
|
36
|
+
options: options
|
|
37
|
+
)
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
# Returns the notes a contributor deleted, newest first. X keeps each note's ID,
|
|
41
|
+
# times, rating & tags. A notice replaces its text & post. Each note costs 1
|
|
42
|
+
# credit. A contributor who deleted none returns an empty list, free.
|
|
43
|
+
#
|
|
44
|
+
# @overload list_contributor_deleted_notes(alias_, cursor: nil, page_size: nil, fields: nil, omit: nil, request_options: {})
|
|
45
|
+
#
|
|
46
|
+
# @param alias_ [String] Community Notes contributor alias, or the URL-encoded contributor URL, such as x.com/i/communitynotes/u/ardent-beach-friarbird. Any letter case works.
|
|
47
|
+
#
|
|
48
|
+
# @param cursor [String] Pagination cursor for collection results. Also read as next_cursor, next_token, pagination_token or continuation_token.
|
|
49
|
+
#
|
|
50
|
+
# @param page_size [Integer] Notes per page (1-10, default 10). A low credit balance can return fewer. Follow next_cursor for more pages. Also read as limit, count, max_results, maxItems, max_items & per_page.
|
|
51
|
+
#
|
|
52
|
+
# @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
|
|
53
|
+
#
|
|
54
|
+
# @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
|
|
55
|
+
#
|
|
56
|
+
# @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
57
|
+
#
|
|
58
|
+
# @return [XTwitterScraper::Models::PaginatedCommunityNotes]
|
|
59
|
+
#
|
|
60
|
+
# @see XTwitterScraper::Models::X::CommunityNoteListContributorDeletedNotesParams
|
|
61
|
+
def list_contributor_deleted_notes(alias_, params = {})
|
|
62
|
+
parsed, options = XTwitterScraper::Models::X::CommunityNoteListContributorDeletedNotesParams.dump_request(params)
|
|
63
|
+
query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
|
|
64
|
+
@client.request(
|
|
65
|
+
method: :get,
|
|
66
|
+
path: ["x/community-notes/contributors/%1$s/deleted-notes", alias_],
|
|
67
|
+
query: query,
|
|
68
|
+
model: XTwitterScraper::Models::PaginatedCommunityNotes,
|
|
69
|
+
options: options
|
|
70
|
+
)
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
# Returns a contributor's notes, newest first, each with the post it is on.
|
|
74
|
+
# Includes notes X has not rated helpful. Each note costs 1 credit. Follow
|
|
75
|
+
# next_cursor for more.
|
|
76
|
+
#
|
|
77
|
+
# @overload list_contributor_notes(alias_, cursor: nil, page_size: nil, fields: nil, omit: nil, request_options: {})
|
|
78
|
+
#
|
|
79
|
+
# @param alias_ [String] Community Notes contributor alias, or the URL-encoded contributor URL, such as x.com/i/communitynotes/u/ardent-beach-friarbird. Any letter case works.
|
|
80
|
+
#
|
|
81
|
+
# @param cursor [String] Pagination cursor for collection results. Also read as next_cursor, next_token, pagination_token or continuation_token.
|
|
82
|
+
#
|
|
83
|
+
# @param page_size [Integer] Notes per page (1-10, default 10). A low credit balance can return fewer. Follow next_cursor for more pages. Also read as limit, count, max_results, maxItems, max_items & per_page.
|
|
84
|
+
#
|
|
85
|
+
# @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
|
|
86
|
+
#
|
|
87
|
+
# @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
|
|
88
|
+
#
|
|
89
|
+
# @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
90
|
+
#
|
|
91
|
+
# @return [XTwitterScraper::Models::PaginatedCommunityNotes]
|
|
92
|
+
#
|
|
93
|
+
# @see XTwitterScraper::Models::X::CommunityNoteListContributorNotesParams
|
|
94
|
+
def list_contributor_notes(alias_, params = {})
|
|
95
|
+
parsed, options = XTwitterScraper::Models::X::CommunityNoteListContributorNotesParams.dump_request(params)
|
|
96
|
+
query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
|
|
97
|
+
@client.request(
|
|
98
|
+
method: :get,
|
|
99
|
+
path: ["x/community-notes/contributors/%1$s/notes", alias_],
|
|
100
|
+
query: query,
|
|
101
|
+
model: XTwitterScraper::Models::PaginatedCommunityNotes,
|
|
102
|
+
options: options
|
|
103
|
+
)
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
# @api private
|
|
107
|
+
#
|
|
108
|
+
# @param client [XTwitterScraper::Client]
|
|
109
|
+
def initialize(client:)
|
|
110
|
+
@client = client
|
|
111
|
+
end
|
|
112
|
+
end
|
|
113
|
+
end
|
|
114
|
+
end
|
|
115
|
+
end
|
|
@@ -69,6 +69,44 @@ module XTwitterScraper
|
|
|
69
69
|
)
|
|
70
70
|
end
|
|
71
71
|
|
|
72
|
+
# Deletes 1 DM from the account's side. The other person keeps it. Success means
|
|
73
|
+
# the DM is gone from the account's conversation. A DM that stays gets 422
|
|
74
|
+
# `x_dm_not_deleted`, and Xquik charges nothing.
|
|
75
|
+
#
|
|
76
|
+
# @overload delete_message(message_id, user_id:, account:, idempotency_key:, prefer: nil, request_options: {})
|
|
77
|
+
#
|
|
78
|
+
# @param message_id [String] DM ID from DM history. Another value gets 400 `invalid_message_id`.
|
|
79
|
+
#
|
|
80
|
+
# @param user_id [String] The other person in the conversation, as a user ID, username with or without @, or URL-encoded profile URL, such as x.com/nasa. Xquik looks up a username's ID first. Anything else gets 400 `invalid_user_id`.
|
|
81
|
+
#
|
|
82
|
+
# @param account [String] Connected X account (@username or ID) that sees the DM.
|
|
83
|
+
#
|
|
84
|
+
# @param idempotency_key [String] Use 1 unique value per intended write. Reuse it only for an identical retry. A matching retry returns the first answer again, with `idempotent: true` added. It keeps the first status, body & Retry-After. It sends nothing to X & charges nothing. While the first request runs, a retry returns 202 & the action. Different input returns 409. Protection lasts at least 90 days. Retrying a write is safe with an idempotency key. A retry with an API key at its monthly budget gets 403 `api_key_budget_reached`.
|
|
85
|
+
#
|
|
86
|
+
# @param prefer [String] A long write answers 202 with a status link, then lands on X. `wait=<seconds>` asks for the answer within that many seconds, up to 85. If the write is still running then, the API answers 202 with Location. Poll Location until `terminal` is true, and don't send the write again.
|
|
87
|
+
#
|
|
88
|
+
# @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
89
|
+
#
|
|
90
|
+
# @return [XTwitterScraper::Models::X::WriteActionRetrieveResponse]
|
|
91
|
+
#
|
|
92
|
+
# @see XTwitterScraper::Models::X::DmDeleteMessageParams
|
|
93
|
+
def delete_message(message_id, params)
|
|
94
|
+
parsed, options = XTwitterScraper::Models::X::DmDeleteMessageParams.dump_request(params)
|
|
95
|
+
user_id = parsed.delete(:user_id) do
|
|
96
|
+
raise ArgumentError.new("missing required path argument user_id")
|
|
97
|
+
end
|
|
98
|
+
header_params = {idempotency_key: "idempotency-key", prefer: "prefer"}
|
|
99
|
+
query = XTwitterScraper::Internal::Util.encode_query_params(parsed.except(*header_params.keys))
|
|
100
|
+
@client.request(
|
|
101
|
+
method: :delete,
|
|
102
|
+
path: ["x/dm/%1$s/messages/%2$s", user_id, message_id],
|
|
103
|
+
query: query,
|
|
104
|
+
headers: parsed.slice(*header_params.keys).transform_keys(header_params),
|
|
105
|
+
model: XTwitterScraper::Models::X::WriteActionRetrieveResponse,
|
|
106
|
+
options: options
|
|
107
|
+
)
|
|
108
|
+
end
|
|
109
|
+
|
|
72
110
|
# @api private
|
|
73
111
|
#
|
|
74
112
|
# @param client [XTwitterScraper::Client]
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
# SPDX-FileCopyrightText: 2026 Xquik contributors
|
|
2
|
+
#
|
|
3
|
+
# SPDX-License-Identifier: Apache-2.0
|
|
4
|
+
|
|
5
|
+
# frozen_string_literal: true
|
|
6
|
+
|
|
7
|
+
module XTwitterScraper
|
|
8
|
+
module Resources
|
|
9
|
+
class X
|
|
10
|
+
class Jobs
|
|
11
|
+
# Returns the places whose names match a query, each with the location ID that GET
|
|
12
|
+
# /x/jobs/search takes. No match returns an empty list, free.
|
|
13
|
+
#
|
|
14
|
+
# @overload list_locations(q:, limit: nil, fields: nil, omit: nil, request_options: {})
|
|
15
|
+
#
|
|
16
|
+
# @param q [String] Place name or its start, such as new york. Its alias is query. Xquik's cap is 4,096 characters.
|
|
17
|
+
#
|
|
18
|
+
# @param limit [Integer] Most places to return. Without it, every match returns. Its aliases are pageSize, count, max_results, maxItems, max_items & per_page.
|
|
19
|
+
#
|
|
20
|
+
# @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
|
|
21
|
+
#
|
|
22
|
+
# @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
|
|
23
|
+
#
|
|
24
|
+
# @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
25
|
+
#
|
|
26
|
+
# @return [XTwitterScraper::Models::JobLocations]
|
|
27
|
+
#
|
|
28
|
+
# @see XTwitterScraper::Models::X::JobListLocationsParams
|
|
29
|
+
def list_locations(params)
|
|
30
|
+
parsed, options = XTwitterScraper::Models::X::JobListLocationsParams.dump_request(params)
|
|
31
|
+
query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
|
|
32
|
+
@client.request(
|
|
33
|
+
method: :get,
|
|
34
|
+
path: "x/jobs/locations",
|
|
35
|
+
query: query,
|
|
36
|
+
model: XTwitterScraper::Models::JobLocations,
|
|
37
|
+
options: options
|
|
38
|
+
)
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
# Returns job listings with title, location, salary, company & apply link. Add
|
|
42
|
+
# filters to narrow them. A closed job does not appear & costs nothing. Follow
|
|
43
|
+
# next_cursor for more.
|
|
44
|
+
#
|
|
45
|
+
# @overload search(q:, location: nil, location_id: nil, location_type: nil, seniority: nil, employment_type: nil, company: nil, cursor: nil, page_size: nil, fields: nil, omit: nil, request_options: {})
|
|
46
|
+
#
|
|
47
|
+
# @param q [String] Keyword, such as a job title or skill. Its alias is query. Xquik's cap is 4,096 characters.
|
|
48
|
+
#
|
|
49
|
+
# @param location [String] City, region or country as text, such as Berlin. Xquik's cap is 4,096 characters.
|
|
50
|
+
#
|
|
51
|
+
# @param location_id [String] Location ID from GET /x/jobs/locations. Replaces location when both are sent.
|
|
52
|
+
#
|
|
53
|
+
# @param location_type [String] Where the work happens. Comma-separated list of onsite, remote & hybrid. Any case works. It allows 44 characters for every choice once with spaces, hyphens or underscores.
|
|
54
|
+
#
|
|
55
|
+
# @param seniority [String] Comma-separated list of intern, entry_level, junior, mid_level, senior, lead, manager & executive. Any case works. It allows 144 characters for every choice once with spaces, hyphens or underscores.
|
|
56
|
+
#
|
|
57
|
+
# @param employment_type [String] Comma-separated list of full_time, full_time_contract, part_time & contract_to_hire. Any case works. It allows 116 characters for every choice once with spaces, hyphens or underscores.
|
|
58
|
+
#
|
|
59
|
+
# @param company [String] Company name to match. Xquik's cap is 4,096 characters.
|
|
60
|
+
#
|
|
61
|
+
# @param cursor [String] Pagination cursor for collection results. Also read as next_cursor, next_token, pagination_token or continuation_token.
|
|
62
|
+
#
|
|
63
|
+
# @param page_size [Integer] Items per page (1-100, default 20). Source, filters or credits can return fewer. Follow next_cursor for more pages. Its aliases are limit, count, max_results, maxItems, max_items & per_page.
|
|
64
|
+
#
|
|
65
|
+
# @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
|
|
66
|
+
#
|
|
67
|
+
# @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
|
|
68
|
+
#
|
|
69
|
+
# @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
70
|
+
#
|
|
71
|
+
# @return [XTwitterScraper::Models::PaginatedJobs]
|
|
72
|
+
#
|
|
73
|
+
# @see XTwitterScraper::Models::X::JobSearchParams
|
|
74
|
+
def search(params)
|
|
75
|
+
parsed, options = XTwitterScraper::Models::X::JobSearchParams.dump_request(params)
|
|
76
|
+
query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
|
|
77
|
+
@client.request(
|
|
78
|
+
method: :get,
|
|
79
|
+
path: "x/jobs/search",
|
|
80
|
+
query: query,
|
|
81
|
+
model: XTwitterScraper::Models::PaginatedJobs,
|
|
82
|
+
options: options
|
|
83
|
+
)
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
# Returns a public job listing with its description as text & Markdown, work type,
|
|
87
|
+
# seniority, salary, company & apply link. A job that closed returns job_not_found
|
|
88
|
+
# & is free.
|
|
89
|
+
#
|
|
90
|
+
# @overload retrieve(id, fields: nil, omit: nil, request_options: {})
|
|
91
|
+
#
|
|
92
|
+
# @param id [String] Job ID or URL-encoded job URL, such as x.com/i/jobs/123. Anything else gets 400 `invalid_job_id`.
|
|
93
|
+
#
|
|
94
|
+
# @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
|
|
95
|
+
#
|
|
96
|
+
# @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
|
|
97
|
+
#
|
|
98
|
+
# @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
99
|
+
#
|
|
100
|
+
# @return [XTwitterScraper::Models::X::JobRetrieveResponse]
|
|
101
|
+
#
|
|
102
|
+
# @see XTwitterScraper::Models::X::JobRetrieveParams
|
|
103
|
+
def retrieve(id, params = {})
|
|
104
|
+
parsed, options = XTwitterScraper::Models::X::JobRetrieveParams.dump_request(params)
|
|
105
|
+
query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
|
|
106
|
+
@client.request(
|
|
107
|
+
method: :get,
|
|
108
|
+
path: ["x/jobs/%1$s", id],
|
|
109
|
+
query: query,
|
|
110
|
+
model: XTwitterScraper::Models::X::JobRetrieveResponse,
|
|
111
|
+
options: options
|
|
112
|
+
)
|
|
113
|
+
end
|
|
114
|
+
|
|
115
|
+
# @api private
|
|
116
|
+
#
|
|
117
|
+
# @param client [XTwitterScraper::Client]
|
|
118
|
+
def initialize(client:)
|
|
119
|
+
@client = client
|
|
120
|
+
end
|
|
121
|
+
end
|
|
122
|
+
end
|
|
123
|
+
end
|
|
124
|
+
end
|
|
@@ -377,6 +377,68 @@ module XTwitterScraper
|
|
|
377
377
|
)
|
|
378
378
|
end
|
|
379
379
|
|
|
380
|
+
# Returns 1 page of public Lists with member counts, banners & owner profiles. X
|
|
381
|
+
# may rank the Lists differently per request. Pass next_cursor as cursor for the
|
|
382
|
+
# next page.
|
|
383
|
+
#
|
|
384
|
+
# @overload retrieve_search(q:, cursor: nil, page_size: nil, fields: nil, omit: nil, request_options: {})
|
|
385
|
+
#
|
|
386
|
+
# @param q [String] Keywords to find Lists by, such as a topic. Alias query. Xquik's cap is 4,096 characters.
|
|
387
|
+
#
|
|
388
|
+
# @param cursor [String] Pagination cursor for collection results. Also read as next_cursor, next_token, pagination_token or continuation_token.
|
|
389
|
+
#
|
|
390
|
+
# @param page_size [Integer] Items per page (1-100, default 20). Source, filters or credits can return fewer. Follow next_cursor for more pages. Its aliases are limit, count, max_results, maxItems, max_items & per_page.
|
|
391
|
+
#
|
|
392
|
+
# @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
|
|
393
|
+
#
|
|
394
|
+
# @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
|
|
395
|
+
#
|
|
396
|
+
# @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
397
|
+
#
|
|
398
|
+
# @return [XTwitterScraper::Models::PaginatedLists]
|
|
399
|
+
#
|
|
400
|
+
# @see XTwitterScraper::Models::X::ListRetrieveSearchParams
|
|
401
|
+
def retrieve_search(params)
|
|
402
|
+
parsed, options = XTwitterScraper::Models::X::ListRetrieveSearchParams.dump_request(params)
|
|
403
|
+
query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
|
|
404
|
+
@client.request(
|
|
405
|
+
method: :get,
|
|
406
|
+
path: "x/lists/search",
|
|
407
|
+
query: query,
|
|
408
|
+
model: XTwitterScraper::Models::PaginatedLists,
|
|
409
|
+
options: options
|
|
410
|
+
)
|
|
411
|
+
end
|
|
412
|
+
|
|
413
|
+
# Returns 1 public X List as its page on X shows it. Accepts the List ID or the
|
|
414
|
+
# URL-encoded List URL, such as x.com/i/lists/4143408. A private List answers 404
|
|
415
|
+
# list_not_found.
|
|
416
|
+
#
|
|
417
|
+
# @overload retrieve(id, fields: nil, omit: nil, request_options: {})
|
|
418
|
+
#
|
|
419
|
+
# @param id [String] X List ID, or the URL-encoded List link, such as x.com/i/lists/4143408.
|
|
420
|
+
#
|
|
421
|
+
# @param fields [String] Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it. Pick only the fields you need with `fields` & `omit`.
|
|
422
|
+
#
|
|
423
|
+
# @param omit [String] Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.
|
|
424
|
+
#
|
|
425
|
+
# @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
426
|
+
#
|
|
427
|
+
# @return [XTwitterScraper::Models::X::ListRetrieveResponse]
|
|
428
|
+
#
|
|
429
|
+
# @see XTwitterScraper::Models::X::ListRetrieveParams
|
|
430
|
+
def retrieve(id, params = {})
|
|
431
|
+
parsed, options = XTwitterScraper::Models::X::ListRetrieveParams.dump_request(params)
|
|
432
|
+
query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
|
|
433
|
+
@client.request(
|
|
434
|
+
method: :get,
|
|
435
|
+
path: ["x/lists/%1$s", id],
|
|
436
|
+
query: query,
|
|
437
|
+
model: XTwitterScraper::Models::X::ListRetrieveResponse,
|
|
438
|
+
options: options
|
|
439
|
+
)
|
|
440
|
+
end
|
|
441
|
+
|
|
380
442
|
# @api private
|
|
381
443
|
#
|
|
382
444
|
# @param client [XTwitterScraper::Client]
|