x-twitter-scraper 0.3.0

data/rbi/x_twitter_scraper/resources/draws.rbi

@@ -0,0 +1,97 @@
+# typed: strong
+
+module XTwitterScraper
+  module Resources
+    # Giveaway draws from tweet replies
+    class Draws
+      # Get draw details
+      sig do
+        params(
+          id: String,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::DrawRetrieveResponse)
+      end
+      def retrieve(
+        # Resource ID (stringified bigint)
+        id,
+        request_options: {}
+      )
+      end
+
+      # List draws
+      sig do
+        params(
+          after: String,
+          limit: Integer,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::DrawListResponse)
+      end
+      def list(
+        # Cursor for pagination
+        after: nil,
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      # Export draw data
+      sig do
+        params(
+          id: String,
+          format_: XTwitterScraper::DrawExportParams::Format::OrSymbol,
+          type: XTwitterScraper::DrawExportParams::Type::OrSymbol,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(StringIO)
+      end
+      def export(
+        # Resource ID (stringified bigint)
+        id,
+        format_: nil,
+        # Export winners or all entries
+        type: nil,
+        request_options: {}
+      )
+      end
+
+      # Run giveaway draw
+      sig do
+        params(
+          tweet_url: String,
+          backup_count: Integer,
+          filter_account_age_days: Integer,
+          filter_language: String,
+          filter_min_followers: Integer,
+          must_follow_username: String,
+          must_retweet: T::Boolean,
+          required_hashtags: T::Array[String],
+          required_keywords: T::Array[String],
+          required_mentions: T::Array[String],
+          unique_authors_only: T::Boolean,
+          winner_count: Integer,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::DrawRunResponse)
+      end
+      def run(
+        tweet_url:,
+        backup_count: nil,
+        filter_account_age_days: nil,
+        filter_language: nil,
+        filter_min_followers: nil,
+        must_follow_username: nil,
+        must_retweet: nil,
+        required_hashtags: nil,
+        required_keywords: nil,
+        required_mentions: nil,
+        unique_authors_only: nil,
+        winner_count: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: XTwitterScraper::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/resources/events.rbi

@@ -0,0 +1,47 @@
+# typed: strong
+
+module XTwitterScraper
+  module Resources
+    # Activity events from monitored accounts
+    class Events
+      # Get event
+      sig do
+        params(
+          id: String,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::EventRetrieveResponse)
+      end
+      def retrieve(
+        # Resource ID (stringified bigint)
+        id,
+        request_options: {}
+      )
+      end
+
+      # List events
+      sig do
+        params(
+          after: String,
+          event_type: XTwitterScraper::EventListParams::EventType::OrSymbol,
+          limit: Integer,
+          monitor_id: String,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::EventListResponse)
+      end
+      def list(
+        # Cursor for pagination
+        after: nil,
+        event_type: nil,
+        limit: nil,
+        monitor_id: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: XTwitterScraper::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/resources/extractions.rbi

@@ -0,0 +1,138 @@
+# typed: strong
+
+module XTwitterScraper
+  module Resources
+    # Bulk data extraction (20 tool types)
+    class Extractions
+      # Get extraction results
+      sig do
+        params(
+          id: String,
+          after: String,
+          limit: Integer,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::ExtractionRetrieveResponse)
+      end
+      def retrieve(
+        # Extraction public ID (UUID)
+        id,
+        # Cursor for pagination
+        after: nil,
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      # List extraction jobs
+      sig do
+        params(
+          after: String,
+          limit: Integer,
+          status: XTwitterScraper::ExtractionListParams::Status::OrSymbol,
+          tool_type: XTwitterScraper::ExtractionListParams::ToolType::OrSymbol,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::ExtractionListResponse)
+      end
+      def list(
+        # Cursor for pagination
+        after: nil,
+        limit: nil,
+        status: nil,
+        tool_type: nil,
+        request_options: {}
+      )
+      end
+
+      # Estimate extraction cost
+      sig do
+        params(
+          tool_type:
+            XTwitterScraper::ExtractionEstimateCostParams::ToolType::OrSymbol,
+          advanced_query: String,
+          exact_phrase: String,
+          exclude_words: String,
+          search_query: String,
+          target_community_id: String,
+          target_list_id: String,
+          target_space_id: String,
+          target_tweet_id: String,
+          target_username: String,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::ExtractionEstimateCostResponse)
+      end
+      def estimate_cost(
+        tool_type:,
+        # Raw advanced search query appended as-is (tweet_search_extractor)
+        advanced_query: nil,
+        # Exact phrase to match (tweet_search_extractor)
+        exact_phrase: nil,
+        # Words to exclude from results (tweet_search_extractor)
+        exclude_words: nil,
+        search_query: nil,
+        target_community_id: nil,
+        target_list_id: nil,
+        target_space_id: nil,
+        target_tweet_id: nil,
+        target_username: nil,
+        request_options: {}
+      )
+      end
+
+      # Export extraction results
+      sig do
+        params(
+          id: String,
+          format_:
+            XTwitterScraper::ExtractionExportResultsParams::Format::OrSymbol,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(StringIO)
+      end
+      def export_results(
+        # Extraction public ID
+        id,
+        format_: nil,
+        request_options: {}
+      )
+      end
+
+      # Run extraction
+      sig do
+        params(
+          tool_type: XTwitterScraper::ExtractionRunParams::ToolType::OrSymbol,
+          advanced_query: String,
+          exact_phrase: String,
+          exclude_words: String,
+          search_query: String,
+          target_community_id: String,
+          target_list_id: String,
+          target_space_id: String,
+          target_tweet_id: String,
+          target_username: String,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::ExtractionRunResponse)
+      end
+      def run(
+        tool_type:,
+        # Raw advanced search query appended as-is (tweet_search_extractor)
+        advanced_query: nil,
+        # Exact phrase to match (tweet_search_extractor)
+        exact_phrase: nil,
+        # Words to exclude from results (tweet_search_extractor)
+        exclude_words: nil,
+        search_query: nil,
+        target_community_id: nil,
+        target_list_id: nil,
+        target_space_id: nil,
+        target_tweet_id: nil,
+        target_username: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: XTwitterScraper::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/resources/integrations.rbi

@@ -0,0 +1,136 @@
+# typed: strong
+
+module XTwitterScraper
+  module Resources
+    # Push notification integrations (Telegram)
+    class Integrations
+      # Create integration
+      sig do
+        params(
+          config: XTwitterScraper::IntegrationCreateParams::Config::OrHash,
+          event_types:
+            T::Array[
+              XTwitterScraper::IntegrationCreateParams::EventType::OrSymbol
+            ],
+          name: String,
+          type: XTwitterScraper::IntegrationCreateParams::Type::OrSymbol,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::IntegrationCreateResponse)
+      end
+      def create(
+        # Integration config (e.g. Telegram chatId)
+        config:,
+        event_types:,
+        name:,
+        type:,
+        request_options: {}
+      )
+      end
+
+      # Get integration details
+      sig do
+        params(
+          id: String,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::IntegrationRetrieveResponse)
+      end
+      def retrieve(
+        # Resource ID (stringified bigint)
+        id,
+        request_options: {}
+      )
+      end
+
+      # Update integration
+      sig do
+        params(
+          id: String,
+          event_types:
+            T::Array[
+              XTwitterScraper::IntegrationUpdateParams::EventType::OrSymbol
+            ],
+          filters: T::Hash[Symbol, T.anything],
+          is_active: T::Boolean,
+          message_template: T::Hash[Symbol, T.anything],
+          name: String,
+          scope_all_monitors: T::Boolean,
+          silent_push: T::Boolean,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::IntegrationUpdateResponse)
+      end
+      def update(
+        # Resource ID (stringified bigint)
+        id,
+        event_types: nil,
+        # Event filter rules (JSON)
+        filters: nil,
+        is_active: nil,
+        # Custom message template (JSON)
+        message_template: nil,
+        name: nil,
+        scope_all_monitors: nil,
+        silent_push: nil,
+        request_options: {}
+      )
+      end
+
+      # List integrations
+      sig do
+        params(
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::IntegrationListResponse)
+      end
+      def list(request_options: {})
+      end
+
+      # Delete integration
+      sig do
+        params(
+          id: String,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::IntegrationDeleteResponse)
+      end
+      def delete(
+        # Resource ID (stringified bigint)
+        id,
+        request_options: {}
+      )
+      end
+
+      # List integration delivery history
+      sig do
+        params(
+          id: String,
+          limit: Integer,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::IntegrationListDeliveriesResponse)
+      end
+      def list_deliveries(
+        # Resource ID (stringified bigint)
+        id,
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      # Send test delivery
+      sig do
+        params(
+          id: String,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::IntegrationSendTestResponse)
+      end
+      def send_test(
+        # Resource ID (stringified bigint)
+        id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: XTwitterScraper::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/resources/monitors.rbi

@@ -0,0 +1,86 @@
+# typed: strong
+
+module XTwitterScraper
+  module Resources
+    # Real-time X account monitoring
+    class Monitors
+      # Create monitor
+      sig do
+        params(
+          event_types:
+            T::Array[XTwitterScraper::MonitorCreateParams::EventType::OrSymbol],
+          username: String,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::MonitorCreateResponse)
+      end
+      def create(
+        event_types:,
+        # X username (without @)
+        username:,
+        request_options: {}
+      )
+      end
+
+      # Get monitor
+      sig do
+        params(
+          id: String,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::MonitorRetrieveResponse)
+      end
+      def retrieve(
+        # Resource ID (stringified bigint)
+        id,
+        request_options: {}
+      )
+      end
+
+      # Update monitor
+      sig do
+        params(
+          id: String,
+          event_types:
+            T::Array[XTwitterScraper::MonitorUpdateParams::EventType::OrSymbol],
+          is_active: T::Boolean,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::MonitorUpdateResponse)
+      end
+      def update(
+        # Resource ID (stringified bigint)
+        id,
+        event_types: nil,
+        is_active: nil,
+        request_options: {}
+      )
+      end
+
+      # List monitors
+      sig do
+        params(
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::MonitorListResponse)
+      end
+      def list(request_options: {})
+      end
+
+      # Deactivate monitor
+      sig do
+        params(
+          id: String,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::MonitorDeactivateResponse)
+      end
+      def deactivate(
+        # Resource ID (stringified bigint)
+        id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: XTwitterScraper::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/resources/radar.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module XTwitterScraper
+  module Resources
+    # Tweet composition, drafts, writing styles & radar
+    class Radar
+      # Get trending topics from curated sources
+      sig do
+        params(
+          category: String,
+          count: Integer,
+          hours: Integer,
+          region: String,
+          source: String,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::RadarRetrieveTrendingTopicsResponse)
+      end
+      def retrieve_trending_topics(
+        # Filter by category (general, tech, dev, etc.)
+        category: nil,
+        # Number of items to return
+        count: nil,
+        # Lookback window in hours
+        hours: nil,
+        # Region filter (us, global, etc.)
+        region: nil,
+        # Source filter. One of: github, google_trends, hacker_news, polymarket, reddit,
+        # trustmrr, wikipedia
+        source: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: XTwitterScraper::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/resources/styles.rbi

@@ -0,0 +1,115 @@
+# typed: strong
+
+module XTwitterScraper
+  module Resources
+    # Tweet composition, drafts, writing styles & radar
+    class Styles
+      # Get cached style profile
+      sig do
+        params(
+          username: String,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::StyleRetrieveResponse)
+      end
+      def retrieve(
+        # X username of cached style
+        username,
+        request_options: {}
+      )
+      end
+
+      # Save style profile with custom tweets
+      sig do
+        params(
+          username: String,
+          label: String,
+          tweets: T::Array[XTwitterScraper::StyleUpdateParams::Tweet::OrHash],
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::StyleUpdateResponse)
+      end
+      def update(
+        # X username of cached style
+        username,
+        # Display label for the style
+        label:,
+        # Array of tweet objects
+        tweets:,
+        request_options: {}
+      )
+      end
+
+      # List cached style profiles
+      sig do
+        params(
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::StyleListResponse)
+      end
+      def list(request_options: {})
+      end
+
+      # Delete a style profile
+      sig do
+        params(
+          username: String,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).void
+      end
+      def delete(
+        # X username of cached style
+        username,
+        request_options: {}
+      )
+      end
+
+      # Analyze writing style from recent tweets
+      sig do
+        params(
+          username: String,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::StyleAnalyzeResponse)
+      end
+      def analyze(
+        # X username to analyze
+        username:,
+        request_options: {}
+      )
+      end
+
+      # Compare two style profiles
+      sig do
+        params(
+          username1: String,
+          username2: String,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::StyleCompareResponse)
+      end
+      def compare(
+        # First username to compare
+        username1:,
+        # Second username to compare
+        username2:,
+        request_options: {}
+      )
+      end
+
+      # Get engagement metrics for style tweets
+      sig do
+        params(
+          username: String,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::StyleGetPerformanceResponse)
+      end
+      def get_performance(
+        # X username of cached style
+        username,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: XTwitterScraper::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/resources/subscribe.rbi

@@ -0,0 +1,22 @@
+# typed: strong
+
+module XTwitterScraper
+  module Resources
+    # Subscription & billing
+    class Subscribe
+      # Get checkout or billing URL
+      sig do
+        params(
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::SubscribeCreateResponse)
+      end
+      def create(request_options: {})
+      end
+
+      # @api private
+      sig { params(client: XTwitterScraper::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end