metronome-sdk 3.5.0 → 3.7.0

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

@@ -22,8 +22,8 @@ module MetronomeSDK
         #
         # Contracts define a customer's products, pricing, discounts, access duration, and
         # billing configuration. Contracts serve as the central billing agreement for both
-        # PLG and Enterprise customers, you can automatically customers access to your
-        # products and services directly from your product or CRM.
+        # PLG and Enterprise customers. You can automatically grant customers access to
+        # your products and services directly from your product or CRM.
         #
         # ### Use this endpoint to:
         #
@@ -144,7 +144,7 @@ module MetronomeSDK
         #   `usage_filters` to route the correct usage to each contract.
         #   [Read more about usage filters](https://docs.metronome.com/manage-product-access/provision-customer/#create-a-usage-filter).
         #
-        # @overload create(customer_id:, starting_at:, billing_provider_configuration: nil, commits: nil, credits: nil, custom_fields: nil, discounts: nil, ending_before: nil, hierarchy_configuration: nil, multiplier_override_prioritization: nil, name: nil, net_payment_terms_days: nil, netsuite_sales_order_id: nil, overrides: nil, package_alias: nil, package_id: nil, prepaid_balance_threshold_configuration: nil, professional_services: nil, rate_card_alias: nil, rate_card_id: nil, recurring_commits: nil, recurring_credits: nil, reseller_royalties: nil, revenue_system_configuration: nil, salesforce_opportunity_id: nil, scheduled_charges: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, subscriptions: nil, total_contract_value: nil, transition: nil, uniqueness_key: nil, usage_filter: nil, usage_statement_schedule: nil, request_options: {})
+        # @overload create(customer_id:, starting_at:, billing_provider_configuration: nil, commits: nil, credits: nil, custom_fields: nil, discounts: nil, ending_before: nil, hierarchy_configuration: nil, multiplier_override_prioritization: nil, name: nil, net_payment_terms_days: nil, netsuite_sales_order_id: nil, overrides: nil, package_alias: nil, package_id: nil, prepaid_balance_threshold_configuration: nil, professional_services: nil, rate_card_alias: nil, rate_card_id: nil, recurring_commits: nil, recurring_credits: nil, reseller_royalties: nil, revenue_system_configuration: nil, salesforce_opportunity_id: nil, scheduled_charges: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, spend_trackers: nil, subscriptions: nil, total_contract_value: nil, transition: nil, uniqueness_key: nil, usage_filter: nil, usage_statement_schedule: nil, request_options: {})
         #
         # @param customer_id [String]
         #
@@ -202,6 +202,8 @@ module MetronomeSDK
         #
         # @param spend_threshold_configuration [MetronomeSDK::Models::SpendThresholdConfiguration]
         #
+        # @param spend_trackers [Array<MetronomeSDK::Models::V1::ContractCreateParams::SpendTracker>] Spend trackers to attach to this contract. Aliases must be unique within a contr
+        #
         # @param subscriptions [Array<MetronomeSDK::Models::V1::ContractCreateParams::Subscription>] Optional list of [subscriptions](https://docs.metronome.com/manage-product-acces
         #
         # @param total_contract_value [Float] This field's availability is dependent on your client's configuration.
@@ -650,6 +652,73 @@ module MetronomeSDK
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {MetronomeSDK::Models::V1::ContractListSeatBalancesParams} for more details.
+        #
+        # Retrieve detailed balance for seat-based credits and commits from the contract's
+        # subscriptions, broken down by individual seats.
+        #
+        # ### Use this endpoint to:
+        #
+        # - Display per-seat balance information in customer dashboards
+        # - Filter balance data by subscription or specific seats
+        #
+        # ### Key response fields:
+        #
+        # An array of seat balance objects containing:
+        #
+        # - Seat id
+        # - Balance: current total balance across all commits and credits
+        #
+        # ### Usage guidelines:
+        #
+        # - Date filtering: use `covering_date` OR `starting_at`/`ending_before` to filter
+        #   balance data by time range
+        # - Set `include_credits_and_commits=true` for detailed commits and credits
+        #   breakdown per seat
+        # - Set `include_ledgers=true` for detailed transaction history per commit/credit
+        #   per seat
+        #
+        # @overload list_seat_balances(contract_id:, customer_id:, covering_date: nil, cursor: nil, effective_before: nil, include_credits_and_commits: nil, include_ledgers: nil, limit: nil, seat_ids: nil, starting_at: nil, subscription_ids: nil, request_options: {})
+        #
+        # @param contract_id [String] The contract ID to retrieve seat balances for
+        #
+        # @param customer_id [String] The customer ID to retrieve seat balances for
+        #
+        # @param covering_date [Time] Include only commits or credits with access that cover this specific date (canno
+        #
+        # @param cursor [String] Page token from a previous response to retrieve the next page
+        #
+        # @param effective_before [Time] Include only commits or credits with access effective on or before this date (ca
+        #
+        # @param include_credits_and_commits [Boolean] Include credits and commits in the response
+        #
+        # @param include_ledgers [Boolean] Include ledger entries for each commit and commit. `include_credits_and_commits`
+        #
+        # @param limit [Integer] Maximum number of seats to return. Range: 1-100. Default: 25.
+        #
+        # @param seat_ids [Array<String>] Optional filter to only include specific seats.
+        #
+        # @param starting_at [Time] Include only commits or credits with access effective on or after this date (can
+        #
+        # @param subscription_ids [Array<String>] Optional filter to only include seats from specific subscriptions. If subscripti
+        #
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MetronomeSDK::Models::V1::ContractListSeatBalancesResponse]
+        #
+        # @see MetronomeSDK::Models::V1::ContractListSeatBalancesParams
+        def list_seat_balances(params)
+          parsed, options = MetronomeSDK::V1::ContractListSeatBalancesParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/contracts/seatBalances/list",
+            body: parsed,
+            model: MetronomeSDK::Models::V1::ContractListSeatBalancesResponse,
+            options: options
+          )
+        end
+
         # Some parameter documentations has been truncated, see
         # {MetronomeSDK::Models::V1::ContractRetrieveRateScheduleParams} for more details.
         #

data/lib/metronome_sdk/resources/v1/customers/invoices.rb

@@ -136,10 +136,12 @@ module MetronomeSDK
           # - Voided invoices are included in results by default unless filtered out by
           #   status
           #
-          # @overload list(customer_id:, credit_type_id: nil, ending_before: nil, limit: nil, next_page: nil, skip_zero_qty_line_items: nil, sort: nil, starting_on: nil, status: nil, request_options: {})
+          # @overload list(customer_id:, contract_id: nil, credit_type_id: nil, ending_before: nil, limit: nil, next_page: nil, skip_zero_qty_line_items: nil, sort: nil, starting_on: nil, status: nil, type: nil, request_options: {})
           #
           # @param customer_id [String] Path param
           #
+          # @param contract_id [String] Query param: Only return invoices for the specified contract
+          #
           # @param credit_type_id [String] Query param: Only return invoices for the specified credit type
           #
           # @param ending_before [Time] Query param: RFC 3339 timestamp (exclusive). Invoices will only be returned for
@@ -156,6 +158,8 @@ module MetronomeSDK
           #
           # @param status [String] Query param: Invoice status, e.g. DRAFT, FINALIZED, or VOID
           #
+          # @param type [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListParams::Type] Query param: Filter invoices by type. Defaults to returning all invoice types.
+          #
           # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
           #
           # @return [MetronomeSDK::Internal::CursorPage<MetronomeSDK::Models::V1::Customers::Invoice>]

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

@@ -58,14 +58,12 @@ module MetronomeSDK
         #   provisioning with a package. Edited contracts will still be associated with
         #   the package used during provisioning.
         #
-        # @overload create(name:, aliases: nil, billing_anchor_date: nil, billing_provider: nil, commits: nil, contract_name: nil, credits: nil, delivery_method: nil, duration: nil, multiplier_override_prioritization: nil, net_payment_terms_days: nil, overrides: nil, prepaid_balance_threshold_configuration: nil, rate_card_alias: nil, rate_card_id: nil, recurring_commits: nil, recurring_credits: nil, scheduled_charges: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, subscriptions: nil, uniqueness_key: nil, usage_statement_schedule: nil, request_options: {})
+        # @overload create(name:, aliases: nil, billing_provider: nil, commits: nil, contract_name: nil, credits: nil, delivery_method: nil, duration: nil, multiplier_override_prioritization: nil, net_payment_terms_days: nil, overrides: nil, prepaid_balance_threshold_configuration: nil, rate_card_alias: nil, rate_card_id: nil, recurring_commits: nil, recurring_credits: nil, scheduled_charges: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, spend_trackers: nil, subscriptions: nil, uniqueness_key: nil, usage_statement_schedule: nil, request_options: {})
         #
         # @param name [String]
         #
         # @param aliases [Array<MetronomeSDK::Models::V1::PackageCreateParams::Alias>] Reference this alias when creating a contract. If the same alias is assigned to
         #
-        # @param billing_anchor_date [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::BillingAnchorDate]
-        #
         # @param billing_provider [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::BillingProvider]
         #
         # @param commits [Array<MetronomeSDK::Models::V1::PackageCreateParams::Commit>]
@@ -100,6 +98,8 @@ module MetronomeSDK
         #
         # @param spend_threshold_configuration [MetronomeSDK::Models::SpendThresholdConfiguration]
         #
+        # @param spend_trackers [Array<MetronomeSDK::Models::V1::PackageCreateParams::SpendTracker>]
+        #
         # @param subscriptions [Array<MetronomeSDK::Models::V1::PackageCreateParams::Subscription>]
         #
         # @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
@@ -218,10 +218,9 @@ module MetronomeSDK
         #
         # ### **Usage guidelines:**
         #
-        # Use the **`starting_at`**, **`covering_date`**,
-        # and **`include_archived`** parameters to filter the list of returned contracts.
-        # For example, to list only currently active contracts,
-        # pass **`covering_date`** equal to the current time.
+        # Use the **`starting_at`**, **`covering_date`**, and **`include_archived`**
+        # parameters to filter the list of returned contracts. For example, to list only
+        # currently active contracts, pass **`covering_date`** equal to the current time.
         #
         # @overload list_contracts_on_package(package_id:, limit: nil, next_page: nil, covering_date: nil, include_archived: nil, starting_at: nil, request_options: {})
         #

data/lib/metronome_sdk/resources/v1.rb

@@ -80,9 +80,6 @@ module MetronomeSDK
       # @return [MetronomeSDK::Resources::V1::Packages]
       attr_reader :packages
 
-      # @return [MetronomeSDK::Resources::V1::Payments]
-      attr_reader :payments
-
       # Use these endpoints to configure a billing API key, a webhook secret, or invoice
       # finalization behavior.
       # @return [MetronomeSDK::Resources::V1::Settings]
@@ -107,7 +104,6 @@ module MetronomeSDK
         @invoices = MetronomeSDK::Resources::V1::Invoices.new(client: client)
         @contracts = MetronomeSDK::Resources::V1::Contracts.new(client: client)
         @packages = MetronomeSDK::Resources::V1::Packages.new(client: client)
-        @payments = MetronomeSDK::Resources::V1::Payments.new(client: client)
         @settings = MetronomeSDK::Resources::V1::Settings.new(client: client)
       end
     end

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

@@ -128,7 +128,7 @@ module MetronomeSDK
         # - Contract editing must be enabled to use this endpoint. Reach out to your
         #   Metronome representative to learn more.
         #
-        # @overload edit(contract_id:, customer_id:, add_billing_provider_configuration_update: nil, add_commits: nil, add_credits: nil, add_discounts: nil, add_overrides: nil, add_prepaid_balance_threshold_configuration: nil, add_professional_services: nil, add_recurring_commits: nil, add_recurring_credits: nil, add_reseller_royalties: nil, add_revenue_system_configuration_update: nil, add_scheduled_charges: nil, add_spend_threshold_configuration: nil, add_subscriptions: nil, allow_contract_ending_before_finalized_invoice: nil, archive_commits: nil, archive_credits: nil, archive_scheduled_charges: nil, remove_overrides: nil, uniqueness_key: nil, update_commits: nil, update_contract_end_date: nil, update_contract_name: nil, update_credits: nil, update_net_payment_terms_days: nil, update_prepaid_balance_threshold_configuration: nil, update_recurring_commits: nil, update_recurring_credits: nil, update_scheduled_charges: nil, update_spend_threshold_configuration: nil, update_subscriptions: nil, request_options: {})
+        # @overload edit(contract_id:, customer_id:, add_billing_provider_configuration_update: nil, add_commits: nil, add_credits: nil, add_discounts: nil, add_overrides: nil, add_prepaid_balance_threshold_configuration: nil, add_professional_services: nil, add_recurring_commits: nil, add_recurring_credits: nil, add_reseller_royalties: nil, add_revenue_system_configuration_update: nil, add_scheduled_charges: nil, add_spend_threshold_configuration: nil, add_spend_trackers: nil, add_subscriptions: nil, allow_contract_ending_before_finalized_invoice: nil, archive_commits: nil, archive_credits: nil, archive_scheduled_charges: nil, archive_spend_trackers: nil, remove_overrides: nil, uniqueness_key: nil, update_commits: nil, update_contract_end_date: nil, update_contract_name: nil, update_credits: nil, update_net_payment_terms_days: nil, update_prepaid_balance_threshold_configuration: nil, update_recurring_commits: nil, update_recurring_credits: nil, update_scheduled_charges: nil, update_spend_threshold_configuration: nil, update_subscriptions: nil, request_options: {})
         #
         # @param contract_id [String] ID of the contract being edited
         #
@@ -160,6 +160,8 @@ module MetronomeSDK
         #
         # @param add_spend_threshold_configuration [MetronomeSDK::Models::SpendThresholdConfigurationV2]
         #
+        # @param add_spend_trackers [Array<MetronomeSDK::Models::V2::ContractEditParams::AddSpendTracker>] Spend trackers to add to this contract. Aliases must be unique within a contract
+        #
         # @param add_subscriptions [Array<MetronomeSDK::Models::V2::ContractEditParams::AddSubscription>] Optional list of [subscriptions](https://docs.metronome.com/manage-product-acces
         #
         # @param allow_contract_ending_before_finalized_invoice [Boolean] If true, allows setting the contract end date earlier than the end_timestamp of
@@ -170,6 +172,8 @@ module MetronomeSDK
         #
         # @param archive_scheduled_charges [Array<MetronomeSDK::Models::V2::ContractEditParams::ArchiveScheduledCharge>] IDs of scheduled charges to archive
         #
+        # @param archive_spend_trackers [Array<String>] Aliases of spend trackers to archive.
+        #
         # @param remove_overrides [Array<MetronomeSDK::Models::V2::ContractEditParams::RemoveOverride>] IDs of overrides to remove
         #
         # @param uniqueness_key [String] Optional uniqueness key to prevent duplicate contract edits.

data/lib/metronome_sdk/version.rb

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

data/lib/metronome_sdk.rb

@@ -121,6 +121,8 @@ require_relative "metronome_sdk/models/v1/contract_list_balances_params"
 require_relative "metronome_sdk/models/v1/contract_list_balances_response"
 require_relative "metronome_sdk/models/v1/contract_list_params"
 require_relative "metronome_sdk/models/v1/contract_list_response"
+require_relative "metronome_sdk/models/v1/contract_list_seat_balances_params"
+require_relative "metronome_sdk/models/v1/contract_list_seat_balances_response"
 require_relative "metronome_sdk/models/v1/contract_retrieve_params"
 require_relative "metronome_sdk/models/v1/contract_retrieve_rate_schedule_params"
 require_relative "metronome_sdk/models/v1/contract_retrieve_rate_schedule_response"
@@ -269,13 +271,6 @@ require_relative "metronome_sdk/models/v1/package_list_params"
 require_relative "metronome_sdk/models/v1/package_list_response"
 require_relative "metronome_sdk/models/v1/package_retrieve_params"
 require_relative "metronome_sdk/models/v1/package_retrieve_response"
-require_relative "metronome_sdk/models/v1/payment"
-require_relative "metronome_sdk/models/v1/payment_attempt_params"
-require_relative "metronome_sdk/models/v1/payment_attempt_response"
-require_relative "metronome_sdk/models/v1/payment_cancel_params"
-require_relative "metronome_sdk/models/v1/payment_cancel_response"
-require_relative "metronome_sdk/models/v1/payment_list_params"
-require_relative "metronome_sdk/models/v1/payment_status"
 require_relative "metronome_sdk/models/v1/plan_detail"
 require_relative "metronome_sdk/models/v1/plan_get_details_params"
 require_relative "metronome_sdk/models/v1/plan_get_details_response"
@@ -341,7 +336,6 @@ require_relative "metronome_sdk/resources/v1/custom_fields"
 require_relative "metronome_sdk/resources/v1/dashboards"
 require_relative "metronome_sdk/resources/v1/invoices"
 require_relative "metronome_sdk/resources/v1/packages"
-require_relative "metronome_sdk/resources/v1/payments"
 require_relative "metronome_sdk/resources/v1/plans"
 require_relative "metronome_sdk/resources/v1/pricing_units"
 require_relative "metronome_sdk/resources/v1/services"

data/rbi/metronome_sdk/models/commit.rbi

@@ -237,6 +237,18 @@ module MetronomeSDK
       end
       attr_writer :specifiers
 
+      # Optional attributes controlling how this commit interacts with spend trackers.
+      sig { returns(T.nilable(MetronomeSDK::Commit::SpendTrackerAttributes)) }
+      attr_reader :spend_tracker_attributes
+
+      sig do
+        params(
+          spend_tracker_attributes:
+            MetronomeSDK::Commit::SpendTrackerAttributes::OrHash
+        ).void
+      end
+      attr_writer :spend_tracker_attributes
+
       # The subscription configuration for this commit, if it was generated from a
       # recurring commit with a subscription attached.
       sig { returns(T.nilable(MetronomeSDK::Commit::SubscriptionConfig)) }
@@ -307,6 +319,8 @@ module MetronomeSDK
           rollover_fraction: Float,
           salesforce_opportunity_id: String,
           specifiers: T::Array[MetronomeSDK::CommitSpecifier::OrHash],
+          spend_tracker_attributes:
+            MetronomeSDK::Commit::SpendTrackerAttributes::OrHash,
           subscription_config: MetronomeSDK::Commit::SubscriptionConfig::OrHash,
           uniqueness_key: String
         ).returns(T.attached_class)
@@ -372,6 +386,8 @@ module MetronomeSDK
         # or credit. A customer's usage needs to meet the condition of at least one of the
         # specifiers to contribute to a commit's or credit's drawdown.
         specifiers: nil,
+        # Optional attributes controlling how this commit interacts with spend trackers.
+        spend_tracker_attributes: nil,
         # The subscription configuration for this commit, if it was generated from a
         # recurring commit with a subscription attached.
         subscription_config: nil,
@@ -413,6 +429,8 @@ module MetronomeSDK
             rollover_fraction: Float,
             salesforce_opportunity_id: String,
             specifiers: T::Array[MetronomeSDK::CommitSpecifier],
+            spend_tracker_attributes:
+              MetronomeSDK::Commit::SpendTrackerAttributes,
             subscription_config: MetronomeSDK::Commit::SubscriptionConfig,
             uniqueness_key: String
           }
@@ -1824,6 +1842,36 @@ module MetronomeSDK
         end
       end
 
+      class SpendTrackerAttributes < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::Commit::SpendTrackerAttributes,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        # If true, this commit is included in spend trackers with discounted set to
+        # DISCOUNTED_ONLY
+        sig { returns(T::Boolean) }
+        attr_accessor :counts_as_discounted
+
+        # Optional attributes controlling how this commit interacts with spend trackers.
+        sig do
+          params(counts_as_discounted: T::Boolean).returns(T.attached_class)
+        end
+        def self.new(
+          # If true, this commit is included in spend trackers with discounted set to
+          # DISCOUNTED_ONLY
+          counts_as_discounted:
+        )
+        end
+
+        sig { override.returns({ counts_as_discounted: T::Boolean }) }
+        def to_hash
+        end
+      end
+
       class SubscriptionConfig < MetronomeSDK::Internal::Type::BaseModel
         OrHash =
           T.type_alias do