x-twitter-scraper 0.3.0 → 0.4.1

data/lib/x_twitter_scraper/models/integration_create_params.rb

@@ -14,12 +14,11 @@ module XTwitterScraper
       required :config, -> { XTwitterScraper::IntegrationCreateParams::Config }
 
       # @!attribute event_types
+      #   Array of event types to subscribe to.
       #
-      #   @return [Array<Symbol, XTwitterScraper::Models::IntegrationCreateParams::EventType>]
+      #   @return [Array<Symbol, XTwitterScraper::Models::EventType>]
       required :event_types,
-               -> {
-                 XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::IntegrationCreateParams::EventType]
-               },
+               -> { XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::EventType] },
                api_name: :eventTypes
 
       # @!attribute name
@@ -29,17 +28,17 @@ module XTwitterScraper
 
       # @!attribute type
       #
-      #   @return [Symbol, XTwitterScraper::Models::IntegrationCreateParams::Type]
-      required :type, enum: -> { XTwitterScraper::IntegrationCreateParams::Type }
+      #   @return [Symbol, :telegram]
+      required :type, const: :telegram
 
-      # @!method initialize(config:, event_types:, name:, type:, request_options: {})
+      # @!method initialize(config:, event_types:, name:, type: :telegram, request_options: {})
       #   @param config [XTwitterScraper::Models::IntegrationCreateParams::Config] Integration config (e.g. Telegram chatId)
       #
-      #   @param event_types [Array<Symbol, XTwitterScraper::Models::IntegrationCreateParams::EventType>]
+      #   @param event_types [Array<Symbol, XTwitterScraper::Models::EventType>] Array of event types to subscribe to.
       #
       #   @param name [String]
       #
-      #   @param type [Symbol, XTwitterScraper::Models::IntegrationCreateParams::Type]
+      #   @param type [Symbol, :telegram]
       #
       #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
 
@@ -54,29 +53,6 @@ module XTwitterScraper
         #
         #   @param chat_id [String]
       end
-
-      module EventType
-        extend XTwitterScraper::Internal::Type::Enum
-
-        TWEET_NEW = :"tweet.new"
-        TWEET_REPLY = :"tweet.reply"
-        TWEET_RETWEET = :"tweet.retweet"
-        TWEET_QUOTE = :"tweet.quote"
-        FOLLOWER_GAINED = :"follower.gained"
-        FOLLOWER_LOST = :"follower.lost"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      module Type
-        extend XTwitterScraper::Internal::Type::Enum
-
-        TELEGRAM = :telegram
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/x_twitter_scraper/models/integration_delivery.rb

@@ -54,6 +54,8 @@ module XTwitterScraper
       optional :source_type, String, api_name: :sourceType
 
       # @!method initialize(id:, attempts:, created_at:, event_type:, status:, delivered_at: nil, last_error: nil, last_status_code: nil, source_id: nil, source_type: nil)
+      #   Integration delivery attempt record with status and retry count.
+      #
       #   @param id [String]
       #   @param attempts [Integer]
       #   @param created_at [Time]

data/lib/x_twitter_scraper/models/integration_list_deliveries_params.rb

@@ -13,13 +13,16 @@ module XTwitterScraper
       required :id, String
 
       # @!attribute limit
+      #   Maximum number of items to return (1-100, default 50)
       #
       #   @return [Integer, nil]
       optional :limit, Integer
 
       # @!method initialize(id:, limit: nil, request_options: {})
       #   @param id [String]
-      #   @param limit [Integer]
+      #
+      #   @param limit [Integer] Maximum number of items to return (1-100, default 50)
+      #
       #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/x_twitter_scraper/models/integration_list_deliveries_response.rb

@@ -6,76 +6,12 @@ module XTwitterScraper
     class IntegrationListDeliveriesResponse < XTwitterScraper::Internal::Type::BaseModel
       # @!attribute deliveries
       #
-      #   @return [Array<XTwitterScraper::Models::IntegrationListDeliveriesResponse::Delivery>]
+      #   @return [Array<XTwitterScraper::Models::IntegrationDelivery>]
       required :deliveries,
-               -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::IntegrationListDeliveriesResponse::Delivery] }
+               -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::IntegrationDelivery] }
 
       # @!method initialize(deliveries:)
-      #   @param deliveries [Array<XTwitterScraper::Models::IntegrationListDeliveriesResponse::Delivery>]
-
-      class Delivery < XTwitterScraper::Internal::Type::BaseModel
-        # @!attribute id
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute attempts
-        #
-        #   @return [Integer]
-        required :attempts, Integer
-
-        # @!attribute created_at
-        #
-        #   @return [Time]
-        required :created_at, Time, api_name: :createdAt
-
-        # @!attribute event_type
-        #
-        #   @return [String]
-        required :event_type, String, api_name: :eventType
-
-        # @!attribute status
-        #
-        #   @return [String]
-        required :status, String
-
-        # @!attribute delivered_at
-        #
-        #   @return [Time, nil]
-        optional :delivered_at, Time, api_name: :deliveredAt
-
-        # @!attribute last_error
-        #
-        #   @return [String, nil]
-        optional :last_error, String, api_name: :lastError
-
-        # @!attribute last_status_code
-        #
-        #   @return [Integer, nil]
-        optional :last_status_code, Integer, api_name: :lastStatusCode
-
-        # @!attribute source_id
-        #
-        #   @return [String, nil]
-        optional :source_id, String, api_name: :sourceId
-
-        # @!attribute source_type
-        #
-        #   @return [String, nil]
-        optional :source_type, String, api_name: :sourceType
-
-        # @!method initialize(id:, attempts:, created_at:, event_type:, status:, delivered_at: nil, last_error: nil, last_status_code: nil, source_id: nil, source_type: nil)
-        #   @param id [String]
-        #   @param attempts [Integer]
-        #   @param created_at [Time]
-        #   @param event_type [String]
-        #   @param status [String]
-        #   @param delivered_at [Time]
-        #   @param last_error [String]
-        #   @param last_status_code [Integer]
-        #   @param source_id [String]
-        #   @param source_type [String]
-      end
+      #   @param deliveries [Array<XTwitterScraper::Models::IntegrationDelivery>]
     end
   end
 end

data/lib/x_twitter_scraper/models/integration_list_response.rb

@@ -6,120 +6,11 @@ module XTwitterScraper
     class IntegrationListResponse < XTwitterScraper::Internal::Type::BaseModel
       # @!attribute integrations
       #
-      #   @return [Array<XTwitterScraper::Models::IntegrationListResponse::Integration>]
-      required :integrations,
-               -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::IntegrationListResponse::Integration] }
+      #   @return [Array<XTwitterScraper::Models::Integration>]
+      required :integrations, -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Integration] }
 
       # @!method initialize(integrations:)
-      #   @param integrations [Array<XTwitterScraper::Models::IntegrationListResponse::Integration>]
-
-      class Integration < XTwitterScraper::Internal::Type::BaseModel
-        # @!attribute id
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute config
-        #   Integration config — shape varies by type (JSON)
-        #
-        #   @return [Hash{Symbol=>Object}]
-        required :config, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]
-
-        # @!attribute created_at
-        #
-        #   @return [Time]
-        required :created_at, Time, api_name: :createdAt
-
-        # @!attribute event_types
-        #
-        #   @return [Array<Symbol, XTwitterScraper::Models::IntegrationListResponse::Integration::EventType>]
-        required :event_types,
-                 -> { XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::Models::IntegrationListResponse::Integration::EventType] },
-                 api_name: :eventTypes
-
-        # @!attribute is_active
-        #
-        #   @return [Boolean]
-        required :is_active, XTwitterScraper::Internal::Type::Boolean, api_name: :isActive
-
-        # @!attribute name
-        #
-        #   @return [String]
-        required :name, String
-
-        # @!attribute type
-        #
-        #   @return [Symbol, XTwitterScraper::Models::IntegrationListResponse::Integration::Type]
-        required :type, enum: -> { XTwitterScraper::Models::IntegrationListResponse::Integration::Type }
-
-        # @!attribute filters
-        #   Event filter rules (JSON)
-        #
-        #   @return [Hash{Symbol=>Object}, nil]
-        optional :filters, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]
-
-        # @!attribute message_template
-        #
-        #   @return [String, nil]
-        optional :message_template, String, api_name: :messageTemplate
-
-        # @!attribute scope_all_monitors
-        #
-        #   @return [Boolean, nil]
-        optional :scope_all_monitors, XTwitterScraper::Internal::Type::Boolean, api_name: :scopeAllMonitors
-
-        # @!attribute silent_push
-        #
-        #   @return [Boolean, nil]
-        optional :silent_push, XTwitterScraper::Internal::Type::Boolean, api_name: :silentPush
-
-        # @!method initialize(id:, config:, created_at:, event_types:, is_active:, name:, type:, filters: nil, message_template: nil, scope_all_monitors: nil, silent_push: nil)
-        #   @param id [String]
-        #
-        #   @param config [Hash{Symbol=>Object}] Integration config — shape varies by type (JSON)
-        #
-        #   @param created_at [Time]
-        #
-        #   @param event_types [Array<Symbol, XTwitterScraper::Models::IntegrationListResponse::Integration::EventType>]
-        #
-        #   @param is_active [Boolean]
-        #
-        #   @param name [String]
-        #
-        #   @param type [Symbol, XTwitterScraper::Models::IntegrationListResponse::Integration::Type]
-        #
-        #   @param filters [Hash{Symbol=>Object}] Event filter rules (JSON)
-        #
-        #   @param message_template [String]
-        #
-        #   @param scope_all_monitors [Boolean]
-        #
-        #   @param silent_push [Boolean]
-
-        module EventType
-          extend XTwitterScraper::Internal::Type::Enum
-
-          TWEET_NEW = :"tweet.new"
-          TWEET_REPLY = :"tweet.reply"
-          TWEET_RETWEET = :"tweet.retweet"
-          TWEET_QUOTE = :"tweet.quote"
-          FOLLOWER_GAINED = :"follower.gained"
-          FOLLOWER_LOST = :"follower.lost"
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # @see XTwitterScraper::Models::IntegrationListResponse::Integration#type
-        module Type
-          extend XTwitterScraper::Internal::Type::Enum
-
-          TELEGRAM = :telegram
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
+      #   @param integrations [Array<XTwitterScraper::Models::Integration>]
     end
   end
 end

data/lib/x_twitter_scraper/models/integration_update_params.rb

@@ -13,12 +13,11 @@ module XTwitterScraper
       required :id, String
 
       # @!attribute event_types
+      #   Array of event types to subscribe to.
       #
-      #   @return [Array<Symbol, XTwitterScraper::Models::IntegrationUpdateParams::EventType>, nil]
+      #   @return [Array<Symbol, XTwitterScraper::Models::EventType>, nil]
       optional :event_types,
-               -> {
-                 XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::IntegrationUpdateParams::EventType]
-               },
+               -> { XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::EventType] },
                api_name: :eventTypes
 
       # @!attribute filters
@@ -58,7 +57,7 @@ module XTwitterScraper
       # @!method initialize(id:, event_types: nil, filters: nil, is_active: nil, message_template: nil, name: nil, scope_all_monitors: nil, silent_push: nil, request_options: {})
       #   @param id [String]
       #
-      #   @param event_types [Array<Symbol, XTwitterScraper::Models::IntegrationUpdateParams::EventType>]
+      #   @param event_types [Array<Symbol, XTwitterScraper::Models::EventType>] Array of event types to subscribe to.
       #
       #   @param filters [Hash{Symbol=>Object}] Event filter rules (JSON)
       #
@@ -73,20 +72,6 @@ module XTwitterScraper
       #   @param silent_push [Boolean]
       #
       #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
-
-      module EventType
-        extend XTwitterScraper::Internal::Type::Enum
-
-        TWEET_NEW = :"tweet.new"
-        TWEET_REPLY = :"tweet.reply"
-        TWEET_RETWEET = :"tweet.retweet"
-        TWEET_QUOTE = :"tweet.quote"
-        FOLLOWER_GAINED = :"follower.gained"
-        FOLLOWER_LOST = :"follower.lost"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/x_twitter_scraper/models/monitor.rb

@@ -2,6 +2,7 @@
 
 module XTwitterScraper
   module Models
+    # @see XTwitterScraper::Resources::Monitors#retrieve
     class Monitor < XTwitterScraper::Internal::Type::BaseModel
       # @!attribute id
       #
@@ -14,10 +15,11 @@ module XTwitterScraper
       required :created_at, Time, api_name: :createdAt
 
       # @!attribute event_types
+      #   Array of event types to subscribe to.
       #
-      #   @return [Array<Symbol, XTwitterScraper::Models::Monitor::EventType>]
+      #   @return [Array<Symbol, XTwitterScraper::Models::EventType>]
       required :event_types,
-               -> { XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::Monitor::EventType] },
+               -> { XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::EventType] },
                api_name: :eventTypes
 
       # @!attribute is_active
@@ -36,26 +38,19 @@ module XTwitterScraper
       required :x_user_id, String, api_name: :xUserId
 
       # @!method initialize(id:, created_at:, event_types:, is_active:, username:, x_user_id:)
+      #   Account monitor that tracks activity for a given X user.
+      #
       #   @param id [String]
+      #
       #   @param created_at [Time]
-      #   @param event_types [Array<Symbol, XTwitterScraper::Models::Monitor::EventType>]
+      #
+      #   @param event_types [Array<Symbol, XTwitterScraper::Models::EventType>] Array of event types to subscribe to.
+      #
       #   @param is_active [Boolean]
+      #
       #   @param username [String]
+      #
       #   @param x_user_id [String]
-
-      module EventType
-        extend XTwitterScraper::Internal::Type::Enum
-
-        TWEET_NEW = :"tweet.new"
-        TWEET_REPLY = :"tweet.reply"
-        TWEET_RETWEET = :"tweet.retweet"
-        TWEET_QUOTE = :"tweet.quote"
-        FOLLOWER_GAINED = :"follower.gained"
-        FOLLOWER_LOST = :"follower.lost"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/x_twitter_scraper/models/monitor_create_params.rb

@@ -8,12 +8,11 @@ module XTwitterScraper
       include XTwitterScraper::Internal::Type::RequestParameters
 
       # @!attribute event_types
+      #   Array of event types to subscribe to.
       #
-      #   @return [Array<Symbol, XTwitterScraper::Models::MonitorCreateParams::EventType>]
+      #   @return [Array<Symbol, XTwitterScraper::Models::EventType>]
       required :event_types,
-               -> {
-                 XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::MonitorCreateParams::EventType]
-               },
+               -> { XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::EventType] },
                api_name: :eventTypes
 
       # @!attribute username
@@ -23,25 +22,11 @@ module XTwitterScraper
       required :username, String
 
       # @!method initialize(event_types:, username:, request_options: {})
-      #   @param event_types [Array<Symbol, XTwitterScraper::Models::MonitorCreateParams::EventType>]
+      #   @param event_types [Array<Symbol, XTwitterScraper::Models::EventType>] Array of event types to subscribe to.
       #
       #   @param username [String] X username (without @)
       #
       #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
-
-      module EventType
-        extend XTwitterScraper::Internal::Type::Enum
-
-        TWEET_NEW = :"tweet.new"
-        TWEET_REPLY = :"tweet.reply"
-        TWEET_RETWEET = :"tweet.retweet"
-        TWEET_QUOTE = :"tweet.quote"
-        FOLLOWER_GAINED = :"follower.gained"
-        FOLLOWER_LOST = :"follower.lost"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/x_twitter_scraper/models/monitor_create_response.rb

@@ -15,10 +15,11 @@ module XTwitterScraper
       required :created_at, Time, api_name: :createdAt
 
       # @!attribute event_types
+      #   Array of event types to subscribe to.
       #
-      #   @return [Array<Symbol, XTwitterScraper::Models::MonitorCreateResponse::EventType>]
+      #   @return [Array<Symbol, XTwitterScraper::Models::EventType>]
       required :event_types,
-               -> { XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::Models::MonitorCreateResponse::EventType] },
+               -> { XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::EventType] },
                api_name: :eventTypes
 
       # @!attribute username
@@ -33,24 +34,14 @@ module XTwitterScraper
 
       # @!method initialize(id:, created_at:, event_types:, username:, x_user_id:)
       #   @param id [String]
+      #
       #   @param created_at [Time]
-      #   @param event_types [Array<Symbol, XTwitterScraper::Models::MonitorCreateResponse::EventType>]
+      #
+      #   @param event_types [Array<Symbol, XTwitterScraper::Models::EventType>] Array of event types to subscribe to.
+      #
       #   @param username [String]
+      #
       #   @param x_user_id [String]
-
-      module EventType
-        extend XTwitterScraper::Internal::Type::Enum
-
-        TWEET_NEW = :"tweet.new"
-        TWEET_REPLY = :"tweet.reply"
-        TWEET_RETWEET = :"tweet.retweet"
-        TWEET_QUOTE = :"tweet.quote"
-        FOLLOWER_GAINED = :"follower.gained"
-        FOLLOWER_LOST = :"follower.lost"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/x_twitter_scraper/models/monitor_list_response.rb

@@ -6,9 +6,8 @@ module XTwitterScraper
     class MonitorListResponse < XTwitterScraper::Internal::Type::BaseModel
       # @!attribute monitors
       #
-      #   @return [Array<XTwitterScraper::Models::MonitorListResponse::Monitor>]
-      required :monitors,
-               -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::MonitorListResponse::Monitor] }
+      #   @return [Array<XTwitterScraper::Models::Monitor>]
+      required :monitors, -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Monitor] }
 
       # @!attribute total
       #
@@ -16,64 +15,8 @@ module XTwitterScraper
       required :total, Integer
 
       # @!method initialize(monitors:, total:)
-      #   @param monitors [Array<XTwitterScraper::Models::MonitorListResponse::Monitor>]
+      #   @param monitors [Array<XTwitterScraper::Models::Monitor>]
       #   @param total [Integer]
-
-      class Monitor < 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
-        #
-        #   @return [Array<Symbol, XTwitterScraper::Models::MonitorListResponse::Monitor::EventType>]
-        required :event_types,
-                 -> { XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::Models::MonitorListResponse::Monitor::EventType] },
-                 api_name: :eventTypes
-
-        # @!attribute is_active
-        #
-        #   @return [Boolean]
-        required :is_active, XTwitterScraper::Internal::Type::Boolean, api_name: :isActive
-
-        # @!attribute username
-        #
-        #   @return [String]
-        required :username, String
-
-        # @!attribute x_user_id
-        #
-        #   @return [String]
-        required :x_user_id, String, api_name: :xUserId
-
-        # @!method initialize(id:, created_at:, event_types:, is_active:, username:, x_user_id:)
-        #   @param id [String]
-        #   @param created_at [Time]
-        #   @param event_types [Array<Symbol, XTwitterScraper::Models::MonitorListResponse::Monitor::EventType>]
-        #   @param is_active [Boolean]
-        #   @param username [String]
-        #   @param x_user_id [String]
-
-        module EventType
-          extend XTwitterScraper::Internal::Type::Enum
-
-          TWEET_NEW = :"tweet.new"
-          TWEET_REPLY = :"tweet.reply"
-          TWEET_RETWEET = :"tweet.retweet"
-          TWEET_QUOTE = :"tweet.quote"
-          FOLLOWER_GAINED = :"follower.gained"
-          FOLLOWER_LOST = :"follower.lost"
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
     end
   end
 end

data/lib/x_twitter_scraper/models/monitor_update_params.rb

@@ -13,12 +13,11 @@ module XTwitterScraper
       required :id, String
 
       # @!attribute event_types
+      #   Array of event types to subscribe to.
       #
-      #   @return [Array<Symbol, XTwitterScraper::Models::MonitorUpdateParams::EventType>, nil]
+      #   @return [Array<Symbol, XTwitterScraper::Models::EventType>, nil]
       optional :event_types,
-               -> {
-                 XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::MonitorUpdateParams::EventType]
-               },
+               -> { XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::EventType] },
                api_name: :eventTypes
 
       # @!attribute is_active
@@ -28,23 +27,12 @@ module XTwitterScraper
 
       # @!method initialize(id:, event_types: nil, is_active: nil, request_options: {})
       #   @param id [String]
-      #   @param event_types [Array<Symbol, XTwitterScraper::Models::MonitorUpdateParams::EventType>]
+      #
+      #   @param event_types [Array<Symbol, XTwitterScraper::Models::EventType>] Array of event types to subscribe to.
+      #
       #   @param is_active [Boolean]
+      #
       #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
-
-      module EventType
-        extend XTwitterScraper::Internal::Type::Enum
-
-        TWEET_NEW = :"tweet.new"
-        TWEET_REPLY = :"tweet.reply"
-        TWEET_RETWEET = :"tweet.retweet"
-        TWEET_QUOTE = :"tweet.quote"
-        FOLLOWER_GAINED = :"follower.gained"
-        FOLLOWER_LOST = :"follower.lost"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end