x-twitter-scraper 0.4.2 → 0.4.4

data/rbi/x_twitter_scraper/models/x/user_remove_follower_response.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    module X
+      class UserRemoveFollowerResponse < XTwitterScraper::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::Models::X::UserRemoveFollowerResponse,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T::Boolean) }
+        attr_accessor :success
+
+        sig { params(success: T::Boolean).returns(T.attached_class) }
+        def self.new(success: true)
+        end
+
+        sig { override.returns({ success: T::Boolean }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/x/user_retrieve_batch_params.rbi

@@ -15,7 +15,8 @@ module XTwitterScraper
             )
           end
 
-        # Comma-separated user IDs (max 100)
+        # Comma-separated numeric user IDs (1-100 values). Duplicate IDs are ignored while
+        # preserving first-seen order.
         sig { returns(String) }
         attr_accessor :ids
 
@@ -26,7 +27,8 @@ module XTwitterScraper
           ).returns(T.attached_class)
         end
         def self.new(
-          # Comma-separated user IDs (max 100)
+          # Comma-separated numeric user IDs (1-100 values). Duplicate IDs are ignored while
+          # preserving first-seen order.
           ids:,
           request_options: {}
         )

data/rbi/x_twitter_scraper/models/x/user_retrieve_batch_response.rbi

@@ -0,0 +1,102 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    module X
+      class UserRetrieveBatchResponse < XTwitterScraper::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::Models::X::UserRetrieveBatchResponse,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        # Batch lookups never paginate.
+        sig { returns(T::Boolean) }
+        attr_accessor :has_next_page
+
+        # Empty because batch lookups never paginate.
+        sig { returns(String) }
+        attr_accessor :next_cursor
+
+        # Number of requested IDs included in the lookup.
+        sig { returns(Integer) }
+        attr_accessor :processed_count
+
+        # Number of unique IDs requested.
+        sig { returns(Integer) }
+        attr_accessor :requested_count
+
+        # Number of user profiles returned and charged.
+        sig { returns(Integer) }
+        attr_accessor :returned_count
+
+        # Processed IDs with no returned profile, in first-seen request order.
+        sig { returns(T::Array[String]) }
+        attr_accessor :unavailable_ids
+
+        # Requested IDs skipped because available credits limited processing. Retry these
+        # IDs after adding credits.
+        sig { returns(T::Array[String]) }
+        attr_accessor :unprocessed_ids
+
+        sig { returns(T::Array[XTwitterScraper::UserProfile]) }
+        attr_accessor :users
+
+        # Batch user lookup results. Duplicate requested IDs are ignored while preserving
+        # first-seen order. unavailable_ids identifies processed IDs with no returned
+        # profile. unprocessed_ids identifies IDs skipped when available credits limit
+        # processing.
+        sig do
+          params(
+            next_cursor: String,
+            processed_count: Integer,
+            requested_count: Integer,
+            returned_count: Integer,
+            unavailable_ids: T::Array[String],
+            unprocessed_ids: T::Array[String],
+            users: T::Array[XTwitterScraper::UserProfile::OrHash],
+            has_next_page: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Empty because batch lookups never paginate.
+          next_cursor:,
+          # Number of requested IDs included in the lookup.
+          processed_count:,
+          # Number of unique IDs requested.
+          requested_count:,
+          # Number of user profiles returned and charged.
+          returned_count:,
+          # Processed IDs with no returned profile, in first-seen request order.
+          unavailable_ids:,
+          # Requested IDs skipped because available credits limited processing. Retry these
+          # IDs after adding credits.
+          unprocessed_ids:,
+          users:,
+          # Batch lookups never paginate.
+          has_next_page: false
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              has_next_page: T::Boolean,
+              next_cursor: String,
+              processed_count: Integer,
+              requested_count: Integer,
+              returned_count: Integer,
+              unavailable_ids: T::Array[String],
+              unprocessed_ids: T::Array[String],
+              users: T::Array[XTwitterScraper::UserProfile]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/x/user_retrieve_followers_params.rbi

@@ -18,6 +18,13 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :id
 
+        # Legacy cursor alias. Prefer cursor.
+        sig { returns(T.nilable(String)) }
+        attr_reader :after
+
+        sig { params(after: String).void }
+        attr_writer :after
+
         # Pagination cursor for followers list
         sig { returns(T.nilable(String)) }
         attr_reader :cursor
@@ -25,7 +32,17 @@ module XTwitterScraper
         sig { params(cursor: String).void }
         attr_writer :cursor
 
-        # Items per page (20-200, default 200)
+        # Legacy integer page size alias for following lists. Prefer pageSize.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :limit
+
+        sig { params(limit: Integer).void }
+        attr_writer :limit
+
+        # Maximum user profiles requested from this page (20-200, default 200). The
+        # response can contain fewer profiles because the source returned fewer or
+        # remaining credits cover fewer results. Keep requesting next_cursor while
+        # has_next_page is true. The deprecated limit and count aliases remain accepted.
         sig { returns(T.nilable(Integer)) }
         attr_reader :page_size
 
@@ -35,16 +52,25 @@ module XTwitterScraper
         sig do
           params(
             id: String,
+            after: String,
             cursor: String,
+            limit: Integer,
             page_size: Integer,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
           id:,
+          # Legacy cursor alias. Prefer cursor.
+          after: nil,
           # Pagination cursor for followers list
           cursor: nil,
-          # Items per page (20-200, default 200)
+          # Legacy integer page size alias for following lists. Prefer pageSize.
+          limit: nil,
+          # Maximum user profiles requested from this page (20-200, default 200). The
+          # response can contain fewer profiles because the source returned fewer or
+          # remaining credits cover fewer results. Keep requesting next_cursor while
+          # has_next_page is true. The deprecated limit and count aliases remain accepted.
           page_size: nil,
           request_options: {}
         )
@@ -54,7 +80,9 @@ module XTwitterScraper
           override.returns(
             {
               id: String,
+              after: String,
               cursor: String,
+              limit: Integer,
               page_size: Integer,
               request_options: XTwitterScraper::RequestOptions
             }

data/rbi/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rbi

@@ -25,10 +25,21 @@ module XTwitterScraper
         sig { params(cursor: String).void }
         attr_writer :cursor
 
+        # Maximum user profiles requested from this page (20-200, default 200). The
+        # response can contain fewer profiles because the source returned fewer or
+        # remaining credits cover fewer results. Keep requesting next_cursor while
+        # has_next_page is true. 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
+
         sig do
           params(
             id: String,
             cursor: String,
+            page_size: Integer,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -36,6 +47,11 @@ module XTwitterScraper
           id:,
           # Pagination cursor for followers-you-know
           cursor: nil,
+          # Maximum user profiles requested from this page (20-200, default 200). The
+          # response can contain fewer profiles because the source returned fewer or
+          # remaining credits cover fewer results. Keep requesting next_cursor while
+          # has_next_page is true. The deprecated limit and count aliases remain accepted.
+          page_size: nil,
           request_options: {}
         )
         end
@@ -45,6 +61,7 @@ module XTwitterScraper
             {
               id: String,
               cursor: String,
+              page_size: Integer,
               request_options: XTwitterScraper::RequestOptions
             }
           )

data/rbi/x_twitter_scraper/models/x/user_retrieve_following_params.rbi

@@ -18,6 +18,13 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :id
 
+        # Legacy cursor alias. Prefer cursor.
+        sig { returns(T.nilable(String)) }
+        attr_reader :after
+
+        sig { params(after: String).void }
+        attr_writer :after
+
         # Pagination cursor for following list
         sig { returns(T.nilable(String)) }
         attr_reader :cursor
@@ -25,7 +32,17 @@ module XTwitterScraper
         sig { params(cursor: String).void }
         attr_writer :cursor
 
-        # Results per page (20-200, default 200)
+        # Legacy page size alias. Prefer pageSize.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :limit
+
+        sig { params(limit: Integer).void }
+        attr_writer :limit
+
+        # Maximum user profiles requested from this page (20-200, default 200). The
+        # response can contain fewer profiles because the source returned fewer or
+        # remaining credits cover fewer results. Keep requesting next_cursor while
+        # has_next_page is true. The deprecated limit and count aliases remain accepted.
         sig { returns(T.nilable(Integer)) }
         attr_reader :page_size
 
@@ -35,16 +52,25 @@ module XTwitterScraper
         sig do
           params(
             id: String,
+            after: String,
             cursor: String,
+            limit: Integer,
             page_size: Integer,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
           id:,
+          # Legacy cursor alias. Prefer cursor.
+          after: nil,
           # Pagination cursor for following list
           cursor: nil,
-          # Results per page (20-200, default 200)
+          # Legacy page size alias. Prefer pageSize.
+          limit: nil,
+          # Maximum user profiles requested from this page (20-200, default 200). The
+          # response can contain fewer profiles because the source returned fewer or
+          # remaining credits cover fewer results. Keep requesting next_cursor while
+          # has_next_page is true. The deprecated limit and count aliases remain accepted.
           page_size: nil,
           request_options: {}
         )
@@ -54,7 +80,9 @@ module XTwitterScraper
           override.returns(
             {
               id: String,
+              after: String,
               cursor: String,
+              limit: Integer,
               page_size: Integer,
               request_options: XTwitterScraper::RequestOptions
             }