metronome-sdk 0.1.0 → 0.2.0

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

@@ -5373,6 +5373,24 @@ module MetronomeSDK
           end
           attr_writer :specifiers
 
+          # Attach a subscription to the recurring commit/credit.
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig
+              )
+            )
+          end
+          attr_reader :subscription_config
+
+          sig do
+            params(
+              subscription_config:
+                MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::OrHash
+            ).void
+          end
+          attr_writer :subscription_config
+
           # A temporary ID that can be used to reference the recurring commit for commit
           # specific overrides.
           sig { returns(T.nilable(String)) }
@@ -5411,6 +5429,8 @@ module MetronomeSDK
                 T::Array[
                   MetronomeSDK::V1::ContractCreateParams::RecurringCommit::Specifier::OrHash
                 ],
+              subscription_config:
+                MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::OrHash,
               temporary_id: String
             ).returns(T.attached_class)
           end
@@ -5462,6 +5482,8 @@ module MetronomeSDK
             # specifiers to contribute to a commit's or credit's drawdown. This field cannot
             # be used together with `applicable_product_ids` or `applicable_product_tags`.
             specifiers: nil,
+            # Attach a subscription to the recurring commit/credit.
+            subscription_config: nil,
             # A temporary ID that can be used to reference the recurring commit for commit
             # specific overrides.
             temporary_id: nil
@@ -5499,6 +5521,8 @@ module MetronomeSDK
                   T::Array[
                     MetronomeSDK::V1::ContractCreateParams::RecurringCommit::Specifier
                   ],
+                subscription_config:
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig,
                 temporary_id: String
               }
             )
@@ -6153,6 +6177,141 @@ module MetronomeSDK
             def to_hash
             end
           end
+
+          class SubscriptionConfig < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig do
+              returns(
+                MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::ApplySeatIncreaseConfig
+              )
+            end
+            attr_reader :apply_seat_increase_config
+
+            sig do
+              params(
+                apply_seat_increase_config:
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::ApplySeatIncreaseConfig::OrHash
+              ).void
+            end
+            attr_writer :apply_seat_increase_config
+
+            # ID of the subscription to configure on the recurring commit/credit.
+            sig { returns(String) }
+            attr_accessor :subscription_id
+
+            # If set to POOLED, allocation added per seat is pooled across the account.
+            sig do
+              returns(
+                T.nilable(
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation::OrSymbol
+                )
+              )
+            end
+            attr_reader :allocation
+
+            sig do
+              params(
+                allocation:
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation::OrSymbol
+              ).void
+            end
+            attr_writer :allocation
+
+            # Attach a subscription to the recurring commit/credit.
+            sig do
+              params(
+                apply_seat_increase_config:
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::ApplySeatIncreaseConfig::OrHash,
+                subscription_id: String,
+                allocation:
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              apply_seat_increase_config:,
+              # ID of the subscription to configure on the recurring commit/credit.
+              subscription_id:,
+              # If set to POOLED, allocation added per seat is pooled across the account.
+              allocation: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  apply_seat_increase_config:
+                    MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::ApplySeatIncreaseConfig,
+                  subscription_id: String,
+                  allocation:
+                    MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation::OrSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class ApplySeatIncreaseConfig < MetronomeSDK::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    MetronomeSDK::V1::ContractCreateParams::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
+
+            # If set to POOLED, allocation added per seat is pooled across the account.
+            module Allocation
+              extend MetronomeSDK::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              POOLED =
+                T.let(
+                  :POOLED,
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
         end
 
         class RecurringCredit < MetronomeSDK::Internal::Type::BaseModel
@@ -6362,6 +6521,24 @@ module MetronomeSDK
           end
           attr_writer :specifiers
 
+          # Attach a subscription to the recurring commit/credit.
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig
+              )
+            )
+          end
+          attr_reader :subscription_config
+
+          sig do
+            params(
+              subscription_config:
+                MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::OrHash
+            ).void
+          end
+          attr_writer :subscription_config
+
           # A temporary ID that can be used to reference the recurring commit for commit
           # specific overrides.
           sig { returns(T.nilable(String)) }
@@ -6398,6 +6575,8 @@ module MetronomeSDK
                 T::Array[
                   MetronomeSDK::V1::ContractCreateParams::RecurringCredit::Specifier::OrHash
                 ],
+              subscription_config:
+                MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::OrHash,
               temporary_id: String
             ).returns(T.attached_class)
           end
@@ -6447,6 +6626,8 @@ module MetronomeSDK
             # specifiers to contribute to a commit's or credit's drawdown. This field cannot
             # be used together with `applicable_product_ids` or `applicable_product_tags`.
             specifiers: nil,
+            # Attach a subscription to the recurring commit/credit.
+            subscription_config: nil,
             # A temporary ID that can be used to reference the recurring commit for commit
             # specific overrides.
             temporary_id: nil
@@ -6482,6 +6663,8 @@ module MetronomeSDK
                   T::Array[
                     MetronomeSDK::V1::ContractCreateParams::RecurringCredit::Specifier
                   ],
+                subscription_config:
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig,
                 temporary_id: String
               }
             )
@@ -7098,6 +7281,141 @@ module MetronomeSDK
             def to_hash
             end
           end
+
+          class SubscriptionConfig < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig do
+              returns(
+                MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::ApplySeatIncreaseConfig
+              )
+            end
+            attr_reader :apply_seat_increase_config
+
+            sig do
+              params(
+                apply_seat_increase_config:
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::ApplySeatIncreaseConfig::OrHash
+              ).void
+            end
+            attr_writer :apply_seat_increase_config
+
+            # ID of the subscription to configure on the recurring commit/credit.
+            sig { returns(String) }
+            attr_accessor :subscription_id
+
+            # If set to POOLED, allocation added per seat is pooled across the account.
+            sig do
+              returns(
+                T.nilable(
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation::OrSymbol
+                )
+              )
+            end
+            attr_reader :allocation
+
+            sig do
+              params(
+                allocation:
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation::OrSymbol
+              ).void
+            end
+            attr_writer :allocation
+
+            # Attach a subscription to the recurring commit/credit.
+            sig do
+              params(
+                apply_seat_increase_config:
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::ApplySeatIncreaseConfig::OrHash,
+                subscription_id: String,
+                allocation:
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              apply_seat_increase_config:,
+              # ID of the subscription to configure on the recurring commit/credit.
+              subscription_id:,
+              # If set to POOLED, allocation added per seat is pooled across the account.
+              allocation: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  apply_seat_increase_config:
+                    MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::ApplySeatIncreaseConfig,
+                  subscription_id: String,
+                  allocation:
+                    MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation::OrSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class ApplySeatIncreaseConfig < MetronomeSDK::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    MetronomeSDK::V1::ContractCreateParams::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
+
+            # If set to POOLED, allocation added per seat is pooled across the account.
+            module Allocation
+              extend MetronomeSDK::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              POOLED =
+                T.let(
+                  :POOLED,
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
         end
 
         class ResellerRoyalty < MetronomeSDK::Internal::Type::BaseModel
@@ -8437,6 +8755,14 @@ module MetronomeSDK
           sig { params(starting_at: Time).void }
           attr_writer :starting_at
 
+          # A temporary ID used to reference the subscription in recurring commit/credit
+          # subscription configs created within the same payload.
+          sig { returns(T.nilable(String)) }
+          attr_reader :temporary_id
+
+          sig { params(temporary_id: String).void }
+          attr_writer :temporary_id
+
           sig do
             params(
               collection_schedule:
@@ -8450,7 +8776,8 @@ module MetronomeSDK
               description: String,
               ending_before: Time,
               name: String,
-              starting_at: Time
+              starting_at: Time,
+              temporary_id: String
             ).returns(T.attached_class)
           end
           def self.new(
@@ -8467,7 +8794,10 @@ module MetronomeSDK
             name: nil,
             # Inclusive start time for the subscription. If not provided, defaults to contract
             # start date
-            starting_at: nil
+            starting_at: nil,
+            # A temporary ID used to reference the subscription in recurring commit/credit
+            # subscription configs created within the same payload.
+            temporary_id: nil
           )
           end
 
@@ -8485,7 +8815,8 @@ module MetronomeSDK
                 description: String,
                 ending_before: Time,
                 name: String,
-                starting_at: Time
+                starting_at: Time,
+                temporary_id: String
               }
             )
           end
@@ -8535,10 +8866,11 @@ module MetronomeSDK
                 )
               end
 
-            # Indicates how mid-period quantity adjustments are invoiced. If BILL_IMMEDIATELY
-            # is selected, the quantity increase will be billed on the scheduled date. If
-            # BILL_ON_NEXT_COLLECTION_DATE is selected, the quantity increase will be billed
-            # for in-arrears at the end of the period.
+            # Indicates how mid-period quantity adjustments are invoiced.
+            # **BILL_IMMEDIATELY**: Only available when collection schedule is `ADVANCE`. The
+            # quantity increase will be billed immediately on the scheduled date.
+            # **BILL_ON_NEXT_COLLECTION_DATE**: The quantity increase will be billed for
+            # in-arrears at the end of the period.
             sig do
               returns(
                 T.nilable(
@@ -8571,10 +8903,11 @@ module MetronomeSDK
               ).returns(T.attached_class)
             end
             def self.new(
-              # Indicates how mid-period quantity adjustments are invoiced. If BILL_IMMEDIATELY
-              # is selected, the quantity increase will be billed on the scheduled date. If
-              # BILL_ON_NEXT_COLLECTION_DATE is selected, the quantity increase will be billed
-              # for in-arrears at the end of the period.
+              # Indicates how mid-period quantity adjustments are invoiced.
+              # **BILL_IMMEDIATELY**: Only available when collection schedule is `ADVANCE`. The
+              # quantity increase will be billed immediately on the scheduled date.
+              # **BILL_ON_NEXT_COLLECTION_DATE**: The quantity increase will be billed for
+              # in-arrears at the end of the period.
               invoice_behavior: nil,
               # Indicates if the partial period will be prorated or charged a full amount.
               is_prorated: nil
@@ -8593,10 +8926,11 @@ module MetronomeSDK
             def to_hash
             end
 
-            # Indicates how mid-period quantity adjustments are invoiced. If BILL_IMMEDIATELY
-            # is selected, the quantity increase will be billed on the scheduled date. If
-            # BILL_ON_NEXT_COLLECTION_DATE is selected, the quantity increase will be billed
-            # for in-arrears at the end of the period.
+            # Indicates how mid-period quantity adjustments are invoiced.
+            # **BILL_IMMEDIATELY**: Only available when collection schedule is `ADVANCE`. The
+            # quantity increase will be billed immediately on the scheduled date.
+            # **BILL_ON_NEXT_COLLECTION_DATE**: The quantity increase will be billed for
+            # in-arrears at the end of the period.
             module InvoiceBehavior
               extend MetronomeSDK::Internal::Type::Enum
 

data/rbi/metronome_sdk/models/v1/customers/customer_alert.rbi

@@ -176,6 +176,29 @@ module MetronomeSDK
             end
             attr_writer :group_key_filter
 
+            # Only present for `spend_threshold_reached` alerts. Scope alert to a specific
+            # group key on individual line items.
+            sig do
+              returns(
+                T.nilable(
+                  T::Array[
+                    MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupValue
+                  ]
+                )
+              )
+            end
+            attr_reader :group_values
+
+            sig do
+              params(
+                group_values:
+                  T::Array[
+                    MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupValue::OrHash
+                  ]
+              ).void
+            end
+            attr_writer :group_values
+
             # Only supported for invoice_total_reached alerts. A list of invoice types to
             # evaluate.
             sig { returns(T.nilable(T::Array[String])) }
@@ -211,6 +234,10 @@ module MetronomeSDK
                   ],
                 group_key_filter:
                   MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupKeyFilter::OrHash,
+                group_values:
+                  T::Array[
+                    MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupValue::OrHash
+                  ],
                 invoice_types_filter: T::Array[String],
                 uniqueness_key: String
               ).returns(T.attached_class)
@@ -238,6 +265,9 @@ module MetronomeSDK
               # 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,
@@ -267,6 +297,10 @@ module MetronomeSDK
                     ],
                   group_key_filter:
                     MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupKeyFilter,
+                  group_values:
+                    T::Array[
+                      MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupValue
+                    ],
                   invoice_types_filter: T::Array[String],
                   uniqueness_key: String
                 }
@@ -523,6 +557,32 @@ module MetronomeSDK
               def to_hash
               end
             end
+
+            class GroupValue < MetronomeSDK::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupValue,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(String) }
+              attr_accessor :key
+
+              sig { returns(String) }
+              attr_accessor :value
+
+              sig do
+                params(key: String, value: String).returns(T.attached_class)
+              end
+              def self.new(key:, value:)
+              end
+
+              sig { override.returns({ key: String, value: String }) }
+              def to_hash
+              end
+            end
           end
 
           # The status of the customer alert. If the alert is archived, null will be

data/rbi/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbi

@@ -424,6 +424,16 @@ module MetronomeSDK
                 :Primary_red,
                 MetronomeSDK::V1::DashboardGetEmbeddableURLParams::ColorOverride::Name::TaggedSymbol
               )
+            PROGRESS_BAR =
+              T.let(
+                :Progress_bar,
+                MetronomeSDK::V1::DashboardGetEmbeddableURLParams::ColorOverride::Name::TaggedSymbol
+              )
+            PROGRESS_BAR_BACKGROUND =
+              T.let(
+                :Progress_bar_background,
+                MetronomeSDK::V1::DashboardGetEmbeddableURLParams::ColorOverride::Name::TaggedSymbol
+              )
 
             sig do
               override.returns(

data/rbi/metronome_sdk/models/v2/contract_edit_commit_params.rbi

@@ -86,6 +86,8 @@ module MetronomeSDK
         # 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. This field cannot
         # be used together with `applicable_product_ids` or `applicable_product_tags`.
+        # Instead, to target usage by product or product tag, pass those values in the
+        # body of `specifiers`.
         sig do
           returns(
             T.nilable(
@@ -138,6 +140,8 @@ module MetronomeSDK
           # 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. This field cannot
           # be used together with `applicable_product_ids` or `applicable_product_tags`.
+          # Instead, to target usage by product or product tag, pass those values in the
+          # body of `specifiers`.
           specifiers: nil,
           request_options: {}
         )

data/rbi/metronome_sdk/models/v2/contract_edit_credit_params.rbi

@@ -60,6 +60,8 @@ module MetronomeSDK
         # 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. This field cannot
         # be used together with `applicable_product_ids` or `applicable_product_tags`.
+        # Instead, to target usage by product or product tag, pass those values in the
+        # body of `specifiers`.
         sig do
           returns(
             T.nilable(
@@ -104,6 +106,8 @@ module MetronomeSDK
           # 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. This field cannot
           # be used together with `applicable_product_ids` or `applicable_product_tags`.
+          # Instead, to target usage by product or product tag, pass those values in the
+          # body of `specifiers`.
           specifiers: nil,
           request_options: {}
         )