terminal-shop 1.8.0 → 2.0.0

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.0.0"
 end

data/sig/terminal-shop/base_client.rbs

@@ -55,14 +55,14 @@ module TerminalShop
 
     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]
@@ -90,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,28 +62,28 @@ 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?, (^-> TerminalShop::Converter::input)]]
 
@@ -107,22 +107,29 @@ 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
 
-  class ArrayOf[Elem]
+  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
@@ -135,7 +142,7 @@ module TerminalShop
       top value
     ) -> ([true, top, nil] | [false, bool, Integer])
 
-    def item_type: -> Elem
+    def item_type: -> top
 
     def initialize: (
       ::Hash[Symbol, top]
@@ -145,9 +152,16 @@ module TerminalShop
     ) -> void
   end
 
-  class HashOf[Elem]
+  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
@@ -160,7 +174,7 @@ module TerminalShop
       top value
     ) -> ([true, top, nil] | [false, bool, Integer])
 
-    def item_type: -> Elem
+    def item_type: -> top
 
     def initialize: (
       ::Hash[Symbol, top]
@@ -178,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

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

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

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

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

data/sig/terminal-shop/models/address_list_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_list_params
-          | TerminalShop::BaseModel data
-        ) -> void
+      def initialize: (?request_options: TerminalShop::request_opts) -> void
 
       def to_hash: -> TerminalShop::Models::address_list_params
     end

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

@@ -6,12 +6,7 @@ module TerminalShop
     class AddressListResponse < TerminalShop::BaseModel
       attr_accessor data: ::Array[TerminalShop::Models::AddressAPI]
 
-      def initialize:
-        (data: ::Array[TerminalShop::Models::AddressAPI]) -> void
-        | (
-          ?TerminalShop::Models::address_list_response
-          | TerminalShop::BaseModel data
-        ) -> void
+      def initialize: (data: ::Array[TerminalShop::Models::AddressAPI]) -> void
 
       def to_hash: -> TerminalShop::Models::address_list_response
     end

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

@@ -12,11 +12,12 @@ module TerminalShop
 
       attr_accessor secret: String
 
-      def initialize:
-        (id: String, name: String, redirect_uri: String, secret: String) -> void
-        | (
-          ?TerminalShop::Models::app_api | TerminalShop::BaseModel data
-        ) -> void
+      def initialize: (
+        id: String,
+        name: String,
+        redirect_uri: String,
+        secret: String
+      ) -> void
 
       def to_hash: -> TerminalShop::Models::app_api
     end

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

@@ -11,16 +11,11 @@ module TerminalShop
 
       attr_accessor redirect_uri: String
 
-      def initialize:
-        (
-          name: String,
-          redirect_uri: String,
-          request_options: TerminalShop::request_opts
-        ) -> void
-        | (
-          ?TerminalShop::Models::app_create_params
-          | TerminalShop::BaseModel data
-        ) -> void
+      def initialize: (
+        name: String,
+        redirect_uri: String,
+        ?request_options: TerminalShop::request_opts
+      ) -> void
 
       def to_hash: -> TerminalShop::Models::app_create_params
     end

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

@@ -6,12 +6,9 @@ module TerminalShop
     class AppCreateResponse < TerminalShop::BaseModel
       attr_accessor data: TerminalShop::Models::AppCreateResponse::Data
 
-      def initialize:
-        (data: TerminalShop::Models::AppCreateResponse::Data) -> void
-        | (
-          ?TerminalShop::Models::app_create_response
-          | TerminalShop::BaseModel data
-        ) -> void
+      def initialize: (
+        data: TerminalShop::Models::AppCreateResponse::Data
+      ) -> void
 
       def to_hash: -> TerminalShop::Models::app_create_response
 
@@ -22,12 +19,7 @@ module TerminalShop
 
         attr_accessor secret: String
 
-        def initialize:
-          (id: String, secret: String) -> void
-          | (
-            ?TerminalShop::Models::AppCreateResponse::data
-            | TerminalShop::BaseModel data
-          ) -> void
+        def initialize: (id: String, secret: String) -> void
 
         def to_hash: -> TerminalShop::Models::AppCreateResponse::data
       end

data/sig/terminal-shop/models/app_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::app_delete_params
-          | TerminalShop::BaseModel data
-        ) -> void
+      def initialize: (?request_options: TerminalShop::request_opts) -> void
 
       def to_hash: -> TerminalShop::Models::app_delete_params
     end

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

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

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

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

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

@@ -5,11 +5,7 @@ module TerminalShop
     class AppGetResponse < TerminalShop::BaseModel
       attr_accessor data: TerminalShop::Models::AppAPI
 
-      def initialize:
-        (data: TerminalShop::Models::AppAPI) -> void
-        | (
-          ?TerminalShop::Models::app_get_response | TerminalShop::BaseModel data
-        ) -> void
+      def initialize: (data: TerminalShop::Models::AppAPI) -> void
 
       def to_hash: -> TerminalShop::Models::app_get_response
     end

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

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

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

@@ -5,12 +5,7 @@ module TerminalShop
     class AppListResponse < TerminalShop::BaseModel
       attr_accessor data: ::Array[TerminalShop::Models::AppAPI]
 
-      def initialize:
-        (data: ::Array[TerminalShop::Models::AppAPI]) -> void
-        | (
-          ?TerminalShop::Models::app_list_response
-          | TerminalShop::BaseModel data
-        ) -> void
+      def initialize: (data: ::Array[TerminalShop::Models::AppAPI]) -> void
 
       def to_hash: -> TerminalShop::Models::app_list_response
     end