x-twitter-scraper 0.4.5 → 0.5.2

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

@@ -20,10 +20,10 @@ 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
+        # Derived connection health. `healthy` = session active. `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
+        # auto-retry on next use. `temporaryIssue` = temporary connection problem; retry
         # shortly.
         sig { returns(XTwitterScraper::X::XAccount::Health::TaggedSymbol) }
         attr_accessor :health
@@ -62,10 +62,10 @@ module XTwitterScraper
         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
+          # Derived connection health. `healthy` = session active. `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
+          # auto-retry on next use. `temporaryIssue` = temporary connection problem; retry
           # shortly.
           health:,
           status:,
@@ -93,10 +93,10 @@ module XTwitterScraper
         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
+        # Derived connection health. `healthy` = session active. `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
+        # auto-retry on next use. `temporaryIssue` = temporary connection problem; retry
         # shortly.
         module Health
           extend XTwitterScraper::Internal::Type::Enum

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

@@ -46,7 +46,7 @@ module XTwitterScraper
         sig { params(updated_at: Time).void }
         attr_writer :updated_at
 
-        # Full X account details with status, cookies, and update timestamp.
+        # Connected X account details with health and timestamp metadata.
         sig do
           params(
             id: String,

data/rbi/x_twitter_scraper/resources/compose.rbi

@@ -4,48 +4,22 @@ module XTwitterScraper
   module Resources
     # AI tweet composition, drafts, writing styles, and radar
     class Compose
-      # Compose, refine, or score a tweet
+      # 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.
       sig do
         params(
-          step: XTwitterScraper::ComposeCreateParams::Step::OrSymbol,
-          additional_context: String,
-          call_to_action: String,
-          draft: String,
-          goal: XTwitterScraper::ComposeCreateParams::Goal::OrSymbol,
-          has_link: T::Boolean,
-          has_media: T::Boolean,
-          media_type: XTwitterScraper::ComposeCreateParams::MediaType::OrSymbol,
-          style_username: String,
-          tone: String,
-          topic: String,
+          body:
+            T.any(
+              XTwitterScraper::ComposeCreateParams::Body::ComposePrepareRequest::OrHash,
+              XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest::OrHash,
+              XTwitterScraper::ComposeCreateParams::Body::ComposeScoreRequest::OrHash
+            ),
           request_options: XTwitterScraper::RequestOptions::OrHash
-        ).returns(XTwitterScraper::Models::ComposeCreateResponse)
+        ).returns(XTwitterScraper::Models::ComposeCreateResponse::Variants)
       end
-      def create(
-        # Workflow step
-        step:,
-        # Extra context or URLs (refine)
-        additional_context: nil,
-        # Desired call to action (refine)
-        call_to_action: nil,
-        # Tweet draft text to evaluate (score)
-        draft: nil,
-        # Optimization goal
-        goal: nil,
-        # Whether a link is attached (score)
-        has_link: nil,
-        # Whether media is attached (score)
-        has_media: nil,
-        # Media type (refine)
-        media_type: nil,
-        # Cached style username for voice matching (compose)
-        style_username: nil,
-        # Desired tone (refine)
-        tone: nil,
-        # Tweet topic (compose, refine)
-        topic: nil,
-        request_options: {}
-      )
+      def create(body:, request_options: {})
       end
 
       # @api private

data/rbi/x_twitter_scraper/resources/credits.rbi

@@ -35,7 +35,7 @@ module XTwitterScraper
         ).returns(XTwitterScraper::Models::CreditRetrieveTopupStatusResponse)
       end
       def retrieve_topup_status(
-        # Billing session ID returned by the top-up billing flow.
+        # Top-up session ID to inspect.
         session_id:,
         request_options: {}
       )

data/rbi/x_twitter_scraper/resources/extractions.rbi

@@ -162,16 +162,16 @@ module XTwitterScraper
         retweets: nil,
         # Estimate only retweets of this tweet ID (tweet_search_extractor)
         retweets_of_tweet_id: nil,
-        # Required for tweet_search_extractor & community_search.
+        # Query used to price tweet_search_extractor or community_search.
         search_query: nil,
         # Estimate start date in YYYY-MM-DD format (tweet_search_extractor)
         since_date: nil,
-        # Required for community_post_extractor & community_search.
+        # Community ID used to price community_post_extractor or community_search.
         target_community_id: nil,
-        # Required for list_follower_explorer, list_member_extractor &
+        # List ID used to price list_follower_explorer, list_member_extractor, or
         # list_post_extractor.
         target_list_id: nil,
-        # Required for space_explorer.
+        # Space ID used to price space_explorer.
         target_space_id: nil,
         target_tweet_id: nil,
         target_username: nil,

data/rbi/x_twitter_scraper/resources/guest_wallets.rbi

@@ -18,7 +18,7 @@ module XTwitterScraper
         ).returns(XTwitterScraper::Models::GuestWalletCreateResponse)
       end
       def create(
-        # Body param: Confirmed USD amount in cents.
+        # Body param: USD cents accepted for this checkout.
         amount_minor:,
         # Header param: Generate a cryptographically random UUID v4. Reuse it only to
         # retry the same wallet and amount request. Initial wallet creation can recover
@@ -55,7 +55,7 @@ module XTwitterScraper
         ).returns(XTwitterScraper::Models::GuestWalletTopupResponse)
       end
       def topup(
-        # Body param: Confirmed USD amount in cents.
+        # Body param: USD cents accepted for this checkout.
         amount_minor:,
         # Header param: Generate a cryptographically random UUID v4. Reuse it only to
         # retry the same wallet and amount request. Initial wallet creation can recover

data/rbi/x_twitter_scraper/resources/monitors/keywords.rbi

@@ -3,12 +3,11 @@
 module XTwitterScraper
   module Resources
     class Monitors
-      # Real-time X account monitoring
+      # X account monitoring with 1-second checks
       class Keywords
-        # Creates an instant keyword monitor. Keyword monitors are unlimited. Active
-        # monitors check every 1 second and cost 21 credits per hour. Events and webhook
-        # deliveries are included. Creation requires available credits for the first
-        # hourly charge.
+        # Creates a keyword monitor. Keyword monitors are unlimited. Active monitors check
+        # every 1 second and cost 21 credits per hour. Events and webhook deliveries are
+        # included. Creation requires available credits for the first hourly charge.
         sig do
           params(
             event_types: T::Array[XTwitterScraper::EventType::OrSymbol],

data/rbi/x_twitter_scraper/resources/monitors.rbi

@@ -2,13 +2,13 @@
 
 module XTwitterScraper
   module Resources
-    # Real-time X account monitoring
+    # X account monitoring with 1-second checks
     class Monitors
-      # Real-time X account monitoring
+      # X account monitoring with 1-second checks
       sig { returns(XTwitterScraper::Resources::Monitors::Keywords) }
       attr_reader :keywords
 
-      # Creates an instant monitor. Monitors are unlimited. Active monitors check every
+      # Creates an account monitor. Monitors are unlimited. Active monitors check every
       # 1 second and cost 21 credits per hour. Events and webhook deliveries are
       # included. Creation requires available credits for the first hourly charge and
       # username lookup.

data/rbi/x_twitter_scraper/resources/support/tickets.rbi

@@ -10,10 +10,20 @@ module XTwitterScraper
           params(
             body: String,
             subject: String,
+            idempotency_key: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::Models::Support::TicketCreateResponse)
         end
-        def create(body:, subject:, request_options: {})
+        def create(
+          # Body param
+          body:,
+          # Body param
+          subject:,
+          # Header param: Generate one random value per ticket or reply. Reuse it only when
+          # retrying identical text and attachments. Never log this value.
+          idempotency_key: nil,
+          request_options: {}
+        )
         end
 
         # Get ticket with all messages
@@ -61,13 +71,18 @@ module XTwitterScraper
           params(
             id: String,
             body: String,
+            idempotency_key: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::Models::Support::TicketReplyResponse)
         end
         def reply(
-          # Support ticket public ID for the reply
+          # Path param: Support ticket public ID for the reply
           id,
+          # Body param
           body:,
+          # Header param: Generate one random value per ticket or reply. Reuse it only when
+          # retrying identical text and attachments. Never log this value.
+          idempotency_key: nil,
           request_options: {}
         )
         end

data/rbi/x_twitter_scraper/resources/trends.rbi

@@ -4,7 +4,7 @@ module XTwitterScraper
   module Resources
     # Trending topics and hashtags by region
     class Trends
-      # Get trending hashtags and topics by region (alias)
+      # Get trending hashtags & topics by region (alias)
       sig do
         params(
           count: Integer,

data/rbi/x_twitter_scraper/resources/x/communities/join.rbi

@@ -11,16 +11,22 @@ module XTwitterScraper
             params(
               id: String,
               account: String,
+              idempotency_key: String,
               request_options: XTwitterScraper::RequestOptions::OrHash
             ).returns(
               XTwitterScraper::Models::X::Communities::JoinCreateResponse
             )
           end
           def create(
-            # Resource ID returned by the matching create or list endpoint.
+            # Path param: Resource ID returned by the matching create or list endpoint.
             id,
-            # X account identifier (@username or account ID)
+            # Body param: X account identifier (@username or account ID)
             account:,
+            # Header param: Generate one unique value for each intended write. Reuse it only
+            # when retrying the exact same account, action, target, and payload. A reused key
+            # returns the original action. Reusing it with different input returns 409. Replay
+            # protection remains active for at least 90 days.
+            idempotency_key:,
             request_options: {}
           )
           end
@@ -30,16 +36,22 @@ module XTwitterScraper
             params(
               id: String,
               account: String,
+              idempotency_key: String,
               request_options: XTwitterScraper::RequestOptions::OrHash
             ).returns(
               XTwitterScraper::Models::X::Communities::JoinDeleteAllResponse
             )
           end
           def delete_all(
-            # Resource ID returned by the matching create or list endpoint.
+            # Path param: Resource ID returned by the matching create or list endpoint.
             id,
-            # X account identifier (@username or account ID)
+            # Body param: X account identifier (@username or account ID)
             account:,
+            # Header param: Generate one unique value for each intended write. Reuse it only
+            # when retrying the exact same account, action, target, and payload. A reused key
+            # returns the original action. Reusing it with different input returns 409. Replay
+            # protection remains active for at least 90 days.
+            idempotency_key:,
             request_options: {}
           )
           end

data/rbi/x_twitter_scraper/resources/x/communities.rbi

@@ -17,16 +17,22 @@ module XTwitterScraper
           params(
             account: String,
             name: String,
+            idempotency_key: String,
             description: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::Models::X::CommunityCreateResponse)
         end
         def create(
-          # X account (@username or ID) creating the community
+          # Body param: X account (@username or ID) creating the community
           account:,
-          # Community name
+          # Body param: Community name
           name:,
-          # Community description
+          # Header param: Generate one unique value for each intended write. Reuse it only
+          # when retrying the exact same account, action, target, and payload. A reused key
+          # returns the original action. Reusing it with different input returns 409. Replay
+          # protection remains active for at least 90 days.
+          idempotency_key:,
+          # Body param: Community description
           description: nil,
           request_options: {}
         )
@@ -38,21 +44,27 @@ module XTwitterScraper
             id: String,
             account: String,
             community_name: String,
+            idempotency_key: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::Models::X::CommunityDeleteResponse)
         end
         def delete(
-          # Resource ID returned by the matching create or list endpoint.
+          # Path param: Resource ID returned by the matching create or list endpoint.
           id,
-          # X account (@username or ID) deleting the community
+          # Body param: X account (@username or ID) deleting the community
           account:,
-          # Community name for confirmation
+          # Body param: Community name for confirmation
           community_name:,
+          # Header param: Generate one unique value for each intended write. Reuse it only
+          # when retrying the exact same account, action, target, and payload. A reused key
+          # returns the original action. Reusing it with different input returns 409. Replay
+          # protection remains active for at least 90 days.
+          idempotency_key:,
           request_options: {}
         )
         end
 
-        # Get community name, description and member count
+        # Get community name, description & member count
         sig do
           params(
             id: String,

data/rbi/x_twitter_scraper/resources/x/dm.rbi

@@ -34,17 +34,24 @@ module XTwitterScraper
             user_id: String,
             account: String,
             text: String,
+            idempotency_key: String,
             media_ids: T::Array[String],
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::Models::X::DmSendResponse)
         end
         def send_(
-          # Recipient user ID
+          # Path param: Recipient user ID
           user_id,
-          # X account (@username or ID) sending the DM
+          # Body param: X account (@username or ID) sending the DM
           account:,
+          # Body param
           text:,
-          # Optional array containing exactly 1 uploaded media ID.
+          # Header param: Generate one unique value for each intended write. Reuse it only
+          # when retrying the exact same account, action, target, and payload. A reused key
+          # returns the original action. Reusing it with different input returns 409. Replay
+          # protection remains active for at least 90 days.
+          idempotency_key:,
+          # Body param: Optional array containing exactly 1 uploaded media ID.
           media_ids: nil,
           request_options: {}
         )

data/rbi/x_twitter_scraper/resources/x/media.rbi

@@ -3,9 +3,8 @@
 module XTwitterScraper
   module Resources
     class X
-      # Media upload and download
       class Media
-        # Download images and videos from tweets
+        # Download images & videos from tweets
         sig do
           params(
             tweet_id: String,
@@ -33,14 +32,20 @@ module XTwitterScraper
           params(
             account: String,
             url: String,
+            idempotency_key: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::Models::X::MediaUploadResponse)
         end
         def upload(
-          # X account (@username or ID) uploading media from URL
+          # Body param: X account (@username or ID) uploading media from URL
           account:,
-          # HTTPS URL to download and upload as media
+          # Body param: HTTPS URL to download and upload as media
           url:,
+          # Header param: Generate one unique value for each intended write. Reuse it only
+          # when retrying the exact same account, action, target, and payload. A reused key
+          # returns the original action. Reusing it with different input returns 409. Replay
+          # protection remains active for at least 90 days.
+          idempotency_key:,
           request_options: {}
         )
         end

data/rbi/x_twitter_scraper/resources/x/profile.rbi

@@ -9,6 +9,7 @@ module XTwitterScraper
         sig do
           params(
             account: String,
+            idempotency_key: String,
             description: String,
             location: String,
             name: String,
@@ -17,14 +18,20 @@ module XTwitterScraper
           ).returns(XTwitterScraper::Models::X::ProfileUpdateResponse)
         end
         def update(
-          # X account (@username or ID) to update profile
+          # Body param: X account (@username or ID) to update profile
           account:,
-          # Bio description
+          # Header param: Generate one unique value for each intended write. Reuse it only
+          # when retrying the exact same account, action, target, and payload. A reused key
+          # returns the original action. Reusing it with different input returns 409. Replay
+          # protection remains active for at least 90 days.
+          idempotency_key:,
+          # Body param: Bio description
           description: nil,
+          # Body param
           location: nil,
-          # Display name
+          # Body param: Display name
           name: nil,
-          # Website URL
+          # Body param: Website URL
           url: nil,
           request_options: {}
         )
@@ -35,14 +42,20 @@ module XTwitterScraper
           params(
             account: String,
             url: String,
+            idempotency_key: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::Models::X::ProfileUpdateAvatarResponse)
         end
         def update_avatar(
-          # X account (@username or ID) receiving avatar from URL
+          # Body param: X account (@username or ID) receiving avatar from URL
           account:,
-          # HTTPS URL to the avatar image to download
+          # Body param: HTTPS URL to the avatar image to download
           url:,
+          # Header param: Generate one unique value for each intended write. Reuse it only
+          # when retrying the exact same account, action, target, and payload. A reused key
+          # returns the original action. Reusing it with different input returns 409. Replay
+          # protection remains active for at least 90 days.
+          idempotency_key:,
           request_options: {}
         )
         end
@@ -52,14 +65,20 @@ module XTwitterScraper
           params(
             account: String,
             url: String,
+            idempotency_key: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::Models::X::ProfileUpdateBannerResponse)
         end
         def update_banner(
-          # X account (@username or ID) receiving banner from URL
+          # Body param: X account (@username or ID) receiving banner from URL
           account:,
-          # HTTPS URL to the banner image to download
+          # Body param: HTTPS URL to the banner image to download
           url:,
+          # Header param: Generate one unique value for each intended write. Reuse it only
+          # when retrying the exact same account, action, target, and payload. A reused key
+          # returns the original action. Reusing it with different input returns 409. Replay
+          # protection remains active for at least 90 days.
+          idempotency_key:,
           request_options: {}
         )
         end

data/rbi/x_twitter_scraper/resources/x/tweets/like.rbi

@@ -11,14 +11,20 @@ module XTwitterScraper
             params(
               id: String,
               account: String,
+              idempotency_key: String,
               request_options: XTwitterScraper::RequestOptions::OrHash
             ).returns(XTwitterScraper::Models::X::Tweets::LikeCreateResponse)
           end
           def create(
-            # Tweet ID to like
+            # Path param: Tweet ID to like
             id,
-            # X account identifier (@username or account ID)
+            # Body param: X account identifier (@username or account ID)
             account:,
+            # Header param: Generate one unique value for each intended write. Reuse it only
+            # when retrying the exact same account, action, target, and payload. A reused key
+            # returns the original action. Reusing it with different input returns 409. Replay
+            # protection remains active for at least 90 days.
+            idempotency_key:,
             request_options: {}
           )
           end
@@ -28,14 +34,20 @@ module XTwitterScraper
             params(
               id: String,
               account: String,
+              idempotency_key: String,
               request_options: XTwitterScraper::RequestOptions::OrHash
             ).returns(XTwitterScraper::Models::X::Tweets::LikeDeleteResponse)
           end
           def delete(
-            # Tweet ID to unlike
+            # Path param: Tweet ID to unlike
             id,
-            # X account identifier (@username or account ID)
+            # Body param: X account identifier (@username or account ID)
             account:,
+            # Header param: Generate one unique value for each intended write. Reuse it only
+            # when retrying the exact same account, action, target, and payload. A reused key
+            # returns the original action. Reusing it with different input returns 409. Replay
+            # protection remains active for at least 90 days.
+            idempotency_key:,
             request_options: {}
           )
           end

data/rbi/x_twitter_scraper/resources/x/tweets/retweet.rbi

@@ -11,14 +11,20 @@ module XTwitterScraper
             params(
               id: String,
               account: String,
+              idempotency_key: String,
               request_options: XTwitterScraper::RequestOptions::OrHash
             ).returns(XTwitterScraper::Models::X::Tweets::RetweetCreateResponse)
           end
           def create(
-            # Tweet ID to retweet
+            # Path param: Tweet ID to retweet
             id,
-            # X account identifier (@username or account ID)
+            # Body param: X account identifier (@username or account ID)
             account:,
+            # Header param: Generate one unique value for each intended write. Reuse it only
+            # when retrying the exact same account, action, target, and payload. A reused key
+            # returns the original action. Reusing it with different input returns 409. Replay
+            # protection remains active for at least 90 days.
+            idempotency_key:,
             request_options: {}
           )
           end
@@ -28,14 +34,20 @@ module XTwitterScraper
             params(
               id: String,
               account: String,
+              idempotency_key: String,
               request_options: XTwitterScraper::RequestOptions::OrHash
             ).returns(XTwitterScraper::Models::X::Tweets::RetweetDeleteResponse)
           end
           def delete(
-            # Tweet ID to unretweet
+            # Path param: Tweet ID to unretweet
             id,
-            # X account identifier (@username or account ID)
+            # Body param: X account identifier (@username or account ID)
             account:,
+            # Header param: Generate one unique value for each intended write. Reuse it only
+            # when retrying the exact same account, action, target, and payload. A reused key
+            # returns the original action. Reusing it with different input returns 409. Replay
+            # protection remains active for at least 90 days.
+            idempotency_key:,
             request_options: {}
           )
           end