x-twitter-scraper 0.4.2 → 0.4.4

data/lib/x_twitter_scraper/models/x/search_tweet.rb

@@ -1,119 +0,0 @@
-# frozen_string_literal: true
-
-module XTwitterScraper
-  module Models
-    module X
-      class SearchTweet < XTwitterScraper::Internal::Type::BaseModel
-        # @!attribute id
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute text
-        #
-        #   @return [String]
-        required :text, String
-
-        # @!attribute author
-        #
-        #   @return [XTwitterScraper::Models::X::SearchTweet::Author, nil]
-        optional :author, -> { XTwitterScraper::X::SearchTweet::Author }
-
-        # @!attribute bookmark_count
-        #
-        #   @return [Integer, nil]
-        optional :bookmark_count, Integer, api_name: :bookmarkCount
-
-        # @!attribute created_at
-        #
-        #   @return [String, nil]
-        optional :created_at, String, api_name: :createdAt
-
-        # @!attribute is_note_tweet
-        #   True for Note Tweets (long-form content, up to 25,000 characters)
-        #
-        #   @return [Boolean, nil]
-        optional :is_note_tweet, XTwitterScraper::Internal::Type::Boolean, api_name: :isNoteTweet
-
-        # @!attribute like_count
-        #
-        #   @return [Integer, nil]
-        optional :like_count, Integer, api_name: :likeCount
-
-        # @!attribute quote_count
-        #
-        #   @return [Integer, nil]
-        optional :quote_count, Integer, api_name: :quoteCount
-
-        # @!attribute reply_count
-        #
-        #   @return [Integer, nil]
-        optional :reply_count, Integer, api_name: :replyCount
-
-        # @!attribute retweet_count
-        #
-        #   @return [Integer, nil]
-        optional :retweet_count, Integer, api_name: :retweetCount
-
-        # @!attribute view_count
-        #
-        #   @return [Integer, nil]
-        optional :view_count, Integer, api_name: :viewCount
-
-        # @!method initialize(id:, text:, author: nil, bookmark_count: nil, created_at: nil, is_note_tweet: nil, like_count: nil, quote_count: nil, reply_count: nil, retweet_count: nil, view_count: nil)
-        #   Tweet returned from search results with inline author info.
-        #
-        #   @param id [String]
-        #
-        #   @param text [String]
-        #
-        #   @param author [XTwitterScraper::Models::X::SearchTweet::Author]
-        #
-        #   @param bookmark_count [Integer]
-        #
-        #   @param created_at [String]
-        #
-        #   @param is_note_tweet [Boolean] True for Note Tweets (long-form content, up to 25,000 characters)
-        #
-        #   @param like_count [Integer]
-        #
-        #   @param quote_count [Integer]
-        #
-        #   @param reply_count [Integer]
-        #
-        #   @param retweet_count [Integer]
-        #
-        #   @param view_count [Integer]
-
-        # @see XTwitterScraper::Models::X::SearchTweet#author
-        class Author < XTwitterScraper::Internal::Type::BaseModel
-          # @!attribute id
-          #
-          #   @return [String]
-          required :id, String
-
-          # @!attribute name
-          #
-          #   @return [String]
-          required :name, String
-
-          # @!attribute username
-          #
-          #   @return [String]
-          required :username, String
-
-          # @!attribute verified
-          #
-          #   @return [Boolean, nil]
-          optional :verified, XTwitterScraper::Internal::Type::Boolean
-
-          # @!method initialize(id:, name:, username:, verified: nil)
-          #   @param id [String]
-          #   @param name [String]
-          #   @param username [String]
-          #   @param verified [Boolean]
-        end
-      end
-    end
-  end
-end

data/lib/x_twitter_scraper/models/x/user_profile.rb

@@ -1,80 +0,0 @@
-# frozen_string_literal: true
-
-module XTwitterScraper
-  module Models
-    module X
-      # @see XTwitterScraper::Resources::X::Users#retrieve
-      class UserProfile < XTwitterScraper::Internal::Type::BaseModel
-        # @!attribute id
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute name
-        #
-        #   @return [String]
-        required :name, String
-
-        # @!attribute username
-        #
-        #   @return [String]
-        required :username, String
-
-        # @!attribute created_at
-        #
-        #   @return [String, nil]
-        optional :created_at, String, api_name: :createdAt
-
-        # @!attribute description
-        #
-        #   @return [String, nil]
-        optional :description, String
-
-        # @!attribute followers
-        #
-        #   @return [Integer, nil]
-        optional :followers, Integer
-
-        # @!attribute following
-        #
-        #   @return [Integer, nil]
-        optional :following, Integer
-
-        # @!attribute location
-        #
-        #   @return [String, nil]
-        optional :location, String
-
-        # @!attribute profile_picture
-        #
-        #   @return [String, nil]
-        optional :profile_picture, String, api_name: :profilePicture
-
-        # @!attribute statuses_count
-        #
-        #   @return [Integer, nil]
-        optional :statuses_count, Integer, api_name: :statusesCount
-
-        # @!attribute verified
-        #
-        #   @return [Boolean, nil]
-        optional :verified, XTwitterScraper::Internal::Type::Boolean
-
-        # @!method initialize(id:, name:, username:, created_at: nil, description: nil, followers: nil, following: nil, location: nil, profile_picture: nil, statuses_count: nil, verified: nil)
-        #   X user profile with bio, follower counts, and verification status.
-        #
-        #   @param id [String]
-        #   @param name [String]
-        #   @param username [String]
-        #   @param created_at [String]
-        #   @param description [String]
-        #   @param followers [Integer]
-        #   @param following [Integer]
-        #   @param location [String]
-        #   @param profile_picture [String]
-        #   @param statuses_count [Integer]
-        #   @param verified [Boolean]
-      end
-    end
-  end
-end

data/lib/x_twitter_scraper/resources/api_keys.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-module XTwitterScraper
-  module Resources
-    # API key management (session auth only)
-    class APIKeys
-      # Create API key
-      #
-      # @overload create(name: nil, request_options: {})
-      #
-      # @param name [String]
-      # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [XTwitterScraper::Models::APIKeyCreateResponse]
-      #
-      # @see XTwitterScraper::Models::APIKeyCreateParams
-      def create(params = {})
-        parsed, options = XTwitterScraper::APIKeyCreateParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: "api-keys",
-          body: parsed,
-          model: XTwitterScraper::Models::APIKeyCreateResponse,
-          security: {auth_api_key: true},
-          options: options
-        )
-      end
-
-      # List API keys
-      #
-      # @overload list(request_options: {})
-      #
-      # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [XTwitterScraper::Models::APIKeyListResponse]
-      #
-      # @see XTwitterScraper::Models::APIKeyListParams
-      def list(params = {})
-        @client.request(
-          method: :get,
-          path: "api-keys",
-          model: XTwitterScraper::Models::APIKeyListResponse,
-          security: {auth_api_key: true},
-          options: params[:request_options]
-        )
-      end
-
-      # Revoke API key
-      #
-      # @overload revoke(id, request_options: {})
-      #
-      # @param id [String] Resource ID (stringified bigint)
-      #
-      # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [XTwitterScraper::Models::APIKeyRevokeResponse]
-      #
-      # @see XTwitterScraper::Models::APIKeyRevokeParams
-      def revoke(id, params = {})
-        @client.request(
-          method: :delete,
-          path: ["api-keys/%1$s", id],
-          model: XTwitterScraper::Models::APIKeyRevokeResponse,
-          security: {auth_api_key: true},
-          options: params[:request_options]
-        )
-      end
-
-      # @api private
-      #
-      # @param client [XTwitterScraper::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/lib/x_twitter_scraper/resources/bot/platform_links.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module XTwitterScraper
-  module Resources
-    class Bot
-      class PlatformLinks
-        # @api private
-        #
-        # @param client [XTwitterScraper::Client]
-        def initialize(client:)
-          @client = client
-        end
-      end
-    end
-  end
-end

data/lib/x_twitter_scraper/resources/bot.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module XTwitterScraper
-  module Resources
-    class Bot
-      # @return [XTwitterScraper::Resources::Bot::PlatformLinks]
-      attr_reader :platform_links
-
-      # @api private
-      #
-      # @param client [XTwitterScraper::Client]
-      def initialize(client:)
-        @client = client
-        @platform_links = XTwitterScraper::Resources::Bot::PlatformLinks.new(client: client)
-      end
-    end
-  end
-end

data/lib/x_twitter_scraper/resources/integrations.rb

@@ -1,182 +0,0 @@
-# frozen_string_literal: true
-
-module XTwitterScraper
-  module Resources
-    # Push notification integrations (Telegram)
-    class Integrations
-      # Create integration
-      #
-      # @overload create(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::EventType>] Array of event types to subscribe to.
-      #
-      # @param name [String]
-      #
-      # @param type [Symbol, :telegram]
-      #
-      # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [XTwitterScraper::Models::Integration]
-      #
-      # @see XTwitterScraper::Models::IntegrationCreateParams
-      def create(params)
-        parsed, options = XTwitterScraper::IntegrationCreateParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: "integrations",
-          body: parsed,
-          model: XTwitterScraper::Integration,
-          options: options
-        )
-      end
-
-      # Get integration details
-      #
-      # @overload retrieve(id, request_options: {})
-      #
-      # @param id [String] Resource ID (stringified bigint)
-      #
-      # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [XTwitterScraper::Models::Integration]
-      #
-      # @see XTwitterScraper::Models::IntegrationRetrieveParams
-      def retrieve(id, params = {})
-        @client.request(
-          method: :get,
-          path: ["integrations/%1$s", id],
-          model: XTwitterScraper::Integration,
-          options: params[:request_options]
-        )
-      end
-
-      # Update integration
-      #
-      # @overload update(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] Resource ID (stringified bigint)
-      #
-      # @param event_types [Array<Symbol, XTwitterScraper::Models::EventType>] Array of event types to subscribe to.
-      #
-      # @param filters [Hash{Symbol=>Object}] Event filter rules (JSON)
-      #
-      # @param is_active [Boolean]
-      #
-      # @param message_template [Hash{Symbol=>Object}] Custom message template (JSON)
-      #
-      # @param name [String]
-      #
-      # @param scope_all_monitors [Boolean]
-      #
-      # @param silent_push [Boolean]
-      #
-      # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [XTwitterScraper::Models::Integration]
-      #
-      # @see XTwitterScraper::Models::IntegrationUpdateParams
-      def update(id, params = {})
-        parsed, options = XTwitterScraper::IntegrationUpdateParams.dump_request(params)
-        @client.request(
-          method: :patch,
-          path: ["integrations/%1$s", id],
-          body: parsed,
-          model: XTwitterScraper::Integration,
-          options: options
-        )
-      end
-
-      # List integrations
-      #
-      # @overload list(request_options: {})
-      #
-      # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [XTwitterScraper::Models::IntegrationListResponse]
-      #
-      # @see XTwitterScraper::Models::IntegrationListParams
-      def list(params = {})
-        @client.request(
-          method: :get,
-          path: "integrations",
-          model: XTwitterScraper::Models::IntegrationListResponse,
-          options: params[:request_options]
-        )
-      end
-
-      # Delete integration
-      #
-      # @overload delete(id, request_options: {})
-      #
-      # @param id [String] Resource ID (stringified bigint)
-      #
-      # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [XTwitterScraper::Models::IntegrationDeleteResponse]
-      #
-      # @see XTwitterScraper::Models::IntegrationDeleteParams
-      def delete(id, params = {})
-        @client.request(
-          method: :delete,
-          path: ["integrations/%1$s", id],
-          model: XTwitterScraper::Models::IntegrationDeleteResponse,
-          options: params[:request_options]
-        )
-      end
-
-      # List integration delivery history
-      #
-      # @overload list_deliveries(id, limit: nil, request_options: {})
-      #
-      # @param id [String] Resource ID (stringified bigint)
-      #
-      # @param limit [Integer] Maximum number of items to return (1-100, default 50)
-      #
-      # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [XTwitterScraper::Models::IntegrationListDeliveriesResponse]
-      #
-      # @see XTwitterScraper::Models::IntegrationListDeliveriesParams
-      def list_deliveries(id, params = {})
-        parsed, options = XTwitterScraper::IntegrationListDeliveriesParams.dump_request(params)
-        query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
-        @client.request(
-          method: :get,
-          path: ["integrations/%1$s/deliveries", id],
-          query: query,
-          model: XTwitterScraper::Models::IntegrationListDeliveriesResponse,
-          options: options
-        )
-      end
-
-      # Send test delivery
-      #
-      # @overload send_test(id, request_options: {})
-      #
-      # @param id [String] Resource ID (stringified bigint)
-      #
-      # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [XTwitterScraper::Models::IntegrationSendTestResponse]
-      #
-      # @see XTwitterScraper::Models::IntegrationSendTestParams
-      def send_test(id, params = {})
-        @client.request(
-          method: :post,
-          path: ["integrations/%1$s/test", id],
-          model: XTwitterScraper::Models::IntegrationSendTestResponse,
-          options: params[:request_options]
-        )
-      end
-
-      # @api private
-      #
-      # @param client [XTwitterScraper::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/rbi/x_twitter_scraper/models/api_key.rbi

@@ -1,69 +0,0 @@
-# typed: strong
-
-module XTwitterScraper
-  module Models
-    class APIKey < XTwitterScraper::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(XTwitterScraper::APIKey, XTwitterScraper::Internal::AnyHash)
-        end
-
-      sig { returns(String) }
-      attr_accessor :id
-
-      sig { returns(Time) }
-      attr_accessor :created_at
-
-      sig { returns(T::Boolean) }
-      attr_accessor :is_active
-
-      sig { returns(String) }
-      attr_accessor :name
-
-      sig { returns(String) }
-      attr_accessor :prefix
-
-      sig { returns(T.nilable(Time)) }
-      attr_reader :last_used_at
-
-      sig { params(last_used_at: Time).void }
-      attr_writer :last_used_at
-
-      # API key metadata returned when listing keys.
-      sig do
-        params(
-          id: String,
-          created_at: Time,
-          is_active: T::Boolean,
-          name: String,
-          prefix: String,
-          last_used_at: Time
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        id:,
-        created_at:,
-        is_active:,
-        name:,
-        prefix:,
-        last_used_at: nil
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            id: String,
-            created_at: Time,
-            is_active: T::Boolean,
-            name: String,
-            prefix: String,
-            last_used_at: Time
-          }
-        )
-      end
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/x_twitter_scraper/models/api_key_create_params.rbi

@@ -1,41 +0,0 @@
-# typed: strong
-
-module XTwitterScraper
-  module Models
-    class APIKeyCreateParams < XTwitterScraper::Internal::Type::BaseModel
-      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
-      include XTwitterScraper::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(
-            XTwitterScraper::APIKeyCreateParams,
-            XTwitterScraper::Internal::AnyHash
-          )
-        end
-
-      sig { returns(T.nilable(String)) }
-      attr_reader :name
-
-      sig { params(name: String).void }
-      attr_writer :name
-
-      sig do
-        params(
-          name: String,
-          request_options: XTwitterScraper::RequestOptions::OrHash
-        ).returns(T.attached_class)
-      end
-      def self.new(name: nil, request_options: {})
-      end
-
-      sig do
-        override.returns(
-          { name: String, request_options: XTwitterScraper::RequestOptions }
-        )
-      end
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/x_twitter_scraper/models/api_key_create_response.rbi

@@ -1,56 +0,0 @@
-# typed: strong
-
-module XTwitterScraper
-  module Models
-    class APIKeyCreateResponse < XTwitterScraper::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(
-            XTwitterScraper::Models::APIKeyCreateResponse,
-            XTwitterScraper::Internal::AnyHash
-          )
-        end
-
-      sig { returns(String) }
-      attr_accessor :id
-
-      sig { returns(Time) }
-      attr_accessor :created_at
-
-      sig { returns(String) }
-      attr_accessor :full_key
-
-      sig { returns(String) }
-      attr_accessor :name
-
-      sig { returns(String) }
-      attr_accessor :prefix
-
-      sig do
-        params(
-          id: String,
-          created_at: Time,
-          full_key: String,
-          name: String,
-          prefix: String
-        ).returns(T.attached_class)
-      end
-      def self.new(id:, created_at:, full_key:, name:, prefix:)
-      end
-
-      sig do
-        override.returns(
-          {
-            id: String,
-            created_at: Time,
-            full_key: String,
-            name: String,
-            prefix: String
-          }
-        )
-      end
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/x_twitter_scraper/models/api_key_list_params.rbi

@@ -1,32 +0,0 @@
-# typed: strong
-
-module XTwitterScraper
-  module Models
-    class APIKeyListParams < XTwitterScraper::Internal::Type::BaseModel
-      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
-      include XTwitterScraper::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(
-            XTwitterScraper::APIKeyListParams,
-            XTwitterScraper::Internal::AnyHash
-          )
-        end
-
-      sig do
-        params(
-          request_options: XTwitterScraper::RequestOptions::OrHash
-        ).returns(T.attached_class)
-      end
-      def self.new(request_options: {})
-      end
-
-      sig do
-        override.returns({ request_options: XTwitterScraper::RequestOptions })
-      end
-      def to_hash
-      end
-    end
-  end
-end