metronome-sdk 2.0.0 → 2.2.0

data/rbi/metronome_sdk/models/hierarchy_configuration.rbi

@@ -120,10 +120,13 @@ module MetronomeSDK
               )
             end
 
-          # Indicates the desired behavior of consolidated invoices generated by the parent
-          # in a customer hierarchy **CONCATENATE**: Statements on the invoices of child
-          # customers will be appended to the consolidated invoice **NONE**: Do not generate
-          # consolidated invoices
+          # Account hierarchy M3 - Indicates the desired behavior of consolidated invoices
+          # generated by the parent in a customer hierarchy
+          #
+          # **CONCATENATE**: Statements on the invoices of child customers will be appended
+          # to the consolidated invoice
+          #
+          # **NONE**: Do not generate consolidated invoices
           sig do
             returns(
               T.nilable(
@@ -148,10 +151,13 @@ module MetronomeSDK
             ).returns(T.attached_class)
           end
           def self.new(
-            # Indicates the desired behavior of consolidated invoices generated by the parent
-            # in a customer hierarchy **CONCATENATE**: Statements on the invoices of child
-            # customers will be appended to the consolidated invoice **NONE**: Do not generate
-            # consolidated invoices
+            # Account hierarchy M3 - Indicates the desired behavior of consolidated invoices
+            # generated by the parent in a customer hierarchy
+            #
+            # **CONCATENATE**: Statements on the invoices of child customers will be appended
+            # to the consolidated invoice
+            #
+            # **NONE**: Do not generate consolidated invoices
             invoice_consolidation_type: nil
           )
           end
@@ -167,10 +173,13 @@ module MetronomeSDK
           def to_hash
           end
 
-          # Indicates the desired behavior of consolidated invoices generated by the parent
-          # in a customer hierarchy **CONCATENATE**: Statements on the invoices of child
-          # customers will be appended to the consolidated invoice **NONE**: Do not generate
-          # consolidated invoices
+          # Account hierarchy M3 - Indicates the desired behavior of consolidated invoices
+          # generated by the parent in a customer hierarchy
+          #
+          # **CONCATENATE**: Statements on the invoices of child customers will be appended
+          # to the consolidated invoice
+          #
+          # **NONE**: Do not generate consolidated invoices
           module InvoiceConsolidationType
             extend MetronomeSDK::Internal::Type::Enum
 
@@ -232,7 +241,12 @@ module MetronomeSDK
         end
         attr_writer :parent
 
-        # Indicates whether the parent should pay for the child's invoice charges
+        # Account hierarchy M3 - Indicates which customer should pay for the child's
+        # invoice charges
+        #
+        # **SELF**: The child pays for its own invoice charges
+        #
+        # **PARENT**: The parent pays for the child's invoice charges
         sig do
           returns(
             T.nilable(
@@ -250,10 +264,14 @@ module MetronomeSDK
         end
         attr_writer :payer
 
-        # Indicates the behavior of the child's invoice statements on the parent's
-        # invoices **CONSOLIDATE**: Child's invoice statements will be added to parent's
-        # consolidated invoices **SEPARATE**: Child's invoice statements will appear not
-        # appear on parent's consolidated invoices
+        # Account hierarchy M3 - Indicates the behavior of the child's invoice statements
+        # on the parent's invoices.
+        #
+        # **CONSOLIDATE**: Child's invoice statements will be added to parent's
+        # consolidated invoices
+        #
+        # **SEPARATE**: Child's invoice statements will appear not appear on parent's
+        # consolidated invoices
         sig do
           returns(
             T.nilable(
@@ -284,12 +302,21 @@ module MetronomeSDK
         def self.new(
           # The single parent contract/customer for this child.
           parent:,
-          # Indicates whether the parent should pay for the child's invoice charges
+          # Account hierarchy M3 - Indicates which customer should pay for the child's
+          # invoice charges
+          #
+          # **SELF**: The child pays for its own invoice charges
+          #
+          # **PARENT**: The parent pays for the child's invoice charges
           payer: nil,
-          # Indicates the behavior of the child's invoice statements on the parent's
-          # invoices **CONSOLIDATE**: Child's invoice statements will be added to parent's
-          # consolidated invoices **SEPARATE**: Child's invoice statements will appear not
-          # appear on parent's consolidated invoices
+          # Account hierarchy M3 - Indicates the behavior of the child's invoice statements
+          # on the parent's invoices.
+          #
+          # **CONSOLIDATE**: Child's invoice statements will be added to parent's
+          # consolidated invoices
+          #
+          # **SEPARATE**: Child's invoice statements will appear not appear on parent's
+          # consolidated invoices
           usage_statement_behavior: nil
         )
         end
@@ -338,7 +365,12 @@ module MetronomeSDK
           end
         end
 
-        # Indicates whether the parent should pay for the child's invoice charges
+        # Account hierarchy M3 - Indicates which customer should pay for the child's
+        # invoice charges
+        #
+        # **SELF**: The child pays for its own invoice charges
+        #
+        # **PARENT**: The parent pays for the child's invoice charges
         module Payer
           extend MetronomeSDK::Internal::Type::Enum
 
@@ -373,10 +405,14 @@ module MetronomeSDK
           end
         end
 
-        # Indicates the behavior of the child's invoice statements on the parent's
-        # invoices **CONSOLIDATE**: Child's invoice statements will be added to parent's
-        # consolidated invoices **SEPARATE**: Child's invoice statements will appear not
-        # appear on parent's consolidated invoices
+        # Account hierarchy M3 - Indicates the behavior of the child's invoice statements
+        # on the parent's invoices.
+        #
+        # **CONSOLIDATE**: Child's invoice statements will be added to parent's
+        # consolidated invoices
+        #
+        # **SEPARATE**: Child's invoice statements will appear not appear on parent's
+        # consolidated invoices
         module UsageStatementBehavior
           extend MetronomeSDK::Internal::Type::Enum
 

data/rbi/metronome_sdk/models/subscription.rbi

@@ -36,6 +36,11 @@ module MetronomeSDK
       # QUANTITY_ONLY. **QUANTITY_ONLY**: The subscription quantity is specified
       # directly on the subscription. `initial_quantity` must be provided with this
       # option. Compatible with recurring commits/credits that use POOLED allocation.
+      # **SEAT_BASED**: Use when you want to pass specific seat identifiers (e.g. add
+      # user_123) to increment and decrement a subscription quantity, rather than
+      # directly providing the quantity. You must use a **SEAT_BASED** subscription to
+      # use a linked recurring credit with an allocation per seat. `seat_config` must be
+      # provided with this option.
       sig do
         returns(
           MetronomeSDK::Subscription::QuantityManagementMode::TaggedSymbol
@@ -99,6 +104,14 @@ module MetronomeSDK
       sig { params(name: String).void }
       attr_writer :name
 
+      sig { returns(T.nilable(MetronomeSDK::Subscription::SeatConfig)) }
+      attr_reader :seat_config
+
+      sig do
+        params(seat_config: MetronomeSDK::Subscription::SeatConfig::OrHash).void
+      end
+      attr_writer :seat_config
+
       sig do
         params(
           billing_periods: MetronomeSDK::Subscription::BillingPeriods::OrHash,
@@ -117,7 +130,8 @@ module MetronomeSDK
           description: String,
           ending_before: Time,
           fiat_credit_type_id: String,
-          name: String
+          name: String,
+          seat_config: MetronomeSDK::Subscription::SeatConfig::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
@@ -129,6 +143,11 @@ module MetronomeSDK
         # QUANTITY_ONLY. **QUANTITY_ONLY**: The subscription quantity is specified
         # directly on the subscription. `initial_quantity` must be provided with this
         # option. Compatible with recurring commits/credits that use POOLED allocation.
+        # **SEAT_BASED**: Use when you want to pass specific seat identifiers (e.g. add
+        # user_123) to increment and decrement a subscription quantity, rather than
+        # directly providing the quantity. You must use a **SEAT_BASED** subscription to
+        # use a linked recurring credit with an allocation per seat. `seat_config` must be
+        # provided with this option.
         quantity_management_mode:,
         # List of quantity schedule items for the subscription. Only includes the current
         # quantity and future quantity changes.
@@ -141,7 +160,8 @@ module MetronomeSDK
         description: nil,
         ending_before: nil,
         fiat_credit_type_id: nil,
-        name: nil
+        name: nil,
+        seat_config: nil
       )
       end
 
@@ -163,7 +183,8 @@ module MetronomeSDK
             description: String,
             ending_before: Time,
             fiat_credit_type_id: String,
-            name: String
+            name: String,
+            seat_config: MetronomeSDK::Subscription::SeatConfig
           }
         )
       end
@@ -441,6 +462,11 @@ module MetronomeSDK
       # QUANTITY_ONLY. **QUANTITY_ONLY**: The subscription quantity is specified
       # directly on the subscription. `initial_quantity` must be provided with this
       # option. Compatible with recurring commits/credits that use POOLED allocation.
+      # **SEAT_BASED**: Use when you want to pass specific seat identifiers (e.g. add
+      # user_123) to increment and decrement a subscription quantity, rather than
+      # directly providing the quantity. You must use a **SEAT_BASED** subscription to
+      # use a linked recurring credit with an allocation per seat. `seat_config` must be
+      # provided with this option.
       module QuantityManagementMode
         extend MetronomeSDK::Internal::Type::Enum
 
@@ -630,6 +656,41 @@ module MetronomeSDK
           end
         end
       end
+
+      class SeatConfig < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::Subscription::SeatConfig,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        # The property name, sent on usage events, that identifies the seat ID associated
+        # with the usage event. For example, the property name might be seat_id or
+        # user_id. The property must be set as a group key on billable metrics and a
+        # presentation/pricing group key on contract products. This allows linked
+        # recurring credits with an allocation per seat to be consumed by only one seat's
+        # usage.
+        sig { returns(String) }
+        attr_accessor :seat_group_key
+
+        sig { params(seat_group_key: String).returns(T.attached_class) }
+        def self.new(
+          # The property name, sent on usage events, that identifies the seat ID associated
+          # with the usage event. For example, the property name might be seat_id or
+          # user_id. The property must be set as a group key on billable metrics and a
+          # presentation/pricing group key on contract products. This allows linked
+          # recurring credits with an allocation per seat to be consumed by only one seat's
+          # usage.
+          seat_group_key:
+        )
+        end
+
+        sig { override.returns({ seat_group_key: String }) }
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/metronome_sdk/models/v1/alert_create_params.rbi

@@ -129,6 +129,20 @@ module MetronomeSDK
         sig { params(plan_id: String).void }
         attr_writer :plan_id
 
+        # Required for `low_remaining_seat_balance_reached` notifications. The alert is
+        # scoped to this seat group key-value pair.
+        sig do
+          returns(T.nilable(MetronomeSDK::V1::AlertCreateParams::SeatFilter))
+        end
+        attr_reader :seat_filter
+
+        sig do
+          params(
+            seat_filter: MetronomeSDK::V1::AlertCreateParams::SeatFilter::OrHash
+          ).void
+        end
+        attr_writer :seat_filter
+
         # Prevents the creation of duplicates. If a request to create a record is made
         # with a previously used uniqueness key, a new record will not be created and the
         # request will fail with a 409 error.
@@ -157,6 +171,8 @@ module MetronomeSDK
               T::Array[MetronomeSDK::V1::AlertCreateParams::GroupValue::OrHash],
             invoice_types_filter: T::Array[String],
             plan_id: String,
+            seat_filter:
+              MetronomeSDK::V1::AlertCreateParams::SeatFilter::OrHash,
             uniqueness_key: String,
             request_options: MetronomeSDK::RequestOptions::OrHash
           ).returns(T.attached_class)
@@ -201,6 +217,9 @@ module MetronomeSDK
           # If provided, will create this threshold notification for this specific plan. To
           # create a notification for all customers, do not specify a `plan_id`.
           plan_id: nil,
+          # Required for `low_remaining_seat_balance_reached` notifications. The alert is
+          # scoped to this seat group key-value pair.
+          seat_filter: nil,
           # Prevents the creation of duplicates. If a request to create a record is made
           # with a previously used uniqueness key, a new record will not be created and the
           # request will fail with a 409 error.
@@ -229,6 +248,7 @@ module MetronomeSDK
                 T::Array[MetronomeSDK::V1::AlertCreateParams::GroupValue],
               invoice_types_filter: T::Array[String],
               plan_id: String,
+              seat_filter: MetronomeSDK::V1::AlertCreateParams::SeatFilter,
               uniqueness_key: String,
               request_options: MetronomeSDK::RequestOptions
             }
@@ -317,6 +337,11 @@ module MetronomeSDK
               :invoice_total_reached,
               MetronomeSDK::V1::AlertCreateParams::AlertType::TaggedSymbol
             )
+          LOW_REMAINING_SEAT_BALANCE_REACHED =
+            T.let(
+              :low_remaining_seat_balance_reached,
+              MetronomeSDK::V1::AlertCreateParams::AlertType::TaggedSymbol
+            )
 
           sig do
             override.returns(
@@ -441,6 +466,50 @@ module MetronomeSDK
           def to_hash
           end
         end
+
+        class SeatFilter < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::V1::AlertCreateParams::SeatFilter,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          # The seat group key (e.g., "seat_id", "user_id")
+          sig { returns(String) }
+          attr_accessor :seat_group_key
+
+          # Optional seat identifier the alert is scoped to.
+          sig { returns(T.nilable(String)) }
+          attr_reader :seat_group_value
+
+          sig { params(seat_group_value: String).void }
+          attr_writer :seat_group_value
+
+          # Required for `low_remaining_seat_balance_reached` notifications. The alert is
+          # scoped to this seat group key-value pair.
+          sig do
+            params(seat_group_key: String, seat_group_value: String).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            # The seat group key (e.g., "seat_id", "user_id")
+            seat_group_key:,
+            # Optional seat identifier the alert is scoped to.
+            seat_group_value: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              { seat_group_key: String, seat_group_value: String }
+            )
+          end
+          def to_hash
+          end
+        end
       end
     end
   end

data/rbi/metronome_sdk/models/v1/contract_add_manual_balance_entry_params.rbi

@@ -42,6 +42,14 @@ module MetronomeSDK
         sig { params(contract_id: String).void }
         attr_writer :contract_id
 
+        # If using individually configured commits/credits attached to seat managed
+        # subscriptions, the amount to add for each seat. Must sum to total amount.
+        sig { returns(T.nilable(T::Hash[Symbol, Float])) }
+        attr_reader :per_group_amounts
+
+        sig { params(per_group_amounts: T::Hash[Symbol, Float]).void }
+        attr_writer :per_group_amounts
+
         # RFC 3339 timestamp indicating when the manual adjustment takes place. If not
         # provided, it will default to the start of the segment.
         sig { returns(T.nilable(Time)) }
@@ -58,6 +66,7 @@ module MetronomeSDK
             reason: String,
             segment_id: String,
             contract_id: String,
+            per_group_amounts: T::Hash[Symbol, Float],
             timestamp: Time,
             request_options: MetronomeSDK::RequestOptions::OrHash
           ).returns(T.attached_class)
@@ -75,6 +84,9 @@ module MetronomeSDK
           segment_id:,
           # ID of the contract to update. Leave blank to update a customer level balance.
           contract_id: nil,
+          # If using individually configured commits/credits attached to seat managed
+          # subscriptions, the amount to add for each seat. Must sum to total amount.
+          per_group_amounts: nil,
           # RFC 3339 timestamp indicating when the manual adjustment takes place. If not
           # provided, it will default to the start of the segment.
           timestamp: nil,
@@ -91,6 +103,7 @@ module MetronomeSDK
               reason: String,
               segment_id: String,
               contract_id: String,
+              per_group_amounts: T::Hash[Symbol, Float],
               timestamp: Time,
               request_options: MetronomeSDK::RequestOptions
             }