orb-billing 1.26.0 → 1.28.0

package/src/resources/prices/prices.ts

@@ -9,7 +9,7 @@ import * as ExternalPriceIDAPI from "./external-price-id";
 import { Page, type PageParams } from "../../pagination";
 
 export class Prices extends APIResource {
-  externalPriceId: ExternalPriceIDAPI.ExternalPriceID = new ExternalPriceIDAPI.ExternalPriceID(this.client);
+  externalPriceId: ExternalPriceIDAPI.ExternalPriceID = new ExternalPriceIDAPI.ExternalPriceID(this._client);
 
   /**
    * This endpoint is used to create a [price](../reference/price). A price created
@@ -24,7 +24,7 @@ export class Prices extends APIResource {
    * price model configurations possible in this endpoint.
    */
   create(body: PriceCreateParams, options?: Core.RequestOptions): Core.APIPromise<Price> {
-    return this.post('/prices', { body, ...options });
+    return this._client.post('/prices', { body, ...options });
   }
 
   /**
@@ -40,14 +40,14 @@ export class Prices extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-    return this.getAPIList('/prices', PricesPage, { query, ...options });
+    return this._client.getAPIList('/prices', PricesPage, { query, ...options });
   }
 
   /**
    * This endpoint returns a price given an identifier.
    */
   fetch(priceId: string, options?: Core.RequestOptions): Core.APIPromise<Price> {
-    return this.get(`/prices/${priceId}`, options);
+    return this._client.get(`/prices/${priceId}`, options);
   }
 }
 
@@ -314,12 +314,22 @@ export namespace Price {
 
     currency: string;
 
+    discount: Shared.Discount | null;
+
     external_price_id: string | null;
 
     fixed_price_quantity: number | null;
 
     item: UnitPrice.Item;
 
+    maximum: UnitPrice.Maximum | null;
+
+    maximum_amount: string | null;
+
+    minimum: UnitPrice.Minimum | null;
+
+    minimum_amount: string | null;
+
     model_type: 'unit';
 
     name: string;
@@ -329,16 +339,6 @@ export namespace Price {
     price_type: 'usage_price' | 'fixed_price';
 
     unit_config: UnitPrice.UnitConfig;
-
-    discount?: Shared.Discount | null;
-
-    maximum?: UnitPrice.Maximum | null;
-
-    maximum_amount?: string | null;
-
-    minimum?: UnitPrice.Minimum | null;
-
-    minimum_amount?: string | null;
   }
 
   export namespace UnitPrice {
@@ -352,18 +352,6 @@ export namespace Price {
       name: string;
     }
 
-    export interface UnitConfig {
-      /**
-       * Rate per unit of usage
-       */
-      unit_amount: string;
-
-      /**
-       * Multiplier to scale rated quantity by
-       */
-      scaling_factor?: number | null;
-    }
-
     export interface Maximum {
       /**
        * List of price_ids that this maximum amount applies to. For plan/plan phase
@@ -389,6 +377,18 @@ export namespace Price {
        */
       minimum_amount: string;
     }
+
+    export interface UnitConfig {
+      /**
+       * Rate per unit of usage
+       */
+      unit_amount: string;
+
+      /**
+       * Multiplier to scale rated quantity by
+       */
+      scaling_factor?: number | null;
+    }
   }
 
   export interface PackagePrice {
@@ -402,12 +402,22 @@ export namespace Price {
 
     currency: string;
 
+    discount: Shared.Discount | null;
+
     external_price_id: string | null;
 
     fixed_price_quantity: number | null;
 
     item: PackagePrice.Item;
 
+    maximum: PackagePrice.Maximum | null;
+
+    maximum_amount: string | null;
+
+    minimum: PackagePrice.Minimum | null;
+
+    minimum_amount: string | null;
+
     model_type: 'package';
 
     name: string;
@@ -417,16 +427,6 @@ export namespace Price {
     plan_phase_order: number | null;
 
     price_type: 'usage_price' | 'fixed_price';
-
-    discount?: Shared.Discount | null;
-
-    maximum?: PackagePrice.Maximum | null;
-
-    maximum_amount?: string | null;
-
-    minimum?: PackagePrice.Minimum | null;
-
-    minimum_amount?: string | null;
   }
 
   export namespace PackagePrice {
@@ -440,19 +440,6 @@ export namespace Price {
       name: string;
     }
 
-    export interface PackageConfig {
-      /**
-       * A currency amount to rate usage by
-       */
-      package_amount: string;
-
-      /**
-       * An integer amount to represent package size. For example, 1000 here would divide
-       * usage by 1000 before multiplying by package_amount in rating
-       */
-      package_size?: number | null;
-    }
-
     export interface Maximum {
       /**
        * List of price_ids that this maximum amount applies to. For plan/plan phase
@@ -478,6 +465,19 @@ export namespace Price {
        */
       minimum_amount: string;
     }
+
+    export interface PackageConfig {
+      /**
+       * A currency amount to rate usage by
+       */
+      package_amount: string;
+
+      /**
+       * An integer amount to represent package size. For example, 1000 here would divide
+       * usage by 1000 before multiplying by package_amount in rating
+       */
+      package_size?: number | null;
+    }
   }
 
   export interface MatrixPrice {
@@ -491,6 +491,8 @@ export namespace Price {
 
     currency: string;
 
+    discount: Shared.Discount | null;
+
     external_price_id: string | null;
 
     fixed_price_quantity: number | null;
@@ -499,23 +501,21 @@ export namespace Price {
 
     matrix_config: MatrixPrice.MatrixConfig;
 
-    model_type: 'matrix';
+    maximum: MatrixPrice.Maximum | null;
 
-    name: string;
+    maximum_amount: string | null;
 
-    plan_phase_order: number | null;
+    minimum: MatrixPrice.Minimum | null;
 
-    price_type: 'usage_price' | 'fixed_price';
-
-    discount?: Shared.Discount | null;
+    minimum_amount: string | null;
 
-    maximum?: MatrixPrice.Maximum | null;
+    model_type: 'matrix';
 
-    maximum_amount?: string | null;
+    name: string;
 
-    minimum?: MatrixPrice.Minimum | null;
+    plan_phase_order: number | null;
 
-    minimum_amount?: string | null;
+    price_type: 'usage_price' | 'fixed_price';
   }
 
   export namespace MatrixPrice {
@@ -611,12 +611,22 @@ export namespace Price {
 
     currency: string;
 
+    discount: Shared.Discount | null;
+
     external_price_id: string | null;
 
     fixed_price_quantity: number | null;
 
     item: TieredPrice.Item;
 
+    maximum: TieredPrice.Maximum | null;
+
+    maximum_amount: string | null;
+
+    minimum: TieredPrice.Minimum | null;
+
+    minimum_amount: string | null;
+
     model_type: 'tiered';
 
     name: string;
@@ -626,16 +636,6 @@ export namespace Price {
     price_type: 'usage_price' | 'fixed_price';
 
     tiered_config: TieredPrice.TieredConfig;
-
-    discount?: Shared.Discount | null;
-
-    maximum?: TieredPrice.Maximum | null;
-
-    maximum_amount?: string | null;
-
-    minimum?: TieredPrice.Minimum | null;
-
-    minimum_amount?: string | null;
   }
 
   export namespace TieredPrice {
@@ -649,32 +649,6 @@ export namespace Price {
       name: string;
     }
 
-    export interface TieredConfig {
-      /**
-       * Tiers for rating based on total usage quantities into the specified tier
-       */
-      tiers: Array<TieredConfig.Tier>;
-    }
-
-    export namespace TieredConfig {
-      export interface Tier {
-        /**
-         * Inclusive tier starting value
-         */
-        first_unit: number;
-
-        /**
-         * Amount per unit
-         */
-        unit_amount: string;
-
-        /**
-         * Exclusive tier ending value. If null, this is treated as the last tier
-         */
-        last_unit?: number | null;
-      }
-    }
-
     export interface Maximum {
       /**
        * List of price_ids that this maximum amount applies to. For plan/plan phase
@@ -700,6 +674,32 @@ export namespace Price {
        */
       minimum_amount: string;
     }
+
+    export interface TieredConfig {
+      /**
+       * Tiers for rating based on total usage quantities into the specified tier
+       */
+      tiers: Array<TieredConfig.Tier>;
+    }
+
+    export namespace TieredConfig {
+      export interface Tier {
+        /**
+         * Inclusive tier starting value
+         */
+        first_unit: number;
+
+        /**
+         * Amount per unit
+         */
+        unit_amount: string;
+
+        /**
+         * Exclusive tier ending value. If null, this is treated as the last tier
+         */
+        last_unit?: number | null;
+      }
+    }
   }
 
   export interface TieredBpsPrice {
@@ -713,12 +713,22 @@ export namespace Price {
 
     currency: string;
 
+    discount: Shared.Discount | null;
+
     external_price_id: string | null;
 
     fixed_price_quantity: number | null;
 
     item: TieredBpsPrice.Item;
 
+    maximum: TieredBpsPrice.Maximum | null;
+
+    maximum_amount: string | null;
+
+    minimum: TieredBpsPrice.Minimum | null;
+
+    minimum_amount: string | null;
+
     model_type: 'tiered_bps';
 
     name: string;
@@ -728,16 +738,6 @@ export namespace Price {
     price_type: 'usage_price' | 'fixed_price';
 
     tiered_bps_config: TieredBpsPrice.TieredBpsConfig;
-
-    discount?: Shared.Discount | null;
-
-    maximum?: TieredBpsPrice.Maximum | null;
-
-    maximum_amount?: string | null;
-
-    minimum?: TieredBpsPrice.Minimum | null;
-
-    minimum_amount?: string | null;
   }
 
   export namespace TieredBpsPrice {
@@ -751,6 +751,32 @@ export namespace Price {
       name: string;
     }
 
+    export interface Maximum {
+      /**
+       * List of price_ids that this maximum amount applies to. For plan/plan phase
+       * maximums, this can be a subset of prices.
+       */
+      applies_to_price_ids: Array<string>;
+
+      /**
+       * Maximum amount applied
+       */
+      maximum_amount: string;
+    }
+
+    export interface Minimum {
+      /**
+       * List of price_ids that this minimum amount applies to. For plan/plan phase
+       * minimums, this can be a subset of prices.
+       */
+      applies_to_price_ids: Array<string>;
+
+      /**
+       * Minimum amount applied
+       */
+      minimum_amount: string;
+    }
+
     export interface TieredBpsConfig {
       /**
        * Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
@@ -782,32 +808,6 @@ export namespace Price {
         per_unit_maximum?: string | null;
       }
     }
-
-    export interface Maximum {
-      /**
-       * List of price_ids that this maximum amount applies to. For plan/plan phase
-       * maximums, this can be a subset of prices.
-       */
-      applies_to_price_ids: Array<string>;
-
-      /**
-       * Maximum amount applied
-       */
-      maximum_amount: string;
-    }
-
-    export interface Minimum {
-      /**
-       * List of price_ids that this minimum amount applies to. For plan/plan phase
-       * minimums, this can be a subset of prices.
-       */
-      applies_to_price_ids: Array<string>;
-
-      /**
-       * Minimum amount applied
-       */
-      minimum_amount: string;
-    }
   }
 
   export interface BpsPrice {
@@ -823,29 +823,29 @@ export namespace Price {
 
     currency: string;
 
+    discount: Shared.Discount | null;
+
     external_price_id: string | null;
 
     fixed_price_quantity: number | null;
 
     item: BpsPrice.Item;
 
-    model_type: 'bps';
+    maximum: BpsPrice.Maximum | null;
 
-    name: string;
+    maximum_amount: string | null;
 
-    plan_phase_order: number | null;
+    minimum: BpsPrice.Minimum | null;
 
-    price_type: 'usage_price' | 'fixed_price';
-
-    discount?: Shared.Discount | null;
+    minimum_amount: string | null;
 
-    maximum?: BpsPrice.Maximum | null;
+    model_type: 'bps';
 
-    maximum_amount?: string | null;
+    name: string;
 
-    minimum?: BpsPrice.Minimum | null;
+    plan_phase_order: number | null;
 
-    minimum_amount?: string | null;
+    price_type: 'usage_price' | 'fixed_price';
   }
 
   export namespace BpsPrice {
@@ -911,29 +911,29 @@ export namespace Price {
 
     currency: string;
 
+    discount: Shared.Discount | null;
+
     external_price_id: string | null;
 
     fixed_price_quantity: number | null;
 
     item: BulkBpsPrice.Item;
 
-    model_type: 'bulk_bps';
+    maximum: BulkBpsPrice.Maximum | null;
 
-    name: string;
+    maximum_amount: string | null;
 
-    plan_phase_order: number | null;
-
-    price_type: 'usage_price' | 'fixed_price';
+    minimum: BulkBpsPrice.Minimum | null;
 
-    discount?: Shared.Discount | null;
+    minimum_amount: string | null;
 
-    maximum?: BulkBpsPrice.Maximum | null;
+    model_type: 'bulk_bps';
 
-    maximum_amount?: string | null;
+    name: string;
 
-    minimum?: BulkBpsPrice.Minimum | null;
+    plan_phase_order: number | null;
 
-    minimum_amount?: string | null;
+    price_type: 'usage_price' | 'fixed_price';
   }
 
   export namespace BulkBpsPrice {
@@ -1014,29 +1014,29 @@ export namespace Price {
 
     currency: string;
 
+    discount: Shared.Discount | null;
+
     external_price_id: string | null;
 
     fixed_price_quantity: number | null;
 
     item: BulkPrice.Item;
 
-    model_type: 'bulk';
-
-    name: string;
+    maximum: BulkPrice.Maximum | null;
 
-    plan_phase_order: number | null;
+    maximum_amount: string | null;
 
-    price_type: 'usage_price' | 'fixed_price';
+    minimum: BulkPrice.Minimum | null;
 
-    discount?: Shared.Discount | null;
+    minimum_amount: string | null;
 
-    maximum?: BulkPrice.Maximum | null;
+    model_type: 'bulk';
 
-    maximum_amount?: string | null;
+    name: string;
 
-    minimum?: BulkPrice.Minimum | null;
+    plan_phase_order: number | null;
 
-    minimum_amount?: string | null;
+    price_type: 'usage_price' | 'fixed_price';
   }
 
   export namespace BulkPrice {
@@ -1109,12 +1109,22 @@ export namespace Price {
 
     currency: string;
 
+    discount: Shared.Discount | null;
+
     external_price_id: string | null;
 
     fixed_price_quantity: number | null;
 
     item: TestRatingFunctionPrice.Item;
 
+    maximum: TestRatingFunctionPrice.Maximum | null;
+
+    maximum_amount: string | null;
+
+    minimum: TestRatingFunctionPrice.Minimum | null;
+
+    minimum_amount: string | null;
+
     model_type: 'test_rating_function';
 
     name: string;
@@ -1124,16 +1134,6 @@ export namespace Price {
     price_type: 'usage_price' | 'fixed_price';
 
     test_rating_function_config: Record<string, unknown>;
-
-    discount?: Shared.Discount | null;
-
-    maximum?: TestRatingFunctionPrice.Maximum | null;
-
-    maximum_amount?: string | null;
-
-    minimum?: TestRatingFunctionPrice.Minimum | null;
-
-    minimum_amount?: string | null;
   }
 
   export namespace TestRatingFunctionPrice {
@@ -1185,6 +1185,8 @@ export namespace Price {
 
     currency: string;
 
+    discount: Shared.Discount | null;
+
     external_price_id: string | null;
 
     fivetran_example_config: Record<string, unknown>;
@@ -1193,23 +1195,21 @@ export namespace Price {
 
     item: FivetranExamplePrice.Item;
 
-    model_type: 'fivetran_example';
-
-    name: string;
+    maximum: FivetranExamplePrice.Maximum | null;
 
-    plan_phase_order: number | null;
+    maximum_amount: string | null;
 
-    price_type: 'usage_price' | 'fixed_price';
+    minimum: FivetranExamplePrice.Minimum | null;
 
-    discount?: Shared.Discount | null;
+    minimum_amount: string | null;
 
-    maximum?: FivetranExamplePrice.Maximum | null;
+    model_type: 'fivetran_example';
 
-    maximum_amount?: string | null;
+    name: string;
 
-    minimum?: FivetranExamplePrice.Minimum | null;
+    plan_phase_order: number | null;
 
-    minimum_amount?: string | null;
+    price_type: 'usage_price' | 'fixed_price';
   }
 
   export namespace FivetranExamplePrice {
@@ -1261,12 +1261,22 @@ export namespace Price {
 
     currency: string;
 
+    discount: Shared.Discount | null;
+
     external_price_id: string | null;
 
     fixed_price_quantity: number | null;
 
     item: ThresholdTotalAmountPrice.Item;
 
+    maximum: ThresholdTotalAmountPrice.Maximum | null;
+
+    maximum_amount: string | null;
+
+    minimum: ThresholdTotalAmountPrice.Minimum | null;
+
+    minimum_amount: string | null;
+
     model_type: 'threshold_total_amount';
 
     name: string;
@@ -1276,16 +1286,6 @@ export namespace Price {
     price_type: 'usage_price' | 'fixed_price';
 
     threshold_total_amount_config: Record<string, unknown>;
-
-    discount?: Shared.Discount | null;
-
-    maximum?: ThresholdTotalAmountPrice.Maximum | null;
-
-    maximum_amount?: string | null;
-
-    minimum?: ThresholdTotalAmountPrice.Minimum | null;
-
-    minimum_amount?: string | null;
   }
 
   export namespace ThresholdTotalAmountPrice {
@@ -1337,12 +1337,22 @@ export namespace Price {
 
     currency: string;
 
+    discount: Shared.Discount | null;
+
     external_price_id: string | null;
 
     fixed_price_quantity: number | null;
 
     item: TieredPackagePrice.Item;
 
+    maximum: TieredPackagePrice.Maximum | null;
+
+    maximum_amount: string | null;
+
+    minimum: TieredPackagePrice.Minimum | null;
+
+    minimum_amount: string | null;
+
     model_type: 'tiered_package';
 
     name: string;
@@ -1352,16 +1362,6 @@ export namespace Price {
     price_type: 'usage_price' | 'fixed_price';
 
     tiered_package_config: Record<string, unknown>;
-
-    discount?: Shared.Discount | null;
-
-    maximum?: TieredPackagePrice.Maximum | null;
-
-    maximum_amount?: string | null;
-
-    minimum?: TieredPackagePrice.Minimum | null;
-
-    minimum_amount?: string | null;
   }
 
   export namespace TieredPackagePrice {
@@ -1413,12 +1413,22 @@ export namespace Price {
 
     currency: string;
 
+    discount: Shared.Discount | null;
+
     external_price_id: string | null;
 
     fixed_price_quantity: number | null;
 
     item: TieredWithMinimumPrice.Item;
 
+    maximum: TieredWithMinimumPrice.Maximum | null;
+
+    maximum_amount: string | null;
+
+    minimum: TieredWithMinimumPrice.Minimum | null;
+
+    minimum_amount: string | null;
+
     model_type: 'tiered_with_minimum';
 
     name: string;
@@ -1428,16 +1438,6 @@ export namespace Price {
     price_type: 'usage_price' | 'fixed_price';
 
     tiered_with_minimum_config: Record<string, unknown>;
-
-    discount?: Shared.Discount | null;
-
-    maximum?: TieredWithMinimumPrice.Maximum | null;
-
-    maximum_amount?: string | null;
-
-    minimum?: TieredWithMinimumPrice.Minimum | null;
-
-    minimum_amount?: string | null;
   }
 
   export namespace TieredWithMinimumPrice {
@@ -1489,12 +1489,22 @@ export namespace Price {
 
     currency: string;
 
+    discount: Shared.Discount | null;
+
     external_price_id: string | null;
 
     fixed_price_quantity: number | null;
 
     item: PackageWithAllocationPrice.Item;
 
+    maximum: PackageWithAllocationPrice.Maximum | null;
+
+    maximum_amount: string | null;
+
+    minimum: PackageWithAllocationPrice.Minimum | null;
+
+    minimum_amount: string | null;
+
     model_type: 'package_with_allocation';
 
     name: string;
@@ -1504,16 +1514,6 @@ export namespace Price {
     plan_phase_order: number | null;
 
     price_type: 'usage_price' | 'fixed_price';
-
-    discount?: Shared.Discount | null;
-
-    maximum?: PackageWithAllocationPrice.Maximum | null;
-
-    maximum_amount?: string | null;
-
-    minimum?: PackageWithAllocationPrice.Minimum | null;
-
-    minimum_amount?: string | null;
   }
 
   export namespace PackageWithAllocationPrice {