orb-billing 1.43.0 → 1.44.0

data/lib/orb/resources/webhook_endpoints.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+module Orb
+  module Resources
+    # A webhook endpoint is an HTTPS URL that Orb sends
+    # [webhook events](/integrations-and-exports/webhooks) to.
+    class WebhookEndpoints
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::WebhookEndpointCreateParams} for more details.
+      #
+      # This endpoint creates a webhook endpoint and returns the secret used to sign its
+      # webhook events. The secret isn't returned by any other endpoint. An account can
+      # have at most 20 webhook endpoints by default.
+      #
+      # @overload create(url:, enabled_event_types: nil, request_options: {})
+      #
+      # @param url [String] The HTTPS URL that Orb sends webhook events to.
+      #
+      # @param enabled_event_types [Array<String>, nil] The webhook event types to send to this endpoint. If omitted or null, all event
+      #
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::WebhookEndpointWithSecret]
+      #
+      # @see Orb::Models::WebhookEndpointCreateParams
+      def create(params)
+        parsed, options = Orb::WebhookEndpointCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "webhook_endpoints",
+          body: parsed,
+          model: Orb::WebhookEndpointWithSecret,
+          options: options
+        )
+      end
+
+      # This endpoint returns a webhook endpoint identified by its ID.
+      #
+      # @overload retrieve(webhook_endpoint_id, request_options: {})
+      #
+      # @param webhook_endpoint_id [String]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::WebhookEndpoint]
+      #
+      # @see Orb::Models::WebhookEndpointRetrieveParams
+      def retrieve(webhook_endpoint_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["webhook_endpoints/%1$s", webhook_endpoint_id],
+          model: Orb::WebhookEndpoint,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::WebhookEndpointUpdateParams} for more details.
+      #
+      # This endpoint updates a webhook endpoint's URL or the event types sent to it.
+      #
+      # @overload update(webhook_endpoint_id, enabled_event_types: nil, url: nil, request_options: {})
+      #
+      # @param webhook_endpoint_id [String]
+      #
+      # @param enabled_event_types [Array<String>, nil] The webhook event types to send to this endpoint. Null sends all event types; om
+      #
+      # @param url [String, nil] The HTTPS URL that Orb sends webhook events to.
+      #
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::WebhookEndpoint]
+      #
+      # @see Orb::Models::WebhookEndpointUpdateParams
+      def update(webhook_endpoint_id, params = {})
+        parsed, options = Orb::WebhookEndpointUpdateParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["webhook_endpoints/%1$s", webhook_endpoint_id],
+          body: parsed,
+          model: Orb::WebhookEndpoint,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::WebhookEndpointListParams} for more details.
+      #
+      # This endpoint returns the account's webhook endpoints, ordered starting from the
+      # most recently created.
+      #
+      # @overload list(cursor: nil, limit: nil, request_options: {})
+      #
+      # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+      #
+      # @param limit [Integer] The number of items to fetch. Defaults to 20.
+      #
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Internal::Page<Orb::Models::WebhookEndpoint>]
+      #
+      # @see Orb::Models::WebhookEndpointListParams
+      def list(params = {})
+        parsed, options = Orb::WebhookEndpointListParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "webhook_endpoints",
+          query: query,
+          page: Orb::Internal::Page,
+          model: Orb::WebhookEndpoint,
+          options: options
+        )
+      end
+
+      # This endpoint deletes a webhook endpoint. Orb stops sending webhook events to it
+      # immediately.
+      #
+      # @overload delete(webhook_endpoint_id, request_options: {})
+      #
+      # @param webhook_endpoint_id [String]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Orb::Models::WebhookEndpointDeleteParams
+      def delete(webhook_endpoint_id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["webhook_endpoints/%1$s", webhook_endpoint_id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # This endpoint disables a webhook endpoint, so Orb stops sending webhook events
+      # to it until it is enabled again.
+      #
+      # @overload disable(webhook_endpoint_id, request_options: {})
+      #
+      # @param webhook_endpoint_id [String]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::WebhookEndpoint]
+      #
+      # @see Orb::Models::WebhookEndpointDisableParams
+      def disable(webhook_endpoint_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["webhook_endpoints/%1$s/disable", webhook_endpoint_id],
+          model: Orb::WebhookEndpoint,
+          options: params[:request_options]
+        )
+      end
+
+      # This endpoint enables a webhook endpoint, so Orb resumes sending webhook events
+      # to it.
+      #
+      # @overload enable(webhook_endpoint_id, request_options: {})
+      #
+      # @param webhook_endpoint_id [String]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::WebhookEndpoint]
+      #
+      # @see Orb::Models::WebhookEndpointEnableParams
+      def enable(webhook_endpoint_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["webhook_endpoints/%1$s/enable", webhook_endpoint_id],
+          model: Orb::WebhookEndpoint,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Orb::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/orb/resources/webhooks.rb

@@ -5,7 +5,7 @@ module Orb
     class Webhooks
       # @param payload [String] The raw webhook payload as a string
       #
-      # @return [Orb::Models::BackfillReflectedWebhookEvent, Orb::Models::BackfillRevertedWebhookEvent, Orb::Models::BillableMetricEditedWebhookEvent, Orb::Models::CreditBlockAccountingSyncFailedWebhookEvent, Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent, Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent, Orb::Models::CreditNoteAccountingSyncSucceededWebhookEvent, Orb::Models::CreditNoteIssuedWebhookEvent, Orb::Models::CreditNoteMarkedAsVoidWebhookEvent, Orb::Models::CustomerAccountingSyncFailedWebhookEvent, Orb::Models::CustomerAccountingSyncSucceededWebhookEvent, Orb::Models::CustomerBalanceTransactionCreatedWebhookEvent, Orb::Models::CustomerCreatedWebhookEvent, Orb::Models::CustomerCreditBalanceDepletedWebhookEvent, Orb::Models::CustomerCreditBalanceDroppedWebhookEvent, Orb::Models::CustomerCreditBalanceRecoveredWebhookEvent, Orb::Models::CustomerCreditLedgerIncrementedWebhookEvent, Orb::Models::CustomerEditedWebhookEvent, Orb::Models::DataExportsTransferErrorWebhookEvent, Orb::Models::DataExportsTransferSuccessWebhookEvent, Orb::Models::EventUnmatchedEventWebhookEvent, Orb::Models::IngestionUnmatchedCustomerIDsWebhookEvent, Orb::Models::InvoiceAccountingSyncFailedWebhookEvent, Orb::Models::InvoiceAccountingSyncSucceededWebhookEvent, Orb::Models::InvoiceAutomationScheduleStepExecutedWebhookEvent, Orb::Models::InvoiceCostDataExportedWebhookEvent, Orb::Models::InvoiceDunningScheduleCreatedWebhookEvent, Orb::Models::InvoiceDunningScheduleEndedWebhookEvent, Orb::Models::InvoiceDunningScheduleResetWebhookEvent, Orb::Models::InvoiceDunningScheduleStepExecutedWebhookEvent, Orb::Models::InvoiceEditedWebhookEvent, Orb::Models::InvoiceInvoiceDateElapsedWebhookEvent, Orb::Models::InvoiceIssueFailedWebhookEvent, Orb::Models::InvoiceIssuedWebhookEvent, Orb::Models::InvoiceIssuedSummaryWebhookEvent, Orb::Models::InvoiceManuallyMarkedAsPaidWebhookEvent, Orb::Models::InvoiceManuallyMarkedAsVoidWebhookEvent, Orb::Models::InvoicePaymentFailedWebhookEvent, Orb::Models::InvoicePaymentProcessingWebhookEvent, Orb::Models::InvoicePaymentSucceededWebhookEvent, Orb::Models::InvoiceSyncFailedWebhookEvent, Orb::Models::InvoiceSyncSucceededWebhookEvent, Orb::Models::InvoiceUndoMarkAsPaidWebhookEvent, Orb::Models::InvoiceDueDateRecalculationCanceledWebhookEvent, Orb::Models::InvoiceDueDateRecalculationCompletedWebhookEvent, Orb::Models::InvoiceDueDateRecalculationStartedWebhookEvent, Orb::Models::MetricEventsDroppedByWatermarkWebhookEvent, Orb::Models::PaymentMethodCreatedWebhookEvent, Orb::Models::PaymentMethodDeletedWebhookEvent, Orb::Models::PlanDefaultVersionSetWebhookEvent, Orb::Models::PlanVersionCreatedWebhookEvent, Orb::Models::PriceEditedWebhookEvent, Orb::Models::ResourceEventTestWebhookEvent, Orb::Models::SalesOrderAccountingSyncFailedWebhookEvent, Orb::Models::SalesOrderAccountingSyncSucceededWebhookEvent, Orb::Models::SubscriptionAccountingSyncFailedWebhookEvent, Orb::Models::SubscriptionAccountingSyncSucceededWebhookEvent, Orb::Models::SubscriptionAlertDisabledWebhookEvent, Orb::Models::SubscriptionCancellationScheduledWebhookEvent, Orb::Models::SubscriptionCancellationUnscheduledWebhookEvent, Orb::Models::SubscriptionCostExceededWebhookEvent, Orb::Models::SubscriptionCreatedWebhookEvent, Orb::Models::SubscriptionEditedWebhookEvent, Orb::Models::SubscriptionEndedWebhookEvent, Orb::Models::SubscriptionFixedFeeQuantityUpdatedWebhookEvent, Orb::Models::SubscriptionGroupedCostExceededWebhookEvent, Orb::Models::SubscriptionInvoicingThresholdExceededWebhookEvent, Orb::Models::SubscriptionLicenseAllocationResetWebhookEvent, Orb::Models::SubscriptionLicenseBalanceThresholdReachedWebhookEvent, Orb::Models::SubscriptionPlanChangeScheduledWebhookEvent, Orb::Models::SubscriptionPlanChangedWebhookEvent, Orb::Models::SubscriptionPlanVersionChangeScheduledWebhookEvent, Orb::Models::SubscriptionPlanVersionChangedWebhookEvent, Orb::Models::SubscriptionSpendExceededWebhookEvent, Orb::Models::SubscriptionStartedWebhookEvent, Orb::Models::SubscriptionTrialEndedWebhookEvent, Orb::Models::SubscriptionUsageExceededWebhookEvent, Orb::Models::TransactionAccountingSyncFailedWebhookEvent, Orb::Models::TransactionAccountingSyncSucceededWebhookEvent]
+      # @return [Orb::Models::BackfillReflectedWebhookEvent, Orb::Models::BackfillRevertedWebhookEvent, Orb::Models::BillableMetricEditedWebhookEvent, Orb::Models::CreditBlockAccountingSyncFailedWebhookEvent, Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent, Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent, Orb::Models::CreditNoteAccountingSyncSucceededWebhookEvent, Orb::Models::CreditNoteIssuedWebhookEvent, Orb::Models::CreditNoteMarkedAsVoidWebhookEvent, Orb::Models::CustomerAccountingSyncFailedWebhookEvent, Orb::Models::CustomerAccountingSyncSucceededWebhookEvent, Orb::Models::CustomerBalanceTransactionCreatedWebhookEvent, Orb::Models::CustomerCreatedWebhookEvent, Orb::Models::CustomerCreditBalanceDepletedWebhookEvent, Orb::Models::CustomerCreditBalanceDroppedWebhookEvent, Orb::Models::CustomerCreditBalanceRecoveredWebhookEvent, Orb::Models::CustomerCreditLedgerIncrementedWebhookEvent, Orb::Models::CustomerEditedWebhookEvent, Orb::Models::DataExportsTransferErrorWebhookEvent, Orb::Models::DataExportsTransferSuccessWebhookEvent, Orb::Models::EventUnmatchedEventWebhookEvent, Orb::Models::IngestionUnmatchedCustomerIDsWebhookEvent, Orb::Models::InvoiceAccountingSyncFailedWebhookEvent, Orb::Models::InvoiceAccountingSyncSucceededWebhookEvent, Orb::Models::InvoiceAutomationScheduleStepExecutedWebhookEvent, Orb::Models::InvoiceCostDataExportedWebhookEvent, Orb::Models::InvoiceDunningScheduleCreatedWebhookEvent, Orb::Models::InvoiceDunningScheduleEndedWebhookEvent, Orb::Models::InvoiceDunningScheduleResetWebhookEvent, Orb::Models::InvoiceDunningScheduleStepExecutedWebhookEvent, Orb::Models::InvoiceEditedWebhookEvent, Orb::Models::InvoiceInvoiceDateElapsedWebhookEvent, Orb::Models::InvoiceIssueFailedWebhookEvent, Orb::Models::InvoiceIssuedWebhookEvent, Orb::Models::InvoiceIssuedSummaryWebhookEvent, Orb::Models::InvoiceManuallyMarkedAsPaidWebhookEvent, Orb::Models::InvoiceManuallyMarkedAsVoidWebhookEvent, Orb::Models::InvoicePaymentFailedWebhookEvent, Orb::Models::InvoicePaymentProcessingWebhookEvent, Orb::Models::InvoicePaymentSucceededWebhookEvent, Orb::Models::InvoiceSyncFailedWebhookEvent, Orb::Models::InvoiceSyncSucceededWebhookEvent, Orb::Models::InvoiceUndoMarkAsPaidWebhookEvent, Orb::Models::InvoiceDueDateRecalculationCanceledWebhookEvent, Orb::Models::InvoiceDueDateRecalculationCompletedWebhookEvent, Orb::Models::InvoiceDueDateRecalculationStartedWebhookEvent, Orb::Models::MetricEventsDroppedByWatermarkWebhookEvent, Orb::Models::PaymentMethodCreatedWebhookEvent, Orb::Models::PaymentMethodDeletedWebhookEvent, Orb::Models::PlanCreatedWebhookEvent, Orb::Models::PlanDefaultVersionSetWebhookEvent, Orb::Models::PlanEditedWebhookEvent, Orb::Models::PlanVersionCreatedWebhookEvent, Orb::Models::PriceEditedWebhookEvent, Orb::Models::ResourceEventTestWebhookEvent, Orb::Models::SalesOrderAccountingSyncFailedWebhookEvent, Orb::Models::SalesOrderAccountingSyncSucceededWebhookEvent, Orb::Models::SubscriptionAccountingSyncFailedWebhookEvent, Orb::Models::SubscriptionAccountingSyncSucceededWebhookEvent, Orb::Models::SubscriptionAlertDisabledWebhookEvent, Orb::Models::SubscriptionCancellationScheduledWebhookEvent, Orb::Models::SubscriptionCancellationUnscheduledWebhookEvent, Orb::Models::SubscriptionCostExceededWebhookEvent, Orb::Models::SubscriptionCreatedWebhookEvent, Orb::Models::SubscriptionEditedWebhookEvent, Orb::Models::SubscriptionEndedWebhookEvent, Orb::Models::SubscriptionFixedFeeQuantityUpdatedWebhookEvent, Orb::Models::SubscriptionGroupedCostExceededWebhookEvent, Orb::Models::SubscriptionInvoicingThresholdExceededWebhookEvent, Orb::Models::SubscriptionLicenseAllocationResetWebhookEvent, Orb::Models::SubscriptionLicenseBalanceThresholdReachedWebhookEvent, Orb::Models::SubscriptionPlanChangeScheduledWebhookEvent, Orb::Models::SubscriptionPlanChangedWebhookEvent, Orb::Models::SubscriptionPlanVersionChangeScheduledWebhookEvent, Orb::Models::SubscriptionPlanVersionChangedWebhookEvent, Orb::Models::SubscriptionSpendExceededWebhookEvent, Orb::Models::SubscriptionStartedWebhookEvent, Orb::Models::SubscriptionTrialEndedWebhookEvent, Orb::Models::SubscriptionUsageExceededWebhookEvent, Orb::Models::TransactionAccountingSyncFailedWebhookEvent, Orb::Models::TransactionAccountingSyncSucceededWebhookEvent]
       def unwrap(payload)
         parsed = JSON.parse(payload, symbolize_names: true)
         Orb::Internal::Type::Converter.coerce(Orb::Models::UnwrapWebhookEvent, parsed)

data/lib/orb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Orb
-  VERSION = "1.43.0"
+  VERSION = "1.44.0"
 end

data/lib/orb.rb

@@ -61,6 +61,7 @@ require_relative "orb/models/aggregated_cost"
 require_relative "orb/models/alert"
 require_relative "orb/models/alert_create_for_customer_params"
 require_relative "orb/models/alert_create_for_external_customer_params"
+require_relative "orb/models/alert_create_for_plan_params"
 require_relative "orb/models/alert_create_for_subscription_params"
 require_relative "orb/models/alert_delete_params"
 require_relative "orb/models/alert_disable_params"
@@ -190,6 +191,9 @@ require_relative "orb/models/dimensional_price_group_list_params"
 require_relative "orb/models/dimensional_price_group_retrieve_params"
 require_relative "orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params"
 require_relative "orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params"
+require_relative "orb/models/dimensional_price_groups/price_create_params"
+require_relative "orb/models/dimensional_price_groups/price_create_response"
+require_relative "orb/models/dimensional_price_groups/price_list_params"
 require_relative "orb/models/dimensional_price_groups"
 require_relative "orb/models/dimensional_price_group_update_params"
 require_relative "orb/models/discount"
@@ -411,8 +415,10 @@ require_relative "orb/models/percentage_discount"
 require_relative "orb/models/percentage_discount_interval"
 require_relative "orb/models/per_price_cost"
 require_relative "orb/models/plan"
+require_relative "orb/models/plan_created_webhook_event"
 require_relative "orb/models/plan_create_params"
 require_relative "orb/models/plan_default_version_set_webhook_event"
+require_relative "orb/models/plan_edited_webhook_event"
 require_relative "orb/models/plan_fetch_params"
 require_relative "orb/models/plan_list_params"
 require_relative "orb/models/plan_phase_amount_discount_adjustment"
@@ -523,6 +529,15 @@ require_relative "orb/models/unit_conversion_rate_config"
 require_relative "orb/models/unwrap_webhook_event"
 require_relative "orb/models/usage_discount"
 require_relative "orb/models/usage_discount_interval"
+require_relative "orb/models/webhook_endpoint"
+require_relative "orb/models/webhook_endpoint_create_params"
+require_relative "orb/models/webhook_endpoint_delete_params"
+require_relative "orb/models/webhook_endpoint_disable_params"
+require_relative "orb/models/webhook_endpoint_enable_params"
+require_relative "orb/models/webhook_endpoint_list_params"
+require_relative "orb/models/webhook_endpoint_retrieve_params"
+require_relative "orb/models/webhook_endpoint_update_params"
+require_relative "orb/models/webhook_endpoint_with_secret"
 require_relative "orb/models/webhook_unwrap_params"
 require_relative "orb/models"
 require_relative "orb/resources/alerts"
@@ -540,6 +555,7 @@ require_relative "orb/resources/customers/credits/ledger"
 require_relative "orb/resources/customers/credits/top_ups"
 require_relative "orb/resources/dimensional_price_groups"
 require_relative "orb/resources/dimensional_price_groups/external_dimensional_price_group_id"
+require_relative "orb/resources/dimensional_price_groups/prices"
 require_relative "orb/resources/events"
 require_relative "orb/resources/events/backfills"
 require_relative "orb/resources/events/volume"
@@ -559,4 +575,5 @@ require_relative "orb/resources/prices/external_price_id"
 require_relative "orb/resources/subscription_changes"
 require_relative "orb/resources/subscriptions"
 require_relative "orb/resources/top_level"
+require_relative "orb/resources/webhook_endpoints"
 require_relative "orb/resources/webhooks"

data/rbi/orb/client.rbi

@@ -91,6 +91,11 @@ module Orb
     sig { returns(Orb::Resources::Items) }
     attr_reader :items
 
+    # A webhook endpoint is an HTTPS URL that Orb sends
+    # [webhook events](/integrations-and-exports/webhooks) to.
+    sig { returns(Orb::Resources::WebhookEndpoints) }
+    attr_reader :webhook_endpoints
+
     # The Metric resource represents a calculation of a quantity based on events.
     # Metrics are defined by the query that transforms raw usage events into
     # meaningful values for your customers.

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