orb-billing 0.2.0 → 0.3.1

data/lib/orb/models/subscription_usage.rb

@@ -17,12 +17,8 @@ module Orb
         required :data,
                  -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data] }
 
-        # @!parse
-        #   # @param data [Array<Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data>]
-        #   #
-        #   def initialize(data:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(data:)
+        #   @param data [Array<Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data>]
 
         class Data < Orb::Internal::Type::BaseModel
           # @!attribute billable_metric
@@ -43,14 +39,10 @@ module Orb
           required :view_mode,
                    enum: -> { Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::ViewMode }
 
-          # @!parse
-          #   # @param billable_metric [Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::BillableMetric]
-          #   # @param usage [Array<Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::Usage>]
-          #   # @param view_mode [Symbol, Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::ViewMode]
-          #   #
-          #   def initialize(billable_metric:, usage:, view_mode:, **) = super
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(billable_metric:, usage:, view_mode:)
+          #   @param billable_metric [Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::BillableMetric]
+          #   @param usage [Array<Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::Usage>]
+          #   @param view_mode [Symbol, Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::ViewMode]
 
           # @see Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data#billable_metric
           class BillableMetric < Orb::Internal::Type::BaseModel
@@ -64,13 +56,9 @@ module Orb
             #   @return [String]
             required :name, String
 
-            # @!parse
-            #   # @param id [String]
-            #   # @param name [String]
-            #   #
-            #   def initialize(id:, name:, **) = super
-
-            # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+            # @!method initialize(id:, name:)
+            #   @param id [String]
+            #   @param name [String]
           end
 
           class Usage < Orb::Internal::Type::BaseModel
@@ -89,14 +77,10 @@ module Orb
             #   @return [Time]
             required :timeframe_start, Time
 
-            # @!parse
-            #   # @param quantity [Float]
-            #   # @param timeframe_end [Time]
-            #   # @param timeframe_start [Time]
-            #   #
-            #   def initialize(quantity:, timeframe_end:, timeframe_start:, **) = super
-
-            # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+            # @!method initialize(quantity:, timeframe_end:, timeframe_start:)
+            #   @param quantity [Float]
+            #   @param timeframe_end [Time]
+            #   @param timeframe_start [Time]
           end
 
           # @see Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data#view_mode
@@ -106,11 +90,8 @@ module Orb
             PERIODIC = :periodic
             CUMULATIVE = :cumulative
 
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
+            # @!method self.values
+            #   @return [Array<Symbol>]
           end
         end
       end
@@ -127,13 +108,9 @@ module Orb
         #   @return [Orb::Models::PaginationMetadata, nil]
         optional :pagination_metadata, -> { Orb::Models::PaginationMetadata }, nil?: true
 
-        # @!parse
-        #   # @param data [Array<Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data>]
-        #   # @param pagination_metadata [Orb::Models::PaginationMetadata, nil]
-        #   #
-        #   def initialize(data:, pagination_metadata: nil, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(data:, pagination_metadata: nil)
+        #   @param data [Array<Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data>]
+        #   @param pagination_metadata [Orb::Models::PaginationMetadata, nil]
 
         class Data < Orb::Internal::Type::BaseModel
           # @!attribute billable_metric
@@ -158,15 +135,11 @@ module Orb
           #   @return [Symbol, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode]
           required :view_mode, enum: -> { Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode }
 
-          # @!parse
-          #   # @param billable_metric [Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::BillableMetric]
-          #   # @param metric_group [Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::MetricGroup]
-          #   # @param usage [Array<Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::Usage>]
-          #   # @param view_mode [Symbol, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode]
-          #   #
-          #   def initialize(billable_metric:, metric_group:, usage:, view_mode:, **) = super
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(billable_metric:, metric_group:, usage:, view_mode:)
+          #   @param billable_metric [Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::BillableMetric]
+          #   @param metric_group [Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::MetricGroup]
+          #   @param usage [Array<Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::Usage>]
+          #   @param view_mode [Symbol, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode]
 
           # @see Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data#billable_metric
           class BillableMetric < Orb::Internal::Type::BaseModel
@@ -180,13 +153,9 @@ module Orb
             #   @return [String]
             required :name, String
 
-            # @!parse
-            #   # @param id [String]
-            #   # @param name [String]
-            #   #
-            #   def initialize(id:, name:, **) = super
-
-            # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+            # @!method initialize(id:, name:)
+            #   @param id [String]
+            #   @param name [String]
           end
 
           # @see Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data#metric_group
@@ -201,13 +170,9 @@ module Orb
             #   @return [String]
             required :property_value, String
 
-            # @!parse
-            #   # @param property_key [String]
-            #   # @param property_value [String]
-            #   #
-            #   def initialize(property_key:, property_value:, **) = super
-
-            # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+            # @!method initialize(property_key:, property_value:)
+            #   @param property_key [String]
+            #   @param property_value [String]
           end
 
           class Usage < Orb::Internal::Type::BaseModel
@@ -226,14 +191,10 @@ module Orb
             #   @return [Time]
             required :timeframe_start, Time
 
-            # @!parse
-            #   # @param quantity [Float]
-            #   # @param timeframe_end [Time]
-            #   # @param timeframe_start [Time]
-            #   #
-            #   def initialize(quantity:, timeframe_end:, timeframe_start:, **) = super
-
-            # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+            # @!method initialize(quantity:, timeframe_end:, timeframe_start:)
+            #   @param quantity [Float]
+            #   @param timeframe_end [Time]
+            #   @param timeframe_start [Time]
           end
 
           # @see Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data#view_mode
@@ -243,18 +204,14 @@ module Orb
             PERIODIC = :periodic
             CUMULATIVE = :cumulative
 
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
+            # @!method self.values
+            #   @return [Array<Symbol>]
           end
         end
       end
 
-      # @!parse
-      #   # @return [Array(Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage)]
-      #   def self.variants; end
+      # @!method self.variants
+      #   @return [Array(Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage)]
     end
   end
 end

data/lib/orb/models/subscriptions.rb

@@ -13,13 +13,9 @@ module Orb
       #   @return [Orb::Models::PaginationMetadata]
       required :pagination_metadata, -> { Orb::Models::PaginationMetadata }
 
-      # @!parse
-      #   # @param data [Array<Orb::Models::Subscription>]
-      #   # @param pagination_metadata [Orb::Models::PaginationMetadata]
-      #   #
-      #   def initialize(data:, pagination_metadata:, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(data:, pagination_metadata:)
+      #   @param data [Array<Orb::Models::Subscription>]
+      #   @param pagination_metadata [Orb::Models::PaginationMetadata]
     end
   end
 end

data/lib/orb/models/top_level_ping_params.rb

@@ -4,16 +4,11 @@ module Orb
   module Models
     # @see Orb::Resources::TopLevel#ping
     class TopLevelPingParams < Orb::Internal::Type::BaseModel
-      # @!parse
-      #   extend Orb::Internal::Type::RequestParameters::Converter
+      extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
-      # @!parse
-      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(request_options: {}, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(request_options: {})
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/orb/models/top_level_ping_response.rb

@@ -9,12 +9,8 @@ module Orb
       #   @return [String]
       required :response, String
 
-      # @!parse
-      #   # @param response [String]
-      #   #
-      #   def initialize(response:, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(response:)
+      #   @param response [String]
     end
   end
 end

data/lib/orb/models/trial_discount.rb

@@ -32,25 +32,20 @@ module Orb
       #   @return [Float, nil]
       optional :trial_percentage_discount, Float, nil?: true
 
-      # @!parse
-      #   # @param applies_to_price_ids [Array<String>]
-      #   # @param discount_type [Symbol, Orb::Models::TrialDiscount::DiscountType]
-      #   # @param reason [String, nil]
-      #   # @param trial_amount_discount [String, nil]
-      #   # @param trial_percentage_discount [Float, nil]
-      #   #
-      #   def initialize(
-      #     applies_to_price_ids:,
-      #     discount_type:,
-      #     reason: nil,
-      #     trial_amount_discount: nil,
-      #     trial_percentage_discount: nil,
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(applies_to_price_ids:, discount_type:, reason: nil, trial_amount_discount: nil, trial_percentage_discount: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::TrialDiscount} for more details.
+      #
+      #   @param applies_to_price_ids [Array<String>] List of price_ids that this discount applies to. For plan/plan phase discounts,
+      #   ...
+      #
+      #   @param discount_type [Symbol, Orb::Models::TrialDiscount::DiscountType]
+      #
+      #   @param reason [String, nil]
+      #
+      #   @param trial_amount_discount [String, nil] Only available if discount_type is `trial`
+      #
+      #   @param trial_percentage_discount [Float, nil] Only available if discount_type is `trial`
 
       # @see Orb::Models::TrialDiscount#discount_type
       module DiscountType
@@ -58,11 +53,8 @@ module Orb
 
         TRIAL = :trial
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end

data/lib/orb/models/usage_discount.rb

@@ -27,15 +27,19 @@ module Orb
       #   @return [String, nil]
       optional :reason, String, nil?: true
 
-      # @!parse
-      #   # @param applies_to_price_ids [Array<String>]
-      #   # @param discount_type [Symbol, Orb::Models::UsageDiscount::DiscountType]
-      #   # @param usage_discount [Float]
-      #   # @param reason [String, nil]
-      #   #
-      #   def initialize(applies_to_price_ids:, discount_type:, usage_discount:, reason: nil, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(applies_to_price_ids:, discount_type:, usage_discount:, reason: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::UsageDiscount} for more details.
+      #
+      #   @param applies_to_price_ids [Array<String>] List of price_ids that this discount applies to. For plan/plan phase discounts,
+      #   ...
+      #
+      #   @param discount_type [Symbol, Orb::Models::UsageDiscount::DiscountType]
+      #
+      #   @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
+      #   ...
+      #
+      #   @param reason [String, nil]
 
       # @see Orb::Models::UsageDiscount#discount_type
       module DiscountType
@@ -43,11 +47,8 @@ module Orb
 
         USAGE = :usage
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end

data/lib/orb/models.rb

@@ -0,0 +1,220 @@
+# frozen_string_literal: true
+
+module Orb
+  Alert = Orb::Models::Alert
+
+  AlertCreateForCustomerParams = Orb::Models::AlertCreateForCustomerParams
+
+  AlertCreateForExternalCustomerParams = Orb::Models::AlertCreateForExternalCustomerParams
+
+  AlertCreateForSubscriptionParams = Orb::Models::AlertCreateForSubscriptionParams
+
+  AlertDisableParams = Orb::Models::AlertDisableParams
+
+  AlertEnableParams = Orb::Models::AlertEnableParams
+
+  AlertListParams = Orb::Models::AlertListParams
+
+  AlertRetrieveParams = Orb::Models::AlertRetrieveParams
+
+  AlertUpdateParams = Orb::Models::AlertUpdateParams
+
+  AmountDiscount = Orb::Models::AmountDiscount
+
+  BillableMetric = Orb::Models::BillableMetric
+
+  BillingCycleRelativeDate = Orb::Models::BillingCycleRelativeDate
+
+  Coupon = Orb::Models::Coupon
+
+  CouponArchiveParams = Orb::Models::CouponArchiveParams
+
+  CouponCreateParams = Orb::Models::CouponCreateParams
+
+  CouponFetchParams = Orb::Models::CouponFetchParams
+
+  CouponListParams = Orb::Models::CouponListParams
+
+  Coupons = Orb::Models::Coupons
+
+  CreditNote = Orb::Models::CreditNote
+
+  CreditNoteCreateParams = Orb::Models::CreditNoteCreateParams
+
+  CreditNoteFetchParams = Orb::Models::CreditNoteFetchParams
+
+  CreditNoteListParams = Orb::Models::CreditNoteListParams
+
+  Customer = Orb::Models::Customer
+
+  CustomerCreateParams = Orb::Models::CustomerCreateParams
+
+  CustomerDeleteParams = Orb::Models::CustomerDeleteParams
+
+  CustomerFetchByExternalIDParams = Orb::Models::CustomerFetchByExternalIDParams
+
+  CustomerFetchParams = Orb::Models::CustomerFetchParams
+
+  CustomerListParams = Orb::Models::CustomerListParams
+
+  Customers = Orb::Models::Customers
+
+  CustomerSyncPaymentMethodsFromGatewayByExternalCustomerIDParams =
+    Orb::Models::CustomerSyncPaymentMethodsFromGatewayByExternalCustomerIDParams
+
+  CustomerSyncPaymentMethodsFromGatewayParams = Orb::Models::CustomerSyncPaymentMethodsFromGatewayParams
+
+  CustomerUpdateByExternalIDParams = Orb::Models::CustomerUpdateByExternalIDParams
+
+  CustomerUpdateParams = Orb::Models::CustomerUpdateParams
+
+  DimensionalPriceGroup = Orb::Models::DimensionalPriceGroup
+
+  DimensionalPriceGroupCreateParams = Orb::Models::DimensionalPriceGroupCreateParams
+
+  DimensionalPriceGroupListParams = Orb::Models::DimensionalPriceGroupListParams
+
+  DimensionalPriceGroupRetrieveParams = Orb::Models::DimensionalPriceGroupRetrieveParams
+
+  DimensionalPriceGroups = Orb::Models::DimensionalPriceGroups
+
+  DimensionalPriceGroupsAPI = Orb::Models::DimensionalPriceGroupsAPI
+
+  Discount = Orb::Models::Discount
+
+  EvaluatePriceGroup = Orb::Models::EvaluatePriceGroup
+
+  EventDeprecateParams = Orb::Models::EventDeprecateParams
+
+  EventIngestParams = Orb::Models::EventIngestParams
+
+  Events = Orb::Models::Events
+
+  EventSearchParams = Orb::Models::EventSearchParams
+
+  EventUpdateParams = Orb::Models::EventUpdateParams
+
+  Invoice = Orb::Models::Invoice
+
+  InvoiceCreateParams = Orb::Models::InvoiceCreateParams
+
+  InvoiceFetchParams = Orb::Models::InvoiceFetchParams
+
+  InvoiceFetchUpcomingParams = Orb::Models::InvoiceFetchUpcomingParams
+
+  InvoiceIssueParams = Orb::Models::InvoiceIssueParams
+
+  InvoiceLevelDiscount = Orb::Models::InvoiceLevelDiscount
+
+  InvoiceLineItemCreateParams = Orb::Models::InvoiceLineItemCreateParams
+
+  InvoiceListParams = Orb::Models::InvoiceListParams
+
+  InvoiceMarkPaidParams = Orb::Models::InvoiceMarkPaidParams
+
+  InvoicePayParams = Orb::Models::InvoicePayParams
+
+  InvoiceUpdateParams = Orb::Models::InvoiceUpdateParams
+
+  InvoiceVoidParams = Orb::Models::InvoiceVoidParams
+
+  Item = Orb::Models::Item
+
+  ItemCreateParams = Orb::Models::ItemCreateParams
+
+  ItemFetchParams = Orb::Models::ItemFetchParams
+
+  ItemListParams = Orb::Models::ItemListParams
+
+  ItemUpdateParams = Orb::Models::ItemUpdateParams
+
+  MetricCreateParams = Orb::Models::MetricCreateParams
+
+  MetricFetchParams = Orb::Models::MetricFetchParams
+
+  MetricListParams = Orb::Models::MetricListParams
+
+  MetricUpdateParams = Orb::Models::MetricUpdateParams
+
+  PaginationMetadata = Orb::Models::PaginationMetadata
+
+  PercentageDiscount = Orb::Models::PercentageDiscount
+
+  Plan = Orb::Models::Plan
+
+  PlanCreateParams = Orb::Models::PlanCreateParams
+
+  PlanFetchParams = Orb::Models::PlanFetchParams
+
+  PlanListParams = Orb::Models::PlanListParams
+
+  Plans = Orb::Models::Plans
+
+  PlanUpdateParams = Orb::Models::PlanUpdateParams
+
+  Price = Orb::Models::Price
+
+  PriceCreateParams = Orb::Models::PriceCreateParams
+
+  PriceEvaluateParams = Orb::Models::PriceEvaluateParams
+
+  PriceFetchParams = Orb::Models::PriceFetchParams
+
+  PriceListParams = Orb::Models::PriceListParams
+
+  Prices = Orb::Models::Prices
+
+  PriceUpdateParams = Orb::Models::PriceUpdateParams
+
+  Subscription = Orb::Models::Subscription
+
+  SubscriptionCancelParams = Orb::Models::SubscriptionCancelParams
+
+  SubscriptionChangeApplyParams = Orb::Models::SubscriptionChangeApplyParams
+
+  SubscriptionChangeCancelParams = Orb::Models::SubscriptionChangeCancelParams
+
+  SubscriptionChangeRetrieveParams = Orb::Models::SubscriptionChangeRetrieveParams
+
+  SubscriptionCreateParams = Orb::Models::SubscriptionCreateParams
+
+  SubscriptionFetchCostsParams = Orb::Models::SubscriptionFetchCostsParams
+
+  SubscriptionFetchParams = Orb::Models::SubscriptionFetchParams
+
+  SubscriptionFetchScheduleParams = Orb::Models::SubscriptionFetchScheduleParams
+
+  SubscriptionFetchUsageParams = Orb::Models::SubscriptionFetchUsageParams
+
+  SubscriptionListParams = Orb::Models::SubscriptionListParams
+
+  SubscriptionPriceIntervalsParams = Orb::Models::SubscriptionPriceIntervalsParams
+
+  SubscriptionsAPI = Orb::Models::SubscriptionsAPI
+
+  SubscriptionSchedulePlanChangeParams = Orb::Models::SubscriptionSchedulePlanChangeParams
+
+  SubscriptionTriggerPhaseParams = Orb::Models::SubscriptionTriggerPhaseParams
+
+  SubscriptionUnscheduleCancellationParams = Orb::Models::SubscriptionUnscheduleCancellationParams
+
+  SubscriptionUnscheduleFixedFeeQuantityUpdatesParams =
+    Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesParams
+
+  SubscriptionUnschedulePendingPlanChangesParams =
+    Orb::Models::SubscriptionUnschedulePendingPlanChangesParams
+
+  SubscriptionUpdateFixedFeeQuantityParams = Orb::Models::SubscriptionUpdateFixedFeeQuantityParams
+
+  SubscriptionUpdateParams = Orb::Models::SubscriptionUpdateParams
+
+  SubscriptionUpdateTrialParams = Orb::Models::SubscriptionUpdateTrialParams
+
+  SubscriptionUsage = Orb::Models::SubscriptionUsage
+
+  TopLevelPingParams = Orb::Models::TopLevelPingParams
+
+  TrialDiscount = Orb::Models::TrialDiscount
+
+  UsageDiscount = Orb::Models::UsageDiscount
+end

data/lib/orb/request_options.rb

@@ -65,11 +65,9 @@ module Orb
     #   @return [Float, nil]
     optional :timeout, Float
 
-    # @!parse
-    #   # Returns a new instance of RequestOptions.
-    #   #
-    #   # @param values [Hash{Symbol=>Object}]
-    #   #
-    #   def initialize(values = {}) = super
+    # @!method initialize(values = {})
+    #   Returns a new instance of RequestOptions.
+    #
+    #   @param values [Hash{Symbol=>Object}]
   end
 end