x-twitter-scraper 0.4.3 → 0.4.4

data/rbi/x_twitter_scraper/models/guest_wallet_topup_response.rbi

@@ -0,0 +1,293 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    class GuestWalletTopupResponse < XTwitterScraper::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            XTwitterScraper::Models::GuestWalletTopupResponse,
+            XTwitterScraper::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T::Boolean) }
+      attr_accessor :account_required
+
+      # Confirmed USD amount for a guest wallet purchase.
+      sig { returns(XTwitterScraper::GuestWalletAmount) }
+      attr_reader :amount
+
+      sig { params(amount: XTwitterScraper::GuestWalletAmount::OrHash).void }
+      attr_writer :amount
+
+      # Raw Stripe-hosted checkout URL for user interaction.
+      sig { returns(String) }
+      attr_accessor :checkout_url
+
+      # Credits granted after verified payment.
+      sig { returns(String) }
+      attr_accessor :credits
+
+      # Time when the pending checkout expires.
+      sig { returns(Time) }
+      attr_accessor :expires_at
+
+      sig { returns(Symbol) }
+      attr_accessor :instructions
+
+      # Wait at least this long before polling status_url.
+      sig { returns(Integer) }
+      attr_accessor :poll_after_seconds
+
+      sig { returns(String) }
+      attr_accessor :purchase_id
+
+      sig { returns(T::Boolean) }
+      attr_accessor :requires_user_interaction
+
+      sig do
+        returns(
+          XTwitterScraper::Models::GuestWalletTopupResponse::Status::TaggedSymbol
+        )
+      end
+      attr_accessor :status
+
+      sig { returns(Symbol) }
+      attr_accessor :status_url
+
+      sig { returns(String) }
+      attr_accessor :wallet_id
+
+      # Paid-read bearer credential returned only by initial creation. Store it as a
+      # secret. Never place it in a URL or log.
+      sig { returns(T.nilable(String)) }
+      attr_reader :api_key
+
+      sig { params(api_key: String).void }
+      attr_writer :api_key
+
+      sig do
+        returns(
+          T.nilable(
+            XTwitterScraper::Models::GuestWalletTopupResponse::Authorization
+          )
+        )
+      end
+      attr_reader :authorization
+
+      sig do
+        params(
+          authorization:
+            XTwitterScraper::Models::GuestWalletTopupResponse::Authorization::OrHash
+        ).void
+      end
+      attr_writer :authorization
+
+      sig do
+        returns(
+          T.nilable(
+            XTwitterScraper::Models::GuestWalletTopupResponse::CredentialNotice::TaggedSymbol
+          )
+        )
+      end
+      attr_reader :credential_notice
+
+      sig do
+        params(
+          credential_notice:
+            XTwitterScraper::Models::GuestWalletTopupResponse::CredentialNotice::OrSymbol
+        ).void
+      end
+      attr_writer :credential_notice
+
+      # Pending Stripe checkout and guest wallet purchase details.
+      sig do
+        params(
+          amount: XTwitterScraper::GuestWalletAmount::OrHash,
+          checkout_url: String,
+          credits: String,
+          expires_at: Time,
+          purchase_id: String,
+          status:
+            XTwitterScraper::Models::GuestWalletTopupResponse::Status::OrSymbol,
+          wallet_id: String,
+          api_key: String,
+          authorization:
+            XTwitterScraper::Models::GuestWalletTopupResponse::Authorization::OrHash,
+          credential_notice:
+            XTwitterScraper::Models::GuestWalletTopupResponse::CredentialNotice::OrSymbol,
+          account_required: T::Boolean,
+          instructions: Symbol,
+          poll_after_seconds: Integer,
+          requires_user_interaction: T::Boolean,
+          status_url: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Confirmed USD amount for a guest wallet purchase.
+        amount:,
+        # Raw Stripe-hosted checkout URL for user interaction.
+        checkout_url:,
+        # Credits granted after verified payment.
+        credits:,
+        # Time when the pending checkout expires.
+        expires_at:,
+        purchase_id:,
+        status:,
+        wallet_id:,
+        # Paid-read bearer credential returned only by initial creation. Store it as a
+        # secret. Never place it in a URL or log.
+        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.",
+        # Wait at least this long before polling status_url.
+        poll_after_seconds: 2,
+        requires_user_interaction: true,
+        status_url: :"https://xquik.com/api/v1/guest-wallets/status"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_required: T::Boolean,
+            amount: XTwitterScraper::GuestWalletAmount,
+            checkout_url: String,
+            credits: String,
+            expires_at: Time,
+            instructions: Symbol,
+            poll_after_seconds: Integer,
+            purchase_id: String,
+            requires_user_interaction: T::Boolean,
+            status:
+              XTwitterScraper::Models::GuestWalletTopupResponse::Status::TaggedSymbol,
+            status_url: Symbol,
+            wallet_id: String,
+            api_key: String,
+            authorization:
+              XTwitterScraper::Models::GuestWalletTopupResponse::Authorization,
+            credential_notice:
+              XTwitterScraper::Models::GuestWalletTopupResponse::CredentialNotice::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Status
+        extend XTwitterScraper::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              XTwitterScraper::Models::GuestWalletTopupResponse::Status
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CREATING =
+          T.let(
+            :creating,
+            XTwitterScraper::Models::GuestWalletTopupResponse::Status::TaggedSymbol
+          )
+        PENDING =
+          T.let(
+            :pending,
+            XTwitterScraper::Models::GuestWalletTopupResponse::Status::TaggedSymbol
+          )
+        PAID =
+          T.let(
+            :paid,
+            XTwitterScraper::Models::GuestWalletTopupResponse::Status::TaggedSymbol
+          )
+        EXPIRED =
+          T.let(
+            :expired,
+            XTwitterScraper::Models::GuestWalletTopupResponse::Status::TaggedSymbol
+          )
+        FAILED =
+          T.let(
+            :failed,
+            XTwitterScraper::Models::GuestWalletTopupResponse::Status::TaggedSymbol
+          )
+        REFUNDED =
+          T.let(
+            :refunded,
+            XTwitterScraper::Models::GuestWalletTopupResponse::Status::TaggedSymbol
+          )
+        DISPUTED =
+          T.let(
+            :disputed,
+            XTwitterScraper::Models::GuestWalletTopupResponse::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              XTwitterScraper::Models::GuestWalletTopupResponse::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class Authorization < XTwitterScraper::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::Models::GuestWalletTopupResponse::Authorization,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Symbol) }
+        attr_accessor :header
+
+        sig { returns(Symbol) }
+        attr_accessor :scheme
+
+        sig { params(header: Symbol, scheme: Symbol).returns(T.attached_class) }
+        def self.new(header: :Authorization, scheme: :Bearer)
+        end
+
+        sig { override.returns({ header: Symbol, scheme: Symbol }) }
+        def to_hash
+        end
+      end
+
+      module CredentialNotice
+        extend XTwitterScraper::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              XTwitterScraper::Models::GuestWalletTopupResponse::CredentialNotice
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        STORE_API_KEY_AND_THE_IDEMPOTENCY_KEY_SECURELY_BEFORE_SHARING_CHECKOUT_URL_NO_EMAIL_RECOVERY_IS_AVAILABLE =
+          T.let(
+            :"Store api_key and the Idempotency-Key securely before sharing checkout_url. No email recovery is available.",
+            XTwitterScraper::Models::GuestWalletTopupResponse::CredentialNotice::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              XTwitterScraper::Models::GuestWalletTopupResponse::CredentialNotice::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/monitor.rbi

@@ -21,6 +21,10 @@ module XTwitterScraper
       sig { returns(T::Boolean) }
       attr_accessor :is_active
 
+      # Next hourly credit charge time for this account monitor.
+      sig { returns(Time) }
+      attr_accessor :next_billing_at
+
       sig { returns(String) }
       attr_accessor :username
 
@@ -34,6 +38,7 @@ module XTwitterScraper
           created_at: Time,
           event_types: T::Array[XTwitterScraper::EventType::OrSymbol],
           is_active: T::Boolean,
+          next_billing_at: Time,
           username: String,
           x_user_id: String
         ).returns(T.attached_class)
@@ -44,6 +49,8 @@ module XTwitterScraper
         # Array of event types to subscribe to.
         event_types:,
         is_active:,
+        # Next hourly credit charge time for this account monitor.
+        next_billing_at:,
         username:,
         x_user_id:
       )
@@ -56,6 +63,7 @@ module XTwitterScraper
             created_at: Time,
             event_types: T::Array[XTwitterScraper::EventType::TaggedSymbol],
             is_active: T::Boolean,
+            next_billing_at: Time,
             username: String,
             x_user_id: String
           }

data/rbi/x_twitter_scraper/models/monitor_create_response.rbi

@@ -21,6 +21,13 @@ module XTwitterScraper
       sig { returns(T::Array[XTwitterScraper::EventType::TaggedSymbol]) }
       attr_accessor :event_types
 
+      sig { returns(T::Boolean) }
+      attr_accessor :is_active
+
+      # Next hourly credit charge time. New active monitors are due immediately.
+      sig { returns(Time) }
+      attr_accessor :next_billing_at
+
       sig { returns(String) }
       attr_accessor :username
 
@@ -32,6 +39,8 @@ module XTwitterScraper
           id: String,
           created_at: Time,
           event_types: T::Array[XTwitterScraper::EventType::OrSymbol],
+          is_active: T::Boolean,
+          next_billing_at: Time,
           username: String,
           x_user_id: String
         ).returns(T.attached_class)
@@ -41,6 +50,9 @@ module XTwitterScraper
         created_at:,
         # Array of event types to subscribe to.
         event_types:,
+        is_active:,
+        # Next hourly credit charge time. New active monitors are due immediately.
+        next_billing_at:,
         username:,
         x_user_id:
       )
@@ -52,6 +64,8 @@ module XTwitterScraper
             id: String,
             created_at: Time,
             event_types: T::Array[XTwitterScraper::EventType::TaggedSymbol],
+            is_active: T::Boolean,
+            next_billing_at: Time,
             username: String,
             x_user_id: String
           }

data/rbi/x_twitter_scraper/models/monitors/keyword_create_params.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    module Monitors
+      class KeywordCreateParams < XTwitterScraper::Internal::Type::BaseModel
+        extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+        include XTwitterScraper::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::Monitors::KeywordCreateParams,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        # Array of event types to subscribe to.
+        sig { returns(T::Array[XTwitterScraper::EventType::OrSymbol]) }
+        attr_accessor :event_types
+
+        # X search query to monitor. Whitespace is normalized.
+        sig { returns(String) }
+        attr_accessor :query
+
+        sig do
+          params(
+            event_types: T::Array[XTwitterScraper::EventType::OrSymbol],
+            query: String,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Array of event types to subscribe to.
+          event_types:,
+          # X search query to monitor. Whitespace is normalized.
+          query:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              event_types: T::Array[XTwitterScraper::EventType::OrSymbol],
+              query: String,
+              request_options: XTwitterScraper::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/monitors/keyword_create_response.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    module Monitors
+      class KeywordCreateResponse < XTwitterScraper::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::Models::Monitors::KeywordCreateResponse,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # Array of event types to subscribe to.
+        sig { returns(T::Array[XTwitterScraper::EventType::TaggedSymbol]) }
+        attr_accessor :event_types
+
+        sig { returns(T::Boolean) }
+        attr_accessor :is_active
+
+        # Next hourly credit charge time for this keyword query monitor.
+        sig { returns(Time) }
+        attr_accessor :next_billing_at
+
+        sig { returns(String) }
+        attr_accessor :query
+
+        # Keyword monitor that tracks matching public X activity.
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            event_types: T::Array[XTwitterScraper::EventType::OrSymbol],
+            is_active: T::Boolean,
+            next_billing_at: Time,
+            query: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          created_at:,
+          # Array of event types to subscribe to.
+          event_types:,
+          is_active:,
+          # Next hourly credit charge time for this keyword query monitor.
+          next_billing_at:,
+          query:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Time,
+              event_types: T::Array[XTwitterScraper::EventType::TaggedSymbol],
+              is_active: T::Boolean,
+              next_billing_at: Time,
+              query: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/monitors/keyword_deactivate_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    module Monitors
+      class KeywordDeactivateParams < XTwitterScraper::Internal::Type::BaseModel
+        extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+        include XTwitterScraper::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::Monitors::KeywordDeactivateParams,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig do
+          params(
+            id: String,
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            { id: String, request_options: XTwitterScraper::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/monitors/keyword_deactivate_response.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    module Monitors
+      class KeywordDeactivateResponse < XTwitterScraper::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::Models::Monitors::KeywordDeactivateResponse,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T::Boolean) }
+        attr_accessor :success
+
+        sig { params(success: T::Boolean).returns(T.attached_class) }
+        def self.new(success: true)
+        end
+
+        sig { override.returns({ success: T::Boolean }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/monitors/keyword_list_params.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    module Monitors
+      class KeywordListParams < XTwitterScraper::Internal::Type::BaseModel
+        extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+        include XTwitterScraper::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::Monitors::KeywordListParams,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        sig do
+          params(
+            request_options: XTwitterScraper::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(request_options: {})
+        end
+
+        sig do
+          override.returns({ request_options: XTwitterScraper::RequestOptions })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end