orb-billing 1.27.0 → 1.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9963c97978a5d148cea925094ef65f1f198cb85230d9ea6fdfc0988d6c92df2e
-  data.tar.gz: 39ada2b3ae8568cbf46ed3d80a8c6a4bf9539546cd510f9cc7cca83912fd964f
+  metadata.gz: e696c92aadec856a97cadfc85a5efaa55b51947b6d261e23afb9b038fc291203
+  data.tar.gz: b5fb963b9ab31969d11a701a07e188843e5f4f19560ddea000223f3bbd95f16f
 SHA512:
-  metadata.gz: 376cf1aa3abd49b701bfba2b33bdbd4976c5916e798014a83b08ea2e6f0b709bf981046616fbef1f475559f9dd6f0e2738f147d1c221da7ced3695c9b98bc8eb
-  data.tar.gz: aee8e43ed717d30c552b3b7a021113c9079615282fcdbff4c43fc1be3a60ff9a8f079287240b07151346b0630c324856c650eda5c4f1ab4773405a6251319a6f
+  metadata.gz: 22f4131bc53e513d7d4a9735bd04ef912b276aec5abe2fb8653ee4ff02f6ff471123a20d296bcb8c226bd6a4b1a623ff03eeb1678dfac39fc5b9edb751c1fcaa
+  data.tar.gz: 37ad33761702700de24810b0a5bb8b4df17cb21543bf8f9362405392dc2d28521fdfcc37f2dae1fe129df459301c3be044af577427d6d04322a3dfd936d3c243

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [1.28.0](https://github.com/orbcorp/orb-ruby/compare/v1.27.0...v1.28.0) (2026-08-25)
+
+
+### Features
+
+* **api:** restore deprecated `scaling_factor` field on unit and matrix price configs ([31e58e0](https://github.com/orbcorp/orb-ruby/commit/31e58e08017b5b80f8cce123106b585d5f7d7f2d))
+
+
+### Bug Fixes
+
+* **api:** reject empty or missing dimension values in dimensional price configuration ([31e58e0](https://github.com/orbcorp/orb-ruby/commit/31e58e08017b5b80f8cce123106b585d5f7d7f2d))
+
 ## [1.27.0](https://github.com/orbcorp/orb-ruby/compare/v1.26.0...v1.27.0) (2026-08-19)
 
 

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "orb-billing", "~> 1.27.0"
+gem "orb-billing", "~> 1.28.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/orb/models/matrix_config.rb

@@ -21,7 +21,19 @@ module Orb
       #   @return [Array<Orb::Models::MatrixValue>]
       required :matrix_values, -> { Orb::Internal::Type::ArrayOf[Orb::MatrixValue] }
 
-      # @!method initialize(default_unit_amount:, dimensions:, matrix_values:)
+      # @!attribute scaling_factor
+      #   @deprecated
+      #
+      #   Optional multiplier applied to default-bucket quantity before
+      #   default_unit_amount.
+      #
+      #   @return [Float, nil]
+      optional :scaling_factor, Float, nil?: true
+
+      # @!method initialize(default_unit_amount:, dimensions:, matrix_values:, scaling_factor: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::MatrixConfig} for more details.
+      #
       #   Configuration for matrix pricing
       #
       #   @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value
@@ -29,6 +41,8 @@ module Orb
       #   @param dimensions [Array<String, nil>] One or two event property values to evaluate matrix groups by
       #
       #   @param matrix_values [Array<Orb::Models::MatrixValue>] Matrix values configuration
+      #
+      #   @param scaling_factor [Float, nil] Optional multiplier applied to default-bucket quantity before default_unit_amoun
     end
   end
 end

data/lib/orb/models/matrix_value.rb

@@ -15,12 +15,22 @@ module Orb
       #   @return [String]
       required :unit_amount, String
 
-      # @!method initialize(dimension_values:, unit_amount:)
+      # @!attribute scaling_factor
+      #   @deprecated
+      #
+      #   Optional multiplier applied to rated quantity before unit_amount.
+      #
+      #   @return [Float, nil]
+      optional :scaling_factor, Float, nil?: true
+
+      # @!method initialize(dimension_values:, unit_amount:, scaling_factor: nil)
       #   Configuration for a single matrix value
       #
       #   @param dimension_values [Array<String, nil>] One or two matrix keys to filter usage to this Matrix value by
       #
       #   @param unit_amount [String] Unit price for the specified dimension_values
+      #
+      #   @param scaling_factor [Float, nil] Optional multiplier applied to rated quantity before unit_amount.
     end
   end
 end

data/lib/orb/models/matrix_with_allocation_config.rb

@@ -27,7 +27,19 @@ module Orb
       #   @return [Array<Orb::Models::MatrixWithAllocationConfig::MatrixValue>]
       required :matrix_values, -> { Orb::Internal::Type::ArrayOf[Orb::MatrixWithAllocationConfig::MatrixValue] }
 
-      # @!method initialize(allocation:, default_unit_amount:, dimensions:, matrix_values:)
+      # @!attribute scaling_factor
+      #   @deprecated
+      #
+      #   Optional multiplier applied to default-bucket quantity before
+      #   default_unit_amount.
+      #
+      #   @return [String, nil]
+      optional :scaling_factor, String, nil?: true
+
+      # @!method initialize(allocation:, default_unit_amount:, dimensions:, matrix_values:, scaling_factor: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::MatrixWithAllocationConfig} for more details.
+      #
       #   Configuration for matrix pricing with usage allocation
       #
       #   @param allocation [String] Usage allocation
@@ -37,6 +49,8 @@ module Orb
       #   @param dimensions [Array<String, nil>] One or two event property values to evaluate matrix groups by
       #
       #   @param matrix_values [Array<Orb::Models::MatrixWithAllocationConfig::MatrixValue>] Matrix values configuration
+      #
+      #   @param scaling_factor [String, nil] Optional multiplier applied to default-bucket quantity before default_unit_amoun
 
       class MatrixValue < Orb::Internal::Type::BaseModel
         # @!attribute dimension_values
@@ -53,7 +67,15 @@ module Orb
         #   @return [String]
         required :unit_amount, String
 
-        # @!method initialize(dimension_values:, unit_amount:)
+        # @!attribute scaling_factor
+        #   @deprecated
+        #
+        #   Optional multiplier applied to rated quantity before unit_amount.
+        #
+        #   @return [String, nil]
+        optional :scaling_factor, String, nil?: true
+
+        # @!method initialize(dimension_values:, unit_amount:, scaling_factor: nil)
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::MatrixWithAllocationConfig::MatrixValue} for more details.
         #
@@ -62,6 +84,8 @@ module Orb
         #   @param dimension_values [Array<String, nil>] One or two matrix keys to filter usage to this Matrix value by. For example, ["r
         #
         #   @param unit_amount [String] Unit price for the specified dimension_values
+        #
+        #   @param scaling_factor [String, nil] Optional multiplier applied to rated quantity before unit_amount.
       end
     end
   end

data/lib/orb/models/unit_config.rb

@@ -15,12 +15,22 @@ module Orb
       #   @return [Boolean, nil]
       optional :prorated, Orb::Internal::Type::Boolean
 
-      # @!method initialize(unit_amount:, prorated: nil)
+      # @!attribute scaling_factor
+      #   @deprecated
+      #
+      #   Optional multiplier applied to rated quantity before unit_amount.
+      #
+      #   @return [Float, nil]
+      optional :scaling_factor, Float, nil?: true
+
+      # @!method initialize(unit_amount:, prorated: nil, scaling_factor: nil)
       #   Configuration for unit pricing
       #
       #   @param unit_amount [String] Rate per unit of usage
       #
       #   @param prorated [Boolean] If true, subtotals from this price are prorated based on the service period
+      #
+      #   @param scaling_factor [Float, nil] Optional multiplier applied to rated quantity before unit_amount.
     end
   end
 end

data/lib/orb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Orb
-  VERSION = "1.27.0"
+  VERSION = "1.28.0"
 end

data/rbi/orb/models/matrix_config.rbi

@@ -17,12 +17,18 @@ module Orb
       sig { returns(T::Array[Orb::MatrixValue]) }
       attr_accessor :matrix_values
 
+      # Optional multiplier applied to default-bucket quantity before
+      # default_unit_amount.
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :scaling_factor
+
       # Configuration for matrix pricing
       sig do
         params(
           default_unit_amount: String,
           dimensions: T::Array[T.nilable(String)],
-          matrix_values: T::Array[Orb::MatrixValue::OrHash]
+          matrix_values: T::Array[Orb::MatrixValue::OrHash],
+          scaling_factor: T.nilable(Float)
         ).returns(T.attached_class)
       end
       def self.new(
@@ -31,7 +37,10 @@ module Orb
         # One or two event property values to evaluate matrix groups by
         dimensions:,
         # Matrix values configuration
-        matrix_values:
+        matrix_values:,
+        # Optional multiplier applied to default-bucket quantity before
+        # default_unit_amount.
+        scaling_factor: nil
       )
       end
 
@@ -40,7 +49,8 @@ module Orb
           {
             default_unit_amount: String,
             dimensions: T::Array[T.nilable(String)],
-            matrix_values: T::Array[Orb::MatrixValue]
+            matrix_values: T::Array[Orb::MatrixValue],
+            scaling_factor: T.nilable(Float)
           }
         )
       end

data/rbi/orb/models/matrix_value.rbi

@@ -13,24 +13,35 @@ module Orb
       sig { returns(String) }
       attr_accessor :unit_amount
 
+      # Optional multiplier applied to rated quantity before unit_amount.
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :scaling_factor
+
       # Configuration for a single matrix value
       sig do
         params(
           dimension_values: T::Array[T.nilable(String)],
-          unit_amount: String
+          unit_amount: String,
+          scaling_factor: T.nilable(Float)
         ).returns(T.attached_class)
       end
       def self.new(
         # One or two matrix keys to filter usage to this Matrix value by
         dimension_values:,
         # Unit price for the specified dimension_values
-        unit_amount:
+        unit_amount:,
+        # Optional multiplier applied to rated quantity before unit_amount.
+        scaling_factor: nil
       )
       end
 
       sig do
         override.returns(
-          { dimension_values: T::Array[T.nilable(String)], unit_amount: String }
+          {
+            dimension_values: T::Array[T.nilable(String)],
+            unit_amount: String,
+            scaling_factor: T.nilable(Float)
+          }
         )
       end
       def to_hash

data/rbi/orb/models/matrix_with_allocation_config.rbi

@@ -24,6 +24,11 @@ module Orb
       sig { returns(T::Array[Orb::MatrixWithAllocationConfig::MatrixValue]) }
       attr_accessor :matrix_values
 
+      # Optional multiplier applied to default-bucket quantity before
+      # default_unit_amount.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :scaling_factor
+
       # Configuration for matrix pricing with usage allocation
       sig do
         params(
@@ -31,7 +36,8 @@ module Orb
           default_unit_amount: String,
           dimensions: T::Array[T.nilable(String)],
           matrix_values:
-            T::Array[Orb::MatrixWithAllocationConfig::MatrixValue::OrHash]
+            T::Array[Orb::MatrixWithAllocationConfig::MatrixValue::OrHash],
+          scaling_factor: T.nilable(String)
         ).returns(T.attached_class)
       end
       def self.new(
@@ -42,7 +48,10 @@ module Orb
         # One or two event property values to evaluate matrix groups by
         dimensions:,
         # Matrix values configuration
-        matrix_values:
+        matrix_values:,
+        # Optional multiplier applied to default-bucket quantity before
+        # default_unit_amount.
+        scaling_factor: nil
       )
       end
 
@@ -53,7 +62,8 @@ module Orb
             default_unit_amount: String,
             dimensions: T::Array[T.nilable(String)],
             matrix_values:
-              T::Array[Orb::MatrixWithAllocationConfig::MatrixValue]
+              T::Array[Orb::MatrixWithAllocationConfig::MatrixValue],
+            scaling_factor: T.nilable(String)
           }
         )
       end
@@ -79,11 +89,16 @@ module Orb
         sig { returns(String) }
         attr_accessor :unit_amount
 
+        # Optional multiplier applied to rated quantity before unit_amount.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :scaling_factor
+
         # Configuration for a single matrix value
         sig do
           params(
             dimension_values: T::Array[T.nilable(String)],
-            unit_amount: String
+            unit_amount: String,
+            scaling_factor: T.nilable(String)
           ).returns(T.attached_class)
         end
         def self.new(
@@ -92,7 +107,9 @@ module Orb
           # instance tier.
           dimension_values:,
           # Unit price for the specified dimension_values
-          unit_amount:
+          unit_amount:,
+          # Optional multiplier applied to rated quantity before unit_amount.
+          scaling_factor: nil
         )
         end
 
@@ -100,7 +117,8 @@ module Orb
           override.returns(
             {
               dimension_values: T::Array[T.nilable(String)],
-              unit_amount: String
+              unit_amount: String,
+              scaling_factor: T.nilable(String)
             }
           )
         end

data/rbi/orb/models/unit_config.rbi

@@ -16,21 +16,37 @@ module Orb
       sig { params(prorated: T::Boolean).void }
       attr_writer :prorated
 
+      # Optional multiplier applied to rated quantity before unit_amount.
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :scaling_factor
+
       # Configuration for unit pricing
       sig do
-        params(unit_amount: String, prorated: T::Boolean).returns(
-          T.attached_class
-        )
+        params(
+          unit_amount: String,
+          prorated: T::Boolean,
+          scaling_factor: T.nilable(Float)
+        ).returns(T.attached_class)
       end
       def self.new(
         # Rate per unit of usage
         unit_amount:,
         # If true, subtotals from this price are prorated based on the service period
-        prorated: nil
+        prorated: nil,
+        # Optional multiplier applied to rated quantity before unit_amount.
+        scaling_factor: nil
       )
       end
 
-      sig { override.returns({ unit_amount: String, prorated: T::Boolean }) }
+      sig do
+        override.returns(
+          {
+            unit_amount: String,
+            prorated: T::Boolean,
+            scaling_factor: T.nilable(Float)
+          }
+        )
+      end
       def to_hash
       end
     end

data/sig/orb/models/matrix_config.rbs

@@ -4,7 +4,8 @@ module Orb
       {
         default_unit_amount: String,
         dimensions: ::Array[String?],
-        matrix_values: ::Array[Orb::MatrixValue]
+        matrix_values: ::Array[Orb::MatrixValue],
+        scaling_factor: Float?
       }
 
     class MatrixConfig < Orb::Internal::Type::BaseModel
@@ -14,16 +15,20 @@ module Orb
 
       attr_accessor matrix_values: ::Array[Orb::MatrixValue]
 
+      attr_accessor scaling_factor: Float?
+
       def initialize: (
         default_unit_amount: String,
         dimensions: ::Array[String?],
-        matrix_values: ::Array[Orb::MatrixValue]
+        matrix_values: ::Array[Orb::MatrixValue],
+        ?scaling_factor: Float?
       ) -> void
 
       def to_hash: -> {
         default_unit_amount: String,
         dimensions: ::Array[String?],
-        matrix_values: ::Array[Orb::MatrixValue]
+        matrix_values: ::Array[Orb::MatrixValue],
+        scaling_factor: Float?
       }
     end
   end

data/sig/orb/models/matrix_value.rbs

@@ -1,21 +1,29 @@
 module Orb
   module Models
     type matrix_value =
-      { dimension_values: ::Array[String?], unit_amount: String }
+      {
+        dimension_values: ::Array[String?],
+        unit_amount: String,
+        scaling_factor: Float?
+      }
 
     class MatrixValue < Orb::Internal::Type::BaseModel
       attr_accessor dimension_values: ::Array[String?]
 
       attr_accessor unit_amount: String
 
+      attr_accessor scaling_factor: Float?
+
       def initialize: (
         dimension_values: ::Array[String?],
-        unit_amount: String
+        unit_amount: String,
+        ?scaling_factor: Float?
       ) -> void
 
       def to_hash: -> {
         dimension_values: ::Array[String?],
-        unit_amount: String
+        unit_amount: String,
+        scaling_factor: Float?
       }
     end
   end

data/sig/orb/models/matrix_with_allocation_config.rbs

@@ -5,7 +5,8 @@ module Orb
         allocation: String,
         default_unit_amount: String,
         dimensions: ::Array[String?],
-        matrix_values: ::Array[Orb::MatrixWithAllocationConfig::MatrixValue]
+        matrix_values: ::Array[Orb::MatrixWithAllocationConfig::MatrixValue],
+        scaling_factor: String?
       }
 
     class MatrixWithAllocationConfig < Orb::Internal::Type::BaseModel
@@ -17,36 +18,48 @@ module Orb
 
       attr_accessor matrix_values: ::Array[Orb::MatrixWithAllocationConfig::MatrixValue]
 
+      attr_accessor scaling_factor: String?
+
       def initialize: (
         allocation: String,
         default_unit_amount: String,
         dimensions: ::Array[String?],
-        matrix_values: ::Array[Orb::MatrixWithAllocationConfig::MatrixValue]
+        matrix_values: ::Array[Orb::MatrixWithAllocationConfig::MatrixValue],
+        ?scaling_factor: String?
       ) -> void
 
       def to_hash: -> {
         allocation: String,
         default_unit_amount: String,
         dimensions: ::Array[String?],
-        matrix_values: ::Array[Orb::MatrixWithAllocationConfig::MatrixValue]
+        matrix_values: ::Array[Orb::MatrixWithAllocationConfig::MatrixValue],
+        scaling_factor: String?
       }
 
       type matrix_value =
-        { dimension_values: ::Array[String?], unit_amount: String }
+        {
+          dimension_values: ::Array[String?],
+          unit_amount: String,
+          scaling_factor: String?
+        }
 
       class MatrixValue < Orb::Internal::Type::BaseModel
         attr_accessor dimension_values: ::Array[String?]
 
         attr_accessor unit_amount: String
 
+        attr_accessor scaling_factor: String?
+
         def initialize: (
           dimension_values: ::Array[String?],
-          unit_amount: String
+          unit_amount: String,
+          ?scaling_factor: String?
         ) -> void
 
         def to_hash: -> {
           dimension_values: ::Array[String?],
-          unit_amount: String
+          unit_amount: String,
+          scaling_factor: String?
         }
       end
     end

data/sig/orb/models/unit_config.rbs

@@ -1,6 +1,7 @@
 module Orb
   module Models
-    type unit_config = { unit_amount: String, prorated: bool }
+    type unit_config =
+      { unit_amount: String, prorated: bool, scaling_factor: Float? }
 
     class UnitConfig < Orb::Internal::Type::BaseModel
       attr_accessor unit_amount: String
@@ -9,9 +10,19 @@ module Orb
 
       def prorated=: (bool) -> bool
 
-      def initialize: (unit_amount: String, ?prorated: bool) -> void
+      attr_accessor scaling_factor: Float?
 
-      def to_hash: -> { unit_amount: String, prorated: bool }
+      def initialize: (
+        unit_amount: String,
+        ?prorated: bool,
+        ?scaling_factor: Float?
+      ) -> void
+
+      def to_hash: -> {
+        unit_amount: String,
+        prorated: bool,
+        scaling_factor: Float?
+      }
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orb-billing
 version: !ruby/object:Gem::Version
-  version: 1.27.0
+  version: 1.28.0
 platform: ruby
 authors:
 - Orb
@@ -1407,7 +1407,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.18
+rubygems_version: 4.0.19
 specification_version: 4
 summary: Ruby library to access the Orb API
 test_files: []