x-twitter-scraper 0.3.0

data/lib/x_twitter_scraper/models/extraction_retrieve_params.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Extractions#retrieve
+    class ExtractionRetrieveParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute after
+      #   Cursor for pagination
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute limit
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(id:, after: nil, limit: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @param after [String] Cursor for pagination
+      #
+      #   @param limit [Integer]
+      #
+      #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/x_twitter_scraper/models/extraction_retrieve_response.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Extractions#retrieve
+    class ExtractionRetrieveResponse < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute has_more
+      #
+      #   @return [Boolean]
+      required :has_more, XTwitterScraper::Internal::Type::Boolean, api_name: :hasMore
+
+      # @!attribute job
+      #   Extraction job metadata — shape varies by tool type (JSON)
+      #
+      #   @return [Hash{Symbol=>Object}]
+      required :job, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]
+
+      # @!attribute results
+      #
+      #   @return [Array<Hash{Symbol=>Object}>]
+      required :results,
+               XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]]
+
+      # @!attribute next_cursor
+      #
+      #   @return [String, nil]
+      optional :next_cursor, String, api_name: :nextCursor
+
+      # @!method initialize(has_more:, job:, results:, next_cursor: nil)
+      #   @param has_more [Boolean]
+      #
+      #   @param job [Hash{Symbol=>Object}] Extraction job metadata — shape varies by tool type (JSON)
+      #
+      #   @param results [Array<Hash{Symbol=>Object}>]
+      #
+      #   @param next_cursor [String]
+    end
+  end
+end

data/lib/x_twitter_scraper/models/extraction_run_params.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Extractions#run
+    class ExtractionRunParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      # @!attribute tool_type
+      #
+      #   @return [Symbol, XTwitterScraper::Models::ExtractionRunParams::ToolType]
+      required :tool_type, enum: -> { XTwitterScraper::ExtractionRunParams::ToolType }, api_name: :toolType
+
+      # @!attribute advanced_query
+      #   Raw advanced search query appended as-is (tweet_search_extractor)
+      #
+      #   @return [String, nil]
+      optional :advanced_query, String, api_name: :advancedQuery
+
+      # @!attribute exact_phrase
+      #   Exact phrase to match (tweet_search_extractor)
+      #
+      #   @return [String, nil]
+      optional :exact_phrase, String, api_name: :exactPhrase
+
+      # @!attribute exclude_words
+      #   Words to exclude from results (tweet_search_extractor)
+      #
+      #   @return [String, nil]
+      optional :exclude_words, String, api_name: :excludeWords
+
+      # @!attribute search_query
+      #
+      #   @return [String, nil]
+      optional :search_query, String, api_name: :searchQuery
+
+      # @!attribute target_community_id
+      #
+      #   @return [String, nil]
+      optional :target_community_id, String, api_name: :targetCommunityId
+
+      # @!attribute target_list_id
+      #
+      #   @return [String, nil]
+      optional :target_list_id, String, api_name: :targetListId
+
+      # @!attribute target_space_id
+      #
+      #   @return [String, nil]
+      optional :target_space_id, String, api_name: :targetSpaceId
+
+      # @!attribute target_tweet_id
+      #
+      #   @return [String, nil]
+      optional :target_tweet_id, String, api_name: :targetTweetId
+
+      # @!attribute target_username
+      #
+      #   @return [String, nil]
+      optional :target_username, String, api_name: :targetUsername
+
+      # @!method initialize(tool_type:, advanced_query: nil, exact_phrase: nil, exclude_words: nil, search_query: nil, target_community_id: nil, target_list_id: nil, target_space_id: nil, target_tweet_id: nil, target_username: nil, request_options: {})
+      #   @param tool_type [Symbol, XTwitterScraper::Models::ExtractionRunParams::ToolType]
+      #
+      #   @param advanced_query [String] Raw advanced search query appended as-is (tweet_search_extractor)
+      #
+      #   @param exact_phrase [String] Exact phrase to match (tweet_search_extractor)
+      #
+      #   @param exclude_words [String] Words to exclude from results (tweet_search_extractor)
+      #
+      #   @param search_query [String]
+      #
+      #   @param target_community_id [String]
+      #
+      #   @param target_list_id [String]
+      #
+      #   @param target_space_id [String]
+      #
+      #   @param target_tweet_id [String]
+      #
+      #   @param target_username [String]
+      #
+      #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+
+      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
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/extraction_run_response.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Extractions#run
+    class ExtractionRunResponse < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute status
+      #
+      #   @return [Symbol, XTwitterScraper::Models::ExtractionRunResponse::Status]
+      required :status, enum: -> { XTwitterScraper::Models::ExtractionRunResponse::Status }
+
+      # @!attribute tool_type
+      #
+      #   @return [Symbol, XTwitterScraper::Models::ExtractionRunResponse::ToolType]
+      required :tool_type,
+               enum: -> { XTwitterScraper::Models::ExtractionRunResponse::ToolType },
+               api_name: :toolType
+
+      # @!method initialize(id:, status:, tool_type:)
+      #   @param id [String]
+      #   @param status [Symbol, XTwitterScraper::Models::ExtractionRunResponse::Status]
+      #   @param tool_type [Symbol, XTwitterScraper::Models::ExtractionRunResponse::ToolType]
+
+      # @see XTwitterScraper::Models::ExtractionRunResponse#status
+      module Status
+        extend XTwitterScraper::Internal::Type::Enum
+
+        RUNNING = :running
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see XTwitterScraper::Models::ExtractionRunResponse#tool_type
+      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
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/integration.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    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::Integration::EventType>]
+      required :event_types,
+               -> { XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::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::Integration::Type]
+      required :type, enum: -> { XTwitterScraper::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::Integration::EventType>]
+      #
+      #   @param is_active [Boolean]
+      #
+      #   @param name [String]
+      #
+      #   @param type [Symbol, XTwitterScraper::Models::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::Integration#type
+      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_create_params.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Integrations#create
+    class IntegrationCreateParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      # @!attribute config
+      #   Integration config (e.g. Telegram chatId)
+      #
+      #   @return [XTwitterScraper::Models::IntegrationCreateParams::Config]
+      required :config, -> { XTwitterScraper::IntegrationCreateParams::Config }
+
+      # @!attribute event_types
+      #
+      #   @return [Array<Symbol, XTwitterScraper::Models::IntegrationCreateParams::EventType>]
+      required :event_types,
+               -> {
+                 XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::IntegrationCreateParams::EventType]
+               },
+               api_name: :eventTypes
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute type
+      #
+      #   @return [Symbol, XTwitterScraper::Models::IntegrationCreateParams::Type]
+      required :type, enum: -> { XTwitterScraper::IntegrationCreateParams::Type }
+
+      # @!method initialize(config:, event_types:, name:, type:, request_options: {})
+      #   @param config [XTwitterScraper::Models::IntegrationCreateParams::Config] Integration config (e.g. Telegram chatId)
+      #
+      #   @param event_types [Array<Symbol, XTwitterScraper::Models::IntegrationCreateParams::EventType>]
+      #
+      #   @param name [String]
+      #
+      #   @param type [Symbol, XTwitterScraper::Models::IntegrationCreateParams::Type]
+      #
+      #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+
+      class Config < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute chat_id
+        #
+        #   @return [String]
+        required :chat_id, String, api_name: :chatId
+
+        # @!method initialize(chat_id:)
+        #   Integration config (e.g. Telegram chatId)
+        #
+        #   @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_create_response.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Integrations#create
+    class IntegrationCreateResponse < 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::IntegrationCreateResponse::EventType>]
+      required :event_types,
+               -> { XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::Models::IntegrationCreateResponse::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::IntegrationCreateResponse::Type]
+      required :type, enum: -> { XTwitterScraper::Models::IntegrationCreateResponse::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::IntegrationCreateResponse::EventType>]
+      #
+      #   @param is_active [Boolean]
+      #
+      #   @param name [String]
+      #
+      #   @param type [Symbol, XTwitterScraper::Models::IntegrationCreateResponse::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::IntegrationCreateResponse#type
+      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_delete_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Integrations#delete
+    class IntegrationDeleteParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/x_twitter_scraper/models/integration_delete_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Integrations#delete
+    class IntegrationDeleteResponse < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute success
+      #
+      #   @return [Boolean, true]
+      required :success, const: true
+
+      # @!method initialize(success: true)
+      #   @param success [Boolean, true]
+    end
+  end
+end

data/lib/x_twitter_scraper/models/integration_delivery.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    class IntegrationDelivery < 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
+  end
+end