metronome-sdk 2.2.0 → 3.0.0

data/rbi/metronome_sdk/models/credit.rbi

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

data/rbi/metronome_sdk/models/rate.rbi

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

data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbi

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

data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbi

@@ -129,15 +129,6 @@ module MetronomeSDK
             sig { params(tiers: T::Array[MetronomeSDK::Tier::OrHash]).void }
             attr_writer :tiers
 
-            # Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
-            # using list prices rather than the standard rates for this product on the
-            # contract.
-            sig { returns(T.nilable(T::Boolean)) }
-            attr_reader :use_list_prices
-
-            sig { params(use_list_prices: T::Boolean).void }
-            attr_writer :use_list_prices
-
             sig do
               params(
                 entitled: T::Boolean,
@@ -157,7 +148,6 @@ module MetronomeSDK
                 pricing_group_values: T::Hash[Symbol, String],
                 quantity: Float,
                 tiers: T::Array[MetronomeSDK::Tier::OrHash],
-                use_list_prices: T::Boolean,
                 request_options: MetronomeSDK::RequestOptions::OrHash
               ).returns(T.attached_class)
             end
@@ -199,10 +189,6 @@ module MetronomeSDK
               quantity: nil,
               # Only set for TIERED rate_type.
               tiers: nil,
-              # Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
-              # using list prices rather than the standard rates for this product on the
-              # contract.
-              use_list_prices: nil,
               request_options: {}
             )
             end
@@ -227,7 +213,6 @@ module MetronomeSDK
                   pricing_group_values: T::Hash[Symbol, String],
                   quantity: Float,
                   tiers: T::Array[MetronomeSDK::Tier],
-                  use_list_prices: T::Boolean,
                   request_options: MetronomeSDK::RequestOptions
                 }
               )

data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbi

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

data/rbi/metronome_sdk/models/v1/custom_field_add_key_params.rbi

@@ -150,6 +150,26 @@ module MetronomeSDK
               :subscription,
               MetronomeSDK::V1::CustomFieldAddKeyParams::Entity::TaggedSymbol
             )
+          PACKAGE_COMMIT =
+            T.let(
+              :package_commit,
+              MetronomeSDK::V1::CustomFieldAddKeyParams::Entity::TaggedSymbol
+            )
+          PACKAGE_CREDIT =
+            T.let(
+              :package_credit,
+              MetronomeSDK::V1::CustomFieldAddKeyParams::Entity::TaggedSymbol
+            )
+          PACKAGE_SUBSCRIPTION =
+            T.let(
+              :package_subscription,
+              MetronomeSDK::V1::CustomFieldAddKeyParams::Entity::TaggedSymbol
+            )
+          PACKAGE_SCHEDULED_CHARGE =
+            T.let(
+              :package_scheduled_charge,
+              MetronomeSDK::V1::CustomFieldAddKeyParams::Entity::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/metronome_sdk/models/v1/custom_field_delete_values_params.rbi

@@ -156,6 +156,26 @@ module MetronomeSDK
               :subscription,
               MetronomeSDK::V1::CustomFieldDeleteValuesParams::Entity::TaggedSymbol
             )
+          PACKAGE_COMMIT =
+            T.let(
+              :package_commit,
+              MetronomeSDK::V1::CustomFieldDeleteValuesParams::Entity::TaggedSymbol
+            )
+          PACKAGE_CREDIT =
+            T.let(
+              :package_credit,
+              MetronomeSDK::V1::CustomFieldDeleteValuesParams::Entity::TaggedSymbol
+            )
+          PACKAGE_SUBSCRIPTION =
+            T.let(
+              :package_subscription,
+              MetronomeSDK::V1::CustomFieldDeleteValuesParams::Entity::TaggedSymbol
+            )
+          PACKAGE_SCHEDULED_CHARGE =
+            T.let(
+              :package_scheduled_charge,
+              MetronomeSDK::V1::CustomFieldDeleteValuesParams::Entity::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/metronome_sdk/models/v1/custom_field_list_keys_params.rbi

@@ -177,6 +177,26 @@ module MetronomeSDK
               :subscription,
               MetronomeSDK::V1::CustomFieldListKeysParams::Entity::TaggedSymbol
             )
+          PACKAGE_COMMIT =
+            T.let(
+              :package_commit,
+              MetronomeSDK::V1::CustomFieldListKeysParams::Entity::TaggedSymbol
+            )
+          PACKAGE_CREDIT =
+            T.let(
+              :package_credit,
+              MetronomeSDK::V1::CustomFieldListKeysParams::Entity::TaggedSymbol
+            )
+          PACKAGE_SUBSCRIPTION =
+            T.let(
+              :package_subscription,
+              MetronomeSDK::V1::CustomFieldListKeysParams::Entity::TaggedSymbol
+            )
+          PACKAGE_SCHEDULED_CHARGE =
+            T.let(
+              :package_scheduled_charge,
+              MetronomeSDK::V1::CustomFieldListKeysParams::Entity::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/metronome_sdk/models/v1/custom_field_list_keys_response.rbi

@@ -151,6 +151,26 @@ module MetronomeSDK
               :subscription,
               MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::TaggedSymbol
             )
+          PACKAGE_COMMIT =
+            T.let(
+              :package_commit,
+              MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::TaggedSymbol
+            )
+          PACKAGE_CREDIT =
+            T.let(
+              :package_credit,
+              MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::TaggedSymbol
+            )
+          PACKAGE_SUBSCRIPTION =
+            T.let(
+              :package_subscription,
+              MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::TaggedSymbol
+            )
+          PACKAGE_SCHEDULED_CHARGE =
+            T.let(
+              :package_scheduled_charge,
+              MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/metronome_sdk/models/v1/custom_field_remove_key_params.rbi

@@ -151,6 +151,26 @@ module MetronomeSDK
               :subscription,
               MetronomeSDK::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol
             )
+          PACKAGE_COMMIT =
+            T.let(
+              :package_commit,
+              MetronomeSDK::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol
+            )
+          PACKAGE_CREDIT =
+            T.let(
+              :package_credit,
+              MetronomeSDK::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol
+            )
+          PACKAGE_SUBSCRIPTION =
+            T.let(
+              :package_subscription,
+              MetronomeSDK::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol
+            )
+          PACKAGE_SCHEDULED_CHARGE =
+            T.let(
+              :package_scheduled_charge,
+              MetronomeSDK::V1::CustomFieldRemoveKeyParams::Entity::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/metronome_sdk/models/v1/custom_field_set_values_params.rbi

@@ -163,6 +163,26 @@ module MetronomeSDK
               :subscription,
               MetronomeSDK::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol
             )
+          PACKAGE_COMMIT =
+            T.let(
+              :package_commit,
+              MetronomeSDK::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol
+            )
+          PACKAGE_CREDIT =
+            T.let(
+              :package_credit,
+              MetronomeSDK::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol
+            )
+          PACKAGE_SUBSCRIPTION =
+            T.let(
+              :package_subscription,
+              MetronomeSDK::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol
+            )
+          PACKAGE_SCHEDULED_CHARGE =
+            T.let(
+              :package_scheduled_charge,
+              MetronomeSDK::V1::CustomFieldSetValuesParams::Entity::TaggedSymbol
+            )
 
           sig do
             override.returns(