x-twitter-scraper 0.10.4 → 0.10.6

data/rbi/x_twitter_scraper/internal/type/base_model.rbi

@@ -31,15 +31,10 @@ module XTwitterScraper
           end
 
         class << self
-          # @api private
-          #
-          # Assumes superclass fields are totally defined before fields are accessed /
-          # defined on subclasses.
           sig { params(child: XTwitterScraper::Internal::Type::BaseModel).void }
           def inherited(child)
           end
 
-          # @api private
           sig do
             returns(
               T::Hash[
@@ -59,7 +54,6 @@ module XTwitterScraper
           def known_fields
           end
 
-          # @api private
           sig do
             returns(
               T::Hash[
@@ -74,7 +68,6 @@ module XTwitterScraper
           def fields
           end
 
-          # @api private
           sig do
             params(
               name_sym: Symbol,
@@ -112,7 +105,6 @@ module XTwitterScraper
           private def add_field(name_sym, required:, type_info:, spec:)
           end
 
-          # @api private
           sig do
             params(
               name_sym: Symbol,
@@ -130,7 +122,6 @@ module XTwitterScraper
           def required(name_sym, type_info, spec = {})
           end
 
-          # @api private
           sig do
             params(
               name_sym: Symbol,
@@ -148,17 +139,10 @@ module XTwitterScraper
           def optional(name_sym, type_info, spec = {})
           end
 
-          # @api private
-          #
-          # `request_only` attributes not excluded from `.#coerce` when receiving responses
-          # even if well behaved servers should not send them
           sig { params(blk: T.proc.void).void }
           private def request_only(&blk)
           end
 
-          # @api private
-          #
-          # `response_only` attributes are omitted from `.#dump` when making requests
           sig { params(blk: T.proc.void).void }
           private def response_only(&blk)
           end
@@ -181,7 +165,6 @@ module XTwitterScraper
         end
 
         class << self
-          # @api private
           sig do
             override
               .params(
@@ -198,7 +181,6 @@ module XTwitterScraper
           def coerce(value, state:)
           end
 
-          # @api private
           sig do
             override
               .params(
@@ -210,14 +192,12 @@ module XTwitterScraper
           def dump(value, state:)
           end
 
-          # @api private
           sig { returns(T.anything) }
           def to_sorbet_type
           end
         end
 
         class << self
-          # @api private
           sig do
             params(
               model: XTwitterScraper::Internal::Type::BaseModel,
@@ -228,42 +208,18 @@ module XTwitterScraper
           end
         end
 
-        # Returns the raw value associated with the given key, if found. Otherwise, nil is
-        # returned.
-        #
-        # It is valid to lookup keys that are not in the API spec, for example to access
-        # undocumented features. This method does not parse response data into
-        # higher-level types. Lookup by anything other than a Symbol is an ArgumentError.
         sig { params(key: Symbol).returns(T.nilable(T.anything)) }
         def [](key)
         end
 
-        # Returns a Hash of the data underlying this object. O(1)
-        #
-        # Keys are Symbols and values are the raw values from the response. The return
-        # value indicates which values were ever set on the object. i.e. there will be a
-        # key in this hash if they ever were, even if the set value was nil.
-        #
-        # This method is not recursive. The returned value is shared by the object, so it
-        # should not be mutated.
         sig { overridable.returns(XTwitterScraper::Internal::AnyHash) }
         def to_h
         end
 
-        # Returns a Hash of the data underlying this object. O(1)
-        #
-        # Keys are Symbols and values are the raw values from the response. The return
-        # value indicates which values were ever set on the object. i.e. there will be a
-        # key in this hash if they ever were, even if the set value was nil.
-        #
-        # This method is not recursive. The returned value is shared by the object, so it
-        # should not be mutated.
         sig { overridable.returns(XTwitterScraper::Internal::AnyHash) }
         def to_hash
         end
 
-        # In addition to the behaviour of `#to_h`, this method will recursively call
-        # `#to_h` on nested models.
         sig { overridable.returns(XTwitterScraper::Internal::AnyHash) }
         def deep_to_h
         end
@@ -284,7 +240,6 @@ module XTwitterScraper
         def to_yaml(*a)
         end
 
-        # Create a new instance of a model.
         sig do
           params(
             data:
@@ -298,7 +253,6 @@ module XTwitterScraper
         end
 
         class << self
-          # @api private
           sig { params(depth: Integer).returns(String) }
           def inspect(depth: 0)
           end
@@ -308,7 +262,6 @@ module XTwitterScraper
         def to_s
         end
 
-        # @api private
         sig { returns(String) }
         def inspect
         end

data/rbi/x_twitter_scraper/internal/type/base_page.rbi

@@ -7,9 +7,6 @@
 module XTwitterScraper
   module Internal
     module Type
-      # @api private
-      #
-      # This module provides a base implementation for paginated responses in the SDK.
       module BasePage
         Elem = type_member(:out)
 
@@ -29,7 +26,6 @@ module XTwitterScraper
         def to_enum
         end
 
-        # @api private
         sig do
           params(
             client: XTwitterScraper::Internal::Transport::BaseClient,

data/rbi/x_twitter_scraper/internal/type/boolean.rbi

@@ -7,9 +7,6 @@
 module XTwitterScraper
   module Internal
     module Type
-      # @api private
-      #
-      # Ruby has no Boolean class; this is something for models to refer to.
       class Boolean
         extend XTwitterScraper::Internal::Type::Converter
         extend XTwitterScraper::Internal::Util::SorbetRuntimeSupport
@@ -25,9 +22,6 @@ module XTwitterScraper
         end
 
         class << self
-          # @api private
-          #
-          # Coerce value to Boolean if possible, otherwise return the original value.
           sig do
             override
               .params(
@@ -39,7 +33,6 @@ module XTwitterScraper
           def coerce(value, state:)
           end
 
-          # @api private
           sig do
             override
               .params(
@@ -51,7 +44,6 @@ module XTwitterScraper
           def dump(value, state:)
           end
 
-          # @api private
           sig { returns(T.anything) }
           def to_sorbet_type
           end

data/rbi/x_twitter_scraper/internal/type/converter.rbi

@@ -7,7 +7,6 @@
 module XTwitterScraper
   module Internal
     module Type
-      # @api private
       module Converter
         extend XTwitterScraper::Internal::Util::SorbetRuntimeSupport
 
@@ -36,7 +35,6 @@ module XTwitterScraper
 
         DumpState = T.type_alias { { can_retry: T::Boolean } }
 
-        # @api private
         sig do
           overridable
             .params(
@@ -48,7 +46,6 @@ module XTwitterScraper
         def coerce(value, state:)
         end
 
-        # @api private
         sig do
           overridable
             .params(
@@ -60,13 +57,11 @@ module XTwitterScraper
         def dump(value, state:)
         end
 
-        # @api private
         sig { params(depth: Integer).returns(String) }
         def inspect(depth: 0)
         end
 
         class << self
-          # @api private
           sig do
             params(
               spec:
@@ -99,7 +94,6 @@ module XTwitterScraper
           def self.type_info(spec)
           end
 
-          # @api private
           sig do
             params(
               type_info:
@@ -157,7 +151,6 @@ module XTwitterScraper
           def self.meta_info(type_info, spec)
           end
 
-          # @api private
           sig do
             params(translate_names: T::Boolean).returns(
               XTwitterScraper::Internal::Type::Converter::CoerceState
@@ -166,17 +159,6 @@ module XTwitterScraper
           def self.new_coerce_state(translate_names: true)
           end
 
-          # @api private
-          #
-          # Based on `target`, transform `value` into `target`, to the extent possible:
-          #
-          # 1. if the given `value` conforms to `target` already, return the given `value`
-          # 2. if it's possible and safe to convert the given `value` to `target`, then the
-          #    converted value
-          # 3. otherwise, the given `value` unaltered
-          #
-          # The coercion process is subject to improvement between minor release versions.
-          # See https://docs.pydantic.dev/latest/concepts/unions/#smart-mode
           sig do
             params(
               target: XTwitterScraper::Internal::Type::Converter::Input,
@@ -187,27 +169,10 @@ module XTwitterScraper
           def self.coerce(
             target,
             value,
-            # The `strictness` is one of `true`, `false`. This informs the coercion strategy
-            # when we have to decide between multiple possible conversion targets:
-            #
-            # - `true`: the conversion must be exact, with minimum coercion.
-            # - `false`: the conversion can be approximate, with some coercion.
-            #
-            # The `exactness` is `Hash` with keys being one of `yes`, `no`, or `maybe`. For
-            # any given conversion attempt, the exactness will be updated based on how closely
-            # the value recursively matches the target type:
-            #
-            # - `yes`: the value can be converted to the target type with minimum coercion.
-            # - `maybe`: the value can be converted to the target type with some reasonable
-            #   coercion.
-            # - `no`: the value cannot be converted to the target type.
-            #
-            # See implementation below for more details.
             state: XTwitterScraper::Internal::Type::Converter.new_coerce_state
           )
           end
 
-          # @api private
           sig do
             params(
               target: XTwitterScraper::Internal::Type::Converter::Input,
@@ -218,7 +183,6 @@ module XTwitterScraper
           def self.dump(target, value, state: { can_retry: true })
           end
 
-          # @api private
           sig { params(target: T.anything, depth: Integer).returns(String) }
           def self.inspect(target, depth:)
           end

data/rbi/x_twitter_scraper/internal/type/enum.rbi

@@ -7,23 +7,10 @@
 module XTwitterScraper
   module Internal
     module Type
-      # @api private
-      #
-      # A value from among a specified list of options. OpenAPI enum values map to Ruby
-      # values in the SDK as follows:
-      #
-      # 1. boolean => true | false
-      # 2. integer => Integer
-      # 3. float => Float
-      # 4. string => Symbol
-      #
-      # We can therefore convert string values to Symbols, but can't convert other
-      # values safely.
       module Enum
         include XTwitterScraper::Internal::Type::Converter
         include XTwitterScraper::Internal::Util::SorbetRuntimeSupport
 
-        # All of the valid Symbol values for this enum.
         sig do
           overridable.returns(
             T::Array[T.any(NilClass, T::Boolean, Integer, Float, Symbol)]
@@ -44,10 +31,6 @@ module XTwitterScraper
         def hash
         end
 
-        # @api private
-        #
-        # Unlike with primitives, `Enum` additionally validates that the value is a member
-        # of the enum.
         sig do
           override
             .params(
@@ -59,7 +42,6 @@ module XTwitterScraper
         def coerce(value, state:)
         end
 
-        # @api private
         sig do
           override
             .params(
@@ -71,12 +53,10 @@ module XTwitterScraper
         def dump(value, state:)
         end
 
-        # @api private
         sig { returns(T.anything) }
         def to_sorbet_type
         end
 
-        # @api private
         sig { params(depth: Integer).returns(String) }
         def inspect(depth: 0)
         end

data/rbi/x_twitter_scraper/internal/type/file_input.rbi

@@ -7,13 +7,6 @@
 module XTwitterScraper
   module Internal
     module Type
-      # @api private
-      #
-      # Either `Pathname` or `StringIO`, or `IO`, or
-      # `XTwitterScraper::Internal::Type::FileInput`.
-      #
-      # Note: when `IO` is used, all retries are disabled, since many IO` streams are
-      # not rewindable.
       class FileInput
         extend XTwitterScraper::Internal::Type::Converter
 
@@ -28,7 +21,6 @@ module XTwitterScraper
         end
 
         class << self
-          # @api private
           sig do
             override
               .params(
@@ -40,7 +32,6 @@ module XTwitterScraper
           def coerce(value, state:)
           end
 
-          # @api private
           sig do
             override
               .params(
@@ -52,7 +43,6 @@ module XTwitterScraper
           def dump(value, state:)
           end
 
-          # @api private
           sig { returns(T.anything) }
           def to_sorbet_type
           end

data/rbi/x_twitter_scraper/internal/type/hash_of.rbi

@@ -7,9 +7,6 @@
 module XTwitterScraper
   module Internal
     module Type
-      # @api private
-      #
-      # Hash of items of a given type.
       class HashOf
         include XTwitterScraper::Internal::Type::Converter
         include XTwitterScraper::Internal::Util::SorbetRuntimeSupport
@@ -46,7 +43,6 @@ module XTwitterScraper
         def hash
         end
 
-        # @api private
         sig do
           override
             .params(
@@ -58,7 +54,6 @@ module XTwitterScraper
         def coerce(value, state:)
         end
 
-        # @api private
         sig do
           override
             .params(
@@ -70,22 +65,18 @@ module XTwitterScraper
         def dump(value, state:)
         end
 
-        # @api private
         sig { returns(T.anything) }
         def to_sorbet_type
         end
 
-        # @api private
         sig { returns(Elem) }
         protected def item_type
         end
 
-        # @api private
         sig { returns(T::Boolean) }
         protected def nilable?
         end
 
-        # @api private
         sig do
           params(
             type_info:
@@ -102,7 +93,6 @@ module XTwitterScraper
         def initialize(type_info, spec = {})
         end
 
-        # @api private
         sig { params(depth: Integer).returns(String) }
         def inspect(depth: 0)
         end

data/rbi/x_twitter_scraper/internal/type/request_parameters.rbi

@@ -7,9 +7,7 @@
 module XTwitterScraper
   module Internal
     module Type
-      # @api private
       module RequestParameters
-        # Options to specify HTTP behaviour for this request.
         sig { returns(XTwitterScraper::RequestOptions) }
         attr_reader :request_options
 
@@ -18,9 +16,7 @@ module XTwitterScraper
         end
         attr_writer :request_options
 
-        # @api private
         module Converter
-          # @api private
           sig do
             params(params: T.anything).returns(
               [T.anything, XTwitterScraper::Internal::AnyHash]

data/rbi/x_twitter_scraper/internal/type/union.rbi

@@ -7,14 +7,10 @@
 module XTwitterScraper
   module Internal
     module Type
-      # @api private
       module Union
         include XTwitterScraper::Internal::Type::Converter
         include XTwitterScraper::Internal::Util::SorbetRuntimeSupport
 
-        # @api private
-        #
-        # All of the specified variant info for this union.
         sig do
           returns(
             T::Array[
@@ -31,7 +27,6 @@ module XTwitterScraper
         private def known_variants
         end
 
-        # @api private
         sig do
           returns(
             T::Array[
@@ -46,17 +41,14 @@ module XTwitterScraper
         protected def derefed_variants
         end
 
-        # All of the specified variants for this union.
         sig { overridable.returns(T::Array[T.anything]) }
         def variants
         end
 
-        # @api private
         sig { params(property: Symbol).void }
         private def discriminator(property)
         end
 
-        # @api private
         sig do
           params(
             key:
@@ -77,7 +69,6 @@ module XTwitterScraper
         private def variant(key, spec = nil)
         end
 
-        # @api private
         sig { params(value: T.anything).returns(T.nilable(T.anything)) }
         private def resolve_variant(value)
         end
@@ -94,12 +85,6 @@ module XTwitterScraper
         def hash
         end
 
-        # @api private
-        #
-        # Tries to efficiently coerce the given value to one of the known variants.
-        #
-        # If the value cannot match any of the known variants, the coercion is considered
-        # non-viable and returns the original value.
         sig do
           override
             .params(
@@ -111,7 +96,6 @@ module XTwitterScraper
         def coerce(value, state:)
         end
 
-        # @api private
         sig do
           override
             .params(
@@ -123,12 +107,10 @@ module XTwitterScraper
         def dump(value, state:)
         end
 
-        # @api private
         sig { returns(T.anything) }
         def to_sorbet_type
         end
 
-        # @api private
         sig { params(depth: Integer).returns(String) }
         def inspect(depth: 0)
         end

data/rbi/x_twitter_scraper/internal/type/unknown.rbi

@@ -7,9 +7,6 @@
 module XTwitterScraper
   module Internal
     module Type
-      # @api private
-      #
-      # When we don't know what to expect for the value.
       class Unknown
         extend XTwitterScraper::Internal::Type::Converter
         extend XTwitterScraper::Internal::Util::SorbetRuntimeSupport
@@ -25,9 +22,6 @@ module XTwitterScraper
         end
 
         class << self
-          # @api private
-          #
-          # No coercion needed for Unknown type.
           sig do
             override
               .params(
@@ -39,7 +33,6 @@ module XTwitterScraper
           def coerce(value, state:)
           end
 
-          # @api private
           sig do
             override
               .params(
@@ -51,7 +44,6 @@ module XTwitterScraper
           def dump(value, state:)
           end
 
-          # @api private
           sig { returns(T.anything) }
           def to_sorbet_type
           end