terminal-shop 1.8.0 → 2.1.0

data/rbi/lib/terminal-shop/type/converter.rbi

@@ -0,0 +1,101 @@
+# typed: strong
+
+module TerminalShop
+  module Type
+    # @api private
+    module Converter
+      Input = T.type_alias { T.any(TerminalShop::Type::Converter, T::Class[T.anything]) }
+
+      State =
+        T.type_alias do
+          {
+            strictness: T.any(T::Boolean, Symbol),
+            exactness: {yes: Integer, no: Integer, maybe: Integer},
+            branched: Integer
+          }
+        end
+
+      # @api private
+      sig do
+        overridable.params(value: T.anything, state: TerminalShop::Type::Converter::State).returns(T.anything)
+      end
+      def coerce(value, state:)
+      end
+
+      # @api private
+      sig { overridable.params(value: T.anything).returns(T.anything) }
+      def dump(value)
+      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::Type::Converter::Input)),
+                union: T.nilable(T.proc.returns(TerminalShop::Type::Converter::Input))
+              },
+              T.proc.returns(TerminalShop::Type::Converter::Input),
+              TerminalShop::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::Type::Converter::Input,
+            value: T.anything,
+            state: TerminalShop::Type::Converter::State
+          )
+            .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 { params(target: TerminalShop::Type::Converter::Input, value: T.anything).returns(T.anything) }
+        def self.dump(target, value)
+        end
+      end
+    end
+  end
+end

data/rbi/lib/terminal-shop/type/enum.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module TerminalShop
+  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::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
+
+      # @api private
+      #
+      # Guard against thread safety issues by instantiating `@values`.
+      sig { void }
+      private def finalize!
+      end
+
+      sig { params(other: T.anything).returns(T::Boolean) }
+      def ===(other)
+      end
+
+      sig { params(other: T.anything).returns(T::Boolean) }
+      def ==(other)
+      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::Type::Converter::State)
+          .returns(T.any(Symbol, T.anything))
+      end
+      def coerce(value, state:)
+      end
+
+      # @api private
+      sig { override.params(value: T.any(Symbol, T.anything)).returns(T.any(Symbol, T.anything)) }
+      def dump(value)
+      end
+    end
+  end
+end

data/rbi/lib/terminal-shop/type/hash_of.rbi

@@ -0,0 +1,85 @@
+# typed: strong
+
+module TerminalShop
+  module Type
+    # @api private
+    #
+    # Hash of items of a given type.
+    class HashOf
+      include TerminalShop::Type::Converter
+
+      abstract!
+      final!
+
+      Elem = type_member(:out)
+
+      sig(:final) do
+        params(
+          type_info: T.any(
+            TerminalShop::Util::AnyHash,
+            T.proc.returns(TerminalShop::Type::Converter::Input),
+            TerminalShop::Type::Converter::Input
+          ),
+          spec: TerminalShop::Util::AnyHash
+        )
+          .returns(T.attached_class)
+      end
+      def self.[](type_info, spec = {})
+      end
+
+      sig(:final) { params(other: T.anything).returns(T::Boolean) }
+      def ===(other)
+      end
+
+      sig(:final) { params(other: T.anything).returns(T::Boolean) }
+      def ==(other)
+      end
+
+      # @api private
+      sig(:final) do
+        override
+          .params(
+            value: T.any(T::Hash[T.anything, T.anything], T.anything),
+            state: TerminalShop::Type::Converter::State
+          )
+          .returns(T.any(TerminalShop::Util::AnyHash, T.anything))
+      end
+      def coerce(value, state:)
+      end
+
+      # @api private
+      sig(:final) do
+        override
+          .params(value: T.any(T::Hash[T.anything, T.anything], T.anything))
+          .returns(T.any(TerminalShop::Util::AnyHash, T.anything))
+      end
+      def dump(value)
+      end
+
+      # @api private
+      sig(:final) { returns(Elem) }
+      protected def item_type
+      end
+
+      # @api private
+      sig(:final) { returns(T::Boolean) }
+      protected def nilable?
+      end
+
+      # @api private
+      sig(:final) do
+        params(
+          type_info: T.any(
+            TerminalShop::Util::AnyHash,
+            T.proc.returns(TerminalShop::Type::Converter::Input),
+            TerminalShop::Type::Converter::Input
+          ),
+          spec: TerminalShop::Util::AnyHash
+        )
+          .void
+      end
+      def initialize(type_info, spec = {})
+      end
+    end
+  end
+end

data/rbi/lib/terminal-shop/type/request_parameters.rbi

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

data/rbi/lib/terminal-shop/type/union.rbi

@@ -0,0 +1,68 @@
+# typed: strong
+
+module TerminalShop
+  module Type
+    # @api private
+    module Union
+      include TerminalShop::Type::Converter
+
+      # @api private
+      #
+      # All of the specified variant info for this union.
+      sig { returns(T::Array[[T.nilable(Symbol), T.proc.returns(TerminalShop::Type::Converter::Input)]]) }
+      private def known_variants
+      end
+
+      # @api private
+      sig { returns(T::Array[[T.nilable(Symbol), T.anything]]) }
+      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: T.any(Symbol, TerminalShop::Util::AnyHash, T.proc.returns(T.anything), T.anything),
+          spec: T.any(TerminalShop::Util::AnyHash, T.proc.returns(T.anything), T.anything)
+        )
+          .void
+      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
+
+      sig { params(other: T.anything).returns(T::Boolean) }
+      def ===(other)
+      end
+
+      sig { params(other: T.anything).returns(T::Boolean) }
+      def ==(other)
+      end
+
+      # @api private
+      sig do
+        override.params(value: T.anything, state: TerminalShop::Type::Converter::State).returns(T.anything)
+      end
+      def coerce(value, state:)
+      end
+
+      # @api private
+      sig { override.params(value: T.anything).returns(T.anything) }
+      def dump(value)
+      end
+    end
+  end
+end

data/rbi/lib/terminal-shop/type/unknown.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module TerminalShop
+  module Type
+    # @api private
+    #
+    # When we don't know what to expect for the value.
+    class Unknown
+      extend TerminalShop::Type::Converter
+
+      abstract!
+      final!
+
+      sig(:final) { params(other: T.anything).returns(T::Boolean) }
+      def self.===(other)
+      end
+
+      sig(:final) { params(other: T.anything).returns(T::Boolean) }
+      def self.==(other)
+      end
+
+      class << self
+        # @api private
+        sig(:final) do
+          override.params(value: T.anything, state: TerminalShop::Type::Converter::State).returns(T.anything)
+        end
+        def coerce(value, state:)
+        end
+
+        # @api private
+        sig(:final) { override.params(value: T.anything).returns(T.anything) }
+        def dump(value)
+        end
+      end
+    end
+  end
+end

data/rbi/lib/terminal-shop/type.rbi

@@ -0,0 +1,23 @@
+# typed: strong
+
+module TerminalShop
+  Unknown = TerminalShop::Type::Unknown
+
+  BooleanModel = TerminalShop::Type::BooleanModel
+
+  Enum = TerminalShop::Type::Enum
+
+  Union = TerminalShop::Type::Union
+
+  ArrayOf = TerminalShop::Type::ArrayOf
+
+  HashOf = TerminalShop::Type::HashOf
+
+  BaseModel = TerminalShop::Type::BaseModel
+
+  RequestParameters = TerminalShop::Type::RequestParameters
+
+  # This module contains various type declarations.
+  module Type
+  end
+end

data/rbi/lib/terminal-shop/util.rbi

@@ -3,6 +3,10 @@
 module TerminalShop
   # @api private
   module Util
+    # Due to the current WIP status of Shapes support in Sorbet, types referencing
+    #   this alias might be refined in the future.
+    AnyHash = T.type_alias { T::Hash[Symbol, T.anything] }
+
     # @api private
     sig { returns(Float) }
     def self.monotonic_secs
@@ -52,6 +56,11 @@ module TerminalShop
       end
     end
 
+    # Use this to indicate that a value should be explicitly removed from a data
+    #   structure when using `TerminalShop::Util.deep_merge`.
+    #
+    #   e.g. merging `{a: 1}` and `{a: OMIT}` should produce `{}`, where merging
+    #   `{a: 1}` and `{}` would produce `{a: 1}`.
     OMIT = T.let(T.anything, T.anything)
 
     class << self
@@ -80,7 +89,7 @@ module TerminalShop
       # @api private
       sig do
         params(
-          data: T.any(T::Hash[Symbol, T.anything], T::Array[T.anything], T.anything),
+          data: T.any(TerminalShop::Util::AnyHash, T::Array[T.anything], T.anything),
           pick: T.nilable(T.any(Symbol, Integer, T::Array[T.any(Symbol, Integer)])),
           sentinel: T.nilable(T.anything),
           blk: T.nilable(T.proc.returns(T.anything))
@@ -118,15 +127,16 @@ module TerminalShop
       end
     end
 
-    ParsedUriShape = T.type_alias do
-      {
-        scheme: T.nilable(String),
-        host: T.nilable(String),
-        port: T.nilable(Integer),
-        path: T.nilable(String),
-        query: T::Hash[String, T::Array[String]]
-      }
-    end
+    ParsedUriShape =
+      T.type_alias do
+        {
+          scheme: T.nilable(String),
+          host: T.nilable(String),
+          port: T.nilable(Integer),
+          path: T.nilable(String),
+          query: T::Hash[String, T::Array[String]]
+        }
+      end
 
     class << self
       # @api private
@@ -249,9 +259,10 @@ module TerminalShop
       end
     end
 
-    ServerSentEvent = T.type_alias do
-      {event: T.nilable(String), data: T.nilable(String), id: T.nilable(String), retry: T.nilable(Integer)}
-    end
+    ServerSentEvent =
+      T.type_alias do
+        {event: T.nilable(String), data: T.nilable(String), id: T.nilable(String), retry: T.nilable(Integer)}
+      end
 
     class << self
       # @api private

data/rbi/lib/terminal-shop/version.rbi

@@ -1,5 +1,5 @@
 # typed: strong
 
 module TerminalShop
-  VERSION = "1.8.0"
+  VERSION = "2.1.0"
 end

data/sig/terminal-shop/client.rbs

@@ -1,5 +1,5 @@
 module TerminalShop
-  class Client < TerminalShop::BaseClient
+  class Client < TerminalShop::Transport::BaseClient
     DEFAULT_MAX_RETRIES: 2
 
     DEFAULT_TIMEOUT_IN_SECONDS: Float
@@ -42,14 +42,14 @@ module TerminalShop
     private def auth_headers: -> ::Hash[String, String]
 
     def initialize: (
-      environment: :production | :dev | nil,
-      base_url: String?,
-      bearer_token: String?,
-      app_id: String?,
-      max_retries: Integer,
-      timeout: Float,
-      initial_retry_delay: Float,
-      max_retry_delay: Float
+      ?environment: :production | :dev | nil,
+      ?base_url: String?,
+      ?bearer_token: String?,
+      ?app_id: String?,
+      ?max_retries: Integer,
+      ?timeout: Float,
+      ?initial_retry_delay: Float,
+      ?max_retry_delay: Float
     ) -> void
   end
 end

data/sig/terminal-shop/errors.rbs

@@ -15,33 +15,33 @@ module TerminalShop
 
     def initialize: (
       url: URI::Generic,
-      status: Integer?,
-      body: Object?,
-      request: nil,
-      response: nil,
-      message: String?
+      ?status: Integer?,
+      ?body: Object?,
+      ?request: nil,
+      ?response: nil,
+      ?message: String?
     ) -> void
   end
 
   class APIConnectionError < TerminalShop::APIError
     def initialize: (
       url: URI::Generic,
-      status: nil,
-      body: nil,
-      request: nil,
-      response: nil,
-      message: String?
+      ?status: nil,
+      ?body: nil,
+      ?request: nil,
+      ?response: nil,
+      ?message: String?
     ) -> void
   end
 
   class APITimeoutError < TerminalShop::APIConnectionError
     def initialize: (
       url: URI::Generic,
-      status: nil,
-      body: nil,
-      request: nil,
-      response: nil,
-      message: String?
+      ?status: nil,
+      ?body: nil,
+      ?request: nil,
+      ?response: nil,
+      ?message: String?
     ) -> void
   end
 
@@ -52,7 +52,7 @@ module TerminalShop
       body: Object?,
       request: nil,
       response: nil,
-      message: String?
+      ?message: String?
     ) -> instance
 
     def initialize: (
@@ -61,7 +61,7 @@ module TerminalShop
       body: Object?,
       request: nil,
       response: nil,
-      message: String?
+      ?message: String?
     ) -> void
   end
 

data/sig/terminal-shop/models/address.rbs

@@ -38,21 +38,17 @@ module TerminalShop
 
       def street2=: (String) -> String
 
-      def initialize:
-        (
-          id: String,
-          city: String,
-          country: String,
-          name: String,
-          street1: String,
-          zip: String,
-          phone: String,
-          province: String,
-          street2: String
-        ) -> void
-        | (
-          ?TerminalShop::Models::address_api | TerminalShop::BaseModel data
-        ) -> void
+      def initialize: (
+        id: String,
+        city: String,
+        country: String,
+        name: String,
+        street1: String,
+        zip: String,
+        ?phone: String,
+        ?province: String,
+        ?street2: String
+      ) -> void
 
       def to_hash: -> TerminalShop::Models::address_api
     end

data/sig/terminal-shop/models/address_create_params.rbs

@@ -14,7 +14,7 @@ module TerminalShop
       & TerminalShop::request_parameters
 
     class AddressCreateParams < TerminalShop::BaseModel
-      extend TerminalShop::RequestParameters::Converter
+      extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
       attr_accessor city: String
@@ -39,22 +39,17 @@ module TerminalShop
 
       def street2=: (String) -> String
 
-      def initialize:
-        (
-          city: String,
-          country: String,
-          name: String,
-          street1: String,
-          zip: String,
-          phone: String,
-          province: String,
-          street2: String,
-          request_options: TerminalShop::request_opts
-        ) -> void
-        | (
-          ?TerminalShop::Models::address_create_params
-          | TerminalShop::BaseModel data
-        ) -> void
+      def initialize: (
+        city: String,
+        country: String,
+        name: String,
+        street1: String,
+        zip: String,
+        ?phone: String,
+        ?province: String,
+        ?street2: String,
+        ?request_options: TerminalShop::request_opts
+      ) -> void
 
       def to_hash: -> TerminalShop::Models::address_create_params
     end

data/sig/terminal-shop/models/address_create_response.rbs

@@ -5,12 +5,7 @@ module TerminalShop
     class AddressCreateResponse < TerminalShop::BaseModel
       attr_accessor data: String
 
-      def initialize:
-        (data: String) -> void
-        | (
-          ?TerminalShop::Models::address_create_response
-          | TerminalShop::BaseModel data
-        ) -> void
+      def initialize: (data: String) -> void
 
       def to_hash: -> TerminalShop::Models::address_create_response
     end

data/sig/terminal-shop/models/address_delete_params.rbs

@@ -3,15 +3,10 @@ module TerminalShop
     type address_delete_params = {  } & TerminalShop::request_parameters
 
     class AddressDeleteParams < TerminalShop::BaseModel
-      extend TerminalShop::RequestParameters::Converter
+      extend TerminalShop::Type::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
-      def initialize:
-        (request_options: TerminalShop::request_opts) -> void
-        | (
-          ?TerminalShop::Models::address_delete_params
-          | TerminalShop::BaseModel data
-        ) -> void
+      def initialize: (?request_options: TerminalShop::request_opts) -> void
 
       def to_hash: -> TerminalShop::Models::address_delete_params
     end