orb-billing 1.13.0 → 1.15.0

data/rbi/orb/models/adjustment_interval.rbi

@@ -32,6 +32,7 @@ module Orb
               Orb::PlanPhaseUsageDiscountAdjustment::OrHash,
               Orb::PlanPhaseAmountDiscountAdjustment::OrHash,
               Orb::PlanPhasePercentageDiscountAdjustment::OrHash,
+              Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::OrHash,
               Orb::PlanPhaseMinimumAdjustment::OrHash,
               Orb::PlanPhaseMaximumAdjustment::OrHash
             ),
@@ -75,11 +76,346 @@ module Orb
               Orb::PlanPhaseUsageDiscountAdjustment,
               Orb::PlanPhaseAmountDiscountAdjustment,
               Orb::PlanPhasePercentageDiscountAdjustment,
+              Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount,
               Orb::PlanPhaseMinimumAdjustment,
               Orb::PlanPhaseMaximumAdjustment
             )
           end
 
+        class TieredPercentageDiscount < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(Symbol) }
+          attr_accessor :adjustment_type
+
+          # The price IDs that this adjustment applies to.
+          sig { returns(T::Array[String]) }
+          attr_accessor :applies_to_price_ids
+
+          # The filters that determine which prices to apply this adjustment to.
+          sig do
+            returns(
+              T::Array[
+                Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter
+              ]
+            )
+          end
+          attr_accessor :filters
+
+          # True for adjustments that apply to an entire invoice, false for adjustments that
+          # apply to only one price.
+          sig { returns(T::Boolean) }
+          attr_accessor :is_invoice_level
+
+          # The plan phase in which this adjustment is active.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :plan_phase_order
+
+          # The reason for the adjustment.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :reason
+
+          # The adjustment id this adjustment replaces. This adjustment will take the place
+          # of the replaced adjustment in plan version migrations.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :replaces_adjustment_id
+
+          # The ordered, contiguous bands of cumulative eligible spend, each discounted at
+          # its own percentage (progressive fill-a-tier), applied to the prices this
+          # adjustment covers in a given billing period.
+          sig do
+            returns(
+              T::Array[
+                Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Tier
+              ]
+            )
+          end
+          attr_accessor :tiers
+
+          sig do
+            params(
+              id: String,
+              applies_to_price_ids: T::Array[String],
+              filters:
+                T::Array[
+                  Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::OrHash
+                ],
+              is_invoice_level: T::Boolean,
+              plan_phase_order: T.nilable(Integer),
+              reason: T.nilable(String),
+              replaces_adjustment_id: T.nilable(String),
+              tiers:
+                T::Array[
+                  Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Tier::OrHash
+                ],
+              adjustment_type: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            id:,
+            # The price IDs that this adjustment applies to.
+            applies_to_price_ids:,
+            # The filters that determine which prices to apply this adjustment to.
+            filters:,
+            # True for adjustments that apply to an entire invoice, false for adjustments that
+            # apply to only one price.
+            is_invoice_level:,
+            # The plan phase in which this adjustment is active.
+            plan_phase_order:,
+            # The reason for the adjustment.
+            reason:,
+            # The adjustment id this adjustment replaces. This adjustment will take the place
+            # of the replaced adjustment in plan version migrations.
+            replaces_adjustment_id:,
+            # The ordered, contiguous bands of cumulative eligible spend, each discounted at
+            # its own percentage (progressive fill-a-tier), applied to the prices this
+            # adjustment covers in a given billing period.
+            tiers:,
+            adjustment_type: :tiered_percentage_discount
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                adjustment_type: Symbol,
+                applies_to_price_ids: T::Array[String],
+                filters:
+                  T::Array[
+                    Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter
+                  ],
+                is_invoice_level: T::Boolean,
+                plan_phase_order: T.nilable(Integer),
+                reason: T.nilable(String),
+                replaces_adjustment_id: T.nilable(String),
+                tiers:
+                  T::Array[
+                    Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Tier
+                  ]
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Filter < Orb::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter,
+                  Orb::Internal::AnyHash
+                )
+              end
+
+            # The property of the price to filter on.
+            sig do
+              returns(
+                Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::Field::TaggedSymbol
+              )
+            end
+            attr_accessor :field
+
+            # Should prices that match the filter be included or excluded.
+            sig do
+              returns(
+                Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::Operator::TaggedSymbol
+              )
+            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::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::Field::OrSymbol,
+                operator:
+                  Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::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::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::Field::TaggedSymbol,
+                  operator:
+                    Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::Operator::TaggedSymbol,
+                  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::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::Field
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              PRICE_ID =
+                T.let(
+                  :price_id,
+                  Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::Field::TaggedSymbol
+                )
+              ITEM_ID =
+                T.let(
+                  :item_id,
+                  Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::Field::TaggedSymbol
+                )
+              PRICE_TYPE =
+                T.let(
+                  :price_type,
+                  Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::Field::TaggedSymbol
+                )
+              CURRENCY =
+                T.let(
+                  :currency,
+                  Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::Field::TaggedSymbol
+                )
+              PRICING_UNIT_ID =
+                T.let(
+                  :pricing_unit_id,
+                  Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::Field::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::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::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::Operator
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              INCLUDES =
+                T.let(
+                  :includes,
+                  Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::Operator::TaggedSymbol
+                )
+              EXCLUDES =
+                T.let(
+                  :excludes,
+                  Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::Operator::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::Operator::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+
+          class Tier < Orb::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Tier,
+                  Orb::Internal::AnyHash
+                )
+              end
+
+            # Exclusive lower bound of cumulative spend for this tier.
+            sig { returns(Float) }
+            attr_accessor :lower_bound
+
+            # The percentage (between 0 and 1) discounted from spend that falls within this
+            # tier.
+            sig { returns(Float) }
+            attr_accessor :percentage
+
+            # Inclusive upper bound of cumulative spend for this tier; null for the final
+            # open-ended tier.
+            sig { returns(T.nilable(Float)) }
+            attr_accessor :upper_bound
+
+            # One band of a tiered percentage discount. Bounds are denominated in the
+            # discount's currency. `lower_bound` is the exclusive start of the band and
+            # `upper_bound` is the inclusive end; `upper_bound` is null only for the
+            # open-ended final tier.
+            sig do
+              params(
+                lower_bound: Float,
+                percentage: Float,
+                upper_bound: T.nilable(Float)
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Exclusive lower bound of cumulative spend for this tier.
+              lower_bound:,
+              # The percentage (between 0 and 1) discounted from spend that falls within this
+              # tier.
+              percentage:,
+              # Inclusive upper bound of cumulative spend for this tier; null for the final
+              # open-ended tier.
+              upper_bound: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  lower_bound: Float,
+                  percentage: Float,
+                  upper_bound: T.nilable(Float)
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+
         sig do
           override.returns(
             T::Array[Orb::AdjustmentInterval::Adjustment::Variants]

data/rbi/orb/models/alert.rbi

@@ -65,6 +65,11 @@ module Orb
       sig { returns(T.nilable(T::Array[Orb::Alert::BalanceAlertStatus])) }
       attr_accessor :balance_alert_status
 
+      # The property keys to group cost alerts by. Only present for cost alerts with
+      # grouping enabled.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :grouping_keys
+
       # Minified license type for alert serialization.
       sig { returns(T.nilable(Orb::Alert::LicenseType)) }
       attr_reader :license_type
@@ -74,6 +79,16 @@ module Orb
       end
       attr_writer :license_type
 
+      # Filters scoping which prices are included in grouped cost alert evaluation.
+      sig { returns(T.nilable(T::Array[Orb::Alert::PriceFilter])) }
+      attr_accessor :price_filters
+
+      # 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.
+      sig { returns(T.nilable(T::Array[Orb::Alert::ThresholdOverride])) }
+      attr_accessor :threshold_overrides
+
       # [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
       # usage, or credit balance and trigger webhooks when a threshold is exceeded.
       #
@@ -93,7 +108,11 @@ module Orb
           type: Orb::Alert::Type::OrSymbol,
           balance_alert_status:
             T.nilable(T::Array[Orb::Alert::BalanceAlertStatus::OrHash]),
-          license_type: T.nilable(Orb::Alert::LicenseType::OrHash)
+          grouping_keys: T.nilable(T::Array[String]),
+          license_type: T.nilable(Orb::Alert::LicenseType::OrHash),
+          price_filters: T.nilable(T::Array[Orb::Alert::PriceFilter::OrHash]),
+          threshold_overrides:
+            T.nilable(T::Array[Orb::Alert::ThresholdOverride::OrHash])
         ).returns(T.attached_class)
       end
       def self.new(
@@ -121,8 +140,17 @@ module Orb
         # The current status of the alert. This field is only present for credit balance
         # alerts.
         balance_alert_status: nil,
+        # The property keys to group cost alerts by. Only present for cost alerts with
+        # grouping enabled.
+        grouping_keys: nil,
         # Minified license type for alert serialization.
-        license_type: nil
+        license_type: nil,
+        # Filters scoping which prices are included in grouped cost alert evaluation.
+        price_filters: nil,
+        # 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.
+        threshold_overrides: nil
       )
       end
 
@@ -141,7 +169,11 @@ module Orb
             type: Orb::Alert::Type::TaggedSymbol,
             balance_alert_status:
               T.nilable(T::Array[Orb::Alert::BalanceAlertStatus]),
-            license_type: T.nilable(Orb::Alert::LicenseType)
+            grouping_keys: T.nilable(T::Array[String]),
+            license_type: T.nilable(Orb::Alert::LicenseType),
+            price_filters: T.nilable(T::Array[Orb::Alert::PriceFilter]),
+            threshold_overrides:
+              T.nilable(T::Array[Orb::Alert::ThresholdOverride])
           }
         )
       end
@@ -297,6 +329,153 @@ module Orb
         def to_hash
         end
       end
+
+      class PriceFilter < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Orb::Alert::PriceFilter, Orb::Internal::AnyHash)
+          end
+
+        # The property of the price to filter on.
+        sig { returns(Orb::Alert::PriceFilter::Field::TaggedSymbol) }
+        attr_accessor :field
+
+        # Should prices that match the filter be included or excluded.
+        sig { returns(Orb::Alert::PriceFilter::Operator::TaggedSymbol) }
+        attr_accessor :operator
+
+        # The IDs or values that match this filter.
+        sig { returns(T::Array[String]) }
+        attr_accessor :values
+
+        sig do
+          params(
+            field: Orb::Alert::PriceFilter::Field::OrSymbol,
+            operator: Orb::Alert::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::Alert::PriceFilter::Field::TaggedSymbol,
+              operator: Orb::Alert::PriceFilter::Operator::TaggedSymbol,
+              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 { T.all(Symbol, Orb::Alert::PriceFilter::Field) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PRICE_ID =
+            T.let(:price_id, Orb::Alert::PriceFilter::Field::TaggedSymbol)
+          ITEM_ID =
+            T.let(:item_id, Orb::Alert::PriceFilter::Field::TaggedSymbol)
+          PRICE_TYPE =
+            T.let(:price_type, Orb::Alert::PriceFilter::Field::TaggedSymbol)
+          CURRENCY =
+            T.let(:currency, Orb::Alert::PriceFilter::Field::TaggedSymbol)
+          PRICING_UNIT_ID =
+            T.let(
+              :pricing_unit_id,
+              Orb::Alert::PriceFilter::Field::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Orb::Alert::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 { T.all(Symbol, Orb::Alert::PriceFilter::Operator) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          INCLUDES =
+            T.let(:includes, Orb::Alert::PriceFilter::Operator::TaggedSymbol)
+          EXCLUDES =
+            T.let(:excludes, Orb::Alert::PriceFilter::Operator::TaggedSymbol)
+
+          sig do
+            override.returns(
+              T::Array[Orb::Alert::PriceFilter::Operator::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      class ThresholdOverride < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Orb::Alert::ThresholdOverride, Orb::Internal::AnyHash)
+          end
+
+        # The values of the grouping keys that identify this group. The list length
+        # matches the alert's grouping_keys.
+        sig { returns(T::Array[String]) }
+        attr_accessor :group_values
+
+        # The thresholds applied to this group. An empty list means the group is silenced.
+        sig { returns(T::Array[Orb::Threshold]) }
+        attr_accessor :thresholds
+
+        # 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.
+        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
+          # matches the alert's grouping_keys.
+          group_values:,
+          # The thresholds applied to this group. An empty list means the group is silenced.
+          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_create_for_customer_params.rbi

@@ -11,6 +11,9 @@ module Orb
           T.any(Orb::AlertCreateForCustomerParams, Orb::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :customer_id
+
       # The case sensitive currency or custom pricing unit to use for this alert.
       sig { returns(String) }
       attr_accessor :currency
@@ -25,6 +28,7 @@ module Orb
 
       sig do
         params(
+          customer_id: String,
           currency: String,
           type: Orb::AlertCreateForCustomerParams::Type::OrSymbol,
           thresholds: T.nilable(T::Array[Orb::Threshold::OrHash]),
@@ -32,6 +36,7 @@ module Orb
         ).returns(T.attached_class)
       end
       def self.new(
+        customer_id:,
         # The case sensitive currency or custom pricing unit to use for this alert.
         currency:,
         # The type of alert to create. This must be a valid alert type.
@@ -45,6 +50,7 @@ module Orb
       sig do
         override.returns(
           {
+            customer_id: String,
             currency: String,
             type: Orb::AlertCreateForCustomerParams::Type::OrSymbol,
             thresholds: T.nilable(T::Array[Orb::Threshold]),

data/rbi/orb/models/alert_create_for_external_customer_params.rbi

@@ -14,6 +14,9 @@ module Orb
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :external_customer_id
+
       # The case sensitive currency or custom pricing unit to use for this alert.
       sig { returns(String) }
       attr_accessor :currency
@@ -28,6 +31,7 @@ module Orb
 
       sig do
         params(
+          external_customer_id: String,
           currency: String,
           type: Orb::AlertCreateForExternalCustomerParams::Type::OrSymbol,
           thresholds: T.nilable(T::Array[Orb::Threshold::OrHash]),
@@ -35,6 +39,7 @@ module Orb
         ).returns(T.attached_class)
       end
       def self.new(
+        external_customer_id:,
         # The case sensitive currency or custom pricing unit to use for this alert.
         currency:,
         # The type of alert to create. This must be a valid alert type.
@@ -48,6 +53,7 @@ module Orb
       sig do
         override.returns(
           {
+            external_customer_id: String,
             currency: String,
             type: Orb::AlertCreateForExternalCustomerParams::Type::OrSymbol,
             thresholds: T.nilable(T::Array[Orb::Threshold]),