x-twitter-scraper 0.3.0

data/rbi/x_twitter_scraper/resources/support/tickets.rbi

@@ -0,0 +1,70 @@
+# typed: strong
+
+module XTwitterScraper
+  module Resources
+    class Support
+      # Support ticket management
+      class Tickets
+        # Create a support ticket
+        sig do
+          params(
+            body: String,
+            subject: String,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(XTwitterScraper::Models::Support::TicketCreateResponse)
+        end
+        def create(body:, subject:, request_options: {})
+        end
+
+        # Get ticket with all messages
+        sig do
+          params(
+            id: String,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(XTwitterScraper::Models::Support::TicketRetrieveResponse)
+        end
+        def retrieve(id, request_options: {})
+        end
+
+        # Update ticket status
+        sig do
+          params(
+            id: String,
+            status:
+              XTwitterScraper::Support::TicketUpdateParams::Status::OrSymbol,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(XTwitterScraper::Models::Support::TicketUpdateResponse)
+        end
+        def update(id, status:, request_options: {})
+        end
+
+        # List user's support tickets
+        sig do
+          params(
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(XTwitterScraper::Models::Support::TicketListResponse)
+        end
+        def list(request_options: {})
+        end
+
+        # Reply to a support ticket
+        sig do
+          params(
+            id: String,
+            body: String,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(XTwitterScraper::Models::Support::TicketReplyResponse)
+        end
+        def reply(id, body:, 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/support.rbi

@@ -0,0 +1,16 @@
+# typed: strong
+
+module XTwitterScraper
+  module Resources
+    class Support
+      # Support ticket management
+      sig { returns(XTwitterScraper::Resources::Support::Tickets) }
+      attr_reader :tickets
+
+      # @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/trends.rbi

@@ -0,0 +1,29 @@
+# typed: strong
+
+module XTwitterScraper
+  module Resources
+    # Trending topics by region
+    class Trends
+      # Get trending topics
+      sig do
+        params(
+          count: Integer,
+          woeid: Integer,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::TrendListResponse)
+      end
+      def list(
+        count: nil,
+        # Region WOEID (1=Worldwide, 23424977=US, 23424975=UK, 23424969=Turkey)
+        woeid: 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/webhooks.rbi

@@ -0,0 +1,102 @@
+# typed: strong
+
+module XTwitterScraper
+  module Resources
+    # Webhook endpoint management & delivery
+    class Webhooks
+      # Create webhook
+      sig do
+        params(
+          event_types:
+            T::Array[XTwitterScraper::WebhookCreateParams::EventType::OrSymbol],
+          url: String,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::WebhookCreateResponse)
+      end
+      def create(
+        event_types:,
+        # HTTPS URL
+        url:,
+        request_options: {}
+      )
+      end
+
+      # Update webhook
+      sig do
+        params(
+          id: String,
+          event_types:
+            T::Array[XTwitterScraper::WebhookUpdateParams::EventType::OrSymbol],
+          is_active: T::Boolean,
+          url: String,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::WebhookUpdateResponse)
+      end
+      def update(
+        # Resource ID (stringified bigint)
+        id,
+        event_types: nil,
+        is_active: nil,
+        url: nil,
+        request_options: {}
+      )
+      end
+
+      # List webhooks
+      sig do
+        params(
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::WebhookListResponse)
+      end
+      def list(request_options: {})
+      end
+
+      # Deactivate webhook
+      sig do
+        params(
+          id: String,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::WebhookDeactivateResponse)
+      end
+      def deactivate(
+        # Resource ID (stringified bigint)
+        id,
+        request_options: {}
+      )
+      end
+
+      # List webhook deliveries
+      sig do
+        params(
+          id: String,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::WebhookListDeliveriesResponse)
+      end
+      def list_deliveries(
+        # Resource ID (stringified bigint)
+        id,
+        request_options: {}
+      )
+      end
+
+      # Test webhook endpoint
+      sig do
+        params(
+          id: String,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::WebhookTestResponse)
+      end
+      def 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/x/accounts.rbi

@@ -0,0 +1,100 @@
+# typed: strong
+
+module XTwitterScraper
+  module Resources
+    class X
+      # Connected X account management
+      class Accounts
+        # Connect X account
+        sig do
+          params(
+            email: String,
+            password: String,
+            username: String,
+            proxy_country: String,
+            totp_secret: String,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(XTwitterScraper::Models::X::AccountCreateResponse)
+        end
+        def create(
+          # Account email
+          email:,
+          # Account password
+          password:,
+          # X username
+          username:,
+          # Proxy country code
+          proxy_country: nil,
+          # TOTP secret for 2FA
+          totp_secret: nil,
+          request_options: {}
+        )
+        end
+
+        # Get X account details
+        sig do
+          params(
+            id: String,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(XTwitterScraper::Models::X::AccountRetrieveResponse)
+        end
+        def retrieve(
+          # Resource ID (stringified bigint)
+          id,
+          request_options: {}
+        )
+        end
+
+        # List connected X accounts
+        sig do
+          params(
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(XTwitterScraper::Models::X::AccountListResponse)
+        end
+        def list(request_options: {})
+        end
+
+        # Disconnect X account
+        sig do
+          params(
+            id: String,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(XTwitterScraper::Models::X::AccountDeleteResponse)
+        end
+        def delete(
+          # Resource ID (stringified bigint)
+          id,
+          request_options: {}
+        )
+        end
+
+        # Re-authenticate X account
+        sig do
+          params(
+            id: String,
+            password: String,
+            totp_secret: String,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(XTwitterScraper::Models::X::AccountReauthResponse)
+        end
+        def reauth(
+          # Resource ID (stringified bigint)
+          id,
+          # Account password
+          password:,
+          # TOTP secret for 2FA
+          totp_secret: nil,
+          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/bookmarks.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module XTwitterScraper
+  module Resources
+    class X
+      # X data lookups (subscription required)
+      class Bookmarks
+        # Get bookmarked tweets
+        sig do
+          params(
+            cursor: String,
+            folder_id: String,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(XTwitterScraper::Models::X::BookmarkListResponse)
+        end
+        def list(
+          # Pagination cursor from previous response
+          cursor: nil,
+          # Optional bookmark folder ID
+          folder_id: nil,
+          request_options: {}
+        )
+        end
+
+        # Get bookmark folders
+        sig do
+          params(
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(XTwitterScraper::Models::X::BookmarkRetrieveFoldersResponse)
+        end
+        def retrieve_folders(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/communities/join.rbi

@@ -0,0 +1,57 @@
+# typed: strong
+
+module XTwitterScraper
+  module Resources
+    class X
+      class Communities
+        # X write actions (tweets, likes, follows, DMs)
+        class Join
+          # Join community
+          sig do
+            params(
+              id: String,
+              account: String,
+              request_options: XTwitterScraper::RequestOptions::OrHash
+            ).returns(
+              XTwitterScraper::Models::X::Communities::JoinCreateResponse
+            )
+          end
+          def create(
+            # Resource ID (stringified bigint)
+            id,
+            # X account (@username or account ID)
+            account:,
+            request_options: {}
+          )
+          end
+
+          # Leave community
+          sig do
+            params(
+              id: String,
+              account: String,
+              request_options: XTwitterScraper::RequestOptions::OrHash
+            ).returns(
+              XTwitterScraper::Models::X::Communities::JoinDeleteAllResponse
+            )
+          end
+          def delete_all(
+            # Resource ID (stringified bigint)
+            id,
+            # X account (@username or account ID)
+            account:,
+            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
+end

data/rbi/x_twitter_scraper/resources/x/communities/tweets.rbi

@@ -0,0 +1,39 @@
+# typed: strong
+
+module XTwitterScraper
+  module Resources
+    class X
+      class Communities
+        # X data lookups (subscription required)
+        class Tweets
+          # Search tweets across all communities
+          sig do
+            params(
+              q: String,
+              cursor: String,
+              query_type: String,
+              request_options: XTwitterScraper::RequestOptions::OrHash
+            ).void
+          end
+          def list(
+            # Search query
+            q:,
+            # Pagination cursor
+            cursor: nil,
+            # Sort order (Latest or Top)
+            query_type: nil,
+            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
+end

data/rbi/x_twitter_scraper/resources/x/communities.rbi

@@ -0,0 +1,132 @@
+# typed: strong
+
+module XTwitterScraper
+  module Resources
+    class X
+      class Communities
+        # X write actions (tweets, likes, follows, DMs)
+        sig { returns(XTwitterScraper::Resources::X::Communities::Join) }
+        attr_reader :join
+
+        # X data lookups (subscription required)
+        sig { returns(XTwitterScraper::Resources::X::Communities::Tweets) }
+        attr_reader :tweets
+
+        # Create community
+        sig do
+          params(
+            account: String,
+            name: String,
+            description: String,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(XTwitterScraper::Models::X::CommunityCreateResponse)
+        end
+        def create(
+          # X account (@username or account ID)
+          account:,
+          # Community name
+          name:,
+          # Community description
+          description: nil,
+          request_options: {}
+        )
+        end
+
+        # Delete community
+        sig do
+          params(
+            id: String,
+            account: String,
+            community_name: String,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(XTwitterScraper::Models::X::CommunityDeleteResponse)
+        end
+        def delete(
+          # Resource ID (stringified bigint)
+          id,
+          # X account (@username or account ID)
+          account:,
+          # Community name for confirmation
+          community_name:,
+          request_options: {}
+        )
+        end
+
+        # Get community details
+        sig do
+          params(
+            id: String,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(XTwitterScraper::Models::X::CommunityRetrieveInfoResponse)
+        end
+        def retrieve_info(
+          # Community ID
+          id,
+          request_options: {}
+        )
+        end
+
+        # Get community members
+        sig do
+          params(
+            id: String,
+            cursor: String,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).void
+        end
+        def retrieve_members(
+          # Community ID
+          id,
+          # Pagination cursor
+          cursor: nil,
+          request_options: {}
+        )
+        end
+
+        # Get community moderators
+        sig do
+          params(
+            id: String,
+            cursor: String,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).void
+        end
+        def retrieve_moderators(
+          # Community ID
+          id,
+          # Pagination cursor
+          cursor: nil,
+          request_options: {}
+        )
+        end
+
+        # Search tweets across communities
+        sig do
+          params(
+            q: String,
+            cursor: String,
+            query_type: String,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).void
+        end
+        def retrieve_search(
+          # Search query
+          q:,
+          # Pagination cursor
+          cursor: nil,
+          # Sort order (Latest or Top)
+          query_type: nil,
+          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/dm.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module XTwitterScraper
+  module Resources
+    class X
+      class Dm
+        # Get DM conversation history
+        sig do
+          params(
+            user_id: String,
+            cursor: String,
+            max_id: String,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(XTwitterScraper::Models::X::DmRetrieveHistoryResponse)
+        end
+        def retrieve_history(
+          # Target user ID
+          user_id,
+          # Pagination cursor from previous response
+          cursor: nil,
+          # Legacy pagination cursor (backward compat)
+          max_id: nil,
+          request_options: {}
+        )
+        end
+
+        # Send direct message
+        sig do
+          params(
+            user_id: String,
+            account: String,
+            text: String,
+            media_ids: T::Array[String],
+            reply_to_message_id: String,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(XTwitterScraper::Models::X::DmSendResponse)
+        end
+        def send_(
+          # Recipient user ID
+          user_id,
+          # X account (@username or account ID)
+          account:,
+          text:,
+          media_ids: nil,
+          reply_to_message_id: nil,
+          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/followers.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module XTwitterScraper
+  module Resources
+    class X
+      # X data lookups (subscription required)
+      class Followers
+        # Check follow relationship
+        sig do
+          params(
+            source: String,
+            target: String,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(XTwitterScraper::Models::X::FollowerCheckResponse)
+        end
+        def check(
+          # Username to check (without @)
+          source:,
+          # Target username (without @)
+          target:,
+          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