x-twitter-scraper 0.4.2 → 0.4.4
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 +23 -0
- data/LICENSE +201 -0
- data/README.md +10 -12
- data/lib/x_twitter_scraper/client.rb +30 -26
- data/lib/x_twitter_scraper/internal/transport/base_client.rb +5 -0
- data/lib/x_twitter_scraper/internal/type/base_model.rb +4 -3
- data/lib/x_twitter_scraper/internal/util.rb +3 -1
- data/lib/x_twitter_scraper/models/account_retrieve_response.rb +138 -23
- data/lib/x_twitter_scraper/models/content_disclosure.rb +66 -0
- data/lib/x_twitter_scraper/models/credit_redirect_topup_checkout_params.rb +22 -0
- data/lib/x_twitter_scraper/models/credit_retrieve_balance_response.rb +37 -10
- data/lib/x_twitter_scraper/models/credit_retrieve_topup_status_params.rb +22 -0
- data/lib/x_twitter_scraper/models/credit_retrieve_topup_status_response.rb +45 -0
- data/lib/x_twitter_scraper/models/credit_topup_balance_params.rb +13 -5
- data/lib/x_twitter_scraper/models/credit_topup_balance_response.rb +18 -5
- data/lib/x_twitter_scraper/models/draft_list_params.rb +8 -2
- data/lib/x_twitter_scraper/models/draw_detail.rb +15 -1
- data/lib/x_twitter_scraper/models/draw_export_params.rb +3 -3
- data/lib/x_twitter_scraper/models/draw_list_item.rb +8 -1
- data/lib/x_twitter_scraper/models/draw_list_params.rb +13 -7
- data/lib/x_twitter_scraper/models/draw_run_response.rb +13 -2
- data/lib/x_twitter_scraper/models/embedded_tweet.rb +202 -0
- data/lib/x_twitter_scraper/models/error.rb +203 -34
- data/lib/x_twitter_scraper/models/event.rb +48 -6
- data/lib/x_twitter_scraper/models/event_detail.rb +46 -7
- data/lib/x_twitter_scraper/models/event_list_params.rb +13 -7
- data/lib/x_twitter_scraper/models/event_type.rb +17 -2
- data/lib/x_twitter_scraper/models/extraction_estimate_cost_params.rb +308 -7
- data/lib/x_twitter_scraper/models/extraction_estimate_cost_response.rb +38 -14
- data/lib/x_twitter_scraper/models/extraction_export_results_params.rb +3 -3
- data/lib/x_twitter_scraper/models/extraction_job.rb +3 -0
- data/lib/x_twitter_scraper/models/extraction_list_params.rb +16 -7
- data/lib/x_twitter_scraper/models/extraction_retrieve_params.rb +5 -5
- data/lib/x_twitter_scraper/models/extraction_retrieve_response.rb +2 -2
- data/lib/x_twitter_scraper/models/extraction_run_params.rb +304 -7
- data/lib/x_twitter_scraper/models/extraction_run_response.rb +3 -0
- data/lib/x_twitter_scraper/models/guest_wallet_amount.rb +25 -0
- data/lib/x_twitter_scraper/models/guest_wallet_create_params.rb +36 -0
- data/lib/x_twitter_scraper/models/guest_wallet_create_response.rb +161 -0
- data/lib/x_twitter_scraper/models/{integration_list_params.rb → guest_wallet_retrieve_status_params.rb} +2 -2
- data/lib/x_twitter_scraper/models/guest_wallet_retrieve_status_response.rb +196 -0
- data/lib/x_twitter_scraper/models/guest_wallet_topup_params.rb +36 -0
- data/lib/x_twitter_scraper/models/guest_wallet_topup_response.rb +172 -0
- data/lib/x_twitter_scraper/models/monitor.rb +9 -1
- data/lib/x_twitter_scraper/models/monitor_create_response.rb +16 -1
- data/lib/x_twitter_scraper/models/monitors/keyword_create_params.rb +34 -0
- data/lib/x_twitter_scraper/models/monitors/keyword_create_response.rb +59 -0
- data/lib/x_twitter_scraper/models/monitors/keyword_deactivate_params.rb +22 -0
- data/lib/x_twitter_scraper/models/monitors/keyword_deactivate_response.rb +18 -0
- data/lib/x_twitter_scraper/models/monitors/keyword_list_params.rb +16 -0
- data/lib/x_twitter_scraper/models/monitors/keyword_list_response.rb +76 -0
- data/lib/x_twitter_scraper/models/monitors/keyword_retrieve_params.rb +22 -0
- data/lib/x_twitter_scraper/models/monitors/keyword_retrieve_response.rb +59 -0
- data/lib/x_twitter_scraper/models/monitors/keyword_update_params.rb +40 -0
- data/lib/x_twitter_scraper/models/monitors/keyword_update_response.rb +59 -0
- data/lib/x_twitter_scraper/models/paginated_tweets.rb +8 -4
- data/lib/x_twitter_scraper/models/paginated_users.rb +8 -4
- data/lib/x_twitter_scraper/models/radar_item.rb +99 -6
- data/lib/x_twitter_scraper/models/radar_retrieve_trending_topics_params.rb +39 -14
- data/lib/x_twitter_scraper/models/radar_retrieve_trending_topics_response.rb +14 -5
- data/lib/x_twitter_scraper/models/search_tweet.rb +236 -0
- data/lib/x_twitter_scraper/models/subscribe_create_params.rb +21 -1
- data/lib/x_twitter_scraper/models/subscribe_create_response.rb +10 -10
- data/lib/x_twitter_scraper/models/trend_list_params.rb +7 -4
- data/lib/x_twitter_scraper/models/tweet_media.rb +77 -0
- data/lib/x_twitter_scraper/models/user_profile.rb +258 -0
- data/lib/x_twitter_scraper/models/webhook.rb +46 -1
- data/lib/x_twitter_scraper/models/webhook_create_response.rb +2 -1
- data/lib/x_twitter_scraper/models/{api_key_revoke_params.rb → webhook_resume_params.rb} +2 -2
- data/lib/x_twitter_scraper/models/webhook_resume_response.rb +31 -0
- data/lib/x_twitter_scraper/models/x/account_connection_challenge_submit_params.rb +31 -0
- data/lib/x_twitter_scraper/models/x/account_connection_challenge_submit_response.rb +66 -0
- data/lib/x_twitter_scraper/models/x/account_create_params.rb +1 -9
- data/lib/x_twitter_scraper/models/x/account_create_response.rb +30 -1
- data/lib/x_twitter_scraper/models/x/account_reauth_params.rb +9 -1
- data/lib/x_twitter_scraper/models/x/account_reauth_response.rb +36 -1
- data/lib/x_twitter_scraper/models/x/bookmark_retrieve_folders_response.rb +6 -2
- data/lib/x_twitter_scraper/models/x/communities/join_create_response.rb +20 -0
- data/lib/x_twitter_scraper/models/x/communities/join_delete_all_response.rb +20 -0
- data/lib/x_twitter_scraper/models/x/communities/tweet_list_by_community_params.rb +17 -1
- data/lib/x_twitter_scraper/models/x/communities/tweet_list_params.rb +43 -9
- data/lib/x_twitter_scraper/models/x/community_retrieve_info_response.rb +69 -1
- data/lib/x_twitter_scraper/models/x/community_retrieve_members_params.rb +14 -1
- data/lib/x_twitter_scraper/models/x/community_retrieve_search_params.rb +38 -4
- data/lib/x_twitter_scraper/models/x/dm_retrieve_history_params.rb +13 -1
- data/lib/x_twitter_scraper/models/x/dm_retrieve_history_response.rb +26 -9
- data/lib/x_twitter_scraper/models/x/dm_send_params.rb +3 -9
- data/lib/x_twitter_scraper/models/x/follower_check_params.rb +4 -4
- data/lib/x_twitter_scraper/models/x/list_retrieve_followers_params.rb +15 -1
- data/lib/x_twitter_scraper/models/x/list_retrieve_members_params.rb +9 -1
- data/lib/x_twitter_scraper/models/x/list_retrieve_tweets_params.rb +16 -1
- data/lib/x_twitter_scraper/models/x/media_download_params.rb +19 -3
- data/lib/x_twitter_scraper/models/x/media_upload_params.rb +8 -15
- data/lib/x_twitter_scraper/models/x/media_upload_response.rb +10 -1
- data/lib/x_twitter_scraper/models/x/profile_update_avatar_params.rb +8 -8
- data/lib/x_twitter_scraper/models/x/profile_update_banner_params.rb +8 -8
- data/lib/x_twitter_scraper/models/x/tweet_author.rb +4 -21
- data/lib/x_twitter_scraper/models/x/tweet_create_params.rb +18 -11
- data/lib/x_twitter_scraper/models/x/tweet_create_response.rb +28 -1
- data/lib/x_twitter_scraper/models/x/tweet_detail.rb +109 -43
- data/lib/x_twitter_scraper/models/x/tweet_get_favoriters_params.rb +15 -1
- data/lib/x_twitter_scraper/models/x/tweet_get_quotes_params.rb +268 -1
- data/lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb +268 -1
- data/lib/x_twitter_scraper/models/x/tweet_get_retweeters_params.rb +15 -1
- data/lib/x_twitter_scraper/models/x/tweet_get_thread_params.rb +16 -1
- data/lib/x_twitter_scraper/models/x/tweet_retrieve_response.rb +9 -4
- data/lib/x_twitter_scraper/models/x/tweet_search_params.rb +314 -8
- data/lib/x_twitter_scraper/models/x/user_remove_follower_params.rb +31 -0
- data/lib/x_twitter_scraper/models/x/user_remove_follower_response.rb +18 -0
- data/lib/x_twitter_scraper/models/x/user_retrieve_batch_params.rb +6 -2
- data/lib/x_twitter_scraper/models/x/user_retrieve_batch_response.rb +83 -0
- data/lib/x_twitter_scraper/models/x/user_retrieve_followers_params.rb +25 -3
- data/lib/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rb +16 -1
- data/lib/x_twitter_scraper/models/x/user_retrieve_following_params.rb +25 -3
- data/lib/x_twitter_scraper/models/x/user_retrieve_likes_params.rb +268 -1
- data/lib/x_twitter_scraper/models/x/user_retrieve_media_params.rb +268 -1
- data/lib/x_twitter_scraper/models/x/user_retrieve_mentions_params.rb +268 -1
- data/lib/x_twitter_scraper/models/x/user_retrieve_replies_params.rb +306 -0
- data/lib/x_twitter_scraper/models/x/user_retrieve_tweets_params.rb +268 -1
- data/lib/x_twitter_scraper/models/x/user_retrieve_verified_followers_params.rb +16 -1
- data/lib/x_twitter_scraper/models/x/write_action_retrieve_params.rb +22 -0
- data/lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb +173 -0
- data/lib/x_twitter_scraper/models/x/x_account.rb +56 -2
- data/lib/x_twitter_scraper/models/x/x_account_detail.rb +23 -8
- data/lib/x_twitter_scraper/models/x_get_article_response.rb +189 -11
- data/lib/x_twitter_scraper/models/x_get_home_timeline_params.rb +2 -2
- data/lib/x_twitter_scraper/models/x_get_notifications_params.rb +3 -3
- data/lib/x_twitter_scraper/models/x_get_trends_params.rb +17 -1
- data/lib/x_twitter_scraper/models.rb +21 -21
- data/lib/x_twitter_scraper/resources/account.rb +1 -3
- data/lib/x_twitter_scraper/resources/compose.rb +1 -1
- data/lib/x_twitter_scraper/resources/credits.rb +54 -4
- data/lib/x_twitter_scraper/resources/drafts.rb +7 -4
- data/lib/x_twitter_scraper/resources/draws.rb +14 -8
- data/lib/x_twitter_scraper/resources/events.rb +7 -5
- data/lib/x_twitter_scraper/resources/extractions.rb +145 -20
- data/lib/x_twitter_scraper/resources/guest_wallets.rb +108 -0
- data/lib/x_twitter_scraper/resources/monitors/keywords.rb +128 -0
- data/lib/x_twitter_scraper/resources/monitors.rb +13 -5
- data/lib/x_twitter_scraper/resources/radar.rb +8 -6
- data/lib/x_twitter_scraper/resources/styles.rb +1 -1
- data/lib/x_twitter_scraper/resources/subscribe.rb +9 -4
- data/lib/x_twitter_scraper/resources/support/tickets.rb +3 -3
- data/lib/x_twitter_scraper/resources/trends.rb +7 -4
- data/lib/x_twitter_scraper/resources/webhooks.rb +25 -5
- data/lib/x_twitter_scraper/resources/x/account_connection_challenges.rb +41 -0
- data/lib/x_twitter_scraper/resources/x/accounts.rb +7 -13
- data/lib/x_twitter_scraper/resources/x/bookmarks.rb +1 -1
- data/lib/x_twitter_scraper/resources/x/communities/join.rb +6 -6
- data/lib/x_twitter_scraper/resources/x/communities/tweets.rb +27 -10
- data/lib/x_twitter_scraper/resources/x/communities.rb +27 -11
- data/lib/x_twitter_scraper/resources/x/dm.rb +9 -6
- data/lib/x_twitter_scraper/resources/x/followers.rb +4 -4
- data/lib/x_twitter_scraper/resources/x/lists.rb +22 -9
- data/lib/x_twitter_scraper/resources/x/media.rb +11 -9
- data/lib/x_twitter_scraper/resources/x/profile.rb +6 -6
- data/lib/x_twitter_scraper/resources/x/tweets.rb +282 -28
- data/lib/x_twitter_scraper/resources/x/users.rb +485 -34
- data/lib/x_twitter_scraper/resources/x/write_actions.rb +37 -0
- data/lib/x_twitter_scraper/resources/x.rb +33 -13
- data/lib/x_twitter_scraper/version.rb +1 -1
- data/lib/x_twitter_scraper.rb +41 -27
- data/rbi/x_twitter_scraper/client.rbi +14 -22
- data/rbi/x_twitter_scraper/models/account_retrieve_response.rbi +181 -23
- data/rbi/x_twitter_scraper/models/content_disclosure.rbi +149 -0
- data/rbi/x_twitter_scraper/models/{integration_retrieve_params.rbi → credit_redirect_topup_checkout_params.rbi} +14 -6
- data/rbi/x_twitter_scraper/models/credit_retrieve_balance_response.rbi +35 -9
- data/rbi/x_twitter_scraper/models/{integration_list_deliveries_params.rbi → credit_retrieve_topup_status_params.rbi} +8 -17
- data/rbi/x_twitter_scraper/models/credit_retrieve_topup_status_response.rbi +107 -0
- data/rbi/x_twitter_scraper/models/credit_topup_balance_params.rbi +20 -6
- data/rbi/x_twitter_scraper/models/credit_topup_balance_response.rbi +19 -5
- data/rbi/x_twitter_scraper/models/draft_list_params.rbi +8 -2
- data/rbi/x_twitter_scraper/models/draw_detail.rbi +2 -0
- data/rbi/x_twitter_scraper/models/draw_export_params.rbi +3 -12
- data/rbi/x_twitter_scraper/models/draw_list_item.rbi +2 -0
- data/rbi/x_twitter_scraper/models/draw_list_params.rbi +16 -10
- data/rbi/x_twitter_scraper/models/draw_run_response.rbi +15 -1
- data/rbi/x_twitter_scraper/models/embedded_tweet.rbi +255 -0
- data/rbi/x_twitter_scraper/models/error.rbi +865 -87
- data/rbi/x_twitter_scraper/models/event.rbi +63 -4
- data/rbi/x_twitter_scraper/models/event_detail.rbi +73 -5
- data/rbi/x_twitter_scraper/models/event_list_params.rbi +16 -10
- data/rbi/x_twitter_scraper/models/event_type.rbi +58 -4
- data/rbi/x_twitter_scraper/models/extraction_estimate_cost_params.rbi +580 -2
- data/rbi/x_twitter_scraper/models/extraction_estimate_cost_response.rbi +98 -14
- data/rbi/x_twitter_scraper/models/extraction_export_results_params.rbi +3 -13
- data/rbi/x_twitter_scraper/models/extraction_job.rbi +15 -0
- data/rbi/x_twitter_scraper/models/extraction_list_params.rbi +31 -10
- data/rbi/x_twitter_scraper/models/extraction_retrieve_params.rbi +8 -8
- data/rbi/x_twitter_scraper/models/extraction_retrieve_response.rbi +2 -2
- data/rbi/x_twitter_scraper/models/extraction_run_params.rbi +546 -2
- data/rbi/x_twitter_scraper/models/extraction_run_response.rbi +15 -0
- data/rbi/x_twitter_scraper/models/guest_wallet_amount.rbi +39 -0
- data/rbi/x_twitter_scraper/models/guest_wallet_create_params.rbi +58 -0
- data/rbi/x_twitter_scraper/models/guest_wallet_create_response.rbi +243 -0
- data/rbi/x_twitter_scraper/models/{integration_list_params.rbi → guest_wallet_retrieve_status_params.rbi} +2 -2
- data/rbi/x_twitter_scraper/models/guest_wallet_retrieve_status_response.rbi +402 -0
- data/rbi/x_twitter_scraper/models/guest_wallet_topup_params.rbi +58 -0
- data/rbi/x_twitter_scraper/models/guest_wallet_topup_response.rbi +293 -0
- data/rbi/x_twitter_scraper/models/monitor.rbi +8 -0
- data/rbi/x_twitter_scraper/models/monitor_create_response.rbi +14 -0
- data/rbi/x_twitter_scraper/models/monitors/keyword_create_params.rbi +56 -0
- data/rbi/x_twitter_scraper/models/monitors/keyword_create_response.rbi +75 -0
- data/rbi/x_twitter_scraper/models/monitors/keyword_deactivate_params.rbi +40 -0
- data/rbi/x_twitter_scraper/models/monitors/keyword_deactivate_response.rbi +28 -0
- data/rbi/x_twitter_scraper/models/monitors/keyword_list_params.rbi +34 -0
- data/rbi/x_twitter_scraper/models/monitors/keyword_list_response.rbi +123 -0
- data/rbi/x_twitter_scraper/models/monitors/keyword_retrieve_params.rbi +40 -0
- data/rbi/x_twitter_scraper/models/monitors/keyword_retrieve_response.rbi +75 -0
- data/rbi/x_twitter_scraper/models/monitors/keyword_update_params.rbi +72 -0
- data/rbi/x_twitter_scraper/models/monitors/keyword_update_response.rbi +75 -0
- data/rbi/x_twitter_scraper/models/paginated_tweets.rbi +8 -4
- data/rbi/x_twitter_scraper/models/paginated_users.rbi +8 -4
- data/rbi/x_twitter_scraper/models/radar_item.rbi +131 -6
- data/rbi/x_twitter_scraper/models/radar_retrieve_trending_topics_params.rbi +109 -20
- data/rbi/x_twitter_scraper/models/radar_retrieve_trending_topics_response.rbi +22 -5
- data/rbi/x_twitter_scraper/models/search_tweet.rbi +316 -0
- data/rbi/x_twitter_scraper/models/subscribe_create_params.rbi +62 -2
- data/rbi/x_twitter_scraper/models/subscribe_create_response.rbi +10 -23
- data/rbi/x_twitter_scraper/models/trend_list_params.rbi +4 -4
- data/rbi/x_twitter_scraper/models/tweet_media.rbi +130 -0
- data/rbi/x_twitter_scraper/models/user_profile.rbi +346 -0
- data/rbi/x_twitter_scraper/models/webhook.rbi +57 -0
- data/rbi/x_twitter_scraper/models/webhook_create_response.rbi +2 -0
- data/rbi/x_twitter_scraper/models/{api_key_revoke_params.rbi → webhook_resume_params.rbi} +2 -2
- data/rbi/x_twitter_scraper/models/webhook_resume_response.rbi +55 -0
- data/rbi/x_twitter_scraper/models/x/account_connection_challenge_submit_params.rbi +54 -0
- data/rbi/x_twitter_scraper/models/x/account_connection_challenge_submit_response.rbi +131 -0
- data/rbi/x_twitter_scraper/models/x/account_create_params.rbi +0 -11
- data/rbi/x_twitter_scraper/models/x/account_create_response.rbi +79 -1
- data/rbi/x_twitter_scraper/models/x/account_reauth_params.rbi +11 -0
- data/rbi/x_twitter_scraper/models/x/account_reauth_response.rbi +96 -5
- data/rbi/x_twitter_scraper/models/x/bookmark_retrieve_folders_response.rbi +9 -1
- data/rbi/x_twitter_scraper/models/x/communities/join_create_response.rbi +30 -0
- data/rbi/x_twitter_scraper/models/x/communities/join_delete_all_response.rbi +30 -0
- data/rbi/x_twitter_scraper/models/x/communities/tweet_list_by_community_params.rbi +19 -0
- data/rbi/x_twitter_scraper/models/x/communities/tweet_list_params.rbi +85 -10
- data/rbi/x_twitter_scraper/models/x/community_retrieve_info_response.rbi +115 -0
- data/rbi/x_twitter_scraper/models/x/community_retrieve_members_params.rbi +15 -0
- data/rbi/x_twitter_scraper/models/x/community_retrieve_search_params.rbi +79 -4
- data/rbi/x_twitter_scraper/models/x/dm_retrieve_history_params.rbi +10 -0
- data/rbi/x_twitter_scraper/models/x/dm_retrieve_history_response.rbi +20 -13
- data/rbi/x_twitter_scraper/models/x/dm_send_params.rbi +2 -9
- data/rbi/x_twitter_scraper/models/x/follower_check_params.rbi +4 -4
- data/rbi/x_twitter_scraper/models/x/list_retrieve_followers_params.rbi +17 -0
- data/rbi/x_twitter_scraper/models/x/list_retrieve_members_params.rbi +11 -0
- data/rbi/x_twitter_scraper/models/x/list_retrieve_tweets_params.rbi +19 -0
- data/rbi/x_twitter_scraper/models/x/media_download_params.rbi +24 -2
- data/rbi/x_twitter_scraper/models/x/media_upload_params.rbi +9 -18
- data/rbi/x_twitter_scraper/models/x/media_upload_response.rbi +20 -5
- data/rbi/x_twitter_scraper/models/x/profile_update_avatar_params.rbi +9 -9
- data/rbi/x_twitter_scraper/models/x/profile_update_banner_params.rbi +9 -9
- data/rbi/x_twitter_scraper/models/x/tweet_author.rbi +8 -39
- data/rbi/x_twitter_scraper/models/x/tweet_create_params.rbi +23 -12
- data/rbi/x_twitter_scraper/models/x/tweet_create_response.rbi +41 -5
- data/rbi/x_twitter_scraper/models/x/tweet_detail.rbi +156 -115
- data/rbi/x_twitter_scraper/models/x/tweet_get_favoriters_params.rbi +17 -0
- data/rbi/x_twitter_scraper/models/x/tweet_get_quotes_params.rbi +508 -0
- data/rbi/x_twitter_scraper/models/x/tweet_get_replies_params.rbi +512 -0
- data/rbi/x_twitter_scraper/models/x/tweet_get_retweeters_params.rbi +17 -0
- data/rbi/x_twitter_scraper/models/x/tweet_get_thread_params.rbi +19 -0
- data/rbi/x_twitter_scraper/models/x/tweet_retrieve_response.rbi +8 -4
- data/rbi/x_twitter_scraper/models/x/tweet_search_params.rbi +557 -7
- data/rbi/x_twitter_scraper/models/x/user_remove_follower_params.rbi +54 -0
- data/rbi/x_twitter_scraper/models/x/user_remove_follower_response.rbi +28 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_batch_params.rbi +4 -2
- data/rbi/x_twitter_scraper/models/x/user_retrieve_batch_response.rbi +102 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_followers_params.rbi +30 -2
- data/rbi/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rbi +17 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_following_params.rbi +30 -2
- data/rbi/x_twitter_scraper/models/x/user_retrieve_likes_params.rbi +520 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_media_params.rbi +520 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_mentions_params.rbi +523 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_replies_params.rbi +591 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_tweets_params.rbi +523 -0
- data/rbi/x_twitter_scraper/models/x/user_retrieve_verified_followers_params.rbi +17 -0
- data/rbi/x_twitter_scraper/models/x/write_action_retrieve_params.rbi +40 -0
- data/rbi/x_twitter_scraper/models/x/write_action_retrieve_response.rbi +313 -0
- data/rbi/x_twitter_scraper/models/x/x_account.rbi +87 -4
- data/rbi/x_twitter_scraper/models/x/x_account_detail.rbi +58 -10
- data/rbi/x_twitter_scraper/models/x_get_article_response.rbi +308 -12
- data/rbi/x_twitter_scraper/models/x_get_home_timeline_params.rbi +2 -2
- data/rbi/x_twitter_scraper/models/x_get_notifications_params.rbi +3 -3
- data/rbi/x_twitter_scraper/models/x_get_trends_params.rbi +30 -2
- data/rbi/x_twitter_scraper/models.rbi +24 -22
- data/rbi/x_twitter_scraper/resources/account.rbi +1 -1
- data/rbi/x_twitter_scraper/resources/compose.rbi +1 -1
- data/rbi/x_twitter_scraper/resources/credits.rbi +37 -5
- data/rbi/x_twitter_scraper/resources/drafts.rbi +7 -4
- data/rbi/x_twitter_scraper/resources/draws.rbi +14 -8
- data/rbi/x_twitter_scraper/resources/events.rbi +8 -5
- data/rbi/x_twitter_scraper/resources/extractions.rbi +210 -11
- data/rbi/x_twitter_scraper/resources/guest_wallets.rbi +76 -0
- data/rbi/x_twitter_scraper/resources/monitors/keywords.rbi +95 -0
- data/rbi/x_twitter_scraper/resources/monitors.rbi +12 -5
- data/rbi/x_twitter_scraper/resources/radar.rbi +12 -8
- data/rbi/x_twitter_scraper/resources/styles.rbi +1 -1
- data/rbi/x_twitter_scraper/resources/subscribe.rbi +9 -3
- data/rbi/x_twitter_scraper/resources/support/tickets.rbi +3 -3
- data/rbi/x_twitter_scraper/resources/trends.rbi +4 -4
- data/rbi/x_twitter_scraper/resources/webhooks.rbi +19 -5
- data/rbi/x_twitter_scraper/resources/x/account_connection_challenges.rbi +36 -0
- data/rbi/x_twitter_scraper/resources/x/accounts.rbi +6 -6
- data/rbi/x_twitter_scraper/resources/x/bookmarks.rbi +1 -1
- data/rbi/x_twitter_scraper/resources/x/communities/join.rbi +8 -4
- data/rbi/x_twitter_scraper/resources/x/communities/tweets.rbi +25 -7
- data/rbi/x_twitter_scraper/resources/x/communities.rbi +23 -7
- data/rbi/x_twitter_scraper/resources/x/dm.rbi +5 -2
- data/rbi/x_twitter_scraper/resources/x/followers.rbi +4 -4
- data/rbi/x_twitter_scraper/resources/x/lists.rbi +20 -4
- data/rbi/x_twitter_scraper/resources/x/media.rbi +13 -9
- data/rbi/x_twitter_scraper/resources/x/profile.rbi +8 -8
- data/rbi/x_twitter_scraper/resources/x/tweets.rbi +309 -16
- data/rbi/x_twitter_scraper/resources/x/users.rbi +520 -18
- data/rbi/x_twitter_scraper/resources/x/write_actions.rbi +31 -0
- data/rbi/x_twitter_scraper/resources/x.rbi +30 -12
- data/sig/x_twitter_scraper/client.rbs +2 -6
- data/sig/x_twitter_scraper/models/account_retrieve_response.rbs +106 -19
- data/sig/x_twitter_scraper/models/content_disclosure.rbs +78 -0
- data/sig/x_twitter_scraper/models/{api_key_create_params.rbs → credit_redirect_topup_checkout_params.rbs} +7 -8
- data/sig/x_twitter_scraper/models/credit_retrieve_balance_response.rbs +22 -12
- data/sig/x_twitter_scraper/models/{integration_list_deliveries_params.rbs → credit_retrieve_topup_status_params.rbs} +6 -12
- data/sig/x_twitter_scraper/models/credit_retrieve_topup_status_response.rbs +45 -0
- data/sig/x_twitter_scraper/models/credit_topup_balance_params.rbs +11 -4
- data/sig/x_twitter_scraper/models/credit_topup_balance_response.rbs +6 -4
- data/sig/x_twitter_scraper/models/draw_export_params.rbs +2 -6
- data/sig/x_twitter_scraper/models/draw_list_params.rbs +5 -5
- data/sig/x_twitter_scraper/models/embedded_tweet.rbs +187 -0
- data/sig/x_twitter_scraper/models/error.rbs +341 -54
- data/sig/x_twitter_scraper/models/event.rbs +34 -2
- data/sig/x_twitter_scraper/models/event_detail.rbs +34 -2
- data/sig/x_twitter_scraper/models/event_list_params.rbs +5 -5
- data/sig/x_twitter_scraper/models/event_type.rbs +34 -4
- data/sig/x_twitter_scraper/models/extraction_estimate_cost_params.rbs +269 -1
- data/sig/x_twitter_scraper/models/extraction_estimate_cost_response.rbs +46 -12
- data/sig/x_twitter_scraper/models/extraction_export_results_params.rbs +2 -6
- data/sig/x_twitter_scraper/models/extraction_job.rbs +6 -0
- data/sig/x_twitter_scraper/models/extraction_list_params.rbs +11 -5
- data/sig/x_twitter_scraper/models/extraction_retrieve_params.rbs +5 -5
- data/sig/x_twitter_scraper/models/extraction_run_params.rbs +269 -1
- data/sig/x_twitter_scraper/models/extraction_run_response.rbs +6 -0
- data/sig/x_twitter_scraper/models/guest_wallet_amount.rbs +15 -0
- data/sig/x_twitter_scraper/models/guest_wallet_create_params.rbs +32 -0
- data/sig/x_twitter_scraper/models/guest_wallet_create_response.rbs +125 -0
- data/sig/x_twitter_scraper/models/{api_key_list_params.rbs → guest_wallet_retrieve_status_params.rbs} +2 -2
- data/sig/x_twitter_scraper/models/guest_wallet_retrieve_status_response.rbs +163 -0
- data/sig/x_twitter_scraper/models/guest_wallet_topup_params.rbs +32 -0
- data/sig/x_twitter_scraper/models/guest_wallet_topup_response.rbs +146 -0
- data/sig/x_twitter_scraper/models/monitor.rbs +5 -0
- data/sig/x_twitter_scraper/models/monitor_create_response.rbs +10 -0
- data/sig/x_twitter_scraper/models/monitors/keyword_create_params.rbs +33 -0
- data/sig/x_twitter_scraper/models/monitors/keyword_create_response.rbs +47 -0
- data/sig/x_twitter_scraper/models/monitors/keyword_deactivate_params.rbs +25 -0
- data/sig/x_twitter_scraper/models/monitors/keyword_deactivate_response.rbs +15 -0
- data/sig/x_twitter_scraper/models/monitors/keyword_list_params.rbs +19 -0
- data/sig/x_twitter_scraper/models/monitors/keyword_list_response.rbs +69 -0
- data/sig/x_twitter_scraper/models/monitors/keyword_retrieve_params.rbs +25 -0
- data/sig/x_twitter_scraper/models/monitors/keyword_retrieve_response.rbs +47 -0
- data/sig/x_twitter_scraper/models/monitors/keyword_update_params.rbs +44 -0
- data/sig/x_twitter_scraper/models/monitors/keyword_update_response.rbs +47 -0
- data/sig/x_twitter_scraper/models/paginated_tweets.rbs +4 -4
- data/sig/x_twitter_scraper/models/paginated_users.rbs +4 -4
- data/sig/x_twitter_scraper/models/radar_item.rbs +81 -8
- data/sig/x_twitter_scraper/models/radar_retrieve_trending_topics_params.rbs +44 -10
- data/sig/x_twitter_scraper/models/radar_retrieve_trending_topics_response.rbs +14 -4
- data/sig/x_twitter_scraper/models/search_tweet.rbs +205 -0
- data/sig/x_twitter_scraper/models/subscribe_create_params.rbs +28 -3
- data/sig/x_twitter_scraper/models/subscribe_create_response.rbs +10 -16
- data/sig/x_twitter_scraper/models/tweet_media.rbs +72 -0
- data/sig/x_twitter_scraper/models/user_profile.rbs +247 -0
- data/sig/x_twitter_scraper/models/webhook.rbs +27 -0
- data/sig/x_twitter_scraper/models/{api_key_revoke_params.rbs → webhook_resume_params.rbs} +2 -2
- data/sig/x_twitter_scraper/models/webhook_resume_response.rbs +26 -0
- data/sig/x_twitter_scraper/models/x/account_connection_challenge_submit_params.rbs +30 -0
- data/sig/x_twitter_scraper/models/x/account_connection_challenge_submit_response.rbs +68 -0
- data/sig/x_twitter_scraper/models/x/account_create_params.rbs +0 -7
- data/sig/x_twitter_scraper/models/x/account_create_response.rbs +37 -1
- data/sig/x_twitter_scraper/models/x/account_reauth_params.rbs +7 -1
- data/sig/x_twitter_scraper/models/x/account_reauth_response.rbs +51 -3
- data/sig/x_twitter_scraper/models/x/communities/join_create_response.rbs +17 -0
- data/sig/x_twitter_scraper/models/x/communities/join_delete_all_response.rbs +17 -0
- data/sig/x_twitter_scraper/models/x/communities/tweet_list_by_community_params.rbs +7 -1
- data/sig/x_twitter_scraper/models/x/communities/tweet_list_params.rbs +34 -5
- data/sig/x_twitter_scraper/models/x/community_retrieve_info_response.rbs +66 -0
- data/sig/x_twitter_scraper/models/x/community_retrieve_members_params.rbs +7 -1
- data/sig/x_twitter_scraper/models/x/community_retrieve_search_params.rbs +34 -5
- data/sig/x_twitter_scraper/models/x/dm_retrieve_history_params.rbs +5 -1
- data/sig/x_twitter_scraper/models/x/dm_retrieve_history_response.rbs +13 -10
- data/sig/x_twitter_scraper/models/x/dm_send_params.rbs +1 -8
- data/sig/x_twitter_scraper/models/x/list_retrieve_followers_params.rbs +7 -1
- data/sig/x_twitter_scraper/models/x/list_retrieve_members_params.rbs +7 -1
- data/sig/x_twitter_scraper/models/x/list_retrieve_tweets_params.rbs +7 -0
- data/sig/x_twitter_scraper/models/x/media_download_params.rbs +18 -1
- data/sig/x_twitter_scraper/models/x/media_upload_params.rbs +4 -14
- data/sig/x_twitter_scraper/models/x/media_upload_response.rbs +10 -3
- data/sig/x_twitter_scraper/models/x/profile_update_avatar_params.rbs +4 -4
- data/sig/x_twitter_scraper/models/x/profile_update_banner_params.rbs +4 -4
- data/sig/x_twitter_scraper/models/x/tweet_author.rbs +8 -31
- data/sig/x_twitter_scraper/models/x/tweet_create_params.rbs +13 -11
- data/sig/x_twitter_scraper/models/x/tweet_create_response.rbs +30 -3
- data/sig/x_twitter_scraper/models/x/tweet_detail.rbs +99 -61
- data/sig/x_twitter_scraper/models/x/tweet_get_favoriters_params.rbs +7 -1
- data/sig/x_twitter_scraper/models/x/tweet_get_quotes_params.rbs +242 -1
- data/sig/x_twitter_scraper/models/x/tweet_get_replies_params.rbs +247 -1
- data/sig/x_twitter_scraper/models/x/tweet_get_retweeters_params.rbs +7 -1
- data/sig/x_twitter_scraper/models/x/tweet_get_thread_params.rbs +7 -1
- data/sig/x_twitter_scraper/models/x/tweet_search_params.rbs +277 -1
- data/sig/x_twitter_scraper/models/x/user_remove_follower_params.rbs +30 -0
- data/sig/x_twitter_scraper/models/x/user_remove_follower_response.rbs +15 -0
- data/sig/x_twitter_scraper/models/x/user_retrieve_batch_response.rbs +57 -0
- data/sig/x_twitter_scraper/models/x/user_retrieve_followers_params.rbs +19 -1
- data/sig/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rbs +7 -1
- data/sig/x_twitter_scraper/models/x/user_retrieve_following_params.rbs +19 -1
- data/sig/x_twitter_scraper/models/x/user_retrieve_likes_params.rbs +245 -1
- data/sig/x_twitter_scraper/models/x/user_retrieve_media_params.rbs +245 -1
- data/sig/x_twitter_scraper/models/x/user_retrieve_mentions_params.rbs +247 -1
- data/sig/x_twitter_scraper/models/x/user_retrieve_replies_params.rbs +283 -0
- data/sig/x_twitter_scraper/models/x/user_retrieve_tweets_params.rbs +242 -1
- data/sig/x_twitter_scraper/models/x/user_retrieve_verified_followers_params.rbs +7 -1
- data/sig/x_twitter_scraper/models/x/write_action_retrieve_params.rbs +25 -0
- data/sig/x_twitter_scraper/models/x/write_action_retrieve_response.rbs +177 -0
- data/sig/x_twitter_scraper/models/x/x_account.rbs +41 -3
- data/sig/x_twitter_scraper/models/x/x_account_detail.rbs +26 -7
- data/sig/x_twitter_scraper/models/x_get_article_response.rbs +193 -6
- data/sig/x_twitter_scraper/models/x_get_trends_params.rbs +20 -3
- data/sig/x_twitter_scraper/models.rbs +21 -21
- data/sig/x_twitter_scraper/resources/credits.rbs +12 -1
- data/sig/x_twitter_scraper/resources/draws.rbs +2 -2
- data/sig/x_twitter_scraper/resources/events.rbs +1 -1
- data/sig/x_twitter_scraper/resources/extractions.rbs +61 -3
- data/sig/x_twitter_scraper/resources/guest_wallets.rbs +25 -0
- data/sig/x_twitter_scraper/resources/monitors/keywords.rbs +36 -0
- data/sig/x_twitter_scraper/resources/monitors.rbs +2 -0
- data/sig/x_twitter_scraper/resources/radar.rbs +3 -2
- data/sig/x_twitter_scraper/resources/subscribe.rbs +1 -0
- data/sig/x_twitter_scraper/resources/webhooks.rbs +5 -0
- data/sig/x_twitter_scraper/resources/x/account_connection_challenges.rbs +15 -0
- data/sig/x_twitter_scraper/resources/x/accounts.rbs +1 -1
- data/sig/x_twitter_scraper/resources/x/communities/join.rbs +2 -2
- data/sig/x_twitter_scraper/resources/x/communities/tweets.rbs +4 -1
- data/sig/x_twitter_scraper/resources/x/communities.rbs +4 -1
- data/sig/x_twitter_scraper/resources/x/dm.rbs +1 -1
- data/sig/x_twitter_scraper/resources/x/lists.rbs +3 -0
- data/sig/x_twitter_scraper/resources/x/media.rbs +3 -2
- data/sig/x_twitter_scraper/resources/x/profile.rbs +2 -2
- data/sig/x_twitter_scraper/resources/x/tweets.rbs +88 -2
- data/sig/x_twitter_scraper/resources/x/users.rbs +151 -2
- data/sig/x_twitter_scraper/resources/x/write_actions.rbs +14 -0
- data/sig/x_twitter_scraper/resources/x.rbs +6 -0
- metadata +141 -84
- data/lib/x_twitter_scraper/models/api_key.rb +0 -47
- data/lib/x_twitter_scraper/models/api_key_create_params.rb +0 -20
- data/lib/x_twitter_scraper/models/api_key_create_response.rb +0 -40
- data/lib/x_twitter_scraper/models/api_key_list_params.rb +0 -14
- data/lib/x_twitter_scraper/models/api_key_list_response.rb +0 -16
- data/lib/x_twitter_scraper/models/api_key_revoke_response.rb +0 -16
- data/lib/x_twitter_scraper/models/integration.rb +0 -93
- data/lib/x_twitter_scraper/models/integration_create_params.rb +0 -58
- data/lib/x_twitter_scraper/models/integration_delete_params.rb +0 -20
- data/lib/x_twitter_scraper/models/integration_delete_response.rb +0 -16
- data/lib/x_twitter_scraper/models/integration_delivery.rb +0 -71
- data/lib/x_twitter_scraper/models/integration_list_deliveries_params.rb +0 -29
- data/lib/x_twitter_scraper/models/integration_list_deliveries_response.rb +0 -17
- data/lib/x_twitter_scraper/models/integration_list_response.rb +0 -16
- data/lib/x_twitter_scraper/models/integration_retrieve_params.rb +0 -20
- data/lib/x_twitter_scraper/models/integration_send_test_params.rb +0 -20
- data/lib/x_twitter_scraper/models/integration_send_test_response.rb +0 -16
- data/lib/x_twitter_scraper/models/integration_update_params.rb +0 -77
- data/lib/x_twitter_scraper/models/x/community_action_result.rb +0 -31
- data/lib/x_twitter_scraper/models/x/search_tweet.rb +0 -119
- data/lib/x_twitter_scraper/models/x/user_profile.rb +0 -80
- data/lib/x_twitter_scraper/resources/api_keys.rb +0 -77
- data/lib/x_twitter_scraper/resources/bot/platform_links.rb +0 -16
- data/lib/x_twitter_scraper/resources/bot.rb +0 -18
- data/lib/x_twitter_scraper/resources/integrations.rb +0 -182
- data/rbi/x_twitter_scraper/models/api_key.rbi +0 -69
- data/rbi/x_twitter_scraper/models/api_key_create_params.rbi +0 -41
- data/rbi/x_twitter_scraper/models/api_key_create_response.rbi +0 -56
- data/rbi/x_twitter_scraper/models/api_key_list_params.rbi +0 -32
- data/rbi/x_twitter_scraper/models/api_key_list_response.rbi +0 -30
- data/rbi/x_twitter_scraper/models/api_key_revoke_response.rbi +0 -26
- data/rbi/x_twitter_scraper/models/integration.rbi +0 -117
- data/rbi/x_twitter_scraper/models/integration_create_params.rbi +0 -95
- data/rbi/x_twitter_scraper/models/integration_delete_params.rbi +0 -38
- data/rbi/x_twitter_scraper/models/integration_delete_response.rbi +0 -26
- data/rbi/x_twitter_scraper/models/integration_delivery.rbi +0 -108
- data/rbi/x_twitter_scraper/models/integration_list_deliveries_response.rbi +0 -34
- data/rbi/x_twitter_scraper/models/integration_list_response.rbi +0 -34
- data/rbi/x_twitter_scraper/models/integration_send_test_params.rbi +0 -38
- data/rbi/x_twitter_scraper/models/integration_send_test_response.rbi +0 -26
- data/rbi/x_twitter_scraper/models/integration_update_params.rbi +0 -115
- data/rbi/x_twitter_scraper/models/x/community_action_result.rbi +0 -49
- data/rbi/x_twitter_scraper/models/x/search_tweet.rbi +0 -181
- data/rbi/x_twitter_scraper/models/x/user_profile.rbi +0 -125
- data/rbi/x_twitter_scraper/resources/api_keys.rbi +0 -46
- data/rbi/x_twitter_scraper/resources/bot/platform_links.rbi +0 -16
- data/rbi/x_twitter_scraper/resources/bot.rbi +0 -15
- data/rbi/x_twitter_scraper/resources/integrations.rbi +0 -133
- data/sig/x_twitter_scraper/models/api_key.rbs +0 -47
- data/sig/x_twitter_scraper/models/api_key_create_response.rbs +0 -40
- data/sig/x_twitter_scraper/models/api_key_list_response.rbs +0 -13
- data/sig/x_twitter_scraper/models/api_key_revoke_response.rbs +0 -13
- data/sig/x_twitter_scraper/models/integration.rbs +0 -78
- data/sig/x_twitter_scraper/models/integration_create_params.rbs +0 -51
- data/sig/x_twitter_scraper/models/integration_delete_params.rbs +0 -23
- data/sig/x_twitter_scraper/models/integration_delete_response.rbs +0 -13
- data/sig/x_twitter_scraper/models/integration_delivery.rbs +0 -75
- data/sig/x_twitter_scraper/models/integration_list_deliveries_response.rbs +0 -18
- data/sig/x_twitter_scraper/models/integration_list_params.rbs +0 -15
- data/sig/x_twitter_scraper/models/integration_list_response.rbs +0 -16
- data/sig/x_twitter_scraper/models/integration_retrieve_params.rbs +0 -23
- data/sig/x_twitter_scraper/models/integration_send_test_params.rbs +0 -23
- data/sig/x_twitter_scraper/models/integration_send_test_response.rbs +0 -13
- data/sig/x_twitter_scraper/models/integration_update_params.rbs +0 -77
- data/sig/x_twitter_scraper/models/x/community_action_result.rbs +0 -28
- data/sig/x_twitter_scraper/models/x/search_tweet.rbs +0 -121
- data/sig/x_twitter_scraper/models/x/user_profile.rbs +0 -88
- data/sig/x_twitter_scraper/resources/api_keys.rbs +0 -21
- data/sig/x_twitter_scraper/resources/bot/platform_links.rbs +0 -9
- data/sig/x_twitter_scraper/resources/bot.rbs +0 -9
- data/sig/x_twitter_scraper/resources/integrations.rbs +0 -52
|
@@ -7,11 +7,11 @@ module XTwitterScraper
|
|
|
7
7
|
extend XTwitterScraper::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include XTwitterScraper::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!attribute
|
|
11
|
-
# Cursor for keyset pagination
|
|
10
|
+
# @!attribute cursor
|
|
11
|
+
# Cursor for keyset pagination from prior response next_cursor
|
|
12
12
|
#
|
|
13
13
|
# @return [String, nil]
|
|
14
|
-
optional :
|
|
14
|
+
optional :cursor, String
|
|
15
15
|
|
|
16
16
|
# @!attribute event_type
|
|
17
17
|
# Filter events by type
|
|
@@ -20,7 +20,10 @@ module XTwitterScraper
|
|
|
20
20
|
optional :event_type, enum: -> { XTwitterScraper::EventType }
|
|
21
21
|
|
|
22
22
|
# @!attribute limit
|
|
23
|
-
# Maximum number of items to return (1-100, default 50)
|
|
23
|
+
# Maximum number of items to return (1-100, default 50). For paid per-result
|
|
24
|
+
# endpoints, the returned count may be lower when remaining credits cannot cover
|
|
25
|
+
# the requested page. If zero paid results are affordable, the endpoint returns
|
|
26
|
+
# 402 insufficient_credits.
|
|
24
27
|
#
|
|
25
28
|
# @return [Integer, nil]
|
|
26
29
|
optional :limit, Integer
|
|
@@ -31,12 +34,15 @@ module XTwitterScraper
|
|
|
31
34
|
# @return [String, nil]
|
|
32
35
|
optional :monitor_id, String
|
|
33
36
|
|
|
34
|
-
# @!method initialize(
|
|
35
|
-
#
|
|
37
|
+
# @!method initialize(cursor: nil, event_type: nil, limit: nil, monitor_id: nil, request_options: {})
|
|
38
|
+
# Some parameter documentations has been truncated, see
|
|
39
|
+
# {XTwitterScraper::Models::EventListParams} for more details.
|
|
40
|
+
#
|
|
41
|
+
# @param cursor [String] Cursor for keyset pagination from prior response next_cursor
|
|
36
42
|
#
|
|
37
43
|
# @param event_type [Symbol, XTwitterScraper::Models::EventType] Filter events by type
|
|
38
44
|
#
|
|
39
|
-
# @param limit [Integer] Maximum number of items to return (1-100, default 50)
|
|
45
|
+
# @param limit [Integer] Maximum number of items to return (1-100, default 50). For paid per-result endpo
|
|
40
46
|
#
|
|
41
47
|
# @param monitor_id [String] Filter events by monitor ID
|
|
42
48
|
#
|
|
@@ -10,8 +10,23 @@ module XTwitterScraper
|
|
|
10
10
|
TWEET_REPLY = :"tweet.reply"
|
|
11
11
|
TWEET_RETWEET = :"tweet.retweet"
|
|
12
12
|
TWEET_QUOTE = :"tweet.quote"
|
|
13
|
-
|
|
14
|
-
|
|
13
|
+
TWEET_MEDIA = :"tweet.media"
|
|
14
|
+
TWEET_LINK = :"tweet.link"
|
|
15
|
+
TWEET_POLL = :"tweet.poll"
|
|
16
|
+
TWEET_MENTION = :"tweet.mention"
|
|
17
|
+
TWEET_HASHTAG = :"tweet.hashtag"
|
|
18
|
+
TWEET_LONGFORM = :"tweet.longform"
|
|
19
|
+
PROFILE_AVATAR_CHANGED = :"profile.avatar.changed"
|
|
20
|
+
PROFILE_BANNER_CHANGED = :"profile.banner.changed"
|
|
21
|
+
PROFILE_NAME_CHANGED = :"profile.name.changed"
|
|
22
|
+
PROFILE_USERNAME_CHANGED = :"profile.username.changed"
|
|
23
|
+
PROFILE_BIO_CHANGED = :"profile.bio.changed"
|
|
24
|
+
PROFILE_LOCATION_CHANGED = :"profile.location.changed"
|
|
25
|
+
PROFILE_URL_CHANGED = :"profile.url.changed"
|
|
26
|
+
PROFILE_VERIFIED_CHANGED = :"profile.verified.changed"
|
|
27
|
+
PROFILE_PROTECTED_CHANGED = :"profile.protected.changed"
|
|
28
|
+
PROFILE_PINNED_TWEET_CHANGED = :"profile.pinned_tweet.changed"
|
|
29
|
+
PROFILE_UNAVAILABLE_CHANGED = :"profile.unavailable.changed"
|
|
15
30
|
|
|
16
31
|
# @!method self.values
|
|
17
32
|
# @return [Array<Symbol>]
|
|
@@ -21,6 +21,32 @@ module XTwitterScraper
|
|
|
21
21
|
# @return [String, nil]
|
|
22
22
|
optional :advanced_query, String, api_name: :advancedQuery
|
|
23
23
|
|
|
24
|
+
# @!attribute any_words
|
|
25
|
+
# Alternative words or quoted phrases for estimated results. Separate with spaces,
|
|
26
|
+
# commas, or lines.
|
|
27
|
+
#
|
|
28
|
+
# @return [String, nil]
|
|
29
|
+
optional :any_words, String, api_name: :anyWords
|
|
30
|
+
|
|
31
|
+
# @!attribute bounding_box
|
|
32
|
+
# Geo bounding box used for estimation, e.g. -74.1 40.6 -73.9 40.8
|
|
33
|
+
# (tweet_search_extractor)
|
|
34
|
+
#
|
|
35
|
+
# @return [String, nil]
|
|
36
|
+
optional :bounding_box, String, api_name: :boundingBox
|
|
37
|
+
|
|
38
|
+
# @!attribute cashtags
|
|
39
|
+
# Cashtags applied to the estimate, separated by spaces, commas, or lines.
|
|
40
|
+
#
|
|
41
|
+
# @return [String, nil]
|
|
42
|
+
optional :cashtags, String
|
|
43
|
+
|
|
44
|
+
# @!attribute conversation_id
|
|
45
|
+
# Conversation ID filter used for estimation (tweet_search_extractor)
|
|
46
|
+
#
|
|
47
|
+
# @return [String, nil]
|
|
48
|
+
optional :conversation_id, String, api_name: :conversationId
|
|
49
|
+
|
|
24
50
|
# @!attribute exact_phrase
|
|
25
51
|
# Exact phrase filter for search estimation
|
|
26
52
|
#
|
|
@@ -28,27 +54,163 @@ module XTwitterScraper
|
|
|
28
54
|
optional :exact_phrase, String, api_name: :exactPhrase
|
|
29
55
|
|
|
30
56
|
# @!attribute exclude_words
|
|
31
|
-
# Words excluded from estimated
|
|
57
|
+
# Words or quoted phrases excluded from estimated results. Separate with spaces,
|
|
58
|
+
# commas, or lines.
|
|
32
59
|
#
|
|
33
60
|
# @return [String, nil]
|
|
34
61
|
optional :exclude_words, String, api_name: :excludeWords
|
|
35
62
|
|
|
63
|
+
# @!attribute from_user
|
|
64
|
+
# Estimate only tweets from this author username (tweet_search_extractor)
|
|
65
|
+
#
|
|
66
|
+
# @return [String, nil]
|
|
67
|
+
optional :from_user, String, api_name: :fromUser
|
|
68
|
+
|
|
69
|
+
# @!attribute hashtags
|
|
70
|
+
# Hashtags applied to the estimate, separated by spaces, commas, or lines.
|
|
71
|
+
#
|
|
72
|
+
# @return [String, nil]
|
|
73
|
+
optional :hashtags, String
|
|
74
|
+
|
|
75
|
+
# @!attribute in_reply_to_tweet_id
|
|
76
|
+
# Estimate only replies to this tweet ID (tweet_search_extractor)
|
|
77
|
+
#
|
|
78
|
+
# @return [String, nil]
|
|
79
|
+
optional :in_reply_to_tweet_id, String, api_name: :inReplyToTweetId
|
|
80
|
+
|
|
81
|
+
# @!attribute language
|
|
82
|
+
# Language code used for estimate filtering (tweet_search_extractor)
|
|
83
|
+
#
|
|
84
|
+
# @return [String, nil]
|
|
85
|
+
optional :language, String
|
|
86
|
+
|
|
87
|
+
# @!attribute list_id
|
|
88
|
+
# Estimate search results within this list ID (tweet_search_extractor)
|
|
89
|
+
#
|
|
90
|
+
# @return [String, nil]
|
|
91
|
+
optional :list_id, String, api_name: :listId
|
|
92
|
+
|
|
93
|
+
# @!attribute media_type
|
|
94
|
+
# Media type used for estimate filtering (tweet_search_extractor)
|
|
95
|
+
#
|
|
96
|
+
# @return [Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::MediaType, nil]
|
|
97
|
+
optional :media_type,
|
|
98
|
+
enum: -> { XTwitterScraper::ExtractionEstimateCostParams::MediaType },
|
|
99
|
+
api_name: :mediaType
|
|
100
|
+
|
|
101
|
+
# @!attribute mentioning
|
|
102
|
+
# Estimate tweets mentioning this username (tweet_search_extractor)
|
|
103
|
+
#
|
|
104
|
+
# @return [String, nil]
|
|
105
|
+
optional :mentioning, String
|
|
106
|
+
|
|
107
|
+
# @!attribute min_faves
|
|
108
|
+
# Minimum likes threshold for estimated results (tweet_search_extractor)
|
|
109
|
+
#
|
|
110
|
+
# @return [Integer, nil]
|
|
111
|
+
optional :min_faves, Integer, api_name: :minFaves
|
|
112
|
+
|
|
113
|
+
# @!attribute min_quotes
|
|
114
|
+
# Minimum quote count threshold for estimated results (tweet_search_extractor)
|
|
115
|
+
#
|
|
116
|
+
# @return [Integer, nil]
|
|
117
|
+
optional :min_quotes, Integer, api_name: :minQuotes
|
|
118
|
+
|
|
119
|
+
# @!attribute min_replies
|
|
120
|
+
# Minimum replies threshold for estimated results (tweet_search_extractor)
|
|
121
|
+
#
|
|
122
|
+
# @return [Integer, nil]
|
|
123
|
+
optional :min_replies, Integer, api_name: :minReplies
|
|
124
|
+
|
|
125
|
+
# @!attribute min_retweets
|
|
126
|
+
# Minimum retweets threshold for estimated results (tweet_search_extractor)
|
|
127
|
+
#
|
|
128
|
+
# @return [Integer, nil]
|
|
129
|
+
optional :min_retweets, Integer, api_name: :minRetweets
|
|
130
|
+
|
|
131
|
+
# @!attribute place
|
|
132
|
+
# Estimate search results within this place ID (tweet_search_extractor)
|
|
133
|
+
#
|
|
134
|
+
# @return [String, nil]
|
|
135
|
+
optional :place, String
|
|
136
|
+
|
|
137
|
+
# @!attribute place_country
|
|
138
|
+
# Estimate search results within this country code (tweet_search_extractor)
|
|
139
|
+
#
|
|
140
|
+
# @return [String, nil]
|
|
141
|
+
optional :place_country, String, api_name: :placeCountry
|
|
142
|
+
|
|
143
|
+
# @!attribute point_radius
|
|
144
|
+
# Geo point radius used for estimation, e.g. -73.99 40.73 25mi
|
|
145
|
+
# (tweet_search_extractor)
|
|
146
|
+
#
|
|
147
|
+
# @return [String, nil]
|
|
148
|
+
optional :point_radius, String, api_name: :pointRadius
|
|
149
|
+
|
|
150
|
+
# @!attribute quotes
|
|
151
|
+
# Quote mode used for estimation (tweet_search_extractor)
|
|
152
|
+
#
|
|
153
|
+
# @return [Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::Quotes, nil]
|
|
154
|
+
optional :quotes, enum: -> { XTwitterScraper::ExtractionEstimateCostParams::Quotes }
|
|
155
|
+
|
|
156
|
+
# @!attribute quotes_of_tweet_id
|
|
157
|
+
# Estimate only quotes of this tweet ID (tweet_search_extractor)
|
|
158
|
+
#
|
|
159
|
+
# @return [String, nil]
|
|
160
|
+
optional :quotes_of_tweet_id, String, api_name: :quotesOfTweetId
|
|
161
|
+
|
|
162
|
+
# @!attribute replies
|
|
163
|
+
# Reply mode used for estimation (tweet_search_extractor)
|
|
164
|
+
#
|
|
165
|
+
# @return [Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::Replies, nil]
|
|
166
|
+
optional :replies, enum: -> { XTwitterScraper::ExtractionEstimateCostParams::Replies }
|
|
167
|
+
|
|
168
|
+
# @!attribute results_limit
|
|
169
|
+
# Maximum number of results to estimate. When set, the estimate caps projected
|
|
170
|
+
# results to this value.
|
|
171
|
+
#
|
|
172
|
+
# @return [Integer, nil]
|
|
173
|
+
optional :results_limit, Integer, api_name: :resultsLimit
|
|
174
|
+
|
|
175
|
+
# @!attribute retweets
|
|
176
|
+
# Retweet mode used for estimation (tweet_search_extractor)
|
|
177
|
+
#
|
|
178
|
+
# @return [Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::Retweets, nil]
|
|
179
|
+
optional :retweets, enum: -> { XTwitterScraper::ExtractionEstimateCostParams::Retweets }
|
|
180
|
+
|
|
181
|
+
# @!attribute retweets_of_tweet_id
|
|
182
|
+
# Estimate only retweets of this tweet ID (tweet_search_extractor)
|
|
183
|
+
#
|
|
184
|
+
# @return [String, nil]
|
|
185
|
+
optional :retweets_of_tweet_id, String, api_name: :retweetsOfTweetId
|
|
186
|
+
|
|
36
187
|
# @!attribute search_query
|
|
188
|
+
# Required for tweet_search_extractor & community_search.
|
|
37
189
|
#
|
|
38
190
|
# @return [String, nil]
|
|
39
191
|
optional :search_query, String, api_name: :searchQuery
|
|
40
192
|
|
|
193
|
+
# @!attribute since_date
|
|
194
|
+
# Estimate start date in YYYY-MM-DD format (tweet_search_extractor)
|
|
195
|
+
#
|
|
196
|
+
# @return [Date, nil]
|
|
197
|
+
optional :since_date, Date, api_name: :sinceDate
|
|
198
|
+
|
|
41
199
|
# @!attribute target_community_id
|
|
200
|
+
# Required for community_post_extractor & community_search.
|
|
42
201
|
#
|
|
43
202
|
# @return [String, nil]
|
|
44
203
|
optional :target_community_id, String, api_name: :targetCommunityId
|
|
45
204
|
|
|
46
205
|
# @!attribute target_list_id
|
|
206
|
+
# Required for list_follower_explorer, list_member_extractor &
|
|
207
|
+
# list_post_extractor.
|
|
47
208
|
#
|
|
48
209
|
# @return [String, nil]
|
|
49
210
|
optional :target_list_id, String, api_name: :targetListId
|
|
50
211
|
|
|
51
212
|
# @!attribute target_space_id
|
|
213
|
+
# Required for space_explorer.
|
|
52
214
|
#
|
|
53
215
|
# @return [String, nil]
|
|
54
216
|
optional :target_space_id, String, api_name: :targetSpaceId
|
|
@@ -63,27 +225,112 @@ module XTwitterScraper
|
|
|
63
225
|
# @return [String, nil]
|
|
64
226
|
optional :target_username, String, api_name: :targetUsername
|
|
65
227
|
|
|
66
|
-
# @!
|
|
228
|
+
# @!attribute to_user
|
|
229
|
+
# Estimate replies sent to this username (tweet_search_extractor)
|
|
230
|
+
#
|
|
231
|
+
# @return [String, nil]
|
|
232
|
+
optional :to_user, String, api_name: :toUser
|
|
233
|
+
|
|
234
|
+
# @!attribute until_date
|
|
235
|
+
# Estimate end date in YYYY-MM-DD format (tweet_search_extractor)
|
|
236
|
+
#
|
|
237
|
+
# @return [Date, nil]
|
|
238
|
+
optional :until_date, Date, api_name: :untilDate
|
|
239
|
+
|
|
240
|
+
# @!attribute url
|
|
241
|
+
# URL substring or domain filter used for estimation (tweet_search_extractor)
|
|
242
|
+
#
|
|
243
|
+
# @return [String, nil]
|
|
244
|
+
optional :url, String
|
|
245
|
+
|
|
246
|
+
# @!attribute verified_only
|
|
247
|
+
# Estimate only verified authors (tweet_search_extractor)
|
|
248
|
+
#
|
|
249
|
+
# @return [Boolean, nil]
|
|
250
|
+
optional :verified_only, XTwitterScraper::Internal::Type::Boolean, api_name: :verifiedOnly
|
|
251
|
+
|
|
252
|
+
# @!method initialize(tool_type:, advanced_query: nil, any_words: nil, bounding_box: nil, cashtags: nil, conversation_id: nil, exact_phrase: nil, exclude_words: nil, from_user: nil, hashtags: nil, in_reply_to_tweet_id: nil, language: nil, list_id: nil, media_type: nil, mentioning: nil, min_faves: nil, min_quotes: nil, min_replies: nil, min_retweets: nil, place: nil, place_country: nil, point_radius: nil, quotes: nil, quotes_of_tweet_id: nil, replies: nil, results_limit: nil, retweets: nil, retweets_of_tweet_id: nil, search_query: nil, since_date: nil, target_community_id: nil, target_list_id: nil, target_space_id: nil, target_tweet_id: nil, target_username: nil, to_user: nil, until_date: nil, url: nil, verified_only: nil, request_options: {})
|
|
253
|
+
# Some parameter documentations has been truncated, see
|
|
254
|
+
# {XTwitterScraper::Models::ExtractionEstimateCostParams} for more details.
|
|
255
|
+
#
|
|
67
256
|
# @param tool_type [Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::ToolType] Identifier for the extraction tool used to run a job.
|
|
68
257
|
#
|
|
69
258
|
# @param advanced_query [String] Raw advanced query string appended to the estimate (tweet_search_extractor)
|
|
70
259
|
#
|
|
260
|
+
# @param any_words [String] Alternative words or quoted phrases for estimated results. Separate with spaces,
|
|
261
|
+
#
|
|
262
|
+
# @param bounding_box [String] Geo bounding box used for estimation, e.g. -74.1 40.6 -73.9 40.8 (tweet_search_e
|
|
263
|
+
#
|
|
264
|
+
# @param cashtags [String] Cashtags applied to the estimate, separated by spaces, commas, or lines.
|
|
265
|
+
#
|
|
266
|
+
# @param conversation_id [String] Conversation ID filter used for estimation (tweet_search_extractor)
|
|
267
|
+
#
|
|
71
268
|
# @param exact_phrase [String] Exact phrase filter for search estimation
|
|
72
269
|
#
|
|
73
|
-
# @param exclude_words [String] Words excluded from estimated
|
|
270
|
+
# @param exclude_words [String] Words or quoted phrases excluded from estimated results. Separate with spaces, c
|
|
271
|
+
#
|
|
272
|
+
# @param from_user [String] Estimate only tweets from this author username (tweet_search_extractor)
|
|
273
|
+
#
|
|
274
|
+
# @param hashtags [String] Hashtags applied to the estimate, separated by spaces, commas, or lines.
|
|
275
|
+
#
|
|
276
|
+
# @param in_reply_to_tweet_id [String] Estimate only replies to this tweet ID (tweet_search_extractor)
|
|
277
|
+
#
|
|
278
|
+
# @param language [String] Language code used for estimate filtering (tweet_search_extractor)
|
|
279
|
+
#
|
|
280
|
+
# @param list_id [String] Estimate search results within this list ID (tweet_search_extractor)
|
|
281
|
+
#
|
|
282
|
+
# @param media_type [Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::MediaType] Media type used for estimate filtering (tweet_search_extractor)
|
|
283
|
+
#
|
|
284
|
+
# @param mentioning [String] Estimate tweets mentioning this username (tweet_search_extractor)
|
|
285
|
+
#
|
|
286
|
+
# @param min_faves [Integer] Minimum likes threshold for estimated results (tweet_search_extractor)
|
|
287
|
+
#
|
|
288
|
+
# @param min_quotes [Integer] Minimum quote count threshold for estimated results (tweet_search_extractor)
|
|
289
|
+
#
|
|
290
|
+
# @param min_replies [Integer] Minimum replies threshold for estimated results (tweet_search_extractor)
|
|
291
|
+
#
|
|
292
|
+
# @param min_retweets [Integer] Minimum retweets threshold for estimated results (tweet_search_extractor)
|
|
293
|
+
#
|
|
294
|
+
# @param place [String] Estimate search results within this place ID (tweet_search_extractor)
|
|
295
|
+
#
|
|
296
|
+
# @param place_country [String] Estimate search results within this country code (tweet_search_extractor)
|
|
297
|
+
#
|
|
298
|
+
# @param point_radius [String] Geo point radius used for estimation, e.g. -73.99 40.73 25mi (tweet_search_extra
|
|
299
|
+
#
|
|
300
|
+
# @param quotes [Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::Quotes] Quote mode used for estimation (tweet_search_extractor)
|
|
301
|
+
#
|
|
302
|
+
# @param quotes_of_tweet_id [String] Estimate only quotes of this tweet ID (tweet_search_extractor)
|
|
303
|
+
#
|
|
304
|
+
# @param replies [Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::Replies] Reply mode used for estimation (tweet_search_extractor)
|
|
305
|
+
#
|
|
306
|
+
# @param results_limit [Integer] Maximum number of results to estimate. When set, the estimate caps projected res
|
|
307
|
+
#
|
|
308
|
+
# @param retweets [Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::Retweets] Retweet mode used for estimation (tweet_search_extractor)
|
|
309
|
+
#
|
|
310
|
+
# @param retweets_of_tweet_id [String] Estimate only retweets of this tweet ID (tweet_search_extractor)
|
|
74
311
|
#
|
|
75
|
-
# @param search_query [String]
|
|
312
|
+
# @param search_query [String] Required for tweet_search_extractor & community_search.
|
|
76
313
|
#
|
|
77
|
-
# @param
|
|
314
|
+
# @param since_date [Date] Estimate start date in YYYY-MM-DD format (tweet_search_extractor)
|
|
78
315
|
#
|
|
79
|
-
# @param
|
|
316
|
+
# @param target_community_id [String] Required for community_post_extractor & community_search.
|
|
80
317
|
#
|
|
81
|
-
# @param
|
|
318
|
+
# @param target_list_id [String] Required for list_follower_explorer, list_member_extractor & list_post_extractor
|
|
319
|
+
#
|
|
320
|
+
# @param target_space_id [String] Required for space_explorer.
|
|
82
321
|
#
|
|
83
322
|
# @param target_tweet_id [String]
|
|
84
323
|
#
|
|
85
324
|
# @param target_username [String]
|
|
86
325
|
#
|
|
326
|
+
# @param to_user [String] Estimate replies sent to this username (tweet_search_extractor)
|
|
327
|
+
#
|
|
328
|
+
# @param until_date [Date] Estimate end date in YYYY-MM-DD format (tweet_search_extractor)
|
|
329
|
+
#
|
|
330
|
+
# @param url [String] URL substring or domain filter used for estimation (tweet_search_extractor)
|
|
331
|
+
#
|
|
332
|
+
# @param verified_only [Boolean] Estimate only verified authors (tweet_search_extractor)
|
|
333
|
+
#
|
|
87
334
|
# @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
|
|
88
335
|
|
|
89
336
|
# Identifier for the extraction tool used to run a job.
|
|
@@ -95,6 +342,7 @@ module XTwitterScraper
|
|
|
95
342
|
COMMUNITY_MODERATOR_EXPLORER = :community_moderator_explorer
|
|
96
343
|
COMMUNITY_POST_EXTRACTOR = :community_post_extractor
|
|
97
344
|
COMMUNITY_SEARCH = :community_search
|
|
345
|
+
FAVORITERS = :favoriters
|
|
98
346
|
FOLLOWER_EXPLORER = :follower_explorer
|
|
99
347
|
FOLLOWING_EXPLORER = :following_explorer
|
|
100
348
|
LIST_FOLLOWER_EXPLORER = :list_follower_explorer
|
|
@@ -109,11 +357,64 @@ module XTwitterScraper
|
|
|
109
357
|
SPACE_EXPLORER = :space_explorer
|
|
110
358
|
THREAD_EXTRACTOR = :thread_extractor
|
|
111
359
|
TWEET_SEARCH_EXTRACTOR = :tweet_search_extractor
|
|
360
|
+
USER_LIKES = :user_likes
|
|
361
|
+
USER_MEDIA = :user_media
|
|
112
362
|
VERIFIED_FOLLOWER_EXPLORER = :verified_follower_explorer
|
|
113
363
|
|
|
114
364
|
# @!method self.values
|
|
115
365
|
# @return [Array<Symbol>]
|
|
116
366
|
end
|
|
367
|
+
|
|
368
|
+
# Media type used for estimate filtering (tweet_search_extractor)
|
|
369
|
+
module MediaType
|
|
370
|
+
extend XTwitterScraper::Internal::Type::Enum
|
|
371
|
+
|
|
372
|
+
IMAGES = :images
|
|
373
|
+
VIDEOS = :videos
|
|
374
|
+
GIFS = :gifs
|
|
375
|
+
MEDIA = :media
|
|
376
|
+
LINKS = :links
|
|
377
|
+
NONE = :none
|
|
378
|
+
|
|
379
|
+
# @!method self.values
|
|
380
|
+
# @return [Array<Symbol>]
|
|
381
|
+
end
|
|
382
|
+
|
|
383
|
+
# Quote mode used for estimation (tweet_search_extractor)
|
|
384
|
+
module Quotes
|
|
385
|
+
extend XTwitterScraper::Internal::Type::Enum
|
|
386
|
+
|
|
387
|
+
INCLUDE = :include
|
|
388
|
+
EXCLUDE = :exclude
|
|
389
|
+
ONLY = :only
|
|
390
|
+
|
|
391
|
+
# @!method self.values
|
|
392
|
+
# @return [Array<Symbol>]
|
|
393
|
+
end
|
|
394
|
+
|
|
395
|
+
# Reply mode used for estimation (tweet_search_extractor)
|
|
396
|
+
module Replies
|
|
397
|
+
extend XTwitterScraper::Internal::Type::Enum
|
|
398
|
+
|
|
399
|
+
INCLUDE = :include
|
|
400
|
+
EXCLUDE = :exclude
|
|
401
|
+
ONLY = :only
|
|
402
|
+
|
|
403
|
+
# @!method self.values
|
|
404
|
+
# @return [Array<Symbol>]
|
|
405
|
+
end
|
|
406
|
+
|
|
407
|
+
# Retweet mode used for estimation (tweet_search_extractor)
|
|
408
|
+
module Retweets
|
|
409
|
+
extend XTwitterScraper::Internal::Type::Enum
|
|
410
|
+
|
|
411
|
+
INCLUDE = :include
|
|
412
|
+
EXCLUDE = :exclude
|
|
413
|
+
ONLY = :only
|
|
414
|
+
|
|
415
|
+
# @!method self.values
|
|
416
|
+
# @return [Array<Symbol>]
|
|
417
|
+
end
|
|
117
418
|
end
|
|
118
419
|
end
|
|
119
420
|
end
|
|
@@ -9,32 +9,56 @@ module XTwitterScraper
|
|
|
9
9
|
# @return [Boolean]
|
|
10
10
|
required :allowed, XTwitterScraper::Internal::Type::Boolean
|
|
11
11
|
|
|
12
|
+
# @!attribute credits_available
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :credits_available, String, api_name: :creditsAvailable
|
|
16
|
+
|
|
17
|
+
# @!attribute credits_required
|
|
18
|
+
#
|
|
19
|
+
# @return [String]
|
|
20
|
+
required :credits_required, String, api_name: :creditsRequired
|
|
21
|
+
|
|
12
22
|
# @!attribute estimated_results
|
|
13
23
|
#
|
|
14
24
|
# @return [Integer]
|
|
15
25
|
required :estimated_results, Integer, api_name: :estimatedResults
|
|
16
26
|
|
|
17
|
-
# @!attribute projected_percent
|
|
18
|
-
#
|
|
19
|
-
# @return [Float]
|
|
20
|
-
required :projected_percent, Float, api_name: :projectedPercent
|
|
21
|
-
|
|
22
27
|
# @!attribute source
|
|
23
28
|
#
|
|
24
|
-
# @return [
|
|
25
|
-
required :source,
|
|
29
|
+
# @return [Symbol, XTwitterScraper::Models::ExtractionEstimateCostResponse::Source]
|
|
30
|
+
required :source, enum: -> { XTwitterScraper::Models::ExtractionEstimateCostResponse::Source }
|
|
26
31
|
|
|
27
|
-
# @!attribute
|
|
32
|
+
# @!attribute resolved_x_user_id
|
|
28
33
|
#
|
|
29
|
-
# @return [
|
|
30
|
-
|
|
34
|
+
# @return [String, nil]
|
|
35
|
+
optional :resolved_x_user_id, String, api_name: :resolvedXUserId
|
|
31
36
|
|
|
32
|
-
# @!method initialize(allowed:,
|
|
37
|
+
# @!method initialize(allowed:, credits_available:, credits_required:, estimated_results:, source:, resolved_x_user_id: nil)
|
|
33
38
|
# @param allowed [Boolean]
|
|
39
|
+
# @param credits_available [String]
|
|
40
|
+
# @param credits_required [String]
|
|
34
41
|
# @param estimated_results [Integer]
|
|
35
|
-
# @param
|
|
36
|
-
# @param
|
|
37
|
-
|
|
42
|
+
# @param source [Symbol, XTwitterScraper::Models::ExtractionEstimateCostResponse::Source]
|
|
43
|
+
# @param resolved_x_user_id [String]
|
|
44
|
+
|
|
45
|
+
# @see XTwitterScraper::Models::ExtractionEstimateCostResponse#source
|
|
46
|
+
module Source
|
|
47
|
+
extend XTwitterScraper::Internal::Type::Enum
|
|
48
|
+
|
|
49
|
+
FOLLOWERS = :followers
|
|
50
|
+
FOLLOWING = :following
|
|
51
|
+
PAGINATION_CAP = :paginationCap
|
|
52
|
+
POSTS = :posts
|
|
53
|
+
QUOTE_COUNT = :quoteCount
|
|
54
|
+
REPLY_COUNT = :replyCount
|
|
55
|
+
RESULTS_LIMIT = :resultsLimit
|
|
56
|
+
RETWEET_COUNT = :retweetCount
|
|
57
|
+
UNKNOWN = :unknown
|
|
58
|
+
|
|
59
|
+
# @!method self.values
|
|
60
|
+
# @return [Array<Symbol>]
|
|
61
|
+
end
|
|
38
62
|
end
|
|
39
63
|
end
|
|
40
64
|
end
|
|
@@ -15,10 +15,10 @@ module XTwitterScraper
|
|
|
15
15
|
# @!attribute format_
|
|
16
16
|
# Export file format
|
|
17
17
|
#
|
|
18
|
-
# @return [Symbol, XTwitterScraper::Models::ExtractionExportResultsParams::Format
|
|
19
|
-
|
|
18
|
+
# @return [Symbol, XTwitterScraper::Models::ExtractionExportResultsParams::Format]
|
|
19
|
+
required :format_, enum: -> { XTwitterScraper::ExtractionExportResultsParams::Format }
|
|
20
20
|
|
|
21
|
-
# @!method initialize(id:, format_
|
|
21
|
+
# @!method initialize(id:, format_:, request_options: {})
|
|
22
22
|
# @param id [String]
|
|
23
23
|
#
|
|
24
24
|
# @param format_ [Symbol, XTwitterScraper::Models::ExtractionExportResultsParams::Format] Export file format
|
|
@@ -72,6 +72,7 @@ module XTwitterScraper
|
|
|
72
72
|
COMMUNITY_MODERATOR_EXPLORER = :community_moderator_explorer
|
|
73
73
|
COMMUNITY_POST_EXTRACTOR = :community_post_extractor
|
|
74
74
|
COMMUNITY_SEARCH = :community_search
|
|
75
|
+
FAVORITERS = :favoriters
|
|
75
76
|
FOLLOWER_EXPLORER = :follower_explorer
|
|
76
77
|
FOLLOWING_EXPLORER = :following_explorer
|
|
77
78
|
LIST_FOLLOWER_EXPLORER = :list_follower_explorer
|
|
@@ -86,6 +87,8 @@ module XTwitterScraper
|
|
|
86
87
|
SPACE_EXPLORER = :space_explorer
|
|
87
88
|
THREAD_EXTRACTOR = :thread_extractor
|
|
88
89
|
TWEET_SEARCH_EXTRACTOR = :tweet_search_extractor
|
|
90
|
+
USER_LIKES = :user_likes
|
|
91
|
+
USER_MEDIA = :user_media
|
|
89
92
|
VERIFIED_FOLLOWER_EXPLORER = :verified_follower_explorer
|
|
90
93
|
|
|
91
94
|
# @!method self.values
|
|
@@ -7,14 +7,17 @@ module XTwitterScraper
|
|
|
7
7
|
extend XTwitterScraper::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include XTwitterScraper::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!attribute
|
|
11
|
-
# Cursor for keyset pagination
|
|
10
|
+
# @!attribute cursor
|
|
11
|
+
# Cursor for keyset pagination from prior response next_cursor
|
|
12
12
|
#
|
|
13
13
|
# @return [String, nil]
|
|
14
|
-
optional :
|
|
14
|
+
optional :cursor, String
|
|
15
15
|
|
|
16
16
|
# @!attribute limit
|
|
17
|
-
# Maximum number of items to return (1-100, default 50)
|
|
17
|
+
# Maximum number of items to return (1-100, default 50). For paid per-result
|
|
18
|
+
# endpoints, the returned count may be lower when remaining credits cannot cover
|
|
19
|
+
# the requested page. If zero paid results are affordable, the endpoint returns
|
|
20
|
+
# 402 insufficient_credits.
|
|
18
21
|
#
|
|
19
22
|
# @return [Integer, nil]
|
|
20
23
|
optional :limit, Integer
|
|
@@ -31,10 +34,13 @@ module XTwitterScraper
|
|
|
31
34
|
# @return [Symbol, XTwitterScraper::Models::ExtractionListParams::ToolType, nil]
|
|
32
35
|
optional :tool_type, enum: -> { XTwitterScraper::ExtractionListParams::ToolType }
|
|
33
36
|
|
|
34
|
-
# @!method initialize(
|
|
35
|
-
#
|
|
37
|
+
# @!method initialize(cursor: nil, limit: nil, status: nil, tool_type: nil, request_options: {})
|
|
38
|
+
# Some parameter documentations has been truncated, see
|
|
39
|
+
# {XTwitterScraper::Models::ExtractionListParams} for more details.
|
|
36
40
|
#
|
|
37
|
-
# @param
|
|
41
|
+
# @param cursor [String] Cursor for keyset pagination from prior response next_cursor
|
|
42
|
+
#
|
|
43
|
+
# @param limit [Integer] Maximum number of items to return (1-100, default 50). For paid per-result endpo
|
|
38
44
|
#
|
|
39
45
|
# @param status [Symbol, XTwitterScraper::Models::ExtractionListParams::Status] Filter by job status
|
|
40
46
|
#
|
|
@@ -63,6 +69,7 @@ module XTwitterScraper
|
|
|
63
69
|
COMMUNITY_MODERATOR_EXPLORER = :community_moderator_explorer
|
|
64
70
|
COMMUNITY_POST_EXTRACTOR = :community_post_extractor
|
|
65
71
|
COMMUNITY_SEARCH = :community_search
|
|
72
|
+
FAVORITERS = :favoriters
|
|
66
73
|
FOLLOWER_EXPLORER = :follower_explorer
|
|
67
74
|
FOLLOWING_EXPLORER = :following_explorer
|
|
68
75
|
LIST_FOLLOWER_EXPLORER = :list_follower_explorer
|
|
@@ -77,6 +84,8 @@ module XTwitterScraper
|
|
|
77
84
|
SPACE_EXPLORER = :space_explorer
|
|
78
85
|
THREAD_EXTRACTOR = :thread_extractor
|
|
79
86
|
TWEET_SEARCH_EXTRACTOR = :tweet_search_extractor
|
|
87
|
+
USER_LIKES = :user_likes
|
|
88
|
+
USER_MEDIA = :user_media
|
|
80
89
|
VERIFIED_FOLLOWER_EXPLORER = :verified_follower_explorer
|
|
81
90
|
|
|
82
91
|
# @!method self.values
|
|
@@ -12,11 +12,11 @@ module XTwitterScraper
|
|
|
12
12
|
# @return [String]
|
|
13
13
|
required :id, String
|
|
14
14
|
|
|
15
|
-
# @!attribute
|
|
16
|
-
# Cursor for keyset pagination
|
|
15
|
+
# @!attribute cursor
|
|
16
|
+
# Cursor for keyset pagination from prior response next_cursor
|
|
17
17
|
#
|
|
18
18
|
# @return [String, nil]
|
|
19
|
-
optional :
|
|
19
|
+
optional :cursor, String
|
|
20
20
|
|
|
21
21
|
# @!attribute limit
|
|
22
22
|
# Maximum number of results to return (1-1000, default 100)
|
|
@@ -24,10 +24,10 @@ module XTwitterScraper
|
|
|
24
24
|
# @return [Integer, nil]
|
|
25
25
|
optional :limit, Integer
|
|
26
26
|
|
|
27
|
-
# @!method initialize(id:,
|
|
27
|
+
# @!method initialize(id:, cursor: nil, limit: nil, request_options: {})
|
|
28
28
|
# @param id [String]
|
|
29
29
|
#
|
|
30
|
-
# @param
|
|
30
|
+
# @param cursor [String] Cursor for keyset pagination from prior response next_cursor
|
|
31
31
|
#
|
|
32
32
|
# @param limit [Integer] Maximum number of results to return (1-1000, default 100)
|
|
33
33
|
#
|
|
@@ -10,7 +10,7 @@ module XTwitterScraper
|
|
|
10
10
|
required :has_more, XTwitterScraper::Internal::Type::Boolean, api_name: :hasMore
|
|
11
11
|
|
|
12
12
|
# @!attribute job
|
|
13
|
-
# Extraction job metadata
|
|
13
|
+
# Extraction job metadata - shape varies by tool type (JSON)
|
|
14
14
|
#
|
|
15
15
|
# @return [Hash{Symbol=>Object}]
|
|
16
16
|
required :job, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]
|
|
@@ -29,7 +29,7 @@ module XTwitterScraper
|
|
|
29
29
|
# @!method initialize(has_more:, job:, results:, next_cursor: nil)
|
|
30
30
|
# @param has_more [Boolean]
|
|
31
31
|
#
|
|
32
|
-
# @param job [Hash{Symbol=>Object}] Extraction job metadata
|
|
32
|
+
# @param job [Hash{Symbol=>Object}] Extraction job metadata - shape varies by tool type (JSON)
|
|
33
33
|
#
|
|
34
34
|
# @param results [Array<Hash{Symbol=>Object}>]
|
|
35
35
|
#
|