orb-billing 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72bf8cc708079b89812a37a34a92505d31c7a8e4fb7be72449ef1cefa3a68433
-  data.tar.gz: c94583819d1a3c5e6544dc35378a645f5b823e6591a6fc8a18e0a02c070e68da
+  metadata.gz: 4f4ae521bd8d9d4275a40fa934cf549e2eb6cbcbca223e029b346e30ddf8a944
+  data.tar.gz: 24fa3c6a5e0e8122fa51b318b0d3c5873d314512cfbf5b662affd52a7b54128a
 SHA512:
-  metadata.gz: 3955626d5164c7909179bd3d87b0bdea7660cc532390ecff4586642a79072014f039fe0e1ecf05a9c1a52ed2a5088800bac24bea9ae02fe0110692c6579cf0f1
-  data.tar.gz: b440576069f58911b5fb0640bdd8e92a0210b8027b9cf7640aee6c2094d94ff56b8285e3e870630c825684b3902f8eb4085ec8b79a233b5eb4d3ca9557e9f898
+  metadata.gz: a6fa4cc817ea442fbb900eed43c07bb83ab8ff177fdec5678b7dc361f48c8bb1a3ed980c704ee8e6efea2922f970d62655fa5a4e5603dd520fba979a03158533
+  data.tar.gz: a88704dc4577925662b94caff23d0bfe56ffe6a4b00f67415cd3afd1eb72d46a5d9cf36123f33cbbc1f8ac12ada9203667597ef1843e1e742d2a2397a77a5268

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 1.2.0 (2025-06-26)
+
+Full Changelog: [v1.1.0...v1.2.0](https://github.com/orbcorp/orb-ruby/compare/v1.1.0...v1.2.0)
+
+### Features
+
+* **api:** api update ([5a73526](https://github.com/orbcorp/orb-ruby/commit/5a73526b78e0eeb8b440b94b885fce49f6b28006))
+
+
+### Chores
+
+* **internal:** version bump ([9c3718b](https://github.com/orbcorp/orb-ruby/commit/9c3718b58f8bba10548e2897448d908588c6ea02))
+
 ## 1.1.0 (2025-06-18)
 
 Full Changelog: [v1.0.1...v1.1.0](https://github.com/orbcorp/orb-ruby/compare/v1.0.1...v1.1.0)

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.1.0"
+gem "orb-billing", "~> 1.2.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/orb/models/monetary_amount_discount_adjustment.rb

@@ -53,7 +53,14 @@ module Orb
       #   @return [String, nil]
       required :reason, String, nil?: true
 
-      # @!method initialize(id:, adjustment_type:, amount:, amount_discount:, applies_to_price_ids:, filters:, is_invoice_level:, reason:)
+      # @!attribute replaces_adjustment_id
+      #   The adjustment id this adjustment replaces. This adjustment will take the place
+      #   of the replaced adjustment in plan version migrations.
+      #
+      #   @return [String, nil]
+      required :replaces_adjustment_id, String, nil?: true
+
+      # @!method initialize(id:, adjustment_type:, amount:, amount_discount:, applies_to_price_ids:, filters:, is_invoice_level:, reason:, replaces_adjustment_id:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::MonetaryAmountDiscountAdjustment} for more details.
       #
@@ -72,6 +79,8 @@ module Orb
       #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
       #
       #   @param reason [String, nil] The reason for the adjustment.
+      #
+      #   @param replaces_adjustment_id [String, nil] The adjustment id this adjustment replaces. This adjustment will take the place
 
       # @see Orb::Models::MonetaryAmountDiscountAdjustment#adjustment_type
       module AdjustmentType

data/lib/orb/models/monetary_maximum_adjustment.rb

@@ -53,7 +53,14 @@ module Orb
       #   @return [String, nil]
       required :reason, String, nil?: true
 
-      # @!method initialize(id:, adjustment_type:, amount:, applies_to_price_ids:, filters:, is_invoice_level:, maximum_amount:, reason:)
+      # @!attribute replaces_adjustment_id
+      #   The adjustment id this adjustment replaces. This adjustment will take the place
+      #   of the replaced adjustment in plan version migrations.
+      #
+      #   @return [String, nil]
+      required :replaces_adjustment_id, String, nil?: true
+
+      # @!method initialize(id:, adjustment_type:, amount:, applies_to_price_ids:, filters:, is_invoice_level:, maximum_amount:, reason:, replaces_adjustment_id:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::MonetaryMaximumAdjustment} for more details.
       #
@@ -72,6 +79,8 @@ module Orb
       #   @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
       #
       #   @param reason [String, nil] The reason for the adjustment.
+      #
+      #   @param replaces_adjustment_id [String, nil] The adjustment id this adjustment replaces. This adjustment will take the place
 
       # @see Orb::Models::MonetaryMaximumAdjustment#adjustment_type
       module AdjustmentType

data/lib/orb/models/monetary_minimum_adjustment.rb

@@ -59,7 +59,14 @@ module Orb
       #   @return [String, nil]
       required :reason, String, nil?: true
 
-      # @!method initialize(id:, adjustment_type:, amount:, applies_to_price_ids:, filters:, is_invoice_level:, item_id:, minimum_amount:, reason:)
+      # @!attribute replaces_adjustment_id
+      #   The adjustment id this adjustment replaces. This adjustment will take the place
+      #   of the replaced adjustment in plan version migrations.
+      #
+      #   @return [String, nil]
+      required :replaces_adjustment_id, String, nil?: true
+
+      # @!method initialize(id:, adjustment_type:, amount:, applies_to_price_ids:, filters:, is_invoice_level:, item_id:, minimum_amount:, reason:, replaces_adjustment_id:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::MonetaryMinimumAdjustment} for more details.
       #
@@ -80,6 +87,8 @@ module Orb
       #   @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
       #
       #   @param reason [String, nil] The reason for the adjustment.
+      #
+      #   @param replaces_adjustment_id [String, nil] The adjustment id this adjustment replaces. This adjustment will take the place
 
       # @see Orb::Models::MonetaryMinimumAdjustment#adjustment_type
       module AdjustmentType

data/lib/orb/models/monetary_percentage_discount_adjustment.rb

@@ -53,7 +53,14 @@ module Orb
       #   @return [String, nil]
       required :reason, String, nil?: true
 
-      # @!method initialize(id:, adjustment_type:, amount:, applies_to_price_ids:, filters:, is_invoice_level:, percentage_discount:, reason:)
+      # @!attribute replaces_adjustment_id
+      #   The adjustment id this adjustment replaces. This adjustment will take the place
+      #   of the replaced adjustment in plan version migrations.
+      #
+      #   @return [String, nil]
+      required :replaces_adjustment_id, String, nil?: true
+
+      # @!method initialize(id:, adjustment_type:, amount:, applies_to_price_ids:, filters:, is_invoice_level:, percentage_discount:, reason:, replaces_adjustment_id:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::MonetaryPercentageDiscountAdjustment} for more details.
       #
@@ -72,6 +79,8 @@ module Orb
       #   @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
       #
       #   @param reason [String, nil] The reason for the adjustment.
+      #
+      #   @param replaces_adjustment_id [String, nil] The adjustment id this adjustment replaces. This adjustment will take the place
 
       # @see Orb::Models::MonetaryPercentageDiscountAdjustment#adjustment_type
       module AdjustmentType

data/lib/orb/models/monetary_usage_discount_adjustment.rb

@@ -46,6 +46,13 @@ module Orb
       #   @return [String, nil]
       required :reason, String, nil?: true
 
+      # @!attribute replaces_adjustment_id
+      #   The adjustment id this adjustment replaces. This adjustment will take the place
+      #   of the replaced adjustment in plan version migrations.
+      #
+      #   @return [String, nil]
+      required :replaces_adjustment_id, String, nil?: true
+
       # @!attribute usage_discount
       #   The number of usage units by which to discount the price this adjustment applies
       #   to in a given billing period.
@@ -53,7 +60,7 @@ module Orb
       #   @return [Float]
       required :usage_discount, Float
 
-      # @!method initialize(id:, adjustment_type:, amount:, applies_to_price_ids:, filters:, is_invoice_level:, reason:, usage_discount:)
+      # @!method initialize(id:, adjustment_type:, amount:, applies_to_price_ids:, filters:, is_invoice_level:, reason:, replaces_adjustment_id:, usage_discount:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::MonetaryUsageDiscountAdjustment} for more details.
       #
@@ -71,6 +78,8 @@ module Orb
       #
       #   @param reason [String, nil] The reason for the adjustment.
       #
+      #   @param replaces_adjustment_id [String, nil] The adjustment id this adjustment replaces. This adjustment will take the place
+      #
       #   @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
 
       # @see Orb::Models::MonetaryUsageDiscountAdjustment#adjustment_type

data/lib/orb/models/plan_phase_amount_discount_adjustment.rb

@@ -53,7 +53,14 @@ module Orb
       #   @return [String, nil]
       required :reason, String, nil?: true
 
-      # @!method initialize(id:, adjustment_type:, amount_discount:, applies_to_price_ids:, filters:, is_invoice_level:, plan_phase_order:, reason:)
+      # @!attribute replaces_adjustment_id
+      #   The adjustment id this adjustment replaces. This adjustment will take the place
+      #   of the replaced adjustment in plan version migrations.
+      #
+      #   @return [String, nil]
+      required :replaces_adjustment_id, String, nil?: true
+
+      # @!method initialize(id:, adjustment_type:, amount_discount:, applies_to_price_ids:, filters:, is_invoice_level:, plan_phase_order:, reason:, replaces_adjustment_id:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::PlanPhaseAmountDiscountAdjustment} for more details.
       #
@@ -72,6 +79,8 @@ module Orb
       #   @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
       #
       #   @param reason [String, nil] The reason for the adjustment.
+      #
+      #   @param replaces_adjustment_id [String, nil] The adjustment id this adjustment replaces. This adjustment will take the place
 
       # @see Orb::Models::PlanPhaseAmountDiscountAdjustment#adjustment_type
       module AdjustmentType

data/lib/orb/models/plan_phase_maximum_adjustment.rb

@@ -53,7 +53,14 @@ module Orb
       #   @return [String, nil]
       required :reason, String, nil?: true
 
-      # @!method initialize(id:, adjustment_type:, applies_to_price_ids:, filters:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:)
+      # @!attribute replaces_adjustment_id
+      #   The adjustment id this adjustment replaces. This adjustment will take the place
+      #   of the replaced adjustment in plan version migrations.
+      #
+      #   @return [String, nil]
+      required :replaces_adjustment_id, String, nil?: true
+
+      # @!method initialize(id:, adjustment_type:, applies_to_price_ids:, filters:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, replaces_adjustment_id:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::PlanPhaseMaximumAdjustment} for more details.
       #
@@ -72,6 +79,8 @@ module Orb
       #   @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
       #
       #   @param reason [String, nil] The reason for the adjustment.
+      #
+      #   @param replaces_adjustment_id [String, nil] The adjustment id this adjustment replaces. This adjustment will take the place
 
       # @see Orb::Models::PlanPhaseMaximumAdjustment#adjustment_type
       module AdjustmentType

data/lib/orb/models/plan_phase_minimum_adjustment.rb

@@ -59,7 +59,14 @@ module Orb
       #   @return [String, nil]
       required :reason, String, nil?: true
 
-      # @!method initialize(id:, adjustment_type:, applies_to_price_ids:, filters:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:)
+      # @!attribute replaces_adjustment_id
+      #   The adjustment id this adjustment replaces. This adjustment will take the place
+      #   of the replaced adjustment in plan version migrations.
+      #
+      #   @return [String, nil]
+      required :replaces_adjustment_id, String, nil?: true
+
+      # @!method initialize(id:, adjustment_type:, applies_to_price_ids:, filters:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, replaces_adjustment_id:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::PlanPhaseMinimumAdjustment} for more details.
       #
@@ -80,6 +87,8 @@ module Orb
       #   @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
       #
       #   @param reason [String, nil] The reason for the adjustment.
+      #
+      #   @param replaces_adjustment_id [String, nil] The adjustment id this adjustment replaces. This adjustment will take the place
 
       # @see Orb::Models::PlanPhaseMinimumAdjustment#adjustment_type
       module AdjustmentType

data/lib/orb/models/plan_phase_percentage_discount_adjustment.rb

@@ -53,7 +53,14 @@ module Orb
       #   @return [String, nil]
       required :reason, String, nil?: true
 
-      # @!method initialize(id:, adjustment_type:, applies_to_price_ids:, filters:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:)
+      # @!attribute replaces_adjustment_id
+      #   The adjustment id this adjustment replaces. This adjustment will take the place
+      #   of the replaced adjustment in plan version migrations.
+      #
+      #   @return [String, nil]
+      required :replaces_adjustment_id, String, nil?: true
+
+      # @!method initialize(id:, adjustment_type:, applies_to_price_ids:, filters:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, replaces_adjustment_id:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::PlanPhasePercentageDiscountAdjustment} for more details.
       #
@@ -72,6 +79,8 @@ module Orb
       #   @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
       #
       #   @param reason [String, nil] The reason for the adjustment.
+      #
+      #   @param replaces_adjustment_id [String, nil] The adjustment id this adjustment replaces. This adjustment will take the place
 
       # @see Orb::Models::PlanPhasePercentageDiscountAdjustment#adjustment_type
       module AdjustmentType

data/lib/orb/models/plan_phase_usage_discount_adjustment.rb

@@ -46,6 +46,13 @@ module Orb
       #   @return [String, nil]
       required :reason, String, nil?: true
 
+      # @!attribute replaces_adjustment_id
+      #   The adjustment id this adjustment replaces. This adjustment will take the place
+      #   of the replaced adjustment in plan version migrations.
+      #
+      #   @return [String, nil]
+      required :replaces_adjustment_id, String, nil?: true
+
       # @!attribute usage_discount
       #   The number of usage units by which to discount the price this adjustment applies
       #   to in a given billing period.
@@ -53,7 +60,7 @@ module Orb
       #   @return [Float]
       required :usage_discount, Float
 
-      # @!method initialize(id:, adjustment_type:, applies_to_price_ids:, filters:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:)
+      # @!method initialize(id:, adjustment_type:, applies_to_price_ids:, filters:, is_invoice_level:, plan_phase_order:, reason:, replaces_adjustment_id:, usage_discount:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::PlanPhaseUsageDiscountAdjustment} for more details.
       #
@@ -71,6 +78,8 @@ module Orb
       #
       #   @param reason [String, nil] The reason for the adjustment.
       #
+      #   @param replaces_adjustment_id [String, nil] The adjustment id this adjustment replaces. This adjustment will take the place
+      #
       #   @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
 
       # @see Orb::Models::PlanPhaseUsageDiscountAdjustment#adjustment_type