orb-billing 0.11.0 → 1.0.0

data/lib/orb/models/subscription_trial_info.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class SubscriptionTrialInfo < Orb::Internal::Type::BaseModel
+      # @!attribute end_date
+      #
+      #   @return [Time, nil]
+      required :end_date, Time, nil?: true
+
+      # @!method initialize(end_date:)
+      #   @param end_date [Time, nil]
+    end
+  end
+end

data/lib/orb/models/tax_amount.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class TaxAmount < Orb::Internal::Type::BaseModel
+      # @!attribute amount
+      #   The amount of additional tax incurred by this tax rate.
+      #
+      #   @return [String]
+      required :amount, String
+
+      # @!attribute tax_rate_description
+      #   The human-readable description of the applied tax rate.
+      #
+      #   @return [String]
+      required :tax_rate_description, String
+
+      # @!attribute tax_rate_percentage
+      #   The tax rate percentage, out of 100.
+      #
+      #   @return [String, nil]
+      required :tax_rate_percentage, String, nil?: true
+
+      # @!method initialize(amount:, tax_rate_description:, tax_rate_percentage:)
+      #   @param amount [String] The amount of additional tax incurred by this tax rate.
+      #
+      #   @param tax_rate_description [String] The human-readable description of the applied tax rate.
+      #
+      #   @param tax_rate_percentage [String, nil] The tax rate percentage, out of 100.
+    end
+  end
+end

data/lib/orb/models/threshold.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class Threshold < Orb::Internal::Type::BaseModel
+      # @!attribute value
+      #   The value at which an alert will fire. For credit balance alerts, the alert will
+      #   fire at or below this value. For usage and cost alerts, the alert will fire at
+      #   or above this value.
+      #
+      #   @return [Float]
+      required :value, Float
+
+      # @!method initialize(value:)
+      #   Some parameter documentations has been truncated, see {Orb::Models::Threshold}
+      #   for more details.
+      #
+      #   Thresholds are used to define the conditions under which an alert will be
+      #   triggered.
+      #
+      #   @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will
+    end
+  end
+end

data/lib/orb/models/tier.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class Tier < Orb::Internal::Type::BaseModel
+      # @!attribute first_unit
+      #   Exclusive tier starting value
+      #
+      #   @return [Float]
+      required :first_unit, Float
+
+      # @!attribute unit_amount
+      #   Amount per unit
+      #
+      #   @return [String]
+      required :unit_amount, String
+
+      # @!attribute last_unit
+      #   Inclusive tier ending value. If null, this is treated as the last tier
+      #
+      #   @return [Float, nil]
+      optional :last_unit, Float, nil?: true
+
+      # @!method initialize(first_unit:, unit_amount:, last_unit: nil)
+      #   @param first_unit [Float] Exclusive tier starting value
+      #
+      #   @param unit_amount [String] Amount per unit
+      #
+      #   @param last_unit [Float, nil] Inclusive tier ending value. If null, this is treated as the last tier
+    end
+  end
+end

data/lib/orb/models/tier_config.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class TierConfig < Orb::Internal::Type::BaseModel
+      # @!attribute first_unit
+      #
+      #   @return [Float]
+      required :first_unit, Float
+
+      # @!attribute last_unit
+      #
+      #   @return [Float, nil]
+      required :last_unit, Float, nil?: true
+
+      # @!attribute unit_amount
+      #
+      #   @return [String]
+      required :unit_amount, String
+
+      # @!method initialize(first_unit:, last_unit:, unit_amount:)
+      #   @param first_unit [Float]
+      #   @param last_unit [Float, nil]
+      #   @param unit_amount [String]
+    end
+  end
+end

data/lib/orb/models/tier_sub_line_item.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class TierSubLineItem < 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 tier_config
+      #
+      #   @return [Orb::Models::TierConfig]
+      required :tier_config, -> { Orb::TierConfig }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, Orb::Models::TierSubLineItem::Type]
+      required :type, enum: -> { Orb::TierSubLineItem::Type }
+
+      # @!method initialize(amount:, grouping:, name:, quantity:, tier_config:, 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 tier_config [Orb::Models::TierConfig]
+      #
+      #   @param type [Symbol, Orb::Models::TierSubLineItem::Type]
+
+      # @see Orb::Models::TierSubLineItem#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        TIER = :tier
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/tiered_bps_config.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class TieredBPSConfig < Orb::Internal::Type::BaseModel
+      # @!attribute tiers
+      #   Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
+      #   tiers
+      #
+      #   @return [Array<Orb::Models::BPSTier>]
+      required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::BPSTier] }
+
+      # @!method initialize(tiers:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::TieredBPSConfig} for more details.
+      #
+      #   @param tiers [Array<Orb::Models::BPSTier>] Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
+    end
+  end
+end

data/lib/orb/models/tiered_config.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class TieredConfig < Orb::Internal::Type::BaseModel
+      # @!attribute tiers
+      #   Tiers for rating based on total usage quantities into the specified tier
+      #
+      #   @return [Array<Orb::Models::Tier>]
+      required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Tier] }
+
+      # @!method initialize(tiers:)
+      #   @param tiers [Array<Orb::Models::Tier>] Tiers for rating based on total usage quantities into the specified tier
+    end
+  end
+end

data/lib/orb/models/tiered_conversion_rate_config.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class TieredConversionRateConfig < Orb::Internal::Type::BaseModel
+      # @!attribute conversion_rate_type
+      #
+      #   @return [Symbol, Orb::Models::TieredConversionRateConfig::ConversionRateType]
+      required :conversion_rate_type, enum: -> { Orb::TieredConversionRateConfig::ConversionRateType }
+
+      # @!attribute tiered_config
+      #
+      #   @return [Orb::Models::ConversionRateTieredConfig]
+      required :tiered_config, -> { Orb::ConversionRateTieredConfig }
+
+      # @!method initialize(conversion_rate_type:, tiered_config:)
+      #   @param conversion_rate_type [Symbol, Orb::Models::TieredConversionRateConfig::ConversionRateType]
+      #   @param tiered_config [Orb::Models::ConversionRateTieredConfig]
+
+      # @see Orb::Models::TieredConversionRateConfig#conversion_rate_type
+      module ConversionRateType
+        extend Orb::Internal::Type::Enum
+
+        TIERED = :tiered
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/transform_price_filter.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class TransformPriceFilter < Orb::Internal::Type::BaseModel
+      # @!attribute field
+      #   The property of the price to filter on.
+      #
+      #   @return [Symbol, Orb::Models::TransformPriceFilter::Field]
+      required :field, enum: -> { Orb::TransformPriceFilter::Field }
+
+      # @!attribute operator
+      #   Should prices that match the filter be included or excluded.
+      #
+      #   @return [Symbol, Orb::Models::TransformPriceFilter::Operator]
+      required :operator, enum: -> { Orb::TransformPriceFilter::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::TransformPriceFilter::Field] The property of the price to filter on.
+      #
+      #   @param operator [Symbol, Orb::Models::TransformPriceFilter::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::TransformPriceFilter#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::TransformPriceFilter#operator
+      module Operator
+        extend Orb::Internal::Type::Enum
+
+        INCLUDES = :includes
+        EXCLUDES = :excludes
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/trial_discount.rb

@@ -15,6 +15,12 @@ module Orb
       #   @return [Array<String>, nil]
       optional :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
 
+      # @!attribute filters
+      #   The filters that determine which prices to apply this discount to.
+      #
+      #   @return [Array<Orb::Models::TransformPriceFilter>, nil]
+      optional :filters, -> { Orb::Internal::Type::ArrayOf[Orb::TransformPriceFilter] }, nil?: true
+
       # @!attribute reason
       #
       #   @return [String, nil]
@@ -32,7 +38,7 @@ module Orb
       #   @return [Float, nil]
       optional :trial_percentage_discount, Float, nil?: true
 
-      # @!method initialize(discount_type:, applies_to_price_ids: nil, reason: nil, trial_amount_discount: nil, trial_percentage_discount: nil)
+      # @!method initialize(discount_type:, applies_to_price_ids: nil, filters: nil, reason: nil, trial_amount_discount: nil, trial_percentage_discount: nil)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::TrialDiscount} for more details.
       #
@@ -40,6 +46,8 @@ 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::TransformPriceFilter>, nil] The filters that determine which prices to apply this discount to.
+      #
       #   @param reason [String, nil]
       #
       #   @param trial_amount_discount [String, nil] Only available if discount_type is `trial`

data/lib/orb/models/unit_config.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class UnitConfig < Orb::Internal::Type::BaseModel
+      # @!attribute unit_amount
+      #   Rate per unit of usage
+      #
+      #   @return [String]
+      required :unit_amount, String
+
+      # @!method initialize(unit_amount:)
+      #   @param unit_amount [String] Rate per unit of usage
+    end
+  end
+end

data/lib/orb/models/unit_conversion_rate_config.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class UnitConversionRateConfig < Orb::Internal::Type::BaseModel
+      # @!attribute conversion_rate_type
+      #
+      #   @return [Symbol, Orb::Models::UnitConversionRateConfig::ConversionRateType]
+      required :conversion_rate_type, enum: -> { Orb::UnitConversionRateConfig::ConversionRateType }
+
+      # @!attribute unit_config
+      #
+      #   @return [Orb::Models::ConversionRateUnitConfig]
+      required :unit_config, -> { Orb::ConversionRateUnitConfig }
+
+      # @!method initialize(conversion_rate_type:, unit_config:)
+      #   @param conversion_rate_type [Symbol, Orb::Models::UnitConversionRateConfig::ConversionRateType]
+      #   @param unit_config [Orb::Models::ConversionRateUnitConfig]
+
+      # @see Orb::Models::UnitConversionRateConfig#conversion_rate_type
+      module ConversionRateType
+        extend Orb::Internal::Type::Enum
+
+        UNIT = :unit
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/usage_discount.rb

@@ -22,12 +22,18 @@ module Orb
       #   @return [Array<String>, nil]
       optional :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
 
+      # @!attribute filters
+      #   The filters that determine which prices to apply this discount to.
+      #
+      #   @return [Array<Orb::Models::TransformPriceFilter>, nil]
+      optional :filters, -> { Orb::Internal::Type::ArrayOf[Orb::TransformPriceFilter] }, nil?: true
+
       # @!attribute reason
       #
       #   @return [String, nil]
       optional :reason, String, nil?: true
 
-      # @!method initialize(discount_type:, usage_discount:, applies_to_price_ids: nil, reason: nil)
+      # @!method initialize(discount_type:, usage_discount:, applies_to_price_ids: nil, filters: nil, reason: nil)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::UsageDiscount} for more details.
       #
@@ -37,6 +43,8 @@ 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::TransformPriceFilter>, nil] The filters that determine which prices to apply this discount to.
+      #
       #   @param reason [String, nil]
 
       # @see Orb::Models::UsageDiscount#discount_type

data/lib/orb/models/usage_discount_interval.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class UsageDiscountInterval < 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::UsageDiscountInterval::DiscountType]
+      required :discount_type, enum: -> { Orb::UsageDiscountInterval::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 start_date
+      #   The start date of the discount interval.
+      #
+      #   @return [Time]
+      required :start_date, Time
+
+      # @!attribute usage_discount
+      #   Only available if discount_type is `usage`. Number of usage units that this
+      #   discount is for
+      #
+      #   @return [Float]
+      required :usage_discount, Float
+
+      # @!method initialize(applies_to_price_interval_ids:, discount_type:, end_date:, filters:, start_date:, usage_discount:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::UsageDiscountInterval} 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::UsageDiscountInterval::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 start_date [Time] The start date of the discount interval.
+      #
+      #   @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
+
+      # @see Orb::Models::UsageDiscountInterval#discount_type
+      module DiscountType
+        extend Orb::Internal::Type::Enum
+
+        USAGE = :usage
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end