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
|
@@ -4,7 +4,18 @@ module XTwitterScraper
|
|
|
4
4
|
module Models
|
|
5
5
|
# @see XTwitterScraper::Resources::Account#retrieve
|
|
6
6
|
class AccountRetrieveResponse < XTwitterScraper::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute monitor_billing
|
|
8
|
+
#
|
|
9
|
+
# @return [XTwitterScraper::Models::AccountRetrieveResponse::MonitorBilling]
|
|
10
|
+
required :monitor_billing,
|
|
11
|
+
-> { XTwitterScraper::Models::AccountRetrieveResponse::MonitorBilling },
|
|
12
|
+
api_name: :monitorBilling
|
|
13
|
+
|
|
7
14
|
# @!attribute monitors_allowed
|
|
15
|
+
# @deprecated Monitor slots are unlimited. Use monitorBilling.unlimitedSlots instead.
|
|
16
|
+
#
|
|
17
|
+
# Deprecated. Monitor slots are unlimited, so this is always
|
|
18
|
+
# Number.MAX_SAFE_INTEGER.
|
|
8
19
|
#
|
|
9
20
|
# @return [Integer]
|
|
10
21
|
required :monitors_allowed, Integer, api_name: :monitorsAllowed
|
|
@@ -19,18 +30,94 @@ module XTwitterScraper
|
|
|
19
30
|
# @return [Symbol, XTwitterScraper::Models::AccountRetrieveResponse::Plan]
|
|
20
31
|
required :plan, enum: -> { XTwitterScraper::Models::AccountRetrieveResponse::Plan }
|
|
21
32
|
|
|
22
|
-
# @!attribute
|
|
33
|
+
# @!attribute credit_info
|
|
23
34
|
#
|
|
24
|
-
# @return [XTwitterScraper::Models::AccountRetrieveResponse::
|
|
25
|
-
optional :
|
|
26
|
-
-> { XTwitterScraper::Models::AccountRetrieveResponse::
|
|
27
|
-
api_name: :
|
|
35
|
+
# @return [XTwitterScraper::Models::AccountRetrieveResponse::CreditInfo, nil]
|
|
36
|
+
optional :credit_info,
|
|
37
|
+
-> { XTwitterScraper::Models::AccountRetrieveResponse::CreditInfo },
|
|
38
|
+
api_name: :creditInfo
|
|
28
39
|
|
|
29
|
-
# @!
|
|
30
|
-
#
|
|
40
|
+
# @!attribute x_username
|
|
41
|
+
# Linked X username, omitted when no X account is connected.
|
|
42
|
+
#
|
|
43
|
+
# @return [String, nil]
|
|
44
|
+
optional :x_username, String, api_name: :xUsername
|
|
45
|
+
|
|
46
|
+
# @!method initialize(monitor_billing:, monitors_allowed:, monitors_used:, plan:, credit_info: nil, x_username: nil)
|
|
47
|
+
# Some parameter documentations has been truncated, see
|
|
48
|
+
# {XTwitterScraper::Models::AccountRetrieveResponse} for more details.
|
|
49
|
+
#
|
|
50
|
+
# @param monitor_billing [XTwitterScraper::Models::AccountRetrieveResponse::MonitorBilling]
|
|
51
|
+
#
|
|
52
|
+
# @param monitors_allowed [Integer] Deprecated. Monitor slots are unlimited, so this is always Number.MAX_SAFE_INTEG
|
|
53
|
+
#
|
|
31
54
|
# @param monitors_used [Integer]
|
|
55
|
+
#
|
|
32
56
|
# @param plan [Symbol, XTwitterScraper::Models::AccountRetrieveResponse::Plan]
|
|
33
|
-
#
|
|
57
|
+
#
|
|
58
|
+
# @param credit_info [XTwitterScraper::Models::AccountRetrieveResponse::CreditInfo]
|
|
59
|
+
#
|
|
60
|
+
# @param x_username [String] Linked X username, omitted when no X account is connected.
|
|
61
|
+
|
|
62
|
+
# @see XTwitterScraper::Models::AccountRetrieveResponse#monitor_billing
|
|
63
|
+
class MonitorBilling < XTwitterScraper::Internal::Type::BaseModel
|
|
64
|
+
# @!attribute active_daily_estimate
|
|
65
|
+
# Estimated daily credits for currently active monitors.
|
|
66
|
+
#
|
|
67
|
+
# @return [String]
|
|
68
|
+
required :active_daily_estimate, String, api_name: :activeDailyEstimate
|
|
69
|
+
|
|
70
|
+
# @!attribute active_hourly_burn
|
|
71
|
+
# Credits charged each hour for currently active monitors.
|
|
72
|
+
#
|
|
73
|
+
# @return [String]
|
|
74
|
+
required :active_hourly_burn, String, api_name: :activeHourlyBurn
|
|
75
|
+
|
|
76
|
+
# @!attribute credits_per_active_monitor_day
|
|
77
|
+
# Estimated daily credits for 1 active instant monitor.
|
|
78
|
+
#
|
|
79
|
+
# @return [String]
|
|
80
|
+
required :credits_per_active_monitor_day, String, api_name: :creditsPerActiveMonitorDay
|
|
81
|
+
|
|
82
|
+
# @!attribute credits_per_active_monitor_hour
|
|
83
|
+
# Hourly credits charged for 1 active instant monitor.
|
|
84
|
+
#
|
|
85
|
+
# @return [String]
|
|
86
|
+
required :credits_per_active_monitor_hour, String, api_name: :creditsPerActiveMonitorHour
|
|
87
|
+
|
|
88
|
+
# @!attribute events_included
|
|
89
|
+
# Webhook and event deliveries are included in monitor billing.
|
|
90
|
+
#
|
|
91
|
+
# @return [Boolean]
|
|
92
|
+
required :events_included, XTwitterScraper::Internal::Type::Boolean, api_name: :eventsIncluded
|
|
93
|
+
|
|
94
|
+
# @!attribute instant_check_interval_seconds
|
|
95
|
+
# Active monitors check every 1 second.
|
|
96
|
+
#
|
|
97
|
+
# @return [Integer]
|
|
98
|
+
required :instant_check_interval_seconds, Integer, api_name: :instantCheckIntervalSeconds
|
|
99
|
+
|
|
100
|
+
# @!attribute unlimited_slots
|
|
101
|
+
# Monitor slot count is unlimited.
|
|
102
|
+
#
|
|
103
|
+
# @return [Boolean]
|
|
104
|
+
required :unlimited_slots, XTwitterScraper::Internal::Type::Boolean, api_name: :unlimitedSlots
|
|
105
|
+
|
|
106
|
+
# @!method initialize(active_daily_estimate:, active_hourly_burn:, credits_per_active_monitor_day:, credits_per_active_monitor_hour:, events_included:, instant_check_interval_seconds:, unlimited_slots:)
|
|
107
|
+
# @param active_daily_estimate [String] Estimated daily credits for currently active monitors.
|
|
108
|
+
#
|
|
109
|
+
# @param active_hourly_burn [String] Credits charged each hour for currently active monitors.
|
|
110
|
+
#
|
|
111
|
+
# @param credits_per_active_monitor_day [String] Estimated daily credits for 1 active instant monitor.
|
|
112
|
+
#
|
|
113
|
+
# @param credits_per_active_monitor_hour [String] Hourly credits charged for 1 active instant monitor.
|
|
114
|
+
#
|
|
115
|
+
# @param events_included [Boolean] Webhook and event deliveries are included in monitor billing.
|
|
116
|
+
#
|
|
117
|
+
# @param instant_check_interval_seconds [Integer] Active monitors check every 1 second.
|
|
118
|
+
#
|
|
119
|
+
# @param unlimited_slots [Boolean] Monitor slot count is unlimited.
|
|
120
|
+
end
|
|
34
121
|
|
|
35
122
|
# @see XTwitterScraper::Models::AccountRetrieveResponse#plan
|
|
36
123
|
module Plan
|
|
@@ -43,27 +130,55 @@ module XTwitterScraper
|
|
|
43
130
|
# @return [Array<Symbol>]
|
|
44
131
|
end
|
|
45
132
|
|
|
46
|
-
# @see XTwitterScraper::Models::AccountRetrieveResponse#
|
|
47
|
-
class
|
|
48
|
-
# @!attribute
|
|
133
|
+
# @see XTwitterScraper::Models::AccountRetrieveResponse#credit_info
|
|
134
|
+
class CreditInfo < XTwitterScraper::Internal::Type::BaseModel
|
|
135
|
+
# @!attribute auto_topup_amount_dollars
|
|
136
|
+
# Dollar amount charged when automatic top-up runs.
|
|
49
137
|
#
|
|
50
|
-
# @return [
|
|
51
|
-
required :
|
|
138
|
+
# @return [Float]
|
|
139
|
+
required :auto_topup_amount_dollars, Float, api_name: :autoTopupAmountDollars
|
|
52
140
|
|
|
53
|
-
# @!attribute
|
|
141
|
+
# @!attribute auto_topup_enabled
|
|
54
142
|
#
|
|
55
|
-
# @return [
|
|
56
|
-
required :
|
|
143
|
+
# @return [Boolean]
|
|
144
|
+
required :auto_topup_enabled, XTwitterScraper::Internal::Type::Boolean, api_name: :autoTopupEnabled
|
|
57
145
|
|
|
58
|
-
# @!attribute
|
|
146
|
+
# @!attribute auto_topup_threshold
|
|
147
|
+
# Bigint string threshold that triggers automatic top-up when enabled.
|
|
59
148
|
#
|
|
60
|
-
# @return [
|
|
61
|
-
required :
|
|
149
|
+
# @return [String]
|
|
150
|
+
required :auto_topup_threshold, String, api_name: :autoTopupThreshold
|
|
62
151
|
|
|
63
|
-
# @!
|
|
64
|
-
#
|
|
65
|
-
#
|
|
66
|
-
# @
|
|
152
|
+
# @!attribute balance
|
|
153
|
+
# Bigint string to preserve precision above Number.MAX_SAFE_INTEGER.
|
|
154
|
+
#
|
|
155
|
+
# @return [String]
|
|
156
|
+
required :balance, String
|
|
157
|
+
|
|
158
|
+
# @!attribute lifetime_purchased
|
|
159
|
+
# Total purchased credits as a bigint string.
|
|
160
|
+
#
|
|
161
|
+
# @return [String]
|
|
162
|
+
required :lifetime_purchased, String, api_name: :lifetimePurchased
|
|
163
|
+
|
|
164
|
+
# @!attribute lifetime_used
|
|
165
|
+
# Total consumed credits as a bigint string.
|
|
166
|
+
#
|
|
167
|
+
# @return [String]
|
|
168
|
+
required :lifetime_used, String, api_name: :lifetimeUsed
|
|
169
|
+
|
|
170
|
+
# @!method initialize(auto_topup_amount_dollars:, auto_topup_enabled:, auto_topup_threshold:, balance:, lifetime_purchased:, lifetime_used:)
|
|
171
|
+
# @param auto_topup_amount_dollars [Float] Dollar amount charged when automatic top-up runs.
|
|
172
|
+
#
|
|
173
|
+
# @param auto_topup_enabled [Boolean]
|
|
174
|
+
#
|
|
175
|
+
# @param auto_topup_threshold [String] Bigint string threshold that triggers automatic top-up when enabled.
|
|
176
|
+
#
|
|
177
|
+
# @param balance [String] Bigint string to preserve precision above Number.MAX_SAFE_INTEGER.
|
|
178
|
+
#
|
|
179
|
+
# @param lifetime_purchased [String] Total purchased credits as a bigint string.
|
|
180
|
+
#
|
|
181
|
+
# @param lifetime_used [String] Total consumed credits as a bigint string.
|
|
67
182
|
end
|
|
68
183
|
end
|
|
69
184
|
end
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module XTwitterScraper
|
|
4
|
+
module Models
|
|
5
|
+
class ContentDisclosure < XTwitterScraper::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute advertising
|
|
7
|
+
#
|
|
8
|
+
# @return [XTwitterScraper::Models::ContentDisclosure::Advertising, nil]
|
|
9
|
+
optional :advertising, -> { XTwitterScraper::ContentDisclosure::Advertising }
|
|
10
|
+
|
|
11
|
+
# @!attribute ai_generated
|
|
12
|
+
#
|
|
13
|
+
# @return [XTwitterScraper::Models::ContentDisclosure::AIGenerated, nil]
|
|
14
|
+
optional :ai_generated, -> { XTwitterScraper::ContentDisclosure::AIGenerated }, api_name: :aiGenerated
|
|
15
|
+
|
|
16
|
+
# @!method initialize(advertising: nil, ai_generated: nil)
|
|
17
|
+
# Content disclosure metadata shown by X when a tweet is labeled as paid
|
|
18
|
+
# partnership content or AI-generated media.
|
|
19
|
+
#
|
|
20
|
+
# @param advertising [XTwitterScraper::Models::ContentDisclosure::Advertising]
|
|
21
|
+
# @param ai_generated [XTwitterScraper::Models::ContentDisclosure::AIGenerated]
|
|
22
|
+
|
|
23
|
+
# @see XTwitterScraper::Models::ContentDisclosure#advertising
|
|
24
|
+
class Advertising < XTwitterScraper::Internal::Type::BaseModel
|
|
25
|
+
# @!attribute is_paid_promotion
|
|
26
|
+
# True when X labels the tweet as paid promotion content.
|
|
27
|
+
#
|
|
28
|
+
# @return [Boolean, nil]
|
|
29
|
+
optional :is_paid_promotion, XTwitterScraper::Internal::Type::Boolean, api_name: :isPaidPromotion
|
|
30
|
+
|
|
31
|
+
# @!method initialize(is_paid_promotion: nil)
|
|
32
|
+
# @param is_paid_promotion [Boolean] True when X labels the tweet as paid promotion content.
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# @see XTwitterScraper::Models::ContentDisclosure#ai_generated
|
|
36
|
+
class AIGenerated < XTwitterScraper::Internal::Type::BaseModel
|
|
37
|
+
# @!attribute can_edit
|
|
38
|
+
# Whether the disclosure can be edited on X.
|
|
39
|
+
#
|
|
40
|
+
# @return [Boolean, nil]
|
|
41
|
+
optional :can_edit, XTwitterScraper::Internal::Type::Boolean, api_name: :canEdit
|
|
42
|
+
|
|
43
|
+
# @!attribute detection_source
|
|
44
|
+
# Source of the AI-generated media disclosure.
|
|
45
|
+
#
|
|
46
|
+
# @return [String, nil]
|
|
47
|
+
optional :detection_source, String, api_name: :detectionSource
|
|
48
|
+
|
|
49
|
+
# @!attribute has_ai_generated_media
|
|
50
|
+
# True when X labels the tweet as containing AI-generated media.
|
|
51
|
+
#
|
|
52
|
+
# @return [Boolean, nil]
|
|
53
|
+
optional :has_ai_generated_media,
|
|
54
|
+
XTwitterScraper::Internal::Type::Boolean,
|
|
55
|
+
api_name: :hasAiGeneratedMedia
|
|
56
|
+
|
|
57
|
+
# @!method initialize(can_edit: nil, detection_source: nil, has_ai_generated_media: nil)
|
|
58
|
+
# @param can_edit [Boolean] Whether the disclosure can be edited on X.
|
|
59
|
+
#
|
|
60
|
+
# @param detection_source [String] Source of the AI-generated media disclosure.
|
|
61
|
+
#
|
|
62
|
+
# @param has_ai_generated_media [Boolean] True when X labels the tweet as containing AI-generated media.
|
|
63
|
+
end
|
|
64
|
+
end
|
|
65
|
+
end
|
|
66
|
+
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module XTwitterScraper
|
|
4
|
+
module Models
|
|
5
|
+
# @see XTwitterScraper::Resources::Credits#redirect_topup_checkout
|
|
6
|
+
class CreditRedirectTopupCheckoutParams < XTwitterScraper::Internal::Type::BaseModel
|
|
7
|
+
extend XTwitterScraper::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include XTwitterScraper::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute session_id
|
|
11
|
+
# Billing session ID returned by the top-up billing flow.
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :session_id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(session_id:, request_options: {})
|
|
17
|
+
# @param session_id [String] Billing session ID returned by the top-up billing flow.
|
|
18
|
+
#
|
|
19
|
+
# @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -4,31 +4,58 @@ module XTwitterScraper
|
|
|
4
4
|
module Models
|
|
5
5
|
# @see XTwitterScraper::Resources::Credits#retrieve_balance
|
|
6
6
|
class CreditRetrieveBalanceResponse < XTwitterScraper::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute auto_topup_amount_dollars
|
|
8
|
+
# Configured dollar amount for each automatic top-up.
|
|
9
|
+
#
|
|
10
|
+
# @return [Float]
|
|
11
|
+
required :auto_topup_amount_dollars, Float
|
|
12
|
+
|
|
7
13
|
# @!attribute auto_topup_enabled
|
|
8
14
|
#
|
|
9
15
|
# @return [Boolean]
|
|
10
16
|
required :auto_topup_enabled, XTwitterScraper::Internal::Type::Boolean
|
|
11
17
|
|
|
18
|
+
# @!attribute auto_topup_threshold
|
|
19
|
+
# Credit balance threshold that triggers automatic top-up when enabled,
|
|
20
|
+
# represented as a bigint string.
|
|
21
|
+
#
|
|
22
|
+
# @return [String]
|
|
23
|
+
required :auto_topup_threshold, String
|
|
24
|
+
|
|
12
25
|
# @!attribute balance
|
|
26
|
+
# Current credit balance as a bigint string to preserve precision above
|
|
27
|
+
# Number.MAX_SAFE_INTEGER.
|
|
13
28
|
#
|
|
14
|
-
# @return [
|
|
15
|
-
required :balance,
|
|
29
|
+
# @return [String]
|
|
30
|
+
required :balance, String
|
|
16
31
|
|
|
17
32
|
# @!attribute lifetime_purchased
|
|
33
|
+
# Lifetime purchased credits as a bigint string.
|
|
18
34
|
#
|
|
19
|
-
# @return [
|
|
20
|
-
required :lifetime_purchased,
|
|
35
|
+
# @return [String]
|
|
36
|
+
required :lifetime_purchased, String
|
|
21
37
|
|
|
22
38
|
# @!attribute lifetime_used
|
|
39
|
+
# Lifetime consumed credits as a bigint string.
|
|
23
40
|
#
|
|
24
|
-
# @return [
|
|
25
|
-
required :lifetime_used,
|
|
41
|
+
# @return [String]
|
|
42
|
+
required :lifetime_used, String
|
|
26
43
|
|
|
27
|
-
# @!method initialize(auto_topup_enabled:, balance:, lifetime_purchased:, lifetime_used:)
|
|
44
|
+
# @!method initialize(auto_topup_amount_dollars:, auto_topup_enabled:, auto_topup_threshold:, balance:, lifetime_purchased:, lifetime_used:)
|
|
45
|
+
# Some parameter documentations has been truncated, see
|
|
46
|
+
# {XTwitterScraper::Models::CreditRetrieveBalanceResponse} for more details.
|
|
47
|
+
#
|
|
48
|
+
# @param auto_topup_amount_dollars [Float] Configured dollar amount for each automatic top-up.
|
|
49
|
+
#
|
|
28
50
|
# @param auto_topup_enabled [Boolean]
|
|
29
|
-
#
|
|
30
|
-
# @param
|
|
31
|
-
#
|
|
51
|
+
#
|
|
52
|
+
# @param auto_topup_threshold [String] Credit balance threshold that triggers automatic top-up when enabled, represente
|
|
53
|
+
#
|
|
54
|
+
# @param balance [String] Current credit balance as a bigint string to preserve precision above Number.MAX
|
|
55
|
+
#
|
|
56
|
+
# @param lifetime_purchased [String] Lifetime purchased credits as a bigint string.
|
|
57
|
+
#
|
|
58
|
+
# @param lifetime_used [String] Lifetime consumed credits as a bigint string.
|
|
32
59
|
end
|
|
33
60
|
end
|
|
34
61
|
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module XTwitterScraper
|
|
4
|
+
module Models
|
|
5
|
+
# @see XTwitterScraper::Resources::Credits#retrieve_topup_status
|
|
6
|
+
class CreditRetrieveTopupStatusParams < XTwitterScraper::Internal::Type::BaseModel
|
|
7
|
+
extend XTwitterScraper::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include XTwitterScraper::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute session_id
|
|
11
|
+
# Billing session ID returned by the top-up billing flow.
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :session_id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(session_id:, request_options: {})
|
|
17
|
+
# @param session_id [String] Billing session ID returned by the top-up billing flow.
|
|
18
|
+
#
|
|
19
|
+
# @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module XTwitterScraper
|
|
4
|
+
module Models
|
|
5
|
+
# @see XTwitterScraper::Resources::Credits#retrieve_topup_status
|
|
6
|
+
class CreditRetrieveTopupStatusResponse < XTwitterScraper::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute status
|
|
8
|
+
#
|
|
9
|
+
# @return [Symbol, XTwitterScraper::Models::CreditRetrieveTopupStatusResponse::Status]
|
|
10
|
+
required :status, enum: -> { XTwitterScraper::Models::CreditRetrieveTopupStatusResponse::Status }
|
|
11
|
+
|
|
12
|
+
# @!attribute amount_dollars
|
|
13
|
+
# Dollar amount requested for the top-up.
|
|
14
|
+
#
|
|
15
|
+
# @return [Integer, nil]
|
|
16
|
+
optional :amount_dollars, Integer, nil?: true
|
|
17
|
+
|
|
18
|
+
# @!attribute credits
|
|
19
|
+
# Bigint string credit amount granted or pending.
|
|
20
|
+
#
|
|
21
|
+
# @return [String, nil]
|
|
22
|
+
optional :credits, String
|
|
23
|
+
|
|
24
|
+
# @!method initialize(status:, amount_dollars: nil, credits: nil)
|
|
25
|
+
# @param status [Symbol, XTwitterScraper::Models::CreditRetrieveTopupStatusResponse::Status]
|
|
26
|
+
#
|
|
27
|
+
# @param amount_dollars [Integer, nil] Dollar amount requested for the top-up.
|
|
28
|
+
#
|
|
29
|
+
# @param credits [String] Bigint string credit amount granted or pending.
|
|
30
|
+
|
|
31
|
+
# @see XTwitterScraper::Models::CreditRetrieveTopupStatusResponse#status
|
|
32
|
+
module Status
|
|
33
|
+
extend XTwitterScraper::Internal::Type::Enum
|
|
34
|
+
|
|
35
|
+
PAID = :paid
|
|
36
|
+
PROCESSING = :processing
|
|
37
|
+
FAILED = :failed
|
|
38
|
+
EXPIRED = :expired
|
|
39
|
+
|
|
40
|
+
# @!method self.values
|
|
41
|
+
# @return [Array<Symbol>]
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
end
|
|
@@ -7,14 +7,22 @@ module XTwitterScraper
|
|
|
7
7
|
extend XTwitterScraper::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include XTwitterScraper::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!attribute
|
|
11
|
-
# Amount to top up in
|
|
10
|
+
# @!attribute dollars
|
|
11
|
+
# Amount to top up in US dollars. Minimum 10.
|
|
12
12
|
#
|
|
13
13
|
# @return [Integer]
|
|
14
|
-
required :
|
|
14
|
+
required :dollars, Integer
|
|
15
15
|
|
|
16
|
-
# @!
|
|
17
|
-
#
|
|
16
|
+
# @!attribute locale
|
|
17
|
+
# Optional checkout locale. Defaults to en.
|
|
18
|
+
#
|
|
19
|
+
# @return [String, nil]
|
|
20
|
+
optional :locale, String
|
|
21
|
+
|
|
22
|
+
# @!method initialize(dollars:, locale: nil, request_options: {})
|
|
23
|
+
# @param dollars [Integer] Amount to top up in US dollars. Minimum 10.
|
|
24
|
+
#
|
|
25
|
+
# @param locale [String] Optional checkout locale. Defaults to en.
|
|
18
26
|
#
|
|
19
27
|
# @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
|
|
20
28
|
end
|
|
@@ -4,13 +4,26 @@ module XTwitterScraper
|
|
|
4
4
|
module Models
|
|
5
5
|
# @see XTwitterScraper::Resources::Credits#topup_balance
|
|
6
6
|
class CreditTopupBalanceResponse < XTwitterScraper::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute
|
|
7
|
+
# @!attribute redirect_url
|
|
8
|
+
# Stable first-party Xquik redirect URL for the active Stripe Checkout session.
|
|
8
9
|
#
|
|
9
|
-
# @return [
|
|
10
|
-
required :
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :redirect_url, String
|
|
11
12
|
|
|
12
|
-
# @!
|
|
13
|
-
#
|
|
13
|
+
# @!attribute url
|
|
14
|
+
# Same stable first-party Xquik redirect URL as redirect_url. The response never
|
|
15
|
+
# exposes a raw Stripe Checkout URL.
|
|
16
|
+
#
|
|
17
|
+
# @return [String]
|
|
18
|
+
required :url, String
|
|
19
|
+
|
|
20
|
+
# @!method initialize(redirect_url:, url:)
|
|
21
|
+
# Some parameter documentations has been truncated, see
|
|
22
|
+
# {XTwitterScraper::Models::CreditTopupBalanceResponse} for more details.
|
|
23
|
+
#
|
|
24
|
+
# @param redirect_url [String] Stable first-party Xquik redirect URL for the active Stripe Checkout session.
|
|
25
|
+
#
|
|
26
|
+
# @param url [String] Same stable first-party Xquik redirect URL as redirect_url. The response never e
|
|
14
27
|
end
|
|
15
28
|
end
|
|
16
29
|
end
|
|
@@ -14,15 +14,21 @@ module XTwitterScraper
|
|
|
14
14
|
optional :after_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
|
|
21
24
|
|
|
22
25
|
# @!method initialize(after_cursor: nil, limit: nil, request_options: {})
|
|
26
|
+
# Some parameter documentations has been truncated, see
|
|
27
|
+
# {XTwitterScraper::Models::DraftListParams} for more details.
|
|
28
|
+
#
|
|
23
29
|
# @param after_cursor [String] Cursor for pagination
|
|
24
30
|
#
|
|
25
|
-
# @param limit [Integer] Maximum number of items to return (1-100, default 50)
|
|
31
|
+
# @param limit [Integer] Maximum number of items to return (1-100, default 50). For paid per-result endpo
|
|
26
32
|
#
|
|
27
33
|
# @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
|
|
28
34
|
end
|
|
@@ -4,6 +4,7 @@ module XTwitterScraper
|
|
|
4
4
|
module Models
|
|
5
5
|
class DrawDetail < XTwitterScraper::Internal::Type::BaseModel
|
|
6
6
|
# @!attribute id
|
|
7
|
+
# Draw public ID.
|
|
7
8
|
#
|
|
8
9
|
# @return [String]
|
|
9
10
|
required :id, String
|
|
@@ -76,19 +77,32 @@ module XTwitterScraper
|
|
|
76
77
|
# @!method initialize(id:, created_at:, status:, total_entries:, tweet_author_username:, tweet_id:, tweet_like_count:, tweet_quote_count:, tweet_reply_count:, tweet_retweet_count:, tweet_text:, tweet_url:, valid_entries:, drawn_at: nil)
|
|
77
78
|
# Full giveaway draw with tweet metrics, entries, and timing.
|
|
78
79
|
#
|
|
79
|
-
# @param id [String]
|
|
80
|
+
# @param id [String] Draw public ID.
|
|
81
|
+
#
|
|
80
82
|
# @param created_at [Time]
|
|
83
|
+
#
|
|
81
84
|
# @param status [String]
|
|
85
|
+
#
|
|
82
86
|
# @param total_entries [Integer]
|
|
87
|
+
#
|
|
83
88
|
# @param tweet_author_username [String]
|
|
89
|
+
#
|
|
84
90
|
# @param tweet_id [String]
|
|
91
|
+
#
|
|
85
92
|
# @param tweet_like_count [Integer]
|
|
93
|
+
#
|
|
86
94
|
# @param tweet_quote_count [Integer]
|
|
95
|
+
#
|
|
87
96
|
# @param tweet_reply_count [Integer]
|
|
97
|
+
#
|
|
88
98
|
# @param tweet_retweet_count [Integer]
|
|
99
|
+
#
|
|
89
100
|
# @param tweet_text [String]
|
|
101
|
+
#
|
|
90
102
|
# @param tweet_url [String]
|
|
103
|
+
#
|
|
91
104
|
# @param valid_entries [Integer]
|
|
105
|
+
#
|
|
92
106
|
# @param drawn_at [Time]
|
|
93
107
|
end
|
|
94
108
|
end
|
|
@@ -15,8 +15,8 @@ module XTwitterScraper
|
|
|
15
15
|
# @!attribute format_
|
|
16
16
|
# Export output format
|
|
17
17
|
#
|
|
18
|
-
# @return [Symbol, XTwitterScraper::Models::DrawExportParams::Format
|
|
19
|
-
|
|
18
|
+
# @return [Symbol, XTwitterScraper::Models::DrawExportParams::Format]
|
|
19
|
+
required :format_, enum: -> { XTwitterScraper::DrawExportParams::Format }
|
|
20
20
|
|
|
21
21
|
# @!attribute type
|
|
22
22
|
# Export winners or all entries
|
|
@@ -24,7 +24,7 @@ module XTwitterScraper
|
|
|
24
24
|
# @return [Symbol, XTwitterScraper::Models::DrawExportParams::Type, nil]
|
|
25
25
|
optional :type, enum: -> { XTwitterScraper::DrawExportParams::Type }
|
|
26
26
|
|
|
27
|
-
# @!method initialize(id:, format_
|
|
27
|
+
# @!method initialize(id:, format_:, type: nil, request_options: {})
|
|
28
28
|
# @param id [String]
|
|
29
29
|
#
|
|
30
30
|
# @param format_ [Symbol, XTwitterScraper::Models::DrawExportParams::Format] Export output format
|
|
@@ -4,6 +4,7 @@ module XTwitterScraper
|
|
|
4
4
|
module Models
|
|
5
5
|
class DrawListItem < XTwitterScraper::Internal::Type::BaseModel
|
|
6
6
|
# @!attribute id
|
|
7
|
+
# Draw public ID for detail responses.
|
|
7
8
|
#
|
|
8
9
|
# @return [String]
|
|
9
10
|
required :id, String
|
|
@@ -41,12 +42,18 @@ module XTwitterScraper
|
|
|
41
42
|
# @!method initialize(id:, created_at:, status:, total_entries:, tweet_url:, valid_entries:, drawn_at: nil)
|
|
42
43
|
# Giveaway draw summary with entry counts and status.
|
|
43
44
|
#
|
|
44
|
-
# @param id [String]
|
|
45
|
+
# @param id [String] Draw public ID for detail responses.
|
|
46
|
+
#
|
|
45
47
|
# @param created_at [Time]
|
|
48
|
+
#
|
|
46
49
|
# @param status [String]
|
|
50
|
+
#
|
|
47
51
|
# @param total_entries [Integer]
|
|
52
|
+
#
|
|
48
53
|
# @param tweet_url [String]
|
|
54
|
+
#
|
|
49
55
|
# @param valid_entries [Integer]
|
|
56
|
+
#
|
|
50
57
|
# @param drawn_at [Time]
|
|
51
58
|
end
|
|
52
59
|
end
|
|
@@ -7,22 +7,28 @@ 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
|
|
21
24
|
|
|
22
|
-
# @!method initialize(
|
|
23
|
-
#
|
|
25
|
+
# @!method initialize(cursor: nil, limit: nil, request_options: {})
|
|
26
|
+
# Some parameter documentations has been truncated, see
|
|
27
|
+
# {XTwitterScraper::Models::DrawListParams} for more details.
|
|
24
28
|
#
|
|
25
|
-
# @param
|
|
29
|
+
# @param cursor [String] Cursor for keyset pagination from prior response next_cursor
|
|
30
|
+
#
|
|
31
|
+
# @param limit [Integer] Maximum number of items to return (1-100, default 50). For paid per-result endpo
|
|
26
32
|
#
|
|
27
33
|
# @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
|
|
28
34
|
end
|