orb-billing 1.13.0 → 1.15.0

data/lib/orb/models/alert.rb

@@ -74,13 +74,36 @@ module Orb
                -> { Orb::Internal::Type::ArrayOf[Orb::Alert::BalanceAlertStatus] },
                nil?: true
 
+      # @!attribute grouping_keys
+      #   The property keys to group cost alerts by. Only present for cost alerts with
+      #   grouping enabled.
+      #
+      #   @return [Array<String>, nil]
+      optional :grouping_keys, Orb::Internal::Type::ArrayOf[String], nil?: true
+
       # @!attribute license_type
       #   Minified license type for alert serialization.
       #
       #   @return [Orb::Models::Alert::LicenseType, nil]
       optional :license_type, -> { Orb::Alert::LicenseType }, nil?: true
 
-      # @!method initialize(id:, created_at:, currency:, customer:, enabled:, metric:, plan:, subscription:, thresholds:, type:, balance_alert_status: nil, license_type: nil)
+      # @!attribute price_filters
+      #   Filters scoping which prices are included in grouped cost alert evaluation.
+      #
+      #   @return [Array<Orb::Models::Alert::PriceFilter>, nil]
+      optional :price_filters, -> { Orb::Internal::Type::ArrayOf[Orb::Alert::PriceFilter] }, nil?: true
+
+      # @!attribute threshold_overrides
+      #   Per-group threshold overrides. Each override maps a specific combination of
+      #   grouping_keys values to a replacement threshold list. Only present for grouped
+      #   cost alerts that have at least one override.
+      #
+      #   @return [Array<Orb::Models::Alert::ThresholdOverride>, nil]
+      optional :threshold_overrides,
+               -> { Orb::Internal::Type::ArrayOf[Orb::Alert::ThresholdOverride] },
+               nil?: true
+
+      # @!method initialize(id:, created_at:, currency:, customer:, enabled:, metric:, plan:, subscription:, thresholds:, type:, balance_alert_status: nil, grouping_keys: nil, license_type: nil, price_filters: nil, threshold_overrides: nil)
       #   Some parameter documentations has been truncated, see {Orb::Models::Alert} for
       #   more details.
       #
@@ -112,7 +135,13 @@ module Orb
       #
       #   @param balance_alert_status [Array<Orb::Models::Alert::BalanceAlertStatus>, nil] The current status of the alert. This field is only present for credit balance a
       #
+      #   @param grouping_keys [Array<String>, nil] The property keys to group cost alerts by. Only present for cost alerts with gro
+      #
       #   @param license_type [Orb::Models::Alert::LicenseType, nil] Minified license type for alert serialization.
+      #
+      #   @param price_filters [Array<Orb::Models::Alert::PriceFilter>, nil] Filters scoping which prices are included in grouped cost alert evaluation.
+      #
+      #   @param threshold_overrides [Array<Orb::Models::Alert::ThresholdOverride>, nil] Per-group threshold overrides. Each override maps a specific combination of grou
 
       # @see Orb::Models::Alert#metric
       class Metric < Orb::Internal::Type::BaseModel
@@ -217,6 +246,90 @@ module Orb
         #
         #   @param id [String]
       end
+
+      class PriceFilter < Orb::Internal::Type::BaseModel
+        # @!attribute field
+        #   The property of the price to filter on.
+        #
+        #   @return [Symbol, Orb::Models::Alert::PriceFilter::Field]
+        required :field, enum: -> { Orb::Alert::PriceFilter::Field }
+
+        # @!attribute operator
+        #   Should prices that match the filter be included or excluded.
+        #
+        #   @return [Symbol, Orb::Models::Alert::PriceFilter::Operator]
+        required :operator, enum: -> { Orb::Alert::PriceFilter::Operator }
+
+        # @!attribute values
+        #   The IDs or values that match this filter.
+        #
+        #   @return [Array<String>]
+        required :values, Orb::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(field:, operator:, values:)
+        #   @param field [Symbol, Orb::Models::Alert::PriceFilter::Field] The property of the price to filter on.
+        #
+        #   @param operator [Symbol, Orb::Models::Alert::PriceFilter::Operator] Should prices that match the filter be included or excluded.
+        #
+        #   @param values [Array<String>] The IDs or values that match this filter.
+
+        # The property of the price to filter on.
+        #
+        # @see Orb::Models::Alert::PriceFilter#field
+        module Field
+          extend Orb::Internal::Type::Enum
+
+          PRICE_ID = :price_id
+          ITEM_ID = :item_id
+          PRICE_TYPE = :price_type
+          CURRENCY = :currency
+          PRICING_UNIT_ID = :pricing_unit_id
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Should prices that match the filter be included or excluded.
+        #
+        # @see Orb::Models::Alert::PriceFilter#operator
+        module Operator
+          extend Orb::Internal::Type::Enum
+
+          INCLUDES = :includes
+          EXCLUDES = :excludes
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      class ThresholdOverride < Orb::Internal::Type::BaseModel
+        # @!attribute group_values
+        #   The values of the grouping keys that identify this group. The list length
+        #   matches the alert's grouping_keys.
+        #
+        #   @return [Array<String>]
+        required :group_values, Orb::Internal::Type::ArrayOf[String]
+
+        # @!attribute thresholds
+        #   The thresholds applied to this group. An empty list means the group is silenced.
+        #
+        #   @return [Array<Orb::Models::Threshold>]
+        required :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Threshold] }
+
+        # @!method initialize(group_values:, thresholds:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Alert::ThresholdOverride} for more details.
+        #
+        #   A per-group threshold override on a grouped cost alert.
+        #
+        #   An empty `thresholds` list means the group is silenced (never fires). A
+        #   non-empty list fully replaces the default thresholds for that group.
+        #
+        #   @param group_values [Array<String>] The values of the grouping keys that identify this group. The list length matche
+        #
+        #   @param thresholds [Array<Orb::Models::Threshold>] The thresholds applied to this group. An empty list means the group is silenced.
+      end
     end
   end
 end

data/lib/orb/models/alert_create_for_customer_params.rb

@@ -7,6 +7,11 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      # @!attribute customer_id
+      #
+      #   @return [String]
+      required :customer_id, String
+
       # @!attribute currency
       #   The case sensitive currency or custom pricing unit to use for this alert.
       #
@@ -25,7 +30,9 @@ module Orb
       #   @return [Array<Orb::Models::Threshold>, nil]
       optional :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Threshold] }, nil?: true
 
-      # @!method initialize(currency:, type:, thresholds: nil, request_options: {})
+      # @!method initialize(customer_id:, currency:, type:, thresholds: nil, request_options: {})
+      #   @param customer_id [String]
+      #
       #   @param currency [String] The case sensitive currency or custom pricing unit to use for this alert.
       #
       #   @param type [Symbol, Orb::Models::AlertCreateForCustomerParams::Type] The type of alert to create. This must be a valid alert type.

data/lib/orb/models/alert_create_for_external_customer_params.rb

@@ -7,6 +7,11 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      # @!attribute external_customer_id
+      #
+      #   @return [String]
+      required :external_customer_id, String
+
       # @!attribute currency
       #   The case sensitive currency or custom pricing unit to use for this alert.
       #
@@ -25,7 +30,9 @@ module Orb
       #   @return [Array<Orb::Models::Threshold>, nil]
       optional :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Threshold] }, nil?: true
 
-      # @!method initialize(currency:, type:, thresholds: nil, request_options: {})
+      # @!method initialize(external_customer_id:, currency:, type:, thresholds: nil, request_options: {})
+      #   @param external_customer_id [String]
+      #
       #   @param currency [String] The case sensitive currency or custom pricing unit to use for this alert.
       #
       #   @param type [Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type] The type of alert to create. This must be a valid alert type.

data/lib/orb/models/alert_create_for_subscription_params.rb

@@ -7,6 +7,11 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      # @!attribute subscription_id
+      #
+      #   @return [String]
+      required :subscription_id, String
+
       # @!attribute thresholds
       #   The thresholds that define the values at which the alert will be triggered.
       #
@@ -19,19 +24,68 @@ module Orb
       #   @return [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type]
       required :type, enum: -> { Orb::AlertCreateForSubscriptionParams::Type }
 
+      # @!attribute currency
+      #   The case sensitive currency or custom pricing unit to use for grouped cost
+      #   alerts. Required when grouping_keys is set.
+      #
+      #   @return [String, nil]
+      optional :currency, String, nil?: true
+
+      # @!attribute grouping_keys
+      #   The property keys to group cost alerts by. Only applicable for cost_exceeded
+      #   alerts.
+      #
+      #   @return [Array<String>, nil]
+      optional :grouping_keys, Orb::Internal::Type::ArrayOf[String], nil?: true
+
       # @!attribute metric_id
       #   The metric to track usage for.
       #
       #   @return [String, nil]
       optional :metric_id, String, nil?: true
 
-      # @!method initialize(thresholds:, type:, metric_id: nil, request_options: {})
+      # @!attribute price_filters
+      #   Filters to scope which prices are included in grouped cost alert evaluation.
+      #   Supports filtering by price_id, item_id, or price_type with includes/excludes
+      #   operators. Only applicable when grouping_keys is set.
+      #
+      #   @return [Array<Orb::Models::AlertCreateForSubscriptionParams::PriceFilter>, nil]
+      optional :price_filters,
+               -> { Orb::Internal::Type::ArrayOf[Orb::AlertCreateForSubscriptionParams::PriceFilter] },
+               nil?: true
+
+      # @!attribute threshold_overrides
+      #   Per-group threshold overrides. Each override maps a specific combination of
+      #   grouping_keys values to a list of thresholds that fully replaces the default
+      #   thresholds for that group. An empty thresholds list silences the group. Groups
+      #   without an override use the default thresholds. Only applicable when
+      #   grouping_keys is set.
+      #
+      #   @return [Array<Orb::Models::AlertCreateForSubscriptionParams::ThresholdOverride>, nil]
+      optional :threshold_overrides,
+               -> { Orb::Internal::Type::ArrayOf[Orb::AlertCreateForSubscriptionParams::ThresholdOverride] },
+               nil?: true
+
+      # @!method initialize(subscription_id:, thresholds:, type:, currency: nil, grouping_keys: nil, metric_id: nil, price_filters: nil, threshold_overrides: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::AlertCreateForSubscriptionParams} for more details.
+      #
+      #   @param subscription_id [String]
+      #
       #   @param thresholds [Array<Orb::Models::Threshold>] The thresholds that define the values at which the alert will be triggered.
       #
       #   @param type [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type] The type of alert to create. This must be a valid alert type.
       #
+      #   @param currency [String, nil] The case sensitive currency or custom pricing unit to use for grouped cost alert
+      #
+      #   @param grouping_keys [Array<String>, nil] The property keys to group cost alerts by. Only applicable for cost_exceeded ale
+      #
       #   @param metric_id [String, nil] The metric to track usage for.
       #
+      #   @param price_filters [Array<Orb::Models::AlertCreateForSubscriptionParams::PriceFilter>, nil] Filters to scope which prices are included in grouped cost alert evaluation. Sup
+      #
+      #   @param threshold_overrides [Array<Orb::Models::AlertCreateForSubscriptionParams::ThresholdOverride>, nil] Per-group threshold overrides. Each override maps a specific combination of grou
+      #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
       # The type of alert to create. This must be a valid alert type.
@@ -44,6 +98,93 @@ module Orb
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      class PriceFilter < Orb::Internal::Type::BaseModel
+        # @!attribute field
+        #   The property of the price to filter on.
+        #
+        #   @return [Symbol, Orb::Models::AlertCreateForSubscriptionParams::PriceFilter::Field]
+        required :field, enum: -> { Orb::AlertCreateForSubscriptionParams::PriceFilter::Field }
+
+        # @!attribute operator
+        #   Should prices that match the filter be included or excluded.
+        #
+        #   @return [Symbol, Orb::Models::AlertCreateForSubscriptionParams::PriceFilter::Operator]
+        required :operator, enum: -> { Orb::AlertCreateForSubscriptionParams::PriceFilter::Operator }
+
+        # @!attribute values
+        #   The IDs or values that match this filter.
+        #
+        #   @return [Array<String>]
+        required :values, Orb::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(field:, operator:, values:)
+        #   @param field [Symbol, Orb::Models::AlertCreateForSubscriptionParams::PriceFilter::Field] The property of the price to filter on.
+        #
+        #   @param operator [Symbol, Orb::Models::AlertCreateForSubscriptionParams::PriceFilter::Operator] Should prices that match the filter be included or excluded.
+        #
+        #   @param values [Array<String>] The IDs or values that match this filter.
+
+        # The property of the price to filter on.
+        #
+        # @see Orb::Models::AlertCreateForSubscriptionParams::PriceFilter#field
+        module Field
+          extend Orb::Internal::Type::Enum
+
+          PRICE_ID = :price_id
+          ITEM_ID = :item_id
+          PRICE_TYPE = :price_type
+          CURRENCY = :currency
+          PRICING_UNIT_ID = :pricing_unit_id
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Should prices that match the filter be included or excluded.
+        #
+        # @see Orb::Models::AlertCreateForSubscriptionParams::PriceFilter#operator
+        module Operator
+          extend Orb::Internal::Type::Enum
+
+          INCLUDES = :includes
+          EXCLUDES = :excludes
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      class ThresholdOverride < Orb::Internal::Type::BaseModel
+        # @!attribute group_values
+        #   The values of the grouping keys that identify this group. The list length must
+        #   match the alert's grouping_keys, and values appear in the same order as
+        #   grouping_keys.
+        #
+        #   @return [Array<String>]
+        required :group_values, Orb::Internal::Type::ArrayOf[String]
+
+        # @!attribute thresholds
+        #   The thresholds to apply to this group. An empty list silences alerts for this
+        #   group. A non-empty list fully replaces the default thresholds for this group.
+        #
+        #   @return [Array<Orb::Models::Threshold>]
+        required :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Threshold] }
+
+        # @!method initialize(group_values:, thresholds:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::AlertCreateForSubscriptionParams::ThresholdOverride} for more
+        #   details.
+        #
+        #   Per-group threshold override on a grouped cost alert.
+        #
+        #   - An empty `thresholds` list silences alerts for this group (never fires).
+        #   - A non-empty list fully replaces the default thresholds for this group.
+        #
+        #   @param group_values [Array<String>] The values of the grouping keys that identify this group. The list length must m
+        #
+        #   @param thresholds [Array<Orb::Models::Threshold>] The thresholds to apply to this group. An empty list silences alerts for this gr
+      end
     end
   end
 end

data/lib/orb/models/alert_disable_params.rb

@@ -7,13 +7,20 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      # @!attribute alert_configuration_id
+      #
+      #   @return [String]
+      required :alert_configuration_id, String
+
       # @!attribute subscription_id
       #   Used to update the status of a plan alert scoped to this subscription_id
       #
       #   @return [String, nil]
       optional :subscription_id, String, nil?: true
 
-      # @!method initialize(subscription_id: nil, request_options: {})
+      # @!method initialize(alert_configuration_id:, subscription_id: nil, request_options: {})
+      #   @param alert_configuration_id [String]
+      #
       #   @param subscription_id [String, nil] Used to update the status of a plan alert scoped to this subscription_id
       #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]

data/lib/orb/models/alert_enable_params.rb

@@ -7,13 +7,20 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      # @!attribute alert_configuration_id
+      #
+      #   @return [String]
+      required :alert_configuration_id, String
+
       # @!attribute subscription_id
       #   Used to update the status of a plan alert scoped to this subscription_id
       #
       #   @return [String, nil]
       optional :subscription_id, String, nil?: true
 
-      # @!method initialize(subscription_id: nil, request_options: {})
+      # @!method initialize(alert_configuration_id:, subscription_id: nil, request_options: {})
+      #   @param alert_configuration_id [String]
+      #
       #   @param subscription_id [String, nil] Used to update the status of a plan alert scoped to this subscription_id
       #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]

data/lib/orb/models/alert_retrieve_params.rb

@@ -7,7 +7,13 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute alert_id
+      #
+      #   @return [String]
+      required :alert_id, String
+
+      # @!method initialize(alert_id:, request_options: {})
+      #   @param alert_id [String]
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/orb/models/alert_update_params.rb

@@ -7,16 +7,135 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      # @!attribute alert_configuration_id
+      #
+      #   @return [String]
+      required :alert_configuration_id, String
+
       # @!attribute thresholds
       #   The thresholds that define the values at which the alert will be triggered.
       #
       #   @return [Array<Orb::Models::Threshold>]
       required :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Threshold] }
 
-      # @!method initialize(thresholds:, request_options: {})
+      # @!attribute price_filters
+      #   Replaces the price filters on a grouped cost alert; an empty list clears them.
+      #   Only applicable to cost alerts with grouping_keys. Omit to leave unchanged.
+      #
+      #   @return [Array<Orb::Models::AlertUpdateParams::PriceFilter>, nil]
+      optional :price_filters,
+               -> { Orb::Internal::Type::ArrayOf[Orb::AlertUpdateParams::PriceFilter] },
+               nil?: true
+
+      # @!attribute threshold_overrides
+      #   Replaces the per-group threshold overrides on a grouped cost alert; an empty
+      #   list clears them. Only applicable to cost alerts with grouping_keys. Omit to
+      #   leave unchanged.
+      #
+      #   @return [Array<Orb::Models::AlertUpdateParams::ThresholdOverride>, nil]
+      optional :threshold_overrides,
+               -> { Orb::Internal::Type::ArrayOf[Orb::AlertUpdateParams::ThresholdOverride] },
+               nil?: true
+
+      # @!method initialize(alert_configuration_id:, thresholds:, price_filters: nil, threshold_overrides: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::AlertUpdateParams} for more details.
+      #
+      #   @param alert_configuration_id [String]
+      #
       #   @param thresholds [Array<Orb::Models::Threshold>] The thresholds that define the values at which the alert will be triggered.
       #
+      #   @param price_filters [Array<Orb::Models::AlertUpdateParams::PriceFilter>, nil] Replaces the price filters on a grouped cost alert; an empty list clears them. O
+      #
+      #   @param threshold_overrides [Array<Orb::Models::AlertUpdateParams::ThresholdOverride>, nil] Replaces the per-group threshold overrides on a grouped cost alert; an empty lis
+      #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+
+      class PriceFilter < Orb::Internal::Type::BaseModel
+        # @!attribute field
+        #   The property of the price to filter on.
+        #
+        #   @return [Symbol, Orb::Models::AlertUpdateParams::PriceFilter::Field]
+        required :field, enum: -> { Orb::AlertUpdateParams::PriceFilter::Field }
+
+        # @!attribute operator
+        #   Should prices that match the filter be included or excluded.
+        #
+        #   @return [Symbol, Orb::Models::AlertUpdateParams::PriceFilter::Operator]
+        required :operator, enum: -> { Orb::AlertUpdateParams::PriceFilter::Operator }
+
+        # @!attribute values
+        #   The IDs or values that match this filter.
+        #
+        #   @return [Array<String>]
+        required :values, Orb::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(field:, operator:, values:)
+        #   @param field [Symbol, Orb::Models::AlertUpdateParams::PriceFilter::Field] The property of the price to filter on.
+        #
+        #   @param operator [Symbol, Orb::Models::AlertUpdateParams::PriceFilter::Operator] Should prices that match the filter be included or excluded.
+        #
+        #   @param values [Array<String>] The IDs or values that match this filter.
+
+        # The property of the price to filter on.
+        #
+        # @see Orb::Models::AlertUpdateParams::PriceFilter#field
+        module Field
+          extend Orb::Internal::Type::Enum
+
+          PRICE_ID = :price_id
+          ITEM_ID = :item_id
+          PRICE_TYPE = :price_type
+          CURRENCY = :currency
+          PRICING_UNIT_ID = :pricing_unit_id
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Should prices that match the filter be included or excluded.
+        #
+        # @see Orb::Models::AlertUpdateParams::PriceFilter#operator
+        module Operator
+          extend Orb::Internal::Type::Enum
+
+          INCLUDES = :includes
+          EXCLUDES = :excludes
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      class ThresholdOverride < Orb::Internal::Type::BaseModel
+        # @!attribute group_values
+        #   The values of the grouping keys that identify this group. The list length must
+        #   match the alert's grouping_keys, and values appear in the same order as
+        #   grouping_keys.
+        #
+        #   @return [Array<String>]
+        required :group_values, Orb::Internal::Type::ArrayOf[String]
+
+        # @!attribute thresholds
+        #   The thresholds to apply to this group. An empty list silences alerts for this
+        #   group. A non-empty list fully replaces the default thresholds for this group.
+        #
+        #   @return [Array<Orb::Models::Threshold>]
+        required :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Threshold] }
+
+        # @!method initialize(group_values:, thresholds:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::AlertUpdateParams::ThresholdOverride} for more details.
+        #
+        #   Per-group threshold override on a grouped cost alert.
+        #
+        #   - An empty `thresholds` list silences alerts for this group (never fires).
+        #   - A non-empty list fully replaces the default thresholds for this group.
+        #
+        #   @param group_values [Array<String>] The values of the grouping keys that identify this group. The list length must m
+        #
+        #   @param thresholds [Array<Orb::Models::Threshold>] The thresholds to apply to this group. An empty list silences alerts for this gr
+      end
     end
   end
 end