orb-billing 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dad66a8975532dada27f6ccd45c30a2d97fc1334e417d96bd5123cf31638f1e4
-  data.tar.gz: 40a105a901a0d0bd2472a4c1226068af5a7ddcd8be89d1bb514a6c4dfd4821f2
+  metadata.gz: 38014623b9d35e9a21f898d52dd9b6ae72add7d81d6b2e7b770c52fe0a8b20e4
+  data.tar.gz: 9e4077b061466a1143aae81ca11a13ed72197f49fe789a878785401b2881db5b
 SHA512:
-  metadata.gz: a7d81a8f1ad17e5fb82969800b5059ddfc34777205bfeb3d8ad25863e7d8cfee2f9e97cdfffa66b4fa6bd1b6c3eec46daa1618c8f34a9292f87091d6854549ed
-  data.tar.gz: 154c6ed79392ad5ced3f83e5750b9b06b4c06c57e705753874baba8b7845f6eea93dc8a6526828451d331be82a0a4c117c54df55939a955fefee2425f3cdae33
+  metadata.gz: a4e090684580441ec584194c11f958ef16cad342df8297fc195ac48157e3c382b2cc7c4ea2004e4c8a6e73d005057e9fbd5ace348965da03d1155c4f6efc31ac
+  data.tar.gz: b37691fc91a2d572a8d45e3f8dc8c490da23ff3c4f6f1b9304318be291a4f040dfb243ae758d6a56ed8ce5b2ea422dba066424cb795769be90733e8b7c15e69e

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.8.0 (2025-05-29)
+
+Full Changelog: [v0.7.0...v0.8.0](https://github.com/orbcorp/orb-ruby/compare/v0.7.0...v0.8.0)
+
+### Features
+
+* **api:** api update ([a2e8bcf](https://github.com/orbcorp/orb-ruby/commit/a2e8bcf1773986a845af2abcf055036a043b06bd))
+
+
+### Chores
+
+* **internal:** version bump ([2e01a85](https://github.com/orbcorp/orb-ruby/commit/2e01a85a81d448e5ee4f15effb9edb5580634417))
+
 ## 0.7.0 (2025-05-28)
 
 Full Changelog: [v0.6.0...v0.7.0](https://github.com/orbcorp/orb-ruby/compare/v0.6.0...v0.7.0)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "orb-billing", "~> 0.7.0"
+gem "orb-billing", "~> 0.8.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb

@@ -408,14 +408,24 @@ module Orb
             #   @return [String]
             required :currency, String
 
+            # @!attribute custom_expiration
+            #   The custom expiration for the allocation.
+            #
+            #   @return [Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::AllocationPrice::CustomExpiration, nil]
+            optional :custom_expiration,
+                     -> {
+                       Orb::Beta::ExternalPlanIDCreatePlanVersionParams::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::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::AllocationPrice}
             #   for more details.
@@ -428,7 +438,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::Beta::ExternalPlanIDCreatePlanVersionParams::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.
             #
@@ -446,6 +458,39 @@ module Orb
               # @!method self.values
               #   @return [Array<Symbol>]
             end
+
+            # @see Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::AllocationPrice#custom_expiration
+            class CustomExpiration < Orb::Internal::Type::BaseModel
+              # @!attribute duration
+              #
+              #   @return [Integer]
+              required :duration, Integer
+
+              # @!attribute duration_unit
+              #
+              #   @return [Symbol, Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::AllocationPrice::CustomExpiration::DurationUnit]
+              required :duration_unit,
+                       enum: -> {
+                         Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::AllocationPrice::CustomExpiration::DurationUnit
+                       }
+
+              # @!method initialize(duration:, duration_unit:)
+              #   The custom expiration for the allocation.
+              #
+              #   @param duration [Integer]
+              #   @param duration_unit [Symbol, Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::AllocationPrice::CustomExpiration::DurationUnit]
+
+              # @see Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::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
 
           # The price to add to the plan
@@ -9349,14 +9394,24 @@ module Orb
             #   @return [String]
             required :currency, String
 
+            # @!attribute custom_expiration
+            #   The custom expiration for the allocation.
+            #
+            #   @return [Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::AllocationPrice::CustomExpiration, nil]
+            optional :custom_expiration,
+                     -> {
+                       Orb::Beta::ExternalPlanIDCreatePlanVersionParams::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::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::AllocationPrice}
             #   for more details.
@@ -9369,7 +9424,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::Beta::ExternalPlanIDCreatePlanVersionParams::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.
             #
@@ -9387,6 +9444,39 @@ module Orb
               # @!method self.values
               #   @return [Array<Symbol>]
             end
+
+            # @see Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::AllocationPrice#custom_expiration
+            class CustomExpiration < Orb::Internal::Type::BaseModel
+              # @!attribute duration
+              #
+              #   @return [Integer]
+              required :duration, Integer
+
+              # @!attribute duration_unit
+              #
+              #   @return [Symbol, Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::AllocationPrice::CustomExpiration::DurationUnit]
+              required :duration_unit,
+                       enum: -> {
+                         Orb::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::AllocationPrice::CustomExpiration::DurationUnit
+                       }
+
+              # @!method initialize(duration:, duration_unit:)
+              #   The custom expiration for the allocation.
+              #
+              #   @param duration [Integer]
+              #   @param duration_unit [Symbol, Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::AllocationPrice::CustomExpiration::DurationUnit]
+
+              # @see Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::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
 
           # The price to add to the plan

data/lib/orb/models/beta_create_plan_version_params.rb

@@ -381,14 +381,22 @@ module Orb
           #   @return [String]
           required :currency, String
 
+          # @!attribute custom_expiration
+          #   The custom expiration for the allocation.
+          #
+          #   @return [Orb::Models::BetaCreatePlanVersionParams::AddPrice::AllocationPrice::CustomExpiration, nil]
+          optional :custom_expiration,
+                   -> { Orb::BetaCreatePlanVersionParams::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::BetaCreatePlanVersionParams::AddPrice::AllocationPrice} for more
           #   details.
@@ -401,7 +409,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::BetaCreatePlanVersionParams::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.
           #
@@ -419,6 +429,39 @@ module Orb
             # @!method self.values
             #   @return [Array<Symbol>]
           end
+
+          # @see Orb::Models::BetaCreatePlanVersionParams::AddPrice::AllocationPrice#custom_expiration
+          class CustomExpiration < Orb::Internal::Type::BaseModel
+            # @!attribute duration
+            #
+            #   @return [Integer]
+            required :duration, Integer
+
+            # @!attribute duration_unit
+            #
+            #   @return [Symbol, Orb::Models::BetaCreatePlanVersionParams::AddPrice::AllocationPrice::CustomExpiration::DurationUnit]
+            required :duration_unit,
+                     enum: -> {
+                       Orb::BetaCreatePlanVersionParams::AddPrice::AllocationPrice::CustomExpiration::DurationUnit
+                     }
+
+            # @!method initialize(duration:, duration_unit:)
+            #   The custom expiration for the allocation.
+            #
+            #   @param duration [Integer]
+            #   @param duration_unit [Symbol, Orb::Models::BetaCreatePlanVersionParams::AddPrice::AllocationPrice::CustomExpiration::DurationUnit]
+
+            # @see Orb::Models::BetaCreatePlanVersionParams::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
 
         # The price to add to the plan
@@ -9235,14 +9278,22 @@ module Orb
           #   @return [String]
           required :currency, String
 
+          # @!attribute custom_expiration
+          #   The custom expiration for the allocation.
+          #
+          #   @return [Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::AllocationPrice::CustomExpiration, nil]
+          optional :custom_expiration,
+                   -> { Orb::BetaCreatePlanVersionParams::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::BetaCreatePlanVersionParams::ReplacePrice::AllocationPrice} for
           #   more details.
@@ -9255,7 +9306,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::BetaCreatePlanVersionParams::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.
           #
@@ -9273,6 +9326,39 @@ module Orb
             # @!method self.values
             #   @return [Array<Symbol>]
           end
+
+          # @see Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::AllocationPrice#custom_expiration
+          class CustomExpiration < Orb::Internal::Type::BaseModel
+            # @!attribute duration
+            #
+            #   @return [Integer]
+            required :duration, Integer
+
+            # @!attribute duration_unit
+            #
+            #   @return [Symbol, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::AllocationPrice::CustomExpiration::DurationUnit]
+            required :duration_unit,
+                     enum: -> {
+                       Orb::BetaCreatePlanVersionParams::ReplacePrice::AllocationPrice::CustomExpiration::DurationUnit
+                     }
+
+            # @!method initialize(duration:, duration_unit:)
+            #   The custom expiration for the allocation.
+            #
+            #   @param duration [Integer]
+            #   @param duration_unit [Symbol, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::AllocationPrice::CustomExpiration::DurationUnit]
+
+            # @see Orb::Models::BetaCreatePlanVersionParams::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
 
         # The price to add to the plan