modern_treasury 0.1.0.pre.alpha.15 → 0.1.0.pre.alpha.17

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

@@ -0,0 +1,104 @@
+# typed: strong
+
+module ModernTreasury
+  module Internal
+    module Type
+      # @api private
+      module Converter
+        Input = T.type_alias { T.any(ModernTreasury::Internal::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: ModernTreasury::Internal::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(ModernTreasury::Internal::Type::Converter::Input)),
+                  union: T.nilable(T.proc.returns(ModernTreasury::Internal::Type::Converter::Input))
+                },
+                T.proc.returns(ModernTreasury::Internal::Type::Converter::Input),
+                ModernTreasury::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: ModernTreasury::Internal::Type::Converter::Input,
+              value: T.anything,
+              state: ModernTreasury::Internal::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 do
+            params(
+              target: ModernTreasury::Internal::Type::Converter::Input,
+              value: T.anything
+            ).returns(T.anything)
+          end
+          def self.dump(target, value); end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# typed: strong
+
+module ModernTreasury
+  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 ModernTreasury::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
+
+        # @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: ModernTreasury::Internal::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
+end

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

@@ -0,0 +1,79 @@
+# typed: strong
+
+module ModernTreasury
+  module Internal
+    module Type
+      # @api private
+      #
+      # Hash of items of a given type.
+      class HashOf
+        include ModernTreasury::Internal::Type::Converter
+
+        abstract!
+        final!
+
+        Elem = type_member(:out)
+
+        sig(:final) do
+          params(
+            type_info: T.any(
+              ModernTreasury::Internal::AnyHash,
+              T.proc.returns(ModernTreasury::Internal::Type::Converter::Input),
+              ModernTreasury::Internal::Type::Converter::Input
+            ),
+            spec: ModernTreasury::Internal::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: ModernTreasury::Internal::Type::Converter::State
+            )
+            .returns(T.any(ModernTreasury::Internal::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(ModernTreasury::Internal::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(
+              ModernTreasury::Internal::AnyHash,
+              T.proc.returns(ModernTreasury::Internal::Type::Converter::Input),
+              ModernTreasury::Internal::Type::Converter::Input
+            ),
+            spec: ModernTreasury::Internal::AnyHash
+          )
+            .void
+        end
+        def initialize(type_info, spec = {}); end
+      end
+    end
+  end
+end

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

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

data/rbi/lib/modern_treasury/internal/type/union.rbi

@@ -0,0 +1,69 @@
+# typed: strong
+
+module ModernTreasury
+  module Internal
+    module Type
+      # @api private
+      module Union
+        include ModernTreasury::Internal::Type::Converter
+
+        # @api private
+        #
+        # All of the specified variant info for this union.
+        sig do
+          returns(
+            T::Array[[
+              T.nilable(Symbol),
+              T.proc.returns(ModernTreasury::Internal::Type::Converter::Input)
+            ]]
+          )
+        end
+        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, ModernTreasury::Internal::AnyHash, T.proc.returns(T.anything), T.anything),
+            spec: T.any(ModernTreasury::Internal::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: ModernTreasury::Internal::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
+end

data/rbi/lib/modern_treasury/internal/type/unknown.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module ModernTreasury
+  module Internal
+    module Type
+      # @api private
+      #
+      # When we don't know what to expect for the value.
+      class Unknown
+        extend ModernTreasury::Internal::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: ModernTreasury::Internal::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
+end

data/rbi/lib/modern_treasury/internal/util.rbi

@@ -0,0 +1,254 @@
+# typed: strong
+
+module ModernTreasury
+  module Internal
+    # @api private
+    module Util
+      # @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
+        # @api private
+        sig { params(input: T.anything).returns(T::Boolean) }
+        def primitive?(input); end
+
+        # @api private
+        sig { params(input: T.any(String, T::Boolean)).returns(T.any(T::Boolean, T.anything)) }
+        def coerce_boolean(input); end
+
+        # @api private
+        sig { params(input: T.any(String, T::Boolean)).returns(T.nilable(T::Boolean)) }
+        def coerce_boolean!(input); end
+
+        # @api private
+        sig { params(input: T.any(String, Integer)).returns(T.any(Integer, T.anything)) }
+        def coerce_integer(input); end
+
+        # @api private
+        sig { params(input: T.any(String, Integer, Float)).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
+
+      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,
+          # 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(ModernTreasury::Internal::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))
+          )
+            .returns(T.nilable(T.anything))
+        end
+        def dig(data, pick, sentinel = nil, &blk); end
+      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))
+        end
+        def encode_query(query); 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
+
+      class << self
+        # @api private
+        sig do
+          params(url: T.any(URI::Generic, String)).returns(ModernTreasury::Internal::Util::ParsedUriShape)
+        end
+        def parse_uri(url); end
+
+        # @api private
+        sig { params(parsed: ModernTreasury::Internal::Util::ParsedUriShape).returns(URI::Generic) }
+        def unparse_uri(parsed); end
+
+        # @api private
+        sig do
+          params(
+            lhs: ModernTreasury::Internal::Util::ParsedUriShape,
+            rhs: ModernTreasury::Internal::Util::ParsedUriShape
+          )
+            .returns(URI::Generic)
+        end
+        def join_parsed_uri(lhs, rhs); end
+      end
+
+      class << self
+        # @api private
+        sig do
+          params(
+            headers: T::Hash[String,
+                             T.nilable(T.any(String, Integer, T::Array[T.nilable(T.any(String, Integer))]))]
+          )
+            .returns(T::Hash[String, String])
+        end
+        def normalized_headers(*headers); 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]),
+            blk: T.proc.params(arg0: String).void
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(stream, &blk); end
+      end
+
+      class << self
+        sig { params(blk: T.proc.params(y: Enumerator::Yielder).void).returns(T::Enumerable[String]) }
+        def writable_enum(&blk); end
+      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 write_multipart_chunk(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),
+            stream: T::Enumerable[String],
+            suppress_error: T::Boolean
+          )
+            .returns(T.anything)
+        end
+        def decode_content(headers, stream:, suppress_error: false); end
+      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])
+        end
+        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
+          )
+            .returns(T::Enumerable[T.anything])
+        end
+        def chain_fused(enum, &blk); end
+      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
+
+        # @api private
+        #
+        # https://html.spec.whatwg.org/multipage/server-sent-events.html#parsing-an-event-stream
+        sig do
+          params(lines: T::Enumerable[String])
+            .returns(T::Enumerable[ModernTreasury::Internal::Util::ServerSentEvent])
+        end
+        def decode_sse(lines); end
+      end
+    end
+  end
+end

data/rbi/lib/modern_treasury/internal.rbi

@@ -0,0 +1,12 @@
+# typed: strong
+
+module ModernTreasury
+  # @api private
+  module Internal
+    # 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] }
+
+    OMIT = T.let(T.anything, T.anything)
+  end
+end