orb-billing 0.5.1 → 0.5.3

data/lib/orb/models/subscription.rb

@@ -20,7 +20,7 @@ module Orb
       #   The adjustment intervals for this subscription sorted by the start_date of the
       #   adjustment interval.
       #
-      #   @return [Array<Orb::Subscription::AdjustmentInterval>]
+      #   @return [Array<Orb::Models::Subscription::AdjustmentInterval>]
       required :adjustment_intervals,
                -> {
                  Orb::Internal::Type::ArrayOf[Orb::Subscription::AdjustmentInterval]
@@ -36,7 +36,7 @@ module Orb
 
       # @!attribute billing_cycle_anchor_configuration
       #
-      #   @return [Orb::Subscription::BillingCycleAnchorConfiguration]
+      #   @return [Orb::Models::Subscription::BillingCycleAnchorConfiguration]
       required :billing_cycle_anchor_configuration, -> { Orb::Subscription::BillingCycleAnchorConfiguration }
 
       # @!attribute billing_cycle_day
@@ -89,7 +89,7 @@ module Orb
       #   your account's timezone. See [Timezone localization](/essentials/timezones) for
       #   information on what this timezone parameter influences within Orb.
       #
-      #   @return [Orb::Customer]
+      #   @return [Orb::Models::Customer]
       required :customer, -> { Orb::Customer }
 
       # @!attribute default_invoice_memo
@@ -102,7 +102,7 @@ module Orb
       # @!attribute discount_intervals
       #   The discount intervals for this subscription sorted by the start_date.
       #
-      #   @return [Array<Orb::Subscription::DiscountInterval::Amount, Orb::Subscription::DiscountInterval::Percentage, Orb::Subscription::DiscountInterval::Usage>]
+      #   @return [Array<Orb::Models::Subscription::DiscountInterval::Amount, Orb::Models::Subscription::DiscountInterval::Percentage, Orb::Models::Subscription::DiscountInterval::Usage>]
       required :discount_intervals,
                -> { Orb::Internal::Type::ArrayOf[union: Orb::Subscription::DiscountInterval] }
 
@@ -114,7 +114,7 @@ module Orb
 
       # @!attribute fixed_fee_quantity_schedule
       #
-      #   @return [Array<Orb::Subscription::FixedFeeQuantitySchedule>]
+      #   @return [Array<Orb::Models::Subscription::FixedFeeQuantitySchedule>]
       required :fixed_fee_quantity_schedule,
                -> { Orb::Internal::Type::ArrayOf[Orb::Subscription::FixedFeeQuantitySchedule] }
 
@@ -126,7 +126,7 @@ module Orb
       # @!attribute maximum_intervals
       #   The maximum intervals for this subscription sorted by the start_date.
       #
-      #   @return [Array<Orb::Subscription::MaximumInterval>]
+      #   @return [Array<Orb::Models::Subscription::MaximumInterval>]
       required :maximum_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::Subscription::MaximumInterval] }
 
       # @!attribute metadata
@@ -141,7 +141,7 @@ module Orb
       # @!attribute minimum_intervals
       #   The minimum intervals for this subscription sorted by the start_date.
       #
-      #   @return [Array<Orb::Subscription::MinimumInterval>]
+      #   @return [Array<Orb::Models::Subscription::MinimumInterval>]
       required :minimum_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::Subscription::MinimumInterval] }
 
       # @!attribute net_terms
@@ -156,7 +156,7 @@ module Orb
       # @!attribute pending_subscription_change
       #   A pending subscription change if one exists on this subscription.
       #
-      #   @return [Orb::Subscription::PendingSubscriptionChange, nil]
+      #   @return [Orb::Models::Subscription::PendingSubscriptionChange, nil]
       required :pending_subscription_change, -> { Orb::Subscription::PendingSubscriptionChange }, nil?: true
 
       # @!attribute plan
@@ -165,18 +165,18 @@ module Orb
       #   subscription. You can see more about how to configure prices in the
       #   [Price resource](/reference/price).
       #
-      #   @return [Orb::Plan]
+      #   @return [Orb::Models::Plan]
       required :plan, -> { Orb::Plan }
 
       # @!attribute price_intervals
       #   The price intervals for this subscription.
       #
-      #   @return [Array<Orb::Subscription::PriceInterval>]
+      #   @return [Array<Orb::Models::Subscription::PriceInterval>]
       required :price_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::Subscription::PriceInterval] }
 
       # @!attribute redeemed_coupon
       #
-      #   @return [Orb::Subscription::RedeemedCoupon, nil]
+      #   @return [Orb::Models::Subscription::RedeemedCoupon, nil]
       required :redeemed_coupon, -> { Orb::Subscription::RedeemedCoupon }, nil?: true
 
       # @!attribute start_date
@@ -187,17 +187,17 @@ module Orb
 
       # @!attribute status
       #
-      #   @return [Symbol, Orb::Subscription::Status]
+      #   @return [Symbol, Orb::Models::Subscription::Status]
       required :status, enum: -> { Orb::Subscription::Status }
 
       # @!attribute trial_info
       #
-      #   @return [Orb::Subscription::TrialInfo]
+      #   @return [Orb::Models::Subscription::TrialInfo]
       required :trial_info, -> { Orb::Subscription::TrialInfo }
 
       # @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:)
-      #   Some parameter documentations has been truncated, see {Orb::Subscription} for
-      #   more details.
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::Subscription} for more details.
       #
       #   A [subscription](/core-concepts#subscription) represents the purchase of a plan
       #   by a customer.
@@ -223,11 +223,11 @@ module Orb
       #
       #   @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase
       #
-      #   @param adjustment_intervals [Array<Orb::Subscription::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
+      #   @param adjustment_intervals [Array<Orb::Models::Subscription::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
       #
       #   @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
       #
-      #   @param billing_cycle_anchor_configuration [Orb::Subscription::BillingCycleAnchorConfiguration]
+      #   @param billing_cycle_anchor_configuration [Orb::Models::Subscription::BillingCycleAnchorConfiguration]
       #
       #   @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
       #
@@ -237,39 +237,39 @@ module Orb
       #
       #   @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
       #
-      #   @param customer [Orb::Customer] A customer is a buyer of your products, and the other party to the billing relat
+      #   @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
       #
       #   @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
       #
-      #   @param discount_intervals [Array<Orb::Subscription::DiscountInterval::Amount, Orb::Subscription::DiscountInterval::Percentage, Orb::Subscription::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
+      #   @param discount_intervals [Array<Orb::Models::Subscription::DiscountInterval::Amount, Orb::Models::Subscription::DiscountInterval::Percentage, Orb::Models::Subscription::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
       #
       #   @param end_date [Time, nil] The date Orb stops billing for this subscription.
       #
-      #   @param fixed_fee_quantity_schedule [Array<Orb::Subscription::FixedFeeQuantitySchedule>]
+      #   @param fixed_fee_quantity_schedule [Array<Orb::Models::Subscription::FixedFeeQuantitySchedule>]
       #
       #   @param invoicing_threshold [String, nil]
       #
-      #   @param maximum_intervals [Array<Orb::Subscription::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
+      #   @param maximum_intervals [Array<Orb::Models::Subscription::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
       #
       #   @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
       #
-      #   @param minimum_intervals [Array<Orb::Subscription::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
+      #   @param minimum_intervals [Array<Orb::Models::Subscription::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
       #
       #   @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
       #
-      #   @param pending_subscription_change [Orb::Subscription::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
+      #   @param pending_subscription_change [Orb::Models::Subscription::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
       #
-      #   @param plan [Orb::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
+      #   @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
       #
-      #   @param price_intervals [Array<Orb::Subscription::PriceInterval>] The price intervals for this subscription.
+      #   @param price_intervals [Array<Orb::Models::Subscription::PriceInterval>] The price intervals for this subscription.
       #
-      #   @param redeemed_coupon [Orb::Subscription::RedeemedCoupon, nil]
+      #   @param redeemed_coupon [Orb::Models::Subscription::RedeemedCoupon, nil]
       #
       #   @param start_date [Time] The date Orb starts billing for this subscription.
       #
-      #   @param status [Symbol, Orb::Subscription::Status]
+      #   @param status [Symbol, Orb::Models::Subscription::Status]
       #
-      #   @param trial_info [Orb::Subscription::TrialInfo]
+      #   @param trial_info [Orb::Models::Subscription::TrialInfo]
 
       class AdjustmentInterval < Orb::Internal::Type::BaseModel
         # @!attribute id
@@ -279,7 +279,7 @@ module Orb
 
         # @!attribute adjustment
         #
-        #   @return [Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Subscription::AdjustmentInterval::Adjustment::Maximum]
+        #   @return [Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum]
         required :adjustment, union: -> { Orb::Subscription::AdjustmentInterval::Adjustment }
 
         # @!attribute applies_to_price_interval_ids
@@ -303,7 +303,7 @@ module Orb
         # @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
         #   @param id [String]
         #
-        #   @param adjustment [Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Subscription::AdjustmentInterval::Adjustment::Maximum]
+        #   @param adjustment [Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum]
         #
         #   @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
         #
@@ -311,7 +311,7 @@ module Orb
         #
         #   @param start_date [Time] The start date of the adjustment interval.
 
-        # @see Orb::Subscription::AdjustmentInterval#adjustment
+        # @see Orb::Models::Subscription::AdjustmentInterval#adjustment
         module Adjustment
           extend Orb::Internal::Type::Union
 
@@ -375,8 +375,8 @@ module Orb
 
             # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
             #   Some parameter documentations has been truncated, see
-            #   {Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount} for more
-            #   details.
+            #   {Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount} for
+            #   more details.
             #
             #   @param id [String]
             #
@@ -438,8 +438,8 @@ module Orb
 
             # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
             #   Some parameter documentations has been truncated, see
-            #   {Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount} for more
-            #   details.
+            #   {Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount} for
+            #   more details.
             #
             #   @param id [String]
             #
@@ -501,8 +501,8 @@ module Orb
 
             # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
             #   Some parameter documentations has been truncated, see
-            #   {Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount} for more
-            #   details.
+            #   {Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount}
+            #   for more details.
             #
             #   @param id [String]
             #
@@ -570,7 +570,8 @@ module Orb
 
             # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
             #   Some parameter documentations has been truncated, see
-            #   {Orb::Subscription::AdjustmentInterval::Adjustment::Minimum} for more details.
+            #   {Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum} for more
+            #   details.
             #
             #   @param id [String]
             #
@@ -634,7 +635,8 @@ module Orb
 
             # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
             #   Some parameter documentations has been truncated, see
-            #   {Orb::Subscription::AdjustmentInterval::Adjustment::Maximum} for more details.
+            #   {Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum} for more
+            #   details.
             #
             #   @param id [String]
             #
@@ -652,23 +654,11 @@ module Orb
           end
 
           # @!method self.variants
-          #   @return [Array(Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Subscription::AdjustmentInterval::Adjustment::Maximum)]
-
-          define_sorbet_constant!(:Variants) do
-            T.type_alias do
-              T.any(
-                Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount,
-                Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount,
-                Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount,
-                Orb::Subscription::AdjustmentInterval::Adjustment::Minimum,
-                Orb::Subscription::AdjustmentInterval::Adjustment::Maximum
-              )
-            end
-          end
+          #   @return [Array(Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum)]
         end
       end
 
-      # @see Orb::Subscription#billing_cycle_anchor_configuration
+      # @see Orb::Models::Subscription#billing_cycle_anchor_configuration
       class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel
         # @!attribute day
         #   The day of the month on which the billing cycle is anchored. If the maximum
@@ -696,7 +686,7 @@ module Orb
 
         # @!method initialize(day:, month: nil, year: nil)
         #   Some parameter documentations has been truncated, see
-        #   {Orb::Subscription::BillingCycleAnchorConfiguration} for more details.
+        #   {Orb::Models::Subscription::BillingCycleAnchorConfiguration} for more details.
         #
         #   @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
         #
@@ -805,7 +795,7 @@ module Orb
 
           # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage)
           #   Some parameter documentations has been truncated, see
-          #   {Orb::Subscription::DiscountInterval::Percentage} for more details.
+          #   {Orb::Models::Subscription::DiscountInterval::Percentage} for more details.
           #
           #   @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
           #
@@ -859,7 +849,7 @@ module Orb
 
           # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage)
           #   Some parameter documentations has been truncated, see
-          #   {Orb::Subscription::DiscountInterval::Usage} for more details.
+          #   {Orb::Models::Subscription::DiscountInterval::Usage} for more details.
           #
           #   @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
           #
@@ -875,17 +865,7 @@ module Orb
         end
 
         # @!method self.variants
-        #   @return [Array(Orb::Subscription::DiscountInterval::Amount, Orb::Subscription::DiscountInterval::Percentage, Orb::Subscription::DiscountInterval::Usage)]
-
-        define_sorbet_constant!(:Variants) do
-          T.type_alias do
-            T.any(
-              Orb::Subscription::DiscountInterval::Amount,
-              Orb::Subscription::DiscountInterval::Percentage,
-              Orb::Subscription::DiscountInterval::Usage
-            )
-          end
-        end
+        #   @return [Array(Orb::Models::Subscription::DiscountInterval::Amount, Orb::Models::Subscription::DiscountInterval::Percentage, Orb::Models::Subscription::DiscountInterval::Usage)]
       end
 
       class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
@@ -950,7 +930,7 @@ module Orb
 
         # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:)
         #   Some parameter documentations has been truncated, see
-        #   {Orb::Subscription::MaximumInterval} for more details.
+        #   {Orb::Models::Subscription::MaximumInterval} for more details.
         #
         #   @param applies_to_price_ids [Array<String>] The price ids that this maximum interval applies to.
         #
@@ -997,7 +977,7 @@ module Orb
 
         # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:)
         #   Some parameter documentations has been truncated, see
-        #   {Orb::Subscription::MinimumInterval} for more details.
+        #   {Orb::Models::Subscription::MinimumInterval} for more details.
         #
         #   @param applies_to_price_ids [Array<String>] The price ids that this minimum interval applies to.
         #
@@ -1010,7 +990,7 @@ module Orb
         #   @param start_date [Time] The start date of the minimum interval.
       end
 
-      # @see Orb::Subscription#pending_subscription_change
+      # @see Orb::Models::Subscription#pending_subscription_change
       class PendingSubscriptionChange < Orb::Internal::Type::BaseModel
         # @!attribute id
         #
@@ -1068,7 +1048,7 @@ module Orb
         #   The fixed fee quantity transitions for this price interval. This is only
         #   relevant for fixed fees.
         #
-        #   @return [Array<Orb::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil]
+        #   @return [Array<Orb::Models::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil]
         required :fixed_fee_quantity_transitions,
                  -> {
                    Orb::Internal::Type::ArrayOf[Orb::Subscription::PriceInterval::FixedFeeQuantityTransition]
@@ -1087,7 +1067,7 @@ module Orb
         #   For more on the types of prices, see
         #   [the core concepts documentation](/core-concepts#plan-and-price)
         #
-        #   @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk]
+        #   @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 start_date
@@ -1106,7 +1086,7 @@ module Orb
 
         # @!method initialize(id:, billing_cycle_day:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:)
         #   Some parameter documentations has been truncated, see
-        #   {Orb::Subscription::PriceInterval} for more details.
+        #   {Orb::Models::Subscription::PriceInterval} for more details.
         #
         #   The Price Interval resource represents a period of time for which a price will
         #   bill on a subscription. A subscription’s price intervals define its billing
@@ -1124,9 +1104,9 @@ module Orb
         #
         #   @param filter [String, nil] An additional filter to apply to usage queries.
         #
-        #   @param fixed_fee_quantity_transitions [Array<Orb::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
+        #   @param fixed_fee_quantity_transitions [Array<Orb::Models::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
         #
-        #   @param price [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
+        #   @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 resource represents a price that can be billed on a subscription, resu
         #
         #   @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
         #
@@ -1155,7 +1135,7 @@ module Orb
         end
       end
 
-      # @see Orb::Subscription#redeemed_coupon
+      # @see Orb::Models::Subscription#redeemed_coupon
       class RedeemedCoupon < Orb::Internal::Type::BaseModel
         # @!attribute coupon_id
         #
@@ -1178,7 +1158,7 @@ module Orb
         #   @param start_date [Time]
       end
 
-      # @see Orb::Subscription#status
+      # @see Orb::Models::Subscription#status
       module Status
         extend Orb::Internal::Type::Enum
 
@@ -1190,7 +1170,7 @@ module Orb
         #   @return [Array<Symbol>]
       end
 
-      # @see Orb::Subscription#trial_info
+      # @see Orb::Models::Subscription#trial_info
       class TrialInfo < Orb::Internal::Type::BaseModel
         # @!attribute end_date
         #

data/lib/orb/models/subscription_cancel_params.rb

@@ -10,7 +10,7 @@ module Orb
       # @!attribute cancel_option
       #   Determines the timing of subscription cancellation
       #
-      #   @return [Symbol, Orb::SubscriptionCancelParams::CancelOption]
+      #   @return [Symbol, Orb::Models::SubscriptionCancelParams::CancelOption]
       required :cancel_option, enum: -> { Orb::SubscriptionCancelParams::CancelOption }
 
       # @!attribute allow_invoice_credit_or_void
@@ -32,7 +32,7 @@ module Orb
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::SubscriptionCancelParams} for more details.
       #
-      #   @param cancel_option [Symbol, Orb::SubscriptionCancelParams::CancelOption] Determines the timing of subscription cancellation
+      #   @param cancel_option [Symbol, Orb::Models::SubscriptionCancelParams::CancelOption] Determines the timing of subscription cancellation
       #
       #   @param allow_invoice_credit_or_void [Boolean, nil] If false, this request will fail if it would void an issued invoice or create a
       #

data/lib/orb/models/subscription_cancel_response.rb

@@ -88,7 +88,7 @@ module Orb
       #   your account's timezone. See [Timezone localization](/essentials/timezones) for
       #   information on what this timezone parameter influences within Orb.
       #
-      #   @return [Orb::Customer]
+      #   @return [Orb::Models::Customer]
       required :customer, -> { Orb::Customer }
 
       # @!attribute default_invoice_memo
@@ -168,7 +168,7 @@ module Orb
       #   subscription. You can see more about how to configure prices in the
       #   [Price resource](/reference/price).
       #
-      #   @return [Orb::Plan]
+      #   @return [Orb::Models::Plan]
       required :plan, -> { Orb::Plan }
 
       # @!attribute price_intervals
@@ -229,7 +229,7 @@ module Orb
       #
       #   @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
       #
-      #   @param customer [Orb::Customer] A customer is a buyer of your products, and the other party to the billing relat
+      #   @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
       #
       #   @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
       #
@@ -251,7 +251,7 @@ module Orb
       #
       #   @param pending_subscription_change [Orb::Models::SubscriptionCancelResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
       #
-      #   @param plan [Orb::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
+      #   @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
       #
       #   @param price_intervals [Array<Orb::Models::SubscriptionCancelResponse::PriceInterval>] The price intervals for this subscription.
       #
@@ -650,18 +650,6 @@ module Orb
 
           # @!method self.variants
           #   @return [Array(Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::Maximum)]
-
-          define_sorbet_constant!(:Variants) do
-            T.type_alias do
-              T.any(
-                Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::UsageDiscount,
-                Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::AmountDiscount,
-                Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
-                Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::Minimum,
-                Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::Maximum
-              )
-            end
-          end
         end
       end
 
@@ -876,16 +864,6 @@ module Orb
 
         # @!method self.variants
         #   @return [Array(Orb::Models::SubscriptionCancelResponse::DiscountInterval::Amount, Orb::Models::SubscriptionCancelResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionCancelResponse::DiscountInterval::Usage)]
-
-        define_sorbet_constant!(:Variants) do
-          T.type_alias do
-            T.any(
-              Orb::Models::SubscriptionCancelResponse::DiscountInterval::Amount,
-              Orb::Models::SubscriptionCancelResponse::DiscountInterval::Percentage,
-              Orb::Models::SubscriptionCancelResponse::DiscountInterval::Usage
-            )
-          end
-        end
       end
 
       class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
@@ -1085,7 +1063,7 @@ module Orb
         #   For more on the types of prices, see
         #   [the core concepts documentation](/core-concepts#plan-and-price)
         #
-        #   @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk]
+        #   @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 start_date
@@ -1124,7 +1102,7 @@ module Orb
         #
         #   @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionCancelResponse::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
         #
-        #   @param price [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
+        #   @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 resource represents a price that can be billed on a subscription, resu
         #
         #   @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
         #
@@ -1204,25 +1182,25 @@ module Orb
         # @!attribute created_credit_notes
         #   The credit notes that were created as part of this operation.
         #
-        #   @return [Array<Orb::CreditNote>]
+        #   @return [Array<Orb::Models::CreditNote>]
         required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
 
         # @!attribute created_invoices
         #   The invoices that were created as part of this operation.
         #
-        #   @return [Array<Orb::Invoice>]
+        #   @return [Array<Orb::Models::Invoice>]
         required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
 
         # @!attribute voided_credit_notes
         #   The credit notes that were voided as part of this operation.
         #
-        #   @return [Array<Orb::CreditNote>]
+        #   @return [Array<Orb::Models::CreditNote>]
         required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
 
         # @!attribute voided_invoices
         #   The invoices that were voided as part of this operation.
         #
-        #   @return [Array<Orb::Invoice>]
+        #   @return [Array<Orb::Models::Invoice>]
         required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
 
         # @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:)
@@ -1230,13 +1208,13 @@ module Orb
         #   fetched through the subscription changes API or if the
         #   `include_changed_resources` parameter was passed in the request.
         #
-        #   @param created_credit_notes [Array<Orb::CreditNote>] The credit notes that were created as part of this operation.
+        #   @param created_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were created as part of this operation.
         #
-        #   @param created_invoices [Array<Orb::Invoice>] The invoices that were created as part of this operation.
+        #   @param created_invoices [Array<Orb::Models::Invoice>] The invoices that were created as part of this operation.
         #
-        #   @param voided_credit_notes [Array<Orb::CreditNote>] The credit notes that were voided as part of this operation.
+        #   @param voided_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were voided as part of this operation.
         #
-        #   @param voided_invoices [Array<Orb::Invoice>] The invoices that were voided as part of this operation.
+        #   @param voided_invoices [Array<Orb::Models::Invoice>] The invoices that were voided as part of this operation.
       end
     end
   end