x-twitter-scraper 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b484492b68eb864049194156f172bd54ce3c734dab416a379e89479c29975984
-  data.tar.gz: 8bb73e082d9e1c88738e49eb3b1ab6ee8612651459dda021addf4cc5c55f21d7
+  metadata.gz: bf080feaa482690e15947927eccf2f0021e7de8feb17ce6aabf38259d847f84e
+  data.tar.gz: e3c744d47f24d3cab0e2878551ad141db14685f913b3ae859012726acc805918
 SHA512:
-  metadata.gz: 141f2f77507134941baafee648e1f293f42267e7abf15d43d1df1f81bdfd77eb37a16426bfa32fae8158b736268dc583214bcab543f0a8e28d3cb236f88cacfb
-  data.tar.gz: be8cc2cc7b4cf9d9762d99cf896e1bcf05e33efb7601b13334e552e6979cf067d7a817234115de8c106366389a0395fe18e5993f8b960ebed97b68d3c8d2786d
+  metadata.gz: de861c5b7f11641c354a4a1761a7b99927e070df476fd221421b0de4fb58dd99a5eda4289b4f04f7f3cdacd3a0bc8fd70e6b686740c816a3cfc49be52dd80a52
+  data.tar.gz: 6588a9cdf6e0607cc0cfedb15409ebabbb7e3de747e46a28e4f6b0d30349e9df8fe0b38d9dcc5055658aae48728a7ed7c5305f0b63178a6be462042cbbaa9854

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## 0.4.0 (2026-04-22)
+
+Full Changelog: [v0.3.0...v0.4.0](https://github.com/Xquik-dev/x-twitter-scraper-ruby/compare/v0.3.0...v0.4.0)
+
+### Features
+
+* **api:** api update ([57ca5de](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/57ca5deef4ab9b670bc0e143c00639a8c3da1258))
+* **api:** api update ([21e1e0f](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/21e1e0f3791b791ab09f8982edaae123ba8d45a1))
+* **api:** api update ([c053ff2](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/c053ff2fdc9a671ff1a6d6596a97d1ebb8a33eb2))
+* **api:** api update ([f9c02a4](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/f9c02a49240130a307fcbd1cfbcfaf999966fb06))
+* **api:** api update ([89e3ff5](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/89e3ff5905185e6223233618819d6dc87a2e87d7))
+* **api:** api update ([dbe6467](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/dbe6467a33987dcd3a65b78bfefca13b5123ae63))
+* **api:** api update ([279a416](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/279a416215ad266661cac5edd02e821e2f701d60))
+
+
+### Bug Fixes
+
+* **ci:** pin rubygems/configure-rubygems-credentials to v1.0.0 ([7d2cde5](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/7d2cde520114bba9680b2c98fbe699f75f9b5c04))
+* set homepage to docs.xquik.com, add documentation_uri to gemdocs ([0f8e806](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/0f8e806ff20df4700054a7df0e17aa89e2da4859))
+
+
+### Chores
+
+* update SDK settings ([301d2a6](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/301d2a616dfaf7c4ac15798a7463ecd3ef2770eb))
+
 ## 0.3.0 (2026-04-01)
 
 Full Changelog: [v0.2.0...v0.3.0](https://github.com/Xquik-dev/x-twitter-scraper-ruby/compare/v0.2.0...v0.3.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "x-twitter-scraper", "~> 0.3.0"
+gem "x-twitter-scraper", "~> 0.4.0"
 ```
 
 <!-- x-release-please-end -->
@@ -32,9 +32,9 @@ x_twitter_scraper = XTwitterScraper::Client.new(
   api_key: ENV["X_TWITTER_SCRAPER_API_KEY"] # This is the default and can be omitted
 )
 
-response = x_twitter_scraper.x.tweets.search(q: "from:elonmusk", limit: 10)
+paginated_tweets = x_twitter_scraper.x.tweets.search(q: "from:elonmusk", limit: 10)
 
-puts(response.has_next_page)
+puts(paginated_tweets.has_next_page)
 ```
 
 ### File uploads
@@ -153,7 +153,7 @@ You can send undocumented parameters to any endpoint, and read undocumented resp
 Note: the `extra_` parameters of the same name overrides the documented parameters.
 
 ```ruby
-response =
+paginated_tweets =
   x_twitter_scraper.x.tweets.search(
     q: "from:elonmusk",
     limit: 10,
@@ -164,7 +164,7 @@ response =
     }
   )
 
-puts(response[:my_undocumented_property])
+puts(paginated_tweets[:my_undocumented_property])
 ```
 
 #### Undocumented request params

data/lib/x_twitter_scraper/models/api_key.rb

@@ -34,6 +34,8 @@ module XTwitterScraper
       optional :last_used_at, Time, api_name: :lastUsedAt
 
       # @!method initialize(id:, created_at:, is_active:, name:, prefix:, last_used_at: nil)
+      #   API key metadata returned when listing keys.
+      #
       #   @param id [String]
       #   @param created_at [Time]
       #   @param is_active [Boolean]

data/lib/x_twitter_scraper/models/api_key_list_response.rb

@@ -6,52 +6,11 @@ module XTwitterScraper
     class APIKeyListResponse < XTwitterScraper::Internal::Type::BaseModel
       # @!attribute keys
       #
-      #   @return [Array<XTwitterScraper::Models::APIKeyListResponse::Key>]
-      required :keys,
-               -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::APIKeyListResponse::Key] }
+      #   @return [Array<XTwitterScraper::Models::APIKey>]
+      required :keys, -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::APIKey] }
 
       # @!method initialize(keys:)
-      #   @param keys [Array<XTwitterScraper::Models::APIKeyListResponse::Key>]
-
-      class Key < XTwitterScraper::Internal::Type::BaseModel
-        # @!attribute id
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute created_at
-        #
-        #   @return [Time]
-        required :created_at, Time, api_name: :createdAt
-
-        # @!attribute is_active
-        #
-        #   @return [Boolean]
-        required :is_active, XTwitterScraper::Internal::Type::Boolean, api_name: :isActive
-
-        # @!attribute name
-        #
-        #   @return [String]
-        required :name, String
-
-        # @!attribute prefix
-        #
-        #   @return [String]
-        required :prefix, String
-
-        # @!attribute last_used_at
-        #
-        #   @return [Time, nil]
-        optional :last_used_at, Time, api_name: :lastUsedAt
-
-        # @!method initialize(id:, created_at:, is_active:, name:, prefix:, last_used_at: nil)
-        #   @param id [String]
-        #   @param created_at [Time]
-        #   @param is_active [Boolean]
-        #   @param name [String]
-        #   @param prefix [String]
-        #   @param last_used_at [Time]
-      end
+      #   @param keys [Array<XTwitterScraper::Models::APIKey>]
     end
   end
 end

data/lib/x_twitter_scraper/models/delivery.rb

@@ -44,6 +44,8 @@ module XTwitterScraper
       optional :last_status_code, Integer, api_name: :lastStatusCode
 
       # @!method initialize(id:, attempts:, created_at:, status:, stream_event_id:, delivered_at: nil, last_error: nil, last_status_code: nil)
+      #   Webhook delivery attempt record with status and retry count.
+      #
       #   @param id [String]
       #   @param attempts [Integer]
       #   @param created_at [Time]

data/lib/x_twitter_scraper/models/draft.rb

@@ -29,6 +29,8 @@ module XTwitterScraper
       optional :topic, String
 
       # @!method initialize(id:, created_at:, text:, goal: nil, topic: nil)
+      #   Saved tweet draft with optional topic and goal.
+      #
       #   @param id [String]
       #   @param created_at [Time]
       #   @param text [String]

data/lib/x_twitter_scraper/models/draft_detail.rb

@@ -2,6 +2,7 @@
 
 module XTwitterScraper
   module Models
+    # @see XTwitterScraper::Resources::Drafts#create
     class DraftDetail < XTwitterScraper::Internal::Type::BaseModel
       # @!attribute id
       #
@@ -34,6 +35,8 @@ module XTwitterScraper
       optional :topic, String
 
       # @!method initialize(id:, created_at:, text:, updated_at:, goal: nil, topic: nil)
+      #   Full tweet draft including update timestamp.
+      #
       #   @param id [String]
       #   @param created_at [Time]
       #   @param text [String]

data/lib/x_twitter_scraper/models/draft_list_params.rb

@@ -14,6 +14,7 @@ module XTwitterScraper
       optional :after_cursor, String
 
       # @!attribute limit
+      #   Maximum number of items to return (1-100, default 50)
       #
       #   @return [Integer, nil]
       optional :limit, Integer
@@ -21,7 +22,7 @@ module XTwitterScraper
       # @!method initialize(after_cursor: nil, limit: nil, request_options: {})
       #   @param after_cursor [String] Cursor for pagination
       #
-      #   @param limit [Integer]
+      #   @param limit [Integer] Maximum number of items to return (1-100, default 50)
       #
       #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/x_twitter_scraper/models/draft_list_response.rb

@@ -6,9 +6,8 @@ module XTwitterScraper
     class DraftListResponse < XTwitterScraper::Internal::Type::BaseModel
       # @!attribute drafts
       #
-      #   @return [Array<XTwitterScraper::Models::DraftListResponse::Draft>]
-      required :drafts,
-               -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::DraftListResponse::Draft] }
+      #   @return [Array<XTwitterScraper::Models::Draft>]
+      required :drafts, -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Draft] }
 
       # @!attribute has_more
       #
@@ -21,43 +20,9 @@ module XTwitterScraper
       optional :next_cursor, String, api_name: :nextCursor
 
       # @!method initialize(drafts:, has_more:, next_cursor: nil)
-      #   @param drafts [Array<XTwitterScraper::Models::DraftListResponse::Draft>]
+      #   @param drafts [Array<XTwitterScraper::Models::Draft>]
       #   @param has_more [Boolean]
       #   @param next_cursor [String]
-
-      class Draft < XTwitterScraper::Internal::Type::BaseModel
-        # @!attribute id
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute created_at
-        #
-        #   @return [Time]
-        required :created_at, Time, api_name: :createdAt
-
-        # @!attribute text
-        #
-        #   @return [String]
-        required :text, String
-
-        # @!attribute goal
-        #
-        #   @return [String, nil]
-        optional :goal, String
-
-        # @!attribute topic
-        #
-        #   @return [String, nil]
-        optional :topic, String
-
-        # @!method initialize(id:, created_at:, text:, goal: nil, topic: nil)
-        #   @param id [String]
-        #   @param created_at [Time]
-        #   @param text [String]
-        #   @param goal [String]
-        #   @param topic [String]
-      end
     end
   end
 end

data/lib/x_twitter_scraper/models/draw_detail.rb

@@ -74,6 +74,8 @@ module XTwitterScraper
       optional :drawn_at, Time, api_name: :drawnAt
 
       # @!method initialize(id:, created_at:, status:, total_entries:, tweet_author_username:, tweet_id:, tweet_like_count:, tweet_quote_count:, tweet_reply_count:, tweet_retweet_count:, tweet_text:, tweet_url:, valid_entries:, drawn_at: nil)
+      #   Full giveaway draw with tweet metrics, entries, and timing.
+      #
       #   @param id [String]
       #   @param created_at [Time]
       #   @param status [String]

data/lib/x_twitter_scraper/models/draw_export_params.rb

@@ -13,6 +13,7 @@ module XTwitterScraper
       required :id, String
 
       # @!attribute format_
+      #   Export output format
       #
       #   @return [Symbol, XTwitterScraper::Models::DrawExportParams::Format, nil]
       optional :format_, enum: -> { XTwitterScraper::DrawExportParams::Format }
@@ -26,12 +27,13 @@ module XTwitterScraper
       # @!method initialize(id:, format_: nil, type: nil, request_options: {})
       #   @param id [String]
       #
-      #   @param format_ [Symbol, XTwitterScraper::Models::DrawExportParams::Format]
+      #   @param format_ [Symbol, XTwitterScraper::Models::DrawExportParams::Format] Export output format
       #
       #   @param type [Symbol, XTwitterScraper::Models::DrawExportParams::Type] Export winners or all entries
       #
       #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
 
+      # Export output format
       module Format
         extend XTwitterScraper::Internal::Type::Enum
 

data/lib/x_twitter_scraper/models/draw_list_item.rb

@@ -39,6 +39,8 @@ module XTwitterScraper
       optional :drawn_at, Time, api_name: :drawnAt
 
       # @!method initialize(id:, created_at:, status:, total_entries:, tweet_url:, valid_entries:, drawn_at: nil)
+      #   Giveaway draw summary with entry counts and status.
+      #
       #   @param id [String]
       #   @param created_at [Time]
       #   @param status [String]

data/lib/x_twitter_scraper/models/draw_list_params.rb

@@ -8,20 +8,21 @@ module XTwitterScraper
       include XTwitterScraper::Internal::Type::RequestParameters
 
       # @!attribute after
-      #   Cursor for pagination
+      #   Cursor for keyset pagination
       #
       #   @return [String, nil]
       optional :after, String
 
       # @!attribute limit
+      #   Maximum number of items to return (1-100, default 50)
       #
       #   @return [Integer, nil]
       optional :limit, Integer
 
       # @!method initialize(after: nil, limit: nil, request_options: {})
-      #   @param after [String] Cursor for pagination
+      #   @param after [String] Cursor for keyset pagination
       #
-      #   @param limit [Integer]
+      #   @param limit [Integer] Maximum number of items to return (1-100, default 50)
       #
       #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/x_twitter_scraper/models/draw_list_response.rb

@@ -6,9 +6,8 @@ module XTwitterScraper
     class DrawListResponse < XTwitterScraper::Internal::Type::BaseModel
       # @!attribute draws
       #
-      #   @return [Array<XTwitterScraper::Models::DrawListResponse::Draw>]
-      required :draws,
-               -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::DrawListResponse::Draw] }
+      #   @return [Array<XTwitterScraper::Models::DrawListItem>]
+      required :draws, -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::DrawListItem] }
 
       # @!attribute has_more
       #
@@ -21,55 +20,9 @@ module XTwitterScraper
       optional :next_cursor, String, api_name: :nextCursor
 
       # @!method initialize(draws:, has_more:, next_cursor: nil)
-      #   @param draws [Array<XTwitterScraper::Models::DrawListResponse::Draw>]
+      #   @param draws [Array<XTwitterScraper::Models::DrawListItem>]
       #   @param has_more [Boolean]
       #   @param next_cursor [String]
-
-      class Draw < 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 total_entries
-        #
-        #   @return [Integer]
-        required :total_entries, Integer, api_name: :totalEntries
-
-        # @!attribute tweet_url
-        #
-        #   @return [String]
-        required :tweet_url, String, api_name: :tweetUrl
-
-        # @!attribute valid_entries
-        #
-        #   @return [Integer]
-        required :valid_entries, Integer, api_name: :validEntries
-
-        # @!attribute drawn_at
-        #
-        #   @return [Time, nil]
-        optional :drawn_at, Time, api_name: :drawnAt
-
-        # @!method initialize(id:, created_at:, status:, total_entries:, tweet_url:, valid_entries:, drawn_at: nil)
-        #   @param id [String]
-        #   @param created_at [Time]
-        #   @param status [String]
-        #   @param total_entries [Integer]
-        #   @param tweet_url [String]
-        #   @param valid_entries [Integer]
-        #   @param drawn_at [Time]
-      end
     end
   end
 end

data/lib/x_twitter_scraper/models/draw_retrieve_response.rb

@@ -5,136 +5,20 @@ module XTwitterScraper
     # @see XTwitterScraper::Resources::Draws#retrieve
     class DrawRetrieveResponse < XTwitterScraper::Internal::Type::BaseModel
       # @!attribute draw
+      #   Full giveaway draw with tweet metrics, entries, and timing.
       #
-      #   @return [XTwitterScraper::Models::DrawRetrieveResponse::Draw]
-      required :draw, -> { XTwitterScraper::Models::DrawRetrieveResponse::Draw }
+      #   @return [XTwitterScraper::Models::DrawDetail]
+      required :draw, -> { XTwitterScraper::DrawDetail }
 
       # @!attribute winners
       #
-      #   @return [Array<XTwitterScraper::Models::DrawRetrieveResponse::Winner>]
-      required :winners,
-               -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::DrawRetrieveResponse::Winner] }
+      #   @return [Array<XTwitterScraper::Models::Winner>]
+      required :winners, -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Winner] }
 
       # @!method initialize(draw:, winners:)
-      #   @param draw [XTwitterScraper::Models::DrawRetrieveResponse::Draw]
-      #   @param winners [Array<XTwitterScraper::Models::DrawRetrieveResponse::Winner>]
-
-      # @see XTwitterScraper::Models::DrawRetrieveResponse#draw
-      class Draw < 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 total_entries
-        #
-        #   @return [Integer]
-        required :total_entries, Integer, api_name: :totalEntries
-
-        # @!attribute tweet_author_username
-        #
-        #   @return [String]
-        required :tweet_author_username, String, api_name: :tweetAuthorUsername
-
-        # @!attribute tweet_id
-        #
-        #   @return [String]
-        required :tweet_id, String, api_name: :tweetId
-
-        # @!attribute tweet_like_count
-        #
-        #   @return [Integer]
-        required :tweet_like_count, Integer, api_name: :tweetLikeCount
-
-        # @!attribute tweet_quote_count
-        #
-        #   @return [Integer]
-        required :tweet_quote_count, Integer, api_name: :tweetQuoteCount
-
-        # @!attribute tweet_reply_count
-        #
-        #   @return [Integer]
-        required :tweet_reply_count, Integer, api_name: :tweetReplyCount
-
-        # @!attribute tweet_retweet_count
-        #
-        #   @return [Integer]
-        required :tweet_retweet_count, Integer, api_name: :tweetRetweetCount
-
-        # @!attribute tweet_text
-        #
-        #   @return [String]
-        required :tweet_text, String, api_name: :tweetText
-
-        # @!attribute tweet_url
-        #
-        #   @return [String]
-        required :tweet_url, String, api_name: :tweetUrl
-
-        # @!attribute valid_entries
-        #
-        #   @return [Integer]
-        required :valid_entries, Integer, api_name: :validEntries
-
-        # @!attribute drawn_at
-        #
-        #   @return [Time, nil]
-        optional :drawn_at, Time, api_name: :drawnAt
-
-        # @!method initialize(id:, created_at:, status:, total_entries:, tweet_author_username:, tweet_id:, tweet_like_count:, tweet_quote_count:, tweet_reply_count:, tweet_retweet_count:, tweet_text:, tweet_url:, valid_entries:, drawn_at: nil)
-        #   @param id [String]
-        #   @param created_at [Time]
-        #   @param status [String]
-        #   @param total_entries [Integer]
-        #   @param tweet_author_username [String]
-        #   @param tweet_id [String]
-        #   @param tweet_like_count [Integer]
-        #   @param tweet_quote_count [Integer]
-        #   @param tweet_reply_count [Integer]
-        #   @param tweet_retweet_count [Integer]
-        #   @param tweet_text [String]
-        #   @param tweet_url [String]
-        #   @param valid_entries [Integer]
-        #   @param drawn_at [Time]
-      end
-
-      class Winner < XTwitterScraper::Internal::Type::BaseModel
-        # @!attribute author_username
-        #
-        #   @return [String]
-        required :author_username, String, api_name: :authorUsername
-
-        # @!attribute is_backup
-        #
-        #   @return [Boolean]
-        required :is_backup, XTwitterScraper::Internal::Type::Boolean, api_name: :isBackup
-
-        # @!attribute position
-        #
-        #   @return [Integer]
-        required :position, Integer
-
-        # @!attribute tweet_id
-        #
-        #   @return [String]
-        required :tweet_id, String, api_name: :tweetId
-
-        # @!method initialize(author_username:, is_backup:, position:, tweet_id:)
-        #   @param author_username [String]
-        #   @param is_backup [Boolean]
-        #   @param position [Integer]
-        #   @param tweet_id [String]
-      end
+      #   @param draw [XTwitterScraper::Models::DrawDetail] Full giveaway draw with tweet metrics, entries, and timing.
+      #
+      #   @param winners [Array<XTwitterScraper::Models::Winner>]
     end
   end
 end

data/lib/x_twitter_scraper/models/draw_run_response.rb

@@ -26,44 +26,15 @@ module XTwitterScraper
 
       # @!attribute winners
       #
-      #   @return [Array<XTwitterScraper::Models::DrawRunResponse::Winner>]
-      required :winners,
-               -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::DrawRunResponse::Winner] }
+      #   @return [Array<XTwitterScraper::Models::Winner>]
+      required :winners, -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Winner] }
 
       # @!method initialize(id:, total_entries:, tweet_id:, valid_entries:, winners:)
       #   @param id [String]
       #   @param total_entries [Integer]
       #   @param tweet_id [String]
       #   @param valid_entries [Integer]
-      #   @param winners [Array<XTwitterScraper::Models::DrawRunResponse::Winner>]
-
-      class Winner < XTwitterScraper::Internal::Type::BaseModel
-        # @!attribute author_username
-        #
-        #   @return [String]
-        required :author_username, String, api_name: :authorUsername
-
-        # @!attribute is_backup
-        #
-        #   @return [Boolean]
-        required :is_backup, XTwitterScraper::Internal::Type::Boolean, api_name: :isBackup
-
-        # @!attribute position
-        #
-        #   @return [Integer]
-        required :position, Integer
-
-        # @!attribute tweet_id
-        #
-        #   @return [String]
-        required :tweet_id, String, api_name: :tweetId
-
-        # @!method initialize(author_username:, is_backup:, position:, tweet_id:)
-        #   @param author_username [String]
-        #   @param is_backup [Boolean]
-        #   @param position [Integer]
-        #   @param tweet_id [String]
-      end
+      #   @param winners [Array<XTwitterScraper::Models::Winner>]
     end
   end
 end

data/lib/x_twitter_scraper/models/error.rb

@@ -9,6 +9,8 @@ module XTwitterScraper
       required :error, enum: -> { XTwitterScraper::Error::Error }
 
       # @!method initialize(error:)
+      #   Error response containing a machine-readable error code.
+      #
       #   @param error [Symbol, XTwitterScraper::Models::Error::Error]
 
       # @see XTwitterScraper::Models::Error#error

data/lib/x_twitter_scraper/models/event.rb

@@ -24,9 +24,10 @@ module XTwitterScraper
       required :occurred_at, Time, api_name: :occurredAt
 
       # @!attribute type
+      #   Type of monitor event fired when account activity occurs.
       #
-      #   @return [Symbol, XTwitterScraper::Models::Event::Type]
-      required :type, enum: -> { XTwitterScraper::Event::Type }
+      #   @return [Symbol, XTwitterScraper::Models::EventType]
+      required :type, enum: -> { XTwitterScraper::EventType }
 
       # @!attribute username
       #
@@ -34,27 +35,19 @@ module XTwitterScraper
       required :username, String
 
       # @!method initialize(id:, data:, monitor_id:, occurred_at:, type:, username:)
+      #   Monitor event summary with type, username, and occurrence time.
+      #
       #   @param id [String]
+      #
       #   @param data [Hash{Symbol=>Object}]
+      #
       #   @param monitor_id [String]
+      #
       #   @param occurred_at [Time]
-      #   @param type [Symbol, XTwitterScraper::Models::Event::Type]
+      #
+      #   @param type [Symbol, XTwitterScraper::Models::EventType] Type of monitor event fired when account activity occurs.
+      #
       #   @param username [String]
-
-      # @see XTwitterScraper::Models::Event#type
-      module Type
-        extend XTwitterScraper::Internal::Type::Enum
-
-        TWEET_NEW = :"tweet.new"
-        TWEET_REPLY = :"tweet.reply"
-        TWEET_RETWEET = :"tweet.retweet"
-        TWEET_QUOTE = :"tweet.quote"
-        FOLLOWER_GAINED = :"follower.gained"
-        FOLLOWER_LOST = :"follower.lost"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end