metronome-sdk 3.4.0 → 3.6.0

data/rbi/metronome_sdk/resources/v1/contracts/products.rbi

@@ -34,6 +34,8 @@ module MetronomeSDK
                 T.nilable(
                   MetronomeSDK::V1::Contracts::QuantityRounding::OrHash
                 ),
+              sql_breakdown_granularity:
+                MetronomeSDK::V1::Contracts::ProductCreateParams::SqlBreakdownGranularity::OrSymbol,
               tags: T::Array[String],
               request_options: MetronomeSDK::RequestOptions::OrHash
             ).returns(
@@ -84,6 +86,13 @@ module MetronomeSDK
             # the method is "round up" and the decimal places is 0, then the quantity will be
             # rounded up to the nearest integer.
             quantity_rounding: nil,
+            # Defines the breakdown behavior when calculating usage from SQL Billable Metrics.
+            # If set to 'service_period' (default), the usage will be evaluated once for all
+            # events the invoice service period and the usage will be applied at the last
+            # instant of the invoice. If set to 'hour', it will be broken down and evaluated
+            # for each hour. For most use cases, 'hour' is recommended. The setting has no
+            # effect for Streaming Billable Metrics.
+            sql_breakdown_granularity: nil,
             tags: nil,
             request_options: {}
           )
@@ -134,6 +143,8 @@ module MetronomeSDK
                 T.nilable(
                   MetronomeSDK::V1::Contracts::QuantityRounding::OrHash
                 ),
+              sql_breakdown_granularity:
+                MetronomeSDK::V1::Contracts::ProductUpdateParams::SqlBreakdownGranularity::OrSymbol,
               tags: T::Array[String],
               request_options: MetronomeSDK::RequestOptions::OrHash
             ).returns(
@@ -192,6 +203,13 @@ module MetronomeSDK
             # the method is "round up" and the decimal places is 0, then the quantity will be
             # rounded up to the nearest integer.
             quantity_rounding: nil,
+            # Defines the breakdown behavior when calculating usage from SQL Billable Metrics.
+            # If set to 'service_period' (default), the usage will be evaluated once for all
+            # events the invoice service period and the usage will be applied at the last
+            # instant of the invoice. If set to 'hour', it will be broken down and evaluated
+            # for each hour. For most use cases, 'hour' is recommended. The setting has no
+            # effect for Streaming Billable Metrics.
+            sql_breakdown_granularity: nil,
             # If not provided, defaults to product's current tags
             tags: nil,
             request_options: {}

data/rbi/metronome_sdk/resources/v1/contracts.rbi

@@ -19,8 +19,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:
         #
@@ -245,7 +245,7 @@ module MetronomeSDK
           package_alias: nil,
           # If provided, provisions a customer on a package instead of creating a
           # traditional contract. When specified, only customer_id, starting_at, package_id,
-          # and uniqueness_key are allowed.
+          # uniqueness_key, transition, and custom_fields are allowed.
           package_id: nil,
           prepaid_balance_threshold_configuration: nil,
           # This field's availability is dependent on your client's configuration.
@@ -568,6 +568,10 @@ module MetronomeSDK
         #
         # ### Usage guidelines:
         #
+        # - **Balance ledger details**: Use the
+        #   [listBalances](https://docs.metronome.com/api-reference/credits-and-commits/list-balances)
+        #   endpoint instead to understand detailed ledger drawdowns for each individual
+        #   balance
         # - **Draft invoice handling**: Use `invoice_inclusion_mode` to control whether
         #   pending draft invoice deductions are included (`FINALIZED_AND_DRAFT`, the
         #   default) or excluded (`FINALIZED`) from the balance calculation
@@ -630,6 +634,9 @@ module MetronomeSDK
         #
         # ### Usage guidelines:
         #
+        # - Use the
+        #   [getNetBalance](https://docs.metronome.com/api-reference/credits-and-commits/get-the-net-balance-of-a-customer)
+        #   endpoint to retrieve a single combined current balance
         # - Date filtering: Use `effective_before` to include only balances with access
         #   before a specific date (exclusive)
         # - Set `include_balance=true` for calculated balance amounts on each commit or
@@ -689,6 +696,84 @@ module MetronomeSDK
         )
         end
 
+        # 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
+        sig do
+          params(
+            contract_id: String,
+            customer_id: String,
+            covering_date: Time,
+            cursor: String,
+            effective_before: Time,
+            include_credits_and_commits: T::Boolean,
+            include_ledgers: T::Boolean,
+            limit: Integer,
+            seat_ids: T::Array[String],
+            starting_at: Time,
+            subscription_ids: T::Array[String],
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(MetronomeSDK::Models::V1::ContractListSeatBalancesResponse)
+        end
+        def list_seat_balances(
+          # The contract ID to retrieve seat balances for
+          contract_id:,
+          # The customer ID to retrieve seat balances for
+          customer_id:,
+          # Include only commits or credits with access that cover this specific date
+          # (cannot be used with starting_at or ending_before).
+          covering_date: nil,
+          # Page token from a previous response to retrieve the next page
+          cursor: nil,
+          # Include only commits or credits with access effective on or before this date
+          # (cannot be used with covering_date).
+          effective_before: nil,
+          # Include credits and commits in the response
+          include_credits_and_commits: nil,
+          # Include ledger entries for each commit and commit. `include_credits_and_commits`
+          # must be set to `true` for `include_ledgers=true` to apply.
+          include_ledgers: nil,
+          # Maximum number of seats to return. Range: 1-100. Default: 25. When
+          # `include_credits_and_commits = true`, if the total commits/credits across all
+          # seats exceeds 100, a limit of 100 applies to the total credits and commits.
+          # Seats are included greedily to maximize the number of seats returned. Example:
+          # if seat 1 has 98 commits and seat 2 has 10 commits, both seats will be returned
+          # (total: 108 commits). Each returned seat includes all of its associated credits
+          # and commits.
+          limit: nil,
+          # Optional filter to only include specific seats.
+          seat_ids: nil,
+          # Include only commits or credits with access effective on or after this date
+          # (cannot be used with covering_date).
+          starting_at: nil,
+          # Optional filter to only include seats from specific subscriptions. If
+          # subscriptions ids are not mapped to SEAT_BASED subscriptions, error will be
+          # returned.
+          subscription_ids: nil,
+          request_options: {}
+        )
+        end
+
         # For a specific customer and contract, get the rates at a specific point in time.
         # This endpoint takes the contract's rate card into consideration, including
         # scheduled changes. It also takes into account overrides on the contract.

data/rbi/metronome_sdk/resources/v1/customers/invoices.rbi

@@ -120,6 +120,7 @@ module MetronomeSDK
           sig do
             params(
               customer_id: String,
+              contract_id: String,
               credit_type_id: String,
               ending_before: Time,
               limit: Integer,
@@ -129,6 +130,8 @@ module MetronomeSDK
                 MetronomeSDK::V1::Customers::InvoiceListParams::Sort::OrSymbol,
               starting_on: Time,
               status: String,
+              type:
+                MetronomeSDK::V1::Customers::InvoiceListParams::Type::OrSymbol,
               request_options: MetronomeSDK::RequestOptions::OrHash
             ).returns(
               MetronomeSDK::Internal::CursorPage[
@@ -139,6 +142,8 @@ module MetronomeSDK
           def list(
             # Path param
             customer_id:,
+            # Query param: Only return invoices for the specified contract
+            contract_id: nil,
             # Query param: Only return invoices for the specified credit type
             credit_type_id: nil,
             # Query param: RFC 3339 timestamp (exclusive). Invoices will only be returned for
@@ -159,6 +164,8 @@ module MetronomeSDK
             starting_on: nil,
             # Query param: Invoice status, e.g. DRAFT, FINALIZED, or VOID
             status: nil,
+            # Query param: Filter invoices by type. Defaults to returning all invoice types.
+            type: nil,
             request_options: {}
           )
           end

data/rbi/metronome_sdk/resources/v1/packages.rbi

@@ -59,8 +59,6 @@ module MetronomeSDK
             name: String,
             aliases:
               T::Array[MetronomeSDK::V1::PackageCreateParams::Alias::OrHash],
-            billing_anchor_date:
-              MetronomeSDK::V1::PackageCreateParams::BillingAnchorDate::OrSymbol,
             billing_provider:
               MetronomeSDK::V1::PackageCreateParams::BillingProvider::OrSymbol,
             commits:
@@ -112,7 +110,6 @@ module MetronomeSDK
           # multiple packages, it will reference the package to which it was most recently
           # assigned. It is not exposed to end customers.
           aliases: nil,
-          billing_anchor_date: nil,
           billing_provider: nil,
           commits: nil,
           contract_name: nil,

data/sig/metronome_sdk/internal/util.rbs

@@ -45,8 +45,12 @@ module MetronomeSDK
         -> top?
       } -> top?
 
+      RFC_3986_NOT_PCHARS: Regexp
+
       def self?.uri_origin: (URI::Generic uri) -> String
 
+      def self?.encode_path: (String | Integer path) -> String
+
       def self?.interpolate_path: (String | ::Array[String] path) -> String
 
       def self?.decode_query: (String? query) -> ::Hash[String, ::Array[String]]

data/sig/metronome_sdk/models/base_threshold_commit.rbs

@@ -1,7 +1,7 @@
 module MetronomeSDK
   module Models
     type base_threshold_commit =
-      { product_id: String, description: String, name: String }
+      { product_id: String, description: String, name: String, priority: Float }
 
     class BaseThresholdCommit < MetronomeSDK::Internal::Type::BaseModel
       attr_accessor product_id: String
@@ -14,13 +14,23 @@ module MetronomeSDK
 
       def name=: (String) -> String
 
+      attr_reader priority: Float?
+
+      def priority=: (Float) -> Float
+
       def initialize: (
         product_id: String,
         ?description: String,
-        ?name: String
+        ?name: String,
+        ?priority: Float
       ) -> void
 
-      def to_hash: -> { product_id: String, description: String, name: String }
+      def to_hash: -> {
+        product_id: String,
+        description: String,
+        name: String,
+        priority: Float
+      }
     end
   end
 end