metronome-sdk 2.1.0 → 3.0.0

data/rbi/metronome_sdk/models/credit.rbi

@@ -144,6 +144,14 @@ module MetronomeSDK
       sig { params(rate_type: MetronomeSDK::Credit::RateType::OrSymbol).void }
       attr_writer :rate_type
 
+      # The ID of the recurring credit that this credit was generated from, if
+      # applicable.
+      sig { returns(T.nilable(String)) }
+      attr_reader :recurring_credit_id
+
+      sig { params(recurring_credit_id: String).void }
+      attr_writer :recurring_credit_id
+
       # This field's availability is dependent on your client's configuration.
       sig { returns(T.nilable(String)) }
       attr_reader :salesforce_opportunity_id
@@ -162,6 +170,18 @@ module MetronomeSDK
       end
       attr_writer :specifiers
 
+      # The subscription configuration for this credit, if it was generated from a
+      # recurring credit with a subscription attached.
+      sig { returns(T.nilable(MetronomeSDK::Credit::SubscriptionConfig)) }
+      attr_reader :subscription_config
+
+      sig do
+        params(
+          subscription_config: MetronomeSDK::Credit::SubscriptionConfig::OrHash
+        ).void
+      end
+      attr_writer :subscription_config
+
       # Prevents the creation of duplicates. If a request to create a commit or credit
       # is made with a uniqueness key that was previously used to create a commit or
       # credit, a new record will not be created and the request will fail with a 409
@@ -203,8 +223,10 @@ module MetronomeSDK
           netsuite_sales_order_id: String,
           priority: Float,
           rate_type: MetronomeSDK::Credit::RateType::OrSymbol,
+          recurring_credit_id: String,
           salesforce_opportunity_id: String,
           specifiers: T::Array[MetronomeSDK::CommitSpecifier::OrHash],
+          subscription_config: MetronomeSDK::Credit::SubscriptionConfig::OrHash,
           uniqueness_key: String
         ).returns(T.attached_class)
       end
@@ -242,12 +264,18 @@ module MetronomeSDK
         # will apply first.
         priority: nil,
         rate_type: nil,
+        # The ID of the recurring credit that this credit was generated from, if
+        # applicable.
+        recurring_credit_id: nil,
         # This field's availability is dependent on your client's configuration.
         salesforce_opportunity_id: nil,
         # List of filters that determine what kind of customer usage draws down a commit
         # 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,
+        # The subscription configuration for this credit, if it was generated from a
+        # recurring credit with a subscription attached.
+        subscription_config: nil,
         # Prevents the creation of duplicates. If a request to create a commit or credit
         # is made with a uniqueness key that was previously used to create a commit or
         # credit, a new record will not be created and the request will fail with a 409
@@ -276,8 +304,10 @@ module MetronomeSDK
             netsuite_sales_order_id: String,
             priority: Float,
             rate_type: MetronomeSDK::Credit::RateType::TaggedSymbol,
+            recurring_credit_id: String,
             salesforce_opportunity_id: String,
             specifiers: T::Array[MetronomeSDK::CommitSpecifier],
+            subscription_config: MetronomeSDK::Credit::SubscriptionConfig,
             uniqueness_key: String
           }
         )
@@ -1016,6 +1046,147 @@ module MetronomeSDK
         def self.values
         end
       end
+
+      class SubscriptionConfig < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::Credit::SubscriptionConfig,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(
+              MetronomeSDK::Credit::SubscriptionConfig::Allocation::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :allocation
+
+        sig do
+          params(
+            allocation:
+              MetronomeSDK::Credit::SubscriptionConfig::Allocation::OrSymbol
+          ).void
+        end
+        attr_writer :allocation
+
+        sig do
+          returns(
+            T.nilable(
+              MetronomeSDK::Credit::SubscriptionConfig::ApplySeatIncreaseConfig
+            )
+          )
+        end
+        attr_reader :apply_seat_increase_config
+
+        sig do
+          params(
+            apply_seat_increase_config:
+              MetronomeSDK::Credit::SubscriptionConfig::ApplySeatIncreaseConfig::OrHash
+          ).void
+        end
+        attr_writer :apply_seat_increase_config
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :subscription_id
+
+        sig { params(subscription_id: String).void }
+        attr_writer :subscription_id
+
+        # The subscription configuration for this credit, if it was generated from a
+        # recurring credit with a subscription attached.
+        sig do
+          params(
+            allocation:
+              MetronomeSDK::Credit::SubscriptionConfig::Allocation::OrSymbol,
+            apply_seat_increase_config:
+              MetronomeSDK::Credit::SubscriptionConfig::ApplySeatIncreaseConfig::OrHash,
+            subscription_id: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          allocation: nil,
+          apply_seat_increase_config: nil,
+          subscription_id: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              allocation:
+                MetronomeSDK::Credit::SubscriptionConfig::Allocation::TaggedSymbol,
+              apply_seat_increase_config:
+                MetronomeSDK::Credit::SubscriptionConfig::ApplySeatIncreaseConfig,
+              subscription_id: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Allocation
+          extend MetronomeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                MetronomeSDK::Credit::SubscriptionConfig::Allocation
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          INDIVIDUAL =
+            T.let(
+              :INDIVIDUAL,
+              MetronomeSDK::Credit::SubscriptionConfig::Allocation::TaggedSymbol
+            )
+          POOLED =
+            T.let(
+              :POOLED,
+              MetronomeSDK::Credit::SubscriptionConfig::Allocation::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                MetronomeSDK::Credit::SubscriptionConfig::Allocation::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class ApplySeatIncreaseConfig < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::Credit::SubscriptionConfig::ApplySeatIncreaseConfig,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          # Indicates whether a mid-period seat increase should be prorated.
+          sig { returns(T::Boolean) }
+          attr_accessor :is_prorated
+
+          sig { params(is_prorated: T::Boolean).returns(T.attached_class) }
+          def self.new(
+            # Indicates whether a mid-period seat increase should be prorated.
+            is_prorated:
+          )
+          end
+
+          sig { override.returns({ is_prorated: T::Boolean }) }
+          def to_hash
+          end
+        end
+      end
     end
   end
 end

data/rbi/metronome_sdk/models/rate.rbi

@@ -63,15 +63,6 @@ module MetronomeSDK
       sig { params(tiers: T::Array[MetronomeSDK::Tier::OrHash]).void }
       attr_writer :tiers
 
-      # Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
-      # using list prices rather than the standard rates for this product on the
-      # contract.
-      sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :use_list_prices
-
-      sig { params(use_list_prices: T::Boolean).void }
-      attr_writer :use_list_prices
-
       sig do
         params(
           rate_type: MetronomeSDK::Rate::RateType::OrSymbol,
@@ -81,8 +72,7 @@ module MetronomeSDK
           price: Float,
           pricing_group_values: T::Hash[Symbol, String],
           quantity: Float,
-          tiers: T::Array[MetronomeSDK::Tier::OrHash],
-          use_list_prices: T::Boolean
+          tiers: T::Array[MetronomeSDK::Tier::OrHash]
         ).returns(T.attached_class)
       end
       def self.new(
@@ -103,11 +93,7 @@ module MetronomeSDK
         # Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
         quantity: nil,
         # Only set for TIERED rate_type.
-        tiers: nil,
-        # Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
-        # using list prices rather than the standard rates for this product on the
-        # contract.
-        use_list_prices: nil
+        tiers: nil
       )
       end
 
@@ -121,8 +107,7 @@ module MetronomeSDK
             price: Float,
             pricing_group_values: T::Hash[Symbol, String],
             quantity: Float,
-            tiers: T::Array[MetronomeSDK::Tier],
-            use_list_prices: T::Boolean
+            tiers: T::Array[MetronomeSDK::Tier]
           }
         )
       end

data/rbi/metronome_sdk/models/subscription.rbi

@@ -36,8 +36,8 @@ 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**: (BETA) Use when you want to pass specific seat identifiers (e.g.
-      # add user_123) to increment and decrement a subscription quantity, rather than
+      # **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.
@@ -104,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,
@@ -122,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(
@@ -134,8 +143,8 @@ 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**: (BETA) Use when you want to pass specific seat identifiers (e.g.
-        # add user_123) to increment and decrement a subscription quantity, rather than
+        # **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.
@@ -151,7 +160,8 @@ module MetronomeSDK
         description: nil,
         ending_before: nil,
         fiat_credit_type_id: nil,
-        name: nil
+        name: nil,
+        seat_config: nil
       )
       end
 
@@ -173,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
@@ -451,8 +462,8 @@ 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**: (BETA) Use when you want to pass specific seat identifiers (e.g.
-      # add user_123) to increment and decrement a subscription quantity, rather than
+      # **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.
@@ -645,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
             }