x-twitter-scraper 0.4.2 → 0.4.4

data/lib/x_twitter_scraper/models/webhook.rb

@@ -9,11 +9,26 @@ module XTwitterScraper
       #   @return [String]
       required :id, String
 
+      # @!attribute consecutive_failures
+      #   Consecutive failed delivery attempts since the last success.
+      #
+      #   @return [Integer]
+      required :consecutive_failures, Integer, api_name: :consecutiveFailures
+
       # @!attribute created_at
       #
       #   @return [Time]
       required :created_at, Time, api_name: :createdAt
 
+      # @!attribute delivery_status
+      #   Endpoint delivery state. needs_attention means delivery stopped after repeated
+      #   failures.
+      #
+      #   @return [Symbol, XTwitterScraper::Models::Webhook::DeliveryStatus]
+      required :delivery_status,
+               enum: -> { XTwitterScraper::Webhook::DeliveryStatus },
+               api_name: :deliveryStatus
+
       # @!attribute event_types
       #   Array of event types to subscribe to.
       #
@@ -22,6 +37,12 @@ module XTwitterScraper
                -> { XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::EventType] },
                api_name: :eventTypes
 
+      # @!attribute failure_hard_cap
+      #   Consecutive delivery failures that pause the endpoint.
+      #
+      #   @return [Integer]
+      required :failure_hard_cap, Integer, api_name: :failureHardCap
+
       # @!attribute is_active
       #
       #   @return [Boolean]
@@ -32,18 +53,42 @@ module XTwitterScraper
       #   @return [String]
       required :url, String
 
-      # @!method initialize(id:, created_at:, event_types:, is_active:, url:)
+      # @!method initialize(id:, consecutive_failures:, created_at:, delivery_status:, event_types:, failure_hard_cap:, is_active:, url:)
+      #   Some parameter documentations has been truncated, see
+      #   {XTwitterScraper::Models::Webhook} for more details.
+      #
       #   Webhook endpoint registered to receive event deliveries.
       #
       #   @param id [String]
       #
+      #   @param consecutive_failures [Integer] Consecutive failed delivery attempts since the last success.
+      #
       #   @param created_at [Time]
       #
+      #   @param delivery_status [Symbol, XTwitterScraper::Models::Webhook::DeliveryStatus] Endpoint delivery state. needs_attention means delivery stopped after repeated f
+      #
       #   @param event_types [Array<Symbol, XTwitterScraper::Models::EventType>] Array of event types to subscribe to.
       #
+      #   @param failure_hard_cap [Integer] Consecutive delivery failures that pause the endpoint.
+      #
       #   @param is_active [Boolean]
       #
       #   @param url [String]
+
+      # Endpoint delivery state. needs_attention means delivery stopped after repeated
+      # failures.
+      #
+      # @see XTwitterScraper::Models::Webhook#delivery_status
+      module DeliveryStatus
+        extend XTwitterScraper::Internal::Type::Enum
+
+        ACTIVE = :active
+        PAUSED = :paused
+        NEEDS_ATTENTION = :needs_attention
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/x_twitter_scraper/models/webhook_create_response.rb

@@ -23,6 +23,7 @@ module XTwitterScraper
                api_name: :eventTypes
 
       # @!attribute secret
+      #   Plaintext HMAC signing secret returned only at creation.
       #
       #   @return [String]
       required :secret, String
@@ -39,7 +40,7 @@ module XTwitterScraper
       #
       #   @param event_types [Array<Symbol, XTwitterScraper::Models::EventType>] Array of event types to subscribe to.
       #
-      #   @param secret [String]
+      #   @param secret [String] Plaintext HMAC signing secret returned only at creation.
       #
       #   @param url [String]
     end

data/lib/x_twitter_scraper/models/{api_key_revoke_params.rb → webhook_resume_params.rb}

@@ -2,8 +2,8 @@
 
 module XTwitterScraper
   module Models
-    # @see XTwitterScraper::Resources::APIKeys#revoke
-    class APIKeyRevokeParams < XTwitterScraper::Internal::Type::BaseModel
+    # @see XTwitterScraper::Resources::Webhooks#resume
+    class WebhookResumeParams < XTwitterScraper::Internal::Type::BaseModel
       extend XTwitterScraper::Internal::Type::RequestParameters::Converter
       include XTwitterScraper::Internal::Type::RequestParameters
 

data/lib/x_twitter_scraper/models/webhook_resume_response.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Webhooks#resume
+    class WebhookResumeResponse < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute status_code
+      #
+      #   @return [Integer]
+      required :status_code, Integer, api_name: :statusCode
+
+      # @!attribute success
+      #
+      #   @return [Boolean]
+      required :success, XTwitterScraper::Internal::Type::Boolean
+
+      # @!attribute webhook
+      #   Webhook endpoint registered to receive event deliveries.
+      #
+      #   @return [XTwitterScraper::Models::Webhook]
+      required :webhook, -> { XTwitterScraper::Webhook }
+
+      # @!method initialize(status_code:, success:, webhook:)
+      #   @param status_code [Integer]
+      #
+      #   @param success [Boolean]
+      #
+      #   @param webhook [XTwitterScraper::Models::Webhook] Webhook endpoint registered to receive event deliveries.
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      # @see XTwitterScraper::Resources::X::AccountConnectionChallenges#submit
+      class AccountConnectionChallengeSubmitParams < XTwitterScraper::Internal::Type::BaseModel
+        extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+        include XTwitterScraper::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute email_code
+        #   Code sent to the account email.
+        #
+        #   @return [String]
+        required :email_code, String
+
+        # @!method initialize(id:, email_code:, request_options: {})
+        #   @param id [String]
+        #
+        #   @param email_code [String] Code sent to the account email.
+        #
+        #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      # @see XTwitterScraper::Resources::X::AccountConnectionChallenges#submit
+      class AccountConnectionChallengeSubmitResponse < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time, api_name: :createdAt
+
+        # @!attribute health
+        #
+        #   @return [Symbol, XTwitterScraper::Models::X::AccountConnectionChallengeSubmitResponse::Health]
+        required :health,
+                 enum: -> { XTwitterScraper::Models::X::AccountConnectionChallengeSubmitResponse::Health }
+
+        # @!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
+
+        # @!method initialize(id:, created_at:, health:, status:, x_user_id:, x_username:)
+        #   Sanitized X account summary returned by connect and reauth.
+        #
+        #   @param id [String]
+        #   @param created_at [Time]
+        #   @param health [Symbol, XTwitterScraper::Models::X::AccountConnectionChallengeSubmitResponse::Health]
+        #   @param status [String]
+        #   @param x_user_id [String]
+        #   @param x_username [String]
+
+        # @see XTwitterScraper::Models::X::AccountConnectionChallengeSubmitResponse#health
+        module Health
+          extend XTwitterScraper::Internal::Type::Enum
+
+          HEALTHY = :healthy
+          LOCKED = :locked
+          NEEDS_REAUTH = :needsReauth
+          RECOVERING = :recovering
+          SUSPENDED = :suspended
+          TEMPORARY_ISSUE = :temporaryIssue
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -26,27 +26,19 @@ module XTwitterScraper
         #   @return [String]
         required :username, String
 
-        # @!attribute proxy_country
-        #   Proxy country code
-        #
-        #   @return [String, nil]
-        optional :proxy_country, String
-
         # @!attribute totp_secret
         #   TOTP secret for 2FA
         #
         #   @return [String, nil]
         optional :totp_secret, String
 
-        # @!method initialize(email:, password:, username:, proxy_country: nil, totp_secret: nil, request_options: {})
+        # @!method initialize(email:, password:, username:, totp_secret: nil, request_options: {})
         #   @param email [String] Account email
         #
         #   @param password [String] Account password
         #
         #   @param username [String] X username
         #
-        #   @param proxy_country [String] Proxy country code
-        #
         #   @param totp_secret [String] TOTP secret for 2FA
         #
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]

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

@@ -10,6 +10,16 @@ module XTwitterScraper
         #   @return [String]
         required :id, String
 
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time, api_name: :createdAt
+
+        # @!attribute health
+        #
+        #   @return [Symbol, XTwitterScraper::Models::X::AccountCreateResponse::Health]
+        required :health, enum: -> { XTwitterScraper::Models::X::AccountCreateResponse::Health }
+
         # @!attribute status
         #
         #   @return [String]
@@ -25,11 +35,30 @@ module XTwitterScraper
         #   @return [String]
         required :x_username, String, api_name: :xUsername
 
-        # @!method initialize(id:, status:, x_user_id:, x_username:)
+        # @!method initialize(id:, created_at:, health:, status:, x_user_id:, x_username:)
+        #   Sanitized X account summary returned by connect and reauth.
+        #
         #   @param id [String]
+        #   @param created_at [Time]
+        #   @param health [Symbol, XTwitterScraper::Models::X::AccountCreateResponse::Health]
         #   @param status [String]
         #   @param x_user_id [String]
         #   @param x_username [String]
+
+        # @see XTwitterScraper::Models::X::AccountCreateResponse#health
+        module Health
+          extend XTwitterScraper::Internal::Type::Enum
+
+          HEALTHY = :healthy
+          LOCKED = :locked
+          NEEDS_REAUTH = :needsReauth
+          RECOVERING = :recovering
+          SUSPENDED = :suspended
+          TEMPORARY_ISSUE = :temporaryIssue
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end
   end

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

@@ -19,17 +19,25 @@ module XTwitterScraper
         #   @return [String]
         required :password, String
 
+        # @!attribute email
+        #   Email for the X account (updates stored email)
+        #
+        #   @return [String, nil]
+        optional :email, String
+
         # @!attribute totp_secret
         #   TOTP secret for 2FA re-authentication
         #
         #   @return [String, nil]
         optional :totp_secret, String
 
-        # @!method initialize(id:, password:, totp_secret: nil, request_options: {})
+        # @!method initialize(id:, password:, email: nil, totp_secret: nil, request_options: {})
         #   @param id [String]
         #
         #   @param password [String] Updated account password
         #
+        #   @param email [String] Email for the X account (updates stored email)
+        #
         #   @param totp_secret [String] TOTP secret for 2FA re-authentication
         #
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]

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

@@ -10,20 +10,55 @@ module XTwitterScraper
         #   @return [String]
         required :id, String
 
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time, api_name: :createdAt
+
+        # @!attribute health
+        #
+        #   @return [Symbol, XTwitterScraper::Models::X::AccountReauthResponse::Health]
+        required :health, enum: -> { XTwitterScraper::Models::X::AccountReauthResponse::Health }
+
         # @!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
 
-        # @!method initialize(id:, status:, x_username:)
+        # @!method initialize(id:, created_at:, health:, status:, x_user_id:, x_username:)
+        #   Sanitized X account summary returned by connect and reauth.
+        #
         #   @param id [String]
+        #   @param created_at [Time]
+        #   @param health [Symbol, XTwitterScraper::Models::X::AccountReauthResponse::Health]
         #   @param status [String]
+        #   @param x_user_id [String]
         #   @param x_username [String]
+
+        # @see XTwitterScraper::Models::X::AccountReauthResponse#health
+        module Health
+          extend XTwitterScraper::Internal::Type::Enum
+
+          HEALTHY = :healthy
+          LOCKED = :locked
+          NEEDS_REAUTH = :needsReauth
+          RECOVERING = :recovering
+          SUSPENDED = :suspended
+          TEMPORARY_ISSUE = :temporaryIssue
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end
   end

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

@@ -12,19 +12,23 @@ module XTwitterScraper
                  -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::X::BookmarkRetrieveFoldersResponse::Folder] }
 
         # @!attribute has_next_page
+        #   Always false for the current bookmark folder route
         #
         #   @return [Boolean]
         required :has_next_page, XTwitterScraper::Internal::Type::Boolean
 
         # @!attribute next_cursor
+        #   Always empty for the current bookmark folder route
         #
         #   @return [String]
         required :next_cursor, String
 
         # @!method initialize(folders:, has_next_page:, next_cursor:)
         #   @param folders [Array<XTwitterScraper::Models::X::BookmarkRetrieveFoldersResponse::Folder>]
-        #   @param has_next_page [Boolean]
-        #   @param next_cursor [String]
+        #
+        #   @param has_next_page [Boolean] Always false for the current bookmark folder route
+        #
+        #   @param next_cursor [String] Always empty for the current bookmark folder route
 
         class Folder < XTwitterScraper::Internal::Type::BaseModel
           # @!attribute id

data/lib/x_twitter_scraper/models/x/communities/join_create_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      module Communities
+        # @see XTwitterScraper::Resources::X::Communities::Join#create
+        class JoinCreateResponse < XTwitterScraper::Internal::Type::BaseModel
+          # @!attribute success
+          #
+          #   @return [Boolean, true]
+          required :success, const: true
+
+          # @!method initialize(success: true)
+          #   @param success [Boolean, true]
+        end
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/x/communities/join_delete_all_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      module Communities
+        # @see XTwitterScraper::Resources::X::Communities::Join#delete_all
+        class JoinDeleteAllResponse < XTwitterScraper::Internal::Type::BaseModel
+          # @!attribute success
+          #
+          #   @return [Boolean, true]
+          required :success, const: true
+
+          # @!method initialize(success: true)
+          #   @param success [Boolean, true]
+        end
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/x/communities/tweet_list_by_community_params.rb

@@ -20,11 +20,27 @@ module XTwitterScraper
           #   @return [String, nil]
           optional :cursor, String
 
-          # @!method initialize(id:, cursor: nil, request_options: {})
+          # @!attribute page_size
+          #   Maximum items requested from this page (1-100, default 20). The response can
+          #   contain fewer items because the source returned fewer, filters removed items, or
+          #   remaining credits cover fewer results. Keep requesting next_cursor while
+          #   has_next_page is true, even when a page is empty. The deprecated limit and count
+          #   aliases remain accepted.
+          #
+          #   @return [Integer, nil]
+          optional :page_size, Integer
+
+          # @!method initialize(id:, cursor: nil, page_size: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {XTwitterScraper::Models::X::Communities::TweetListByCommunityParams} for more
+          #   details.
+          #
           #   @param id [String]
           #
           #   @param cursor [String] Pagination cursor for community tweets
           #
+          #   @param page_size [Integer] Maximum items requested from this page (1-100, default 20). The response can con
+          #
           #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
         end
       end

data/lib/x_twitter_scraper/models/x/communities/tweet_list_params.rb

@@ -9,32 +9,66 @@ module XTwitterScraper
           extend XTwitterScraper::Internal::Type::RequestParameters::Converter
           include XTwitterScraper::Internal::Type::RequestParameters
 
+          # @!attribute community_id
+          #   Numeric ID of the community to search
+          #
+          #   @return [String]
+          required :community_id, String
+
           # @!attribute q
-          #   Search query for cross-community tweets
+          #   Keyword query within the selected community
           #
           #   @return [String]
           required :q, String
 
           # @!attribute cursor
-          #   Pagination cursor for cross-community results
+          #   Pagination cursor for community results
           #
           #   @return [String, nil]
           optional :cursor, String
 
+          # @!attribute page_size
+          #   Maximum items requested from this page (1-100, default 20). The response can
+          #   contain fewer items because the source returned fewer, filters removed items, or
+          #   remaining credits cover fewer results. Keep requesting next_cursor while
+          #   has_next_page is true, even when a page is empty. The deprecated limit and count
+          #   aliases remain accepted.
+          #
+          #   @return [Integer, nil]
+          optional :page_size, Integer
+
           # @!attribute query_type
-          #   Sort order for cross-community results (Latest or Top)
+          #   Sort order for community results (Latest or Top)
           #
-          #   @return [String, nil]
-          optional :query_type, String
+          #   @return [Symbol, XTwitterScraper::Models::X::Communities::TweetListParams::QueryType, nil]
+          optional :query_type, enum: -> { XTwitterScraper::X::Communities::TweetListParams::QueryType }
 
-          # @!method initialize(q:, cursor: nil, query_type: nil, request_options: {})
-          #   @param q [String] Search query for cross-community tweets
+          # @!method initialize(community_id:, q:, cursor: nil, page_size: nil, query_type: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {XTwitterScraper::Models::X::Communities::TweetListParams} for more details.
           #
-          #   @param cursor [String] Pagination cursor for cross-community results
+          #   @param community_id [String] Numeric ID of the community to search
           #
-          #   @param query_type [String] Sort order for cross-community results (Latest or Top)
+          #   @param q [String] Keyword query within the selected community
+          #
+          #   @param cursor [String] Pagination cursor for community results
+          #
+          #   @param page_size [Integer] Maximum items requested from this page (1-100, default 20). The response can con
+          #
+          #   @param query_type [Symbol, XTwitterScraper::Models::X::Communities::TweetListParams::QueryType] Sort order for community results (Latest or Top)
           #
           #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+
+          # Sort order for community results (Latest or Top)
+          module QueryType
+            extend XTwitterScraper::Internal::Type::Enum
+
+            LATEST = :Latest
+            TOP = :Top
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
         end
       end
     end