x-twitter-scraper 0.5.5 → 0.6.0

data/rbi/x_twitter_scraper/models/x/account_connection_attempt_retrieve_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    module X
+      class AccountConnectionAttemptRetrieveParams < XTwitterScraper::Internal::Type::BaseModel
+        extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+        include XTwitterScraper::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::X::AccountConnectionAttemptRetrieveParams,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig do
+          params(
+            id: String,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            { id: String, request_options: XTwitterScraper::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/x/account_connection_attempt_retrieve_response.rbi

@@ -0,0 +1,317 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    module X
+      # The connection is still in progress.
+      module AccountConnectionAttemptRetrieveResponse
+        extend XTwitterScraper::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::XAccountConnectionAttemptPending,
+              XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::XAccountConnectionAttemptSuccess,
+              XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::XAccountConnectionAttemptFailed,
+              XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::XAccountConnectionChallenge
+            )
+          end
+
+        class XAccountConnectionAttemptPending < XTwitterScraper::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::XAccountConnectionAttemptPending,
+                XTwitterScraper::Internal::AnyHash
+              )
+            end
+
+          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 XAccountConnectionAttemptSuccess < XTwitterScraper::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::XAccountConnectionAttemptSuccess,
+                XTwitterScraper::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(Symbol) }
+          attr_accessor :object
+
+          sig { returns(Symbol) }
+          attr_accessor :status
+
+          # The account connected successfully.
+          sig do
+            params(id: String, object: Symbol, status: Symbol).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            id:,
+            object: :x_account_connection_attempt,
+            status: :success
+          )
+          end
+
+          sig do
+            override.returns({ id: String, object: Symbol, status: Symbol })
+          end
+          def to_hash
+          end
+        end
+
+        class XAccountConnectionAttemptFailed < XTwitterScraper::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::XAccountConnectionAttemptFailed,
+                XTwitterScraper::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(String) }
+          attr_accessor :error
+
+          sig { returns(Symbol) }
+          attr_accessor :object
+
+          sig { returns(T::Boolean) }
+          attr_accessor :retryable
+
+          sig { returns(Symbol) }
+          attr_accessor :status
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :reason
+
+          sig { params(reason: String).void }
+          attr_writer :reason
+
+          # The connection reached a final failure.
+          sig do
+            params(
+              id: String,
+              error: String,
+              retryable: T::Boolean,
+              reason: String,
+              object: Symbol,
+              status: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            id:,
+            error:,
+            retryable:,
+            reason: nil,
+            object: :x_account_connection_attempt,
+            status: :failed
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                error: String,
+                object: Symbol,
+                retryable: T::Boolean,
+                status: Symbol,
+                reason: String
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class XAccountConnectionChallenge < XTwitterScraper::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::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 do
+            returns(
+              XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::XAccountConnectionChallenge::Object::TaggedSymbol
+            )
+          end
+          attr_accessor :object
+
+          sig do
+            returns(
+              XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::XAccountConnectionChallenge::Status::TaggedSymbol
+            )
+          end
+          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,
+              object:
+                XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::XAccountConnectionChallenge::Object::OrSymbol,
+              status:
+                XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::XAccountConnectionChallenge::Status::OrSymbol,
+              username: String
+            ).returns(T.attached_class)
+          end
+          def self.new(id:, expires_at:, message:, object:, status:, username:)
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                expires_at: Time,
+                message: String,
+                object:
+                  XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::XAccountConnectionChallenge::Object::TaggedSymbol,
+                status:
+                  XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::XAccountConnectionChallenge::Status::TaggedSymbol,
+                username: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module Object
+            extend XTwitterScraper::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::XAccountConnectionChallenge::Object
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            X_ACCOUNT_CONNECTION_CHALLENGE =
+              T.let(
+                :x_account_connection_challenge,
+                XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::XAccountConnectionChallenge::Object::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::XAccountConnectionChallenge::Object::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          module Status
+            extend XTwitterScraper::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::XAccountConnectionChallenge::Status
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            REQUIRES_EMAIL_CODE =
+              T.let(
+                :requires_email_code,
+                XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::XAccountConnectionChallenge::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::XAccountConnectionChallenge::Status::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
+        sig do
+          override.returns(
+            T::Array[
+              XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::Variants
+            ]
+          )
+        end
+        def self.variants
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/x/account_create_params.rbi

@@ -27,23 +27,20 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :password
 
+        # Authenticator App TOTP secret required for durable login
+        sig { returns(String) }
+        attr_accessor :totp_secret
+
         # X username
         sig { returns(String) }
         attr_accessor :username
 
-        # TOTP secret for 2FA
-        sig { returns(T.nilable(String)) }
-        attr_reader :totp_secret
-
-        sig { params(totp_secret: String).void }
-        attr_writer :totp_secret
-
         sig do
           params(
             email: String,
             password: String,
-            username: String,
             totp_secret: String,
+            username: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -52,10 +49,10 @@ module XTwitterScraper
           email:,
           # Account password
           password:,
+          # Authenticator App TOTP secret required for durable login
+          totp_secret:,
           # X username
           username:,
-          # TOTP secret for 2FA
-          totp_secret: nil,
           request_options: {}
         )
         end
@@ -65,8 +62,8 @@ module XTwitterScraper
             {
               email: String,
               password: String,
-              username: String,
               totp_secret: String,
+              username: String,
               request_options: XTwitterScraper::RequestOptions
             }
           )

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

@@ -7,129 +7,8 @@
 module XTwitterScraper
   module Models
     module X
-      class AccountCreateResponse < XTwitterScraper::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              XTwitterScraper::Models::X::AccountCreateResponse,
-              XTwitterScraper::Internal::AnyHash
-            )
-          end
-
-        sig { returns(String) }
-        attr_accessor :id
-
-        sig { returns(Time) }
-        attr_accessor :created_at
-
-        sig do
-          returns(
-            XTwitterScraper::Models::X::AccountCreateResponse::Health::TaggedSymbol
-          )
-        end
-        attr_accessor :health
-
-        sig { returns(String) }
-        attr_accessor :status
-
-        sig { returns(String) }
-        attr_accessor :x_user_id
-
-        sig { returns(String) }
-        attr_accessor :x_username
-
-        # 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 do
-          override.returns(
-            {
-              id: String,
-              created_at: Time,
-              health:
-                XTwitterScraper::Models::X::AccountCreateResponse::Health::TaggedSymbol,
-              status: String,
-              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::Health
-              )
-            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 do
-            override.returns(
-              T::Array[
-                XTwitterScraper::Models::X::AccountCreateResponse::Health::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
+      AccountCreateResponse =
+        T.let(T.anything, XTwitterScraper::Internal::Type::Converter)
     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/x_account.rbi

@@ -24,11 +24,11 @@ module XTwitterScraper
         sig { returns(Time) }
         attr_accessor :created_at
 
-        # Derived connection health. `healthy` = session active. `needsReauth` = user must
+        # 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` = past cooldown, will
-        # auto-retry on next use. `temporaryIssue` = temporary connection problem; retry
-        # shortly.
+        # 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.
         sig { returns(XTwitterScraper::X::XAccount::Health::TaggedSymbol) }
         attr_accessor :health
 
@@ -66,11 +66,11 @@ module XTwitterScraper
         def self.new(
           id:,
           created_at:,
-          # Derived connection health. `healthy` = session active. `needsReauth` = user must
+          # 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` = past cooldown, will
-          # auto-retry on next use. `temporaryIssue` = temporary connection problem; retry
-          # shortly.
+          # 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.
           health:,
           status:,
           updated_at:,
@@ -97,11 +97,11 @@ module XTwitterScraper
         def to_hash
         end
 
-        # Derived connection health. `healthy` = session active. `needsReauth` = user must
+        # 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` = past cooldown, will
-        # auto-retry on next use. `temporaryIssue` = temporary connection problem; retry
-        # shortly.
+        # 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.
         module Health
           extend XTwitterScraper::Internal::Type::Enum
 

data/rbi/x_twitter_scraper/resources/compose.rbi

@@ -8,10 +8,10 @@ module XTwitterScraper
   module Resources
     # AI tweet composition, drafts, writing styles, and radar
     class Compose
-      # Run one step of Xquik's three-step writing workflow. Compose returns questions
-      # and editorial rules. Refine returns goal-specific guidance. Score applies
-      # deterministic text checks. It does not predict reach or expose X ranking
-      # weights.
+      # Run one step of Xquik's three-step writing workflow. Compose returns questions,
+      # editorial rules, and source-specific Radar recommendations. Refine returns
+      # goal-specific guidance. Score applies deterministic text checks. It does not
+      # predict reach or expose X ranking weights.
       sig do
         params(
           body:

data/rbi/x_twitter_scraper/resources/x/account_connection_attempts.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module XTwitterScraper
+  module Resources
+    class X
+      # Connected X account management
+      class AccountConnectionAttempts
+        # Get X account connection status
+        sig do
+          params(
+            id: String,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(
+            XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::Variants
+          )
+        end
+        def retrieve(
+          # Connection attempt ID returned by `POST /x/accounts`.
+          id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig do
+          params(client: XTwitterScraper::Client).returns(T.attached_class)
+        end
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/resources/x/accounts.rbi

@@ -14,20 +14,20 @@ module XTwitterScraper
           params(
             email: String,
             password: String,
-            username: String,
             totp_secret: String,
+            username: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
-          ).returns(XTwitterScraper::Models::X::AccountCreateResponse)
+          ).returns(T.anything)
         end
         def create(
           # Account email
           email:,
           # Account password
           password:,
+          # Authenticator App TOTP secret required for durable login
+          totp_secret:,
           # X username
           username:,
-          # TOTP secret for 2FA
-          totp_secret: nil,
           request_options: {}
         )
         end
@@ -96,7 +96,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/resources/x.rbi

@@ -44,6 +44,10 @@ module XTwitterScraper
       end
       attr_reader :account_connection_challenges
 
+      # Connected X account management
+      sig { returns(XTwitterScraper::Resources::X::AccountConnectionAttempts) }
+      attr_reader :account_connection_attempts
+
       # Look up, search, and analyze individual tweets
       sig { returns(XTwitterScraper::Resources::X::Bookmarks) }
       attr_reader :bookmarks