orb-billing 0.1.3 → 0.3.0

data/rbi/lib/orb/internal/page.rbi

@@ -13,6 +13,7 @@ module Orb
       sig { returns(PaginationMetadata) }
       attr_accessor :pagination_metadata
 
+      # @api private
       sig { returns(String) }
       def inspect; end
 

data/rbi/lib/orb/internal/transport/base_client.rbi

@@ -24,7 +24,14 @@ module Orb
                         )]
               ),
               body: T.nilable(T.anything),
-              unwrap: T.nilable(Symbol),
+              unwrap: T.nilable(
+                T.any(
+                  Symbol,
+                  Integer,
+                  T::Array[T.any(Symbol, Integer)],
+                  T.proc.params(arg0: T.anything).returns(T.anything)
+                )
+              ),
               page: T.nilable(T::Class[Orb::Internal::Type::BasePage[Orb::Internal::Type::BaseModel]]),
               stream: T.nilable(T::Class[T.anything]),
               model: T.nilable(Orb::Internal::Type::Converter::Input),
@@ -90,7 +97,7 @@ module Orb
 
         # @api private
         sig { returns(Orb::Internal::Transport::PooledNetRequester) }
-        attr_accessor :requester
+        attr_reader :requester
 
         # @api private
         sig do
@@ -167,7 +174,14 @@ module Orb
                       )]
             ),
             body: T.nilable(T.anything),
-            unwrap: T.nilable(Symbol),
+            unwrap: T.nilable(
+              T.any(
+                Symbol,
+                Integer,
+                T::Array[T.any(Symbol, Integer)],
+                T.proc.params(arg0: T.anything).returns(T.anything)
+              )
+            ),
             page: T.nilable(T::Class[Orb::Internal::Type::BasePage[Orb::Internal::Type::BaseModel]]),
             stream: T.nilable(T::Class[T.anything]),
             model: T.nilable(Orb::Internal::Type::Converter::Input),
@@ -187,6 +201,7 @@ module Orb
           model: Orb::Internal::Type::Unknown,
           options: {}
         ); end
+        # @api private
         sig { returns(String) }
         def inspect; end
       end

data/rbi/lib/orb/internal/type/array_of.rbi

@@ -10,11 +10,10 @@ module Orb
         include Orb::Internal::Type::Converter
 
         abstract!
-        final!
 
         Elem = type_member(:out)
 
-        sig(:final) do
+        sig do
           params(
             type_info: T.any(
               Orb::Internal::AnyHash,
@@ -27,14 +26,17 @@ module Orb
         end
         def self.[](type_info, spec = {}); end
 
-        sig(:final) { params(other: T.anything).returns(T::Boolean) }
+        sig { params(other: T.anything).returns(T::Boolean) }
         def ===(other); end
 
-        sig(:final) { params(other: T.anything).returns(T::Boolean) }
+        sig { params(other: T.anything).returns(T::Boolean) }
         def ==(other); end
 
+        sig { returns(Integer) }
+        def hash; end
+
         # @api private
-        sig(:final) do
+        sig do
           override
             .params(value: T.any(
               T::Array[T.anything],
@@ -46,7 +48,7 @@ module Orb
         def coerce(value, state:); end
 
         # @api private
-        sig(:final) do
+        sig do
           override
             .params(value: T.any(
               T::Array[T.anything],
@@ -58,15 +60,15 @@ module Orb
         def dump(value, state:); end
 
         # @api private
-        sig(:final) { returns(Elem) }
+        sig { returns(Elem) }
         protected def item_type; end
 
         # @api private
-        sig(:final) { returns(T::Boolean) }
+        sig { returns(T::Boolean) }
         protected def nilable?; end
 
         # @api private
-        sig(:final) do
+        sig do
           params(
             type_info: T.any(
               Orb::Internal::AnyHash,
@@ -78,6 +80,10 @@ module Orb
             .void
         end
         def initialize(type_info, spec = {}); end
+
+        # @api private
+        sig { params(depth: Integer).returns(String) }
+        def inspect(depth: 0); end
       end
     end
   end

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

@@ -111,11 +111,17 @@ module Orb
 
           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
@@ -175,6 +181,12 @@ module Orb
         sig { params(keys: T.nilable(T::Array[Symbol])).returns(Orb::Internal::AnyHash) }
         def deconstruct_keys(keys); end
 
+        class << self
+          # @api private
+          sig { params(model: Orb::Internal::Type::BaseModel).returns(Orb::Internal::AnyHash) }
+          def walk(model); end
+        end
+
         sig { params(a: T.anything).returns(String) }
         def to_json(*a); end
 
@@ -185,6 +197,16 @@ module Orb
         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

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

@@ -3,6 +3,8 @@
 module Orb
   module Internal
     module Type
+      # @api private
+      #
       # This module provides a base implementation for paginated responses in the SDK.
       module BasePage
         Elem = type_member(:out)

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

@@ -10,17 +10,16 @@ module Orb
         extend Orb::Internal::Type::Converter
 
         abstract!
-        final!
 
-        sig(:final) { params(other: T.anything).returns(T::Boolean) }
+        sig { params(other: T.anything).returns(T::Boolean) }
         def self.===(other); end
 
-        sig(:final) { params(other: T.anything).returns(T::Boolean) }
+        sig { params(other: T.anything).returns(T::Boolean) }
         def self.==(other); end
 
         class << self
           # @api private
-          sig(:final) do
+          sig do
             override
               .params(value: T.any(
                 T::Boolean,
@@ -32,7 +31,7 @@ module Orb
           def coerce(value, state:); end
 
           # @api private
-          sig(:final) do
+          sig do
             override
               .params(value: T.any(T::Boolean, T.anything), state: Orb::Internal::Type::Converter::DumpState)
               .returns(T.any(T::Boolean, T.anything))

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

@@ -35,6 +35,10 @@ module Orb
         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
@@ -106,6 +110,10 @@ module Orb
               .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

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

@@ -22,18 +22,15 @@ module Orb
         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
 
+        sig { returns(Integer) }
+        def hash; end
+
         # @api private
         #
         # Unlike with primitives, `Enum` additionally validates that the value is a member
@@ -57,6 +54,10 @@ module Orb
             .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

data/rbi/lib/orb/internal/type/{io_like.rbi → file_input.rbi}

@@ -5,22 +5,24 @@ module Orb
     module Type
       # @api private
       #
-      # Either `Pathname` or `StringIO`.
-      class IOLike
+      # Either `Pathname` or `StringIO`, or `IO`, or `Orb::Internal::Type::FileInput`.
+      #
+      # Note: when `IO` is used, all retries are disabled, since many IO` streams are
+      # not rewindable.
+      class FileInput
         extend Orb::Internal::Type::Converter
 
         abstract!
-        final!
 
-        sig(:final) { params(other: T.anything).returns(T::Boolean) }
+        sig { params(other: T.anything).returns(T::Boolean) }
         def self.===(other); end
 
-        sig(:final) { params(other: T.anything).returns(T::Boolean) }
+        sig { params(other: T.anything).returns(T::Boolean) }
         def self.==(other); end
 
         class << self
           # @api private
-          sig(:final) do
+          sig do
             override
               .params(value: T.any(
                 StringIO,
@@ -33,7 +35,7 @@ module Orb
           def coerce(value, state:); end
 
           # @api private
-          sig(:final) do
+          sig do
             override
               .params(
                 value: T.any(Pathname, StringIO, IO, String, T.anything),

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

@@ -10,11 +10,10 @@ module Orb
         include Orb::Internal::Type::Converter
 
         abstract!
-        final!
 
         Elem = type_member(:out)
 
-        sig(:final) do
+        sig do
           params(
             type_info: T.any(
               Orb::Internal::AnyHash,
@@ -27,14 +26,17 @@ module Orb
         end
         def self.[](type_info, spec = {}); end
 
-        sig(:final) { params(other: T.anything).returns(T::Boolean) }
+        sig { params(other: T.anything).returns(T::Boolean) }
         def ===(other); end
 
-        sig(:final) { params(other: T.anything).returns(T::Boolean) }
+        sig { params(other: T.anything).returns(T::Boolean) }
         def ==(other); end
 
+        sig { returns(Integer) }
+        def hash; end
+
         # @api private
-        sig(:final) do
+        sig do
           override
             .params(
               value: T.any(T::Hash[T.anything, T.anything], T.anything),
@@ -45,7 +47,7 @@ module Orb
         def coerce(value, state:); end
 
         # @api private
-        sig(:final) do
+        sig do
           override
             .params(
               value: T.any(T::Hash[T.anything, T.anything], T.anything),
@@ -56,15 +58,15 @@ module Orb
         def dump(value, state:); end
 
         # @api private
-        sig(:final) { returns(Elem) }
+        sig { returns(Elem) }
         protected def item_type; end
 
         # @api private
-        sig(:final) { returns(T::Boolean) }
+        sig { returns(T::Boolean) }
         protected def nilable?; end
 
         # @api private
-        sig(:final) do
+        sig do
           params(
             type_info: T.any(
               Orb::Internal::AnyHash,
@@ -76,6 +78,10 @@ module Orb
             .void
         end
         def initialize(type_info, spec = {}); end
+
+        # @api private
+        sig { params(depth: Integer).returns(String) }
+        def inspect(depth: 0); end
       end
     end
   end

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

@@ -45,6 +45,9 @@ module Orb
         sig { params(other: T.anything).returns(T::Boolean) }
         def ==(other); end
 
+        sig { returns(Integer) }
+        def hash; end
+
         # @api private
         sig do
           override.params(
@@ -62,6 +65,10 @@ module Orb
           ).returns(T.anything)
         end
         def dump(value, state:); end
+
+        # @api private
+        sig { params(depth: Integer).returns(String) }
+        def inspect(depth: 0); end
       end
     end
   end

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

@@ -10,17 +10,16 @@ module Orb
         extend Orb::Internal::Type::Converter
 
         abstract!
-        final!
 
-        sig(:final) { params(other: T.anything).returns(T::Boolean) }
+        sig { params(other: T.anything).returns(T::Boolean) }
         def self.===(other); end
 
-        sig(:final) { params(other: T.anything).returns(T::Boolean) }
+        sig { params(other: T.anything).returns(T::Boolean) }
         def self.==(other); end
 
         class << self
           # @api private
-          sig(:final) do
+          sig do
             override.params(
               value: T.anything,
               state: Orb::Internal::Type::Converter::CoerceState
@@ -29,7 +28,7 @@ module Orb
           def coerce(value, state:); end
 
           # @api private
-          sig(:final) do
+          sig do
             override.params(
               value: T.anything,
               state: Orb::Internal::Type::Converter::DumpState

data/rbi/lib/orb/internal/util.rbi

@@ -68,13 +68,19 @@ module Orb
         sig do
           params(
             data: T.any(Orb::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),
+            pick: T.nilable(
+              T.any(
+                Symbol,
+                Integer,
+                T::Array[T.any(Symbol, Integer)],
+                T.proc.params(arg0: T.anything).returns(T.anything)
+              )
+            ),
             blk: T.nilable(T.proc.returns(T.anything))
           )
             .returns(T.nilable(T.anything))
         end
-        def dig(data, pick, sentinel = nil, &blk); end
+        def dig(data, pick, &blk); end
       end
 
       class << self
@@ -140,22 +146,6 @@ module Orb
         def normalized_headers(*headers); end
       end
 
-      # @api private
-      class SerializationAdapter
-        sig { returns(T.any(Pathname, IO)) }
-        attr_reader :inner
-
-        sig { params(a: T.anything).returns(String) }
-        def to_json(*a); end
-
-        sig { params(a: T.anything).returns(String) }
-        def to_yaml(*a); end
-
-        # @api private
-        sig { params(inner: T.any(Pathname, IO)).returns(T.attached_class) }
-        def self.new(inner); end
-      end
-
       # @api private
       #
       # An adapter that satisfies the IO interface required by `::IO.copy_stream`
@@ -192,7 +182,22 @@ module Orb
         def writable_enum(&blk); end
       end
 
+      JSON_CONTENT = T.let(%r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}, Regexp)
+      JSONL_CONTENT = T.let(%r{^application/(?:x-)?jsonl}, Regexp)
+
       class << self
+        # @api private
+        sig do
+          params(
+            y: Enumerator::Yielder,
+            val: T.anything,
+            closing: T::Array[T.proc.void],
+            content_type: T.nilable(String)
+          )
+            .void
+        end
+        private def write_multipart_content(y, val:, closing:, content_type: nil); end
+
         # @api private
         sig do
           params(
@@ -215,6 +220,14 @@ module Orb
         def encode_content(headers, body); end
 
         # @api private
+        #
+        # https://www.iana.org/assignments/character-sets/character-sets.xhtml
+        sig { params(content_type: String, text: String).void }
+        def force_charset!(content_type, text:); end
+
+        # @api private
+        #
+        # Assumes each chunk in stream has `Encoding::BINARY`.
         sig do
           params(
             headers: T.any(T::Hash[String, String], Net::HTTPHeader),
@@ -263,12 +276,19 @@ module Orb
 
       class << self
         # @api private
+        #
+        # Assumes Strings have been forced into having `Encoding::BINARY`.
+        #
+        # This decoder is responsible for reassembling lines split across multiple
+        # fragments.
         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
+        #
+        # Assumes that `lines` has been decoded with `#decode_lines`.
         sig do
           params(lines: T::Enumerable[String]).returns(T::Enumerable[Orb::Internal::Util::ServerSentEvent])
         end

data/rbi/lib/orb/internal.rbi

@@ -1,12 +1,11 @@
 # typed: strong
 
 module Orb
-  # @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)
+    OMIT = T.let(Object.new.freeze, T.anything)
   end
 end

data/rbi/lib/orb/models/alert.rbi

@@ -77,19 +77,28 @@ module Orb
           .returns(T.attached_class)
       end
       def self.new(
+        # Also referred to as alert_id in this documentation.
         id:,
+        # The creation time of the resource in Orb.
         created_at:,
+        # The name of the currency the credit balance or invoice cost is denominated in.
         currency:,
+        # The customer the alert applies to.
         customer:,
+        # Whether the alert is enabled or disabled.
         enabled:,
+        # The metric the alert applies to.
         metric:,
+        # The plan the alert applies to.
         plan:,
+        # The subscription the alert applies to.
         subscription:,
+        # The thresholds that define the conditions under which the alert will be
+        # triggered.
         thresholds:,
+        # The type of alert. This must be a valid alert type.
         type:
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(
@@ -162,8 +171,15 @@ module Orb
           )
             .returns(T.attached_class)
         end
-        def self.new(id:, external_plan_id:, name:, plan_version:); end
-
+        def self.new(
+          id:,
+          # An optional user-defined ID for this plan resource, used throughout the system
+          # as an alias for this Plan. Use this field to identify a plan by an existing
+          # identifier in your system.
+          external_plan_id:,
+          name:,
+          plan_version:
+        ); end
         sig do
           override
             .returns(
@@ -200,8 +216,12 @@ module Orb
         # Thresholds are used to define the conditions under which an alert will be
         # triggered.
         sig { params(value: Float).returns(T.attached_class) }
-        def self.new(value:); end
-
+        def self.new(
+          # The value at which an alert will fire. For credit balance alerts, the alert will
+          # fire at or below this value. For usage and cost alerts, the alert will fire at
+          # or above this value.
+          value:
+        ); end
         sig { override.returns({value: Float}) }
         def to_hash; end
       end
@@ -211,7 +231,7 @@ module Orb
         extend Orb::Internal::Type::Enum
 
         TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Alert::Type) }
-        OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Alert::Type::TaggedSymbol) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         CREDIT_BALANCE_DEPLETED = T.let(:credit_balance_depleted, Orb::Models::Alert::Type::TaggedSymbol)
         CREDIT_BALANCE_DROPPED = T.let(:credit_balance_dropped, Orb::Models::Alert::Type::TaggedSymbol)

data/rbi/lib/orb/models/alert_create_for_customer_params.rbi

@@ -27,8 +27,15 @@ module Orb
         )
           .returns(T.attached_class)
       end
-      def self.new(currency:, type:, thresholds: nil, request_options: {}); end
-
+      def self.new(
+        # The case sensitive currency or custom pricing unit to use for this alert.
+        currency:,
+        # The type of alert to create. This must be a valid alert type.
+        type:,
+        # The thresholds that define the values at which the alert will be triggered.
+        thresholds: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(
@@ -47,8 +54,7 @@ module Orb
         extend Orb::Internal::Type::Enum
 
         TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::AlertCreateForCustomerParams::Type) }
-        OrSymbol =
-          T.type_alias { T.any(Symbol, String, Orb::Models::AlertCreateForCustomerParams::Type::TaggedSymbol) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         CREDIT_BALANCE_DEPLETED =
           T.let(:credit_balance_depleted, Orb::Models::AlertCreateForCustomerParams::Type::TaggedSymbol)
@@ -71,8 +77,12 @@ module Orb
         # Thresholds are used to define the conditions under which an alert will be
         # triggered.
         sig { params(value: Float).returns(T.attached_class) }
-        def self.new(value:); end
-
+        def self.new(
+          # The value at which an alert will fire. For credit balance alerts, the alert will
+          # fire at or below this value. For usage and cost alerts, the alert will fire at
+          # or above this value.
+          value:
+        ); end
         sig { override.returns({value: Float}) }
         def to_hash; end
       end