metronome-sdk 0.1.0 → 0.2.0

data/rbi/metronome_sdk/models/contract_without_amendments.rbi

@@ -1660,6 +1660,24 @@ module MetronomeSDK
         end
         attr_writer :specifiers
 
+        # Attach a subscription to the recurring commit/credit.
+        sig do
+          returns(
+            T.nilable(
+              MetronomeSDK::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig
+            )
+          )
+        end
+        attr_reader :subscription_config
+
+        sig do
+          params(
+            subscription_config:
+              MetronomeSDK::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig::OrHash
+          ).void
+        end
+        attr_writer :subscription_config
+
         sig do
           params(
             id: String,
@@ -1693,7 +1711,9 @@ module MetronomeSDK
             specifiers:
               T::Array[
                 MetronomeSDK::ContractWithoutAmendments::RecurringCommit::Specifier::OrHash
-              ]
+              ],
+            subscription_config:
+              MetronomeSDK::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
@@ -1742,7 +1762,9 @@ module MetronomeSDK
           # List of filters that determine what kind of customer usage draws down a commit
           # or credit. A customer's usage needs to meet the condition of at least one of the
           # specifiers to contribute to a commit's or credit's drawdown.
-          specifiers: nil
+          specifiers: nil,
+          # Attach a subscription to the recurring commit/credit.
+          subscription_config: nil
         )
         end
 
@@ -1780,7 +1802,9 @@ module MetronomeSDK
               specifiers:
                 T::Array[
                   MetronomeSDK::ContractWithoutAmendments::RecurringCommit::Specifier
-                ]
+                ],
+              subscription_config:
+                MetronomeSDK::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig
             }
           )
         end
@@ -2461,6 +2485,131 @@ module MetronomeSDK
           def to_hash
           end
         end
+
+        class SubscriptionConfig < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              MetronomeSDK::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig::Allocation::TaggedSymbol
+            )
+          end
+          attr_accessor :allocation
+
+          sig do
+            returns(
+              MetronomeSDK::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig::ApplySeatIncreaseConfig
+            )
+          end
+          attr_reader :apply_seat_increase_config
+
+          sig do
+            params(
+              apply_seat_increase_config:
+                MetronomeSDK::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig::ApplySeatIncreaseConfig::OrHash
+            ).void
+          end
+          attr_writer :apply_seat_increase_config
+
+          sig { returns(String) }
+          attr_accessor :subscription_id
+
+          # Attach a subscription to the recurring commit/credit.
+          sig do
+            params(
+              allocation:
+                MetronomeSDK::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig::Allocation::OrSymbol,
+              apply_seat_increase_config:
+                MetronomeSDK::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig::ApplySeatIncreaseConfig::OrHash,
+              subscription_id: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            allocation:,
+            apply_seat_increase_config:,
+            subscription_id:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                allocation:
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig::Allocation::TaggedSymbol,
+                apply_seat_increase_config:
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig::ApplySeatIncreaseConfig,
+                subscription_id: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module Allocation
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig::Allocation
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            INDIVIDUAL =
+              T.let(
+                :INDIVIDUAL,
+                MetronomeSDK::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig::Allocation::TaggedSymbol
+              )
+            POOLED =
+              T.let(
+                :POOLED,
+                MetronomeSDK::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig::Allocation::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig::Allocation::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          class ApplySeatIncreaseConfig < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::SubscriptionConfig::ApplySeatIncreaseConfig,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            # Indicates whether a mid-period seat increase should be prorated.
+            sig { returns(T::Boolean) }
+            attr_accessor :is_prorated
+
+            sig { params(is_prorated: T::Boolean).returns(T.attached_class) }
+            def self.new(
+              # Indicates whether a mid-period seat increase should be prorated.
+              is_prorated:
+            )
+            end
+
+            sig { override.returns({ is_prorated: T::Boolean }) }
+            def to_hash
+            end
+          end
+        end
       end
 
       class RecurringCredit < MetronomeSDK::Internal::Type::BaseModel
@@ -2689,6 +2838,24 @@ module MetronomeSDK
         end
         attr_writer :specifiers
 
+        # Attach a subscription to the recurring commit/credit.
+        sig do
+          returns(
+            T.nilable(
+              MetronomeSDK::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig
+            )
+          )
+        end
+        attr_reader :subscription_config
+
+        sig do
+          params(
+            subscription_config:
+              MetronomeSDK::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig::OrHash
+          ).void
+        end
+        attr_writer :subscription_config
+
         sig do
           params(
             id: String,
@@ -2720,7 +2887,9 @@ module MetronomeSDK
             specifiers:
               T::Array[
                 MetronomeSDK::ContractWithoutAmendments::RecurringCredit::Specifier::OrHash
-              ]
+              ],
+            subscription_config:
+              MetronomeSDK::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
@@ -2767,7 +2936,9 @@ module MetronomeSDK
           # List of filters that determine what kind of customer usage draws down a commit
           # or credit. A customer's usage needs to meet the condition of at least one of the
           # specifiers to contribute to a commit's or credit's drawdown.
-          specifiers: nil
+          specifiers: nil,
+          # Attach a subscription to the recurring commit/credit.
+          subscription_config: nil
         )
         end
 
@@ -2803,7 +2974,9 @@ module MetronomeSDK
               specifiers:
                 T::Array[
                   MetronomeSDK::ContractWithoutAmendments::RecurringCredit::Specifier
-                ]
+                ],
+              subscription_config:
+                MetronomeSDK::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig
             }
           )
         end
@@ -3446,6 +3619,131 @@ module MetronomeSDK
           def to_hash
           end
         end
+
+        class SubscriptionConfig < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              MetronomeSDK::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig::Allocation::TaggedSymbol
+            )
+          end
+          attr_accessor :allocation
+
+          sig do
+            returns(
+              MetronomeSDK::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig::ApplySeatIncreaseConfig
+            )
+          end
+          attr_reader :apply_seat_increase_config
+
+          sig do
+            params(
+              apply_seat_increase_config:
+                MetronomeSDK::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig::ApplySeatIncreaseConfig::OrHash
+            ).void
+          end
+          attr_writer :apply_seat_increase_config
+
+          sig { returns(String) }
+          attr_accessor :subscription_id
+
+          # Attach a subscription to the recurring commit/credit.
+          sig do
+            params(
+              allocation:
+                MetronomeSDK::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig::Allocation::OrSymbol,
+              apply_seat_increase_config:
+                MetronomeSDK::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig::ApplySeatIncreaseConfig::OrHash,
+              subscription_id: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            allocation:,
+            apply_seat_increase_config:,
+            subscription_id:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                allocation:
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig::Allocation::TaggedSymbol,
+                apply_seat_increase_config:
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig::ApplySeatIncreaseConfig,
+                subscription_id: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module Allocation
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig::Allocation
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            INDIVIDUAL =
+              T.let(
+                :INDIVIDUAL,
+                MetronomeSDK::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig::Allocation::TaggedSymbol
+              )
+            POOLED =
+              T.let(
+                :POOLED,
+                MetronomeSDK::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig::Allocation::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig::Allocation::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          class ApplySeatIncreaseConfig < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::SubscriptionConfig::ApplySeatIncreaseConfig,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            # Indicates whether a mid-period seat increase should be prorated.
+            sig { returns(T::Boolean) }
+            attr_accessor :is_prorated
+
+            sig { params(is_prorated: T::Boolean).returns(T.attached_class) }
+            def self.new(
+              # Indicates whether a mid-period seat increase should be prorated.
+              is_prorated:
+            )
+            end
+
+            sig { override.returns({ is_prorated: T::Boolean }) }
+            def to_hash
+            end
+          end
+        end
       end
 
       class ResellerRoyalty < MetronomeSDK::Internal::Type::BaseModel

data/rbi/metronome_sdk/models/credit.rbi

@@ -740,6 +740,12 @@ module MetronomeSDK
           end
           attr_accessor :type
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :contract_id
+
+          sig { params(contract_id: String).void }
+          attr_writer :contract_id
+
           sig do
             params(
               amount: Float,
@@ -747,10 +753,18 @@ module MetronomeSDK
               segment_id: String,
               timestamp: Time,
               type:
-                MetronomeSDK::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry::Type::OrSymbol
+                MetronomeSDK::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry::Type::OrSymbol,
+              contract_id: String
             ).returns(T.attached_class)
           end
-          def self.new(amount:, invoice_id:, segment_id:, timestamp:, type:)
+          def self.new(
+            amount:,
+            invoice_id:,
+            segment_id:,
+            timestamp:,
+            type:,
+            contract_id: nil
+          )
           end
 
           sig do
@@ -761,7 +775,8 @@ module MetronomeSDK
                 segment_id: String,
                 timestamp: Time,
                 type:
-                  MetronomeSDK::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry::Type::TaggedSymbol
+                  MetronomeSDK::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry::Type::TaggedSymbol,
+                contract_id: String
               }
             )
           end
@@ -907,6 +922,12 @@ module MetronomeSDK
           end
           attr_accessor :type
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :contract_id
+
+          sig { params(contract_id: String).void }
+          attr_writer :contract_id
+
           sig do
             params(
               amount: Float,
@@ -914,10 +935,18 @@ module MetronomeSDK
               segment_id: String,
               timestamp: Time,
               type:
-                MetronomeSDK::Credit::Ledger::CreditCanceledLedgerEntry::Type::OrSymbol
+                MetronomeSDK::Credit::Ledger::CreditCanceledLedgerEntry::Type::OrSymbol,
+              contract_id: String
             ).returns(T.attached_class)
           end
-          def self.new(amount:, invoice_id:, segment_id:, timestamp:, type:)
+          def self.new(
+            amount:,
+            invoice_id:,
+            segment_id:,
+            timestamp:,
+            type:,
+            contract_id: nil
+          )
           end
 
           sig do
@@ -928,7 +957,8 @@ module MetronomeSDK
                 segment_id: String,
                 timestamp: Time,
                 type:
-                  MetronomeSDK::Credit::Ledger::CreditCanceledLedgerEntry::Type::TaggedSymbol
+                  MetronomeSDK::Credit::Ledger::CreditCanceledLedgerEntry::Type::TaggedSymbol,
+                contract_id: String
               }
             )
           end
@@ -993,6 +1023,12 @@ module MetronomeSDK
           end
           attr_accessor :type
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :contract_id
+
+          sig { params(contract_id: String).void }
+          attr_writer :contract_id
+
           sig do
             params(
               amount: Float,
@@ -1000,10 +1036,18 @@ module MetronomeSDK
               segment_id: String,
               timestamp: Time,
               type:
-                MetronomeSDK::Credit::Ledger::CreditCreditedLedgerEntry::Type::OrSymbol
+                MetronomeSDK::Credit::Ledger::CreditCreditedLedgerEntry::Type::OrSymbol,
+              contract_id: String
             ).returns(T.attached_class)
           end
-          def self.new(amount:, invoice_id:, segment_id:, timestamp:, type:)
+          def self.new(
+            amount:,
+            invoice_id:,
+            segment_id:,
+            timestamp:,
+            type:,
+            contract_id: nil
+          )
           end
 
           sig do
@@ -1014,7 +1058,8 @@ module MetronomeSDK
                 segment_id: String,
                 timestamp: Time,
                 type:
-                  MetronomeSDK::Credit::Ledger::CreditCreditedLedgerEntry::Type::TaggedSymbol
+                  MetronomeSDK::Credit::Ledger::CreditCreditedLedgerEntry::Type::TaggedSymbol,
+                contract_id: String
               }
             )
           end

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

@@ -94,22 +94,22 @@ module MetronomeSDK
         sig { params(evaluate_on_create: T::Boolean).void }
         attr_writer :evaluate_on_create
 
-        # Scopes alert evaluation to a specific presentation group key on individual line
-        # items. Only present for spend alerts.
+        # Only present for `spend_threshold_reached` alerts. Scope alert to a specific
+        # group key on individual line items.
         sig do
           returns(
-            T.nilable(MetronomeSDK::V1::AlertCreateParams::GroupKeyFilter)
+            T.nilable(T::Array[MetronomeSDK::V1::AlertCreateParams::GroupValue])
           )
         end
-        attr_reader :group_key_filter
+        attr_reader :group_values
 
         sig do
           params(
-            group_key_filter:
-              MetronomeSDK::V1::AlertCreateParams::GroupKeyFilter::OrHash
+            group_values:
+              T::Array[MetronomeSDK::V1::AlertCreateParams::GroupValue::OrHash]
           ).void
         end
-        attr_writer :group_key_filter
+        attr_writer :group_values
 
         # Only supported for invoice_total_reached alerts. A list of invoice types to
         # evaluate.
@@ -151,8 +151,8 @@ module MetronomeSDK
               ],
             customer_id: String,
             evaluate_on_create: T::Boolean,
-            group_key_filter:
-              MetronomeSDK::V1::AlertCreateParams::GroupKeyFilter::OrHash,
+            group_values:
+              T::Array[MetronomeSDK::V1::AlertCreateParams::GroupValue::OrHash],
             invoice_types_filter: T::Array[String],
             plan_id: String,
             uniqueness_key: String,
@@ -188,9 +188,9 @@ module MetronomeSDK
           # alert threshold. If false, it will only evaluate on future customers that
           # trigger the alert threshold. Defaults to true.
           evaluate_on_create: nil,
-          # Scopes alert evaluation to a specific presentation group key on individual line
-          # items. Only present for spend alerts.
-          group_key_filter: nil,
+          # Only present for `spend_threshold_reached` alerts. Scope alert to a specific
+          # group key on individual line items.
+          group_values: nil,
           # Only supported for invoice_total_reached alerts. A list of invoice types to
           # evaluate.
           invoice_types_filter: nil,
@@ -221,8 +221,8 @@ module MetronomeSDK
                 ],
               customer_id: String,
               evaluate_on_create: T::Boolean,
-              group_key_filter:
-                MetronomeSDK::V1::AlertCreateParams::GroupKeyFilter,
+              group_values:
+                T::Array[MetronomeSDK::V1::AlertCreateParams::GroupValue],
               invoice_types_filter: T::Array[String],
               plan_id: String,
               uniqueness_key: String,
@@ -411,11 +411,11 @@ module MetronomeSDK
           end
         end
 
-        class GroupKeyFilter < MetronomeSDK::Internal::Type::BaseModel
+        class GroupValue < MetronomeSDK::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
               T.any(
-                MetronomeSDK::V1::AlertCreateParams::GroupKeyFilter,
+                MetronomeSDK::V1::AlertCreateParams::GroupValue,
                 MetronomeSDK::Internal::AnyHash
               )
             end
@@ -426,8 +426,6 @@ module MetronomeSDK
           sig { returns(String) }
           attr_accessor :value
 
-          # Scopes alert evaluation to a specific presentation group key on individual line
-          # items. Only present for spend alerts.
           sig { params(key: String, value: String).returns(T.attached_class) }
           def self.new(key:, value:)
           end