x-twitter-scraper 0.3.0

data/sig/x_twitter_scraper/models/extraction_run_params.rbs

@@ -0,0 +1,138 @@
+module XTwitterScraper
+  module Models
+    type extraction_run_params =
+      {
+        tool_type: XTwitterScraper::Models::ExtractionRunParams::tool_type,
+        advanced_query: String,
+        exact_phrase: String,
+        exclude_words: String,
+        search_query: String,
+        target_community_id: String,
+        target_list_id: String,
+        target_space_id: String,
+        target_tweet_id: String,
+        target_username: String
+      }
+      & XTwitterScraper::Internal::Type::request_parameters
+
+    class ExtractionRunParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      attr_accessor tool_type: XTwitterScraper::Models::ExtractionRunParams::tool_type
+
+      attr_reader advanced_query: String?
+
+      def advanced_query=: (String) -> String
+
+      attr_reader exact_phrase: String?
+
+      def exact_phrase=: (String) -> String
+
+      attr_reader exclude_words: String?
+
+      def exclude_words=: (String) -> String
+
+      attr_reader search_query: String?
+
+      def search_query=: (String) -> String
+
+      attr_reader target_community_id: String?
+
+      def target_community_id=: (String) -> String
+
+      attr_reader target_list_id: String?
+
+      def target_list_id=: (String) -> String
+
+      attr_reader target_space_id: String?
+
+      def target_space_id=: (String) -> String
+
+      attr_reader target_tweet_id: String?
+
+      def target_tweet_id=: (String) -> String
+
+      attr_reader target_username: String?
+
+      def target_username=: (String) -> String
+
+      def initialize: (
+        tool_type: XTwitterScraper::Models::ExtractionRunParams::tool_type,
+        ?advanced_query: String,
+        ?exact_phrase: String,
+        ?exclude_words: String,
+        ?search_query: String,
+        ?target_community_id: String,
+        ?target_list_id: String,
+        ?target_space_id: String,
+        ?target_tweet_id: String,
+        ?target_username: String,
+        ?request_options: XTwitterScraper::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        tool_type: XTwitterScraper::Models::ExtractionRunParams::tool_type,
+        advanced_query: String,
+        exact_phrase: String,
+        exclude_words: String,
+        search_query: String,
+        target_community_id: String,
+        target_list_id: String,
+        target_space_id: String,
+        target_tweet_id: String,
+        target_username: String,
+        request_options: XTwitterScraper::RequestOptions
+      }
+
+      type tool_type =
+        :article_extractor
+        | :community_extractor
+        | :community_moderator_explorer
+        | :community_post_extractor
+        | :community_search
+        | :follower_explorer
+        | :following_explorer
+        | :list_follower_explorer
+        | :list_member_extractor
+        | :list_post_extractor
+        | :mention_extractor
+        | :people_search
+        | :post_extractor
+        | :quote_extractor
+        | :reply_extractor
+        | :repost_extractor
+        | :space_explorer
+        | :thread_extractor
+        | :tweet_search_extractor
+        | :verified_follower_explorer
+
+      module ToolType
+        extend XTwitterScraper::Internal::Type::Enum
+
+        ARTICLE_EXTRACTOR: :article_extractor
+        COMMUNITY_EXTRACTOR: :community_extractor
+        COMMUNITY_MODERATOR_EXPLORER: :community_moderator_explorer
+        COMMUNITY_POST_EXTRACTOR: :community_post_extractor
+        COMMUNITY_SEARCH: :community_search
+        FOLLOWER_EXPLORER: :follower_explorer
+        FOLLOWING_EXPLORER: :following_explorer
+        LIST_FOLLOWER_EXPLORER: :list_follower_explorer
+        LIST_MEMBER_EXTRACTOR: :list_member_extractor
+        LIST_POST_EXTRACTOR: :list_post_extractor
+        MENTION_EXTRACTOR: :mention_extractor
+        PEOPLE_SEARCH: :people_search
+        POST_EXTRACTOR: :post_extractor
+        QUOTE_EXTRACTOR: :quote_extractor
+        REPLY_EXTRACTOR: :reply_extractor
+        REPOST_EXTRACTOR: :repost_extractor
+        SPACE_EXPLORER: :space_explorer
+        THREAD_EXTRACTOR: :thread_extractor
+        TWEET_SEARCH_EXTRACTOR: :tweet_search_extractor
+        VERIFIED_FOLLOWER_EXPLORER: :verified_follower_explorer
+
+        def self?.values: -> ::Array[XTwitterScraper::Models::ExtractionRunParams::tool_type]
+      end
+    end
+  end
+end

data/sig/x_twitter_scraper/models/extraction_run_response.rbs

@@ -0,0 +1,89 @@
+module XTwitterScraper
+  module Models
+    type extraction_run_response =
+      {
+        id: String,
+        status: XTwitterScraper::Models::ExtractionRunResponse::status,
+        tool_type: XTwitterScraper::Models::ExtractionRunResponse::tool_type
+      }
+
+    class ExtractionRunResponse < XTwitterScraper::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor status: XTwitterScraper::Models::ExtractionRunResponse::status
+
+      attr_accessor tool_type: XTwitterScraper::Models::ExtractionRunResponse::tool_type
+
+      def initialize: (
+        id: String,
+        status: XTwitterScraper::Models::ExtractionRunResponse::status,
+        tool_type: XTwitterScraper::Models::ExtractionRunResponse::tool_type
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        status: XTwitterScraper::Models::ExtractionRunResponse::status,
+        tool_type: XTwitterScraper::Models::ExtractionRunResponse::tool_type
+      }
+
+      type status = :running
+
+      module Status
+        extend XTwitterScraper::Internal::Type::Enum
+
+        RUNNING: :running
+
+        def self?.values: -> ::Array[XTwitterScraper::Models::ExtractionRunResponse::status]
+      end
+
+      type tool_type =
+        :article_extractor
+        | :community_extractor
+        | :community_moderator_explorer
+        | :community_post_extractor
+        | :community_search
+        | :follower_explorer
+        | :following_explorer
+        | :list_follower_explorer
+        | :list_member_extractor
+        | :list_post_extractor
+        | :mention_extractor
+        | :people_search
+        | :post_extractor
+        | :quote_extractor
+        | :reply_extractor
+        | :repost_extractor
+        | :space_explorer
+        | :thread_extractor
+        | :tweet_search_extractor
+        | :verified_follower_explorer
+
+      module ToolType
+        extend XTwitterScraper::Internal::Type::Enum
+
+        ARTICLE_EXTRACTOR: :article_extractor
+        COMMUNITY_EXTRACTOR: :community_extractor
+        COMMUNITY_MODERATOR_EXPLORER: :community_moderator_explorer
+        COMMUNITY_POST_EXTRACTOR: :community_post_extractor
+        COMMUNITY_SEARCH: :community_search
+        FOLLOWER_EXPLORER: :follower_explorer
+        FOLLOWING_EXPLORER: :following_explorer
+        LIST_FOLLOWER_EXPLORER: :list_follower_explorer
+        LIST_MEMBER_EXTRACTOR: :list_member_extractor
+        LIST_POST_EXTRACTOR: :list_post_extractor
+        MENTION_EXTRACTOR: :mention_extractor
+        PEOPLE_SEARCH: :people_search
+        POST_EXTRACTOR: :post_extractor
+        QUOTE_EXTRACTOR: :quote_extractor
+        REPLY_EXTRACTOR: :reply_extractor
+        REPOST_EXTRACTOR: :repost_extractor
+        SPACE_EXPLORER: :space_explorer
+        THREAD_EXTRACTOR: :thread_extractor
+        TWEET_SEARCH_EXTRACTOR: :tweet_search_extractor
+        VERIFIED_FOLLOWER_EXPLORER: :verified_follower_explorer
+
+        def self?.values: -> ::Array[XTwitterScraper::Models::ExtractionRunResponse::tool_type]
+      end
+    end
+  end
+end

data/sig/x_twitter_scraper/models/integration.rbs

@@ -0,0 +1,109 @@
+module XTwitterScraper
+  module Models
+    type integration =
+      {
+        id: String,
+        config: ::Hash[Symbol, top],
+        created_at: Time,
+        event_types: ::Array[XTwitterScraper::Models::Integration::event_type],
+        is_active: bool,
+        name: String,
+        type: XTwitterScraper::Models::Integration::type_,
+        filters: ::Hash[Symbol, top],
+        message_template: String,
+        scope_all_monitors: bool,
+        silent_push: bool
+      }
+
+    class Integration < XTwitterScraper::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor config: ::Hash[Symbol, top]
+
+      attr_accessor created_at: Time
+
+      attr_accessor event_types: ::Array[XTwitterScraper::Models::Integration::event_type]
+
+      attr_accessor is_active: bool
+
+      attr_accessor name: String
+
+      attr_accessor type: XTwitterScraper::Models::Integration::type_
+
+      attr_reader filters: ::Hash[Symbol, top]?
+
+      def filters=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+      attr_reader message_template: String?
+
+      def message_template=: (String) -> String
+
+      attr_reader scope_all_monitors: bool?
+
+      def scope_all_monitors=: (bool) -> bool
+
+      attr_reader silent_push: bool?
+
+      def silent_push=: (bool) -> bool
+
+      def initialize: (
+        id: String,
+        config: ::Hash[Symbol, top],
+        created_at: Time,
+        event_types: ::Array[XTwitterScraper::Models::Integration::event_type],
+        is_active: bool,
+        name: String,
+        type: XTwitterScraper::Models::Integration::type_,
+        ?filters: ::Hash[Symbol, top],
+        ?message_template: String,
+        ?scope_all_monitors: bool,
+        ?silent_push: bool
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        config: ::Hash[Symbol, top],
+        created_at: Time,
+        event_types: ::Array[XTwitterScraper::Models::Integration::event_type],
+        is_active: bool,
+        name: String,
+        type: XTwitterScraper::Models::Integration::type_,
+        filters: ::Hash[Symbol, top],
+        message_template: String,
+        scope_all_monitors: bool,
+        silent_push: bool
+      }
+
+      type event_type =
+        :"tweet.new"
+        | :"tweet.reply"
+        | :"tweet.retweet"
+        | :"tweet.quote"
+        | :"follower.gained"
+        | :"follower.lost"
+
+      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"
+
+        def self?.values: -> ::Array[XTwitterScraper::Models::Integration::event_type]
+      end
+
+      type type_ = :telegram
+
+      module Type
+        extend XTwitterScraper::Internal::Type::Enum
+
+        TELEGRAM: :telegram
+
+        def self?.values: -> ::Array[XTwitterScraper::Models::Integration::type_]
+      end
+    end
+  end
+end

data/sig/x_twitter_scraper/models/integration_create_params.rbs

@@ -0,0 +1,82 @@
+module XTwitterScraper
+  module Models
+    type integration_create_params =
+      {
+        config: XTwitterScraper::IntegrationCreateParams::Config,
+        event_types: ::Array[XTwitterScraper::Models::IntegrationCreateParams::event_type],
+        name: String,
+        type: XTwitterScraper::Models::IntegrationCreateParams::type_
+      }
+      & XTwitterScraper::Internal::Type::request_parameters
+
+    class IntegrationCreateParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      attr_accessor config: XTwitterScraper::IntegrationCreateParams::Config
+
+      attr_accessor event_types: ::Array[XTwitterScraper::Models::IntegrationCreateParams::event_type]
+
+      attr_accessor name: String
+
+      attr_accessor type: XTwitterScraper::Models::IntegrationCreateParams::type_
+
+      def initialize: (
+        config: XTwitterScraper::IntegrationCreateParams::Config,
+        event_types: ::Array[XTwitterScraper::Models::IntegrationCreateParams::event_type],
+        name: String,
+        type: XTwitterScraper::Models::IntegrationCreateParams::type_,
+        ?request_options: XTwitterScraper::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        config: XTwitterScraper::IntegrationCreateParams::Config,
+        event_types: ::Array[XTwitterScraper::Models::IntegrationCreateParams::event_type],
+        name: String,
+        type: XTwitterScraper::Models::IntegrationCreateParams::type_,
+        request_options: XTwitterScraper::RequestOptions
+      }
+
+      type config = { chat_id: String }
+
+      class Config < XTwitterScraper::Internal::Type::BaseModel
+        attr_accessor chat_id: String
+
+        def initialize: (chat_id: String) -> void
+
+        def to_hash: -> { chat_id: String }
+      end
+
+      type event_type =
+        :"tweet.new"
+        | :"tweet.reply"
+        | :"tweet.retweet"
+        | :"tweet.quote"
+        | :"follower.gained"
+        | :"follower.lost"
+
+      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"
+
+        def self?.values: -> ::Array[XTwitterScraper::Models::IntegrationCreateParams::event_type]
+      end
+
+      type type_ = :telegram
+
+      module Type
+        extend XTwitterScraper::Internal::Type::Enum
+
+        TELEGRAM: :telegram
+
+        def self?.values: -> ::Array[XTwitterScraper::Models::IntegrationCreateParams::type_]
+      end
+    end
+  end
+end

data/sig/x_twitter_scraper/models/integration_create_response.rbs

@@ -0,0 +1,109 @@
+module XTwitterScraper
+  module Models
+    type integration_create_response =
+      {
+        id: String,
+        config: ::Hash[Symbol, top],
+        created_at: Time,
+        event_types: ::Array[XTwitterScraper::Models::IntegrationCreateResponse::event_type],
+        is_active: bool,
+        name: String,
+        type: XTwitterScraper::Models::IntegrationCreateResponse::type_,
+        filters: ::Hash[Symbol, top],
+        message_template: String,
+        scope_all_monitors: bool,
+        silent_push: bool
+      }
+
+    class IntegrationCreateResponse < XTwitterScraper::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor config: ::Hash[Symbol, top]
+
+      attr_accessor created_at: Time
+
+      attr_accessor event_types: ::Array[XTwitterScraper::Models::IntegrationCreateResponse::event_type]
+
+      attr_accessor is_active: bool
+
+      attr_accessor name: String
+
+      attr_accessor type: XTwitterScraper::Models::IntegrationCreateResponse::type_
+
+      attr_reader filters: ::Hash[Symbol, top]?
+
+      def filters=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+      attr_reader message_template: String?
+
+      def message_template=: (String) -> String
+
+      attr_reader scope_all_monitors: bool?
+
+      def scope_all_monitors=: (bool) -> bool
+
+      attr_reader silent_push: bool?
+
+      def silent_push=: (bool) -> bool
+
+      def initialize: (
+        id: String,
+        config: ::Hash[Symbol, top],
+        created_at: Time,
+        event_types: ::Array[XTwitterScraper::Models::IntegrationCreateResponse::event_type],
+        is_active: bool,
+        name: String,
+        type: XTwitterScraper::Models::IntegrationCreateResponse::type_,
+        ?filters: ::Hash[Symbol, top],
+        ?message_template: String,
+        ?scope_all_monitors: bool,
+        ?silent_push: bool
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        config: ::Hash[Symbol, top],
+        created_at: Time,
+        event_types: ::Array[XTwitterScraper::Models::IntegrationCreateResponse::event_type],
+        is_active: bool,
+        name: String,
+        type: XTwitterScraper::Models::IntegrationCreateResponse::type_,
+        filters: ::Hash[Symbol, top],
+        message_template: String,
+        scope_all_monitors: bool,
+        silent_push: bool
+      }
+
+      type event_type =
+        :"tweet.new"
+        | :"tweet.reply"
+        | :"tweet.retweet"
+        | :"tweet.quote"
+        | :"follower.gained"
+        | :"follower.lost"
+
+      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"
+
+        def self?.values: -> ::Array[XTwitterScraper::Models::IntegrationCreateResponse::event_type]
+      end
+
+      type type_ = :telegram
+
+      module Type
+        extend XTwitterScraper::Internal::Type::Enum
+
+        TELEGRAM: :telegram
+
+        def self?.values: -> ::Array[XTwitterScraper::Models::IntegrationCreateResponse::type_]
+      end
+    end
+  end
+end

data/sig/x_twitter_scraper/models/integration_delete_params.rbs

@@ -0,0 +1,23 @@
+module XTwitterScraper
+  module Models
+    type integration_delete_params =
+      { id: String } & XTwitterScraper::Internal::Type::request_parameters
+
+    class IntegrationDeleteParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      attr_accessor id: String
+
+      def initialize: (
+        id: String,
+        ?request_options: XTwitterScraper::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        request_options: XTwitterScraper::RequestOptions
+      }
+    end
+  end
+end

data/sig/x_twitter_scraper/models/integration_delete_response.rbs

@@ -0,0 +1,13 @@
+module XTwitterScraper
+  module Models
+    type integration_delete_response = { success: true }
+
+    class IntegrationDeleteResponse < XTwitterScraper::Internal::Type::BaseModel
+      attr_accessor success: true
+
+      def initialize: (?success: true) -> void
+
+      def to_hash: -> { success: true }
+    end
+  end
+end

data/sig/x_twitter_scraper/models/integration_delivery.rbs

@@ -0,0 +1,75 @@
+module XTwitterScraper
+  module Models
+    type integration_delivery =
+      {
+        id: String,
+        attempts: Integer,
+        created_at: Time,
+        event_type: String,
+        status: String,
+        delivered_at: Time,
+        last_error: String,
+        last_status_code: Integer,
+        source_id: String,
+        source_type: String
+      }
+
+    class IntegrationDelivery < XTwitterScraper::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor attempts: Integer
+
+      attr_accessor created_at: Time
+
+      attr_accessor event_type: String
+
+      attr_accessor status: String
+
+      attr_reader delivered_at: Time?
+
+      def delivered_at=: (Time) -> Time
+
+      attr_reader last_error: String?
+
+      def last_error=: (String) -> String
+
+      attr_reader last_status_code: Integer?
+
+      def last_status_code=: (Integer) -> Integer
+
+      attr_reader source_id: String?
+
+      def source_id=: (String) -> String
+
+      attr_reader source_type: String?
+
+      def source_type=: (String) -> String
+
+      def initialize: (
+        id: String,
+        attempts: Integer,
+        created_at: Time,
+        event_type: String,
+        status: String,
+        ?delivered_at: Time,
+        ?last_error: String,
+        ?last_status_code: Integer,
+        ?source_id: String,
+        ?source_type: String
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        attempts: Integer,
+        created_at: Time,
+        event_type: String,
+        status: String,
+        delivered_at: Time,
+        last_error: String,
+        last_status_code: Integer,
+        source_id: String,
+        source_type: String
+      }
+    end
+  end
+end

data/sig/x_twitter_scraper/models/integration_list_deliveries_params.rbs

@@ -0,0 +1,30 @@
+module XTwitterScraper
+  module Models
+    type integration_list_deliveries_params =
+      { id: String, limit: Integer }
+      & XTwitterScraper::Internal::Type::request_parameters
+
+    class IntegrationListDeliveriesParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      attr_accessor id: String
+
+      attr_reader limit: Integer?
+
+      def limit=: (Integer) -> Integer
+
+      def initialize: (
+        id: String,
+        ?limit: Integer,
+        ?request_options: XTwitterScraper::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        limit: Integer,
+        request_options: XTwitterScraper::RequestOptions
+      }
+    end
+  end
+end