orb-billing 4.33.0 → 4.47.2

package/src/resources/customers/customers.ts

@@ -3,10 +3,33 @@
 import { APIResource } from '../../resource';
 import { isRequestOptions } from '../../core';
 import * as Core from '../../core';
-import * as CustomersAPI from './customers';
 import * as BalanceTransactionsAPI from './balance-transactions';
+import {
+  BalanceTransactionCreateParams,
+  BalanceTransactionCreateResponse,
+  BalanceTransactionListParams,
+  BalanceTransactionListResponse,
+  BalanceTransactionListResponsesPage,
+  BalanceTransactions,
+} from './balance-transactions';
 import * as CostsAPI from './costs';
+import {
+  CostListByExternalIDParams,
+  CostListByExternalIDResponse,
+  CostListParams,
+  CostListResponse,
+  Costs,
+} from './costs';
 import * as CreditsAPI from './credits/credits';
+import {
+  CreditListByExternalIDParams,
+  CreditListByExternalIDResponse,
+  CreditListByExternalIDResponsesPage,
+  CreditListParams,
+  CreditListResponse,
+  CreditListResponsesPage,
+  Credits,
+} from './credits/credits';
 import { Page, type PageParams } from '../../pagination';
 
 export class Customers extends APIResource {
@@ -2200,29 +2223,48 @@ export namespace CustomerUpdateByExternalIDParams {
   }
 }
 
-export namespace Customers {
-  export import Customer = CustomersAPI.Customer;
-  export import CustomersPage = CustomersAPI.CustomersPage;
-  export import CustomerCreateParams = CustomersAPI.CustomerCreateParams;
-  export import CustomerUpdateParams = CustomersAPI.CustomerUpdateParams;
-  export import CustomerListParams = CustomersAPI.CustomerListParams;
-  export import CustomerUpdateByExternalIDParams = CustomersAPI.CustomerUpdateByExternalIDParams;
-  export import Costs = CostsAPI.Costs;
-  export import CostListResponse = CostsAPI.CostListResponse;
-  export import CostListByExternalIDResponse = CostsAPI.CostListByExternalIDResponse;
-  export import CostListParams = CostsAPI.CostListParams;
-  export import CostListByExternalIDParams = CostsAPI.CostListByExternalIDParams;
-  export import Credits = CreditsAPI.Credits;
-  export import CreditListResponse = CreditsAPI.CreditListResponse;
-  export import CreditListByExternalIDResponse = CreditsAPI.CreditListByExternalIDResponse;
-  export import CreditListResponsesPage = CreditsAPI.CreditListResponsesPage;
-  export import CreditListByExternalIDResponsesPage = CreditsAPI.CreditListByExternalIDResponsesPage;
-  export import CreditListParams = CreditsAPI.CreditListParams;
-  export import CreditListByExternalIDParams = CreditsAPI.CreditListByExternalIDParams;
-  export import BalanceTransactions = BalanceTransactionsAPI.BalanceTransactions;
-  export import BalanceTransactionCreateResponse = BalanceTransactionsAPI.BalanceTransactionCreateResponse;
-  export import BalanceTransactionListResponse = BalanceTransactionsAPI.BalanceTransactionListResponse;
-  export import BalanceTransactionListResponsesPage = BalanceTransactionsAPI.BalanceTransactionListResponsesPage;
-  export import BalanceTransactionCreateParams = BalanceTransactionsAPI.BalanceTransactionCreateParams;
-  export import BalanceTransactionListParams = BalanceTransactionsAPI.BalanceTransactionListParams;
+Customers.CustomersPage = CustomersPage;
+Customers.Costs = Costs;
+Customers.Credits = Credits;
+Customers.CreditListResponsesPage = CreditListResponsesPage;
+Customers.CreditListByExternalIDResponsesPage = CreditListByExternalIDResponsesPage;
+Customers.BalanceTransactions = BalanceTransactions;
+Customers.BalanceTransactionListResponsesPage = BalanceTransactionListResponsesPage;
+
+export declare namespace Customers {
+  export {
+    type Customer as Customer,
+    CustomersPage as CustomersPage,
+    type CustomerCreateParams as CustomerCreateParams,
+    type CustomerUpdateParams as CustomerUpdateParams,
+    type CustomerListParams as CustomerListParams,
+    type CustomerUpdateByExternalIDParams as CustomerUpdateByExternalIDParams,
+  };
+
+  export {
+    Costs as Costs,
+    type CostListResponse as CostListResponse,
+    type CostListByExternalIDResponse as CostListByExternalIDResponse,
+    type CostListParams as CostListParams,
+    type CostListByExternalIDParams as CostListByExternalIDParams,
+  };
+
+  export {
+    Credits as Credits,
+    type CreditListResponse as CreditListResponse,
+    type CreditListByExternalIDResponse as CreditListByExternalIDResponse,
+    CreditListResponsesPage as CreditListResponsesPage,
+    CreditListByExternalIDResponsesPage as CreditListByExternalIDResponsesPage,
+    type CreditListParams as CreditListParams,
+    type CreditListByExternalIDParams as CreditListByExternalIDParams,
+  };
+
+  export {
+    BalanceTransactions as BalanceTransactions,
+    type BalanceTransactionCreateResponse as BalanceTransactionCreateResponse,
+    type BalanceTransactionListResponse as BalanceTransactionListResponse,
+    BalanceTransactionListResponsesPage as BalanceTransactionListResponsesPage,
+    type BalanceTransactionCreateParams as BalanceTransactionCreateParams,
+    type BalanceTransactionListParams as BalanceTransactionListParams,
+  };
 }

package/src/resources/customers/index.ts

@@ -1,35 +1,35 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export {
-  BalanceTransactionCreateResponse,
-  BalanceTransactionListResponse,
-  BalanceTransactionCreateParams,
-  BalanceTransactionListParams,
   BalanceTransactionListResponsesPage,
   BalanceTransactions,
+  type BalanceTransactionCreateResponse,
+  type BalanceTransactionListResponse,
+  type BalanceTransactionCreateParams,
+  type BalanceTransactionListParams,
 } from './balance-transactions';
 export {
-  CostListResponse,
-  CostListByExternalIDResponse,
-  CostListParams,
-  CostListByExternalIDParams,
   Costs,
+  type CostListResponse,
+  type CostListByExternalIDResponse,
+  type CostListParams,
+  type CostListByExternalIDParams,
 } from './costs';
 export {
-  CreditListResponse,
-  CreditListByExternalIDResponse,
-  CreditListParams,
-  CreditListByExternalIDParams,
   CreditListResponsesPage,
   CreditListByExternalIDResponsesPage,
   Credits,
+  type CreditListResponse,
+  type CreditListByExternalIDResponse,
+  type CreditListParams,
+  type CreditListByExternalIDParams,
 } from './credits/index';
 export {
-  Customer,
-  CustomerCreateParams,
-  CustomerUpdateParams,
-  CustomerListParams,
-  CustomerUpdateByExternalIDParams,
   CustomersPage,
   Customers,
+  type Customer,
+  type CustomerCreateParams,
+  type CustomerUpdateParams,
+  type CustomerListParams,
+  type CustomerUpdateByExternalIDParams,
 } from './customers';

package/src/resources/dimensional-price-groups/dimensional-price-groups.ts

@@ -0,0 +1,146 @@
+// 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 * as Shared from '../shared';
+import * as ExternalDimensionalPriceGroupIDAPI from './external-dimensional-price-group-id';
+import { ExternalDimensionalPriceGroupID } from './external-dimensional-price-group-id';
+import { Page, type PageParams } from '../../pagination';
+
+export class DimensionalPriceGroups extends APIResource {
+  externalDimensionalPriceGroupId: ExternalDimensionalPriceGroupIDAPI.ExternalDimensionalPriceGroupID =
+    new ExternalDimensionalPriceGroupIDAPI.ExternalDimensionalPriceGroupID(this._client);
+
+  /**
+   * A dimensional price group is used to partition the result of a billable metric
+   * by a set of dimensions. Prices in a price group must specify the parition used
+   * to derive their usage.
+   *
+   * For example, suppose we have a billable metric that measures the number of
+   * widgets used and we want to charge differently depending on the color of the
+   * widget. We can create a price group with a dimension "color" and two prices: one
+   * that charges $10 per red widget and one that charges $20 per blue widget.
+   */
+  create(
+    body: DimensionalPriceGroupCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<DimensionalPriceGroup> {
+    return this._client.post('/dimensional_price_groups', { body, ...options });
+  }
+
+  /**
+   * Fetch dimensional price group
+   */
+  retrieve(
+    dimensionalPriceGroupId: string,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<DimensionalPriceGroup> {
+    return this._client.get(`/dimensional_price_groups/${dimensionalPriceGroupId}`, options);
+  }
+
+  /**
+   * List dimensional price groups
+   */
+  list(
+    query?: DimensionalPriceGroupListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<DimensionalPriceGroupsPage, DimensionalPriceGroup>;
+  list(options?: Core.RequestOptions): Core.PagePromise<DimensionalPriceGroupsPage, DimensionalPriceGroup>;
+  list(
+    query: DimensionalPriceGroupListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<DimensionalPriceGroupsPage, DimensionalPriceGroup> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.getAPIList('/dimensional_price_groups', DimensionalPriceGroupsPage, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export class DimensionalPriceGroupsPage extends Page<DimensionalPriceGroup> {}
+
+/**
+ * A dimensional price group is used to partition the result of a billable metric
+ * by a set of dimensions. Prices in a price group must specify the parition used
+ * to derive their usage.
+ */
+export interface DimensionalPriceGroup {
+  id: string;
+
+  /**
+   * The billable metric associated with this dimensional price group. All prices
+   * associated with this dimensional price group will be computed using this
+   * billable metric.
+   */
+  billable_metric_id: string;
+
+  /**
+   * The dimensions that this dimensional price group is defined over
+   */
+  dimensions: Array<string>;
+
+  /**
+   * An alias for the dimensional price group
+   */
+  external_dimensional_price_group_id: string | null;
+
+  /**
+   * User specified key-value pairs for the resource. If not present, this defaults
+   * to an empty dictionary. Individual keys can be removed by setting the value to
+   * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+   * `null`.
+   */
+  metadata: Record<string, string>;
+
+  /**
+   * The name of the dimensional price group
+   */
+  name: string;
+}
+
+export interface DimensionalPriceGroups {
+  data: Array<DimensionalPriceGroup>;
+
+  pagination_metadata: Shared.PaginationMetadata;
+}
+
+export interface DimensionalPriceGroupCreateParams {
+  billable_metric_id: string;
+
+  /**
+   * The set of keys (in order) used to disambiguate prices in the group.
+   */
+  dimensions: Array<string>;
+
+  name: string;
+
+  external_dimensional_price_group_id?: string | null;
+
+  /**
+   * User-specified key/value pairs for the resource. Individual keys can be removed
+   * by setting the value to `null`, and the entire metadata mapping can be cleared
+   * by setting `metadata` to `null`.
+   */
+  metadata?: Record<string, string | null> | null;
+}
+
+export interface DimensionalPriceGroupListParams extends PageParams {}
+
+DimensionalPriceGroups.DimensionalPriceGroupsPage = DimensionalPriceGroupsPage;
+DimensionalPriceGroups.ExternalDimensionalPriceGroupID = ExternalDimensionalPriceGroupID;
+
+export declare namespace DimensionalPriceGroups {
+  export {
+    type DimensionalPriceGroup as DimensionalPriceGroup,
+    type DimensionalPriceGroups as DimensionalPriceGroups,
+    DimensionalPriceGroupsPage as DimensionalPriceGroupsPage,
+    type DimensionalPriceGroupCreateParams as DimensionalPriceGroupCreateParams,
+    type DimensionalPriceGroupListParams as DimensionalPriceGroupListParams,
+  };
+
+  export { ExternalDimensionalPriceGroupID as ExternalDimensionalPriceGroupID };
+}

package/src/resources/dimensional-price-groups/external-dimensional-price-group-id.ts

@@ -0,0 +1,20 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as DimensionalPriceGroupsAPI from './dimensional-price-groups';
+
+export class ExternalDimensionalPriceGroupID extends APIResource {
+  /**
+   * Fetch dimensional price group by external ID
+   */
+  retrieve(
+    externalDimensionalPriceGroupId: string,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<DimensionalPriceGroupsAPI.DimensionalPriceGroup> {
+    return this._client.get(
+      `/dimensional_price_groups/external_dimensional_price_group_id/${externalDimensionalPriceGroupId}`,
+      options,
+    );
+  }
+}

package/src/resources/dimensional-price-groups/index.ts

@@ -0,0 +1,10 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  DimensionalPriceGroupsPage,
+  type DimensionalPriceGroups,
+  type DimensionalPriceGroup,
+  type DimensionalPriceGroupCreateParams,
+  type DimensionalPriceGroupListParams,
+} from './dimensional-price-groups';
+export { ExternalDimensionalPriceGroupID } from './external-dimensional-price-group-id';

package/src/resources/events/backfills.ts

@@ -3,7 +3,6 @@
 import { APIResource } from '../../resource';
 import { isRequestOptions } from '../../core';
 import * as Core from '../../core';
-import * as BackfillsAPI from './backfills';
 import { Page, type PageParams } from '../../pagination';
 
 export class Backfills extends APIResource {
@@ -38,8 +37,10 @@ export class Backfills extends APIResource {
    * only affect events for that customer. If neither is specified, the backfill will
    * affect all customers.
    *
-   * When `replace_existing_events` is `true`, the field `filter` can be optionally
-   * added which enables filtering using
+   * When `replace_existing_events` is `true`, this indicates that existing events in
+   * the timeframe should no longer be counted towards invoiced usage. In this
+   * scenario, the parameter `filter` can be optionally added which enables filtering
+   * using
    * [computed properties](../guides/extensibility/advanced-metrics#computed-properties).
    * The expressiveness of computed properties allows you to deprecate existing
    * events based on both a period of time and specific property values.
@@ -391,13 +392,17 @@ export interface BackfillCreateParams {
 
 export interface BackfillListParams extends PageParams {}
 
-export namespace Backfills {
-  export import BackfillCreateResponse = BackfillsAPI.BackfillCreateResponse;
-  export import BackfillListResponse = BackfillsAPI.BackfillListResponse;
-  export import BackfillCloseResponse = BackfillsAPI.BackfillCloseResponse;
-  export import BackfillFetchResponse = BackfillsAPI.BackfillFetchResponse;
-  export import BackfillRevertResponse = BackfillsAPI.BackfillRevertResponse;
-  export import BackfillListResponsesPage = BackfillsAPI.BackfillListResponsesPage;
-  export import BackfillCreateParams = BackfillsAPI.BackfillCreateParams;
-  export import BackfillListParams = BackfillsAPI.BackfillListParams;
+Backfills.BackfillListResponsesPage = BackfillListResponsesPage;
+
+export declare namespace Backfills {
+  export {
+    type BackfillCreateResponse as BackfillCreateResponse,
+    type BackfillListResponse as BackfillListResponse,
+    type BackfillCloseResponse as BackfillCloseResponse,
+    type BackfillFetchResponse as BackfillFetchResponse,
+    type BackfillRevertResponse as BackfillRevertResponse,
+    BackfillListResponsesPage as BackfillListResponsesPage,
+    type BackfillCreateParams as BackfillCreateParams,
+    type BackfillListParams as BackfillListParams,
+  };
 }

package/src/resources/events/events.ts

@@ -2,9 +2,20 @@
 
 import { APIResource } from '../../resource';
 import * as Core from '../../core';
-import * as EventsAPI from './events';
 import * as BackfillsAPI from './backfills';
+import {
+  BackfillCloseResponse,
+  BackfillCreateParams,
+  BackfillCreateResponse,
+  BackfillFetchResponse,
+  BackfillListParams,
+  BackfillListResponse,
+  BackfillListResponsesPage,
+  BackfillRevertResponse,
+  Backfills,
+} from './backfills';
 import * as VolumeAPI from './volume';
+import { EventVolumes, Volume, VolumeListParams } from './volume';
 
 export class Events extends APIResource {
   backfills: BackfillsAPI.Backfills = new BackfillsAPI.Backfills(this._client);
@@ -81,8 +92,8 @@ export class Events extends APIResource {
    *   call to a payment gateway failed and the user should not be billed)
    *
    * If you want to only change specific properties of an event, but keep the event
-   * as part of the billing calculation, use the [Amend single event](amend-event)
-   * endpoint instead.
+   * as part of the billing calculation, use the [Amend event](amend-event) endpoint
+   * instead.
    *
    * This API is always audit-safe. The process will still retain the deprecated
    * event, though it will be ignored for billing calculations. For auditing and data
@@ -562,24 +573,32 @@ export interface EventSearchParams {
   timeframe_start?: string | null;
 }
 
-export namespace Events {
-  export import EventUpdateResponse = EventsAPI.EventUpdateResponse;
-  export import EventDeprecateResponse = EventsAPI.EventDeprecateResponse;
-  export import EventIngestResponse = EventsAPI.EventIngestResponse;
-  export import EventSearchResponse = EventsAPI.EventSearchResponse;
-  export import EventUpdateParams = EventsAPI.EventUpdateParams;
-  export import EventIngestParams = EventsAPI.EventIngestParams;
-  export import EventSearchParams = EventsAPI.EventSearchParams;
-  export import Backfills = BackfillsAPI.Backfills;
-  export import BackfillCreateResponse = BackfillsAPI.BackfillCreateResponse;
-  export import BackfillListResponse = BackfillsAPI.BackfillListResponse;
-  export import BackfillCloseResponse = BackfillsAPI.BackfillCloseResponse;
-  export import BackfillFetchResponse = BackfillsAPI.BackfillFetchResponse;
-  export import BackfillRevertResponse = BackfillsAPI.BackfillRevertResponse;
-  export import BackfillListResponsesPage = BackfillsAPI.BackfillListResponsesPage;
-  export import BackfillCreateParams = BackfillsAPI.BackfillCreateParams;
-  export import BackfillListParams = BackfillsAPI.BackfillListParams;
-  export import Volume = VolumeAPI.Volume;
-  export import EventVolumes = VolumeAPI.EventVolumes;
-  export import VolumeListParams = VolumeAPI.VolumeListParams;
+Events.Backfills = Backfills;
+Events.BackfillListResponsesPage = BackfillListResponsesPage;
+Events.Volume = Volume;
+
+export declare namespace Events {
+  export {
+    type EventUpdateResponse as EventUpdateResponse,
+    type EventDeprecateResponse as EventDeprecateResponse,
+    type EventIngestResponse as EventIngestResponse,
+    type EventSearchResponse as EventSearchResponse,
+    type EventUpdateParams as EventUpdateParams,
+    type EventIngestParams as EventIngestParams,
+    type EventSearchParams as EventSearchParams,
+  };
+
+  export {
+    Backfills as Backfills,
+    type BackfillCreateResponse as BackfillCreateResponse,
+    type BackfillListResponse as BackfillListResponse,
+    type BackfillCloseResponse as BackfillCloseResponse,
+    type BackfillFetchResponse as BackfillFetchResponse,
+    type BackfillRevertResponse as BackfillRevertResponse,
+    BackfillListResponsesPage as BackfillListResponsesPage,
+    type BackfillCreateParams as BackfillCreateParams,
+    type BackfillListParams as BackfillListParams,
+  };
+
+  export { Volume as Volume, type EventVolumes as EventVolumes, type VolumeListParams as VolumeListParams };
 }

package/src/resources/events/index.ts

@@ -1,24 +1,24 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export {
-  BackfillCreateResponse,
-  BackfillListResponse,
-  BackfillCloseResponse,
-  BackfillFetchResponse,
-  BackfillRevertResponse,
-  BackfillCreateParams,
-  BackfillListParams,
   BackfillListResponsesPage,
   Backfills,
+  type BackfillCreateResponse,
+  type BackfillListResponse,
+  type BackfillCloseResponse,
+  type BackfillFetchResponse,
+  type BackfillRevertResponse,
+  type BackfillCreateParams,
+  type BackfillListParams,
 } from './backfills';
 export {
-  EventUpdateResponse,
-  EventDeprecateResponse,
-  EventIngestResponse,
-  EventSearchResponse,
-  EventUpdateParams,
-  EventIngestParams,
-  EventSearchParams,
   Events,
+  type EventUpdateResponse,
+  type EventDeprecateResponse,
+  type EventIngestResponse,
+  type EventSearchResponse,
+  type EventUpdateParams,
+  type EventIngestParams,
+  type EventSearchParams,
 } from './events';
-export { EventVolumes, VolumeListParams, Volume } from './volume';
+export { Volume, type EventVolumes, type VolumeListParams } from './volume';

package/src/resources/events/volume.ts

@@ -2,7 +2,6 @@
 
 import { APIResource } from '../../resource';
 import * as Core from '../../core';
-import * as VolumeAPI from './volume';
 
 export class Volume extends APIResource {
   /**
@@ -75,7 +74,6 @@ export interface VolumeListParams {
   timeframe_end?: string;
 }
 
-export namespace Volume {
-  export import EventVolumes = VolumeAPI.EventVolumes;
-  export import VolumeListParams = VolumeAPI.VolumeListParams;
+export declare namespace Volume {
+  export { type EventVolumes as EventVolumes, type VolumeListParams as VolumeListParams };
 }