orb-billing 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2f2a150f3bbeffc4968f28b279e5c7c43abec6157af25c8e611fd831e284c28
-  data.tar.gz: a16f35197738dd432d005af4c9712424d72b6321a40dd2bb8a8610b1c6cf6759
+  metadata.gz: b20102d8611954dcd1c5682addb7eb5d7b54314f2a38a14ac662e61fdd3084d5
+  data.tar.gz: '0857f6afda9adda33b5370837b17c5ab08e2bead3d708a3554e0c23c4398c2de'
 SHA512:
-  metadata.gz: 1e00b2405bef17513a4df12aee28e0960ae7d5e7cb84a58897bc38fac404f910a7137a3ba195fc9b097d4669179ca632b79def2b9235246f1946185717fc0c91
-  data.tar.gz: abc4cf559259bf76454de1a583eb75accd6deddcc596730fff3ed4cadebf4a44c158ea2b78f2072a4ab953d1ca73fd623b93df3fee072ca8e6d429e03e60772a
+  metadata.gz: a2641bfb912356b7b5458ffa63da5c444a75c651dc14984a863badfb4b461e1b06da20ac25153dfa4d1e8176411268b541777f631cf75300b1704dfc0316a417
+  data.tar.gz: 51816a9538c1d9e475afd9bc3e027aa4ef09874850ebb0d12d0c3b662c63315ef1a61e28e3d271ad83e3c529d8dddb545eace95b2fafa4c6e6689edbd63cb2a2

data/.ignore

@@ -0,0 +1,2 @@
+rbi/*
+sig/*

data/CHANGELOG.md

@@ -1,5 +1,36 @@
 # Changelog
 
+## 0.2.0 (2025-04-17)
+
+Full Changelog: [v0.1.3...v0.2.0](https://github.com/orbcorp/orb-ruby/compare/v0.1.3...v0.2.0)
+
+### Features
+
+* **client:** enable setting base URL from environment variable ([a472f4c](https://github.com/orbcorp/orb-ruby/commit/a472f4cdee0d969b7e240a9519acccd3877f3de6))
+
+
+### Bug Fixes
+
+* always send idempotency header when specified as a request option ([f570e93](https://github.com/orbcorp/orb-ruby/commit/f570e93e8fe1a2f6d6df495021ea1152aeaf1e58))
+
+
+### Chores
+
+* **internal:** always run post-processing when formatting when syntax_tree ([9df6d63](https://github.com/orbcorp/orb-ruby/commit/9df6d6382e67f6f28f1cedff4ee1c949ffd70237))
+* **internal:** codegen related update ([202fff4](https://github.com/orbcorp/orb-ruby/commit/202fff413ad9e9be16b67a07270dd4ac2c4f14e4))
+* **internal:** codegen related update ([2b99ae2](https://github.com/orbcorp/orb-ruby/commit/2b99ae2ea108ad4e6227bd5ab7e9a7dd064a8ded))
+* **internal:** contribute.md and contributor QoL improvements ([cb204de](https://github.com/orbcorp/orb-ruby/commit/cb204de43549ee6aa9ead2d1e071ec5df0c58cb2))
+* **internal:** loosen internal type restrictions ([9dc6b52](https://github.com/orbcorp/orb-ruby/commit/9dc6b52d1bfa57e3fab328bf8673872522ab7f25))
+* **internal:** minor touch ups on sdk internals ([9297be8](https://github.com/orbcorp/orb-ruby/commit/9297be8eaa459f14cb0b4118066ecd59877686ab))
+* **internal:** protect SSE parsing pipeline from broken UTF-8 characters ([bb2243a](https://github.com/orbcorp/orb-ruby/commit/bb2243a19fbd077687be4b2a4a001e4b7381c54d))
+* **internal:** version bump ([c664f2f](https://github.com/orbcorp/orb-ruby/commit/c664f2fb5019cabca07ce026410d6951f9412d69))
+* refine `#inspect` and `#to_s` for model classes ([86f8280](https://github.com/orbcorp/orb-ruby/commit/86f8280e1126e5bd4013f4c1e5ddd09190044fa3))
+
+
+### Documentation
+
+* update documentation links to be more uniform ([a0bfe42](https://github.com/orbcorp/orb-ruby/commit/a0bfe42c34e09819e4948069670cfdf895cb51af))
+
 ## 0.1.3 (2025-04-11)
 
 Full Changelog: [v0.1.2...v0.1.3](https://github.com/orbcorp/orb-ruby/compare/v0.1.2...v0.1.3)

data/README.md

@@ -4,9 +4,9 @@ The Orb Ruby library provides convenient access to the Orb REST API from any Rub
 
 ## Documentation
 
-Documentation for released of this gem can be found [on RubyDoc](https://gemdocs.org/gems/orb-billing).
+Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/orb-billing).
 
-The underlying REST API documentation can be found on [docs.withorb.com](https://docs.withorb.com/reference/api-reference).
+The REST API documentation can be found on [docs.withorb.com](https://docs.withorb.com/reference/api-reference).
 
 ## Installation
 
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "orb-billing", "~> 0.1.3"
+gem "orb-billing", "~> 0.2.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/orb/client.rb

@@ -76,7 +76,8 @@ module Orb
     #
     # @param api_key [String, nil] Defaults to `ENV["ORB_API_KEY"]`
     #
-    # @param base_url [String, nil] Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
+    # @param base_url [String, nil] Override the default base URL for the API, e.g.,
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["ORB_BASE_URL"]`
     #
     # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
     #
@@ -89,7 +90,7 @@ module Orb
     # @param idempotency_header [String]
     def initialize(
       api_key: ENV["ORB_API_KEY"],
-      base_url: nil,
+      base_url: ENV["ORB_BASE_URL"],
       max_retries: DEFAULT_MAX_RETRIES,
       timeout: DEFAULT_TIMEOUT_IN_SECONDS,
       initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY,

data/lib/orb/internal/page.rb

@@ -22,33 +22,6 @@ module Orb
       # @return [PaginationMetadata]
       attr_accessor :pagination_metadata
 
-      # @api private
-      #
-      # @param client [Orb::Internal::Transport::BaseClient]
-      # @param req [Hash{Symbol=>Object}]
-      # @param headers [Hash{String=>String}, Net::HTTPHeader]
-      # @param page_data [Hash{Symbol=>Object}]
-      def initialize(client:, req:, headers:, page_data:)
-        super
-        model = req.fetch(:model)
-
-        case page_data
-        in {data: Array | nil => data}
-          @data = data&.map { Orb::Internal::Type::Converter.coerce(model, _1) }
-        else
-        end
-
-        case page_data
-        in {pagination_metadata: Hash | nil => pagination_metadata}
-          @pagination_metadata =
-            Orb::Internal::Type::Converter.coerce(
-              Orb::Internal::Page::PaginationMetadata,
-              pagination_metadata
-            )
-        else
-        end
-      end
-
       # @return [Boolean]
       def next_page?
         !pagination_metadata&.next_cursor.nil?
@@ -73,19 +46,48 @@ module Orb
         unless block_given?
           raise ArgumentError.new("A block must be given to ##{__method__}")
         end
+
         page = self
         loop do
-          page.data&.each { blk.call(_1) }
+          page.data&.each(&blk)
+
           break unless page.next_page?
           page = page.next_page
         end
       end
 
+      # @api private
+      #
+      # @param client [Orb::Internal::Transport::BaseClient]
+      # @param req [Hash{Symbol=>Object}]
+      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param page_data [Hash{Symbol=>Object}]
+      def initialize(client:, req:, headers:, page_data:)
+        super
+
+        case page_data
+        in {data: Array | nil => data}
+          @data = data&.map { Orb::Internal::Type::Converter.coerce(@model, _1) }
+        else
+        end
+        case page_data
+        in {pagination_metadata: Hash | nil => pagination_metadata}
+          @pagination_metadata =
+            Orb::Internal::Type::Converter.coerce(
+              Orb::Internal::Page::PaginationMetadata,
+              pagination_metadata
+            )
+        else
+        end
+      end
+
+      # @api private
+      #
       # @return [String]
       def inspect
-        # rubocop:disable Layout/LineLength
-        "#<#{self.class}:0x#{object_id.to_s(16)} data=#{data.inspect} pagination_metadata=#{pagination_metadata.inspect}>"
-        # rubocop:enable Layout/LineLength
+        model = Orb::Internal::Type::Converter.inspect(@model, depth: 1)
+
+        "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)}>"
       end
 
       class PaginationMetadata < Orb::Internal::Type::BaseModel

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

@@ -93,7 +93,11 @@ module Orb
                 URI.join(url, response_headers["location"])
               rescue ArgumentError
                 message = "Server responded with status #{status} but no valid location header."
-                raise Orb::Errors::APIConnectionError.new(url: url, message: message)
+                raise Orb::Errors::APIConnectionError.new(
+                  url: url,
+                  response: response_headers,
+                  message: message
+                )
               end
 
             request = {**request, url: location}
@@ -101,7 +105,11 @@ module Orb
             case [url.scheme, location.scheme]
             in ["https", "http"]
               message = "Tried to redirect to a insecure URL"
-              raise Orb::Errors::APIConnectionError.new(url: url, message: message)
+              raise Orb::Errors::APIConnectionError.new(
+                url: url,
+                response: response_headers,
+                message: message
+              )
             else
               nil
             end
@@ -245,7 +253,7 @@ module Orb
 
           if @idempotency_header &&
              !headers.key?(@idempotency_header) &&
-             !Net::HTTP::IDEMPOTENT_METHODS_.include?(method.to_s.upcase)
+             (!Net::HTTP::IDEMPOTENT_METHODS_.include?(method.to_s.upcase) || opts.key?(:idempotency_key))
             headers[@idempotency_header] = opts.fetch(:idempotency_key) { generate_idempotency_key }
           end
 
@@ -350,7 +358,7 @@ module Orb
             self.class.reap_connection!(status, stream: stream)
 
             message = "Failed to complete the request within #{self.class::MAX_REDIRECTS} redirects."
-            raise Orb::Errors::APIConnectionError.new(url: url, message: message)
+            raise Orb::Errors::APIConnectionError.new(url: url, response: response, message: message)
           in 300..399
             self.class.reap_connection!(status, stream: stream)
 
@@ -460,6 +468,8 @@ module Orb
           end
         end
 
+        # @api private
+        #
         # @return [String]
         def inspect
           # rubocop:disable Layout/LineLength

data/lib/orb/internal/transport/pooled_net_requester.rb

@@ -149,7 +149,7 @@ module Orb
                 break if finished
 
                 rsp.read_body do |bytes|
-                  y << bytes
+                  y << bytes.force_encoding(Encoding::BINARY)
                   break if finished
 
                   self.class.calibrate_socket_timeout(conn, deadline)

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

@@ -13,6 +13,10 @@ module Orb
       class ArrayOf
         include Orb::Internal::Type::Converter
 
+        private_class_method :new
+
+        # @overload [](type_info, spec = {})
+        #
         # @param type_info [Hash{Symbol=>Object}, Proc, Orb::Internal::Type::Converter, Class]
         #
         # @param spec [Hash{Symbol=>Object}] .
@@ -24,7 +28,7 @@ module Orb
         #   @option spec [Proc] :union
         #
         #   @option spec [Boolean] :"nil?"
-        def self.[](type_info, spec = {}) = new(type_info, spec)
+        def self.[](...) = new(...)
 
         # @param other [Object]
         #
@@ -120,7 +124,18 @@ module Orb
         #   @option spec [Boolean] :"nil?"
         def initialize(type_info, spec = {})
           @item_type_fn = Orb::Internal::Type::Converter.type_info(type_info || spec)
-          @nilable = spec[:nil?]
+          @nilable = spec.fetch(:nil?, false)
+        end
+
+        # @api private
+        #
+        # @param depth [Integer]
+        #
+        # @return [String]
+        def inspect(depth: 0)
+          items = Orb::Internal::Type::Converter.inspect(item_type, depth: depth.succ)
+
+          "#{self.class}[#{[items, nilable? ? 'nil' : nil].compact.join(' | ')}]"
         end
       end
     end

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

@@ -63,7 +63,7 @@ module Orb
 
             setter = "#{name_sym}="
             api_name = info.fetch(:api_name, name_sym)
-            nilable = info[:nil?]
+            nilable = info.fetch(:nil?, false)
             const = required && !nilable ? info.fetch(:const, Orb::Internal::OMIT) : Orb::Internal::OMIT
 
             [name_sym, setter].each { undef_method(_1) } if known_fields.key?(name_sym)
@@ -338,6 +338,27 @@ module Orb
             .to_h
         end
 
+        class << self
+          # @param model [Orb::Internal::Type::BaseModel]
+          #
+          # @return [Hash{Symbol=>Object}]
+          def walk(model)
+            walk = ->(x) do
+              case x
+              in Orb::Internal::Type::BaseModel
+                walk.call(x.to_h)
+              in Hash
+                x.transform_values(&walk)
+              in Array
+                x.map(&walk)
+              else
+                x
+              end
+            end
+            walk.call(model)
+          end
+        end
+
         # @param a [Object]
         #
         # @return [String]
@@ -361,15 +382,38 @@ module Orb
           end
         end
 
-        # @return [String]
-        def inspect
-          rows = self.class.known_fields.keys.map do
-            "#{_1}=#{@data.key?(_1) ? public_send(_1) : ''}"
-          rescue Orb::Errors::ConversionError
-            "#{_1}=#{@data.fetch(_1)}"
+        class << self
+          # @api private
+          #
+          # @param depth [Integer]
+          #
+          # @return [String]
+          def inspect(depth: 0)
+            return super() if depth.positive?
+
+            depth = depth.succ
+            deferred = fields.transform_values do |field|
+              type, required, nilable = field.fetch_values(:type, :required, :nilable)
+              inspected = [
+                Orb::Internal::Type::Converter.inspect(type, depth: depth),
+                !required || nilable ? "nil" : nil
+              ].compact.join(" | ")
+              -> { inspected }.tap { _1.define_singleton_method(:inspect) { call } }
+            end
+
+            "#{name}[#{deferred.inspect}]"
           end
-          "#<#{self.class.name}:0x#{object_id.to_s(16)} #{rows.join(' ')}>"
         end
+
+        # @api private
+        #
+        # @return [String]
+        def to_s = self.class.walk(@data).to_s
+
+        # @api private
+        #
+        # @return [String]
+        def inspect = "#<#{self.class}:0x#{object_id.to_s(16)} #{self}>"
       end
     end
   end

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

@@ -36,6 +36,7 @@ module Orb
         def initialize(client:, req:, headers:, page_data:)
           @client = client
           @req = req
+          @model = req.fetch(:model)
           super()
         end
 

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

@@ -11,6 +11,8 @@ module Orb
       class Boolean
         extend Orb::Internal::Type::Converter
 
+        private_class_method :new
+
         # @param other [Object]
         #
         # @return [Boolean]

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

@@ -49,6 +49,15 @@ module Orb
           end
         end
 
+        # @api private
+        #
+        # @param depth [Integer]
+        #
+        # @return [String]
+        def inspect(depth: 0)
+          super()
+        end
+
         # rubocop:enable Lint/UnusedMethodArgument
 
         class << self
@@ -240,6 +249,21 @@ module Orb
               Orb::Internal::Type::Unknown.dump(value, state: state)
             end
           end
+
+          # @api private
+          #
+          # @param target [Object]
+          # @param depth [Integer]
+          #
+          # @return [String]
+          def inspect(target, depth:)
+            case target
+            in Orb::Internal::Type::Converter
+              target.inspect(depth: depth.succ)
+            else
+              target.inspect
+            end
+          end
         end
       end
     end

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

@@ -58,9 +58,9 @@ module Orb
         #
         # @return [Boolean]
         def ==(other)
-          # rubocop:disable Layout/LineLength
-          other.is_a?(Module) && other.singleton_class <= Orb::Internal::Type::Enum && other.values.to_set == values.to_set
-          # rubocop:enable Layout/LineLength
+          # rubocop:disable Style/CaseEquality
+          Orb::Internal::Type::Enum === other && other.values.to_set == values.to_set
+          # rubocop:enable Style/CaseEquality
         end
 
         # @api private
@@ -103,6 +103,22 @@ module Orb
         #   #
         #   # @return [Symbol, Object]
         #   def dump(value, state:) = super
+
+        # @api private
+        #
+        # @param depth [Integer]
+        #
+        # @return [String]
+        def inspect(depth: 0)
+          if depth.positive?
+            return is_a?(Module) ? super() : self.class.name
+          end
+
+          members = values.map { Orb::Internal::Type::Converter.inspect(_1, depth: depth.succ) }
+          prefix = is_a?(Module) ? name : self.class.name
+
+          "#{prefix}[#{members.join(' | ')}]"
+        end
       end
     end
   end

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

@@ -13,6 +13,10 @@ module Orb
       class HashOf
         include Orb::Internal::Type::Converter
 
+        private_class_method :new
+
+        # @overload [](type_info, spec = {})
+        #
         # @param type_info [Hash{Symbol=>Object}, Proc, Orb::Internal::Type::Converter, Class]
         #
         # @param spec [Hash{Symbol=>Object}] .
@@ -24,7 +28,7 @@ module Orb
         #   @option spec [Proc] :union
         #
         #   @option spec [Boolean] :"nil?"
-        def self.[](type_info, spec = {}) = new(type_info, spec)
+        def self.[](...) = new(...)
 
         # @param other [Object]
         #
@@ -140,7 +144,18 @@ module Orb
         #   @option spec [Boolean] :"nil?"
         def initialize(type_info, spec = {})
           @item_type_fn = Orb::Internal::Type::Converter.type_info(type_info || spec)
-          @nilable = spec[:nil?]
+          @nilable = spec.fetch(:nil?, false)
+        end
+
+        # @api private
+        #
+        # @param depth [Integer]
+        #
+        # @return [String]
+        def inspect(depth: 0)
+          items = Orb::Internal::Type::Converter.inspect(item_type, depth: depth.succ)
+
+          "#{self.class}[#{[items, nilable? ? 'nil' : nil].compact.join(' | ')}]"
         end
       end
     end

data/lib/orb/internal/type/io_like.rb

@@ -11,6 +11,8 @@ module Orb
       class IOLike
         extend Orb::Internal::Type::Converter
 
+        private_class_method :new
+
         # @param other [Object]
         #
         # @return [Boolean]

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

@@ -140,9 +140,7 @@ module Orb
         #
         # @return [Boolean]
         def ==(other)
-          # rubocop:disable Layout/LineLength
-          other.is_a?(Module) && other.singleton_class <= Orb::Internal::Type::Union && other.derefed_variants == derefed_variants
-          # rubocop:enable Layout/LineLength
+          Orb::Internal::Type::Union === other && other.derefed_variants == derefed_variants
         end
 
         # @api private
@@ -225,6 +223,22 @@ module Orb
 
         # rubocop:enable Style/CaseEquality
         # rubocop:enable Style/HashEachMethods
+
+        # @api private
+        #
+        # @param depth [Integer]
+        #
+        # @return [String]
+        def inspect(depth: 0)
+          if depth.positive?
+            return is_a?(Module) ? super() : self.class.name
+          end
+
+          members = variants.map { Orb::Internal::Type::Converter.inspect(_1, depth: depth.succ) }
+          prefix = is_a?(Module) ? name : self.class.name
+
+          "#{prefix}[#{members.join(' | ')}]"
+        end
       end
     end
   end

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

@@ -13,6 +13,8 @@ module Orb
 
         # rubocop:disable Lint/UnusedMethodArgument
 
+        private_class_method :new
+
         # @param other [Object]
         #
         # @return [Boolean]

data/lib/orb/internal/util.rb

@@ -448,7 +448,7 @@ module Orb
             else
               src
             end
-          @buf = String.new.b
+          @buf = String.new
           @blk = blk
         end
       end
@@ -460,7 +460,7 @@ module Orb
         # @return [Enumerable<String>]
         def writable_enum(&blk)
           Enumerator.new do |y|
-            buf = String.new.b
+            buf = String.new
             y.define_singleton_method(:write) do
               self << buf.replace(_1)
               buf.bytesize
@@ -582,6 +582,27 @@ module Orb
 
         # @api private
         #
+        # https://www.iana.org/assignments/character-sets/character-sets.xhtml
+        #
+        # @param content_type [String]
+        # @param text [String]
+        def force_charset!(content_type, text:)
+          charset = /charset=([^;\s]+)/.match(content_type)&.captures&.first
+
+          return unless charset
+
+          begin
+            encoding = Encoding.find(charset)
+            text.force_encoding(encoding)
+          rescue ArgumentError
+            nil
+          end
+        end
+
+        # @api private
+        #
+        # Assumes each chunk in stream has `Encoding::BINARY`.
+        #
         # @param headers [Hash{String=>String}, Net::HTTPHeader]
         # @param stream [Enumerable<String>]
         # @param suppress_error [Boolean]
@@ -589,7 +610,7 @@ module Orb
         # @raise [JSON::ParserError]
         # @return [Object]
         def decode_content(headers, stream:, suppress_error: false)
-          case headers["content-type"]
+          case (content_type = headers["content-type"])
           in %r{^application/(?:vnd\.api\+)?json}
             json = stream.to_a.join
             begin
@@ -606,11 +627,10 @@ module Orb
           in %r{^text/event-stream}
             lines = decode_lines(stream)
             decode_sse(lines)
-          in %r{^text/}
-            stream.to_a.join
           else
-            # TODO: parsing other response types
-            StringIO.new(stream.to_a.join)
+            text = stream.to_a.join
+            force_charset!(content_type, text: text)
+            StringIO.new(text)
           end
         end
       end
@@ -675,12 +695,17 @@ 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.
+        #
         # @param enum [Enumerable<String>]
         #
         # @return [Enumerable<String>]
         def decode_lines(enum)
           re = /(\r\n|\r|\n)/
-          buffer = String.new.b
+          buffer = String.new
           cr_seen = nil
 
           chain_fused(enum) do |y|
@@ -711,6 +736,8 @@ module Orb
         #
         # https://html.spec.whatwg.org/multipage/server-sent-events.html#parsing-an-event-stream
         #
+        # Assumes that `lines` has been decoded with `#decode_lines`.
+        #
         # @param lines [Enumerable<String>]
         #
         # @return [Enumerable<Hash{Symbol=>Object}>]
@@ -734,7 +761,7 @@ module Orb
                 in "event"
                   current.merge!(event: value)
                 in "data"
-                  (current[:data] ||= String.new.b) << (value << "\n")
+                  (current[:data] ||= String.new) << (value << "\n")
                 in "id" unless value.include?("\0")
                   current.merge!(id: value)
                 in "retry" if /^\d+$/ =~ value

data/lib/orb/internal.rb

@@ -3,6 +3,10 @@
 module Orb
   # @api private
   module Internal
-    OMIT = Object.new.freeze
+    OMIT =
+      Object.new.tap do
+        _1.define_singleton_method(:inspect) { "#<#{Orb::Internal}::OMIT>" }
+      end
+        .freeze
   end
 end

data/lib/orb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Orb
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/rbi/lib/orb/client.rbi

@@ -78,8 +78,9 @@ module Orb
     def self.new(
       # Defaults to `ENV["ORB_API_KEY"]`
       api_key: ENV["ORB_API_KEY"],
-      # Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
-      base_url: nil,
+      # Override the default base URL for the API, e.g.,
+      # `"https://api.example.com/v2/"`. Defaults to `ENV["ORB_BASE_URL"]`
+      base_url: ENV["ORB_BASE_URL"],
       # Max number of retries to attempt after a failed retryable request.
       max_retries: DEFAULT_MAX_RETRIES,
       timeout: DEFAULT_TIMEOUT_IN_SECONDS,

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

@@ -187,6 +187,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,14 @@ 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
 
         # @api private
-        sig(:final) do
+        sig do
           override
             .params(value: T.any(
               T::Array[T.anything],
@@ -46,7 +45,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 +57,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 +77,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

@@ -175,6 +175,11 @@ module Orb
         sig { params(keys: T.nilable(T::Array[Symbol])).returns(Orb::Internal::AnyHash) }
         def deconstruct_keys(keys); end
 
+        class << self
+          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 +190,17 @@ 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
+
+        # @api private
+        sig { returns(String) }
+        def to_s; end
+
+        # @api private
         sig { returns(String) }
         def inspect; end
       end

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

@@ -57,6 +57,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/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,14 @@ 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
 
         # @api private
-        sig(:final) do
+        sig do
           override
             .params(
               value: T.any(T::Hash[T.anything, T.anything], T.anything),
@@ -45,7 +44,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 +55,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 +75,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/io_like.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(
                 StringIO,
@@ -33,7 +32,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/union.rbi

@@ -62,6 +62,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

@@ -215,6 +215,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 +271,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

@@ -7,6 +7,6 @@ module Orb
     # 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/sig/orb/internal/type/array_of.rbs

@@ -35,6 +35,8 @@ module Orb
           | Orb::Internal::Type::Converter::input type_info,
           ?::Hash[Symbol, top] spec
         ) -> void
+
+        def inspect: (?depth: Integer) -> String
       end
     end
   end

data/sig/orb/internal/type/base_model.rbs

@@ -69,12 +69,20 @@ module Orb
 
         def deconstruct_keys: (::Array[Symbol]? keys) -> ::Hash[Symbol, top]
 
+        def self.walk: (
+          Orb::Internal::Type::BaseModel model
+        ) -> ::Hash[Symbol, top]
+
         def to_json: (*top a) -> String
 
         def to_yaml: (*top a) -> String
 
         def initialize: (?::Hash[Symbol, top] | self data) -> void
 
+        def self.inspect: (?depth: Integer) -> String
+
+        def to_s: -> String
+
         def inspect: -> String
       end
     end

data/sig/orb/internal/type/converter.rbs

@@ -23,6 +23,8 @@ module Orb
           state: Orb::Internal::Type::Converter::dump_state
         ) -> top
 
+        def inspect: (?depth: Integer) -> String
+
         def self.type_info: (
           {
             const: (nil | bool | Integer | Float | Symbol)?,
@@ -44,6 +46,8 @@ module Orb
           top value,
           ?state: Orb::Internal::Type::Converter::dump_state
         ) -> top
+
+        def self.inspect: (top target, depth: Integer) -> String
       end
     end
   end

data/sig/orb/internal/type/enum.rbs

@@ -21,6 +21,8 @@ module Orb
           Symbol | top value,
           state: Orb::Internal::Type::Converter::dump_state
         ) -> (Symbol | top)
+
+        def inspect: (?depth: Integer) -> String
       end
     end
   end

data/sig/orb/internal/type/hash_of.rbs

@@ -35,6 +35,8 @@ module Orb
           | Orb::Internal::Type::Converter::input type_info,
           ?::Hash[Symbol, top] spec
         ) -> void
+
+        def inspect: (?depth: Integer) -> String
       end
     end
   end

data/sig/orb/internal/type/union.rbs

@@ -39,6 +39,8 @@ module Orb
           top value,
           state: Orb::Internal::Type::Converter::dump_state
         ) -> top
+
+        def inspect: (?depth: Integer) -> String
       end
     end
   end

data/sig/orb/internal/util.rbs

@@ -120,6 +120,8 @@ module Orb
         top body
       ) -> top
 
+      def self?.force_charset!: (String content_type, text: String) -> void
+
       def self?.decode_content: (
         ::Hash[String, String] headers,
         stream: Enumerable[String],

data/sig/orb/internal.rbs

@@ -1,5 +1,5 @@
 module Orb
   module Internal
-    OMIT: top
+    OMIT: Object
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orb-billing
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Orb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-12 00:00:00.000000000 Z
+date: 2025-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -31,6 +31,7 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- ".ignore"
 - CHANGELOG.md
 - README.md
 - SECURITY.md