orb-billing 0.1.0.pre.alpha.36 → 0.1.0.pre.alpha.37

data/lib/orb/models/subscription.rb

@@ -3,7 +3,7 @@
 module Orb
   module Models
     # @see Orb::Resources::Subscriptions#update
-    class Subscription < Orb::BaseModel
+    class Subscription < Orb::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -21,7 +21,8 @@ module Orb
       #     adjustment interval.
       #
       #   @return [Array<Orb::Models::Subscription::AdjustmentInterval>]
-      required :adjustment_intervals, -> { Orb::ArrayOf[Orb::Models::Subscription::AdjustmentInterval] }
+      required :adjustment_intervals,
+               -> { Orb::Internal::Type::ArrayOf[Orb::Models::Subscription::AdjustmentInterval] }
 
       # @!attribute auto_collection
       #   Determines whether issued invoices for this subscription will automatically be
@@ -29,7 +30,7 @@ module Orb
       #     the plan's behavior. If null, defaults to the customer's setting.
       #
       #   @return [Boolean, nil]
-      required :auto_collection, Orb::BooleanModel, nil?: true
+      required :auto_collection, Orb::Internal::Type::BooleanModel, nil?: true
 
       # @!attribute billing_cycle_anchor_configuration
       #
@@ -101,7 +102,8 @@ module Orb
       #   The discount intervals for this subscription sorted by the start_date.
       #
       #   @return [Array<Orb::Models::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::Subscription::DiscountInterval::UsageDiscountInterval>]
-      required :discount_intervals, -> { Orb::ArrayOf[union: Orb::Models::Subscription::DiscountInterval] }
+      required :discount_intervals,
+               -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::Subscription::DiscountInterval] }
 
       # @!attribute end_date
       #   The date Orb stops billing for this subscription.
@@ -113,7 +115,7 @@ module Orb
       #
       #   @return [Array<Orb::Models::Subscription::FixedFeeQuantitySchedule>]
       required :fixed_fee_quantity_schedule,
-               -> { Orb::ArrayOf[Orb::Models::Subscription::FixedFeeQuantitySchedule] }
+               -> { Orb::Internal::Type::ArrayOf[Orb::Models::Subscription::FixedFeeQuantitySchedule] }
 
       # @!attribute invoicing_threshold
       #
@@ -124,7 +126,8 @@ module Orb
       #   The maximum intervals for this subscription sorted by the start_date.
       #
       #   @return [Array<Orb::Models::Subscription::MaximumInterval>]
-      required :maximum_intervals, -> { Orb::ArrayOf[Orb::Models::Subscription::MaximumInterval] }
+      required :maximum_intervals,
+               -> { Orb::Internal::Type::ArrayOf[Orb::Models::Subscription::MaximumInterval] }
 
       # @!attribute metadata
       #   User specified key-value pairs for the resource. If not present, this defaults
@@ -133,13 +136,14 @@ module Orb
       #     `null`.
       #
       #   @return [Hash{Symbol=>String}]
-      required :metadata, Orb::HashOf[String]
+      required :metadata, Orb::Internal::Type::HashOf[String]
 
       # @!attribute minimum_intervals
       #   The minimum intervals for this subscription sorted by the start_date.
       #
       #   @return [Array<Orb::Models::Subscription::MinimumInterval>]
-      required :minimum_intervals, -> { Orb::ArrayOf[Orb::Models::Subscription::MinimumInterval] }
+      required :minimum_intervals,
+               -> { Orb::Internal::Type::ArrayOf[Orb::Models::Subscription::MinimumInterval] }
 
       # @!attribute net_terms
       #   Determines the difference between the invoice issue date for subscription
@@ -163,7 +167,7 @@ module Orb
       #   The price intervals for this subscription.
       #
       #   @return [Array<Orb::Models::Subscription::PriceInterval>]
-      required :price_intervals, -> { Orb::ArrayOf[Orb::Models::Subscription::PriceInterval] }
+      required :price_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Subscription::PriceInterval] }
 
       # @!attribute redeemed_coupon
       #
@@ -264,9 +268,9 @@ module Orb
       #     super
       #   end
 
-      # def initialize: (Hash | Orb::BaseModel) -> void
+      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
 
-      class AdjustmentInterval < Orb::BaseModel
+      class AdjustmentInterval < Orb::Internal::Type::BaseModel
         # @!attribute id
         #
         #   @return [String]
@@ -281,7 +285,7 @@ module Orb
         #   The price interval IDs that this adjustment applies to.
         #
         #   @return [Array<String>]
-        required :applies_to_price_interval_ids, Orb::ArrayOf[String]
+        required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String]
 
         # @!attribute end_date
         #   The end date of the adjustment interval.
@@ -304,11 +308,11 @@ module Orb
         #   #
         #   def initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:, **) = super
 
-        # def initialize: (Hash | Orb::BaseModel) -> void
+        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
 
         # @see Orb::Models::Subscription::AdjustmentInterval#adjustment
         module Adjustment
-          extend Orb::Union
+          extend Orb::Internal::Type::Union
 
           discriminator :adjustment_type
 
@@ -327,7 +331,7 @@ module Orb
           variant :maximum,
                   -> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment }
 
-          class PlanPhaseUsageDiscountAdjustment < Orb::BaseModel
+          class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel
             # @!attribute id
             #
             #   @return [String]
@@ -342,14 +346,14 @@ module Orb
             #   The price IDs that this adjustment applies to.
             #
             #   @return [Array<String>]
-            required :applies_to_price_ids, Orb::ArrayOf[String]
+            required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
 
             # @!attribute is_invoice_level
             #   True for adjustments that apply to an entire invocice, false for adjustments
             #     that apply to only one price.
             #
             #   @return [Boolean]
-            required :is_invoice_level, Orb::BooleanModel
+            required :is_invoice_level, Orb::Internal::Type::BooleanModel
 
             # @!attribute plan_phase_order
             #   The plan phase in which this adjustment is active.
@@ -392,10 +396,10 @@ module Orb
             #     super
             #   end
 
-            # def initialize: (Hash | Orb::BaseModel) -> void
+            # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
           end
 
-          class PlanPhaseAmountDiscountAdjustment < Orb::BaseModel
+          class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
             # @!attribute id
             #
             #   @return [String]
@@ -417,14 +421,14 @@ module Orb
             #   The price IDs that this adjustment applies to.
             #
             #   @return [Array<String>]
-            required :applies_to_price_ids, Orb::ArrayOf[String]
+            required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
 
             # @!attribute is_invoice_level
             #   True for adjustments that apply to an entire invocice, false for adjustments
             #     that apply to only one price.
             #
             #   @return [Boolean]
-            required :is_invoice_level, Orb::BooleanModel
+            required :is_invoice_level, Orb::Internal::Type::BooleanModel
 
             # @!attribute plan_phase_order
             #   The plan phase in which this adjustment is active.
@@ -460,10 +464,10 @@ module Orb
             #     super
             #   end
 
-            # def initialize: (Hash | Orb::BaseModel) -> void
+            # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
           end
 
-          class PlanPhasePercentageDiscountAdjustment < Orb::BaseModel
+          class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
             # @!attribute id
             #
             #   @return [String]
@@ -478,14 +482,14 @@ module Orb
             #   The price IDs that this adjustment applies to.
             #
             #   @return [Array<String>]
-            required :applies_to_price_ids, Orb::ArrayOf[String]
+            required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
 
             # @!attribute is_invoice_level
             #   True for adjustments that apply to an entire invocice, false for adjustments
             #     that apply to only one price.
             #
             #   @return [Boolean]
-            required :is_invoice_level, Orb::BooleanModel
+            required :is_invoice_level, Orb::Internal::Type::BooleanModel
 
             # @!attribute percentage_discount
             #   The percentage (as a value between 0 and 1) by which to discount the price
@@ -528,10 +532,10 @@ module Orb
             #     super
             #   end
 
-            # def initialize: (Hash | Orb::BaseModel) -> void
+            # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
           end
 
-          class PlanPhaseMinimumAdjustment < Orb::BaseModel
+          class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel
             # @!attribute id
             #
             #   @return [String]
@@ -546,14 +550,14 @@ module Orb
             #   The price IDs that this adjustment applies to.
             #
             #   @return [Array<String>]
-            required :applies_to_price_ids, Orb::ArrayOf[String]
+            required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
 
             # @!attribute is_invoice_level
             #   True for adjustments that apply to an entire invocice, false for adjustments
             #     that apply to only one price.
             #
             #   @return [Boolean]
-            required :is_invoice_level, Orb::BooleanModel
+            required :is_invoice_level, Orb::Internal::Type::BooleanModel
 
             # @!attribute item_id
             #   The item ID that revenue from this minimum will be attributed to.
@@ -604,10 +608,10 @@ module Orb
             #     super
             #   end
 
-            # def initialize: (Hash | Orb::BaseModel) -> void
+            # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
           end
 
-          class PlanPhaseMaximumAdjustment < Orb::BaseModel
+          class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel
             # @!attribute id
             #
             #   @return [String]
@@ -622,14 +626,14 @@ module Orb
             #   The price IDs that this adjustment applies to.
             #
             #   @return [Array<String>]
-            required :applies_to_price_ids, Orb::ArrayOf[String]
+            required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
 
             # @!attribute is_invoice_level
             #   True for adjustments that apply to an entire invocice, false for adjustments
             #     that apply to only one price.
             #
             #   @return [Boolean]
-            required :is_invoice_level, Orb::BooleanModel
+            required :is_invoice_level, Orb::Internal::Type::BooleanModel
 
             # @!attribute maximum_amount
             #   The maximum amount to charge in a given billing period for the prices this
@@ -672,7 +676,7 @@ module Orb
             #     super
             #   end
 
-            # def initialize: (Hash | Orb::BaseModel) -> void
+            # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
           end
 
           # @!parse
@@ -682,7 +686,7 @@ module Orb
       end
 
       # @see Orb::Models::Subscription#billing_cycle_anchor_configuration
-      class BillingCycleAnchorConfiguration < Orb::BaseModel
+      class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel
         # @!attribute day
         #   The day of the month on which the billing cycle is anchored. If the maximum
         #     number of days in a month is greater than this value, the last day of the month
@@ -714,11 +718,11 @@ module Orb
         #   #
         #   def initialize(day:, month: nil, year: nil, **) = super
 
-        # def initialize: (Hash | Orb::BaseModel) -> void
+        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
       end
 
       module DiscountInterval
-        extend Orb::Union
+        extend Orb::Internal::Type::Union
 
         discriminator :discount_type
 
@@ -728,7 +732,7 @@ module Orb
 
         variant :usage, -> { Orb::Models::Subscription::DiscountInterval::UsageDiscountInterval }
 
-        class AmountDiscountInterval < Orb::BaseModel
+        class AmountDiscountInterval < Orb::Internal::Type::BaseModel
           # @!attribute amount_discount
           #   Only available if discount_type is `amount`.
           #
@@ -739,13 +743,13 @@ module Orb
           #   The price ids that this discount interval applies to.
           #
           #   @return [Array<String>]
-          required :applies_to_price_ids, Orb::ArrayOf[String]
+          required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
 
           # @!attribute applies_to_price_interval_ids
           #   The price interval ids that this discount interval applies to.
           #
           #   @return [Array<String>]
-          required :applies_to_price_interval_ids, Orb::ArrayOf[String]
+          required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String]
 
           # @!attribute discount_type
           #
@@ -784,21 +788,21 @@ module Orb
           #     super
           #   end
 
-          # def initialize: (Hash | Orb::BaseModel) -> void
+          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
         end
 
-        class PercentageDiscountInterval < Orb::BaseModel
+        class PercentageDiscountInterval < Orb::Internal::Type::BaseModel
           # @!attribute applies_to_price_ids
           #   The price ids that this discount interval applies to.
           #
           #   @return [Array<String>]
-          required :applies_to_price_ids, Orb::ArrayOf[String]
+          required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
 
           # @!attribute applies_to_price_interval_ids
           #   The price interval ids that this discount interval applies to.
           #
           #   @return [Array<String>]
-          required :applies_to_price_interval_ids, Orb::ArrayOf[String]
+          required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String]
 
           # @!attribute discount_type
           #
@@ -844,21 +848,21 @@ module Orb
           #     super
           #   end
 
-          # def initialize: (Hash | Orb::BaseModel) -> void
+          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
         end
 
-        class UsageDiscountInterval < Orb::BaseModel
+        class UsageDiscountInterval < Orb::Internal::Type::BaseModel
           # @!attribute applies_to_price_ids
           #   The price ids that this discount interval applies to.
           #
           #   @return [Array<String>]
-          required :applies_to_price_ids, Orb::ArrayOf[String]
+          required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
 
           # @!attribute applies_to_price_interval_ids
           #   The price interval ids that this discount interval applies to.
           #
           #   @return [Array<String>]
-          required :applies_to_price_interval_ids, Orb::ArrayOf[String]
+          required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String]
 
           # @!attribute discount_type
           #
@@ -904,7 +908,7 @@ module Orb
           #     super
           #   end
 
-          # def initialize: (Hash | Orb::BaseModel) -> void
+          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
         end
 
         # @!parse
@@ -912,7 +916,7 @@ module Orb
         #   def self.variants; end
       end
 
-      class FixedFeeQuantitySchedule < Orb::BaseModel
+      class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
         # @!attribute end_date
         #
         #   @return [Time, nil]
@@ -941,21 +945,21 @@ module Orb
         #   #
         #   def initialize(end_date:, price_id:, quantity:, start_date:, **) = super
 
-        # def initialize: (Hash | Orb::BaseModel) -> void
+        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
       end
 
-      class MaximumInterval < Orb::BaseModel
+      class MaximumInterval < Orb::Internal::Type::BaseModel
         # @!attribute applies_to_price_ids
         #   The price ids that this maximum interval applies to.
         #
         #   @return [Array<String>]
-        required :applies_to_price_ids, Orb::ArrayOf[String]
+        required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
 
         # @!attribute applies_to_price_interval_ids
         #   The price interval ids that this maximum interval applies to.
         #
         #   @return [Array<String>]
-        required :applies_to_price_interval_ids, Orb::ArrayOf[String]
+        required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String]
 
         # @!attribute end_date
         #   The end date of the maximum interval.
@@ -985,21 +989,21 @@ module Orb
         #   #
         #   def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:, **) = super
 
-        # def initialize: (Hash | Orb::BaseModel) -> void
+        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
       end
 
-      class MinimumInterval < Orb::BaseModel
+      class MinimumInterval < Orb::Internal::Type::BaseModel
         # @!attribute applies_to_price_ids
         #   The price ids that this minimum interval applies to.
         #
         #   @return [Array<String>]
-        required :applies_to_price_ids, Orb::ArrayOf[String]
+        required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
 
         # @!attribute applies_to_price_interval_ids
         #   The price interval ids that this minimum interval applies to.
         #
         #   @return [Array<String>]
-        required :applies_to_price_interval_ids, Orb::ArrayOf[String]
+        required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String]
 
         # @!attribute end_date
         #   The end date of the minimum interval.
@@ -1029,10 +1033,10 @@ module Orb
         #   #
         #   def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:, **) = super
 
-        # def initialize: (Hash | Orb::BaseModel) -> void
+        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
       end
 
-      class PriceInterval < Orb::BaseModel
+      class PriceInterval < Orb::Internal::Type::BaseModel
         # @!attribute id
         #
         #   @return [String]
@@ -1079,7 +1083,7 @@ module Orb
         #
         #   @return [Array<Orb::Models::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil]
         required :fixed_fee_quantity_transitions,
-                 -> { Orb::ArrayOf[Orb::Models::Subscription::PriceInterval::FixedFeeQuantityTransition] },
+                 -> { Orb::Internal::Type::ArrayOf[Orb::Models::Subscription::PriceInterval::FixedFeeQuantityTransition] },
                  nil?: true
 
         # @!attribute price
@@ -1109,7 +1113,7 @@ module Orb
         #     this price interval.
         #
         #   @return [Array<String>, nil]
-        required :usage_customer_ids, Orb::ArrayOf[String], nil?: true
+        required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
 
         # @!parse
         #   # The Price Interval resource represents a period of time for which a price will
@@ -1143,9 +1147,9 @@ module Orb
         #     super
         #   end
 
-        # def initialize: (Hash | Orb::BaseModel) -> void
+        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
 
-        class FixedFeeQuantityTransition < Orb::BaseModel
+        class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
           # @!attribute effective_date
           #
           #   @return [Time]
@@ -1168,12 +1172,12 @@ module Orb
           #   #
           #   def initialize(effective_date:, price_id:, quantity:, **) = super
 
-          # def initialize: (Hash | Orb::BaseModel) -> void
+          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
         end
       end
 
       # @see Orb::Models::Subscription#redeemed_coupon
-      class RedeemedCoupon < Orb::BaseModel
+      class RedeemedCoupon < Orb::Internal::Type::BaseModel
         # @!attribute coupon_id
         #
         #   @return [String]
@@ -1196,12 +1200,12 @@ module Orb
         #   #
         #   def initialize(coupon_id:, end_date:, start_date:, **) = super
 
-        # def initialize: (Hash | Orb::BaseModel) -> void
+        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
       end
 
       # @see Orb::Models::Subscription#status
       module Status
-        extend Orb::Enum
+        extend Orb::Internal::Type::Enum
 
         ACTIVE = :active
         ENDED = :ended
@@ -1215,7 +1219,7 @@ module Orb
       end
 
       # @see Orb::Models::Subscription#trial_info
-      class TrialInfo < Orb::BaseModel
+      class TrialInfo < Orb::Internal::Type::BaseModel
         # @!attribute end_date
         #
         #   @return [Time, nil]
@@ -1226,7 +1230,7 @@ module Orb
         #   #
         #   def initialize(end_date:, **) = super
 
-        # def initialize: (Hash | Orb::BaseModel) -> void
+        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
       end
     end
   end

data/lib/orb/models/subscription_cancel_params.rb

@@ -3,10 +3,10 @@
 module Orb
   module Models
     # @see Orb::Resources::Subscriptions#cancel
-    class SubscriptionCancelParams < Orb::BaseModel
+    class SubscriptionCancelParams < Orb::Internal::Type::BaseModel
       # @!parse
-      #   extend Orb::Type::RequestParameters::Converter
-      include Orb::RequestParameters
+      #   extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
 
       # @!attribute cancel_option
       #   Determines the timing of subscription cancellation
@@ -20,7 +20,7 @@ module Orb
       #     existing invoices to be changed.
       #
       #   @return [Boolean, nil]
-      optional :allow_invoice_credit_or_void, Orb::BooleanModel, nil?: true
+      optional :allow_invoice_credit_or_void, Orb::Internal::Type::BooleanModel, nil?: true
 
       # @!attribute cancellation_date
       #   The date that the cancellation should take effect. This parameter can only be
@@ -37,11 +37,11 @@ module Orb
       #   #
       #   def initialize(cancel_option:, allow_invoice_credit_or_void: nil, cancellation_date: nil, request_options: {}, **) = super
 
-      # def initialize: (Hash | Orb::BaseModel) -> void
+      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
 
       # Determines the timing of subscription cancellation
       module CancelOption
-        extend Orb::Enum
+        extend Orb::Internal::Type::Enum
 
         END_OF_SUBSCRIPTION_TERM = :end_of_subscription_term
         IMMEDIATE = :immediate