x-twitter-scraper 0.5.5 → 0.7.0

data/lib/x_twitter_scraper/models/user_profile.rb

@@ -22,15 +22,23 @@ module XTwitterScraper
       #   @return [String]
       required :username, String
 
+      # @!attribute affiliates_highlighted_label
+      #   Organization affiliation label shown on an X profile.
+      #
+      #   @return [XTwitterScraper::Models::UserProfile::AffiliatesHighlightedLabel, nil]
+      optional :affiliates_highlighted_label,
+               -> { XTwitterScraper::UserProfile::AffiliatesHighlightedLabel },
+               api_name: :affiliatesHighlightedLabel
+
       # @!attribute automated_by
       #
       #   @return [String, nil]
       optional :automated_by, String, api_name: :automatedBy
 
-      # @!attribute can_dm
+      # @!attribute business_account_affiliates_count
       #
-      #   @return [Boolean, nil]
-      optional :can_dm, XTwitterScraper::Internal::Type::Boolean, api_name: :canDm
+      #   @return [Integer, nil]
+      optional :business_account_affiliates_count, Integer, api_name: :businessAccountAffiliatesCount
 
       # @!attribute community_role
       #   Community role when returned by community member reads
@@ -48,6 +56,11 @@ module XTwitterScraper
       #   @return [String, nil]
       optional :created_at, String, api_name: :createdAt
 
+      # @!attribute creator_subscriptions_count
+      #
+      #   @return [Integer, nil]
+      optional :creator_subscriptions_count, Integer, api_name: :creatorSubscriptionsCount
+
       # @!attribute description
       #
       #   @return [String, nil]
@@ -73,6 +86,36 @@ module XTwitterScraper
       #   @return [Boolean, nil]
       optional :has_custom_timelines, XTwitterScraper::Internal::Type::Boolean, api_name: :hasCustomTimelines
 
+      # @!attribute has_graduated_access
+      #
+      #   @return [Boolean, nil]
+      optional :has_graduated_access, XTwitterScraper::Internal::Type::Boolean, api_name: :hasGraduatedAccess
+
+      # @!attribute has_hidden_subscriptions_on_profile
+      #
+      #   @return [Boolean, nil]
+      optional :has_hidden_subscriptions_on_profile,
+               XTwitterScraper::Internal::Type::Boolean,
+               api_name: :hasHiddenSubscriptionsOnProfile
+
+      # @!attribute highlights_info
+      #   Profile highlight availability and count metadata.
+      #
+      #   @return [XTwitterScraper::Models::UserProfile::HighlightsInfo, nil]
+      optional :highlights_info,
+               -> {
+                 XTwitterScraper::UserProfile::HighlightsInfo
+               },
+               api_name: :highlightsInfo
+
+      # @!attribute identity_verification
+      #   Identity verification metadata displayed by X.
+      #
+      #   @return [XTwitterScraper::Models::UserProfile::IdentityVerification, nil]
+      optional :identity_verification,
+               -> { XTwitterScraper::UserProfile::IdentityVerification },
+               api_name: :identityVerification
+
       # @!attribute is_automated
       #
       #   @return [Boolean, nil]
@@ -84,6 +127,13 @@ module XTwitterScraper
       #   @return [Boolean, nil]
       optional :is_blue_verified, XTwitterScraper::Internal::Type::Boolean, api_name: :isBlueVerified
 
+      # @!attribute is_profile_translatable
+      #
+      #   @return [Boolean, nil]
+      optional :is_profile_translatable,
+               XTwitterScraper::Internal::Type::Boolean,
+               api_name: :isProfileTranslatable
+
       # @!attribute is_translator
       #
       #   @return [Boolean, nil]
@@ -105,6 +155,11 @@ module XTwitterScraper
       #   @return [Integer, nil]
       optional :media_count, Integer, api_name: :mediaCount
 
+      # @!attribute parody_commentary_fan_label
+      #
+      #   @return [String, nil]
+      optional :parody_commentary_fan_label, String, api_name: :parodyCommentaryFanLabel
+
       # @!attribute pinned_tweet_ids
       #
       #   @return [Array<String>, nil]
@@ -127,11 +182,36 @@ module XTwitterScraper
       #   @return [String, nil]
       optional :profile_banner_url, String, api_name: :profileBannerUrl
 
+      # @!attribute profile_description_language
+      #
+      #   @return [String, nil]
+      optional :profile_description_language, String, api_name: :profileDescriptionLanguage
+
+      # @!attribute profile_image_shape
+      #
+      #   @return [String, nil]
+      optional :profile_image_shape, String, api_name: :profileImageShape
+
+      # @!attribute profile_interstitial_type
+      #
+      #   @return [String, nil]
+      optional :profile_interstitial_type, String, api_name: :profileInterstitialType
+
       # @!attribute profile_picture
       #
       #   @return [String, nil]
       optional :profile_picture, String, api_name: :profilePicture
 
+      # @!attribute profile_sort_enabled
+      #
+      #   @return [Boolean, nil]
+      optional :profile_sort_enabled, XTwitterScraper::Internal::Type::Boolean, api_name: :profileSortEnabled
+
+      # @!attribute profile_translator_type
+      #
+      #   @return [String, nil]
+      optional :profile_translator_type, String, api_name: :profileTranslatorType
+
       # @!attribute protected
       #   Whether the profile protects its posts
       #
@@ -143,6 +223,13 @@ module XTwitterScraper
       #   @return [Integer, nil]
       optional :statuses_count, Integer, api_name: :statusesCount
 
+      # @!attribute super_follow_eligible
+      #
+      #   @return [Boolean, nil]
+      optional :super_follow_eligible,
+               XTwitterScraper::Internal::Type::Boolean,
+               api_name: :superFollowEligible
+
       # @!attribute unavailable
       #
       #   @return [Boolean, nil]
@@ -168,18 +255,6 @@ module XTwitterScraper
       #   @return [String, nil]
       optional :verified_type, String, api_name: :verifiedType
 
-      # @!attribute viewer_followed_by
-      #   Whether this profile follows the authenticated viewer
-      #
-      #   @return [Boolean, nil]
-      optional :viewer_followed_by, XTwitterScraper::Internal::Type::Boolean, api_name: :viewerFollowedBy
-
-      # @!attribute viewer_following
-      #   Whether the authenticated viewer follows this profile
-      #
-      #   @return [Boolean, nil]
-      optional :viewer_following, XTwitterScraper::Internal::Type::Boolean, api_name: :viewerFollowing
-
       # @!attribute withheld_in_countries
       #
       #   @return [Array<String>, nil]
@@ -187,7 +262,7 @@ module XTwitterScraper
                XTwitterScraper::Internal::Type::ArrayOf[String],
                api_name: :withheldInCountries
 
-      # @!method initialize(id:, name:, username:, automated_by: nil, can_dm: nil, community_role: nil, cover_picture: nil, created_at: nil, description: nil, favourites_count: nil, followers: nil, following: nil, has_custom_timelines: nil, is_automated: nil, is_blue_verified: nil, is_translator: nil, is_verified: nil, location: nil, media_count: nil, pinned_tweet_ids: nil, possibly_sensitive: nil, profile_bio: nil, profile_banner_url: nil, profile_picture: nil, protected: nil, statuses_count: nil, unavailable: nil, unavailable_reason: nil, url: nil, verified: nil, verified_type: nil, viewer_followed_by: nil, viewer_following: nil, withheld_in_countries: nil)
+      # @!method initialize(id:, name:, username:, affiliates_highlighted_label: nil, automated_by: nil, business_account_affiliates_count: nil, community_role: nil, cover_picture: nil, created_at: nil, creator_subscriptions_count: nil, description: nil, favourites_count: nil, followers: nil, following: nil, has_custom_timelines: nil, has_graduated_access: nil, has_hidden_subscriptions_on_profile: nil, highlights_info: nil, identity_verification: nil, is_automated: nil, is_blue_verified: nil, is_profile_translatable: nil, is_translator: nil, is_verified: nil, location: nil, media_count: nil, parody_commentary_fan_label: nil, pinned_tweet_ids: nil, possibly_sensitive: nil, profile_bio: nil, profile_banner_url: nil, profile_description_language: nil, profile_image_shape: nil, profile_interstitial_type: nil, profile_picture: nil, profile_sort_enabled: nil, profile_translator_type: nil, protected: nil, statuses_count: nil, super_follow_eligible: nil, unavailable: nil, unavailable_reason: nil, url: nil, verified: nil, verified_type: nil, withheld_in_countries: nil)
       #   X user profile with bio, follower counts, and verification status.
       #
       #   @param id [String]
@@ -196,9 +271,11 @@ module XTwitterScraper
       #
       #   @param username [String]
       #
+      #   @param affiliates_highlighted_label [XTwitterScraper::Models::UserProfile::AffiliatesHighlightedLabel] Organization affiliation label shown on an X profile.
+      #
       #   @param automated_by [String]
       #
-      #   @param can_dm [Boolean]
+      #   @param business_account_affiliates_count [Integer]
       #
       #   @param community_role [String] Community role when returned by community member reads
       #
@@ -206,6 +283,8 @@ module XTwitterScraper
       #
       #   @param created_at [String]
       #
+      #   @param creator_subscriptions_count [Integer]
+      #
       #   @param description [String]
       #
       #   @param favourites_count [Integer]
@@ -216,10 +295,20 @@ module XTwitterScraper
       #
       #   @param has_custom_timelines [Boolean]
       #
+      #   @param has_graduated_access [Boolean]
+      #
+      #   @param has_hidden_subscriptions_on_profile [Boolean]
+      #
+      #   @param highlights_info [XTwitterScraper::Models::UserProfile::HighlightsInfo] Profile highlight availability and count metadata.
+      #
+      #   @param identity_verification [XTwitterScraper::Models::UserProfile::IdentityVerification] Identity verification metadata displayed by X.
+      #
       #   @param is_automated [Boolean]
       #
       #   @param is_blue_verified [Boolean] Whether X shows a blue verification badge
       #
+      #   @param is_profile_translatable [Boolean]
+      #
       #   @param is_translator [Boolean]
       #
       #   @param is_verified [Boolean] Whether X marks the profile as verified
@@ -228,6 +317,8 @@ module XTwitterScraper
       #
       #   @param media_count [Integer]
       #
+      #   @param parody_commentary_fan_label [String]
+      #
       #   @param pinned_tweet_ids [Array<String>]
       #
       #   @param possibly_sensitive [Boolean]
@@ -236,12 +327,24 @@ module XTwitterScraper
       #
       #   @param profile_banner_url [String] Original X profile banner field when available
       #
+      #   @param profile_description_language [String]
+      #
+      #   @param profile_image_shape [String]
+      #
+      #   @param profile_interstitial_type [String]
+      #
       #   @param profile_picture [String]
       #
+      #   @param profile_sort_enabled [Boolean]
+      #
+      #   @param profile_translator_type [String]
+      #
       #   @param protected [Boolean] Whether the profile protects its posts
       #
       #   @param statuses_count [Integer]
       #
+      #   @param super_follow_eligible [Boolean]
+      #
       #   @param unavailable [Boolean]
       #
       #   @param unavailable_reason [String]
@@ -252,11 +355,98 @@ module XTwitterScraper
       #
       #   @param verified_type [String]
       #
-      #   @param viewer_followed_by [Boolean] Whether this profile follows the authenticated viewer
-      #
-      #   @param viewer_following [Boolean] Whether the authenticated viewer follows this profile
-      #
       #   @param withheld_in_countries [Array<String>]
+
+      # @see XTwitterScraper::Models::UserProfile#affiliates_highlighted_label
+      class AffiliatesHighlightedLabel < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute badge_url
+        #
+        #   @return [String, nil]
+        optional :badge_url, String, api_name: :badgeUrl
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute url
+        #
+        #   @return [String, nil]
+        optional :url, String
+
+        # @!attribute url_type
+        #
+        #   @return [String, nil]
+        optional :url_type, String, api_name: :urlType
+
+        # @!attribute user_label_display_type
+        #
+        #   @return [String, nil]
+        optional :user_label_display_type, String, api_name: :userLabelDisplayType
+
+        # @!attribute user_label_type
+        #
+        #   @return [String, nil]
+        optional :user_label_type, String, api_name: :userLabelType
+
+        # @!method initialize(badge_url: nil, description: nil, url: nil, url_type: nil, user_label_display_type: nil, user_label_type: nil)
+        #   Organization affiliation label shown on an X profile.
+        #
+        #   @param badge_url [String]
+        #   @param description [String]
+        #   @param url [String]
+        #   @param url_type [String]
+        #   @param user_label_display_type [String]
+        #   @param user_label_type [String]
+      end
+
+      # @see XTwitterScraper::Models::UserProfile#highlights_info
+      class HighlightsInfo < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute can_highlight_tweets
+        #
+        #   @return [Boolean, nil]
+        optional :can_highlight_tweets,
+                 XTwitterScraper::Internal::Type::Boolean,
+                 api_name: :canHighlightTweets
+
+        # @!attribute highlighted_tweets
+        #
+        #   @return [String, nil]
+        optional :highlighted_tweets, String, api_name: :highlightedTweets
+
+        # @!method initialize(can_highlight_tweets: nil, highlighted_tweets: nil)
+        #   Profile highlight availability and count metadata.
+        #
+        #   @param can_highlight_tweets [Boolean]
+        #   @param highlighted_tweets [String]
+      end
+
+      # @see XTwitterScraper::Models::UserProfile#identity_verification
+      class IdentityVerification < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute is_identity_verified
+        #
+        #   @return [Boolean, nil]
+        optional :is_identity_verified,
+                 XTwitterScraper::Internal::Type::Boolean,
+                 api_name: :isIdentityVerified
+
+        # @!attribute verified_since_msec
+        #
+        #   @return [String, nil]
+        optional :verified_since_msec, String, api_name: :verifiedSinceMsec
+
+        # @!method initialize(description: nil, is_identity_verified: nil, verified_since_msec: nil)
+        #   Identity verification metadata displayed by X.
+        #
+        #   @param description [String]
+        #   @param is_identity_verified [Boolean]
+        #   @param verified_since_msec [String]
+      end
     end
   end
 end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      # @see XTwitterScraper::Resources::X::AccountConnectionAttempts#retrieve
+      class AccountConnectionAttemptRetrieveParams < XTwitterScraper::Internal::Type::BaseModel
+        extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+        include XTwitterScraper::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:, request_options: {})
+        #   @param id [String]
+        #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,224 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      # The connection is still in progress.
+      #
+      # @see XTwitterScraper::Resources::X::AccountConnectionAttempts#retrieve
+      module AccountConnectionAttemptRetrieveResponse
+        extend XTwitterScraper::Internal::Type::Union
+
+        discriminator :status
+
+        # The connection is still in progress.
+        variant :pending, -> { XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::Pending }
+
+        # The account connected successfully.
+        variant :success, -> { XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::Success }
+
+        # The connection reached a final failure.
+        variant :failed, -> { XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::Failed }
+
+        # Resumable account connection challenge. Submit the email code to finish the same connection attempt.
+        variant :requires_email_code,
+                -> { XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::RequiresEmailCode }
+
+        class Pending < 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]
+
+          module Object
+            extend XTwitterScraper::Internal::Type::Enum
+
+            X_ACCOUNT_CONNECTION_ATTEMPT = :x_account_connection_attempt
+          end
+
+          module Status
+            extend XTwitterScraper::Internal::Type::Enum
+
+            PENDING = :pending
+          end
+        end
+
+        class Success < 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 status
+          #
+          #   @return [Symbol, :success]
+          required :status, const: :success
+
+          # @!method initialize(id:, object: :x_account_connection_attempt, status: :success)
+          #   The account connected successfully.
+          #
+          #   @param id [String]
+          #   @param object [Symbol, :x_account_connection_attempt]
+          #   @param status [Symbol, :success]
+
+          module Object
+            extend XTwitterScraper::Internal::Type::Enum
+
+            X_ACCOUNT_CONNECTION_ATTEMPT = :x_account_connection_attempt
+          end
+
+          module Status
+            extend XTwitterScraper::Internal::Type::Enum
+
+            SUCCESS = :success
+          end
+        end
+
+        class Failed < XTwitterScraper::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute error
+          #
+          #   @return [String]
+          required :error, String
+
+          # @!attribute object
+          #
+          #   @return [Symbol, :x_account_connection_attempt]
+          required :object, const: :x_account_connection_attempt
+
+          # @!attribute retryable
+          #
+          #   @return [Boolean]
+          required :retryable, XTwitterScraper::Internal::Type::Boolean
+
+          # @!attribute status
+          #
+          #   @return [Symbol, :failed]
+          required :status, const: :failed
+
+          # @!attribute reason
+          #
+          #   @return [String, nil]
+          optional :reason, String
+
+          # @!method initialize(id:, error:, retryable:, reason: nil, object: :x_account_connection_attempt, status: :failed)
+          #   The connection reached a final failure.
+          #
+          #   @param id [String]
+          #   @param error [String]
+          #   @param retryable [Boolean]
+          #   @param reason [String]
+          #   @param object [Symbol, :x_account_connection_attempt]
+          #   @param status [Symbol, :failed]
+
+          module Object
+            extend XTwitterScraper::Internal::Type::Enum
+
+            X_ACCOUNT_CONNECTION_ATTEMPT = :x_account_connection_attempt
+          end
+
+          module Status
+            extend XTwitterScraper::Internal::Type::Enum
+
+            FAILED = :failed
+          end
+        end
+
+        class RequiresEmailCode < 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]
+
+          module Object
+            extend XTwitterScraper::Internal::Type::Enum
+
+            X_ACCOUNT_CONNECTION_CHALLENGE = :x_account_connection_challenge
+          end
+
+          module Status
+            extend XTwitterScraper::Internal::Type::Enum
+
+            REQUIRES_EMAIL_CODE = :requires_email_code
+          end
+        end
+
+        XAccountConnectionAttemptPending = Pending
+        XAccountConnectionAttemptSuccess = Success
+        XAccountConnectionAttemptFailed = Failed
+        XAccountConnectionChallenge = RequiresEmailCode
+
+        # @!method self.variants
+        #   @return [Array(XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::Pending, XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::Success, XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::Failed, XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::RequiresEmailCode)]
+      end
+    end
+  end
+end

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

@@ -27,8 +27,8 @@ module XTwitterScraper
 
         # @!attribute status
         #
-        #   @return [String]
-        required :status, String
+        #   @return [Symbol, :active]
+        required :status, const: :active
 
         # @!attribute x_user_id
         #
@@ -40,15 +40,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::AccountConnectionChallengeSubmitResponse::Health]
-        #   @param status [String]
         #   @param x_user_id [String]
         #   @param x_username [String]
+        #   @param status [Symbol, :active]
 
         # @see XTwitterScraper::Models::X::AccountConnectionChallengeSubmitResponse#health
         module Health

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

@@ -24,26 +24,26 @@ module XTwitterScraper
         #   @return [String]
         required :password, String
 
+        # @!attribute totp_secret
+        #   Authenticator App TOTP secret required for durable login
+        #
+        #   @return [String]
+        required :totp_secret, String
+
         # @!attribute username
         #   X username
         #
         #   @return [String]
         required :username, String
 
-        # @!attribute totp_secret
-        #   TOTP secret for 2FA
-        #
-        #   @return [String, nil]
-        optional :totp_secret, String
-
-        # @!method initialize(email:, password:, username:, totp_secret: nil, request_options: {})
+        # @!method initialize(email:, password:, totp_secret:, username:, request_options: {})
         #   @param email [String] Account email
         #
         #   @param password [String] Account password
         #
-        #   @param username [String] X username
+        #   @param totp_secret [String] Authenticator App TOTP secret required for durable login
         #
-        #   @param totp_secret [String] TOTP secret for 2FA
+        #   @param username [String] X username
         #
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
       end