orb-billing 0.12.0 → 1.0.0

data/lib/orb/models/new_usage_discount.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class NewUsageDiscount < Orb::Internal::Type::BaseModel
+      # @!attribute adjustment_type
+      #
+      #   @return [Symbol, Orb::Models::NewUsageDiscount::AdjustmentType]
+      required :adjustment_type, enum: -> { Orb::NewUsageDiscount::AdjustmentType }
+
+      # @!attribute usage_discount
+      #
+      #   @return [Float]
+      required :usage_discount, Float
+
+      # @!attribute applies_to_all
+      #   If set, the adjustment will apply to every price on the subscription.
+      #
+      #   @return [Boolean, Orb::Models::NewUsageDiscount::AppliesToAll, nil]
+      optional :applies_to_all, enum: -> { Orb::NewUsageDiscount::AppliesToAll }, nil?: true
+
+      # @!attribute applies_to_item_ids
+      #   The set of item IDs to which this adjustment applies.
+      #
+      #   @return [Array<String>, nil]
+      optional :applies_to_item_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute applies_to_price_ids
+      #   The set of price IDs to which this adjustment applies.
+      #
+      #   @return [Array<String>, nil]
+      optional :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute currency
+      #   If set, only prices in the specified currency will have the adjustment applied.
+      #
+      #   @return [String, nil]
+      optional :currency, String, nil?: true
+
+      # @!attribute filters
+      #   A list of filters that determine which prices this adjustment will apply to.
+      #
+      #   @return [Array<Orb::Models::TransformPriceFilter>, nil]
+      optional :filters, -> { Orb::Internal::Type::ArrayOf[Orb::TransformPriceFilter] }, nil?: true
+
+      # @!attribute is_invoice_level
+      #   When false, this adjustment will be applied to a single price. Otherwise, it
+      #   will be applied at the invoice level, possibly to multiple prices.
+      #
+      #   @return [Boolean, nil]
+      optional :is_invoice_level, Orb::Internal::Type::Boolean
+
+      # @!attribute price_type
+      #   If set, only prices of the specified type will have the adjustment applied.
+      #
+      #   @return [Symbol, Orb::Models::NewUsageDiscount::PriceType, nil]
+      optional :price_type, enum: -> { Orb::NewUsageDiscount::PriceType }, nil?: true
+
+      # @!method initialize(adjustment_type:, usage_discount:, applies_to_all: nil, applies_to_item_ids: nil, applies_to_price_ids: nil, currency: nil, filters: nil, is_invoice_level: nil, price_type: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::NewUsageDiscount} for more details.
+      #
+      #   @param adjustment_type [Symbol, Orb::Models::NewUsageDiscount::AdjustmentType]
+      #
+      #   @param usage_discount [Float]
+      #
+      #   @param applies_to_all [Boolean, Orb::Models::NewUsageDiscount::AppliesToAll, nil] If set, the adjustment will apply to every price on the subscription.
+      #
+      #   @param applies_to_item_ids [Array<String>, nil] The set of item IDs to which this adjustment applies.
+      #
+      #   @param applies_to_price_ids [Array<String>, nil] The set of price IDs to which this adjustment applies.
+      #
+      #   @param currency [String, nil] If set, only prices in the specified currency will have the adjustment applied.
+      #
+      #   @param filters [Array<Orb::Models::TransformPriceFilter>, nil] A list of filters that determine which prices this adjustment will apply to.
+      #
+      #   @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil
+      #
+      #   @param price_type [Symbol, Orb::Models::NewUsageDiscount::PriceType, nil] If set, only prices of the specified type will have the adjustment applied.
+
+      # @see Orb::Models::NewUsageDiscount#adjustment_type
+      module AdjustmentType
+        extend Orb::Internal::Type::Enum
+
+        USAGE_DISCOUNT = :usage_discount
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # If set, the adjustment will apply to every price on the subscription.
+      #
+      # @see Orb::Models::NewUsageDiscount#applies_to_all
+      module AppliesToAll
+        extend Orb::Internal::Type::Enum
+
+        TRUE = true
+
+        # @!method self.values
+        #   @return [Array<Boolean>]
+      end
+
+      # If set, only prices of the specified type will have the adjustment applied.
+      #
+      # @see Orb::Models::NewUsageDiscount#price_type
+      module PriceType
+        extend Orb::Internal::Type::Enum
+
+        USAGE = :usage
+        FIXED_IN_ADVANCE = :fixed_in_advance
+        FIXED_IN_ARREARS = :fixed_in_arrears
+        FIXED = :fixed
+        IN_ARREARS = :in_arrears
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/other_sub_line_item.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class OtherSubLineItem < 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 name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute quantity
+      #
+      #   @return [Float]
+      required :quantity, Float
+
+      # @!attribute type
+      #
+      #   @return [Symbol, Orb::Models::OtherSubLineItem::Type]
+      required :type, enum: -> { Orb::OtherSubLineItem::Type }
+
+      # @!method initialize(amount:, grouping:, name:, quantity:, type:)
+      #   @param amount [String] The total amount for this sub line item.
+      #
+      #   @param grouping [Orb::Models::SubLineItemGrouping, nil]
+      #
+      #   @param name [String]
+      #
+      #   @param quantity [Float]
+      #
+      #   @param type [Symbol, Orb::Models::OtherSubLineItem::Type]
+
+      # @see Orb::Models::OtherSubLineItem#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        NULL = :"'null'"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/package_config.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class PackageConfig < Orb::Internal::Type::BaseModel
+      # @!attribute package_amount
+      #   A currency amount to rate usage by
+      #
+      #   @return [String]
+      required :package_amount, String
+
+      # @!attribute package_size
+      #   An integer amount to represent package size. For example, 1000 here would divide
+      #   usage by 1000 before multiplying by package_amount in rating
+      #
+      #   @return [Integer]
+      required :package_size, Integer
+
+      # @!method initialize(package_amount:, package_size:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::PackageConfig} for more details.
+      #
+      #   @param package_amount [String] A currency amount to rate usage by
+      #
+      #   @param package_size [Integer] An integer amount to represent package size. For example, 1000 here would divide
+    end
+  end
+end

data/lib/orb/models/per_price_cost.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class PerPriceCost < Orb::Internal::Type::BaseModel
+      # @!attribute price
+      #   The price object
+      #
+      #   @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
+      required :price, union: -> { Orb::Price }
+
+      # @!attribute price_id
+      #   The price the cost is associated with
+      #
+      #   @return [String]
+      required :price_id, String
+
+      # @!attribute subtotal
+      #   Price's contributions for the timeframe, excluding any minimums and discounts.
+      #
+      #   @return [String]
+      required :subtotal, String
+
+      # @!attribute total
+      #   Price's contributions for the timeframe, including minimums and discounts.
+      #
+      #   @return [String]
+      required :total, String
+
+      # @!attribute quantity
+      #   The price's quantity for the timeframe
+      #
+      #   @return [Float, nil]
+      optional :quantity, Float, nil?: true
+
+      # @!method initialize(price:, price_id:, subtotal:, total:, quantity: nil)
+      #   @param price [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk] The price object
+      #
+      #   @param price_id [String] The price the cost is associated with
+      #
+      #   @param subtotal [String] Price's contributions for the timeframe, excluding any minimums and discounts.
+      #
+      #   @param total [String] Price's contributions for the timeframe, including minimums and discounts.
+      #
+      #   @param quantity [Float, nil] The price's quantity for the timeframe
+    end
+  end
+end

data/lib/orb/models/percentage_discount.rb

@@ -25,8 +25,8 @@ module Orb
       # @!attribute filters
       #   The filters that determine which prices to apply this discount to.
       #
-      #   @return [Array<Orb::Models::PercentageDiscount::Filter>, nil]
-      optional :filters, -> { Orb::Internal::Type::ArrayOf[Orb::PercentageDiscount::Filter] }, nil?: true
+      #   @return [Array<Orb::Models::TransformPriceFilter>, nil]
+      optional :filters, -> { Orb::Internal::Type::ArrayOf[Orb::TransformPriceFilter] }, nil?: true
 
       # @!attribute reason
       #
@@ -43,7 +43,7 @@ module Orb
       #
       #   @param applies_to_price_ids [Array<String>, nil] List of price_ids that this discount applies to. For plan/plan phase discounts,
       #
-      #   @param filters [Array<Orb::Models::PercentageDiscount::Filter>, nil] The filters that determine which prices to apply this discount to.
+      #   @param filters [Array<Orb::Models::TransformPriceFilter>, nil] The filters that determine which prices to apply this discount to.
       #
       #   @param reason [String, nil]
 
@@ -56,62 +56,6 @@ module Orb
         # @!method self.values
         #   @return [Array<Symbol>]
       end
-
-      class Filter < Orb::Internal::Type::BaseModel
-        # @!attribute field
-        #   The property of the price to filter on.
-        #
-        #   @return [Symbol, Orb::Models::PercentageDiscount::Filter::Field]
-        required :field, enum: -> { Orb::PercentageDiscount::Filter::Field }
-
-        # @!attribute operator
-        #   Should prices that match the filter be included or excluded.
-        #
-        #   @return [Symbol, Orb::Models::PercentageDiscount::Filter::Operator]
-        required :operator, enum: -> { Orb::PercentageDiscount::Filter::Operator }
-
-        # @!attribute values
-        #   The IDs or values that match this filter.
-        #
-        #   @return [Array<String>]
-        required :values, Orb::Internal::Type::ArrayOf[String]
-
-        # @!method initialize(field:, operator:, values:)
-        #   @param field [Symbol, Orb::Models::PercentageDiscount::Filter::Field] The property of the price to filter on.
-        #
-        #   @param operator [Symbol, Orb::Models::PercentageDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
-        #
-        #   @param values [Array<String>] The IDs or values that match this filter.
-
-        # The property of the price to filter on.
-        #
-        # @see Orb::Models::PercentageDiscount::Filter#field
-        module Field
-          extend Orb::Internal::Type::Enum
-
-          PRICE_ID = :price_id
-          ITEM_ID = :item_id
-          PRICE_TYPE = :price_type
-          CURRENCY = :currency
-          PRICING_UNIT_ID = :pricing_unit_id
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # Should prices that match the filter be included or excluded.
-        #
-        # @see Orb::Models::PercentageDiscount::Filter#operator
-        module Operator
-          extend Orb::Internal::Type::Enum
-
-          INCLUDES = :includes
-          EXCLUDES = :excludes
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
     end
   end
 end

data/lib/orb/models/percentage_discount_interval.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class PercentageDiscountInterval < Orb::Internal::Type::BaseModel
+      # @!attribute applies_to_price_interval_ids
+      #   The price interval ids that this discount interval applies to.
+      #
+      #   @return [Array<String>]
+      required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String]
+
+      # @!attribute discount_type
+      #
+      #   @return [Symbol, Orb::Models::PercentageDiscountInterval::DiscountType]
+      required :discount_type, enum: -> { Orb::PercentageDiscountInterval::DiscountType }
+
+      # @!attribute end_date
+      #   The end date of the discount interval.
+      #
+      #   @return [Time, nil]
+      required :end_date, Time, nil?: true
+
+      # @!attribute filters
+      #   The filters that determine which prices this discount interval applies to.
+      #
+      #   @return [Array<Orb::Models::TransformPriceFilter>]
+      required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::TransformPriceFilter] }
+
+      # @!attribute percentage_discount
+      #   Only available if discount_type is `percentage`.This is a number between 0
+      #   and 1.
+      #
+      #   @return [Float]
+      required :percentage_discount, Float
+
+      # @!attribute start_date
+      #   The start date of the discount interval.
+      #
+      #   @return [Time]
+      required :start_date, Time
+
+      # @!method initialize(applies_to_price_interval_ids:, discount_type:, end_date:, filters:, percentage_discount:, start_date:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::PercentageDiscountInterval} for more details.
+      #
+      #   @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
+      #
+      #   @param discount_type [Symbol, Orb::Models::PercentageDiscountInterval::DiscountType]
+      #
+      #   @param end_date [Time, nil] The end date of the discount interval.
+      #
+      #   @param filters [Array<Orb::Models::TransformPriceFilter>] The filters that determine which prices this discount interval applies to.
+      #
+      #   @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1
+      #
+      #   @param start_date [Time] The start date of the discount interval.
+
+      # @see Orb::Models::PercentageDiscountInterval#discount_type
+      module DiscountType
+        extend Orb::Internal::Type::Enum
+
+        PERCENTAGE = :percentage
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end