metronome-sdk 3.6.0 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4d5355d04639b7153cfe94271378797fceaff008c386c001c6450f66674a584
-  data.tar.gz: 25c993147e97e4acead3048b17b7328e67b4e95274bef1893723bf806ddd9bec
+  metadata.gz: 97f31a567a1ed13359a6db7517a0a31b47f7ab157d92e417fdfb60050869737a
+  data.tar.gz: b17e2f57bd7d2db609f95f5dcf5b165d6e050dd05eb717bab10148b450b19bb0
 SHA512:
-  metadata.gz: 653c76e15fba1881dcc6e344161a61f7c0c061aba2603bdb26a3f489986c23e31d1fe77bb2134070f53333efe9efa5d37b73f206abb30b4cba33eb05f967c771
-  data.tar.gz: 3d6505e8bd6767e3873ba2d70c28bc93eac7280ae2ca126eba43a18eca5e4a113704574909e5c0a26f503204675bc407582190dd9d1f20afa91ecc98cc30def0
+  metadata.gz: 771169e3edf3cbd87d0ce517fa9999c1303af4ad003ad278c58ad7239545f7157224e52646b1db43fc7b17db0af0d038cdda41d66bc6115038cb39ba48123843
+  data.tar.gz: 8b0180525f48ed9bf872de4bf2f29c6b504f20eef0dd1acc013d526115dfb34b3839dca5c0e20d0a8ec2248ea6968678b919a2881c7ab801b637eb72f2abd17f

data/CHANGELOG.md

@@ -1,5 +1,59 @@
 # Changelog
 
+## 3.8.0 (2026-06-29)
+
+Full Changelog: [v3.7.0...v3.8.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v3.7.0...v3.8.0)
+
+### Features
+
+* [🪿] Remove `allow-subscriptions-custom-billing-anchor` feature flag ([4a67399](https://github.com/Metronome-Industries/metronome-ruby/commit/4a673991f9369fe744bc3a5a2f854c14c9b497ac))
+* Add `Action` and `Action_hover` theme color options to embeddable dashboard ([ad6641d](https://github.com/Metronome-Industries/metronome-ruby/commit/ad6641d4ff8118e8acc920c143adb6e57bfd4201))
+* Add alert specifiers to  for `low_remaining_contract_credit_and_commit_balance_reached` threshold notification creation payload ([8dccadf](https://github.com/Metronome-Industries/metronome-ruby/commit/8dccadf1cc4077759e004a8802cb603971b6f978))
+* Add any_commit_and_credit_ids to override specifier fields ([797cfca](https://github.com/Metronome-Industries/metronome-ruby/commit/797cfca1e8f5179b99887b99ccbf8391366cdb74))
+* add getSubscriptionSeatsHistory to Node SDK ([d288a2a](https://github.com/Metronome-Industries/metronome-ruby/commit/d288a2a109b6f0d6e0c45cdd4d3a8ab64ec9732c))
+* Add notification_metadata to four API endpoints (Anthropic-only) ([fb4e252](https://github.com/Metronome-Industries/metronome-ruby/commit/fb4e252118ebc3ce523e12074af87a90dadf712a))
+* added created by to commits ([a11cb6f](https://github.com/Metronome-Industries/metronome-ruby/commit/a11cb6fe06264f5d348818e77c8b1b1bb560b339))
+* **CONN-980:** add contract_id, invoice_type, show_unbillable_invoices to embeddable dashboard API ([cccf877](https://github.com/Metronome-Industries/metronome-ruby/commit/cccf877456c646c28569fbf9e4e86cec7b32faf6))
+* createdBy description specifies excluding system created commits ([d492e50](https://github.com/Metronome-Industries/metronome-ruby/commit/d492e5019a404dd6cfd0606a7fa959e45e79d42c))
+* daily recurrence frequency for recurring commits ([b143c69](https://github.com/Metronome-Industries/metronome-ruby/commit/b143c690a98329e91830210aebb56d9fd910b8d3))
+* Docs: Update v1.yml ([2b13cb9](https://github.com/Metronome-Industries/metronome-ruby/commit/2b13cb9e673f4af7a8413c581e8b0722f98905c2))
+* Revert "[pgs] Remove `allow-subscriptions-custom-billing-anchor` and proration rounding feature flags" ([804fc62](https://github.com/Metronome-Industries/metronome-ruby/commit/804fc62384bd67a65e9f022349d8af18e7faf3e8))
+* Revert "Revert "[pgs] Remove `allow-subscriptions-custom-billing-anchor` and proration rounding feature flags"" ([b5532d9](https://github.com/Metronome-Industries/metronome-ruby/commit/b5532d9ec1866c08629b7f7616bdb7eb12a2f541))
+* skip seat IDs from balances ([242fa91](https://github.com/Metronome-Industries/metronome-ruby/commit/242fa91291d812744c214497ee2f87e03c20e048))
+* Update copy ([911d292](https://github.com/Metronome-Industries/metronome-ruby/commit/911d2924cef101ec49077fe8a859e7b9a9d3f083))
+
+
+### Bug Fixes
+
+* **client:** send content-type header for requests with an omitted optional body ([4d4e05a](https://github.com/Metronome-Industries/metronome-ruby/commit/4d4e05aa6c499bc6f51e60d134225cccc49767d0))
+
+
+### Chores
+
+* (internal) Add description for threshold balance specifiers fields ([bbc523a](https://github.com/Metronome-Industries/metronome-ruby/commit/bbc523aae016d1a9d907bdae0a656164ffd242de))
+* **internal:** bound formatter parallelism to CPU count ([b497f47](https://github.com/Metronome-Industries/metronome-ruby/commit/b497f478f4d039c50d4cf2366bd2d492d0489002))
+
+
+### Documentation
+
+* add RPS limit and batch recommendation to addRate endpoint ([aad17f7](https://github.com/Metronome-Industries/metronome-ruby/commit/aad17f7960f3caad7db5c4e4d3d78e1308b92676))
+
+## 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)

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.6.0"
+gem "metronome-sdk", "~> 3.8.0"
 ```
 
 <!-- x-release-please-end -->

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

@@ -306,7 +306,10 @@ module MetronomeSDK
               MetronomeSDK::Internal::Util.deep_merge(*[req[:body], opts[:extra_body]].compact)
             end
 
-          headers.delete("content-type") if body.nil?
+          # Generated methods always pass `req[:body]` for operations that define a
+          # request body, so only elide the content-type header when the operation
+          # has no body at all, not when an optional body param was omitted.
+          headers.delete("content-type") if body.nil? && !req.key?(:body)
 
           url = MetronomeSDK::Internal::Util.join_parsed_uri(
             @base_url_components,

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

@@ -81,6 +81,13 @@ module MetronomeSDK
       #   @return [MetronomeSDK::Models::Commit::Contract, nil]
       optional :contract, -> { MetronomeSDK::Commit::Contract }
 
+      # @!attribute created_by
+      #   The actor who created this commit. Omitted for system-generated commits such as
+      #   recurring commits, rollover commits, and threshold commits.
+      #
+      #   @return [String, nil]
+      optional :created_by, String
+
       # @!attribute custom_fields
       #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
       #
@@ -171,6 +178,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 +200,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, created_by: 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.
       #
@@ -215,6 +228,8 @@ module MetronomeSDK
       #
       #   @param contract [MetronomeSDK::Models::Commit::Contract]
       #
+      #   @param created_by [String] The actor who created this commit. Omitted for system-generated commits such as
+      #
       #   @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
       #
       #   @param description [String]
@@ -245,6 +260,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 +970,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