metronome-sdk 0.1.0.pre.alpha.4 → 0.2.0

data/lib/metronome_sdk/models/contract_without_amendments.rb

@@ -771,6 +771,13 @@ module MetronomeSDK
         #   @return [Time, nil]
         optional :ending_before, Time
 
+        # @!attribute hierarchy_configuration
+        #   Optional configuration for recurring commit/credit hierarchy access control
+        #
+        #   @return [MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration, nil]
+        optional :hierarchy_configuration,
+                 -> { MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration }
+
         # @!attribute invoice_amount
         #   The amount the customer should be billed for the commit. Not required.
         #
@@ -829,7 +836,14 @@ module MetronomeSDK
                    MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ContractWithoutAmendments::RecurringCommit::Specifier]
                  }
 
-        # @!method initialize(id:, access_amount:, commit_duration:, priority:, product:, rate_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, contract: nil, description: nil, ending_before: nil, invoice_amount: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil)
+        # @!attribute subscription_config
+        #   Attach a subscription to the recurring commit/credit.
+        #
+        #   @return [MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig, nil]
+        optional :subscription_config,
+                 -> { MetronomeSDK::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig }
+
+        # @!method initialize(id:, access_amount:, commit_duration:, priority:, product:, rate_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, contract: nil, description: nil, ending_before: nil, hierarchy_configuration: nil, invoice_amount: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil, subscription_config: nil)
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit} for more
         #   details.
@@ -858,6 +872,8 @@ module MetronomeSDK
         #
         #   @param ending_before [Time] Determines when the contract will stop creating recurring commits. Optional
         #
+        #   @param hierarchy_configuration [MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration] Optional configuration for recurring commit/credit hierarchy access control
+        #
         #   @param invoice_amount [MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::InvoiceAmount] The amount the customer should be billed for the commit. Not required.
         #
         #   @param name [String] Displayed on invoices. Will be passed through to the individual commits
@@ -871,6 +887,8 @@ module MetronomeSDK
         #   @param rollover_fraction [Float] Will be passed down to the individual commits. This controls how much of an indi
         #
         #   @param specifiers [Array<MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::Specifier>] List of filters that determine what kind of customer usage draws down a commit o
+        #
+        #   @param subscription_config [MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig] Attach a subscription to the recurring commit/credit.
 
         # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit#access_amount
         class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
@@ -968,6 +986,117 @@ module MetronomeSDK
           #   @param id [String]
         end
 
+        # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit#hierarchy_configuration
+        class HierarchyConfiguration < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute child_access
+          #
+          #   @return [MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
+          required :child_access,
+                   union: -> {
+                     MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess
+                   }
+
+          # @!method initialize(child_access:)
+          #   Optional configuration for recurring commit/credit hierarchy access control
+          #
+          #   @param child_access [MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
+
+          # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration#child_access
+          module ChildAccess
+            extend MetronomeSDK::Internal::Type::Union
+
+            variant -> {
+              MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll
+            }
+
+            variant -> {
+              MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone
+            }
+
+            variant -> {
+              MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs
+            }
+
+            class CommitHierarchyChildAccessAll < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute type
+              #
+              #   @return [Symbol, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
+              required :type,
+                       enum: -> {
+                         MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type
+                       }
+
+              # @!method initialize(type:)
+              #   @param type [Symbol, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
+
+              # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll#type
+              module Type
+                extend MetronomeSDK::Internal::Type::Enum
+
+                ALL = :ALL
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+
+            class CommitHierarchyChildAccessNone < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute type
+              #
+              #   @return [Symbol, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
+              required :type,
+                       enum: -> {
+                         MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type
+                       }
+
+              # @!method initialize(type:)
+              #   @param type [Symbol, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
+
+              # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone#type
+              module Type
+                extend MetronomeSDK::Internal::Type::Enum
+
+                NONE = :NONE
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+
+            class CommitHierarchyChildAccessContractIDs < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute contract_ids
+              #
+              #   @return [Array<String>]
+              required :contract_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+              # @!attribute type
+              #
+              #   @return [Symbol, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
+              required :type,
+                       enum: -> {
+                         MetronomeSDK::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type
+                       }
+
+              # @!method initialize(contract_ids:, type:)
+              #   @param contract_ids [Array<String>]
+              #   @param type [Symbol, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
+
+              # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs#type
+              module Type
+                extend MetronomeSDK::Internal::Type::Enum
+
+                CONTRACT_IDS = :CONTRACT_IDS
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+
+            # @!method self.variants
+            #   @return [Array(MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs)]
+          end
+        end
+
         # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit#invoice_amount
         class InvoiceAmount < MetronomeSDK::Internal::Type::BaseModel
           # @!attribute credit_type_id
@@ -1065,6 +1194,60 @@ module MetronomeSDK
           #
           #   @param product_tags [Array<String>] If provided, the specifier will only apply to products with all the specified ta
         end
+
+        # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit#subscription_config
+        class SubscriptionConfig < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute allocation
+          #
+          #   @return [Symbol, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig::Allocation]
+          required :allocation,
+                   enum: -> {
+                     MetronomeSDK::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig::Allocation
+                   }
+
+          # @!attribute apply_seat_increase_config
+          #
+          #   @return [MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig::ApplySeatIncreaseConfig]
+          required :apply_seat_increase_config,
+                   -> {
+                     MetronomeSDK::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig::ApplySeatIncreaseConfig
+                   }
+
+          # @!attribute subscription_id
+          #
+          #   @return [String]
+          required :subscription_id, String
+
+          # @!method initialize(allocation:, apply_seat_increase_config:, subscription_id:)
+          #   Attach a subscription to the recurring commit/credit.
+          #
+          #   @param allocation [Symbol, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig::Allocation]
+          #   @param apply_seat_increase_config [MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig::ApplySeatIncreaseConfig]
+          #   @param subscription_id [String]
+
+          # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig#allocation
+          module Allocation
+            extend MetronomeSDK::Internal::Type::Enum
+
+            INDIVIDUAL = :INDIVIDUAL
+            POOLED = :POOLED
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig#apply_seat_increase_config
+          class ApplySeatIncreaseConfig < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute is_prorated
+            #   Indicates whether a mid-period seat increase should be prorated.
+            #
+            #   @return [Boolean]
+            required :is_prorated, MetronomeSDK::Internal::Type::Boolean
+
+            # @!method initialize(is_prorated:)
+            #   @param is_prorated [Boolean] Indicates whether a mid-period seat increase should be prorated.
+          end
+        end
       end
 
       class RecurringCredit < MetronomeSDK::Internal::Type::BaseModel
@@ -1140,6 +1323,13 @@ module MetronomeSDK
         #   @return [Time, nil]
         optional :ending_before, Time
 
+        # @!attribute hierarchy_configuration
+        #   Optional configuration for recurring commit/credit hierarchy access control
+        #
+        #   @return [MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration, nil]
+        optional :hierarchy_configuration,
+                 -> { MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration }
+
         # @!attribute name
         #   Displayed on invoices. Will be passed through to the individual commits
         #
@@ -1189,7 +1379,14 @@ module MetronomeSDK
                    MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ContractWithoutAmendments::RecurringCredit::Specifier]
                  }
 
-        # @!method initialize(id:, access_amount:, commit_duration:, priority:, product:, rate_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, contract: nil, description: nil, ending_before: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil)
+        # @!attribute subscription_config
+        #   Attach a subscription to the recurring commit/credit.
+        #
+        #   @return [MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig, nil]
+        optional :subscription_config,
+                 -> { MetronomeSDK::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig }
+
+        # @!method initialize(id:, access_amount:, commit_duration:, priority:, product:, rate_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, contract: nil, description: nil, ending_before: nil, hierarchy_configuration: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil, subscription_config: nil)
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit} for more
         #   details.
@@ -1218,6 +1415,8 @@ module MetronomeSDK
         #
         #   @param ending_before [Time] Determines when the contract will stop creating recurring commits. Optional
         #
+        #   @param hierarchy_configuration [MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration] Optional configuration for recurring commit/credit hierarchy access control
+        #
         #   @param name [String] Displayed on invoices. Will be passed through to the individual commits
         #
         #   @param netsuite_sales_order_id [String] Will be passed down to the individual commits
@@ -1229,6 +1428,8 @@ module MetronomeSDK
         #   @param rollover_fraction [Float] Will be passed down to the individual commits. This controls how much of an indi
         #
         #   @param specifiers [Array<MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::Specifier>] List of filters that determine what kind of customer usage draws down a commit o
+        #
+        #   @param subscription_config [MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig] Attach a subscription to the recurring commit/credit.
 
         # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit#access_amount
         class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
@@ -1326,6 +1527,117 @@ module MetronomeSDK
           #   @param id [String]
         end
 
+        # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit#hierarchy_configuration
+        class HierarchyConfiguration < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute child_access
+          #
+          #   @return [MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
+          required :child_access,
+                   union: -> {
+                     MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess
+                   }
+
+          # @!method initialize(child_access:)
+          #   Optional configuration for recurring commit/credit hierarchy access control
+          #
+          #   @param child_access [MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
+
+          # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration#child_access
+          module ChildAccess
+            extend MetronomeSDK::Internal::Type::Union
+
+            variant -> {
+              MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll
+            }
+
+            variant -> {
+              MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone
+            }
+
+            variant -> {
+              MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs
+            }
+
+            class CommitHierarchyChildAccessAll < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute type
+              #
+              #   @return [Symbol, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
+              required :type,
+                       enum: -> {
+                         MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type
+                       }
+
+              # @!method initialize(type:)
+              #   @param type [Symbol, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
+
+              # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll#type
+              module Type
+                extend MetronomeSDK::Internal::Type::Enum
+
+                ALL = :ALL
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+
+            class CommitHierarchyChildAccessNone < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute type
+              #
+              #   @return [Symbol, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
+              required :type,
+                       enum: -> {
+                         MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type
+                       }
+
+              # @!method initialize(type:)
+              #   @param type [Symbol, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
+
+              # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone#type
+              module Type
+                extend MetronomeSDK::Internal::Type::Enum
+
+                NONE = :NONE
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+
+            class CommitHierarchyChildAccessContractIDs < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute contract_ids
+              #
+              #   @return [Array<String>]
+              required :contract_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+              # @!attribute type
+              #
+              #   @return [Symbol, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
+              required :type,
+                       enum: -> {
+                         MetronomeSDK::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type
+                       }
+
+              # @!method initialize(contract_ids:, type:)
+              #   @param contract_ids [Array<String>]
+              #   @param type [Symbol, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
+
+              # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs#type
+              module Type
+                extend MetronomeSDK::Internal::Type::Enum
+
+                CONTRACT_IDS = :CONTRACT_IDS
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+
+            # @!method self.variants
+            #   @return [Array(MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs)]
+          end
+        end
+
         # Determines whether the first and last commit will be prorated. If not provided,
         # the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
         #
@@ -1398,6 +1710,60 @@ module MetronomeSDK
           #
           #   @param product_tags [Array<String>] If provided, the specifier will only apply to products with all the specified ta
         end
+
+        # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit#subscription_config
+        class SubscriptionConfig < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute allocation
+          #
+          #   @return [Symbol, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig::Allocation]
+          required :allocation,
+                   enum: -> {
+                     MetronomeSDK::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig::Allocation
+                   }
+
+          # @!attribute apply_seat_increase_config
+          #
+          #   @return [MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig::ApplySeatIncreaseConfig]
+          required :apply_seat_increase_config,
+                   -> {
+                     MetronomeSDK::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig::ApplySeatIncreaseConfig
+                   }
+
+          # @!attribute subscription_id
+          #
+          #   @return [String]
+          required :subscription_id, String
+
+          # @!method initialize(allocation:, apply_seat_increase_config:, subscription_id:)
+          #   Attach a subscription to the recurring commit/credit.
+          #
+          #   @param allocation [Symbol, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig::Allocation]
+          #   @param apply_seat_increase_config [MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig::ApplySeatIncreaseConfig]
+          #   @param subscription_id [String]
+
+          # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig#allocation
+          module Allocation
+            extend MetronomeSDK::Internal::Type::Enum
+
+            INDIVIDUAL = :INDIVIDUAL
+            POOLED = :POOLED
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig#apply_seat_increase_config
+          class ApplySeatIncreaseConfig < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute is_prorated
+            #   Indicates whether a mid-period seat increase should be prorated.
+            #
+            #   @return [Boolean]
+            required :is_prorated, MetronomeSDK::Internal::Type::Boolean
+
+            # @!method initialize(is_prorated:)
+            #   @param is_prorated [Boolean] Indicates whether a mid-period seat increase should be prorated.
+          end
+        end
       end
 
       class ResellerRoyalty < MetronomeSDK::Internal::Type::BaseModel

data/lib/metronome_sdk/models/credit.rb

@@ -77,7 +77,7 @@ module MetronomeSDK
       #   A list of ordered events that impact the balance of a credit. For example, an
       #   invoice deduction or an expiration.
       #
-      #   @return [Array<MetronomeSDK::Models::Credit::Ledger::CreditSegmentStartLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditExpirationLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditCanceledLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditCreditedLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditManualLedgerEntry>, nil]
+      #   @return [Array<MetronomeSDK::Models::Credit::Ledger::CreditSegmentStartLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditExpirationLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditCanceledLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditCreditedLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditManualLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry>, nil]
       optional :ledger, -> { MetronomeSDK::Internal::Type::ArrayOf[union: MetronomeSDK::Credit::Ledger] }
 
       # @!attribute name
@@ -154,7 +154,7 @@ module MetronomeSDK
       #
       #   @param hierarchy_configuration [MetronomeSDK::Models::Credit::HierarchyConfiguration] Optional configuration for credit hierarchy access control
       #
-      #   @param ledger [Array<MetronomeSDK::Models::Credit::Ledger::CreditSegmentStartLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditExpirationLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditCanceledLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditCreditedLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditManualLedgerEntry>] A list of ordered events that impact the balance of a credit. For example, an in
+      #   @param ledger [Array<MetronomeSDK::Models::Credit::Ledger::CreditSegmentStartLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditExpirationLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditCanceledLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditCreditedLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditManualLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry>] A list of ordered events that impact the balance of a credit. For example, an in
       #
       #   @param name [String]
       #
@@ -331,6 +331,8 @@ module MetronomeSDK
 
         variant -> { MetronomeSDK::Credit::Ledger::CreditManualLedgerEntry }
 
+        variant -> { MetronomeSDK::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry }
+
         class CreditSegmentStartLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
           # @!attribute amount
           #
@@ -396,12 +398,18 @@ module MetronomeSDK
           required :type,
                    enum: -> { MetronomeSDK::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry::Type }
 
-          # @!method initialize(amount:, invoice_id:, segment_id:, timestamp:, type:)
+          # @!attribute contract_id
+          #
+          #   @return [String, nil]
+          optional :contract_id, String
+
+          # @!method initialize(amount:, invoice_id:, segment_id:, timestamp:, type:, contract_id: nil)
           #   @param amount [Float]
           #   @param invoice_id [String]
           #   @param segment_id [String]
           #   @param timestamp [Time]
           #   @param type [Symbol, MetronomeSDK::Models::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry::Type]
+          #   @param contract_id [String]
 
           # @see MetronomeSDK::Models::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry#type
           module Type
@@ -478,12 +486,18 @@ module MetronomeSDK
           #   @return [Symbol, MetronomeSDK::Models::Credit::Ledger::CreditCanceledLedgerEntry::Type]
           required :type, enum: -> { MetronomeSDK::Credit::Ledger::CreditCanceledLedgerEntry::Type }
 
-          # @!method initialize(amount:, invoice_id:, segment_id:, timestamp:, type:)
+          # @!attribute contract_id
+          #
+          #   @return [String, nil]
+          optional :contract_id, String
+
+          # @!method initialize(amount:, invoice_id:, segment_id:, timestamp:, type:, contract_id: nil)
           #   @param amount [Float]
           #   @param invoice_id [String]
           #   @param segment_id [String]
           #   @param timestamp [Time]
           #   @param type [Symbol, MetronomeSDK::Models::Credit::Ledger::CreditCanceledLedgerEntry::Type]
+          #   @param contract_id [String]
 
           # @see MetronomeSDK::Models::Credit::Ledger::CreditCanceledLedgerEntry#type
           module Type
@@ -522,12 +536,18 @@ module MetronomeSDK
           #   @return [Symbol, MetronomeSDK::Models::Credit::Ledger::CreditCreditedLedgerEntry::Type]
           required :type, enum: -> { MetronomeSDK::Credit::Ledger::CreditCreditedLedgerEntry::Type }
 
-          # @!method initialize(amount:, invoice_id:, segment_id:, timestamp:, type:)
+          # @!attribute contract_id
+          #
+          #   @return [String, nil]
+          optional :contract_id, String
+
+          # @!method initialize(amount:, invoice_id:, segment_id:, timestamp:, type:, contract_id: nil)
           #   @param amount [Float]
           #   @param invoice_id [String]
           #   @param segment_id [String]
           #   @param timestamp [Time]
           #   @param type [Symbol, MetronomeSDK::Models::Credit::Ledger::CreditCreditedLedgerEntry::Type]
+          #   @param contract_id [String]
 
           # @see MetronomeSDK::Models::Credit::Ledger::CreditCreditedLedgerEntry#type
           module Type
@@ -578,8 +598,49 @@ module MetronomeSDK
           end
         end
 
+        class CreditSeatBasedAdjustmentLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute amount
+          #
+          #   @return [Float]
+          required :amount, Float
+
+          # @!attribute segment_id
+          #
+          #   @return [String]
+          required :segment_id, String
+
+          # @!attribute timestamp
+          #
+          #   @return [Time]
+          required :timestamp, Time
+
+          # @!attribute type
+          #
+          #   @return [Symbol, MetronomeSDK::Models::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry::Type]
+          required :type,
+                   enum: -> {
+                     MetronomeSDK::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry::Type
+                   }
+
+          # @!method initialize(amount:, segment_id:, timestamp:, type:)
+          #   @param amount [Float]
+          #   @param segment_id [String]
+          #   @param timestamp [Time]
+          #   @param type [Symbol, MetronomeSDK::Models::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry::Type]
+
+          # @see MetronomeSDK::Models::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry#type
+          module Type
+            extend MetronomeSDK::Internal::Type::Enum
+
+            CREDIT_SEAT_BASED_ADJUSTMENT = :CREDIT_SEAT_BASED_ADJUSTMENT
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
         # @!method self.variants
-        #   @return [Array(MetronomeSDK::Models::Credit::Ledger::CreditSegmentStartLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditExpirationLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditCanceledLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditCreditedLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditManualLedgerEntry)]
+        #   @return [Array(MetronomeSDK::Models::Credit::Ledger::CreditSegmentStartLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditExpirationLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditCanceledLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditCreditedLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditManualLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry)]
       end
 
       # @see MetronomeSDK::Models::Credit#rate_type

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

@@ -75,12 +75,13 @@ module MetronomeSDK
         #   @return [Boolean, nil]
         optional :evaluate_on_create, MetronomeSDK::Internal::Type::Boolean
 
-        # @!attribute group_key_filter
-        #   Scopes alert evaluation to a specific presentation group key on individual line
-        #   items. Only present for spend alerts.
+        # @!attribute group_values
+        #   Only present for `spend_threshold_reached` alerts. Scope alert to a specific
+        #   group key on individual line items.
         #
-        #   @return [MetronomeSDK::Models::V1::AlertCreateParams::GroupKeyFilter, nil]
-        optional :group_key_filter, -> { MetronomeSDK::V1::AlertCreateParams::GroupKeyFilter }
+        #   @return [Array<MetronomeSDK::Models::V1::AlertCreateParams::GroupValue>, nil]
+        optional :group_values,
+                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::AlertCreateParams::GroupValue] }
 
         # @!attribute invoice_types_filter
         #   Only supported for invoice_total_reached alerts. A list of invoice types to
@@ -104,7 +105,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_key_filter: 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, uniqueness_key: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::V1::AlertCreateParams} for more details.
         #
@@ -126,7 +127,7 @@ module MetronomeSDK
         #
         #   @param evaluate_on_create [Boolean] If true, the alert will evaluate immediately on customers that already meet the
         #
-        #   @param group_key_filter [MetronomeSDK::Models::V1::AlertCreateParams::GroupKeyFilter] Scopes alert evaluation to a specific presentation group key on individual line
+        #   @param group_values [Array<MetronomeSDK::Models::V1::AlertCreateParams::GroupValue>] Only present for `spend_threshold_reached` alerts. Scope alert to a specific gro
         #
         #   @param invoice_types_filter [Array<String>] Only supported for invoice_total_reached alerts. A list of invoice types to eval
         #
@@ -195,7 +196,7 @@ module MetronomeSDK
           end
         end
 
-        class GroupKeyFilter < MetronomeSDK::Internal::Type::BaseModel
+        class GroupValue < MetronomeSDK::Internal::Type::BaseModel
           # @!attribute key
           #
           #   @return [String]
@@ -207,9 +208,6 @@ module MetronomeSDK
           required :value, String
 
           # @!method initialize(key:, value:)
-          #   Scopes alert evaluation to a specific presentation group key on individual line
-          #   items. Only present for spend alerts.
-          #
           #   @param key [String]
           #   @param value [String]
         end