orb-billing 5.75.1 → 6.0.0

package/src/resources/metrics.ts

@@ -1,10 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../resource';
-import { isRequestOptions } from '../core';
-import * as Core from '../core';
+import { APIResource } from '../core/resource';
 import * as ItemsAPI from './items';
-import { Page, type PageParams } from '../pagination';
+import { APIPromise } from '../core/api-promise';
+import { Page, type PageParams, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
 
 /**
  * The Metric resource represents a calculation of a quantity based on events.
@@ -26,7 +27,7 @@ export class Metrics extends APIResource {
    * });
    * ```
    */
-  create(body: MetricCreateParams, options?: Core.RequestOptions): Core.APIPromise<BillableMetric> {
+  create(body: MetricCreateParams, options?: RequestOptions): APIPromise<BillableMetric> {
     return this._client.post('/metrics', { body, ...options });
   }
 
@@ -42,12 +43,8 @@ export class Metrics extends APIResource {
    * );
    * ```
    */
-  update(
-    metricId: string,
-    body: MetricUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<BillableMetric> {
-    return this._client.put(`/metrics/${metricId}`, { body, ...options });
+  update(metricId: string, body: MetricUpdateParams, options?: RequestOptions): APIPromise<BillableMetric> {
+    return this._client.put(path`/metrics/${metricId}`, { body, ...options });
   }
 
   /**
@@ -63,18 +60,10 @@ export class Metrics extends APIResource {
    * ```
    */
   list(
-    query?: MetricListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<BillableMetricsPage, BillableMetric>;
-  list(options?: Core.RequestOptions): Core.PagePromise<BillableMetricsPage, BillableMetric>;
-  list(
-    query: MetricListParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<BillableMetricsPage, BillableMetric> {
-    if (isRequestOptions(query)) {
-      return this.list({}, query);
-    }
-    return this._client.getAPIList('/metrics', BillableMetricsPage, { query, ...options });
+    query: MetricListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<BillableMetricsPage, BillableMetric> {
+    return this._client.getAPIList('/metrics', Page<BillableMetric>, { query, ...options });
   }
 
   /**
@@ -89,12 +78,12 @@ export class Metrics extends APIResource {
    * );
    * ```
    */
-  fetch(metricId: string, options?: Core.RequestOptions): Core.APIPromise<BillableMetric> {
-    return this._client.get(`/metrics/${metricId}`, options);
+  fetch(metricId: string, options?: RequestOptions): APIPromise<BillableMetric> {
+    return this._client.get(path`/metrics/${metricId}`, options);
   }
 }
 
-export class BillableMetricsPage extends Page<BillableMetric> {}
+export type BillableMetricsPage = Page<BillableMetric>;
 
 /**
  * The Metric resource represents a calculation of a quantity based on events.
@@ -123,6 +112,12 @@ export interface BillableMetric {
 
   name: string;
 
+  /**
+   * The SQL definition of the metric. For metrics defined via configuration rather
+   * than SQL, this is a derived SQL representation.
+   */
+  sql: string;
+
   status: 'active' | 'draft' | 'archived';
 
   parameter_definitions?: Array<{ [key: string]: unknown }> | null;
@@ -176,12 +171,10 @@ export interface MetricListParams extends PageParams {
   'created_at[lte]'?: string | null;
 }
 
-Metrics.BillableMetricsPage = BillableMetricsPage;
-
 export declare namespace Metrics {
   export {
     type BillableMetric as BillableMetric,
-    BillableMetricsPage as BillableMetricsPage,
+    type BillableMetricsPage as BillableMetricsPage,
     type MetricCreateParams as MetricCreateParams,
     type MetricUpdateParams as MetricUpdateParams,
     type MetricListParams as MetricListParams,

package/src/resources/plans/external-plan-id.ts

@@ -1,8 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
+import { APIResource } from '../../core/resource';
 import * as PlansAPI from './plans';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 /**
  * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be subscribed to by a
@@ -19,9 +21,9 @@ export class ExternalPlanID extends APIResource {
   update(
     otherExternalPlanId: string,
     body: ExternalPlanIDUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<PlansAPI.Plan> {
-    return this._client.put(`/plans/external_plan_id/${otherExternalPlanId}`, { body, ...options });
+    options?: RequestOptions,
+  ): APIPromise<PlansAPI.Plan> {
+    return this._client.put(path`/plans/external_plan_id/${otherExternalPlanId}`, { body, ...options });
   }
 
   /**
@@ -42,8 +44,8 @@ export class ExternalPlanID extends APIResource {
    * that is present. A detailed explanation of price types can be found in the
    * [Price schema](/core-concepts#plan-and-price). "
    */
-  fetch(externalPlanId: string, options?: Core.RequestOptions): Core.APIPromise<PlansAPI.Plan> {
-    return this._client.get(`/plans/external_plan_id/${externalPlanId}`, options);
+  fetch(externalPlanId: string, options?: RequestOptions): APIPromise<PlansAPI.Plan> {
+    return this._client.get(path`/plans/external_plan_id/${externalPlanId}`, options);
   }
 }
 

package/src/resources/plans/index.ts

@@ -2,18 +2,20 @@
 
 export { ExternalPlanID, type ExternalPlanIDUpdateParams } from './external-plan-id';
 export {
-  MigrationListResponsesPage,
   Migrations,
   type MigrationRetrieveResponse,
   type MigrationListResponse,
   type MigrationCancelResponse,
+  type MigrationRetrieveParams,
   type MigrationListParams,
+  type MigrationCancelParams,
+  type MigrationListResponsesPage,
 } from './migrations';
 export {
-  PlansPage,
   Plans,
   type Plan,
   type PlanCreateParams,
   type PlanUpdateParams,
   type PlanListParams,
+  type PlansPage,
 } from './plans';

package/src/resources/plans/migrations.ts

@@ -1,9 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import { isRequestOptions } from '../../core';
-import * as Core from '../../core';
-import { Page, type PageParams } from '../../pagination';
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { Page, type PageParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 /**
  * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be subscribed to by a
@@ -15,11 +16,12 @@ export class Migrations extends APIResource {
    * Fetch migration
    */
   retrieve(
-    planId: string,
     migrationId: string,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<MigrationRetrieveResponse> {
-    return this._client.get(`/plans/${planId}/migrations/${migrationId}`, options);
+    params: MigrationRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<MigrationRetrieveResponse> {
+    const { plan_id: planId } = params;
+    return this._client.get(path`/plans/${planId}/migrations/${migrationId}`, options);
   }
 
   /**
@@ -30,22 +32,10 @@ export class Migrations extends APIResource {
    */
   list(
     planId: string,
-    query?: MigrationListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<MigrationListResponsesPage, MigrationListResponse>;
-  list(
-    planId: string,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<MigrationListResponsesPage, MigrationListResponse>;
-  list(
-    planId: string,
-    query: MigrationListParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<MigrationListResponsesPage, MigrationListResponse> {
-    if (isRequestOptions(query)) {
-      return this.list(planId, {}, query);
-    }
-    return this._client.getAPIList(`/plans/${planId}/migrations`, MigrationListResponsesPage, {
+    query: MigrationListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<MigrationListResponsesPage, MigrationListResponse> {
+    return this._client.getAPIList(path`/plans/${planId}/migrations`, Page<MigrationListResponse>, {
       query,
       ...options,
     });
@@ -55,15 +45,16 @@ export class Migrations extends APIResource {
    * This endpoint cancels a migration.
    */
   cancel(
-    planId: string,
     migrationId: string,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<MigrationCancelResponse> {
-    return this._client.post(`/plans/${planId}/migrations/${migrationId}/cancel`, options);
+    params: MigrationCancelParams,
+    options?: RequestOptions,
+  ): APIPromise<MigrationCancelResponse> {
+    const { plan_id: planId } = params;
+    return this._client.post(path`/plans/${planId}/migrations/${migrationId}/cancel`, options);
   }
 }
 
-export class MigrationListResponsesPage extends Page<MigrationListResponse> {}
+export type MigrationListResponsesPage = Page<MigrationListResponse>;
 
 export interface MigrationRetrieveResponse {
   /**
@@ -137,16 +128,24 @@ export interface MigrationCancelResponse {
   status: 'not_started' | 'in_progress' | 'completed' | 'action_needed' | 'canceled';
 }
 
+export interface MigrationRetrieveParams {
+  plan_id: string;
+}
+
 export interface MigrationListParams extends PageParams {}
 
-Migrations.MigrationListResponsesPage = MigrationListResponsesPage;
+export interface MigrationCancelParams {
+  plan_id: string;
+}
 
 export declare namespace Migrations {
   export {
     type MigrationRetrieveResponse as MigrationRetrieveResponse,
     type MigrationListResponse as MigrationListResponse,
     type MigrationCancelResponse as MigrationCancelResponse,
-    MigrationListResponsesPage as MigrationListResponsesPage,
+    type MigrationListResponsesPage as MigrationListResponsesPage,
+    type MigrationRetrieveParams as MigrationRetrieveParams,
     type MigrationListParams as MigrationListParams,
+    type MigrationCancelParams as MigrationCancelParams,
   };
 }

package/src/resources/plans/plans.ts

@@ -1,21 +1,24 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import { isRequestOptions } from '../../core';
-import * as Core from '../../core';
+import { APIResource } from '../../core/resource';
 import * as Shared from '../shared';
 import * as ExternalPlanIDAPI from './external-plan-id';
 import { ExternalPlanID, ExternalPlanIDUpdateParams } from './external-plan-id';
 import * as MigrationsAPI from './migrations';
 import {
+  MigrationCancelParams,
   MigrationCancelResponse,
   MigrationListParams,
   MigrationListResponse,
   MigrationListResponsesPage,
+  MigrationRetrieveParams,
   MigrationRetrieveResponse,
   Migrations,
 } from './migrations';
-import { Page, type PageParams } from '../../pagination';
+import { APIPromise } from '../../core/api-promise';
+import { Page, type PageParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 /**
  * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be subscribed to by a
@@ -23,13 +26,13 @@ import { Page, type PageParams } from '../../pagination';
  * in the [Price resource](/reference/price).
  */
 export class Plans extends APIResource {
-  externalPlanId: ExternalPlanIDAPI.ExternalPlanID = new ExternalPlanIDAPI.ExternalPlanID(this._client);
+  externalPlanID: ExternalPlanIDAPI.ExternalPlanID = new ExternalPlanIDAPI.ExternalPlanID(this._client);
   migrations: MigrationsAPI.Migrations = new MigrationsAPI.Migrations(this._client);
 
   /**
    * This endpoint allows creation of plans including their prices.
    */
-  create(body: PlanCreateParams, options?: Core.RequestOptions): Core.APIPromise<Plan> {
+  create(body: PlanCreateParams, options?: RequestOptions): APIPromise<Plan> {
     return this._client.post('/plans', { body, ...options });
   }
 
@@ -39,8 +42,8 @@ export class Plans extends APIResource {
    *
    * Other fields on a plan are currently immutable.
    */
-  update(planId: string, body: PlanUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Plan> {
-    return this._client.put(`/plans/${planId}`, { body, ...options });
+  update(planId: string, body: PlanUpdateParams, options?: RequestOptions): APIPromise<Plan> {
+    return this._client.put(path`/plans/${planId}`, { body, ...options });
   }
 
   /**
@@ -50,16 +53,11 @@ export class Plans extends APIResource {
    * [`pagination_metadata`](/api-reference/pagination) which lets the caller
    * retrieve the next page of results if they exist.
    */
-  list(query?: PlanListParams, options?: Core.RequestOptions): Core.PagePromise<PlansPage, Plan>;
-  list(options?: Core.RequestOptions): Core.PagePromise<PlansPage, Plan>;
   list(
-    query: PlanListParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<PlansPage, Plan> {
-    if (isRequestOptions(query)) {
-      return this.list({}, query);
-    }
-    return this._client.getAPIList('/plans', PlansPage, { query, ...options });
+    query: PlanListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PlansPage, Plan> {
+    return this._client.getAPIList('/plans', Page<Plan>, { query, ...options });
   }
 
   /**
@@ -81,12 +79,12 @@ export class Plans extends APIResource {
    * Orb supports plan phases, also known as contract ramps. For plans with phases,
    * the serialized prices refer to all prices across all phases.
    */
-  fetch(planId: string, options?: Core.RequestOptions): Core.APIPromise<Plan> {
-    return this._client.get(`/plans/${planId}`, options);
+  fetch(planId: string, options?: RequestOptions): APIPromise<Plan> {
+    return this._client.get(path`/plans/${planId}`, options);
   }
 }
 
-export class PlansPage extends Page<Plan> {}
+export type PlansPage = Page<Plan>;
 
 /**
  * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
@@ -2074,15 +2072,13 @@ export interface PlanListParams extends PageParams {
   status?: 'active' | 'archived' | 'draft';
 }
 
-Plans.PlansPage = PlansPage;
 Plans.ExternalPlanID = ExternalPlanID;
 Plans.Migrations = Migrations;
-Plans.MigrationListResponsesPage = MigrationListResponsesPage;
 
 export declare namespace Plans {
   export {
     type Plan as Plan,
-    PlansPage as PlansPage,
+    type PlansPage as PlansPage,
     type PlanCreateParams as PlanCreateParams,
     type PlanUpdateParams as PlanUpdateParams,
     type PlanListParams as PlanListParams,
@@ -2095,7 +2091,9 @@ export declare namespace Plans {
     type MigrationRetrieveResponse as MigrationRetrieveResponse,
     type MigrationListResponse as MigrationListResponse,
     type MigrationCancelResponse as MigrationCancelResponse,
-    MigrationListResponsesPage as MigrationListResponsesPage,
+    type MigrationListResponsesPage as MigrationListResponsesPage,
+    type MigrationRetrieveParams as MigrationRetrieveParams,
     type MigrationListParams as MigrationListParams,
+    type MigrationCancelParams as MigrationCancelParams,
   };
 }

package/src/resources/prices/external-price-id.ts

@@ -1,8 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
+import { APIResource } from '../../core/resource';
 import * as Shared from '../shared';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 /**
  * The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in
@@ -21,7 +23,7 @@ export class ExternalPriceID extends APIResource {
    *
    * @example
    * ```ts
-   * const price = await client.prices.externalPriceId.update(
+   * const price = await client.prices.externalPriceID.update(
    *   'external_price_id',
    * );
    * ```
@@ -29,9 +31,9 @@ export class ExternalPriceID extends APIResource {
   update(
     externalPriceId: string,
     body: ExternalPriceIDUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<Shared.Price> {
-    return this._client.put(`/prices/external_price_id/${externalPriceId}`, { body, ...options });
+    options?: RequestOptions,
+  ): APIPromise<Shared.Price> {
+    return this._client.put(path`/prices/external_price_id/${externalPriceId}`, { body, ...options });
   }
 
   /**
@@ -41,13 +43,13 @@ export class ExternalPriceID extends APIResource {
    *
    * @example
    * ```ts
-   * const price = await client.prices.externalPriceId.fetch(
+   * const price = await client.prices.externalPriceID.fetch(
    *   'external_price_id',
    * );
    * ```
    */
-  fetch(externalPriceId: string, options?: Core.RequestOptions): Core.APIPromise<Shared.Price> {
-    return this._client.get(`/prices/external_price_id/${externalPriceId}`, options);
+  fetch(externalPriceId: string, options?: RequestOptions): APIPromise<Shared.Price> {
+    return this._client.get(path`/prices/external_price_id/${externalPriceId}`, options);
   }
 }
 

package/src/resources/prices/prices.ts

@@ -1,14 +1,15 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import { isRequestOptions } from '../../core';
-import * as Core from '../../core';
+import { APIResource } from '../../core/resource';
 import * as PricesAPI from './prices';
 import * as Shared from '../shared';
 import { PricesPage } from '../shared';
 import * as ExternalPriceIDAPI from './external-price-id';
 import { ExternalPriceID, ExternalPriceIDUpdateParams } from './external-price-id';
-import { type PageParams } from '../../pagination';
+import { APIPromise } from '../../core/api-promise';
+import { Page, type PageParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 /**
  * The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in
@@ -20,7 +21,7 @@ import { type PageParams } from '../../pagination';
  * For more on the types of prices, see [the core concepts documentation](/core-concepts#plan-and-price)
  */
 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](/product-catalog/price-configuration).
@@ -46,7 +47,7 @@ export class Prices extends APIResource {
    * });
    * ```
    */
-  create(body: PriceCreateParams, options?: Core.RequestOptions): Core.APIPromise<Shared.Price> {
+  create(body: PriceCreateParams, options?: RequestOptions): APIPromise<Shared.Price> {
     return this._client.post('/prices', { body, ...options });
   }
 
@@ -60,12 +61,8 @@ export class Prices extends APIResource {
    * const price = await client.prices.update('price_id');
    * ```
    */
-  update(
-    priceId: string,
-    body: PriceUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<Shared.Price> {
-    return this._client.put(`/prices/${priceId}`, { body, ...options });
+  update(priceId: string, body: PriceUpdateParams, options?: RequestOptions): APIPromise<Shared.Price> {
+    return this._client.put(path`/prices/${priceId}`, { body, ...options });
   }
 
   /**
@@ -80,16 +77,11 @@ export class Prices extends APIResource {
    * }
    * ```
    */
-  list(query?: PriceListParams, options?: Core.RequestOptions): Core.PagePromise<PricesPage, Shared.Price>;
-  list(options?: Core.RequestOptions): Core.PagePromise<PricesPage, Shared.Price>;
   list(
-    query: PriceListParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<PricesPage, Shared.Price> {
-    if (isRequestOptions(query)) {
-      return this.list({}, query);
-    }
-    return this._client.getAPIList('/prices', PricesPage, { query, ...options });
+    query: PriceListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PricesPage, Shared.Price> {
+    return this._client.getAPIList('/prices', Page<Shared.Price>, { query, ...options });
   }
 
   /**
@@ -130,9 +122,9 @@ export class Prices extends APIResource {
   evaluate(
     priceId: string,
     body: PriceEvaluateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<PriceEvaluateResponse> {
-    return this._client.post(`/prices/${priceId}/evaluate`, { body, ...options });
+    options?: RequestOptions,
+  ): APIPromise<PriceEvaluateResponse> {
+    return this._client.post(path`/prices/${priceId}/evaluate`, { body, ...options });
   }
 
   /**
@@ -176,8 +168,8 @@ export class Prices extends APIResource {
    */
   evaluateMultiple(
     body: PriceEvaluateMultipleParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<PriceEvaluateMultipleResponse> {
+    options?: RequestOptions,
+  ): APIPromise<PriceEvaluateMultipleResponse> {
     return this._client.post('/prices/evaluate', { body, ...options });
   }
 
@@ -211,8 +203,8 @@ export class Prices extends APIResource {
    */
   evaluatePreviewEvents(
     body: PriceEvaluatePreviewEventsParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<PriceEvaluatePreviewEventsResponse> {
+    options?: RequestOptions,
+  ): APIPromise<PriceEvaluatePreviewEventsResponse> {
     return this._client.post('/prices/evaluate_preview_events', { body, ...options });
   }
 
@@ -224,8 +216,8 @@ export class Prices extends APIResource {
    * const price = await client.prices.fetch('price_id');
    * ```
    */
-  fetch(priceId: string, options?: Core.RequestOptions): Core.APIPromise<Shared.Price> {
-    return this._client.get(`/prices/${priceId}`, options);
+  fetch(priceId: string, options?: RequestOptions): APIPromise<Shared.Price> {
+    return this._client.get(path`/prices/${priceId}`, options);
   }
 }
 
@@ -7190,4 +7182,4 @@ export declare namespace Prices {
   };
 }
 
-export { PricesPage };
+export { type PricesPage };

package/src/resources/shared.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import * as Shared from './shared';
-import { Page } from '../pagination';
+import { Page } from '../core/pagination';
 
 export interface Address {
   city: string | null;
@@ -16690,8 +16690,8 @@ export namespace UsageDiscountInterval {
   }
 }
 
-export class CreditNotesPage extends Page<CreditNote> {}
+export type CreditNotesPage = Page<CreditNote>;
 
-export class InvoicesPage extends Page<Invoice> {}
+export type InvoicesPage = Page<Invoice>;
 
-export class PricesPage extends Page<Price> {}
+export type PricesPage = Page<Price>;