x-twitter-scraper 0.4.2 → 0.4.4

data/rbi/x_twitter_scraper/models/credit_retrieve_topup_status_response.rbi

@@ -0,0 +1,107 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    class CreditRetrieveTopupStatusResponse < XTwitterScraper::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            XTwitterScraper::Models::CreditRetrieveTopupStatusResponse,
+            XTwitterScraper::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(
+          XTwitterScraper::Models::CreditRetrieveTopupStatusResponse::Status::TaggedSymbol
+        )
+      end
+      attr_accessor :status
+
+      # Dollar amount requested for the top-up.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :amount_dollars
+
+      # Bigint string credit amount granted or pending.
+      sig { returns(T.nilable(String)) }
+      attr_reader :credits
+
+      sig { params(credits: String).void }
+      attr_writer :credits
+
+      sig do
+        params(
+          status:
+            XTwitterScraper::Models::CreditRetrieveTopupStatusResponse::Status::OrSymbol,
+          amount_dollars: T.nilable(Integer),
+          credits: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        status:,
+        # Dollar amount requested for the top-up.
+        amount_dollars: nil,
+        # Bigint string credit amount granted or pending.
+        credits: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            status:
+              XTwitterScraper::Models::CreditRetrieveTopupStatusResponse::Status::TaggedSymbol,
+            amount_dollars: T.nilable(Integer),
+            credits: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Status
+        extend XTwitterScraper::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              XTwitterScraper::Models::CreditRetrieveTopupStatusResponse::Status
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PAID =
+          T.let(
+            :paid,
+            XTwitterScraper::Models::CreditRetrieveTopupStatusResponse::Status::TaggedSymbol
+          )
+        PROCESSING =
+          T.let(
+            :processing,
+            XTwitterScraper::Models::CreditRetrieveTopupStatusResponse::Status::TaggedSymbol
+          )
+        FAILED =
+          T.let(
+            :failed,
+            XTwitterScraper::Models::CreditRetrieveTopupStatusResponse::Status::TaggedSymbol
+          )
+        EXPIRED =
+          T.let(
+            :expired,
+            XTwitterScraper::Models::CreditRetrieveTopupStatusResponse::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              XTwitterScraper::Models::CreditRetrieveTopupStatusResponse::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/credit_topup_balance_params.rbi

@@ -14,26 +14,40 @@ module XTwitterScraper
           )
         end
 
-      # Amount to top up in credits
+      # Amount to top up in US dollars. Minimum 10.
       sig { returns(Integer) }
-      attr_accessor :amount
+      attr_accessor :dollars
+
+      # Optional checkout locale. Defaults to en.
+      sig { returns(T.nilable(String)) }
+      attr_reader :locale
+
+      sig { params(locale: String).void }
+      attr_writer :locale
 
       sig do
         params(
-          amount: Integer,
+          dollars: Integer,
+          locale: String,
           request_options: XTwitterScraper::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        # Amount to top up in credits
-        amount:,
+        # Amount to top up in US dollars. Minimum 10.
+        dollars:,
+        # Optional checkout locale. Defaults to en.
+        locale: nil,
         request_options: {}
       )
       end
 
       sig do
         override.returns(
-          { amount: Integer, request_options: XTwitterScraper::RequestOptions }
+          {
+            dollars: Integer,
+            locale: String,
+            request_options: XTwitterScraper::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/x_twitter_scraper/models/credit_topup_balance_response.rbi

@@ -11,14 +11,28 @@ module XTwitterScraper
           )
         end
 
-      sig { returns(T::Boolean) }
-      attr_accessor :success
+      # Stable first-party Xquik redirect URL for the active Stripe Checkout session.
+      sig { returns(String) }
+      attr_accessor :redirect_url
 
-      sig { params(success: T::Boolean).returns(T.attached_class) }
-      def self.new(success: true)
+      # Same stable first-party Xquik redirect URL as redirect_url. The response never
+      # exposes a raw Stripe Checkout URL.
+      sig { returns(String) }
+      attr_accessor :url
+
+      sig do
+        params(redirect_url: String, url: String).returns(T.attached_class)
+      end
+      def self.new(
+        # Stable first-party Xquik redirect URL for the active Stripe Checkout session.
+        redirect_url:,
+        # Same stable first-party Xquik redirect URL as redirect_url. The response never
+        # exposes a raw Stripe Checkout URL.
+        url:
+      )
       end
 
-      sig { override.returns({ success: T::Boolean }) }
+      sig { override.returns({ redirect_url: String, url: String }) }
       def to_hash
       end
     end

data/rbi/x_twitter_scraper/models/draft_list_params.rbi

@@ -21,7 +21,10 @@ module XTwitterScraper
       sig { params(after_cursor: String).void }
       attr_writer :after_cursor
 
-      # Maximum number of items to return (1-100, default 50)
+      # Maximum number of items to return (1-100, default 50). For paid per-result
+      # endpoints, the returned count may be lower when remaining credits cannot cover
+      # the requested page. If zero paid results are affordable, the endpoint returns
+      # 402 insufficient_credits.
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
@@ -38,7 +41,10 @@ module XTwitterScraper
       def self.new(
         # Cursor for pagination
         after_cursor: nil,
-        # Maximum number of items to return (1-100, default 50)
+        # Maximum number of items to return (1-100, default 50). For paid per-result
+        # endpoints, the returned count may be lower when remaining credits cannot cover
+        # the requested page. If zero paid results are affordable, the endpoint returns
+        # 402 insufficient_credits.
         limit: nil,
         request_options: {}
       )

data/rbi/x_twitter_scraper/models/draw_detail.rbi

@@ -8,6 +8,7 @@ module XTwitterScraper
           T.any(XTwitterScraper::DrawDetail, XTwitterScraper::Internal::AnyHash)
         end
 
+      # Draw public ID.
       sig { returns(String) }
       attr_accessor :id
 
@@ -73,6 +74,7 @@ module XTwitterScraper
         ).returns(T.attached_class)
       end
       def self.new(
+        # Draw public ID.
         id:,
         created_at:,
         status:,

data/rbi/x_twitter_scraper/models/draw_export_params.rbi

@@ -18,17 +18,8 @@ module XTwitterScraper
       attr_accessor :id
 
       # Export output format
-      sig do
-        returns(T.nilable(XTwitterScraper::DrawExportParams::Format::OrSymbol))
-      end
-      attr_reader :format_
-
-      sig do
-        params(
-          format_: XTwitterScraper::DrawExportParams::Format::OrSymbol
-        ).void
-      end
-      attr_writer :format_
+      sig { returns(XTwitterScraper::DrawExportParams::Format::OrSymbol) }
+      attr_accessor :format_
 
       # Export winners or all entries
       sig do
@@ -52,7 +43,7 @@ module XTwitterScraper
       def self.new(
         id:,
         # Export output format
-        format_: nil,
+        format_:,
         # Export winners or all entries
         type: nil,
         request_options: {}

data/rbi/x_twitter_scraper/models/draw_list_item.rbi

@@ -11,6 +11,7 @@ module XTwitterScraper
           )
         end
 
+      # Draw public ID for detail responses.
       sig { returns(String) }
       attr_accessor :id
 
@@ -48,6 +49,7 @@ module XTwitterScraper
         ).returns(T.attached_class)
       end
       def self.new(
+        # Draw public ID for detail responses.
         id:,
         created_at:,
         status:,

data/rbi/x_twitter_scraper/models/draw_list_params.rbi

@@ -14,14 +14,17 @@ module XTwitterScraper
           )
         end
 
-      # Cursor for keyset pagination
+      # Cursor for keyset pagination from prior response next_cursor
       sig { returns(T.nilable(String)) }
-      attr_reader :after
+      attr_reader :cursor
 
-      sig { params(after: String).void }
-      attr_writer :after
+      sig { params(cursor: String).void }
+      attr_writer :cursor
 
-      # Maximum number of items to return (1-100, default 50)
+      # Maximum number of items to return (1-100, default 50). For paid per-result
+      # endpoints, the returned count may be lower when remaining credits cannot cover
+      # the requested page. If zero paid results are affordable, the endpoint returns
+      # 402 insufficient_credits.
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
@@ -30,15 +33,18 @@ module XTwitterScraper
 
       sig do
         params(
-          after: String,
+          cursor: String,
           limit: Integer,
           request_options: XTwitterScraper::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        # Cursor for keyset pagination
-        after: nil,
-        # Maximum number of items to return (1-100, default 50)
+        # Cursor for keyset pagination from prior response next_cursor
+        cursor: nil,
+        # Maximum number of items to return (1-100, default 50). For paid per-result
+        # endpoints, the returned count may be lower when remaining credits cannot cover
+        # the requested page. If zero paid results are affordable, the endpoint returns
+        # 402 insufficient_credits.
         limit: nil,
         request_options: {}
       )
@@ -47,7 +53,7 @@ module XTwitterScraper
       sig do
         override.returns(
           {
-            after: String,
+            cursor: String,
             limit: Integer,
             request_options: XTwitterScraper::RequestOptions
           }

data/rbi/x_twitter_scraper/models/draw_run_response.rbi

@@ -14,12 +14,16 @@ module XTwitterScraper
       sig { returns(String) }
       attr_accessor :id
 
+      # Candidate entries inspected for this draw after the credit-derived cap. This may
+      # be lower than the source tweet's full reply count.
       sig { returns(Integer) }
       attr_accessor :total_entries
 
       sig { returns(String) }
       attr_accessor :tweet_id
 
+      # Entries from the inspected candidate set that passed all filters. This is not
+      # necessarily every valid reply on the source tweet when credits cap inspection.
       sig { returns(Integer) }
       attr_accessor :valid_entries
 
@@ -35,7 +39,17 @@ module XTwitterScraper
           winners: T::Array[XTwitterScraper::Winner::OrHash]
         ).returns(T.attached_class)
       end
-      def self.new(id:, total_entries:, tweet_id:, valid_entries:, winners:)
+      def self.new(
+        id:,
+        # Candidate entries inspected for this draw after the credit-derived cap. This may
+        # be lower than the source tweet's full reply count.
+        total_entries:,
+        tweet_id:,
+        # Entries from the inspected candidate set that passed all filters. This is not
+        # necessarily every valid reply on the source tweet when credits cap inspection.
+        valid_entries:,
+        winners:
+      )
       end
 
       sig do

data/rbi/x_twitter_scraper/models/embedded_tweet.rbi

@@ -0,0 +1,255 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    class EmbeddedTweet < XTwitterScraper::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            XTwitterScraper::EmbeddedTweet,
+            XTwitterScraper::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(Integer) }
+      attr_accessor :bookmark_count
+
+      sig { returns(Integer) }
+      attr_accessor :like_count
+
+      sig { returns(Integer) }
+      attr_accessor :quote_count
+
+      sig { returns(Integer) }
+      attr_accessor :reply_count
+
+      sig { returns(Integer) }
+      attr_accessor :retweet_count
+
+      sig { returns(String) }
+      attr_accessor :text
+
+      sig { returns(Integer) }
+      attr_accessor :view_count
+
+      # X user profile with bio, follower counts, and verification status.
+      sig { returns(T.nilable(XTwitterScraper::UserProfile)) }
+      attr_reader :author
+
+      sig { params(author: XTwitterScraper::UserProfile::OrHash).void }
+      attr_writer :author
+
+      # Content disclosure metadata shown by X when a tweet is labeled as paid
+      # partnership content or AI-generated media.
+      sig { returns(T.nilable(XTwitterScraper::ContentDisclosure)) }
+      attr_reader :content_disclosure
+
+      sig do
+        params(
+          content_disclosure: XTwitterScraper::ContentDisclosure::OrHash
+        ).void
+      end
+      attr_writer :content_disclosure
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :conversation_id
+
+      sig { params(conversation_id: String).void }
+      attr_writer :conversation_id
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :created_at
+
+      sig { params(created_at: String).void }
+      attr_writer :created_at
+
+      sig { returns(T.nilable(T::Array[Integer])) }
+      attr_reader :display_text_range
+
+      sig { params(display_text_range: T::Array[Integer]).void }
+      attr_writer :display_text_range
+
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_reader :entities
+
+      sig { params(entities: T::Hash[Symbol, T.anything]).void }
+      attr_writer :entities
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :in_reply_to_id
+
+      sig { params(in_reply_to_id: String).void }
+      attr_writer :in_reply_to_id
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :in_reply_to_user_id
+
+      sig { params(in_reply_to_user_id: String).void }
+      attr_writer :in_reply_to_user_id
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :in_reply_to_username
+
+      sig { params(in_reply_to_username: String).void }
+      attr_writer :in_reply_to_username
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :is_limited_reply
+
+      sig { params(is_limited_reply: T::Boolean).void }
+      attr_writer :is_limited_reply
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :is_note_tweet
+
+      sig { params(is_note_tweet: T::Boolean).void }
+      attr_writer :is_note_tweet
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :is_quote_status
+
+      sig { params(is_quote_status: T::Boolean).void }
+      attr_writer :is_quote_status
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :is_reply
+
+      sig { params(is_reply: T::Boolean).void }
+      attr_writer :is_reply
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :lang
+
+      sig { params(lang: String).void }
+      attr_writer :lang
+
+      sig { returns(T.nilable(T::Array[XTwitterScraper::TweetMedia])) }
+      attr_reader :media
+
+      sig { params(media: T::Array[XTwitterScraper::TweetMedia::OrHash]).void }
+      attr_writer :media
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :source
+
+      sig { params(source: String).void }
+      attr_writer :source
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :type
+
+      sig { params(type: String).void }
+      attr_writer :type
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :url
+
+      sig { params(url: String).void }
+      attr_writer :url
+
+      # Quoted or retweeted tweet context. Every object includes id, text, and
+      # engagement metrics. A zero metric can mean X did not report the count. Author,
+      # media, and conversation fields appear when available.
+      sig do
+        params(
+          id: String,
+          bookmark_count: Integer,
+          like_count: Integer,
+          quote_count: Integer,
+          reply_count: Integer,
+          retweet_count: Integer,
+          text: String,
+          view_count: Integer,
+          author: XTwitterScraper::UserProfile::OrHash,
+          content_disclosure: XTwitterScraper::ContentDisclosure::OrHash,
+          conversation_id: String,
+          created_at: String,
+          display_text_range: T::Array[Integer],
+          entities: T::Hash[Symbol, T.anything],
+          in_reply_to_id: String,
+          in_reply_to_user_id: String,
+          in_reply_to_username: String,
+          is_limited_reply: T::Boolean,
+          is_note_tweet: T::Boolean,
+          is_quote_status: T::Boolean,
+          is_reply: T::Boolean,
+          lang: String,
+          media: T::Array[XTwitterScraper::TweetMedia::OrHash],
+          source: String,
+          type: String,
+          url: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        bookmark_count:,
+        like_count:,
+        quote_count:,
+        reply_count:,
+        retweet_count:,
+        text:,
+        view_count:,
+        # X user profile with bio, follower counts, and verification status.
+        author: nil,
+        # Content disclosure metadata shown by X when a tweet is labeled as paid
+        # partnership content or AI-generated media.
+        content_disclosure: nil,
+        conversation_id: nil,
+        created_at: nil,
+        display_text_range: nil,
+        entities: nil,
+        in_reply_to_id: nil,
+        in_reply_to_user_id: nil,
+        in_reply_to_username: nil,
+        is_limited_reply: nil,
+        is_note_tweet: nil,
+        is_quote_status: nil,
+        is_reply: nil,
+        lang: nil,
+        media: nil,
+        source: nil,
+        type: nil,
+        url: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            bookmark_count: Integer,
+            like_count: Integer,
+            quote_count: Integer,
+            reply_count: Integer,
+            retweet_count: Integer,
+            text: String,
+            view_count: Integer,
+            author: XTwitterScraper::UserProfile,
+            content_disclosure: XTwitterScraper::ContentDisclosure,
+            conversation_id: String,
+            created_at: String,
+            display_text_range: T::Array[Integer],
+            entities: T::Hash[Symbol, T.anything],
+            in_reply_to_id: String,
+            in_reply_to_user_id: String,
+            in_reply_to_username: String,
+            is_limited_reply: T::Boolean,
+            is_note_tweet: T::Boolean,
+            is_quote_status: T::Boolean,
+            is_reply: T::Boolean,
+            lang: String,
+            media: T::Array[XTwitterScraper::TweetMedia],
+            source: String,
+            type: String,
+            url: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end