orb-billing 1.13.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c7cdd5d38f2aa6b93c7100f54d7867b638d76be4a8737ea73c1a2c4973b9340
-  data.tar.gz: 5e94a570bc66d4ebc9b9be79806626b3dc12ab835ee19c7efe78ac7c2b89224a
+  metadata.gz: b84af6e70f3d30d1ef9552374daf2b0144fee6814f2966244bc9b34dbdbb0e6b
+  data.tar.gz: b191864a2ff5b1b1d3bcacb4d6f4ceb4970b061a5d8cbc1e8e7b0c3d7e7855b5
 SHA512:
-  metadata.gz: 8f9921baba3f8d5438b4aa0bbcf0d54ddd4b52b9495f5318e81970535069a06237e8f6350129784166700bd37ba3b33b7421ab5d3d44e8fd3735d244a9fe8cd0
-  data.tar.gz: 715cbc4a16163338a16725d67de9915e144b9877209f6ceb86caead7047f9610c7781a851ef8e8123068536ad7090a05aa8240c4451ebe6e5f487cf63f42a076
+  metadata.gz: 05db33717edabb673e11a3b263cb4a8fa7a3e56bbf4e965b99164de2b72e7123f76610201f37f8b32873ac43d340ba1cbce45557cd68bf12f4d2dde5e0225a9b
+  data.tar.gz: f936d843a726d2d4286f28b047422caf79a6fc6748c3ee8fede765edb7e1fa659156eb6f656de2c2849a1b34b2a40bd520fe2110d54f11fdf942e7d3b34cd9f9

data/CHANGELOG.md

@@ -1,5 +1,48 @@
 # Changelog
 
+## 1.14.0 (2026-04-13)
+
+Full Changelog: [v1.13.0...v1.14.0](https://github.com/orbcorp/orb-ruby/compare/v1.13.0...v1.14.0)
+
+### Features
+
+* **api:** api update ([65c2d82](https://github.com/orbcorp/orb-ruby/commit/65c2d8287a22ee020e6d3b131458a1c708144f6a))
+* **api:** api update ([2f89bbe](https://github.com/orbcorp/orb-ruby/commit/2f89bbe429e30a3deb6a4f8d89db7913aeda60fb))
+* **api:** api update ([d185f3d](https://github.com/orbcorp/orb-ruby/commit/d185f3dde0afc117b2a5df5608fc7aeedbec6f49))
+* **api:** api update ([029ba18](https://github.com/orbcorp/orb-ruby/commit/029ba18854d6ef34ee3a8b30d8b54d4b28be2a77))
+* **api:** api update ([27b02b6](https://github.com/orbcorp/orb-ruby/commit/27b02b67cdeb02fd1083a30f8b450be96ac4d0fb))
+* **api:** api update ([337be04](https://github.com/orbcorp/orb-ruby/commit/337be04c7a4f8abe058b0ca27becf8124badc168))
+* **api:** api update ([751628a](https://github.com/orbcorp/orb-ruby/commit/751628a1843a653fdd0a8e718ed431d8ce518c24))
+* **api:** api update ([eb40fda](https://github.com/orbcorp/orb-ruby/commit/eb40fdad4ce17f70dc2f315c000f0bd8c0118055))
+* **api:** api update ([a865cea](https://github.com/orbcorp/orb-ruby/commit/a865cea3435365ca97c336a991cdf2c632604b24))
+* **client:** add webhook support ([f434716](https://github.com/orbcorp/orb-ruby/commit/f434716cc961eae629f626c95be963e89b712c90))
+
+
+### Bug Fixes
+
+* align path encoding with RFC 3986 section 3.3 ([21d02ec](https://github.com/orbcorp/orb-ruby/commit/21d02eccd03e5cd37b5a20b0718fa6dbd1803302))
+* **client:** add types for path params, and update structure of unions nested in params ([8a52368](https://github.com/orbcorp/orb-ruby/commit/8a523686305ffbee12c8f2643a37d3cab4edb5d5))
+* **internal:** correct multipart form field name encoding ([efb1b4a](https://github.com/orbcorp/orb-ruby/commit/efb1b4ab5d45ab2c965a41bab4b99fa5370679d0))
+* multipart encoding for file arrays ([aff6ad8](https://github.com/orbcorp/orb-ruby/commit/aff6ad82926b24962cc913c73a5663ee8776a271))
+* variable name typo ([6ed82a7](https://github.com/orbcorp/orb-ruby/commit/6ed82a7f6b83f9da113a37be4cb6c84665b1deeb))
+
+
+### Chores
+
+* **ci:** skip lint on metadata-only changes ([a2caac3](https://github.com/orbcorp/orb-ruby/commit/a2caac38daaabff98fb29618628dee0558afd973))
+* **ci:** skip uploading artifacts on stainless-internal branches ([21805c5](https://github.com/orbcorp/orb-ruby/commit/21805c52bfa86ecf544fdc3c5828003638d5938d))
+* **ci:** support opting out of skipping builds on metadata-only commits ([37edebe](https://github.com/orbcorp/orb-ruby/commit/37edebe2c123b23eb923ae53f18e732d3369a9d5))
+* **internal:** tweak CI branches ([6692611](https://github.com/orbcorp/orb-ruby/commit/6692611801c9e7402ec21d5e7eb07f46d0b61951))
+* **internal:** update gitignore ([7ad9ec0](https://github.com/orbcorp/orb-ruby/commit/7ad9ec089de88e0adfd67f94e1f5d073f75e90be))
+* **test:** do not count install time for mock server timeout ([b7ef3b3](https://github.com/orbcorp/orb-ruby/commit/b7ef3b3c4e1054a2a5db603476b57c9d3a64b860))
+* **tests:** bump steady to v0.19.4 ([e63158f](https://github.com/orbcorp/orb-ruby/commit/e63158f62d06ab361c7c2dfc544298decb85f1ca))
+* **tests:** bump steady to v0.19.5 ([d82e274](https://github.com/orbcorp/orb-ruby/commit/d82e2748e8ee154e43745d7b1bfe5bf2a3827284))
+* **tests:** bump steady to v0.19.6 ([aad19ff](https://github.com/orbcorp/orb-ruby/commit/aad19ff345ca22d148ca36ccb7f7850c8f1d14f0))
+* **tests:** bump steady to v0.19.7 ([3c90c75](https://github.com/orbcorp/orb-ruby/commit/3c90c7514ee8f9f38e405e8ca38599d73bb354a3))
+* **tests:** bump steady to v0.20.1 ([7da3249](https://github.com/orbcorp/orb-ruby/commit/7da32497ce4e9cde8f282082e05abb1d23a86b51))
+* **tests:** bump steady to v0.20.2 ([34a56cf](https://github.com/orbcorp/orb-ruby/commit/34a56cfdd242cb2c2fba7ccc3e93f7c11c166010))
+* **tests:** update mock server to steady ([2e5e97f](https://github.com/orbcorp/orb-ruby/commit/2e5e97f7a3cf18ad23ecef601edde222bfc62bbd))
+
 ## 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)

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.13.0"
+gem "orb-billing", "~> 1.14.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/orb/client.rb

@@ -18,6 +18,9 @@ module Orb
     # @return [String]
     attr_reader :api_key
 
+    # @return [String, nil]
+    attr_reader :webhook_secret
+
     # @return [Orb::Resources::TopLevel]
     attr_reader :top_level
 
@@ -160,6 +163,8 @@ module Orb
     #
     # @param api_key [String, nil] Defaults to `ENV["ORB_API_KEY"]`
     #
+    # @param webhook_secret [String, nil] Defaults to `ENV["ORB_WEBHOOK_SECRET"]`
+    #
     # @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"]`
     #
@@ -174,6 +179,7 @@ module Orb
     # @param idempotency_header [String]
     def initialize(
       api_key: ENV["ORB_API_KEY"],
+      webhook_secret: ENV["ORB_WEBHOOK_SECRET"],
       base_url: ENV["ORB_BASE_URL"],
       max_retries: self.class::DEFAULT_MAX_RETRIES,
       timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
@@ -188,6 +194,7 @@ module Orb
       end
 
       @api_key = api_key.to_s
+      @webhook_secret = webhook_secret&.to_s
 
       super(
         base_url: base_url,

data/lib/orb/internal/util.rb

@@ -157,7 +157,7 @@ module Orb
           in Hash | nil => coerced
             coerced
           else
-            message = "Expected a #{Hash} or #{Orb::Internal::Type::BaseModel}, got #{data.inspect}"
+            message = "Expected a #{Hash} or #{Orb::Internal::Type::BaseModel}, got #{input.inspect}"
             raise ArgumentError.new(message)
           end
         end
@@ -237,6 +237,11 @@ module Orb
         end
       end
 
+      # @type [Regexp]
+      #
+      # https://www.rfc-editor.org/rfc/rfc3986.html#section-3.3
+      RFC_3986_NOT_PCHARS = /[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/
+
       class << self
         # @api private
         #
@@ -247,6 +252,15 @@ module Orb
           "#{uri.scheme}://#{uri.host}#{":#{uri.port}" unless uri.port == uri.default_port}"
         end
 
+        # @api private
+        #
+        # @param path [String, Integer]
+        #
+        # @return [String]
+        def encode_path(path)
+          path.to_s.gsub(Orb::Internal::Util::RFC_3986_NOT_PCHARS) { ERB::Util.url_encode(_1) }
+        end
+
         # @api private
         #
         # @param path [String, Array<String>]
@@ -259,7 +273,7 @@ module Orb
           in []
             ""
           in [String => p, *interpolations]
-            encoded = interpolations.map { ERB::Util.url_encode(_1) }
+            encoded = interpolations.map { encode_path(_1) }
             format(p, *encoded)
           end
         end
@@ -571,16 +585,15 @@ module Orb
           y << "Content-Disposition: form-data"
 
           unless key.nil?
-            name = ERB::Util.url_encode(key.to_s)
-            y << "; name=\"#{name}\""
+            y << "; name=\"#{key}\""
           end
 
           case val
           in Orb::FilePart unless val.filename.nil?
-            filename = ERB::Util.url_encode(val.filename)
+            filename = encode_path(val.filename)
             y << "; filename=\"#{filename}\""
           in Pathname | IO
-            filename = ERB::Util.url_encode(::File.basename(val.to_path))
+            filename = encode_path(::File.basename(val.to_path))
             y << "; filename=\"#{filename}\""
           else
           end
@@ -597,6 +610,7 @@ module Orb
         #
         # @return [Array(String, Enumerable<String>)]
         private def encode_multipart_streaming(body)
+          # rubocop:disable Style/CaseEquality
           # RFC 1521 Section 7.2.1 says we should have 70 char maximum for boundary length
           boundary = SecureRandom.urlsafe_base64(46)
 
@@ -606,7 +620,7 @@ module Orb
             in Hash
               body.each do |key, val|
                 case val
-                in Array if val.all? { primitive?(_1) }
+                in Array if val.all? { primitive?(_1) || Orb::Internal::Type::FileInput === _1 }
                   val.each do |v|
                     write_multipart_chunk(y, boundary: boundary, key: key, val: v, closing: closing)
                   end
@@ -622,6 +636,7 @@ module Orb
 
           fused_io = fused_enum(strio) { closing.each(&:call) }
           [boundary, fused_io]
+          # rubocop:enable Style/CaseEquality
         end
 
         # @api private

data/lib/orb/models/alert.rb

@@ -74,13 +74,20 @@ module Orb
                -> { Orb::Internal::Type::ArrayOf[Orb::Alert::BalanceAlertStatus] },
                nil?: true
 
+      # @!attribute grouping_keys
+      #   The property keys to group cost alerts by. Only present for cost alerts with
+      #   grouping enabled.
+      #
+      #   @return [Array<String>, nil]
+      optional :grouping_keys, Orb::Internal::Type::ArrayOf[String], nil?: true
+
       # @!attribute license_type
       #   Minified license type for alert serialization.
       #
       #   @return [Orb::Models::Alert::LicenseType, nil]
       optional :license_type, -> { Orb::Alert::LicenseType }, nil?: true
 
-      # @!method initialize(id:, created_at:, currency:, customer:, enabled:, metric:, plan:, subscription:, thresholds:, type:, balance_alert_status: nil, license_type: nil)
+      # @!method initialize(id:, created_at:, currency:, customer:, enabled:, metric:, plan:, subscription:, thresholds:, type:, balance_alert_status: nil, grouping_keys: nil, license_type: nil)
       #   Some parameter documentations has been truncated, see {Orb::Models::Alert} for
       #   more details.
       #
@@ -112,6 +119,8 @@ module Orb
       #
       #   @param balance_alert_status [Array<Orb::Models::Alert::BalanceAlertStatus>, nil] The current status of the alert. This field is only present for credit balance a
       #
+      #   @param grouping_keys [Array<String>, nil] The property keys to group cost alerts by. Only present for cost alerts with gro
+      #
       #   @param license_type [Orb::Models::Alert::LicenseType, nil] Minified license type for alert serialization.
 
       # @see Orb::Models::Alert#metric

data/lib/orb/models/alert_create_for_customer_params.rb

@@ -7,6 +7,11 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      # @!attribute customer_id
+      #
+      #   @return [String]
+      required :customer_id, String
+
       # @!attribute currency
       #   The case sensitive currency or custom pricing unit to use for this alert.
       #
@@ -25,7 +30,9 @@ module Orb
       #   @return [Array<Orb::Models::Threshold>, nil]
       optional :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Threshold] }, nil?: true
 
-      # @!method initialize(currency:, type:, thresholds: nil, request_options: {})
+      # @!method initialize(customer_id:, currency:, type:, thresholds: nil, request_options: {})
+      #   @param customer_id [String]
+      #
       #   @param currency [String] The case sensitive currency or custom pricing unit to use for this alert.
       #
       #   @param type [Symbol, Orb::Models::AlertCreateForCustomerParams::Type] The type of alert to create. This must be a valid alert type.

data/lib/orb/models/alert_create_for_external_customer_params.rb

@@ -7,6 +7,11 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      # @!attribute external_customer_id
+      #
+      #   @return [String]
+      required :external_customer_id, String
+
       # @!attribute currency
       #   The case sensitive currency or custom pricing unit to use for this alert.
       #
@@ -25,7 +30,9 @@ module Orb
       #   @return [Array<Orb::Models::Threshold>, nil]
       optional :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Threshold] }, nil?: true
 
-      # @!method initialize(currency:, type:, thresholds: nil, request_options: {})
+      # @!method initialize(external_customer_id:, currency:, type:, thresholds: nil, request_options: {})
+      #   @param external_customer_id [String]
+      #
       #   @param currency [String] The case sensitive currency or custom pricing unit to use for this alert.
       #
       #   @param type [Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type] The type of alert to create. This must be a valid alert type.

data/lib/orb/models/alert_create_for_subscription_params.rb

@@ -7,6 +7,11 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      # @!attribute subscription_id
+      #
+      #   @return [String]
+      required :subscription_id, String
+
       # @!attribute thresholds
       #   The thresholds that define the values at which the alert will be triggered.
       #
@@ -19,19 +24,42 @@ module Orb
       #   @return [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type]
       required :type, enum: -> { Orb::AlertCreateForSubscriptionParams::Type }
 
+      # @!attribute grouping_keys
+      #   The property keys to group cost alerts by. Only applicable for cost_exceeded
+      #   alerts.
+      #
+      #   @return [Array<String>, nil]
+      optional :grouping_keys, Orb::Internal::Type::ArrayOf[String], nil?: true
+
       # @!attribute metric_id
       #   The metric to track usage for.
       #
       #   @return [String, nil]
       optional :metric_id, String, nil?: true
 
-      # @!method initialize(thresholds:, type:, metric_id: nil, request_options: {})
+      # @!attribute pricing_unit_id
+      #   The pricing unit to use for grouped cost alerts. Required when grouping_keys is
+      #   set.
+      #
+      #   @return [String, nil]
+      optional :pricing_unit_id, String, nil?: true
+
+      # @!method initialize(subscription_id:, thresholds:, type:, grouping_keys: nil, metric_id: nil, pricing_unit_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::AlertCreateForSubscriptionParams} for more details.
+      #
+      #   @param subscription_id [String]
+      #
       #   @param thresholds [Array<Orb::Models::Threshold>] The thresholds that define the values at which the alert will be triggered.
       #
       #   @param type [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type] The type of alert to create. This must be a valid alert type.
       #
+      #   @param grouping_keys [Array<String>, nil] The property keys to group cost alerts by. Only applicable for cost_exceeded ale
+      #
       #   @param metric_id [String, nil] The metric to track usage for.
       #
+      #   @param pricing_unit_id [String, nil] The pricing unit to use for grouped cost alerts. Required when grouping_keys is
+      #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
       # The type of alert to create. This must be a valid alert type.

data/lib/orb/models/alert_disable_params.rb

@@ -7,13 +7,20 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      # @!attribute alert_configuration_id
+      #
+      #   @return [String]
+      required :alert_configuration_id, String
+
       # @!attribute subscription_id
       #   Used to update the status of a plan alert scoped to this subscription_id
       #
       #   @return [String, nil]
       optional :subscription_id, String, nil?: true
 
-      # @!method initialize(subscription_id: nil, request_options: {})
+      # @!method initialize(alert_configuration_id:, subscription_id: nil, request_options: {})
+      #   @param alert_configuration_id [String]
+      #
       #   @param subscription_id [String, nil] Used to update the status of a plan alert scoped to this subscription_id
       #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]

data/lib/orb/models/alert_enable_params.rb

@@ -7,13 +7,20 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      # @!attribute alert_configuration_id
+      #
+      #   @return [String]
+      required :alert_configuration_id, String
+
       # @!attribute subscription_id
       #   Used to update the status of a plan alert scoped to this subscription_id
       #
       #   @return [String, nil]
       optional :subscription_id, String, nil?: true
 
-      # @!method initialize(subscription_id: nil, request_options: {})
+      # @!method initialize(alert_configuration_id:, subscription_id: nil, request_options: {})
+      #   @param alert_configuration_id [String]
+      #
       #   @param subscription_id [String, nil] Used to update the status of a plan alert scoped to this subscription_id
       #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]

data/lib/orb/models/alert_retrieve_params.rb

@@ -7,7 +7,13 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute alert_id
+      #
+      #   @return [String]
+      required :alert_id, String
+
+      # @!method initialize(alert_id:, request_options: {})
+      #   @param alert_id [String]
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/orb/models/alert_update_params.rb

@@ -7,13 +7,20 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      # @!attribute alert_configuration_id
+      #
+      #   @return [String]
+      required :alert_configuration_id, String
+
       # @!attribute thresholds
       #   The thresholds that define the values at which the alert will be triggered.
       #
       #   @return [Array<Orb::Models::Threshold>]
       required :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Threshold] }
 
-      # @!method initialize(thresholds:, request_options: {})
+      # @!method initialize(alert_configuration_id:, thresholds:, request_options: {})
+      #   @param alert_configuration_id [String]
+      #
       #   @param thresholds [Array<Orb::Models::Threshold>] The thresholds that define the values at which the alert will be triggered.
       #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]