x-twitter-scraper 0.5.5 → 0.7.0

data/lib/x_twitter_scraper/models/x/account_create_response.rb

@@ -7,62 +7,154 @@
 module XTwitterScraper
   module Models
     module X
+      # Sanitized X account summary returned by connect and reauth.
+      #
       # @see XTwitterScraper::Resources::X::Accounts#create
-      class AccountCreateResponse < XTwitterScraper::Internal::Type::BaseModel
-        # @!attribute id
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute created_at
-        #
-        #   @return [Time]
-        required :created_at, Time, api_name: :createdAt
-
-        # @!attribute health
-        #
-        #   @return [Symbol, XTwitterScraper::Models::X::AccountCreateResponse::Health]
-        required :health, enum: -> { XTwitterScraper::Models::X::AccountCreateResponse::Health }
-
-        # @!attribute status
-        #
-        #   @return [String]
-        required :status, String
-
-        # @!attribute x_user_id
-        #
-        #   @return [String]
-        required :x_user_id, String, api_name: :xUserId
-
-        # @!attribute x_username
-        #
-        #   @return [String]
-        required :x_username, String, api_name: :xUsername
-
-        # @!method initialize(id:, created_at:, health:, status:, x_user_id:, x_username:)
-        #   Sanitized X account summary returned by connect and reauth.
-        #
-        #   @param id [String]
-        #   @param created_at [Time]
-        #   @param health [Symbol, XTwitterScraper::Models::X::AccountCreateResponse::Health]
-        #   @param status [String]
-        #   @param x_user_id [String]
-        #   @param x_username [String]
-
-        # @see XTwitterScraper::Models::X::AccountCreateResponse#health
-        module Health
-          extend XTwitterScraper::Internal::Type::Enum
-
-          HEALTHY = :healthy
-          LOCKED = :locked
-          NEEDS_REAUTH = :needsReauth
-          RECOVERING = :recovering
-          SUSPENDED = :suspended
-          TEMPORARY_ISSUE = :temporaryIssue
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
+      module AccountCreateResponse
+        extend XTwitterScraper::Internal::Type::Union
+
+        # Sanitized X account summary returned by connect and reauth.
+        variant -> { XTwitterScraper::Models::X::AccountCreateResponse::SanitizedXAccount }
+
+        # The connection is still in progress.
+        variant -> { XTwitterScraper::Models::X::AccountCreateResponse::XAccountConnectionAttemptPending }
+
+        # Resumable account connection challenge. Submit the email code to finish the same connection attempt.
+        variant -> { XTwitterScraper::Models::X::AccountCreateResponse::XAccountConnectionChallenge }
+
+        class SanitizedXAccount < XTwitterScraper::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute created_at
+          #
+          #   @return [Time]
+          required :created_at, Time, api_name: :createdAt
+
+          # @!attribute health
+          #
+          #   @return [Symbol, XTwitterScraper::Models::X::AccountCreateResponse::SanitizedXAccount::Health]
+          required :health,
+                   enum: -> { XTwitterScraper::Models::X::AccountCreateResponse::SanitizedXAccount::Health }
+
+          # @!attribute status
+          #
+          #   @return [Symbol, :active]
+          required :status, const: :active
+
+          # @!attribute x_user_id
+          #
+          #   @return [String]
+          required :x_user_id, String, api_name: :xUserId
+
+          # @!attribute x_username
+          #
+          #   @return [String]
+          required :x_username, String, api_name: :xUsername
+
+          # @!method initialize(id:, created_at:, health:, x_user_id:, x_username:, status: :active)
+          #   Sanitized X account summary returned by connect and reauth.
+          #
+          #   @param id [String]
+          #   @param created_at [Time]
+          #   @param health [Symbol, XTwitterScraper::Models::X::AccountCreateResponse::SanitizedXAccount::Health]
+          #   @param x_user_id [String]
+          #   @param x_username [String]
+          #   @param status [Symbol, :active]
+
+          # @see XTwitterScraper::Models::X::AccountCreateResponse::SanitizedXAccount#health
+          module Health
+            extend XTwitterScraper::Internal::Type::Enum
+
+            HEALTHY = :healthy
+            LOCKED = :locked
+            NEEDS_REAUTH = :needsReauth
+            RECOVERING = :recovering
+            SUSPENDED = :suspended
+            TEMPORARY_ISSUE = :temporaryIssue
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class XAccountConnectionAttemptPending < XTwitterScraper::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute object
+          #
+          #   @return [Symbol, :x_account_connection_attempt]
+          required :object, const: :x_account_connection_attempt
+
+          # @!attribute poll_after_ms
+          #
+          #   @return [Integer]
+          required :poll_after_ms, Integer, api_name: :pollAfterMs
+
+          # @!attribute status
+          #
+          #   @return [Symbol, :pending]
+          required :status, const: :pending
+
+          # @!method initialize(id:, poll_after_ms:, object: :x_account_connection_attempt, status: :pending)
+          #   The connection is still in progress.
+          #
+          #   @param id [String]
+          #   @param poll_after_ms [Integer]
+          #   @param object [Symbol, :x_account_connection_attempt]
+          #   @param status [Symbol, :pending]
+        end
+
+        class XAccountConnectionChallenge < XTwitterScraper::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute expires_at
+          #
+          #   @return [Time]
+          required :expires_at, Time, api_name: :expiresAt
+
+          # @!attribute message
+          #
+          #   @return [String]
+          required :message, String
+
+          # @!attribute object
+          #
+          #   @return [Symbol, :x_account_connection_challenge]
+          required :object, const: :x_account_connection_challenge
+
+          # @!attribute status
+          #
+          #   @return [Symbol, :requires_email_code]
+          required :status, const: :requires_email_code
+
+          # @!attribute username
+          #
+          #   @return [String]
+          required :username, String
+
+          # @!method initialize(id:, expires_at:, message:, username:, object: :x_account_connection_challenge, status: :requires_email_code)
+          #   Resumable account connection challenge. Submit the email code to finish the same
+          #   connection attempt.
+          #
+          #   @param id [String]
+          #   @param expires_at [Time]
+          #   @param message [String]
+          #   @param username [String]
+          #   @param object [Symbol, :x_account_connection_challenge]
+          #   @param status [Symbol, :requires_email_code]
         end
+
+        # @!method self.variants
+        #   @return [Array(XTwitterScraper::Models::X::AccountCreateResponse::SanitizedXAccount, XTwitterScraper::Models::X::AccountCreateResponse::XAccountConnectionAttemptPending, XTwitterScraper::Models::X::AccountCreateResponse::XAccountConnectionChallenge)]
       end
     end
   end

data/lib/x_twitter_scraper/models/x/account_reauth_params.rb

@@ -30,7 +30,7 @@ module XTwitterScraper
         optional :email, String
 
         # @!attribute totp_secret
-        #   TOTP secret for 2FA re-authentication
+        #   Replacement Authenticator App TOTP secret. Omit it to reuse the saved secret.
         #
         #   @return [String, nil]
         optional :totp_secret, String
@@ -42,7 +42,7 @@ module XTwitterScraper
         #
         #   @param email [String] Email for the X account (updates stored email)
         #
-        #   @param totp_secret [String] TOTP secret for 2FA re-authentication
+        #   @param totp_secret [String] Replacement Authenticator App TOTP secret. Omit it to reuse the saved secret.
         #
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/x_twitter_scraper/models/x/account_reauth_response.rb

@@ -26,8 +26,8 @@ module XTwitterScraper
 
         # @!attribute status
         #
-        #   @return [String]
-        required :status, String
+        #   @return [Symbol, :active]
+        required :status, const: :active
 
         # @!attribute x_user_id
         #
@@ -39,15 +39,15 @@ module XTwitterScraper
         #   @return [String]
         required :x_username, String, api_name: :xUsername
 
-        # @!method initialize(id:, created_at:, health:, status:, x_user_id:, x_username:)
+        # @!method initialize(id:, created_at:, health:, x_user_id:, x_username:, status: :active)
         #   Sanitized X account summary returned by connect and reauth.
         #
         #   @param id [String]
         #   @param created_at [Time]
         #   @param health [Symbol, XTwitterScraper::Models::X::AccountReauthResponse::Health]
-        #   @param status [String]
         #   @param x_user_id [String]
         #   @param x_username [String]
+        #   @param status [Symbol, :active]
 
         # @see XTwitterScraper::Models::X::AccountReauthResponse#health
         module Health

data/lib/x_twitter_scraper/models/x/communities/tweet_list_by_community_params.rb

@@ -25,10 +25,8 @@ module XTwitterScraper
           optional :cursor, String
 
           # @!attribute page_size
-          #   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.
           #
           #   @return [Integer, nil]
@@ -43,7 +41,7 @@ module XTwitterScraper
           #
           #   @param cursor [String] Pagination cursor for community tweets
           #
-          #   @param page_size [Integer] Maximum items requested from this page (1-100, default 20). The response can con
+          #   @param page_size [Integer] Maximum page items (1-100, default 20). Source, filters, or credits can reduce r
           #
           #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
         end

data/lib/x_twitter_scraper/models/x/communities/tweet_list_params.rb

@@ -32,10 +32,8 @@ module XTwitterScraper
           optional :cursor, String
 
           # @!attribute page_size
-          #   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.
           #
           #   @return [Integer, nil]
@@ -57,7 +55,7 @@ module XTwitterScraper
           #
           #   @param cursor [String] Pagination cursor for community results
           #
-          #   @param page_size [Integer] Maximum items requested from this page (1-100, default 20). The response can con
+          #   @param page_size [Integer] Maximum page items (1-100, default 20). Source, filters, or credits can reduce r
           #
           #   @param query_type [Symbol, XTwitterScraper::Models::X::Communities::TweetListParams::QueryType] Sort order for community results (Latest or Top)
           #

data/lib/x_twitter_scraper/models/x/community_retrieve_info_response.rb

@@ -55,12 +55,6 @@ module XTwitterScraper
           #   @return [String, nil]
           optional :invites_policy, String
 
-          # @!attribute is_member
-          #   Whether the authenticated viewer is a member
-          #
-          #   @return [Boolean, nil]
-          optional :is_member, XTwitterScraper::Internal::Type::Boolean
-
           # @!attribute is_nsfw
           #   Whether the community is marked sensitive
           #
@@ -98,12 +92,6 @@ module XTwitterScraper
           optional :primary_topic,
                    -> { XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::PrimaryTopic }
 
-          # @!attribute role
-          #   Authenticated viewer's community role
-          #
-          #   @return [String, nil]
-          optional :role, String
-
           # @!attribute rules
           #   Community rules
           #
@@ -111,7 +99,7 @@ module XTwitterScraper
           optional :rules,
                    -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::Rule] }
 
-          # @!method initialize(id:, banner_url: nil, created_at: nil, creator: nil, description: nil, invites_policy: nil, is_member: nil, is_nsfw: nil, join_policy: nil, member_count: nil, moderator_count: nil, name: nil, primary_topic: nil, role: nil, rules: nil)
+          # @!method initialize(id:, banner_url: nil, created_at: nil, creator: nil, description: nil, invites_policy: nil, is_nsfw: nil, join_policy: nil, member_count: nil, moderator_count: nil, name: nil, primary_topic: nil, rules: nil)
           #   Community info object
           #
           #   @param id [String] Unique community identifier
@@ -126,8 +114,6 @@ module XTwitterScraper
           #
           #   @param invites_policy [String] Invitation policy
           #
-          #   @param is_member [Boolean] Whether the authenticated viewer is a member
-          #
           #   @param is_nsfw [Boolean] Whether the community is marked sensitive
           #
           #   @param join_policy [String] Join policy (open or restricted)
@@ -140,8 +126,6 @@ module XTwitterScraper
           #
           #   @param primary_topic [XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::PrimaryTopic] Primary topic
           #
-          #   @param role [String] Authenticated viewer's community role
-          #
           #   @param rules [Array<XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::Rule>] Community rules
 
           # @see XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community#creator

data/lib/x_twitter_scraper/models/x/community_retrieve_search_params.rb

@@ -31,10 +31,8 @@ module XTwitterScraper
         optional :cursor, String
 
         # @!attribute page_size
-        #   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.
         #
         #   @return [Integer, nil]
@@ -56,7 +54,7 @@ module XTwitterScraper
         #
         #   @param cursor [String] Pagination cursor for community search
         #
-        #   @param page_size [Integer] Maximum items requested from this page (1-100, default 20). The response can con
+        #   @param page_size [Integer] Maximum page items (1-100, default 20). Source, filters, or credits can reduce r
         #
         #   @param query_type [Symbol, XTwitterScraper::Models::X::CommunityRetrieveSearchParams::QueryType] Sort order (Latest or Top)
         #

data/lib/x_twitter_scraper/models/x/list_retrieve_tweets_params.rb

@@ -30,10 +30,8 @@ module XTwitterScraper
         optional :include_replies, XTwitterScraper::Internal::Type::Boolean
 
         # @!attribute page_size
-        #   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.
         #
         #   @return [Integer, nil]
@@ -61,7 +59,7 @@ module XTwitterScraper
         #
         #   @param include_replies [Boolean] Include replies (default false)
         #
-        #   @param page_size [Integer] Maximum items requested from this page (1-100, default 20). The response can con
+        #   @param page_size [Integer] Maximum page items (1-100, default 20). Source, filters, or credits can reduce r
         #
         #   @param since_time [String] Unix timestamp - filter after
         #

data/lib/x_twitter_scraper/models/x/tweet_author.rb

@@ -8,9 +8,22 @@ module XTwitterScraper
   module Models
     module X
       class TweetAuthor < XTwitterScraper::Models::UserProfile
-        # @!method initialize
+        # @!attribute followers
+        #
+        #   @return [Integer]
+        required :followers, Integer
+
+        # @!attribute verified
+        #
+        #   @return [Boolean]
+        required :verified, XTwitterScraper::Internal::Type::Boolean
+
+        # @!method initialize(followers:, verified:)
         #   Tweet author profile. The lookup route always includes follower count and
         #   verification state. Other profile fields appear when available.
+        #
+        #   @param followers [Integer]
+        #   @param verified [Boolean]
       end
     end
   end