x-twitter-scraper 0.7.2 → 0.9.0

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

@@ -29,37 +29,170 @@ module XTwitterScraper
         sig { params(after: String).void }
         attr_writer :after
 
-        # Pagination cursor for followers list
+        # Match any comma-separated or line-separated bio term, ignoring case.
+        sig { returns(T.nilable(String)) }
+        attr_reader :bio_contains
+
+        sig { params(bio_contains: String).void }
+        attr_writer :bio_contains
+
+        # Cursor from the previous response. Xquik cursors resume automatic coverage.
+        # Existing unprefixed cursors keep legacy standard behavior.
         sig { returns(T.nilable(String)) }
         attr_reader :cursor
 
         sig { params(cursor: String).void }
         attr_writer :cursor
 
-        # Legacy integer page size alias for following lists. Prefer pageSize.
+        # Only return profiles with a location.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :has_location
+
+        sig { params(has_location: T::Boolean).void }
+        attr_writer :has_location
+
+        # Only return profiles with a website.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :has_website
+
+        sig { params(has_website: T::Boolean).void }
+        attr_writer :has_website
+
+        # Legacy page-size alias outside explicit coverage mode. Coverage accepts 1-10000.
+        # 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.
+        # Match a location substring, ignoring case.
+        sig { returns(T.nilable(String)) }
+        attr_reader :location_contains
+
+        sig { params(location_contains: String).void }
+        attr_writer :location_contains
+
+        # Maximum follower count. Missing counts pass this maximum.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :max_followers
+
+        sig { params(max_followers: Integer).void }
+        attr_writer :max_followers
+
+        # Maximum following count.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :max_following
+
+        sig { params(max_following: Integer).void }
+        attr_writer :max_following
+
+        # Maximum post count. maxPosts is also accepted.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :max_statuses
+
+        sig { params(max_statuses: Integer).void }
+        attr_writer :max_statuses
+
+        # Minimum account age in whole days.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :min_account_age_days
+
+        sig { params(min_account_age_days: Integer).void }
+        attr_writer :min_account_age_days
+
+        # Minimum follower count. Filtering happens before billing.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :min_followers
+
+        sig { params(min_followers: Integer).void }
+        attr_writer :min_followers
+
+        # Minimum following count.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :min_following
+
+        sig { params(min_following: Integer).void }
+        attr_writer :min_following
+
+        # Minimum post count. minPosts is also accepted.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :min_statuses
+
+        sig { params(min_statuses: Integer).void }
+        attr_writer :min_statuses
+
+        # Omit mode for resumable maximum coverage. Standard keeps legacy pagination.
+        # Coverage returns diagnostics once and rejects cursors.
+        sig do
+          returns(
+            T.nilable(
+              XTwitterScraper::X::UserRetrieveFollowersParams::Mode::OrSymbol
+            )
+          )
+        end
+        attr_reader :mode
+
+        sig do
+          params(
+            mode:
+              XTwitterScraper::X::UserRetrieveFollowersParams::Mode::OrSymbol
+          ).void
+        end
+        attr_writer :mode
+
+        # Maximum user profiles: automatic 300; standard 200. Sources return fewer
+        # profiles. Continue with has_next_page.
         sig { returns(T.nilable(Integer)) }
         attr_reader :page_size
 
         sig { params(page_size: Integer).void }
         attr_writer :page_size
 
+        # Match a username substring, ignoring case.
+        sig { returns(T.nilable(String)) }
+        attr_reader :username_contains
+
+        sig { params(username_contains: String).void }
+        attr_writer :username_contains
+
+        # Only return verified profiles.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :verified_only
+
+        sig { params(verified_only: T::Boolean).void }
+        attr_writer :verified_only
+
+        # Match the verification type exactly, ignoring case.
+        sig { returns(T.nilable(String)) }
+        attr_reader :verified_type
+
+        sig { params(verified_type: String).void }
+        attr_writer :verified_type
+
         sig do
           params(
             id: String,
             after: String,
+            bio_contains: String,
             cursor: String,
+            has_location: T::Boolean,
+            has_website: T::Boolean,
             limit: Integer,
+            location_contains: String,
+            max_followers: Integer,
+            max_following: Integer,
+            max_statuses: Integer,
+            min_account_age_days: Integer,
+            min_followers: Integer,
+            min_following: Integer,
+            min_statuses: Integer,
+            mode:
+              XTwitterScraper::X::UserRetrieveFollowersParams::Mode::OrSymbol,
             page_size: Integer,
+            username_contains: String,
+            verified_only: T::Boolean,
+            verified_type: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -67,15 +200,46 @@ module XTwitterScraper
           id:,
           # Legacy cursor alias. Prefer cursor.
           after: nil,
-          # Pagination cursor for followers list
+          # Match any comma-separated or line-separated bio term, ignoring case.
+          bio_contains: nil,
+          # Cursor from the previous response. Xquik cursors resume automatic coverage.
+          # Existing unprefixed cursors keep legacy standard behavior.
           cursor: nil,
-          # Legacy integer page size alias for following lists. Prefer pageSize.
+          # Only return profiles with a location.
+          has_location: nil,
+          # Only return profiles with a website.
+          has_website: nil,
+          # Legacy page-size alias outside explicit coverage mode. Coverage accepts 1-10000.
+          # 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.
+          # Match a location substring, ignoring case.
+          location_contains: nil,
+          # Maximum follower count. Missing counts pass this maximum.
+          max_followers: nil,
+          # Maximum following count.
+          max_following: nil,
+          # Maximum post count. maxPosts is also accepted.
+          max_statuses: nil,
+          # Minimum account age in whole days.
+          min_account_age_days: nil,
+          # Minimum follower count. Filtering happens before billing.
+          min_followers: nil,
+          # Minimum following count.
+          min_following: nil,
+          # Minimum post count. minPosts is also accepted.
+          min_statuses: nil,
+          # Omit mode for resumable maximum coverage. Standard keeps legacy pagination.
+          # Coverage returns diagnostics once and rejects cursors.
+          mode: nil,
+          # Maximum user profiles: automatic 300; standard 200. Sources return fewer
+          # profiles. Continue with has_next_page.
           page_size: nil,
+          # Match a username substring, ignoring case.
+          username_contains: nil,
+          # Only return verified profiles.
+          verified_only: nil,
+          # Match the verification type exactly, ignoring case.
+          verified_type: nil,
           request_options: {}
         )
         end
@@ -85,15 +249,67 @@ module XTwitterScraper
             {
               id: String,
               after: String,
+              bio_contains: String,
               cursor: String,
+              has_location: T::Boolean,
+              has_website: T::Boolean,
               limit: Integer,
+              location_contains: String,
+              max_followers: Integer,
+              max_following: Integer,
+              max_statuses: Integer,
+              min_account_age_days: Integer,
+              min_followers: Integer,
+              min_following: Integer,
+              min_statuses: Integer,
+              mode:
+                XTwitterScraper::X::UserRetrieveFollowersParams::Mode::OrSymbol,
               page_size: Integer,
+              username_contains: String,
+              verified_only: T::Boolean,
+              verified_type: String,
               request_options: XTwitterScraper::RequestOptions
             }
           )
         end
         def to_hash
         end
+
+        # Omit mode for resumable maximum coverage. Standard keeps legacy pagination.
+        # Coverage returns diagnostics once and rejects cursors.
+        module Mode
+          extend XTwitterScraper::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                XTwitterScraper::X::UserRetrieveFollowersParams::Mode
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          STANDARD =
+            T.let(
+              :standard,
+              XTwitterScraper::X::UserRetrieveFollowersParams::Mode::TaggedSymbol
+            )
+          COVERAGE =
+            T.let(
+              :coverage,
+              XTwitterScraper::X::UserRetrieveFollowersParams::Mode::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                XTwitterScraper::X::UserRetrieveFollowersParams::Mode::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end