orb-billing 1.46.0 → 1.48.0

data/rbi/orb/models/invoice_issued_summary_webhook_event.rbi

@@ -16,7 +16,8 @@ module Orb
       sig { returns(Time) }
       attr_accessor :created_at
 
-      # #InvoiceApiResourceWithoutLineItems
+      # An invoice without its line items, subtotal, discounts, minimums or maximums.
+      # Fetch the invoice for those.
       sig { returns(Orb::InvoiceIssuedSummaryWebhookEvent::Invoice) }
       attr_reader :invoice
 
@@ -68,7 +69,8 @@ module Orb
         id:,
         # The time at which this event was created, to the second.
         created_at:,
-        # #InvoiceApiResourceWithoutLineItems
+        # An invoice without its line items, subtotal, discounts, minimums or maximums.
+        # Fetch the invoice for those.
         invoice:,
         # The serialization style this payload was rendered in, as configured on the
         # endpoint.
@@ -463,7 +465,8 @@ module Orb
         sig { returns(T::Boolean) }
         attr_accessor :will_auto_issue
 
-        # #InvoiceApiResourceWithoutLineItems
+        # An invoice without its line items, subtotal, discounts, minimums or maximums.
+        # Fetch the invoice for those.
         sig do
           params(
             id: String,

data/rbi/orb/models/invoice_list_summary_response.rbi

@@ -355,7 +355,8 @@ module Orb
       sig { returns(T::Boolean) }
       attr_accessor :will_auto_issue
 
-      # #InvoiceApiResourceWithoutLineItems
+      # An invoice without its line items, subtotal, discounts, minimums or maximums.
+      # Fetch the invoice for those.
       sig do
         params(
           id: String,

data/rbi/orb/models/metric_archive_params.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module Orb
+  module Models
+    class MetricArchiveParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias { T.any(Orb::MetricArchiveParams, Orb::Internal::AnyHash) }
+
+      sig { returns(String) }
+      attr_accessor :metric_id
+
+      sig do
+        params(
+          metric_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(metric_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { metric_id: String, request_options: Orb::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/orb/models/metric_list_params.rbi

@@ -33,6 +33,10 @@ module Orb
       sig { params(limit: Integer).void }
       attr_writer :limit
 
+      # The metric status to filter to ('active', 'archived', or 'draft').
+      sig { returns(T.nilable(Orb::MetricListParams::Status::OrSymbol)) }
+      attr_accessor :status
+
       sig do
         params(
           created_at_gt: T.nilable(Time),
@@ -41,6 +45,7 @@ module Orb
           created_at_lte: T.nilable(Time),
           cursor: T.nilable(String),
           limit: Integer,
+          status: T.nilable(Orb::MetricListParams::Status::OrSymbol),
           request_options: Orb::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -54,6 +59,8 @@ module Orb
         cursor: nil,
         # The number of items to fetch. Defaults to 20.
         limit: nil,
+        # The metric status to filter to ('active', 'archived', or 'draft').
+        status: nil,
         request_options: {}
       )
       end
@@ -67,12 +74,34 @@ module Orb
             created_at_lte: T.nilable(Time),
             cursor: T.nilable(String),
             limit: Integer,
+            status: T.nilable(Orb::MetricListParams::Status::OrSymbol),
             request_options: Orb::RequestOptions
           }
         )
       end
       def to_hash
       end
+
+      # The metric status to filter to ('active', 'archived', or 'draft').
+      module Status
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Orb::MetricListParams::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE = T.let(:active, Orb::MetricListParams::Status::TaggedSymbol)
+        ARCHIVED = T.let(:archived, Orb::MetricListParams::Status::TaggedSymbol)
+        DRAFT = T.let(:draft, Orb::MetricListParams::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Orb::MetricListParams::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/orb/models/metric_unarchive_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Orb
+  module Models
+    class MetricUnarchiveParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Orb::MetricUnarchiveParams, Orb::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :metric_id
+
+      sig do
+        params(
+          metric_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(metric_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { metric_id: String, request_options: Orb::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/orb/models/metric_update_params.rbi

@@ -12,25 +12,39 @@ module Orb
       sig { returns(String) }
       attr_accessor :metric_id
 
+      # A description of the metric.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
       # User-specified key/value pairs for the resource. Individual keys can be removed
       # by setting the value to `null`, and the entire metadata mapping can be cleared
       # by setting `metadata` to `null`.
       sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
       attr_accessor :metadata
 
+      # The name of the metric.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
       sig do
         params(
           metric_id: String,
+          description: T.nilable(String),
           metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+          name: T.nilable(String),
           request_options: Orb::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
         metric_id:,
+        # A description of the metric.
+        description: nil,
         # User-specified key/value pairs for the resource. Individual keys can be removed
         # by setting the value to `null`, and the entire metadata mapping can be cleared
         # by setting `metadata` to `null`.
         metadata: nil,
+        # The name of the metric.
+        name: nil,
         request_options: {}
       )
       end
@@ -39,7 +53,9 @@ module Orb
         override.returns(
           {
             metric_id: String,
+            description: T.nilable(String),
             metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+            name: T.nilable(String),
             request_options: Orb::RequestOptions
           }
         )

data/rbi/orb/models/plan_update_params.rbi

@@ -28,12 +28,17 @@ module Orb
       sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
       attr_accessor :metadata
 
+      # The name of the plan.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
       sig do
         params(
           plan_id: String,
           description: T.nilable(String),
           external_plan_id: T.nilable(String),
           metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+          name: T.nilable(String),
           request_options: Orb::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -49,6 +54,8 @@ module Orb
         # by setting the value to `null`, and the entire metadata mapping can be cleared
         # by setting `metadata` to `null`.
         metadata: nil,
+        # The name of the plan.
+        name: nil,
         request_options: {}
       )
       end
@@ -60,6 +67,7 @@ module Orb
             description: T.nilable(String),
             external_plan_id: T.nilable(String),
             metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+            name: T.nilable(String),
             request_options: Orb::RequestOptions
           }
         )

data/rbi/orb/models/plans/external_plan_id_update_params.rbi

@@ -34,12 +34,17 @@ module Orb
         sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
         attr_accessor :metadata
 
+        # The name of the plan.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
         sig do
           params(
             other_external_plan_id: String,
             description: T.nilable(String),
             external_plan_id: T.nilable(String),
             metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+            name: T.nilable(String),
             request_options: Orb::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -55,6 +60,8 @@ module Orb
           # by setting the value to `null`, and the entire metadata mapping can be cleared
           # by setting `metadata` to `null`.
           metadata: nil,
+          # The name of the plan.
+          name: nil,
           request_options: {}
         )
         end
@@ -66,6 +73,7 @@ module Orb
               description: T.nilable(String),
               external_plan_id: T.nilable(String),
               metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+              name: T.nilable(String),
               request_options: Orb::RequestOptions
             }
           )

data/rbi/orb/models/subscription_alert_disabled_webhook_event.rbi

@@ -41,10 +41,8 @@ module Orb
       end
       attr_writer :properties
 
-      # A lightweight subscription representation for webhook payloads.
-      #
-      # This avoids the expensive to_subscription_params() call required for full
-      # serialization.
+      # The subscription in a license or grouped cost webhook payload: its status,
+      # dates, plan and customer.
       sig { returns(Orb::SubscriptionAlertDisabledWebhookEvent::Subscription) }
       attr_reader :subscription
 
@@ -87,10 +85,8 @@ module Orb
         # Sent when the system disables an alert on its own, currently for
         # cardinality-limit enforcement on grouped cost alerts.
         properties:,
-        # A lightweight subscription representation for webhook payloads.
-        #
-        # This avoids the expensive to_subscription_params() call required for full
-        # serialization.
+        # The subscription in a license or grouped cost webhook payload: its status,
+        # dates, plan and customer.
         subscription:,
         # The event this payload describes.
         type:
@@ -1122,10 +1118,8 @@ module Orb
         end
         attr_accessor :status
 
-        # A lightweight subscription representation for webhook payloads.
-        #
-        # This avoids the expensive to_subscription_params() call required for full
-        # serialization.
+        # The subscription in a license or grouped cost webhook payload: its status,
+        # dates, plan and customer.
         sig do
           params(
             id: String,

data/rbi/orb/models/subscription_grouped_cost_exceeded_webhook_event.rbi

@@ -43,10 +43,8 @@ module Orb
       end
       attr_writer :properties
 
-      # A lightweight subscription representation for webhook payloads.
-      #
-      # This avoids the expensive to_subscription_params() call required for full
-      # serialization.
+      # The subscription in a license or grouped cost webhook payload: its status,
+      # dates, plan and customer.
       sig do
         returns(Orb::SubscriptionGroupedCostExceededWebhookEvent::Subscription)
       end
@@ -93,10 +91,8 @@ module Orb
         # Every group that crossed a threshold for one alert, batched into a single
         # message.
         properties:,
-        # A lightweight subscription representation for webhook payloads.
-        #
-        # This avoids the expensive to_subscription_params() call required for full
-        # serialization.
+        # The subscription in a license or grouped cost webhook payload: its status,
+        # dates, plan and customer.
         subscription:,
         # The event this payload describes.
         type:
@@ -1149,10 +1145,8 @@ module Orb
         end
         attr_accessor :status
 
-        # A lightweight subscription representation for webhook payloads.
-        #
-        # This avoids the expensive to_subscription_params() call required for full
-        # serialization.
+        # The subscription in a license or grouped cost webhook payload: its status,
+        # dates, plan and customer.
         sig do
           params(
             id: String,

data/rbi/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rbi

@@ -43,10 +43,8 @@ module Orb
       end
       attr_writer :properties
 
-      # A lightweight subscription representation for webhook payloads.
-      #
-      # This avoids the expensive to_subscription_params() call required for full
-      # serialization.
+      # The subscription in a license or grouped cost webhook payload: its status,
+      # dates, plan and customer.
       sig do
         returns(
           Orb::SubscriptionInvoicingThresholdExceededWebhookEvent::Subscription
@@ -95,10 +93,8 @@ module Orb
         # endpoint.
         payload_style:,
         properties:,
-        # A lightweight subscription representation for webhook payloads.
-        #
-        # This avoids the expensive to_subscription_params() call required for full
-        # serialization.
+        # The subscription in a license or grouped cost webhook payload: its status,
+        # dates, plan and customer.
         subscription:,
         # The event this payload describes.
         type:
@@ -261,10 +257,8 @@ module Orb
         end
         attr_accessor :status
 
-        # A lightweight subscription representation for webhook payloads.
-        #
-        # This avoids the expensive to_subscription_params() call required for full
-        # serialization.
+        # The subscription in a license or grouped cost webhook payload: its status,
+        # dates, plan and customer.
         sig do
           params(
             id: String,

data/rbi/orb/models/subscription_license_allocation_reset_webhook_event.rbi

@@ -43,10 +43,8 @@ module Orb
       end
       attr_writer :properties
 
-      # A lightweight subscription representation for webhook payloads.
-      #
-      # This avoids the expensive to_subscription_params() call required for full
-      # serialization.
+      # The subscription in a license or grouped cost webhook payload: its status,
+      # dates, plan and customer.
       sig do
         returns(
           Orb::SubscriptionLicenseAllocationResetWebhookEvent::Subscription
@@ -96,10 +94,8 @@ module Orb
         # Fires at the start of a billing period when license allocations are replenished.
         # Allocations sharing a billing period are batched into one message.
         properties:,
-        # A lightweight subscription representation for webhook payloads.
-        #
-        # This avoids the expensive to_subscription_params() call required for full
-        # serialization.
+        # The subscription in a license or grouped cost webhook payload: its status,
+        # dates, plan and customer.
         subscription:,
         # The event this payload describes.
         type:
@@ -308,10 +304,8 @@ module Orb
         end
         attr_accessor :status
 
-        # A lightweight subscription representation for webhook payloads.
-        #
-        # This avoids the expensive to_subscription_params() call required for full
-        # serialization.
+        # The subscription in a license or grouped cost webhook payload: its status,
+        # dates, plan and customer.
         sig do
           params(
             id: String,

data/rbi/orb/models/subscription_license_balance_threshold_reached_webhook_event.rbi

@@ -45,10 +45,8 @@ module Orb
       end
       attr_writer :properties
 
-      # A lightweight subscription representation for webhook payloads.
-      #
-      # This avoids the expensive to_subscription_params() call required for full
-      # serialization.
+      # The subscription in a license or grouped cost webhook payload: its status,
+      # dates, plan and customer.
       sig do
         returns(
           Orb::SubscriptionLicenseBalanceThresholdReachedWebhookEvent::Subscription
@@ -98,10 +96,8 @@ module Orb
         # Every license that crossed a threshold for one alert, batched into a single
         # message. For account-wide alerts the licenses may span several license types.
         properties:,
-        # A lightweight subscription representation for webhook payloads.
-        #
-        # This avoids the expensive to_subscription_params() call required for full
-        # serialization.
+        # The subscription in a license or grouped cost webhook payload: its status,
+        # dates, plan and customer.
         subscription:,
         # The event this payload describes.
         type:
@@ -1152,10 +1148,8 @@ module Orb
         end
         attr_accessor :status
 
-        # A lightweight subscription representation for webhook payloads.
-        #
-        # This avoids the expensive to_subscription_params() call required for full
-        # serialization.
+        # The subscription in a license or grouped cost webhook payload: its status,
+        # dates, plan and customer.
         sig do
           params(
             id: String,

data/rbi/orb/models/webhook_endpoint.rbi

@@ -23,6 +23,13 @@ module Orb
       sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :enabled_event_types
 
+      # The payload style of the webhook events sent to this endpoint. `standard`
+      # payloads include each object's own fields and references to related objects,
+      # without invoice line items or subscription price intervals. `expanded` payloads
+      # include every object fully expanded.
+      sig { returns(Orb::WebhookEndpoint::PayloadStyle::TaggedSymbol) }
+      attr_accessor :payload_style
+
       # The HTTPS URL that Orb sends webhook events to.
       sig { returns(String) }
       attr_accessor :url
@@ -35,6 +42,7 @@ module Orb
           created_at: Time,
           enabled: T::Boolean,
           enabled_event_types: T.nilable(T::Array[String]),
+          payload_style: Orb::WebhookEndpoint::PayloadStyle::OrSymbol,
           url: String
         ).returns(T.attached_class)
       end
@@ -48,6 +56,11 @@ module Orb
         # The webhook event types sent to this endpoint. If null, all event types are
         # sent.
         enabled_event_types:,
+        # The payload style of the webhook events sent to this endpoint. `standard`
+        # payloads include each object's own fields and references to related objects,
+        # without invoice line items or subscription price intervals. `expanded` payloads
+        # include every object fully expanded.
+        payload_style:,
         # The HTTPS URL that Orb sends webhook events to.
         url:
       )
@@ -60,12 +73,38 @@ module Orb
             created_at: Time,
             enabled: T::Boolean,
             enabled_event_types: T.nilable(T::Array[String]),
+            payload_style: Orb::WebhookEndpoint::PayloadStyle::TaggedSymbol,
             url: String
           }
         )
       end
       def to_hash
       end
+
+      # The payload style of the webhook events sent to this endpoint. `standard`
+      # payloads include each object's own fields and references to related objects,
+      # without invoice line items or subscription price intervals. `expanded` payloads
+      # include every object fully expanded.
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Orb::WebhookEndpoint::PayloadStyle) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EXPANDED =
+          T.let(:expanded, Orb::WebhookEndpoint::PayloadStyle::TaggedSymbol)
+        STANDARD =
+          T.let(:standard, Orb::WebhookEndpoint::PayloadStyle::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Orb::WebhookEndpoint::PayloadStyle::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/orb/models/webhook_endpoint_create_params.rbi

@@ -20,10 +20,21 @@ module Orb
       sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :enabled_event_types
 
+      # The payload style of the webhook events sent to this endpoint. If omitted or
+      # null, the account's default style is used.
+      sig do
+        returns(
+          T.nilable(Orb::WebhookEndpointCreateParams::PayloadStyle::OrSymbol)
+        )
+      end
+      attr_accessor :payload_style
+
       sig do
         params(
           url: String,
           enabled_event_types: T.nilable(T::Array[String]),
+          payload_style:
+            T.nilable(Orb::WebhookEndpointCreateParams::PayloadStyle::OrSymbol),
           request_options: Orb::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -33,6 +44,9 @@ module Orb
         # The webhook event types to send to this endpoint. If omitted or null, all event
         # types are sent.
         enabled_event_types: nil,
+        # The payload style of the webhook events sent to this endpoint. If omitted or
+        # null, the account's default style is used.
+        payload_style: nil,
         request_options: {}
       )
       end
@@ -42,12 +56,49 @@ module Orb
           {
             url: String,
             enabled_event_types: T.nilable(T::Array[String]),
+            payload_style:
+              T.nilable(
+                Orb::WebhookEndpointCreateParams::PayloadStyle::OrSymbol
+              ),
             request_options: Orb::RequestOptions
           }
         )
       end
       def to_hash
       end
+
+      # The payload style of the webhook events sent to this endpoint. If omitted or
+      # null, the account's default style is used.
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Orb::WebhookEndpointCreateParams::PayloadStyle)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EXPANDED =
+          T.let(
+            :expanded,
+            Orb::WebhookEndpointCreateParams::PayloadStyle::TaggedSymbol
+          )
+        STANDARD =
+          T.let(
+            :standard,
+            Orb::WebhookEndpointCreateParams::PayloadStyle::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::WebhookEndpointCreateParams::PayloadStyle::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end