feat(api): api update (#206)

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 101
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-11f40c15fa889d9752019e8a35b82d2e7a3d42f2b42c850b469f120a5b2c47ba.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-e480186cdd0e2cc631befa7e2c6ba5f2d7ae52052f0e79a748214f3ade8a98ee.yml

orb-java-core/src/main/kotlin/com/withorb/api/models/Alert.kt

@@ -21,8 +21,8 @@ import java.util.Objects
 import java.util.Optional
 
 /**
- * [Alerts within Orb](https://docs.withorb.com/guides/product-catalog/configuring-alerts) monitor
- * spending, usage, or credit balance and trigger webhooks when a threshold is exceeded.
+ * [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.
  */

orb-java-core/src/main/kotlin/com/withorb/api/models/AlertCreateForCustomerParams.kt

@@ -25,9 +25,9 @@ import java.util.Optional
  * 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](https://docs.withorb.com/guides/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.
+ * [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.
  */
 class AlertCreateForCustomerParams
 constructor(

orb-java-core/src/main/kotlin/com/withorb/api/models/AlertCreateForExternalCustomerParams.kt

@@ -25,9 +25,9 @@ import java.util.Optional
  * 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](https://docs.withorb.com/guides/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.
+ * [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.
  */
 class AlertCreateForExternalCustomerParams
 constructor(

orb-java-core/src/main/kotlin/com/withorb/api/models/AlertListPage.kt

@@ -28,7 +28,7 @@ import java.util.stream.StreamSupport
  * the plan level alerts associated with the subscription.
  *
  * The list of alerts is ordered starting from the most recently created alert. This endpoint
- * follows Orb's [standardized pagination format](../reference/pagination).
+ * follows Orb's [standardized pagination format](/api-reference/pagination).
  */
 class AlertListPage
 private constructor(

orb-java-core/src/main/kotlin/com/withorb/api/models/AlertListPageAsync.kt

@@ -29,7 +29,7 @@ import java.util.function.Predicate
  * the plan level alerts associated with the subscription.
  *
  * The list of alerts is ordered starting from the most recently created alert. This endpoint
- * follows Orb's [standardized pagination format](../reference/pagination).
+ * follows Orb's [standardized pagination format](/api-reference/pagination).
  */
 class AlertListPageAsync
 private constructor(

orb-java-core/src/main/kotlin/com/withorb/api/models/AlertListParams.kt

@@ -19,7 +19,7 @@ import java.util.Optional
  * the plan level alerts associated with the subscription.
  *
  * The list of alerts is ordered starting from the most recently created alert. This endpoint
- * follows Orb's [standardized pagination format](../reference/pagination).
+ * follows Orb's [standardized pagination format](/api-reference/pagination).
  */
 class AlertListParams
 constructor(

orb-java-core/src/main/kotlin/com/withorb/api/models/Coupon.kt

@@ -35,37 +35,6 @@ import kotlin.jvm.optionals.getOrNull
  * percentage amount to an invoice or subscription. Coupons are activated using a redemption code,
  * which applies the discount to a subscription or invoice. The duration of a coupon determines how
  * long it remains available for use by end users.
- *
- * ## How to use coupons
- *
- * Coupons can be created using the Orb dashboard or programmatically through the API. Once a coupon
- * is created, it can be managed and applied programmatically via the API. To redeem a coupon, use
- * the `redemption_code` property when [creating a subscription](create-subscription.api.mdx) or
- * when scheduling a [plan change](schedule-plan-change.api.mdx).
- *
- * ## When to use coupons
- *
- * A common use case for coupons is through self-serve signup or upgrade flows in your checkout
- * experience or billing portal. Coupons can also be used as one-off to incentivize use for custom
- * agreements.
- *
- * Coupons are effective when launching new features and encouraging existing users to upgrade to a
- * higher tier. For example, you could create a coupon code "UPGRADE20" that offers a 20% discount
- * on the first month of the new plan. This code can be applied during the upgrade process in your
- * billing portal, making it straightforward for users to benefit from the new features at a reduced
- * cost.
- *
- * ## Coupon scoping
- *
- * When a coupon is applied on a subscription, it creates a discount adjustment that applies to all
- * of the prices on the subscription at the time of the coupon application. Notably, coupons do not
- * scope in new price additions to a subscription automatically — if a new price is added to the
- * subscription with a subscription edit or plan version migration, the discount created with the
- * coupon will not apply to it automatically. If you'd like the coupon to apply to newly added
- * prices, you can [edit the adjustment intervals](add-edit-price-intervals.api.mdx) to end the
- * discount interval created by the coupon at the time of the migration and add a new one starting
- * at the time of the migration that includes the newly added prices you'd like the coupon to apply
- * to.
  */
 @NoAutoDetect
 class Coupon

orb-java-core/src/main/kotlin/com/withorb/api/models/CouponSubscriptionListPage.kt

@@ -21,9 +21,9 @@ import java.util.stream.StreamSupport
 
 /**
  * This endpoint returns a list of all subscriptions that have redeemed a given coupon as a
- * [paginated](../reference/pagination) list, ordered starting from the most recently created
+ * [paginated](/api-reference/pagination) list, ordered starting from the most recently created
  * subscription. For a full discussion of the subscription resource, see
- * [Subscription](../guides/concepts#subscription).
+ * [Subscription](/core-concepts#subscription).
  */
 class CouponSubscriptionListPage
 private constructor(

orb-java-core/src/main/kotlin/com/withorb/api/models/CouponSubscriptionListPageAsync.kt

@@ -22,9 +22,9 @@ import java.util.function.Predicate
 
 /**
  * This endpoint returns a list of all subscriptions that have redeemed a given coupon as a
- * [paginated](../reference/pagination) list, ordered starting from the most recently created
+ * [paginated](/api-reference/pagination) list, ordered starting from the most recently created
  * subscription. For a full discussion of the subscription resource, see
- * [Subscription](../guides/concepts#subscription).
+ * [Subscription](/core-concepts#subscription).
  */
 class CouponSubscriptionListPageAsync
 private constructor(