metronome-sdk 3.7.0 → 3.8.0

data/rbi/metronome_sdk/resources/v1/alerts.rbi

@@ -60,6 +60,10 @@ module MetronomeSDK
               MetronomeSDK::V1::AlertCreateParams::AlertType::OrSymbol,
             name: String,
             threshold: Float,
+            alert_specifiers:
+              T::Array[
+                MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::OrHash
+              ],
             billable_metric_id: String,
             credit_grant_type_filters: T::Array[String],
             credit_type_id: String,
@@ -88,6 +92,10 @@ module MetronomeSDK
           # type, this number may represent a financial amount, the days remaining, or a
           # percentage reached.
           threshold:,
+          # Can be used with only `low_remaining_contract_credit_and_commit_balance_reached`
+          # notifications. Defines the balances that are considered when evaluating the
+          # alert.
+          alert_specifiers: nil,
           # For threshold notifications of type `usage_threshold_reached`, specifies which
           # billable metric to track the usage for.
           billable_metric_id: nil,

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

@@ -51,6 +51,10 @@ module MetronomeSDK
             end
 
             # Add a new rate
+            #
+            # This endpoint is heavily rate limited. For adding multiple rates, using the
+            # [addRates](https://docs.metronome.com/api-reference/rate-cards/add-rates)
+            # endpoint is strongly encouraged.
             sig do
               params(
                 entitled: T::Boolean,

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

@@ -616,6 +616,72 @@ module MetronomeSDK
         )
         end
 
+        # Get the history of subscription seats schedule over time for a given
+        # `subscription_id`. This endpoint provides information about seat assignments and
+        # total quantities for different time periods, allowing you to track how seat
+        # assignments have changed over time.
+        #
+        # ### Use this endpoint to:
+        #
+        # - Track changes to seat assignments over time
+        # - Get seat schedule for a specific date using the `covering_date` parameter
+        # - Get seat schedule history with optional date range filtering using
+        #   `starting_at` and `ending_before`
+        #
+        # ### Key response fields:
+        #
+        # - data: array of seat schedule entries with time periods, quantity, and
+        #   assignments
+        # - next_page: cursor for pagination to retrieve additional results
+        #
+        # ### Usage guidelines:
+        #
+        # - Use `covering_date` to get the active seats for a specific point in time.
+        #   `covering_date` cannot be used with `starting_at` or `ending_before`.
+        # - Use `starting_at` and `ending_before` to filter results by time range.
+        #   `starting_at` and `ending_before` cannot be used with `covering_date`.
+        # - Maximum limit is 10 seat schedule entries per request
+        # - Results are ordered by `starting_at` timestamp
+        sig do
+          params(
+            contract_id: String,
+            customer_id: String,
+            subscription_id: String,
+            covering_date: T.nilable(Time),
+            cursor: T.nilable(String),
+            ending_before: T.nilable(Time),
+            limit: T.nilable(Integer),
+            starting_at: T.nilable(Time),
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(
+            MetronomeSDK::Models::V1::ContractGetSubscriptionSeatsHistoryResponse
+          )
+        end
+        def get_subscription_seats_history(
+          contract_id:,
+          customer_id:,
+          subscription_id:,
+          # Get the seats history segment for the covering date. Cannot be used with
+          # `starting_at` or `ending_before`.
+          covering_date: nil,
+          # Cursor for pagination. Use the value from the `next_page` field of the previous
+          # response to retrieve the next page of results.
+          cursor: nil,
+          # Include seats history segments that are active at or before this timestamp. Use
+          # with `starting_at` to get a specific time range. If not set, there's no upper
+          # bound.
+          ending_before: nil,
+          # Maximum number of seat schedule entries to return. Defaults to 10. Required
+          # range: 1 <= x <= 10.
+          limit: nil,
+          # Include seats history segments that are active at or after this timestamp. Use
+          # with `ending_before` to get a specific time range. If not set, there's no lower
+          # bound.
+          starting_at: nil,
+          request_options: {}
+        )
+        end
+
         # Retrieve a comprehensive view of all available balances (commits and credits)
         # for a customer. This endpoint provides real-time visibility into prepaid funds,
         # postpaid commitments, promotional credits, and other balance types that can
@@ -737,6 +803,7 @@ module MetronomeSDK
             include_ledgers: T::Boolean,
             limit: Integer,
             seat_ids: T::Array[String],
+            skip_missing_seat_ids: T::Boolean,
             starting_at: Time,
             subscription_ids: T::Array[String],
             request_options: MetronomeSDK::RequestOptions::OrHash
@@ -770,6 +837,9 @@ module MetronomeSDK
           limit: nil,
           # Optional filter to only include specific seats.
           seat_ids: nil,
+          # When true, any seat_ids not found in contract subscriptions will be silently
+          # omitted from the response instead of returning a 400 error.
+          skip_missing_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,

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

@@ -44,11 +44,11 @@ module MetronomeSDK
           # - `null` - Notification has been archived
           # - `triggered_by`: Additional context about what caused the notification to
           #   trigger (when applicable)
+          # - `updated_at`: Timestamp of when the `customer_status` was last updated
           # - alert: Complete threshold notification configuration including:
           #   - Notification ID, name, and type
           #   - Current threshold values and credit type information
           #   - Notification status (enabled, disabled, or archived)
-          #   - Last update timestamp
           #   - Any applied filters (credit grant types, custom fields, group values)
           #
           # ### Usage guidelines:
@@ -69,6 +69,10 @@ module MetronomeSDK
             params(
               alert_id: String,
               customer_id: String,
+              alert_specifiers:
+                T::Array[
+                  MetronomeSDK::V1::Customers::AlertRetrieveParams::AlertSpecifier::OrHash
+                ],
               group_values:
                 T::Array[
                   MetronomeSDK::V1::Customers::AlertRetrieveParams::GroupValue::OrHash
@@ -87,6 +91,9 @@ module MetronomeSDK
             alert_id:,
             # The Metronome ID of the customer
             customer_id:,
+            # Can be used with only `low_remaining_contract_credit_and_commit_balance_reached`
+            # notifications. Used to filter the alert by the custom field key-value pair.
+            alert_specifiers: nil,
             # Only present for `spend_threshold_reached` notifications. Retrieve the
             # notification for a specific group key-value pair.
             group_values: nil,

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

@@ -132,6 +132,7 @@ module MetronomeSDK
               status: String,
               type:
                 MetronomeSDK::V1::Customers::InvoiceListParams::Type::OrSymbol,
+              webhook_notification_id: String,
               request_options: MetronomeSDK::RequestOptions::OrHash
             ).returns(
               MetronomeSDK::Internal::CursorPage[
@@ -166,6 +167,9 @@ module MetronomeSDK
             status: nil,
             # Query param: Filter invoices by type. Defaults to returning all invoice types.
             type: nil,
+            # Query param: Indicates that this API request was triggered by a webhook
+            # notification with the provided ID.
+            webhook_notification_id: nil,
             request_options: {}
           )
           end

data/rbi/metronome_sdk/resources/v1/dashboards.rbi

@@ -30,8 +30,13 @@ module MetronomeSDK
         #
         # - Dashboard types: Choose from `invoices`, `usage`, or `commits_and_credits`
         # - Customization options:
-        #   - `dashboard_options`: Configure whether you want invoices to show zero usage
-        #     line items
+        #   - `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")
         #   - `color_overrides`: Match your brand's color palette
         #   - `bm_group_key_overrides`: Customize how dimensions are displayed (for the
         #     usage embeddable dashboard)

data/sig/metronome_sdk/models/commit.rbs

@@ -14,6 +14,7 @@ module MetronomeSDK
         archived_at: Time,
         balance: Float,
         contract: MetronomeSDK::Commit::Contract,
+        created_by: String,
         custom_fields: ::Hash[Symbol, String],
         description: String,
         hierarchy_configuration: MetronomeSDK::CommitHierarchyConfiguration,
@@ -79,6 +80,10 @@ module MetronomeSDK
         MetronomeSDK::Commit::Contract
       ) -> MetronomeSDK::Commit::Contract
 
+      attr_reader created_by: String?
+
+      def created_by=: (String) -> String
+
       attr_reader custom_fields: ::Hash[Symbol, String]?
 
       def custom_fields=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
@@ -182,6 +187,7 @@ module MetronomeSDK
         ?archived_at: Time,
         ?balance: Float,
         ?contract: MetronomeSDK::Commit::Contract,
+        ?created_by: String,
         ?custom_fields: ::Hash[Symbol, String],
         ?description: String,
         ?hierarchy_configuration: MetronomeSDK::CommitHierarchyConfiguration,
@@ -215,6 +221,7 @@ module MetronomeSDK
         archived_at: Time,
         balance: Float,
         contract: MetronomeSDK::Commit::Contract,
+        created_by: String,
         custom_fields: ::Hash[Symbol, String],
         description: String,
         hierarchy_configuration: MetronomeSDK::CommitHierarchyConfiguration,