feat(client)!: breaking change to re-use types

A number of types that were previously defined in-line at each call site have now been declared as shareable types. This has the benefit of greatly reducing the number of duplicated definitions of the same types, but is also a breaking change since these types will be moving to a shared single definition.

A summary of the new types is below:

  Billing Configuration Models

  - Address
  - BillingCycleAnchorConfiguration
  - BillingCycleConfiguration
  - FixedFeeQuantityScheduleEntry
  - FixedFeeQuantityTransition
  - CustomExpiration
  - SubLineItemGrouping

  Pricing Models (Base)

  - Price
    - PriceUnitPrice
    - PricePackagePrice
    - PriceMatrixPrice
    - PriceTieredPrice
    - PriceTieredBPSPrice
    - PriceBPSPrice
    - PriceBulkBPSPrice
    - PriceBulkPrice
  - PriceInterval

  Advanced Pricing Models

  - PriceThresholdTotalAmountPrice
  - PriceTieredPackagePrice
  - PriceTieredWithMinimumPrice
  - PricePackageWithAllocationPrice
  - PriceMatrixWithAllocationPrice
  - PriceTieredWithProrationPrice
  - PriceUnitWithProrationPrice
  - PriceGroupedAllocationPrice
  - PriceMatrixWithDisplayNamePrice

  Discount and Adjustment Models

  - AmountDiscount
  - PercentageDiscount
  - UsageDiscount
  - TrialDiscount
  - Discount
  - CouponRedemption (formerly SubscriptionRedeemedCoupon)
  - TransformPriceFilter
  - AdjustmentInterval
  - AdjustmentIntervalAdjustment

  Monetary Adjustment Models

  - MonetaryAmountDiscountAdjustment
  - MonetaryMaximumAdjustment
  - MonetaryMinimumAdjustment
  - MonetaryPercentageDiscountAdjustment
  - MonetaryUsageDiscountAdjustment

  Plan Phase Adjustment Models

  - PlanPhaseAmountDiscountAdjustment
  - PlanPhaseMaximumAdjustment
  - PlanPhaseMinimumAdjustment
  - PlanPhasePercentageDiscountAdjustment
  - PlanPhaseUsageDiscountAdjustment

  Limit Models

  - Maximum (formerly PlanMaximum)
  - Minimum (formerly PlanMinimum)
  - MinimumInterval (formerly SubscriptionMinimumInterval)
  - MaximumInterval (formerly SubscriptionMaximumInterval)

  Cost and Allocation Models

  - AggregatedCost
  - PerPriceCost
  - Allocation
  - SubscriptionTrialInfo

  Configuration Parameter Models

  - BPSConfigParam
  - BulkBPSConfigParam
  - BulkConfigParam
  - MatrixConfigParam
  - PackageConfigParam
  - TieredBPSConfigParam
  - TieredConfigParam
  - UnitConfigParam

  Reference Models

  - CustomerMinified
  - SubscriptionMinified
  - InvoiceTiny
  - CreditNoteTiny
  - ItemSlim
  - BillableMetricTiny
  - TaxAmount

  Dimensional Pricing Models

  - DimensionalPriceConfiguration
  - MatrixValue

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 115
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-fee4c7438579fd72ae7c08ad11cc502da279ad3cccfe2235b18afcacc91ad0d9.yml
 openapi_spec_hash: dc9d553a388715ba22d873aee54a3ed1
-config_hash: 1e2186b09e57d7d27b6ab5c8e6410b31
+config_hash: 38d4539e31b962c34d7ceb224b161855

api.md

@@ -3,6 +3,7 @@
 import { APIResource } from '../resource';
 import { isRequestOptions } from '../core';
 import * as Core from '../core';
+import * as Shared from './shared';
 import { Page, type PageParams } from '../pagination';
 
 export class Alerts extends APIResource {
@@ -187,7 +188,7 @@ export interface Alert {
   /**
    * The customer the alert applies to.
    */
-  customer: Alert.Customer | null;
+  customer: Shared.CustomerMinified | null;
 
   /**
    * Whether the alert is enabled or disabled.
@@ -207,13 +208,13 @@ export interface Alert {
   /**
    * The subscription the alert applies to.
    */
-  subscription: Alert.Subscription | null;
+  subscription: Shared.SubscriptionMinified | null;
 
   /**
    * The thresholds that define the conditions under which the alert will be
    * triggered.
    */
-  thresholds: Array<Alert.Threshold> | null;
+  thresholds: Array<Threshold> | null;
 
   /**
    * The type of alert. This must be a valid alert type.
@@ -233,15 +234,6 @@ export interface Alert {
 }
 
 export namespace Alert {
-  /**
-   * The customer the alert applies to.
-   */
-  export interface Customer {
-    id: string;
-
-    external_customer_id: string | null;
-  }
-
   /**
    * The metric the alert applies to.
    */
@@ -267,26 +259,6 @@ export namespace Alert {
     plan_version: string;
   }
 
-  /**
-   * The subscription the alert applies to.
-   */
-  export interface Subscription {
-    id: string;
-  }
-
-  /**
-   * Thresholds are used to define the conditions under which an alert will be
-   * triggered.
-   */
-  export interface Threshold {
-    /**
-     * The value at which an alert will fire. For credit balance alerts, the alert will
-     * fire at or below this value. For usage and cost alerts, the alert will fire at
-     * or above this value.
-     */
-    value: number;
-  }
-
   /**
    * Alert status is used to determine if an alert is currently in-alert or not.
    */
@@ -303,26 +275,24 @@ export namespace Alert {
   }
 }
 
-export interface AlertUpdateParams {
+/**
+ * Thresholds are used to define the conditions under which an alert will be
+ * triggered.
+ */
+export interface Threshold {
   /**
-   * The thresholds that define the values at which the alert will be triggered.
+   * The value at which an alert will fire. For credit balance alerts, the alert will
+   * fire at or below this value. For usage and cost alerts, the alert will fire at
+   * or above this value.
    */
-  thresholds: Array<AlertUpdateParams.Threshold>;
+  value: number;
 }
 
-export namespace AlertUpdateParams {
+export interface AlertUpdateParams {
   /**
-   * Thresholds are used to define the conditions under which an alert will be
-   * triggered.
+   * The thresholds that define the values at which the alert will be triggered.
    */
-  export interface Threshold {
-    /**
-     * The value at which an alert will fire. For credit balance alerts, the alert will
-     * fire at or below this value. For usage and cost alerts, the alert will fire at
-     * or above this value.
-     */
-    value: number;
-  }
+  thresholds: Array<Threshold>;
 }
 
 export interface AlertListParams extends PageParams {
@@ -364,22 +334,7 @@ export interface AlertCreateForCustomerParams {
   /**
    * The thresholds that define the values at which the alert will be triggered.
    */
-  thresholds?: Array<AlertCreateForCustomerParams.Threshold> | null;
-}
-
-export namespace AlertCreateForCustomerParams {
-  /**
-   * Thresholds are used to define the conditions under which an alert will be
-   * triggered.
-   */
-  export interface Threshold {
-    /**
-     * The value at which an alert will fire. For credit balance alerts, the alert will
-     * fire at or below this value. For usage and cost alerts, the alert will fire at
-     * or above this value.
-     */
-    value: number;
-  }
+  thresholds?: Array<Threshold> | null;
 }
 
 export interface AlertCreateForExternalCustomerParams {
@@ -396,29 +351,14 @@ export interface AlertCreateForExternalCustomerParams {
   /**
    * The thresholds that define the values at which the alert will be triggered.
    */
-  thresholds?: Array<AlertCreateForExternalCustomerParams.Threshold> | null;
-}
-
-export namespace AlertCreateForExternalCustomerParams {
-  /**
-   * Thresholds are used to define the conditions under which an alert will be
-   * triggered.
-   */
-  export interface Threshold {
-    /**
-     * The value at which an alert will fire. For credit balance alerts, the alert will
-     * fire at or below this value. For usage and cost alerts, the alert will fire at
-     * or above this value.
-     */
-    value: number;
-  }
+  thresholds?: Array<Threshold> | null;
 }
 
 export interface AlertCreateForSubscriptionParams {
   /**
    * The thresholds that define the values at which the alert will be triggered.
    */
-  thresholds: Array<AlertCreateForSubscriptionParams.Threshold>;
+  thresholds: Array<Threshold>;
 
   /**
    * The type of alert to create. This must be a valid alert type.
@@ -431,21 +371,6 @@ export interface AlertCreateForSubscriptionParams {
   metric_id?: string | null;
 }
 
-export namespace AlertCreateForSubscriptionParams {
-  /**
-   * Thresholds are used to define the conditions under which an alert will be
-   * triggered.
-   */
-  export interface Threshold {
-    /**
-     * The value at which an alert will fire. For credit balance alerts, the alert will
-     * fire at or below this value. For usage and cost alerts, the alert will fire at
-     * or above this value.
-     */
-    value: number;
-  }
-}
-
 export interface AlertDisableParams {
   /**
    * Used to update the status of a plan alert scoped to this subscription_id
@@ -465,6 +390,7 @@ Alerts.AlertsPage = AlertsPage;
 export declare namespace Alerts {
   export {
     type Alert as Alert,
+    type Threshold as Threshold,
     AlertsPage as AlertsPage,
     type AlertUpdateParams as AlertUpdateParams,
     type AlertListParams as AlertListParams,