metronome-sdk 3.5.0 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0efabaeb66e2c3c37a2df72b4643172c5696992964c9d4d87fa7c8831d954bae
-  data.tar.gz: ce828a8840076f76c98d7721873e799fa3f536dcb4cedf25705fb5080b2ef90b
+  metadata.gz: 72c947987bf3b6947462d66133a12deab29b5c7ed85c20169adfa923caf73076
+  data.tar.gz: 54e641c55d3862d539331f0716fb62feece95b6cf83e15217dedb4fbdf2dc1bc
 SHA512:
-  metadata.gz: f4404c030aaafa8c308dd7b708bfb709e92d5a0b03c9822187fe5dd2ce7cae120fb0c2ba76f39d95de800cd91005e6ed913658509cdcc53a213d9fd0301bda12
-  data.tar.gz: 728d74b8043e076f0b0719967681cb8341558ee9a9a536b40dbf7364141c49faf2c8934fcd3ed35af5ce47e287e230a284b0607a95d33d32e943233ba2ab4fb0
+  metadata.gz: 1e9d8143dcda81173e1fd5c63001d0d952a27b667194d9c1e26c2a19a1f3d0c80b82f5463d394603cd22bd0f0ab79d7ffd47faaabaf6e7633ed73a73fcbb99cd
+  data.tar.gz: fa66a0ab59ddde426e0e9ac34adae0f40d3d99e1fdb827ed4934bde394d6902b90372f7e1e69942aeb416706e6cfc9ade9a05c9267723bc5b98dd7fb1943376e

data/CHANGELOG.md

@@ -1,5 +1,58 @@
 # Changelog
 
+## 3.7.0 (2026-05-29)
+
+Full Changelog: [v3.6.0...v3.7.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v3.6.0...v3.7.0)
+
+### Features
+
+* [LAUNCH-2814] editContract returns full edit in the response ([fd684bc](https://github.com/Metronome-Industries/metronome-ruby/commit/fd684bc491dc2083911a144ba0a455385eaf315d))
+* [orch-1860] remove all deprecated `/payments/*` endpoints from API ([1c6cdb1](https://github.com/Metronome-Industries/metronome-ruby/commit/1c6cdb1d7629e6a29adc78a1dbd460eebbbab08b))
+* create contract returns contract data ([16469e5](https://github.com/Metronome-Industries/metronome-ruby/commit/16469e57c6563dd35b5b2f3cf05893a69ec7d406))
+* nikku-orch-1723-update-create-contract ([a5de974](https://github.com/Metronome-Industries/metronome-ruby/commit/a5de9740f141a211e0435fff858ceca62d2b5359))
+
+
+### Chores
+
+* (internal) Add threshold balance specifier to contract create & edit, package create and both contract and package retrievals ([eb1049d](https://github.com/Metronome-Industries/metronome-ruby/commit/eb1049d2826865a29710c274e13cc311005a0e91))
+
+## 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)

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.5.0"
+gem "metronome-sdk", "~> 3.7.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/type/enum.rb

@@ -15,31 +15,6 @@ module MetronomeSDK
       #
       # We can therefore convert string values to Symbols, but can't convert other
       # values safely.
-      #
-      # @example
-      #   # `payment_status` is a `MetronomeSDK::V1::PaymentStatus`
-      #   case payment_status
-      #   when MetronomeSDK::V1::PaymentStatus::PENDING
-      #     # ...
-      #   when MetronomeSDK::V1::PaymentStatus::REQUIRES_INTERVENTION
-      #     # ...
-      #   when MetronomeSDK::V1::PaymentStatus::PAID
-      #     # ...
-      #   else
-      #     puts(payment_status)
-      #   end
-      #
-      # @example
-      #   case payment_status
-      #   in :pending
-      #     # ...
-      #   in :requires_intervention
-      #     # ...
-      #   in :paid
-      #     # ...
-      #   else
-      #     puts(payment_status)
-      #   end
       module Enum
         include MetronomeSDK::Internal::Type::Converter
         include MetronomeSDK::Internal::Util::SorbetRuntimeSupport

data/lib/metronome_sdk/models/commit.rb

@@ -171,6 +171,12 @@ module MetronomeSDK
       #   @return [Array<MetronomeSDK::Models::CommitSpecifier>, nil]
       optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifier] }
 
+      # @!attribute spend_tracker_attributes
+      #   Optional attributes controlling how this commit interacts with spend trackers.
+      #
+      #   @return [MetronomeSDK::Models::Commit::SpendTrackerAttributes, nil]
+      optional :spend_tracker_attributes, -> { MetronomeSDK::Commit::SpendTrackerAttributes }
+
       # @!attribute subscription_config
       #   The subscription configuration for this commit, if it was generated from a
       #   recurring commit with a subscription attached.
@@ -187,7 +193,7 @@ module MetronomeSDK
       #   @return [String, nil]
       optional :uniqueness_key, String
 
-      # @!method initialize(id:, created_at:, product:, type:, access_schedule: nil, amount: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, archived_at: nil, balance: nil, contract: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, invoice_contract: nil, invoice_schedule: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, recurring_commit_id: nil, rolled_over_from: nil, rollover_fraction: nil, salesforce_opportunity_id: nil, specifiers: nil, subscription_config: nil, uniqueness_key: nil)
+      # @!method initialize(id:, created_at:, product:, type:, access_schedule: nil, amount: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, archived_at: nil, balance: nil, contract: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, invoice_contract: nil, invoice_schedule: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, recurring_commit_id: nil, rolled_over_from: nil, rollover_fraction: nil, salesforce_opportunity_id: nil, specifiers: nil, spend_tracker_attributes: nil, subscription_config: nil, uniqueness_key: nil)
       #   Some parameter documentations has been truncated, see
       #   {MetronomeSDK::Models::Commit} for more details.
       #
@@ -245,6 +251,8 @@ module MetronomeSDK
       #
       #   @param specifiers [Array<MetronomeSDK::Models::CommitSpecifier>] List of filters that determine what kind of customer usage draws down a commit o
       #
+      #   @param spend_tracker_attributes [MetronomeSDK::Models::Commit::SpendTrackerAttributes] Optional attributes controlling how this commit interacts with spend trackers.
+      #
       #   @param subscription_config [MetronomeSDK::Models::Commit::SubscriptionConfig] The subscription configuration for this commit, if it was generated from a recur
       #
       #   @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a commit or credit i
@@ -953,6 +961,24 @@ module MetronomeSDK
         #   @param contract_id [String]
       end
 
+      # @see MetronomeSDK::Models::Commit#spend_tracker_attributes
+      class SpendTrackerAttributes < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute counts_as_discounted
+        #   If true, this commit is included in spend trackers with discounted set to
+        #   DISCOUNTED_ONLY
+        #
+        #   @return [Boolean]
+        required :counts_as_discounted, MetronomeSDK::Internal::Type::Boolean
+
+        # @!method initialize(counts_as_discounted:)
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::Commit::SpendTrackerAttributes} for more details.
+        #
+        #   Optional attributes controlling how this commit interacts with spend trackers.
+        #
+        #   @param counts_as_discounted [Boolean] If true, this commit is included in spend trackers with discounted set to DISCOU
+      end
+
       # @see MetronomeSDK::Models::Commit#subscription_config
       class SubscriptionConfig < MetronomeSDK::Internal::Type::BaseModel
         # @!attribute allocation

data/lib/metronome_sdk/models/contract.rb

@@ -76,6 +76,13 @@ module MetronomeSDK
       #   @return [MetronomeSDK::Models::SpendThresholdConfiguration, nil]
       optional :spend_threshold_configuration, -> { MetronomeSDK::SpendThresholdConfiguration }
 
+      # @!attribute spend_trackers
+      #   Spend trackers attached to this contract.
+      #
+      #   @return [Array<MetronomeSDK::Models::Contract::SpendTracker>, nil]
+      optional :spend_trackers,
+               -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Contract::SpendTracker] }
+
       # @!attribute subscriptions
       #   List of subscriptions on the contract.
       #
@@ -90,7 +97,7 @@ module MetronomeSDK
       #   @return [String, nil]
       optional :uniqueness_key, String
 
-      # @!method initialize(id:, amendments:, current:, customer_id:, initial:, archived_at: nil, custom_fields: nil, customer_billing_provider_configuration: nil, package_id: nil, prepaid_balance_threshold_configuration: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, subscriptions: nil, uniqueness_key: nil)
+      # @!method initialize(id:, amendments:, current:, customer_id:, initial:, archived_at: nil, custom_fields: nil, customer_billing_provider_configuration: nil, package_id: nil, prepaid_balance_threshold_configuration: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, spend_trackers: nil, subscriptions: nil, uniqueness_key: nil)
       #   Some parameter documentations has been truncated, see
       #   {MetronomeSDK::Models::Contract} for more details.
       #
@@ -118,6 +125,8 @@ module MetronomeSDK
       #
       #   @param spend_threshold_configuration [MetronomeSDK::Models::SpendThresholdConfiguration]
       #
+      #   @param spend_trackers [Array<MetronomeSDK::Models::Contract::SpendTracker>] Spend trackers attached to this contract.
+      #
       #   @param subscriptions [Array<MetronomeSDK::Models::Subscription>] List of subscriptions on the contract.
       #
       #   @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
@@ -400,6 +409,136 @@ module MetronomeSDK
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      class SpendTracker < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute alias_
+        #   Human-readable identifier, unique per contract.
+        #
+        #   @return [String]
+        required :alias_, String, api_name: :alias
+
+        # @!attribute applicable_spend_specifiers
+        #
+        #   @return [Array<MetronomeSDK::Models::Contract::SpendTracker::ApplicableSpendSpecifier>]
+        required :applicable_spend_specifiers,
+                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier] }
+
+        # @!attribute credit_type_id
+        #
+        #   @return [String]
+        required :credit_type_id, String
+
+        # @!attribute reset_frequency
+        #
+        #   @return [Symbol, MetronomeSDK::Models::Contract::SpendTracker::ResetFrequency]
+        required :reset_frequency, enum: -> { MetronomeSDK::Contract::SpendTracker::ResetFrequency }
+
+        # @!attribute accumulated_spend
+        #
+        #   @return [MetronomeSDK::Models::Contract::SpendTracker::AccumulatedSpend, nil]
+        optional :accumulated_spend, -> { MetronomeSDK::Contract::SpendTracker::AccumulatedSpend }
+
+        # @!method initialize(alias_:, applicable_spend_specifiers:, credit_type_id:, reset_frequency:, accumulated_spend: nil)
+        #   @param alias_ [String] Human-readable identifier, unique per contract.
+        #
+        #   @param applicable_spend_specifiers [Array<MetronomeSDK::Models::Contract::SpendTracker::ApplicableSpendSpecifier>]
+        #
+        #   @param credit_type_id [String]
+        #
+        #   @param reset_frequency [Symbol, MetronomeSDK::Models::Contract::SpendTracker::ResetFrequency]
+        #
+        #   @param accumulated_spend [MetronomeSDK::Models::Contract::SpendTracker::AccumulatedSpend]
+
+        class ApplicableSpendSpecifier < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute sources
+          #
+          #   @return [Array<Symbol, MetronomeSDK::Models::Contract::SpendTracker::ApplicableSpendSpecifier::Source>]
+          required :sources,
+                   -> { MetronomeSDK::Internal::Type::ArrayOf[enum: MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier::Source] }
+
+          # @!attribute spend_type
+          #
+          #   @return [Symbol, MetronomeSDK::Models::Contract::SpendTracker::ApplicableSpendSpecifier::SpendType]
+          required :spend_type,
+                   enum: -> { MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier::SpendType }
+
+          # @!attribute discounted
+          #
+          #   @return [Symbol, MetronomeSDK::Models::Contract::SpendTracker::ApplicableSpendSpecifier::Discounted, nil]
+          optional :discounted,
+                   enum: -> { MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier::Discounted }
+
+          # @!method initialize(sources:, spend_type:, discounted: nil)
+          #   @param sources [Array<Symbol, MetronomeSDK::Models::Contract::SpendTracker::ApplicableSpendSpecifier::Source>]
+          #   @param spend_type [Symbol, MetronomeSDK::Models::Contract::SpendTracker::ApplicableSpendSpecifier::SpendType]
+          #   @param discounted [Symbol, MetronomeSDK::Models::Contract::SpendTracker::ApplicableSpendSpecifier::Discounted]
+
+          module Source
+            extend MetronomeSDK::Internal::Type::Enum
+
+            THRESHOLD_RECHARGE = :THRESHOLD_RECHARGE
+            MANUAL = :MANUAL
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see MetronomeSDK::Models::Contract::SpendTracker::ApplicableSpendSpecifier#spend_type
+          module SpendType
+            extend MetronomeSDK::Internal::Type::Enum
+
+            COMMIT_PURCHASE = :COMMIT_PURCHASE
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see MetronomeSDK::Models::Contract::SpendTracker::ApplicableSpendSpecifier#discounted
+          module Discounted
+            extend MetronomeSDK::Internal::Type::Enum
+
+            ANY = :ANY
+            DISCOUNTED_ONLY = :DISCOUNTED_ONLY
+            UNDISCOUNTED_ONLY = :UNDISCOUNTED_ONLY
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @see MetronomeSDK::Models::Contract::SpendTracker#reset_frequency
+        module ResetFrequency
+          extend MetronomeSDK::Internal::Type::Enum
+
+          BILLING_PERIOD = :BILLING_PERIOD
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see MetronomeSDK::Models::Contract::SpendTracker#accumulated_spend
+        class AccumulatedSpend < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute amount
+          #
+          #   @return [Float]
+          required :amount, Float
+
+          # @!attribute period_ending_before
+          #
+          #   @return [Time]
+          required :period_ending_before, Time
+
+          # @!attribute period_starting_at
+          #
+          #   @return [Time]
+          required :period_starting_at, Time
+
+          # @!method initialize(amount:, period_ending_before:, period_starting_at:)
+          #   @param amount [Float]
+          #   @param period_ending_before [Time]
+          #   @param period_starting_at [Time]
+        end
+      end
     end
   end
 end