orb-billing 1.11.2 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c21aa9aa90d14aae4b1217351fcc1965c62bd62914a28567d22dba99767ecbf0
-  data.tar.gz: c5875edf3c46feb5108b8ecfe4e6fda56321e7f5b0950b8c1ca24ae3c05be6f8
+  metadata.gz: 5c7cdd5d38f2aa6b93c7100f54d7867b638d76be4a8737ea73c1a2c4973b9340
+  data.tar.gz: 5e94a570bc66d4ebc9b9be79806626b3dc12ab835ee19c7efe78ac7c2b89224a
 SHA512:
-  metadata.gz: 29aa4fd5af33498cbcbcc7f46436b2e29ecb1692466571a01c28c2cc80bc103dfe7147d50868ede1c8d238d25c1b18662131a1103bf77fd8bfadc37fe7896a7d
-  data.tar.gz: 81e835602384198d7bba9aa834edcd98fc8753b026b15873f065c104ef5bc0db2fb98f3e03fa605751dc354f27bd876b3e60c704cee877eff7d3be16d00db77c
+  metadata.gz: 8f9921baba3f8d5438b4aa0bbcf0d54ddd4b52b9495f5318e81970535069a06237e8f6350129784166700bd37ba3b33b7421ab5d3d44e8fd3735d244a9fe8cd0
+  data.tar.gz: 715cbc4a16163338a16725d67de9915e144b9877209f6ceb86caead7047f9610c7781a851ef8e8123068536ad7090a05aa8240c4451ebe6e5f487cf63f42a076

data/CHANGELOG.md

@@ -1,5 +1,128 @@
 # Changelog
 
+## 1.13.0 (2026-03-03)
+
+Full Changelog: [v1.12.0...v1.13.0](https://github.com/orbcorp/orb-ruby/compare/v1.12.0...v1.13.0)
+
+### Features
+
+* **api:** api update ([c203926](https://github.com/orbcorp/orb-ruby/commit/c203926582b3237293d3078ada79bf3d221071d7))
+* **api:** api update ([fd4f82d](https://github.com/orbcorp/orb-ruby/commit/fd4f82dd2f04f36cd49a7413fdfaa5e1189f22c2))
+* **api:** api update ([a703c63](https://github.com/orbcorp/orb-ruby/commit/a703c638264d4dd7761a3534562f47a86b8da288))
+* **api:** api update ([49c2213](https://github.com/orbcorp/orb-ruby/commit/49c22131d40a8e0e050f894be9ff48d5958301aa))
+* **api:** api update ([357d2d4](https://github.com/orbcorp/orb-ruby/commit/357d2d4e2758c92578d1c7af1e26f1a1779738b0))
+
+
+### Bug Fixes
+
+* **client:** serialize query parameters properly ([003ab4e](https://github.com/orbcorp/orb-ruby/commit/003ab4e466176c051711b7e89e1e40be5de6a664))
+* properly mock time in ruby ci tests ([c8c588e](https://github.com/orbcorp/orb-ruby/commit/c8c588eb8bd5383d1875fef102cd7de66d6dff71))
+
+
+### Chores
+
+* **ci:** add build step ([b57c8a3](https://github.com/orbcorp/orb-ruby/commit/b57c8a3f52e22c5c67f3842357747437d12f56d7))
+* **docs:** add missing descriptions ([174bbeb](https://github.com/orbcorp/orb-ruby/commit/174bbebe6ed10a5c2c079232299b48b4269e470c))
+* update mock server docs ([4b838cf](https://github.com/orbcorp/orb-ruby/commit/4b838cf2bc89666bea9767ae25e66868d38bbeef))
+
+## 1.12.0 (2026-02-12)
+
+Full Changelog: [v1.11.2...v1.12.0](https://github.com/orbcorp/orb-ruby/compare/v1.11.2...v1.12.0)
+
+### ⚠ BREAKING CHANGES
+
+* **api:** define shared model ConversionRateConfig
+
+### Features
+
+* **api:** api update ([25dea19](https://github.com/orbcorp/orb-ruby/commit/25dea196cdd20a1099d54e7f7872037cc76de888))
+* **api:** api update ([065b4c0](https://github.com/orbcorp/orb-ruby/commit/065b4c072106c25518386f10483230ce3b8369bf))
+* **api:** api update ([1cae097](https://github.com/orbcorp/orb-ruby/commit/1cae0970ef281a06ac1004bae27c2870d4015834))
+* **api:** api update ([20be312](https://github.com/orbcorp/orb-ruby/commit/20be31255b3b157e64bcee41c530767ebae7ae46))
+* **api:** api update ([82a95e1](https://github.com/orbcorp/orb-ruby/commit/82a95e16b9a27835527f87601e8017029dbb6adf))
+* **api:** api update ([b28aaa6](https://github.com/orbcorp/orb-ruby/commit/b28aaa6a7b47420b5006876f407e81da69da2960))
+* **api:** api update ([99c34e5](https://github.com/orbcorp/orb-ruby/commit/99c34e5534e553bb0d1371029ebb187a4996d8a0))
+* **api:** api update ([06f2f3a](https://github.com/orbcorp/orb-ruby/commit/06f2f3a630bebb897c6d8179d26b874d57aa5170))
+* **api:** api update ([becbbfb](https://github.com/orbcorp/orb-ruby/commit/becbbfbda376e7262edc85e8b62033c900802aa3))
+* **api:** api update ([b6cd2e4](https://github.com/orbcorp/orb-ruby/commit/b6cd2e48e6f93bd9c35a03370bf2bcaec81dfe40))
+* **api:** api update ([87a0726](https://github.com/orbcorp/orb-ruby/commit/87a07260f66116747a5e9fc1fef8b04e2ed2ce73))
+* **api:** api update ([be086a4](https://github.com/orbcorp/orb-ruby/commit/be086a41778e92515daa377fd87f6f0abfca72ae))
+* **api:** api update ([9f52897](https://github.com/orbcorp/orb-ruby/commit/9f528979375caa801a1cf91f8bf5d3918a09c4ef))
+* **api:** api update ([98aaf7c](https://github.com/orbcorp/orb-ruby/commit/98aaf7c01983329fe7900895b91f79192b38e15e))
+* **api:** api update ([921d3c6](https://github.com/orbcorp/orb-ruby/commit/921d3c6a87d758ce6a1cc3fcfd7f4b81e0482d86))
+* **api:** api update ([88e3262](https://github.com/orbcorp/orb-ruby/commit/88e32624c94e7de29738f086c90e41b07dcdd760))
+* **api:** api update ([4de7f17](https://github.com/orbcorp/orb-ruby/commit/4de7f17ac1c5fe9b440348e06529528ef41a317e))
+* **api:** api update ([6ada340](https://github.com/orbcorp/orb-ruby/commit/6ada3406fbcb73e97da781bffaa5c0dcc81d3ad1))
+* **api:** api update ([455c9c1](https://github.com/orbcorp/orb-ruby/commit/455c9c18b77ee41a6b9c27fc791cc622553b83f8))
+* **api:** api update ([024cfe9](https://github.com/orbcorp/orb-ruby/commit/024cfe9ce8ec66066224003fd8476cde441dfcba))
+* **api:** api update ([d677c86](https://github.com/orbcorp/orb-ruby/commit/d677c8652f13f00ab40e63799223f64807d4d624))
+* **api:** api update ([97803ff](https://github.com/orbcorp/orb-ruby/commit/97803ffbb43d1730ebb2f23386b241a3e9f99ee4))
+* **api:** api update ([e883731](https://github.com/orbcorp/orb-ruby/commit/e8837312b28020f32d984bc83003be7c5d0bbe58))
+* **api:** api update ([c82723f](https://github.com/orbcorp/orb-ruby/commit/c82723f6b075de5b8b806f4523437c31bc3f4d36))
+* **api:** api update ([b3fa16d](https://github.com/orbcorp/orb-ruby/commit/b3fa16d2ae0fa06ed8c04f7c10634d240152e8b5))
+* **api:** api update ([863a72d](https://github.com/orbcorp/orb-ruby/commit/863a72d5bc1ed22405334019d51e987daadedff4))
+* **api:** api update ([6df80f0](https://github.com/orbcorp/orb-ruby/commit/6df80f039a079ed7c9c15201e6693ac88e64ee12))
+* **api:** api update ([34d9e85](https://github.com/orbcorp/orb-ruby/commit/34d9e857f7863e718aaa844dcf0c299e234e9ab7))
+* **api:** api update ([21271b0](https://github.com/orbcorp/orb-ruby/commit/21271b04f2b4b3af856b02dd156542770683f6d8))
+* **api:** api update ([182e255](https://github.com/orbcorp/orb-ruby/commit/182e255a2ed9a39f774afb700320ff762da40e6d))
+* **api:** api update ([87ab4bb](https://github.com/orbcorp/orb-ruby/commit/87ab4bb08910a9c6e5a7995ca307e8a80c737c39))
+* **api:** api update ([dbeafc7](https://github.com/orbcorp/orb-ruby/commit/dbeafc76cc391a10d8cb21f5db2ef8bb825aee1c))
+* **api:** api update ([f8b2792](https://github.com/orbcorp/orb-ruby/commit/f8b27927f181b45c2196de229a35b5eae6122f46))
+* **api:** api update ([f8c9f2c](https://github.com/orbcorp/orb-ruby/commit/f8c9f2c57e94d09130d68b080b0adc5ae38bbd30))
+* **api:** api update ([d1fc414](https://github.com/orbcorp/orb-ruby/commit/d1fc414cb976afe6bb19dc284dceb7ed7bfa38c2))
+* **api:** api update ([83a6ffd](https://github.com/orbcorp/orb-ruby/commit/83a6ffda9613b6571029f01235d673d179294c94))
+* **api:** api update ([343fa0b](https://github.com/orbcorp/orb-ruby/commit/343fa0b8a9a724b73f8abe5e9de34795f232e065))
+* **api:** api update ([b89ea6d](https://github.com/orbcorp/orb-ruby/commit/b89ea6d10a12909e77c76617d11068ade5cf6fc8))
+* **api:** api update ([be80854](https://github.com/orbcorp/orb-ruby/commit/be80854305b7dd24350c0a955de536d37233bc35))
+* **api:** api update ([8e3ac4b](https://github.com/orbcorp/orb-ruby/commit/8e3ac4b248b2aca6ac6d5360f34be8521b05bc83))
+* **api:** api update ([246283d](https://github.com/orbcorp/orb-ruby/commit/246283dc41fd3d9b128ac44ccd8550ae7b987578))
+* **api:** api update ([bc6c8f9](https://github.com/orbcorp/orb-ruby/commit/bc6c8f9914220783adeb80fa6a9eb87d009fa58d))
+* **api:** api update ([394af82](https://github.com/orbcorp/orb-ruby/commit/394af826a5ba3cd462447304c8ec659038e67617))
+* **api:** define shared model ConversionRateConfig ([aa669fe](https://github.com/orbcorp/orb-ruby/commit/aa669fef9079dbac856be83d56cabd826e3c47c0))
+* **api:** manual updates ([85ded24](https://github.com/orbcorp/orb-ruby/commit/85ded24125953bfdaac7a5f862633929c07b0546))
+* **api:** manual updates ([45682e2](https://github.com/orbcorp/orb-ruby/commit/45682e2e4835f5575b9efc9c5d0bd307f5610baa))
+* expose response headers for both streams and errors ([cafba93](https://github.com/orbcorp/orb-ruby/commit/cafba93f8798a84815c9c9d1183327e498cb6b95))
+* extract minimum composite to type ([3bd8a47](https://github.com/orbcorp/orb-ruby/commit/3bd8a47a7c0601ccb9c43b472131562319a59e51))
+* handle thread interrupts in the core HTTP client ([bd23d78](https://github.com/orbcorp/orb-ruby/commit/bd23d789ed205441ea6f6d76324278867eaf59eb))
+
+
+### Bug Fixes
+
+* absolutely qualified uris should always override the default ([22b2593](https://github.com/orbcorp/orb-ruby/commit/22b25937df7cf77dbf1e1a9836e5cd822087d338))
+* always send `filename=...` for multipart requests where a file is expected ([aefe58f](https://github.com/orbcorp/orb-ruby/commit/aefe58f92b1296aa30172ce8206f84723a3a326c))
+* better thread safety via early initializing SSL store during HTTP client creation ([89f6a24](https://github.com/orbcorp/orb-ruby/commit/89f6a24e6ed1147c45a583c91ac368932cf37ddb))
+* calling `break` out of streams should be instantaneous ([c7f51d6](https://github.com/orbcorp/orb-ruby/commit/c7f51d6d47678f33015fdffc78e6cff826a90a2c))
+* **client:** always add content-length to post body, even when empty ([59f4f8b](https://github.com/orbcorp/orb-ruby/commit/59f4f8b2416b68c556f75e8f4e89d647cd93a1fe))
+* **client:** loosen json header parsing ([60bf3f3](https://github.com/orbcorp/orb-ruby/commit/60bf3f3bfda9caa36269e75ccb5d5df6c4811bd0))
+* coroutine leaks from connection pool ([a4faf55](https://github.com/orbcorp/orb-ruby/commit/a4faf55a381bcdaae01f0a22cd8922038af38f69))
+* **internal:** use null byte as file separator in the fast formatting script ([58f092f](https://github.com/orbcorp/orb-ruby/commit/58f092f32214ae8deb17db5e002f10fafd60378e))
+* issue where json.parse errors when receiving HTTP 204 with nobody ([ecbf9f1](https://github.com/orbcorp/orb-ruby/commit/ecbf9f18b8229cb9d9c729a346a5f00dc1be2427))
+* shorten multipart boundary sep to less than RFC specificed max length ([984b6ad](https://github.com/orbcorp/orb-ruby/commit/984b6ad403302ab97275136e145dce322ce82e9b))
+* should not reuse buffers for `IO.copy_stream` interop ([11db4b2](https://github.com/orbcorp/orb-ruby/commit/11db4b2e6edf33581a21c6eacfbdaf347af418ea))
+
+
+### Performance Improvements
+
+* faster code formatting ([9538971](https://github.com/orbcorp/orb-ruby/commit/95389713d7c3b97ec3cf0963b86211d5fba72fe4))
+
+
+### Chores
+
+* allow fast-format to use bsd sed as well ([6566897](https://github.com/orbcorp/orb-ruby/commit/6566897b0797bdbad69e21ed05d97f4ce1509f07))
+* bump dependency version and update sorbet types ([26ac9ce](https://github.com/orbcorp/orb-ruby/commit/26ac9ce1b4ae0315417ece34fc02b63b569db0c6))
+* **client:** send user-agent header ([ed62aa3](https://github.com/orbcorp/orb-ruby/commit/ed62aa37562af4ddca14635d87bc44fe049df745))
+* do not install brew dependencies in ./scripts/bootstrap by default ([c7d1331](https://github.com/orbcorp/orb-ruby/commit/c7d13317194914b406f35048eb198c715e3645da))
+* **docs:** remove www prefix ([fd0b56a](https://github.com/orbcorp/orb-ruby/commit/fd0b56a55df0ae699a00fa168c3cf1524bff5a23))
+* explicitly require "base64" gem ([2dc59bc](https://github.com/orbcorp/orb-ruby/commit/2dc59bc83506fbb02785f784023a217e0472513e))
+* fix typo in descriptions ([ebb72da](https://github.com/orbcorp/orb-ruby/commit/ebb72daa8a4a736d1c4a68c44bf346d3fc93c45d))
+* ignore linter error for tests having large collections ([717bc2e](https://github.com/orbcorp/orb-ruby/commit/717bc2e5e09f3c6cea641189a2a9eb516dcbf0ec))
+* **internal:** codegen related update ([fced85a](https://github.com/orbcorp/orb-ruby/commit/fced85ad0524759c290f1a5afaad4e7baaa1525e))
+* **internal:** codegen related update ([01a2d5d](https://github.com/orbcorp/orb-ruby/commit/01a2d5dbfe250eab0597658dd7156ba234bf6424))
+* **internal:** codegen related update ([88e7ca5](https://github.com/orbcorp/orb-ruby/commit/88e7ca54ee9a3aeed69433c775638765f2838514))
+* **internal:** codegen related update ([d7dd0b8](https://github.com/orbcorp/orb-ruby/commit/d7dd0b8380fd9ec066388c3327ed16fdba9f7fa6))
+* **internal:** update `actions/checkout` version ([03524b6](https://github.com/orbcorp/orb-ruby/commit/03524b6b0a9252b46637bde590b46a98f67ec497))
+* move `cgi` into dependencies for ruby 4 ([09ae2b0](https://github.com/orbcorp/orb-ruby/commit/09ae2b03acf7b359b387b682250cd412e0834057))
+
 ## 1.11.2 (2025-08-29)
 
 Full Changelog: [v1.11.1...v1.11.2](https://github.com/orbcorp/orb-ruby/compare/v1.11.1...v1.11.2)

data/README.md

@@ -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", "~> 1.11.2"
+gem "orb-billing", "~> 1.13.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/orb/client.rb

@@ -21,42 +21,109 @@ module Orb
     # @return [Orb::Resources::TopLevel]
     attr_reader :top_level
 
+    # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
+    # subscribed to by a customer. Plans define the billing behavior of the
+    # subscription. You can see more about how to configure prices in the
+    # [Price resource](/reference/price).
     # @return [Orb::Resources::Beta]
     attr_reader :beta
 
+    # A coupon represents a reusable discount configuration that can be applied either
+    # as a fixed or percentage amount to an invoice or subscription. Coupons are
+    # activated using a redemption code, which applies the discount to a subscription
+    # or invoice. The duration of a coupon determines how long it remains available
+    # for use by end users.
     # @return [Orb::Resources::Coupons]
     attr_reader :coupons
 
+    # The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
+    # been applied to a particular invoice.
     # @return [Orb::Resources::CreditNotes]
     attr_reader :credit_notes
 
+    # A customer is a buyer of your products, and the other party to the billing
+    # relationship.
+    #
+    # In Orb, customers are assigned system generated identifiers automatically, but
+    # it's often desirable to have these match existing identifiers in your system. To
+    # avoid having to denormalize Orb ID information, you can pass in an
+    # `external_customer_id` with your own identifier. See
+    # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
+    # information about how these aliases work in Orb.
+    #
+    # In addition to having an identifier in your system, a customer may exist in a
+    # payment provider solution like Stripe. Use the `payment_provider_id` and the
+    # `payment_provider` enum field to express this mapping.
+    #
+    # A customer also has a timezone (from the standard
+    # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
+    # your account's timezone. See [Timezone localization](/essentials/timezones) for
+    # information on what this timezone parameter influences within Orb.
     # @return [Orb::Resources::Customers]
     attr_reader :customers
 
+    # The [Event](/core-concepts#event) resource represents a usage event that has
+    # been created for a customer. Events are the core of Orb's usage-based billing
+    # model, and are used to calculate the usage charges for a given billing period.
     # @return [Orb::Resources::Events]
     attr_reader :events
 
+    # An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
+    # representing the request for payment for a single subscription. This includes a
+    # set of line items, which correspond to prices in the subscription's plan and can
+    # represent fixed recurring fees or usage-based fees. They are generated at the
+    # end of a billing period, or as the result of an action, such as a cancellation.
     # @return [Orb::Resources::InvoiceLineItems]
     attr_reader :invoice_line_items
 
+    # An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
+    # representing the request for payment for a single subscription. This includes a
+    # set of line items, which correspond to prices in the subscription's plan and can
+    # represent fixed recurring fees or usage-based fees. They are generated at the
+    # end of a billing period, or as the result of an action, such as a cancellation.
     # @return [Orb::Resources::Invoices]
     attr_reader :invoices
 
+    # The Item resource represents a sellable product or good. Items are associated
+    # with all line items, billable metrics, and prices and are used for defining
+    # external sync behavior for invoices and tax calculation purposes.
     # @return [Orb::Resources::Items]
     attr_reader :items
 
+    # The Metric resource represents a calculation of a quantity based on events.
+    # Metrics are defined by the query that transforms raw usage events into
+    # meaningful values for your customers.
     # @return [Orb::Resources::Metrics]
     attr_reader :metrics
 
+    # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
+    # subscribed to by a customer. Plans define the billing behavior of the
+    # subscription. You can see more about how to configure prices in the
+    # [Price resource](/reference/price).
     # @return [Orb::Resources::Plans]
     attr_reader :plans
 
+    # The Price resource represents a price that can be billed on a subscription,
+    # resulting in a charge on an invoice in the form of an invoice line item. Prices
+    # take a quantity and determine an amount to bill.
+    #
+    # Orb supports a few different pricing models out of the box. Each of these models
+    # is serialized differently in a given Price object. The model_type field
+    # determines the key for the configuration object that is present.
+    #
+    # For more on the types of prices, see
+    # [the core concepts documentation](/core-concepts#plan-and-price)
     # @return [Orb::Resources::Prices]
     attr_reader :prices
 
     # @return [Orb::Resources::Subscriptions]
     attr_reader :subscriptions
 
+    # [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
+    # usage, or credit balance and trigger webhooks when a threshold is exceeded.
+    #
+    # Alerts created through the API can be scoped to either customers or
+    # subscriptions.
     # @return [Orb::Resources::Alerts]
     attr_reader :alerts
 
@@ -66,6 +133,20 @@ module Orb
     # @return [Orb::Resources::SubscriptionChanges]
     attr_reader :subscription_changes
 
+    # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
+    # credits within Orb.
+    # @return [Orb::Resources::CreditBlocks]
+    attr_reader :credit_blocks
+
+    # The LicenseType resource represents a type of license that can be assigned to
+    # users. License types are used during billing by grouping metrics on the
+    # configured grouping key.
+    # @return [Orb::Resources::LicenseTypes]
+    attr_reader :license_types
+
+    # @return [Orb::Resources::Licenses]
+    attr_reader :licenses
+
     # @api private
     #
     # @return [Hash{String=>String}]
@@ -133,6 +214,9 @@ module Orb
       @alerts = Orb::Resources::Alerts.new(client: self)
       @dimensional_price_groups = Orb::Resources::DimensionalPriceGroups.new(client: self)
       @subscription_changes = Orb::Resources::SubscriptionChanges.new(client: self)
+      @credit_blocks = Orb::Resources::CreditBlocks.new(client: self)
+      @license_types = Orb::Resources::LicenseTypes.new(client: self)
+      @licenses = Orb::Resources::Licenses.new(client: self)
     end
   end
 end

data/lib/orb/errors.rb

@@ -40,6 +40,9 @@ module Orb
       # @return [Integer, nil]
       attr_accessor :status
 
+      # @return [Hash{String=>String}, nil]
+      attr_accessor :headers
+
       # @return [Object, nil]
       attr_accessor :body
 
@@ -47,13 +50,15 @@ module Orb
       #
       # @param url [URI::Generic]
       # @param status [Integer, nil]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [Object, nil]
       # @param request [nil]
       # @param response [nil]
       # @param message [String, nil]
-      def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
+      def initialize(url:, status: nil, headers: nil, body: nil, request: nil, response: nil, message: nil)
         @url = url
         @status = status
+        @headers = headers
         @body = body
         @request = request
         @response = response
@@ -74,6 +79,7 @@ module Orb
       #
       # @param url [URI::Generic]
       # @param status [nil]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [nil]
       # @param request [nil]
       # @param response [nil]
@@ -81,6 +87,7 @@ module Orb
       def initialize(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -95,6 +102,7 @@ module Orb
       #
       # @param url [URI::Generic]
       # @param status [nil]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [nil]
       # @param request [nil]
       # @param response [nil]
@@ -102,6 +110,7 @@ module Orb
       def initialize(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -116,22 +125,25 @@ module Orb
       #
       # @param url [URI::Generic]
       # @param status [Integer]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [Object, nil]
       # @param request [nil]
       # @param response [nil]
       # @param message [String, nil]
       #
       # @return [self]
-      def self.for(url:, status:, body:, request:, response:, message: nil)
+      def self.for(url:, status:, headers:, body:, request:, response:, message: nil)
         key = Orb::Internal::Util.dig(body, :type)
-        kwargs = {
-          url: url,
-          status: status,
-          body: body,
-          request: request,
-          response: response,
-          message: message
-        }
+        kwargs =
+          {
+            url: url,
+            status: status,
+            headers: headers,
+            body: body,
+            request: request,
+            response: response,
+            message: message
+          }
 
         case [status, key]
         in [400, Orb::Errors::ConstraintViolation::TYPE]
@@ -187,15 +199,17 @@ module Orb
       #
       # @param url [URI::Generic]
       # @param status [Integer]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [Object, nil]
       # @param request [nil]
       # @param response [nil]
       # @param message [String, nil]
-      def initialize(url:, status:, body:, request:, response:, message: nil)
+      def initialize(url:, status:, headers:, body:, request:, response:, message: nil)
         message ||= {url: url.to_s, status: status, body: body}
         super(
           url: url,
           status: status,
+          headers: headers,
           body: body,
           request: request,
           response: response,

data/lib/orb/file_part.rb

@@ -38,18 +38,21 @@ module Orb
     def to_yaml(*a) = read.to_yaml(*a)
 
     # @param content [Pathname, StringIO, IO, String]
-    # @param filename [String, nil]
+    # @param filename [Pathname, String, nil]
     # @param content_type [String, nil]
     def initialize(content, filename: nil, content_type: nil)
-      @content = content
+      @content_type = content_type
       @filename =
-        case content
-        in Pathname
-          filename.nil? ? content.basename.to_path : ::File.basename(filename)
+        case [filename, (@content = content)]
+        in [String | Pathname, _]
+          ::File.basename(filename)
+        in [nil, Pathname]
+          content.basename.to_path
+        in [nil, IO]
+          content.to_path
         else
-          filename.nil? ? nil : ::File.basename(filename)
+          filename
         end
-      @content_type = content_type
     end
   end
 end

data/lib/orb/internal/page.rb

@@ -60,7 +60,7 @@ module Orb
       #
       # @param client [Orb::Internal::Transport::BaseClient]
       # @param req [Hash{Symbol=>Object}]
-      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param headers [Hash{String=>String}]
       # @param page_data [Hash{Symbol=>Object}]
       def initialize(client:, req:, headers:, page_data:)
         super

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

@@ -47,7 +47,7 @@ module Orb
           # @api private
           #
           # @param status [Integer]
-          # @param headers [Hash{String=>String}, Net::HTTPHeader]
+          # @param headers [Hash{String=>String}]
           #
           # @return [Boolean]
           def should_retry?(status, headers:)
@@ -85,7 +85,7 @@ module Orb
           #
           # @param status [Integer]
           #
-          # @param response_headers [Hash{String=>String}, Net::HTTPHeader]
+          # @param response_headers [Hash{String=>String}]
           #
           # @return [Hash{Symbol=>Object}]
           def follow_redirect(request, status:, response_headers:)
@@ -201,7 +201,8 @@ module Orb
             self.class::PLATFORM_HEADERS,
             {
               "accept" => "application/json",
-              "content-type" => "application/json"
+              "content-type" => "application/json",
+              "user-agent" => user_agent
             },
             headers
           )
@@ -219,6 +220,11 @@ module Orb
         # @return [Hash{String=>String}]
         private def auth_headers = {}
 
+        # @api private
+        #
+        # @return [String]
+        private def user_agent = "#{self.class.name}/Ruby #{Orb::VERSION}"
+
         # @api private
         #
         # @return [String]
@@ -375,6 +381,7 @@ module Orb
           rescue Orb::Errors::APIConnectionError => e
             status = e
           end
+          headers = Orb::Internal::Util.normalized_headers(response&.each_header&.to_h)
 
           case status
           in ..299
@@ -387,7 +394,7 @@ module Orb
           in 300..399
             self.class.reap_connection!(status, stream: stream)
 
-            request = self.class.follow_redirect(request, status: status, response_headers: response)
+            request = self.class.follow_redirect(request, status: status, response_headers: headers)
             send_request(
               request,
               redirect_count: redirect_count + 1,
@@ -396,9 +403,9 @@ module Orb
             )
           in Orb::Errors::APIConnectionError if retry_count >= max_retries
             raise status
-          in (400..) if retry_count >= max_retries || !self.class.should_retry?(status, headers: response)
+          in (400..) if retry_count >= max_retries || !self.class.should_retry?(status, headers: headers)
             decoded = Kernel.then do
-              Orb::Internal::Util.decode_content(response, stream: stream, suppress_error: true)
+              Orb::Internal::Util.decode_content(headers, stream: stream, suppress_error: true)
             ensure
               self.class.reap_connection!(status, stream: stream)
             end
@@ -406,6 +413,7 @@ module Orb
             raise Orb::Errors::APIStatusError.for(
               url: url,
               status: status,
+              headers: headers,
               body: decoded,
               request: nil,
               response: response
@@ -482,19 +490,21 @@ module Orb
             send_retry_header: send_retry_header
           )
 
-          decoded = Orb::Internal::Util.decode_content(response, stream: stream)
+          headers = Orb::Internal::Util.normalized_headers(response.each_header.to_h)
+          decoded = Orb::Internal::Util.decode_content(headers, stream: stream)
           case req
           in {stream: Class => st}
             st.new(
               model: model,
               url: url,
               status: status,
+              headers: headers,
               response: response,
               unwrap: unwrap,
               stream: decoded
             )
           in {page: Class => page}
-            page.new(client: self, req: req, headers: response, page_data: decoded)
+            page.new(client: self, req: req, headers: headers, page_data: decoded)
           else
             unwrapped = Orb::Internal::Util.dig(decoded, unwrap)
             Orb::Internal::Type::Converter.coerce(model, unwrapped)