orb-billing 0.12.0 → 1.0.0

data/lib/orb/models/plan_phase_amount_discount_adjustment.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute adjustment_type
+      #
+      #   @return [Symbol, Orb::Models::PlanPhaseAmountDiscountAdjustment::AdjustmentType]
+      required :adjustment_type, enum: -> { Orb::PlanPhaseAmountDiscountAdjustment::AdjustmentType }
+
+      # @!attribute amount_discount
+      #   The amount by which to discount the prices this adjustment applies to in a given
+      #   billing period.
+      #
+      #   @return [String]
+      required :amount_discount, String
+
+      # @!attribute applies_to_price_ids
+      #   @deprecated
+      #
+      #   The price IDs that this adjustment applies to.
+      #
+      #   @return [Array<String>]
+      required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
+
+      # @!attribute filters
+      #   The filters that determine which prices to apply this adjustment to.
+      #
+      #   @return [Array<Orb::Models::TransformPriceFilter>]
+      required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::TransformPriceFilter] }
+
+      # @!attribute is_invoice_level
+      #   True for adjustments that apply to an entire invocice, false for adjustments
+      #   that apply to only one price.
+      #
+      #   @return [Boolean]
+      required :is_invoice_level, Orb::Internal::Type::Boolean
+
+      # @!attribute plan_phase_order
+      #   The plan phase in which this adjustment is active.
+      #
+      #   @return [Integer, nil]
+      required :plan_phase_order, Integer, nil?: true
+
+      # @!attribute reason
+      #   The reason for the adjustment.
+      #
+      #   @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:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::PlanPhaseAmountDiscountAdjustment} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param adjustment_type [Symbol, Orb::Models::PlanPhaseAmountDiscountAdjustment::AdjustmentType]
+      #
+      #   @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
+      #
+      #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
+      #
+      #   @param filters [Array<Orb::Models::TransformPriceFilter>] The filters that determine which prices to apply this adjustment to.
+      #
+      #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
+      #
+      #   @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
+      #
+      #   @param reason [String, nil] The reason for the adjustment.
+
+      # @see Orb::Models::PlanPhaseAmountDiscountAdjustment#adjustment_type
+      module AdjustmentType
+        extend Orb::Internal::Type::Enum
+
+        AMOUNT_DISCOUNT = :amount_discount
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/plan_phase_maximum_adjustment.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute adjustment_type
+      #
+      #   @return [Symbol, Orb::Models::PlanPhaseMaximumAdjustment::AdjustmentType]
+      required :adjustment_type, enum: -> { Orb::PlanPhaseMaximumAdjustment::AdjustmentType }
+
+      # @!attribute applies_to_price_ids
+      #   @deprecated
+      #
+      #   The price IDs that this adjustment applies to.
+      #
+      #   @return [Array<String>]
+      required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
+
+      # @!attribute filters
+      #   The filters that determine which prices to apply this adjustment to.
+      #
+      #   @return [Array<Orb::Models::TransformPriceFilter>]
+      required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::TransformPriceFilter] }
+
+      # @!attribute is_invoice_level
+      #   True for adjustments that apply to an entire invocice, false for adjustments
+      #   that apply to only one price.
+      #
+      #   @return [Boolean]
+      required :is_invoice_level, Orb::Internal::Type::Boolean
+
+      # @!attribute maximum_amount
+      #   The maximum amount to charge in a given billing period for the prices this
+      #   adjustment applies to.
+      #
+      #   @return [String]
+      required :maximum_amount, String
+
+      # @!attribute plan_phase_order
+      #   The plan phase in which this adjustment is active.
+      #
+      #   @return [Integer, nil]
+      required :plan_phase_order, Integer, nil?: true
+
+      # @!attribute reason
+      #   The reason for the adjustment.
+      #
+      #   @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:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::PlanPhaseMaximumAdjustment} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param adjustment_type [Symbol, Orb::Models::PlanPhaseMaximumAdjustment::AdjustmentType]
+      #
+      #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
+      #
+      #   @param filters [Array<Orb::Models::TransformPriceFilter>] The filters that determine which prices to apply this adjustment to.
+      #
+      #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
+      #
+      #   @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
+      #
+      #   @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
+      #
+      #   @param reason [String, nil] The reason for the adjustment.
+
+      # @see Orb::Models::PlanPhaseMaximumAdjustment#adjustment_type
+      module AdjustmentType
+        extend Orb::Internal::Type::Enum
+
+        MAXIMUM = :maximum
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/plan_phase_minimum_adjustment.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute adjustment_type
+      #
+      #   @return [Symbol, Orb::Models::PlanPhaseMinimumAdjustment::AdjustmentType]
+      required :adjustment_type, enum: -> { Orb::PlanPhaseMinimumAdjustment::AdjustmentType }
+
+      # @!attribute applies_to_price_ids
+      #   @deprecated
+      #
+      #   The price IDs that this adjustment applies to.
+      #
+      #   @return [Array<String>]
+      required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
+
+      # @!attribute filters
+      #   The filters that determine which prices to apply this adjustment to.
+      #
+      #   @return [Array<Orb::Models::TransformPriceFilter>]
+      required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::TransformPriceFilter] }
+
+      # @!attribute is_invoice_level
+      #   True for adjustments that apply to an entire invocice, false for adjustments
+      #   that apply to only one price.
+      #
+      #   @return [Boolean]
+      required :is_invoice_level, Orb::Internal::Type::Boolean
+
+      # @!attribute item_id
+      #   The item ID that revenue from this minimum will be attributed to.
+      #
+      #   @return [String]
+      required :item_id, String
+
+      # @!attribute minimum_amount
+      #   The minimum amount to charge in a given billing period for the prices this
+      #   adjustment applies to.
+      #
+      #   @return [String]
+      required :minimum_amount, String
+
+      # @!attribute plan_phase_order
+      #   The plan phase in which this adjustment is active.
+      #
+      #   @return [Integer, nil]
+      required :plan_phase_order, Integer, nil?: true
+
+      # @!attribute reason
+      #   The reason for the adjustment.
+      #
+      #   @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:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::PlanPhaseMinimumAdjustment} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param adjustment_type [Symbol, Orb::Models::PlanPhaseMinimumAdjustment::AdjustmentType]
+      #
+      #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
+      #
+      #   @param filters [Array<Orb::Models::TransformPriceFilter>] The filters that determine which prices to apply this adjustment to.
+      #
+      #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
+      #
+      #   @param item_id [String] The item ID that revenue from this minimum will be attributed to.
+      #
+      #   @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
+      #
+      #   @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
+      #
+      #   @param reason [String, nil] The reason for the adjustment.
+
+      # @see Orb::Models::PlanPhaseMinimumAdjustment#adjustment_type
+      module AdjustmentType
+        extend Orb::Internal::Type::Enum
+
+        MINIMUM = :minimum
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/plan_phase_percentage_discount_adjustment.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute adjustment_type
+      #
+      #   @return [Symbol, Orb::Models::PlanPhasePercentageDiscountAdjustment::AdjustmentType]
+      required :adjustment_type, enum: -> { Orb::PlanPhasePercentageDiscountAdjustment::AdjustmentType }
+
+      # @!attribute applies_to_price_ids
+      #   @deprecated
+      #
+      #   The price IDs that this adjustment applies to.
+      #
+      #   @return [Array<String>]
+      required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
+
+      # @!attribute filters
+      #   The filters that determine which prices to apply this adjustment to.
+      #
+      #   @return [Array<Orb::Models::TransformPriceFilter>]
+      required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::TransformPriceFilter] }
+
+      # @!attribute is_invoice_level
+      #   True for adjustments that apply to an entire invocice, false for adjustments
+      #   that apply to only one price.
+      #
+      #   @return [Boolean]
+      required :is_invoice_level, Orb::Internal::Type::Boolean
+
+      # @!attribute percentage_discount
+      #   The percentage (as a value between 0 and 1) by which to discount the price
+      #   intervals this adjustment applies to in a given billing period.
+      #
+      #   @return [Float]
+      required :percentage_discount, Float
+
+      # @!attribute plan_phase_order
+      #   The plan phase in which this adjustment is active.
+      #
+      #   @return [Integer, nil]
+      required :plan_phase_order, Integer, nil?: true
+
+      # @!attribute reason
+      #   The reason for the adjustment.
+      #
+      #   @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:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::PlanPhasePercentageDiscountAdjustment} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param adjustment_type [Symbol, Orb::Models::PlanPhasePercentageDiscountAdjustment::AdjustmentType]
+      #
+      #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
+      #
+      #   @param filters [Array<Orb::Models::TransformPriceFilter>] The filters that determine which prices to apply this adjustment to.
+      #
+      #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
+      #
+      #   @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
+      #
+      #   @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
+      #
+      #   @param reason [String, nil] The reason for the adjustment.
+
+      # @see Orb::Models::PlanPhasePercentageDiscountAdjustment#adjustment_type
+      module AdjustmentType
+        extend Orb::Internal::Type::Enum
+
+        PERCENTAGE_DISCOUNT = :percentage_discount
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/plan_phase_usage_discount_adjustment.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute adjustment_type
+      #
+      #   @return [Symbol, Orb::Models::PlanPhaseUsageDiscountAdjustment::AdjustmentType]
+      required :adjustment_type, enum: -> { Orb::PlanPhaseUsageDiscountAdjustment::AdjustmentType }
+
+      # @!attribute applies_to_price_ids
+      #   @deprecated
+      #
+      #   The price IDs that this adjustment applies to.
+      #
+      #   @return [Array<String>]
+      required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
+
+      # @!attribute filters
+      #   The filters that determine which prices to apply this adjustment to.
+      #
+      #   @return [Array<Orb::Models::TransformPriceFilter>]
+      required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::TransformPriceFilter] }
+
+      # @!attribute is_invoice_level
+      #   True for adjustments that apply to an entire invocice, false for adjustments
+      #   that apply to only one price.
+      #
+      #   @return [Boolean]
+      required :is_invoice_level, Orb::Internal::Type::Boolean
+
+      # @!attribute plan_phase_order
+      #   The plan phase in which this adjustment is active.
+      #
+      #   @return [Integer, nil]
+      required :plan_phase_order, Integer, nil?: true
+
+      # @!attribute reason
+      #   The reason for the adjustment.
+      #
+      #   @return [String, nil]
+      required :reason, 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.
+      #
+      #   @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:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::PlanPhaseUsageDiscountAdjustment} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param adjustment_type [Symbol, Orb::Models::PlanPhaseUsageDiscountAdjustment::AdjustmentType]
+      #
+      #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
+      #
+      #   @param filters [Array<Orb::Models::TransformPriceFilter>] The filters that determine which prices to apply this adjustment to.
+      #
+      #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
+      #
+      #   @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 usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
+
+      # @see Orb::Models::PlanPhaseUsageDiscountAdjustment#adjustment_type
+      module AdjustmentType
+        extend Orb::Internal::Type::Enum
+
+        USAGE_DISCOUNT = :usage_discount
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end