orb-billing 1.45.0 → 1.47.0

data/rbi/orb/resources/plans/external_plan_id.rbi

@@ -8,8 +8,9 @@ module Orb
       # subscription. You can see more about how to configure prices in the
       # [Price resource](/reference/price).
       class ExternalPlanID
-        # This endpoint can be used to update the `external_plan_id`, `description`, and
-        # `metadata` of an existing plan.
+        # This endpoint can be used to update the `name`, `external_plan_id`,
+        # `description`, and `metadata` of an existing plan. A plan's `name` cannot be
+        # empty.
         #
         # Other fields on a plan are currently immutable.
         sig do
@@ -18,6 +19,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::OrHash
           ).returns(Orb::Plan)
         end
@@ -33,6 +35,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

data/rbi/orb/resources/plans.rbi

@@ -74,8 +74,9 @@ module Orb
       )
       end
 
-      # This endpoint can be used to update the `external_plan_id`, `description`, and
-      # `metadata` of an existing plan.
+      # This endpoint can be used to update the `name`, `external_plan_id`,
+      # `description`, and `metadata` of an existing plan. A plan's `name` cannot be
+      # empty.
       #
       # Other fields on a plan are currently immutable.
       sig do
@@ -84,6 +85,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::OrHash
         ).returns(Orb::Plan)
       end
@@ -99,6 +101,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

data/rbi/orb/resources/webhook_endpoints.rbi

@@ -12,6 +12,8 @@ module Orb
         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(Orb::WebhookEndpointWithSecret)
       end
@@ -21,6 +23,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
@@ -40,6 +45,8 @@ module Orb
         params(
           webhook_endpoint_id: String,
           enabled_event_types: T.nilable(T::Array[String]),
+          payload_style:
+            T.nilable(Orb::WebhookEndpointUpdateParams::PayloadStyle::OrSymbol),
           url: T.nilable(String),
           request_options: Orb::RequestOptions::OrHash
         ).returns(Orb::WebhookEndpoint)
@@ -49,6 +56,9 @@ module Orb
         # The webhook event types to send to this endpoint. Null sends all event types;
         # omit to leave them unchanged.
         enabled_event_types: nil,
+        # The payload style of the webhook events sent to this endpoint. Applies to events
+        # created after the change; omit to leave it unchanged.
+        payload_style: nil,
         # The HTTPS URL that Orb sends webhook events to.
         url: nil,
         request_options: {}

data/rbi/orb/resources/webhooks/standard.rbi

@@ -0,0 +1,107 @@
+# typed: strong
+
+module Orb
+  module Resources
+    class Webhooks
+      class Standard
+        sig do
+          params(payload: String).returns(
+            T.any(
+              Orb::Webhooks::BackfillReflectedStandardWebhookEvent,
+              Orb::Webhooks::BackfillRevertedStandardWebhookEvent,
+              Orb::Webhooks::BillableMetricEditedStandardWebhookEvent,
+              Orb::Webhooks::CreditBlockAccountingSyncFailedStandardWebhookEvent,
+              Orb::Webhooks::CreditBlockAccountingSyncSucceededStandardWebhookEvent,
+              Orb::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent,
+              Orb::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent,
+              Orb::Webhooks::CreditNoteIssuedStandardWebhookEvent,
+              Orb::Webhooks::CreditNoteMarkedAsVoidStandardWebhookEvent,
+              Orb::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent,
+              Orb::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent,
+              Orb::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent,
+              Orb::Webhooks::CustomerCreatedStandardWebhookEvent,
+              Orb::Webhooks::CustomerCreditBalanceDepletedStandardWebhookEvent,
+              Orb::Webhooks::CustomerCreditBalanceDroppedStandardWebhookEvent,
+              Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent,
+              Orb::Webhooks::CustomerCreditLedgerIncrementedStandardWebhookEvent,
+              Orb::Webhooks::CustomerEditedStandardWebhookEvent,
+              Orb::Webhooks::DataExportsTransferErrorStandardWebhookEvent,
+              Orb::Webhooks::DataExportsTransferSuccessStandardWebhookEvent,
+              Orb::Webhooks::EventUnmatchedEventStandardWebhookEvent,
+              Orb::Webhooks::IngestionUnmatchedCustomerIDsStandardWebhookEvent,
+              Orb::Webhooks::InvoiceAccountingSyncFailedStandardWebhookEvent,
+              Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent,
+              Orb::Webhooks::InvoiceAutomationScheduleStepExecutedStandardWebhookEvent,
+              Orb::Webhooks::InvoiceCostDataExportedStandardWebhookEvent,
+              Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent,
+              Orb::Webhooks::InvoiceDunningScheduleEndedStandardWebhookEvent,
+              Orb::Webhooks::InvoiceDunningScheduleResetStandardWebhookEvent,
+              Orb::Webhooks::InvoiceDunningScheduleStepExecutedStandardWebhookEvent,
+              Orb::Webhooks::InvoiceEditedStandardWebhookEvent,
+              Orb::Webhooks::InvoiceInvoiceDateElapsedStandardWebhookEvent,
+              Orb::Webhooks::InvoiceIssueFailedStandardWebhookEvent,
+              Orb::Webhooks::InvoiceIssuedStandardWebhookEvent,
+              Orb::Webhooks::InvoiceIssuedSummaryStandardWebhookEvent,
+              Orb::Webhooks::InvoiceManuallyMarkedAsPaidStandardWebhookEvent,
+              Orb::Webhooks::InvoiceManuallyMarkedAsVoidStandardWebhookEvent,
+              Orb::Webhooks::InvoicePaymentFailedStandardWebhookEvent,
+              Orb::Webhooks::InvoicePaymentProcessingStandardWebhookEvent,
+              Orb::Webhooks::InvoicePaymentSucceededStandardWebhookEvent,
+              Orb::Webhooks::InvoiceSyncFailedStandardWebhookEvent,
+              Orb::Webhooks::InvoiceSyncSucceededStandardWebhookEvent,
+              Orb::Webhooks::InvoiceUndoMarkAsPaidStandardWebhookEvent,
+              Orb::Webhooks::InvoiceDueDateRecalculationCanceledStandardWebhookEvent,
+              Orb::Webhooks::InvoiceDueDateRecalculationCompletedStandardWebhookEvent,
+              Orb::Webhooks::InvoiceDueDateRecalculationStartedStandardWebhookEvent,
+              Orb::Webhooks::MetricEventsDroppedByWatermarkStandardWebhookEvent,
+              Orb::Webhooks::PaymentMethodCreatedStandardWebhookEvent,
+              Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent,
+              Orb::Webhooks::PlanCreatedStandardWebhookEvent,
+              Orb::Webhooks::PlanDefaultVersionSetStandardWebhookEvent,
+              Orb::Webhooks::PlanEditedStandardWebhookEvent,
+              Orb::Webhooks::PlanVersionCreatedStandardWebhookEvent,
+              Orb::Webhooks::PriceEditedStandardWebhookEvent,
+              Orb::Webhooks::ResourceEventTestStandardWebhookEvent,
+              Orb::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent,
+              Orb::Webhooks::SalesOrderAccountingSyncSucceededStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionAccountingSyncFailedStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionAccountingSyncSucceededStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionCancellationScheduledStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionCancellationUnscheduledStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionCreatedStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionEditedStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionEndedStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionFixedFeeQuantityUpdatedStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionGroupedCostExceededStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionLicenseBalanceThresholdReachedStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionPlanChangeScheduledStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionPlanChangedStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionPlanVersionChangeScheduledStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionPlanVersionChangedStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionSpendExceededStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionStartedStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionTrialEndedStandardWebhookEvent,
+              Orb::Webhooks::SubscriptionUsageExceededStandardWebhookEvent,
+              Orb::Webhooks::TransactionAccountingSyncFailedStandardWebhookEvent,
+              Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent
+            )
+          )
+        end
+        def unwrap_standard(
+          # The raw webhook payload as a string
+          payload
+        )
+        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/webhooks.rbi

@@ -3,6 +3,9 @@
 module Orb
   module Resources
     class Webhooks
+      sig { returns(Orb::Resources::Webhooks::Standard) }
+      attr_reader :standard
+
       sig do
         params(payload: String).returns(
           T.any(

data/sig/orb/models/metric_list_params.rbs

@@ -7,7 +7,8 @@ module Orb
         created_at_lt: Time?,
         created_at_lte: Time?,
         cursor: String?,
-        limit: Integer
+        limit: Integer,
+        status: Orb::Models::MetricListParams::status?
       }
       & Orb::Internal::Type::request_parameters
 
@@ -29,6 +30,8 @@ module Orb
 
       def limit=: (Integer) -> Integer
 
+      attr_accessor status: Orb::Models::MetricListParams::status?
+
       def initialize: (
         ?created_at_gt: Time?,
         ?created_at_gte: Time?,
@@ -36,6 +39,7 @@ module Orb
         ?created_at_lte: Time?,
         ?cursor: String?,
         ?limit: Integer,
+        ?status: Orb::Models::MetricListParams::status?,
         ?request_options: Orb::request_opts
       ) -> void
 
@@ -46,8 +50,21 @@ module Orb
         created_at_lte: Time?,
         cursor: String?,
         limit: Integer,
+        status: Orb::Models::MetricListParams::status?,
         request_options: Orb::RequestOptions
       }
+
+      type status = :active | :archived | :draft
+
+      module Status
+        extend Orb::Internal::Type::Enum
+
+        ACTIVE: :active
+        ARCHIVED: :archived
+        DRAFT: :draft
+
+        def self?.values: -> ::Array[Orb::Models::MetricListParams::status]
+      end
     end
   end
 end

data/sig/orb/models/metric_update_params.rbs

@@ -1,7 +1,12 @@
 module Orb
   module Models
     type metric_update_params =
-      { metric_id: String, metadata: ::Hash[Symbol, String?]? }
+      {
+        metric_id: String,
+        description: String?,
+        metadata: ::Hash[Symbol, String?]?,
+        name: String?
+      }
       & Orb::Internal::Type::request_parameters
 
     class MetricUpdateParams < Orb::Internal::Type::BaseModel
@@ -10,17 +15,25 @@ module Orb
 
       attr_accessor metric_id: String
 
+      attr_accessor description: String?
+
       attr_accessor metadata: ::Hash[Symbol, String?]?
 
+      attr_accessor name: String?
+
       def initialize: (
         metric_id: String,
+        ?description: String?,
         ?metadata: ::Hash[Symbol, String?]?,
+        ?name: String?,
         ?request_options: Orb::request_opts
       ) -> void
 
       def to_hash: -> {
         metric_id: String,
+        description: String?,
         metadata: ::Hash[Symbol, String?]?,
+        name: String?,
         request_options: Orb::RequestOptions
       }
     end

data/sig/orb/models/plan_update_params.rbs

@@ -5,7 +5,8 @@ module Orb
         plan_id: String,
         description: String?,
         external_plan_id: String?,
-        metadata: ::Hash[Symbol, String?]?
+        metadata: ::Hash[Symbol, String?]?,
+        name: String?
       }
       & Orb::Internal::Type::request_parameters
 
@@ -21,11 +22,14 @@ module Orb
 
       attr_accessor metadata: ::Hash[Symbol, String?]?
 
+      attr_accessor name: String?
+
       def initialize: (
         plan_id: String,
         ?description: String?,
         ?external_plan_id: String?,
         ?metadata: ::Hash[Symbol, String?]?,
+        ?name: String?,
         ?request_options: Orb::request_opts
       ) -> void
 
@@ -34,6 +38,7 @@ module Orb
         description: String?,
         external_plan_id: String?,
         metadata: ::Hash[Symbol, String?]?,
+        name: String?,
         request_options: Orb::RequestOptions
       }
     end

data/sig/orb/models/plans/external_plan_id_update_params.rbs

@@ -6,7 +6,8 @@ module Orb
           other_external_plan_id: String,
           description: String?,
           external_plan_id: String?,
-          metadata: ::Hash[Symbol, String?]?
+          metadata: ::Hash[Symbol, String?]?,
+          name: String?
         }
         & Orb::Internal::Type::request_parameters
 
@@ -22,11 +23,14 @@ module Orb
 
         attr_accessor metadata: ::Hash[Symbol, String?]?
 
+        attr_accessor name: String?
+
         def initialize: (
           other_external_plan_id: String,
           ?description: String?,
           ?external_plan_id: String?,
           ?metadata: ::Hash[Symbol, String?]?,
+          ?name: String?,
           ?request_options: Orb::request_opts
         ) -> void
 
@@ -35,6 +39,7 @@ module Orb
           description: String?,
           external_plan_id: String?,
           metadata: ::Hash[Symbol, String?]?,
+          name: String?,
           request_options: Orb::RequestOptions
         }
       end

data/sig/orb/models/webhook_endpoint.rbs

@@ -6,6 +6,7 @@ module Orb
         created_at: Time,
         enabled: bool,
         enabled_event_types: ::Array[String]?,
+        payload_style: Orb::Models::WebhookEndpoint::payload_style,
         url: String
       }
 
@@ -18,6 +19,8 @@ module Orb
 
       attr_accessor enabled_event_types: ::Array[String]?
 
+      attr_accessor payload_style: Orb::Models::WebhookEndpoint::payload_style
+
       attr_accessor url: String
 
       def initialize: (
@@ -25,6 +28,7 @@ module Orb
         created_at: Time,
         enabled: bool,
         enabled_event_types: ::Array[String]?,
+        payload_style: Orb::Models::WebhookEndpoint::payload_style,
         url: String
       ) -> void
 
@@ -33,8 +37,20 @@ module Orb
         created_at: Time,
         enabled: bool,
         enabled_event_types: ::Array[String]?,
+        payload_style: Orb::Models::WebhookEndpoint::payload_style,
         url: String
       }
+
+      type payload_style = :expanded | :standard
+
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        EXPANDED: :expanded
+        STANDARD: :standard
+
+        def self?.values: -> ::Array[Orb::Models::WebhookEndpoint::payload_style]
+      end
     end
   end
 end

data/sig/orb/models/webhook_endpoint_create_params.rbs

@@ -1,7 +1,11 @@
 module Orb
   module Models
     type webhook_endpoint_create_params =
-      { url: String, enabled_event_types: ::Array[String]? }
+      {
+        url: String,
+        enabled_event_types: ::Array[String]?,
+        payload_style: Orb::Models::WebhookEndpointCreateParams::payload_style?
+      }
       & Orb::Internal::Type::request_parameters
 
     class WebhookEndpointCreateParams < Orb::Internal::Type::BaseModel
@@ -12,17 +16,32 @@ module Orb
 
       attr_accessor enabled_event_types: ::Array[String]?
 
+      attr_accessor payload_style: Orb::Models::WebhookEndpointCreateParams::payload_style?
+
       def initialize: (
         url: String,
         ?enabled_event_types: ::Array[String]?,
+        ?payload_style: Orb::Models::WebhookEndpointCreateParams::payload_style?,
         ?request_options: Orb::request_opts
       ) -> void
 
       def to_hash: -> {
         url: String,
         enabled_event_types: ::Array[String]?,
+        payload_style: Orb::Models::WebhookEndpointCreateParams::payload_style?,
         request_options: Orb::RequestOptions
       }
+
+      type payload_style = :expanded | :standard
+
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        EXPANDED: :expanded
+        STANDARD: :standard
+
+        def self?.values: -> ::Array[Orb::Models::WebhookEndpointCreateParams::payload_style]
+      end
     end
   end
 end

data/sig/orb/models/webhook_endpoint_update_params.rbs

@@ -4,6 +4,7 @@ module Orb
       {
         webhook_endpoint_id: String,
         enabled_event_types: ::Array[String]?,
+        payload_style: Orb::Models::WebhookEndpointUpdateParams::payload_style?,
         url: String?
       }
       & Orb::Internal::Type::request_parameters
@@ -16,11 +17,14 @@ module Orb
 
       attr_accessor enabled_event_types: ::Array[String]?
 
+      attr_accessor payload_style: Orb::Models::WebhookEndpointUpdateParams::payload_style?
+
       attr_accessor url: String?
 
       def initialize: (
         webhook_endpoint_id: String,
         ?enabled_event_types: ::Array[String]?,
+        ?payload_style: Orb::Models::WebhookEndpointUpdateParams::payload_style?,
         ?url: String?,
         ?request_options: Orb::request_opts
       ) -> void
@@ -28,9 +32,21 @@ module Orb
       def to_hash: -> {
         webhook_endpoint_id: String,
         enabled_event_types: ::Array[String]?,
+        payload_style: Orb::Models::WebhookEndpointUpdateParams::payload_style?,
         url: String?,
         request_options: Orb::RequestOptions
       }
+
+      type payload_style = :expanded | :standard
+
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        EXPANDED: :expanded
+        STANDARD: :standard
+
+        def self?.values: -> ::Array[Orb::Models::WebhookEndpointUpdateParams::payload_style]
+      end
     end
   end
 end

data/sig/orb/models/webhook_endpoint_with_secret.rbs

@@ -6,6 +6,7 @@ module Orb
         created_at: Time,
         enabled: bool,
         enabled_event_types: ::Array[String]?,
+        payload_style: Orb::Models::WebhookEndpointWithSecret::payload_style,
         secret: String,
         url: String
       }
@@ -19,6 +20,8 @@ module Orb
 
       attr_accessor enabled_event_types: ::Array[String]?
 
+      attr_accessor payload_style: Orb::Models::WebhookEndpointWithSecret::payload_style
+
       attr_accessor secret: String
 
       attr_accessor url: String
@@ -28,6 +31,7 @@ module Orb
         created_at: Time,
         enabled: bool,
         enabled_event_types: ::Array[String]?,
+        payload_style: Orb::Models::WebhookEndpointWithSecret::payload_style,
         secret: String,
         url: String
       ) -> void
@@ -37,9 +41,21 @@ module Orb
         created_at: Time,
         enabled: bool,
         enabled_event_types: ::Array[String]?,
+        payload_style: Orb::Models::WebhookEndpointWithSecret::payload_style,
         secret: String,
         url: String
       }
+
+      type payload_style = :expanded | :standard
+
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        EXPANDED: :expanded
+        STANDARD: :standard
+
+        def self?.values: -> ::Array[Orb::Models::WebhookEndpointWithSecret::payload_style]
+      end
     end
   end
 end