metronome-sdk 3.7.0 → 3.9.0

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

@@ -58,7 +58,7 @@ module MetronomeSDK
         #   threshold notification evaluations in real-time as usage events stream in,
         #   unlike competitors who rely on periodic polling or batch evaluation cycles
         #
-        # @overload create(alert_type:, name:, threshold:, billable_metric_id: nil, credit_grant_type_filters: nil, credit_type_id: nil, custom_field_filters: nil, customer_id: nil, evaluate_on_create: nil, group_values: nil, invoice_types_filter: nil, plan_id: nil, seat_filter: nil, uniqueness_key: nil, request_options: {})
+        # @overload create(alert_type:, name:, threshold:, alert_specifiers: nil, billable_metric_id: nil, credit_grant_type_filters: nil, credit_type_id: nil, custom_field_filters: nil, customer_id: nil, evaluate_on_create: nil, group_values: nil, invoice_types_filter: nil, plan_id: nil, seat_filter: nil, uniqueness_key: nil, request_options: {})
         #
         # @param alert_type [Symbol, MetronomeSDK::Models::V1::AlertCreateParams::AlertType] Type of the threshold notification
         #
@@ -66,6 +66,8 @@ module MetronomeSDK
         #
         # @param threshold [Float] Threshold value of the notification policy. Depending upon the notification typ
         #
+        # @param alert_specifiers [Array<MetronomeSDK::Models::V1::AlertCreateParams::AlertSpecifier>] Can be used with only `low_remaining_contract_credit_and_commit_balance_reached`
+        #
         # @param billable_metric_id [String] For threshold notifications of type `usage_threshold_reached`, specifies which b
         #
         # @param credit_grant_type_filters [Array<String>] An array of strings, representing a way to filter the credit grant this threshol

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

@@ -59,6 +59,10 @@ module MetronomeSDK
             #
             # 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.
+            #
             # @overload add(entitled:, product_id:, rate_card_id:, rate_type:, starting_at:, billing_frequency: nil, commit_rate: nil, credit_type_id: nil, custom_rate: nil, ending_before: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil, request_options: {})
             #
             # @param entitled [Boolean]

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

@@ -568,6 +568,71 @@ module MetronomeSDK
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {MetronomeSDK::Models::V1::ContractGetSubscriptionSeatsHistoryParams} for more
+        # details.
+        #
+        # 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
+        #
+        # @overload get_subscription_seats_history(contract_id:, customer_id:, subscription_id:, covering_date: nil, cursor: nil, ending_before: nil, limit: nil, starting_at: nil, request_options: {})
+        #
+        # @param contract_id [String]
+        #
+        # @param customer_id [String]
+        #
+        # @param subscription_id [String]
+        #
+        # @param covering_date [Time, nil] Get the seats history segment for the covering date. Cannot be used with `starti
+        #
+        # @param cursor [String, nil] Cursor for pagination. Use the value from the `next_page` field of the previous
+        #
+        # @param ending_before [Time, nil] Include seats history segments that are active at or before this timestamp. Use
+        #
+        # @param limit [Integer, nil] Maximum number of seat schedule entries to return. Defaults to 10. Required rang
+        #
+        # @param starting_at [Time, nil] Include seats history segments that are active at or after this timestamp. Use w
+        #
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MetronomeSDK::Models::V1::ContractGetSubscriptionSeatsHistoryResponse]
+        #
+        # @see MetronomeSDK::Models::V1::ContractGetSubscriptionSeatsHistoryParams
+        def get_subscription_seats_history(params)
+          parsed, options = MetronomeSDK::V1::ContractGetSubscriptionSeatsHistoryParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/contracts/getSubscriptionSeatsHistory",
+            body: parsed,
+            model: MetronomeSDK::Models::V1::ContractGetSubscriptionSeatsHistoryResponse,
+            options: options
+          )
+        end
+
         # Some parameter documentations has been truncated, see
         # {MetronomeSDK::Models::V1::ContractListBalancesParams} for more details.
         #
@@ -679,7 +744,7 @@ module MetronomeSDK
         # - 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: {})
+        # @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, skip_missing_seat_ids: nil, starting_at: nil, subscription_ids: nil, request_options: {})
         #
         # @param contract_id [String] The contract ID to retrieve seat balances for
         #
@@ -699,6 +764,8 @@ module MetronomeSDK
         #
         # @param seat_ids [Array<String>] Optional filter to only include specific seats.
         #
+        # @param skip_missing_seat_ids [Boolean] When true, any seat_ids not found in contract subscriptions will be silently omi
+        #
         # @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

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

@@ -47,11 +47,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,12 +69,14 @@ module MetronomeSDK
           # - Error handling: Returns 404 if either the customer or alert_id doesn't exist
           #   or isn't accessible to your organization
           #
-          # @overload retrieve(alert_id:, customer_id:, group_values: nil, plans_or_contracts: nil, seat_filter: nil, request_options: {})
+          # @overload retrieve(alert_id:, customer_id:, alert_specifiers: nil, group_values: nil, plans_or_contracts: nil, seat_filter: nil, request_options: {})
           #
           # @param alert_id [String] The Metronome ID of the threshold notification
           #
           # @param customer_id [String] The Metronome ID of the customer
           #
+          # @param alert_specifiers [Array<MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::AlertSpecifier>] Can be used with only `low_remaining_contract_credit_and_commit_balance_reached`
+          #
           # @param group_values [Array<MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::GroupValue>] Only present for `spend_threshold_reached` notifications. Retrieve the notificat
           #
           # @param plans_or_contracts [Symbol, MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::PlansOrContracts] When parallel threshold notifications are enabled during migration, this flag de

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

@@ -136,7 +136,7 @@ module MetronomeSDK
           # - Voided invoices are included in results by default unless filtered out by
           #   status
           #
-          # @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: {})
+          # @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, webhook_notification_id: nil, request_options: {})
           #
           # @param customer_id [String] Path param
           #
@@ -160,6 +160,8 @@ module MetronomeSDK
           #
           # @param type [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListParams::Type] Query param: Filter invoices by type. Defaults to returning all invoice types.
           #
+          # @param webhook_notification_id [String] Query param: Indicates that this API request was triggered by a webhook notifica
+          #
           # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
           #
           # @return [MetronomeSDK::Internal::CursorPage<MetronomeSDK::Models::V1::Customers::Invoice>]

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

@@ -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/lib/metronome_sdk/version.rb

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

data/lib/metronome_sdk.rb

@@ -117,6 +117,8 @@ require_relative "metronome_sdk/models/v1/contract_create_params"
 require_relative "metronome_sdk/models/v1/contract_create_response"
 require_relative "metronome_sdk/models/v1/contract_get_net_balance_params"
 require_relative "metronome_sdk/models/v1/contract_get_net_balance_response"
+require_relative "metronome_sdk/models/v1/contract_get_subscription_seats_history_params"
+require_relative "metronome_sdk/models/v1/contract_get_subscription_seats_history_response"
 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"

data/rbi/metronome_sdk/models/commit.rbi

@@ -91,6 +91,14 @@ module MetronomeSDK
       sig { params(contract: MetronomeSDK::Commit::Contract::OrHash).void }
       attr_writer :contract
 
+      # 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)) }
+      attr_reader :created_by
+
+      sig { params(created_by: String).void }
+      attr_writer :created_by
+
       # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
       sig { returns(T.nilable(T::Hash[Symbol, String])) }
       attr_reader :custom_fields
@@ -285,6 +293,7 @@ module MetronomeSDK
           archived_at: Time,
           balance: Float,
           contract: MetronomeSDK::Commit::Contract::OrHash,
+          created_by: String,
           custom_fields: T::Hash[Symbol, String],
           description: String,
           hierarchy_configuration:
@@ -356,6 +365,9 @@ module MetronomeSDK
         # included in the balance, including future-dated manual ledger entries.
         balance: nil,
         contract: nil,
+        # The actor who created this commit. Omitted for system-generated commits such as
+        # recurring commits, rollover commits, and threshold commits.
+        created_by: nil,
         # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         custom_fields: nil,
         description: nil,
@@ -414,6 +426,7 @@ module MetronomeSDK
             archived_at: Time,
             balance: Float,
             contract: MetronomeSDK::Commit::Contract,
+            created_by: String,
             custom_fields: T::Hash[Symbol, String],
             description: String,
             hierarchy_configuration: MetronomeSDK::CommitHierarchyConfiguration,

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