x-twitter-scraper 0.5.5 → 0.7.0

data/rbi/x_twitter_scraper/models/x/account_create_response.rbi

@@ -7,128 +7,269 @@
 module XTwitterScraper
   module Models
     module X
-      class AccountCreateResponse < XTwitterScraper::Internal::Type::BaseModel
-        OrHash =
+      # Sanitized X account summary returned by connect and reauth.
+      module AccountCreateResponse
+        extend XTwitterScraper::Internal::Type::Union
+
+        Variants =
           T.type_alias do
             T.any(
-              XTwitterScraper::Models::X::AccountCreateResponse,
-              XTwitterScraper::Internal::AnyHash
+              XTwitterScraper::Models::X::AccountCreateResponse::SanitizedXAccount,
+              XTwitterScraper::Models::X::AccountCreateResponse::XAccountConnectionAttemptPending,
+              XTwitterScraper::Models::X::AccountCreateResponse::XAccountConnectionChallenge
             )
           end
 
-        sig { returns(String) }
-        attr_accessor :id
+        class SanitizedXAccount < XTwitterScraper::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                XTwitterScraper::Models::X::AccountCreateResponse::SanitizedXAccount,
+                XTwitterScraper::Internal::AnyHash
+              )
+            end
 
-        sig { returns(Time) }
-        attr_accessor :created_at
+          sig { returns(String) }
+          attr_accessor :id
 
-        sig do
-          returns(
-            XTwitterScraper::Models::X::AccountCreateResponse::Health::TaggedSymbol
-          )
-        end
-        attr_accessor :health
+          sig { returns(Time) }
+          attr_accessor :created_at
 
-        sig { returns(String) }
-        attr_accessor :status
+          sig do
+            returns(
+              XTwitterScraper::Models::X::AccountCreateResponse::SanitizedXAccount::Health::TaggedSymbol
+            )
+          end
+          attr_accessor :health
 
-        sig { returns(String) }
-        attr_accessor :x_user_id
+          sig { returns(Symbol) }
+          attr_accessor :status
 
-        sig { returns(String) }
-        attr_accessor :x_username
+          sig { returns(String) }
+          attr_accessor :x_user_id
 
-        # Sanitized X account summary returned by connect and reauth.
-        sig do
-          params(
-            id: String,
-            created_at: Time,
-            health:
-              XTwitterScraper::Models::X::AccountCreateResponse::Health::OrSymbol,
-            status: String,
-            x_user_id: String,
-            x_username: String
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          id:,
-          created_at:,
-          health:,
-          status:,
-          x_user_id:,
-          x_username:
-        )
-        end
+          sig { returns(String) }
+          attr_accessor :x_username
 
-        sig do
-          override.returns(
-            {
+          # Sanitized X account summary returned by connect and reauth.
+          sig do
+            params(
               id: String,
               created_at: Time,
               health:
-                XTwitterScraper::Models::X::AccountCreateResponse::Health::TaggedSymbol,
-              status: String,
+                XTwitterScraper::Models::X::AccountCreateResponse::SanitizedXAccount::Health::OrSymbol,
               x_user_id: String,
-              x_username: String
-            }
+              x_username: String,
+              status: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            id:,
+            created_at:,
+            health:,
+            x_user_id:,
+            x_username:,
+            status: :active
           )
-        end
-        def to_hash
-        end
+          end
 
-        module Health
-          extend XTwitterScraper::Internal::Type::Enum
+          sig do
+            override.returns(
+              {
+                id: String,
+                created_at: Time,
+                health:
+                  XTwitterScraper::Models::X::AccountCreateResponse::SanitizedXAccount::Health::TaggedSymbol,
+                status: Symbol,
+                x_user_id: String,
+                x_username: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module Health
+            extend XTwitterScraper::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  XTwitterScraper::Models::X::AccountCreateResponse::SanitizedXAccount::Health
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            HEALTHY =
+              T.let(
+                :healthy,
+                XTwitterScraper::Models::X::AccountCreateResponse::SanitizedXAccount::Health::TaggedSymbol
+              )
+            LOCKED =
+              T.let(
+                :locked,
+                XTwitterScraper::Models::X::AccountCreateResponse::SanitizedXAccount::Health::TaggedSymbol
+              )
+            NEEDS_REAUTH =
+              T.let(
+                :needsReauth,
+                XTwitterScraper::Models::X::AccountCreateResponse::SanitizedXAccount::Health::TaggedSymbol
+              )
+            RECOVERING =
+              T.let(
+                :recovering,
+                XTwitterScraper::Models::X::AccountCreateResponse::SanitizedXAccount::Health::TaggedSymbol
+              )
+            SUSPENDED =
+              T.let(
+                :suspended,
+                XTwitterScraper::Models::X::AccountCreateResponse::SanitizedXAccount::Health::TaggedSymbol
+              )
+            TEMPORARY_ISSUE =
+              T.let(
+                :temporaryIssue,
+                XTwitterScraper::Models::X::AccountCreateResponse::SanitizedXAccount::Health::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  XTwitterScraper::Models::X::AccountCreateResponse::SanitizedXAccount::Health::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
 
-          TaggedSymbol =
+        class XAccountConnectionAttemptPending < XTwitterScraper::Internal::Type::BaseModel
+          OrHash =
             T.type_alias do
-              T.all(
-                Symbol,
-                XTwitterScraper::Models::X::AccountCreateResponse::Health
+              T.any(
+                XTwitterScraper::Models::X::AccountCreateResponse::XAccountConnectionAttemptPending,
+                XTwitterScraper::Internal::AnyHash
               )
             end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-          HEALTHY =
-            T.let(
-              :healthy,
-              XTwitterScraper::Models::X::AccountCreateResponse::Health::TaggedSymbol
-            )
-          LOCKED =
-            T.let(
-              :locked,
-              XTwitterScraper::Models::X::AccountCreateResponse::Health::TaggedSymbol
-            )
-          NEEDS_REAUTH =
-            T.let(
-              :needsReauth,
-              XTwitterScraper::Models::X::AccountCreateResponse::Health::TaggedSymbol
-            )
-          RECOVERING =
-            T.let(
-              :recovering,
-              XTwitterScraper::Models::X::AccountCreateResponse::Health::TaggedSymbol
-            )
-          SUSPENDED =
-            T.let(
-              :suspended,
-              XTwitterScraper::Models::X::AccountCreateResponse::Health::TaggedSymbol
-            )
-          TEMPORARY_ISSUE =
-            T.let(
-              :temporaryIssue,
-              XTwitterScraper::Models::X::AccountCreateResponse::Health::TaggedSymbol
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(Symbol) }
+          attr_accessor :object
+
+          sig { returns(Integer) }
+          attr_accessor :poll_after_ms
+
+          sig { returns(Symbol) }
+          attr_accessor :status
+
+          # The connection is still in progress.
+          sig do
+            params(
+              id: String,
+              poll_after_ms: Integer,
+              object: Symbol,
+              status: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            id:,
+            poll_after_ms:,
+            object: :x_account_connection_attempt,
+            status: :pending
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                object: Symbol,
+                poll_after_ms: Integer,
+                status: Symbol
+              }
             )
+          end
+          def to_hash
+          end
+        end
+
+        class XAccountConnectionChallenge < XTwitterScraper::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                XTwitterScraper::Models::X::AccountCreateResponse::XAccountConnectionChallenge,
+                XTwitterScraper::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(Time) }
+          attr_accessor :expires_at
+
+          sig { returns(String) }
+          attr_accessor :message
+
+          sig { returns(Symbol) }
+          attr_accessor :object
+
+          sig { returns(Symbol) }
+          attr_accessor :status
+
+          sig { returns(String) }
+          attr_accessor :username
+
+          # Resumable account connection challenge. Submit the email code to finish the same
+          # connection attempt.
+          sig do
+            params(
+              id: String,
+              expires_at: Time,
+              message: String,
+              username: String,
+              object: Symbol,
+              status: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            id:,
+            expires_at:,
+            message:,
+            username:,
+            object: :x_account_connection_challenge,
+            status: :requires_email_code
+          )
+          end
 
           sig do
             override.returns(
-              T::Array[
-                XTwitterScraper::Models::X::AccountCreateResponse::Health::TaggedSymbol
-              ]
+              {
+                id: String,
+                expires_at: Time,
+                message: String,
+                object: Symbol,
+                status: Symbol,
+                username: String
+              }
             )
           end
-          def self.values
+          def to_hash
           end
         end
+
+        sig do
+          override.returns(
+            T::Array[
+              XTwitterScraper::Models::X::AccountCreateResponse::Variants
+            ]
+          )
+        end
+        def self.variants
+        end
       end
     end
   end

data/rbi/x_twitter_scraper/models/x/account_reauth_params.rbi

@@ -33,7 +33,7 @@ module XTwitterScraper
         sig { params(email: String).void }
         attr_writer :email
 
-        # TOTP secret for 2FA re-authentication
+        # Replacement Authenticator App TOTP secret. Omit it to reuse the saved secret.
         sig { returns(T.nilable(String)) }
         attr_reader :totp_secret
 
@@ -55,7 +55,7 @@ module XTwitterScraper
           password:,
           # Email for the X account (updates stored email)
           email: nil,
-          # TOTP secret for 2FA re-authentication
+          # Replacement Authenticator App TOTP secret. Omit it to reuse the saved secret.
           totp_secret: nil,
           request_options: {}
         )

data/rbi/x_twitter_scraper/models/x/account_reauth_response.rbi

@@ -29,7 +29,7 @@ module XTwitterScraper
         end
         attr_accessor :health
 
-        sig { returns(String) }
+        sig { returns(Symbol) }
         attr_accessor :status
 
         sig { returns(String) }
@@ -45,18 +45,18 @@ module XTwitterScraper
             created_at: Time,
             health:
               XTwitterScraper::Models::X::AccountReauthResponse::Health::OrSymbol,
-            status: String,
             x_user_id: String,
-            x_username: String
+            x_username: String,
+            status: Symbol
           ).returns(T.attached_class)
         end
         def self.new(
           id:,
           created_at:,
           health:,
-          status:,
           x_user_id:,
-          x_username:
+          x_username:,
+          status: :active
         )
         end
 
@@ -67,7 +67,7 @@ module XTwitterScraper
               created_at: Time,
               health:
                 XTwitterScraper::Models::X::AccountReauthResponse::Health::TaggedSymbol,
-              status: String,
+              status: Symbol,
               x_user_id: String,
               x_username: String
             }

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

@@ -30,10 +30,8 @@ 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
+          # Maximum page items (1-100, default 20). Source, filters, or credits can reduce
+          # results. Continue while has_next_page is true. Deprecated limit and count
           # aliases remain accepted.
           sig { returns(T.nilable(Integer)) }
           attr_reader :page_size
@@ -53,10 +51,8 @@ module XTwitterScraper
             id:,
             # Pagination cursor for community tweets
             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
+            # Maximum page items (1-100, default 20). Source, filters, or credits can reduce
+            # results. Continue while has_next_page is true. Deprecated limit and count
             # aliases remain accepted.
             page_size: nil,
             request_options: {}

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

@@ -35,10 +35,8 @@ 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
+          # Maximum page items (1-100, default 20). Source, filters, or credits can reduce
+          # results. Continue while has_next_page is true. Deprecated limit and count
           # aliases remain accepted.
           sig { returns(T.nilable(Integer)) }
           attr_reader :page_size
@@ -82,10 +80,8 @@ module XTwitterScraper
             q:,
             # Pagination cursor for community results
             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
+            # Maximum page items (1-100, default 20). Source, filters, or credits can reduce
+            # results. Continue while has_next_page is true. Deprecated limit and count
             # aliases remain accepted.
             page_size: nil,
             # Sort order for community results (Latest or Top)

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

@@ -113,13 +113,6 @@ module XTwitterScraper
           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
@@ -173,13 +166,6 @@ 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(
@@ -212,7 +198,6 @@ module XTwitterScraper
                 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,
@@ -220,7 +205,6 @@ module XTwitterScraper
               name: String,
               primary_topic:
                 XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::PrimaryTopic::OrHash,
-              role: String,
               rules:
                 T::Array[
                   XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::Rule::OrHash
@@ -239,8 +223,6 @@ module XTwitterScraper
             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)
@@ -253,8 +235,6 @@ module XTwitterScraper
             name: nil,
             # Primary topic
             primary_topic: nil,
-            # Authenticated viewer's community role
-            role: nil,
             # Community rules
             rules: nil
           )
@@ -270,7 +250,6 @@ module XTwitterScraper
                   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,
@@ -278,7 +257,6 @@ module XTwitterScraper
                 name: String,
                 primary_topic:
                   XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::PrimaryTopic,
-                role: String,
                 rules:
                   T::Array[
                     XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::Rule

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

@@ -34,10 +34,8 @@ 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
+        # Maximum page items (1-100, default 20). Source, filters, or credits can reduce
+        # results. Continue while has_next_page is true. Deprecated limit and count
         # aliases remain accepted.
         sig { returns(T.nilable(Integer)) }
         attr_reader :page_size
@@ -81,10 +79,8 @@ module XTwitterScraper
           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
+          # Maximum page items (1-100, default 20). Source, filters, or credits can reduce
+          # results. Continue while has_next_page is true. Deprecated limit and count
           # aliases remain accepted.
           page_size: nil,
           # Sort order (Latest or Top)

data/rbi/x_twitter_scraper/models/x/list_retrieve_tweets_params.rbi

@@ -36,10 +36,8 @@ module XTwitterScraper
         sig { params(include_replies: T::Boolean).void }
         attr_writer :include_replies
 
-        # 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
+        # Maximum page items (1-100, default 20). Source, filters, or credits can reduce
+        # results. Continue while has_next_page is true. Deprecated limit and count
         # aliases remain accepted.
         sig { returns(T.nilable(Integer)) }
         attr_reader :page_size
@@ -78,10 +76,8 @@ module XTwitterScraper
           cursor: nil,
           # Include replies (default false)
           include_replies: 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
+          # Maximum page items (1-100, default 20). Source, filters, or credits can reduce
+          # results. Continue while has_next_page is true. Deprecated limit and count
           # aliases remain accepted.
           page_size: nil,
           # Unix timestamp - filter after

data/rbi/x_twitter_scraper/models/x/tweet_author.rbi

@@ -16,13 +16,23 @@ module XTwitterScraper
             )
           end
 
+        sig { returns(Integer) }
+        attr_accessor :followers
+
+        sig { returns(T::Boolean) }
+        attr_accessor :verified
+
         # Tweet author profile. The lookup route always includes follower count and
         # verification state. Other profile fields appear when available.
-        sig { returns(T.attached_class) }
-        def self.new
+        sig do
+          params(followers: Integer, verified: T::Boolean).returns(
+            T.attached_class
+          )
+        end
+        def self.new(followers:, verified:)
         end
 
-        sig { override.returns({}) }
+        sig { override.returns({ followers: Integer, verified: T::Boolean }) }
         def to_hash
         end
       end