terminal-shop 1.7.0 → 2.0.0

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

@@ -1,64 +1,95 @@
 # typed: strong
 
 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
     end
 
     class << self
+      # @api private
       sig { returns(String) }
       def arch
       end
 
+      # @api private
       sig { returns(String) }
       def os
       end
     end
 
     class << self
-      sig { params(input: T.anything).returns(T.any(T::Boolean, T.anything)) }
+      # @api private
+      sig { params(input: T.anything).returns(T::Boolean) }
       def primitive?(input)
       end
 
+      # @api private
       sig { params(input: T.anything).returns(T.any(T::Boolean, T.anything)) }
       def coerce_boolean(input)
       end
 
+      # @api private
       sig { params(input: T.anything).returns(T.nilable(T::Boolean)) }
       def coerce_boolean!(input)
       end
 
+      # @api private
       sig { params(input: T.anything).returns(T.any(Integer, T.anything)) }
       def coerce_integer(input)
       end
 
+      # @api private
       sig { params(input: T.anything).returns(T.any(Float, T.anything)) }
       def coerce_float(input)
       end
 
+      # @api private
       sig { params(input: T.anything).returns(T.any(T::Hash[T.anything, T.anything], T.anything)) }
       def coerce_hash(input)
       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
+      # @api private
       sig { params(lhs: T.anything, rhs: T.anything, concat: T::Boolean).returns(T.anything) }
       private def deep_merge_lr(lhs, rhs, concat: false)
       end
 
+      # @api private
+      #
+      # Recursively merge one hash with another. If the values at a given key are not
+      #   both hashes, just take the new value.
       sig do
         params(values: T::Array[T.anything], sentinel: T.nilable(T.anything), concat: T::Boolean)
           .returns(T.anything)
       end
-      def deep_merge(*values, sentinel: nil, concat: false)
+      def deep_merge(
+        *values,
+        # the value to return if no values are provided.
+        sentinel: nil,
+        # whether to merge sequences by concatenation.
+        concat: false
+      )
       end
 
+      # @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))
@@ -70,20 +101,24 @@ module TerminalShop
     end
 
     class << self
+      # @api private
       sig { params(uri: URI::Generic).returns(String) }
       def uri_origin(uri)
       end
 
+      # @api private
       sig { params(path: T.any(String, T::Array[String])).returns(String) }
       def interpolate_path(path)
       end
     end
 
     class << self
+      # @api private
       sig { params(query: T.nilable(String)).returns(T::Hash[String, T::Array[String]]) }
       def decode_query(query)
       end
 
+      # @api private
       sig do
         params(query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]))
           .returns(T.nilable(String))
@@ -92,25 +127,29 @@ 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
       sig { params(url: T.any(URI::Generic, String)).returns(TerminalShop::Util::ParsedUriShape) }
       def parse_uri(url)
       end
 
+      # @api private
       sig { params(parsed: TerminalShop::Util::ParsedUriShape).returns(URI::Generic) }
       def unparse_uri(parsed)
       end
 
+      # @api private
       sig do
         params(lhs: TerminalShop::Util::ParsedUriShape, rhs: TerminalShop::Util::ParsedUriShape)
           .returns(URI::Generic)
@@ -120,6 +159,7 @@ module TerminalShop
     end
 
     class << self
+      # @api private
       sig do
         params(
           headers: T::Hash[String,
@@ -131,15 +171,21 @@ module TerminalShop
       end
     end
 
+    # @api private
+    #
+    # An adapter that satisfies the IO interface required by `::IO.copy_stream`
     class ReadIOAdapter
+      # @api private
       sig { params(max_len: T.nilable(Integer)).returns(String) }
       private def read_enum(max_len)
       end
 
+      # @api private
       sig { params(max_len: T.nilable(Integer), out_string: T.nilable(String)).returns(T.nilable(String)) }
       def read(max_len = nil, out_string = nil)
       end
 
+      # @api private
       sig do
         params(
           stream: T.any(String, IO, StringIO, T::Enumerable[String]),
@@ -158,20 +204,24 @@ module TerminalShop
     end
 
     class << self
+      # @api private
       sig do
         params(y: Enumerator::Yielder, boundary: String, key: T.any(Symbol, String), val: T.anything).void
       end
       private def encode_multipart_formdata(y, boundary:, key:, val:)
       end
 
+      # @api private
       sig { params(body: T.anything).returns([String, T::Enumerable[String]]) }
       private def encode_multipart_streaming(body)
       end
 
+      # @api private
       sig { params(headers: T::Hash[String, String], body: T.anything).returns(T.anything) }
       def encode_content(headers, body)
       end
 
+      # @api private
       sig do
         params(
           headers: T.any(T::Hash[String, String], Net::HTTPHeader),
@@ -185,6 +235,9 @@ module TerminalShop
     end
 
     class << self
+      # @api private
+      #
+      # https://doc.rust-lang.org/std/iter/trait.FusedIterator.html
       sig do
         params(enum: T::Enumerable[T.anything], external: T::Boolean, close: T.proc.void)
           .returns(T::Enumerable[T.anything])
@@ -192,30 +245,35 @@ module TerminalShop
       def fused_enum(enum, external: false, &close)
       end
 
+      # @api private
       sig { params(enum: T.nilable(T::Enumerable[T.anything])).void }
       def close_fused!(enum)
       end
 
+      # @api private
       sig do
-        params(
-          enum: T.nilable(T::Enumerable[T.anything]),
-          blk: T.proc.params(arg0: Enumerator::Yielder).void
-        ).void
+        params(enum: T.nilable(T::Enumerable[T.anything]), blk: T.proc.params(arg0: Enumerator::Yielder).void)
+          .returns(T::Enumerable[T.anything])
       end
       def chain_fused(enum, &blk)
       end
     end
 
-    SSEMessage = 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
       sig { params(enum: T::Enumerable[String]).returns(T::Enumerable[String]) }
       def decode_lines(enum)
       end
 
-      sig { params(lines: T::Enumerable[String]).returns(TerminalShop::Util::SSEMessage) }
+      # @api private
+      #
+      # https://html.spec.whatwg.org/multipage/server-sent-events.html#parsing-an-event-stream
+      sig { params(lines: T::Enumerable[String]).returns(TerminalShop::Util::ServerSentEvent) }
       def decode_sse(lines)
       end
     end

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

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

data/sig/terminal-shop/base_client.rbs

@@ -45,19 +45,24 @@ module TerminalShop
       response_headers: ::Hash[String, String]
     ) -> TerminalShop::BaseClient::request_input
 
-    # @private
+    def self.reap_connection!: (
+      Integer | TerminalShop::APIConnectionError status,
+      stream: Enumerable[String]?
+    ) -> void
+
+    # @api private
     attr_accessor requester: top
 
     def initialize: (
       base_url: String,
-      timeout: Float,
-      max_retries: Integer,
-      initial_retry_delay: Float,
-      max_retry_delay: Float,
-      headers: ::Hash[String, (String
+      ?timeout: Float,
+      ?max_retries: Integer,
+      ?initial_retry_delay: Float,
+      ?max_retry_delay: Float,
+      ?headers: ::Hash[String, (String
       | Integer
       | ::Array[(String | Integer)?])?],
-      idempotency_header: String?
+      ?idempotency_header: String?
     ) -> void
 
     private def auth_headers: -> ::Hash[String, String]
@@ -85,16 +90,16 @@ module TerminalShop
       (
         Symbol method,
         String | ::Array[String] path,
-        query: ::Hash[String, (::Array[String] | String)?]?,
-        headers: ::Hash[String, (String
+        ?query: ::Hash[String, (::Array[String] | String)?]?,
+        ?headers: ::Hash[String, (String
         | Integer
         | ::Array[(String | Integer)?])?]?,
-        body: top?,
-        unwrap: Symbol?,
-        page: Class?,
-        stream: Class?,
-        model: TerminalShop::Converter::input?,
-        options: TerminalShop::request_opts?
+        ?body: top?,
+        ?unwrap: Symbol?,
+        ?page: Class?,
+        ?stream: Class?,
+        ?model: TerminalShop::Converter::input?,
+        ?options: TerminalShop::request_opts?
       ) -> top
       | (TerminalShop::BaseClient::request_components req) -> top
 

data/sig/terminal-shop/base_model.rbs

@@ -62,32 +62,34 @@ module TerminalShop
     ) -> ([true, top, nil] | [false, bool, Integer])
   end
 
-  class Enum
-    extend TerminalShop::Converter
+  module Enum
+    include TerminalShop::Converter
 
     def self.values: -> ::Array[(nil | bool | Integer | Float | Symbol)]
 
     private def self.finalize!: -> void
 
-    def self.===: (top other) -> bool
+    def ===: (top other) -> bool
 
-    def self.==: (top other) -> bool
+    def ==: (top other) -> bool
 
-    def self.coerce: (String | Symbol | top value) -> (Symbol | top)
+    def coerce: (String | Symbol | top value) -> (Symbol | top)
 
-    def self.dump: (Symbol | top value) -> (Symbol | top)
+    def dump: (Symbol | top value) -> (Symbol | top)
 
-    def self.try_strict_coerce: (
+    def try_strict_coerce: (
       top value
     ) -> ([true, top, nil] | [false, bool, Integer])
   end
 
-  class Union
-    extend TerminalShop::Converter
+  module Union
+    include TerminalShop::Converter
 
-    private def self.known_variants: -> ::Array[[Symbol?, Proc]]
+    private def self.known_variants: -> ::Array[[Symbol?, (^-> TerminalShop::Converter::input)]]
 
-    def self.variants: -> ::Array[[Symbol?, top]]
+    def self.derefed_variants: -> ::Array[[Symbol?, top]]
+
+    def self.variants: -> ::Array[top]
 
     private def self.discriminator: (Symbol property) -> void
 
@@ -105,15 +107,15 @@ module TerminalShop
       top value
     ) -> TerminalShop::Converter::input?
 
-    def self.===: (top other) -> bool
+    def ===: (top other) -> bool
 
-    def self.==: (top other) -> bool
+    def ==: (top other) -> bool
 
-    def self.coerce: (top value) -> top
+    def coerce: (top value) -> top
 
-    def self.dump: (top value) -> top
+    def dump: (top value) -> top
 
-    def self.try_strict_coerce: (
+    def try_strict_coerce: (
       top value
     ) -> ([true, top, nil] | [false, bool, Integer])
   end
@@ -121,6 +123,13 @@ module TerminalShop
   class ArrayOf
     include TerminalShop::Converter
 
+    def self.[]: (
+      ::Hash[Symbol, top]
+      | ^-> TerminalShop::Converter::input
+      | TerminalShop::Converter::input type_info,
+      ?::Hash[Symbol, top] spec
+    ) -> instance
+
     def ===: (top other) -> bool
 
     def ==: (top other) -> bool
@@ -133,7 +142,7 @@ module TerminalShop
       top value
     ) -> ([true, top, nil] | [false, bool, Integer])
 
-    def item_type: -> TerminalShop::Converter::input
+    def item_type: -> top
 
     def initialize: (
       ::Hash[Symbol, top]
@@ -146,6 +155,13 @@ module TerminalShop
   class HashOf
     include TerminalShop::Converter
 
+    def self.[]: (
+      ::Hash[Symbol, top]
+      | ^-> TerminalShop::Converter::input
+      | TerminalShop::Converter::input type_info,
+      ?::Hash[Symbol, top] spec
+    ) -> instance
+
     def ===: (top other) -> bool
 
     def ==: (top other) -> bool
@@ -158,7 +174,7 @@ module TerminalShop
       top value
     ) -> ([true, top, nil] | [false, bool, Integer])
 
-    def item_type: -> TerminalShop::Converter::input
+    def item_type: -> top
 
     def initialize: (
       ::Hash[Symbol, top]
@@ -176,6 +192,8 @@ module TerminalShop
     def self.known_fields: -> ::Hash[Symbol, (TerminalShop::BaseModel::known_field
     & { type_fn: (^-> TerminalShop::Converter::input) })]
 
+    def self.reverse_map: -> ::Hash[Symbol, Symbol]
+
     def self.fields: -> ::Hash[Symbol, (TerminalShop::BaseModel::known_field
     & { type: TerminalShop::Converter::input })]
 

data/sig/terminal-shop/client.rbs

@@ -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

@@ -1,47 +1,47 @@
 module TerminalShop
   class Error < StandardError
-    attr_reader cause: StandardError?
+    attr_accessor cause: StandardError?
   end
 
   class ConversionError < TerminalShop::Error
   end
 
   class APIError < TerminalShop::Error
-    attr_reader url: URI::Generic
+    attr_accessor url: URI::Generic
 
-    attr_reader status: Integer?
+    attr_accessor status: Integer?
 
-    attr_reader body: top?
+    attr_accessor body: top?
 
     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

@@ -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

@@ -6,12 +6,7 @@ module TerminalShop
       extend TerminalShop::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

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

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

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

@@ -6,12 +6,7 @@ module TerminalShop
       extend TerminalShop::RequestParameters::Converter
       include TerminalShop::RequestParameters
 
-      def initialize:
-        (request_options: TerminalShop::request_opts) -> void
-        | (
-          ?TerminalShop::Models::address_get_params
-          | TerminalShop::BaseModel data
-        ) -> void
+      def initialize: (?request_options: TerminalShop::request_opts) -> void
 
       def to_hash: -> TerminalShop::Models::address_get_params
     end