chore: show truncated parameter docs in yard

Author: stainless-app[bot]

lib/orb/models/alert.rb

@@ -66,22 +66,35 @@ class Alert < Orb::Internal::Type::BaseModel
       required :type, enum: -> { Orb::Models::Alert::Type }
 
       # @!method initialize(id:, created_at:, currency:, customer:, enabled:, metric:, plan:, subscription:, thresholds:, type:)
+      #   Some parameter documentations has been truncated, see {Orb::Models::Alert} for
+      #   more details.
+      #
       #   [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
       #   usage, or credit balance and trigger webhooks when a threshold is exceeded.
       #
       #   Alerts created through the API can be scoped to either customers or
       #   subscriptions.
       #
-      #   @param id [String]
-      #   @param created_at [Time]
-      #   @param currency [String, nil]
-      #   @param customer [Orb::Models::Alert::Customer, nil]
-      #   @param enabled [Boolean]
-      #   @param metric [Orb::Models::Alert::Metric, nil]
-      #   @param plan [Orb::Models::Alert::Plan, nil]
-      #   @param subscription [Orb::Models::Alert::Subscription, nil]
-      #   @param thresholds [Array<Orb::Models::Alert::Threshold>, nil]
-      #   @param type [Symbol, Orb::Models::Alert::Type]
+      #   @param id [String] Also referred to as alert_id in this documentation.
+      #
+      #   @param created_at [Time] The creation time of the resource in Orb.
+      #
+      #   @param currency [String, nil] The name of the currency the credit balance or invoice cost is denominated in.
+      #
+      #   @param customer [Orb::Models::Alert::Customer, nil] The customer the alert applies to.
+      #
+      #   @param enabled [Boolean] Whether the alert is enabled or disabled.
+      #
+      #   @param metric [Orb::Models::Alert::Metric, nil] The metric the alert applies to.
+      #
+      #   @param plan [Orb::Models::Alert::Plan, nil] The plan the alert applies to.
+      #
+      #   @param subscription [Orb::Models::Alert::Subscription, nil] The subscription the alert applies to.
+      #
+      #   @param thresholds [Array<Orb::Models::Alert::Threshold>, nil] The thresholds that define the conditions under which the alert will be triggere
+      #   ...
+      #
+      #   @param type [Symbol, Orb::Models::Alert::Type] The type of alert. This must be a valid alert type.
 
       # @see Orb::Models::Alert#customer
       class Customer < Orb::Internal::Type::BaseModel
@@ -141,11 +154,18 @@ class Plan < Orb::Internal::Type::BaseModel
         required :plan_version, String
 
         # @!method initialize(id:, external_plan_id:, name:, plan_version:)
+        #   Some parameter documentations has been truncated, see {Orb::Models::Alert::Plan}
+        #   for more details.
+        #
         #   The plan the alert applies to.
         #
         #   @param id [String, nil]
-        #   @param external_plan_id [String, nil]
+        #
+        #   @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
+        #   ...
+        #
         #   @param name [String, nil]
+        #
         #   @param plan_version [String]
       end
 
@@ -172,10 +192,14 @@ class Threshold < Orb::Internal::Type::BaseModel
         required :value, Float
 
         # @!method initialize(value:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Alert::Threshold} for more details.
+        #
         #   Thresholds are used to define the conditions under which an alert will be
         #   triggered.
         #
-        #   @param value [Float]
+        #   @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will
+        #   ...
       end
 
       # The type of alert. This must be a valid alert type.

lib/orb/models/alert_create_for_customer_params.rb

@@ -28,9 +28,12 @@ class AlertCreateForCustomerParams < Orb::Internal::Type::BaseModel
                nil?: true
 
       # @!method initialize(currency:, type:, thresholds: nil, request_options: {})
-      #   @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}]
 
       # The type of alert to create. This must be a valid alert type.
@@ -55,10 +58,14 @@ class Threshold < Orb::Internal::Type::BaseModel
         required :value, Float
 
         # @!method initialize(value:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::AlertCreateForCustomerParams::Threshold} for more details.
+        #
         #   Thresholds are used to define the conditions under which an alert will be
         #   triggered.
         #
-        #   @param value [Float]
+        #   @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will
+        #   ...
       end
     end
   end

lib/orb/models/alert_create_for_external_customer_params.rb

@@ -28,9 +28,12 @@ class AlertCreateForExternalCustomerParams < Orb::Internal::Type::BaseModel
                nil?: true
 
       # @!method initialize(currency:, type:, thresholds: nil, request_options: {})
-      #   @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}]
 
       # The type of alert to create. This must be a valid alert type.
@@ -55,10 +58,14 @@ class Threshold < Orb::Internal::Type::BaseModel
         required :value, Float
 
         # @!method initialize(value:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::AlertCreateForExternalCustomerParams::Threshold} for more details.
+        #
         #   Thresholds are used to define the conditions under which an alert will be
         #   triggered.
         #
-        #   @param value [Float]
+        #   @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will
+        #   ...
       end
     end
   end

lib/orb/models/alert_create_for_subscription_params.rb

@@ -27,9 +27,12 @@ class AlertCreateForSubscriptionParams < Orb::Internal::Type::BaseModel
       optional :metric_id, String, nil?: true
 
       # @!method initialize(thresholds:, type:, metric_id: nil, request_options: {})
-      #   @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}]
 
       class Threshold < Orb::Internal::Type::BaseModel
@@ -42,10 +45,14 @@ class Threshold < Orb::Internal::Type::BaseModel
         required :value, Float
 
         # @!method initialize(value:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::AlertCreateForSubscriptionParams::Threshold} for more details.
+        #
         #   Thresholds are used to define the conditions under which an alert will be
         #   triggered.
         #
-        #   @param value [Float]
+        #   @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will
+        #   ...
       end
 
       # The type of alert to create. This must be a valid alert type.

lib/orb/models/alert_disable_params.rb

@@ -14,7 +14,8 @@ class AlertDisableParams < Orb::Internal::Type::BaseModel
       optional :subscription_id, String, nil?: true
 
       # @!method initialize(subscription_id: nil, request_options: {})
-      #   @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}]
     end
   end

lib/orb/models/alert_enable_params.rb

@@ -14,7 +14,8 @@ class AlertEnableParams < Orb::Internal::Type::BaseModel
       optional :subscription_id, String, nil?: true
 
       # @!method initialize(subscription_id: nil, request_options: {})
-      #   @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}]
     end
   end

lib/orb/models/alert_list_params.rb

@@ -59,15 +59,28 @@ class AlertListParams < Orb::Internal::Type::BaseModel
       optional :subscription_id, String, nil?: true
 
       # @!method initialize(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: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::AlertListParams} for more details.
+      #
       #   @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}]
     end
   end

lib/orb/models/alert_update_params.rb

@@ -14,7 +14,8 @@ class AlertUpdateParams < Orb::Internal::Type::BaseModel
       required :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Models::AlertUpdateParams::Threshold] }
 
       # @!method initialize(thresholds:, request_options: {})
-      #   @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}]
 
       class Threshold < Orb::Internal::Type::BaseModel
@@ -27,10 +28,14 @@ class Threshold < Orb::Internal::Type::BaseModel
         required :value, Float
 
         # @!method initialize(value:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::AlertUpdateParams::Threshold} for more details.
+        #
         #   Thresholds are used to define the conditions under which an alert will be
         #   triggered.
         #
-        #   @param value [Float]
+        #   @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will
+        #   ...
       end
     end
   end

lib/orb/models/amount_discount.rb

@@ -27,9 +27,16 @@ class AmountDiscount < Orb::Internal::Type::BaseModel
       optional :reason, String, nil?: true
 
       # @!method initialize(amount_discount:, applies_to_price_ids:, discount_type:, reason: nil)
-      #   @param amount_discount [String]
-      #   @param applies_to_price_ids [Array<String>]
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::AmountDiscount} for more details.
+      #
+      #   @param amount_discount [String] Only available if discount_type is `amount`.
+      #
+      #   @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::AmountDiscount::DiscountType]
+      #
       #   @param reason [String, nil]
 
       # @see Orb::Models::AmountDiscount#discount_type

lib/orb/models/billable_metric.rb

@@ -42,15 +42,25 @@ class BillableMetric < Orb::Internal::Type::BaseModel
       required :status, enum: -> { Orb::Models::BillableMetric::Status }
 
       # @!method initialize(id:, description:, item:, metadata:, name:, status:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::BillableMetric} for more details.
+      #
       #   The Metric resource represents a calculation of a quantity based on events.
       #   Metrics are defined by the query that transforms raw usage events into
       #   meaningful values for your customers.
       #
       #   @param id [String]
+      #
       #   @param description [String, nil]
-      #   @param item [Orb::Models::Item]
-      #   @param metadata [Hash{Symbol=>String}]
+      #
+      #   @param item [Orb::Models::Item] The Item resource represents a sellable product or good. Items are associated wi
+      #   ...
+      #
+      #   @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
+      #   ...
+      #
       #   @param name [String]
+      #
       #   @param status [Symbol, Orb::Models::BillableMetric::Status]
 
       # @see Orb::Models::BillableMetric#status