x-twitter-scraper 0.5.4 → 0.6.0

data/lib/x_twitter_scraper/models/x/tweets/like_delete_response.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/x/tweets/retweet_create_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/x/tweets/retweet_create_response.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/x/tweets/retweet_delete_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/x/tweets/retweet_delete_response.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

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

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

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

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

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

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

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

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

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

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

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

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

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

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

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

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

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

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

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

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

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

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

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

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

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

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

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

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

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

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/x/users/follow_create_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/x/users/follow_create_response.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/x/users/follow_delete_all_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/x/users/follow_delete_all_response.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

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

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

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

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

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

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper
@@ -15,11 +19,11 @@ module XTwitterScraper
         required :created_at, Time, api_name: :createdAt
 
         # @!attribute health
-        #   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.
         #
         #   @return [Symbol, XTwitterScraper::Models::X::XAccount::Health]
         required :health, enum: -> { XTwitterScraper::X::XAccount::Health }
@@ -59,7 +63,7 @@ module XTwitterScraper
         #
         #   @param created_at [Time]
         #
-        #   @param health [Symbol, XTwitterScraper::Models::X::XAccount::Health] Derived connection health. `healthy` = session active. `needsReauth` = user must
+        #   @param health [Symbol, XTwitterScraper::Models::X::XAccount::Health] Derived connection health. `healthy` = ready to use. `needsReauth` = user must s
         #
         #   @param status [String]
         #
@@ -71,11 +75,11 @@ module XTwitterScraper
         #
         #   @param cookies_obtained_at [Time]
 
-        # 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.
         #
         # @see XTwitterScraper::Models::X::XAccount#health
         module Health

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

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/x_get_article_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/x_get_article_response.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/x_get_home_timeline_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/x_get_notifications_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/x_get_notifications_response.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/x_get_trends_params.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models/x_get_trends_response.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/models.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/request_options.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/resources/account.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/resources/compose.rb

@@ -1,13 +1,17 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 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.
       #
       # @overload create(body:, request_options: {})
       #

data/lib/x_twitter_scraper/resources/credits.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/resources/drafts.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/resources/draws.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/resources/events.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/resources/extractions.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/resources/guest_wallets.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/resources/monitors/keywords.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/resources/monitors.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/resources/radar.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/resources/styles.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/resources/subscribe.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/resources/support/tickets.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/resources/support.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/resources/trends.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/resources/webhooks.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/resources/x/account_connection_attempts.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Resources
+    class X
+      # Connected X account management
+      class AccountConnectionAttempts
+        # Get X account connection status
+        #
+        # @overload retrieve(id, request_options: {})
+        #
+        # @param id [String] Connection attempt ID returned by `POST /x/accounts`.
+        #
+        # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::XAccountConnectionAttemptPending, XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::XAccountConnectionAttemptSuccess, XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::XAccountConnectionAttemptFailed, XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse::XAccountConnectionChallenge]
+        #
+        # @see XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveParams
+        def retrieve(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["x/account-connection-attempts/%1$s", id],
+            model: XTwitterScraper::Models::X::AccountConnectionAttemptRetrieveResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [XTwitterScraper::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/resources/x/account_connection_challenges.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper

data/lib/x_twitter_scraper/resources/x/accounts.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper
@@ -7,19 +11,19 @@ module XTwitterScraper
       class Accounts
         # Connect X account
         #
-        # @overload create(email:, password:, username:, totp_secret: nil, request_options: {})
+        # @overload create(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}, nil]
         #
-        # @return [XTwitterScraper::Models::X::AccountCreateResponse]
+        # @return [Object]
         #
         # @see XTwitterScraper::Models::X::AccountCreateParams
         def create(params)
@@ -28,7 +32,7 @@ module XTwitterScraper
             method: :post,
             path: "x/accounts",
             body: parsed,
-            model: XTwitterScraper::Models::X::AccountCreateResponse,
+            model: XTwitterScraper::Internal::Type::Unknown,
             options: options
           )
         end
@@ -120,7 +124,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}, nil]
         #

data/lib/x_twitter_scraper/resources/x/bookmarks.rb

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2026 Xquik contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
 # frozen_string_literal: true
 
 module XTwitterScraper