terminal-shop 3.6.1 → 3.7.0

data/rbi/terminal_shop/internal/type/base_model.rbi

@@ -5,30 +5,55 @@ module TerminalShop
     module Type
       class BaseModel
         extend TerminalShop::Internal::Type::Converter
+        extend TerminalShop::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(
+              TerminalShop::Internal::Type::BaseModel,
+              TerminalShop::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(
-                  TerminalShop::Internal::Type::BaseModel::KnownFieldShape,
-                  {type_fn: T.proc.returns(TerminalShop::Internal::Type::Converter::Input)}
+                  TerminalShop::Internal::Type::BaseModel::KnownField,
+                  {
+                    type_fn:
+                      T.proc.returns(
+                        TerminalShop::Internal::Type::Converter::Input
+                      )
+                  }
                 )
               ]
             )
           end
-          def known_fields; end
+          def known_fields
+          end
 
           # @api private
           sig do
@@ -36,107 +61,138 @@ module TerminalShop
               T::Hash[
                 Symbol,
                 T.all(
-                  TerminalShop::Internal::Type::BaseModel::KnownFieldShape,
-                  {type: TerminalShop::Internal::Type::Converter::Input}
+                  TerminalShop::Internal::Type::BaseModel::KnownField,
+                  { type: TerminalShop::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(TerminalShop::Internal::Type::Converter::Input)),
-                  union: T.nilable(T.proc.returns(TerminalShop::Internal::Type::Converter::Input)),
-                  api_name: Symbol,
-                  nil?: T::Boolean
-                },
-                T.proc.returns(TerminalShop::Internal::Type::Converter::Input),
-                TerminalShop::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(
+                          TerminalShop::Internal::Type::Converter::Input
+                        )
+                      ),
+                    union:
+                      T.nilable(
+                        T.proc.returns(
+                          TerminalShop::Internal::Type::Converter::Input
+                        )
+                      ),
+                    api_name: Symbol,
+                    nil?: T::Boolean
+                  },
+                  T.proc.returns(
+                    TerminalShop::Internal::Type::Converter::Input
+                  ),
+                  TerminalShop::Internal::Type::Converter::Input
+                ),
               spec: TerminalShop::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(
-                TerminalShop::Internal::AnyHash,
-                T.proc.returns(TerminalShop::Internal::Type::Converter::Input),
-                TerminalShop::Internal::Type::Converter::Input
-              ),
+              type_info:
+                T.any(
+                  TerminalShop::Internal::AnyHash,
+                  T.proc.returns(
+                    TerminalShop::Internal::Type::Converter::Input
+                  ),
+                  TerminalShop::Internal::Type::Converter::Input
+                ),
               spec: TerminalShop::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(
-                TerminalShop::Internal::AnyHash,
-                T.proc.returns(TerminalShop::Internal::Type::Converter::Input),
-                TerminalShop::Internal::Type::Converter::Input
-              ),
+              type_info:
+                T.any(
+                  TerminalShop::Internal::AnyHash,
+                  T.proc.returns(
+                    TerminalShop::Internal::Type::Converter::Input
+                  ),
+                  TerminalShop::Internal::Type::Converter::Input
+                ),
               spec: TerminalShop::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(
-                  TerminalShop::Internal::Type::BaseModel,
-                  T::Hash[T.anything, T.anything],
-                  T.anything
-                ),
+                value:
+                  T.any(
+                    TerminalShop::Internal::Type::BaseModel,
+                    T::Hash[T.anything, T.anything],
+                    T.anything
+                  ),
                 state: TerminalShop::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
@@ -147,7 +203,20 @@ module TerminalShop
               )
               .returns(T.any(T::Hash[T.anything, T.anything], T.anything))
           end
-          def dump(value, state:); end
+          def dump(value, state:)
+          end
+        end
+
+        class << self
+          # @api private
+          sig do
+            params(
+              model: TerminalShop::Internal::Type::BaseModel,
+              convert: T::Boolean
+            ).returns(TerminalShop::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
@@ -157,7 +226,8 @@ module TerminalShop
         # 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)
         #
@@ -168,7 +238,8 @@ module TerminalShop
         # This method is not recursive. The returned value is shared by the object, so it
         # should not be mutated.
         sig { overridable.returns(TerminalShop::Internal::AnyHash) }
-        def to_h; end
+        def to_h
+        end
 
         # Returns a Hash of the data underlying this object. O(1)
         #
@@ -179,41 +250,55 @@ module TerminalShop
         # This method is not recursive. The returned value is shared by the object, so it
         # should not be mutated.
         sig { overridable.returns(TerminalShop::Internal::AnyHash) }
-        def to_hash; end
+        def to_hash
+        end
 
-        sig { params(keys: T.nilable(T::Array[Symbol])).returns(TerminalShop::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(TerminalShop::Internal::AnyHash) }
+        def deep_to_h
+        end
 
-        class << self
-          # @api private
-          sig do
-            params(model: TerminalShop::Internal::Type::BaseModel).returns(TerminalShop::Internal::AnyHash)
-          end
-          def walk(model); end
+        sig do
+          params(keys: T.nilable(T::Array[Symbol])).returns(
+            TerminalShop::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/terminal_shop/internal/type/base_page.rbi

@@ -10,28 +10,33 @@ module TerminalShop
         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: TerminalShop::Internal::Transport::BaseClient,
-            req: TerminalShop::Internal::Transport::BaseClient::RequestComponentsShape,
+            req:
+              TerminalShop::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/terminal_shop/internal/type/boolean.rbi

@@ -12,35 +12,37 @@ module TerminalShop
         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: TerminalShop::Internal::Type::Converter::CoerceState)
+              .params(
+                value: T.any(T::Boolean, T.anything),
+                state: TerminalShop::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: TerminalShop::Internal::Type::Converter::DumpState)
+              .params(
+                value: T.any(T::Boolean, T.anything),
+                state: TerminalShop::Internal::Type::Converter::DumpState
+              )
               .returns(T.any(T::Boolean, T.anything))
           end
-          def dump(value, state:); end
+          def dump(value, state:)
+          end
         end
       end
     end

data/rbi/terminal_shop/internal/type/converter.rbi

@@ -5,56 +5,90 @@ module TerminalShop
     module Type
       # @api private
       module Converter
-        Input = T.type_alias { T.any(TerminalShop::Internal::Type::Converter, T::Class[T.anything]) }
+        extend TerminalShop::Internal::Util::SorbetRuntimeSupport
+
+        Input =
+          T.type_alias do
+            T.any(TerminalShop::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: TerminalShop::Internal::Type::Converter::CoerceState)
+            .params(
+              value: T.anything,
+              state: TerminalShop::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: TerminalShop::Internal::Type::Converter::DumpState)
+            .params(
+              value: T.anything,
+              state: TerminalShop::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(TerminalShop::Internal::Type::Converter::Input)),
-                  union: T.nilable(T.proc.returns(TerminalShop::Internal::Type::Converter::Input))
-                },
-                T.proc.returns(TerminalShop::Internal::Type::Converter::Input),
-                TerminalShop::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(
+                          TerminalShop::Internal::Type::Converter::Input
+                        )
+                      ),
+                    union:
+                      T.nilable(
+                        T.proc.returns(
+                          TerminalShop::Internal::Type::Converter::Input
+                        )
+                      )
+                  },
+                  T.proc.returns(
+                    TerminalShop::Internal::Type::Converter::Input
+                  ),
+                  TerminalShop::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 +106,7 @@ module TerminalShop
               target: TerminalShop::Internal::Type::Converter::Input,
               value: T.anything,
               state: TerminalShop::Internal::Type::Converter::CoerceState
-            )
-              .returns(T.anything)
+            ).returns(T.anything)
           end
           def self.coerce(
             target,
@@ -97,22 +130,33 @@ module TerminalShop
             # - `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: TerminalShop::Internal::Type::Converter::Input,
               value: T.anything,
               state: TerminalShop::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/terminal_shop/internal/type/enum.rbi

@@ -17,19 +17,28 @@ module TerminalShop
       # values safely.
       module Enum
         include TerminalShop::Internal::Type::Converter
+        include TerminalShop::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
         #
@@ -43,23 +52,25 @@ module TerminalShop
             )
             .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: TerminalShop::Internal::Type::Converter::DumpState)
+            .params(
+              value: T.any(Symbol, T.anything),
+              state: TerminalShop::Internal::Type::Converter::DumpState
+            )
             .returns(T.any(Symbol, 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
       end
     end
   end