orb-billing 0.3.1 → 0.4.0

data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb

@@ -88,8 +88,8 @@ module Orb
       #   your account's timezone. See [Timezone localization](/essentials/timezones) for
       #   information on what this timezone parameter influences within Orb.
       #
-      #   @return [Orb::Models::Customer]
-      required :customer, -> { Orb::Models::Customer }
+      #   @return [Orb::Customer]
+      required :customer, -> { Orb::Customer }
 
       # @!attribute default_invoice_memo
       #   Determines the default memo on this subscriptions' invoices. Note that if this
@@ -168,8 +168,8 @@ module Orb
       #   subscription. You can see more about how to configure prices in the
       #   [Price resource](/reference/price).
       #
-      #   @return [Orb::Models::Plan]
-      required :plan, -> { Orb::Models::Plan }
+      #   @return [Orb::Plan]
+      required :plan, -> { Orb::Plan }
 
       # @!attribute price_intervals
       #   The price intervals for this subscription.
@@ -219,32 +219,24 @@ module Orb
       #   @param id [String]
       #
       #   @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::Models::SubscriptionUnschedulePendingPlanChangesResponse::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::Models::SubscriptionUnschedulePendingPlanChangesResponse::BillingCycleAnchorConfiguration]
       #
       #   @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
-      #   ...
       #
       #   @param created_at [Time]
       #
       #   @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
-      #   ...
       #
       #   @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::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
-      #   ...
+      #   @param customer [Orb::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::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
       #
@@ -257,17 +249,14 @@ module Orb
       #   @param maximum_intervals [Array<Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::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::Models::SubscriptionUnschedulePendingPlanChangesResponse::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::Models::SubscriptionUnschedulePendingPlanChangesResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
       #
-      #   @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
-      #   ...
+      #   @param plan [Orb::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
       #
       #   @param price_intervals [Array<Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PriceInterval>] The price intervals for this subscription.
       #
@@ -280,7 +269,6 @@ module Orb
       #   @param trial_info [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::TrialInfo]
       #
       #   @param changed_resources [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet
-      #   ...
 
       class AdjustmentInterval < Orb::Internal::Type::BaseModel
         # @!attribute id
@@ -397,14 +385,12 @@ module Orb
             #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
             #
             #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
-            #   ...
             #
             #   @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
             #
             #   @param reason [String, nil] The reason for the adjustment.
             #
             #   @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
-            #   ...
             #
             #   @param adjustment_type [Symbol, :usage_discount]
           end
@@ -460,12 +446,10 @@ module Orb
             #   @param id [String]
             #
             #   @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
-            #   ...
             #
             #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
             #
             #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
-            #   ...
             #
             #   @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
             #
@@ -527,10 +511,8 @@ module Orb
             #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
             #
             #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
-            #   ...
             #
             #   @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
-            #   ...
             #
             #   @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
             #
@@ -598,12 +580,10 @@ module Orb
             #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
             #
             #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
-            #   ...
             #
             #   @param item_id [String] The item ID that revenue from this minimum will be attributed to.
             #
             #   @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
-            #   ...
             #
             #   @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
             #
@@ -665,10 +645,8 @@ module Orb
             #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
             #
             #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
-            #   ...
             #
             #   @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
-            #   ...
             #
             #   @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
             #
@@ -679,6 +657,18 @@ module Orb
 
           # @!method self.variants
           #   @return [Array(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::Maximum)]
+
+          define_sorbet_constant!(:Variants) do
+            T.type_alias do
+              T.any(
+                Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::UsageDiscount,
+                Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::AmountDiscount,
+                Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
+                Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::Minimum,
+                Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::Maximum
+              )
+            end
+          end
         end
       end
 
@@ -714,13 +704,10 @@ module Orb
         #   for more details.
         #
         #   @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
-        #   ...
         #
         #   @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore
-        #   ...
         #
         #   @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc
-        #   ...
       end
 
       module DiscountInterval
@@ -836,7 +823,6 @@ module Orb
           #   @param end_date [Time, nil] The end date of the discount interval.
           #
           #   @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1
-          #   ...
           #
           #   @param start_date [Time] The start date of the discount interval.
           #
@@ -894,13 +880,22 @@ module Orb
           #   @param start_date [Time] The start date of the discount interval.
           #
           #   @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
-          #   ...
           #
           #   @param discount_type [Symbol, :usage]
         end
 
         # @!method self.variants
         #   @return [Array(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Usage)]
+
+        define_sorbet_constant!(:Variants) do
+          T.type_alias do
+            T.any(
+              Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Amount,
+              Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Percentage,
+              Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Usage
+            )
+          end
+        end
       end
 
       class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
@@ -975,7 +970,6 @@ module Orb
         #   @param end_date [Time, nil] The end date of the maximum interval.
         #
         #   @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t
-        #   ...
         #
         #   @param start_date [Time] The start date of the maximum interval.
       end
@@ -1024,7 +1018,6 @@ module Orb
         #   @param end_date [Time, nil] The end date of the minimum interval.
         #
         #   @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t
-        #   ...
         #
         #   @param start_date [Time] The start date of the minimum interval.
       end
@@ -1104,8 +1097,8 @@ module Orb
         #   For more on the types of prices, see
         #   [the core concepts documentation](/core-concepts#plan-and-price)
         #
-        #   @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::Models::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]
+        required :price, union: -> { Orb::Price }
 
         # @!attribute start_date
         #   The start date of the price interval. This is the date that Orb starts billing
@@ -1135,27 +1128,20 @@ module Orb
         #   @param billing_cycle_day [Integer] The day of the month that Orb bills for this price
         #
         #   @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
-        #   ...
         #
         #   @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
-        #   ...
         #
         #   @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for
-        #   ...
         #
         #   @param filter [String, nil] An additional filter to apply to usage queries.
         #
         #   @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
-        #   ...
         #
-        #   @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 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 start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
-        #   ...
         #
         #   @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
-        #   ...
 
         class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
           # @!attribute effective_date
@@ -1231,39 +1217,39 @@ module Orb
         # @!attribute created_credit_notes
         #   The credit notes that were created as part of this operation.
         #
-        #   @return [Array<Orb::Models::CreditNote>]
-        required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] }
+        #   @return [Array<Orb::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::Models::Invoice>]
-        required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] }
+        #   @return [Array<Orb::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::Models::CreditNote>]
-        required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] }
+        #   @return [Array<Orb::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::Models::Invoice>]
-        required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] }
+        #   @return [Array<Orb::Invoice>]
+        required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
 
         # @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:)
         #   The resources that were changed as part of this operation. Only present when
         #   fetched through the subscription changes API or if the
         #   `include_changed_resources` parameter was passed in the request.
         #
-        #   @param created_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were created as part of this operation.
+        #   @param created_credit_notes [Array<Orb::CreditNote>] The credit notes 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 created_invoices [Array<Orb::Invoice>] The invoices that were created 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_credit_notes [Array<Orb::CreditNote>] The credit notes 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.
+        #   @param voided_invoices [Array<Orb::Invoice>] The invoices that were voided as part of this operation.
       end
     end
   end

data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb

@@ -31,8 +31,8 @@ module Orb
       #   specified, this defaults to `effective_date`. Otherwise, this defaults to
       #   `immediate` unless it's explicitly set to `upcoming_invoice`.
       #
-      #   @return [Symbol, Orb::Models::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption, nil]
-      optional :change_option, enum: -> { Orb::Models::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption }
+      #   @return [Symbol, Orb::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption, nil]
+      optional :change_option, enum: -> { Orb::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption }
 
       # @!attribute effective_date
       #   The date that the quantity change should take effect, localized to the
@@ -51,13 +51,10 @@ module Orb
       #   @param quantity [Float]
       #
       #   @param allow_invoice_credit_or_void [Boolean, nil] If false, this request will fail if it would void an issued invoice or create a
-      #   ...
       #
-      #   @param change_option [Symbol, Orb::Models::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption] Determines when the change takes effect. Note that if `effective_date` is specif
-      #   ...
+      #   @param change_option [Symbol, Orb::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption] Determines when the change takes effect. Note that if `effective_date` is specif
       #
       #   @param effective_date [Date, nil] The date that the quantity change should take effect, localized to the customer'
-      #   ...
       #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]