x-twitter-scraper 0.7.2 → 0.9.0

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

@@ -0,0 +1,245 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      # Paginated user profiles. No-mode follower, following, and verified follower
+      # requests merge independent views automatically. Response fields, page size,
+      # aliases, filters, and per-returned-profile billing stay unchanged. Existing
+      # unprefixed cursors retain legacy behavior. Follow next_cursor while
+      # has_next_page is true.
+      #
+      # @see XTwitterScraper::Resources::X::Users#retrieve_verified_followers
+      module UserRetrieveVerifiedFollowersResponse
+        extend XTwitterScraper::Internal::Type::Union
+
+        # Paginated user profiles. No-mode follower, following, and verified follower requests merge independent views automatically. Response fields, page size, aliases, filters, and per-returned-profile billing stay unchanged. Existing unprefixed cursors retain legacy behavior. Follow next_cursor while has_next_page is true.
+        variant -> { XTwitterScraper::PaginatedUsers }
+
+        # Paginated user profiles. No-mode follower, following, and verified follower requests merge independent views automatically. Response fields, page size, aliases, filters, and per-returned-profile billing stay unchanged. Existing unprefixed cursors retain legacy behavior. Follow next_cursor while has_next_page is true.
+        variant -> { XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse }
+
+        class UserListCoverageResponse < XTwitterScraper::Models::PaginatedUsers
+          # @!attribute diagnostic
+          #   Coverage evidence across parallel relationship strategies.
+          #
+          #   @return [XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic]
+          required :diagnostic,
+                   -> { XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic }
+
+          # @!attribute has_next_page
+          #
+          #   @return [Boolean, XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::HasNextPage, nil]
+          optional :has_next_page,
+                   enum: -> { XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::HasNextPage }
+
+          # @!attribute next_cursor
+          #
+          #   @return [Symbol, XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::NextCursor, nil]
+          optional :next_cursor,
+                   enum: -> { XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::NextCursor }
+
+          # @!method initialize(diagnostic:, has_next_page: nil, next_cursor: nil)
+          #   Paginated user profiles. No-mode follower, following, and verified follower
+          #   requests merge independent views automatically. Response fields, page size,
+          #   aliases, filters, and per-returned-profile billing stay unchanged. Existing
+          #   unprefixed cursors retain legacy behavior. Follow next_cursor while
+          #   has_next_page is true.
+          #
+          #   @param diagnostic [XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic] Coverage evidence across parallel relationship strategies.
+          #
+          #   @param has_next_page [Boolean, XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::HasNextPage]
+          #
+          #   @param next_cursor [Symbol, XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::NextCursor]
+
+          class Diagnostic < XTwitterScraper::Internal::Type::BaseModel
+            # @!attribute complete
+            #   True when every strategy exhausted its source.
+            #
+            #   @return [Boolean]
+            required :complete, XTwitterScraper::Internal::Type::Boolean
+
+            # @!attribute cursor_failure_count
+            #
+            #   @return [Integer]
+            required :cursor_failure_count, Integer, api_name: :cursorFailureCount
+
+            # @!attribute deadline_reached
+            #
+            #   @return [Boolean]
+            required :deadline_reached, XTwitterScraper::Internal::Type::Boolean, api_name: :deadlineReached
+
+            # @!attribute duplicate_count
+            #
+            #   @return [Integer]
+            required :duplicate_count, Integer, api_name: :duplicateCount
+
+            # @!attribute failed_strategy_count
+            #
+            #   @return [Integer]
+            required :failed_strategy_count, Integer, api_name: :failedStrategyCount
+
+            # @!attribute malformed_count
+            #
+            #   @return [Integer]
+            required :malformed_count, Integer, api_name: :malformedCount
+
+            # @!attribute pages_fetched
+            #
+            #   @return [Integer]
+            required :pages_fetched, Integer, api_name: :pagesFetched
+
+            # @!attribute response_truncated
+            #   Whether credits or the requested limit reduced output.
+            #
+            #   @return [Boolean]
+            required :response_truncated,
+                     XTwitterScraper::Internal::Type::Boolean,
+                     api_name: :responseTruncated
+
+            # @!attribute result_limit_reached
+            #
+            #   @return [Boolean]
+            required :result_limit_reached,
+                     XTwitterScraper::Internal::Type::Boolean,
+                     api_name: :resultLimitReached
+
+            # @!attribute returned_users
+            #
+            #   @return [Integer]
+            required :returned_users, Integer, api_name: :returnedUsers
+
+            # @!attribute stalled_strategy_count
+            #
+            #   @return [Integer]
+            required :stalled_strategy_count, Integer, api_name: :stalledStrategyCount
+
+            # @!attribute strategies
+            #
+            #   @return [Array<XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy>]
+            required :strategies,
+                     -> do
+                       XTwitterScraper::Internal::Type::ArrayOf[
+                         XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy
+                       ]
+                     end
+
+            # @!attribute strategy_count
+            #
+            #   @return [Integer]
+            required :strategy_count, Integer, api_name: :strategyCount
+
+            # @!attribute unique_users
+            #
+            #   @return [Integer]
+            required :unique_users, Integer, api_name: :uniqueUsers
+
+            # @!method initialize(complete:, cursor_failure_count:, deadline_reached:, duplicate_count:, failed_strategy_count:, malformed_count:, pages_fetched:, response_truncated:, result_limit_reached:, returned_users:, stalled_strategy_count:, strategies:, strategy_count:, unique_users:)
+            #   Coverage evidence across parallel relationship strategies.
+            #
+            #   @param complete [Boolean] True when every strategy exhausted its source.
+            #
+            #   @param cursor_failure_count [Integer]
+            #
+            #   @param deadline_reached [Boolean]
+            #
+            #   @param duplicate_count [Integer]
+            #
+            #   @param failed_strategy_count [Integer]
+            #
+            #   @param malformed_count [Integer]
+            #
+            #   @param pages_fetched [Integer]
+            #
+            #   @param response_truncated [Boolean] Whether credits or the requested limit reduced output.
+            #
+            #   @param result_limit_reached [Boolean]
+            #
+            #   @param returned_users [Integer]
+            #
+            #   @param stalled_strategy_count [Integer]
+            #
+            #   @param strategies [Array<XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy>]
+            #
+            #   @param strategy_count [Integer]
+            #
+            #   @param unique_users [Integer]
+
+            class Strategy < XTwitterScraper::Internal::Type::BaseModel
+              # @!attribute duplicate_count
+              #
+              #   @return [Integer]
+              required :duplicate_count, Integer, api_name: :duplicateCount
+
+              # @!attribute pages_fetched
+              #
+              #   @return [Integer]
+              required :pages_fetched, Integer, api_name: :pagesFetched
+
+              # @!attribute stop_reason
+              #
+              #   @return [Symbol, XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy::StopReason]
+              required :stop_reason,
+                       enum: -> { XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy::StopReason },
+                       api_name: :stopReason
+
+              # @!attribute strategy
+              #
+              #   @return [Integer]
+              required :strategy, Integer
+
+              # @!attribute unique_added
+              #
+              #   @return [Integer]
+              required :unique_added, Integer, api_name: :uniqueAdded
+
+              # @!method initialize(duplicate_count:, pages_fetched:, stop_reason:, strategy:, unique_added:)
+              #   @param duplicate_count [Integer]
+              #   @param pages_fetched [Integer]
+              #   @param stop_reason [Symbol, XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy::StopReason]
+              #   @param strategy [Integer]
+              #   @param unique_added [Integer]
+
+              # @see XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy#stop_reason
+              module StopReason
+                extend XTwitterScraper::Internal::Type::Enum
+
+                CURSOR_FAILURE = :cursor_failure
+                DEADLINE = :deadline
+                EXHAUSTED = :exhausted
+                FAILED = :failed
+                PAGE_LIMIT = :page_limit
+                RESULT_LIMIT = :result_limit
+                STALLED = :stalled
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+          end
+
+          module HasNextPage
+            extend XTwitterScraper::Internal::Type::Enum
+
+            FALSE = false
+
+            # @!method self.values
+            #   @return [Array<Boolean>]
+          end
+
+          module NextCursor
+            extend XTwitterScraper::Internal::Type::Enum
+
+            EMPTY = :""
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @!method self.variants
+        #   @return [Array(XTwitterScraper::Models::PaginatedUsers, XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersResponse::UserListCoverageResponse)]
+      end
+    end
+  end
+end

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

@@ -19,11 +19,9 @@ module XTwitterScraper
         required :created_at, Time, api_name: :createdAt
 
         # @!attribute health
-        #   Derived connection health. `healthy` = ready to use. `needsReauth` = user must
-        #   submit fresh credentials. `locked` = X locked the account; unlock on x.com
-        #   first. `suspended` = X banned the account. `recovering` = cooldown ended; the
-        #   account can reconnect on its next use. `temporaryIssue` = temporary connection
-        #   problem; wait before the next use.
+        #   Derived health. `healthy` is ready. `needsReauth` needs credentials. `locked`
+        #   must be unlocked on X. `suspended` is banned. `recovering` can reconnect. Wait
+        #   before using `temporaryIssue`.
         #
         #   @return [Symbol, XTwitterScraper::Models::X::XAccount::Health]
         required :health, enum: -> { XTwitterScraper::X::XAccount::Health }
@@ -63,7 +61,7 @@ module XTwitterScraper
         #
         #   @param created_at [Time]
         #
-        #   @param health [Symbol, XTwitterScraper::Models::X::XAccount::Health] Derived connection health. `healthy` = ready to use. `needsReauth` = user must s
+        #   @param health [Symbol, XTwitterScraper::Models::X::XAccount::Health] Derived health. `healthy` is ready. `needsReauth` needs credentials. `locked` mu
         #
         #   @param status [String]
         #
@@ -75,11 +73,9 @@ module XTwitterScraper
         #
         #   @param cookies_obtained_at [Time]
 
-        # Derived connection health. `healthy` = ready to use. `needsReauth` = user must
-        # submit fresh credentials. `locked` = X locked the account; unlock on x.com
-        # first. `suspended` = X banned the account. `recovering` = cooldown ended; the
-        # account can reconnect on its next use. `temporaryIssue` = temporary connection
-        # problem; wait before the next use.
+        # Derived health. `healthy` is ready. `needsReauth` needs credentials. `locked`
+        # must be unlocked on X. `suspended` is banned. `recovering` can reconnect. Wait
+        # before using `temporaryIssue`.
         #
         # @see XTwitterScraper::Models::X::XAccount#health
         module Health

data/lib/x_twitter_scraper/resources/credits.rb

@@ -73,8 +73,8 @@ module XTwitterScraper
         )
       end
 
-      # Create a Stripe Checkout session only after the user confirms. The request never
-      # completes payment or adds credits by itself.
+      # Create a hosted checkout only after the user confirms. The request never
+      # completes payment or adds credits.
       #
       # @overload topup_balance(dollars:, locale: nil, request_options: {})
       #

data/lib/x_twitter_scraper/resources/draws.rb

@@ -35,7 +35,7 @@ module XTwitterScraper
       #
       # @overload list(cursor: nil, limit: nil, request_options: {})
       #
-      # @param cursor [String] Cursor for keyset pagination from prior response next_cursor
+      # @param cursor [String] Previous nextCursor.
       #
       # @param limit [Integer] Maximum number of items to return (1-100, default 50). For paid per-result endpo
       #
@@ -56,13 +56,16 @@ module XTwitterScraper
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {XTwitterScraper::Models::DrawExportParams} for more details.
+      #
       # Export draw data
       #
       # @overload export(id, format_:, type: nil, request_options: {})
       #
       # @param id [String] Draw public ID returned by create and list draw responses.
       #
-      # @param format_ [Symbol, XTwitterScraper::Models::DrawExportParams::Format] Export output format
+      # @param format_ [Symbol, XTwitterScraper::Models::DrawExportParams::Format] Export output format. PDF entry exports include up to 10,000 rows. Other entry f
       #
       # @param type [Symbol, XTwitterScraper::Models::DrawExportParams::Type] Export winners or all entries
       #

data/lib/x_twitter_scraper/resources/events.rb

@@ -33,15 +33,17 @@ module XTwitterScraper
       #
       # List events
       #
-      # @overload list(cursor: nil, event_type: nil, limit: nil, monitor_id: nil, request_options: {})
+      # @overload list(cursor: nil, event_type: nil, keyword_monitor_id: nil, limit: nil, monitor_id: nil, request_options: {})
       #
-      # @param cursor [String] Cursor for keyset pagination from prior response next_cursor
+      # @param cursor [String] Previous nextCursor.
       #
       # @param event_type [Symbol, XTwitterScraper::Models::EventType] Filter events by type
       #
+      # @param keyword_monitor_id [String] Keyword monitor ID.
+      #
       # @param limit [Integer] Maximum number of items to return (1-100, default 50). For paid per-result endpo
       #
-      # @param monitor_id [String] Filter events by monitor ID
+      # @param monitor_id [String] Account monitor ID.
       #
       # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -54,7 +56,11 @@ module XTwitterScraper
         @client.request(
           method: :get,
           path: "events",
-          query: query.transform_keys(event_type: "eventType", monitor_id: "monitorId"),
+          query: query.transform_keys(
+            event_type: "eventType",
+            keyword_monitor_id: "keywordMonitorId",
+            monitor_id: "monitorId"
+          ),
           model: XTwitterScraper::Models::EventListResponse,
           options: options
         )