x-twitter-scraper 0.4.2 → 0.4.4

data/rbi/x_twitter_scraper/models/x_get_article_response.rbi

@@ -21,23 +21,29 @@ module XTwitterScraper
       end
       attr_writer :article
 
-      # Author of a tweet with follower count and verification status.
-      sig { returns(T.nilable(XTwitterScraper::X::TweetAuthor)) }
+      # X Article author profile fields returned when available.
+      sig do
+        returns(T.nilable(XTwitterScraper::Models::XGetArticleResponse::Author))
+      end
       attr_reader :author
 
-      sig { params(author: XTwitterScraper::X::TweetAuthor::OrHash).void }
+      sig do
+        params(
+          author: XTwitterScraper::Models::XGetArticleResponse::Author::OrHash
+        ).void
+      end
       attr_writer :author
 
       sig do
         params(
           article:
             XTwitterScraper::Models::XGetArticleResponse::Article::OrHash,
-          author: XTwitterScraper::X::TweetAuthor::OrHash
+          author: XTwitterScraper::Models::XGetArticleResponse::Author::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
         article:,
-        # Author of a tweet with follower count and verification status.
+        # X Article author profile fields returned when available.
         author: nil
       )
       end
@@ -46,7 +52,7 @@ module XTwitterScraper
         override.returns(
           {
             article: XTwitterScraper::Models::XGetArticleResponse::Article,
-            author: XTwitterScraper::X::TweetAuthor
+            author: XTwitterScraper::Models::XGetArticleResponse::Author
           }
         )
       end
@@ -62,6 +68,13 @@ module XTwitterScraper
             )
           end
 
+        # Plain text joined from all article blocks
+        sig { returns(T.nilable(String)) }
+        attr_reader :body_text
+
+        sig { params(body_text: String).void }
+        attr_writer :body_text
+
         sig do
           returns(
             T.nilable(
@@ -133,6 +146,7 @@ module XTwitterScraper
 
         sig do
           params(
+            body_text: String,
             contents:
               T::Array[
                 XTwitterScraper::Models::XGetArticleResponse::Article::Content::OrHash
@@ -148,6 +162,8 @@ module XTwitterScraper
           ).returns(T.attached_class)
         end
         def self.new(
+          # Plain text joined from all article blocks
+          body_text: nil,
           contents: nil,
           cover_image_url: nil,
           created_at: nil,
@@ -163,6 +179,7 @@ module XTwitterScraper
         sig do
           override.returns(
             {
+              body_text: String,
               contents:
                 T::Array[
                   XTwitterScraper::Models::XGetArticleResponse::Article::Content
@@ -196,21 +213,51 @@ module XTwitterScraper
           sig { params(height: Integer).void }
           attr_writer :height
 
+          # Inline text formatting ranges
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  XTwitterScraper::Models::XGetArticleResponse::Article::Content::InlineStyleRange
+                ]
+              )
+            )
+          end
+          attr_reader :inline_style_ranges
+
+          sig do
+            params(
+              inline_style_ranges:
+                T::Array[
+                  XTwitterScraper::Models::XGetArticleResponse::Article::Content::InlineStyleRange::OrHash
+                ]
+            ).void
+          end
+          attr_writer :inline_style_ranges
+
+          # Preview image URL for media blocks
+          sig { returns(T.nilable(String)) }
+          attr_reader :preview_url
+
+          sig { params(preview_url: String).void }
+          attr_writer :preview_url
+
           sig { returns(T.nilable(String)) }
           attr_reader :text
 
           sig { params(text: String).void }
           attr_writer :text
 
-          # 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
           sig { returns(T.nilable(String)) }
           attr_reader :type
 
           sig { params(type: String).void }
           attr_writer :type
 
-          # Media URL for image/gif blocks
+          # Media URL for media blocks
           sig { returns(T.nilable(String)) }
           attr_reader :url
 
@@ -226,6 +273,11 @@ module XTwitterScraper
           sig do
             params(
               height: Integer,
+              inline_style_ranges:
+                T::Array[
+                  XTwitterScraper::Models::XGetArticleResponse::Article::Content::InlineStyleRange::OrHash
+                ],
+              preview_url: String,
               text: String,
               type: String,
               url: String,
@@ -234,11 +286,16 @@ module XTwitterScraper
           end
           def self.new(
             height: nil,
+            # Inline text formatting ranges
+            inline_style_ranges: nil,
+            # Preview image URL for media blocks
+            preview_url: nil,
             text: nil,
-            # 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
             type: nil,
-            # Media URL for image/gif blocks
+            # Media URL for media blocks
             url: nil,
             width: nil
           )
@@ -248,6 +305,11 @@ module XTwitterScraper
             override.returns(
               {
                 height: Integer,
+                inline_style_ranges:
+                  T::Array[
+                    XTwitterScraper::Models::XGetArticleResponse::Article::Content::InlineStyleRange
+                  ],
+                preview_url: String,
                 text: String,
                 type: String,
                 url: String,
@@ -257,6 +319,240 @@ module XTwitterScraper
           end
           def to_hash
           end
+
+          class InlineStyleRange < XTwitterScraper::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  XTwitterScraper::Models::XGetArticleResponse::Article::Content::InlineStyleRange,
+                  XTwitterScraper::Internal::AnyHash
+                )
+              end
+
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :length
+
+            sig { params(length: Integer).void }
+            attr_writer :length
+
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :offset
+
+            sig { params(offset: Integer).void }
+            attr_writer :offset
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :style
+
+            sig { params(style: String).void }
+            attr_writer :style
+
+            sig do
+              params(length: Integer, offset: Integer, style: String).returns(
+                T.attached_class
+              )
+            end
+            def self.new(length: nil, offset: nil, style: nil)
+            end
+
+            sig do
+              override.returns(
+                { length: Integer, offset: Integer, style: String }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+
+      class Author < XTwitterScraper::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::Models::XGetArticleResponse::Author,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(String) }
+        attr_accessor :name
+
+        sig { returns(String) }
+        attr_accessor :username
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :can_dm
+
+        sig { params(can_dm: T::Boolean).void }
+        attr_writer :can_dm
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :created_at
+
+        sig { params(created_at: String).void }
+        attr_writer :created_at
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :description
+
+        sig { params(description: String).void }
+        attr_writer :description
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :favourites_count
+
+        sig { params(favourites_count: Integer).void }
+        attr_writer :favourites_count
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :followers_count
+
+        sig { params(followers_count: Integer).void }
+        attr_writer :followers_count
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :following_count
+
+        sig { params(following_count: Integer).void }
+        attr_writer :following_count
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_blue_verified
+
+        sig { params(is_blue_verified: T::Boolean).void }
+        attr_writer :is_blue_verified
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_translator
+
+        sig { params(is_translator: T::Boolean).void }
+        attr_writer :is_translator
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_verified
+
+        sig { params(is_verified: T::Boolean).void }
+        attr_writer :is_verified
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :location
+
+        sig { params(location: String).void }
+        attr_writer :location
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :media_count
+
+        sig { params(media_count: Integer).void }
+        attr_writer :media_count
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :profile_banner_url
+
+        sig { params(profile_banner_url: String).void }
+        attr_writer :profile_banner_url
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :profile_picture
+
+        sig { params(profile_picture: String).void }
+        attr_writer :profile_picture
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :protected
+
+        sig { params(protected: T::Boolean).void }
+        attr_writer :protected
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :statuses_count
+
+        sig { params(statuses_count: Integer).void }
+        attr_writer :statuses_count
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :url
+
+        sig { params(url: String).void }
+        attr_writer :url
+
+        # X Article author profile fields returned when available.
+        sig do
+          params(
+            id: String,
+            name: String,
+            username: String,
+            can_dm: T::Boolean,
+            created_at: String,
+            description: String,
+            favourites_count: Integer,
+            followers_count: Integer,
+            following_count: Integer,
+            is_blue_verified: T::Boolean,
+            is_translator: T::Boolean,
+            is_verified: T::Boolean,
+            location: String,
+            media_count: Integer,
+            profile_banner_url: String,
+            profile_picture: String,
+            protected: T::Boolean,
+            statuses_count: Integer,
+            url: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          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
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              name: String,
+              username: String,
+              can_dm: T::Boolean,
+              created_at: String,
+              description: String,
+              favourites_count: Integer,
+              followers_count: Integer,
+              following_count: Integer,
+              is_blue_verified: T::Boolean,
+              is_translator: T::Boolean,
+              is_verified: T::Boolean,
+              location: String,
+              media_count: Integer,
+              profile_banner_url: String,
+              profile_picture: String,
+              protected: T::Boolean,
+              statuses_count: Integer,
+              url: String
+            }
+          )
+        end
+        def to_hash
         end
       end
     end

data/rbi/x_twitter_scraper/models/x_get_home_timeline_params.rbi

@@ -21,7 +21,7 @@ module XTwitterScraper
       sig { params(cursor: String).void }
       attr_writer :cursor
 
-      # Comma-separated tweet IDs to exclude from results
+      # Comma-separated tweet IDs to exclude from results. Empty entries are ignored.
       sig { returns(T.nilable(String)) }
       attr_reader :seen_tweet_ids
 
@@ -38,7 +38,7 @@ module XTwitterScraper
       def self.new(
         # Pagination cursor for timeline
         cursor: nil,
-        # Comma-separated tweet IDs to exclude from results
+        # Comma-separated tweet IDs to exclude from results. Empty entries are ignored.
         seen_tweet_ids: nil,
         request_options: {}
       )

data/rbi/x_twitter_scraper/models/x_get_notifications_params.rbi

@@ -21,7 +21,7 @@ module XTwitterScraper
       sig { params(cursor: String).void }
       attr_writer :cursor
 
-      # Notification type filter
+      # Notification type filter. Unrecognized values fall back to All.
       sig do
         returns(
           T.nilable(XTwitterScraper::XGetNotificationsParams::Type::OrSymbol)
@@ -46,7 +46,7 @@ module XTwitterScraper
       def self.new(
         # Pagination cursor for notifications
         cursor: nil,
-        # Notification type filter
+        # Notification type filter. Unrecognized values fall back to All.
         type: nil,
         request_options: {}
       )
@@ -64,7 +64,7 @@ module XTwitterScraper
       def to_hash
       end
 
-      # Notification type filter
+      # Notification type filter. Unrecognized values fall back to All.
       module Type
         extend XTwitterScraper::Internal::Type::Enum
 

data/rbi/x_twitter_scraper/models/x_get_trends_params.rbi

@@ -14,16 +14,44 @@ module XTwitterScraper
           )
         end
 
+      # Number of trending topics to return (1-50, default 30)
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :count
+
+      sig { params(count: Integer).void }
+      attr_writer :count
+
+      # Region WOEID (1=Worldwide, 23424977=US, 23424975=UK, 23424969=Turkey)
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :woeid
+
+      sig { params(woeid: Integer).void }
+      attr_writer :woeid
+
       sig do
         params(
+          count: Integer,
+          woeid: Integer,
           request_options: XTwitterScraper::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(
+        # Number of trending topics to return (1-50, default 30)
+        count: nil,
+        # Region WOEID (1=Worldwide, 23424977=US, 23424975=UK, 23424969=Turkey)
+        woeid: nil,
+        request_options: {}
+      )
       end
 
       sig do
-        override.returns({ request_options: XTwitterScraper::RequestOptions })
+        override.returns(
+          {
+            count: Integer,
+            woeid: Integer,
+            request_options: XTwitterScraper::RequestOptions
+          }
+        )
       end
       def to_hash
       end

data/rbi/x_twitter_scraper/models.rbi

@@ -7,19 +7,19 @@ 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
@@ -48,6 +48,8 @@ module XTwitterScraper
 
   DrawRunParams = XTwitterScraper::Models::DrawRunParams
 
+  EmbeddedTweet = XTwitterScraper::Models::EmbeddedTweet
+
   Error = XTwitterScraper::Models::Error
 
   Event = XTwitterScraper::Models::Event
@@ -74,24 +76,14 @@ 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
 
@@ -103,6 +95,8 @@ module XTwitterScraper
 
   MonitorRetrieveParams = XTwitterScraper::Models::MonitorRetrieveParams
 
+  Monitors = XTwitterScraper::Models::Monitors
+
   MonitorUpdateParams = XTwitterScraper::Models::MonitorUpdateParams
 
   PaginatedTweets = XTwitterScraper::Models::PaginatedTweets
@@ -114,6 +108,8 @@ module XTwitterScraper
   RadarRetrieveTrendingTopicsParams =
     XTwitterScraper::Models::RadarRetrieveTrendingTopicsParams
 
+  SearchTweet = XTwitterScraper::Models::SearchTweet
+
   StyleAnalyzeParams = XTwitterScraper::Models::StyleAnalyzeParams
 
   StyleCompareParams = XTwitterScraper::Models::StyleCompareParams
@@ -138,6 +134,10 @@ module XTwitterScraper
 
   TrendListParams = XTwitterScraper::Models::TrendListParams
 
+  TweetMedia = XTwitterScraper::Models::TweetMedia
+
+  UserProfile = XTwitterScraper::Models::UserProfile
+
   Webhook = XTwitterScraper::Models::Webhook
 
   WebhookCreateParams = XTwitterScraper::Models::WebhookCreateParams
@@ -149,6 +149,8 @@ module XTwitterScraper
 
   WebhookListParams = XTwitterScraper::Models::WebhookListParams
 
+  WebhookResumeParams = XTwitterScraper::Models::WebhookResumeParams
+
   WebhookTestParams = XTwitterScraper::Models::WebhookTestParams
 
   WebhookUpdateParams = XTwitterScraper::Models::WebhookUpdateParams

data/rbi/x_twitter_scraper/resources/account.rbi

@@ -2,7 +2,7 @@
 
 module XTwitterScraper
   module Resources
-    # Account info & settings
+    # Account info and settings
     class Account
       # Get account info
       sig do

data/rbi/x_twitter_scraper/resources/compose.rbi

@@ -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
       sig do

data/rbi/x_twitter_scraper/resources/credits.rbi

@@ -2,8 +2,22 @@
 
 module XTwitterScraper
   module Resources
-    # Subscription & billing
+    # Subscription, billing, and credits
     class Credits
+      # Redirect to an active top-up payment page
+      sig do
+        params(
+          session_id: String,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).void
+      end
+      def redirect_topup_checkout(
+        # Billing session ID returned by the top-up billing flow.
+        session_id:,
+        request_options: {}
+      )
+      end
+
       # Get credits balance
       sig do
         params(
@@ -13,16 +27,34 @@ module XTwitterScraper
       def retrieve_balance(request_options: {})
       end
 
-      # Top up credits balance
+      # Get top-up billing status
+      sig do
+        params(
+          session_id: String,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(XTwitterScraper::Models::CreditRetrieveTopupStatusResponse)
+      end
+      def retrieve_topup_status(
+        # Billing session ID returned by the top-up billing flow.
+        session_id:,
+        request_options: {}
+      )
+      end
+
+      # Create a Stripe Checkout session only after the user confirms. The request never
+      # completes payment or adds credits by itself.
       sig do
         params(
-          amount: Integer,
+          dollars: Integer,
+          locale: String,
           request_options: XTwitterScraper::RequestOptions::OrHash
         ).returns(XTwitterScraper::Models::CreditTopupBalanceResponse)
       end
       def topup_balance(
-        # 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