metronome-sdk 1.0.0 → 2.0.0

data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb

@@ -323,8 +323,9 @@ module MetronomeSDK
             # @!attribute invoice_schedule
             #   The schedule that the customer will be invoiced for this commit.
             #
-            #   @return [MetronomeSDK::Models::SchedulePointInTime, nil]
-            optional :invoice_schedule, -> { MetronomeSDK::SchedulePointInTime }
+            #   @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit::InvoiceSchedule, nil]
+            optional :invoice_schedule,
+                     -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit::InvoiceSchedule }
 
             # @!attribute name
             #
@@ -393,7 +394,7 @@ module MetronomeSDK
             #
             #   @param hierarchy_configuration [MetronomeSDK::Models::CommitHierarchyConfiguration] Optional configuration for commit hierarchy access control
             #
-            #   @param invoice_schedule [MetronomeSDK::Models::SchedulePointInTime] The schedule that the customer will be invoiced for this commit.
+            #   @param invoice_schedule [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit::InvoiceSchedule] The schedule that the customer will be invoiced for this commit.
             #
             #   @param name [String]
             #
@@ -437,6 +438,75 @@ module MetronomeSDK
               #   @return [Array<Symbol>]
             end
 
+            # @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit#invoice_schedule
+            class InvoiceSchedule < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute credit_type
+              #
+              #   @return [MetronomeSDK::Models::CreditTypeData, nil]
+              optional :credit_type, -> { MetronomeSDK::CreditTypeData }
+
+              # @!attribute do_not_invoice
+              #   If true, this schedule will not generate an invoice.
+              #
+              #   @return [Boolean, nil]
+              optional :do_not_invoice, MetronomeSDK::Internal::Type::Boolean
+
+              # @!attribute schedule_items
+              #
+              #   @return [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit::InvoiceSchedule::ScheduleItem>, nil]
+              optional :schedule_items,
+                       -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit::InvoiceSchedule::ScheduleItem] }
+
+              # @!method initialize(credit_type: nil, do_not_invoice: nil, schedule_items: nil)
+              #   The schedule that the customer will be invoiced for this commit.
+              #
+              #   @param credit_type [MetronomeSDK::Models::CreditTypeData]
+              #
+              #   @param do_not_invoice [Boolean] If true, this schedule will not generate an invoice.
+              #
+              #   @param schedule_items [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit::InvoiceSchedule::ScheduleItem>]
+
+              class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
+                # @!attribute id
+                #
+                #   @return [String]
+                required :id, String
+
+                # @!attribute timestamp
+                #
+                #   @return [Time]
+                required :timestamp, Time
+
+                # @!attribute amount
+                #
+                #   @return [Float, nil]
+                optional :amount, Float
+
+                # @!attribute invoice_id
+                #
+                #   @return [String, nil]
+                optional :invoice_id, String, nil?: true
+
+                # @!attribute quantity
+                #
+                #   @return [Float, nil]
+                optional :quantity, Float
+
+                # @!attribute unit_price
+                #
+                #   @return [Float, nil]
+                optional :unit_price, Float
+
+                # @!method initialize(id:, timestamp:, amount: nil, invoice_id: nil, quantity: nil, unit_price: nil)
+                #   @param id [String]
+                #   @param timestamp [Time]
+                #   @param amount [Float]
+                #   @param invoice_id [String, nil]
+                #   @param quantity [Float]
+                #   @param unit_price [Float]
+              end
+            end
+
             # @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddCommit#rate_type
             module RateType
               extend MetronomeSDK::Internal::Type::Enum
@@ -637,8 +707,9 @@ module MetronomeSDK
 
             # @!attribute overwrite_rate
             #
-            #   @return [MetronomeSDK::Models::OverwriteRate, nil]
-            optional :overwrite_rate, -> { MetronomeSDK::OverwriteRate }
+            #   @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverwriteRate, nil]
+            optional :overwrite_rate,
+                     -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverwriteRate }
 
             # @!attribute priority
             #
@@ -673,7 +744,7 @@ module MetronomeSDK
             #   @param multiplier [Float]
             #   @param override_specifiers [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverrideSpecifier>]
             #   @param override_tiers [Array<MetronomeSDK::Models::OverrideTier>]
-            #   @param overwrite_rate [MetronomeSDK::Models::OverwriteRate]
+            #   @param overwrite_rate [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverwriteRate]
             #   @param priority [Float]
             #   @param product [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::Product]
             #   @param target [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::Target]
@@ -745,6 +816,86 @@ module MetronomeSDK
               end
             end
 
+            # @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride#overwrite_rate
+            class OverwriteRate < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute rate_type
+              #
+              #   @return [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverwriteRate::RateType]
+              required :rate_type,
+                       enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverwriteRate::RateType }
+
+              # @!attribute credit_type
+              #
+              #   @return [MetronomeSDK::Models::CreditTypeData, nil]
+              optional :credit_type, -> { MetronomeSDK::CreditTypeData }
+
+              # @!attribute custom_rate
+              #   Only set for CUSTOM rate_type. This field is interpreted by custom rate
+              #   processors.
+              #
+              #   @return [Hash{Symbol=>Object}, nil]
+              optional :custom_rate, MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]
+
+              # @!attribute is_prorated
+              #   Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
+              #   set to true.
+              #
+              #   @return [Boolean, nil]
+              optional :is_prorated, MetronomeSDK::Internal::Type::Boolean
+
+              # @!attribute price
+              #   Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type,
+              #   this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.
+              #
+              #   @return [Float, nil]
+              optional :price, Float
+
+              # @!attribute quantity
+              #   Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
+              #
+              #   @return [Float, nil]
+              optional :quantity, Float
+
+              # @!attribute tiers
+              #   Only set for TIERED rate_type.
+              #
+              #   @return [Array<MetronomeSDK::Models::Tier>, nil]
+              optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Tier] }
+
+              # @!method initialize(rate_type:, credit_type: nil, custom_rate: nil, is_prorated: nil, price: nil, quantity: nil, tiers: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverwriteRate}
+              #   for more details.
+              #
+              #   @param rate_type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverwriteRate::RateType]
+              #
+              #   @param credit_type [MetronomeSDK::Models::CreditTypeData]
+              #
+              #   @param custom_rate [Hash{Symbol=>Object}] Only set for CUSTOM rate_type. This field is interpreted by custom rate processo
+              #
+              #   @param is_prorated [Boolean] Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
+              #
+              #   @param price [Float] Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type, t
+              #
+              #   @param quantity [Float] Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
+              #
+              #   @param tiers [Array<MetronomeSDK::Models::Tier>] Only set for TIERED rate_type.
+
+              # @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverwriteRate#rate_type
+              module RateType
+                extend MetronomeSDK::Internal::Type::Enum
+
+                FLAT = :FLAT
+                PERCENTAGE = :PERCENTAGE
+                SUBSCRIPTION = :SUBSCRIPTION
+                TIERED = :TIERED
+                CUSTOM = :CUSTOM
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+
             # @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride#product
             class Product < MetronomeSDK::Internal::Type::BaseModel
               # @!attribute id
@@ -2570,11 +2721,18 @@ module MetronomeSDK
             optional :invoice_amount,
                      -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::InvoiceAmount }
 
-            # @!method initialize(id:, access_amount: nil, ending_before: nil, invoice_amount: nil)
+            # @!attribute rate_type
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::RateType, nil]
+            optional :rate_type,
+                     enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::RateType }
+
+            # @!method initialize(id:, access_amount: nil, ending_before: nil, invoice_amount: nil, rate_type: nil)
             #   @param id [String]
             #   @param access_amount [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::AccessAmount]
             #   @param ending_before [Time]
             #   @param invoice_amount [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::InvoiceAmount]
+            #   @param rate_type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit::RateType]
 
             # @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit#access_amount
             class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
@@ -2609,6 +2767,17 @@ module MetronomeSDK
               #   @param quantity [Float]
               #   @param unit_price [Float]
             end
+
+            # @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCommit#rate_type
+            module RateType
+              extend MetronomeSDK::Internal::Type::Enum
+
+              LIST_RATE = :LIST_RATE
+              COMMIT_RATE = :COMMIT_RATE
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
           end
 
           class UpdateRecurringCredit < MetronomeSDK::Internal::Type::BaseModel
@@ -2628,10 +2797,17 @@ module MetronomeSDK
             #   @return [Time, nil]
             optional :ending_before, Time
 
-            # @!method initialize(id:, access_amount: nil, ending_before: nil)
+            # @!attribute rate_type
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCredit::RateType, nil]
+            optional :rate_type,
+                     enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCredit::RateType }
+
+            # @!method initialize(id:, access_amount: nil, ending_before: nil, rate_type: nil)
             #   @param id [String]
             #   @param access_amount [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCredit::AccessAmount]
             #   @param ending_before [Time]
+            #   @param rate_type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCredit::RateType]
 
             # @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCredit#access_amount
             class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
@@ -2649,6 +2825,17 @@ module MetronomeSDK
               #   @param quantity [Float]
               #   @param unit_price [Float]
             end
+
+            # @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateRecurringCredit#rate_type
+            module RateType
+              extend MetronomeSDK::Internal::Type::Enum
+
+              LIST_RATE = :LIST_RATE
+              COMMIT_RATE = :COMMIT_RATE
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
           end
 
           class UpdateRefundInvoice < MetronomeSDK::Internal::Type::BaseModel

data/lib/metronome_sdk/resources/v1/alerts.rb

@@ -7,16 +7,15 @@ module MetronomeSDK
         # Some parameter documentations has been truncated, see
         # {MetronomeSDK::Models::V1::AlertCreateParams} for more details.
         #
-        # Create a new alert to monitor customer spending, balances, and billing metrics
-        # in real-time. Metronome's alert system provides industry-leading speed with
-        # immediate evaluation capabilities, enabling you to proactively manage customer
-        # accounts and prevent revenue leakage.
+        # Create a new threshold notification to monitor customer spending, balances, and
+        # billing metrics in real-time. Metronome's notification system provides
+        # industry-leading speed with immediate evaluation capabilities, enabling you to
+        # proactively manage customer accounts and prevent revenue leakage.
         #
-        # This endpoint creates configurable alerts that continuously monitor various
-        # billing thresholds including spend limits, credit balances, commitment
-        # utilization, and invoice totals. Alerts can be configured globally for all
-        # customers or targeted to specific customer accounts. Custom fields can be used
-        # on certain alert types to further target alerts to groups of customers.
+        # This endpoint creates configurable threshold notifications that continuously
+        # monitor various billing thresholds including spend limits, credit balances,
+        # commitment utilization, and invoice totals. Threshold notifications can be
+        # configured globally for all customers or targeted to specific customer accounts.
         #
         # ### Use this endpoint to:
         #
@@ -32,52 +31,53 @@ module MetronomeSDK
         #
         # A successful response returns a CustomerAlert object containing:
         #
-        # - The alert configuration with its unique ID and current status
+        # - The threshold notification configuration with its unique ID and current status
         # - The customer's evaluation status (ok, in_alarm, or evaluating)
-        # - Alert metadata including type, threshold values, and update timestamps
+        # - Threshold notification metadata including type, threshold values, and update
+        #   timestamps
         #
         # ### Usage guidelines:
         #
         # - Immediate evaluation: Set `evaluate_on_create` : `true` (default) for instant
         #   evaluation against existing customers
-        # - Uniqueness constraints: Each alert must have a unique `uniqueness_key` within
-        #   your organization. Use `release_uniqueness_key` : `true` when archiving to
-        #   reuse keys
-        # - Alert type requirements: Different alert types require specific fields (e.g.,
-        #   `billable_metric_id` for usage alerts, `credit_type_id` for credit-based
-        #   alerts)
-        # - Webhook delivery: Alerts trigger webhook notifications for real-time
-        #   integration with your systems. Configure webhook endpoints before creating
-        #   alerts
-        # - Performance at scale: Metronome's event-driven architecture processes alert
-        #   evaluations in real-time as usage events stream in, unlike competitors who
-        #   rely on periodic polling or batch evaluation cycles
+        # - Uniqueness constraints: Each threshold notification must have a unique
+        #   `uniqueness_key` within your organization. Use `release_uniqueness_key` :
+        #   `true` when archiving to reuse keys
+        # - Notification type requirements: Different threshold notification types require
+        #   specific fields (e.g., `billable_metric_id` for usage notifications,
+        #   `credit_type_id` for credit-based threshold notifications)
+        # - Webhook delivery: Threshold notifications trigger webhook notifications for
+        #   real-time integration with your systems. Configure webhook endpoints before
+        #   creating threshold notifications
+        # - Performance at scale: Metronome's event-driven architecture processes
+        #   threshold notification evaluations in real-time as usage events stream in,
+        #   unlike competitors who rely on periodic polling or batch evaluation cycles
         #
         # @overload create(alert_type:, name:, threshold:, billable_metric_id: nil, credit_grant_type_filters: nil, credit_type_id: nil, custom_field_filters: nil, customer_id: nil, evaluate_on_create: nil, group_values: nil, invoice_types_filter: nil, plan_id: nil, uniqueness_key: nil, request_options: {})
         #
-        # @param alert_type [Symbol, MetronomeSDK::Models::V1::AlertCreateParams::AlertType] Type of the alert
+        # @param alert_type [Symbol, MetronomeSDK::Models::V1::AlertCreateParams::AlertType] Type of the threshold notification
         #
-        # @param name [String] Name of the alert
+        # @param name [String] Name of the threshold notification
         #
-        # @param threshold [Float] Threshold value of the alert policy. Depending upon the alert type, this number
+        # @param threshold [Float] Threshold value of the notification policy. Depending upon the notification typ
         #
-        # @param billable_metric_id [String] For alerts of type `usage_threshold_reached`, specifies which billable metric to
+        # @param billable_metric_id [String] For threshold notifications of type `usage_threshold_reached`, specifies which b
         #
-        # @param credit_grant_type_filters [Array<String>] An array of strings, representing a way to filter the credit grant this alert ap
+        # @param credit_grant_type_filters [Array<String>] An array of strings, representing a way to filter the credit grant this threshol
         #
-        # @param credit_type_id [String] ID of the credit's currency, defaults to USD. If the specific alert type require
+        # @param credit_type_id [String] ID of the credit's currency, defaults to USD. If the specific notification type
         #
-        # @param custom_field_filters [Array<MetronomeSDK::Models::V1::AlertCreateParams::CustomFieldFilter>] A list of custom field filters for alert types that support advanced filtering.
+        # @param custom_field_filters [Array<MetronomeSDK::Models::V1::AlertCreateParams::CustomFieldFilter>] A list of custom field filters for threshold notification types that support adv
         #
-        # @param customer_id [String] If provided, will create this alert for this specific customer. To create an ale
+        # @param customer_id [String] If provided, will create this threshold notification for this specific customer.
         #
-        # @param evaluate_on_create [Boolean] If true, the alert will evaluate immediately on customers that already meet the
+        # @param evaluate_on_create [Boolean] If true, the threshold notification will evaluate immediately on customers that
         #
-        # @param group_values [Array<MetronomeSDK::Models::V1::AlertCreateParams::GroupValue>] Only present for `spend_threshold_reached` alerts. Scope alert to a specific gro
+        # @param group_values [Array<MetronomeSDK::Models::V1::AlertCreateParams::GroupValue>] Only present for `spend_threshold_reached` notifications. Scope notification to
         #
-        # @param invoice_types_filter [Array<String>] Only supported for invoice_total_reached alerts. A list of invoice types to eval
+        # @param invoice_types_filter [Array<String>] Only supported for invoice_total_reached threshold notifications. A list of invo
         #
-        # @param plan_id [String] If provided, will create this alert for this specific plan. To create an alert f
+        # @param plan_id [String] If provided, will create this threshold notification for this specific plan. To
         #
         # @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
         #
@@ -97,39 +97,43 @@ module MetronomeSDK
           )
         end
 
-        # Permanently disable an alert and remove it from active monitoring across all
-        # customers. Archived alerts stop evaluating immediately and can optionally
-        # release their uniqueness key for reuse in future alert configurations.
+        # Some parameter documentations has been truncated, see
+        # {MetronomeSDK::Models::V1::AlertArchiveParams} for more details.
+        #
+        # Permanently disable a threshold notification and remove it from active
+        # monitoring across all customers. Archived threshold notifications stop
+        # evaluating immediately and can optionally release their uniqueness key for reuse
+        # in future threshold notification configurations.
         #
         # ### Use this endpoint to:
         #
-        # - Decommission alerts that are no longer needed
-        # - Clean up test or deprecated alert configurations
-        # - Free up uniqueness keys for reuse with new alerts
-        # - Stop alert evaluations without losing historical configuration data
+        # - Decommission threshold notifications that are no longer needed
+        # - Clean up test or deprecated threshold notification configurations
+        # - Free up uniqueness keys for reuse with new threshold notifications
+        # - Stop threshold notification evaluations without losing historical
+        #   configuration data
         # - Disable outdated monitoring rules during pricing model transitions
         #
         # ### Key response fields:
         #
-        # - data: Object containing the archived alert's ID
-        # - Alert evaluation stops immediately for all affected customers
-        # - Historical alert data and configurations remain accessible for audit purposes
+        # - data: Object containing the archived threshold notification's ID
         #
         # ### Usage guidelines:
         #
-        # - Irreversible for evaluation: Archived alerts cannot be re-enabled; create a
-        #   new alert to resume monitoring
+        # - Irreversible for evaluation: Archived threshold notifications cannot be
+        #   re-enabled; create a new threshold notification to resume monitoring
         # - Uniqueness key handling: Set `release_uniqueness_key` : `true` to reuse the
-        #   key in future alerts
-        # - Immediate effect: Alert evaluation stops instantly across all customers
-        # - Historical preservation: Archive operation maintains alert history and
-        #   configuration for compliance and auditing
+        #   key in future threshold notifications
+        # - Immediate effect: Threshold notification evaluation stops instantly across all
+        #   customers
+        # - Historical preservation: Archive operation maintains threshold notification
+        #   history and configuration for compliance and auditing
         #
         # @overload archive(id:, release_uniqueness_key: nil, request_options: {})
         #
-        # @param id [String] The Metronome ID of the alert
+        # @param id [String] The Metronome ID of the threshold notification
         #
-        # @param release_uniqueness_key [Boolean] If true, resets the uniqueness key on this alert so it can be re-used
+        # @param release_uniqueness_key [Boolean] If true, resets the uniqueness key on this threshold notification so it can be r
         #
         # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/metronome_sdk/resources/v1/contracts.rb

@@ -709,11 +709,12 @@ module MetronomeSDK
         # Some parameter documentations has been truncated, see
         # {MetronomeSDK::Models::V1::ContractUpdateEndDateParams} for more details.
         #
-        # Update or and an end date to a contract. Ending a contract early will impact
+        # Update or add an end date to a contract. Ending a contract early will impact
         # draft usage statements, truncate any terms, and remove upcoming scheduled
         # invoices. Moving the date into the future will only extend the contract length.
-        # Terms and scheduled invoices are not extended. Use this if a contract's end date
-        # has changed or if a perpetual contract ends.
+        # Terms and scheduled invoices are not extended. In-advance subscriptions will not
+        # be extended. Use this if a contract's end date has changed or if a perpetual
+        # contract ends.
         #
         # @overload update_end_date(contract_id:, customer_id:, allow_ending_before_finalized_invoice: nil, ending_before: nil, request_options: {})
         #