metronome-sdk 2.0.0 → 2.2.0

data/lib/metronome_sdk/models/subscription.rb

@@ -24,6 +24,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.
       #
       #   @return [Symbol, MetronomeSDK::Models::Subscription::QuantityManagementMode]
       required :quantity_management_mode, enum: -> { MetronomeSDK::Subscription::QuantityManagementMode }
@@ -77,7 +82,12 @@ module MetronomeSDK
       #   @return [String, nil]
       optional :name, String
 
-      # @!method initialize(billing_periods:, collection_schedule:, proration:, quantity_management_mode:, quantity_schedule:, starting_at:, subscription_rate:, id: nil, custom_fields: nil, description: nil, ending_before: nil, fiat_credit_type_id: nil, name: nil)
+      # @!attribute seat_config
+      #
+      #   @return [MetronomeSDK::Models::Subscription::SeatConfig, nil]
+      optional :seat_config, -> { MetronomeSDK::Subscription::SeatConfig }
+
+      # @!method initialize(billing_periods:, collection_schedule:, proration:, quantity_management_mode:, quantity_schedule:, starting_at:, subscription_rate:, id: nil, custom_fields: nil, description: nil, ending_before: nil, fiat_credit_type_id: nil, name: nil, seat_config: nil)
       #   Some parameter documentations has been truncated, see
       #   {MetronomeSDK::Models::Subscription} for more details.
       #
@@ -106,6 +116,8 @@ module MetronomeSDK
       #   @param fiat_credit_type_id [String]
       #
       #   @param name [String]
+      #
+      #   @param seat_config [MetronomeSDK::Models::Subscription::SeatConfig]
 
       # @see MetronomeSDK::Models::Subscription#billing_periods
       class BillingPeriods < MetronomeSDK::Internal::Type::BaseModel
@@ -226,6 +238,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.
       #
       # @see MetronomeSDK::Models::Subscription#quantity_management_mode
       module QuantityManagementMode
@@ -306,6 +323,26 @@ module MetronomeSDK
           #   @param name [String]
         end
       end
+
+      # @see MetronomeSDK::Models::Subscription#seat_config
+      class SeatConfig < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute seat_group_key
+        #   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.
+        #
+        #   @return [String]
+        required :seat_group_key, String
+
+        # @!method initialize(seat_group_key:)
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::Subscription::SeatConfig} for more details.
+        #
+        #   @param seat_group_key [String] The property name, sent on usage events, that identifies the seat ID associated
+      end
     end
   end
 end

data/lib/metronome_sdk/models/v1/alert_create_params.rb

@@ -97,6 +97,13 @@ module MetronomeSDK
         #   @return [String, nil]
         optional :plan_id, String
 
+        # @!attribute seat_filter
+        #   Required for `low_remaining_seat_balance_reached` notifications. The alert is
+        #   scoped to this seat group key-value pair.
+        #
+        #   @return [MetronomeSDK::Models::V1::AlertCreateParams::SeatFilter, nil]
+        optional :seat_filter, -> { MetronomeSDK::V1::AlertCreateParams::SeatFilter }
+
         # @!attribute uniqueness_key
         #   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
@@ -105,7 +112,7 @@ module MetronomeSDK
         #   @return [String, nil]
         optional :uniqueness_key, String
 
-        # @!method initialize(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, uniqueness_key: nil, request_options: {})
+        # @!method initialize(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: {})
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::V1::AlertCreateParams} for more details.
         #
@@ -133,6 +140,8 @@ module MetronomeSDK
         #
         #   @param plan_id [String] If provided, will create this threshold notification for this specific plan. To
         #
+        #   @param seat_filter [MetronomeSDK::Models::V1::AlertCreateParams::SeatFilter] Required for `low_remaining_seat_balance_reached` notifications. The alert is sc
+        #
         #   @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
         #
         #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
@@ -157,6 +166,7 @@ module MetronomeSDK
           LOW_REMAINING_CONTRACT_CREDIT_AND_COMMIT_BALANCE_REACHED =
             :low_remaining_contract_credit_and_commit_balance_reached
           INVOICE_TOTAL_REACHED = :invoice_total_reached
+          LOW_REMAINING_SEAT_BALANCE_REACHED = :low_remaining_seat_balance_reached
 
           # @!method self.values
           #   @return [Array<Symbol>]
@@ -211,6 +221,28 @@ module MetronomeSDK
           #   @param key [String]
           #   @param value [String]
         end
+
+        class SeatFilter < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute seat_group_key
+          #   The seat group key (e.g., "seat_id", "user_id")
+          #
+          #   @return [String]
+          required :seat_group_key, String
+
+          # @!attribute seat_group_value
+          #   Optional seat identifier the alert is scoped to.
+          #
+          #   @return [String, nil]
+          optional :seat_group_value, String
+
+          # @!method initialize(seat_group_key:, seat_group_value: nil)
+          #   Required for `low_remaining_seat_balance_reached` notifications. The alert is
+          #   scoped to this seat group key-value pair.
+          #
+          #   @param seat_group_key [String] The seat group key (e.g., "seat_id", "user_id")
+          #
+          #   @param seat_group_value [String] Optional seat identifier the alert is scoped to.
+        end
       end
     end
   end

data/lib/metronome_sdk/models/v1/contract_add_manual_balance_entry_params.rb

@@ -44,6 +44,13 @@ module MetronomeSDK
         #   @return [String, nil]
         optional :contract_id, String
 
+        # @!attribute per_group_amounts
+        #   If using individually configured commits/credits attached to seat managed
+        #   subscriptions, the amount to add for each seat. Must sum to total amount.
+        #
+        #   @return [Hash{Symbol=>Float}, nil]
+        optional :per_group_amounts, MetronomeSDK::Internal::Type::HashOf[Float]
+
         # @!attribute timestamp
         #   RFC 3339 timestamp indicating when the manual adjustment takes place. If not
         #   provided, it will default to the start of the segment.
@@ -51,7 +58,7 @@ module MetronomeSDK
         #   @return [Time, nil]
         optional :timestamp, Time
 
-        # @!method initialize(id:, amount:, customer_id:, reason:, segment_id:, contract_id: nil, timestamp: nil, request_options: {})
+        # @!method initialize(id:, amount:, customer_id:, reason:, segment_id:, contract_id: nil, per_group_amounts: nil, timestamp: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::V1::ContractAddManualBalanceEntryParams} for more
         #   details.
@@ -68,6 +75,8 @@ module MetronomeSDK
         #
         #   @param contract_id [String] ID of the contract to update. Leave blank to update a customer level balance.
         #
+        #   @param per_group_amounts [Hash{Symbol=>Float}] If using individually configured commits/credits attached to seat managed subscr
+        #
         #   @param timestamp [Time] RFC 3339 timestamp indicating when the manual adjustment takes place. If not pro
         #
         #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]

data/lib/metronome_sdk/models/v1/contract_create_params.rb

@@ -145,6 +145,14 @@ module MetronomeSDK
         optional :reseller_royalties,
                  -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractCreateParams::ResellerRoyalty] }
 
+        # @!attribute revenue_system_configuration
+        #   The revenue system configuration associated with a contract. Provide either an
+        #   ID or the provider and delivery method.
+        #
+        #   @return [MetronomeSDK::Models::V1::ContractCreateParams::RevenueSystemConfiguration, nil]
+        optional :revenue_system_configuration,
+                 -> { MetronomeSDK::V1::ContractCreateParams::RevenueSystemConfiguration }
+
         # @!attribute salesforce_opportunity_id
         #   This field's availability is dependent on your client's configuration.
         #
@@ -211,7 +219,7 @@ module MetronomeSDK
         #   @return [MetronomeSDK::Models::V1::ContractCreateParams::UsageStatementSchedule, nil]
         optional :usage_statement_schedule, -> { MetronomeSDK::V1::ContractCreateParams::UsageStatementSchedule }
 
-        # @!method initialize(customer_id:, starting_at:, billing_provider_configuration: nil, commits: nil, credits: nil, custom_fields: nil, discounts: nil, ending_before: nil, hierarchy_configuration: nil, multiplier_override_prioritization: nil, name: nil, net_payment_terms_days: nil, netsuite_sales_order_id: nil, overrides: nil, prepaid_balance_threshold_configuration: nil, priority: nil, professional_services: nil, rate_card_alias: nil, rate_card_id: nil, recurring_commits: nil, recurring_credits: nil, reseller_royalties: nil, salesforce_opportunity_id: nil, scheduled_charges: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, subscriptions: nil, total_contract_value: nil, transition: nil, uniqueness_key: nil, usage_filter: nil, usage_statement_schedule: nil, request_options: {})
+        # @!method initialize(customer_id:, starting_at:, billing_provider_configuration: nil, commits: nil, credits: nil, custom_fields: nil, discounts: nil, ending_before: nil, hierarchy_configuration: nil, multiplier_override_prioritization: nil, name: nil, net_payment_terms_days: nil, netsuite_sales_order_id: nil, overrides: nil, prepaid_balance_threshold_configuration: nil, priority: nil, professional_services: nil, rate_card_alias: nil, rate_card_id: nil, recurring_commits: nil, recurring_credits: nil, reseller_royalties: nil, revenue_system_configuration: nil, salesforce_opportunity_id: nil, scheduled_charges: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, subscriptions: nil, total_contract_value: nil, transition: nil, uniqueness_key: nil, usage_filter: nil, usage_statement_schedule: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::V1::ContractCreateParams} for more details.
         #
@@ -259,6 +267,8 @@ module MetronomeSDK
         #
         #   @param reseller_royalties [Array<MetronomeSDK::Models::V1::ContractCreateParams::ResellerRoyalty>] This field's availability is dependent on your client's configuration.
         #
+        #   @param revenue_system_configuration [MetronomeSDK::Models::V1::ContractCreateParams::RevenueSystemConfiguration] The revenue system configuration associated with a contract. Provide either an I
+        #
         #   @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
         #
         #   @param scheduled_charges [Array<MetronomeSDK::Models::V1::ContractCreateParams::ScheduledCharge>]
@@ -1358,16 +1368,25 @@ module MetronomeSDK
                    -> { MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior }
 
           # @!attribute payer
-          #   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
           #
           #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::Payer, nil]
           optional :payer, enum: -> { MetronomeSDK::V1::ContractCreateParams::HierarchyConfiguration::Payer }
 
           # @!attribute usage_statement_behavior
-          #   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
           #
           #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::UsageStatementBehavior, nil]
           optional :usage_statement_behavior,
@@ -1382,9 +1401,9 @@ module MetronomeSDK
           #
           #   @param parent_behavior [MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior]
           #
-          #   @param payer [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::Payer] Indicates whether the parent should pay for the child's invoice charges
+          #   @param payer [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::Payer] Account hierarchy M3 - Indicates which customer should pay for the child's invoi
           #
-          #   @param usage_statement_behavior [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::UsageStatementBehavior] Indicates the behavior of the child's invoice statements on the parent's invoice
+          #   @param usage_statement_behavior [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::UsageStatementBehavior] Account hierarchy M3 - Indicates the behavior of the child's invoice statements
 
           # @see MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration#parent
           class Parent < MetronomeSDK::Internal::Type::BaseModel
@@ -1406,10 +1425,13 @@ module MetronomeSDK
           # @see MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration#parent_behavior
           class ParentBehavior < MetronomeSDK::Internal::Type::BaseModel
             # @!attribute invoice_consolidation_type
-            #   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
             #
             #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior::InvoiceConsolidationType, nil]
             optional :invoice_consolidation_type,
@@ -1420,12 +1442,15 @@ module MetronomeSDK
             #   {MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior}
             #   for more details.
             #
-            #   @param invoice_consolidation_type [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior::InvoiceConsolidationType] Indicates the desired behavior of consolidated invoices generated by the parent
+            #   @param invoice_consolidation_type [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior::InvoiceConsolidationType] Account hierarchy M3 - Indicates the desired behavior of consolidated invoices g
 
-            # 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
             #
             # @see MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration::ParentBehavior#invoice_consolidation_type
             module InvoiceConsolidationType
@@ -1439,7 +1464,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
           #
           # @see MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration#payer
           module Payer
@@ -1452,10 +1482,14 @@ module MetronomeSDK
             #   @return [Array<Symbol>]
           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
           #
           # @see MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration#usage_statement_behavior
           module UsageStatementBehavior
@@ -2223,20 +2257,25 @@ module MetronomeSDK
             required :subscription_id, String
 
             # @!attribute allocation
-            #   If set to POOLED, allocation added per seat is pooled across the account.
+            #   If set to POOLED, allocation added per seat is pooled across the account. If set
+            #   to INDIVIDUAL, each seat in the subscription will have its own allocation.
             #
             #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation, nil]
             optional :allocation,
                      enum: -> { MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation }
 
             # @!method initialize(apply_seat_increase_config:, subscription_id:, allocation: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig}
+            #   for more details.
+            #
             #   Attach a subscription to the recurring commit/credit.
             #
             #   @param apply_seat_increase_config [MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::ApplySeatIncreaseConfig]
             #
             #   @param subscription_id [String] ID of the subscription to configure on the recurring commit/credit.
             #
-            #   @param allocation [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation] If set to POOLED, allocation added per seat is pooled across the account.
+            #   @param allocation [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation] If set to POOLED, allocation added per seat is pooled across the account. If set
 
             # @see MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig#apply_seat_increase_config
             class ApplySeatIncreaseConfig < MetronomeSDK::Internal::Type::BaseModel
@@ -2250,7 +2289,8 @@ module MetronomeSDK
               #   @param is_prorated [Boolean] Indicates whether a mid-period seat increase should be prorated.
             end
 
-            # If set to POOLED, allocation added per seat is pooled across the account.
+            # If set to POOLED, allocation added per seat is pooled across the account. If set
+            # to INDIVIDUAL, each seat in the subscription will have its own allocation.
             #
             # @see MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig#allocation
             module Allocation
@@ -2564,20 +2604,25 @@ module MetronomeSDK
             required :subscription_id, String
 
             # @!attribute allocation
-            #   If set to POOLED, allocation added per seat is pooled across the account.
+            #   If set to POOLED, allocation added per seat is pooled across the account. If set
+            #   to INDIVIDUAL, each seat in the subscription will have its own allocation.
             #
             #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation, nil]
             optional :allocation,
                      enum: -> { MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation }
 
             # @!method initialize(apply_seat_increase_config:, subscription_id:, allocation: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig}
+            #   for more details.
+            #
             #   Attach a subscription to the recurring commit/credit.
             #
             #   @param apply_seat_increase_config [MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::ApplySeatIncreaseConfig]
             #
             #   @param subscription_id [String] ID of the subscription to configure on the recurring commit/credit.
             #
-            #   @param allocation [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation] If set to POOLED, allocation added per seat is pooled across the account.
+            #   @param allocation [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation] If set to POOLED, allocation added per seat is pooled across the account. If set
 
             # @see MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig#apply_seat_increase_config
             class ApplySeatIncreaseConfig < MetronomeSDK::Internal::Type::BaseModel
@@ -2591,7 +2636,8 @@ module MetronomeSDK
               #   @param is_prorated [Boolean] Indicates whether a mid-period seat increase should be prorated.
             end
 
-            # If set to POOLED, allocation added per seat is pooled across the account.
+            # If set to POOLED, allocation added per seat is pooled across the account. If set
+            # to INDIVIDUAL, each seat in the subscription will have its own allocation.
             #
             # @see MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig#allocation
             module Allocation
@@ -2735,6 +2781,72 @@ module MetronomeSDK
           end
         end
 
+        class RevenueSystemConfiguration < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute delivery_method
+          #   How revenue recognition records should be delivered to the revenue system. Do
+          #   not specify if using revenue_system_configuration_id.
+          #
+          #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RevenueSystemConfiguration::DeliveryMethod, nil]
+          optional :delivery_method,
+                   enum: -> { MetronomeSDK::V1::ContractCreateParams::RevenueSystemConfiguration::DeliveryMethod }
+
+          # @!attribute provider
+          #   The system that is providing services for revenue recognition. Do not specify if
+          #   using revenue_system_configuration_id.
+          #
+          #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RevenueSystemConfiguration::Provider, nil]
+          optional :provider,
+                   enum: -> { MetronomeSDK::V1::ContractCreateParams::RevenueSystemConfiguration::Provider }
+
+          # @!attribute revenue_system_configuration_id
+          #   The Metronome ID of the revenue system configuration. Use when a customer has
+          #   multiple configurations with the same provider and delivery method. Otherwise,
+          #   specify the provider and delivery_method.
+          #
+          #   @return [String, nil]
+          optional :revenue_system_configuration_id, String
+
+          # @!method initialize(delivery_method: nil, provider: nil, revenue_system_configuration_id: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V1::ContractCreateParams::RevenueSystemConfiguration} for
+          #   more details.
+          #
+          #   The revenue system configuration associated with a contract. Provide either an
+          #   ID or the provider and delivery method.
+          #
+          #   @param delivery_method [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RevenueSystemConfiguration::DeliveryMethod] How revenue recognition records should be delivered to the revenue system. Do no
+          #
+          #   @param provider [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RevenueSystemConfiguration::Provider] The system that is providing services for revenue recognition. Do not specify if
+          #
+          #   @param revenue_system_configuration_id [String] The Metronome ID of the revenue system configuration. Use when a customer has mu
+
+          # How revenue recognition records should be delivered to the revenue system. Do
+          # not specify if using revenue_system_configuration_id.
+          #
+          # @see MetronomeSDK::Models::V1::ContractCreateParams::RevenueSystemConfiguration#delivery_method
+          module DeliveryMethod
+            extend MetronomeSDK::Internal::Type::Enum
+
+            DIRECT_TO_BILLING_PROVIDER = :direct_to_billing_provider
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The system that is providing services for revenue recognition. Do not specify if
+          # using revenue_system_configuration_id.
+          #
+          # @see MetronomeSDK::Models::V1::ContractCreateParams::RevenueSystemConfiguration#provider
+          module Provider
+            extend MetronomeSDK::Internal::Type::Enum
+
+            NETSUITE = :netsuite
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
         class ScheduledCharge < MetronomeSDK::Internal::Type::BaseModel
           # @!attribute product_id
           #
@@ -3034,11 +3146,21 @@ 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.
           #
           #   @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Subscription::QuantityManagementMode, nil]
           optional :quantity_management_mode,
                    enum: -> { MetronomeSDK::V1::ContractCreateParams::Subscription::QuantityManagementMode }
 
+          # @!attribute seat_config
+          #
+          #   @return [MetronomeSDK::Models::V1::ContractCreateParams::Subscription::SeatConfig, nil]
+          optional :seat_config, -> { MetronomeSDK::V1::ContractCreateParams::Subscription::SeatConfig }
+
           # @!attribute starting_at
           #   Inclusive start time for the subscription. If not provided, defaults to contract
           #   start date
@@ -3053,7 +3175,7 @@ module MetronomeSDK
           #   @return [String, nil]
           optional :temporary_id, String
 
-          # @!method initialize(collection_schedule:, proration:, subscription_rate:, custom_fields: nil, description: nil, ending_before: nil, initial_quantity: nil, name: nil, quantity_management_mode: nil, starting_at: nil, temporary_id: nil)
+          # @!method initialize(collection_schedule:, proration:, subscription_rate:, custom_fields: nil, description: nil, ending_before: nil, initial_quantity: nil, name: nil, quantity_management_mode: nil, seat_config: nil, starting_at: nil, temporary_id: nil)
           #   Some parameter documentations has been truncated, see
           #   {MetronomeSDK::Models::V1::ContractCreateParams::Subscription} for more details.
           #
@@ -3075,6 +3197,8 @@ module MetronomeSDK
           #
           #   @param quantity_management_mode [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Subscription::QuantityManagementMode] Determines how the subscription's quantity is controlled. Defaults to QUANTITY_O
           #
+          #   @param seat_config [MetronomeSDK::Models::V1::ContractCreateParams::Subscription::SeatConfig]
+          #
           #   @param starting_at [Time] Inclusive start time for the subscription. If not provided, defaults to contract
           #
           #   @param temporary_id [String] A temporary ID used to reference the subscription in recurring commit/credit sub
@@ -3182,6 +3306,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.
           #
           # @see MetronomeSDK::Models::V1::ContractCreateParams::Subscription#quantity_management_mode
           module QuantityManagementMode
@@ -3193,6 +3322,43 @@ module MetronomeSDK
             # @!method self.values
             #   @return [Array<Symbol>]
           end
+
+          # @see MetronomeSDK::Models::V1::ContractCreateParams::Subscription#seat_config
+          class SeatConfig < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute initial_seat_ids
+            #   The initial assigned seats on this subscription.
+            #
+            #   @return [Array<String>]
+            required :initial_seat_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+            # @!attribute seat_group_key
+            #   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.
+            #
+            #   @return [String]
+            required :seat_group_key, String
+
+            # @!attribute initial_unassigned_seats
+            #   The initial amount of unassigned seats on this subscription.
+            #
+            #   @return [Float, nil]
+            optional :initial_unassigned_seats, Float
+
+            # @!method initialize(initial_seat_ids:, seat_group_key:, initial_unassigned_seats: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {MetronomeSDK::Models::V1::ContractCreateParams::Subscription::SeatConfig} for
+            #   more details.
+            #
+            #   @param initial_seat_ids [Array<String>] The initial assigned seats on this subscription.
+            #
+            #   @param seat_group_key [String] The property name, sent on usage events, that identifies the seat ID associated
+            #
+            #   @param initial_unassigned_seats [Float] The initial amount of unassigned seats on this subscription.
+          end
         end
 
         class Transition < MetronomeSDK::Internal::Type::BaseModel

data/lib/metronome_sdk/models/v1/contract_list_balances_params.rb

@@ -30,6 +30,12 @@ module MetronomeSDK
         #   @return [Time, nil]
         optional :effective_before, Time
 
+        # @!attribute exclude_zero_balances
+        #   Exclude balances with zero amounts from the response.
+        #
+        #   @return [Boolean, nil]
+        optional :exclude_zero_balances, MetronomeSDK::Internal::Type::Boolean
+
         # @!attribute include_archived
         #   Include archived credits and credits from archived contracts.
         #
@@ -74,7 +80,7 @@ module MetronomeSDK
         #   @return [Time, nil]
         optional :starting_at, Time
 
-        # @!method initialize(customer_id:, id: nil, covering_date: nil, effective_before: nil, include_archived: nil, include_balance: nil, include_contract_balances: nil, include_ledgers: nil, limit: nil, next_page: nil, starting_at: nil, request_options: {})
+        # @!method initialize(customer_id:, id: nil, covering_date: nil, effective_before: nil, exclude_zero_balances: nil, include_archived: nil, include_balance: nil, include_contract_balances: nil, include_ledgers: nil, limit: nil, next_page: nil, starting_at: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::V1::ContractListBalancesParams} for more details.
         #
@@ -86,6 +92,8 @@ module MetronomeSDK
         #
         #   @param effective_before [Time] Include only balances that have any access before the provided date (exclusive)
         #
+        #   @param exclude_zero_balances [Boolean] Exclude balances with zero amounts from the response.
+        #
         #   @param include_archived [Boolean] Include archived credits and credits from archived contracts.
         #
         #   @param include_balance [Boolean] Include the balance of credits and commits in the response. Setting this flag ma