terminal-shop 2.1.3 → 3.5.0

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

@@ -0,0 +1,220 @@
+# typed: strong
+
+module TerminalShop
+  module Internal
+    module Type
+      class BaseModel
+        extend TerminalShop::Internal::Type::Converter
+
+        abstract!
+
+        KnownFieldShape = T.type_alias do
+          {mode: T.nilable(Symbol), required: T::Boolean, nilable: T::Boolean}
+        end
+
+        class << self
+          # @api private
+          #
+          # Assumes superclass fields are totally defined before fields are accessed /
+          # defined on subclasses.
+          sig do
+            returns(
+              T::Hash[
+                Symbol,
+                T.all(
+                  TerminalShop::Internal::Type::BaseModel::KnownFieldShape,
+                  {type_fn: T.proc.returns(TerminalShop::Internal::Type::Converter::Input)}
+                )
+              ]
+            )
+          end
+          def known_fields; end
+
+          # @api private
+          sig do
+            returns(
+              T::Hash[
+                Symbol,
+                T.all(
+                  TerminalShop::Internal::Type::BaseModel::KnownFieldShape,
+                  {type: TerminalShop::Internal::Type::Converter::Input}
+                )
+              ]
+            )
+          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
+              ),
+              spec: TerminalShop::Internal::AnyHash
+            )
+              .void
+          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
+              ),
+              spec: TerminalShop::Internal::AnyHash
+            )
+              .void
+          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
+              ),
+              spec: TerminalShop::Internal::AnyHash
+            )
+              .void
+          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
+
+          # @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
+
+          sig { params(other: T.anything).returns(T::Boolean) }
+          def ==(other); end
+
+          sig { returns(Integer) }
+          def hash; end
+        end
+
+        sig { params(other: T.anything).returns(T::Boolean) }
+        def ==(other); end
+
+        sig { returns(Integer) }
+        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
+                ),
+                state: TerminalShop::Internal::Type::Converter::CoerceState
+              )
+              .returns(T.any(T.attached_class, T.anything))
+          end
+          def coerce(value, state:); end
+
+          # @api private
+          sig do
+            override
+              .params(
+                value: T.any(T.attached_class, T.anything),
+                state: TerminalShop::Internal::Type::Converter::DumpState
+              )
+              .returns(T.any(T::Hash[T.anything, T.anything], T.anything))
+          end
+          def dump(value, state:); 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(TerminalShop::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(TerminalShop::Internal::AnyHash) }
+        def to_hash; end
+
+        sig { params(keys: T.nilable(T::Array[Symbol])).returns(TerminalShop::Internal::AnyHash) }
+        def deconstruct_keys(keys); end
+
+        class << self
+          # @api private
+          sig do
+            params(model: TerminalShop::Internal::Type::BaseModel).returns(TerminalShop::Internal::AnyHash)
+          end
+          def walk(model); end
+        end
+
+        sig { params(a: T.anything).returns(String) }
+        def to_json(*a); end
+
+        sig { params(a: T.anything).returns(String) }
+        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
+
+        class << self
+          # @api private
+          sig { params(depth: Integer).returns(String) }
+          def inspect(depth: 0); end
+        end
+
+        sig { returns(String) }
+        def to_s; end
+
+        # @api private
+        sig { returns(String) }
+        def inspect; end
+      end
+    end
+  end
+end

data/rbi/lib/terminal_shop/internal/type/base_page.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module TerminalShop
+  module Internal
+    module Type
+      # @api private
+      #
+      # This module provides a base implementation for paginated responses in the SDK.
+      module BasePage
+        Elem = type_member(:out)
+
+        sig { overridable.returns(T::Boolean) }
+        def next_page?; end
+
+        sig { overridable.returns(T.self_type) }
+        def next_page; end
+
+        sig { overridable.params(blk: T.proc.params(arg0: Elem).void).void }
+        def auto_paging_each(&blk); end
+
+        sig { returns(T::Enumerable[Elem]) }
+        def to_enum; end
+
+        # @api private
+        sig do
+          params(
+            client: TerminalShop::Internal::Transport::BaseClient,
+            req: TerminalShop::Internal::Transport::BaseClient::RequestComponentsShape,
+            headers: T.any(T::Hash[String, String], Net::HTTPHeader),
+            page_data: T.anything
+          )
+            .void
+        end
+        def initialize(client:, req:, headers:, page_data:); end
+      end
+    end
+  end
+end

data/rbi/lib/terminal_shop/internal/type/boolean.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module TerminalShop
+  module Internal
+    module Type
+      # @api private
+      #
+      # Ruby has no Boolean class; this is something for models to refer to.
+      class Boolean
+        extend TerminalShop::Internal::Type::Converter
+
+        abstract!
+
+        sig { params(other: T.anything).returns(T::Boolean) }
+        def self.===(other); end
+
+        sig { params(other: T.anything).returns(T::Boolean) }
+        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)
+              .returns(T.any(T::Boolean, T.anything))
+          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)
+              .returns(T.any(T::Boolean, T.anything))
+          end
+          def dump(value, state:); end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,120 @@
+# typed: strong
+
+module TerminalShop
+  module Internal
+    module Type
+      # @api private
+      module Converter
+        Input = T.type_alias { T.any(TerminalShop::Internal::Type::Converter, T::Class[T.anything]) }
+
+        CoerceState =
+          T.type_alias do
+            {
+              strictness: T.any(T::Boolean, Symbol),
+              exactness: {yes: Integer, no: Integer, maybe: Integer},
+              branched: Integer
+            }
+          end
+
+        DumpState = T.type_alias { {can_retry: T::Boolean} }
+
+        # @api private
+        sig do
+          overridable
+            .params(value: T.anything, state: TerminalShop::Internal::Type::Converter::CoerceState)
+            .returns(T.anything)
+        end
+        def coerce(value, state:); end
+
+        # @api private
+        sig do
+          overridable
+            .params(value: T.anything, state: TerminalShop::Internal::Type::Converter::DumpState)
+            .returns(T.anything)
+        end
+        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: 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
+
+          # @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: TerminalShop::Internal::Type::Converter::Input,
+              value: T.anything,
+              state: TerminalShop::Internal::Type::Converter::CoerceState
+            )
+              .returns(T.anything)
+          end
+          def self.coerce(
+            target,
+            value,
+            # The `strictness` is one of `true`, `false`, or `:strong`. 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.
+            # - `:strong`: the conversion must be exact, with no coercion, and raise an error
+            #   if not possible.
+            #
+            # 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: {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)
+          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
+        end
+      end
+    end
+  end
+end

data/rbi/lib/terminal_shop/internal/type/enum.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module TerminalShop
+  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 TerminalShop::Internal::Type::Converter
+
+        # 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 { params(other: T.anything).returns(T::Boolean) }
+        def ===(other); end
+
+        sig { params(other: T.anything).returns(T::Boolean) }
+        def ==(other); end
+
+        sig { returns(Integer) }
+        def hash; end
+
+        # @api private
+        #
+        # Unlike with primitives, `Enum` additionally validates that the value is a member
+        # of the enum.
+        sig do
+          override
+            .params(
+              value: T.any(String, Symbol, T.anything),
+              state: TerminalShop::Internal::Type::Converter::CoerceState
+            )
+            .returns(T.any(Symbol, T.anything))
+        end
+        def coerce(value, state:); end
+
+        # @api private
+        sig do
+          override
+            .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
+
+        # @api private
+        sig { params(depth: Integer).returns(String) }
+        def inspect(depth: 0); end
+      end
+    end
+  end
+end

data/rbi/lib/terminal_shop/internal/type/file_input.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module TerminalShop
+  module Internal
+    module Type
+      # @api private
+      #
+      # Either `Pathname` or `StringIO`, or `IO`, or
+      # `TerminalShop::Internal::Type::FileInput`.
+      #
+      # Note: when `IO` is used, all retries are disabled, since many IO` streams are
+      # not rewindable.
+      class FileInput
+        extend TerminalShop::Internal::Type::Converter
+
+        abstract!
+
+        sig { params(other: T.anything).returns(T::Boolean) }
+        def self.===(other); end
+
+        sig { params(other: T.anything).returns(T::Boolean) }
+        def self.==(other); end
+
+        class << self
+          # @api private
+          sig do
+            override
+              .params(
+                value: T.any(StringIO, String, T.anything),
+                state: TerminalShop::Internal::Type::Converter::CoerceState
+              )
+              .returns(T.any(StringIO, T.anything))
+          end
+          def coerce(value, state:); end
+
+          # @api private
+          sig do
+            override
+              .params(
+                value: T.any(Pathname, StringIO, IO, String, T.anything),
+                state: TerminalShop::Internal::Type::Converter::DumpState
+              )
+              .returns(T.any(Pathname, StringIO, IO, String, T.anything))
+          end
+          def dump(value, state:); end
+        end
+      end
+    end
+  end
+end

data/rbi/lib/terminal_shop/internal/type/hash_of.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module TerminalShop
+  module Internal
+    module Type
+      # @api private
+      #
+      # Hash of items of a given type.
+      class HashOf
+        include TerminalShop::Internal::Type::Converter
+
+        abstract!
+
+        Elem = type_member(:out)
+
+        sig do
+          params(
+            type_info: T.any(
+              TerminalShop::Internal::AnyHash,
+              T.proc.returns(TerminalShop::Internal::Type::Converter::Input),
+              TerminalShop::Internal::Type::Converter::Input
+            ),
+            spec: TerminalShop::Internal::AnyHash
+          )
+            .returns(T.attached_class)
+        end
+        def self.[](type_info, spec = {}); end
+
+        sig { params(other: T.anything).returns(T::Boolean) }
+        def ===(other); end
+
+        sig { params(other: T.anything).returns(T::Boolean) }
+        def ==(other); end
+
+        sig { returns(Integer) }
+        def hash; end
+
+        # @api private
+        sig do
+          override
+            .params(
+              value: T.any(T::Hash[T.anything, T.anything], T.anything),
+              state: TerminalShop::Internal::Type::Converter::CoerceState
+            )
+            .returns(T.any(TerminalShop::Internal::AnyHash, T.anything))
+        end
+        def coerce(value, state:); end
+
+        # @api private
+        sig do
+          override
+            .params(
+              value: T.any(T::Hash[T.anything, T.anything], T.anything),
+              state: TerminalShop::Internal::Type::Converter::DumpState
+            )
+            .returns(T.any(TerminalShop::Internal::AnyHash, T.anything))
+        end
+        def dump(value, state:); 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: T.any(
+              TerminalShop::Internal::AnyHash,
+              T.proc.returns(TerminalShop::Internal::Type::Converter::Input),
+              TerminalShop::Internal::Type::Converter::Input
+            ),
+            spec: TerminalShop::Internal::AnyHash
+          )
+            .void
+        end
+        def initialize(type_info, spec = {}); end
+
+        # @api private
+        sig { params(depth: Integer).returns(String) }
+        def inspect(depth: 0); end
+      end
+    end
+  end
+end

data/rbi/lib/terminal_shop/internal/type/request_parameters.rbi

@@ -0,0 +1,21 @@
+# typed: strong
+
+module TerminalShop
+  module Internal
+    module Type
+      # @api private
+      module RequestParameters
+        # Options to specify HTTP behaviour for this request.
+        sig { returns(T.any(TerminalShop::RequestOptions, TerminalShop::Internal::AnyHash)) }
+        attr_accessor :request_options
+
+        # @api private
+        module Converter
+          # @api private
+          sig { params(params: T.anything).returns([T.anything, TerminalShop::Internal::AnyHash]) }
+          def dump_request(params); end
+        end
+      end
+    end
+  end
+end