x-twitter-scraper 0.3.0

data/lib/x_twitter_scraper/models/x/x_account_detail.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      class XAccountDetail < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time, api_name: :createdAt
+
+        # @!attribute status
+        #
+        #   @return [String]
+        required :status, String
+
+        # @!attribute x_user_id
+        #
+        #   @return [String]
+        required :x_user_id, String, api_name: :xUserId
+
+        # @!attribute x_username
+        #
+        #   @return [String]
+        required :x_username, String, api_name: :xUsername
+
+        # @!attribute cookies_obtained_at
+        #
+        #   @return [Time, nil]
+        optional :cookies_obtained_at, Time, api_name: :cookiesObtainedAt
+
+        # @!attribute proxy_country
+        #
+        #   @return [String, nil]
+        optional :proxy_country, String, api_name: :proxyCountry
+
+        # @!attribute updated_at
+        #
+        #   @return [Time, nil]
+        optional :updated_at, Time, api_name: :updatedAt
+
+        # @!method initialize(id:, created_at:, status:, x_user_id:, x_username:, cookies_obtained_at: nil, proxy_country: nil, updated_at: nil)
+        #   @param id [String]
+        #   @param created_at [Time]
+        #   @param status [String]
+        #   @param x_user_id [String]
+        #   @param x_username [String]
+        #   @param cookies_obtained_at [Time]
+        #   @param proxy_country [String]
+        #   @param updated_at [Time]
+      end
+    end
+
+    XAccountDetail = X::XAccountDetail
+  end
+end

data/lib/x_twitter_scraper/models/x_get_article_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::X#get_article
+    class XGetArticleParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      # @!attribute tweet_id
+      #
+      #   @return [String]
+      required :tweet_id, String
+
+      # @!method initialize(tweet_id:, request_options: {})
+      #   @param tweet_id [String]
+      #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/x_twitter_scraper/models/x_get_article_response.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::X#get_article
+    class XGetArticleResponse < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute article
+      #
+      #   @return [XTwitterScraper::Models::XGetArticleResponse::Article]
+      required :article, -> { XTwitterScraper::Models::XGetArticleResponse::Article }
+
+      # @!attribute author
+      #
+      #   @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::XGetArticleResponse::Author]
+
+      # @see XTwitterScraper::Models::XGetArticleResponse#article
+      class Article < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute contents
+        #
+        #   @return [Array<XTwitterScraper::Models::XGetArticleResponse::Article::Content>, nil]
+        optional :contents,
+                 -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::XGetArticleResponse::Article::Content] }
+
+        # @!attribute cover_image_url
+        #
+        #   @return [String, nil]
+        optional :cover_image_url, String, api_name: :coverImageUrl
+
+        # @!attribute created_at
+        #
+        #   @return [String, nil]
+        optional :created_at, String, api_name: :createdAt
+
+        # @!attribute like_count
+        #
+        #   @return [Integer, nil]
+        optional :like_count, Integer, api_name: :likeCount
+
+        # @!attribute preview_text
+        #
+        #   @return [String, nil]
+        optional :preview_text, String, api_name: :previewText
+
+        # @!attribute quote_count
+        #
+        #   @return [Integer, nil]
+        optional :quote_count, Integer, api_name: :quoteCount
+
+        # @!attribute reply_count
+        #
+        #   @return [Integer, nil]
+        optional :reply_count, Integer, api_name: :replyCount
+
+        # @!attribute title
+        #
+        #   @return [String, nil]
+        optional :title, String
+
+        # @!attribute view_count
+        #
+        #   @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)
+        #   @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
+          # @!attribute height
+          #
+          #   @return [Integer, nil]
+          optional :height, Integer
+
+          # @!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
+          #
+          #   @return [String, nil]
+          optional :type, String
+
+          # @!attribute url
+          #   Media URL for image/gif blocks
+          #
+          #   @return [String, nil]
+          optional :url, String
+
+          # @!attribute width
+          #
+          #   @return [Integer, nil]
+          optional :width, Integer
+
+          # @!method initialize(height: 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 text [String]
+          #
+          #   @param type [String] Block type: unstyled, header-one, header-two, header-three, unordered-list-item,
+          #
+          #   @param url [String] Media URL for image/gif blocks
+          #
+          #   @param width [Integer]
+        end
+      end
+
+      # @see XTwitterScraper::Models::XGetArticleResponse#author
+      class Author < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute followers
+        #
+        #   @return [Integer]
+        required :followers, Integer
+
+        # @!attribute username
+        #
+        #   @return [String]
+        required :username, String
+
+        # @!attribute verified
+        #
+        #   @return [Boolean]
+        required :verified, XTwitterScraper::Internal::Type::Boolean
+
+        # @!attribute profile_picture
+        #
+        #   @return [String, nil]
+        optional :profile_picture, String, api_name: :profilePicture
+
+        # @!method initialize(id:, followers:, username:, verified:, profile_picture: nil)
+        #   @param id [String]
+        #   @param followers [Integer]
+        #   @param username [String]
+        #   @param verified [Boolean]
+        #   @param profile_picture [String]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/x_get_home_timeline_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::X#get_home_timeline
+    class XGetHomeTimelineParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      # @!attribute cursor
+      #   Pagination cursor from previous response
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute seen_tweet_ids
+      #   Comma-separated tweet IDs to exclude from results
+      #
+      #   @return [String, nil]
+      optional :seen_tweet_ids, String
+
+      # @!method initialize(cursor: nil, seen_tweet_ids: nil, request_options: {})
+      #   @param cursor [String] Pagination cursor from previous response
+      #
+      #   @param seen_tweet_ids [String] Comma-separated tweet IDs to exclude from results
+      #
+      #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/x_twitter_scraper/models/x_get_home_timeline_response.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::X#get_home_timeline
+    class XGetHomeTimelineResponse < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute has_next_page
+      #
+      #   @return [Boolean]
+      required :has_next_page, XTwitterScraper::Internal::Type::Boolean
+
+      # @!attribute next_cursor
+      #
+      #   @return [String]
+      required :next_cursor, String
+
+      # @!attribute tweets
+      #
+      #   @return [Array<XTwitterScraper::Models::XGetHomeTimelineResponse::Tweet>]
+      required :tweets,
+               -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::XGetHomeTimelineResponse::Tweet] }
+
+      # @!method initialize(has_next_page:, next_cursor:, tweets:)
+      #   @param has_next_page [Boolean]
+      #   @param next_cursor [String]
+      #   @param tweets [Array<XTwitterScraper::Models::XGetHomeTimelineResponse::Tweet>]
+
+      class Tweet < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute text
+        #
+        #   @return [String]
+        required :text, String
+
+        # @!attribute author
+        #
+        #   @return [XTwitterScraper::Models::XGetHomeTimelineResponse::Tweet::Author, nil]
+        optional :author, -> { XTwitterScraper::Models::XGetHomeTimelineResponse::Tweet::Author }
+
+        # @!attribute bookmark_count
+        #
+        #   @return [Integer, nil]
+        optional :bookmark_count, Integer, api_name: :bookmarkCount
+
+        # @!attribute created_at
+        #
+        #   @return [String, nil]
+        optional :created_at, String, api_name: :createdAt
+
+        # @!attribute like_count
+        #
+        #   @return [Integer, nil]
+        optional :like_count, Integer, api_name: :likeCount
+
+        # @!attribute quote_count
+        #
+        #   @return [Integer, nil]
+        optional :quote_count, Integer, api_name: :quoteCount
+
+        # @!attribute reply_count
+        #
+        #   @return [Integer, nil]
+        optional :reply_count, Integer, api_name: :replyCount
+
+        # @!attribute retweet_count
+        #
+        #   @return [Integer, nil]
+        optional :retweet_count, Integer, api_name: :retweetCount
+
+        # @!attribute view_count
+        #
+        #   @return [Integer, nil]
+        optional :view_count, Integer, api_name: :viewCount
+
+        # @!method initialize(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)
+        #   @param id [String]
+        #   @param text [String]
+        #   @param author [XTwitterScraper::Models::XGetHomeTimelineResponse::Tweet::Author]
+        #   @param bookmark_count [Integer]
+        #   @param created_at [String]
+        #   @param like_count [Integer]
+        #   @param quote_count [Integer]
+        #   @param reply_count [Integer]
+        #   @param retweet_count [Integer]
+        #   @param view_count [Integer]
+
+        # @see XTwitterScraper::Models::XGetHomeTimelineResponse::Tweet#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 verified
+          #
+          #   @return [Boolean, nil]
+          optional :verified, XTwitterScraper::Internal::Type::Boolean
+
+          # @!method initialize(id:, name:, username:, verified: nil)
+          #   @param id [String]
+          #   @param name [String]
+          #   @param username [String]
+          #   @param verified [Boolean]
+        end
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/x_get_notifications_params.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::X#get_notifications
+    class XGetNotificationsParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      # @!attribute cursor
+      #   Pagination cursor from previous response
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute type
+      #   Notification type filter
+      #
+      #   @return [Symbol, XTwitterScraper::Models::XGetNotificationsParams::Type, nil]
+      optional :type, enum: -> { XTwitterScraper::XGetNotificationsParams::Type }
+
+      # @!method initialize(cursor: nil, type: nil, request_options: {})
+      #   @param cursor [String] Pagination cursor from previous response
+      #
+      #   @param type [Symbol, XTwitterScraper::Models::XGetNotificationsParams::Type] Notification type filter
+      #
+      #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+
+      # Notification type filter
+      module Type
+        extend XTwitterScraper::Internal::Type::Enum
+
+        ALL = :All
+        VERIFIED = :Verified
+        MENTIONS = :Mentions
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/x_get_notifications_response.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::X#get_notifications
+    class XGetNotificationsResponse < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute has_next_page
+      #
+      #   @return [Boolean]
+      required :has_next_page, XTwitterScraper::Internal::Type::Boolean
+
+      # @!attribute next_cursor
+      #
+      #   @return [String]
+      required :next_cursor, String
+
+      # @!attribute notifications
+      #
+      #   @return [Array<XTwitterScraper::Models::XGetNotificationsResponse::Notification>]
+      required :notifications,
+               -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::XGetNotificationsResponse::Notification] }
+
+      # @!method initialize(has_next_page:, next_cursor:, notifications:)
+      #   @param has_next_page [Boolean]
+      #   @param next_cursor [String]
+      #   @param notifications [Array<XTwitterScraper::Models::XGetNotificationsResponse::Notification>]
+
+      class Notification < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute message
+        #
+        #   @return [String, nil]
+        optional :message, String
+
+        # @!attribute timestamp
+        #
+        #   @return [String, nil]
+        optional :timestamp, String
+
+        # @!attribute type
+        #
+        #   @return [String, nil]
+        optional :type, String
+
+        # @!method initialize(id:, message: nil, timestamp: nil, type: nil)
+        #   @param id [String]
+        #   @param message [String]
+        #   @param timestamp [String]
+        #   @param type [String]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/x_get_trends_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::X#get_trends
+    class XGetTrendsParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end