metronome-sdk 2.0.0 → 2.2.0

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

@@ -66,6 +66,25 @@ module MetronomeSDK
           end
           attr_writer :plans_or_contracts
 
+          # Only allowed for `low_remaining_seat_balance_reached` notifications. This
+          # filters alerts by the seat group key-value pair.
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::V1::Customers::AlertRetrieveParams::SeatFilter
+              )
+            )
+          end
+          attr_reader :seat_filter
+
+          sig do
+            params(
+              seat_filter:
+                MetronomeSDK::V1::Customers::AlertRetrieveParams::SeatFilter::OrHash
+            ).void
+          end
+          attr_writer :seat_filter
+
           sig do
             params(
               alert_id: String,
@@ -76,6 +95,8 @@ module MetronomeSDK
                 ],
               plans_or_contracts:
                 MetronomeSDK::V1::Customers::AlertRetrieveParams::PlansOrContracts::OrSymbol,
+              seat_filter:
+                MetronomeSDK::V1::Customers::AlertRetrieveParams::SeatFilter::OrHash,
               request_options: MetronomeSDK::RequestOptions::OrHash
             ).returns(T.attached_class)
           end
@@ -90,6 +111,9 @@ module MetronomeSDK
             # When parallel threshold notifications are enabled during migration, this flag
             # denotes whether to fetch notifications for plans or contracts.
             plans_or_contracts: nil,
+            # Only allowed for `low_remaining_seat_balance_reached` notifications. This
+            # filters alerts by the seat group key-value pair.
+            seat_filter: nil,
             request_options: {}
           )
           end
@@ -105,6 +129,8 @@ module MetronomeSDK
                   ],
                 plans_or_contracts:
                   MetronomeSDK::V1::Customers::AlertRetrieveParams::PlansOrContracts::OrSymbol,
+                seat_filter:
+                  MetronomeSDK::V1::Customers::AlertRetrieveParams::SeatFilter,
                 request_options: MetronomeSDK::RequestOptions
               }
             )
@@ -173,6 +199,47 @@ module MetronomeSDK
             def self.values
             end
           end
+
+          class SeatFilter < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::V1::Customers::AlertRetrieveParams::SeatFilter,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            # The seat group key (e.g., "seat_id", "user_id")
+            sig { returns(String) }
+            attr_accessor :seat_group_key
+
+            # The specific seat identifier to filter by
+            sig { returns(String) }
+            attr_accessor :seat_group_value
+
+            # Only allowed for `low_remaining_seat_balance_reached` notifications. This
+            # filters alerts by the seat group key-value pair.
+            sig do
+              params(seat_group_key: String, seat_group_value: String).returns(
+                T.attached_class
+              )
+            end
+            def self.new(
+              # The seat group key (e.g., "seat_id", "user_id")
+              seat_group_key:,
+              # The specific seat identifier to filter by
+              seat_group_value:
+            )
+            end
+
+            sig do
+              override.returns(
+                { seat_group_key: String, seat_group_value: String }
+              )
+            end
+            def to_hash
+            end
+          end
         end
       end
     end

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

@@ -31,6 +31,18 @@ module MetronomeSDK
           sig { returns(String) }
           attr_accessor :billing_provider_customer_id
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :aws_customer_account_id
+
+          sig { params(aws_customer_account_id: String).void }
+          attr_writer :aws_customer_account_id
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :aws_customer_id
+
+          sig { params(aws_customer_id: String).void }
+          attr_writer :aws_customer_id
+
           sig { returns(T.nilable(String)) }
           attr_reader :aws_product_code
 
@@ -54,6 +66,8 @@ module MetronomeSDK
           end
           attr_writer :aws_region
 
+          # The collection method for the customer's invoices. NOTE:
+          # `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
           sig do
             returns(
               T.nilable(
@@ -77,6 +91,8 @@ module MetronomeSDK
               billing_provider_type:
                 MetronomeSDK::V1::Customers::BillingConfigCreateParams::BillingProviderType::OrSymbol,
               billing_provider_customer_id: String,
+              aws_customer_account_id: String,
+              aws_customer_id: String,
               aws_product_code: String,
               aws_region:
                 MetronomeSDK::V1::Customers::BillingConfigCreateParams::AwsRegion::OrSymbol,
@@ -91,8 +107,12 @@ module MetronomeSDK
             # The customer ID in the billing provider's system. For Azure, this is the
             # subscription ID.
             billing_provider_customer_id:,
+            aws_customer_account_id: nil,
+            aws_customer_id: nil,
             aws_product_code: nil,
             aws_region: nil,
+            # The collection method for the customer's invoices. NOTE:
+            # `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
             stripe_collection_method: nil,
             request_options: {}
           )
@@ -105,6 +125,8 @@ module MetronomeSDK
                 billing_provider_type:
                   MetronomeSDK::V1::Customers::BillingConfigCreateParams::BillingProviderType::OrSymbol,
                 billing_provider_customer_id: String,
+                aws_customer_account_id: String,
+                aws_customer_id: String,
                 aws_product_code: String,
                 aws_region:
                   MetronomeSDK::V1::Customers::BillingConfigCreateParams::AwsRegion::OrSymbol,
@@ -169,6 +191,11 @@ module MetronomeSDK
                 :gcp_marketplace,
                 MetronomeSDK::V1::Customers::BillingConfigCreateParams::BillingProviderType::TaggedSymbol
               )
+            METRONOME =
+              T.let(
+                :metronome,
+                MetronomeSDK::V1::Customers::BillingConfigCreateParams::BillingProviderType::TaggedSymbol
+              )
 
             sig do
               override.returns(
@@ -330,6 +357,8 @@ module MetronomeSDK
             end
           end
 
+          # The collection method for the customer's invoices. NOTE:
+          # `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
           module StripeCollectionMethod
             extend MetronomeSDK::Internal::Type::Enum
 

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

@@ -106,6 +106,11 @@ module MetronomeSDK
                 :gcp_marketplace,
                 MetronomeSDK::V1::Customers::BillingConfigDeleteParams::BillingProviderType::TaggedSymbol
               )
+            METRONOME =
+              T.let(
+                :metronome,
+                MetronomeSDK::V1::Customers::BillingConfigDeleteParams::BillingProviderType::TaggedSymbol
+              )
 
             sig do
               override.returns(

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

@@ -106,6 +106,11 @@ module MetronomeSDK
                 :gcp_marketplace,
                 MetronomeSDK::V1::Customers::BillingConfigRetrieveParams::BillingProviderType::TaggedSymbol
               )
+            METRONOME =
+              T.let(
+                :metronome,
+                MetronomeSDK::V1::Customers::BillingConfigRetrieveParams::BillingProviderType::TaggedSymbol
+              )
 
             sig do
               override.returns(

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

@@ -57,6 +57,18 @@ module MetronomeSDK
                 )
               end
 
+            sig { returns(T.nilable(String)) }
+            attr_reader :aws_customer_account_id
+
+            sig { params(aws_customer_account_id: String).void }
+            attr_writer :aws_customer_account_id
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :aws_customer_id
+
+            sig { params(aws_customer_id: String).void }
+            attr_writer :aws_customer_id
+
             # Contract expiration date for the customer. The expected format is RFC 3339 and
             # can be retrieved from
             # [AWS's GetEntitlements API](https://docs.aws.amazon.com/marketplaceentitlement/latest/APIReference/API_GetEntitlements.html).
@@ -143,6 +155,8 @@ module MetronomeSDK
             sig { params(billing_provider_customer_id: String).void }
             attr_writer :billing_provider_customer_id
 
+            # The collection method for the customer's invoices. NOTE:
+            # `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
             sig do
               returns(
                 T.nilable(
@@ -162,6 +176,8 @@ module MetronomeSDK
 
             sig do
               params(
+                aws_customer_account_id: String,
+                aws_customer_id: String,
                 aws_expiration_date: Time,
                 aws_is_subscription_product: T::Boolean,
                 aws_product_code: String,
@@ -178,6 +194,8 @@ module MetronomeSDK
               ).returns(T.attached_class)
             end
             def self.new(
+              aws_customer_account_id: nil,
+              aws_customer_id: nil,
               # Contract expiration date for the customer. The expected format is RFC 3339 and
               # can be retrieved from
               # [AWS's GetEntitlements API](https://docs.aws.amazon.com/marketplaceentitlement/latest/APIReference/API_GetEntitlements.html).
@@ -197,6 +215,8 @@ module MetronomeSDK
               azure_start_date: nil,
               azure_subscription_status: nil,
               billing_provider_customer_id: nil,
+              # The collection method for the customer's invoices. NOTE:
+              # `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
               stripe_collection_method: nil
             )
             end
@@ -204,6 +224,8 @@ module MetronomeSDK
             sig do
               override.returns(
                 {
+                  aws_customer_account_id: String,
+                  aws_customer_id: String,
                   aws_expiration_date: Time,
                   aws_is_subscription_product: T::Boolean,
                   aws_product_code: String,
@@ -416,6 +438,8 @@ module MetronomeSDK
               end
             end
 
+            # The collection method for the customer's invoices. NOTE:
+            # `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
             module StripeCollectionMethod
               extend MetronomeSDK::Internal::Type::Enum
 

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

@@ -95,7 +95,7 @@ module MetronomeSDK
 
           # The contract that this commit will be billed on. This is required for "POSTPAID"
           # commits and for "PREPAID" commits unless there is no invoice schedule above
-          # (i.e., the commit is 'free').
+          # (i.e., the commit is 'free'), or if do_not_invoice is set to true.
           sig { returns(T.nilable(String)) }
           attr_reader :invoice_contract_id
 
@@ -243,7 +243,7 @@ module MetronomeSDK
             description: nil,
             # The contract that this commit will be billed on. This is required for "POSTPAID"
             # commits and for "PREPAID" commits unless there is no invoice schedule above
-            # (i.e., the commit is 'free').
+            # (i.e., the commit is 'free'), or if do_not_invoice is set to true.
             invoice_contract_id: nil,
             # Required for "POSTPAID" commits: the true up invoice will be generated at this
             # time and only one schedule item is allowed; the total must match

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

@@ -209,6 +209,25 @@ module MetronomeSDK
             sig { params(invoice_types_filter: T::Array[String]).void }
             attr_writer :invoice_types_filter
 
+            # Only present for low_remaining_seat_balance_reached notifications. The seat
+            # group key or seat group key-value pair the alert is scoped to.
+            sig do
+              returns(
+                T.nilable(
+                  MetronomeSDK::V1::Customers::CustomerAlert::Alert::SeatFilter
+                )
+              )
+            end
+            attr_reader :seat_filter
+
+            sig do
+              params(
+                seat_filter:
+                  MetronomeSDK::V1::Customers::CustomerAlert::Alert::SeatFilter::OrHash
+              ).void
+            end
+            attr_writer :seat_filter
+
             # Prevents the creation of duplicates. If a request to create a record is made
             # with a previously used uniqueness key, a new record will not be created and the
             # request will fail with a 409 error.
@@ -241,6 +260,8 @@ module MetronomeSDK
                     MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupValue::OrHash
                   ],
                 invoice_types_filter: T::Array[String],
+                seat_filter:
+                  MetronomeSDK::V1::Customers::CustomerAlert::Alert::SeatFilter::OrHash,
                 uniqueness_key: String
               ).returns(T.attached_class)
             end
@@ -275,6 +296,9 @@ module MetronomeSDK
               # Only supported for invoice_total_reached threshold notifications. A list of
               # invoice types to evaluate.
               invoice_types_filter: nil,
+              # Only present for low_remaining_seat_balance_reached notifications. The seat
+              # group key or seat group key-value pair the alert is scoped to.
+              seat_filter: nil,
               # Prevents the creation of duplicates. If a request to create a record is made
               # with a previously used uniqueness key, a new record will not be created and the
               # request will fail with a 409 error.
@@ -306,6 +330,8 @@ module MetronomeSDK
                       MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupValue
                     ],
                   invoice_types_filter: T::Array[String],
+                  seat_filter:
+                    MetronomeSDK::V1::Customers::CustomerAlert::Alert::SeatFilter,
                   uniqueness_key: String
                 }
               )
@@ -431,6 +457,11 @@ module MetronomeSDK
                   :low_remaining_contract_credit_and_commit_balance_reached,
                   MetronomeSDK::V1::Customers::CustomerAlert::Alert::Type::TaggedSymbol
                 )
+              LOW_REMAINING_SEAT_BALANCE_REACHED =
+                T.let(
+                  :low_remaining_seat_balance_reached,
+                  MetronomeSDK::V1::Customers::CustomerAlert::Alert::Type::TaggedSymbol
+                )
               INVOICE_TOTAL_REACHED =
                 T.let(
                   :invoice_total_reached,
@@ -590,6 +621,51 @@ module MetronomeSDK
               def to_hash
               end
             end
+
+            class SeatFilter < MetronomeSDK::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    MetronomeSDK::V1::Customers::CustomerAlert::Alert::SeatFilter,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              # The seat group key (e.g., "seat_id", "user_id") that the alert is scoped to.
+              sig { returns(String) }
+              attr_accessor :seat_group_key
+
+              # The seat group value that the alert is scoped to.
+              sig { returns(T.nilable(String)) }
+              attr_reader :seat_group_value
+
+              sig { params(seat_group_value: String).void }
+              attr_writer :seat_group_value
+
+              # Only present for low_remaining_seat_balance_reached notifications. The seat
+              # group key or seat group key-value pair the alert is scoped to.
+              sig do
+                params(
+                  seat_group_key: String,
+                  seat_group_value: String
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # The seat group key (e.g., "seat_id", "user_id") that the alert is scoped to.
+                seat_group_key:,
+                # The seat group value that the alert is scoped to.
+                seat_group_value: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  { seat_group_key: String, seat_group_value: String }
+                )
+              end
+              def to_hash
+              end
+            end
           end
 
           # The status of the threshold notification. If the notification is archived, null