orb-billing 1.13.0 → 1.15.0

data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi

@@ -16,6 +16,9 @@ module Orb
               )
             end
 
+          sig { returns(String) }
+          attr_accessor :external_customer_id
+
           sig { returns(T.nilable(Time)) }
           attr_accessor :created_at_gt
 
@@ -67,6 +70,7 @@ module Orb
 
           sig do
             params(
+              external_customer_id: String,
               created_at_gt: T.nilable(Time),
               created_at_gte: T.nilable(Time),
               created_at_lt: T.nilable(Time),
@@ -87,6 +91,7 @@ module Orb
             ).returns(T.attached_class)
           end
           def self.new(
+            external_customer_id:,
             created_at_gt: nil,
             created_at_gte: nil,
             created_at_lt: nil,
@@ -108,6 +113,7 @@ module Orb
           sig do
             override.returns(
               {
+                external_customer_id: String,
                 created_at_gt: T.nilable(Time),
                 created_at_gte: T.nilable(Time),
                 created_at_lt: T.nilable(Time),

data/rbi/orb/models/customers/credits/ledger_list_params.rbi

@@ -16,6 +16,9 @@ module Orb
               )
             end
 
+          sig { returns(String) }
+          attr_accessor :customer_id
+
           sig { returns(T.nilable(Time)) }
           attr_accessor :created_at_gt
 
@@ -67,6 +70,7 @@ module Orb
 
           sig do
             params(
+              customer_id: String,
               created_at_gt: T.nilable(Time),
               created_at_gte: T.nilable(Time),
               created_at_lt: T.nilable(Time),
@@ -87,6 +91,7 @@ module Orb
             ).returns(T.attached_class)
           end
           def self.new(
+            customer_id:,
             created_at_gt: nil,
             created_at_gte: nil,
             created_at_lt: nil,
@@ -108,6 +113,7 @@ module Orb
           sig do
             override.returns(
               {
+                customer_id: String,
                 created_at_gt: T.nilable(Time),
                 created_at_gte: T.nilable(Time),
                 created_at_lt: T.nilable(Time),

data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi

@@ -16,6 +16,9 @@ module Orb
               )
             end
 
+          sig { returns(String) }
+          attr_accessor :external_customer_id
+
           # The amount to increment when the threshold is reached.
           sig { returns(String) }
           attr_accessor :amount
@@ -72,6 +75,7 @@ module Orb
 
           sig do
             params(
+              external_customer_id: String,
               amount: String,
               currency: String,
               invoice_settings:
@@ -88,6 +92,7 @@ module Orb
             ).returns(T.attached_class)
           end
           def self.new(
+            external_customer_id:,
             # The amount to increment when the threshold is reached.
             amount:,
             # The currency or custom pricing unit to use for this top-up. If this is a
@@ -115,6 +120,7 @@ module Orb
           sig do
             override.returns(
               {
+                external_customer_id: String,
                 amount: String,
                 currency: String,
                 invoice_settings:

data/rbi/orb/models/customers/credits/top_up_create_params.rbi

@@ -16,6 +16,9 @@ module Orb
               )
             end
 
+          sig { returns(String) }
+          attr_accessor :customer_id
+
           # The amount to increment when the threshold is reached.
           sig { returns(String) }
           attr_accessor :amount
@@ -70,6 +73,7 @@ module Orb
 
           sig do
             params(
+              customer_id: String,
               amount: String,
               currency: String,
               invoice_settings:
@@ -86,6 +90,7 @@ module Orb
             ).returns(T.attached_class)
           end
           def self.new(
+            customer_id:,
             # The amount to increment when the threshold is reached.
             amount:,
             # The currency or custom pricing unit to use for this top-up. If this is a
@@ -113,6 +118,7 @@ module Orb
           sig do
             override.returns(
               {
+                customer_id: String,
                 amount: String,
                 currency: String,
                 invoice_settings:

data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi

@@ -19,19 +19,24 @@ module Orb
           sig { returns(String) }
           attr_accessor :external_customer_id
 
+          sig { returns(String) }
+          attr_accessor :top_up_id
+
           sig do
             params(
               external_customer_id: String,
+              top_up_id: String,
               request_options: Orb::RequestOptions::OrHash
             ).returns(T.attached_class)
           end
-          def self.new(external_customer_id:, request_options: {})
+          def self.new(external_customer_id:, top_up_id:, request_options: {})
           end
 
           sig do
             override.returns(
               {
                 external_customer_id: String,
+                top_up_id: String,
                 request_options: Orb::RequestOptions
               }
             )

data/rbi/orb/models/customers/credits/top_up_delete_params.rbi

@@ -19,18 +19,26 @@ module Orb
           sig { returns(String) }
           attr_accessor :customer_id
 
+          sig { returns(String) }
+          attr_accessor :top_up_id
+
           sig do
             params(
               customer_id: String,
+              top_up_id: String,
               request_options: Orb::RequestOptions::OrHash
             ).returns(T.attached_class)
           end
-          def self.new(customer_id:, request_options: {})
+          def self.new(customer_id:, top_up_id:, request_options: {})
           end
 
           sig do
             override.returns(
-              { customer_id: String, request_options: Orb::RequestOptions }
+              {
+                customer_id: String,
+                top_up_id: String,
+                request_options: Orb::RequestOptions
+              }
             )
           end
           def to_hash

data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi

@@ -16,6 +16,9 @@ module Orb
               )
             end
 
+          sig { returns(String) }
+          attr_accessor :external_customer_id
+
           # Cursor for pagination. This can be populated by the `next_cursor` value returned
           # from the initial request.
           sig { returns(T.nilable(String)) }
@@ -30,12 +33,14 @@ module Orb
 
           sig do
             params(
+              external_customer_id: String,
               cursor: T.nilable(String),
               limit: Integer,
               request_options: Orb::RequestOptions::OrHash
             ).returns(T.attached_class)
           end
           def self.new(
+            external_customer_id:,
             # Cursor for pagination. This can be populated by the `next_cursor` value returned
             # from the initial request.
             cursor: nil,
@@ -48,6 +53,7 @@ module Orb
           sig do
             override.returns(
               {
+                external_customer_id: String,
                 cursor: T.nilable(String),
                 limit: Integer,
                 request_options: Orb::RequestOptions

data/rbi/orb/models/customers/credits/top_up_list_params.rbi

@@ -16,6 +16,9 @@ module Orb
               )
             end
 
+          sig { returns(String) }
+          attr_accessor :customer_id
+
           # Cursor for pagination. This can be populated by the `next_cursor` value returned
           # from the initial request.
           sig { returns(T.nilable(String)) }
@@ -30,12 +33,14 @@ module Orb
 
           sig do
             params(
+              customer_id: String,
               cursor: T.nilable(String),
               limit: Integer,
               request_options: Orb::RequestOptions::OrHash
             ).returns(T.attached_class)
           end
           def self.new(
+            customer_id:,
             # Cursor for pagination. This can be populated by the `next_cursor` value returned
             # from the initial request.
             cursor: nil,
@@ -48,6 +53,7 @@ module Orb
           sig do
             override.returns(
               {
+                customer_id: String,
                 cursor: T.nilable(String),
                 limit: Integer,
                 request_options: Orb::RequestOptions

data/rbi/orb/models/dimensional_price_group.rbi

@@ -37,7 +37,7 @@ module Orb
       attr_accessor :name
 
       # 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 parition used
+      # by a set of dimensions. Prices in a price group must specify the partition used
       # to derive their usage.
       sig do
         params(

data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi

@@ -14,15 +14,26 @@ module Orb
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :dimensional_price_group_id
+
       sig do
-        params(request_options: Orb::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          dimensional_price_group_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(dimensional_price_group_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Orb::RequestOptions }) }
+      sig do
+        override.returns(
+          {
+            dimensional_price_group_id: String,
+            request_options: Orb::RequestOptions
+          }
+        )
+      end
       def to_hash
       end
     end

data/rbi/orb/models/dimensional_price_group_update_params.rbi

@@ -11,6 +11,9 @@ module Orb
           T.any(Orb::DimensionalPriceGroupUpdateParams, Orb::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :dimensional_price_group_id
+
       # An optional user-defined ID for this dimensional price group resource, used
       # throughout the system as an alias for this dimensional price group. Use this
       # field to identify a dimensional price group by an existing identifier in your
@@ -26,12 +29,14 @@ module Orb
 
       sig do
         params(
+          dimensional_price_group_id: String,
           external_dimensional_price_group_id: T.nilable(String),
           metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
           request_options: Orb::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        dimensional_price_group_id:,
         # An optional user-defined ID for this dimensional price group resource, used
         # throughout the system as an alias for this dimensional price group. Use this
         # field to identify a dimensional price group by an existing identifier in your
@@ -48,6 +53,7 @@ module Orb
       sig do
         override.returns(
           {
+            dimensional_price_group_id: String,
             external_dimensional_price_group_id: T.nilable(String),
             metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
             request_options: Orb::RequestOptions

data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi

@@ -15,15 +15,26 @@ module Orb
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :external_dimensional_price_group_id
+
         sig do
-          params(request_options: Orb::RequestOptions::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            external_dimensional_price_group_id: String,
+            request_options: Orb::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
-        def self.new(request_options: {})
+        def self.new(external_dimensional_price_group_id:, request_options: {})
         end
 
-        sig { override.returns({ request_options: Orb::RequestOptions }) }
+        sig do
+          override.returns(
+            {
+              external_dimensional_price_group_id: String,
+              request_options: Orb::RequestOptions
+            }
+          )
+        end
         def to_hash
         end
       end

data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rbi

@@ -15,6 +15,9 @@ module Orb
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :path_external_dimensional_price_group_id
+
         # An optional user-defined ID for this dimensional price group resource, used
         # throughout the system as an alias for this dimensional price group. Use this
         # field to identify a dimensional price group by an existing identifier in your
@@ -30,12 +33,14 @@ module Orb
 
         sig do
           params(
+            path_external_dimensional_price_group_id: String,
             body_external_dimensional_price_group_id: T.nilable(String),
             metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
             request_options: Orb::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
+          path_external_dimensional_price_group_id:,
           # An optional user-defined ID for this dimensional price group resource, used
           # throughout the system as an alias for this dimensional price group. Use this
           # field to identify a dimensional price group by an existing identifier in your
@@ -52,6 +57,7 @@ module Orb
         sig do
           override.returns(
             {
+              path_external_dimensional_price_group_id: String,
               body_external_dimensional_price_group_id: T.nilable(String),
               metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
               request_options: Orb::RequestOptions

data/rbi/orb/models/discount.rbi

@@ -11,10 +11,278 @@ module Orb
             Orb::PercentageDiscount,
             Orb::TrialDiscount,
             Orb::UsageDiscount,
-            Orb::AmountDiscount
+            Orb::AmountDiscount,
+            Orb::Discount::TieredPercentage
           )
         end
 
+      class TieredPercentage < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Orb::Discount::TieredPercentage, Orb::Internal::AnyHash)
+          end
+
+        sig { returns(Symbol) }
+        attr_accessor :discount_type
+
+        # Only available if discount_type is `tiered_percentage`. The ordered, contiguous
+        # bands of cumulative eligible spend, each discounted at its own percentage
+        # (progressive fill-a-tier).
+        sig { returns(T::Array[Orb::Discount::TieredPercentage::Tier]) }
+        attr_accessor :tiers
+
+        # List of price_ids that this discount applies to. For plan/plan phase discounts,
+        # this can be a subset of prices.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :applies_to_price_ids
+
+        # The filters that determine which prices to apply this discount to.
+        sig do
+          returns(T.nilable(T::Array[Orb::Discount::TieredPercentage::Filter]))
+        end
+        attr_accessor :filters
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :reason
+
+        sig do
+          params(
+            tiers: T::Array[Orb::Discount::TieredPercentage::Tier::OrHash],
+            applies_to_price_ids: T.nilable(T::Array[String]),
+            filters:
+              T.nilable(
+                T::Array[Orb::Discount::TieredPercentage::Filter::OrHash]
+              ),
+            reason: T.nilable(String),
+            discount_type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Only available if discount_type is `tiered_percentage`. The ordered, contiguous
+          # bands of cumulative eligible spend, each discounted at its own percentage
+          # (progressive fill-a-tier).
+          tiers:,
+          # List of price_ids that this discount applies to. For plan/plan phase discounts,
+          # this can be a subset of prices.
+          applies_to_price_ids: nil,
+          # The filters that determine which prices to apply this discount to.
+          filters: nil,
+          reason: nil,
+          discount_type: :tiered_percentage
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              discount_type: Symbol,
+              tiers: T::Array[Orb::Discount::TieredPercentage::Tier],
+              applies_to_price_ids: T.nilable(T::Array[String]),
+              filters:
+                T.nilable(T::Array[Orb::Discount::TieredPercentage::Filter]),
+              reason: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Tier < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::Discount::TieredPercentage::Tier,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          # Exclusive lower bound of cumulative spend for this tier.
+          sig { returns(Float) }
+          attr_accessor :lower_bound
+
+          # The percentage (between 0 and 1) discounted from spend that falls within this
+          # tier.
+          sig { returns(Float) }
+          attr_accessor :percentage
+
+          # Inclusive upper bound of cumulative spend for this tier; null for the final
+          # open-ended tier.
+          sig { returns(T.nilable(Float)) }
+          attr_accessor :upper_bound
+
+          # One band of a tiered percentage discount. Bounds are denominated in the
+          # discount's currency. `lower_bound` is the exclusive start of the band and
+          # `upper_bound` is the inclusive end; `upper_bound` is null only for the
+          # open-ended final tier.
+          sig do
+            params(
+              lower_bound: Float,
+              percentage: Float,
+              upper_bound: T.nilable(Float)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Exclusive lower bound of cumulative spend for this tier.
+            lower_bound:,
+            # The percentage (between 0 and 1) discounted from spend that falls within this
+            # tier.
+            percentage:,
+            # Inclusive upper bound of cumulative spend for this tier; null for the final
+            # open-ended tier.
+            upper_bound: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                lower_bound: Float,
+                percentage: Float,
+                upper_bound: T.nilable(Float)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class Filter < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::Discount::TieredPercentage::Filter,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          # The property of the price to filter on.
+          sig do
+            returns(Orb::Discount::TieredPercentage::Filter::Field::OrSymbol)
+          end
+          attr_accessor :field
+
+          # Should prices that match the filter be included or excluded.
+          sig do
+            returns(Orb::Discount::TieredPercentage::Filter::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::Discount::TieredPercentage::Filter::Field::OrSymbol,
+              operator:
+                Orb::Discount::TieredPercentage::Filter::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::Discount::TieredPercentage::Filter::Field::OrSymbol,
+                operator:
+                  Orb::Discount::TieredPercentage::Filter::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::Discount::TieredPercentage::Filter::Field)
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PRICE_ID =
+              T.let(
+                :price_id,
+                Orb::Discount::TieredPercentage::Filter::Field::TaggedSymbol
+              )
+            ITEM_ID =
+              T.let(
+                :item_id,
+                Orb::Discount::TieredPercentage::Filter::Field::TaggedSymbol
+              )
+            PRICE_TYPE =
+              T.let(
+                :price_type,
+                Orb::Discount::TieredPercentage::Filter::Field::TaggedSymbol
+              )
+            CURRENCY =
+              T.let(
+                :currency,
+                Orb::Discount::TieredPercentage::Filter::Field::TaggedSymbol
+              )
+            PRICING_UNIT_ID =
+              T.let(
+                :pricing_unit_id,
+                Orb::Discount::TieredPercentage::Filter::Field::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Orb::Discount::TieredPercentage::Filter::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::Discount::TieredPercentage::Filter::Operator)
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            INCLUDES =
+              T.let(
+                :includes,
+                Orb::Discount::TieredPercentage::Filter::Operator::TaggedSymbol
+              )
+            EXCLUDES =
+              T.let(
+                :excludes,
+                Orb::Discount::TieredPercentage::Filter::Operator::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Orb::Discount::TieredPercentage::Filter::Operator::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+
       sig { override.returns(T::Array[Orb::Discount::Variants]) }
       def self.variants
       end