metronome-sdk 2.0.0 → 2.2.0

data/rbi/metronome_sdk/models/v1/contract_create_params.rbi

@@ -291,6 +291,25 @@ module MetronomeSDK
         end
         attr_writer :reseller_royalties
 
+        # The revenue system configuration associated with a contract. Provide either an
+        # ID or the provider and delivery method.
+        sig do
+          returns(
+            T.nilable(
+              MetronomeSDK::V1::ContractCreateParams::RevenueSystemConfiguration
+            )
+          )
+        end
+        attr_reader :revenue_system_configuration
+
+        sig do
+          params(
+            revenue_system_configuration:
+              MetronomeSDK::V1::ContractCreateParams::RevenueSystemConfiguration::OrHash
+          ).void
+        end
+        attr_writer :revenue_system_configuration
+
         # This field's availability is dependent on your client's configuration.
         sig { returns(T.nilable(String)) }
         attr_reader :salesforce_opportunity_id
@@ -472,6 +491,8 @@ module MetronomeSDK
               T::Array[
                 MetronomeSDK::V1::ContractCreateParams::ResellerRoyalty::OrHash
               ],
+            revenue_system_configuration:
+              MetronomeSDK::V1::ContractCreateParams::RevenueSystemConfiguration::OrHash,
             salesforce_opportunity_id: String,
             scheduled_charges:
               T::Array[
@@ -534,6 +555,9 @@ module MetronomeSDK
           recurring_credits: nil,
           # This field's availability is dependent on your client's configuration.
           reseller_royalties: nil,
+          # The revenue system configuration associated with a contract. Provide either an
+          # ID or the provider and delivery method.
+          revenue_system_configuration: nil,
           # This field's availability is dependent on your client's configuration.
           salesforce_opportunity_id: nil,
           scheduled_charges: nil,
@@ -604,6 +628,8 @@ module MetronomeSDK
                 T::Array[
                   MetronomeSDK::V1::ContractCreateParams::ResellerRoyalty
                 ],
+              revenue_system_configuration:
+                MetronomeSDK::V1::ContractCreateParams::RevenueSystemConfiguration,
               salesforce_opportunity_id: String,
               scheduled_charges:
                 T::Array[
@@ -2925,7 +2951,12 @@ module MetronomeSDK
           end
           attr_writer :parent_behavior
 
-          # 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(
@@ -2943,10 +2974,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(
@@ -2979,12 +3014,21 @@ module MetronomeSDK
           def self.new(
             parent: nil,
             parent_behavior: nil,
-            # 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
@@ -3045,10 +3089,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(
@@ -3073,10 +3120,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
@@ -3092,10 +3142,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
 
@@ -3131,7 +3184,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
 
@@ -3166,10 +3224,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
 
@@ -4752,7 +4814,8 @@ module MetronomeSDK
             sig { returns(String) }
             attr_accessor :subscription_id
 
-            # 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.
             sig do
               returns(
                 T.nilable(
@@ -4784,7 +4847,8 @@ module MetronomeSDK
               apply_seat_increase_config:,
               # ID of the subscription to configure on the recurring commit/credit.
               subscription_id:,
-              # 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.
               allocation: nil
             )
             end
@@ -4828,7 +4892,8 @@ module MetronomeSDK
               end
             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.
             module Allocation
               extend MetronomeSDK::Internal::Type::Enum
 
@@ -5493,7 +5558,8 @@ module MetronomeSDK
             sig { returns(String) }
             attr_accessor :subscription_id
 
-            # 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.
             sig do
               returns(
                 T.nilable(
@@ -5525,7 +5591,8 @@ module MetronomeSDK
               apply_seat_increase_config:,
               # ID of the subscription to configure on the recurring commit/credit.
               subscription_id:,
-              # 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.
               allocation: nil
             )
             end
@@ -5569,7 +5636,8 @@ module MetronomeSDK
               end
             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.
             module Allocation
               extend MetronomeSDK::Internal::Type::Enum
 
@@ -5881,6 +5949,164 @@ module MetronomeSDK
           end
         end
 
+        class RevenueSystemConfiguration < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::V1::ContractCreateParams::RevenueSystemConfiguration,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          # How revenue recognition records should be delivered to the revenue system. Do
+          # not specify if using revenue_system_configuration_id.
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::V1::ContractCreateParams::RevenueSystemConfiguration::DeliveryMethod::OrSymbol
+              )
+            )
+          end
+          attr_reader :delivery_method
+
+          sig do
+            params(
+              delivery_method:
+                MetronomeSDK::V1::ContractCreateParams::RevenueSystemConfiguration::DeliveryMethod::OrSymbol
+            ).void
+          end
+          attr_writer :delivery_method
+
+          # The system that is providing services for revenue recognition. Do not specify if
+          # using revenue_system_configuration_id.
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::V1::ContractCreateParams::RevenueSystemConfiguration::Provider::OrSymbol
+              )
+            )
+          end
+          attr_reader :provider
+
+          sig do
+            params(
+              provider:
+                MetronomeSDK::V1::ContractCreateParams::RevenueSystemConfiguration::Provider::OrSymbol
+            ).void
+          end
+          attr_writer :provider
+
+          # 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.
+          sig { returns(T.nilable(String)) }
+          attr_reader :revenue_system_configuration_id
+
+          sig { params(revenue_system_configuration_id: String).void }
+          attr_writer :revenue_system_configuration_id
+
+          # The revenue system configuration associated with a contract. Provide either an
+          # ID or the provider and delivery method.
+          sig do
+            params(
+              delivery_method:
+                MetronomeSDK::V1::ContractCreateParams::RevenueSystemConfiguration::DeliveryMethod::OrSymbol,
+              provider:
+                MetronomeSDK::V1::ContractCreateParams::RevenueSystemConfiguration::Provider::OrSymbol,
+              revenue_system_configuration_id: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # How revenue recognition records should be delivered to the revenue system. Do
+            # not specify if using revenue_system_configuration_id.
+            delivery_method: nil,
+            # The system that is providing services for revenue recognition. Do not specify if
+            # using revenue_system_configuration_id.
+            provider: nil,
+            # 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.
+            revenue_system_configuration_id: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                delivery_method:
+                  MetronomeSDK::V1::ContractCreateParams::RevenueSystemConfiguration::DeliveryMethod::OrSymbol,
+                provider:
+                  MetronomeSDK::V1::ContractCreateParams::RevenueSystemConfiguration::Provider::OrSymbol,
+                revenue_system_configuration_id: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # How revenue recognition records should be delivered to the revenue system. Do
+          # not specify if using revenue_system_configuration_id.
+          module DeliveryMethod
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::V1::ContractCreateParams::RevenueSystemConfiguration::DeliveryMethod
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            DIRECT_TO_BILLING_PROVIDER =
+              T.let(
+                :direct_to_billing_provider,
+                MetronomeSDK::V1::ContractCreateParams::RevenueSystemConfiguration::DeliveryMethod::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::V1::ContractCreateParams::RevenueSystemConfiguration::DeliveryMethod::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # The system that is providing services for revenue recognition. Do not specify if
+          # using revenue_system_configuration_id.
+          module Provider
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::V1::ContractCreateParams::RevenueSystemConfiguration::Provider
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            NETSUITE =
+              T.let(
+                :netsuite,
+                MetronomeSDK::V1::ContractCreateParams::RevenueSystemConfiguration::Provider::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::V1::ContractCreateParams::RevenueSystemConfiguration::Provider::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
         class ScheduledCharge < MetronomeSDK::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
@@ -6478,6 +6704,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(
               T.nilable(
@@ -6495,6 +6726,23 @@ module MetronomeSDK
           end
           attr_writer :quantity_management_mode
 
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::V1::ContractCreateParams::Subscription::SeatConfig
+              )
+            )
+          end
+          attr_reader :seat_config
+
+          sig do
+            params(
+              seat_config:
+                MetronomeSDK::V1::ContractCreateParams::Subscription::SeatConfig::OrHash
+            ).void
+          end
+          attr_writer :seat_config
+
           # Inclusive start time for the subscription. If not provided, defaults to contract
           # start date
           sig { returns(T.nilable(Time)) }
@@ -6526,6 +6774,8 @@ module MetronomeSDK
               name: String,
               quantity_management_mode:
                 MetronomeSDK::V1::ContractCreateParams::Subscription::QuantityManagementMode::OrSymbol,
+              seat_config:
+                MetronomeSDK::V1::ContractCreateParams::Subscription::SeatConfig::OrHash,
               starting_at: Time,
               temporary_id: String
             ).returns(T.attached_class)
@@ -6548,7 +6798,13 @@ 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: nil,
+            seat_config: nil,
             # Inclusive start time for the subscription. If not provided, defaults to contract
             # start date
             starting_at: nil,
@@ -6574,6 +6830,8 @@ module MetronomeSDK
                 name: String,
                 quantity_management_mode:
                   MetronomeSDK::V1::ContractCreateParams::Subscription::QuantityManagementMode::OrSymbol,
+                seat_config:
+                  MetronomeSDK::V1::ContractCreateParams::Subscription::SeatConfig,
                 starting_at: Time,
                 temporary_id: String
               }
@@ -6826,6 +7084,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
 
@@ -6859,6 +7122,70 @@ module MetronomeSDK
             def self.values
             end
           end
+
+          class SeatConfig < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::V1::ContractCreateParams::Subscription::SeatConfig,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            # The initial assigned seats on this subscription.
+            sig { returns(T::Array[String]) }
+            attr_accessor :initial_seat_ids
+
+            # 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
+
+            # The initial amount of unassigned seats on this subscription.
+            sig { returns(T.nilable(Float)) }
+            attr_reader :initial_unassigned_seats
+
+            sig { params(initial_unassigned_seats: Float).void }
+            attr_writer :initial_unassigned_seats
+
+            sig do
+              params(
+                initial_seat_ids: T::Array[String],
+                seat_group_key: String,
+                initial_unassigned_seats: Float
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The initial assigned seats on this subscription.
+              initial_seat_ids:,
+              # 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:,
+              # The initial amount of unassigned seats on this subscription.
+              initial_unassigned_seats: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  initial_seat_ids: T::Array[String],
+                  seat_group_key: String,
+                  initial_unassigned_seats: Float
+                }
+              )
+            end
+            def to_hash
+            end
+          end
         end
 
         class Transition < MetronomeSDK::Internal::Type::BaseModel

data/rbi/metronome_sdk/models/v1/contract_list_balances_params.rbi

@@ -38,6 +38,13 @@ module MetronomeSDK
         sig { params(effective_before: Time).void }
         attr_writer :effective_before
 
+        # Exclude balances with zero amounts from the response.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :exclude_zero_balances
+
+        sig { params(exclude_zero_balances: T::Boolean).void }
+        attr_writer :exclude_zero_balances
+
         # Include archived credits and credits from archived contracts.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :include_archived
@@ -95,6 +102,7 @@ module MetronomeSDK
             id: String,
             covering_date: Time,
             effective_before: Time,
+            exclude_zero_balances: T::Boolean,
             include_archived: T::Boolean,
             include_balance: T::Boolean,
             include_contract_balances: T::Boolean,
@@ -112,6 +120,8 @@ module MetronomeSDK
           covering_date: nil,
           # Include only balances that have any access before the provided date (exclusive)
           effective_before: nil,
+          # Exclude balances with zero amounts from the response.
+          exclude_zero_balances: nil,
           # Include archived credits and credits from archived contracts.
           include_archived: nil,
           # Include the balance of credits and commits in the response. Setting this flag
@@ -139,6 +149,7 @@ module MetronomeSDK
               id: String,
               covering_date: Time,
               effective_before: Time,
+              exclude_zero_balances: T::Boolean,
               include_archived: T::Boolean,
               include_balance: T::Boolean,
               include_contract_balances: T::Boolean,