metronome-sdk 3.7.0 → 3.8.0

data/rbi/metronome_sdk/models/subscription.rbi

@@ -73,6 +73,17 @@ module MetronomeSDK
       sig { params(id: String).void }
       attr_writer :id
 
+      sig { returns(T.nilable(MetronomeSDK::Subscription::BillingCycleConfig)) }
+      attr_reader :billing_cycle_config
+
+      sig do
+        params(
+          billing_cycle_config:
+            MetronomeSDK::Subscription::BillingCycleConfig::OrHash
+        ).void
+      end
+      attr_writer :billing_cycle_config
+
       # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
       sig { returns(T.nilable(T::Hash[Symbol, String])) }
       attr_reader :custom_fields
@@ -126,6 +137,8 @@ module MetronomeSDK
           subscription_rate:
             MetronomeSDK::Subscription::SubscriptionRate::OrHash,
           id: String,
+          billing_cycle_config:
+            MetronomeSDK::Subscription::BillingCycleConfig::OrHash,
           custom_fields: T::Hash[Symbol, String],
           description: String,
           ending_before: Time,
@@ -155,6 +168,7 @@ module MetronomeSDK
         starting_at:,
         subscription_rate:,
         id: nil,
+        billing_cycle_config: nil,
         # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         custom_fields: nil,
         description: nil,
@@ -179,6 +193,8 @@ module MetronomeSDK
             starting_at: Time,
             subscription_rate: MetronomeSDK::Subscription::SubscriptionRate,
             id: String,
+            billing_cycle_config:
+              MetronomeSDK::Subscription::BillingCycleConfig,
             custom_fields: T::Hash[Symbol, String],
             description: String,
             ending_before: Time,
@@ -401,14 +417,27 @@ module MetronomeSDK
         sig { returns(T::Boolean) }
         attr_accessor :is_prorated
 
+        sig do
+          returns(T.nilable(MetronomeSDK::Subscription::Proration::Rounding))
+        end
+        attr_reader :rounding
+
+        sig do
+          params(
+            rounding: MetronomeSDK::Subscription::Proration::Rounding::OrHash
+          ).void
+        end
+        attr_writer :rounding
+
         sig do
           params(
             invoice_behavior:
               MetronomeSDK::Subscription::Proration::InvoiceBehavior::OrSymbol,
-            is_prorated: T::Boolean
+            is_prorated: T::Boolean,
+            rounding: MetronomeSDK::Subscription::Proration::Rounding::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(invoice_behavior:, is_prorated:)
+        def self.new(invoice_behavior:, is_prorated:, rounding: nil)
         end
 
         sig do
@@ -416,7 +445,8 @@ module MetronomeSDK
             {
               invoice_behavior:
                 MetronomeSDK::Subscription::Proration::InvoiceBehavior::TaggedSymbol,
-              is_prorated: T::Boolean
+              is_prorated: T::Boolean,
+              rounding: MetronomeSDK::Subscription::Proration::Rounding
             }
           )
         end
@@ -456,6 +486,98 @@ module MetronomeSDK
           def self.values
           end
         end
+
+        class Rounding < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::Subscription::Proration::Rounding,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          # Number of decimal places to round to. Applied directly to the stored monetary
+          # representation. Negative values round to powers of 10 (e.g., -2 rounds to
+          # nearest 100 in the stored unit. For USD, this means rounding to the nearest
+          # dollar).
+          sig { returns(Float) }
+          attr_accessor :decimal_places
+
+          sig do
+            returns(
+              MetronomeSDK::Subscription::Proration::Rounding::RoundingMethod::TaggedSymbol
+            )
+          end
+          attr_accessor :rounding_method
+
+          sig do
+            params(
+              decimal_places: Float,
+              rounding_method:
+                MetronomeSDK::Subscription::Proration::Rounding::RoundingMethod::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Number of decimal places to round to. Applied directly to the stored monetary
+            # representation. Negative values round to powers of 10 (e.g., -2 rounds to
+            # nearest 100 in the stored unit. For USD, this means rounding to the nearest
+            # dollar).
+            decimal_places:,
+            rounding_method:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                decimal_places: Float,
+                rounding_method:
+                  MetronomeSDK::Subscription::Proration::Rounding::RoundingMethod::TaggedSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module RoundingMethod
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::Subscription::Proration::Rounding::RoundingMethod
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            HALF_UP =
+              T.let(
+                :HALF_UP,
+                MetronomeSDK::Subscription::Proration::Rounding::RoundingMethod::TaggedSymbol
+              )
+            FLOOR =
+              T.let(
+                :FLOOR,
+                MetronomeSDK::Subscription::Proration::Rounding::RoundingMethod::TaggedSymbol
+              )
+            CEILING =
+              T.let(
+                :CEILING,
+                MetronomeSDK::Subscription::Proration::Rounding::RoundingMethod::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::Subscription::Proration::Rounding::RoundingMethod::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
       end
 
       # Determines how the subscription's quantity is controlled. Defaults to
@@ -657,6 +779,93 @@ module MetronomeSDK
         end
       end
 
+      class BillingCycleConfig < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::Subscription::BillingCycleConfig,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        # The date this subscription's billing cycle is anchored to.
+        sig { returns(Time) }
+        attr_accessor :anchor_date
+
+        # Controls whether this subscription consolidates onto usage invoices or gets its
+        # own scheduled invoice.
+        sig do
+          returns(
+            MetronomeSDK::Subscription::BillingCycleConfig::InvoicePlacement::TaggedSymbol
+          )
+        end
+        attr_accessor :invoice_placement
+
+        sig do
+          params(
+            anchor_date: Time,
+            invoice_placement:
+              MetronomeSDK::Subscription::BillingCycleConfig::InvoicePlacement::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The date this subscription's billing cycle is anchored to.
+          anchor_date:,
+          # Controls whether this subscription consolidates onto usage invoices or gets its
+          # own scheduled invoice.
+          invoice_placement:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              anchor_date: Time,
+              invoice_placement:
+                MetronomeSDK::Subscription::BillingCycleConfig::InvoicePlacement::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Controls whether this subscription consolidates onto usage invoices or gets its
+        # own scheduled invoice.
+        module InvoicePlacement
+          extend MetronomeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                MetronomeSDK::Subscription::BillingCycleConfig::InvoicePlacement
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ON_SCHEDULED_INVOICE =
+            T.let(
+              :ON_SCHEDULED_INVOICE,
+              MetronomeSDK::Subscription::BillingCycleConfig::InvoicePlacement::TaggedSymbol
+            )
+          ON_USAGE_INVOICE =
+            T.let(
+              :ON_USAGE_INVOICE,
+              MetronomeSDK::Subscription::BillingCycleConfig::InvoicePlacement::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                MetronomeSDK::Subscription::BillingCycleConfig::InvoicePlacement::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
       class SeatConfig < MetronomeSDK::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

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

@@ -31,6 +31,28 @@ module MetronomeSDK
         sig { returns(Float) }
         attr_accessor :threshold
 
+        # Can be used with only `low_remaining_contract_credit_and_commit_balance_reached`
+        # notifications. Defines the balances that are considered when evaluating the
+        # alert.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[MetronomeSDK::V1::AlertCreateParams::AlertSpecifier]
+            )
+          )
+        end
+        attr_reader :alert_specifiers
+
+        sig do
+          params(
+            alert_specifiers:
+              T::Array[
+                MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::OrHash
+              ]
+          ).void
+        end
+        attr_writer :alert_specifiers
+
         # For threshold notifications of type `usage_threshold_reached`, specifies which
         # billable metric to track the usage for.
         sig { returns(T.nilable(String)) }
@@ -158,6 +180,10 @@ module MetronomeSDK
               MetronomeSDK::V1::AlertCreateParams::AlertType::OrSymbol,
             name: String,
             threshold: Float,
+            alert_specifiers:
+              T::Array[
+                MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::OrHash
+              ],
             billable_metric_id: String,
             credit_grant_type_filters: T::Array[String],
             credit_type_id: String,
@@ -186,6 +212,10 @@ module MetronomeSDK
           # type, this number may represent a financial amount, the days remaining, or a
           # percentage reached.
           threshold:,
+          # Can be used with only `low_remaining_contract_credit_and_commit_balance_reached`
+          # notifications. Defines the balances that are considered when evaluating the
+          # alert.
+          alert_specifiers: nil,
           # For threshold notifications of type `usage_threshold_reached`, specifies which
           # billable metric to track the usage for.
           billable_metric_id: nil,
@@ -235,6 +265,8 @@ module MetronomeSDK
                 MetronomeSDK::V1::AlertCreateParams::AlertType::OrSymbol,
               name: String,
               threshold: Float,
+              alert_specifiers:
+                T::Array[MetronomeSDK::V1::AlertCreateParams::AlertSpecifier],
               billable_metric_id: String,
               credit_grant_type_filters: T::Array[String],
               credit_type_id: String,
@@ -354,6 +386,347 @@ module MetronomeSDK
           end
         end
 
+        class AlertSpecifier < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::V1::AlertCreateParams::AlertSpecifier,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          # A list of custom field filters for notification types that support advanced
+          # filtering
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::CustomFieldFilter
+                ]
+              )
+            )
+          end
+          attr_reader :custom_field_filters
+
+          sig do
+            params(
+              custom_field_filters:
+                T::Array[
+                  MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::CustomFieldFilter::OrHash
+                ]
+            ).void
+          end
+          attr_writer :custom_field_filters
+
+          # If provided, the specifier will not apply to balances that matches the inclusion
+          # criteria and any of the excluding values.
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::Exclude
+                ]
+              )
+            )
+          end
+          attr_reader :exclude
+
+          sig do
+            params(
+              exclude:
+                T::Array[
+                  MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::Exclude::OrHash
+                ]
+            ).void
+          end
+          attr_writer :exclude
+
+          sig do
+            params(
+              custom_field_filters:
+                T::Array[
+                  MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::CustomFieldFilter::OrHash
+                ],
+              exclude:
+                T::Array[
+                  MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::Exclude::OrHash
+                ]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # A list of custom field filters for notification types that support advanced
+            # filtering
+            custom_field_filters: nil,
+            # If provided, the specifier will not apply to balances that matches the inclusion
+            # criteria and any of the excluding values.
+            exclude: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                custom_field_filters:
+                  T::Array[
+                    MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::CustomFieldFilter
+                  ],
+                exclude:
+                  T::Array[
+                    MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::Exclude
+                  ]
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class CustomFieldFilter < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::CustomFieldFilter,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig do
+              returns(
+                MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::CustomFieldFilter::Entity::OrSymbol
+              )
+            end
+            attr_accessor :entity
+
+            sig { returns(String) }
+            attr_accessor :key
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :value
+
+            sig { params(value: String).void }
+            attr_writer :value
+
+            sig do
+              params(
+                entity:
+                  MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::CustomFieldFilter::Entity::OrSymbol,
+                key: String,
+                value: String
+              ).returns(T.attached_class)
+            end
+            def self.new(entity:, key:, value: nil)
+            end
+
+            sig do
+              override.returns(
+                {
+                  entity:
+                    MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::CustomFieldFilter::Entity::OrSymbol,
+                  key: String,
+                  value: String
+                }
+              )
+            end
+            def to_hash
+            end
+
+            module Entity
+              extend MetronomeSDK::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::CustomFieldFilter::Entity
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              CONTRACT =
+                T.let(
+                  :Contract,
+                  MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::CustomFieldFilter::Entity::TaggedSymbol
+                )
+              COMMIT =
+                T.let(
+                  :Commit,
+                  MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::CustomFieldFilter::Entity::TaggedSymbol
+                )
+              CONTRACT_CREDIT =
+                T.let(
+                  :ContractCredit,
+                  MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::CustomFieldFilter::Entity::TaggedSymbol
+                )
+              CONTRACT_CREDIT_OR_COMMIT =
+                T.let(
+                  :ContractCreditOrCommit,
+                  MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::CustomFieldFilter::Entity::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::CustomFieldFilter::Entity::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+
+          class Exclude < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::Exclude,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            # A list of custom field filters for notification types that support advanced
+            # filtering
+            sig do
+              returns(
+                T.nilable(
+                  T::Array[
+                    MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::Exclude::CustomFieldFilter
+                  ]
+                )
+              )
+            end
+            attr_reader :custom_field_filters
+
+            sig do
+              params(
+                custom_field_filters:
+                  T::Array[
+                    MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::Exclude::CustomFieldFilter::OrHash
+                  ]
+              ).void
+            end
+            attr_writer :custom_field_filters
+
+            sig do
+              params(
+                custom_field_filters:
+                  T::Array[
+                    MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::Exclude::CustomFieldFilter::OrHash
+                  ]
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # A list of custom field filters for notification types that support advanced
+              # filtering
+              custom_field_filters: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  custom_field_filters:
+                    T::Array[
+                      MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::Exclude::CustomFieldFilter
+                    ]
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class CustomFieldFilter < MetronomeSDK::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::Exclude::CustomFieldFilter,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              sig do
+                returns(
+                  MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::Exclude::CustomFieldFilter::Entity::OrSymbol
+                )
+              end
+              attr_accessor :entity
+
+              sig { returns(String) }
+              attr_accessor :key
+
+              sig { returns(String) }
+              attr_accessor :value
+
+              sig do
+                params(
+                  entity:
+                    MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::Exclude::CustomFieldFilter::Entity::OrSymbol,
+                  key: String,
+                  value: String
+                ).returns(T.attached_class)
+              end
+              def self.new(entity:, key:, value:)
+              end
+
+              sig do
+                override.returns(
+                  {
+                    entity:
+                      MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::Exclude::CustomFieldFilter::Entity::OrSymbol,
+                    key: String,
+                    value: String
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              module Entity
+                extend MetronomeSDK::Internal::Type::Enum
+
+                TaggedSymbol =
+                  T.type_alias do
+                    T.all(
+                      Symbol,
+                      MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::Exclude::CustomFieldFilter::Entity
+                    )
+                  end
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                CONTRACT =
+                  T.let(
+                    :Contract,
+                    MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::Exclude::CustomFieldFilter::Entity::TaggedSymbol
+                  )
+                COMMIT =
+                  T.let(
+                    :Commit,
+                    MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::Exclude::CustomFieldFilter::Entity::TaggedSymbol
+                  )
+                CONTRACT_CREDIT =
+                  T.let(
+                    :ContractCredit,
+                    MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::Exclude::CustomFieldFilter::Entity::TaggedSymbol
+                  )
+                CONTRACT_CREDIT_OR_COMMIT =
+                  T.let(
+                    :ContractCreditOrCommit,
+                    MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::Exclude::CustomFieldFilter::Entity::TaggedSymbol
+                  )
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      MetronomeSDK::V1::AlertCreateParams::AlertSpecifier::Exclude::CustomFieldFilter::Entity::TaggedSymbol
+                    ]
+                  )
+                end
+                def self.values
+                end
+              end
+            end
+          end
+        end
+
         class CustomFieldFilter < MetronomeSDK::Internal::Type::BaseModel
           OrHash =
             T.type_alias do