knockapi 1.0.0 → 1.2.0

data/rbi/knockapi/internal/type/converter.rbi

@@ -5,56 +5,88 @@ module Knockapi
     module Type
       # @api private
       module Converter
-        Input = T.type_alias { T.any(Knockapi::Internal::Type::Converter, T::Class[T.anything]) }
+        extend Knockapi::Internal::Util::SorbetRuntimeSupport
+
+        Input =
+          T.type_alias do
+            T.any(Knockapi::Internal::Type::Converter, T::Class[T.anything])
+          end
 
         CoerceState =
           T.type_alias do
             {
               strictness: T.any(T::Boolean, Symbol),
-              exactness: {yes: Integer, no: Integer, maybe: Integer},
+              exactness: {
+                yes: Integer,
+                no: Integer,
+                maybe: Integer
+              },
               branched: Integer
             }
           end
 
-        DumpState = T.type_alias { {can_retry: T::Boolean} }
+        DumpState = T.type_alias { { can_retry: T::Boolean } }
 
         # @api private
         sig do
           overridable
-            .params(value: T.anything, state: Knockapi::Internal::Type::Converter::CoerceState)
+            .params(
+              value: T.anything,
+              state: Knockapi::Internal::Type::Converter::CoerceState
+            )
             .returns(T.anything)
         end
-        def coerce(value, state:); end
+        def coerce(value, state:)
+        end
 
         # @api private
         sig do
           overridable
-            .params(value: T.anything, state: Knockapi::Internal::Type::Converter::DumpState)
+            .params(
+              value: T.anything,
+              state: Knockapi::Internal::Type::Converter::DumpState
+            )
             .returns(T.anything)
         end
-        def dump(value, state:); end
+        def dump(value, state:)
+        end
 
         # @api private
         sig { params(depth: Integer).returns(String) }
-        def inspect(depth: 0); end
+        def inspect(depth: 0)
+        end
 
         class << self
           # @api private
           sig do
             params(
-              spec: T.any(
-                {
-                  const: T.nilable(T.any(NilClass, T::Boolean, Integer, Float, Symbol)),
-                  enum: T.nilable(T.proc.returns(Knockapi::Internal::Type::Converter::Input)),
-                  union: T.nilable(T.proc.returns(Knockapi::Internal::Type::Converter::Input))
-                },
-                T.proc.returns(Knockapi::Internal::Type::Converter::Input),
-                Knockapi::Internal::Type::Converter::Input
-              )
-            )
-              .returns(T.proc.returns(T.anything))
+              spec:
+                T.any(
+                  {
+                    const:
+                      T.nilable(
+                        T.any(NilClass, T::Boolean, Integer, Float, Symbol)
+                      ),
+                    enum:
+                      T.nilable(
+                        T.proc.returns(
+                          Knockapi::Internal::Type::Converter::Input
+                        )
+                      ),
+                    union:
+                      T.nilable(
+                        T.proc.returns(
+                          Knockapi::Internal::Type::Converter::Input
+                        )
+                      )
+                  },
+                  T.proc.returns(Knockapi::Internal::Type::Converter::Input),
+                  Knockapi::Internal::Type::Converter::Input
+                )
+            ).returns(T.proc.returns(T.anything))
+          end
+          def self.type_info(spec)
           end
-          def self.type_info(spec); end
 
           # @api private
           #
@@ -72,8 +104,7 @@ module Knockapi
               target: Knockapi::Internal::Type::Converter::Input,
               value: T.anything,
               state: Knockapi::Internal::Type::Converter::CoerceState
-            )
-              .returns(T.anything)
+            ).returns(T.anything)
           end
           def self.coerce(
             target,
@@ -97,22 +128,33 @@ module Knockapi
             # - `no`: the value cannot be converted to the target type.
             #
             # See implementation below for more details.
-            state: {strictness: true, exactness: {yes: 0, no: 0, maybe: 0}, branched: 0}
-          ); end
+            state: {
+              strictness: true,
+              exactness: {
+                yes: 0,
+                no: 0,
+                maybe: 0
+              },
+              branched: 0
+            }
+          )
+          end
+
           # @api private
           sig do
             params(
               target: Knockapi::Internal::Type::Converter::Input,
               value: T.anything,
               state: Knockapi::Internal::Type::Converter::DumpState
-            )
-              .returns(T.anything)
+            ).returns(T.anything)
+          end
+          def self.dump(target, value, state: { can_retry: true })
           end
-          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
+          def self.inspect(target, depth:)
+          end
         end
       end
     end

data/rbi/knockapi/internal/type/enum.rbi

@@ -17,19 +17,28 @@ module Knockapi
       # values safely.
       module Enum
         include Knockapi::Internal::Type::Converter
+        include Knockapi::Internal::Util::SorbetRuntimeSupport
 
         # All of the valid Symbol values for this enum.
-        sig { overridable.returns(T::Array[T.any(NilClass, T::Boolean, Integer, Float, Symbol)]) }
-        def values; end
+        sig do
+          overridable.returns(
+            T::Array[T.any(NilClass, T::Boolean, Integer, Float, Symbol)]
+          )
+        end
+        def values
+        end
 
         sig { params(other: T.anything).returns(T::Boolean) }
-        def ===(other); end
+        def ===(other)
+        end
 
         sig { params(other: T.anything).returns(T::Boolean) }
-        def ==(other); end
+        def ==(other)
+        end
 
         sig { returns(Integer) }
-        def hash; end
+        def hash
+        end
 
         # @api private
         #
@@ -37,27 +46,36 @@ module Knockapi
         # of the enum.
         sig do
           override
-            .params(value: T.any(
-              String,
-              Symbol,
-              T.anything
-            ),
-                    state: Knockapi::Internal::Type::Converter::CoerceState)
+            .params(
+              value: T.any(String, Symbol, T.anything),
+              state: Knockapi::Internal::Type::Converter::CoerceState
+            )
             .returns(T.any(Symbol, T.anything))
         end
-        def coerce(value, state:); end
+        def coerce(value, state:)
+        end
 
         # @api private
         sig do
           override
-            .params(value: T.any(Symbol, T.anything), state: Knockapi::Internal::Type::Converter::DumpState)
+            .params(
+              value: T.any(Symbol, T.anything),
+              state: Knockapi::Internal::Type::Converter::DumpState
+            )
             .returns(T.any(Symbol, T.anything))
         end
-        def dump(value, state:); end
+        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
+        def inspect(depth: 0)
+        end
       end
     end
   end

data/rbi/knockapi/internal/type/file_input.rbi

@@ -16,10 +16,12 @@ module Knockapi
         abstract!
 
         sig { params(other: T.anything).returns(T::Boolean) }
-        def self.===(other); end
+        def self.===(other)
+        end
 
         sig { params(other: T.anything).returns(T::Boolean) }
-        def self.==(other); end
+        def self.==(other)
+        end
 
         class << self
           # @api private
@@ -31,7 +33,8 @@ module Knockapi
               )
               .returns(T.any(StringIO, T.anything))
           end
-          def coerce(value, state:); end
+          def coerce(value, state:)
+          end
 
           # @api private
           sig do
@@ -42,7 +45,13 @@ module Knockapi
               )
               .returns(T.any(Pathname, StringIO, IO, String, T.anything))
           end
-          def dump(value, state:); end
+          def dump(value, state:)
+          end
+
+          # @api private
+          sig { returns(T.anything) }
+          def to_sorbet_type
+          end
         end
       end
     end

data/rbi/knockapi/internal/type/hash_of.rbi

@@ -8,6 +8,7 @@ module Knockapi
       # Hash of items of a given type.
       class HashOf
         include Knockapi::Internal::Type::Converter
+        include Knockapi::Internal::Util::SorbetRuntimeSupport
 
         abstract!
 
@@ -15,25 +16,29 @@ module Knockapi
 
         sig do
           params(
-            type_info: T.any(
-              Knockapi::Internal::AnyHash,
-              T.proc.returns(Knockapi::Internal::Type::Converter::Input),
-              Knockapi::Internal::Type::Converter::Input
-            ),
+            type_info:
+              T.any(
+                Knockapi::Internal::AnyHash,
+                T.proc.returns(Knockapi::Internal::Type::Converter::Input),
+                Knockapi::Internal::Type::Converter::Input
+              ),
             spec: Knockapi::Internal::AnyHash
-          )
-            .returns(T.attached_class)
+          ).returns(T.attached_class)
+        end
+        def self.[](type_info, spec = {})
         end
-        def self.[](type_info, spec = {}); end
 
         sig { params(other: T.anything).returns(T::Boolean) }
-        def ===(other); end
+        def ===(other)
+        end
 
         sig { params(other: T.anything).returns(T::Boolean) }
-        def ==(other); end
+        def ==(other)
+        end
 
         sig { returns(Integer) }
-        def hash; end
+        def hash
+        end
 
         # @api private
         sig do
@@ -44,7 +49,8 @@ module Knockapi
             )
             .returns(T.any(Knockapi::Internal::AnyHash, T.anything))
         end
-        def coerce(value, state:); end
+        def coerce(value, state:)
+        end
 
         # @api private
         sig do
@@ -55,33 +61,43 @@ module Knockapi
             )
             .returns(T.any(Knockapi::Internal::AnyHash, T.anything))
         end
-        def dump(value, state:); end
+        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
+        protected def item_type
+        end
 
         # @api private
         sig { returns(T::Boolean) }
-        protected def nilable?; end
+        protected def nilable?
+        end
 
         # @api private
         sig do
           params(
-            type_info: T.any(
-              Knockapi::Internal::AnyHash,
-              T.proc.returns(Knockapi::Internal::Type::Converter::Input),
-              Knockapi::Internal::Type::Converter::Input
-            ),
+            type_info:
+              T.any(
+                Knockapi::Internal::AnyHash,
+                T.proc.returns(Knockapi::Internal::Type::Converter::Input),
+                Knockapi::Internal::Type::Converter::Input
+              ),
             spec: Knockapi::Internal::AnyHash
-          )
-            .void
+          ).void
+        end
+        def initialize(type_info, spec = {})
         end
-        def initialize(type_info, spec = {}); end
 
         # @api private
         sig { params(depth: Integer).returns(String) }
-        def inspect(depth: 0); end
+        def inspect(depth: 0)
+        end
       end
     end
   end

data/rbi/knockapi/internal/type/request_parameters.rbi

@@ -6,14 +6,22 @@ module Knockapi
       # @api private
       module RequestParameters
         # Options to specify HTTP behaviour for this request.
-        sig { returns(Knockapi::RequestOpts) }
-        attr_accessor :request_options
+        sig { returns(Knockapi::RequestOptions) }
+        attr_reader :request_options
+
+        sig { params(request_options: Knockapi::RequestOptions::OrHash).void }
+        attr_writer :request_options
 
         # @api private
         module Converter
           # @api private
-          sig { params(params: T.anything).returns([T.anything, Knockapi::Internal::AnyHash]) }
-          def dump_request(params); end
+          sig do
+            params(params: T.anything).returns(
+              [T.anything, Knockapi::Internal::AnyHash]
+            )
+          end
+          def dump_request(params)
+          end
         end
       end
     end

data/rbi/knockapi/internal/type/union.rbi

@@ -6,69 +6,110 @@ module Knockapi
       # @api private
       module Union
         include Knockapi::Internal::Type::Converter
+        include Knockapi::Internal::Util::SorbetRuntimeSupport
 
         # @api private
         #
         # All of the specified variant info for this union.
         sig do
-          returns(T::Array[[T.nilable(Symbol), T.proc.returns(Knockapi::Internal::Type::Converter::Input)]])
+          returns(
+            T::Array[
+              [
+                T.nilable(Symbol),
+                T.proc.returns(Knockapi::Internal::Type::Converter::Input)
+              ]
+            ]
+          )
+        end
+        private def known_variants
         end
-        private def known_variants; end
 
         # @api private
         sig { returns(T::Array[[T.nilable(Symbol), T.anything]]) }
-        protected def derefed_variants; end
+        protected def derefed_variants
+        end
 
         # All of the specified variants for this union.
         sig { overridable.returns(T::Array[T.anything]) }
-        def variants; end
+        def variants
+        end
 
         # @api private
         sig { params(property: Symbol).void }
-        private def discriminator(property); end
+        private def discriminator(property)
+        end
 
         # @api private
         sig do
           params(
-            key: T.any(Symbol, Knockapi::Internal::AnyHash, T.proc.returns(T.anything), T.anything),
-            spec: T.any(Knockapi::Internal::AnyHash, T.proc.returns(T.anything), T.anything)
-          )
-            .void
+            key:
+              T.any(
+                Symbol,
+                Knockapi::Internal::AnyHash,
+                T.proc.returns(T.anything),
+                T.anything
+              ),
+            spec:
+              T.any(
+                Knockapi::Internal::AnyHash,
+                T.proc.returns(T.anything),
+                T.anything
+              )
+          ).void
+        end
+        private def variant(key, spec = nil)
         end
-        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
+        private def resolve_variant(value)
+        end
 
         sig { params(other: T.anything).returns(T::Boolean) }
-        def ===(other); end
+        def ===(other)
+        end
 
         sig { params(other: T.anything).returns(T::Boolean) }
-        def ==(other); end
+        def ==(other)
+        end
 
         sig { returns(Integer) }
-        def hash; end
+        def hash
+        end
 
         # @api private
         sig do
           override
-            .params(value: T.anything, state: Knockapi::Internal::Type::Converter::CoerceState)
+            .params(
+              value: T.anything,
+              state: Knockapi::Internal::Type::Converter::CoerceState
+            )
             .returns(T.anything)
         end
-        def coerce(value, state:); end
+        def coerce(value, state:)
+        end
 
         # @api private
         sig do
           override
-            .params(value: T.anything, state: Knockapi::Internal::Type::Converter::DumpState)
+            .params(
+              value: T.anything,
+              state: Knockapi::Internal::Type::Converter::DumpState
+            )
             .returns(T.anything)
         end
-        def dump(value, state:); end
+        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
+        def inspect(depth: 0)
+        end
       end
     end
   end

data/rbi/knockapi/internal/type/unknown.rbi

@@ -8,31 +8,47 @@ module Knockapi
       # When we don't know what to expect for the value.
       class Unknown
         extend Knockapi::Internal::Type::Converter
+        extend Knockapi::Internal::Util::SorbetRuntimeSupport
 
         abstract!
 
         sig { params(other: T.anything).returns(T::Boolean) }
-        def self.===(other); end
+        def self.===(other)
+        end
 
         sig { params(other: T.anything).returns(T::Boolean) }
-        def self.==(other); end
+        def self.==(other)
+        end
 
         class << self
           # @api private
           sig do
             override
-              .params(value: T.anything, state: Knockapi::Internal::Type::Converter::CoerceState)
+              .params(
+                value: T.anything,
+                state: Knockapi::Internal::Type::Converter::CoerceState
+              )
               .returns(T.anything)
           end
-          def coerce(value, state:); end
+          def coerce(value, state:)
+          end
 
           # @api private
           sig do
             override
-              .params(value: T.anything, state: Knockapi::Internal::Type::Converter::DumpState)
+              .params(
+                value: T.anything,
+                state: Knockapi::Internal::Type::Converter::DumpState
+              )
               .returns(T.anything)
           end
-          def dump(value, state:); end
+          def dump(value, state:)
+          end
+
+          # @api private
+          sig { returns(T.anything) }
+          def to_sorbet_type
+          end
         end
       end
     end