x-twitter-scraper 0.4.2 → 0.4.4

data/rbi/x_twitter_scraper/models/x/write_action_retrieve_response.rbi

@@ -0,0 +1,313 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    module X
+      class WriteActionRetrieveResponse < XTwitterScraper::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::Models::X::WriteActionRetrieveResponse,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :action
+
+        sig { returns(T::Boolean) }
+        attr_accessor :charged
+
+        sig { returns(String) }
+        attr_accessor :charged_credits
+
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        sig do
+          returns(
+            XTwitterScraper::Models::X::WriteActionRetrieveResponse::Media
+          )
+        end
+        attr_reader :media
+
+        sig do
+          params(
+            media:
+              XTwitterScraper::Models::X::WriteActionRetrieveResponse::Media::OrHash
+          ).void
+        end
+        attr_writer :media
+
+        sig { returns(T::Boolean) }
+        attr_accessor :retryable
+
+        sig { returns(T::Boolean) }
+        attr_accessor :send_dispatched
+
+        sig do
+          returns(
+            XTwitterScraper::Models::X::WriteActionRetrieveResponse::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        sig { returns(String) }
+        attr_accessor :write_action_id
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :confirmation_attempts
+
+        sig { params(confirmation_attempts: Integer).void }
+        attr_writer :confirmation_attempts
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :confirmation_checked_at
+
+        sig { params(confirmation_checked_at: Time).void }
+        attr_writer :confirmation_checked_at
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :confirmation_source
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :confirmed_at
+
+        sig { params(confirmed_at: Time).void }
+        attr_writer :confirmed_at
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :message
+
+        sig { params(message: String).void }
+        attr_writer :message
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :message_id
+
+        sig { params(message_id: String).void }
+        attr_writer :message_id
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :send_dispatched_at
+
+        sig { params(send_dispatched_at: Time).void }
+        attr_writer :send_dispatched_at
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :target_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :tweet_id
+
+        sig { params(tweet_id: String).void }
+        attr_writer :tweet_id
+
+        sig do
+          params(
+            action: String,
+            charged: T::Boolean,
+            charged_credits: String,
+            created_at: Time,
+            media:
+              XTwitterScraper::Models::X::WriteActionRetrieveResponse::Media::OrHash,
+            send_dispatched: T::Boolean,
+            status:
+              XTwitterScraper::Models::X::WriteActionRetrieveResponse::Status::OrSymbol,
+            write_action_id: String,
+            confirmation_attempts: Integer,
+            confirmation_checked_at: Time,
+            confirmation_source: T.nilable(String),
+            confirmed_at: Time,
+            message: String,
+            message_id: String,
+            send_dispatched_at: Time,
+            target_id: T.nilable(String),
+            tweet_id: String,
+            retryable: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          action:,
+          charged:,
+          charged_credits:,
+          created_at:,
+          media:,
+          send_dispatched:,
+          status:,
+          write_action_id:,
+          confirmation_attempts: nil,
+          confirmation_checked_at: nil,
+          confirmation_source: nil,
+          confirmed_at: nil,
+          message: nil,
+          message_id: nil,
+          send_dispatched_at: nil,
+          target_id: nil,
+          tweet_id: nil,
+          retryable: false
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              action: String,
+              charged: T::Boolean,
+              charged_credits: String,
+              created_at: Time,
+              media:
+                XTwitterScraper::Models::X::WriteActionRetrieveResponse::Media,
+              retryable: T::Boolean,
+              send_dispatched: T::Boolean,
+              status:
+                XTwitterScraper::Models::X::WriteActionRetrieveResponse::Status::TaggedSymbol,
+              write_action_id: String,
+              confirmation_attempts: Integer,
+              confirmation_checked_at: Time,
+              confirmation_source: T.nilable(String),
+              confirmed_at: Time,
+              message: String,
+              message_id: String,
+              send_dispatched_at: Time,
+              target_id: T.nilable(String),
+              tweet_id: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Media < XTwitterScraper::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                XTwitterScraper::Models::X::WriteActionRetrieveResponse::Media,
+                XTwitterScraper::Internal::AnyHash
+              )
+            end
+
+          sig { returns(Integer) }
+          attr_accessor :count
+
+          sig { returns(String) }
+          attr_accessor :credits
+
+          sig do
+            returns(
+              XTwitterScraper::Models::X::WriteActionRetrieveResponse::Media::Kind::TaggedSymbol
+            )
+          end
+          attr_accessor :kind
+
+          sig { returns(String) }
+          attr_accessor :total_bytes
+
+          sig do
+            params(
+              count: Integer,
+              credits: String,
+              kind:
+                XTwitterScraper::Models::X::WriteActionRetrieveResponse::Media::Kind::OrSymbol,
+              total_bytes: String
+            ).returns(T.attached_class)
+          end
+          def self.new(count:, credits:, kind:, total_bytes:)
+          end
+
+          sig do
+            override.returns(
+              {
+                count: Integer,
+                credits: String,
+                kind:
+                  XTwitterScraper::Models::X::WriteActionRetrieveResponse::Media::Kind::TaggedSymbol,
+                total_bytes: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module Kind
+            extend XTwitterScraper::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  XTwitterScraper::Models::X::WriteActionRetrieveResponse::Media::Kind
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            NONE =
+              T.let(
+                :none,
+                XTwitterScraper::Models::X::WriteActionRetrieveResponse::Media::Kind::TaggedSymbol
+              )
+            IMAGE =
+              T.let(
+                :image,
+                XTwitterScraper::Models::X::WriteActionRetrieveResponse::Media::Kind::TaggedSymbol
+              )
+            VIDEO =
+              T.let(
+                :video,
+                XTwitterScraper::Models::X::WriteActionRetrieveResponse::Media::Kind::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  XTwitterScraper::Models::X::WriteActionRetrieveResponse::Media::Kind::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
+        module Status
+          extend XTwitterScraper::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                XTwitterScraper::Models::X::WriteActionRetrieveResponse::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SUCCESS =
+            T.let(
+              :success,
+              XTwitterScraper::Models::X::WriteActionRetrieveResponse::Status::TaggedSymbol
+            )
+          FAILED =
+            T.let(
+              :failed,
+              XTwitterScraper::Models::X::WriteActionRetrieveResponse::Status::TaggedSymbol
+            )
+          PENDING_CONFIRMATION =
+            T.let(
+              :pending_confirmation,
+              XTwitterScraper::Models::X::WriteActionRetrieveResponse::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                XTwitterScraper::Models::X::WriteActionRetrieveResponse::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -20,26 +20,60 @@ module XTwitterScraper
         sig { returns(Time) }
         attr_accessor :created_at
 
+        # Derived login/cookie health. `healthy` = cookies valid. `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` = transient backend problem; retry
+        # shortly.
+        sig { returns(XTwitterScraper::X::XAccount::Health::TaggedSymbol) }
+        attr_accessor :health
+
         sig { returns(String) }
         attr_accessor :status
 
+        sig { returns(Time) }
+        attr_accessor :updated_at
+
         sig { returns(String) }
         attr_accessor :x_user_id
 
         sig { returns(String) }
         attr_accessor :x_username
 
-        # Linked X account summary with username and connection status.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :cookies_obtained_at
+
+        sig { params(cookies_obtained_at: Time).void }
+        attr_writer :cookies_obtained_at
+
+        # Linked X account summary with connection status, health, and timestamp metadata.
         sig do
           params(
             id: String,
             created_at: Time,
+            health: XTwitterScraper::X::XAccount::Health::OrSymbol,
             status: String,
+            updated_at: Time,
             x_user_id: String,
-            x_username: String
+            x_username: String,
+            cookies_obtained_at: Time
           ).returns(T.attached_class)
         end
-        def self.new(id:, created_at:, status:, x_user_id:, x_username:)
+        def self.new(
+          id:,
+          created_at:,
+          # Derived login/cookie health. `healthy` = cookies valid. `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` = transient backend problem; retry
+          # shortly.
+          health:,
+          status:,
+          updated_at:,
+          x_user_id:,
+          x_username:,
+          cookies_obtained_at: nil
+        )
         end
 
         sig do
@@ -47,14 +81,63 @@ module XTwitterScraper
             {
               id: String,
               created_at: Time,
+              health: XTwitterScraper::X::XAccount::Health::TaggedSymbol,
               status: String,
+              updated_at: Time,
               x_user_id: String,
-              x_username: String
+              x_username: String,
+              cookies_obtained_at: Time
             }
           )
         end
         def to_hash
         end
+
+        # Derived login/cookie health. `healthy` = cookies valid. `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` = transient backend problem; retry
+        # shortly.
+        module Health
+          extend XTwitterScraper::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, XTwitterScraper::X::XAccount::Health) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          HEALTHY =
+            T.let(:healthy, XTwitterScraper::X::XAccount::Health::TaggedSymbol)
+          LOCKED =
+            T.let(:locked, XTwitterScraper::X::XAccount::Health::TaggedSymbol)
+          NEEDS_REAUTH =
+            T.let(
+              :needsReauth,
+              XTwitterScraper::X::XAccount::Health::TaggedSymbol
+            )
+          RECOVERING =
+            T.let(
+              :recovering,
+              XTwitterScraper::X::XAccount::Health::TaggedSymbol
+            )
+          SUSPENDED =
+            T.let(
+              :suspended,
+              XTwitterScraper::X::XAccount::Health::TaggedSymbol
+            )
+          TEMPORARY_ISSUE =
+            T.let(
+              :temporaryIssue,
+              XTwitterScraper::X::XAccount::Health::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[XTwitterScraper::X::XAccount::Health::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end

data/rbi/x_twitter_scraper/models/x/x_account_detail.rbi

@@ -20,6 +20,11 @@ module XTwitterScraper
         sig { returns(Time) }
         attr_accessor :created_at
 
+        sig do
+          returns(XTwitterScraper::X::XAccountDetail::Health::TaggedSymbol)
+        end
+        attr_accessor :health
+
         sig { returns(String) }
         attr_accessor :status
 
@@ -35,39 +40,33 @@ module XTwitterScraper
         sig { params(cookies_obtained_at: Time).void }
         attr_writer :cookies_obtained_at
 
-        sig { returns(T.nilable(String)) }
-        attr_reader :proxy_country
-
-        sig { params(proxy_country: String).void }
-        attr_writer :proxy_country
-
         sig { returns(T.nilable(Time)) }
         attr_reader :updated_at
 
         sig { params(updated_at: Time).void }
         attr_writer :updated_at
 
-        # Full X account details including proxy, cookies, and update timestamp.
+        # Full X account details with status, cookies, and update timestamp.
         sig do
           params(
             id: String,
             created_at: Time,
+            health: XTwitterScraper::X::XAccountDetail::Health::OrSymbol,
             status: String,
             x_user_id: String,
             x_username: String,
             cookies_obtained_at: Time,
-            proxy_country: String,
             updated_at: Time
           ).returns(T.attached_class)
         end
         def self.new(
           id:,
           created_at:,
+          health:,
           status:,
           x_user_id:,
           x_username:,
           cookies_obtained_at: nil,
-          proxy_country: nil,
           updated_at: nil
         )
         end
@@ -77,17 +76,66 @@ module XTwitterScraper
             {
               id: String,
               created_at: Time,
+              health: XTwitterScraper::X::XAccountDetail::Health::TaggedSymbol,
               status: String,
               x_user_id: String,
               x_username: String,
               cookies_obtained_at: Time,
-              proxy_country: String,
               updated_at: Time
             }
           )
         end
         def to_hash
         end
+
+        module Health
+          extend XTwitterScraper::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, XTwitterScraper::X::XAccountDetail::Health)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          HEALTHY =
+            T.let(
+              :healthy,
+              XTwitterScraper::X::XAccountDetail::Health::TaggedSymbol
+            )
+          LOCKED =
+            T.let(
+              :locked,
+              XTwitterScraper::X::XAccountDetail::Health::TaggedSymbol
+            )
+          NEEDS_REAUTH =
+            T.let(
+              :needsReauth,
+              XTwitterScraper::X::XAccountDetail::Health::TaggedSymbol
+            )
+          RECOVERING =
+            T.let(
+              :recovering,
+              XTwitterScraper::X::XAccountDetail::Health::TaggedSymbol
+            )
+          SUSPENDED =
+            T.let(
+              :suspended,
+              XTwitterScraper::X::XAccountDetail::Health::TaggedSymbol
+            )
+          TEMPORARY_ISSUE =
+            T.let(
+              :temporaryIssue,
+              XTwitterScraper::X::XAccountDetail::Health::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[XTwitterScraper::X::XAccountDetail::Health::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end