orb-billing 0.12.0 → 1.0.0

data/lib/orb/models/invoice_tiny.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class InvoiceTiny < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #   The Invoice id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:)
+      #   @param id [String] The Invoice id
+    end
+  end
+end

data/lib/orb/models/item_slim.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class ItemSlim < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!method initialize(id:, name:)
+      #   @param id [String]
+      #   @param name [String]
+    end
+  end
+end

data/lib/orb/models/matrix_config.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class MatrixConfig < Orb::Internal::Type::BaseModel
+      # @!attribute default_unit_amount
+      #   Default per unit rate for any usage not bucketed into a specified matrix_value
+      #
+      #   @return [String]
+      required :default_unit_amount, String
+
+      # @!attribute dimensions
+      #   One or two event property values to evaluate matrix groups by
+      #
+      #   @return [Array<String, nil>]
+      required :dimensions, Orb::Internal::Type::ArrayOf[String, nil?: true]
+
+      # @!attribute matrix_values
+      #   Matrix values for specified matrix grouping keys
+      #
+      #   @return [Array<Orb::Models::MatrixValue>]
+      required :matrix_values, -> { Orb::Internal::Type::ArrayOf[Orb::MatrixValue] }
+
+      # @!method initialize(default_unit_amount:, dimensions:, matrix_values:)
+      #   @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value
+      #
+      #   @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 for specified matrix grouping keys
+    end
+  end
+end

data/lib/orb/models/matrix_sub_line_item.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class MatrixSubLineItem < Orb::Internal::Type::BaseModel
+      # @!attribute amount
+      #   The total amount for this sub line item.
+      #
+      #   @return [String]
+      required :amount, String
+
+      # @!attribute grouping
+      #
+      #   @return [Orb::Models::SubLineItemGrouping, nil]
+      required :grouping, -> { Orb::SubLineItemGrouping }, nil?: true
+
+      # @!attribute matrix_config
+      #
+      #   @return [Orb::Models::SubLineItemMatrixConfig]
+      required :matrix_config, -> { Orb::SubLineItemMatrixConfig }
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute quantity
+      #
+      #   @return [Float]
+      required :quantity, Float
+
+      # @!attribute type
+      #
+      #   @return [Symbol, Orb::Models::MatrixSubLineItem::Type]
+      required :type, enum: -> { Orb::MatrixSubLineItem::Type }
+
+      # @!method initialize(amount:, grouping:, matrix_config:, name:, quantity:, type:)
+      #   @param amount [String] The total amount for this sub line item.
+      #
+      #   @param grouping [Orb::Models::SubLineItemGrouping, nil]
+      #
+      #   @param matrix_config [Orb::Models::SubLineItemMatrixConfig]
+      #
+      #   @param name [String]
+      #
+      #   @param quantity [Float]
+      #
+      #   @param type [Symbol, Orb::Models::MatrixSubLineItem::Type]
+
+      # @see Orb::Models::MatrixSubLineItem#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        MATRIX = :matrix
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/matrix_value.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class MatrixValue < Orb::Internal::Type::BaseModel
+      # @!attribute dimension_values
+      #   One or two matrix keys to filter usage to this Matrix value by. For example,
+      #   ["region", "tier"] could be used to filter cloud usage by a cloud region and an
+      #   instance tier.
+      #
+      #   @return [Array<String, nil>]
+      required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true]
+
+      # @!attribute unit_amount
+      #   Unit price for the specified dimension_values
+      #
+      #   @return [String]
+      required :unit_amount, String
+
+      # @!method initialize(dimension_values:, unit_amount:)
+      #   Some parameter documentations has been truncated, see {Orb::Models::MatrixValue}
+      #   for more details.
+      #
+      #   @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
+    end
+  end
+end

data/lib/orb/models/matrix_with_allocation_config.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class MatrixWithAllocationConfig < Orb::Internal::Type::BaseModel
+      # @!attribute allocation
+      #   Allocation to be used to calculate the price
+      #
+      #   @return [Float]
+      required :allocation, Float
+
+      # @!attribute default_unit_amount
+      #   Default per unit rate for any usage not bucketed into a specified matrix_value
+      #
+      #   @return [String]
+      required :default_unit_amount, String
+
+      # @!attribute dimensions
+      #   One or two event property values to evaluate matrix groups by
+      #
+      #   @return [Array<String, nil>]
+      required :dimensions, Orb::Internal::Type::ArrayOf[String, nil?: true]
+
+      # @!attribute matrix_values
+      #   Matrix values for specified matrix grouping keys
+      #
+      #   @return [Array<Orb::Models::MatrixValue>]
+      required :matrix_values, -> { Orb::Internal::Type::ArrayOf[Orb::MatrixValue] }
+
+      # @!method initialize(allocation:, default_unit_amount:, dimensions:, matrix_values:)
+      #   @param allocation [Float] Allocation to be used to calculate the price
+      #
+      #   @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value
+      #
+      #   @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 for specified matrix grouping keys
+    end
+  end
+end

data/lib/orb/models/maximum.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class Maximum < Orb::Internal::Type::BaseModel
+      # @!attribute applies_to_price_ids
+      #   @deprecated
+      #
+      #   List of price_ids that this maximum amount applies to. For plan/plan phase
+      #   maximums, this can be a subset of prices.
+      #
+      #   @return [Array<String>]
+      required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
+
+      # @!attribute filters
+      #   The filters that determine which prices to apply this maximum to.
+      #
+      #   @return [Array<Orb::Models::TransformPriceFilter>]
+      required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::TransformPriceFilter] }
+
+      # @!attribute maximum_amount
+      #   Maximum amount applied
+      #
+      #   @return [String]
+      required :maximum_amount, String
+
+      # @!method initialize(applies_to_price_ids:, filters:, maximum_amount:)
+      #   Some parameter documentations has been truncated, see {Orb::Models::Maximum} for
+      #   more details.
+      #
+      #   @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
+      #
+      #   @param filters [Array<Orb::Models::TransformPriceFilter>] The filters that determine which prices to apply this maximum to.
+      #
+      #   @param maximum_amount [String] Maximum amount applied
+    end
+  end
+end

data/lib/orb/models/maximum_interval.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class MaximumInterval < Orb::Internal::Type::BaseModel
+      # @!attribute applies_to_price_interval_ids
+      #   The price interval ids that this maximum interval applies to.
+      #
+      #   @return [Array<String>]
+      required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String]
+
+      # @!attribute end_date
+      #   The end date of the maximum interval.
+      #
+      #   @return [Time, nil]
+      required :end_date, Time, nil?: true
+
+      # @!attribute filters
+      #   The filters that determine which prices this maximum interval applies to.
+      #
+      #   @return [Array<Orb::Models::TransformPriceFilter>]
+      required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::TransformPriceFilter] }
+
+      # @!attribute maximum_amount
+      #   The maximum amount to charge in a given billing period for the price intervals
+      #   this transform applies to.
+      #
+      #   @return [String]
+      required :maximum_amount, String
+
+      # @!attribute start_date
+      #   The start date of the maximum interval.
+      #
+      #   @return [Time]
+      required :start_date, Time
+
+      # @!method initialize(applies_to_price_interval_ids:, end_date:, filters:, maximum_amount:, start_date:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::MaximumInterval} for more details.
+      #
+      #   @param applies_to_price_interval_ids [Array<String>] The price interval ids that this maximum interval applies to.
+      #
+      #   @param end_date [Time, nil] The end date of the maximum interval.
+      #
+      #   @param filters [Array<Orb::Models::TransformPriceFilter>] The filters that determine which prices this maximum interval applies to.
+      #
+      #   @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t
+      #
+      #   @param start_date [Time] The start date of the maximum interval.
+    end
+  end
+end

data/lib/orb/models/minimum.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class Minimum < Orb::Internal::Type::BaseModel
+      # @!attribute applies_to_price_ids
+      #   @deprecated
+      #
+      #   List of price_ids that this minimum amount applies to. For plan/plan phase
+      #   minimums, this can be a subset of prices.
+      #
+      #   @return [Array<String>]
+      required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
+
+      # @!attribute filters
+      #   The filters that determine which prices to apply this minimum to.
+      #
+      #   @return [Array<Orb::Models::TransformPriceFilter>]
+      required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::TransformPriceFilter] }
+
+      # @!attribute minimum_amount
+      #   Minimum amount applied
+      #
+      #   @return [String]
+      required :minimum_amount, String
+
+      # @!method initialize(applies_to_price_ids:, filters:, minimum_amount:)
+      #   Some parameter documentations has been truncated, see {Orb::Models::Minimum} for
+      #   more details.
+      #
+      #   @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
+      #
+      #   @param filters [Array<Orb::Models::TransformPriceFilter>] The filters that determine which prices to apply this minimum to.
+      #
+      #   @param minimum_amount [String] Minimum amount applied
+    end
+  end
+end

data/lib/orb/models/minimum_interval.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class MinimumInterval < Orb::Internal::Type::BaseModel
+      # @!attribute applies_to_price_interval_ids
+      #   The price interval ids that this minimum interval applies to.
+      #
+      #   @return [Array<String>]
+      required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String]
+
+      # @!attribute end_date
+      #   The end date of the minimum interval.
+      #
+      #   @return [Time, nil]
+      required :end_date, Time, nil?: true
+
+      # @!attribute filters
+      #   The filters that determine which prices this minimum interval applies to.
+      #
+      #   @return [Array<Orb::Models::TransformPriceFilter>]
+      required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::TransformPriceFilter] }
+
+      # @!attribute minimum_amount
+      #   The minimum amount to charge in a given billing period for the price intervals
+      #   this minimum applies to.
+      #
+      #   @return [String]
+      required :minimum_amount, String
+
+      # @!attribute start_date
+      #   The start date of the minimum interval.
+      #
+      #   @return [Time]
+      required :start_date, Time
+
+      # @!method initialize(applies_to_price_interval_ids:, end_date:, filters:, minimum_amount:, start_date:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::MinimumInterval} for more details.
+      #
+      #   @param applies_to_price_interval_ids [Array<String>] The price interval ids that this minimum interval applies to.
+      #
+      #   @param end_date [Time, nil] The end date of the minimum interval.
+      #
+      #   @param filters [Array<Orb::Models::TransformPriceFilter>] The filters that determine which prices this minimum interval applies to.
+      #
+      #   @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t
+      #
+      #   @param start_date [Time] The start date of the minimum interval.
+    end
+  end
+end

data/lib/orb/models/monetary_amount_discount_adjustment.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class MonetaryAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute adjustment_type
+      #
+      #   @return [Symbol, Orb::Models::MonetaryAmountDiscountAdjustment::AdjustmentType]
+      required :adjustment_type, enum: -> { Orb::MonetaryAmountDiscountAdjustment::AdjustmentType }
+
+      # @!attribute amount
+      #   The value applied by an adjustment.
+      #
+      #   @return [String]
+      required :amount, String
+
+      # @!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 reason
+      #   The reason for the adjustment.
+      #
+      #   @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:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::MonetaryAmountDiscountAdjustment} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param adjustment_type [Symbol, Orb::Models::MonetaryAmountDiscountAdjustment::AdjustmentType]
+      #
+      #   @param amount [String] The value applied by an adjustment.
+      #
+      #   @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 reason [String, nil] The reason for the adjustment.
+
+      # @see Orb::Models::MonetaryAmountDiscountAdjustment#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/monetary_maximum_adjustment.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class MonetaryMaximumAdjustment < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute adjustment_type
+      #
+      #   @return [Symbol, Orb::Models::MonetaryMaximumAdjustment::AdjustmentType]
+      required :adjustment_type, enum: -> { Orb::MonetaryMaximumAdjustment::AdjustmentType }
+
+      # @!attribute amount
+      #   The value applied by an adjustment.
+      #
+      #   @return [String]
+      required :amount, 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 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 reason
+      #   The reason for the adjustment.
+      #
+      #   @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:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::MonetaryMaximumAdjustment} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param adjustment_type [Symbol, Orb::Models::MonetaryMaximumAdjustment::AdjustmentType]
+      #
+      #   @param amount [String] The value applied by an adjustment.
+      #
+      #   @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 reason [String, nil] The reason for the adjustment.
+
+      # @see Orb::Models::MonetaryMaximumAdjustment#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/monetary_minimum_adjustment.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class MonetaryMinimumAdjustment < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute adjustment_type
+      #
+      #   @return [Symbol, Orb::Models::MonetaryMinimumAdjustment::AdjustmentType]
+      required :adjustment_type, enum: -> { Orb::MonetaryMinimumAdjustment::AdjustmentType }
+
+      # @!attribute amount
+      #   The value applied by an adjustment.
+      #
+      #   @return [String]
+      required :amount, 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 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 reason
+      #   The reason for the adjustment.
+      #
+      #   @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:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::MonetaryMinimumAdjustment} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param adjustment_type [Symbol, Orb::Models::MonetaryMinimumAdjustment::AdjustmentType]
+      #
+      #   @param amount [String] The value applied by an adjustment.
+      #
+      #   @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 reason [String, nil] The reason for the adjustment.
+
+      # @see Orb::Models::MonetaryMinimumAdjustment#adjustment_type
+      module AdjustmentType
+        extend Orb::Internal::Type::Enum
+
+        MINIMUM = :minimum
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end