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
|
@@ -19,6 +19,31 @@ module XTwitterScraper
|
|
|
19
19
|
# @return [String, nil]
|
|
20
20
|
optional :advanced_query, String, api_name: :advancedQuery
|
|
21
21
|
|
|
22
|
+
# @!attribute any_words
|
|
23
|
+
# Words or quoted phrases where any one can match. Separate with spaces, commas,
|
|
24
|
+
# or lines. (tweet_search_extractor)
|
|
25
|
+
#
|
|
26
|
+
# @return [String, nil]
|
|
27
|
+
optional :any_words, String, api_name: :anyWords
|
|
28
|
+
|
|
29
|
+
# @!attribute bounding_box
|
|
30
|
+
# Geo bounding box, e.g. -74.1 40.6 -73.9 40.8 (tweet_search_extractor)
|
|
31
|
+
#
|
|
32
|
+
# @return [String, nil]
|
|
33
|
+
optional :bounding_box, String, api_name: :boundingBox
|
|
34
|
+
|
|
35
|
+
# @!attribute cashtags
|
|
36
|
+
# Cashtags separated by spaces, commas, or lines. (tweet_search_extractor)
|
|
37
|
+
#
|
|
38
|
+
# @return [String, nil]
|
|
39
|
+
optional :cashtags, String
|
|
40
|
+
|
|
41
|
+
# @!attribute conversation_id
|
|
42
|
+
# Conversation ID filter (tweet_search_extractor)
|
|
43
|
+
#
|
|
44
|
+
# @return [String, nil]
|
|
45
|
+
optional :conversation_id, String, api_name: :conversationId
|
|
46
|
+
|
|
22
47
|
# @!attribute exact_phrase
|
|
23
48
|
# Exact phrase to match (tweet_search_extractor)
|
|
24
49
|
#
|
|
@@ -26,27 +51,160 @@ module XTwitterScraper
|
|
|
26
51
|
optional :exact_phrase, String, api_name: :exactPhrase
|
|
27
52
|
|
|
28
53
|
# @!attribute exclude_words
|
|
29
|
-
# Words to exclude
|
|
54
|
+
# Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
|
|
55
|
+
# (tweet_search_extractor)
|
|
30
56
|
#
|
|
31
57
|
# @return [String, nil]
|
|
32
58
|
optional :exclude_words, String, api_name: :excludeWords
|
|
33
59
|
|
|
60
|
+
# @!attribute from_user
|
|
61
|
+
# Filter by author username (tweet_search_extractor)
|
|
62
|
+
#
|
|
63
|
+
# @return [String, nil]
|
|
64
|
+
optional :from_user, String, api_name: :fromUser
|
|
65
|
+
|
|
66
|
+
# @!attribute hashtags
|
|
67
|
+
# Hashtags separated by spaces, commas, or lines. (tweet_search_extractor)
|
|
68
|
+
#
|
|
69
|
+
# @return [String, nil]
|
|
70
|
+
optional :hashtags, String
|
|
71
|
+
|
|
72
|
+
# @!attribute in_reply_to_tweet_id
|
|
73
|
+
# Only replies to this tweet ID (tweet_search_extractor)
|
|
74
|
+
#
|
|
75
|
+
# @return [String, nil]
|
|
76
|
+
optional :in_reply_to_tweet_id, String, api_name: :inReplyToTweetId
|
|
77
|
+
|
|
78
|
+
# @!attribute language
|
|
79
|
+
# Language code filter (tweet_search_extractor)
|
|
80
|
+
#
|
|
81
|
+
# @return [String, nil]
|
|
82
|
+
optional :language, String
|
|
83
|
+
|
|
84
|
+
# @!attribute list_id
|
|
85
|
+
# Search within a list ID (tweet_search_extractor)
|
|
86
|
+
#
|
|
87
|
+
# @return [String, nil]
|
|
88
|
+
optional :list_id, String, api_name: :listId
|
|
89
|
+
|
|
90
|
+
# @!attribute media_type
|
|
91
|
+
# Media type filter (tweet_search_extractor)
|
|
92
|
+
#
|
|
93
|
+
# @return [Symbol, XTwitterScraper::Models::ExtractionRunParams::MediaType, nil]
|
|
94
|
+
optional :media_type, enum: -> { XTwitterScraper::ExtractionRunParams::MediaType }, api_name: :mediaType
|
|
95
|
+
|
|
96
|
+
# @!attribute mentioning
|
|
97
|
+
# Filter tweets mentioning a username (tweet_search_extractor)
|
|
98
|
+
#
|
|
99
|
+
# @return [String, nil]
|
|
100
|
+
optional :mentioning, String
|
|
101
|
+
|
|
102
|
+
# @!attribute min_faves
|
|
103
|
+
# Minimum likes threshold (tweet_search_extractor)
|
|
104
|
+
#
|
|
105
|
+
# @return [Integer, nil]
|
|
106
|
+
optional :min_faves, Integer, api_name: :minFaves
|
|
107
|
+
|
|
108
|
+
# @!attribute min_quotes
|
|
109
|
+
# Minimum quote count threshold (tweet_search_extractor)
|
|
110
|
+
#
|
|
111
|
+
# @return [Integer, nil]
|
|
112
|
+
optional :min_quotes, Integer, api_name: :minQuotes
|
|
113
|
+
|
|
114
|
+
# @!attribute min_replies
|
|
115
|
+
# Minimum replies threshold (tweet_search_extractor)
|
|
116
|
+
#
|
|
117
|
+
# @return [Integer, nil]
|
|
118
|
+
optional :min_replies, Integer, api_name: :minReplies
|
|
119
|
+
|
|
120
|
+
# @!attribute min_retweets
|
|
121
|
+
# Minimum retweets threshold (tweet_search_extractor)
|
|
122
|
+
#
|
|
123
|
+
# @return [Integer, nil]
|
|
124
|
+
optional :min_retweets, Integer, api_name: :minRetweets
|
|
125
|
+
|
|
126
|
+
# @!attribute place
|
|
127
|
+
# Search within a place ID (tweet_search_extractor)
|
|
128
|
+
#
|
|
129
|
+
# @return [String, nil]
|
|
130
|
+
optional :place, String
|
|
131
|
+
|
|
132
|
+
# @!attribute place_country
|
|
133
|
+
# Search within a country code (tweet_search_extractor)
|
|
134
|
+
#
|
|
135
|
+
# @return [String, nil]
|
|
136
|
+
optional :place_country, String, api_name: :placeCountry
|
|
137
|
+
|
|
138
|
+
# @!attribute point_radius
|
|
139
|
+
# Geo point radius, e.g. -73.99 40.73 25mi (tweet_search_extractor)
|
|
140
|
+
#
|
|
141
|
+
# @return [String, nil]
|
|
142
|
+
optional :point_radius, String, api_name: :pointRadius
|
|
143
|
+
|
|
144
|
+
# @!attribute quotes
|
|
145
|
+
# Quote mode (tweet_search_extractor)
|
|
146
|
+
#
|
|
147
|
+
# @return [Symbol, XTwitterScraper::Models::ExtractionRunParams::Quotes, nil]
|
|
148
|
+
optional :quotes, enum: -> { XTwitterScraper::ExtractionRunParams::Quotes }
|
|
149
|
+
|
|
150
|
+
# @!attribute quotes_of_tweet_id
|
|
151
|
+
# Only quotes of this tweet ID (tweet_search_extractor)
|
|
152
|
+
#
|
|
153
|
+
# @return [String, nil]
|
|
154
|
+
optional :quotes_of_tweet_id, String, api_name: :quotesOfTweetId
|
|
155
|
+
|
|
156
|
+
# @!attribute replies
|
|
157
|
+
# Reply mode (tweet_search_extractor)
|
|
158
|
+
#
|
|
159
|
+
# @return [Symbol, XTwitterScraper::Models::ExtractionRunParams::Replies, nil]
|
|
160
|
+
optional :replies, enum: -> { XTwitterScraper::ExtractionRunParams::Replies }
|
|
161
|
+
|
|
162
|
+
# @!attribute results_limit
|
|
163
|
+
# Maximum number of results to extract. When set, the extraction stops after
|
|
164
|
+
# reaching this limit.
|
|
165
|
+
#
|
|
166
|
+
# @return [Integer, nil]
|
|
167
|
+
optional :results_limit, Integer, api_name: :resultsLimit
|
|
168
|
+
|
|
169
|
+
# @!attribute retweets
|
|
170
|
+
# Retweet mode (tweet_search_extractor)
|
|
171
|
+
#
|
|
172
|
+
# @return [Symbol, XTwitterScraper::Models::ExtractionRunParams::Retweets, nil]
|
|
173
|
+
optional :retweets, enum: -> { XTwitterScraper::ExtractionRunParams::Retweets }
|
|
174
|
+
|
|
175
|
+
# @!attribute retweets_of_tweet_id
|
|
176
|
+
# Only retweets of this tweet ID (tweet_search_extractor)
|
|
177
|
+
#
|
|
178
|
+
# @return [String, nil]
|
|
179
|
+
optional :retweets_of_tweet_id, String, api_name: :retweetsOfTweetId
|
|
180
|
+
|
|
34
181
|
# @!attribute search_query
|
|
182
|
+
# Required for tweet_search_extractor & community_search.
|
|
35
183
|
#
|
|
36
184
|
# @return [String, nil]
|
|
37
185
|
optional :search_query, String, api_name: :searchQuery
|
|
38
186
|
|
|
187
|
+
# @!attribute since_date
|
|
188
|
+
# Start date YYYY-MM-DD (tweet_search_extractor)
|
|
189
|
+
#
|
|
190
|
+
# @return [Date, nil]
|
|
191
|
+
optional :since_date, Date, api_name: :sinceDate
|
|
192
|
+
|
|
39
193
|
# @!attribute target_community_id
|
|
194
|
+
# Required for community_post_extractor & community_search.
|
|
40
195
|
#
|
|
41
196
|
# @return [String, nil]
|
|
42
197
|
optional :target_community_id, String, api_name: :targetCommunityId
|
|
43
198
|
|
|
44
199
|
# @!attribute target_list_id
|
|
200
|
+
# Required for list_follower_explorer, list_member_extractor &
|
|
201
|
+
# list_post_extractor.
|
|
45
202
|
#
|
|
46
203
|
# @return [String, nil]
|
|
47
204
|
optional :target_list_id, String, api_name: :targetListId
|
|
48
205
|
|
|
49
206
|
# @!attribute target_space_id
|
|
207
|
+
# Required for space_explorer.
|
|
50
208
|
#
|
|
51
209
|
# @return [String, nil]
|
|
52
210
|
optional :target_space_id, String, api_name: :targetSpaceId
|
|
@@ -61,27 +219,112 @@ module XTwitterScraper
|
|
|
61
219
|
# @return [String, nil]
|
|
62
220
|
optional :target_username, String, api_name: :targetUsername
|
|
63
221
|
|
|
64
|
-
# @!
|
|
222
|
+
# @!attribute to_user
|
|
223
|
+
# Filter replies sent to a username (tweet_search_extractor)
|
|
224
|
+
#
|
|
225
|
+
# @return [String, nil]
|
|
226
|
+
optional :to_user, String, api_name: :toUser
|
|
227
|
+
|
|
228
|
+
# @!attribute until_date
|
|
229
|
+
# End date YYYY-MM-DD (tweet_search_extractor)
|
|
230
|
+
#
|
|
231
|
+
# @return [Date, nil]
|
|
232
|
+
optional :until_date, Date, api_name: :untilDate
|
|
233
|
+
|
|
234
|
+
# @!attribute url
|
|
235
|
+
# URL substring or domain filter (tweet_search_extractor)
|
|
236
|
+
#
|
|
237
|
+
# @return [String, nil]
|
|
238
|
+
optional :url, String
|
|
239
|
+
|
|
240
|
+
# @!attribute verified_only
|
|
241
|
+
# Only verified authors (tweet_search_extractor)
|
|
242
|
+
#
|
|
243
|
+
# @return [Boolean, nil]
|
|
244
|
+
optional :verified_only, XTwitterScraper::Internal::Type::Boolean, api_name: :verifiedOnly
|
|
245
|
+
|
|
246
|
+
# @!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: {})
|
|
247
|
+
# Some parameter documentations has been truncated, see
|
|
248
|
+
# {XTwitterScraper::Models::ExtractionRunParams} for more details.
|
|
249
|
+
#
|
|
65
250
|
# @param tool_type [Symbol, XTwitterScraper::Models::ExtractionRunParams::ToolType] Identifier for the extraction tool used to run a job.
|
|
66
251
|
#
|
|
67
252
|
# @param advanced_query [String] Raw advanced search query appended as-is (tweet_search_extractor)
|
|
68
253
|
#
|
|
254
|
+
# @param any_words [String] Words or quoted phrases where any one can match. Separate with spaces, commas, o
|
|
255
|
+
#
|
|
256
|
+
# @param bounding_box [String] Geo bounding box, e.g. -74.1 40.6 -73.9 40.8 (tweet_search_extractor)
|
|
257
|
+
#
|
|
258
|
+
# @param cashtags [String] Cashtags separated by spaces, commas, or lines. (tweet_search_extractor)
|
|
259
|
+
#
|
|
260
|
+
# @param conversation_id [String] Conversation ID filter (tweet_search_extractor)
|
|
261
|
+
#
|
|
69
262
|
# @param exact_phrase [String] Exact phrase to match (tweet_search_extractor)
|
|
70
263
|
#
|
|
71
|
-
# @param exclude_words [String] Words to exclude
|
|
264
|
+
# @param exclude_words [String] Words or quoted phrases to exclude. Separate with spaces, commas, or lines. (twe
|
|
265
|
+
#
|
|
266
|
+
# @param from_user [String] Filter by author username (tweet_search_extractor)
|
|
267
|
+
#
|
|
268
|
+
# @param hashtags [String] Hashtags separated by spaces, commas, or lines. (tweet_search_extractor)
|
|
269
|
+
#
|
|
270
|
+
# @param in_reply_to_tweet_id [String] Only replies to this tweet ID (tweet_search_extractor)
|
|
271
|
+
#
|
|
272
|
+
# @param language [String] Language code filter (tweet_search_extractor)
|
|
273
|
+
#
|
|
274
|
+
# @param list_id [String] Search within a list ID (tweet_search_extractor)
|
|
275
|
+
#
|
|
276
|
+
# @param media_type [Symbol, XTwitterScraper::Models::ExtractionRunParams::MediaType] Media type filter (tweet_search_extractor)
|
|
277
|
+
#
|
|
278
|
+
# @param mentioning [String] Filter tweets mentioning a username (tweet_search_extractor)
|
|
279
|
+
#
|
|
280
|
+
# @param min_faves [Integer] Minimum likes threshold (tweet_search_extractor)
|
|
281
|
+
#
|
|
282
|
+
# @param min_quotes [Integer] Minimum quote count threshold (tweet_search_extractor)
|
|
283
|
+
#
|
|
284
|
+
# @param min_replies [Integer] Minimum replies threshold (tweet_search_extractor)
|
|
285
|
+
#
|
|
286
|
+
# @param min_retweets [Integer] Minimum retweets threshold (tweet_search_extractor)
|
|
287
|
+
#
|
|
288
|
+
# @param place [String] Search within a place ID (tweet_search_extractor)
|
|
289
|
+
#
|
|
290
|
+
# @param place_country [String] Search within a country code (tweet_search_extractor)
|
|
291
|
+
#
|
|
292
|
+
# @param point_radius [String] Geo point radius, e.g. -73.99 40.73 25mi (tweet_search_extractor)
|
|
293
|
+
#
|
|
294
|
+
# @param quotes [Symbol, XTwitterScraper::Models::ExtractionRunParams::Quotes] Quote mode (tweet_search_extractor)
|
|
295
|
+
#
|
|
296
|
+
# @param quotes_of_tweet_id [String] Only quotes of this tweet ID (tweet_search_extractor)
|
|
297
|
+
#
|
|
298
|
+
# @param replies [Symbol, XTwitterScraper::Models::ExtractionRunParams::Replies] Reply mode (tweet_search_extractor)
|
|
299
|
+
#
|
|
300
|
+
# @param results_limit [Integer] Maximum number of results to extract. When set, the extraction stops after reach
|
|
301
|
+
#
|
|
302
|
+
# @param retweets [Symbol, XTwitterScraper::Models::ExtractionRunParams::Retweets] Retweet mode (tweet_search_extractor)
|
|
303
|
+
#
|
|
304
|
+
# @param retweets_of_tweet_id [String] Only retweets of this tweet ID (tweet_search_extractor)
|
|
72
305
|
#
|
|
73
|
-
# @param search_query [String]
|
|
306
|
+
# @param search_query [String] Required for tweet_search_extractor & community_search.
|
|
74
307
|
#
|
|
75
|
-
# @param
|
|
308
|
+
# @param since_date [Date] Start date YYYY-MM-DD (tweet_search_extractor)
|
|
76
309
|
#
|
|
77
|
-
# @param
|
|
310
|
+
# @param target_community_id [String] Required for community_post_extractor & community_search.
|
|
78
311
|
#
|
|
79
|
-
# @param
|
|
312
|
+
# @param target_list_id [String] Required for list_follower_explorer, list_member_extractor & list_post_extractor
|
|
313
|
+
#
|
|
314
|
+
# @param target_space_id [String] Required for space_explorer.
|
|
80
315
|
#
|
|
81
316
|
# @param target_tweet_id [String]
|
|
82
317
|
#
|
|
83
318
|
# @param target_username [String]
|
|
84
319
|
#
|
|
320
|
+
# @param to_user [String] Filter replies sent to a username (tweet_search_extractor)
|
|
321
|
+
#
|
|
322
|
+
# @param until_date [Date] End date YYYY-MM-DD (tweet_search_extractor)
|
|
323
|
+
#
|
|
324
|
+
# @param url [String] URL substring or domain filter (tweet_search_extractor)
|
|
325
|
+
#
|
|
326
|
+
# @param verified_only [Boolean] Only verified authors (tweet_search_extractor)
|
|
327
|
+
#
|
|
85
328
|
# @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
|
|
86
329
|
|
|
87
330
|
# Identifier for the extraction tool used to run a job.
|
|
@@ -93,6 +336,7 @@ module XTwitterScraper
|
|
|
93
336
|
COMMUNITY_MODERATOR_EXPLORER = :community_moderator_explorer
|
|
94
337
|
COMMUNITY_POST_EXTRACTOR = :community_post_extractor
|
|
95
338
|
COMMUNITY_SEARCH = :community_search
|
|
339
|
+
FAVORITERS = :favoriters
|
|
96
340
|
FOLLOWER_EXPLORER = :follower_explorer
|
|
97
341
|
FOLLOWING_EXPLORER = :following_explorer
|
|
98
342
|
LIST_FOLLOWER_EXPLORER = :list_follower_explorer
|
|
@@ -107,11 +351,64 @@ module XTwitterScraper
|
|
|
107
351
|
SPACE_EXPLORER = :space_explorer
|
|
108
352
|
THREAD_EXTRACTOR = :thread_extractor
|
|
109
353
|
TWEET_SEARCH_EXTRACTOR = :tweet_search_extractor
|
|
354
|
+
USER_LIKES = :user_likes
|
|
355
|
+
USER_MEDIA = :user_media
|
|
110
356
|
VERIFIED_FOLLOWER_EXPLORER = :verified_follower_explorer
|
|
111
357
|
|
|
112
358
|
# @!method self.values
|
|
113
359
|
# @return [Array<Symbol>]
|
|
114
360
|
end
|
|
361
|
+
|
|
362
|
+
# Media type filter (tweet_search_extractor)
|
|
363
|
+
module MediaType
|
|
364
|
+
extend XTwitterScraper::Internal::Type::Enum
|
|
365
|
+
|
|
366
|
+
IMAGES = :images
|
|
367
|
+
VIDEOS = :videos
|
|
368
|
+
GIFS = :gifs
|
|
369
|
+
MEDIA = :media
|
|
370
|
+
LINKS = :links
|
|
371
|
+
NONE = :none
|
|
372
|
+
|
|
373
|
+
# @!method self.values
|
|
374
|
+
# @return [Array<Symbol>]
|
|
375
|
+
end
|
|
376
|
+
|
|
377
|
+
# Quote mode (tweet_search_extractor)
|
|
378
|
+
module Quotes
|
|
379
|
+
extend XTwitterScraper::Internal::Type::Enum
|
|
380
|
+
|
|
381
|
+
INCLUDE = :include
|
|
382
|
+
EXCLUDE = :exclude
|
|
383
|
+
ONLY = :only
|
|
384
|
+
|
|
385
|
+
# @!method self.values
|
|
386
|
+
# @return [Array<Symbol>]
|
|
387
|
+
end
|
|
388
|
+
|
|
389
|
+
# Reply mode (tweet_search_extractor)
|
|
390
|
+
module Replies
|
|
391
|
+
extend XTwitterScraper::Internal::Type::Enum
|
|
392
|
+
|
|
393
|
+
INCLUDE = :include
|
|
394
|
+
EXCLUDE = :exclude
|
|
395
|
+
ONLY = :only
|
|
396
|
+
|
|
397
|
+
# @!method self.values
|
|
398
|
+
# @return [Array<Symbol>]
|
|
399
|
+
end
|
|
400
|
+
|
|
401
|
+
# Retweet mode (tweet_search_extractor)
|
|
402
|
+
module Retweets
|
|
403
|
+
extend XTwitterScraper::Internal::Type::Enum
|
|
404
|
+
|
|
405
|
+
INCLUDE = :include
|
|
406
|
+
EXCLUDE = :exclude
|
|
407
|
+
ONLY = :only
|
|
408
|
+
|
|
409
|
+
# @!method self.values
|
|
410
|
+
# @return [Array<Symbol>]
|
|
411
|
+
end
|
|
115
412
|
end
|
|
116
413
|
end
|
|
117
414
|
end
|
|
@@ -40,6 +40,7 @@ module XTwitterScraper
|
|
|
40
40
|
COMMUNITY_MODERATOR_EXPLORER = :community_moderator_explorer
|
|
41
41
|
COMMUNITY_POST_EXTRACTOR = :community_post_extractor
|
|
42
42
|
COMMUNITY_SEARCH = :community_search
|
|
43
|
+
FAVORITERS = :favoriters
|
|
43
44
|
FOLLOWER_EXPLORER = :follower_explorer
|
|
44
45
|
FOLLOWING_EXPLORER = :following_explorer
|
|
45
46
|
LIST_FOLLOWER_EXPLORER = :list_follower_explorer
|
|
@@ -54,6 +55,8 @@ module XTwitterScraper
|
|
|
54
55
|
SPACE_EXPLORER = :space_explorer
|
|
55
56
|
THREAD_EXTRACTOR = :thread_extractor
|
|
56
57
|
TWEET_SEARCH_EXTRACTOR = :tweet_search_extractor
|
|
58
|
+
USER_LIKES = :user_likes
|
|
59
|
+
USER_MEDIA = :user_media
|
|
57
60
|
VERIFIED_FOLLOWER_EXPLORER = :verified_follower_explorer
|
|
58
61
|
|
|
59
62
|
# @!method self.values
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module XTwitterScraper
|
|
4
|
+
module Models
|
|
5
|
+
class GuestWalletAmount < XTwitterScraper::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute amount_minor
|
|
7
|
+
# USD amount in cents. Accepted range is $10-$250.
|
|
8
|
+
#
|
|
9
|
+
# @return [Integer]
|
|
10
|
+
required :amount_minor, Integer
|
|
11
|
+
|
|
12
|
+
# @!attribute currency
|
|
13
|
+
#
|
|
14
|
+
# @return [Symbol, :usd]
|
|
15
|
+
required :currency, const: :usd
|
|
16
|
+
|
|
17
|
+
# @!method initialize(amount_minor:, currency: :usd)
|
|
18
|
+
# Confirmed USD amount for a guest wallet purchase.
|
|
19
|
+
#
|
|
20
|
+
# @param amount_minor [Integer] USD amount in cents. Accepted range is $10-$250.
|
|
21
|
+
#
|
|
22
|
+
# @param currency [Symbol, :usd]
|
|
23
|
+
end
|
|
24
|
+
end
|
|
25
|
+
end
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module XTwitterScraper
|
|
4
|
+
module Models
|
|
5
|
+
# @see XTwitterScraper::Resources::GuestWallets#create
|
|
6
|
+
class GuestWalletCreateParams < XTwitterScraper::Internal::Type::BaseModel
|
|
7
|
+
extend XTwitterScraper::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include XTwitterScraper::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute amount_minor
|
|
11
|
+
# Confirmed USD amount in cents.
|
|
12
|
+
#
|
|
13
|
+
# @return [Integer]
|
|
14
|
+
required :amount_minor, Integer
|
|
15
|
+
|
|
16
|
+
# @!attribute currency
|
|
17
|
+
#
|
|
18
|
+
# @return [Symbol, :usd]
|
|
19
|
+
required :currency, const: :usd
|
|
20
|
+
|
|
21
|
+
# @!attribute idempotency_key
|
|
22
|
+
#
|
|
23
|
+
# @return [String]
|
|
24
|
+
required :idempotency_key, String
|
|
25
|
+
|
|
26
|
+
# @!method initialize(amount_minor:, idempotency_key:, currency: :usd, request_options: {})
|
|
27
|
+
# @param amount_minor [Integer] Confirmed USD amount in cents.
|
|
28
|
+
#
|
|
29
|
+
# @param idempotency_key [String]
|
|
30
|
+
#
|
|
31
|
+
# @param currency [Symbol, :usd]
|
|
32
|
+
#
|
|
33
|
+
# @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
end
|
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module XTwitterScraper
|
|
4
|
+
module Models
|
|
5
|
+
# @see XTwitterScraper::Resources::GuestWallets#create
|
|
6
|
+
class GuestWalletCreateResponse < XTwitterScraper::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute account_required
|
|
8
|
+
#
|
|
9
|
+
# @return [Boolean, false]
|
|
10
|
+
required :account_required, const: false
|
|
11
|
+
|
|
12
|
+
# @!attribute amount
|
|
13
|
+
# Confirmed USD amount for a guest wallet purchase.
|
|
14
|
+
#
|
|
15
|
+
# @return [XTwitterScraper::Models::GuestWalletAmount]
|
|
16
|
+
required :amount, -> { XTwitterScraper::GuestWalletAmount }
|
|
17
|
+
|
|
18
|
+
# @!attribute api_key
|
|
19
|
+
# Paid-read bearer credential returned only by initial creation. Store it as a
|
|
20
|
+
# secret. Never place it in a URL or log.
|
|
21
|
+
#
|
|
22
|
+
# @return [String]
|
|
23
|
+
required :api_key, String
|
|
24
|
+
|
|
25
|
+
# @!attribute authorization
|
|
26
|
+
#
|
|
27
|
+
# @return [XTwitterScraper::Models::GuestWalletCreateResponse::Authorization]
|
|
28
|
+
required :authorization, -> { XTwitterScraper::Models::GuestWalletCreateResponse::Authorization }
|
|
29
|
+
|
|
30
|
+
# @!attribute checkout_url
|
|
31
|
+
# Raw Stripe-hosted checkout URL for user interaction.
|
|
32
|
+
#
|
|
33
|
+
# @return [String]
|
|
34
|
+
required :checkout_url, String
|
|
35
|
+
|
|
36
|
+
# @!attribute credential_notice
|
|
37
|
+
#
|
|
38
|
+
# @return [Symbol, :"Store api_key and the Idempotency-Key securely before sharing checkout_url. No email recovery is available."]
|
|
39
|
+
required :credential_notice,
|
|
40
|
+
const: :"Store api_key and the Idempotency-Key securely before sharing checkout_url. No email recovery is available."
|
|
41
|
+
|
|
42
|
+
# @!attribute credits
|
|
43
|
+
# Credits granted after verified payment.
|
|
44
|
+
#
|
|
45
|
+
# @return [String]
|
|
46
|
+
required :credits, String
|
|
47
|
+
|
|
48
|
+
# @!attribute expires_at
|
|
49
|
+
# Time when the pending checkout expires.
|
|
50
|
+
#
|
|
51
|
+
# @return [Time]
|
|
52
|
+
required :expires_at, Time
|
|
53
|
+
|
|
54
|
+
# @!attribute instructions
|
|
55
|
+
#
|
|
56
|
+
# @return [Symbol, :"Give checkout_url to the user. They must complete payment on Stripe. Never submit payment for them. After payment, poll status_url every poll_after_seconds until latest_purchase.status is no longer pending."]
|
|
57
|
+
required :instructions,
|
|
58
|
+
const: :"Give checkout_url to the user. They must complete payment on Stripe. Never submit payment for them. After payment, poll status_url every poll_after_seconds until latest_purchase.status is no longer pending."
|
|
59
|
+
|
|
60
|
+
# @!attribute poll_after_seconds
|
|
61
|
+
# Wait at least this long before polling status_url.
|
|
62
|
+
#
|
|
63
|
+
# @return [Integer, 2]
|
|
64
|
+
required :poll_after_seconds, const: 2
|
|
65
|
+
|
|
66
|
+
# @!attribute purchase_id
|
|
67
|
+
#
|
|
68
|
+
# @return [String]
|
|
69
|
+
required :purchase_id, String
|
|
70
|
+
|
|
71
|
+
# @!attribute requires_user_interaction
|
|
72
|
+
#
|
|
73
|
+
# @return [Boolean, true]
|
|
74
|
+
required :requires_user_interaction, const: true
|
|
75
|
+
|
|
76
|
+
# @!attribute status
|
|
77
|
+
#
|
|
78
|
+
# @return [Symbol, XTwitterScraper::Models::GuestWalletCreateResponse::Status]
|
|
79
|
+
required :status, enum: -> { XTwitterScraper::Models::GuestWalletCreateResponse::Status }
|
|
80
|
+
|
|
81
|
+
# @!attribute status_url
|
|
82
|
+
#
|
|
83
|
+
# @return [Symbol, :"https://xquik.com/api/v1/guest-wallets/status"]
|
|
84
|
+
required :status_url, const: :"https://xquik.com/api/v1/guest-wallets/status"
|
|
85
|
+
|
|
86
|
+
# @!attribute wallet_id
|
|
87
|
+
#
|
|
88
|
+
# @return [String]
|
|
89
|
+
required :wallet_id, String
|
|
90
|
+
|
|
91
|
+
# @!method initialize(amount:, api_key:, authorization:, checkout_url:, credits:, expires_at:, purchase_id:, status:, wallet_id:, account_required: false, credential_notice: :"Store api_key and the Idempotency-Key securely before sharing checkout_url. No email recovery is available.", instructions: :"Give checkout_url to the user. They must complete payment on Stripe. Never submit payment for them. After payment, poll status_url every poll_after_seconds until latest_purchase.status is no longer pending.", poll_after_seconds: 2, requires_user_interaction: true, status_url: :"https://xquik.com/api/v1/guest-wallets/status")
|
|
92
|
+
# Some parameter documentations has been truncated, see
|
|
93
|
+
# {XTwitterScraper::Models::GuestWalletCreateResponse} for more details.
|
|
94
|
+
#
|
|
95
|
+
# Initial guest wallet response containing the one-time key.
|
|
96
|
+
#
|
|
97
|
+
# @param amount [XTwitterScraper::Models::GuestWalletAmount] Confirmed USD amount for a guest wallet purchase.
|
|
98
|
+
#
|
|
99
|
+
# @param api_key [String] Paid-read bearer credential returned only by initial creation. Store it as a sec
|
|
100
|
+
#
|
|
101
|
+
# @param authorization [XTwitterScraper::Models::GuestWalletCreateResponse::Authorization]
|
|
102
|
+
#
|
|
103
|
+
# @param checkout_url [String] Raw Stripe-hosted checkout URL for user interaction.
|
|
104
|
+
#
|
|
105
|
+
# @param credits [String] Credits granted after verified payment.
|
|
106
|
+
#
|
|
107
|
+
# @param expires_at [Time] Time when the pending checkout expires.
|
|
108
|
+
#
|
|
109
|
+
# @param purchase_id [String]
|
|
110
|
+
#
|
|
111
|
+
# @param status [Symbol, XTwitterScraper::Models::GuestWalletCreateResponse::Status]
|
|
112
|
+
#
|
|
113
|
+
# @param wallet_id [String]
|
|
114
|
+
#
|
|
115
|
+
# @param account_required [Boolean, false]
|
|
116
|
+
#
|
|
117
|
+
# @param credential_notice [Symbol, :"Store api_key and the Idempotency-Key securely before sharing checkout_url. No email recovery is available."]
|
|
118
|
+
#
|
|
119
|
+
# @param instructions [Symbol, :"Give checkout_url to the user. They must complete payment on Stripe. Never submit payment for them. After payment, poll status_url every poll_after_seconds until latest_purchase.status is no longer pending."]
|
|
120
|
+
#
|
|
121
|
+
# @param poll_after_seconds [Integer, 2] Wait at least this long before polling status_url.
|
|
122
|
+
#
|
|
123
|
+
# @param requires_user_interaction [Boolean, true]
|
|
124
|
+
#
|
|
125
|
+
# @param status_url [Symbol, :"https://xquik.com/api/v1/guest-wallets/status"]
|
|
126
|
+
|
|
127
|
+
# @see XTwitterScraper::Models::GuestWalletCreateResponse#authorization
|
|
128
|
+
class Authorization < XTwitterScraper::Internal::Type::BaseModel
|
|
129
|
+
# @!attribute header
|
|
130
|
+
#
|
|
131
|
+
# @return [Symbol, :Authorization]
|
|
132
|
+
required :header, const: :Authorization
|
|
133
|
+
|
|
134
|
+
# @!attribute scheme
|
|
135
|
+
#
|
|
136
|
+
# @return [Symbol, :Bearer]
|
|
137
|
+
required :scheme, const: :Bearer
|
|
138
|
+
|
|
139
|
+
# @!method initialize(header: :Authorization, scheme: :Bearer)
|
|
140
|
+
# @param header [Symbol, :Authorization]
|
|
141
|
+
# @param scheme [Symbol, :Bearer]
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
# @see XTwitterScraper::Models::GuestWalletCreateResponse#status
|
|
145
|
+
module Status
|
|
146
|
+
extend XTwitterScraper::Internal::Type::Enum
|
|
147
|
+
|
|
148
|
+
CREATING = :creating
|
|
149
|
+
PENDING = :pending
|
|
150
|
+
PAID = :paid
|
|
151
|
+
EXPIRED = :expired
|
|
152
|
+
FAILED = :failed
|
|
153
|
+
REFUNDED = :refunded
|
|
154
|
+
DISPUTED = :disputed
|
|
155
|
+
|
|
156
|
+
# @!method self.values
|
|
157
|
+
# @return [Array<Symbol>]
|
|
158
|
+
end
|
|
159
|
+
end
|
|
160
|
+
end
|
|
161
|
+
end
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
module XTwitterScraper
|
|
4
4
|
module Models
|
|
5
|
-
# @see XTwitterScraper::Resources::
|
|
6
|
-
class
|
|
5
|
+
# @see XTwitterScraper::Resources::GuestWallets#retrieve_status
|
|
6
|
+
class GuestWalletRetrieveStatusParams < XTwitterScraper::Internal::Type::BaseModel
|
|
7
7
|
extend XTwitterScraper::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include XTwitterScraper::Internal::Type::RequestParameters
|
|
9
9
|
|