x-twitter-scraper 0.4.2 → 0.4.4

data/rbi/x_twitter_scraper/resources/x/write_actions.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module XTwitterScraper
+  module Resources
+    class X
+      # X write actions (tweets, likes, follows, DMs)
+      class WriteActions
+        # Get write action status
+        sig do
+          params(
+            id: String,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(XTwitterScraper::Models::X::WriteActionRetrieveResponse)
+        end
+        def retrieve(
+          # Write action ID returned by a pending write response.
+          id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig do
+          params(client: XTwitterScraper::Client).returns(T.attached_class)
+        end
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/resources/x.rbi

@@ -2,23 +2,25 @@
 
 module XTwitterScraper
   module Resources
-    # X data lookups (subscription required)
     class X
+      # X write actions (tweets, likes, follows, DMs)
+      sig { returns(XTwitterScraper::Resources::X::WriteActions) }
+      attr_reader :write_actions
+
       sig { returns(XTwitterScraper::Resources::X::Tweets) }
       attr_reader :tweets
 
-      # X data lookups (subscription required)
       sig { returns(XTwitterScraper::Resources::X::Users) }
       attr_reader :users
 
-      # X data lookups (subscription required)
+      # Look up, search, and explore user profiles and relationships
       sig { returns(XTwitterScraper::Resources::X::Followers) }
       attr_reader :followers
 
       sig { returns(XTwitterScraper::Resources::X::Dm) }
       attr_reader :dm
 
-      # Media upload & download
+      # Media upload and download
       sig { returns(XTwitterScraper::Resources::X::Media) }
       attr_reader :media
 
@@ -33,15 +35,22 @@ module XTwitterScraper
       sig { returns(XTwitterScraper::Resources::X::Accounts) }
       attr_reader :accounts
 
-      # X data lookups (subscription required)
+      # Connected X account management
+      sig do
+        returns(XTwitterScraper::Resources::X::AccountConnectionChallenges)
+      end
+      attr_reader :account_connection_challenges
+
+      # Look up, search, and analyze individual tweets
       sig { returns(XTwitterScraper::Resources::X::Bookmarks) }
       attr_reader :bookmarks
 
-      # X data lookups (subscription required)
+      # X List followers, members, and tweets
       sig { returns(XTwitterScraper::Resources::X::Lists) }
       attr_reader :lists
 
-      # Retrieve the full content of an X Article (long-form post) by tweet ID.
+      # Retrieve the full content of an X Article (long-form post) by numeric tweet ID.
+      # Returns article_not_found when the tweet is valid but is not an X Article.
       sig do
         params(
           tweet_id: String,
@@ -49,7 +58,8 @@ module XTwitterScraper
         ).returns(XTwitterScraper::Models::XGetArticleResponse)
       end
       def get_article(
-        # Tweet ID of the article
+        # Numeric tweet ID of the article, 15-20 digits. If you have a tweet URL, use the
+        # final status ID.
         tweet_id,
         request_options: {}
       )
@@ -66,7 +76,7 @@ module XTwitterScraper
       def get_home_timeline(
         # Pagination cursor for timeline
         cursor: nil,
-        # Comma-separated tweet IDs to exclude from results
+        # Comma-separated tweet IDs to exclude from results. Empty entries are ignored.
         seen_tweet_ids: nil,
         request_options: {}
       )
@@ -83,19 +93,27 @@ module XTwitterScraper
       def get_notifications(
         # Pagination cursor for notifications
         cursor: nil,
-        # Notification type filter
+        # Notification type filter. Unrecognized values fall back to All.
         type: nil,
         request_options: {}
       )
       end
 
-      # Get trending topics
+      # Get trending hashtags and topics from X by region
       sig do
         params(
+          count: Integer,
+          woeid: Integer,
           request_options: XTwitterScraper::RequestOptions::OrHash
         ).returns(XTwitterScraper::Models::XGetTrendsResponse)
       end
-      def get_trends(request_options: {})
+      def get_trends(
+        # Number of trending topics to return (1-50, default 30)
+        count: nil,
+        # Region WOEID (1=Worldwide, 23424977=US, 23424975=UK, 23424969=Turkey)
+        woeid: nil,
+        request_options: {}
+      )
       end
 
       # @api private

data/sig/x_twitter_scraper/client.rbs

@@ -14,8 +14,6 @@ module XTwitterScraper
 
     attr_reader account: XTwitterScraper::Resources::Account
 
-    attr_reader api_keys: XTwitterScraper::Resources::APIKeys
-
     attr_reader subscribe: XTwitterScraper::Resources::Subscribe
 
     attr_reader compose: XTwitterScraper::Resources::Compose
@@ -36,18 +34,16 @@ module XTwitterScraper
 
     attr_reader webhooks: XTwitterScraper::Resources::Webhooks
 
-    attr_reader integrations: XTwitterScraper::Resources::Integrations
-
     attr_reader x: XTwitterScraper::Resources::X
 
     attr_reader trends: XTwitterScraper::Resources::Trends
 
-    attr_reader bot: XTwitterScraper::Resources::Bot
-
     attr_reader support: XTwitterScraper::Resources::Support
 
     attr_reader credits: XTwitterScraper::Resources::Credits
 
+    attr_reader guest_wallets: XTwitterScraper::Resources::GuestWallets
+
     private def auth_headers: (
       security: { auth_api_key: bool, oauth_bearer: bool }
     ) -> ::Hash[String, String]

data/sig/x_twitter_scraper/models/account_retrieve_response.rbs

@@ -2,39 +2,98 @@ module XTwitterScraper
   module Models
     type account_retrieve_response =
       {
+        monitor_billing: XTwitterScraper::Models::AccountRetrieveResponse::MonitorBilling,
         monitors_allowed: Integer,
         monitors_used: Integer,
         plan: XTwitterScraper::Models::AccountRetrieveResponse::plan,
-        current_period: XTwitterScraper::Models::AccountRetrieveResponse::CurrentPeriod
+        credit_info: XTwitterScraper::Models::AccountRetrieveResponse::CreditInfo,
+        x_username: String
       }
 
     class AccountRetrieveResponse < XTwitterScraper::Internal::Type::BaseModel
+      attr_accessor monitor_billing: XTwitterScraper::Models::AccountRetrieveResponse::MonitorBilling
+
       attr_accessor monitors_allowed: Integer
 
       attr_accessor monitors_used: Integer
 
       attr_accessor plan: XTwitterScraper::Models::AccountRetrieveResponse::plan
 
-      attr_reader current_period: XTwitterScraper::Models::AccountRetrieveResponse::CurrentPeriod?
+      attr_reader credit_info: XTwitterScraper::Models::AccountRetrieveResponse::CreditInfo?
+
+      def credit_info=: (
+        XTwitterScraper::Models::AccountRetrieveResponse::CreditInfo
+      ) -> XTwitterScraper::Models::AccountRetrieveResponse::CreditInfo
+
+      attr_reader x_username: String?
 
-      def current_period=: (
-        XTwitterScraper::Models::AccountRetrieveResponse::CurrentPeriod
-      ) -> XTwitterScraper::Models::AccountRetrieveResponse::CurrentPeriod
+      def x_username=: (String) -> String
 
       def initialize: (
+        monitor_billing: XTwitterScraper::Models::AccountRetrieveResponse::MonitorBilling,
         monitors_allowed: Integer,
         monitors_used: Integer,
         plan: XTwitterScraper::Models::AccountRetrieveResponse::plan,
-        ?current_period: XTwitterScraper::Models::AccountRetrieveResponse::CurrentPeriod
+        ?credit_info: XTwitterScraper::Models::AccountRetrieveResponse::CreditInfo,
+        ?x_username: String
       ) -> void
 
       def to_hash: -> {
+        monitor_billing: XTwitterScraper::Models::AccountRetrieveResponse::MonitorBilling,
         monitors_allowed: Integer,
         monitors_used: Integer,
         plan: XTwitterScraper::Models::AccountRetrieveResponse::plan,
-        current_period: XTwitterScraper::Models::AccountRetrieveResponse::CurrentPeriod
+        credit_info: XTwitterScraper::Models::AccountRetrieveResponse::CreditInfo,
+        x_username: String
       }
 
+      type monitor_billing =
+        {
+          active_daily_estimate: String,
+          active_hourly_burn: String,
+          credits_per_active_monitor_day: String,
+          credits_per_active_monitor_hour: String,
+          events_included: bool,
+          instant_check_interval_seconds: Integer,
+          unlimited_slots: bool
+        }
+
+      class MonitorBilling < XTwitterScraper::Internal::Type::BaseModel
+        attr_accessor active_daily_estimate: String
+
+        attr_accessor active_hourly_burn: String
+
+        attr_accessor credits_per_active_monitor_day: String
+
+        attr_accessor credits_per_active_monitor_hour: String
+
+        attr_accessor events_included: bool
+
+        attr_accessor instant_check_interval_seconds: Integer
+
+        attr_accessor unlimited_slots: bool
+
+        def initialize: (
+          active_daily_estimate: String,
+          active_hourly_burn: String,
+          credits_per_active_monitor_day: String,
+          credits_per_active_monitor_hour: String,
+          events_included: bool,
+          instant_check_interval_seconds: Integer,
+          unlimited_slots: bool
+        ) -> void
+
+        def to_hash: -> {
+          active_daily_estimate: String,
+          active_hourly_burn: String,
+          credits_per_active_monitor_day: String,
+          credits_per_active_monitor_hour: String,
+          events_included: bool,
+          instant_check_interval_seconds: Integer,
+          unlimited_slots: bool
+        }
+      end
+
       type plan = :active | :inactive
 
       module Plan
@@ -46,18 +105,46 @@ module XTwitterScraper
         def self?.values: -> ::Array[XTwitterScraper::Models::AccountRetrieveResponse::plan]
       end
 
-      type current_period = { end_: Time, start: Time, usage_percent: Float }
-
-      class CurrentPeriod < XTwitterScraper::Internal::Type::BaseModel
-        attr_accessor end_: Time
-
-        attr_accessor start: Time
-
-        attr_accessor usage_percent: Float
-
-        def initialize: (end_: Time, start: Time, usage_percent: Float) -> void
-
-        def to_hash: -> { end_: Time, start: Time, usage_percent: Float }
+      type credit_info =
+        {
+          auto_topup_amount_dollars: Float,
+          auto_topup_enabled: bool,
+          auto_topup_threshold: String,
+          balance: String,
+          lifetime_purchased: String,
+          lifetime_used: String
+        }
+
+      class CreditInfo < XTwitterScraper::Internal::Type::BaseModel
+        attr_accessor auto_topup_amount_dollars: Float
+
+        attr_accessor auto_topup_enabled: bool
+
+        attr_accessor auto_topup_threshold: String
+
+        attr_accessor balance: String
+
+        attr_accessor lifetime_purchased: String
+
+        attr_accessor lifetime_used: String
+
+        def initialize: (
+          auto_topup_amount_dollars: Float,
+          auto_topup_enabled: bool,
+          auto_topup_threshold: String,
+          balance: String,
+          lifetime_purchased: String,
+          lifetime_used: String
+        ) -> void
+
+        def to_hash: -> {
+          auto_topup_amount_dollars: Float,
+          auto_topup_enabled: bool,
+          auto_topup_threshold: String,
+          balance: String,
+          lifetime_purchased: String,
+          lifetime_used: String
+        }
       end
     end
   end

data/sig/x_twitter_scraper/models/content_disclosure.rbs

@@ -0,0 +1,78 @@
+module XTwitterScraper
+  module Models
+    type content_disclosure =
+      {
+        advertising: XTwitterScraper::ContentDisclosure::Advertising,
+        ai_generated: XTwitterScraper::ContentDisclosure::AIGenerated
+      }
+
+    class ContentDisclosure < XTwitterScraper::Internal::Type::BaseModel
+      attr_reader advertising: XTwitterScraper::ContentDisclosure::Advertising?
+
+      def advertising=: (
+        XTwitterScraper::ContentDisclosure::Advertising
+      ) -> XTwitterScraper::ContentDisclosure::Advertising
+
+      attr_reader ai_generated: XTwitterScraper::ContentDisclosure::AIGenerated?
+
+      def ai_generated=: (
+        XTwitterScraper::ContentDisclosure::AIGenerated
+      ) -> XTwitterScraper::ContentDisclosure::AIGenerated
+
+      def initialize: (
+        ?advertising: XTwitterScraper::ContentDisclosure::Advertising,
+        ?ai_generated: XTwitterScraper::ContentDisclosure::AIGenerated
+      ) -> void
+
+      def to_hash: -> {
+        advertising: XTwitterScraper::ContentDisclosure::Advertising,
+        ai_generated: XTwitterScraper::ContentDisclosure::AIGenerated
+      }
+
+      type advertising = { is_paid_promotion: bool }
+
+      class Advertising < XTwitterScraper::Internal::Type::BaseModel
+        attr_reader is_paid_promotion: bool?
+
+        def is_paid_promotion=: (bool) -> bool
+
+        def initialize: (?is_paid_promotion: bool) -> void
+
+        def to_hash: -> { is_paid_promotion: bool }
+      end
+
+      type ai_generated =
+        {
+          can_edit: bool,
+          detection_source: String,
+          has_ai_generated_media: bool
+        }
+
+      class AIGenerated < XTwitterScraper::Internal::Type::BaseModel
+        attr_reader can_edit: bool?
+
+        def can_edit=: (bool) -> bool
+
+        attr_reader detection_source: String?
+
+        def detection_source=: (String) -> String
+
+        attr_reader has_ai_generated_media: bool?
+
+        def has_ai_generated_media=: (bool) -> bool
+
+        def initialize: (
+          ?can_edit: bool,
+          ?detection_source: String,
+          ?has_ai_generated_media: bool
+        ) -> void
+
+        def to_hash: -> {
+          can_edit: bool,
+          detection_source: String,
+          has_ai_generated_media: bool
+        }
+      end
+    end
+  end
+end

data/sig/x_twitter_scraper/models/{api_key_create_params.rbs → credit_redirect_topup_checkout_params.rbs}

@@ -1,23 +1,22 @@
 module XTwitterScraper
   module Models
-    type api_key_create_params =
-      { name: String } & XTwitterScraper::Internal::Type::request_parameters
+    type credit_redirect_topup_checkout_params =
+      { session_id: String }
+      & XTwitterScraper::Internal::Type::request_parameters
 
-    class APIKeyCreateParams < XTwitterScraper::Internal::Type::BaseModel
+    class CreditRedirectTopupCheckoutParams < XTwitterScraper::Internal::Type::BaseModel
       extend XTwitterScraper::Internal::Type::RequestParameters::Converter
       include XTwitterScraper::Internal::Type::RequestParameters
 
-      attr_reader name: String?
-
-      def name=: (String) -> String
+      attr_accessor session_id: String
 
       def initialize: (
-        ?name: String,
+        session_id: String,
         ?request_options: XTwitterScraper::request_opts
       ) -> void
 
       def to_hash: -> {
-        name: String,
+        session_id: String,
         request_options: XTwitterScraper::RequestOptions
       }
     end

data/sig/x_twitter_scraper/models/credit_retrieve_balance_response.rbs

@@ -2,33 +2,43 @@ module XTwitterScraper
   module Models
     type credit_retrieve_balance_response =
       {
+        auto_topup_amount_dollars: Float,
         auto_topup_enabled: bool,
-        balance: Integer,
-        lifetime_purchased: Integer,
-        lifetime_used: Integer
+        auto_topup_threshold: String,
+        balance: String,
+        lifetime_purchased: String,
+        lifetime_used: String
       }
 
     class CreditRetrieveBalanceResponse < XTwitterScraper::Internal::Type::BaseModel
+      attr_accessor auto_topup_amount_dollars: Float
+
       attr_accessor auto_topup_enabled: bool
 
-      attr_accessor balance: Integer
+      attr_accessor auto_topup_threshold: String
+
+      attr_accessor balance: String
 
-      attr_accessor lifetime_purchased: Integer
+      attr_accessor lifetime_purchased: String
 
-      attr_accessor lifetime_used: Integer
+      attr_accessor lifetime_used: String
 
       def initialize: (
+        auto_topup_amount_dollars: Float,
         auto_topup_enabled: bool,
-        balance: Integer,
-        lifetime_purchased: Integer,
-        lifetime_used: Integer
+        auto_topup_threshold: String,
+        balance: String,
+        lifetime_purchased: String,
+        lifetime_used: String
       ) -> void
 
       def to_hash: -> {
+        auto_topup_amount_dollars: Float,
         auto_topup_enabled: bool,
-        balance: Integer,
-        lifetime_purchased: Integer,
-        lifetime_used: Integer
+        auto_topup_threshold: String,
+        balance: String,
+        lifetime_purchased: String,
+        lifetime_used: String
       }
     end
   end

data/sig/x_twitter_scraper/models/{integration_list_deliveries_params.rbs → credit_retrieve_topup_status_params.rbs}

@@ -1,28 +1,22 @@
 module XTwitterScraper
   module Models
-    type integration_list_deliveries_params =
-      { id: String, limit: Integer }
+    type credit_retrieve_topup_status_params =
+      { session_id: String }
       & XTwitterScraper::Internal::Type::request_parameters
 
-    class IntegrationListDeliveriesParams < XTwitterScraper::Internal::Type::BaseModel
+    class CreditRetrieveTopupStatusParams < XTwitterScraper::Internal::Type::BaseModel
       extend XTwitterScraper::Internal::Type::RequestParameters::Converter
       include XTwitterScraper::Internal::Type::RequestParameters
 
-      attr_accessor id: String
-
-      attr_reader limit: Integer?
-
-      def limit=: (Integer) -> Integer
+      attr_accessor session_id: String
 
       def initialize: (
-        id: String,
-        ?limit: Integer,
+        session_id: String,
         ?request_options: XTwitterScraper::request_opts
       ) -> void
 
       def to_hash: -> {
-        id: String,
-        limit: Integer,
+        session_id: String,
         request_options: XTwitterScraper::RequestOptions
       }
     end

data/sig/x_twitter_scraper/models/credit_retrieve_topup_status_response.rbs

@@ -0,0 +1,45 @@
+module XTwitterScraper
+  module Models
+    type credit_retrieve_topup_status_response =
+      {
+        status: XTwitterScraper::Models::CreditRetrieveTopupStatusResponse::status,
+        amount_dollars: Integer?,
+        credits: String
+      }
+
+    class CreditRetrieveTopupStatusResponse < XTwitterScraper::Internal::Type::BaseModel
+      attr_accessor status: XTwitterScraper::Models::CreditRetrieveTopupStatusResponse::status
+
+      attr_accessor amount_dollars: Integer?
+
+      attr_reader credits: String?
+
+      def credits=: (String) -> String
+
+      def initialize: (
+        status: XTwitterScraper::Models::CreditRetrieveTopupStatusResponse::status,
+        ?amount_dollars: Integer?,
+        ?credits: String
+      ) -> void
+
+      def to_hash: -> {
+        status: XTwitterScraper::Models::CreditRetrieveTopupStatusResponse::status,
+        amount_dollars: Integer?,
+        credits: String
+      }
+
+      type status = :paid | :processing | :failed | :expired
+
+      module Status
+        extend XTwitterScraper::Internal::Type::Enum
+
+        PAID: :paid
+        PROCESSING: :processing
+        FAILED: :failed
+        EXPIRED: :expired
+
+        def self?.values: -> ::Array[XTwitterScraper::Models::CreditRetrieveTopupStatusResponse::status]
+      end
+    end
+  end
+end

data/sig/x_twitter_scraper/models/credit_topup_balance_params.rbs

@@ -1,21 +1,28 @@
 module XTwitterScraper
   module Models
     type credit_topup_balance_params =
-      { amount: Integer } & XTwitterScraper::Internal::Type::request_parameters
+      { dollars: Integer, locale: String }
+      & XTwitterScraper::Internal::Type::request_parameters
 
     class CreditTopupBalanceParams < XTwitterScraper::Internal::Type::BaseModel
       extend XTwitterScraper::Internal::Type::RequestParameters::Converter
       include XTwitterScraper::Internal::Type::RequestParameters
 
-      attr_accessor amount: Integer
+      attr_accessor dollars: Integer
+
+      attr_reader locale: String?
+
+      def locale=: (String) -> String
 
       def initialize: (
-        amount: Integer,
+        dollars: Integer,
+        ?locale: String,
         ?request_options: XTwitterScraper::request_opts
       ) -> void
 
       def to_hash: -> {
-        amount: Integer,
+        dollars: Integer,
+        locale: String,
         request_options: XTwitterScraper::RequestOptions
       }
     end

data/sig/x_twitter_scraper/models/credit_topup_balance_response.rbs

@@ -1,13 +1,15 @@
 module XTwitterScraper
   module Models
-    type credit_topup_balance_response = { success: true }
+    type credit_topup_balance_response = { redirect_url: String, url: String }
 
     class CreditTopupBalanceResponse < XTwitterScraper::Internal::Type::BaseModel
-      attr_accessor success: true
+      attr_accessor redirect_url: String
 
-      def initialize: (?success: true) -> void
+      attr_accessor url: String
 
-      def to_hash: -> { success: true }
+      def initialize: (redirect_url: String, url: String) -> void
+
+      def to_hash: -> { redirect_url: String, url: String }
     end
   end
 end

data/sig/x_twitter_scraper/models/draw_export_params.rbs

@@ -14,11 +14,7 @@ module XTwitterScraper
 
       attr_accessor id: String
 
-      attr_reader format_: XTwitterScraper::Models::DrawExportParams::format_?
-
-      def format_=: (
-        XTwitterScraper::Models::DrawExportParams::format_
-      ) -> XTwitterScraper::Models::DrawExportParams::format_
+      attr_accessor format_: XTwitterScraper::Models::DrawExportParams::format_
 
       attr_reader type: XTwitterScraper::Models::DrawExportParams::type_?
 
@@ -28,7 +24,7 @@ module XTwitterScraper
 
       def initialize: (
         id: String,
-        ?format_: XTwitterScraper::Models::DrawExportParams::format_,
+        format_: XTwitterScraper::Models::DrawExportParams::format_,
         ?type: XTwitterScraper::Models::DrawExportParams::type_,
         ?request_options: XTwitterScraper::request_opts
       ) -> void