orb-billing 0.1.3 → 0.3.0

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/request_options.rb

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

data/lib/orb/resources/alerts.rb

@@ -27,7 +27,9 @@ module Orb
       # @overload update(alert_configuration_id, thresholds:, request_options: {})
       #
       # @param alert_configuration_id [String]
-      # @param thresholds [Array<Orb::Models::AlertUpdateParams::Threshold>]
+      #
+      # @param thresholds [Array<Orb::Models::AlertUpdateParams::Threshold>] The thresholds that define the values at which the alert will be triggered.
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Alert]
@@ -44,6 +46,9 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::AlertListParams} for more details.
+      #
       # This endpoint returns a list of alerts within Orb.
       #
       # The request must specify one of `customer_id`, `external_customer_id`, or
@@ -59,14 +64,24 @@ module Orb
       # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, customer_id: nil, external_customer_id: nil, limit: nil, subscription_id: nil, request_options: {})
       #
       # @param created_at_gt [Time, nil]
+      #
       # @param created_at_gte [Time, nil]
+      #
       # @param created_at_lt [Time, nil]
+      #
       # @param created_at_lte [Time, nil]
-      # @param cursor [String, nil]
-      # @param customer_id [String, nil]
-      # @param external_customer_id [String, nil]
-      # @param limit [Integer]
-      # @param subscription_id [String, nil]
+      #
+      # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+      # ...
+      #
+      # @param customer_id [String, nil] Fetch alerts scoped to this customer_id
+      #
+      # @param external_customer_id [String, nil] Fetch alerts scoped to this external_customer_id
+      #
+      # @param limit [Integer] The number of items to fetch. Defaults to 20.
+      #
+      # @param subscription_id [String, nil] Fetch alerts scoped to this subscription_id
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Internal::Page<Orb::Models::Alert>]
@@ -101,9 +116,13 @@ module Orb
       # @overload create_for_customer(customer_id, currency:, type:, thresholds: nil, request_options: {})
       #
       # @param customer_id [String]
-      # @param currency [String]
-      # @param type [Symbol, Orb::Models::AlertCreateForCustomerParams::Type]
-      # @param thresholds [Array<Orb::Models::AlertCreateForCustomerParams::Threshold>, nil]
+      #
+      # @param currency [String] The case sensitive currency or custom pricing unit to use for this alert.
+      #
+      # @param type [Symbol, Orb::Models::AlertCreateForCustomerParams::Type] The type of alert to create. This must be a valid alert type.
+      #
+      # @param thresholds [Array<Orb::Models::AlertCreateForCustomerParams::Threshold>, nil] The thresholds that define the values at which the alert will be triggered.
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Alert]
@@ -132,9 +151,13 @@ module Orb
       # @overload create_for_external_customer(external_customer_id, currency:, type:, thresholds: nil, request_options: {})
       #
       # @param external_customer_id [String]
-      # @param currency [String]
-      # @param type [Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type]
-      # @param thresholds [Array<Orb::Models::AlertCreateForExternalCustomerParams::Threshold>, nil]
+      #
+      # @param currency [String] The case sensitive currency or custom pricing unit to use for this alert.
+      #
+      # @param type [Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type] The type of alert to create. This must be a valid alert type.
+      #
+      # @param thresholds [Array<Orb::Models::AlertCreateForExternalCustomerParams::Threshold>, nil] The thresholds that define the values at which the alert will be triggered.
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Alert]
@@ -166,9 +189,13 @@ module Orb
       # @overload create_for_subscription(subscription_id, thresholds:, type:, metric_id: nil, request_options: {})
       #
       # @param subscription_id [String]
-      # @param thresholds [Array<Orb::Models::AlertCreateForSubscriptionParams::Threshold>]
-      # @param type [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type]
-      # @param metric_id [String, nil]
+      #
+      # @param thresholds [Array<Orb::Models::AlertCreateForSubscriptionParams::Threshold>] The thresholds that define the values at which the alert will be triggered.
+      #
+      # @param type [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type] The type of alert to create. This must be a valid alert type.
+      #
+      # @param metric_id [String, nil] The metric to track usage for.
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Alert]
@@ -192,7 +219,9 @@ module Orb
       # @overload disable(alert_configuration_id, subscription_id: nil, request_options: {})
       #
       # @param alert_configuration_id [String]
-      # @param subscription_id [String, nil]
+      #
+      # @param subscription_id [String, nil] Used to update the status of a plan alert scoped to this subscription_id
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Alert]
@@ -216,7 +245,9 @@ module Orb
       # @overload enable(alert_configuration_id, subscription_id: nil, request_options: {})
       #
       # @param alert_configuration_id [String]
-      # @param subscription_id [String, nil]
+      #
+      # @param subscription_id [String, nil] Used to update the status of a plan alert scoped to this subscription_id
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Alert]

data/lib/orb/resources/coupons/subscriptions.rb

@@ -4,6 +4,9 @@ module Orb
   module Resources
     class Coupons
       class Subscriptions
+        # Some parameter documentations has been truncated, see
+        # {Orb::Models::Coupons::SubscriptionListParams} for more details.
+        #
         # This endpoint returns a list of all subscriptions that have redeemed a given
         # coupon as a [paginated](/api-reference/pagination) list, ordered starting from
         # the most recently created subscription. For a full discussion of the
@@ -12,8 +15,12 @@ module Orb
         # @overload list(coupon_id, cursor: nil, limit: nil, request_options: {})
         #
         # @param coupon_id [String]
-        # @param cursor [String, nil]
-        # @param limit [Integer]
+        #
+        # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+        # ...
+        #
+        # @param limit [Integer] The number of items to fetch. Defaults to 20.
+        #
         # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Orb::Internal::Page<Orb::Models::Subscription>]

data/lib/orb/resources/coupons.rb

@@ -6,15 +6,24 @@ module Orb
       # @return [Orb::Resources::Coupons::Subscriptions]
       attr_reader :subscriptions
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::CouponCreateParams} for more details.
+      #
       # This endpoint allows the creation of coupons, which can then be redeemed at
       # subscription creation or plan change.
       #
       # @overload create(discount:, redemption_code:, duration_in_months: nil, max_redemptions: nil, request_options: {})
       #
       # @param discount [Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount, Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount]
-      # @param redemption_code [String]
-      # @param duration_in_months [Integer, nil]
-      # @param max_redemptions [Integer, nil]
+      #
+      # @param redemption_code [String] This string can be used to redeem this coupon for a given subscription.
+      #
+      # @param duration_in_months [Integer, nil] This allows for a coupon's discount to apply for a limited time (determined in m
+      # ...
+      #
+      # @param max_redemptions [Integer, nil] The maximum number of redemptions allowed for this coupon before it is exhausted
+      # ...
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Coupon]
@@ -31,6 +40,9 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::CouponListParams} for more details.
+      #
       # This endpoint returns a list of all coupons for an account in a list format.
       #
       # The list of coupons is ordered starting from the most recently created coupon.
@@ -40,10 +52,16 @@ module Orb
       #
       # @overload list(cursor: nil, limit: nil, redemption_code: nil, show_archived: nil, request_options: {})
       #
-      # @param cursor [String, nil]
-      # @param limit [Integer]
-      # @param redemption_code [String, nil]
-      # @param show_archived [Boolean, nil]
+      # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+      # ...
+      #
+      # @param limit [Integer] The number of items to fetch. Defaults to 20.
+      #
+      # @param redemption_code [String, nil] Filter to coupons matching this redemption code.
+      #
+      # @param show_archived [Boolean, nil] Show archived coupons as well (by default, this endpoint only returns active cou
+      # ...
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Internal::Page<Orb::Models::Coupon>]

data/lib/orb/resources/credit_notes.rb

@@ -9,8 +9,11 @@ module Orb
       # @overload create(line_items:, memo: nil, reason: nil, request_options: {})
       #
       # @param line_items [Array<Orb::Models::CreditNoteCreateParams::LineItem>]
-      # @param memo [String, nil]
-      # @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason, nil]
+      #
+      # @param memo [String, nil] An optional memo to attach to the credit note.
+      #
+      # @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason, nil] An optional reason for the credit note.
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::CreditNote]
@@ -27,6 +30,9 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::CreditNoteListParams} for more details.
+      #
       # Get a paginated list of CreditNotes. Users can also filter by customer_id,
       # subscription_id, or external_customer_id. The credit notes will be returned in
       # reverse chronological order by `creation_time`.
@@ -34,11 +40,18 @@ module Orb
       # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {})
       #
       # @param created_at_gt [Time, nil]
+      #
       # @param created_at_gte [Time, nil]
+      #
       # @param created_at_lt [Time, nil]
+      #
       # @param created_at_lte [Time, nil]
-      # @param cursor [String, nil]
-      # @param limit [Integer]
+      #
+      # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+      # ...
+      #
+      # @param limit [Integer] The number of items to fetch. Defaults to 20.
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Internal::Page<Orb::Models::CreditNote>]

data/lib/orb/resources/customers/balance_transactions.rb

@@ -10,9 +10,13 @@ module Orb
         # @overload create(customer_id, amount:, type:, description: nil, request_options: {})
         #
         # @param customer_id [String]
+        #
         # @param amount [String]
+        #
         # @param type [Symbol, Orb::Models::Customers::BalanceTransactionCreateParams::Type]
-        # @param description [String, nil]
+        #
+        # @param description [String, nil] An optional description that can be specified around this entry.
+        #
         # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Orb::Models::Customers::BalanceTransactionCreateResponse]
@@ -29,6 +33,9 @@ module Orb
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Orb::Models::Customers::BalanceTransactionListParams} for more details.
+        #
         # ## The customer balance
         #
         # The customer balance is an amount in the customer's currency, which Orb
@@ -61,12 +68,20 @@ module Orb
         # @overload list(customer_id, cursor: nil, limit: nil, operation_time_gt: nil, operation_time_gte: nil, operation_time_lt: nil, operation_time_lte: nil, request_options: {})
         #
         # @param customer_id [String]
-        # @param cursor [String, nil]
-        # @param limit [Integer]
+        #
+        # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+        # ...
+        #
+        # @param limit [Integer] The number of items to fetch. Defaults to 20.
+        #
         # @param operation_time_gt [Time, nil]
+        #
         # @param operation_time_gte [Time, nil]
+        #
         # @param operation_time_lt [Time, nil]
+        #
         # @param operation_time_lte [Time, nil]
+        #
         # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Orb::Internal::Page<Orb::Models::Customers::BalanceTransactionListResponse>]