metronome-sdk 3.4.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e790ead396d794ecaa6da7fe2daebbc0d2889ac357ab7d388d7d271ff11ddca7
-  data.tar.gz: bbb781138592c99fd427f0fc8817cf27f64fedd92b85b3a52c84e82e0900a905
+  metadata.gz: d4d5355d04639b7153cfe94271378797fceaff008c386c001c6450f66674a584
+  data.tar.gz: 25c993147e97e4acead3048b17b7328e67b4e95274bef1893723bf806ddd9bec
 SHA512:
-  metadata.gz: 824e2718830473643d02f38f5ba467c820e19c505cb1e37c18fb7c69fee28425f41eeb38aa32715eb180613d79c4dfcc5753f53abb8e01c8f8eb2033750b118a
-  data.tar.gz: e521c9add4393abe34ad717c69fc23c3a9dd32fc84a9c65b151d65f83f2b7d84f66ca61d45a58977f06d66e8ef3ecb8e1bfd621b90d0aaf3bd6b5d2c2f797a6a
+  metadata.gz: 653c76e15fba1881dcc6e344161a61f7c0c061aba2603bdb26a3f489986c23e31d1fe77bb2134070f53333efe9efa5d37b73f206abb30b4cba33eb05f967c771
+  data.tar.gz: 3d6505e8bd6767e3873ba2d70c28bc93eac7280ae2ca126eba43a18eca5e4a113704574909e5c0a26f503204675bc407582190dd9d1f20afa91ecc98cc30def0

data/CHANGELOG.md

@@ -1,5 +1,89 @@
 # Changelog
 
+## 3.6.0 (2026-05-18)
+
+Full Changelog: [v3.5.0...v3.6.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v3.5.0...v3.6.0)
+
+### Features
+
+* [docs] fix typo in "Create a Contract" [1] page ([1c944c1](https://github.com/Metronome-Industries/metronome-ruby/commit/1c944c186c83b405e283708850d5a608e6c21ed6))
+* [orch-383] fix API docs for one-off payment-gated commits ([a4d2798](https://github.com/Metronome-Industries/metronome-ruby/commit/a4d27985195453b3546b5ecd8a420b4d768110db))
+* Add alert specifiers to contract create API ([51db5ed](https://github.com/Metronome-Industries/metronome-ruby/commit/51db5ed0d8954978ac23e2ddc30a6b542a535828))
+* add contract_id filter to list invoices endpoint ([a304fbe](https://github.com/Metronome-Industries/metronome-ruby/commit/a304fbe7fbdec29e84f6d7e00757ac8d53c4ddf2))
+* add invoice type filter for list invoices api ([872e130](https://github.com/Metronome-Industries/metronome-ruby/commit/872e1300646c989ab9d1ae057358213651f140d9))
+* Add list seat balances API endpoint to SDK ([b00dd28](https://github.com/Metronome-Industries/metronome-ruby/commit/b00dd2876202080710203143d27a3b592aa7333b))
+* Add regenerated_from_invoice_id to getInvoice response ([4fcd94f](https://github.com/Metronome-Industries/metronome-ruby/commit/4fcd94f52de907beea33c5f619ee529cdf2ee295))
+* Add sql_breakdown_granularity flag to product create/edit ([101c0ef](https://github.com/Metronome-Industries/metronome-ruby/commit/101c0efded08535d01f7d5ef67b80c3325be7e5a))
+* added custom fields to create contract with package ([3df5eaf](https://github.com/Metronome-Industries/metronome-ruby/commit/3df5eafd29b0d030f2de6c9b1da6bd0f2d83fefd))
+* doc updates ([a38c0ad](https://github.com/Metronome-Industries/metronome-ruby/commit/a38c0adccd0a9de33f91052cef6f8db0bfd054ba))
+* Limit spend breakdown/seat balances to 100 vals ([019e16c](https://github.com/Metronome-Industries/metronome-ruby/commit/019e16ca2e5091d75d9674d3c1ae58e4af6c8786))
+* Pranadreddy/launch 2486 remove dead billing anchor date field from api ([880922c](https://github.com/Metronome-Industries/metronome-ruby/commit/880922c776ce6b9026338097d22629153b06790d))
+* support setting headers via env ([70a6689](https://github.com/Metronome-Industries/metronome-ruby/commit/70a66896bf1c85734adbcc3f90ec88e91b3b124d))
+* Update stainless.yml to include Java configuration logic ([caadd1b](https://github.com/Metronome-Industries/metronome-ruby/commit/caadd1bcdfe6e513fa45e1ffe7ba16be4078f8e0))
+* wip ([d85557d](https://github.com/Metronome-Industries/metronome-ruby/commit/d85557d5c8d4e42eaedeeb01d52e925cfaec2bf5))
+
+
+### Bug Fixes
+
+* add archived_at to Credit schema (parity with Commit) ([c4cb0de](https://github.com/Metronome-Industries/metronome-ruby/commit/c4cb0de6639d6260cd5cd4991c2bdbbca9a56308))
+* **client:** elide content type header on requests without body ([3229b9e](https://github.com/Metronome-Industries/metronome-ruby/commit/3229b9ea9655734024eeacf899aef1559401c950))
+
+
+### Chores
+
+* configure new SDK language ([2318d44](https://github.com/Metronome-Industries/metronome-ruby/commit/2318d447232cd1368c1be58b004f4e56f6ec58f8))
+* configure new SDK language ([c604e19](https://github.com/Metronome-Industries/metronome-ruby/commit/c604e191054d276f6620fe43ef76543c000703ee))
+* configure new SDK language ([85c2a71](https://github.com/Metronome-Industries/metronome-ruby/commit/85c2a714681224c4e5b654ae2a0ffa0ff478c269))
+* configure new SDK language ([7f6bb80](https://github.com/Metronome-Industries/metronome-ruby/commit/7f6bb80a5e0f7838849aa1fef4e255ac7a7c6d44))
+* **internal:** more robust bootstrap script ([3f8dd59](https://github.com/Metronome-Industries/metronome-ruby/commit/3f8dd59db3d7878d6232f01d0fda804657de3e2a))
+
+## 3.5.0 (2026-04-18)
+
+Full Changelog: [v3.4.0...v3.5.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v3.4.0...v3.5.0)
+
+### Features
+
+* add override created at in api responses ([87dbd21](https://github.com/Metronome-Industries/metronome-ruby/commit/87dbd21032840c620459273377db9bb272cbfd22))
+* Add recurring_commit_ids and remove recurring_credit_ids from api ([792197c](https://github.com/Metronome-Industries/metronome-ruby/commit/792197c773eb6235d4c29745b813d950746214dd))
+* Docs: Dd/update balance guides ([a0c43b0](https://github.com/Metronome-Industries/metronome-ruby/commit/a0c43b07ceaa54836c753c40dc31a900ead0f30c))
+* Enable OIDC auth for npm publisher ([6db4272](https://github.com/Metronome-Industries/metronome-ruby/commit/6db427233a322a94667e5e35e0de4aa8eb17fdde))
+* External fixes for rollover credits ([6478a14](https://github.com/Metronome-Industries/metronome-ruby/commit/6478a14a3efa407fd1738dfcd94fc57719ced31d))
+* Fully document CreditAdd/CreditUpdate fields in API spec ([eb852a3](https://github.com/Metronome-Industries/metronome-ruby/commit/eb852a392fc610d2a7207d06884bbf2061c11954))
+* Fully document CreditAdd/CreditUpdate fields in API spec ([f0581f3](https://github.com/Metronome-Industries/metronome-ruby/commit/f0581f37f25e052401a9662c41580bd252f42ec8))
+* Map missing `contract_name` when returning Packages ([3eee272](https://github.com/Metronome-Industries/metronome-ruby/commit/3eee272e7797350e99f372996728453946284d16))
+* **ORCH-1361:** add priority to threshold commit OpenAPI schemas ([6461ec2](https://github.com/Metronome-Industries/metronome-ruby/commit/6461ec2ca1efd1b9a09cf33a4c5774dad5f535d1))
+* ORCH-1410: Add discount_configuration to POST v2/contracts/edit ([852219d](https://github.com/Metronome-Industries/metronome-ruby/commit/852219d69ee7cb5e22fdb3e9b0611c463b191f67))
+* remove dead field, pipe day through to MRI, return day when get package ([17f2939](https://github.com/Metronome-Industries/metronome-ruby/commit/17f2939a021072c53619250274aa89278fdb20d4))
+* Support nullable discount fraction on contract update inputs ([c67304b](https://github.com/Metronome-Industries/metronome-ruby/commit/c67304b1a4a9d5ab1761e220e36d3bd1f71e153b))
+
+
+### Bug Fixes
+
+* align path encoding with RFC 3986 section 3.3 ([cba23c1](https://github.com/Metronome-Industries/metronome-ruby/commit/cba23c1734d5642be93612e3d562c43ce5281567))
+* **internal:** correct multipart form field name encoding ([7744335](https://github.com/Metronome-Industries/metronome-ruby/commit/774433578aef086d6997faccc6e48e97c7381ec8))
+* multipart encoding for file arrays ([824320c](https://github.com/Metronome-Industries/metronome-ruby/commit/824320cdfbacbeac8650c6179280d0a71eb24b44))
+* variable name typo ([802a290](https://github.com/Metronome-Industries/metronome-ruby/commit/802a290f7a1eb290c8aad3ec0a6c7ad9eeed20bd))
+
+
+### Chores
+
+* **ci:** skip lint on metadata-only changes ([f14cdaa](https://github.com/Metronome-Industries/metronome-ruby/commit/f14cdaa8a02129e73fc1b32914ae14146b56b4ad))
+* **ci:** support opting out of skipping builds on metadata-only commits ([6f4c5bc](https://github.com/Metronome-Industries/metronome-ruby/commit/6f4c5bc8f054ccafa69ba30514c91657021e871f))
+* **internal:** tweak CI branches ([71b11a6](https://github.com/Metronome-Industries/metronome-ruby/commit/71b11a6dba46733ffec3b0ab10d5812308972c19))
+* **internal:** update gitignore ([dd4bfc8](https://github.com/Metronome-Industries/metronome-ruby/commit/dd4bfc8cae02b3edd68f1104a07b982a6e2c1b3b))
+* **tests:** bump steady to v0.19.4 ([da62d02](https://github.com/Metronome-Industries/metronome-ruby/commit/da62d027d99e26ef0f961336fd08af2926365d99))
+* **tests:** bump steady to v0.19.5 ([76ea6a0](https://github.com/Metronome-Industries/metronome-ruby/commit/76ea6a0aaf684bc2e7c691fa860c8877e1943dc0))
+* **tests:** bump steady to v0.19.6 ([1368bba](https://github.com/Metronome-Industries/metronome-ruby/commit/1368bbac0a69aa766786a9ed78d9195c73b31d09))
+* **tests:** bump steady to v0.19.7 ([5e94fed](https://github.com/Metronome-Industries/metronome-ruby/commit/5e94fed2cf97a1b3a7565ac18952c70b47040847))
+* **tests:** bump steady to v0.20.1 ([069329c](https://github.com/Metronome-Industries/metronome-ruby/commit/069329ca1cc50b77a5b76a057eae32e732066697))
+* **tests:** bump steady to v0.20.2 ([add7ae8](https://github.com/Metronome-Industries/metronome-ruby/commit/add7ae85ea63ebeacbf3cf754ef7bd48a92c701d))
+* **tests:** bump steady to v0.22.1 ([5908006](https://github.com/Metronome-Industries/metronome-ruby/commit/5908006482ed816f9960dc00e727f05067f2d0bc))
+
+
+### Refactors
+
+* **tests:** switch from prism to steady ([e8f7dbc](https://github.com/Metronome-Industries/metronome-ruby/commit/e8f7dbc646afdfa31bcce4a580e863258f76dd06))
+
 ## 3.4.0 (2026-03-11)
 
 Full Changelog: [v3.3.0...v3.4.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v3.3.0...v3.4.0)

data/README.md

@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "metronome-sdk", "~> 3.4.0"
+gem "metronome-sdk", "~> 3.6.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/metronome_sdk/client.rb

@@ -67,6 +67,19 @@ module MetronomeSDK
         raise ArgumentError.new("bearer_token is required, and can be set via environ: \"METRONOME_BEARER_TOKEN\"")
       end
 
+      headers = {}
+      custom_headers_env = ENV["METRONOME_CUSTOM_HEADERS"]
+      unless custom_headers_env.nil?
+        parsed = {}
+        custom_headers_env.split("\n").each do |line|
+          colon = line.index(":")
+          unless colon.nil?
+            parsed[line[0...colon].strip] = line[(colon + 1)..].strip
+          end
+        end
+        headers = parsed.merge(headers)
+      end
+
       @bearer_token = bearer_token.to_s
       @webhook_secret = webhook_secret&.to_s
 
@@ -75,7 +88,8 @@ module MetronomeSDK
         timeout: timeout,
         max_retries: max_retries,
         initial_retry_delay: initial_retry_delay,
-        max_retry_delay: max_retry_delay
+        max_retry_delay: max_retry_delay,
+        headers: headers
       )
 
       @v2 = MetronomeSDK::Resources::V2.new(client: self)

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

@@ -306,6 +306,8 @@ module MetronomeSDK
               MetronomeSDK::Internal::Util.deep_merge(*[req[:body], opts[:extra_body]].compact)
             end
 
+          headers.delete("content-type") if body.nil?
+
           url = MetronomeSDK::Internal::Util.join_parsed_uri(
             @base_url_components,
             {**req, path: path, query: query}

data/lib/metronome_sdk/internal/util.rb

@@ -157,7 +157,7 @@ module MetronomeSDK
           in Hash | nil => coerced
             coerced
           else
-            message = "Expected a #{Hash} or #{MetronomeSDK::Internal::Type::BaseModel}, got #{data.inspect}"
+            message = "Expected a #{Hash} or #{MetronomeSDK::Internal::Type::BaseModel}, got #{input.inspect}"
             raise ArgumentError.new(message)
           end
         end
@@ -237,6 +237,11 @@ module MetronomeSDK
         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 MetronomeSDK
           "#{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(MetronomeSDK::Internal::Util::RFC_3986_NOT_PCHARS) { ERB::Util.url_encode(_1) }
+        end
+
         # @api private
         #
         # @param path [String, Array<String>]
@@ -259,7 +273,7 @@ module MetronomeSDK
           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 MetronomeSDK
           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 MetronomeSDK::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 MetronomeSDK
         #
         # @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 MetronomeSDK
             in Hash
               body.each do |key, val|
                 case val
-                in Array if val.all? { primitive?(_1) }
+                in Array if val.all? { primitive?(_1) || MetronomeSDK::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 MetronomeSDK
 
           fused_io = fused_enum(strio) { closing.each(&:call) }
           [boundary, fused_io]
+          # rubocop:enable Style/CaseEquality
         end
 
         # @api private

data/lib/metronome_sdk/models/base_threshold_commit.rb

@@ -22,7 +22,14 @@ module MetronomeSDK
       #   @return [String, nil]
       optional :name, String
 
-      # @!method initialize(product_id:, description: nil, name: nil)
+      # @!attribute priority
+      #   The priority of the commit, used to determine drawdown order. Lower priority
+      #   commits are consumed first. Defaults to 100 if not specified.
+      #
+      #   @return [Float, nil]
+      optional :priority, Float
+
+      # @!method initialize(product_id:, description: nil, name: nil, priority: nil)
       #   Some parameter documentations has been truncated, see
       #   {MetronomeSDK::Models::BaseThresholdCommit} for more details.
       #
@@ -31,6 +38,8 @@ module MetronomeSDK
       #   @param description [String]
       #
       #   @param name [String] Specify the name of the line item for the threshold charge. If left blank, it wi
+      #
+      #   @param priority [Float] The priority of the commit, used to determine drawdown order. Lower priority com
     end
   end
 end