orb-billing 1.30.0 → 1.32.0

data/sig/orb/models/plan_create_params.rbs

@@ -284,6 +284,7 @@ module Orb
           | Orb::NewPlanPackageWithAllocationPrice
           | Orb::NewPlanUnitWithPercentPrice
           | Orb::NewPlanMatrixWithAllocationPrice
+          | Orb::PlanCreateParams::Price::Price::TieredMatrixWithAllocation
           | Orb::PlanCreateParams::Price::Price::MatrixWithThresholdDiscounts
           | Orb::PlanCreateParams::Price::Price::TieredWithProration
           | Orb::NewPlanUnitWithProrationPrice
@@ -673,6 +674,193 @@ module Orb
             end
           end
 
+          type tiered_matrix_with_allocation =
+            {
+              cadence: Orb::Models::PlanCreateParams::Price::Price::TieredMatrixWithAllocation::cadence,
+              item_id: String,
+              model_type: :tiered_matrix_with_allocation,
+              name: String,
+              tiered_matrix_with_allocation_config: Orb::PlanCreateParams::Price::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig,
+              billable_metric_id: String?,
+              billed_in_advance: bool?,
+              billing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
+              conversion_rate: Float?,
+              conversion_rate_config: Orb::Models::conversion_rate_config?,
+              currency: String?,
+              dimensional_price_configuration: Orb::NewDimensionalPriceConfiguration?,
+              external_price_id: String?,
+              fixed_price_quantity: Float?,
+              invoice_grouping_key: String?,
+              invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
+              license_type_id: String?,
+              metadata: ::Hash[Symbol, String?]?,
+              reference_id: String?
+            }
+
+          class TieredMatrixWithAllocation < Orb::Internal::Type::BaseModel
+            attr_accessor cadence: Orb::Models::PlanCreateParams::Price::Price::TieredMatrixWithAllocation::cadence
+
+            attr_accessor item_id: String
+
+            attr_accessor model_type: :tiered_matrix_with_allocation
+
+            attr_accessor name: String
+
+            attr_accessor tiered_matrix_with_allocation_config: Orb::PlanCreateParams::Price::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig
+
+            attr_accessor billable_metric_id: String?
+
+            attr_accessor billed_in_advance: bool?
+
+            attr_accessor billing_cycle_configuration: Orb::NewBillingCycleConfiguration?
+
+            attr_accessor conversion_rate: Float?
+
+            attr_accessor conversion_rate_config: Orb::Models::conversion_rate_config?
+
+            attr_accessor currency: String?
+
+            attr_accessor dimensional_price_configuration: Orb::NewDimensionalPriceConfiguration?
+
+            attr_accessor external_price_id: String?
+
+            attr_accessor fixed_price_quantity: Float?
+
+            attr_accessor invoice_grouping_key: String?
+
+            attr_accessor invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?
+
+            attr_accessor license_type_id: String?
+
+            attr_accessor metadata: ::Hash[Symbol, String?]?
+
+            attr_accessor reference_id: String?
+
+            def initialize: (
+              cadence: Orb::Models::PlanCreateParams::Price::Price::TieredMatrixWithAllocation::cadence,
+              item_id: String,
+              name: String,
+              tiered_matrix_with_allocation_config: Orb::PlanCreateParams::Price::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig,
+              ?billable_metric_id: String?,
+              ?billed_in_advance: bool?,
+              ?billing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
+              ?conversion_rate: Float?,
+              ?conversion_rate_config: Orb::Models::conversion_rate_config?,
+              ?currency: String?,
+              ?dimensional_price_configuration: Orb::NewDimensionalPriceConfiguration?,
+              ?external_price_id: String?,
+              ?fixed_price_quantity: Float?,
+              ?invoice_grouping_key: String?,
+              ?invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
+              ?license_type_id: String?,
+              ?metadata: ::Hash[Symbol, String?]?,
+              ?reference_id: String?,
+              ?model_type: :tiered_matrix_with_allocation
+            ) -> void
+
+            def to_hash: -> {
+              cadence: Orb::Models::PlanCreateParams::Price::Price::TieredMatrixWithAllocation::cadence,
+              item_id: String,
+              model_type: :tiered_matrix_with_allocation,
+              name: String,
+              tiered_matrix_with_allocation_config: Orb::PlanCreateParams::Price::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig,
+              billable_metric_id: String?,
+              billed_in_advance: bool?,
+              billing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
+              conversion_rate: Float?,
+              conversion_rate_config: Orb::Models::conversion_rate_config?,
+              currency: String?,
+              dimensional_price_configuration: Orb::NewDimensionalPriceConfiguration?,
+              external_price_id: String?,
+              fixed_price_quantity: Float?,
+              invoice_grouping_key: String?,
+              invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
+              license_type_id: String?,
+              metadata: ::Hash[Symbol, String?]?,
+              reference_id: String?
+            }
+
+            type cadence =
+              :annual
+              | :semi_annual
+              | :monthly
+              | :quarterly
+              | :one_time
+              | :custom
+
+            module Cadence
+              extend Orb::Internal::Type::Enum
+
+              ANNUAL: :annual
+              SEMI_ANNUAL: :semi_annual
+              MONTHLY: :monthly
+              QUARTERLY: :quarterly
+              ONE_TIME: :one_time
+              CUSTOM: :custom
+
+              def self?.values: -> ::Array[Orb::Models::PlanCreateParams::Price::Price::TieredMatrixWithAllocation::cadence]
+            end
+
+            type tiered_matrix_with_allocation_config =
+              {
+                allocation: String,
+                default_unit_amount: String,
+                dimensions: ::Array[String],
+                tiers: ::Array[Orb::PlanCreateParams::Price::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig::Tier]
+              }
+
+            class TieredMatrixWithAllocationConfig < Orb::Internal::Type::BaseModel
+              attr_accessor allocation: String
+
+              attr_accessor default_unit_amount: String
+
+              attr_accessor dimensions: ::Array[String]
+
+              attr_accessor tiers: ::Array[Orb::PlanCreateParams::Price::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig::Tier]
+
+              def initialize: (
+                allocation: String,
+                default_unit_amount: String,
+                dimensions: ::Array[String],
+                tiers: ::Array[Orb::PlanCreateParams::Price::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig::Tier]
+              ) -> void
+
+              def to_hash: -> {
+                allocation: String,
+                default_unit_amount: String,
+                dimensions: ::Array[String],
+                tiers: ::Array[Orb::PlanCreateParams::Price::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig::Tier]
+              }
+
+              type tier =
+                {
+                  dimension_values: ::Array[String],
+                  tier_lower_bound: String,
+                  unit_amount: String
+                }
+
+              class Tier < Orb::Internal::Type::BaseModel
+                attr_accessor dimension_values: ::Array[String]
+
+                attr_accessor tier_lower_bound: String
+
+                attr_accessor unit_amount: String
+
+                def initialize: (
+                  dimension_values: ::Array[String],
+                  tier_lower_bound: String,
+                  unit_amount: String
+                ) -> void
+
+                def to_hash: -> {
+                  dimension_values: ::Array[String],
+                  tier_lower_bound: String,
+                  unit_amount: String
+                }
+              end
+            end
+          end
+
           type matrix_with_threshold_discounts =
             {
               cadence: Orb::Models::PlanCreateParams::Price::Price::MatrixWithThresholdDiscounts::cadence,

data/sig/orb/models/price.rbs

@@ -16,6 +16,7 @@ module Orb
       | Orb::Price::PackageWithAllocation
       | Orb::Price::UnitWithPercent
       | Orb::Price::MatrixWithAllocation
+      | Orb::Price::TieredMatrixWithAllocation
       | Orb::Price::MatrixWithThresholdDiscounts
       | Orb::Price::TieredWithProration
       | Orb::Price::UnitWithProration
@@ -4473,6 +4474,337 @@ module Orb
         end
       end
 
+      type tiered_matrix_with_allocation =
+        {
+          id: String,
+          billable_metric: Orb::BillableMetricTiny?,
+          billing_cycle_configuration: Orb::BillingCycleConfiguration,
+          billing_mode: Orb::Models::Price::TieredMatrixWithAllocation::billing_mode,
+          cadence: Orb::Models::Price::TieredMatrixWithAllocation::cadence,
+          composite_price_filters: ::Array[Orb::Price::TieredMatrixWithAllocation::CompositePriceFilter]?,
+          conversion_rate: Float?,
+          conversion_rate_config: Orb::Models::conversion_rate_config?,
+          created_at: Time,
+          credit_allocation: Orb::Allocation?,
+          currency: String,
+          discount: Orb::Models::discount?,
+          external_price_id: String?,
+          fixed_price_quantity: Float?,
+          invoice_grouping_key: String?,
+          invoicing_cycle_configuration: Orb::BillingCycleConfiguration?,
+          item: Orb::ItemSlim,
+          maximum: Orb::Maximum?,
+          maximum_amount: String?,
+          metadata: ::Hash[Symbol, String],
+          minimum: Orb::Minimum?,
+          minimum_amount: String?,
+          model_type: :tiered_matrix_with_allocation,
+          name: String,
+          plan_phase_order: Integer?,
+          price_type: Orb::Models::Price::TieredMatrixWithAllocation::price_type,
+          replaces_price_id: String?,
+          tiered_matrix_with_allocation_config: Orb::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig,
+          dimensional_price_configuration: Orb::DimensionalPriceConfiguration?,
+          license_type: Orb::Price::TieredMatrixWithAllocation::LicenseType?
+        }
+
+      class TieredMatrixWithAllocation < Orb::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor billable_metric: Orb::BillableMetricTiny?
+
+        attr_accessor billing_cycle_configuration: Orb::BillingCycleConfiguration
+
+        attr_accessor billing_mode: Orb::Models::Price::TieredMatrixWithAllocation::billing_mode
+
+        attr_accessor cadence: Orb::Models::Price::TieredMatrixWithAllocation::cadence
+
+        attr_accessor composite_price_filters: ::Array[Orb::Price::TieredMatrixWithAllocation::CompositePriceFilter]?
+
+        attr_accessor conversion_rate: Float?
+
+        attr_accessor conversion_rate_config: Orb::Models::conversion_rate_config?
+
+        attr_accessor created_at: Time
+
+        attr_accessor credit_allocation: Orb::Allocation?
+
+        attr_accessor currency: String
+
+        attr_accessor discount: Orb::Models::discount?
+
+        attr_accessor external_price_id: String?
+
+        attr_accessor fixed_price_quantity: Float?
+
+        attr_accessor invoice_grouping_key: String?
+
+        attr_accessor invoicing_cycle_configuration: Orb::BillingCycleConfiguration?
+
+        attr_accessor item: Orb::ItemSlim
+
+        attr_accessor maximum: Orb::Maximum?
+
+        attr_accessor maximum_amount: String?
+
+        attr_accessor metadata: ::Hash[Symbol, String]
+
+        attr_accessor minimum: Orb::Minimum?
+
+        attr_accessor minimum_amount: String?
+
+        attr_accessor model_type: :tiered_matrix_with_allocation
+
+        attr_accessor name: String
+
+        attr_accessor plan_phase_order: Integer?
+
+        attr_accessor price_type: Orb::Models::Price::TieredMatrixWithAllocation::price_type
+
+        attr_accessor replaces_price_id: String?
+
+        attr_accessor tiered_matrix_with_allocation_config: Orb::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig
+
+        attr_accessor dimensional_price_configuration: Orb::DimensionalPriceConfiguration?
+
+        attr_accessor license_type: Orb::Price::TieredMatrixWithAllocation::LicenseType?
+
+        def initialize: (
+          id: String,
+          billable_metric: Orb::BillableMetricTiny?,
+          billing_cycle_configuration: Orb::BillingCycleConfiguration,
+          billing_mode: Orb::Models::Price::TieredMatrixWithAllocation::billing_mode,
+          cadence: Orb::Models::Price::TieredMatrixWithAllocation::cadence,
+          composite_price_filters: ::Array[Orb::Price::TieredMatrixWithAllocation::CompositePriceFilter]?,
+          conversion_rate: Float?,
+          conversion_rate_config: Orb::Models::conversion_rate_config?,
+          created_at: Time,
+          credit_allocation: Orb::Allocation?,
+          currency: String,
+          discount: Orb::Models::discount?,
+          external_price_id: String?,
+          fixed_price_quantity: Float?,
+          invoice_grouping_key: String?,
+          invoicing_cycle_configuration: Orb::BillingCycleConfiguration?,
+          item: Orb::ItemSlim,
+          maximum: Orb::Maximum?,
+          maximum_amount: String?,
+          metadata: ::Hash[Symbol, String],
+          minimum: Orb::Minimum?,
+          minimum_amount: String?,
+          name: String,
+          plan_phase_order: Integer?,
+          price_type: Orb::Models::Price::TieredMatrixWithAllocation::price_type,
+          replaces_price_id: String?,
+          tiered_matrix_with_allocation_config: Orb::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig,
+          ?dimensional_price_configuration: Orb::DimensionalPriceConfiguration?,
+          ?license_type: Orb::Price::TieredMatrixWithAllocation::LicenseType?,
+          ?model_type: :tiered_matrix_with_allocation
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          billable_metric: Orb::BillableMetricTiny?,
+          billing_cycle_configuration: Orb::BillingCycleConfiguration,
+          billing_mode: Orb::Models::Price::TieredMatrixWithAllocation::billing_mode,
+          cadence: Orb::Models::Price::TieredMatrixWithAllocation::cadence,
+          composite_price_filters: ::Array[Orb::Price::TieredMatrixWithAllocation::CompositePriceFilter]?,
+          conversion_rate: Float?,
+          conversion_rate_config: Orb::Models::conversion_rate_config?,
+          created_at: Time,
+          credit_allocation: Orb::Allocation?,
+          currency: String,
+          discount: Orb::Models::discount?,
+          external_price_id: String?,
+          fixed_price_quantity: Float?,
+          invoice_grouping_key: String?,
+          invoicing_cycle_configuration: Orb::BillingCycleConfiguration?,
+          item: Orb::ItemSlim,
+          maximum: Orb::Maximum?,
+          maximum_amount: String?,
+          metadata: ::Hash[Symbol, String],
+          minimum: Orb::Minimum?,
+          minimum_amount: String?,
+          model_type: :tiered_matrix_with_allocation,
+          name: String,
+          plan_phase_order: Integer?,
+          price_type: Orb::Models::Price::TieredMatrixWithAllocation::price_type,
+          replaces_price_id: String?,
+          tiered_matrix_with_allocation_config: Orb::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig,
+          dimensional_price_configuration: Orb::DimensionalPriceConfiguration?,
+          license_type: Orb::Price::TieredMatrixWithAllocation::LicenseType?
+        }
+
+        type billing_mode = :in_advance | :in_arrear
+
+        module BillingMode
+          extend Orb::Internal::Type::Enum
+
+          IN_ADVANCE: :in_advance
+          IN_ARREAR: :in_arrear
+
+          def self?.values: -> ::Array[Orb::Models::Price::TieredMatrixWithAllocation::billing_mode]
+        end
+
+        type cadence =
+          :one_time | :monthly | :quarterly | :semi_annual | :annual | :custom
+
+        module Cadence
+          extend Orb::Internal::Type::Enum
+
+          ONE_TIME: :one_time
+          MONTHLY: :monthly
+          QUARTERLY: :quarterly
+          SEMI_ANNUAL: :semi_annual
+          ANNUAL: :annual
+          CUSTOM: :custom
+
+          def self?.values: -> ::Array[Orb::Models::Price::TieredMatrixWithAllocation::cadence]
+        end
+
+        type composite_price_filter =
+          {
+            field: Orb::Models::Price::TieredMatrixWithAllocation::CompositePriceFilter::field,
+            operator: Orb::Models::Price::TieredMatrixWithAllocation::CompositePriceFilter::operator,
+            values: ::Array[String]
+          }
+
+        class CompositePriceFilter < Orb::Internal::Type::BaseModel
+          attr_accessor field: Orb::Models::Price::TieredMatrixWithAllocation::CompositePriceFilter::field
+
+          attr_accessor operator: Orb::Models::Price::TieredMatrixWithAllocation::CompositePriceFilter::operator
+
+          attr_accessor values: ::Array[String]
+
+          def initialize: (
+            field: Orb::Models::Price::TieredMatrixWithAllocation::CompositePriceFilter::field,
+            operator: Orb::Models::Price::TieredMatrixWithAllocation::CompositePriceFilter::operator,
+            values: ::Array[String]
+          ) -> void
+
+          def to_hash: -> {
+            field: Orb::Models::Price::TieredMatrixWithAllocation::CompositePriceFilter::field,
+            operator: Orb::Models::Price::TieredMatrixWithAllocation::CompositePriceFilter::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::Price::TieredMatrixWithAllocation::CompositePriceFilter::field]
+          end
+
+          type operator = :includes | :excludes
+
+          module Operator
+            extend Orb::Internal::Type::Enum
+
+            INCLUDES: :includes
+            EXCLUDES: :excludes
+
+            def self?.values: -> ::Array[Orb::Models::Price::TieredMatrixWithAllocation::CompositePriceFilter::operator]
+          end
+        end
+
+        type price_type = :usage_price | :fixed_price | :composite_price
+
+        module PriceType
+          extend Orb::Internal::Type::Enum
+
+          USAGE_PRICE: :usage_price
+          FIXED_PRICE: :fixed_price
+          COMPOSITE_PRICE: :composite_price
+
+          def self?.values: -> ::Array[Orb::Models::Price::TieredMatrixWithAllocation::price_type]
+        end
+
+        type tiered_matrix_with_allocation_config =
+          {
+            allocation: String,
+            default_unit_amount: String,
+            dimensions: ::Array[String],
+            tiers: ::Array[Orb::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig::Tier]
+          }
+
+        class TieredMatrixWithAllocationConfig < Orb::Internal::Type::BaseModel
+          attr_accessor allocation: String
+
+          attr_accessor default_unit_amount: String
+
+          attr_accessor dimensions: ::Array[String]
+
+          attr_accessor tiers: ::Array[Orb::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig::Tier]
+
+          def initialize: (
+            allocation: String,
+            default_unit_amount: String,
+            dimensions: ::Array[String],
+            tiers: ::Array[Orb::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig::Tier]
+          ) -> void
+
+          def to_hash: -> {
+            allocation: String,
+            default_unit_amount: String,
+            dimensions: ::Array[String],
+            tiers: ::Array[Orb::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig::Tier]
+          }
+
+          type tier =
+            {
+              dimension_values: ::Array[String],
+              tier_lower_bound: String,
+              unit_amount: String
+            }
+
+          class Tier < Orb::Internal::Type::BaseModel
+            attr_accessor dimension_values: ::Array[String]
+
+            attr_accessor tier_lower_bound: String
+
+            attr_accessor unit_amount: String
+
+            def initialize: (
+              dimension_values: ::Array[String],
+              tier_lower_bound: String,
+              unit_amount: String
+            ) -> void
+
+            def to_hash: -> {
+              dimension_values: ::Array[String],
+              tier_lower_bound: String,
+              unit_amount: String
+            }
+          end
+        end
+
+        type license_type = { id: String, grouping_key: String, name: String }
+
+        class LicenseType < Orb::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor grouping_key: String
+
+          attr_accessor name: String
+
+          def initialize: (
+            id: String,
+            grouping_key: String,
+            name: String
+          ) -> void
+
+          def to_hash: -> { id: String, grouping_key: String, name: String }
+        end
+      end
+
       type matrix_with_threshold_discounts =
         {
           id: String,