x-twitter-scraper 0.4.3 → 0.4.4

data/rbi/x_twitter_scraper/models/account_retrieve_response.rbi

@@ -11,6 +11,23 @@ module XTwitterScraper
           )
         end
 
+      sig do
+        returns(
+          XTwitterScraper::Models::AccountRetrieveResponse::MonitorBilling
+        )
+      end
+      attr_reader :monitor_billing
+
+      sig do
+        params(
+          monitor_billing:
+            XTwitterScraper::Models::AccountRetrieveResponse::MonitorBilling::OrHash
+        ).void
+      end
+      attr_writer :monitor_billing
+
+      # Deprecated. Monitor slots are unlimited, so this is always
+      # Number.MAX_SAFE_INTEGER.
       sig { returns(Integer) }
       attr_accessor :monitors_allowed
 
@@ -27,53 +44,154 @@ module XTwitterScraper
       sig do
         returns(
           T.nilable(
-            XTwitterScraper::Models::AccountRetrieveResponse::CurrentPeriod
+            XTwitterScraper::Models::AccountRetrieveResponse::CreditInfo
           )
         )
       end
-      attr_reader :current_period
+      attr_reader :credit_info
 
       sig do
         params(
-          current_period:
-            XTwitterScraper::Models::AccountRetrieveResponse::CurrentPeriod::OrHash
+          credit_info:
+            XTwitterScraper::Models::AccountRetrieveResponse::CreditInfo::OrHash
         ).void
       end
-      attr_writer :current_period
+      attr_writer :credit_info
+
+      # Linked X username, omitted when no X account is connected.
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_username
+
+      sig { params(x_username: String).void }
+      attr_writer :x_username
 
       sig do
         params(
+          monitor_billing:
+            XTwitterScraper::Models::AccountRetrieveResponse::MonitorBilling::OrHash,
           monitors_allowed: Integer,
           monitors_used: Integer,
           plan:
             XTwitterScraper::Models::AccountRetrieveResponse::Plan::OrSymbol,
-          current_period:
-            XTwitterScraper::Models::AccountRetrieveResponse::CurrentPeriod::OrHash
+          credit_info:
+            XTwitterScraper::Models::AccountRetrieveResponse::CreditInfo::OrHash,
+          x_username: String
         ).returns(T.attached_class)
       end
       def self.new(
+        monitor_billing:,
+        # Deprecated. Monitor slots are unlimited, so this is always
+        # Number.MAX_SAFE_INTEGER.
         monitors_allowed:,
         monitors_used:,
         plan:,
-        current_period: nil
+        credit_info: nil,
+        # Linked X username, omitted when no X account is connected.
+        x_username: nil
       )
       end
 
       sig do
         override.returns(
           {
+            monitor_billing:
+              XTwitterScraper::Models::AccountRetrieveResponse::MonitorBilling,
             monitors_allowed: Integer,
             monitors_used: Integer,
             plan:
               XTwitterScraper::Models::AccountRetrieveResponse::Plan::TaggedSymbol,
-            current_period:
-              XTwitterScraper::Models::AccountRetrieveResponse::CurrentPeriod
+            credit_info:
+              XTwitterScraper::Models::AccountRetrieveResponse::CreditInfo,
+            x_username: String
           }
         )
       end
       def to_hash
       end
 
+      class MonitorBilling < XTwitterScraper::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::Models::AccountRetrieveResponse::MonitorBilling,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        # Estimated daily credits for currently active monitors.
+        sig { returns(String) }
+        attr_accessor :active_daily_estimate
+
+        # Credits charged each hour for currently active monitors.
+        sig { returns(String) }
+        attr_accessor :active_hourly_burn
+
+        # Estimated daily credits for 1 active instant monitor.
+        sig { returns(String) }
+        attr_accessor :credits_per_active_monitor_day
+
+        # Hourly credits charged for 1 active instant monitor.
+        sig { returns(String) }
+        attr_accessor :credits_per_active_monitor_hour
+
+        # Webhook and event deliveries are included in monitor billing.
+        sig { returns(T::Boolean) }
+        attr_accessor :events_included
+
+        # Active monitors check every 1 second.
+        sig { returns(Integer) }
+        attr_accessor :instant_check_interval_seconds
+
+        # Monitor slot count is unlimited.
+        sig { returns(T::Boolean) }
+        attr_accessor :unlimited_slots
+
+        sig do
+          params(
+            active_daily_estimate: String,
+            active_hourly_burn: String,
+            credits_per_active_monitor_day: String,
+            credits_per_active_monitor_hour: String,
+            events_included: T::Boolean,
+            instant_check_interval_seconds: Integer,
+            unlimited_slots: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Estimated daily credits for currently active monitors.
+          active_daily_estimate:,
+          # Credits charged each hour for currently active monitors.
+          active_hourly_burn:,
+          # Estimated daily credits for 1 active instant monitor.
+          credits_per_active_monitor_day:,
+          # Hourly credits charged for 1 active instant monitor.
+          credits_per_active_monitor_hour:,
+          # Webhook and event deliveries are included in monitor billing.
+          events_included:,
+          # Active monitors check every 1 second.
+          instant_check_interval_seconds:,
+          # Monitor slot count is unlimited.
+          unlimited_slots:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              active_daily_estimate: String,
+              active_hourly_burn: String,
+              credits_per_active_monitor_day: String,
+              credits_per_active_monitor_hour: String,
+              events_included: T::Boolean,
+              instant_check_interval_seconds: Integer,
+              unlimited_slots: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
       module Plan
         extend XTwitterScraper::Internal::Type::Enum
 
@@ -108,34 +226,74 @@ module XTwitterScraper
         end
       end
 
-      class CurrentPeriod < XTwitterScraper::Internal::Type::BaseModel
+      class CreditInfo < XTwitterScraper::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
             T.any(
-              XTwitterScraper::Models::AccountRetrieveResponse::CurrentPeriod,
+              XTwitterScraper::Models::AccountRetrieveResponse::CreditInfo,
               XTwitterScraper::Internal::AnyHash
             )
           end
 
-        sig { returns(Time) }
-        attr_accessor :end_
+        # Dollar amount charged when automatic top-up runs.
+        sig { returns(Float) }
+        attr_accessor :auto_topup_amount_dollars
 
-        sig { returns(Time) }
-        attr_accessor :start
+        sig { returns(T::Boolean) }
+        attr_accessor :auto_topup_enabled
 
-        sig { returns(Float) }
-        attr_accessor :usage_percent
+        # Bigint string threshold that triggers automatic top-up when enabled.
+        sig { returns(String) }
+        attr_accessor :auto_topup_threshold
+
+        # Bigint string to preserve precision above Number.MAX_SAFE_INTEGER.
+        sig { returns(String) }
+        attr_accessor :balance
+
+        # Total purchased credits as a bigint string.
+        sig { returns(String) }
+        attr_accessor :lifetime_purchased
+
+        # Total consumed credits as a bigint string.
+        sig { returns(String) }
+        attr_accessor :lifetime_used
 
         sig do
-          params(end_: Time, start: Time, usage_percent: Float).returns(
-            T.attached_class
-          )
+          params(
+            auto_topup_amount_dollars: Float,
+            auto_topup_enabled: T::Boolean,
+            auto_topup_threshold: String,
+            balance: String,
+            lifetime_purchased: String,
+            lifetime_used: String
+          ).returns(T.attached_class)
         end
-        def self.new(end_:, start:, usage_percent:)
+        def self.new(
+          # Dollar amount charged when automatic top-up runs.
+          auto_topup_amount_dollars:,
+          auto_topup_enabled:,
+          # Bigint string threshold that triggers automatic top-up when enabled.
+          auto_topup_threshold:,
+          # Bigint string to preserve precision above Number.MAX_SAFE_INTEGER.
+          balance:,
+          # Total purchased credits as a bigint string.
+          lifetime_purchased:,
+          # Total consumed credits as a bigint string.
+          lifetime_used:
+        )
         end
 
         sig do
-          override.returns({ end_: Time, start: Time, usage_percent: Float })
+          override.returns(
+            {
+              auto_topup_amount_dollars: Float,
+              auto_topup_enabled: T::Boolean,
+              auto_topup_threshold: String,
+              balance: String,
+              lifetime_purchased: String,
+              lifetime_used: String
+            }
+          )
         end
         def to_hash
         end

data/rbi/x_twitter_scraper/models/content_disclosure.rbi

@@ -0,0 +1,149 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    class ContentDisclosure < XTwitterScraper::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            XTwitterScraper::ContentDisclosure,
+            XTwitterScraper::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(T.nilable(XTwitterScraper::ContentDisclosure::Advertising))
+      end
+      attr_reader :advertising
+
+      sig do
+        params(
+          advertising: XTwitterScraper::ContentDisclosure::Advertising::OrHash
+        ).void
+      end
+      attr_writer :advertising
+
+      sig do
+        returns(T.nilable(XTwitterScraper::ContentDisclosure::AIGenerated))
+      end
+      attr_reader :ai_generated
+
+      sig do
+        params(
+          ai_generated: XTwitterScraper::ContentDisclosure::AIGenerated::OrHash
+        ).void
+      end
+      attr_writer :ai_generated
+
+      # Content disclosure metadata shown by X when a tweet is labeled as paid
+      # partnership content or AI-generated media.
+      sig do
+        params(
+          advertising: XTwitterScraper::ContentDisclosure::Advertising::OrHash,
+          ai_generated: XTwitterScraper::ContentDisclosure::AIGenerated::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(advertising: nil, ai_generated: nil)
+      end
+
+      sig do
+        override.returns(
+          {
+            advertising: XTwitterScraper::ContentDisclosure::Advertising,
+            ai_generated: XTwitterScraper::ContentDisclosure::AIGenerated
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Advertising < XTwitterScraper::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::ContentDisclosure::Advertising,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        # True when X labels the tweet as paid promotion content.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_paid_promotion
+
+        sig { params(is_paid_promotion: T::Boolean).void }
+        attr_writer :is_paid_promotion
+
+        sig { params(is_paid_promotion: T::Boolean).returns(T.attached_class) }
+        def self.new(
+          # True when X labels the tweet as paid promotion content.
+          is_paid_promotion: nil
+        )
+        end
+
+        sig { override.returns({ is_paid_promotion: T::Boolean }) }
+        def to_hash
+        end
+      end
+
+      class AIGenerated < XTwitterScraper::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::ContentDisclosure::AIGenerated,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        # Whether the disclosure can be edited on X.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :can_edit
+
+        sig { params(can_edit: T::Boolean).void }
+        attr_writer :can_edit
+
+        # Source of the AI-generated media disclosure.
+        sig { returns(T.nilable(String)) }
+        attr_reader :detection_source
+
+        sig { params(detection_source: String).void }
+        attr_writer :detection_source
+
+        # True when X labels the tweet as containing AI-generated media.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :has_ai_generated_media
+
+        sig { params(has_ai_generated_media: T::Boolean).void }
+        attr_writer :has_ai_generated_media
+
+        sig do
+          params(
+            can_edit: T::Boolean,
+            detection_source: String,
+            has_ai_generated_media: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Whether the disclosure can be edited on X.
+          can_edit: nil,
+          # Source of the AI-generated media disclosure.
+          detection_source: nil,
+          # True when X labels the tweet as containing AI-generated media.
+          has_ai_generated_media: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              can_edit: T::Boolean,
+              detection_source: String,
+              has_ai_generated_media: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/{integration_retrieve_params.rbi → credit_redirect_topup_checkout_params.rbi}

@@ -2,33 +2,41 @@
 
 module XTwitterScraper
   module Models
-    class IntegrationRetrieveParams < XTwitterScraper::Internal::Type::BaseModel
+    class CreditRedirectTopupCheckoutParams < XTwitterScraper::Internal::Type::BaseModel
       extend XTwitterScraper::Internal::Type::RequestParameters::Converter
       include XTwitterScraper::Internal::Type::RequestParameters
 
       OrHash =
         T.type_alias do
           T.any(
-            XTwitterScraper::IntegrationRetrieveParams,
+            XTwitterScraper::CreditRedirectTopupCheckoutParams,
             XTwitterScraper::Internal::AnyHash
           )
         end
 
+      # Billing session ID returned by the top-up billing flow.
       sig { returns(String) }
-      attr_accessor :id
+      attr_accessor :session_id
 
       sig do
         params(
-          id: String,
+          session_id: String,
           request_options: XTwitterScraper::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(id:, request_options: {})
+      def self.new(
+        # Billing session ID returned by the top-up billing flow.
+        session_id:,
+        request_options: {}
+      )
       end
 
       sig do
         override.returns(
-          { id: String, request_options: XTwitterScraper::RequestOptions }
+          {
+            session_id: String,
+            request_options: XTwitterScraper::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/x_twitter_scraper/models/credit_retrieve_balance_response.rbi

@@ -11,30 +11,54 @@ module XTwitterScraper
           )
         end
 
+      # Configured dollar amount for each automatic top-up.
+      sig { returns(Float) }
+      attr_accessor :auto_topup_amount_dollars
+
       sig { returns(T::Boolean) }
       attr_accessor :auto_topup_enabled
 
-      sig { returns(Integer) }
+      # Credit balance threshold that triggers automatic top-up when enabled,
+      # represented as a bigint string.
+      sig { returns(String) }
+      attr_accessor :auto_topup_threshold
+
+      # Current credit balance as a bigint string to preserve precision above
+      # Number.MAX_SAFE_INTEGER.
+      sig { returns(String) }
       attr_accessor :balance
 
-      sig { returns(Integer) }
+      # Lifetime purchased credits as a bigint string.
+      sig { returns(String) }
       attr_accessor :lifetime_purchased
 
-      sig { returns(Integer) }
+      # Lifetime consumed credits as a bigint string.
+      sig { returns(String) }
       attr_accessor :lifetime_used
 
       sig do
         params(
+          auto_topup_amount_dollars: Float,
           auto_topup_enabled: T::Boolean,
-          balance: Integer,
-          lifetime_purchased: Integer,
-          lifetime_used: Integer
+          auto_topup_threshold: String,
+          balance: String,
+          lifetime_purchased: String,
+          lifetime_used: String
         ).returns(T.attached_class)
       end
       def self.new(
+        # Configured dollar amount for each automatic top-up.
+        auto_topup_amount_dollars:,
         auto_topup_enabled:,
+        # Credit balance threshold that triggers automatic top-up when enabled,
+        # represented as a bigint string.
+        auto_topup_threshold:,
+        # Current credit balance as a bigint string to preserve precision above
+        # Number.MAX_SAFE_INTEGER.
         balance:,
+        # Lifetime purchased credits as a bigint string.
         lifetime_purchased:,
+        # Lifetime consumed credits as a bigint string.
         lifetime_used:
       )
       end
@@ -42,10 +66,12 @@ module XTwitterScraper
       sig do
         override.returns(
           {
+            auto_topup_amount_dollars: Float,
             auto_topup_enabled: T::Boolean,
-            balance: Integer,
-            lifetime_purchased: Integer,
-            lifetime_used: Integer
+            auto_topup_threshold: String,
+            balance: String,
+            lifetime_purchased: String,
+            lifetime_used: String
           }
         )
       end

data/rbi/x_twitter_scraper/models/{integration_list_deliveries_params.rbi → credit_retrieve_topup_status_params.rbi}

@@ -2,39 +2,31 @@
 
 module XTwitterScraper
   module Models
-    class IntegrationListDeliveriesParams < XTwitterScraper::Internal::Type::BaseModel
+    class CreditRetrieveTopupStatusParams < XTwitterScraper::Internal::Type::BaseModel
       extend XTwitterScraper::Internal::Type::RequestParameters::Converter
       include XTwitterScraper::Internal::Type::RequestParameters
 
       OrHash =
         T.type_alias do
           T.any(
-            XTwitterScraper::IntegrationListDeliveriesParams,
+            XTwitterScraper::CreditRetrieveTopupStatusParams,
             XTwitterScraper::Internal::AnyHash
           )
         end
 
+      # Billing session ID returned by the top-up billing flow.
       sig { returns(String) }
-      attr_accessor :id
-
-      # Maximum number of items to return (1-100, default 50)
-      sig { returns(T.nilable(Integer)) }
-      attr_reader :limit
-
-      sig { params(limit: Integer).void }
-      attr_writer :limit
+      attr_accessor :session_id
 
       sig do
         params(
-          id: String,
-          limit: Integer,
+          session_id: String,
           request_options: XTwitterScraper::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        id:,
-        # Maximum number of items to return (1-100, default 50)
-        limit: nil,
+        # Billing session ID returned by the top-up billing flow.
+        session_id:,
         request_options: {}
       )
       end
@@ -42,8 +34,7 @@ module XTwitterScraper
       sig do
         override.returns(
           {
-            id: String,
-            limit: Integer,
+            session_id: String,
             request_options: XTwitterScraper::RequestOptions
           }
         )