x-twitter-scraper 0.7.2 → 0.9.0

data/lib/x_twitter_scraper/resources/guest_wallets.rb

@@ -11,11 +11,9 @@ module XTwitterScraper
       # Some parameter documentations has been truncated, see
       # {XTwitterScraper::Models::GuestWalletCreateParams} for more details.
       #
-      # Create a one-use Stripe-hosted checkout after the user explicitly confirms a
-      # $10-$250 USD amount. This request creates no charge by itself. The user opens
-      # checkout_url on Stripe. This endpoint returns the paid-read API key without
-      # requiring an Xquik account, email, dashboard, or Xquik web page. An idempotent
-      # replay returns the same key.
+      # Create a one-use hosted checkout after the user confirms $10-$250 USD. The
+      # request creates no charge. It returns a paid-read API key without an Xquik
+      # account. Replays return the same key.
       #
       # @overload create(amount_minor:, idempotency_key:, currency: :usd, request_options: {})
       #
@@ -44,10 +42,9 @@ module XTwitterScraper
         )
       end
 
-      # Poll after Stripe payment. Use usable to decide whether paid reads can run. An
-      # active wallet can remain usable while a top-up is pending. A new wallet becomes
-      # usable only after verified webhook fulfillment. Send the guest key as
-      # Authorization: Bearer.
+      # Poll after payment. Use usable to decide whether paid reads can run. An active
+      # wallet can remain usable while a top-up is pending. A new wallet becomes usable
+      # only after payment is verified. Send the guest key as Authorization: Bearer.
       #
       # @overload retrieve_status(request_options: {})
       #
@@ -69,10 +66,9 @@ module XTwitterScraper
       # Some parameter documentations has been truncated, see
       # {XTwitterScraper::Models::GuestWalletTopupParams} for more details.
       #
-      # Create a one-use Stripe-hosted checkout for an existing paid-read guest key
-      # after the user explicitly confirms a $10-$250 USD amount. The key remains the
-      # same. This request creates no charge by itself and never redirects through an
-      # Xquik web page.
+      # Create a one-use hosted checkout after the user confirms a $10-$250 USD amount
+      # for an existing paid-read guest key. The key remains the same. This request
+      # creates no charge and never redirects through Xquik.
       #
       # @overload topup(amount_minor:, idempotency_key:, currency: :usd, request_options: {})
       #

data/lib/x_twitter_scraper/resources/support/attachments.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Resources
+    class Support
+      # Support ticket management
+      class Attachments
+        # Streams an authenticated user's support image or video. Video requests support
+        # one standard byte range for seeking and resumable playback.
+        #
+        # @overload download(id, range: nil, request_options: {})
+        #
+        # @param id [String] Support attachment public ID
+        #
+        # @param range [String] Optional single byte range
+        #
+        # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [StringIO]
+        #
+        # @see XTwitterScraper::Models::Support::AttachmentDownloadParams
+        def download(id, params = {})
+          parsed, options = XTwitterScraper::Support::AttachmentDownloadParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["support/attachments/%1$s", id],
+            headers: {"accept" => "application/octet-stream", **parsed}.transform_keys(range: "range"),
+            model: StringIO,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [XTwitterScraper::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/resources/support.rb

@@ -7,6 +7,10 @@
 module XTwitterScraper
   module Resources
     class Support
+      # Support ticket management
+      # @return [XTwitterScraper::Resources::Support::Attachments]
+      attr_reader :attachments
+
       # Support ticket management
       # @return [XTwitterScraper::Resources::Support::Tickets]
       attr_reader :tickets
@@ -16,6 +20,7 @@ module XTwitterScraper
       # @param client [XTwitterScraper::Client]
       def initialize(client:)
         @client = client
+        @attachments = XTwitterScraper::Resources::Support::Attachments.new(client: client)
         @tickets = XTwitterScraper::Resources::Support::Tickets.new(client: client)
       end
     end

data/lib/x_twitter_scraper/resources/x/communities.rb

@@ -107,14 +107,42 @@ module XTwitterScraper
         #
         # List members of a community
         #
-        # @overload retrieve_members(id, cursor: nil, page_size: nil, request_options: {})
+        # @overload retrieve_members(id, bio_contains: nil, cursor: nil, has_location: nil, has_website: nil, location_contains: nil, max_followers: nil, max_following: nil, max_statuses: nil, min_account_age_days: nil, min_followers: nil, min_following: nil, min_statuses: nil, page_size: nil, username_contains: nil, verified_only: nil, verified_type: nil, request_options: {})
         #
         # @param id [String] Community ID for member lookup
         #
+        # @param bio_contains [String] Match any comma-separated or line-separated bio term, ignoring case.
+        #
         # @param cursor [String] Pagination cursor
         #
+        # @param has_location [Boolean] Only return profiles with a location.
+        #
+        # @param has_website [Boolean] Only return profiles with a website.
+        #
+        # @param location_contains [String] Match a location substring, ignoring case.
+        #
+        # @param max_followers [Integer] Maximum follower count. Missing counts pass this maximum.
+        #
+        # @param max_following [Integer] Maximum following count.
+        #
+        # @param max_statuses [Integer] Maximum post count. maxPosts is also accepted.
+        #
+        # @param min_account_age_days [Integer] Minimum account age in whole days.
+        #
+        # @param min_followers [Integer] Minimum follower count. Filtering happens before billing.
+        #
+        # @param min_following [Integer] Minimum following count.
+        #
+        # @param min_statuses [Integer] Minimum post count. minPosts is also accepted.
+        #
         # @param page_size [Integer] Items per page (20-200, default 20). This is an upper bound for paid authenticat
         #
+        # @param username_contains [String] Match a username substring, ignoring case.
+        #
+        # @param verified_only [Boolean] Only return verified profiles.
+        #
+        # @param verified_type [String] Match the verification type exactly, ignoring case.
+        #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [XTwitterScraper::Models::PaginatedUsers]
@@ -126,20 +154,68 @@ module XTwitterScraper
           @client.request(
             method: :get,
             path: ["x/communities/%1$s/members", id],
-            query: query.transform_keys(page_size: "pageSize"),
+            query: query.transform_keys(
+              bio_contains: "bioContains",
+              has_location: "hasLocation",
+              has_website: "hasWebsite",
+              location_contains: "locationContains",
+              max_followers: "maxFollowers",
+              max_following: "maxFollowing",
+              max_statuses: "maxStatuses",
+              min_account_age_days: "minAccountAgeDays",
+              min_followers: "minFollowers",
+              min_following: "minFollowing",
+              min_statuses: "minStatuses",
+              page_size: "pageSize",
+              username_contains: "usernameContains",
+              verified_only: "verifiedOnly",
+              verified_type: "verifiedType"
+            ),
             model: XTwitterScraper::PaginatedUsers,
             options: options
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {XTwitterScraper::Models::X::CommunityRetrieveModeratorsParams} for more
+        # details.
+        #
         # List moderators of a community
         #
-        # @overload retrieve_moderators(id, cursor: nil, request_options: {})
+        # @overload retrieve_moderators(id, bio_contains: nil, cursor: nil, has_location: nil, has_website: nil, location_contains: nil, max_followers: nil, max_following: nil, max_statuses: nil, min_account_age_days: nil, min_followers: nil, min_following: nil, min_statuses: nil, username_contains: nil, verified_only: nil, verified_type: nil, request_options: {})
         #
         # @param id [String] Community ID for moderator lookup
         #
+        # @param bio_contains [String] Match any comma-separated or line-separated bio term, ignoring case.
+        #
         # @param cursor [String] Pagination cursor for community moderators
         #
+        # @param has_location [Boolean] Only return profiles with a location.
+        #
+        # @param has_website [Boolean] Only return profiles with a website.
+        #
+        # @param location_contains [String] Match a location substring, ignoring case.
+        #
+        # @param max_followers [Integer] Maximum follower count. Missing counts pass this maximum.
+        #
+        # @param max_following [Integer] Maximum following count.
+        #
+        # @param max_statuses [Integer] Maximum post count. maxPosts is also accepted.
+        #
+        # @param min_account_age_days [Integer] Minimum account age in whole days.
+        #
+        # @param min_followers [Integer] Minimum follower count. Filtering happens before billing.
+        #
+        # @param min_following [Integer] Minimum following count.
+        #
+        # @param min_statuses [Integer] Minimum post count. minPosts is also accepted.
+        #
+        # @param username_contains [String] Match a username substring, ignoring case.
+        #
+        # @param verified_only [Boolean] Only return verified profiles.
+        #
+        # @param verified_type [String] Match the verification type exactly, ignoring case.
+        #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [XTwitterScraper::Models::PaginatedUsers]
@@ -151,7 +227,22 @@ module XTwitterScraper
           @client.request(
             method: :get,
             path: ["x/communities/%1$s/moderators", id],
-            query: query,
+            query: query.transform_keys(
+              bio_contains: "bioContains",
+              has_location: "hasLocation",
+              has_website: "hasWebsite",
+              location_contains: "locationContains",
+              max_followers: "maxFollowers",
+              max_following: "maxFollowing",
+              max_statuses: "maxStatuses",
+              min_account_age_days: "minAccountAgeDays",
+              min_followers: "minFollowers",
+              min_following: "minFollowing",
+              min_statuses: "minStatuses",
+              username_contains: "usernameContains",
+              verified_only: "verifiedOnly",
+              verified_type: "verifiedType"
+            ),
             model: XTwitterScraper::PaginatedUsers,
             options: options
           )

data/lib/x_twitter_scraper/resources/x/lists.rb

@@ -14,13 +14,41 @@ module XTwitterScraper
         #
         # List followers of an X List
         #
-        # @overload retrieve_followers(id, cursor: nil, page_size: nil, request_options: {})
+        # @overload retrieve_followers(id, bio_contains: nil, cursor: nil, has_location: nil, has_website: nil, location_contains: nil, max_followers: nil, max_following: nil, max_statuses: nil, min_account_age_days: nil, min_followers: nil, min_following: nil, min_statuses: nil, page_size: nil, username_contains: nil, verified_only: nil, verified_type: nil, request_options: {})
         #
         # @param id [String] List ID
         #
+        # @param bio_contains [String] Match any comma-separated or line-separated bio term, ignoring case.
+        #
         # @param cursor [String] Pagination cursor for list followers
         #
-        # @param page_size [Integer] Maximum user profiles requested from this page (20-200, default 200). The respon
+        # @param has_location [Boolean] Only return profiles with a location.
+        #
+        # @param has_website [Boolean] Only return profiles with a website.
+        #
+        # @param location_contains [String] Match a location substring, ignoring case.
+        #
+        # @param max_followers [Integer] Maximum follower count. Missing counts pass this maximum.
+        #
+        # @param max_following [Integer] Maximum following count.
+        #
+        # @param max_statuses [Integer] Maximum post count. maxPosts is also accepted.
+        #
+        # @param min_account_age_days [Integer] Minimum account age in whole days.
+        #
+        # @param min_followers [Integer] Minimum follower count. Filtering happens before billing.
+        #
+        # @param min_following [Integer] Minimum following count.
+        #
+        # @param min_statuses [Integer] Minimum post count. minPosts is also accepted.
+        #
+        # @param page_size [Integer] Maximum user profiles requested from this page (20-200, default 200). Source, fi
+        #
+        # @param username_contains [String] Match a username substring, ignoring case.
+        #
+        # @param verified_only [Boolean] Only return verified profiles.
+        #
+        # @param verified_type [String] Match the verification type exactly, ignoring case.
         #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -33,22 +61,69 @@ module XTwitterScraper
           @client.request(
             method: :get,
             path: ["x/lists/%1$s/followers", id],
-            query: query.transform_keys(page_size: "pageSize"),
+            query: query.transform_keys(
+              bio_contains: "bioContains",
+              has_location: "hasLocation",
+              has_website: "hasWebsite",
+              location_contains: "locationContains",
+              max_followers: "maxFollowers",
+              max_following: "maxFollowing",
+              max_statuses: "maxStatuses",
+              min_account_age_days: "minAccountAgeDays",
+              min_followers: "minFollowers",
+              min_following: "minFollowing",
+              min_statuses: "minStatuses",
+              page_size: "pageSize",
+              username_contains: "usernameContains",
+              verified_only: "verifiedOnly",
+              verified_type: "verifiedType"
+            ),
             model: XTwitterScraper::PaginatedUsers,
             options: options
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {XTwitterScraper::Models::X::ListRetrieveMembersParams} for more details.
+        #
         # List members of an X List
         #
-        # @overload retrieve_members(id, cursor: nil, page_size: nil, request_options: {})
+        # @overload retrieve_members(id, bio_contains: nil, cursor: nil, has_location: nil, has_website: nil, location_contains: nil, max_followers: nil, max_following: nil, max_statuses: nil, min_account_age_days: nil, min_followers: nil, min_following: nil, min_statuses: nil, page_size: nil, username_contains: nil, verified_only: nil, verified_type: nil, request_options: {})
         #
         # @param id [String] List ID for member lookup
         #
+        # @param bio_contains [String] Match any comma-separated or line-separated bio term, ignoring case.
+        #
         # @param cursor [String] Pagination cursor for list members
         #
+        # @param has_location [Boolean] Only return profiles with a location.
+        #
+        # @param has_website [Boolean] Only return profiles with a website.
+        #
+        # @param location_contains [String] Match a location substring, ignoring case.
+        #
+        # @param max_followers [Integer] Maximum follower count. Missing counts pass this maximum.
+        #
+        # @param max_following [Integer] Maximum following count.
+        #
+        # @param max_statuses [Integer] Maximum post count. maxPosts is also accepted.
+        #
+        # @param min_account_age_days [Integer] Minimum account age in whole days.
+        #
+        # @param min_followers [Integer] Minimum follower count. Filtering happens before billing.
+        #
+        # @param min_following [Integer] Minimum following count.
+        #
+        # @param min_statuses [Integer] Minimum post count. minPosts is also accepted.
+        #
         # @param page_size [Integer] Members per page (20-200, default 20)
         #
+        # @param username_contains [String] Match a username substring, ignoring case.
+        #
+        # @param verified_only [Boolean] Only return verified profiles.
+        #
+        # @param verified_type [String] Match the verification type exactly, ignoring case.
+        #
         # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [XTwitterScraper::Models::PaginatedUsers]
@@ -60,7 +135,23 @@ module XTwitterScraper
           @client.request(
             method: :get,
             path: ["x/lists/%1$s/members", id],
-            query: query.transform_keys(page_size: "pageSize"),
+            query: query.transform_keys(
+              bio_contains: "bioContains",
+              has_location: "hasLocation",
+              has_website: "hasWebsite",
+              location_contains: "locationContains",
+              max_followers: "maxFollowers",
+              max_following: "maxFollowing",
+              max_statuses: "maxStatuses",
+              min_account_age_days: "minAccountAgeDays",
+              min_followers: "minFollowers",
+              min_following: "minFollowing",
+              min_statuses: "minStatuses",
+              page_size: "pageSize",
+              username_contains: "usernameContains",
+              verified_only: "verifiedOnly",
+              verified_type: "verifiedType"
+            ),
             model: XTwitterScraper::PaginatedUsers,
             options: options
           )