x-twitter-scraper 0.3.0 → 0.4.0

data/rbi/x_twitter_scraper/models/webhook_update_params.rbi

@@ -17,20 +17,12 @@ module XTwitterScraper
       sig { returns(String) }
       attr_accessor :id
 
-      sig do
-        returns(
-          T.nilable(
-            T::Array[XTwitterScraper::WebhookUpdateParams::EventType::OrSymbol]
-          )
-        )
-      end
+      # Array of event types to subscribe to.
+      sig { returns(T.nilable(T::Array[XTwitterScraper::EventType::OrSymbol])) }
       attr_reader :event_types
 
       sig do
-        params(
-          event_types:
-            T::Array[XTwitterScraper::WebhookUpdateParams::EventType::OrSymbol]
-        ).void
+        params(event_types: T::Array[XTwitterScraper::EventType::OrSymbol]).void
       end
       attr_writer :event_types
 
@@ -49,8 +41,7 @@ module XTwitterScraper
       sig do
         params(
           id: String,
-          event_types:
-            T::Array[XTwitterScraper::WebhookUpdateParams::EventType::OrSymbol],
+          event_types: T::Array[XTwitterScraper::EventType::OrSymbol],
           is_active: T::Boolean,
           url: String,
           request_options: XTwitterScraper::RequestOptions::OrHash
@@ -58,6 +49,7 @@ module XTwitterScraper
       end
       def self.new(
         id:,
+        # Array of event types to subscribe to.
         event_types: nil,
         is_active: nil,
         url: nil,
@@ -69,10 +61,7 @@ module XTwitterScraper
         override.returns(
           {
             id: String,
-            event_types:
-              T::Array[
-                XTwitterScraper::WebhookUpdateParams::EventType::OrSymbol
-              ],
+            event_types: T::Array[XTwitterScraper::EventType::OrSymbol],
             is_active: T::Boolean,
             url: String,
             request_options: XTwitterScraper::RequestOptions
@@ -81,57 +70,6 @@ module XTwitterScraper
       end
       def to_hash
       end
-
-      module EventType
-        extend XTwitterScraper::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, XTwitterScraper::WebhookUpdateParams::EventType)
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        TWEET_NEW =
-          T.let(
-            :"tweet.new",
-            XTwitterScraper::WebhookUpdateParams::EventType::TaggedSymbol
-          )
-        TWEET_REPLY =
-          T.let(
-            :"tweet.reply",
-            XTwitterScraper::WebhookUpdateParams::EventType::TaggedSymbol
-          )
-        TWEET_RETWEET =
-          T.let(
-            :"tweet.retweet",
-            XTwitterScraper::WebhookUpdateParams::EventType::TaggedSymbol
-          )
-        TWEET_QUOTE =
-          T.let(
-            :"tweet.quote",
-            XTwitterScraper::WebhookUpdateParams::EventType::TaggedSymbol
-          )
-        FOLLOWER_GAINED =
-          T.let(
-            :"follower.gained",
-            XTwitterScraper::WebhookUpdateParams::EventType::TaggedSymbol
-          )
-        FOLLOWER_LOST =
-          T.let(
-            :"follower.lost",
-            XTwitterScraper::WebhookUpdateParams::EventType::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              XTwitterScraper::WebhookUpdateParams::EventType::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
     end
   end
 end

data/rbi/x_twitter_scraper/models/winner.rbi

@@ -20,6 +20,7 @@ module XTwitterScraper
       sig { returns(String) }
       attr_accessor :tweet_id
 
+      # Giveaway draw winner with position and backup flag.
       sig do
         params(
           author_username: String,

data/rbi/x_twitter_scraper/models/x/account_bulk_retry_params.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    module X
+      class AccountBulkRetryParams < XTwitterScraper::Internal::Type::BaseModel
+        extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+        include XTwitterScraper::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::X::AccountBulkRetryParams,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        sig do
+          params(
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(request_options: {})
+        end
+
+        sig do
+          override.returns({ request_options: XTwitterScraper::RequestOptions })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/x/account_bulk_retry_response.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    module X
+      class AccountBulkRetryResponse < XTwitterScraper::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::Models::X::AccountBulkRetryResponse,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        # Number of accounts cleared
+        sig { returns(Integer) }
+        attr_accessor :cleared
+
+        sig { params(cleared: Integer).returns(T.attached_class) }
+        def self.new(
+          # Number of accounts cleared
+          cleared:
+        )
+        end
+
+        sig { override.returns({ cleared: Integer }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/x/account_list_response.rbi

@@ -12,87 +12,22 @@ module XTwitterScraper
             )
           end
 
-        sig do
-          returns(
-            T::Array[XTwitterScraper::Models::X::AccountListResponse::Account]
-          )
-        end
+        sig { returns(T::Array[XTwitterScraper::X::XAccount]) }
         attr_accessor :accounts
 
         sig do
           params(
-            accounts:
-              T::Array[
-                XTwitterScraper::Models::X::AccountListResponse::Account::OrHash
-              ]
+            accounts: T::Array[XTwitterScraper::X::XAccount::OrHash]
           ).returns(T.attached_class)
         end
         def self.new(accounts:)
         end
 
         sig do
-          override.returns(
-            {
-              accounts:
-                T::Array[
-                  XTwitterScraper::Models::X::AccountListResponse::Account
-                ]
-            }
-          )
+          override.returns({ accounts: T::Array[XTwitterScraper::X::XAccount] })
         end
         def to_hash
         end
-
-        class Account < XTwitterScraper::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                XTwitterScraper::Models::X::AccountListResponse::Account,
-                XTwitterScraper::Internal::AnyHash
-              )
-            end
-
-          sig { returns(String) }
-          attr_accessor :id
-
-          sig { returns(Time) }
-          attr_accessor :created_at
-
-          sig { returns(String) }
-          attr_accessor :status
-
-          sig { returns(String) }
-          attr_accessor :x_user_id
-
-          sig { returns(String) }
-          attr_accessor :x_username
-
-          sig do
-            params(
-              id: String,
-              created_at: Time,
-              status: String,
-              x_user_id: String,
-              x_username: String
-            ).returns(T.attached_class)
-          end
-          def self.new(id:, created_at:, status:, x_user_id:, x_username:)
-          end
-
-          sig do
-            override.returns(
-              {
-                id: String,
-                created_at: Time,
-                status: String,
-                x_user_id: String,
-                x_username: String
-              }
-            )
-          end
-          def to_hash
-          end
-        end
       end
     end
   end

data/rbi/x_twitter_scraper/models/x/account_reauth_params.rbi

@@ -18,11 +18,11 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :id
 
-        # Account password
+        # Updated account password
         sig { returns(String) }
         attr_accessor :password
 
-        # TOTP secret for 2FA
+        # TOTP secret for 2FA re-authentication
         sig { returns(T.nilable(String)) }
         attr_reader :totp_secret
 
@@ -39,9 +39,9 @@ module XTwitterScraper
         end
         def self.new(
           id:,
-          # Account password
+          # Updated account password
           password:,
-          # TOTP secret for 2FA
+          # TOTP secret for 2FA re-authentication
           totp_secret: nil,
           request_options: {}
         )

data/rbi/x_twitter_scraper/models/x/bookmark_list_params.rbi

@@ -15,7 +15,7 @@ module XTwitterScraper
             )
           end
 
-        # Pagination cursor from previous response
+        # Pagination cursor for bookmarks
         sig { returns(T.nilable(String)) }
         attr_reader :cursor
 
@@ -37,7 +37,7 @@ module XTwitterScraper
           ).returns(T.attached_class)
         end
         def self.new(
-          # Pagination cursor from previous response
+          # Pagination cursor for bookmarks
           cursor: nil,
           # Optional bookmark folder ID
           folder_id: nil,

data/rbi/x_twitter_scraper/models/x/communities/join_create_params.rbi

@@ -19,7 +19,7 @@ module XTwitterScraper
           sig { returns(String) }
           attr_accessor :id
 
-          # X account (@username or account ID)
+          # X account identifier (@username or account ID)
           sig { returns(String) }
           attr_accessor :account
 
@@ -32,7 +32,7 @@ module XTwitterScraper
           end
           def self.new(
             id:,
-            # X account (@username or account ID)
+            # X account identifier (@username or account ID)
             account:,
             request_options: {}
           )

data/rbi/x_twitter_scraper/models/x/communities/join_delete_all_params.rbi

@@ -19,7 +19,7 @@ module XTwitterScraper
           sig { returns(String) }
           attr_accessor :id
 
-          # X account (@username or account ID)
+          # X account identifier (@username or account ID)
           sig { returns(String) }
           attr_accessor :account
 
@@ -32,7 +32,7 @@ module XTwitterScraper
           end
           def self.new(
             id:,
-            # X account (@username or account ID)
+            # X account identifier (@username or account ID)
             account:,
             request_options: {}
           )

data/rbi/x_twitter_scraper/models/x/communities/tweet_list_by_community_params.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    module X
+      module Communities
+        class TweetListByCommunityParams < XTwitterScraper::Internal::Type::BaseModel
+          extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+          include XTwitterScraper::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                XTwitterScraper::X::Communities::TweetListByCommunityParams,
+                XTwitterScraper::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Pagination cursor for community tweets
+          sig { returns(T.nilable(String)) }
+          attr_reader :cursor
+
+          sig { params(cursor: String).void }
+          attr_writer :cursor
+
+          sig do
+            params(
+              id: String,
+              cursor: String,
+              request_options: XTwitterScraper::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            id:,
+            # Pagination cursor for community tweets
+            cursor: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                cursor: String,
+                request_options: XTwitterScraper::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/x/communities/tweet_list_params.rbi

@@ -16,18 +16,18 @@ module XTwitterScraper
               )
             end
 
-          # Search query
+          # Search query for cross-community tweets
           sig { returns(String) }
           attr_accessor :q
 
-          # Pagination cursor
+          # Pagination cursor for cross-community results
           sig { returns(T.nilable(String)) }
           attr_reader :cursor
 
           sig { params(cursor: String).void }
           attr_writer :cursor
 
-          # Sort order (Latest or Top)
+          # Sort order for cross-community results (Latest or Top)
           sig { returns(T.nilable(String)) }
           attr_reader :query_type
 
@@ -43,11 +43,11 @@ module XTwitterScraper
             ).returns(T.attached_class)
           end
           def self.new(
-            # Search query
+            # Search query for cross-community tweets
             q:,
-            # Pagination cursor
+            # Pagination cursor for cross-community results
             cursor: nil,
-            # Sort order (Latest or Top)
+            # Sort order for cross-community results (Latest or Top)
             query_type: nil,
             request_options: {}
           )

data/rbi/x_twitter_scraper/models/x/community_action_result.rbi

@@ -21,6 +21,7 @@ module XTwitterScraper
         sig { returns(T::Boolean) }
         attr_accessor :success
 
+        # Result of a community join or leave action.
         sig do
           params(
             community_id: String,

data/rbi/x_twitter_scraper/models/x/community_create_params.rbi

@@ -15,7 +15,7 @@ module XTwitterScraper
             )
           end
 
-        # X account (@username or account ID)
+        # X account (@username or ID) creating the community
         sig { returns(String) }
         attr_accessor :account
 
@@ -39,7 +39,7 @@ module XTwitterScraper
           ).returns(T.attached_class)
         end
         def self.new(
-          # X account (@username or account ID)
+          # X account (@username or ID) creating the community
           account:,
           # Community name
           name:,

data/rbi/x_twitter_scraper/models/x/community_delete_params.rbi

@@ -18,7 +18,7 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :id
 
-        # X account (@username or account ID)
+        # X account (@username or ID) deleting the community
         sig { returns(String) }
         attr_accessor :account
 
@@ -36,7 +36,7 @@ module XTwitterScraper
         end
         def self.new(
           id:,
-          # X account (@username or account ID)
+          # X account (@username or ID) deleting the community
           account:,
           # Community name for confirmation
           community_name:,

data/rbi/x_twitter_scraper/models/x/community_retrieve_info_response.rbi

@@ -60,7 +60,7 @@ module XTwitterScraper
               )
             end
 
-          # Community ID
+          # Unique community identifier
           sig { returns(String) }
           attr_accessor :id
 
@@ -78,7 +78,7 @@ module XTwitterScraper
           sig { params(created_at: String).void }
           attr_writer :created_at
 
-          # Community description
+          # About text for the community
           sig { returns(T.nilable(String)) }
           attr_reader :description
 
@@ -106,7 +106,7 @@ module XTwitterScraper
           sig { params(moderator_count: Integer).void }
           attr_writer :moderator_count
 
-          # Community name
+          # Display name of the community
           sig { returns(T.nilable(String)) }
           attr_reader :name
 
@@ -173,13 +173,13 @@ module XTwitterScraper
             ).returns(T.attached_class)
           end
           def self.new(
-            # Community ID
+            # Unique community identifier
             id:,
             # Community banner image URL
             banner_url: nil,
             # Community creation timestamp
             created_at: nil,
-            # Community description
+            # About text for the community
             description: nil,
             # Join policy (open or restricted)
             join_policy: nil,
@@ -187,7 +187,7 @@ module XTwitterScraper
             member_count: nil,
             # Total moderator count
             moderator_count: nil,
-            # Community name
+            # Display name of the community
             name: nil,
             # Primary topic
             primary_topic: nil,

data/rbi/x_twitter_scraper/models/x/community_retrieve_moderators_params.rbi

@@ -18,7 +18,7 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :id
 
-        # Pagination cursor
+        # Pagination cursor for community moderators
         sig { returns(T.nilable(String)) }
         attr_reader :cursor
 
@@ -34,7 +34,7 @@ module XTwitterScraper
         end
         def self.new(
           id:,
-          # Pagination cursor
+          # Pagination cursor for community moderators
           cursor: nil,
           request_options: {}
         )

data/rbi/x_twitter_scraper/models/x/community_retrieve_search_params.rbi

@@ -19,7 +19,7 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :q
 
-        # Pagination cursor
+        # Pagination cursor for community search
         sig { returns(T.nilable(String)) }
         attr_reader :cursor
 
@@ -44,7 +44,7 @@ module XTwitterScraper
         def self.new(
           # Search query
           q:,
-          # Pagination cursor
+          # Pagination cursor for community search
           cursor: nil,
           # Sort order (Latest or Top)
           query_type: nil,

data/rbi/x_twitter_scraper/models/x/dm_retrieve_history_params.rbi

@@ -18,7 +18,7 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :user_id
 
-        # Pagination cursor from previous response
+        # Pagination cursor for DM history
         sig { returns(T.nilable(String)) }
         attr_reader :cursor
 
@@ -42,7 +42,7 @@ module XTwitterScraper
         end
         def self.new(
           user_id:,
-          # Pagination cursor from previous response
+          # Pagination cursor for DM history
           cursor: nil,
           # Legacy pagination cursor (backward compat)
           max_id: nil,

data/rbi/x_twitter_scraper/models/x/dm_send_params.rbi

@@ -18,7 +18,7 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :user_id
 
-        # X account (@username or account ID)
+        # X account (@username or ID) sending the DM
         sig { returns(String) }
         attr_accessor :account
 
@@ -49,7 +49,7 @@ module XTwitterScraper
         end
         def self.new(
           user_id:,
-          # X account (@username or account ID)
+          # X account (@username or ID) sending the DM
           account:,
           text:,
           media_ids: nil,

data/rbi/x_twitter_scraper/models/x/list_retrieve_followers_params.rbi

@@ -18,7 +18,7 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :id
 
-        # Pagination cursor
+        # Pagination cursor for list followers
         sig { returns(T.nilable(String)) }
         attr_reader :cursor
 
@@ -34,7 +34,7 @@ module XTwitterScraper
         end
         def self.new(
           id:,
-          # Pagination cursor
+          # Pagination cursor for list followers
           cursor: nil,
           request_options: {}
         )

data/rbi/x_twitter_scraper/models/x/list_retrieve_members_params.rbi

@@ -18,7 +18,7 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :id
 
-        # Pagination cursor
+        # Pagination cursor for list members
         sig { returns(T.nilable(String)) }
         attr_reader :cursor
 
@@ -34,7 +34,7 @@ module XTwitterScraper
         end
         def self.new(
           id:,
-          # Pagination cursor
+          # Pagination cursor for list members
           cursor: nil,
           request_options: {}
         )

data/rbi/x_twitter_scraper/models/x/list_retrieve_tweets_params.rbi

@@ -18,7 +18,7 @@ module XTwitterScraper
         sig { returns(String) }
         attr_accessor :id
 
-        # Pagination cursor
+        # Pagination cursor for list tweets
         sig { returns(T.nilable(String)) }
         attr_reader :cursor
 
@@ -58,7 +58,7 @@ module XTwitterScraper
         end
         def self.new(
           id:,
-          # Pagination cursor
+          # Pagination cursor for list tweets
           cursor: nil,
           # Include replies (default false)
           include_replies: nil,