x-twitter-scraper 0.7.3 → 0.9.0

data/rbi/x_twitter_scraper/models/x/user_retrieve_verified_followers_response.rbi

@@ -0,0 +1,440 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    module X
+      # Paginated user profiles. No-mode follower, following, and verified follower
+      # requests merge independent views automatically. Response fields, page size,
+      # aliases, filters, and per-returned-profile billing stay unchanged. Existing
+      # unprefixed cursors retain legacy behavior. Follow next_cursor while
+      # has_next_page is true.
+      module UserRetrieveVerifiedFollowersResponse
+        extend XTwitterScraper::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::PaginatedUsers,
+              XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse
+            )
+          end
+
+        class UserListCoverageResponse < XTwitterScraper::Models::PaginatedUsers
+          OrHash =
+            T.type_alias do
+              T.any(
+                XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse,
+                XTwitterScraper::Internal::AnyHash
+              )
+            end
+
+          # Coverage evidence across parallel relationship strategies.
+          sig do
+            returns(
+              XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic
+            )
+          end
+          attr_reader :diagnostic
+
+          sig do
+            params(
+              diagnostic:
+                XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic::OrHash
+            ).void
+          end
+          attr_writer :diagnostic
+
+          sig do
+            returns(
+              T.nilable(
+                XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::HasNextPage::TaggedBoolean
+              )
+            )
+          end
+          attr_reader :has_next_page
+
+          sig do
+            params(
+              has_next_page:
+                XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::HasNextPage::OrBoolean
+            ).void
+          end
+          attr_writer :has_next_page
+
+          sig do
+            returns(
+              T.nilable(
+                XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::NextCursor::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :next_cursor
+
+          sig do
+            params(
+              next_cursor:
+                XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::NextCursor::OrSymbol
+            ).void
+          end
+          attr_writer :next_cursor
+
+          # Paginated user profiles. No-mode follower, following, and verified follower
+          # requests merge independent views automatically. Response fields, page size,
+          # aliases, filters, and per-returned-profile billing stay unchanged. Existing
+          # unprefixed cursors retain legacy behavior. Follow next_cursor while
+          # has_next_page is true.
+          sig do
+            params(
+              diagnostic:
+                XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic::OrHash,
+              has_next_page:
+                XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::HasNextPage::OrBoolean,
+              next_cursor:
+                XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::NextCursor::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Coverage evidence across parallel relationship strategies.
+            diagnostic:,
+            has_next_page: nil,
+            next_cursor: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                diagnostic:
+                  XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic,
+                has_next_page:
+                  XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::HasNextPage::TaggedBoolean,
+                next_cursor:
+                  XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::NextCursor::TaggedSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Diagnostic < XTwitterScraper::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic,
+                  XTwitterScraper::Internal::AnyHash
+                )
+              end
+
+            # True when every strategy exhausted its source.
+            sig { returns(T::Boolean) }
+            attr_accessor :complete
+
+            sig { returns(Integer) }
+            attr_accessor :cursor_failure_count
+
+            sig { returns(T::Boolean) }
+            attr_accessor :deadline_reached
+
+            sig { returns(Integer) }
+            attr_accessor :duplicate_count
+
+            sig { returns(Integer) }
+            attr_accessor :failed_strategy_count
+
+            sig { returns(Integer) }
+            attr_accessor :malformed_count
+
+            sig { returns(Integer) }
+            attr_accessor :pages_fetched
+
+            # Whether credits or the requested limit reduced output.
+            sig { returns(T::Boolean) }
+            attr_accessor :response_truncated
+
+            sig { returns(T::Boolean) }
+            attr_accessor :result_limit_reached
+
+            sig { returns(Integer) }
+            attr_accessor :returned_users
+
+            sig { returns(Integer) }
+            attr_accessor :stalled_strategy_count
+
+            sig do
+              returns(
+                T::Array[
+                  XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy
+                ]
+              )
+            end
+            attr_accessor :strategies
+
+            sig { returns(Integer) }
+            attr_accessor :strategy_count
+
+            sig { returns(Integer) }
+            attr_accessor :unique_users
+
+            # Coverage evidence across parallel relationship strategies.
+            sig do
+              params(
+                complete: T::Boolean,
+                cursor_failure_count: Integer,
+                deadline_reached: T::Boolean,
+                duplicate_count: Integer,
+                failed_strategy_count: Integer,
+                malformed_count: Integer,
+                pages_fetched: Integer,
+                response_truncated: T::Boolean,
+                result_limit_reached: T::Boolean,
+                returned_users: Integer,
+                stalled_strategy_count: Integer,
+                strategies:
+                  T::Array[
+                    XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy::OrHash
+                  ],
+                strategy_count: Integer,
+                unique_users: Integer
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # True when every strategy exhausted its source.
+              complete:,
+              cursor_failure_count:,
+              deadline_reached:,
+              duplicate_count:,
+              failed_strategy_count:,
+              malformed_count:,
+              pages_fetched:,
+              # Whether credits or the requested limit reduced output.
+              response_truncated:,
+              result_limit_reached:,
+              returned_users:,
+              stalled_strategy_count:,
+              strategies:,
+              strategy_count:,
+              unique_users:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  complete: T::Boolean,
+                  cursor_failure_count: Integer,
+                  deadline_reached: T::Boolean,
+                  duplicate_count: Integer,
+                  failed_strategy_count: Integer,
+                  malformed_count: Integer,
+                  pages_fetched: Integer,
+                  response_truncated: T::Boolean,
+                  result_limit_reached: T::Boolean,
+                  returned_users: Integer,
+                  stalled_strategy_count: Integer,
+                  strategies:
+                    T::Array[
+                      XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy
+                    ],
+                  strategy_count: Integer,
+                  unique_users: Integer
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class Strategy < XTwitterScraper::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy,
+                    XTwitterScraper::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(Integer) }
+              attr_accessor :duplicate_count
+
+              sig { returns(Integer) }
+              attr_accessor :pages_fetched
+
+              sig do
+                returns(
+                  XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy::StopReason::TaggedSymbol
+                )
+              end
+              attr_accessor :stop_reason
+
+              sig { returns(Integer) }
+              attr_accessor :strategy
+
+              sig { returns(Integer) }
+              attr_accessor :unique_added
+
+              sig do
+                params(
+                  duplicate_count: Integer,
+                  pages_fetched: Integer,
+                  stop_reason:
+                    XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy::StopReason::OrSymbol,
+                  strategy: Integer,
+                  unique_added: Integer
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                duplicate_count:,
+                pages_fetched:,
+                stop_reason:,
+                strategy:,
+                unique_added:
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    duplicate_count: Integer,
+                    pages_fetched: Integer,
+                    stop_reason:
+                      XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy::StopReason::TaggedSymbol,
+                    strategy: Integer,
+                    unique_added: Integer
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              module StopReason
+                extend XTwitterScraper::Internal::Type::Enum
+
+                TaggedSymbol =
+                  T.type_alias do
+                    T.all(
+                      Symbol,
+                      XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy::StopReason
+                    )
+                  end
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                CURSOR_FAILURE =
+                  T.let(
+                    :cursor_failure,
+                    XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy::StopReason::TaggedSymbol
+                  )
+                DEADLINE =
+                  T.let(
+                    :deadline,
+                    XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy::StopReason::TaggedSymbol
+                  )
+                EXHAUSTED =
+                  T.let(
+                    :exhausted,
+                    XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy::StopReason::TaggedSymbol
+                  )
+                FAILED =
+                  T.let(
+                    :failed,
+                    XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy::StopReason::TaggedSymbol
+                  )
+                PAGE_LIMIT =
+                  T.let(
+                    :page_limit,
+                    XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy::StopReason::TaggedSymbol
+                  )
+                RESULT_LIMIT =
+                  T.let(
+                    :result_limit,
+                    XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy::StopReason::TaggedSymbol
+                  )
+                STALLED =
+                  T.let(
+                    :stalled,
+                    XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy::StopReason::TaggedSymbol
+                  )
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy::StopReason::TaggedSymbol
+                    ]
+                  )
+                end
+                def self.values
+                end
+              end
+            end
+          end
+
+          module HasNextPage
+            extend XTwitterScraper::Internal::Type::Enum
+
+            TaggedBoolean =
+              T.type_alias do
+                T.all(
+                  T::Boolean,
+                  XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::HasNextPage
+                )
+              end
+            OrBoolean = T.type_alias { T::Boolean }
+
+            FALSE =
+              T.let(
+                false,
+                XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::HasNextPage::TaggedBoolean
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::HasNextPage::TaggedBoolean
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          module NextCursor
+            extend XTwitterScraper::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::NextCursor
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            EMPTY =
+              T.let(
+                :"",
+                XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::NextCursor::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::NextCursor::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
+        sig do
+          override.returns(
+            T::Array[
+              XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::Variants
+            ]
+          )
+        end
+        def self.variants
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/x/x_account.rbi

@@ -24,11 +24,9 @@ module XTwitterScraper
         sig { returns(Time) }
         attr_accessor :created_at
 
-        # Derived connection health. `healthy` = ready to use. `needsReauth` = user must
-        # submit fresh credentials. `locked` = X locked the account; unlock on x.com
-        # first. `suspended` = X banned the account. `recovering` = cooldown ended; the
-        # account can reconnect on its next use. `temporaryIssue` = temporary connection
-        # problem; wait before the next use.
+        # Derived health. `healthy` is ready. `needsReauth` needs credentials. `locked`
+        # must be unlocked on X. `suspended` is banned. `recovering` can reconnect. Wait
+        # before using `temporaryIssue`.
         sig { returns(XTwitterScraper::X::XAccount::Health::TaggedSymbol) }
         attr_accessor :health
 
@@ -66,11 +64,9 @@ module XTwitterScraper
         def self.new(
           id:,
           created_at:,
-          # Derived connection health. `healthy` = ready to use. `needsReauth` = user must
-          # submit fresh credentials. `locked` = X locked the account; unlock on x.com
-          # first. `suspended` = X banned the account. `recovering` = cooldown ended; the
-          # account can reconnect on its next use. `temporaryIssue` = temporary connection
-          # problem; wait before the next use.
+          # Derived health. `healthy` is ready. `needsReauth` needs credentials. `locked`
+          # must be unlocked on X. `suspended` is banned. `recovering` can reconnect. Wait
+          # before using `temporaryIssue`.
           health:,
           status:,
           updated_at:,
@@ -97,11 +93,9 @@ module XTwitterScraper
         def to_hash
         end
 
-        # Derived connection health. `healthy` = ready to use. `needsReauth` = user must
-        # submit fresh credentials. `locked` = X locked the account; unlock on x.com
-        # first. `suspended` = X banned the account. `recovering` = cooldown ended; the
-        # account can reconnect on its next use. `temporaryIssue` = temporary connection
-        # problem; wait before the next use.
+        # Derived health. `healthy` is ready. `needsReauth` needs credentials. `locked`
+        # must be unlocked on X. `suspended` is banned. `recovering` can reconnect. Wait
+        # before using `temporaryIssue`.
         module Health
           extend XTwitterScraper::Internal::Type::Enum
 

data/rbi/x_twitter_scraper/resources/credits.rbi

@@ -45,8 +45,8 @@ module XTwitterScraper
       )
       end
 
-      # Create a Stripe Checkout session only after the user confirms. The request never
-      # completes payment or adds credits by itself.
+      # Create a hosted checkout only after the user confirms. The request never
+      # completes payment or adds credits.
       sig do
         params(
           dollars: Integer,

data/rbi/x_twitter_scraper/resources/draws.rbi

@@ -31,7 +31,7 @@ module XTwitterScraper
         ).returns(XTwitterScraper::Models::DrawListResponse)
       end
       def list(
-        # Cursor for keyset pagination from prior response next_cursor
+        # Previous nextCursor.
         cursor: nil,
         # Maximum number of items to return (1-100, default 50). For paid per-result
         # endpoints, the returned count may be lower when remaining credits cannot cover
@@ -54,7 +54,8 @@ module XTwitterScraper
       def export(
         # Draw public ID returned by create and list draw responses.
         id,
-        # Export output format
+        # Export output format. PDF entry exports include up to 10,000 rows. Other entry
+        # formats include up to 100,000 rows.
         format_:,
         # Export winners or all entries
         type: nil,

data/rbi/x_twitter_scraper/resources/events.rbi

@@ -27,22 +27,25 @@ module XTwitterScraper
         params(
           cursor: String,
           event_type: XTwitterScraper::EventType::OrSymbol,
+          keyword_monitor_id: String,
           limit: Integer,
           monitor_id: String,
           request_options: XTwitterScraper::RequestOptions::OrHash
         ).returns(XTwitterScraper::Models::EventListResponse)
       end
       def list(
-        # Cursor for keyset pagination from prior response next_cursor
+        # Previous nextCursor.
         cursor: nil,
         # Filter events by type
         event_type: nil,
+        # Keyword monitor ID.
+        keyword_monitor_id: nil,
         # Maximum number of items to return (1-100, default 50). For paid per-result
         # endpoints, the returned count may be lower when remaining credits cannot cover
         # the requested page. If zero paid results are affordable, the endpoint returns
         # 402 insufficient_credits.
         limit: nil,
-        # Filter events by monitor ID
+        # Account monitor ID.
         monitor_id: nil,
         request_options: {}
       )