knockapi 1.0.0 → 1.2.0

data/rbi/knockapi/internal/transport/pooled_net_requester.rbi

@@ -5,7 +5,9 @@ module Knockapi
     module Transport
       # @api private
       class PooledNetRequester
-        RequestShape =
+        extend Knockapi::Internal::Util::SorbetRuntimeSupport
+
+        Request =
           T.type_alias do
             {
               method: Symbol,
@@ -20,40 +22,57 @@ module Knockapi
         # https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49
         KEEP_ALIVE_TIMEOUT = 30
 
+        DEFAULT_MAX_CONNECTIONS = T.let(T.unsafe(nil), Integer)
+
         class << self
           # @api private
           sig { params(url: URI::Generic).returns(Net::HTTP) }
-          def connect(url); end
+          def connect(url)
+          end
 
           # @api private
           sig { params(conn: Net::HTTP, deadline: Float).void }
-          def calibrate_socket_timeout(conn, deadline); end
+          def calibrate_socket_timeout(conn, deadline)
+          end
 
           # @api private
           sig do
             params(
-              request: Knockapi::Internal::Transport::PooledNetRequester::RequestShape,
+              request:
+                Knockapi::Internal::Transport::PooledNetRequester::Request,
               blk: T.proc.params(arg0: String).void
-            )
-              .returns([Net::HTTPGenericRequest, T.proc.void])
+            ).returns([Net::HTTPGenericRequest, T.proc.void])
+          end
+          def build_request(request, &blk)
           end
-          def build_request(request, &blk); end
         end
 
         # @api private
-        sig { params(url: URI::Generic, deadline: Float, blk: T.proc.params(arg0: Net::HTTP).void).void }
-        private def with_pool(url, deadline:, &blk); end
+        sig do
+          params(
+            url: URI::Generic,
+            deadline: Float,
+            blk: T.proc.params(arg0: Net::HTTP).void
+          ).void
+        end
+        private def with_pool(url, deadline:, &blk)
+        end
 
         # @api private
         sig do
-          params(request: Knockapi::Internal::Transport::PooledNetRequester::RequestShape)
-            .returns([Integer, Net::HTTPResponse, T::Enumerable[String]])
+          params(
+            request: Knockapi::Internal::Transport::PooledNetRequester::Request
+          ).returns([Integer, Net::HTTPResponse, T::Enumerable[String]])
+        end
+        def execute(request)
         end
-        def execute(request); end
 
         # @api private
         sig { params(size: Integer).returns(T.attached_class) }
-        def self.new(size: Etc.nprocessors); end
+        def self.new(
+          size: Knockapi::Internal::Transport::PooledNetRequester::DEFAULT_MAX_CONNECTIONS
+        )
+        end
       end
     end
   end

data/rbi/knockapi/internal/type/array_of.rbi

@@ -8,6 +8,7 @@ module Knockapi
       # Array of items of a given type.
       class ArrayOf
         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(T::Array[T.anything], 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(T::Array[T.anything], 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/base_model.rbi

@@ -5,30 +5,53 @@ module Knockapi
     module Type
       class BaseModel
         extend Knockapi::Internal::Type::Converter
+        extend Knockapi::Internal::Util::SorbetRuntimeSupport
 
         abstract!
 
-        KnownFieldShape = T.type_alias do
-          {mode: T.nilable(Symbol), required: T::Boolean, nilable: T::Boolean}
-        end
+        KnownField =
+          T.type_alias do
+            {
+              mode: T.nilable(Symbol),
+              required: T::Boolean,
+              nilable: T::Boolean
+            }
+          end
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Internal::Type::BaseModel,
+              Knockapi::Internal::AnyHash
+            )
+          end
 
         class << self
           # @api private
           #
           # Assumes superclass fields are totally defined before fields are accessed /
           # defined on subclasses.
+          sig { params(child: T.self_type).void }
+          def inherited(child)
+          end
+
+          # @api private
           sig do
             returns(
               T::Hash[
                 Symbol,
                 T.all(
-                  Knockapi::Internal::Type::BaseModel::KnownFieldShape,
-                  {type_fn: T.proc.returns(Knockapi::Internal::Type::Converter::Input)}
+                  Knockapi::Internal::Type::BaseModel::KnownField,
+                  {
+                    type_fn:
+                      T.proc.returns(Knockapi::Internal::Type::Converter::Input)
+                  }
                 )
               ]
             )
           end
-          def known_fields; end
+          def known_fields
+          end
 
           # @api private
           sig do
@@ -36,119 +59,161 @@ module Knockapi
               T::Hash[
                 Symbol,
                 T.all(
-                  Knockapi::Internal::Type::BaseModel::KnownFieldShape,
-                  {type: Knockapi::Internal::Type::Converter::Input}
+                  Knockapi::Internal::Type::BaseModel::KnownField,
+                  { type: Knockapi::Internal::Type::Converter::Input }
                 )
               ]
             )
           end
-          def fields; end
+          def fields
+          end
 
           # @api private
           sig do
             params(
               name_sym: Symbol,
               required: T::Boolean,
-              type_info: 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)),
-                  api_name: Symbol,
-                  nil?: T::Boolean
-                },
-                T.proc.returns(Knockapi::Internal::Type::Converter::Input),
-                Knockapi::Internal::Type::Converter::Input
-              ),
+              type_info:
+                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
+                        )
+                      ),
+                    api_name: Symbol,
+                    nil?: T::Boolean
+                  },
+                  T.proc.returns(Knockapi::Internal::Type::Converter::Input),
+                  Knockapi::Internal::Type::Converter::Input
+                ),
               spec: Knockapi::Internal::AnyHash
-            )
-              .void
+            ).void
+          end
+          private def add_field(name_sym, required:, type_info:, spec:)
           end
-          private def add_field(name_sym, required:, type_info:, spec:); end
 
           # @api private
           sig do
             params(
               name_sym: Symbol,
-              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 required(name_sym, type_info, spec = {})
           end
-          def required(name_sym, type_info, spec = {}); end
 
           # @api private
           sig do
             params(
               name_sym: Symbol,
-              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 optional(name_sym, type_info, spec = {})
           end
-          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
+          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
+          private def response_only(&blk)
+          end
 
           sig { params(other: T.anything).returns(T::Boolean) }
-          def ==(other); end
+          def ==(other)
+          end
 
           sig { returns(Integer) }
-          def hash; end
+          def hash
+          end
         end
 
         sig { params(other: T.anything).returns(T::Boolean) }
-        def ==(other); end
+        def ==(other)
+        end
 
         sig { returns(Integer) }
-        def hash; end
+        def hash
+        end
 
         class << self
           # @api private
           sig do
             override
               .params(
-                value: T.any(
-                  Knockapi::Internal::Type::BaseModel,
-                  T::Hash[T.anything, T.anything],
-                  T.anything
-                ),
+                value:
+                  T.any(
+                    Knockapi::Internal::Type::BaseModel,
+                    T::Hash[T.anything, T.anything],
+                    T.anything
+                  ),
                 state: Knockapi::Internal::Type::Converter::CoerceState
               )
               .returns(T.any(T.attached_class, T.anything))
           end
-          def coerce(value, state:); end
+          def coerce(value, state:)
+          end
 
           # @api private
           sig do
             override
-              .params(value: T.any(
-                T.attached_class,
-                T.anything
-              ),
-                      state: Knockapi::Internal::Type::Converter::DumpState)
+              .params(
+                value: T.any(T.attached_class, T.anything),
+                state: Knockapi::Internal::Type::Converter::DumpState
+              )
               .returns(T.any(T::Hash[T.anything, T.anything], 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
+
+        class << self
+          # @api private
+          sig do
+            params(
+              model: Knockapi::Internal::Type::BaseModel,
+              convert: T::Boolean
+            ).returns(Knockapi::Internal::AnyHash)
+          end
+          def recursively_to_h(model, convert:)
+          end
         end
 
         # Returns the raw value associated with the given key, if found. Otherwise, nil is
@@ -158,7 +223,8 @@ module Knockapi
         # 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
+        def [](key)
+        end
 
         # Returns a Hash of the data underlying this object. O(1)
         #
@@ -169,7 +235,8 @@ module Knockapi
         # This method is not recursive. The returned value is shared by the object, so it
         # should not be mutated.
         sig { overridable.returns(Knockapi::Internal::AnyHash) }
-        def to_h; end
+        def to_h
+        end
 
         # Returns a Hash of the data underlying this object. O(1)
         #
@@ -180,39 +247,55 @@ module Knockapi
         # This method is not recursive. The returned value is shared by the object, so it
         # should not be mutated.
         sig { overridable.returns(Knockapi::Internal::AnyHash) }
-        def to_hash; end
+        def to_hash
+        end
 
-        sig { params(keys: T.nilable(T::Array[Symbol])).returns(Knockapi::Internal::AnyHash) }
-        def deconstruct_keys(keys); end
+        # In addition to the behaviour of `#to_h`, this method will recursively call
+        # `#to_h` on nested models.
+        sig { overridable.returns(Knockapi::Internal::AnyHash) }
+        def deep_to_h
+        end
 
-        class << self
-          # @api private
-          sig { params(model: Knockapi::Internal::Type::BaseModel).returns(Knockapi::Internal::AnyHash) }
-          def walk(model); end
+        sig do
+          params(keys: T.nilable(T::Array[Symbol])).returns(
+            Knockapi::Internal::AnyHash
+          )
+        end
+        def deconstruct_keys(keys)
         end
 
         sig { params(a: T.anything).returns(String) }
-        def to_json(*a); end
+        def to_json(*a)
+        end
 
         sig { params(a: T.anything).returns(String) }
-        def to_yaml(*a); end
+        def to_yaml(*a)
+        end
 
         # Create a new instance of a model.
-        sig { params(data: T.any(T::Hash[Symbol, T.anything], T.self_type)).returns(T.attached_class) }
-        def self.new(data = {}); end
+        sig do
+          params(data: T.any(T::Hash[Symbol, T.anything], T.self_type)).returns(
+            T.attached_class
+          )
+        end
+        def self.new(data = {})
+        end
 
         class << self
           # @api private
           sig { params(depth: Integer).returns(String) }
-          def inspect(depth: 0); end
+          def inspect(depth: 0)
+          end
         end
 
         sig { returns(String) }
-        def to_s; end
+        def to_s
+        end
 
         # @api private
         sig { returns(String) }
-        def inspect; end
+        def inspect
+        end
       end
     end
   end

data/rbi/knockapi/internal/type/base_page.rbi

@@ -10,28 +10,32 @@ module Knockapi
         Elem = type_member(:out)
 
         sig { overridable.returns(T::Boolean) }
-        def next_page?; end
+        def next_page?
+        end
 
         sig { overridable.returns(T.self_type) }
-        def next_page; end
+        def next_page
+        end
 
         sig { overridable.params(blk: T.proc.params(arg0: Elem).void).void }
-        def auto_paging_each(&blk); end
+        def auto_paging_each(&blk)
+        end
 
         sig { returns(T::Enumerable[Elem]) }
-        def to_enum; end
+        def to_enum
+        end
 
         # @api private
         sig do
           params(
             client: Knockapi::Internal::Transport::BaseClient,
-            req: Knockapi::Internal::Transport::BaseClient::RequestComponentsShape,
+            req: Knockapi::Internal::Transport::BaseClient::RequestComponents,
             headers: T.any(T::Hash[String, String], Net::HTTPHeader),
             page_data: T.anything
-          )
-            .void
+          ).void
+        end
+        def initialize(client:, req:, headers:, page_data:)
         end
-        def initialize(client:, req:, headers:, page_data:); end
       end
     end
   end

data/rbi/knockapi/internal/type/boolean.rbi

@@ -8,39 +8,47 @@ module Knockapi
       # Ruby has no Boolean class; this is something for models to refer to.
       class Boolean
         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.any(
-                T::Boolean,
-                T.anything
-              ),
-                      state: Knockapi::Internal::Type::Converter::CoerceState)
+              .params(
+                value: T.any(T::Boolean, T.anything),
+                state: Knockapi::Internal::Type::Converter::CoerceState
+              )
               .returns(T.any(T::Boolean, T.anything))
           end
-          def coerce(value, state:); end
+          def coerce(value, state:)
+          end
 
           # @api private
           sig do
             override
-              .params(value: T.any(
-                T::Boolean,
-                T.anything
-              ),
-                      state: Knockapi::Internal::Type::Converter::DumpState)
+              .params(
+                value: T.any(T::Boolean, T.anything),
+                state: Knockapi::Internal::Type::Converter::DumpState
+              )
               .returns(T.any(T::Boolean, 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