orb-billing 1.43.0 → 1.45.0

data/rbi/orb/models/alert_create_for_plan_params.rbi

@@ -0,0 +1,290 @@
+# typed: strong
+
+module Orb
+  module Models
+    class AlertCreateForPlanParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Orb::AlertCreateForPlanParams, Orb::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :plan_id
+
+      # The thresholds that define the values at which the alert will be triggered.
+      sig { returns(T::Array[Orb::Threshold]) }
+      attr_accessor :thresholds
+
+      # The type of alert to create. This must be a valid alert type.
+      sig { returns(Orb::AlertCreateForPlanParams::Type::OrSymbol) }
+      attr_accessor :type
+
+      # The case sensitive currency or custom pricing unit the alert is denominated in.
+      # Required for spend_exceeded alerts and 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
+
+      # The plan version to create alerts for. If not specified, the default will be the
+      # plan's active plan version.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :plan_version
+
+      # Filters to scope which prices are included in alert evaluation. Supports
+      # filtering by price_id, item_id, or price_type with includes/excludes operators.
+      # Only applicable to spend_exceeded alerts and to cost_exceeded alerts with
+      # grouping_keys set.
+      sig do
+        returns(T.nilable(T::Array[Orb::AlertCreateForPlanParams::PriceFilter]))
+      end
+      attr_accessor :price_filters
+
+      sig do
+        params(
+          plan_id: String,
+          thresholds: T::Array[Orb::Threshold::OrHash],
+          type: Orb::AlertCreateForPlanParams::Type::OrSymbol,
+          currency: T.nilable(String),
+          grouping_keys: T.nilable(T::Array[String]),
+          metric_id: T.nilable(String),
+          plan_version: T.nilable(Integer),
+          price_filters:
+            T.nilable(
+              T::Array[Orb::AlertCreateForPlanParams::PriceFilter::OrHash]
+            ),
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        plan_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 the alert is denominated in.
+        # Required for spend_exceeded alerts and 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,
+        # The plan version to create alerts for. If not specified, the default will be the
+        # plan's active plan version.
+        plan_version: nil,
+        # Filters to scope which prices are included in alert evaluation. Supports
+        # filtering by price_id, item_id, or price_type with includes/excludes operators.
+        # Only applicable to spend_exceeded alerts and to cost_exceeded alerts with
+        # grouping_keys set.
+        price_filters: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            plan_id: String,
+            thresholds: T::Array[Orb::Threshold],
+            type: Orb::AlertCreateForPlanParams::Type::OrSymbol,
+            currency: T.nilable(String),
+            grouping_keys: T.nilable(T::Array[String]),
+            metric_id: T.nilable(String),
+            plan_version: T.nilable(Integer),
+            price_filters:
+              T.nilable(T::Array[Orb::AlertCreateForPlanParams::PriceFilter]),
+            request_options: Orb::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The type of alert to create. This must be a valid alert type.
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Orb::AlertCreateForPlanParams::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        USAGE_EXCEEDED =
+          T.let(
+            :usage_exceeded,
+            Orb::AlertCreateForPlanParams::Type::TaggedSymbol
+          )
+        COST_EXCEEDED =
+          T.let(
+            :cost_exceeded,
+            Orb::AlertCreateForPlanParams::Type::TaggedSymbol
+          )
+        SPEND_EXCEEDED =
+          T.let(
+            :spend_exceeded,
+            Orb::AlertCreateForPlanParams::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Orb::AlertCreateForPlanParams::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class PriceFilter < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::AlertCreateForPlanParams::PriceFilter,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        # The property of the price to filter on.
+        sig do
+          returns(Orb::AlertCreateForPlanParams::PriceFilter::Field::OrSymbol)
+        end
+        attr_accessor :field
+
+        # Should prices that match the filter be included or excluded.
+        sig do
+          returns(
+            Orb::AlertCreateForPlanParams::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::AlertCreateForPlanParams::PriceFilter::Field::OrSymbol,
+            operator:
+              Orb::AlertCreateForPlanParams::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::AlertCreateForPlanParams::PriceFilter::Field::OrSymbol,
+              operator:
+                Orb::AlertCreateForPlanParams::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::AlertCreateForPlanParams::PriceFilter::Field)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PRICE_ID =
+            T.let(
+              :price_id,
+              Orb::AlertCreateForPlanParams::PriceFilter::Field::TaggedSymbol
+            )
+          ITEM_ID =
+            T.let(
+              :item_id,
+              Orb::AlertCreateForPlanParams::PriceFilter::Field::TaggedSymbol
+            )
+          PRICE_TYPE =
+            T.let(
+              :price_type,
+              Orb::AlertCreateForPlanParams::PriceFilter::Field::TaggedSymbol
+            )
+          CURRENCY =
+            T.let(
+              :currency,
+              Orb::AlertCreateForPlanParams::PriceFilter::Field::TaggedSymbol
+            )
+          PRICING_UNIT_ID =
+            T.let(
+              :pricing_unit_id,
+              Orb::AlertCreateForPlanParams::PriceFilter::Field::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::AlertCreateForPlanParams::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::AlertCreateForPlanParams::PriceFilter::Operator
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          INCLUDES =
+            T.let(
+              :includes,
+              Orb::AlertCreateForPlanParams::PriceFilter::Operator::TaggedSymbol
+            )
+          EXCLUDES =
+            T.let(
+              :excludes,
+              Orb::AlertCreateForPlanParams::PriceFilter::Operator::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::AlertCreateForPlanParams::PriceFilter::Operator::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/backfill_reflected_webhook_event.rbi

@@ -28,6 +28,13 @@ module Orb
       sig { returns(Time) }
       attr_accessor :created_at
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      sig do
+        returns(Orb::BackfillReflectedWebhookEvent::PayloadStyle::TaggedSymbol)
+      end
+      attr_accessor :payload_style
+
       sig { returns(T.anything) }
       attr_accessor :properties
 
@@ -41,6 +48,8 @@ module Orb
           id: String,
           backfill: Orb::BackfillReflectedWebhookEvent::Backfill::OrHash,
           created_at: Time,
+          payload_style:
+            Orb::BackfillReflectedWebhookEvent::PayloadStyle::OrSymbol,
           properties: T.anything,
           type: Orb::BackfillReflectedWebhookEvent::Type::OrSymbol
         ).returns(T.attached_class)
@@ -53,6 +62,9 @@ module Orb
         backfill:,
         # The time at which this event was created, to the second.
         created_at:,
+        # The serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        payload_style:,
         properties:,
         # The event this payload describes.
         type:
@@ -65,6 +77,8 @@ module Orb
             id: String,
             backfill: Orb::BackfillReflectedWebhookEvent::Backfill,
             created_at: Time,
+            payload_style:
+              Orb::BackfillReflectedWebhookEvent::PayloadStyle::TaggedSymbol,
             properties: T.anything,
             type: Orb::BackfillReflectedWebhookEvent::Type::TaggedSymbol
           }
@@ -245,6 +259,39 @@ module Orb
         end
       end
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Orb::BackfillReflectedWebhookEvent::PayloadStyle)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EXPANDED =
+          T.let(
+            :expanded,
+            Orb::BackfillReflectedWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+        STANDARD =
+          T.let(
+            :standard,
+            Orb::BackfillReflectedWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::BackfillReflectedWebhookEvent::PayloadStyle::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
       # The event this payload describes.
       module Type
         extend Orb::Internal::Type::Enum

data/rbi/orb/models/backfill_reverted_webhook_event.rbi

@@ -28,6 +28,13 @@ module Orb
       sig { returns(Time) }
       attr_accessor :created_at
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      sig do
+        returns(Orb::BackfillRevertedWebhookEvent::PayloadStyle::TaggedSymbol)
+      end
+      attr_accessor :payload_style
+
       sig { returns(T.anything) }
       attr_accessor :properties
 
@@ -41,6 +48,8 @@ module Orb
           id: String,
           backfill: Orb::BackfillRevertedWebhookEvent::Backfill::OrHash,
           created_at: Time,
+          payload_style:
+            Orb::BackfillRevertedWebhookEvent::PayloadStyle::OrSymbol,
           properties: T.anything,
           type: Orb::BackfillRevertedWebhookEvent::Type::OrSymbol
         ).returns(T.attached_class)
@@ -53,6 +62,9 @@ module Orb
         backfill:,
         # The time at which this event was created, to the second.
         created_at:,
+        # The serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        payload_style:,
         properties:,
         # The event this payload describes.
         type:
@@ -65,6 +77,8 @@ module Orb
             id: String,
             backfill: Orb::BackfillRevertedWebhookEvent::Backfill,
             created_at: Time,
+            payload_style:
+              Orb::BackfillRevertedWebhookEvent::PayloadStyle::TaggedSymbol,
             properties: T.anything,
             type: Orb::BackfillRevertedWebhookEvent::Type::TaggedSymbol
           }
@@ -242,6 +256,39 @@ module Orb
         end
       end
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Orb::BackfillRevertedWebhookEvent::PayloadStyle)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EXPANDED =
+          T.let(
+            :expanded,
+            Orb::BackfillRevertedWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+        STANDARD =
+          T.let(
+            :standard,
+            Orb::BackfillRevertedWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::BackfillRevertedWebhookEvent::PayloadStyle::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
       # The event this payload describes.
       module Type
         extend Orb::Internal::Type::Enum

data/rbi/orb/models/billable_metric_edited_webhook_event.rbi

@@ -25,6 +25,15 @@ module Orb
       sig { returns(Time) }
       attr_accessor :created_at
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      sig do
+        returns(
+          Orb::BillableMetricEditedWebhookEvent::PayloadStyle::TaggedSymbol
+        )
+      end
+      attr_accessor :payload_style
+
       sig { returns(Orb::BillableMetricEditedWebhookEvent::Properties) }
       attr_reader :properties
 
@@ -45,6 +54,8 @@ module Orb
           id: String,
           billable_metric: Orb::BillableMetric::OrHash,
           created_at: Time,
+          payload_style:
+            Orb::BillableMetricEditedWebhookEvent::PayloadStyle::OrSymbol,
           properties: Orb::BillableMetricEditedWebhookEvent::Properties::OrHash,
           type: Orb::BillableMetricEditedWebhookEvent::Type::OrSymbol
         ).returns(T.attached_class)
@@ -58,6 +69,9 @@ module Orb
         billable_metric:,
         # The time at which this event was created, to the second.
         created_at:,
+        # The serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        payload_style:,
         properties:,
         # The event this payload describes.
         type:
@@ -70,6 +84,8 @@ module Orb
             id: String,
             billable_metric: Orb::BillableMetric,
             created_at: Time,
+            payload_style:
+              Orb::BillableMetricEditedWebhookEvent::PayloadStyle::TaggedSymbol,
             properties: Orb::BillableMetricEditedWebhookEvent::Properties,
             type: Orb::BillableMetricEditedWebhookEvent::Type::TaggedSymbol
           }
@@ -78,6 +94,39 @@ module Orb
       def to_hash
       end
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Orb::BillableMetricEditedWebhookEvent::PayloadStyle)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EXPANDED =
+          T.let(
+            :expanded,
+            Orb::BillableMetricEditedWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+        STANDARD =
+          T.let(
+            :standard,
+            Orb::BillableMetricEditedWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::BillableMetricEditedWebhookEvent::PayloadStyle::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
       class Properties < Orb::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/orb/models/credit_block_accounting_sync_failed_webhook_event.rbi

@@ -45,6 +45,15 @@ module Orb
       sig { returns(Time) }
       attr_accessor :created_at
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      sig do
+        returns(
+          Orb::CreditBlockAccountingSyncFailedWebhookEvent::PayloadStyle::TaggedSymbol
+        )
+      end
+      attr_accessor :payload_style
+
       sig do
         returns(Orb::CreditBlockAccountingSyncFailedWebhookEvent::Properties)
       end
@@ -75,6 +84,8 @@ module Orb
           block:
             Orb::CreditBlockAccountingSyncFailedWebhookEvent::Block::OrHash,
           created_at: Time,
+          payload_style:
+            Orb::CreditBlockAccountingSyncFailedWebhookEvent::PayloadStyle::OrSymbol,
           properties:
             Orb::CreditBlockAccountingSyncFailedWebhookEvent::Properties::OrHash,
           type: Orb::CreditBlockAccountingSyncFailedWebhookEvent::Type::OrSymbol
@@ -88,6 +99,9 @@ module Orb
         block:,
         # The time at which this event was created, to the second.
         created_at:,
+        # The serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        payload_style:,
         properties:,
         # The event this payload describes.
         type:
@@ -102,6 +116,8 @@ module Orb
               Orb::CreditBlockAccountingSyncFailedWebhookEvent::AccountingSyncRecord,
             block: Orb::CreditBlockAccountingSyncFailedWebhookEvent::Block,
             created_at: Time,
+            payload_style:
+              Orb::CreditBlockAccountingSyncFailedWebhookEvent::PayloadStyle::TaggedSymbol,
             properties:
               Orb::CreditBlockAccountingSyncFailedWebhookEvent::Properties,
             type:
@@ -975,6 +991,42 @@ module Orb
         end
       end
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Orb::CreditBlockAccountingSyncFailedWebhookEvent::PayloadStyle
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EXPANDED =
+          T.let(
+            :expanded,
+            Orb::CreditBlockAccountingSyncFailedWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+        STANDARD =
+          T.let(
+            :standard,
+            Orb::CreditBlockAccountingSyncFailedWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::CreditBlockAccountingSyncFailedWebhookEvent::PayloadStyle::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
       class Properties < Orb::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/orb/models/credit_block_accounting_sync_succeeded_webhook_event.rbi

@@ -48,6 +48,15 @@ module Orb
       sig { returns(Time) }
       attr_accessor :created_at
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      sig do
+        returns(
+          Orb::CreditBlockAccountingSyncSucceededWebhookEvent::PayloadStyle::TaggedSymbol
+        )
+      end
+      attr_accessor :payload_style
+
       sig do
         returns(Orb::CreditBlockAccountingSyncSucceededWebhookEvent::Properties)
       end
@@ -78,6 +87,8 @@ module Orb
           block:
             Orb::CreditBlockAccountingSyncSucceededWebhookEvent::Block::OrHash,
           created_at: Time,
+          payload_style:
+            Orb::CreditBlockAccountingSyncSucceededWebhookEvent::PayloadStyle::OrSymbol,
           properties:
             Orb::CreditBlockAccountingSyncSucceededWebhookEvent::Properties::OrHash,
           type:
@@ -92,6 +103,9 @@ module Orb
         block:,
         # The time at which this event was created, to the second.
         created_at:,
+        # The serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        payload_style:,
         properties:,
         # The event this payload describes.
         type:
@@ -106,6 +120,8 @@ module Orb
               Orb::CreditBlockAccountingSyncSucceededWebhookEvent::AccountingSyncRecord,
             block: Orb::CreditBlockAccountingSyncSucceededWebhookEvent::Block,
             created_at: Time,
+            payload_style:
+              Orb::CreditBlockAccountingSyncSucceededWebhookEvent::PayloadStyle::TaggedSymbol,
             properties:
               Orb::CreditBlockAccountingSyncSucceededWebhookEvent::Properties,
             type:
@@ -979,6 +995,42 @@ module Orb
         end
       end
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Orb::CreditBlockAccountingSyncSucceededWebhookEvent::PayloadStyle
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EXPANDED =
+          T.let(
+            :expanded,
+            Orb::CreditBlockAccountingSyncSucceededWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+        STANDARD =
+          T.let(
+            :standard,
+            Orb::CreditBlockAccountingSyncSucceededWebhookEvent::PayloadStyle::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::CreditBlockAccountingSyncSucceededWebhookEvent::PayloadStyle::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
       class Properties < Orb::Internal::Type::BaseModel
         OrHash =
           T.type_alias do