docs(client): separate comment content into paragraphs

Author: stainless-app[bot]

src/Orb/Core/FreezableDictionary.cs

@@ -10,8 +10,8 @@ namespace Orb.Core;
 /// A dictionary that can be mutated and then frozen once no more mutations are expected.<br
 /// /><br />
 ///
-/// This is useful for allowing a dictionary to be modified by a class's `init` properties,
-/// but then preventing it from being modified afterwards.
+/// <para>This is useful for allowing a dictionary to be modified by a class's `init`
+/// properties, but then preventing it from being modified afterwards.</para>
 /// </summary>
 class FreezableDictionary<K, V> : IDictionary<K, V>
     where K : notnull

src/Orb/Models/Alerts/Alert.cs

@@ -13,7 +13,7 @@ namespace Orb.Models.Alerts;
 /// [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.
+/// <para>Alerts created through the API can be scoped to either customers or subscriptions.</para>
 /// </summary>
 [JsonConverter(typeof(ModelConverter<Alert>))]
 public sealed record class Alert : ModelBase, IFromRaw<Alert>

src/Orb/Models/Alerts/AlertCreateForCustomerParams.cs

@@ -14,8 +14,8 @@ namespace Orb.Models.Alerts;
 /// <summary>
 ///  This endpoint creates a new alert to monitor a customer's credit balance. There
 /// are three types of alerts that can be scoped to  customers: `credit_balance_depleted`,
-/// `credit_balance_dropped`, and `credit_balance_recovered`. Customers can have
-/// a maximum  of one of each type of alert per [credit balance currency](/product-catalog/prepurchase).
+/// `credit_balance_dropped`, and `credit_balance_recovered`. Customers can have a
+/// maximum  of one of each type of alert per [credit balance currency](/product-catalog/prepurchase).
 /// `credit_balance_dropped` alerts require a list of thresholds to be provided while
 /// `credit_balance_depleted`  and `credit_balance_recovered` alerts do not require thresholds.
 /// </summary>

src/Orb/Models/Alerts/AlertCreateForExternalCustomerParams.cs

@@ -14,8 +14,8 @@ namespace Orb.Models.Alerts;
 /// <summary>
 ///  This endpoint creates a new alert to monitor a customer's credit balance. There
 /// are three types of alerts that can be scoped to  customers: `credit_balance_depleted`,
-/// `credit_balance_dropped`, and `credit_balance_recovered`. Customers can have
-/// a maximum  of one of each type of alert per [credit balance currency](/product-catalog/prepurchase).
+/// `credit_balance_dropped`, and `credit_balance_recovered`. Customers can have a
+/// maximum  of one of each type of alert per [credit balance currency](/product-catalog/prepurchase).
 /// `credit_balance_dropped` alerts require a list of thresholds to be provided while
 /// `credit_balance_depleted`  and `credit_balance_recovered` alerts do not require thresholds.
 /// </summary>

src/Orb/Models/Alerts/AlertCreateForSubscriptionParams.cs

@@ -14,15 +14,15 @@ namespace Orb.Models.Alerts;
 /// <summary>
 /// This endpoint is used to create alerts at the subscription level.
 ///
-/// Subscription level alerts can be one of two types: `usage_exceeded` or `cost_exceeded`.
+/// <para>Subscription level alerts can be one of two types: `usage_exceeded` or `cost_exceeded`.
 /// A `usage_exceeded` alert is scoped to a particular metric and is triggered when
 /// the usage of that metric exceeds predefined thresholds during the current billing
-/// cycle. A `cost_exceeded` alert is triggered when the total amount due during
-/// the current billing cycle surpasses predefined thresholds. `cost_exceeded` alerts
+/// cycle. A `cost_exceeded` alert is triggered when the total amount due during the
+/// current billing cycle surpasses predefined thresholds. `cost_exceeded` alerts
 /// do not include burndown of pre-purchase credits. Each subscription can have one
 /// `cost_exceeded` alert and one `usage_exceeded` alert per metric that is a part
 /// of the subscription. Alerts are triggered based on usage or cost conditions met
-/// during the current billing cycle.
+/// during the current billing cycle.</para>
 /// </summary>
 public sealed record class AlertCreateForSubscriptionParams : ParamsBase
 {

src/Orb/Models/Alerts/AlertListParams.cs

@@ -11,13 +11,14 @@ namespace Orb.Models.Alerts;
 /// <summary>
 /// This endpoint returns a list of alerts within Orb.
 ///
-/// The request must specify one of `customer_id`, `external_customer_id`, or `subscription_id`.
+/// <para>The request must specify one of `customer_id`, `external_customer_id`,
+/// or `subscription_id`.</para>
 ///
-/// If querying by subscription_id, the endpoint will return the subscription level
-/// alerts as well as the plan level alerts associated with the subscription.
+/// <para>If querying by subscription_id, the endpoint will return the subscription
+/// level alerts as well as the plan level alerts associated with the subscription.</para>
 ///
-/// The list of alerts is ordered starting from the most recently created alert.
-/// This endpoint follows Orb's [standardized pagination format](/api-reference/pagination).
+/// <para>The list of alerts is ordered starting from the most recently created alert.
+/// This endpoint follows Orb's [standardized pagination format](/api-reference/pagination).</para>
 /// </summary>
 public sealed record class AlertListParams : ParamsBase
 {

src/Orb/Models/Beta/BetaCreatePlanVersionParams.cs

@@ -3189,7 +3189,8 @@ public bool? BilledInAdvance
     }
 
     /// <summary>
-    /// For custom cadence: specifies the duration of the billing period in days or months.
+    /// For custom cadence: specifies the duration of the billing period in days
+    /// or months.
     /// </summary>
     public NewBillingCycleConfiguration? BillingCycleConfiguration
     {
@@ -3263,8 +3264,8 @@ public double? ConversionRate
     }
 
     /// <summary>
-    /// An ISO 4217 currency string, or custom pricing unit identifier, in which this
-    /// price is billed.
+    /// An ISO 4217 currency string, or custom pricing unit identifier, in which
+    /// this price is billed.
     /// </summary>
     public string? Currency
     {
@@ -4308,7 +4309,8 @@ public bool? BilledInAdvance
     }
 
     /// <summary>
-    /// For custom cadence: specifies the duration of the billing period in days or months.
+    /// For custom cadence: specifies the duration of the billing period in days
+    /// or months.
     /// </summary>
     public NewBillingCycleConfiguration? BillingCycleConfiguration
     {
@@ -4382,8 +4384,8 @@ public double? ConversionRate
     }
 
     /// <summary>
-    /// An ISO 4217 currency string, or custom pricing unit identifier, in which this
-    /// price is billed.
+    /// An ISO 4217 currency string, or custom pricing unit identifier, in which
+    /// this price is billed.
     /// </summary>
     public string? Currency
     {
@@ -4741,7 +4743,8 @@ public sealed record class TieredWithProrationConfig
         IFromRaw<global::Orb.Models.Beta.TieredWithProrationConfig>
 {
     /// <summary>
-    /// Tiers for rating based on total usage quantities into the specified tier with proration
+    /// Tiers for rating based on total usage quantities into the specified tier
+    /// with proration
     /// </summary>
     public required List<global::Orb.Models.Beta.TierModel> Tiers
     {
@@ -5304,7 +5307,8 @@ public bool? BilledInAdvance
     }
 
     /// <summary>
-    /// For custom cadence: specifies the duration of the billing period in days or months.
+    /// For custom cadence: specifies the duration of the billing period in days
+    /// or months.
     /// </summary>
     public NewBillingCycleConfiguration? BillingCycleConfiguration
     {
@@ -5378,8 +5382,8 @@ public double? ConversionRate
     }
 
     /// <summary>
-    /// An ISO 4217 currency string, or custom pricing unit identifier, in which this
-    /// price is billed.
+    /// An ISO 4217 currency string, or custom pricing unit identifier, in which
+    /// this price is billed.
     /// </summary>
     public string? Currency
     {
@@ -6284,7 +6288,8 @@ public bool? BilledInAdvance
     }
 
     /// <summary>
-    /// For custom cadence: specifies the duration of the billing period in days or months.
+    /// For custom cadence: specifies the duration of the billing period in days
+    /// or months.
     /// </summary>
     public NewBillingCycleConfiguration? BillingCycleConfiguration
     {
@@ -6358,8 +6363,8 @@ public double? ConversionRate
     }
 
     /// <summary>
-    /// An ISO 4217 currency string, or custom pricing unit identifier, in which this
-    /// price is billed.
+    /// An ISO 4217 currency string, or custom pricing unit identifier, in which
+    /// this price is billed.
     /// </summary>
     public string? Currency
     {
@@ -7168,7 +7173,8 @@ public bool? BilledInAdvance
     }
 
     /// <summary>
-    /// For custom cadence: specifies the duration of the billing period in days or months.
+    /// For custom cadence: specifies the duration of the billing period in days
+    /// or months.
     /// </summary>
     public NewBillingCycleConfiguration? BillingCycleConfiguration
     {
@@ -7242,8 +7248,8 @@ public double? ConversionRate
     }
 
     /// <summary>
-    /// An ISO 4217 currency string, or custom pricing unit identifier, in which this
-    /// price is billed.
+    /// An ISO 4217 currency string, or custom pricing unit identifier, in which
+    /// this price is billed.
     /// </summary>
     public string? Currency
     {
@@ -10994,7 +11000,8 @@ public bool? BilledInAdvance
     }
 
     /// <summary>
-    /// For custom cadence: specifies the duration of the billing period in days or months.
+    /// For custom cadence: specifies the duration of the billing period in days
+    /// or months.
     /// </summary>
     public NewBillingCycleConfiguration? BillingCycleConfiguration
     {
@@ -11068,8 +11075,8 @@ public double? ConversionRate
     }
 
     /// <summary>
-    /// An ISO 4217 currency string, or custom pricing unit identifier, in which this
-    /// price is billed.
+    /// An ISO 4217 currency string, or custom pricing unit identifier, in which
+    /// this price is billed.
     /// </summary>
     public string? Currency
     {
@@ -12112,7 +12119,8 @@ public bool? BilledInAdvance
     }
 
     /// <summary>
-    /// For custom cadence: specifies the duration of the billing period in days or months.
+    /// For custom cadence: specifies the duration of the billing period in days
+    /// or months.
     /// </summary>
     public NewBillingCycleConfiguration? BillingCycleConfiguration
     {
@@ -12186,8 +12194,8 @@ public double? ConversionRate
     }
 
     /// <summary>
-    /// An ISO 4217 currency string, or custom pricing unit identifier, in which this
-    /// price is billed.
+    /// An ISO 4217 currency string, or custom pricing unit identifier, in which
+    /// this price is billed.
     /// </summary>
     public string? Currency
     {
@@ -12545,7 +12553,8 @@ public sealed record class TieredWithProrationConfigModel
         IFromRaw<global::Orb.Models.Beta.TieredWithProrationConfigModel>
 {
     /// <summary>
-    /// Tiers for rating based on total usage quantities into the specified tier with proration
+    /// Tiers for rating based on total usage quantities into the specified tier
+    /// with proration
     /// </summary>
     public required List<global::Orb.Models.Beta.Tier2> Tiers
     {
@@ -13108,7 +13117,8 @@ public bool? BilledInAdvance
     }
 
     /// <summary>
-    /// For custom cadence: specifies the duration of the billing period in days or months.
+    /// For custom cadence: specifies the duration of the billing period in days
+    /// or months.
     /// </summary>
     public NewBillingCycleConfiguration? BillingCycleConfiguration
     {
@@ -13182,8 +13192,8 @@ public double? ConversionRate
     }
 
     /// <summary>
-    /// An ISO 4217 currency string, or custom pricing unit identifier, in which this
-    /// price is billed.
+    /// An ISO 4217 currency string, or custom pricing unit identifier, in which
+    /// this price is billed.
     /// </summary>
     public string? Currency
     {
@@ -14090,7 +14100,8 @@ public bool? BilledInAdvance
     }
 
     /// <summary>
-    /// For custom cadence: specifies the duration of the billing period in days or months.
+    /// For custom cadence: specifies the duration of the billing period in days
+    /// or months.
     /// </summary>
     public NewBillingCycleConfiguration? BillingCycleConfiguration
     {
@@ -14164,8 +14175,8 @@ public double? ConversionRate
     }
 
     /// <summary>
-    /// An ISO 4217 currency string, or custom pricing unit identifier, in which this
-    /// price is billed.
+    /// An ISO 4217 currency string, or custom pricing unit identifier, in which
+    /// this price is billed.
     /// </summary>
     public string? Currency
     {
@@ -14970,7 +14981,8 @@ public bool? BilledInAdvance
     }
 
     /// <summary>
-    /// For custom cadence: specifies the duration of the billing period in days or months.
+    /// For custom cadence: specifies the duration of the billing period in days
+    /// or months.
     /// </summary>
     public NewBillingCycleConfiguration? BillingCycleConfiguration
     {
@@ -15044,8 +15056,8 @@ public double? ConversionRate
     }
 
     /// <summary>
-    /// An ISO 4217 currency string, or custom pricing unit identifier, in which this
-    /// price is billed.
+    /// An ISO 4217 currency string, or custom pricing unit identifier, in which
+    /// this price is billed.
     /// </summary>
     public string? Currency
     {