x-twitter-scraper 0.3.0

data/sig/x_twitter_scraper/models/extraction_estimate_cost_params.rbs

@@ -0,0 +1,138 @@
+module XTwitterScraper
+  module Models
+    type extraction_estimate_cost_params =
+      {
+        tool_type: XTwitterScraper::Models::ExtractionEstimateCostParams::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 ExtractionEstimateCostParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      attr_accessor tool_type: XTwitterScraper::Models::ExtractionEstimateCostParams::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::ExtractionEstimateCostParams::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::ExtractionEstimateCostParams::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::ExtractionEstimateCostParams::tool_type]
+      end
+    end
+  end
+end

data/sig/x_twitter_scraper/models/extraction_estimate_cost_response.rbs

@@ -0,0 +1,40 @@
+module XTwitterScraper
+  module Models
+    type extraction_estimate_cost_response =
+      {
+        allowed: bool,
+        estimated_results: Integer,
+        projected_percent: Float,
+        source: String,
+        usage_percent: Float
+      }
+
+    class ExtractionEstimateCostResponse < XTwitterScraper::Internal::Type::BaseModel
+      attr_accessor allowed: bool
+
+      attr_accessor estimated_results: Integer
+
+      attr_accessor projected_percent: Float
+
+      attr_accessor source: String
+
+      attr_accessor usage_percent: Float
+
+      def initialize: (
+        allowed: bool,
+        estimated_results: Integer,
+        projected_percent: Float,
+        source: String,
+        usage_percent: Float
+      ) -> void
+
+      def to_hash: -> {
+        allowed: bool,
+        estimated_results: Integer,
+        projected_percent: Float,
+        source: String,
+        usage_percent: Float
+      }
+    end
+  end
+end

data/sig/x_twitter_scraper/models/extraction_export_results_params.rbs

@@ -0,0 +1,51 @@
+module XTwitterScraper
+  module Models
+    type extraction_export_results_params =
+      {
+        id: String,
+        format_: XTwitterScraper::Models::ExtractionExportResultsParams::format_
+      }
+      & XTwitterScraper::Internal::Type::request_parameters
+
+    class ExtractionExportResultsParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      attr_accessor id: String
+
+      attr_reader format_: XTwitterScraper::Models::ExtractionExportResultsParams::format_?
+
+      def format_=: (
+        XTwitterScraper::Models::ExtractionExportResultsParams::format_
+      ) -> XTwitterScraper::Models::ExtractionExportResultsParams::format_
+
+      def initialize: (
+        id: String,
+        ?format_: XTwitterScraper::Models::ExtractionExportResultsParams::format_,
+        ?request_options: XTwitterScraper::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        format_: XTwitterScraper::Models::ExtractionExportResultsParams::format_,
+        request_options: XTwitterScraper::RequestOptions
+      }
+
+      type format_ = :csv | :json | :md | :"md-document" | :pdf | :txt | :xlsx
+
+      module Format
+        extend XTwitterScraper::Internal::Type::Enum
+
+        CSV: :csv
+        JSON: :json
+        MD: :md
+        MD_DOCUMENT: :"md-document"
+        PDF: :pdf
+        TXT: :txt
+        XLSX: :xlsx
+
+        def self?.values: -> ::Array[XTwitterScraper::Models::ExtractionExportResultsParams::format_]
+      end
+    end
+  end
+end

data/sig/x_twitter_scraper/models/extraction_job.rbs

@@ -0,0 +1,108 @@
+module XTwitterScraper
+  module Models
+    type extraction_job =
+      {
+        id: String,
+        created_at: Time,
+        status: XTwitterScraper::Models::ExtractionJob::status,
+        tool_type: XTwitterScraper::Models::ExtractionJob::tool_type,
+        total_results: Integer,
+        completed_at: Time
+      }
+
+    class ExtractionJob < XTwitterScraper::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor status: XTwitterScraper::Models::ExtractionJob::status
+
+      attr_accessor tool_type: XTwitterScraper::Models::ExtractionJob::tool_type
+
+      attr_accessor total_results: Integer
+
+      attr_reader completed_at: Time?
+
+      def completed_at=: (Time) -> Time
+
+      def initialize: (
+        id: String,
+        created_at: Time,
+        status: XTwitterScraper::Models::ExtractionJob::status,
+        tool_type: XTwitterScraper::Models::ExtractionJob::tool_type,
+        total_results: Integer,
+        ?completed_at: Time
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created_at: Time,
+        status: XTwitterScraper::Models::ExtractionJob::status,
+        tool_type: XTwitterScraper::Models::ExtractionJob::tool_type,
+        total_results: Integer,
+        completed_at: Time
+      }
+
+      type status = :running | :completed | :failed
+
+      module Status
+        extend XTwitterScraper::Internal::Type::Enum
+
+        RUNNING: :running
+        COMPLETED: :completed
+        FAILED: :failed
+
+        def self?.values: -> ::Array[XTwitterScraper::Models::ExtractionJob::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::ExtractionJob::tool_type]
+      end
+    end
+  end
+end

data/sig/x_twitter_scraper/models/extraction_list_params.rbs

@@ -0,0 +1,114 @@
+module XTwitterScraper
+  module Models
+    type extraction_list_params =
+      {
+        after: String,
+        limit: Integer,
+        status: XTwitterScraper::Models::ExtractionListParams::status,
+        tool_type: XTwitterScraper::Models::ExtractionListParams::tool_type
+      }
+      & XTwitterScraper::Internal::Type::request_parameters
+
+    class ExtractionListParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      attr_reader after: String?
+
+      def after=: (String) -> String
+
+      attr_reader limit: Integer?
+
+      def limit=: (Integer) -> Integer
+
+      attr_reader status: XTwitterScraper::Models::ExtractionListParams::status?
+
+      def status=: (
+        XTwitterScraper::Models::ExtractionListParams::status
+      ) -> XTwitterScraper::Models::ExtractionListParams::status
+
+      attr_reader tool_type: XTwitterScraper::Models::ExtractionListParams::tool_type?
+
+      def tool_type=: (
+        XTwitterScraper::Models::ExtractionListParams::tool_type
+      ) -> XTwitterScraper::Models::ExtractionListParams::tool_type
+
+      def initialize: (
+        ?after: String,
+        ?limit: Integer,
+        ?status: XTwitterScraper::Models::ExtractionListParams::status,
+        ?tool_type: XTwitterScraper::Models::ExtractionListParams::tool_type,
+        ?request_options: XTwitterScraper::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        after: String,
+        limit: Integer,
+        status: XTwitterScraper::Models::ExtractionListParams::status,
+        tool_type: XTwitterScraper::Models::ExtractionListParams::tool_type,
+        request_options: XTwitterScraper::RequestOptions
+      }
+
+      type status = :running | :completed | :failed
+
+      module Status
+        extend XTwitterScraper::Internal::Type::Enum
+
+        RUNNING: :running
+        COMPLETED: :completed
+        FAILED: :failed
+
+        def self?.values: -> ::Array[XTwitterScraper::Models::ExtractionListParams::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::ExtractionListParams::tool_type]
+      end
+    end
+  end
+end

data/sig/x_twitter_scraper/models/extraction_list_response.rbs

@@ -0,0 +1,137 @@
+module XTwitterScraper
+  module Models
+    type extraction_list_response =
+      {
+        extractions: ::Array[XTwitterScraper::Models::ExtractionListResponse::Extraction],
+        has_more: bool,
+        next_cursor: String
+      }
+
+    class ExtractionListResponse < XTwitterScraper::Internal::Type::BaseModel
+      attr_accessor extractions: ::Array[XTwitterScraper::Models::ExtractionListResponse::Extraction]
+
+      attr_accessor has_more: bool
+
+      attr_reader next_cursor: String?
+
+      def next_cursor=: (String) -> String
+
+      def initialize: (
+        extractions: ::Array[XTwitterScraper::Models::ExtractionListResponse::Extraction],
+        has_more: bool,
+        ?next_cursor: String
+      ) -> void
+
+      def to_hash: -> {
+        extractions: ::Array[XTwitterScraper::Models::ExtractionListResponse::Extraction],
+        has_more: bool,
+        next_cursor: String
+      }
+
+      type extraction =
+        {
+          id: String,
+          created_at: Time,
+          status: XTwitterScraper::Models::ExtractionListResponse::Extraction::status,
+          tool_type: XTwitterScraper::Models::ExtractionListResponse::Extraction::tool_type,
+          total_results: Integer,
+          completed_at: Time
+        }
+
+      class Extraction < XTwitterScraper::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor created_at: Time
+
+        attr_accessor status: XTwitterScraper::Models::ExtractionListResponse::Extraction::status
+
+        attr_accessor tool_type: XTwitterScraper::Models::ExtractionListResponse::Extraction::tool_type
+
+        attr_accessor total_results: Integer
+
+        attr_reader completed_at: Time?
+
+        def completed_at=: (Time) -> Time
+
+        def initialize: (
+          id: String,
+          created_at: Time,
+          status: XTwitterScraper::Models::ExtractionListResponse::Extraction::status,
+          tool_type: XTwitterScraper::Models::ExtractionListResponse::Extraction::tool_type,
+          total_results: Integer,
+          ?completed_at: Time
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          created_at: Time,
+          status: XTwitterScraper::Models::ExtractionListResponse::Extraction::status,
+          tool_type: XTwitterScraper::Models::ExtractionListResponse::Extraction::tool_type,
+          total_results: Integer,
+          completed_at: Time
+        }
+
+        type status = :running | :completed | :failed
+
+        module Status
+          extend XTwitterScraper::Internal::Type::Enum
+
+          RUNNING: :running
+          COMPLETED: :completed
+          FAILED: :failed
+
+          def self?.values: -> ::Array[XTwitterScraper::Models::ExtractionListResponse::Extraction::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::ExtractionListResponse::Extraction::tool_type]
+        end
+      end
+    end
+  end
+end

data/sig/x_twitter_scraper/models/extraction_retrieve_params.rbs

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

data/sig/x_twitter_scraper/models/extraction_retrieve_response.rbs

@@ -0,0 +1,37 @@
+module XTwitterScraper
+  module Models
+    type extraction_retrieve_response =
+      {
+        has_more: bool,
+        job: ::Hash[Symbol, top],
+        results: ::Array[::Hash[Symbol, top]],
+        next_cursor: String
+      }
+
+    class ExtractionRetrieveResponse < XTwitterScraper::Internal::Type::BaseModel
+      attr_accessor has_more: bool
+
+      attr_accessor job: ::Hash[Symbol, top]
+
+      attr_accessor results: ::Array[::Hash[Symbol, top]]
+
+      attr_reader next_cursor: String?
+
+      def next_cursor=: (String) -> String
+
+      def initialize: (
+        has_more: bool,
+        job: ::Hash[Symbol, top],
+        results: ::Array[::Hash[Symbol, top]],
+        ?next_cursor: String
+      ) -> void
+
+      def to_hash: -> {
+        has_more: bool,
+        job: ::Hash[Symbol, top],
+        results: ::Array[::Hash[Symbol, top]],
+        next_cursor: String
+      }
+    end
+  end
+end