orb-billing 0.7.0 → 0.8.0

data/lib/orb/models/subscription_create_params.rb

@@ -715,14 +715,22 @@ module Orb
           #   @return [String]
           required :currency, String
 
+          # @!attribute custom_expiration
+          #   The custom expiration for the allocation.
+          #
+          #   @return [Orb::Models::SubscriptionCreateParams::AddPrice::AllocationPrice::CustomExpiration, nil]
+          optional :custom_expiration,
+                   -> { Orb::SubscriptionCreateParams::AddPrice::AllocationPrice::CustomExpiration },
+                   nil?: true
+
           # @!attribute expires_at_end_of_cadence
           #   Whether the allocated amount should expire at the end of the cadence or roll
-          #   over to the next period.
+          #   over to the next period. Set to null if using custom_expiration.
           #
-          #   @return [Boolean]
-          required :expires_at_end_of_cadence, Orb::Internal::Type::Boolean
+          #   @return [Boolean, nil]
+          optional :expires_at_end_of_cadence, Orb::Internal::Type::Boolean, nil?: true
 
-          # @!method initialize(amount:, cadence:, currency:, expires_at_end_of_cadence:)
+          # @!method initialize(amount:, cadence:, currency:, custom_expiration: nil, expires_at_end_of_cadence: nil)
           #   Some parameter documentations has been truncated, see
           #   {Orb::Models::SubscriptionCreateParams::AddPrice::AllocationPrice} for more
           #   details.
@@ -735,7 +743,9 @@ module Orb
           #
           #   @param currency [String] An ISO 4217 currency string or a custom pricing unit identifier in which to bill
           #
-          #   @param expires_at_end_of_cadence [Boolean] Whether the allocated amount should expire at the end of the cadence or roll ove
+          #   @param custom_expiration [Orb::Models::SubscriptionCreateParams::AddPrice::AllocationPrice::CustomExpiration, nil] The custom expiration for the allocation.
+          #
+          #   @param expires_at_end_of_cadence [Boolean, nil] Whether the allocated amount should expire at the end of the cadence or roll ove
 
           # The cadence at which to allocate the amount to the customer.
           #
@@ -753,6 +763,39 @@ module Orb
             # @!method self.values
             #   @return [Array<Symbol>]
           end
+
+          # @see Orb::Models::SubscriptionCreateParams::AddPrice::AllocationPrice#custom_expiration
+          class CustomExpiration < Orb::Internal::Type::BaseModel
+            # @!attribute duration
+            #
+            #   @return [Integer]
+            required :duration, Integer
+
+            # @!attribute duration_unit
+            #
+            #   @return [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::AllocationPrice::CustomExpiration::DurationUnit]
+            required :duration_unit,
+                     enum: -> {
+                       Orb::SubscriptionCreateParams::AddPrice::AllocationPrice::CustomExpiration::DurationUnit
+                     }
+
+            # @!method initialize(duration:, duration_unit:)
+            #   The custom expiration for the allocation.
+            #
+            #   @param duration [Integer]
+            #   @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::AllocationPrice::CustomExpiration::DurationUnit]
+
+            # @see Orb::Models::SubscriptionCreateParams::AddPrice::AllocationPrice::CustomExpiration#duration_unit
+            module DurationUnit
+              extend Orb::Internal::Type::Enum
+
+              DAY = :day
+              MONTH = :month
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
         end
 
         class Discount < Orb::Internal::Type::BaseModel
@@ -9937,14 +9980,22 @@ module Orb
           #   @return [String]
           required :currency, String
 
+          # @!attribute custom_expiration
+          #   The custom expiration for the allocation.
+          #
+          #   @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::AllocationPrice::CustomExpiration, nil]
+          optional :custom_expiration,
+                   -> { Orb::SubscriptionCreateParams::ReplacePrice::AllocationPrice::CustomExpiration },
+                   nil?: true
+
           # @!attribute expires_at_end_of_cadence
           #   Whether the allocated amount should expire at the end of the cadence or roll
-          #   over to the next period.
+          #   over to the next period. Set to null if using custom_expiration.
           #
-          #   @return [Boolean]
-          required :expires_at_end_of_cadence, Orb::Internal::Type::Boolean
+          #   @return [Boolean, nil]
+          optional :expires_at_end_of_cadence, Orb::Internal::Type::Boolean, nil?: true
 
-          # @!method initialize(amount:, cadence:, currency:, expires_at_end_of_cadence:)
+          # @!method initialize(amount:, cadence:, currency:, custom_expiration: nil, expires_at_end_of_cadence: nil)
           #   Some parameter documentations has been truncated, see
           #   {Orb::Models::SubscriptionCreateParams::ReplacePrice::AllocationPrice} for more
           #   details.
@@ -9957,7 +10008,9 @@ module Orb
           #
           #   @param currency [String] An ISO 4217 currency string or a custom pricing unit identifier in which to bill
           #
-          #   @param expires_at_end_of_cadence [Boolean] Whether the allocated amount should expire at the end of the cadence or roll ove
+          #   @param custom_expiration [Orb::Models::SubscriptionCreateParams::ReplacePrice::AllocationPrice::CustomExpiration, nil] The custom expiration for the allocation.
+          #
+          #   @param expires_at_end_of_cadence [Boolean, nil] Whether the allocated amount should expire at the end of the cadence or roll ove
 
           # The cadence at which to allocate the amount to the customer.
           #
@@ -9975,6 +10028,39 @@ module Orb
             # @!method self.values
             #   @return [Array<Symbol>]
           end
+
+          # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::AllocationPrice#custom_expiration
+          class CustomExpiration < Orb::Internal::Type::BaseModel
+            # @!attribute duration
+            #
+            #   @return [Integer]
+            required :duration, Integer
+
+            # @!attribute duration_unit
+            #
+            #   @return [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::AllocationPrice::CustomExpiration::DurationUnit]
+            required :duration_unit,
+                     enum: -> {
+                       Orb::SubscriptionCreateParams::ReplacePrice::AllocationPrice::CustomExpiration::DurationUnit
+                     }
+
+            # @!method initialize(duration:, duration_unit:)
+            #   The custom expiration for the allocation.
+            #
+            #   @param duration [Integer]
+            #   @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::AllocationPrice::CustomExpiration::DurationUnit]
+
+            # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::AllocationPrice::CustomExpiration#duration_unit
+            module DurationUnit
+              extend Orb::Internal::Type::Enum
+
+              DAY = :day
+              MONTH = :month
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
         end
 
         class Discount < Orb::Internal::Type::BaseModel

data/lib/orb/models/subscription_price_intervals_params.rb

@@ -218,14 +218,22 @@ module Orb
           #   @return [String]
           required :currency, String
 
+          # @!attribute custom_expiration
+          #   The custom expiration for the allocation.
+          #
+          #   @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice::CustomExpiration, nil]
+          optional :custom_expiration,
+                   -> { Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice::CustomExpiration },
+                   nil?: true
+
           # @!attribute expires_at_end_of_cadence
           #   Whether the allocated amount should expire at the end of the cadence or roll
-          #   over to the next period.
+          #   over to the next period. Set to null if using custom_expiration.
           #
-          #   @return [Boolean]
-          required :expires_at_end_of_cadence, Orb::Internal::Type::Boolean
+          #   @return [Boolean, nil]
+          optional :expires_at_end_of_cadence, Orb::Internal::Type::Boolean, nil?: true
 
-          # @!method initialize(amount:, cadence:, currency:, expires_at_end_of_cadence:)
+          # @!method initialize(amount:, cadence:, currency:, custom_expiration: nil, expires_at_end_of_cadence: nil)
           #   Some parameter documentations has been truncated, see
           #   {Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice} for more
           #   details.
@@ -238,7 +246,9 @@ module Orb
           #
           #   @param currency [String] An ISO 4217 currency string or a custom pricing unit identifier in which to bill
           #
-          #   @param expires_at_end_of_cadence [Boolean] Whether the allocated amount should expire at the end of the cadence or roll ove
+          #   @param custom_expiration [Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice::CustomExpiration, nil] The custom expiration for the allocation.
+          #
+          #   @param expires_at_end_of_cadence [Boolean, nil] Whether the allocated amount should expire at the end of the cadence or roll ove
 
           # The cadence at which to allocate the amount to the customer.
           #
@@ -256,6 +266,39 @@ module Orb
             # @!method self.values
             #   @return [Array<Symbol>]
           end
+
+          # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice#custom_expiration
+          class CustomExpiration < Orb::Internal::Type::BaseModel
+            # @!attribute duration
+            #
+            #   @return [Integer]
+            required :duration, Integer
+
+            # @!attribute duration_unit
+            #
+            #   @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice::CustomExpiration::DurationUnit]
+            required :duration_unit,
+                     enum: -> {
+                       Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice::CustomExpiration::DurationUnit
+                     }
+
+            # @!method initialize(duration:, duration_unit:)
+            #   The custom expiration for the allocation.
+            #
+            #   @param duration [Integer]
+            #   @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice::CustomExpiration::DurationUnit]
+
+            # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice::CustomExpiration#duration_unit
+            module DurationUnit
+              extend Orb::Internal::Type::Enum
+
+              DAY = :day
+              MONTH = :month
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
         end
 
         module Discount

data/lib/orb/models/subscription_schedule_plan_change_params.rb

@@ -688,14 +688,24 @@ module Orb
           #   @return [String]
           required :currency, String
 
+          # @!attribute custom_expiration
+          #   The custom expiration for the allocation.
+          #
+          #   @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::CustomExpiration, nil]
+          optional :custom_expiration,
+                   -> {
+                     Orb::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::CustomExpiration
+                   },
+                   nil?: true
+
           # @!attribute expires_at_end_of_cadence
           #   Whether the allocated amount should expire at the end of the cadence or roll
-          #   over to the next period.
+          #   over to the next period. Set to null if using custom_expiration.
           #
-          #   @return [Boolean]
-          required :expires_at_end_of_cadence, Orb::Internal::Type::Boolean
+          #   @return [Boolean, nil]
+          optional :expires_at_end_of_cadence, Orb::Internal::Type::Boolean, nil?: true
 
-          # @!method initialize(amount:, cadence:, currency:, expires_at_end_of_cadence:)
+          # @!method initialize(amount:, cadence:, currency:, custom_expiration: nil, expires_at_end_of_cadence: nil)
           #   Some parameter documentations has been truncated, see
           #   {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice}
           #   for more details.
@@ -708,7 +718,9 @@ module Orb
           #
           #   @param currency [String] An ISO 4217 currency string or a custom pricing unit identifier in which to bill
           #
-          #   @param expires_at_end_of_cadence [Boolean] Whether the allocated amount should expire at the end of the cadence or roll ove
+          #   @param custom_expiration [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::CustomExpiration, nil] The custom expiration for the allocation.
+          #
+          #   @param expires_at_end_of_cadence [Boolean, nil] Whether the allocated amount should expire at the end of the cadence or roll ove
 
           # The cadence at which to allocate the amount to the customer.
           #
@@ -726,6 +738,39 @@ module Orb
             # @!method self.values
             #   @return [Array<Symbol>]
           end
+
+          # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice#custom_expiration
+          class CustomExpiration < Orb::Internal::Type::BaseModel
+            # @!attribute duration
+            #
+            #   @return [Integer]
+            required :duration, Integer
+
+            # @!attribute duration_unit
+            #
+            #   @return [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::CustomExpiration::DurationUnit]
+            required :duration_unit,
+                     enum: -> {
+                       Orb::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::CustomExpiration::DurationUnit
+                     }
+
+            # @!method initialize(duration:, duration_unit:)
+            #   The custom expiration for the allocation.
+            #
+            #   @param duration [Integer]
+            #   @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::CustomExpiration::DurationUnit]
+
+            # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::CustomExpiration#duration_unit
+            module DurationUnit
+              extend Orb::Internal::Type::Enum
+
+              DAY = :day
+              MONTH = :month
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
         end
 
         class Discount < Orb::Internal::Type::BaseModel
@@ -9974,14 +10019,24 @@ module Orb
           #   @return [String]
           required :currency, String
 
+          # @!attribute custom_expiration
+          #   The custom expiration for the allocation.
+          #
+          #   @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::CustomExpiration, nil]
+          optional :custom_expiration,
+                   -> {
+                     Orb::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::CustomExpiration
+                   },
+                   nil?: true
+
           # @!attribute expires_at_end_of_cadence
           #   Whether the allocated amount should expire at the end of the cadence or roll
-          #   over to the next period.
+          #   over to the next period. Set to null if using custom_expiration.
           #
-          #   @return [Boolean]
-          required :expires_at_end_of_cadence, Orb::Internal::Type::Boolean
+          #   @return [Boolean, nil]
+          optional :expires_at_end_of_cadence, Orb::Internal::Type::Boolean, nil?: true
 
-          # @!method initialize(amount:, cadence:, currency:, expires_at_end_of_cadence:)
+          # @!method initialize(amount:, cadence:, currency:, custom_expiration: nil, expires_at_end_of_cadence: nil)
           #   Some parameter documentations has been truncated, see
           #   {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice}
           #   for more details.
@@ -9994,7 +10049,9 @@ module Orb
           #
           #   @param currency [String] An ISO 4217 currency string or a custom pricing unit identifier in which to bill
           #
-          #   @param expires_at_end_of_cadence [Boolean] Whether the allocated amount should expire at the end of the cadence or roll ove
+          #   @param custom_expiration [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::CustomExpiration, nil] The custom expiration for the allocation.
+          #
+          #   @param expires_at_end_of_cadence [Boolean, nil] Whether the allocated amount should expire at the end of the cadence or roll ove
 
           # The cadence at which to allocate the amount to the customer.
           #
@@ -10012,6 +10069,39 @@ module Orb
             # @!method self.values
             #   @return [Array<Symbol>]
           end
+
+          # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice#custom_expiration
+          class CustomExpiration < Orb::Internal::Type::BaseModel
+            # @!attribute duration
+            #
+            #   @return [Integer]
+            required :duration, Integer
+
+            # @!attribute duration_unit
+            #
+            #   @return [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::CustomExpiration::DurationUnit]
+            required :duration_unit,
+                     enum: -> {
+                       Orb::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::CustomExpiration::DurationUnit
+                     }
+
+            # @!method initialize(duration:, duration_unit:)
+            #   The custom expiration for the allocation.
+            #
+            #   @param duration [Integer]
+            #   @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::CustomExpiration::DurationUnit]
+
+            # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::CustomExpiration#duration_unit
+            module DurationUnit
+              extend Orb::Internal::Type::Enum
+
+              DAY = :day
+              MONTH = :month
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
         end
 
         class Discount < Orb::Internal::Type::BaseModel

data/lib/orb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Orb
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end