orb-billing 1.13.0 → 1.15.0

data/rbi/orb/models/alert_create_for_subscription_params.rbi

@@ -11,6 +11,9 @@ module Orb
           T.any(Orb::AlertCreateForSubscriptionParams, Orb::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :subscription_id
+
       # The thresholds that define the values at which the alert will be triggered.
       sig { returns(T::Array[Orb::Threshold]) }
       attr_accessor :thresholds
@@ -19,25 +22,93 @@ module Orb
       sig { returns(Orb::AlertCreateForSubscriptionParams::Type::OrSymbol) }
       attr_accessor :type
 
+      # The case sensitive currency or custom pricing unit to use for grouped cost
+      # alerts. Required when grouping_keys is set.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :currency
+
+      # The property keys to group cost alerts by. Only applicable for cost_exceeded
+      # alerts.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :grouping_keys
+
       # The metric to track usage for.
       sig { returns(T.nilable(String)) }
       attr_accessor :metric_id
 
+      # 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.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[Orb::AlertCreateForSubscriptionParams::PriceFilter]
+          )
+        )
+      end
+      attr_accessor :price_filters
+
+      # 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.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[Orb::AlertCreateForSubscriptionParams::ThresholdOverride]
+          )
+        )
+      end
+      attr_accessor :threshold_overrides
+
       sig do
         params(
+          subscription_id: String,
           thresholds: T::Array[Orb::Threshold::OrHash],
           type: Orb::AlertCreateForSubscriptionParams::Type::OrSymbol,
+          currency: T.nilable(String),
+          grouping_keys: T.nilable(T::Array[String]),
           metric_id: T.nilable(String),
+          price_filters:
+            T.nilable(
+              T::Array[
+                Orb::AlertCreateForSubscriptionParams::PriceFilter::OrHash
+              ]
+            ),
+          threshold_overrides:
+            T.nilable(
+              T::Array[
+                Orb::AlertCreateForSubscriptionParams::ThresholdOverride::OrHash
+              ]
+            ),
           request_options: Orb::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        subscription_id:,
         # The thresholds that define the values at which the alert will be triggered.
         thresholds:,
         # The type of alert to create. This must be a valid alert type.
         type:,
+        # The case sensitive currency or custom pricing unit to use for grouped cost
+        # alerts. Required when grouping_keys is set.
+        currency: nil,
+        # The property keys to group cost alerts by. Only applicable for cost_exceeded
+        # alerts.
+        grouping_keys: nil,
         # The metric to track usage for.
         metric_id: nil,
+        # 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.
+        price_filters: nil,
+        # 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.
+        threshold_overrides: nil,
         request_options: {}
       )
       end
@@ -45,9 +116,22 @@ module Orb
       sig do
         override.returns(
           {
+            subscription_id: String,
             thresholds: T::Array[Orb::Threshold],
             type: Orb::AlertCreateForSubscriptionParams::Type::OrSymbol,
+            currency: T.nilable(String),
+            grouping_keys: T.nilable(T::Array[String]),
             metric_id: T.nilable(String),
+            price_filters:
+              T.nilable(
+                T::Array[Orb::AlertCreateForSubscriptionParams::PriceFilter]
+              ),
+            threshold_overrides:
+              T.nilable(
+                T::Array[
+                  Orb::AlertCreateForSubscriptionParams::ThresholdOverride
+                ]
+              ),
             request_options: Orb::RequestOptions
           }
         )
@@ -84,6 +168,207 @@ module Orb
         def self.values
         end
       end
+
+      class PriceFilter < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::AlertCreateForSubscriptionParams::PriceFilter,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        # The property of the price to filter on.
+        sig do
+          returns(
+            Orb::AlertCreateForSubscriptionParams::PriceFilter::Field::OrSymbol
+          )
+        end
+        attr_accessor :field
+
+        # Should prices that match the filter be included or excluded.
+        sig do
+          returns(
+            Orb::AlertCreateForSubscriptionParams::PriceFilter::Operator::OrSymbol
+          )
+        end
+        attr_accessor :operator
+
+        # The IDs or values that match this filter.
+        sig { returns(T::Array[String]) }
+        attr_accessor :values
+
+        sig do
+          params(
+            field:
+              Orb::AlertCreateForSubscriptionParams::PriceFilter::Field::OrSymbol,
+            operator:
+              Orb::AlertCreateForSubscriptionParams::PriceFilter::Operator::OrSymbol,
+            values: T::Array[String]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The property of the price to filter on.
+          field:,
+          # Should prices that match the filter be included or excluded.
+          operator:,
+          # The IDs or values that match this filter.
+          values:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              field:
+                Orb::AlertCreateForSubscriptionParams::PriceFilter::Field::OrSymbol,
+              operator:
+                Orb::AlertCreateForSubscriptionParams::PriceFilter::Operator::OrSymbol,
+              values: T::Array[String]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The property of the price to filter on.
+        module Field
+          extend Orb::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Orb::AlertCreateForSubscriptionParams::PriceFilter::Field
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PRICE_ID =
+            T.let(
+              :price_id,
+              Orb::AlertCreateForSubscriptionParams::PriceFilter::Field::TaggedSymbol
+            )
+          ITEM_ID =
+            T.let(
+              :item_id,
+              Orb::AlertCreateForSubscriptionParams::PriceFilter::Field::TaggedSymbol
+            )
+          PRICE_TYPE =
+            T.let(
+              :price_type,
+              Orb::AlertCreateForSubscriptionParams::PriceFilter::Field::TaggedSymbol
+            )
+          CURRENCY =
+            T.let(
+              :currency,
+              Orb::AlertCreateForSubscriptionParams::PriceFilter::Field::TaggedSymbol
+            )
+          PRICING_UNIT_ID =
+            T.let(
+              :pricing_unit_id,
+              Orb::AlertCreateForSubscriptionParams::PriceFilter::Field::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::AlertCreateForSubscriptionParams::PriceFilter::Field::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Should prices that match the filter be included or excluded.
+        module Operator
+          extend Orb::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Orb::AlertCreateForSubscriptionParams::PriceFilter::Operator
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          INCLUDES =
+            T.let(
+              :includes,
+              Orb::AlertCreateForSubscriptionParams::PriceFilter::Operator::TaggedSymbol
+            )
+          EXCLUDES =
+            T.let(
+              :excludes,
+              Orb::AlertCreateForSubscriptionParams::PriceFilter::Operator::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::AlertCreateForSubscriptionParams::PriceFilter::Operator::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      class ThresholdOverride < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::AlertCreateForSubscriptionParams::ThresholdOverride,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        # 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.
+        sig { returns(T::Array[String]) }
+        attr_accessor :group_values
+
+        # 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.
+        sig { returns(T::Array[Orb::Threshold]) }
+        attr_accessor :thresholds
+
+        # 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.
+        sig do
+          params(
+            group_values: T::Array[String],
+            thresholds: T::Array[Orb::Threshold::OrHash]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # 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.
+          group_values:,
+          # 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.
+          thresholds:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              group_values: T::Array[String],
+              thresholds: T::Array[Orb::Threshold]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/orb/models/alert_disable_params.rbi

@@ -9,17 +9,22 @@ module Orb
       OrHash =
         T.type_alias { T.any(Orb::AlertDisableParams, Orb::Internal::AnyHash) }
 
+      sig { returns(String) }
+      attr_accessor :alert_configuration_id
+
       # Used to update the status of a plan alert scoped to this subscription_id
       sig { returns(T.nilable(String)) }
       attr_accessor :subscription_id
 
       sig do
         params(
+          alert_configuration_id: String,
           subscription_id: T.nilable(String),
           request_options: Orb::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        alert_configuration_id:,
         # Used to update the status of a plan alert scoped to this subscription_id
         subscription_id: nil,
         request_options: {}
@@ -29,6 +34,7 @@ module Orb
       sig do
         override.returns(
           {
+            alert_configuration_id: String,
             subscription_id: T.nilable(String),
             request_options: Orb::RequestOptions
           }

data/rbi/orb/models/alert_enable_params.rbi

@@ -9,17 +9,22 @@ module Orb
       OrHash =
         T.type_alias { T.any(Orb::AlertEnableParams, Orb::Internal::AnyHash) }
 
+      sig { returns(String) }
+      attr_accessor :alert_configuration_id
+
       # Used to update the status of a plan alert scoped to this subscription_id
       sig { returns(T.nilable(String)) }
       attr_accessor :subscription_id
 
       sig do
         params(
+          alert_configuration_id: String,
           subscription_id: T.nilable(String),
           request_options: Orb::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        alert_configuration_id:,
         # Used to update the status of a plan alert scoped to this subscription_id
         subscription_id: nil,
         request_options: {}
@@ -29,6 +34,7 @@ module Orb
       sig do
         override.returns(
           {
+            alert_configuration_id: String,
             subscription_id: T.nilable(String),
             request_options: Orb::RequestOptions
           }

data/rbi/orb/models/alert_retrieve_params.rbi

@@ -9,15 +9,23 @@ module Orb
       OrHash =
         T.type_alias { T.any(Orb::AlertRetrieveParams, Orb::Internal::AnyHash) }
 
+      sig { returns(String) }
+      attr_accessor :alert_id
+
       sig do
-        params(request_options: Orb::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          alert_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(alert_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Orb::RequestOptions }) }
+      sig do
+        override.returns(
+          { alert_id: String, request_options: Orb::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/orb/models/alert_update_params.rbi

@@ -9,19 +9,50 @@ module Orb
       OrHash =
         T.type_alias { T.any(Orb::AlertUpdateParams, Orb::Internal::AnyHash) }
 
+      sig { returns(String) }
+      attr_accessor :alert_configuration_id
+
       # The thresholds that define the values at which the alert will be triggered.
       sig { returns(T::Array[Orb::Threshold]) }
       attr_accessor :thresholds
 
+      # 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.
+      sig { returns(T.nilable(T::Array[Orb::AlertUpdateParams::PriceFilter])) }
+      attr_accessor :price_filters
+
+      # 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.
+      sig do
+        returns(T.nilable(T::Array[Orb::AlertUpdateParams::ThresholdOverride]))
+      end
+      attr_accessor :threshold_overrides
+
       sig do
         params(
+          alert_configuration_id: String,
           thresholds: T::Array[Orb::Threshold::OrHash],
+          price_filters:
+            T.nilable(T::Array[Orb::AlertUpdateParams::PriceFilter::OrHash]),
+          threshold_overrides:
+            T.nilable(
+              T::Array[Orb::AlertUpdateParams::ThresholdOverride::OrHash]
+            ),
           request_options: Orb::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        alert_configuration_id:,
         # The thresholds that define the values at which the alert will be triggered.
         thresholds:,
+        # 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.
+        price_filters: nil,
+        # 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.
+        threshold_overrides: nil,
         request_options: {}
       )
       end
@@ -29,13 +60,196 @@ module Orb
       sig do
         override.returns(
           {
+            alert_configuration_id: String,
             thresholds: T::Array[Orb::Threshold],
+            price_filters:
+              T.nilable(T::Array[Orb::AlertUpdateParams::PriceFilter]),
+            threshold_overrides:
+              T.nilable(T::Array[Orb::AlertUpdateParams::ThresholdOverride]),
             request_options: Orb::RequestOptions
           }
         )
       end
       def to_hash
       end
+
+      class PriceFilter < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Orb::AlertUpdateParams::PriceFilter, Orb::Internal::AnyHash)
+          end
+
+        # The property of the price to filter on.
+        sig { returns(Orb::AlertUpdateParams::PriceFilter::Field::OrSymbol) }
+        attr_accessor :field
+
+        # Should prices that match the filter be included or excluded.
+        sig { returns(Orb::AlertUpdateParams::PriceFilter::Operator::OrSymbol) }
+        attr_accessor :operator
+
+        # The IDs or values that match this filter.
+        sig { returns(T::Array[String]) }
+        attr_accessor :values
+
+        sig do
+          params(
+            field: Orb::AlertUpdateParams::PriceFilter::Field::OrSymbol,
+            operator: Orb::AlertUpdateParams::PriceFilter::Operator::OrSymbol,
+            values: T::Array[String]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The property of the price to filter on.
+          field:,
+          # Should prices that match the filter be included or excluded.
+          operator:,
+          # The IDs or values that match this filter.
+          values:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              field: Orb::AlertUpdateParams::PriceFilter::Field::OrSymbol,
+              operator: Orb::AlertUpdateParams::PriceFilter::Operator::OrSymbol,
+              values: T::Array[String]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The property of the price to filter on.
+        module Field
+          extend Orb::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Orb::AlertUpdateParams::PriceFilter::Field)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PRICE_ID =
+            T.let(
+              :price_id,
+              Orb::AlertUpdateParams::PriceFilter::Field::TaggedSymbol
+            )
+          ITEM_ID =
+            T.let(
+              :item_id,
+              Orb::AlertUpdateParams::PriceFilter::Field::TaggedSymbol
+            )
+          PRICE_TYPE =
+            T.let(
+              :price_type,
+              Orb::AlertUpdateParams::PriceFilter::Field::TaggedSymbol
+            )
+          CURRENCY =
+            T.let(
+              :currency,
+              Orb::AlertUpdateParams::PriceFilter::Field::TaggedSymbol
+            )
+          PRICING_UNIT_ID =
+            T.let(
+              :pricing_unit_id,
+              Orb::AlertUpdateParams::PriceFilter::Field::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Orb::AlertUpdateParams::PriceFilter::Field::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Should prices that match the filter be included or excluded.
+        module Operator
+          extend Orb::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Orb::AlertUpdateParams::PriceFilter::Operator)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          INCLUDES =
+            T.let(
+              :includes,
+              Orb::AlertUpdateParams::PriceFilter::Operator::TaggedSymbol
+            )
+          EXCLUDES =
+            T.let(
+              :excludes,
+              Orb::AlertUpdateParams::PriceFilter::Operator::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::AlertUpdateParams::PriceFilter::Operator::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      class ThresholdOverride < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::AlertUpdateParams::ThresholdOverride,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        # 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.
+        sig { returns(T::Array[String]) }
+        attr_accessor :group_values
+
+        # 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.
+        sig { returns(T::Array[Orb::Threshold]) }
+        attr_accessor :thresholds
+
+        # 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.
+        sig do
+          params(
+            group_values: T::Array[String],
+            thresholds: T::Array[Orb::Threshold::OrHash]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # 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.
+          group_values:,
+          # 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.
+          thresholds:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              group_values: T::Array[String],
+              thresholds: T::Array[Orb::Threshold]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end