orb-billing 1.46.0 → 1.48.0

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/sig/orb/models/credit_block_update_params.rbs

@@ -0,0 +1,28 @@
+module Orb
+  module Models
+    type credit_block_update_params =
+      { block_id: String, metadata: ::Hash[Symbol, String?]? }
+      & Orb::Internal::Type::request_parameters
+
+    class CreditBlockUpdateParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      attr_accessor block_id: String
+
+      attr_accessor metadata: ::Hash[Symbol, String?]?
+
+      def initialize: (
+        block_id: String,
+        ?metadata: ::Hash[Symbol, String?]?,
+        ?request_options: Orb::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        block_id: String,
+        metadata: ::Hash[Symbol, String?]?,
+        request_options: Orb::RequestOptions
+      }
+    end
+  end
+end

data/sig/orb/models/credit_block_update_response.rbs

@@ -0,0 +1,263 @@
+module Orb
+  module Models
+    type credit_block_update_response =
+      {
+        id: String,
+        balance: Float,
+        credit_block_source: Orb::Models::CreditBlockUpdateResponse::credit_block_source,
+        effective_date: Time?,
+        expiry_date: Time?,
+        filters: ::Array[Orb::Models::CreditBlockUpdateResponse::Filter],
+        maximum_initial_balance: Float?,
+        metadata: ::Hash[Symbol, String],
+        per_unit_cost_basis: String?,
+        status: Orb::Models::CreditBlockUpdateResponse::status,
+        credit_allocation: Orb::Models::CreditBlockUpdateResponse::CreditAllocation?,
+        credit_commitment: Orb::Models::CreditBlockUpdateResponse::CreditCommitment?
+      }
+
+    class CreditBlockUpdateResponse < Orb::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor balance: Float
+
+      attr_accessor credit_block_source: Orb::Models::CreditBlockUpdateResponse::credit_block_source
+
+      attr_accessor effective_date: Time?
+
+      attr_accessor expiry_date: Time?
+
+      attr_accessor filters: ::Array[Orb::Models::CreditBlockUpdateResponse::Filter]
+
+      attr_accessor maximum_initial_balance: Float?
+
+      attr_accessor metadata: ::Hash[Symbol, String]
+
+      attr_accessor per_unit_cost_basis: String?
+
+      attr_accessor status: Orb::Models::CreditBlockUpdateResponse::status
+
+      attr_accessor credit_allocation: Orb::Models::CreditBlockUpdateResponse::CreditAllocation?
+
+      attr_accessor credit_commitment: Orb::Models::CreditBlockUpdateResponse::CreditCommitment?
+
+      def initialize: (
+        id: String,
+        balance: Float,
+        credit_block_source: Orb::Models::CreditBlockUpdateResponse::credit_block_source,
+        effective_date: Time?,
+        expiry_date: Time?,
+        filters: ::Array[Orb::Models::CreditBlockUpdateResponse::Filter],
+        maximum_initial_balance: Float?,
+        metadata: ::Hash[Symbol, String],
+        per_unit_cost_basis: String?,
+        status: Orb::Models::CreditBlockUpdateResponse::status,
+        ?credit_allocation: Orb::Models::CreditBlockUpdateResponse::CreditAllocation?,
+        ?credit_commitment: Orb::Models::CreditBlockUpdateResponse::CreditCommitment?
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        balance: Float,
+        credit_block_source: Orb::Models::CreditBlockUpdateResponse::credit_block_source,
+        effective_date: Time?,
+        expiry_date: Time?,
+        filters: ::Array[Orb::Models::CreditBlockUpdateResponse::Filter],
+        maximum_initial_balance: Float?,
+        metadata: ::Hash[Symbol, String],
+        per_unit_cost_basis: String?,
+        status: Orb::Models::CreditBlockUpdateResponse::status,
+        credit_allocation: Orb::Models::CreditBlockUpdateResponse::CreditAllocation?,
+        credit_commitment: Orb::Models::CreditBlockUpdateResponse::CreditCommitment?
+      }
+
+      type credit_block_source = :allocation | :top_up | :commitment | :manual
+
+      module CreditBlockSource
+        extend Orb::Internal::Type::Enum
+
+        ALLOCATION: :allocation
+        TOP_UP: :top_up
+        COMMITMENT: :commitment
+        MANUAL: :manual
+
+        def self?.values: -> ::Array[Orb::Models::CreditBlockUpdateResponse::credit_block_source]
+      end
+
+      type filter =
+        {
+          field: Orb::Models::CreditBlockUpdateResponse::Filter::field,
+          operator: Orb::Models::CreditBlockUpdateResponse::Filter::operator,
+          values: ::Array[String]
+        }
+
+      class Filter < Orb::Internal::Type::BaseModel
+        attr_accessor field: Orb::Models::CreditBlockUpdateResponse::Filter::field
+
+        attr_accessor operator: Orb::Models::CreditBlockUpdateResponse::Filter::operator
+
+        attr_accessor values: ::Array[String]
+
+        def initialize: (
+          field: Orb::Models::CreditBlockUpdateResponse::Filter::field,
+          operator: Orb::Models::CreditBlockUpdateResponse::Filter::operator,
+          values: ::Array[String]
+        ) -> void
+
+        def to_hash: -> {
+          field: Orb::Models::CreditBlockUpdateResponse::Filter::field,
+          operator: Orb::Models::CreditBlockUpdateResponse::Filter::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::CreditBlockUpdateResponse::Filter::field]
+        end
+
+        type operator = :includes | :excludes
+
+        module Operator
+          extend Orb::Internal::Type::Enum
+
+          INCLUDES: :includes
+          EXCLUDES: :excludes
+
+          def self?.values: -> ::Array[Orb::Models::CreditBlockUpdateResponse::Filter::operator]
+        end
+      end
+
+      type status = :active | :pending_payment
+
+      module Status
+        extend Orb::Internal::Type::Enum
+
+        ACTIVE: :active
+        PENDING_PAYMENT: :pending_payment
+
+        def self?.values: -> ::Array[Orb::Models::CreditBlockUpdateResponse::status]
+      end
+
+      type credit_allocation =
+        {
+          allows_rollover: bool,
+          currency: String,
+          custom_expiration: Orb::CustomExpiration?,
+          item_id: String,
+          filters: ::Array[Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter],
+          license_type_id: String?
+        }
+
+      class CreditAllocation < Orb::Internal::Type::BaseModel
+        attr_accessor allows_rollover: bool
+
+        attr_accessor currency: String
+
+        attr_accessor custom_expiration: Orb::CustomExpiration?
+
+        attr_accessor item_id: String
+
+        attr_reader filters: ::Array[Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter]?
+
+        def filters=: (
+          ::Array[Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter]
+        ) -> ::Array[Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter]
+
+        attr_accessor license_type_id: String?
+
+        def initialize: (
+          allows_rollover: bool,
+          currency: String,
+          custom_expiration: Orb::CustomExpiration?,
+          item_id: String,
+          ?filters: ::Array[Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter],
+          ?license_type_id: String?
+        ) -> void
+
+        def to_hash: -> {
+          allows_rollover: bool,
+          currency: String,
+          custom_expiration: Orb::CustomExpiration?,
+          item_id: String,
+          filters: ::Array[Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter],
+          license_type_id: String?
+        }
+
+        type filter =
+          {
+            field: Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::field,
+            operator: Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::operator,
+            values: ::Array[String]
+          }
+
+        class Filter < Orb::Internal::Type::BaseModel
+          attr_accessor field: Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::field
+
+          attr_accessor operator: Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::operator
+
+          attr_accessor values: ::Array[String]
+
+          def initialize: (
+            field: Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::field,
+            operator: Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::operator,
+            values: ::Array[String]
+          ) -> void
+
+          def to_hash: -> {
+            field: Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::field,
+            operator: Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::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::CreditBlockUpdateResponse::CreditAllocation::Filter::field]
+          end
+
+          type operator = :includes | :excludes
+
+          module Operator
+            extend Orb::Internal::Type::Enum
+
+            INCLUDES: :includes
+            EXCLUDES: :excludes
+
+            def self?.values: -> ::Array[Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::operator]
+          end
+        end
+      end
+
+      type credit_commitment = { id: String, subscription_id: String? }
+
+      class CreditCommitment < Orb::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor subscription_id: String?
+
+        def initialize: (id: String, ?subscription_id: String?) -> void
+
+        def to_hash: -> { id: String, subscription_id: String? }
+      end
+    end
+  end
+end

data/sig/orb/models/metric_archive_params.rbs

@@ -0,0 +1,23 @@
+module Orb
+  module Models
+    type metric_archive_params =
+      { metric_id: String } & Orb::Internal::Type::request_parameters
+
+    class MetricArchiveParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      attr_accessor metric_id: String
+
+      def initialize: (
+        metric_id: String,
+        ?request_options: Orb::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        metric_id: String,
+        request_options: Orb::RequestOptions
+      }
+    end
+  end
+end

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_unarchive_params.rbs

@@ -0,0 +1,23 @@
+module Orb
+  module Models
+    type metric_unarchive_params =
+      { metric_id: String } & Orb::Internal::Type::request_parameters
+
+    class MetricUnarchiveParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      attr_accessor metric_id: String
+
+      def initialize: (
+        metric_id: String,
+        ?request_options: Orb::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        metric_id: String,
+        request_options: Orb::RequestOptions
+      }
+    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