x-twitter-scraper 0.4.2 → 0.4.4

data/rbi/x_twitter_scraper/models/x/communities/tweet_list_params.rbi

@@ -16,38 +16,75 @@ module XTwitterScraper
               )
             end
 
-          # Search query for cross-community tweets
+          # Numeric ID of the community to search
+          sig { returns(String) }
+          attr_accessor :community_id
+
+          # Keyword query within the selected community
           sig { returns(String) }
           attr_accessor :q
 
-          # Pagination cursor for cross-community results
+          # Pagination cursor for community results
           sig { returns(T.nilable(String)) }
           attr_reader :cursor
 
           sig { params(cursor: String).void }
           attr_writer :cursor
 
-          # Sort order for cross-community results (Latest or Top)
-          sig { returns(T.nilable(String)) }
+          # Maximum items requested from this page (1-100, default 20). The response can
+          # contain fewer items because the source returned fewer, filters removed items, or
+          # remaining credits cover fewer results. Keep requesting next_cursor while
+          # has_next_page is true, even when a page is empty. The deprecated limit and count
+          # aliases remain accepted.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :page_size
+
+          sig { params(page_size: Integer).void }
+          attr_writer :page_size
+
+          # Sort order for community results (Latest or Top)
+          sig do
+            returns(
+              T.nilable(
+                XTwitterScraper::X::Communities::TweetListParams::QueryType::OrSymbol
+              )
+            )
+          end
           attr_reader :query_type
 
-          sig { params(query_type: String).void }
+          sig do
+            params(
+              query_type:
+                XTwitterScraper::X::Communities::TweetListParams::QueryType::OrSymbol
+            ).void
+          end
           attr_writer :query_type
 
           sig do
             params(
+              community_id: String,
               q: String,
               cursor: String,
-              query_type: String,
+              page_size: Integer,
+              query_type:
+                XTwitterScraper::X::Communities::TweetListParams::QueryType::OrSymbol,
               request_options: XTwitterScraper::RequestOptions::OrHash
             ).returns(T.attached_class)
           end
           def self.new(
-            # Search query for cross-community tweets
+            # Numeric ID of the community to search
+            community_id:,
+            # Keyword query within the selected community
             q:,
-            # Pagination cursor for cross-community results
+            # Pagination cursor for community results
             cursor: nil,
-            # Sort order for cross-community results (Latest or Top)
+            # Maximum items requested from this page (1-100, default 20). The response can
+            # contain fewer items because the source returned fewer, filters removed items, or
+            # remaining credits cover fewer results. Keep requesting next_cursor while
+            # has_next_page is true, even when a page is empty. The deprecated limit and count
+            # aliases remain accepted.
+            page_size: nil,
+            # Sort order for community results (Latest or Top)
             query_type: nil,
             request_options: {}
           )
@@ -56,15 +93,53 @@ module XTwitterScraper
           sig do
             override.returns(
               {
+                community_id: String,
                 q: String,
                 cursor: String,
-                query_type: String,
+                page_size: Integer,
+                query_type:
+                  XTwitterScraper::X::Communities::TweetListParams::QueryType::OrSymbol,
                 request_options: XTwitterScraper::RequestOptions
               }
             )
           end
           def to_hash
           end
+
+          # Sort order for community results (Latest or Top)
+          module QueryType
+            extend XTwitterScraper::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  XTwitterScraper::X::Communities::TweetListParams::QueryType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            LATEST =
+              T.let(
+                :Latest,
+                XTwitterScraper::X::Communities::TweetListParams::QueryType::TaggedSymbol
+              )
+            TOP =
+              T.let(
+                :Top,
+                XTwitterScraper::X::Communities::TweetListParams::QueryType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  XTwitterScraper::X::Communities::TweetListParams::QueryType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
         end
       end
     end

data/rbi/x_twitter_scraper/models/x/community_retrieve_info_response.rbi

@@ -78,6 +78,23 @@ module XTwitterScraper
           sig { params(created_at: String).void }
           attr_writer :created_at
 
+          sig do
+            returns(
+              T.nilable(
+                XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::Creator
+              )
+            )
+          end
+          attr_reader :creator
+
+          sig do
+            params(
+              creator:
+                XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::Creator::OrHash
+            ).void
+          end
+          attr_writer :creator
+
           # About text for the community
           sig { returns(T.nilable(String)) }
           attr_reader :description
@@ -85,6 +102,27 @@ module XTwitterScraper
           sig { params(description: String).void }
           attr_writer :description
 
+          # Invitation policy
+          sig { returns(T.nilable(String)) }
+          attr_reader :invites_policy
+
+          sig { params(invites_policy: String).void }
+          attr_writer :invites_policy
+
+          # Whether the authenticated viewer is a member
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :is_member
+
+          sig { params(is_member: T::Boolean).void }
+          attr_writer :is_member
+
+          # Whether the community is marked sensitive
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :is_nsfw
+
+          sig { params(is_nsfw: T::Boolean).void }
+          attr_writer :is_nsfw
+
           # Join policy (open or restricted)
           sig { returns(T.nilable(String)) }
           attr_reader :join_policy
@@ -131,6 +169,13 @@ module XTwitterScraper
           end
           attr_writer :primary_topic
 
+          # Authenticated viewer's community role
+          sig { returns(T.nilable(String)) }
+          attr_reader :role
+
+          sig { params(role: String).void }
+          attr_writer :role
+
           # Community rules
           sig do
             returns(
@@ -159,13 +204,19 @@ module XTwitterScraper
               id: String,
               banner_url: String,
               created_at: String,
+              creator:
+                XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::Creator::OrHash,
               description: String,
+              invites_policy: String,
+              is_member: T::Boolean,
+              is_nsfw: T::Boolean,
               join_policy: String,
               member_count: Integer,
               moderator_count: Integer,
               name: String,
               primary_topic:
                 XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::PrimaryTopic::OrHash,
+              role: String,
               rules:
                 T::Array[
                   XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::Rule::OrHash
@@ -179,8 +230,15 @@ module XTwitterScraper
             banner_url: nil,
             # Community creation timestamp
             created_at: nil,
+            creator: nil,
             # About text for the community
             description: nil,
+            # Invitation policy
+            invites_policy: nil,
+            # Whether the authenticated viewer is a member
+            is_member: nil,
+            # Whether the community is marked sensitive
+            is_nsfw: nil,
             # Join policy (open or restricted)
             join_policy: nil,
             # Total member count
@@ -191,6 +249,8 @@ module XTwitterScraper
             name: nil,
             # Primary topic
             primary_topic: nil,
+            # Authenticated viewer's community role
+            role: nil,
             # Community rules
             rules: nil
           )
@@ -202,13 +262,19 @@ module XTwitterScraper
                 id: String,
                 banner_url: String,
                 created_at: String,
+                creator:
+                  XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::Creator,
                 description: String,
+                invites_policy: String,
+                is_member: T::Boolean,
+                is_nsfw: T::Boolean,
                 join_policy: String,
                 member_count: Integer,
                 moderator_count: Integer,
                 name: String,
                 primary_topic:
                   XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::PrimaryTopic,
+                role: String,
                 rules:
                   T::Array[
                     XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::Rule
@@ -219,6 +285,55 @@ module XTwitterScraper
           def to_hash
           end
 
+          class Creator < XTwitterScraper::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::Creator,
+                  XTwitterScraper::Internal::AnyHash
+                )
+              end
+
+            sig { returns(String) }
+            attr_accessor :id
+
+            sig { returns(String) }
+            attr_accessor :username
+
+            sig { returns(T::Boolean) }
+            attr_accessor :verified
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :name
+
+            sig { params(name: String).void }
+            attr_writer :name
+
+            sig do
+              params(
+                id: String,
+                username: String,
+                verified: T::Boolean,
+                name: String
+              ).returns(T.attached_class)
+            end
+            def self.new(id:, username:, verified:, name: nil)
+            end
+
+            sig do
+              override.returns(
+                {
+                  id: String,
+                  username: String,
+                  verified: T::Boolean,
+                  name: String
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+
           class PrimaryTopic < XTwitterScraper::Internal::Type::BaseModel
             OrHash =
               T.type_alias do

data/rbi/x_twitter_scraper/models/x/community_retrieve_members_params.rbi

@@ -25,10 +25,20 @@ module XTwitterScraper
         sig { params(cursor: String).void }
         attr_writer :cursor
 
+        # Items per page (20-200, default 20). This is an upper bound for paid
+        # authenticated calls: remaining credits can reduce the returned page size, and
+        # zero affordable results returns 402 insufficient_credits.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_size
+
+        sig { params(page_size: Integer).void }
+        attr_writer :page_size
+
         sig do
           params(
             id: String,
             cursor: String,
+            page_size: Integer,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -36,6 +46,10 @@ module XTwitterScraper
           id:,
           # Pagination cursor
           cursor: nil,
+          # Items per page (20-200, default 20). This is an upper bound for paid
+          # authenticated calls: remaining credits can reduce the returned page size, and
+          # zero affordable results returns 402 insufficient_credits.
+          page_size: nil,
           request_options: {}
         )
         end
@@ -45,6 +59,7 @@ module XTwitterScraper
             {
               id: String,
               cursor: String,
+              page_size: Integer,
               request_options: XTwitterScraper::RequestOptions
             }
           )

data/rbi/x_twitter_scraper/models/x/community_retrieve_search_params.rbi

@@ -15,6 +15,10 @@ module XTwitterScraper
             )
           end
 
+        # Numeric ID of the community whose posts to search
+        sig { returns(String) }
+        attr_accessor :community_id
+
         # Search query
         sig { returns(String) }
         attr_accessor :q
@@ -26,26 +30,59 @@ module XTwitterScraper
         sig { params(cursor: String).void }
         attr_writer :cursor
 
+        # Maximum items requested from this page (1-100, default 20). The response can
+        # contain fewer items because the source returned fewer, filters removed items, or
+        # remaining credits cover fewer results. Keep requesting next_cursor while
+        # has_next_page is true, even when a page is empty. The deprecated limit and count
+        # aliases remain accepted.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_size
+
+        sig { params(page_size: Integer).void }
+        attr_writer :page_size
+
         # Sort order (Latest or Top)
-        sig { returns(T.nilable(String)) }
+        sig do
+          returns(
+            T.nilable(
+              XTwitterScraper::X::CommunityRetrieveSearchParams::QueryType::OrSymbol
+            )
+          )
+        end
         attr_reader :query_type
 
-        sig { params(query_type: String).void }
+        sig do
+          params(
+            query_type:
+              XTwitterScraper::X::CommunityRetrieveSearchParams::QueryType::OrSymbol
+          ).void
+        end
         attr_writer :query_type
 
         sig do
           params(
+            community_id: String,
             q: String,
             cursor: String,
-            query_type: String,
+            page_size: Integer,
+            query_type:
+              XTwitterScraper::X::CommunityRetrieveSearchParams::QueryType::OrSymbol,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
+          # Numeric ID of the community whose posts to search
+          community_id:,
           # Search query
           q:,
           # Pagination cursor for community search
           cursor: nil,
+          # Maximum items requested from this page (1-100, default 20). The response can
+          # contain fewer items because the source returned fewer, filters removed items, or
+          # remaining credits cover fewer results. Keep requesting next_cursor while
+          # has_next_page is true, even when a page is empty. The deprecated limit and count
+          # aliases remain accepted.
+          page_size: nil,
           # Sort order (Latest or Top)
           query_type: nil,
           request_options: {}
@@ -55,15 +92,53 @@ module XTwitterScraper
         sig do
           override.returns(
             {
+              community_id: String,
               q: String,
               cursor: String,
-              query_type: String,
+              page_size: Integer,
+              query_type:
+                XTwitterScraper::X::CommunityRetrieveSearchParams::QueryType::OrSymbol,
               request_options: XTwitterScraper::RequestOptions
             }
           )
         end
         def to_hash
         end
+
+        # Sort order (Latest or Top)
+        module QueryType
+          extend XTwitterScraper::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                XTwitterScraper::X::CommunityRetrieveSearchParams::QueryType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          LATEST =
+            T.let(
+              :Latest,
+              XTwitterScraper::X::CommunityRetrieveSearchParams::QueryType::TaggedSymbol
+            )
+          TOP =
+            T.let(
+              :Top,
+              XTwitterScraper::X::CommunityRetrieveSearchParams::QueryType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                XTwitterScraper::X::CommunityRetrieveSearchParams::QueryType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end

data/rbi/x_twitter_scraper/models/x/dm_retrieve_history_params.rbi

@@ -18,6 +18,11 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :user_id
 
+        # X handle (without the `@` prefix) of the connected X account used to read the
+        # conversation. The account must be a participant in the conversation.
+        sig { returns(String) }
+        attr_accessor :account
+
         # Pagination cursor for DM history
         sig { returns(T.nilable(String)) }
         attr_reader :cursor
@@ -35,6 +40,7 @@ module XTwitterScraper
         sig do
           params(
             user_id: String,
+            account: String,
             cursor: String,
             max_id: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
@@ -42,6 +48,9 @@ module XTwitterScraper
         end
         def self.new(
           user_id:,
+          # X handle (without the `@` prefix) of the connected X account used to read the
+          # conversation. The account must be a participant in the conversation.
+          account:,
           # Pagination cursor for DM history
           cursor: nil,
           # Legacy pagination cursor (backward compat)
@@ -54,6 +63,7 @@ module XTwitterScraper
           override.returns(
             {
               user_id: String,
+              account: String,
               cursor: String,
               max_id: String,
               request_options: XTwitterScraper::RequestOptions

data/rbi/x_twitter_scraper/models/x/dm_retrieve_history_response.rbi

@@ -67,23 +67,25 @@ module XTwitterScraper
           sig { returns(String) }
           attr_accessor :id
 
+          sig { returns(String) }
+          attr_accessor :receiver_id
+
+          sig { returns(String) }
+          attr_accessor :sender_id
+
           sig { returns(T.nilable(String)) }
           attr_reader :created_at
 
           sig { params(created_at: String).void }
           attr_writer :created_at
 
+          # URL of attached media (image, GIF, or video). Omitted when the message has no
+          # media attachment.
           sig { returns(T.nilable(String)) }
-          attr_reader :receiver_id
+          attr_reader :media_url
 
-          sig { params(receiver_id: String).void }
-          attr_writer :receiver_id
-
-          sig { returns(T.nilable(String)) }
-          attr_reader :sender_id
-
-          sig { params(sender_id: String).void }
-          attr_writer :sender_id
+          sig { params(media_url: String).void }
+          attr_writer :media_url
 
           sig { returns(T.nilable(String)) }
           attr_reader :text
@@ -94,17 +96,21 @@ module XTwitterScraper
           sig do
             params(
               id: String,
-              created_at: String,
               receiver_id: String,
               sender_id: String,
+              created_at: String,
+              media_url: String,
               text: String
             ).returns(T.attached_class)
           end
           def self.new(
             id:,
+            receiver_id:,
+            sender_id:,
             created_at: nil,
-            receiver_id: nil,
-            sender_id: nil,
+            # URL of attached media (image, GIF, or video). Omitted when the message has no
+            # media attachment.
+            media_url: nil,
             text: nil
           )
           end
@@ -113,9 +119,10 @@ module XTwitterScraper
             override.returns(
               {
                 id: String,
-                created_at: String,
                 receiver_id: String,
                 sender_id: String,
+                created_at: String,
+                media_url: String,
                 text: String
               }
             )

data/rbi/x_twitter_scraper/models/x/dm_send_params.rbi

@@ -25,25 +25,19 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :text
 
+        # Optional array containing exactly 1 uploaded media ID.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :media_ids
 
         sig { params(media_ids: T::Array[String]).void }
         attr_writer :media_ids
 
-        sig { returns(T.nilable(String)) }
-        attr_reader :reply_to_message_id
-
-        sig { params(reply_to_message_id: String).void }
-        attr_writer :reply_to_message_id
-
         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(T.attached_class)
         end
@@ -52,8 +46,8 @@ module XTwitterScraper
           # X account (@username or ID) sending the DM
           account:,
           text:,
+          # Optional array containing exactly 1 uploaded media ID.
           media_ids: nil,
-          reply_to_message_id: nil,
           request_options: {}
         )
         end
@@ -65,7 +59,6 @@ module XTwitterScraper
               account: String,
               text: String,
               media_ids: T::Array[String],
-              reply_to_message_id: String,
               request_options: XTwitterScraper::RequestOptions
             }
           )

data/rbi/x_twitter_scraper/models/x/follower_check_params.rbi

@@ -15,11 +15,11 @@ module XTwitterScraper
             )
           end
 
-        # Username to check (without @)
+        # Source username, @username, or X or Twitter profile URL
         sig { returns(String) }
         attr_accessor :source
 
-        # Target username (without @)
+        # Target username, @username, or X or Twitter profile URL
         sig { returns(String) }
         attr_accessor :target
 
@@ -31,9 +31,9 @@ module XTwitterScraper
           ).returns(T.attached_class)
         end
         def self.new(
-          # Username to check (without @)
+          # Source username, @username, or X or Twitter profile URL
           source:,
-          # Target username (without @)
+          # Target username, @username, or X or Twitter profile URL
           target:,
           request_options: {}
         )