x-twitter-scraper 0.3.0

data/rbi/x_twitter_scraper/models/x/user_retrieve_media_response.rbi

@@ -0,0 +1,233 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    module X
+      class UserRetrieveMediaResponse < XTwitterScraper::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::Models::X::UserRetrieveMediaResponse,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T::Boolean) }
+        attr_accessor :has_next_page
+
+        sig { returns(String) }
+        attr_accessor :next_cursor
+
+        sig do
+          returns(
+            T::Array[
+              XTwitterScraper::Models::X::UserRetrieveMediaResponse::Tweet
+            ]
+          )
+        end
+        attr_accessor :tweets
+
+        sig do
+          params(
+            has_next_page: T::Boolean,
+            next_cursor: String,
+            tweets:
+              T::Array[
+                XTwitterScraper::Models::X::UserRetrieveMediaResponse::Tweet::OrHash
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(has_next_page:, next_cursor:, tweets:)
+        end
+
+        sig do
+          override.returns(
+            {
+              has_next_page: T::Boolean,
+              next_cursor: String,
+              tweets:
+                T::Array[
+                  XTwitterScraper::Models::X::UserRetrieveMediaResponse::Tweet
+                ]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Tweet < XTwitterScraper::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                XTwitterScraper::Models::X::UserRetrieveMediaResponse::Tweet,
+                XTwitterScraper::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(String) }
+          attr_accessor :text
+
+          sig do
+            returns(
+              T.nilable(
+                XTwitterScraper::Models::X::UserRetrieveMediaResponse::Tweet::Author
+              )
+            )
+          end
+          attr_reader :author
+
+          sig do
+            params(
+              author:
+                XTwitterScraper::Models::X::UserRetrieveMediaResponse::Tweet::Author::OrHash
+            ).void
+          end
+          attr_writer :author
+
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :bookmark_count
+
+          sig { params(bookmark_count: Integer).void }
+          attr_writer :bookmark_count
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :created_at
+
+          sig { params(created_at: String).void }
+          attr_writer :created_at
+
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :like_count
+
+          sig { params(like_count: Integer).void }
+          attr_writer :like_count
+
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :quote_count
+
+          sig { params(quote_count: Integer).void }
+          attr_writer :quote_count
+
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :reply_count
+
+          sig { params(reply_count: Integer).void }
+          attr_writer :reply_count
+
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :retweet_count
+
+          sig { params(retweet_count: Integer).void }
+          attr_writer :retweet_count
+
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :view_count
+
+          sig { params(view_count: Integer).void }
+          attr_writer :view_count
+
+          sig do
+            params(
+              id: String,
+              text: String,
+              author:
+                XTwitterScraper::Models::X::UserRetrieveMediaResponse::Tweet::Author::OrHash,
+              bookmark_count: Integer,
+              created_at: String,
+              like_count: Integer,
+              quote_count: Integer,
+              reply_count: Integer,
+              retweet_count: Integer,
+              view_count: Integer
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            id:,
+            text:,
+            author: nil,
+            bookmark_count: nil,
+            created_at: nil,
+            like_count: nil,
+            quote_count: nil,
+            reply_count: nil,
+            retweet_count: nil,
+            view_count: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                text: String,
+                author:
+                  XTwitterScraper::Models::X::UserRetrieveMediaResponse::Tweet::Author,
+                bookmark_count: Integer,
+                created_at: String,
+                like_count: Integer,
+                quote_count: Integer,
+                reply_count: Integer,
+                retweet_count: Integer,
+                view_count: Integer
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Author < XTwitterScraper::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  XTwitterScraper::Models::X::UserRetrieveMediaResponse::Tweet::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 :verified
+
+            sig { params(verified: T::Boolean).void }
+            attr_writer :verified
+
+            sig do
+              params(
+                id: String,
+                name: String,
+                username: String,
+                verified: T::Boolean
+              ).returns(T.attached_class)
+            end
+            def self.new(id:, name:, username:, verified: nil)
+            end
+
+            sig do
+              override.returns(
+                {
+                  id: String,
+                  name: String,
+                  username: String,
+                  verified: T::Boolean
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/x/user_retrieve_mentions_params.rbi

@@ -0,0 +1,79 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    module X
+      class UserRetrieveMentionsParams < XTwitterScraper::Internal::Type::BaseModel
+        extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+        include XTwitterScraper::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::X::UserRetrieveMentionsParams,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Pagination cursor
+        sig { returns(T.nilable(String)) }
+        attr_reader :cursor
+
+        sig { params(cursor: String).void }
+        attr_writer :cursor
+
+        # Unix timestamp - filter after
+        sig { returns(T.nilable(String)) }
+        attr_reader :since_time
+
+        sig { params(since_time: String).void }
+        attr_writer :since_time
+
+        # Unix timestamp - filter before
+        sig { returns(T.nilable(String)) }
+        attr_reader :until_time
+
+        sig { params(until_time: String).void }
+        attr_writer :until_time
+
+        sig do
+          params(
+            id: String,
+            cursor: String,
+            since_time: String,
+            until_time: String,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          # Pagination cursor
+          cursor: nil,
+          # Unix timestamp - filter after
+          since_time: nil,
+          # Unix timestamp - filter before
+          until_time: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              cursor: String,
+              since_time: String,
+              until_time: String,
+              request_options: XTwitterScraper::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/x/user_retrieve_params.rbi

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

data/rbi/x_twitter_scraper/models/x/user_retrieve_response.rbi

@@ -0,0 +1,124 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    module X
+      class UserRetrieveResponse < XTwitterScraper::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::Models::X::UserRetrieveResponse,
+              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(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 :followers
+
+        sig { params(followers: Integer).void }
+        attr_writer :followers
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :following
+
+        sig { params(following: Integer).void }
+        attr_writer :following
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :location
+
+        sig { params(location: String).void }
+        attr_writer :location
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :profile_picture
+
+        sig { params(profile_picture: String).void }
+        attr_writer :profile_picture
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :statuses_count
+
+        sig { params(statuses_count: Integer).void }
+        attr_writer :statuses_count
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :verified
+
+        sig { params(verified: T::Boolean).void }
+        attr_writer :verified
+
+        sig do
+          params(
+            id: String,
+            name: String,
+            username: String,
+            created_at: String,
+            description: String,
+            followers: Integer,
+            following: Integer,
+            location: String,
+            profile_picture: String,
+            statuses_count: Integer,
+            verified: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          name:,
+          username:,
+          created_at: nil,
+          description: nil,
+          followers: nil,
+          following: nil,
+          location: nil,
+          profile_picture: nil,
+          statuses_count: nil,
+          verified: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              name: String,
+              username: String,
+              created_at: String,
+              description: String,
+              followers: Integer,
+              following: Integer,
+              location: String,
+              profile_picture: String,
+              statuses_count: Integer,
+              verified: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/x/user_retrieve_search_params.rbi

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

data/rbi/x_twitter_scraper/models/x/user_retrieve_tweets_params.rbi

@@ -0,0 +1,79 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    module X
+      class UserRetrieveTweetsParams < XTwitterScraper::Internal::Type::BaseModel
+        extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+        include XTwitterScraper::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::X::UserRetrieveTweetsParams,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Pagination cursor from previous response
+        sig { returns(T.nilable(String)) }
+        attr_reader :cursor
+
+        sig { params(cursor: String).void }
+        attr_writer :cursor
+
+        # Include parent tweet for replies
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :include_parent_tweet
+
+        sig { params(include_parent_tweet: T::Boolean).void }
+        attr_writer :include_parent_tweet
+
+        # Include reply tweets
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :include_replies
+
+        sig { params(include_replies: T::Boolean).void }
+        attr_writer :include_replies
+
+        sig do
+          params(
+            id: String,
+            cursor: String,
+            include_parent_tweet: T::Boolean,
+            include_replies: T::Boolean,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          # Pagination cursor from previous response
+          cursor: nil,
+          # Include parent tweet for replies
+          include_parent_tweet: nil,
+          # Include reply tweets
+          include_replies: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              cursor: String,
+              include_parent_tweet: T::Boolean,
+              include_replies: T::Boolean,
+              request_options: XTwitterScraper::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end