x-twitter-scraper 0.4.2 → 0.4.4

data/lib/x_twitter_scraper/models/x_get_article_response.rb

@@ -10,18 +10,24 @@ module XTwitterScraper
       required :article, -> { XTwitterScraper::Models::XGetArticleResponse::Article }
 
       # @!attribute author
-      #   Author of a tweet with follower count and verification status.
+      #   X Article author profile fields returned when available.
       #
-      #   @return [XTwitterScraper::Models::X::TweetAuthor, nil]
-      optional :author, -> { XTwitterScraper::X::TweetAuthor }
+      #   @return [XTwitterScraper::Models::XGetArticleResponse::Author, nil]
+      optional :author, -> { XTwitterScraper::Models::XGetArticleResponse::Author }
 
       # @!method initialize(article:, author: nil)
       #   @param article [XTwitterScraper::Models::XGetArticleResponse::Article]
       #
-      #   @param author [XTwitterScraper::Models::X::TweetAuthor] Author of a tweet with follower count and verification status.
+      #   @param author [XTwitterScraper::Models::XGetArticleResponse::Author] X Article author profile fields returned when available.
 
       # @see XTwitterScraper::Models::XGetArticleResponse#article
       class Article < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute body_text
+        #   Plain text joined from all article blocks
+        #
+        #   @return [String, nil]
+        optional :body_text, String, api_name: :bodyText
+
         # @!attribute contents
         #
         #   @return [Array<XTwitterScraper::Models::XGetArticleResponse::Article::Content>, nil]
@@ -68,15 +74,25 @@ module XTwitterScraper
         #   @return [Integer, nil]
         optional :view_count, Integer, api_name: :viewCount
 
-        # @!method initialize(contents: nil, cover_image_url: nil, created_at: nil, like_count: nil, preview_text: nil, quote_count: nil, reply_count: nil, title: nil, view_count: nil)
+        # @!method initialize(body_text: nil, contents: nil, cover_image_url: nil, created_at: nil, like_count: nil, preview_text: nil, quote_count: nil, reply_count: nil, title: nil, view_count: nil)
+        #   @param body_text [String] Plain text joined from all article blocks
+        #
         #   @param contents [Array<XTwitterScraper::Models::XGetArticleResponse::Article::Content>]
+        #
         #   @param cover_image_url [String]
+        #
         #   @param created_at [String]
+        #
         #   @param like_count [Integer]
+        #
         #   @param preview_text [String]
+        #
         #   @param quote_count [Integer]
+        #
         #   @param reply_count [Integer]
+        #
         #   @param title [String]
+        #
         #   @param view_count [Integer]
 
         class Content < XTwitterScraper::Internal::Type::BaseModel
@@ -85,20 +101,35 @@ module XTwitterScraper
           #   @return [Integer, nil]
           optional :height, Integer
 
+          # @!attribute inline_style_ranges
+          #   Inline text formatting ranges
+          #
+          #   @return [Array<XTwitterScraper::Models::XGetArticleResponse::Article::Content::InlineStyleRange>, nil]
+          optional :inline_style_ranges,
+                   -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::XGetArticleResponse::Article::Content::InlineStyleRange] },
+                   api_name: :inlineStyleRanges
+
+          # @!attribute preview_url
+          #   Preview image URL for media blocks
+          #
+          #   @return [String, nil]
+          optional :preview_url, String, api_name: :previewUrl
+
           # @!attribute text
           #
           #   @return [String, nil]
           optional :text, String
 
           # @!attribute type
-          #   Block type: unstyled, header-one, header-two, header-three, unordered-list-item,
-          #   ordered-list-item, image, gif, divider
+          #   Block type: paragraph, header-one, header-two, header-three, header-four,
+          #   header-five, header-six, unordered-list-item, ordered-list-item, blockquote,
+          #   code-block, media, divider
           #
           #   @return [String, nil]
           optional :type, String
 
           # @!attribute url
-          #   Media URL for image/gif blocks
+          #   Media URL for media blocks
           #
           #   @return [String, nil]
           optional :url, String
@@ -108,22 +139,169 @@ module XTwitterScraper
           #   @return [Integer, nil]
           optional :width, Integer
 
-          # @!method initialize(height: nil, text: nil, type: nil, url: nil, width: nil)
+          # @!method initialize(height: nil, inline_style_ranges: nil, preview_url: nil, text: nil, type: nil, url: nil, width: nil)
           #   Some parameter documentations has been truncated, see
           #   {XTwitterScraper::Models::XGetArticleResponse::Article::Content} for more
           #   details.
           #
           #   @param height [Integer]
           #
+          #   @param inline_style_ranges [Array<XTwitterScraper::Models::XGetArticleResponse::Article::Content::InlineStyleRange>] Inline text formatting ranges
+          #
+          #   @param preview_url [String] Preview image URL for media blocks
+          #
           #   @param text [String]
           #
-          #   @param type [String] Block type: unstyled, header-one, header-two, header-three, unordered-list-item,
+          #   @param type [String] Block type: paragraph, header-one, header-two, header-three, header-four, header
           #
-          #   @param url [String] Media URL for image/gif blocks
+          #   @param url [String] Media URL for media blocks
           #
           #   @param width [Integer]
+
+          class InlineStyleRange < XTwitterScraper::Internal::Type::BaseModel
+            # @!attribute length
+            #
+            #   @return [Integer, nil]
+            optional :length, Integer
+
+            # @!attribute offset
+            #
+            #   @return [Integer, nil]
+            optional :offset, Integer
+
+            # @!attribute style
+            #
+            #   @return [String, nil]
+            optional :style, String
+
+            # @!method initialize(length: nil, offset: nil, style: nil)
+            #   @param length [Integer]
+            #   @param offset [Integer]
+            #   @param style [String]
+          end
         end
       end
+
+      # @see XTwitterScraper::Models::XGetArticleResponse#author
+      class Author < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute username
+        #
+        #   @return [String]
+        required :username, String
+
+        # @!attribute can_dm
+        #
+        #   @return [Boolean, nil]
+        optional :can_dm, XTwitterScraper::Internal::Type::Boolean, api_name: :canDm
+
+        # @!attribute created_at
+        #
+        #   @return [String, nil]
+        optional :created_at, String, api_name: :createdAt
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute favourites_count
+        #
+        #   @return [Integer, nil]
+        optional :favourites_count, Integer, api_name: :favouritesCount
+
+        # @!attribute followers_count
+        #
+        #   @return [Integer, nil]
+        optional :followers_count, Integer, api_name: :followersCount
+
+        # @!attribute following_count
+        #
+        #   @return [Integer, nil]
+        optional :following_count, Integer, api_name: :followingCount
+
+        # @!attribute is_blue_verified
+        #
+        #   @return [Boolean, nil]
+        optional :is_blue_verified, XTwitterScraper::Internal::Type::Boolean, api_name: :isBlueVerified
+
+        # @!attribute is_translator
+        #
+        #   @return [Boolean, nil]
+        optional :is_translator, XTwitterScraper::Internal::Type::Boolean, api_name: :isTranslator
+
+        # @!attribute is_verified
+        #
+        #   @return [Boolean, nil]
+        optional :is_verified, XTwitterScraper::Internal::Type::Boolean, api_name: :isVerified
+
+        # @!attribute location
+        #
+        #   @return [String, nil]
+        optional :location, String
+
+        # @!attribute media_count
+        #
+        #   @return [Integer, nil]
+        optional :media_count, Integer, api_name: :mediaCount
+
+        # @!attribute profile_banner_url
+        #
+        #   @return [String, nil]
+        optional :profile_banner_url, String, api_name: :profileBannerUrl
+
+        # @!attribute profile_picture
+        #
+        #   @return [String, nil]
+        optional :profile_picture, String, api_name: :profilePicture
+
+        # @!attribute protected
+        #
+        #   @return [Boolean, nil]
+        optional :protected, XTwitterScraper::Internal::Type::Boolean
+
+        # @!attribute statuses_count
+        #
+        #   @return [Integer, nil]
+        optional :statuses_count, Integer, api_name: :statusesCount
+
+        # @!attribute url
+        #
+        #   @return [String, nil]
+        optional :url, String
+
+        # @!method initialize(id:, name:, username:, can_dm: nil, created_at: nil, description: nil, favourites_count: nil, followers_count: nil, following_count: nil, is_blue_verified: nil, is_translator: nil, is_verified: nil, location: nil, media_count: nil, profile_banner_url: nil, profile_picture: nil, protected: nil, statuses_count: nil, url: nil)
+        #   X Article author profile fields returned when available.
+        #
+        #   @param id [String]
+        #   @param name [String]
+        #   @param username [String]
+        #   @param can_dm [Boolean]
+        #   @param created_at [String]
+        #   @param description [String]
+        #   @param favourites_count [Integer]
+        #   @param followers_count [Integer]
+        #   @param following_count [Integer]
+        #   @param is_blue_verified [Boolean]
+        #   @param is_translator [Boolean]
+        #   @param is_verified [Boolean]
+        #   @param location [String]
+        #   @param media_count [Integer]
+        #   @param profile_banner_url [String]
+        #   @param profile_picture [String]
+        #   @param protected [Boolean]
+        #   @param statuses_count [Integer]
+        #   @param url [String]
+      end
     end
   end
 end

data/lib/x_twitter_scraper/models/x_get_home_timeline_params.rb

@@ -14,7 +14,7 @@ module XTwitterScraper
       optional :cursor, String
 
       # @!attribute seen_tweet_ids
-      #   Comma-separated tweet IDs to exclude from results
+      #   Comma-separated tweet IDs to exclude from results. Empty entries are ignored.
       #
       #   @return [String, nil]
       optional :seen_tweet_ids, String
@@ -22,7 +22,7 @@ module XTwitterScraper
       # @!method initialize(cursor: nil, seen_tweet_ids: nil, request_options: {})
       #   @param cursor [String] Pagination cursor for timeline
       #
-      #   @param seen_tweet_ids [String] Comma-separated tweet IDs to exclude from results
+      #   @param seen_tweet_ids [String] Comma-separated tweet IDs to exclude from results. Empty entries are ignored.
       #
       #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/x_twitter_scraper/models/x_get_notifications_params.rb

@@ -14,7 +14,7 @@ module XTwitterScraper
       optional :cursor, String
 
       # @!attribute type
-      #   Notification type filter
+      #   Notification type filter. Unrecognized values fall back to All.
       #
       #   @return [Symbol, XTwitterScraper::Models::XGetNotificationsParams::Type, nil]
       optional :type, enum: -> { XTwitterScraper::XGetNotificationsParams::Type }
@@ -22,11 +22,11 @@ module XTwitterScraper
       # @!method initialize(cursor: nil, type: nil, request_options: {})
       #   @param cursor [String] Pagination cursor for notifications
       #
-      #   @param type [Symbol, XTwitterScraper::Models::XGetNotificationsParams::Type] Notification type filter
+      #   @param type [Symbol, XTwitterScraper::Models::XGetNotificationsParams::Type] Notification type filter. Unrecognized values fall back to All.
       #
       #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
 
-      # Notification type filter
+      # Notification type filter. Unrecognized values fall back to All.
       module Type
         extend XTwitterScraper::Internal::Type::Enum
 

data/lib/x_twitter_scraper/models/x_get_trends_params.rb

@@ -7,7 +7,23 @@ module XTwitterScraper
       extend XTwitterScraper::Internal::Type::RequestParameters::Converter
       include XTwitterScraper::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute count
+      #   Number of trending topics to return (1-50, default 30)
+      #
+      #   @return [Integer, nil]
+      optional :count, Integer
+
+      # @!attribute woeid
+      #   Region WOEID (1=Worldwide, 23424977=US, 23424975=UK, 23424969=Turkey)
+      #
+      #   @return [Integer, nil]
+      optional :woeid, Integer
+
+      # @!method initialize(count: nil, woeid: nil, request_options: {})
+      #   @param count [Integer] Number of trending topics to return (1-50, default 30)
+      #
+      #   @param woeid [Integer] Region WOEID (1=Worldwide, 23424977=US, 23424975=UK, 23424969=Turkey)
+      #
       #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/x_twitter_scraper/models.rb

@@ -48,18 +48,16 @@ module XTwitterScraper
 
   AccountUpdateLocaleParams = XTwitterScraper::Models::AccountUpdateLocaleParams
 
-  APIKey = XTwitterScraper::Models::APIKey
-
-  APIKeyCreateParams = XTwitterScraper::Models::APIKeyCreateParams
-
-  APIKeyListParams = XTwitterScraper::Models::APIKeyListParams
+  ComposeCreateParams = XTwitterScraper::Models::ComposeCreateParams
 
-  APIKeyRevokeParams = XTwitterScraper::Models::APIKeyRevokeParams
+  ContentDisclosure = XTwitterScraper::Models::ContentDisclosure
 
-  ComposeCreateParams = XTwitterScraper::Models::ComposeCreateParams
+  CreditRedirectTopupCheckoutParams = XTwitterScraper::Models::CreditRedirectTopupCheckoutParams
 
   CreditRetrieveBalanceParams = XTwitterScraper::Models::CreditRetrieveBalanceParams
 
+  CreditRetrieveTopupStatusParams = XTwitterScraper::Models::CreditRetrieveTopupStatusParams
+
   CreditTopupBalanceParams = XTwitterScraper::Models::CreditTopupBalanceParams
 
   Delivery = XTwitterScraper::Models::Delivery
@@ -88,6 +86,8 @@ module XTwitterScraper
 
   DrawRunParams = XTwitterScraper::Models::DrawRunParams
 
+  EmbeddedTweet = XTwitterScraper::Models::EmbeddedTweet
+
   Error = XTwitterScraper::Models::Error
 
   Event = XTwitterScraper::Models::Event
@@ -112,23 +112,13 @@ module XTwitterScraper
 
   ExtractionRunParams = XTwitterScraper::Models::ExtractionRunParams
 
-  Integration = XTwitterScraper::Models::Integration
-
-  IntegrationCreateParams = XTwitterScraper::Models::IntegrationCreateParams
-
-  IntegrationDeleteParams = XTwitterScraper::Models::IntegrationDeleteParams
+  GuestWalletAmount = XTwitterScraper::Models::GuestWalletAmount
 
-  IntegrationDelivery = XTwitterScraper::Models::IntegrationDelivery
+  GuestWalletCreateParams = XTwitterScraper::Models::GuestWalletCreateParams
 
-  IntegrationListDeliveriesParams = XTwitterScraper::Models::IntegrationListDeliveriesParams
+  GuestWalletRetrieveStatusParams = XTwitterScraper::Models::GuestWalletRetrieveStatusParams
 
-  IntegrationListParams = XTwitterScraper::Models::IntegrationListParams
-
-  IntegrationRetrieveParams = XTwitterScraper::Models::IntegrationRetrieveParams
-
-  IntegrationSendTestParams = XTwitterScraper::Models::IntegrationSendTestParams
-
-  IntegrationUpdateParams = XTwitterScraper::Models::IntegrationUpdateParams
+  GuestWalletTopupParams = XTwitterScraper::Models::GuestWalletTopupParams
 
   Monitor = XTwitterScraper::Models::Monitor
 
@@ -140,6 +130,8 @@ module XTwitterScraper
 
   MonitorRetrieveParams = XTwitterScraper::Models::MonitorRetrieveParams
 
+  Monitors = XTwitterScraper::Models::Monitors
+
   MonitorUpdateParams = XTwitterScraper::Models::MonitorUpdateParams
 
   PaginatedTweets = XTwitterScraper::Models::PaginatedTweets
@@ -150,6 +142,8 @@ module XTwitterScraper
 
   RadarRetrieveTrendingTopicsParams = XTwitterScraper::Models::RadarRetrieveTrendingTopicsParams
 
+  SearchTweet = XTwitterScraper::Models::SearchTweet
+
   StyleAnalyzeParams = XTwitterScraper::Models::StyleAnalyzeParams
 
   StyleCompareParams = XTwitterScraper::Models::StyleCompareParams
@@ -174,6 +168,10 @@ module XTwitterScraper
 
   TrendListParams = XTwitterScraper::Models::TrendListParams
 
+  TweetMedia = XTwitterScraper::Models::TweetMedia
+
+  UserProfile = XTwitterScraper::Models::UserProfile
+
   Webhook = XTwitterScraper::Models::Webhook
 
   WebhookCreateParams = XTwitterScraper::Models::WebhookCreateParams
@@ -184,6 +182,8 @@ module XTwitterScraper
 
   WebhookListParams = XTwitterScraper::Models::WebhookListParams
 
+  WebhookResumeParams = XTwitterScraper::Models::WebhookResumeParams
+
   WebhookTestParams = XTwitterScraper::Models::WebhookTestParams
 
   WebhookUpdateParams = XTwitterScraper::Models::WebhookUpdateParams

data/lib/x_twitter_scraper/resources/account.rb

@@ -2,7 +2,7 @@
 
 module XTwitterScraper
   module Resources
-    # Account info & settings
+    # Account info and settings
     class Account
       # Get account info
       #
@@ -18,7 +18,6 @@ module XTwitterScraper
           method: :get,
           path: "account",
           model: XTwitterScraper::Models::AccountRetrieveResponse,
-          security: {auth_api_key: true},
           options: params[:request_options]
         )
       end
@@ -62,7 +61,6 @@ module XTwitterScraper
           path: "account",
           body: parsed,
           model: XTwitterScraper::Models::AccountUpdateLocaleResponse,
-          security: {auth_api_key: true},
           options: options
         )
       end

data/lib/x_twitter_scraper/resources/compose.rb

@@ -2,7 +2,7 @@
 
 module XTwitterScraper
   module Resources
-    # Tweet composition, drafts, writing styles & radar
+    # AI tweet composition, drafts, writing styles, and radar
     class Compose
       # Compose, refine, or score a tweet
       #

data/lib/x_twitter_scraper/resources/credits.rb

@@ -2,8 +2,32 @@
 
 module XTwitterScraper
   module Resources
-    # Subscription & billing
+    # Subscription, billing, and credits
     class Credits
+      # Redirect to an active top-up payment page
+      #
+      # @overload redirect_topup_checkout(session_id:, request_options: {})
+      #
+      # @param session_id [String] Billing session ID returned by the top-up billing flow.
+      #
+      # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see XTwitterScraper::Models::CreditRedirectTopupCheckoutParams
+      def redirect_topup_checkout(params)
+        parsed, options = XTwitterScraper::CreditRedirectTopupCheckoutParams.dump_request(params)
+        query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "credits/topup/redirect",
+          query: query,
+          model: NilClass,
+          security: {},
+          options: options
+        )
+      end
+
       # Get credits balance
       #
       # @overload retrieve_balance(request_options: {})
@@ -22,11 +46,37 @@ module XTwitterScraper
         )
       end
 
-      # Top up credits balance
+      # Get top-up billing status
+      #
+      # @overload retrieve_topup_status(session_id:, request_options: {})
+      #
+      # @param session_id [String] Billing session ID returned by the top-up billing flow.
+      #
+      # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [XTwitterScraper::Models::CreditRetrieveTopupStatusResponse]
+      #
+      # @see XTwitterScraper::Models::CreditRetrieveTopupStatusParams
+      def retrieve_topup_status(params)
+        parsed, options = XTwitterScraper::CreditRetrieveTopupStatusParams.dump_request(params)
+        query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "credits/topup/status",
+          query: query,
+          model: XTwitterScraper::Models::CreditRetrieveTopupStatusResponse,
+          options: options
+        )
+      end
+
+      # Create a Stripe Checkout session only after the user confirms. The request never
+      # completes payment or adds credits by itself.
+      #
+      # @overload topup_balance(dollars:, locale: nil, request_options: {})
       #
-      # @overload topup_balance(amount:, request_options: {})
+      # @param dollars [Integer] Amount to top up in US dollars. Minimum 10.
       #
-      # @param amount [Integer] Amount to top up in credits
+      # @param locale [String] Optional checkout locale. Defaults to en.
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/x_twitter_scraper/resources/drafts.rb

@@ -2,7 +2,7 @@
 
 module XTwitterScraper
   module Resources
-    # Tweet composition, drafts, writing styles & radar
+    # AI tweet composition, drafts, writing styles, and radar
     class Drafts
       # Save a tweet draft
       #
@@ -31,7 +31,7 @@ module XTwitterScraper
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String] Resource ID (stringified bigint)
+      # @param id [String] Resource ID returned by the matching create or list endpoint.
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -47,13 +47,16 @@ module XTwitterScraper
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {XTwitterScraper::Models::DraftListParams} for more details.
+      #
       # List saved drafts
       #
       # @overload list(after_cursor: nil, limit: nil, request_options: {})
       #
       # @param after_cursor [String] Cursor for pagination
       #
-      # @param limit [Integer] Maximum number of items to return (1-100, default 50)
+      # @param limit [Integer] Maximum number of items to return (1-100, default 50). For paid per-result endpo
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -76,7 +79,7 @@ module XTwitterScraper
       #
       # @overload delete(id, request_options: {})
       #
-      # @param id [String] Resource ID (stringified bigint)
+      # @param id [String] Resource ID returned by the matching create or list endpoint.
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/x_twitter_scraper/resources/draws.rb

@@ -8,7 +8,7 @@ module XTwitterScraper
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String] Resource ID (stringified bigint)
+      # @param id [String] Draw public ID returned by create and list draw responses.
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -24,13 +24,16 @@ module XTwitterScraper
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {XTwitterScraper::Models::DrawListParams} for more details.
+      #
       # List draws
       #
-      # @overload list(after: nil, limit: nil, request_options: {})
+      # @overload list(cursor: nil, limit: nil, request_options: {})
       #
-      # @param after [String] Cursor for keyset pagination
+      # @param cursor [String] Cursor for keyset pagination from prior response next_cursor
       #
-      # @param limit [Integer] Maximum number of items to return (1-100, default 50)
+      # @param limit [Integer] Maximum number of items to return (1-100, default 50). For paid per-result endpo
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -51,9 +54,9 @@ module XTwitterScraper
 
       # Export draw data
       #
-      # @overload export(id, format_: nil, type: nil, request_options: {})
+      # @overload export(id, format_:, type: nil, request_options: {})
       #
-      # @param id [String] Resource ID (stringified bigint)
+      # @param id [String] Draw public ID returned by create and list draw responses.
       #
       # @param format_ [Symbol, XTwitterScraper::Models::DrawExportParams::Format] Export output format
       #
@@ -64,7 +67,7 @@ module XTwitterScraper
       # @return [StringIO]
       #
       # @see XTwitterScraper::Models::DrawExportParams
-      def export(id, params = {})
+      def export(id, params)
         parsed, options = XTwitterScraper::DrawExportParams.dump_request(params)
         query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
         @client.request(
@@ -77,7 +80,10 @@ module XTwitterScraper
         )
       end
 
-      # Run giveaway draw
+      # Runs a giveaway draw from a source tweet. The draw first checks the minimum
+      # credits needed to inspect the source tweet and at least one candidate. Remaining
+      # credits cap how many replies and retweeters can be inspected before filters and
+      # winner selection run.
       #
       # @overload run(tweet_url:, backup_count: nil, filter_account_age_days: nil, filter_language: nil, filter_min_followers: nil, must_follow_username: nil, must_retweet: nil, required_hashtags: nil, required_keywords: nil, required_mentions: nil, unique_authors_only: nil, winner_count: nil, request_options: {})
       #