x-twitter-scraper 0.3.0

data/lib/x_twitter_scraper/internal.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Internal
+    extend XTwitterScraper::Internal::Util::SorbetRuntimeSupport
+
+    OMIT =
+      Object.new.tap do
+        _1.define_singleton_method(:inspect) { "#<#{XTwitterScraper::Internal}::OMIT>" }
+      end
+        .freeze
+
+    define_sorbet_constant!(:AnyHash) do
+      T.type_alias { T::Hash[Symbol, T.anything] }
+    end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, XTwitterScraper::FilePart) }
+    end
+  end
+end

data/lib/x_twitter_scraper/models/account_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Account#retrieve
+    class AccountRetrieveParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/x_twitter_scraper/models/account_retrieve_response.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Account#retrieve
+    class AccountRetrieveResponse < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute monitors_allowed
+      #
+      #   @return [Integer]
+      required :monitors_allowed, Integer, api_name: :monitorsAllowed
+
+      # @!attribute monitors_used
+      #
+      #   @return [Integer]
+      required :monitors_used, Integer, api_name: :monitorsUsed
+
+      # @!attribute plan
+      #
+      #   @return [Symbol, XTwitterScraper::Models::AccountRetrieveResponse::Plan]
+      required :plan, enum: -> { XTwitterScraper::Models::AccountRetrieveResponse::Plan }
+
+      # @!attribute current_period
+      #
+      #   @return [XTwitterScraper::Models::AccountRetrieveResponse::CurrentPeriod, nil]
+      optional :current_period,
+               -> { XTwitterScraper::Models::AccountRetrieveResponse::CurrentPeriod },
+               api_name: :currentPeriod
+
+      # @!method initialize(monitors_allowed:, monitors_used:, plan:, current_period: nil)
+      #   @param monitors_allowed [Integer]
+      #   @param monitors_used [Integer]
+      #   @param plan [Symbol, XTwitterScraper::Models::AccountRetrieveResponse::Plan]
+      #   @param current_period [XTwitterScraper::Models::AccountRetrieveResponse::CurrentPeriod]
+
+      # @see XTwitterScraper::Models::AccountRetrieveResponse#plan
+      module Plan
+        extend XTwitterScraper::Internal::Type::Enum
+
+        ACTIVE = :active
+        INACTIVE = :inactive
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see XTwitterScraper::Models::AccountRetrieveResponse#current_period
+      class CurrentPeriod < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute end_
+        #
+        #   @return [Time]
+        required :end_, Time, api_name: :end
+
+        # @!attribute start
+        #
+        #   @return [Time]
+        required :start, Time
+
+        # @!attribute usage_percent
+        #
+        #   @return [Float]
+        required :usage_percent, Float, api_name: :usagePercent
+
+        # @!method initialize(end_:, start:, usage_percent:)
+        #   @param end_ [Time]
+        #   @param start [Time]
+        #   @param usage_percent [Float]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/account_set_x_username_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Account#set_x_username
+    class AccountSetXUsernameParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      # @!attribute username
+      #   X username without @
+      #
+      #   @return [String]
+      required :username, String
+
+      # @!method initialize(username:, request_options: {})
+      #   @param username [String] X username without @
+      #
+      #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/x_twitter_scraper/models/account_set_x_username_response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Account#set_x_username
+    class AccountSetXUsernameResponse < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute success
+      #
+      #   @return [Boolean, true]
+      required :success, const: true
+
+      # @!attribute x_username
+      #
+      #   @return [String]
+      required :x_username, String, api_name: :xUsername
+
+      # @!method initialize(x_username:, success: true)
+      #   @param x_username [String]
+      #   @param success [Boolean, true]
+    end
+  end
+end

data/lib/x_twitter_scraper/models/account_update_locale_params.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Account#update_locale
+    class AccountUpdateLocaleParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      # @!attribute locale
+      #
+      #   @return [Symbol, XTwitterScraper::Models::AccountUpdateLocaleParams::Locale]
+      required :locale, enum: -> { XTwitterScraper::AccountUpdateLocaleParams::Locale }
+
+      # @!method initialize(locale:, request_options: {})
+      #   @param locale [Symbol, XTwitterScraper::Models::AccountUpdateLocaleParams::Locale]
+      #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+
+      module Locale
+        extend XTwitterScraper::Internal::Type::Enum
+
+        EN = :en
+        TR = :tr
+        ES = :es
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/account_update_locale_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Account#update_locale
+    class AccountUpdateLocaleResponse < 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/api_key.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    class APIKey < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time, api_name: :createdAt
+
+      # @!attribute is_active
+      #
+      #   @return [Boolean]
+      required :is_active, XTwitterScraper::Internal::Type::Boolean, api_name: :isActive
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute prefix
+      #
+      #   @return [String]
+      required :prefix, String
+
+      # @!attribute last_used_at
+      #
+      #   @return [Time, nil]
+      optional :last_used_at, Time, api_name: :lastUsedAt
+
+      # @!method initialize(id:, created_at:, is_active:, name:, prefix:, last_used_at: nil)
+      #   @param id [String]
+      #   @param created_at [Time]
+      #   @param is_active [Boolean]
+      #   @param name [String]
+      #   @param prefix [String]
+      #   @param last_used_at [Time]
+    end
+  end
+end

data/lib/x_twitter_scraper/models/api_key_create_params.rb

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

data/lib/x_twitter_scraper/models/api_key_create_response.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::APIKeys#create
+    class APIKeyCreateResponse < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time, api_name: :createdAt
+
+      # @!attribute full_key
+      #
+      #   @return [String]
+      required :full_key, String, api_name: :fullKey
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute prefix
+      #
+      #   @return [String]
+      required :prefix, String
+
+      # @!method initialize(id:, created_at:, full_key:, name:, prefix:)
+      #   @param id [String]
+      #   @param created_at [Time]
+      #   @param full_key [String]
+      #   @param name [String]
+      #   @param prefix [String]
+    end
+  end
+end

data/lib/x_twitter_scraper/models/api_key_list_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::APIKeys#list
+    class APIKeyListParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/x_twitter_scraper/models/api_key_list_response.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::APIKeys#list
+    class APIKeyListResponse < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute keys
+      #
+      #   @return [Array<XTwitterScraper::Models::APIKeyListResponse::Key>]
+      required :keys,
+               -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::APIKeyListResponse::Key] }
+
+      # @!method initialize(keys:)
+      #   @param keys [Array<XTwitterScraper::Models::APIKeyListResponse::Key>]
+
+      class Key < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time, api_name: :createdAt
+
+        # @!attribute is_active
+        #
+        #   @return [Boolean]
+        required :is_active, XTwitterScraper::Internal::Type::Boolean, api_name: :isActive
+
+        # @!attribute name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute prefix
+        #
+        #   @return [String]
+        required :prefix, String
+
+        # @!attribute last_used_at
+        #
+        #   @return [Time, nil]
+        optional :last_used_at, Time, api_name: :lastUsedAt
+
+        # @!method initialize(id:, created_at:, is_active:, name:, prefix:, last_used_at: nil)
+        #   @param id [String]
+        #   @param created_at [Time]
+        #   @param is_active [Boolean]
+        #   @param name [String]
+        #   @param prefix [String]
+        #   @param last_used_at [Time]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/api_key_revoke_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::APIKeys#revoke
+    class APIKeyRevokeParams < 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/api_key_revoke_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::APIKeys#revoke
+    class APIKeyRevokeResponse < 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/compose_create_params.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Compose#create
+    class ComposeCreateParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      # @!attribute step
+      #   Workflow step
+      #
+      #   @return [Symbol, XTwitterScraper::Models::ComposeCreateParams::Step]
+      required :step, enum: -> { XTwitterScraper::ComposeCreateParams::Step }
+
+      # @!attribute additional_context
+      #   Extra context or URLs (refine)
+      #
+      #   @return [String, nil]
+      optional :additional_context, String, api_name: :additionalContext
+
+      # @!attribute call_to_action
+      #   Desired call to action (refine)
+      #
+      #   @return [String, nil]
+      optional :call_to_action, String, api_name: :callToAction
+
+      # @!attribute draft
+      #   Tweet draft text to evaluate (score)
+      #
+      #   @return [String, nil]
+      optional :draft, String
+
+      # @!attribute goal
+      #   Optimization goal
+      #
+      #   @return [Symbol, XTwitterScraper::Models::ComposeCreateParams::Goal, nil]
+      optional :goal, enum: -> { XTwitterScraper::ComposeCreateParams::Goal }
+
+      # @!attribute has_link
+      #   Whether a link is attached (score)
+      #
+      #   @return [Boolean, nil]
+      optional :has_link, XTwitterScraper::Internal::Type::Boolean, api_name: :hasLink
+
+      # @!attribute has_media
+      #   Whether media is attached (score)
+      #
+      #   @return [Boolean, nil]
+      optional :has_media, XTwitterScraper::Internal::Type::Boolean, api_name: :hasMedia
+
+      # @!attribute media_type
+      #   Media type (refine)
+      #
+      #   @return [Symbol, XTwitterScraper::Models::ComposeCreateParams::MediaType, nil]
+      optional :media_type, enum: -> { XTwitterScraper::ComposeCreateParams::MediaType }, api_name: :mediaType
+
+      # @!attribute style_username
+      #   Cached style username for voice matching (compose)
+      #
+      #   @return [String, nil]
+      optional :style_username, String, api_name: :styleUsername
+
+      # @!attribute tone
+      #   Desired tone (refine)
+      #
+      #   @return [String, nil]
+      optional :tone, String
+
+      # @!attribute topic
+      #   Tweet topic (compose, refine)
+      #
+      #   @return [String, nil]
+      optional :topic, String
+
+      # @!method initialize(step:, additional_context: nil, call_to_action: nil, draft: nil, goal: nil, has_link: nil, has_media: nil, media_type: nil, style_username: nil, tone: nil, topic: nil, request_options: {})
+      #   @param step [Symbol, XTwitterScraper::Models::ComposeCreateParams::Step] Workflow step
+      #
+      #   @param additional_context [String] Extra context or URLs (refine)
+      #
+      #   @param call_to_action [String] Desired call to action (refine)
+      #
+      #   @param draft [String] Tweet draft text to evaluate (score)
+      #
+      #   @param goal [Symbol, XTwitterScraper::Models::ComposeCreateParams::Goal] Optimization goal
+      #
+      #   @param has_link [Boolean] Whether a link is attached (score)
+      #
+      #   @param has_media [Boolean] Whether media is attached (score)
+      #
+      #   @param media_type [Symbol, XTwitterScraper::Models::ComposeCreateParams::MediaType] Media type (refine)
+      #
+      #   @param style_username [String] Cached style username for voice matching (compose)
+      #
+      #   @param tone [String] Desired tone (refine)
+      #
+      #   @param topic [String] Tweet topic (compose, refine)
+      #
+      #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+
+      # Workflow step
+      module Step
+        extend XTwitterScraper::Internal::Type::Enum
+
+        COMPOSE = :compose
+        REFINE = :refine
+        SCORE = :score
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Optimization goal
+      module Goal
+        extend XTwitterScraper::Internal::Type::Enum
+
+        ENGAGEMENT = :engagement
+        FOLLOWERS = :followers
+        AUTHORITY = :authority
+        CONVERSATION = :conversation
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Media type (refine)
+      module MediaType
+        extend XTwitterScraper::Internal::Type::Enum
+
+        PHOTO = :photo
+        VIDEO = :video
+        NONE = :none
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/compose_create_response.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Compose#create
+    class ComposeCreateResponse < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute feedback
+      #   AI feedback on the draft
+      #
+      #   @return [String, nil]
+      optional :feedback, String
+
+      # @!attribute score
+      #   Engagement score (0-100)
+      #
+      #   @return [Float, nil]
+      optional :score, Float
+
+      # @!attribute suggestions
+      #   Improvement suggestions
+      #
+      #   @return [Array<String>, nil]
+      optional :suggestions, XTwitterScraper::Internal::Type::ArrayOf[String]
+
+      # @!attribute text
+      #   Generated or refined tweet text
+      #
+      #   @return [String, nil]
+      optional :text, String
+
+      # @!method initialize(feedback: nil, score: nil, suggestions: nil, text: nil)
+      #   @param feedback [String] AI feedback on the draft
+      #
+      #   @param score [Float] Engagement score (0-100)
+      #
+      #   @param suggestions [Array<String>] Improvement suggestions
+      #
+      #   @param text [String] Generated or refined tweet text
+    end
+  end
+end

data/lib/x_twitter_scraper/models/credit_retrieve_balance_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Credits#retrieve_balance
+    class CreditRetrieveBalanceParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/x_twitter_scraper/models/credit_retrieve_balance_response.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Credits#retrieve_balance
+    class CreditRetrieveBalanceResponse < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute auto_topup_enabled
+      #
+      #   @return [Boolean]
+      required :auto_topup_enabled, XTwitterScraper::Internal::Type::Boolean
+
+      # @!attribute balance
+      #
+      #   @return [Integer]
+      required :balance, Integer
+
+      # @!attribute lifetime_purchased
+      #
+      #   @return [Integer]
+      required :lifetime_purchased, Integer
+
+      # @!attribute lifetime_used
+      #
+      #   @return [Integer]
+      required :lifetime_used, Integer
+
+      # @!method initialize(auto_topup_enabled:, balance:, lifetime_purchased:, lifetime_used:)
+      #   @param auto_topup_enabled [Boolean]
+      #   @param balance [Integer]
+      #   @param lifetime_purchased [Integer]
+      #   @param lifetime_used [Integer]
+    end
+  end
+end

data/lib/x_twitter_scraper/models/credit_topup_balance_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Credits#topup_balance
+    class CreditTopupBalanceParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      # @!attribute amount
+      #   Amount to top up in credits
+      #
+      #   @return [Integer]
+      required :amount, Integer
+
+      # @!method initialize(amount:, request_options: {})
+      #   @param amount [Integer] Amount to top up in credits
+      #
+      #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end