orb-billing 0.7.0 → 0.8.0

data/rbi/orb/models/subscription_create_params.rbi

@@ -1128,9 +1128,29 @@ module Orb
           sig { returns(String) }
           attr_accessor :currency
 
+          # The custom expiration for the allocation.
+          sig do
+            returns(
+              T.nilable(
+                Orb::SubscriptionCreateParams::AddPrice::AllocationPrice::CustomExpiration
+              )
+            )
+          end
+          attr_reader :custom_expiration
+
+          sig do
+            params(
+              custom_expiration:
+                T.nilable(
+                  Orb::SubscriptionCreateParams::AddPrice::AllocationPrice::CustomExpiration::OrHash
+                )
+            ).void
+          end
+          attr_writer :custom_expiration
+
           # Whether the allocated amount should expire at the end of the cadence or roll
-          # over to the next period.
-          sig { returns(T::Boolean) }
+          # over to the next period. Set to null if using custom_expiration.
+          sig { returns(T.nilable(T::Boolean)) }
           attr_accessor :expires_at_end_of_cadence
 
           # The definition of a new allocation price to create and add to the subscription.
@@ -1140,7 +1160,11 @@ module Orb
               cadence:
                 Orb::SubscriptionCreateParams::AddPrice::AllocationPrice::Cadence::OrSymbol,
               currency: String,
-              expires_at_end_of_cadence: T::Boolean
+              custom_expiration:
+                T.nilable(
+                  Orb::SubscriptionCreateParams::AddPrice::AllocationPrice::CustomExpiration::OrHash
+                ),
+              expires_at_end_of_cadence: T.nilable(T::Boolean)
             ).returns(T.attached_class)
           end
           def self.new(
@@ -1151,9 +1175,11 @@ module Orb
             # An ISO 4217 currency string or a custom pricing unit identifier in which to bill
             # this price.
             currency:,
+            # The custom expiration for the allocation.
+            custom_expiration: nil,
             # Whether the allocated amount should expire at the end of the cadence or roll
-            # over to the next period.
-            expires_at_end_of_cadence:
+            # over to the next period. Set to null if using custom_expiration.
+            expires_at_end_of_cadence: nil
           )
           end
 
@@ -1164,7 +1190,11 @@ module Orb
                 cadence:
                   Orb::SubscriptionCreateParams::AddPrice::AllocationPrice::Cadence::OrSymbol,
                 currency: String,
-                expires_at_end_of_cadence: T::Boolean
+                custom_expiration:
+                  T.nilable(
+                    Orb::SubscriptionCreateParams::AddPrice::AllocationPrice::CustomExpiration
+                  ),
+                expires_at_end_of_cadence: T.nilable(T::Boolean)
               }
             )
           end
@@ -1225,6 +1255,83 @@ module Orb
             def self.values
             end
           end
+
+          class CustomExpiration < Orb::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Orb::SubscriptionCreateParams::AddPrice::AllocationPrice::CustomExpiration,
+                  Orb::Internal::AnyHash
+                )
+              end
+
+            sig { returns(Integer) }
+            attr_accessor :duration
+
+            sig do
+              returns(
+                Orb::SubscriptionCreateParams::AddPrice::AllocationPrice::CustomExpiration::DurationUnit::OrSymbol
+              )
+            end
+            attr_accessor :duration_unit
+
+            # The custom expiration for the allocation.
+            sig do
+              params(
+                duration: Integer,
+                duration_unit:
+                  Orb::SubscriptionCreateParams::AddPrice::AllocationPrice::CustomExpiration::DurationUnit::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(duration:, duration_unit:)
+            end
+
+            sig do
+              override.returns(
+                {
+                  duration: Integer,
+                  duration_unit:
+                    Orb::SubscriptionCreateParams::AddPrice::AllocationPrice::CustomExpiration::DurationUnit::OrSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            module DurationUnit
+              extend Orb::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Orb::SubscriptionCreateParams::AddPrice::AllocationPrice::CustomExpiration::DurationUnit
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              DAY =
+                T.let(
+                  :day,
+                  Orb::SubscriptionCreateParams::AddPrice::AllocationPrice::CustomExpiration::DurationUnit::TaggedSymbol
+                )
+              MONTH =
+                T.let(
+                  :month,
+                  Orb::SubscriptionCreateParams::AddPrice::AllocationPrice::CustomExpiration::DurationUnit::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Orb::SubscriptionCreateParams::AddPrice::AllocationPrice::CustomExpiration::DurationUnit::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
         end
 
         class Discount < Orb::Internal::Type::BaseModel
@@ -17917,9 +18024,29 @@ module Orb
           sig { returns(String) }
           attr_accessor :currency
 
+          # The custom expiration for the allocation.
+          sig do
+            returns(
+              T.nilable(
+                Orb::SubscriptionCreateParams::ReplacePrice::AllocationPrice::CustomExpiration
+              )
+            )
+          end
+          attr_reader :custom_expiration
+
+          sig do
+            params(
+              custom_expiration:
+                T.nilable(
+                  Orb::SubscriptionCreateParams::ReplacePrice::AllocationPrice::CustomExpiration::OrHash
+                )
+            ).void
+          end
+          attr_writer :custom_expiration
+
           # Whether the allocated amount should expire at the end of the cadence or roll
-          # over to the next period.
-          sig { returns(T::Boolean) }
+          # over to the next period. Set to null if using custom_expiration.
+          sig { returns(T.nilable(T::Boolean)) }
           attr_accessor :expires_at_end_of_cadence
 
           # The definition of a new allocation price to create and add to the subscription.
@@ -17929,7 +18056,11 @@ module Orb
               cadence:
                 Orb::SubscriptionCreateParams::ReplacePrice::AllocationPrice::Cadence::OrSymbol,
               currency: String,
-              expires_at_end_of_cadence: T::Boolean
+              custom_expiration:
+                T.nilable(
+                  Orb::SubscriptionCreateParams::ReplacePrice::AllocationPrice::CustomExpiration::OrHash
+                ),
+              expires_at_end_of_cadence: T.nilable(T::Boolean)
             ).returns(T.attached_class)
           end
           def self.new(
@@ -17940,9 +18071,11 @@ module Orb
             # An ISO 4217 currency string or a custom pricing unit identifier in which to bill
             # this price.
             currency:,
+            # The custom expiration for the allocation.
+            custom_expiration: nil,
             # Whether the allocated amount should expire at the end of the cadence or roll
-            # over to the next period.
-            expires_at_end_of_cadence:
+            # over to the next period. Set to null if using custom_expiration.
+            expires_at_end_of_cadence: nil
           )
           end
 
@@ -17953,7 +18086,11 @@ module Orb
                 cadence:
                   Orb::SubscriptionCreateParams::ReplacePrice::AllocationPrice::Cadence::OrSymbol,
                 currency: String,
-                expires_at_end_of_cadence: T::Boolean
+                custom_expiration:
+                  T.nilable(
+                    Orb::SubscriptionCreateParams::ReplacePrice::AllocationPrice::CustomExpiration
+                  ),
+                expires_at_end_of_cadence: T.nilable(T::Boolean)
               }
             )
           end
@@ -18014,6 +18151,83 @@ module Orb
             def self.values
             end
           end
+
+          class CustomExpiration < Orb::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Orb::SubscriptionCreateParams::ReplacePrice::AllocationPrice::CustomExpiration,
+                  Orb::Internal::AnyHash
+                )
+              end
+
+            sig { returns(Integer) }
+            attr_accessor :duration
+
+            sig do
+              returns(
+                Orb::SubscriptionCreateParams::ReplacePrice::AllocationPrice::CustomExpiration::DurationUnit::OrSymbol
+              )
+            end
+            attr_accessor :duration_unit
+
+            # The custom expiration for the allocation.
+            sig do
+              params(
+                duration: Integer,
+                duration_unit:
+                  Orb::SubscriptionCreateParams::ReplacePrice::AllocationPrice::CustomExpiration::DurationUnit::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(duration:, duration_unit:)
+            end
+
+            sig do
+              override.returns(
+                {
+                  duration: Integer,
+                  duration_unit:
+                    Orb::SubscriptionCreateParams::ReplacePrice::AllocationPrice::CustomExpiration::DurationUnit::OrSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            module DurationUnit
+              extend Orb::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Orb::SubscriptionCreateParams::ReplacePrice::AllocationPrice::CustomExpiration::DurationUnit
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              DAY =
+                T.let(
+                  :day,
+                  Orb::SubscriptionCreateParams::ReplacePrice::AllocationPrice::CustomExpiration::DurationUnit::TaggedSymbol
+                )
+              MONTH =
+                T.let(
+                  :month,
+                  Orb::SubscriptionCreateParams::ReplacePrice::AllocationPrice::CustomExpiration::DurationUnit::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Orb::SubscriptionCreateParams::ReplacePrice::AllocationPrice::CustomExpiration::DurationUnit::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
         end
 
         class Discount < Orb::Internal::Type::BaseModel

data/rbi/orb/models/subscription_price_intervals_params.rbi

@@ -503,9 +503,29 @@ module Orb
           sig { returns(String) }
           attr_accessor :currency
 
+          # The custom expiration for the allocation.
+          sig do
+            returns(
+              T.nilable(
+                Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice::CustomExpiration
+              )
+            )
+          end
+          attr_reader :custom_expiration
+
+          sig do
+            params(
+              custom_expiration:
+                T.nilable(
+                  Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice::CustomExpiration::OrHash
+                )
+            ).void
+          end
+          attr_writer :custom_expiration
+
           # Whether the allocated amount should expire at the end of the cadence or roll
-          # over to the next period.
-          sig { returns(T::Boolean) }
+          # over to the next period. Set to null if using custom_expiration.
+          sig { returns(T.nilable(T::Boolean)) }
           attr_accessor :expires_at_end_of_cadence
 
           # The definition of a new allocation price to create and add to the subscription.
@@ -515,7 +535,11 @@ module Orb
               cadence:
                 Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice::Cadence::OrSymbol,
               currency: String,
-              expires_at_end_of_cadence: T::Boolean
+              custom_expiration:
+                T.nilable(
+                  Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice::CustomExpiration::OrHash
+                ),
+              expires_at_end_of_cadence: T.nilable(T::Boolean)
             ).returns(T.attached_class)
           end
           def self.new(
@@ -526,9 +550,11 @@ module Orb
             # An ISO 4217 currency string or a custom pricing unit identifier in which to bill
             # this price.
             currency:,
+            # The custom expiration for the allocation.
+            custom_expiration: nil,
             # Whether the allocated amount should expire at the end of the cadence or roll
-            # over to the next period.
-            expires_at_end_of_cadence:
+            # over to the next period. Set to null if using custom_expiration.
+            expires_at_end_of_cadence: nil
           )
           end
 
@@ -539,7 +565,11 @@ module Orb
                 cadence:
                   Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice::Cadence::OrSymbol,
                 currency: String,
-                expires_at_end_of_cadence: T::Boolean
+                custom_expiration:
+                  T.nilable(
+                    Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice::CustomExpiration
+                  ),
+                expires_at_end_of_cadence: T.nilable(T::Boolean)
               }
             )
           end
@@ -600,6 +630,83 @@ module Orb
             def self.values
             end
           end
+
+          class CustomExpiration < Orb::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice::CustomExpiration,
+                  Orb::Internal::AnyHash
+                )
+              end
+
+            sig { returns(Integer) }
+            attr_accessor :duration
+
+            sig do
+              returns(
+                Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice::CustomExpiration::DurationUnit::OrSymbol
+              )
+            end
+            attr_accessor :duration_unit
+
+            # The custom expiration for the allocation.
+            sig do
+              params(
+                duration: Integer,
+                duration_unit:
+                  Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice::CustomExpiration::DurationUnit::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(duration:, duration_unit:)
+            end
+
+            sig do
+              override.returns(
+                {
+                  duration: Integer,
+                  duration_unit:
+                    Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice::CustomExpiration::DurationUnit::OrSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            module DurationUnit
+              extend Orb::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice::CustomExpiration::DurationUnit
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              DAY =
+                T.let(
+                  :day,
+                  Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice::CustomExpiration::DurationUnit::TaggedSymbol
+                )
+              MONTH =
+                T.let(
+                  :month,
+                  Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice::CustomExpiration::DurationUnit::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice::CustomExpiration::DurationUnit::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
         end
 
         module Discount