metronome-sdk 3.8.0 → 3.10.0

data/lib/metronome_sdk/resources/v1/contracts/rate_cards.rb

@@ -112,24 +112,19 @@ module MetronomeSDK
           # Some parameter documentations has been truncated, see
           # {MetronomeSDK::Models::V1::Contracts::RateCardUpdateParams} for more details.
           #
-          # Update the metadata properties of an existing rate card, including its name,
-          # description, and aliases. This endpoint is designed for managing rate card
-          # identity and reference aliases rather than modifying pricing rates.
-          #
-          # Modifies the descriptive properties and alias configuration of a rate card
-          # without affecting the underlying pricing rates or schedules. This allows you to
-          # update how a rate card is identified and referenced throughout your system.
+          # Update a rate card's name, description, aliases, and credit type conversion
+          # rates. This endpoint does not affect underlying pricing rates or schedules.
           #
           # ### Use this endpoint to:
           #
-          # - Rate card renaming: Update display names or descriptions for organizational
+          # - Rename rate cards: Update display names or descriptions for organizational
           #   clarity
-          # - Alias management: Add, modify, or schedule alias transitions for seamless rate
-          #   card migrations
-          # - Documentation updates: Keep rate card descriptions current with business
+          # - Manage aliases: Add, modify, or schedule alias transitions for seamless and
+          #   code-free rate card migrations
+          # - Update documentation: Keep rate card descriptions current with business
           #   context
-          # - Self-serve provisioning setup: Configure aliases to enable code-free rate card
-          #   transitions
+          # - Configure custom pricing units: Add credit type conversions to enable rates
+          #   with different pricing units
           #
           # #### Active contract impact:
           #
@@ -165,10 +160,12 @@ module MetronomeSDK
           #   your PLG workflow using that alias will automatically reference the new rate
           #   card
           #
-          # @overload update(rate_card_id:, aliases: nil, description: nil, name: nil, request_options: {})
+          # @overload update(rate_card_id:, add_credit_type_conversions: nil, aliases: nil, description: nil, name: nil, request_options: {})
           #
           # @param rate_card_id [String] ID of the rate card to update
           #
+          # @param add_credit_type_conversions [Array<MetronomeSDK::Models::V1::Contracts::RateCardUpdateParams::AddCreditTypeConversion>] Add credit type conversions for using custom pricing units in rates. Existing co
+          #
           # @param aliases [Array<MetronomeSDK::Models::V1::Contracts::RateCardUpdateParams::Alias>] Reference this alias when creating a contract. If the same alias is assigned to
           #
           # @param description [String]

data/lib/metronome_sdk/resources/v1/dashboards.rb

@@ -30,16 +30,13 @@ module MetronomeSDK
         #
         # - Dashboard types: Choose from `invoices`, `usage`, or `commits_and_credits`
         # - Customization options:
-        #   - `dashboard_options`: Configure dashboard behavior. For the invoices
-        #     dashboard, supported keys include: `show_zero_usage_line_items`
-        #     ("true"/"false"), `hide_voided_invoices` ("true"/"false"), `contract_id`
-        #     (UUID, filters invoices by contract), `invoice_type` ("USAGE" or
-        #     "SCHEDULED", filters by invoice type), `invoice_status_filter` ("VOID",
-        #     "FINALIZED", "DRAFT", "FINALIZED_AND_DRAFT", or "ALL"), and
-        #     `billable_status_filter` ("BILLABLE", "UNBILLABLE", or "ALL")
+        #   - `dashboard_options`: Configure dashboard behavior. Supported for the
+        #     invoices dashboard only. Available keys include:
+        #     `show_zero_usage_line_items` ("true"/"false"), `contract_id` (UUID, filters
+        #     invoices by contract), `invoice_type` ("USAGE" or "SCHEDULED", filters by
+        #     invoice type), and `invoice_status_filter` ("VOID", "FINALIZED", "DRAFT",
+        #     "FINALIZED_AND_DRAFT", or "ALL")
         #   - `color_overrides`: Match your brand's color palette
-        #   - `bm_group_key_overrides`: Customize how dimensions are displayed (for the
-        #     usage embeddable dashboard)
         # - Iframe implementation: Embed the returned URL directly in an iframe element
         # - Responsive design: Dashboards automatically adapt to container dimensions
         #

data/lib/metronome_sdk/resources/v2/contracts.rb

@@ -236,7 +236,7 @@ module MetronomeSDK
         #   finalized invoice. You can void the invoice beforehand and then remove the
         #   access schedule segment.
         #
-        # @overload edit_commit(commit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, description: nil, hierarchy_configuration: nil, invoice_contract_id: nil, invoice_schedule: nil, name: nil, priority: nil, product_id: nil, rate_type: nil, specifiers: nil, request_options: {})
+        # @overload edit_commit(commit_id:, customer_id:, access_schedule: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, description: nil, hierarchy_configuration: nil, invoice_contract_id: nil, invoice_schedule: nil, name: nil, priority: nil, product_id: nil, rate_type: nil, specifiers: nil, request_options: {})
         #
         # @param commit_id [String] ID of the commit to edit
         #
@@ -244,6 +244,8 @@ module MetronomeSDK
         #
         # @param access_schedule [MetronomeSDK::Models::V2::ContractEditCommitParams::AccessSchedule]
         #
+        # @param applicable_contract_ids [Array<String>, nil] Which contracts the customer-level commit applies to. If set to null, the commit
+        #
         # @param applicable_product_ids [Array<String>, nil] Which products the commit applies to. If applicable_product_ids, applicable_prod
         #
         # @param applicable_product_tags [Array<String>, nil] Which tags the commit applies to. If applicable*product_ids, applicable_product*
@@ -302,7 +304,7 @@ module MetronomeSDK
         #   invoice. You can void the invoice beforehand and then remove the access
         #   schedule segment.
         #
-        # @overload edit_credit(credit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, description: nil, hierarchy_configuration: nil, name: nil, priority: nil, product_id: nil, rate_type: nil, specifiers: nil, request_options: {})
+        # @overload edit_credit(credit_id:, customer_id:, access_schedule: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, description: nil, hierarchy_configuration: nil, name: nil, priority: nil, product_id: nil, rate_type: nil, specifiers: nil, request_options: {})
         #
         # @param credit_id [String] ID of the credit to edit
         #
@@ -310,6 +312,8 @@ module MetronomeSDK
         #
         # @param access_schedule [MetronomeSDK::Models::V2::ContractEditCreditParams::AccessSchedule]
         #
+        # @param applicable_contract_ids [Array<String>, nil] Which contracts the customer-level credit applies to. If set to null, the credit
+        #
         # @param applicable_product_ids [Array<String>, nil] Which products the credit applies to. If both applicable_product_ids and applica
         #
         # @param applicable_product_tags [Array<String>, nil] Which tags the credit applies to. If both applicable*product_ids and applicable*

data/lib/metronome_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MetronomeSDK
-  VERSION = "3.8.0"
+  VERSION = "3.10.0"
 end

data/rbi/metronome_sdk/models/commit.rbi

@@ -91,6 +91,13 @@ module MetronomeSDK
       sig { params(contract: MetronomeSDK::Commit::Contract::OrHash).void }
       attr_writer :contract
 
+      # The ratio of the amount paid for the commit to the amount of credit granted.
+      sig { returns(T.nilable(Float)) }
+      attr_reader :cost_basis
+
+      sig { params(cost_basis: Float).void }
+      attr_writer :cost_basis
+
       # The actor who created this commit. Omitted for system-generated commits such as
       # recurring commits, rollover commits, and threshold commits.
       sig { returns(T.nilable(String)) }
@@ -293,6 +300,7 @@ module MetronomeSDK
           archived_at: Time,
           balance: Float,
           contract: MetronomeSDK::Commit::Contract::OrHash,
+          cost_basis: Float,
           created_by: String,
           custom_fields: T::Hash[Symbol, String],
           description: String,
@@ -365,6 +373,8 @@ module MetronomeSDK
         # included in the balance, including future-dated manual ledger entries.
         balance: nil,
         contract: nil,
+        # The ratio of the amount paid for the commit to the amount of credit granted.
+        cost_basis: nil,
         # The actor who created this commit. Omitted for system-generated commits such as
         # recurring commits, rollover commits, and threshold commits.
         created_by: nil,
@@ -426,6 +436,7 @@ module MetronomeSDK
             archived_at: Time,
             balance: Float,
             contract: MetronomeSDK::Commit::Contract,
+            cost_basis: Float,
             created_by: String,
             custom_fields: T::Hash[Symbol, String],
             description: String,

data/rbi/metronome_sdk/models/contract.rbi

@@ -48,7 +48,6 @@ module MetronomeSDK
       sig { params(custom_fields: T::Hash[Symbol, String]).void }
       attr_writer :custom_fields
 
-      # The billing provider configuration associated with a contract.
       sig do
         returns(
           T.nilable(
@@ -183,7 +182,6 @@ module MetronomeSDK
         archived_at: nil,
         # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         custom_fields: nil,
-        # The billing provider configuration associated with a contract.
         customer_billing_provider_configuration: nil,
         # ID of the package this contract was created from, if applicable.
         package_id: nil,
@@ -567,9 +565,15 @@ module MetronomeSDK
             )
           end
 
+        # ID of this configuration; can be provided as the
+        # billing_provider_configuration_id when creating a contract.
+        sig { returns(String) }
+        attr_accessor :id
+
         sig { returns(T.nilable(Time)) }
         attr_accessor :archived_at
 
+        # The billing provider set for this configuration.
         sig do
           returns(
             MetronomeSDK::Contract::CustomerBillingProviderConfiguration::BillingProvider::TaggedSymbol
@@ -577,6 +581,15 @@ module MetronomeSDK
         end
         attr_accessor :billing_provider
 
+        # Configuration for the billing provider. The structure of this object is specific
+        # to the billing provider.
+        sig { returns(T::Hash[Symbol, T.anything]) }
+        attr_accessor :configuration
+
+        sig { returns(String) }
+        attr_accessor :customer_id
+
+        # The method to use for delivering invoices to this customer.
         sig do
           returns(
             MetronomeSDK::Contract::CustomerBillingProviderConfiguration::DeliveryMethod::TaggedSymbol
@@ -584,59 +597,70 @@ module MetronomeSDK
         end
         attr_accessor :delivery_method
 
-        sig { returns(T.nilable(String)) }
-        attr_reader :id
-
-        sig { params(id: String).void }
-        attr_writer :id
-
-        # Configuration for the billing provider. The structure of this object is specific
-        # to the billing provider.
-        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-        attr_reader :configuration
+        # Configuration for the delivery method. The structure of this object is specific
+        # to the delivery method.
+        sig { returns(T::Hash[Symbol, T.anything]) }
+        attr_accessor :delivery_method_configuration
 
-        sig { params(configuration: T::Hash[Symbol, T.anything]).void }
-        attr_writer :configuration
+        # ID of the delivery method to use for this customer.
+        sig { returns(String) }
+        attr_accessor :delivery_method_id
 
-        # The billing provider configuration associated with a contract.
         sig do
           params(
+            id: String,
             archived_at: T.nilable(Time),
             billing_provider:
               MetronomeSDK::Contract::CustomerBillingProviderConfiguration::BillingProvider::OrSymbol,
+            configuration: T::Hash[Symbol, T.anything],
+            customer_id: String,
             delivery_method:
               MetronomeSDK::Contract::CustomerBillingProviderConfiguration::DeliveryMethod::OrSymbol,
-            id: String,
-            configuration: T::Hash[Symbol, T.anything]
+            delivery_method_configuration: T::Hash[Symbol, T.anything],
+            delivery_method_id: String
           ).returns(T.attached_class)
         end
         def self.new(
+          # ID of this configuration; can be provided as the
+          # billing_provider_configuration_id when creating a contract.
+          id:,
           archived_at:,
+          # The billing provider set for this configuration.
           billing_provider:,
-          delivery_method:,
-          id: nil,
           # Configuration for the billing provider. The structure of this object is specific
           # to the billing provider.
-          configuration: nil
+          configuration:,
+          customer_id:,
+          # The method to use for delivering invoices to this customer.
+          delivery_method:,
+          # Configuration for the delivery method. The structure of this object is specific
+          # to the delivery method.
+          delivery_method_configuration:,
+          # ID of the delivery method to use for this customer.
+          delivery_method_id:
         )
         end
 
         sig do
           override.returns(
             {
+              id: String,
               archived_at: T.nilable(Time),
               billing_provider:
                 MetronomeSDK::Contract::CustomerBillingProviderConfiguration::BillingProvider::TaggedSymbol,
+              configuration: T::Hash[Symbol, T.anything],
+              customer_id: String,
               delivery_method:
                 MetronomeSDK::Contract::CustomerBillingProviderConfiguration::DeliveryMethod::TaggedSymbol,
-              id: String,
-              configuration: T::Hash[Symbol, T.anything]
+              delivery_method_configuration: T::Hash[Symbol, T.anything],
+              delivery_method_id: String
             }
           )
         end
         def to_hash
         end
 
+        # The billing provider set for this configuration.
         module BillingProvider
           extend MetronomeSDK::Internal::Type::Enum
 
@@ -706,6 +730,7 @@ module MetronomeSDK
           end
         end
 
+        # The method to use for delivering invoices to this customer.
         module DeliveryMethod
           extend MetronomeSDK::Internal::Type::Enum