orb-billing 1.43.0 → 1.44.0

data/rbi/orb/models/webhook_endpoint_update_params.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module Orb
+  module Models
+    class WebhookEndpointUpdateParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Orb::WebhookEndpointUpdateParams, Orb::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :webhook_endpoint_id
+
+      # The webhook event types to send to this endpoint. Null sends all event types;
+      # omit to leave them unchanged.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :enabled_event_types
+
+      # The HTTPS URL that Orb sends webhook events to.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :url
+
+      sig do
+        params(
+          webhook_endpoint_id: String,
+          enabled_event_types: T.nilable(T::Array[String]),
+          url: T.nilable(String),
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        webhook_endpoint_id:,
+        # The webhook event types to send to this endpoint. Null sends all event types;
+        # omit to leave them unchanged.
+        enabled_event_types: nil,
+        # The HTTPS URL that Orb sends webhook events to.
+        url: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            webhook_endpoint_id: String,
+            enabled_event_types: T.nilable(T::Array[String]),
+            url: T.nilable(String),
+            request_options: Orb::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/orb/models/webhook_endpoint_with_secret.rbi

@@ -0,0 +1,83 @@
+# typed: strong
+
+module Orb
+  module Models
+    class WebhookEndpointWithSecret < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Orb::WebhookEndpointWithSecret, Orb::Internal::AnyHash)
+        end
+
+      # The Orb-assigned unique identifier for the webhook endpoint.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The time the webhook endpoint was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # Whether Orb sends webhook events to this endpoint.
+      sig { returns(T::Boolean) }
+      attr_accessor :enabled
+
+      # The webhook event types sent to this endpoint. If null, all event types are
+      # sent.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :enabled_event_types
+
+      # The secret used to sign the webhook events sent to this endpoint. Only returned
+      # when the endpoint is created.
+      sig { returns(String) }
+      attr_accessor :secret
+
+      # The HTTPS URL that Orb sends webhook events to.
+      sig { returns(String) }
+      attr_accessor :url
+
+      # A newly created webhook endpoint, along with the secret used to sign its webhook
+      # events.
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          enabled: T::Boolean,
+          enabled_event_types: T.nilable(T::Array[String]),
+          secret: String,
+          url: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The Orb-assigned unique identifier for the webhook endpoint.
+        id:,
+        # The time the webhook endpoint was created.
+        created_at:,
+        # Whether Orb sends webhook events to this endpoint.
+        enabled:,
+        # The webhook event types sent to this endpoint. If null, all event types are
+        # sent.
+        enabled_event_types:,
+        # The secret used to sign the webhook events sent to this endpoint. Only returned
+        # when the endpoint is created.
+        secret:,
+        # The HTTPS URL that Orb sends webhook events to.
+        url:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            enabled: T::Boolean,
+            enabled_event_types: T.nilable(T::Array[String]),
+            secret: String,
+            url: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/orb/models.rbi

@@ -18,6 +18,8 @@ module Orb
   AlertCreateForExternalCustomerParams =
     Orb::Models::AlertCreateForExternalCustomerParams
 
+  AlertCreateForPlanParams = Orb::Models::AlertCreateForPlanParams
+
   AlertCreateForSubscriptionParams =
     Orb::Models::AlertCreateForSubscriptionParams
 
@@ -668,11 +670,15 @@ module Orb
 
   Plan = Orb::Models::Plan
 
+  PlanCreatedWebhookEvent = Orb::Models::PlanCreatedWebhookEvent
+
   PlanCreateParams = Orb::Models::PlanCreateParams
 
   PlanDefaultVersionSetWebhookEvent =
     Orb::Models::PlanDefaultVersionSetWebhookEvent
 
+  PlanEditedWebhookEvent = Orb::Models::PlanEditedWebhookEvent
+
   PlanFetchParams = Orb::Models::PlanFetchParams
 
   PlanListParams = Orb::Models::PlanListParams
@@ -890,5 +896,23 @@ module Orb
 
   UsageDiscountInterval = Orb::Models::UsageDiscountInterval
 
+  WebhookEndpoint = Orb::Models::WebhookEndpoint
+
+  WebhookEndpointCreateParams = Orb::Models::WebhookEndpointCreateParams
+
+  WebhookEndpointDeleteParams = Orb::Models::WebhookEndpointDeleteParams
+
+  WebhookEndpointDisableParams = Orb::Models::WebhookEndpointDisableParams
+
+  WebhookEndpointEnableParams = Orb::Models::WebhookEndpointEnableParams
+
+  WebhookEndpointListParams = Orb::Models::WebhookEndpointListParams
+
+  WebhookEndpointRetrieveParams = Orb::Models::WebhookEndpointRetrieveParams
+
+  WebhookEndpointUpdateParams = Orb::Models::WebhookEndpointUpdateParams
+
+  WebhookEndpointWithSecret = Orb::Models::WebhookEndpointWithSecret
+
   WebhookUnwrapParams = Orb::Models::WebhookUnwrapParams
 end

data/rbi/orb/resources/alerts.rbi

@@ -172,6 +172,65 @@ module Orb
       )
       end
 
+      # This endpoint is used to create alerts at the plan level. Plan level alerts are
+      # automatically propagated to all subscriptions associated with the plan. These
+      # alerts are scoped to a specific plan version; if no version is specified, the
+      # active plan version is used.
+      #
+      # Plan level alerts can be of three types: `usage_exceeded`, `cost_exceeded`, or
+      # `spend_exceeded`. A `usage_exceeded` alert is scoped to a particular metric and
+      # is triggered when the usage of that metric exceeds predefined thresholds during
+      # the current billing cycle. A `cost_exceeded` alert is triggered when the total
+      # amount due during the current billing cycle surpasses predefined thresholds.
+      # `cost_exceeded` alerts do not include burndown of pre-purchase credits. A
+      # `spend_exceeded` alert is triggered when the rated spend (the pricing subtotal,
+      # before invoice-level adjustments and credits) denominated in the alert's
+      # currency exceeds predefined thresholds during the current billing cycle;
+      # `price_filters` can scope which prices contribute. Each plan can have one
+      # `cost_exceeded` alert and one `usage_exceeded` alert per metric that is a part
+      # of the plan.
+      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(Orb::Alert)
+      end
+      def create_for_plan(
+        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
+
       # This endpoint is used to create alerts at the subscription level.
       #
       # Subscription level alerts can be one of three types: `usage_exceeded`,

data/rbi/orb/resources/dimensional_price_groups/prices.rbi

@@ -0,0 +1,82 @@
+# typed: strong
+
+module Orb
+  module Resources
+    class DimensionalPriceGroups
+      class Prices
+        # Create prices in a dimensional price group. Every price shares `item_id`,
+        # `cadence`, `currency`, and `model_type`. Tiered prices also share tier
+        # boundaries; each row supplies its own amounts. The request is one transaction.
+        sig do
+          params(
+            dimensional_price_group_id: String,
+            cadence:
+              Orb::DimensionalPriceGroups::PriceCreateParams::Cadence::OrSymbol,
+            currency: String,
+            item_id: String,
+            model_type:
+              Orb::DimensionalPriceGroups::PriceCreateParams::ModelType::OrSymbol,
+            prices:
+              T::Array[
+                Orb::DimensionalPriceGroups::PriceCreateParams::Price::OrHash
+              ],
+            tiers:
+              T.nilable(
+                T::Array[
+                  Orb::DimensionalPriceGroups::PriceCreateParams::Tier::OrHash
+                ]
+              ),
+            request_options: Orb::RequestOptions::OrHash
+          ).returns(Orb::Models::DimensionalPriceGroups::PriceCreateResponse)
+        end
+        def create(
+          dimensional_price_group_id,
+          # Billing cadence for every price
+          cadence:,
+          # An ISO 4217 currency string for every price.
+          currency:,
+          # The item for every price. Must be the group's billable metric item.
+          item_id:,
+          model_type:,
+          prices:,
+          # Shared tier boundaries. Required for tiered prices and omitted for unit prices.
+          tiers: nil,
+          request_options: {}
+        )
+        end
+
+        # This endpoint returns the prices in a dimensional price group. Subscription
+        # overrides are omitted. Archived prices are omitted unless `status` is `archived`
+        # or `all`.
+        sig do
+          params(
+            dimensional_price_group_id: String,
+            cursor: T.nilable(String),
+            limit: Integer,
+            status:
+              Orb::DimensionalPriceGroups::PriceListParams::Status::OrSymbol,
+            request_options: Orb::RequestOptions::OrHash
+          ).returns(Orb::Internal::Page[Orb::Price::Variants])
+        end
+        def list(
+          dimensional_price_group_id,
+          # Cursor for pagination. This can be populated by the `next_cursor` value returned
+          # from the initial request.
+          cursor: nil,
+          # The number of items to fetch. Defaults to 20.
+          limit: nil,
+          # active omits archived prices. archived returns only archived prices. all returns
+          # both.
+          status: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Orb::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/orb/resources/dimensional_price_groups.rbi

@@ -10,6 +10,9 @@ module Orb
       end
       attr_reader :external_dimensional_price_group_id
 
+      sig { returns(Orb::Resources::DimensionalPriceGroups::Prices) }
+      attr_reader :prices
+
       # A dimensional price group is used to partition the result of a billable metric
       # by a set of dimensions. Prices in a price group must specify the partition used
       # to derive their usage.

data/rbi/orb/resources/webhook_endpoints.rbi

@@ -0,0 +1,116 @@
+# typed: strong
+
+module Orb
+  module Resources
+    # A webhook endpoint is an HTTPS URL that Orb sends
+    # [webhook events](/integrations-and-exports/webhooks) to.
+    class WebhookEndpoints
+      # 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.
+      sig do
+        params(
+          url: String,
+          enabled_event_types: T.nilable(T::Array[String]),
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::WebhookEndpointWithSecret)
+      end
+      def create(
+        # The HTTPS URL that Orb sends webhook events to.
+        url:,
+        # The webhook event types to send to this endpoint. If omitted or null, all event
+        # types are sent.
+        enabled_event_types: nil,
+        request_options: {}
+      )
+      end
+
+      # This endpoint returns a webhook endpoint identified by its ID.
+      sig do
+        params(
+          webhook_endpoint_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::WebhookEndpoint)
+      end
+      def retrieve(webhook_endpoint_id, request_options: {})
+      end
+
+      # This endpoint updates a webhook endpoint's URL or the event types sent to it.
+      sig do
+        params(
+          webhook_endpoint_id: String,
+          enabled_event_types: T.nilable(T::Array[String]),
+          url: T.nilable(String),
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::WebhookEndpoint)
+      end
+      def update(
+        webhook_endpoint_id,
+        # The webhook event types to send to this endpoint. Null sends all event types;
+        # omit to leave them unchanged.
+        enabled_event_types: nil,
+        # The HTTPS URL that Orb sends webhook events to.
+        url: nil,
+        request_options: {}
+      )
+      end
+
+      # This endpoint returns the account's webhook endpoints, ordered starting from the
+      # most recently created.
+      sig do
+        params(
+          cursor: T.nilable(String),
+          limit: Integer,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Internal::Page[Orb::WebhookEndpoint])
+      end
+      def list(
+        # Cursor for pagination. This can be populated by the `next_cursor` value returned
+        # from the initial request.
+        cursor: nil,
+        # The number of items to fetch. Defaults to 20.
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      # This endpoint deletes a webhook endpoint. Orb stops sending webhook events to it
+      # immediately.
+      sig do
+        params(
+          webhook_endpoint_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).void
+      end
+      def delete(webhook_endpoint_id, request_options: {})
+      end
+
+      # This endpoint disables a webhook endpoint, so Orb stops sending webhook events
+      # to it until it is enabled again.
+      sig do
+        params(
+          webhook_endpoint_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::WebhookEndpoint)
+      end
+      def disable(webhook_endpoint_id, request_options: {})
+      end
+
+      # This endpoint enables a webhook endpoint, so Orb resumes sending webhook events
+      # to it.
+      sig do
+        params(
+          webhook_endpoint_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::WebhookEndpoint)
+      end
+      def enable(webhook_endpoint_id, request_options: {})
+      end
+
+      # @api private
+      sig { params(client: Orb::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/orb/resources/webhooks.rbi

@@ -55,7 +55,9 @@ module Orb
             Orb::MetricEventsDroppedByWatermarkWebhookEvent,
             Orb::PaymentMethodCreatedWebhookEvent,
             Orb::PaymentMethodDeletedWebhookEvent,
+            Orb::PlanCreatedWebhookEvent,
             Orb::PlanDefaultVersionSetWebhookEvent,
+            Orb::PlanEditedWebhookEvent,
             Orb::PlanVersionCreatedWebhookEvent,
             Orb::PriceEditedWebhookEvent,
             Orb::ResourceEventTestWebhookEvent,

data/sig/orb/client.rbs

@@ -32,6 +32,8 @@ module Orb
 
     attr_reader items: Orb::Resources::Items
 
+    attr_reader webhook_endpoints: Orb::Resources::WebhookEndpoints
+
     attr_reader metrics: Orb::Resources::Metrics
 
     attr_reader plans: Orb::Resources::Plans

data/sig/orb/models/alert_create_for_plan_params.rbs

@@ -0,0 +1,126 @@
+module Orb
+  module Models
+    type alert_create_for_plan_params =
+      {
+        plan_id: String,
+        thresholds: ::Array[Orb::Threshold],
+        type: Orb::Models::AlertCreateForPlanParams::type_,
+        currency: String?,
+        grouping_keys: ::Array[String]?,
+        metric_id: String?,
+        plan_version: Integer?,
+        price_filters: ::Array[Orb::AlertCreateForPlanParams::PriceFilter]?
+      }
+      & Orb::Internal::Type::request_parameters
+
+    class AlertCreateForPlanParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      attr_accessor plan_id: String
+
+      attr_accessor thresholds: ::Array[Orb::Threshold]
+
+      attr_accessor type: Orb::Models::AlertCreateForPlanParams::type_
+
+      attr_accessor currency: String?
+
+      attr_accessor grouping_keys: ::Array[String]?
+
+      attr_accessor metric_id: String?
+
+      attr_accessor plan_version: Integer?
+
+      attr_accessor price_filters: ::Array[Orb::AlertCreateForPlanParams::PriceFilter]?
+
+      def initialize: (
+        plan_id: String,
+        thresholds: ::Array[Orb::Threshold],
+        type: Orb::Models::AlertCreateForPlanParams::type_,
+        ?currency: String?,
+        ?grouping_keys: ::Array[String]?,
+        ?metric_id: String?,
+        ?plan_version: Integer?,
+        ?price_filters: ::Array[Orb::AlertCreateForPlanParams::PriceFilter]?,
+        ?request_options: Orb::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        plan_id: String,
+        thresholds: ::Array[Orb::Threshold],
+        type: Orb::Models::AlertCreateForPlanParams::type_,
+        currency: String?,
+        grouping_keys: ::Array[String]?,
+        metric_id: String?,
+        plan_version: Integer?,
+        price_filters: ::Array[Orb::AlertCreateForPlanParams::PriceFilter]?,
+        request_options: Orb::RequestOptions
+      }
+
+      type type_ = :usage_exceeded | :cost_exceeded | :spend_exceeded
+
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        USAGE_EXCEEDED: :usage_exceeded
+        COST_EXCEEDED: :cost_exceeded
+        SPEND_EXCEEDED: :spend_exceeded
+
+        def self?.values: -> ::Array[Orb::Models::AlertCreateForPlanParams::type_]
+      end
+
+      type price_filter =
+        {
+          field: Orb::Models::AlertCreateForPlanParams::PriceFilter::field,
+          operator: Orb::Models::AlertCreateForPlanParams::PriceFilter::operator,
+          values: ::Array[String]
+        }
+
+      class PriceFilter < Orb::Internal::Type::BaseModel
+        attr_accessor field: Orb::Models::AlertCreateForPlanParams::PriceFilter::field
+
+        attr_accessor operator: Orb::Models::AlertCreateForPlanParams::PriceFilter::operator
+
+        attr_accessor values: ::Array[String]
+
+        def initialize: (
+          field: Orb::Models::AlertCreateForPlanParams::PriceFilter::field,
+          operator: Orb::Models::AlertCreateForPlanParams::PriceFilter::operator,
+          values: ::Array[String]
+        ) -> void
+
+        def to_hash: -> {
+          field: Orb::Models::AlertCreateForPlanParams::PriceFilter::field,
+          operator: Orb::Models::AlertCreateForPlanParams::PriceFilter::operator,
+          values: ::Array[String]
+        }
+
+        type field =
+          :price_id | :item_id | :price_type | :currency | :pricing_unit_id
+
+        module Field
+          extend Orb::Internal::Type::Enum
+
+          PRICE_ID: :price_id
+          ITEM_ID: :item_id
+          PRICE_TYPE: :price_type
+          CURRENCY: :currency
+          PRICING_UNIT_ID: :pricing_unit_id
+
+          def self?.values: -> ::Array[Orb::Models::AlertCreateForPlanParams::PriceFilter::field]
+        end
+
+        type operator = :includes | :excludes
+
+        module Operator
+          extend Orb::Internal::Type::Enum
+
+          INCLUDES: :includes
+          EXCLUDES: :excludes
+
+          def self?.values: -> ::Array[Orb::Models::AlertCreateForPlanParams::PriceFilter::operator]
+        end
+      end
+    end
+  end
+end