metronome-sdk 1.0.0 → 2.1.0

data/rbi/metronome_sdk/models/v1/customer_create_params.rbi

@@ -177,6 +177,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(
@@ -214,6 +216,8 @@ module MetronomeSDK
             aws_is_subscription_product: 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
           )
           end
@@ -288,6 +292,11 @@ module MetronomeSDK
                 :gcp_marketplace,
                 MetronomeSDK::V1::CustomerCreateParams::BillingConfig::BillingProviderType::TaggedSymbol
               )
+            METRONOME =
+              T.let(
+                :metronome,
+                MetronomeSDK::V1::CustomerCreateParams::BillingConfig::BillingProviderType::TaggedSymbol
+              )
 
             sig do
               override.returns(
@@ -449,6 +458,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/customer_detail.rbi

@@ -48,6 +48,10 @@ module MetronomeSDK
         sig { returns(String) }
         attr_accessor :name
 
+        # RFC 3339 timestamp indicating when the customer was last updated.
+        sig { returns(Time) }
+        attr_accessor :updated_at
+
         # RFC 3339 timestamp indicating when the customer was archived. Null if the
         # customer is active.
         sig { returns(T.nilable(Time)) }
@@ -79,6 +83,7 @@ module MetronomeSDK
             external_id: String,
             ingest_aliases: T::Array[String],
             name: String,
+            updated_at: Time,
             archived_at: T.nilable(Time),
             current_billable_status:
               MetronomeSDK::V1::CustomerDetail::CurrentBillableStatus::OrHash
@@ -99,6 +104,8 @@ module MetronomeSDK
           # in usage events
           ingest_aliases:,
           name:,
+          # RFC 3339 timestamp indicating when the customer was last updated.
+          updated_at:,
           # RFC 3339 timestamp indicating when the customer was archived. Null if the
           # customer is active.
           archived_at: nil,
@@ -117,6 +124,7 @@ module MetronomeSDK
               external_id: String,
               ingest_aliases: T::Array[String],
               name: String,
+              updated_at: Time,
               archived_at: T.nilable(Time),
               current_billable_status:
                 MetronomeSDK::V1::CustomerDetail::CurrentBillableStatus

data/rbi/metronome_sdk/models/v1/customer_preview_events_params.rbi

@@ -18,6 +18,8 @@ module MetronomeSDK
         sig { returns(String) }
         attr_accessor :customer_id
 
+        # Array of usage events to include in the preview calculation. Must contain at
+        # least one event in `merge` mode.
         sig do
           returns(
             T::Array[MetronomeSDK::V1::CustomerPreviewEventsParams::Event]
@@ -25,9 +27,10 @@ module MetronomeSDK
         end
         attr_accessor :events
 
-        # If set to "replace", the preview will be generated as if those were the only
-        # events for the specified customer. If set to "merge", the events will be merged
-        # with any existing events for the specified customer. Defaults to "replace".
+        # Controls how the provided events are combined with existing usage data. Use
+        # `replace` to calculate the preview as if these are the only events for the
+        # customer, ignoring all historical usage. Use `merge` to combine these events
+        # with the customer's existing usage. Defaults to `replace`.
         sig do
           returns(
             T.nilable(
@@ -44,7 +47,7 @@ module MetronomeSDK
         end
         attr_writer :mode
 
-        # If set, all zero quantity line items will be filtered out of the response.
+        # When `true`, line items with zero quantity are excluded from the response.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :skip_zero_qty_line_items
 
@@ -65,12 +68,15 @@ module MetronomeSDK
         end
         def self.new(
           customer_id:,
+          # Array of usage events to include in the preview calculation. Must contain at
+          # least one event in `merge` mode.
           events:,
-          # If set to "replace", the preview will be generated as if those were the only
-          # events for the specified customer. If set to "merge", the events will be merged
-          # with any existing events for the specified customer. Defaults to "replace".
+          # Controls how the provided events are combined with existing usage data. Use
+          # `replace` to calculate the preview as if these are the only events for the
+          # customer, ignoring all historical usage. Use `merge` to combine these events
+          # with the customer's existing usage. Defaults to `replace`.
           mode: nil,
-          # If set, all zero quantity line items will be filtered out of the response.
+          # When `true`, line items with zero quantity are excluded from the response.
           skip_zero_qty_line_items: nil,
           request_options: {}
         )
@@ -104,15 +110,6 @@ module MetronomeSDK
           sig { returns(String) }
           attr_accessor :event_type
 
-          # This has no effect for preview events, but may be set for consistency with Event
-          # objects. They will be processed even if they do not match the customer's ID or
-          # ingest aliases.
-          sig { returns(T.nilable(String)) }
-          attr_reader :customer_id
-
-          sig { params(customer_id: String).void }
-          attr_writer :customer_id
-
           sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
           attr_reader :properties
 
@@ -126,9 +123,9 @@ module MetronomeSDK
           sig { params(timestamp: String).void }
           attr_writer :timestamp
 
-          # This has no effect for preview events, but may be set for consistency with Event
-          # objects. Duplicate transaction_ids are NOT filtered out, even within the same
-          # request.
+          # Optional unique identifier for event deduplication. When provided, preview
+          # events are automatically deduplicated against historical events from the past 34
+          # days. Duplicate transaction IDs within the same request will return an error.
           sig { returns(T.nilable(String)) }
           attr_reader :transaction_id
 
@@ -138,7 +135,6 @@ module MetronomeSDK
           sig do
             params(
               event_type: String,
-              customer_id: String,
               properties: T::Hash[Symbol, T.anything],
               timestamp: String,
               transaction_id: String
@@ -146,16 +142,12 @@ module MetronomeSDK
           end
           def self.new(
             event_type:,
-            # This has no effect for preview events, but may be set for consistency with Event
-            # objects. They will be processed even if they do not match the customer's ID or
-            # ingest aliases.
-            customer_id: nil,
             properties: nil,
             # RFC 3339 formatted. If not provided, the current time will be used.
             timestamp: nil,
-            # This has no effect for preview events, but may be set for consistency with Event
-            # objects. Duplicate transaction_ids are NOT filtered out, even within the same
-            # request.
+            # Optional unique identifier for event deduplication. When provided, preview
+            # events are automatically deduplicated against historical events from the past 34
+            # days. Duplicate transaction IDs within the same request will return an error.
             transaction_id: nil
           )
           end
@@ -164,7 +156,6 @@ module MetronomeSDK
             override.returns(
               {
                 event_type: String,
-                customer_id: String,
                 properties: T::Hash[Symbol, T.anything],
                 timestamp: String,
                 transaction_id: String
@@ -175,9 +166,10 @@ module MetronomeSDK
           end
         end
 
-        # If set to "replace", the preview will be generated as if those were the only
-        # events for the specified customer. If set to "merge", the events will be merged
-        # with any existing events for the specified customer. Defaults to "replace".
+        # Controls how the provided events are combined with existing usage data. Use
+        # `replace` to calculate the preview as if these are the only events for the
+        # customer, ignoring all historical usage. Use `merge` to combine these events
+        # with the customer's existing usage. Defaults to `replace`.
         module Mode
           extend MetronomeSDK::Internal::Type::Enum
 

data/rbi/metronome_sdk/models/v1/customer_preview_events_response.rbi

@@ -12,21 +12,22 @@ module MetronomeSDK
             )
           end
 
-        sig { returns(MetronomeSDK::V1::Customers::Invoice) }
-        attr_reader :data
-
-        sig { params(data: MetronomeSDK::V1::Customers::Invoice::OrHash).void }
-        attr_writer :data
+        sig { returns(T::Array[MetronomeSDK::V1::Customers::Invoice]) }
+        attr_accessor :data
 
         sig do
-          params(data: MetronomeSDK::V1::Customers::Invoice::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            data: T::Array[MetronomeSDK::V1::Customers::Invoice::OrHash]
+          ).returns(T.attached_class)
         end
         def self.new(data:)
         end
 
-        sig { override.returns({ data: MetronomeSDK::V1::Customers::Invoice }) }
+        sig do
+          override.returns(
+            { data: T::Array[MetronomeSDK::V1::Customers::Invoice] }
+          )
+        end
         def to_hash
         end
       end

data/rbi/metronome_sdk/models/v1/customer_retrieve_billing_configurations_response.rbi

@@ -202,6 +202,11 @@ module MetronomeSDK
                 :gcp_marketplace,
                 MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data::BillingProvider::TaggedSymbol
               )
+            METRONOME =
+              T.let(
+                :metronome,
+                MetronomeSDK::Models::V1::CustomerRetrieveBillingConfigurationsResponse::Data::BillingProvider::TaggedSymbol
+              )
 
             sig do
               override.returns(

data/rbi/metronome_sdk/models/v1/customer_set_billing_configurations_params.rbi

@@ -241,6 +241,11 @@ module MetronomeSDK
                 :gcp_marketplace,
                 MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::BillingProvider::TaggedSymbol
               )
+            METRONOME =
+              T.let(
+                :metronome,
+                MetronomeSDK::V1::CustomerSetBillingConfigurationsParams::Data::BillingProvider::TaggedSymbol
+              )
 
             sig do
               override.returns(

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

@@ -27,8 +27,8 @@ module MetronomeSDK
           sig { params(next_page: String).void }
           attr_writer :next_page
 
-          # Optionally filter by alert status. If absent, only enabled alerts will be
-          # returned.
+          # Optionally filter by threshold notification status. If absent, only enabled
+          # notifications will be returned.
           sig do
             returns(
               T.nilable(
@@ -66,8 +66,8 @@ module MetronomeSDK
             customer_id:,
             # Cursor that indicates where the next page of results should start.
             next_page: nil,
-            # Optionally filter by alert status. If absent, only enabled alerts will be
-            # returned.
+            # Optionally filter by threshold notification status. If absent, only enabled
+            # notifications will be returned.
             alert_statuses: nil,
             request_options: {}
           )

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

@@ -16,7 +16,7 @@ module MetronomeSDK
               )
             end
 
-          # The Metronome ID of the alert
+          # The Metronome ID of the threshold notification
           sig { returns(String) }
           attr_accessor :alert_id
 
@@ -32,7 +32,7 @@ module MetronomeSDK
             ).returns(T.attached_class)
           end
           def self.new(
-            # The Metronome ID of the alert
+            # The Metronome ID of the threshold notification
             alert_id:,
             # The Metronome ID of the customer
             customer_id:,

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

@@ -16,7 +16,7 @@ module MetronomeSDK
               )
             end
 
-          # The Metronome ID of the alert
+          # The Metronome ID of the threshold notification
           sig { returns(String) }
           attr_accessor :alert_id
 
@@ -24,8 +24,8 @@ module MetronomeSDK
           sig { returns(String) }
           attr_accessor :customer_id
 
-          # Only present for `spend_threshold_reached` alerts. Retrieve the alert for a
-          # specific group key-value pair.
+          # Only present for `spend_threshold_reached` notifications. Retrieve the
+          # notification for a specific group key-value pair.
           sig do
             returns(
               T.nilable(
@@ -47,8 +47,8 @@ module MetronomeSDK
           end
           attr_writer :group_values
 
-          # When parallel alerts are enabled during migration, this flag denotes whether to
-          # fetch alerts for plans or contracts.
+          # When parallel threshold notifications are enabled during migration, this flag
+          # denotes whether to fetch notifications for plans or contracts.
           sig do
             returns(
               T.nilable(
@@ -80,15 +80,15 @@ module MetronomeSDK
             ).returns(T.attached_class)
           end
           def self.new(
-            # The Metronome ID of the alert
+            # The Metronome ID of the threshold notification
             alert_id:,
             # The Metronome ID of the customer
             customer_id:,
-            # Only present for `spend_threshold_reached` alerts. Retrieve the alert for a
-            # specific group key-value pair.
+            # Only present for `spend_threshold_reached` notifications. Retrieve the
+            # notification for a specific group key-value pair.
             group_values: nil,
-            # When parallel alerts are enabled during migration, this flag denotes whether to
-            # fetch alerts for plans or contracts.
+            # When parallel threshold notifications are enabled during migration, this flag
+            # denotes whether to fetch notifications for plans or contracts.
             plans_or_contracts: nil,
             request_options: {}
           )
@@ -127,8 +127,8 @@ 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.
+            # Scopes threshold notification evaluation to a specific presentation group key on
+            # individual line items. Only present for spend notifications.
             sig { params(key: String, value: String).returns(T.attached_class) }
             def self.new(key:, value:)
             end
@@ -138,8 +138,8 @@ module MetronomeSDK
             end
           end
 
-          # When parallel alerts are enabled during migration, this flag denotes whether to
-          # fetch alerts for plans or contracts.
+          # When parallel threshold notifications are enabled during migration, this flag
+          # denotes whether to fetch notifications for plans or contracts.
           module PlansOrContracts
             extend MetronomeSDK::Internal::Type::Enum
 

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

@@ -54,6 +54,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(
@@ -93,6 +95,8 @@ module MetronomeSDK
             billing_provider_customer_id:,
             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: {}
           )
@@ -169,6 +173,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 +339,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

@@ -143,6 +143,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(
@@ -197,6 +199,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
@@ -416,6 +420,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