orb-billing 1.0.1 → 1.2.0

data/sig/orb/models/new_plan_tiered_with_minimum_price.rbs

@@ -18,7 +18,8 @@ module Orb
         fixed_price_quantity: Float?,
         invoice_grouping_key: String?,
         invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
-        metadata: ::Hash[Symbol, String?]?
+        metadata: ::Hash[Symbol, String?]?,
+        reference_id: String?
       }
 
     class NewPlanTieredWithMinimumPrice < Orb::Internal::Type::BaseModel
@@ -56,6 +57,8 @@ module Orb
 
       attr_accessor metadata: ::Hash[Symbol, String?]?
 
+      attr_accessor reference_id: String?
+
       def initialize: (
         cadence: Orb::Models::NewPlanTieredWithMinimumPrice::cadence,
         item_id: String,
@@ -73,7 +76,8 @@ module Orb
         ?fixed_price_quantity: Float?,
         ?invoice_grouping_key: String?,
         ?invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
-        ?metadata: ::Hash[Symbol, String?]?
+        ?metadata: ::Hash[Symbol, String?]?,
+        ?reference_id: String?
       ) -> void
 
       def to_hash: -> {
@@ -93,7 +97,8 @@ module Orb
         fixed_price_quantity: Float?,
         invoice_grouping_key: String?,
         invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
-        metadata: ::Hash[Symbol, String?]?
+        metadata: ::Hash[Symbol, String?]?,
+        reference_id: String?
       }
 
       type cadence =

data/sig/orb/models/new_plan_unit_price.rbs

@@ -18,7 +18,8 @@ module Orb
         fixed_price_quantity: Float?,
         invoice_grouping_key: String?,
         invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
-        metadata: ::Hash[Symbol, String?]?
+        metadata: ::Hash[Symbol, String?]?,
+        reference_id: String?
       }
 
     class NewPlanUnitPrice < Orb::Internal::Type::BaseModel
@@ -56,6 +57,8 @@ module Orb
 
       attr_accessor metadata: ::Hash[Symbol, String?]?
 
+      attr_accessor reference_id: String?
+
       def initialize: (
         cadence: Orb::Models::NewPlanUnitPrice::cadence,
         item_id: String,
@@ -73,7 +76,8 @@ module Orb
         ?fixed_price_quantity: Float?,
         ?invoice_grouping_key: String?,
         ?invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
-        ?metadata: ::Hash[Symbol, String?]?
+        ?metadata: ::Hash[Symbol, String?]?,
+        ?reference_id: String?
       ) -> void
 
       def to_hash: -> {
@@ -93,7 +97,8 @@ module Orb
         fixed_price_quantity: Float?,
         invoice_grouping_key: String?,
         invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
-        metadata: ::Hash[Symbol, String?]?
+        metadata: ::Hash[Symbol, String?]?,
+        reference_id: String?
       }
 
       type cadence =

data/sig/orb/models/new_plan_unit_with_percent_price.rbs

@@ -18,7 +18,8 @@ module Orb
         fixed_price_quantity: Float?,
         invoice_grouping_key: String?,
         invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
-        metadata: ::Hash[Symbol, String?]?
+        metadata: ::Hash[Symbol, String?]?,
+        reference_id: String?
       }
 
     class NewPlanUnitWithPercentPrice < Orb::Internal::Type::BaseModel
@@ -56,6 +57,8 @@ module Orb
 
       attr_accessor metadata: ::Hash[Symbol, String?]?
 
+      attr_accessor reference_id: String?
+
       def initialize: (
         cadence: Orb::Models::NewPlanUnitWithPercentPrice::cadence,
         item_id: String,
@@ -73,7 +76,8 @@ module Orb
         ?fixed_price_quantity: Float?,
         ?invoice_grouping_key: String?,
         ?invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
-        ?metadata: ::Hash[Symbol, String?]?
+        ?metadata: ::Hash[Symbol, String?]?,
+        ?reference_id: String?
       ) -> void
 
       def to_hash: -> {
@@ -93,7 +97,8 @@ module Orb
         fixed_price_quantity: Float?,
         invoice_grouping_key: String?,
         invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
-        metadata: ::Hash[Symbol, String?]?
+        metadata: ::Hash[Symbol, String?]?,
+        reference_id: String?
       }
 
       type cadence =

data/sig/orb/models/new_plan_unit_with_proration_price.rbs

@@ -18,7 +18,8 @@ module Orb
         fixed_price_quantity: Float?,
         invoice_grouping_key: String?,
         invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
-        metadata: ::Hash[Symbol, String?]?
+        metadata: ::Hash[Symbol, String?]?,
+        reference_id: String?
       }
 
     class NewPlanUnitWithProrationPrice < Orb::Internal::Type::BaseModel
@@ -56,6 +57,8 @@ module Orb
 
       attr_accessor metadata: ::Hash[Symbol, String?]?
 
+      attr_accessor reference_id: String?
+
       def initialize: (
         cadence: Orb::Models::NewPlanUnitWithProrationPrice::cadence,
         item_id: String,
@@ -73,7 +76,8 @@ module Orb
         ?fixed_price_quantity: Float?,
         ?invoice_grouping_key: String?,
         ?invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
-        ?metadata: ::Hash[Symbol, String?]?
+        ?metadata: ::Hash[Symbol, String?]?,
+        ?reference_id: String?
       ) -> void
 
       def to_hash: -> {
@@ -93,7 +97,8 @@ module Orb
         fixed_price_quantity: Float?,
         invoice_grouping_key: String?,
         invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
-        metadata: ::Hash[Symbol, String?]?
+        metadata: ::Hash[Symbol, String?]?,
+        reference_id: String?
       }
 
       type cadence =

data/sig/orb/models/plan_create_params.rbs

@@ -4,11 +4,13 @@ module Orb
       {
         currency: String,
         name: String,
-        prices: ::Array[Orb::Models::PlanCreateParams::price],
+        prices: ::Array[Orb::PlanCreateParams::Price],
+        adjustments: ::Array[Orb::PlanCreateParams::Adjustment]?,
         default_invoice_memo: String?,
         external_plan_id: String?,
         metadata: ::Hash[Symbol, String?]?,
         net_terms: Integer?,
+        plan_phases: ::Array[Orb::PlanCreateParams::PlanPhase]?,
         status: Orb::Models::PlanCreateParams::status
       }
       & Orb::Internal::Type::request_parameters
@@ -21,7 +23,9 @@ module Orb
 
       attr_accessor name: String
 
-      attr_accessor prices: ::Array[Orb::Models::PlanCreateParams::price]
+      attr_accessor prices: ::Array[Orb::PlanCreateParams::Price]
+
+      attr_accessor adjustments: ::Array[Orb::PlanCreateParams::Adjustment]?
 
       attr_accessor default_invoice_memo: String?
 
@@ -31,6 +35,8 @@ module Orb
 
       attr_accessor net_terms: Integer?
 
+      attr_accessor plan_phases: ::Array[Orb::PlanCreateParams::PlanPhase]?
+
       attr_reader status: Orb::Models::PlanCreateParams::status?
 
       def status=: (
@@ -40,11 +46,13 @@ module Orb
       def initialize: (
         currency: String,
         name: String,
-        prices: ::Array[Orb::Models::PlanCreateParams::price],
+        prices: ::Array[Orb::PlanCreateParams::Price],
+        ?adjustments: ::Array[Orb::PlanCreateParams::Adjustment]?,
         ?default_invoice_memo: String?,
         ?external_plan_id: String?,
         ?metadata: ::Hash[Symbol, String?]?,
         ?net_terms: Integer?,
+        ?plan_phases: ::Array[Orb::PlanCreateParams::PlanPhase]?,
         ?status: Orb::Models::PlanCreateParams::status,
         ?request_options: Orb::request_opts
       ) -> void
@@ -52,49 +60,160 @@ module Orb
       def to_hash: -> {
         currency: String,
         name: String,
-        prices: ::Array[Orb::Models::PlanCreateParams::price],
+        prices: ::Array[Orb::PlanCreateParams::Price],
+        adjustments: ::Array[Orb::PlanCreateParams::Adjustment]?,
         default_invoice_memo: String?,
         external_plan_id: String?,
         metadata: ::Hash[Symbol, String?]?,
         net_terms: Integer?,
+        plan_phases: ::Array[Orb::PlanCreateParams::PlanPhase]?,
         status: Orb::Models::PlanCreateParams::status,
         request_options: Orb::RequestOptions
       }
 
       type price =
-        Orb::NewPlanUnitPrice
-        | Orb::NewPlanPackagePrice
-        | Orb::NewPlanMatrixPrice
-        | Orb::NewPlanTieredPrice
-        | Orb::NewPlanTieredBPSPrice
-        | Orb::NewPlanBPSPrice
-        | Orb::NewPlanBulkBPSPrice
-        | Orb::NewPlanBulkPrice
-        | Orb::NewPlanThresholdTotalAmountPrice
-        | Orb::NewPlanTieredPackagePrice
-        | Orb::NewPlanTieredWithMinimumPrice
-        | Orb::NewPlanUnitWithPercentPrice
-        | Orb::NewPlanPackageWithAllocationPrice
-        | Orb::NewPlanTierWithProrationPrice
-        | Orb::NewPlanUnitWithProrationPrice
-        | Orb::NewPlanGroupedAllocationPrice
-        | Orb::NewPlanGroupedWithProratedMinimumPrice
-        | Orb::NewPlanGroupedWithMeteredMinimumPrice
-        | Orb::NewPlanMatrixWithDisplayNamePrice
-        | Orb::NewPlanBulkWithProrationPrice
-        | Orb::NewPlanGroupedTieredPackagePrice
-        | Orb::NewPlanMaxGroupTieredPackagePrice
-        | Orb::NewPlanScalableMatrixWithUnitPricingPrice
-        | Orb::NewPlanScalableMatrixWithTieredPricingPrice
-        | Orb::NewPlanCumulativeGroupedBulkPrice
-        | Orb::NewPlanTieredPackageWithMinimumPrice
-        | Orb::NewPlanMatrixWithAllocationPrice
-        | Orb::NewPlanGroupedTieredPrice
-
-      module Price
-        extend Orb::Internal::Type::Union
-
-        def self?.variants: -> ::Array[Orb::Models::PlanCreateParams::price]
+        {
+          allocation_price: Orb::NewAllocationPrice?,
+          plan_phase_order: Integer?,
+          price: Orb::Models::PlanCreateParams::Price::price?
+        }
+
+      class Price < Orb::Internal::Type::BaseModel
+        attr_accessor allocation_price: Orb::NewAllocationPrice?
+
+        attr_accessor plan_phase_order: Integer?
+
+        attr_accessor price: Orb::Models::PlanCreateParams::Price::price?
+
+        def initialize: (
+          ?allocation_price: Orb::NewAllocationPrice?,
+          ?plan_phase_order: Integer?,
+          ?price: Orb::Models::PlanCreateParams::Price::price?
+        ) -> void
+
+        def to_hash: -> {
+          allocation_price: Orb::NewAllocationPrice?,
+          plan_phase_order: Integer?,
+          price: Orb::Models::PlanCreateParams::Price::price?
+        }
+
+        type price =
+          Orb::NewPlanUnitPrice
+          | Orb::NewPlanPackagePrice
+          | Orb::NewPlanMatrixPrice
+          | Orb::NewPlanTieredPrice
+          | Orb::NewPlanTieredBPSPrice
+          | Orb::NewPlanBPSPrice
+          | Orb::NewPlanBulkBPSPrice
+          | Orb::NewPlanBulkPrice
+          | Orb::NewPlanThresholdTotalAmountPrice
+          | Orb::NewPlanTieredPackagePrice
+          | Orb::NewPlanTieredWithMinimumPrice
+          | Orb::NewPlanUnitWithPercentPrice
+          | Orb::NewPlanPackageWithAllocationPrice
+          | Orb::NewPlanTierWithProrationPrice
+          | Orb::NewPlanUnitWithProrationPrice
+          | Orb::NewPlanGroupedAllocationPrice
+          | Orb::NewPlanGroupedWithProratedMinimumPrice
+          | Orb::NewPlanGroupedWithMeteredMinimumPrice
+          | Orb::NewPlanMatrixWithDisplayNamePrice
+          | Orb::NewPlanBulkWithProrationPrice
+          | Orb::NewPlanGroupedTieredPackagePrice
+          | Orb::NewPlanMaxGroupTieredPackagePrice
+          | Orb::NewPlanScalableMatrixWithUnitPricingPrice
+          | Orb::NewPlanScalableMatrixWithTieredPricingPrice
+          | Orb::NewPlanCumulativeGroupedBulkPrice
+          | Orb::NewPlanTieredPackageWithMinimumPrice
+          | Orb::NewPlanMatrixWithAllocationPrice
+          | Orb::NewPlanGroupedTieredPrice
+
+        module Price
+          extend Orb::Internal::Type::Union
+
+          def self?.variants: -> ::Array[Orb::Models::PlanCreateParams::Price::price]
+        end
+      end
+
+      type adjustment =
+        {
+          adjustment: Orb::Models::PlanCreateParams::Adjustment::adjustment,
+          plan_phase_order: Integer?
+        }
+
+      class Adjustment < Orb::Internal::Type::BaseModel
+        attr_accessor adjustment: Orb::Models::PlanCreateParams::Adjustment::adjustment
+
+        attr_accessor plan_phase_order: Integer?
+
+        def initialize: (
+          adjustment: Orb::Models::PlanCreateParams::Adjustment::adjustment,
+          ?plan_phase_order: Integer?
+        ) -> void
+
+        def to_hash: -> {
+          adjustment: Orb::Models::PlanCreateParams::Adjustment::adjustment,
+          plan_phase_order: Integer?
+        }
+
+        type adjustment =
+          Orb::NewPercentageDiscount
+          | Orb::NewUsageDiscount
+          | Orb::NewAmountDiscount
+          | Orb::NewMinimum
+          | Orb::NewMaximum
+
+        module Adjustment
+          extend Orb::Internal::Type::Union
+
+          def self?.variants: -> ::Array[Orb::Models::PlanCreateParams::Adjustment::adjustment]
+        end
+      end
+
+      type plan_phase =
+        {
+          order: Integer,
+          align_billing_with_phase_start_date: bool?,
+          duration: Integer?,
+          duration_unit: Orb::Models::PlanCreateParams::PlanPhase::duration_unit?
+        }
+
+      class PlanPhase < Orb::Internal::Type::BaseModel
+        attr_accessor order: Integer
+
+        attr_accessor align_billing_with_phase_start_date: bool?
+
+        attr_accessor duration: Integer?
+
+        attr_accessor duration_unit: Orb::Models::PlanCreateParams::PlanPhase::duration_unit?
+
+        def initialize: (
+          order: Integer,
+          ?align_billing_with_phase_start_date: bool?,
+          ?duration: Integer?,
+          ?duration_unit: Orb::Models::PlanCreateParams::PlanPhase::duration_unit?
+        ) -> void
+
+        def to_hash: -> {
+          order: Integer,
+          align_billing_with_phase_start_date: bool?,
+          duration: Integer?,
+          duration_unit: Orb::Models::PlanCreateParams::PlanPhase::duration_unit?
+        }
+
+        type duration_unit =
+          :daily | :monthly | :quarterly | :semi_annual | :annual
+
+        module DurationUnit
+          extend Orb::Internal::Type::Enum
+
+          DAILY: :daily
+          MONTHLY: :monthly
+          QUARTERLY: :quarterly
+          SEMI_ANNUAL: :semi_annual
+          ANNUAL: :annual
+
+          def self?.values: -> ::Array[Orb::Models::PlanCreateParams::PlanPhase::duration_unit]
+        end
       end
 
       type status = :active | :draft

data/sig/orb/models/plan_phase_amount_discount_adjustment.rbs

@@ -9,7 +9,8 @@ module Orb
         filters: ::Array[Orb::TransformPriceFilter],
         is_invoice_level: bool,
         plan_phase_order: Integer?,
-        reason: String?
+        reason: String?,
+        replaces_adjustment_id: String?
       }
 
     class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
@@ -29,6 +30,8 @@ module Orb
 
       attr_accessor reason: String?
 
+      attr_accessor replaces_adjustment_id: String?
+
       def initialize: (
         id: String,
         adjustment_type: Orb::Models::PlanPhaseAmountDiscountAdjustment::adjustment_type,
@@ -37,7 +40,8 @@ module Orb
         filters: ::Array[Orb::TransformPriceFilter],
         is_invoice_level: bool,
         plan_phase_order: Integer?,
-        reason: String?
+        reason: String?,
+        replaces_adjustment_id: String?
       ) -> void
 
       def to_hash: -> {
@@ -48,7 +52,8 @@ module Orb
         filters: ::Array[Orb::TransformPriceFilter],
         is_invoice_level: bool,
         plan_phase_order: Integer?,
-        reason: String?
+        reason: String?,
+        replaces_adjustment_id: String?
       }
 
       type adjustment_type = :amount_discount

data/sig/orb/models/plan_phase_maximum_adjustment.rbs

@@ -9,7 +9,8 @@ module Orb
         is_invoice_level: bool,
         maximum_amount: String,
         plan_phase_order: Integer?,
-        reason: String?
+        reason: String?,
+        replaces_adjustment_id: String?
       }
 
     class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel
@@ -29,6 +30,8 @@ module Orb
 
       attr_accessor reason: String?
 
+      attr_accessor replaces_adjustment_id: String?
+
       def initialize: (
         id: String,
         adjustment_type: Orb::Models::PlanPhaseMaximumAdjustment::adjustment_type,
@@ -37,7 +40,8 @@ module Orb
         is_invoice_level: bool,
         maximum_amount: String,
         plan_phase_order: Integer?,
-        reason: String?
+        reason: String?,
+        replaces_adjustment_id: String?
       ) -> void
 
       def to_hash: -> {
@@ -48,7 +52,8 @@ module Orb
         is_invoice_level: bool,
         maximum_amount: String,
         plan_phase_order: Integer?,
-        reason: String?
+        reason: String?,
+        replaces_adjustment_id: String?
       }
 
       type adjustment_type = :maximum

data/sig/orb/models/plan_phase_minimum_adjustment.rbs

@@ -10,7 +10,8 @@ module Orb
         item_id: String,
         minimum_amount: String,
         plan_phase_order: Integer?,
-        reason: String?
+        reason: String?,
+        replaces_adjustment_id: String?
       }
 
     class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel
@@ -32,6 +33,8 @@ module Orb
 
       attr_accessor reason: String?
 
+      attr_accessor replaces_adjustment_id: String?
+
       def initialize: (
         id: String,
         adjustment_type: Orb::Models::PlanPhaseMinimumAdjustment::adjustment_type,
@@ -41,7 +44,8 @@ module Orb
         item_id: String,
         minimum_amount: String,
         plan_phase_order: Integer?,
-        reason: String?
+        reason: String?,
+        replaces_adjustment_id: String?
       ) -> void
 
       def to_hash: -> {
@@ -53,7 +57,8 @@ module Orb
         item_id: String,
         minimum_amount: String,
         plan_phase_order: Integer?,
-        reason: String?
+        reason: String?,
+        replaces_adjustment_id: String?
       }
 
       type adjustment_type = :minimum

data/sig/orb/models/plan_phase_percentage_discount_adjustment.rbs

@@ -9,7 +9,8 @@ module Orb
         is_invoice_level: bool,
         percentage_discount: Float,
         plan_phase_order: Integer?,
-        reason: String?
+        reason: String?,
+        replaces_adjustment_id: String?
       }
 
     class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
@@ -29,6 +30,8 @@ module Orb
 
       attr_accessor reason: String?
 
+      attr_accessor replaces_adjustment_id: String?
+
       def initialize: (
         id: String,
         adjustment_type: Orb::Models::PlanPhasePercentageDiscountAdjustment::adjustment_type,
@@ -37,7 +40,8 @@ module Orb
         is_invoice_level: bool,
         percentage_discount: Float,
         plan_phase_order: Integer?,
-        reason: String?
+        reason: String?,
+        replaces_adjustment_id: String?
       ) -> void
 
       def to_hash: -> {
@@ -48,7 +52,8 @@ module Orb
         is_invoice_level: bool,
         percentage_discount: Float,
         plan_phase_order: Integer?,
-        reason: String?
+        reason: String?,
+        replaces_adjustment_id: String?
       }
 
       type adjustment_type = :percentage_discount

data/sig/orb/models/plan_phase_usage_discount_adjustment.rbs

@@ -9,6 +9,7 @@ module Orb
         is_invoice_level: bool,
         plan_phase_order: Integer?,
         reason: String?,
+        replaces_adjustment_id: String?,
         usage_discount: Float
       }
 
@@ -27,6 +28,8 @@ module Orb
 
       attr_accessor reason: String?
 
+      attr_accessor replaces_adjustment_id: String?
+
       attr_accessor usage_discount: Float
 
       def initialize: (
@@ -37,6 +40,7 @@ module Orb
         is_invoice_level: bool,
         plan_phase_order: Integer?,
         reason: String?,
+        replaces_adjustment_id: String?,
         usage_discount: Float
       ) -> void
 
@@ -48,6 +52,7 @@ module Orb
         is_invoice_level: bool,
         plan_phase_order: Integer?,
         reason: String?,
+        replaces_adjustment_id: String?,
         usage_discount: Float
       }