x-twitter-scraper 0.4.2 → 0.4.4

data/lib/x_twitter_scraper/models/guest_wallet_retrieve_status_response.rb

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::GuestWallets#retrieve_status
+    class GuestWalletRetrieveStatusResponse < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute balance
+      #
+      #   @return [String]
+      required :balance, String
+
+      # @!attribute latest_purchase
+      #   Latest guest wallet purchase fulfillment state.
+      #
+      #   @return [XTwitterScraper::Models::GuestWalletRetrieveStatusResponse::LatestPurchase, nil]
+      required :latest_purchase,
+               -> { XTwitterScraper::Models::GuestWalletRetrieveStatusResponse::LatestPurchase },
+               nil?: true
+
+      # @!attribute poll_after_seconds
+      #   Polling delay while payment is pending. Null means stop.
+      #
+      #   @return [Integer, XTwitterScraper::Models::GuestWalletRetrieveStatusResponse::PollAfterSeconds, nil]
+      required :poll_after_seconds,
+               enum: -> { XTwitterScraper::Models::GuestWalletRetrieveStatusResponse::PollAfterSeconds },
+               nil?: true
+
+      # @!attribute scope
+      #
+      #   @return [Symbol, :paid_reads]
+      required :scope, const: :paid_reads
+
+      # @!attribute status
+      #   Combined wallet and pending-checkout state. A pending top-up can coexist with
+      #   usable true. Terminal expired or failed states require a new guest wallet.
+      #
+      #   @return [Symbol, XTwitterScraper::Models::GuestWalletRetrieveStatusResponse::Status]
+      required :status, enum: -> { XTwitterScraper::Models::GuestWalletRetrieveStatusResponse::Status }
+
+      # @!attribute top_up
+      #   Top-up action when usable and no checkout is pending.
+      #
+      #   @return [XTwitterScraper::Models::GuestWalletRetrieveStatusResponse::TopUp, nil]
+      required :top_up, -> { XTwitterScraper::Models::GuestWalletRetrieveStatusResponse::TopUp }, nil?: true
+
+      # @!attribute usable
+      #   Authoritative paid-read readiness. Use instead of status.
+      #
+      #   @return [Boolean]
+      required :usable, XTwitterScraper::Internal::Type::Boolean
+
+      # @!attribute wallet_id
+      #
+      #   @return [String]
+      required :wallet_id, String
+
+      # @!method initialize(balance:, latest_purchase:, poll_after_seconds:, status:, top_up:, usable:, wallet_id:, scope: :paid_reads)
+      #   Some parameter documentations has been truncated, see
+      #   {XTwitterScraper::Models::GuestWalletRetrieveStatusResponse} for more details.
+      #
+      #   Current balance, usability, and latest guest purchase state.
+      #
+      #   @param balance [String]
+      #
+      #   @param latest_purchase [XTwitterScraper::Models::GuestWalletRetrieveStatusResponse::LatestPurchase, nil] Latest guest wallet purchase fulfillment state.
+      #
+      #   @param poll_after_seconds [Integer, XTwitterScraper::Models::GuestWalletRetrieveStatusResponse::PollAfterSeconds, nil] Polling delay while payment is pending. Null means stop.
+      #
+      #   @param status [Symbol, XTwitterScraper::Models::GuestWalletRetrieveStatusResponse::Status] Combined wallet and pending-checkout state. A pending top-up can coexist with us
+      #
+      #   @param top_up [XTwitterScraper::Models::GuestWalletRetrieveStatusResponse::TopUp, nil] Top-up action when usable and no checkout is pending.
+      #
+      #   @param usable [Boolean] Authoritative paid-read readiness. Use instead of status.
+      #
+      #   @param wallet_id [String]
+      #
+      #   @param scope [Symbol, :paid_reads]
+
+      # @see XTwitterScraper::Models::GuestWalletRetrieveStatusResponse#latest_purchase
+      class LatestPurchase < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute amount
+        #   Confirmed USD amount for a guest wallet purchase.
+        #
+        #   @return [XTwitterScraper::Models::GuestWalletAmount]
+        required :amount, -> { XTwitterScraper::GuestWalletAmount }
+
+        # @!attribute checkout_url
+        #   Present only while the purchase is pending.
+        #
+        #   @return [String, nil]
+        required :checkout_url, String, nil?: true
+
+        # @!attribute credits
+        #
+        #   @return [String]
+        required :credits, String
+
+        # @!attribute expires_at
+        #
+        #   @return [Time]
+        required :expires_at, Time
+
+        # @!attribute purchase_id
+        #
+        #   @return [String]
+        required :purchase_id, String
+
+        # @!attribute status
+        #
+        #   @return [Symbol, XTwitterScraper::Models::GuestWalletRetrieveStatusResponse::LatestPurchase::Status]
+        required :status,
+                 enum: -> { XTwitterScraper::Models::GuestWalletRetrieveStatusResponse::LatestPurchase::Status }
+
+        # @!method initialize(amount:, checkout_url:, credits:, expires_at:, purchase_id:, status:)
+        #   Latest guest wallet purchase fulfillment state.
+        #
+        #   @param amount [XTwitterScraper::Models::GuestWalletAmount] Confirmed USD amount for a guest wallet purchase.
+        #
+        #   @param checkout_url [String, nil] Present only while the purchase is pending.
+        #
+        #   @param credits [String]
+        #
+        #   @param expires_at [Time]
+        #
+        #   @param purchase_id [String]
+        #
+        #   @param status [Symbol, XTwitterScraper::Models::GuestWalletRetrieveStatusResponse::LatestPurchase::Status]
+
+        # @see XTwitterScraper::Models::GuestWalletRetrieveStatusResponse::LatestPurchase#status
+        module Status
+          extend XTwitterScraper::Internal::Type::Enum
+
+          CREATING = :creating
+          PENDING = :pending
+          PAID = :paid
+          EXPIRED = :expired
+          FAILED = :failed
+          REFUNDED = :refunded
+          DISPUTED = :disputed
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # Polling delay while payment is pending. Null means stop.
+      #
+      # @see XTwitterScraper::Models::GuestWalletRetrieveStatusResponse#poll_after_seconds
+      module PollAfterSeconds
+        extend XTwitterScraper::Internal::Type::Enum
+
+        POLL_AFTER_SECONDS_2 = 2
+
+        # @!method self.values
+        #   @return [Array<Integer>]
+      end
+
+      # Combined wallet and pending-checkout state. A pending top-up can coexist with
+      # usable true. Terminal expired or failed states require a new guest wallet.
+      #
+      # @see XTwitterScraper::Models::GuestWalletRetrieveStatusResponse#status
+      module Status
+        extend XTwitterScraper::Internal::Type::Enum
+
+        ACTIVE = :active
+        PENDING = :pending
+        EXPIRED = :expired
+        FAILED = :failed
+        FROZEN = :frozen
+        CLOSED = :closed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see XTwitterScraper::Models::GuestWalletRetrieveStatusResponse#top_up
+      class TopUp < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute method_
+        #
+        #   @return [Symbol, :POST]
+        required :method_, const: :POST, api_name: :method
+
+        # @!attribute path
+        #
+        #   @return [Symbol, :"/api/v1/guest-wallets/topups"]
+        required :path, const: :"/api/v1/guest-wallets/topups"
+
+        # @!method initialize(method_: :POST, path: :"/api/v1/guest-wallets/topups")
+        #   Top-up action when usable and no checkout is pending.
+        #
+        #   @param method_ [Symbol, :POST]
+        #   @param path [Symbol, :"/api/v1/guest-wallets/topups"]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/guest_wallet_topup_params.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::GuestWallets#topup
+    class GuestWalletTopupParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      # @!attribute amount_minor
+      #   Confirmed USD amount in cents.
+      #
+      #   @return [Integer]
+      required :amount_minor, Integer
+
+      # @!attribute currency
+      #
+      #   @return [Symbol, :usd]
+      required :currency, const: :usd
+
+      # @!attribute idempotency_key
+      #
+      #   @return [String]
+      required :idempotency_key, String
+
+      # @!method initialize(amount_minor:, idempotency_key:, currency: :usd, request_options: {})
+      #   @param amount_minor [Integer] Confirmed USD amount in cents.
+      #
+      #   @param idempotency_key [String]
+      #
+      #   @param currency [Symbol, :usd]
+      #
+      #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/x_twitter_scraper/models/guest_wallet_topup_response.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::GuestWallets#topup
+    class GuestWalletTopupResponse < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute account_required
+      #
+      #   @return [Boolean, false]
+      required :account_required, const: false
+
+      # @!attribute amount
+      #   Confirmed USD amount for a guest wallet purchase.
+      #
+      #   @return [XTwitterScraper::Models::GuestWalletAmount]
+      required :amount, -> { XTwitterScraper::GuestWalletAmount }
+
+      # @!attribute checkout_url
+      #   Raw Stripe-hosted checkout URL for user interaction.
+      #
+      #   @return [String]
+      required :checkout_url, String
+
+      # @!attribute credits
+      #   Credits granted after verified payment.
+      #
+      #   @return [String]
+      required :credits, String
+
+      # @!attribute expires_at
+      #   Time when the pending checkout expires.
+      #
+      #   @return [Time]
+      required :expires_at, Time
+
+      # @!attribute instructions
+      #
+      #   @return [Symbol, :"Give checkout_url to the user. They must complete payment on Stripe. Never submit payment for them. After payment, poll status_url every poll_after_seconds until latest_purchase.status is no longer pending."]
+      required :instructions,
+               const: :"Give checkout_url to the user. They must complete payment on Stripe. Never submit payment for them. After payment, poll status_url every poll_after_seconds until latest_purchase.status is no longer pending."
+
+      # @!attribute poll_after_seconds
+      #   Wait at least this long before polling status_url.
+      #
+      #   @return [Integer, 2]
+      required :poll_after_seconds, const: 2
+
+      # @!attribute purchase_id
+      #
+      #   @return [String]
+      required :purchase_id, String
+
+      # @!attribute requires_user_interaction
+      #
+      #   @return [Boolean, true]
+      required :requires_user_interaction, const: true
+
+      # @!attribute status
+      #
+      #   @return [Symbol, XTwitterScraper::Models::GuestWalletTopupResponse::Status]
+      required :status, enum: -> { XTwitterScraper::Models::GuestWalletTopupResponse::Status }
+
+      # @!attribute status_url
+      #
+      #   @return [Symbol, :"https://xquik.com/api/v1/guest-wallets/status"]
+      required :status_url, const: :"https://xquik.com/api/v1/guest-wallets/status"
+
+      # @!attribute wallet_id
+      #
+      #   @return [String]
+      required :wallet_id, String
+
+      # @!attribute api_key
+      #   Paid-read bearer credential returned only by initial creation. Store it as a
+      #   secret. Never place it in a URL or log.
+      #
+      #   @return [String, nil]
+      optional :api_key, String
+
+      # @!attribute authorization
+      #
+      #   @return [XTwitterScraper::Models::GuestWalletTopupResponse::Authorization, nil]
+      optional :authorization, -> { XTwitterScraper::Models::GuestWalletTopupResponse::Authorization }
+
+      # @!attribute credential_notice
+      #
+      #   @return [Symbol, XTwitterScraper::Models::GuestWalletTopupResponse::CredentialNotice, nil]
+      optional :credential_notice,
+               enum: -> { XTwitterScraper::Models::GuestWalletTopupResponse::CredentialNotice }
+
+      # @!method initialize(amount:, checkout_url:, credits:, expires_at:, purchase_id:, status:, wallet_id:, api_key: nil, authorization: nil, credential_notice: nil, account_required: false, instructions: :"Give checkout_url to the user. They must complete payment on Stripe. Never submit payment for them. After payment, poll status_url every poll_after_seconds until latest_purchase.status is no longer pending.", poll_after_seconds: 2, requires_user_interaction: true, status_url: :"https://xquik.com/api/v1/guest-wallets/status")
+      #   Some parameter documentations has been truncated, see
+      #   {XTwitterScraper::Models::GuestWalletTopupResponse} for more details.
+      #
+      #   Pending Stripe checkout and guest wallet purchase details.
+      #
+      #   @param amount [XTwitterScraper::Models::GuestWalletAmount] Confirmed USD amount for a guest wallet purchase.
+      #
+      #   @param checkout_url [String] Raw Stripe-hosted checkout URL for user interaction.
+      #
+      #   @param credits [String] Credits granted after verified payment.
+      #
+      #   @param expires_at [Time] Time when the pending checkout expires.
+      #
+      #   @param purchase_id [String]
+      #
+      #   @param status [Symbol, XTwitterScraper::Models::GuestWalletTopupResponse::Status]
+      #
+      #   @param wallet_id [String]
+      #
+      #   @param api_key [String] Paid-read bearer credential returned only by initial creation. Store it as a sec
+      #
+      #   @param authorization [XTwitterScraper::Models::GuestWalletTopupResponse::Authorization]
+      #
+      #   @param credential_notice [Symbol, XTwitterScraper::Models::GuestWalletTopupResponse::CredentialNotice]
+      #
+      #   @param account_required [Boolean, false]
+      #
+      #   @param instructions [Symbol, :"Give checkout_url to the user. They must complete payment on Stripe. Never submit payment for them. After payment, poll status_url every poll_after_seconds until latest_purchase.status is no longer pending."]
+      #
+      #   @param poll_after_seconds [Integer, 2] Wait at least this long before polling status_url.
+      #
+      #   @param requires_user_interaction [Boolean, true]
+      #
+      #   @param status_url [Symbol, :"https://xquik.com/api/v1/guest-wallets/status"]
+
+      # @see XTwitterScraper::Models::GuestWalletTopupResponse#status
+      module Status
+        extend XTwitterScraper::Internal::Type::Enum
+
+        CREATING = :creating
+        PENDING = :pending
+        PAID = :paid
+        EXPIRED = :expired
+        FAILED = :failed
+        REFUNDED = :refunded
+        DISPUTED = :disputed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see XTwitterScraper::Models::GuestWalletTopupResponse#authorization
+      class Authorization < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute header
+        #
+        #   @return [Symbol, :Authorization]
+        required :header, const: :Authorization
+
+        # @!attribute scheme
+        #
+        #   @return [Symbol, :Bearer]
+        required :scheme, const: :Bearer
+
+        # @!method initialize(header: :Authorization, scheme: :Bearer)
+        #   @param header [Symbol, :Authorization]
+        #   @param scheme [Symbol, :Bearer]
+      end
+
+      # @see XTwitterScraper::Models::GuestWalletTopupResponse#credential_notice
+      module CredentialNotice
+        extend XTwitterScraper::Internal::Type::Enum
+
+        STORE_API_KEY_AND_THE_IDEMPOTENCY_KEY_SECURELY_BEFORE_SHARING_CHECKOUT_URL_NO_EMAIL_RECOVERY_IS_AVAILABLE =
+          :"Store api_key and the Idempotency-Key securely before sharing checkout_url. No email recovery is available."
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/monitor.rb

@@ -27,6 +27,12 @@ module XTwitterScraper
       #   @return [Boolean]
       required :is_active, XTwitterScraper::Internal::Type::Boolean, api_name: :isActive
 
+      # @!attribute next_billing_at
+      #   Next hourly credit charge time for this account monitor.
+      #
+      #   @return [Time]
+      required :next_billing_at, Time, api_name: :nextBillingAt
+
       # @!attribute username
       #
       #   @return [String]
@@ -37,7 +43,7 @@ module XTwitterScraper
       #   @return [String]
       required :x_user_id, String, api_name: :xUserId
 
-      # @!method initialize(id:, created_at:, event_types:, is_active:, username:, x_user_id:)
+      # @!method initialize(id:, created_at:, event_types:, is_active:, next_billing_at:, username:, x_user_id:)
       #   Account monitor that tracks activity for a given X user.
       #
       #   @param id [String]
@@ -48,6 +54,8 @@ module XTwitterScraper
       #
       #   @param is_active [Boolean]
       #
+      #   @param next_billing_at [Time] Next hourly credit charge time for this account monitor.
+      #
       #   @param username [String]
       #
       #   @param x_user_id [String]

data/lib/x_twitter_scraper/models/monitor_create_response.rb

@@ -22,6 +22,17 @@ module XTwitterScraper
                -> { XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::EventType] },
                api_name: :eventTypes
 
+      # @!attribute is_active
+      #
+      #   @return [Boolean]
+      required :is_active, XTwitterScraper::Internal::Type::Boolean, api_name: :isActive
+
+      # @!attribute next_billing_at
+      #   Next hourly credit charge time. New active monitors are due immediately.
+      #
+      #   @return [Time]
+      required :next_billing_at, Time, api_name: :nextBillingAt
+
       # @!attribute username
       #
       #   @return [String]
@@ -32,13 +43,17 @@ module XTwitterScraper
       #   @return [String]
       required :x_user_id, String, api_name: :xUserId
 
-      # @!method initialize(id:, created_at:, event_types:, username:, x_user_id:)
+      # @!method initialize(id:, created_at:, event_types:, is_active:, next_billing_at:, username:, x_user_id:)
       #   @param id [String]
       #
       #   @param created_at [Time]
       #
       #   @param event_types [Array<Symbol, XTwitterScraper::Models::EventType>] Array of event types to subscribe to.
       #
+      #   @param is_active [Boolean]
+      #
+      #   @param next_billing_at [Time] Next hourly credit charge time. New active monitors are due immediately.
+      #
       #   @param username [String]
       #
       #   @param x_user_id [String]

data/lib/x_twitter_scraper/models/monitors/keyword_create_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module Monitors
+      # @see XTwitterScraper::Resources::Monitors::Keywords#create
+      class KeywordCreateParams < XTwitterScraper::Internal::Type::BaseModel
+        extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+        include XTwitterScraper::Internal::Type::RequestParameters
+
+        # @!attribute event_types
+        #   Array of event types to subscribe to.
+        #
+        #   @return [Array<Symbol, XTwitterScraper::Models::EventType>]
+        required :event_types,
+                 -> { XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::EventType] },
+                 api_name: :eventTypes
+
+        # @!attribute query
+        #   X search query to monitor. Whitespace is normalized.
+        #
+        #   @return [String]
+        required :query, String
+
+        # @!method initialize(event_types:, query:, request_options: {})
+        #   @param event_types [Array<Symbol, XTwitterScraper::Models::EventType>] Array of event types to subscribe to.
+        #
+        #   @param query [String] X search query to monitor. Whitespace is normalized.
+        #
+        #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/monitors/keyword_create_response.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module Monitors
+      # @see XTwitterScraper::Resources::Monitors::Keywords#create
+      class KeywordCreateResponse < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time, api_name: :createdAt
+
+        # @!attribute event_types
+        #   Array of event types to subscribe to.
+        #
+        #   @return [Array<Symbol, XTwitterScraper::Models::EventType>]
+        required :event_types,
+                 -> { XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::EventType] },
+                 api_name: :eventTypes
+
+        # @!attribute is_active
+        #
+        #   @return [Boolean]
+        required :is_active, XTwitterScraper::Internal::Type::Boolean, api_name: :isActive
+
+        # @!attribute next_billing_at
+        #   Next hourly credit charge time for this keyword query monitor.
+        #
+        #   @return [Time]
+        required :next_billing_at, Time, api_name: :nextBillingAt
+
+        # @!attribute query
+        #
+        #   @return [String]
+        required :query, String
+
+        # @!method initialize(id:, created_at:, event_types:, is_active:, next_billing_at:, query:)
+        #   Keyword monitor that tracks matching public X activity.
+        #
+        #   @param id [String]
+        #
+        #   @param created_at [Time]
+        #
+        #   @param event_types [Array<Symbol, XTwitterScraper::Models::EventType>] Array of event types to subscribe to.
+        #
+        #   @param is_active [Boolean]
+        #
+        #   @param next_billing_at [Time] Next hourly credit charge time for this keyword query monitor.
+        #
+        #   @param query [String]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/monitors/keyword_deactivate_params.rb

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

data/lib/x_twitter_scraper/models/monitors/keyword_deactivate_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module Monitors
+      # @see XTwitterScraper::Resources::Monitors::Keywords#deactivate
+      class KeywordDeactivateResponse < 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

data/lib/x_twitter_scraper/models/monitors/keyword_list_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module Monitors
+      # @see XTwitterScraper::Resources::Monitors::Keywords#list
+      class KeywordListParams < 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
+end