orb-billing 1.24.0 → 1.26.0

data/rbi/orb/models/price_create_params.rbi

@@ -23,6 +23,7 @@ module Orb
             Orb::NewFloatingTieredPackagePrice,
             Orb::NewFloatingTieredWithMinimumPrice,
             Orb::NewFloatingGroupedTieredPrice,
+            Orb::PriceCreateParams::Body::GroupedTieredMatrix,
             Orb::NewFloatingTieredPackageWithMinimumPrice,
             Orb::NewFloatingPackageWithAllocationPrice,
             Orb::NewFloatingUnitWithPercentPrice,
@@ -66,6 +67,7 @@ module Orb
               Orb::NewFloatingTieredPackagePrice::OrHash,
               Orb::NewFloatingTieredWithMinimumPrice::OrHash,
               Orb::NewFloatingGroupedTieredPrice::OrHash,
+              Orb::PriceCreateParams::Body::GroupedTieredMatrix::OrHash,
               Orb::NewFloatingTieredPackageWithMinimumPrice::OrHash,
               Orb::NewFloatingPackageWithAllocationPrice::OrHash,
               Orb::NewFloatingUnitWithPercentPrice::OrHash,
@@ -116,6 +118,7 @@ module Orb
                 Orb::NewFloatingTieredPackagePrice,
                 Orb::NewFloatingTieredWithMinimumPrice,
                 Orb::NewFloatingGroupedTieredPrice,
+                Orb::PriceCreateParams::Body::GroupedTieredMatrix,
                 Orb::NewFloatingTieredPackageWithMinimumPrice,
                 Orb::NewFloatingPackageWithAllocationPrice,
                 Orb::NewFloatingUnitWithPercentPrice,
@@ -165,6 +168,7 @@ module Orb
               Orb::NewFloatingTieredPackagePrice,
               Orb::NewFloatingTieredWithMinimumPrice,
               Orb::NewFloatingGroupedTieredPrice,
+              Orb::PriceCreateParams::Body::GroupedTieredMatrix,
               Orb::NewFloatingTieredPackageWithMinimumPrice,
               Orb::NewFloatingPackageWithAllocationPrice,
               Orb::NewFloatingUnitWithPercentPrice,
@@ -652,6 +656,433 @@ module Orb
           end
         end
 
+        class GroupedTieredMatrix < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::PriceCreateParams::Body::GroupedTieredMatrix,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          # The cadence to bill for this price on.
+          sig do
+            returns(
+              Orb::PriceCreateParams::Body::GroupedTieredMatrix::Cadence::OrSymbol
+            )
+          end
+          attr_accessor :cadence
+
+          # An ISO 4217 currency string for which this price is billed in.
+          sig { returns(String) }
+          attr_accessor :currency
+
+          # Configuration for grouped_tiered_matrix pricing
+          sig do
+            returns(
+              Orb::PriceCreateParams::Body::GroupedTieredMatrix::GroupedTieredMatrixConfig
+            )
+          end
+          attr_reader :grouped_tiered_matrix_config
+
+          sig do
+            params(
+              grouped_tiered_matrix_config:
+                Orb::PriceCreateParams::Body::GroupedTieredMatrix::GroupedTieredMatrixConfig::OrHash
+            ).void
+          end
+          attr_writer :grouped_tiered_matrix_config
+
+          # The id of the item the price will be associated with.
+          sig { returns(String) }
+          attr_accessor :item_id
+
+          # The pricing model type
+          sig { returns(Symbol) }
+          attr_accessor :model_type
+
+          # The name of the price.
+          sig { returns(String) }
+          attr_accessor :name
+
+          # The id of the billable metric for the price. Only needed if the price is
+          # usage-based.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :billable_metric_id
+
+          # If the Price represents a fixed cost, the price will be billed in-advance if
+          # this is true, and in-arrears if this is false.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_accessor :billed_in_advance
+
+          # For custom cadence: specifies the duration of the billing period in days or
+          # months.
+          sig { returns(T.nilable(Orb::NewBillingCycleConfiguration)) }
+          attr_reader :billing_cycle_configuration
+
+          sig do
+            params(
+              billing_cycle_configuration:
+                T.nilable(Orb::NewBillingCycleConfiguration::OrHash)
+            ).void
+          end
+          attr_writer :billing_cycle_configuration
+
+          # The per unit conversion rate of the price currency to the invoicing currency.
+          sig { returns(T.nilable(Float)) }
+          attr_accessor :conversion_rate
+
+          # The configuration for the rate of the price currency to the invoicing currency.
+          sig do
+            returns(
+              T.nilable(
+                T.any(
+                  Orb::UnitConversionRateConfig,
+                  Orb::TieredConversionRateConfig
+                )
+              )
+            )
+          end
+          attr_accessor :conversion_rate_config
+
+          # For dimensional price: specifies a price group and dimension values
+          sig { returns(T.nilable(Orb::NewDimensionalPriceConfiguration)) }
+          attr_reader :dimensional_price_configuration
+
+          sig do
+            params(
+              dimensional_price_configuration:
+                T.nilable(Orb::NewDimensionalPriceConfiguration::OrHash)
+            ).void
+          end
+          attr_writer :dimensional_price_configuration
+
+          # An alias for the price.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :external_price_id
+
+          # If the Price represents a fixed cost, this represents the quantity of units
+          # applied.
+          sig { returns(T.nilable(Float)) }
+          attr_accessor :fixed_price_quantity
+
+          # The property used to group this price on an invoice
+          sig { returns(T.nilable(String)) }
+          attr_accessor :invoice_grouping_key
+
+          # Within each billing cycle, specifies the cadence at which invoices are produced.
+          # If unspecified, a single invoice is produced per billing cycle.
+          sig { returns(T.nilable(Orb::NewBillingCycleConfiguration)) }
+          attr_reader :invoicing_cycle_configuration
+
+          sig do
+            params(
+              invoicing_cycle_configuration:
+                T.nilable(Orb::NewBillingCycleConfiguration::OrHash)
+            ).void
+          end
+          attr_writer :invoicing_cycle_configuration
+
+          # The ID of the license type to associate with this price.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :license_type_id
+
+          # 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
+
+          sig do
+            params(
+              cadence:
+                Orb::PriceCreateParams::Body::GroupedTieredMatrix::Cadence::OrSymbol,
+              currency: String,
+              grouped_tiered_matrix_config:
+                Orb::PriceCreateParams::Body::GroupedTieredMatrix::GroupedTieredMatrixConfig::OrHash,
+              item_id: String,
+              name: String,
+              billable_metric_id: T.nilable(String),
+              billed_in_advance: T.nilable(T::Boolean),
+              billing_cycle_configuration:
+                T.nilable(Orb::NewBillingCycleConfiguration::OrHash),
+              conversion_rate: T.nilable(Float),
+              conversion_rate_config:
+                T.nilable(
+                  T.any(
+                    Orb::UnitConversionRateConfig::OrHash,
+                    Orb::TieredConversionRateConfig::OrHash
+                  )
+                ),
+              dimensional_price_configuration:
+                T.nilable(Orb::NewDimensionalPriceConfiguration::OrHash),
+              external_price_id: T.nilable(String),
+              fixed_price_quantity: T.nilable(Float),
+              invoice_grouping_key: T.nilable(String),
+              invoicing_cycle_configuration:
+                T.nilable(Orb::NewBillingCycleConfiguration::OrHash),
+              license_type_id: T.nilable(String),
+              metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+              model_type: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The cadence to bill for this price on.
+            cadence:,
+            # An ISO 4217 currency string for which this price is billed in.
+            currency:,
+            # Configuration for grouped_tiered_matrix pricing
+            grouped_tiered_matrix_config:,
+            # The id of the item the price will be associated with.
+            item_id:,
+            # The name of the price.
+            name:,
+            # The id of the billable metric for the price. Only needed if the price is
+            # usage-based.
+            billable_metric_id: nil,
+            # If the Price represents a fixed cost, the price will be billed in-advance if
+            # this is true, and in-arrears if this is false.
+            billed_in_advance: nil,
+            # For custom cadence: specifies the duration of the billing period in days or
+            # months.
+            billing_cycle_configuration: nil,
+            # The per unit conversion rate of the price currency to the invoicing currency.
+            conversion_rate: nil,
+            # The configuration for the rate of the price currency to the invoicing currency.
+            conversion_rate_config: nil,
+            # For dimensional price: specifies a price group and dimension values
+            dimensional_price_configuration: nil,
+            # An alias for the price.
+            external_price_id: nil,
+            # If the Price represents a fixed cost, this represents the quantity of units
+            # applied.
+            fixed_price_quantity: nil,
+            # The property used to group this price on an invoice
+            invoice_grouping_key: nil,
+            # Within each billing cycle, specifies the cadence at which invoices are produced.
+            # If unspecified, a single invoice is produced per billing cycle.
+            invoicing_cycle_configuration: nil,
+            # The ID of the license type to associate with this price.
+            license_type_id: 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 pricing model type
+            model_type: :grouped_tiered_matrix
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                cadence:
+                  Orb::PriceCreateParams::Body::GroupedTieredMatrix::Cadence::OrSymbol,
+                currency: String,
+                grouped_tiered_matrix_config:
+                  Orb::PriceCreateParams::Body::GroupedTieredMatrix::GroupedTieredMatrixConfig,
+                item_id: String,
+                model_type: Symbol,
+                name: String,
+                billable_metric_id: T.nilable(String),
+                billed_in_advance: T.nilable(T::Boolean),
+                billing_cycle_configuration:
+                  T.nilable(Orb::NewBillingCycleConfiguration),
+                conversion_rate: T.nilable(Float),
+                conversion_rate_config:
+                  T.nilable(
+                    T.any(
+                      Orb::UnitConversionRateConfig,
+                      Orb::TieredConversionRateConfig
+                    )
+                  ),
+                dimensional_price_configuration:
+                  T.nilable(Orb::NewDimensionalPriceConfiguration),
+                external_price_id: T.nilable(String),
+                fixed_price_quantity: T.nilable(Float),
+                invoice_grouping_key: T.nilable(String),
+                invoicing_cycle_configuration:
+                  T.nilable(Orb::NewBillingCycleConfiguration),
+                license_type_id: T.nilable(String),
+                metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The cadence to bill for this price on.
+          module Cadence
+            extend Orb::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Orb::PriceCreateParams::Body::GroupedTieredMatrix::Cadence
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ANNUAL =
+              T.let(
+                :annual,
+                Orb::PriceCreateParams::Body::GroupedTieredMatrix::Cadence::TaggedSymbol
+              )
+            SEMI_ANNUAL =
+              T.let(
+                :semi_annual,
+                Orb::PriceCreateParams::Body::GroupedTieredMatrix::Cadence::TaggedSymbol
+              )
+            MONTHLY =
+              T.let(
+                :monthly,
+                Orb::PriceCreateParams::Body::GroupedTieredMatrix::Cadence::TaggedSymbol
+              )
+            QUARTERLY =
+              T.let(
+                :quarterly,
+                Orb::PriceCreateParams::Body::GroupedTieredMatrix::Cadence::TaggedSymbol
+              )
+            ONE_TIME =
+              T.let(
+                :one_time,
+                Orb::PriceCreateParams::Body::GroupedTieredMatrix::Cadence::TaggedSymbol
+              )
+            CUSTOM =
+              T.let(
+                :custom,
+                Orb::PriceCreateParams::Body::GroupedTieredMatrix::Cadence::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Orb::PriceCreateParams::Body::GroupedTieredMatrix::Cadence::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          class GroupedTieredMatrixConfig < Orb::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Orb::PriceCreateParams::Body::GroupedTieredMatrix::GroupedTieredMatrixConfig,
+                  Orb::Internal::AnyHash
+                )
+              end
+
+            # Per unit rate for usage whose dimension value has no configured tiers
+            sig { returns(String) }
+            attr_accessor :default_unit_amount
+
+            # The billable metric property used to group usage before tiering
+            sig { returns(String) }
+            attr_accessor :dimension
+
+            # Graduated tiers keyed by dimension value; usage for a value is tiered only
+            # against its own rows
+            sig do
+              returns(
+                T::Array[
+                  Orb::PriceCreateParams::Body::GroupedTieredMatrix::GroupedTieredMatrixConfig::Tier
+                ]
+              )
+            end
+            attr_accessor :tiers
+
+            # Configuration for grouped_tiered_matrix pricing
+            sig do
+              params(
+                default_unit_amount: String,
+                dimension: String,
+                tiers:
+                  T::Array[
+                    Orb::PriceCreateParams::Body::GroupedTieredMatrix::GroupedTieredMatrixConfig::Tier::OrHash
+                  ]
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Per unit rate for usage whose dimension value has no configured tiers
+              default_unit_amount:,
+              # The billable metric property used to group usage before tiering
+              dimension:,
+              # Graduated tiers keyed by dimension value; usage for a value is tiered only
+              # against its own rows
+              tiers:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  default_unit_amount: String,
+                  dimension: String,
+                  tiers:
+                    T::Array[
+                      Orb::PriceCreateParams::Body::GroupedTieredMatrix::GroupedTieredMatrixConfig::Tier
+                    ]
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class Tier < Orb::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Orb::PriceCreateParams::Body::GroupedTieredMatrix::GroupedTieredMatrixConfig::Tier,
+                    Orb::Internal::AnyHash
+                  )
+                end
+
+              # The dimension value this tier applies to
+              sig { returns(String) }
+              attr_accessor :dimension_value
+
+              sig { returns(String) }
+              attr_accessor :tier_lower_bound
+
+              # Per unit amount
+              sig { returns(String) }
+              attr_accessor :unit_amount
+
+              # Configuration for a single tier scoped to a dimension value
+              sig do
+                params(
+                  dimension_value: String,
+                  tier_lower_bound: String,
+                  unit_amount: String
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # The dimension value this tier applies to
+                dimension_value:,
+                tier_lower_bound:,
+                # Per unit amount
+                unit_amount:
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    dimension_value: String,
+                    tier_lower_bound: String,
+                    unit_amount: String
+                  }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+        end
+
         class MatrixWithThresholdDiscounts < Orb::Internal::Type::BaseModel
           OrHash =
             T.type_alias do