@metronome/sdk 0.1.0-beta.8 → 0.1.0

package/src/resources/{dashboards.ts → v1/dashboards.ts}

@@ -1,19 +1,45 @@
 // 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 "../../resource.js";
+import * as Core from "../../core.js";
 
 export class Dashboards extends APIResource {
   /**
    * Retrieve an embeddable dashboard url for a customer. The dashboard can be
    * embedded using an iframe in a website. This will show information such as usage
    * data and customer invoices.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.dashboards.getEmbeddableURL({
+   *     customer_id: '4db51251-61de-4bfe-b9ce-495e244f3491',
+   *     dashboard: 'invoices',
+   *     bm_group_key_overrides: [
+   *       {
+   *         group_key_name: 'tenant_id',
+   *         display_name: 'Org ID',
+   *         value_display_names: {
+   *           '48ecb18f358f': 'Cluster EU',
+   *           e358f3ce242d: 'Cluster APAC',
+   *         },
+   *       },
+   *     ],
+   *     color_overrides: [
+   *       { name: 'Gray_dark', value: '#ff0000' },
+   *     ],
+   *     dashboard_options: [
+   *       { key: 'show_zero_usage_line_items', value: 'false' },
+   *       { key: 'hide_voided_invoices', value: 'true' },
+   *     ],
+   *   });
+   * ```
    */
   getEmbeddableURL(
     body: DashboardGetEmbeddableURLParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<DashboardGetEmbeddableURLResponse> {
-    return this._client.post('/dashboards/getEmbeddableUrl', { body, ...options });
+    return this._client.post('/v1/dashboards/getEmbeddableUrl', { body, ...options });
   }
 }
 
@@ -33,7 +59,7 @@ export interface DashboardGetEmbeddableURLParams {
   /**
    * The type of dashboard to retrieve.
    */
-  dashboard: 'invoices' | 'usage' | 'credits';
+  dashboard: 'invoices' | 'usage' | 'credits' | 'commits_and_credits';
 
   /**
    * Optional list of billable metric group key overrides
@@ -67,7 +93,7 @@ export namespace DashboardGetEmbeddableURLParams {
      * <key, value> pairs of the billable metric group key values and their display
      * names. e.g. {"a": "Asia", "b": "Euro"}
      */
-    value_display_names?: Record<string, unknown>;
+    value_display_names?: { [key: string]: unknown };
   }
 
   export interface ColorOverride {

package/src/resources/v1/index.ts

@@ -0,0 +1,151 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Alerts,
+  type AlertCreateResponse,
+  type AlertArchiveResponse,
+  type AlertCreateParams,
+  type AlertArchiveParams,
+} from "./alerts.js";
+export {
+  AuditLogListResponsesCursorPage,
+  AuditLogs,
+  type AuditLogListResponse,
+  type AuditLogListParams,
+} from "./audit-logs.js";
+export {
+  BillableMetricListResponsesCursorPage,
+  BillableMetrics,
+  type BillableMetricCreateResponse,
+  type BillableMetricRetrieveResponse,
+  type BillableMetricListResponse,
+  type BillableMetricArchiveResponse,
+  type BillableMetricCreateParams,
+  type BillableMetricRetrieveParams,
+  type BillableMetricListParams,
+  type BillableMetricArchiveParams,
+} from "./billable-metrics.js";
+export {
+  Contracts,
+  type ContractCreateResponse,
+  type ContractRetrieveResponse,
+  type ContractListResponse,
+  type ContractAmendResponse,
+  type ContractArchiveResponse,
+  type ContractCreateHistoricalInvoicesResponse,
+  type ContractListBalancesResponse,
+  type ContractRetrieveRateScheduleResponse,
+  type ContractRetrieveSubscriptionQuantityHistoryResponse,
+  type ContractScheduleProServicesInvoiceResponse,
+  type ContractUpdateEndDateResponse,
+  type ContractCreateParams,
+  type ContractRetrieveParams,
+  type ContractListParams,
+  type ContractAddManualBalanceEntryParams,
+  type ContractAmendParams,
+  type ContractArchiveParams,
+  type ContractCreateHistoricalInvoicesParams,
+  type ContractListBalancesParams,
+  type ContractRetrieveRateScheduleParams,
+  type ContractRetrieveSubscriptionQuantityHistoryParams,
+  type ContractScheduleProServicesInvoiceParams,
+  type ContractSetUsageFilterParams,
+  type ContractUpdateEndDateParams,
+} from "./contracts/index.js";
+export {
+  CreditGrantListResponsesCursorPage,
+  CreditGrants,
+  type CreditLedgerEntry,
+  type RolloverAmountMaxAmount,
+  type RolloverAmountMaxPercentage,
+  type CreditGrantCreateResponse,
+  type CreditGrantListResponse,
+  type CreditGrantEditResponse,
+  type CreditGrantListEntriesResponse,
+  type CreditGrantVoidResponse,
+  type CreditGrantCreateParams,
+  type CreditGrantListParams,
+  type CreditGrantEditParams,
+  type CreditGrantListEntriesParams,
+  type CreditGrantVoidParams,
+} from "./credit-grants.js";
+export {
+  CustomFields,
+  type CustomFieldListKeysResponse,
+  type CustomFieldAddKeyParams,
+  type CustomFieldDeleteValuesParams,
+  type CustomFieldListKeysParams,
+  type CustomFieldRemoveKeyParams,
+  type CustomFieldSetValuesParams,
+} from "./custom-fields.js";
+export {
+  CustomerDetailsCursorPage,
+  CustomerListBillableMetricsResponsesCursorPage,
+  CustomerListCostsResponsesCursorPage,
+  Customers,
+  type Customer,
+  type CustomerDetail,
+  type CustomerCreateResponse,
+  type CustomerRetrieveResponse,
+  type CustomerArchiveResponse,
+  type CustomerListBillableMetricsResponse,
+  type CustomerListCostsResponse,
+  type CustomerPreviewEventsResponse,
+  type CustomerSetNameResponse,
+  type CustomerCreateParams,
+  type CustomerRetrieveParams,
+  type CustomerListParams,
+  type CustomerArchiveParams,
+  type CustomerListBillableMetricsParams,
+  type CustomerListCostsParams,
+  type CustomerPreviewEventsParams,
+  type CustomerSetIngestAliasesParams,
+  type CustomerSetNameParams,
+  type CustomerUpdateConfigParams,
+} from "./customers/index.js";
+export {
+  Dashboards,
+  type DashboardGetEmbeddableURLResponse,
+  type DashboardGetEmbeddableURLParams,
+} from "./dashboards.js";
+export {
+  Invoices,
+  type InvoiceRegenerateResponse,
+  type InvoiceVoidResponse,
+  type InvoiceRegenerateParams,
+  type InvoiceVoidParams,
+} from "./invoices.js";
+export {
+  PlanListResponsesCursorPage,
+  PlanListChargesResponsesCursorPage,
+  PlanListCustomersResponsesCursorPage,
+  Plans,
+  type PlanDetail,
+  type PlanListResponse,
+  type PlanGetDetailsResponse,
+  type PlanListChargesResponse,
+  type PlanListCustomersResponse,
+  type PlanListParams,
+  type PlanGetDetailsParams,
+  type PlanListChargesParams,
+  type PlanListCustomersParams,
+} from "./plans.js";
+export {
+  PricingUnitListResponsesCursorPage,
+  PricingUnits,
+  type PricingUnitListResponse,
+  type PricingUnitListParams,
+} from "./pricing-units.js";
+export { Services, type ServiceListResponse } from "./services.js";
+export {
+  UsageListWithGroupsResponsesCursorPage,
+  Usage,
+  type UsageListResponse,
+  type UsageListWithGroupsResponse,
+  type UsageSearchResponse,
+  type UsageListParams,
+  type UsageIngestParams,
+  type UsageListWithGroupsParams,
+  type UsageSearchParams,
+} from "./usage.js";
+export { V1 } from "./v1.js";

package/src/resources/{invoices.ts → v1/invoices.ts}

@@ -1,24 +1,38 @@
 // 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 "../../resource.js";
+import * as Core from "../../core.js";
 
 export class Invoices extends APIResource {
   /**
    * Regenerate a voided contract invoice
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.invoices.regenerate({
+   *   id: '6a37bb88-8538-48c5-b37b-a41c836328bd',
+   * });
+   * ```
    */
   regenerate(
     body: InvoiceRegenerateParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<InvoiceRegenerateResponse> {
-    return this._client.post('/invoices/regenerate', { body, ...options });
+    return this._client.post('/v1/invoices/regenerate', { body, ...options });
   }
 
   /**
    * Void an invoice
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.invoices.void({
+   *   id: '6a37bb88-8538-48c5-b37b-a41c836328bd',
+   * });
+   * ```
    */
   void(body: InvoiceVoidParams, options?: Core.RequestOptions): Core.APIPromise<InvoiceVoidResponse> {
-    return this._client.post('/invoices/void', { body, ...options });
+    return this._client.post('/v1/invoices/void', { body, ...options });
   }
 }
 

package/src/resources/{plans.ts → v1/plans.ts}

@@ -1,15 +1,23 @@
 // 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 CustomersAPI from './customers/customers';
-import { CursorPage, type CursorPageParams } from '../pagination';
+import { APIResource } from "../../resource.js";
+import { isRequestOptions } from "../../core.js";
+import * as Core from "../../core.js";
+import * as Shared from "../shared.js";
+import * as CustomersAPI from "./customers/customers.js";
+import { CursorPage, type CursorPageParams } from "../../pagination.js";
 
 export class Plans extends APIResource {
   /**
    * List all available plans.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const planListResponse of client.v1.plans.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: PlanListParams,
@@ -23,29 +31,46 @@ export class Plans extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-    return this._client.getAPIList('/plans', PlanListResponsesCursorPage, { query, ...options });
+    return this._client.getAPIList('/v1/plans', PlanListResponsesCursorPage, { query, ...options });
   }
 
   /**
    * Fetch high level details of a specific plan.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.plans.getDetails({
+   *   plan_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   * });
+   * ```
    */
   getDetails(
     params: PlanGetDetailsParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<PlanGetDetailsResponse> {
     const { plan_id } = params;
-    return this._client.get(`/planDetails/${plan_id}`, options);
+    return this._client.get(`/v1/planDetails/${plan_id}`, options);
   }
 
   /**
    * Fetches a list of charges of a specific plan.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const planListChargesResponse of client.v1.plans.listCharges(
+   *   { plan_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   listCharges(
     params: PlanListChargesParams,
     options?: Core.RequestOptions,
   ): Core.PagePromise<PlanListChargesResponsesCursorPage, PlanListChargesResponse> {
     const { plan_id, ...query } = params;
-    return this._client.getAPIList(`/planDetails/${plan_id}/charges`, PlanListChargesResponsesCursorPage, {
+    return this._client.getAPIList(`/v1/planDetails/${plan_id}/charges`, PlanListChargesResponsesCursorPage, {
       query,
       ...options,
     });
@@ -54,6 +79,16 @@ export class Plans extends APIResource {
   /**
    * Fetches a list of customers on a specific plan (by default, only currently
    * active plans are included)
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const planListCustomersResponse of client.v1.plans.listCustomers(
+   *   { plan_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   listCustomers(
     params: PlanListCustomersParams,
@@ -61,7 +96,7 @@ export class Plans extends APIResource {
   ): Core.PagePromise<PlanListCustomersResponsesCursorPage, PlanListCustomersResponse> {
     const { plan_id, ...query } = params;
     return this._client.getAPIList(
-      `/planDetails/${plan_id}/customers`,
+      `/v1/planDetails/${plan_id}/customers`,
       PlanListCustomersResponsesCursorPage,
       { query, ...options },
     );
@@ -77,7 +112,7 @@ export class PlanListCustomersResponsesCursorPage extends CursorPage<PlanListCus
 export interface PlanDetail {
   id: string;
 
-  custom_fields: Record<string, string>;
+  custom_fields: { [key: string]: string };
 
   name: string;
 
@@ -151,7 +186,7 @@ export interface PlanListResponse {
 
   name: string;
 
-  custom_fields?: Record<string, string>;
+  custom_fields?: { [key: string]: string };
 }
 
 export interface PlanGetDetailsResponse {
@@ -165,7 +200,7 @@ export interface PlanListChargesResponse {
 
   credit_type: Shared.CreditTypeData;
 
-  custom_fields: Record<string, string>;
+  custom_fields: { [key: string]: string };
 
   name: string;
 
@@ -238,7 +273,7 @@ export namespace PlanListCustomersResponse {
   export interface PlanDetails {
     id: string;
 
-    custom_fields: Record<string, string>;
+    custom_fields: { [key: string]: string };
 
     customer_plan_id: string;
 

package/src/resources/{pricing-units.ts → v1/pricing-units.ts}

@@ -1,13 +1,21 @@
 // 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 { CursorPage, type CursorPageParams } from '../pagination';
+import { APIResource } from "../../resource.js";
+import { isRequestOptions } from "../../core.js";
+import * as Core from "../../core.js";
+import { CursorPage, type CursorPageParams } from "../../pagination.js";
 
 export class PricingUnits extends APIResource {
   /**
    * List all pricing units (known in the API by the legacy term "credit types").
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const pricingUnitListResponse of client.v1.pricingUnits.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: PricingUnitListParams,
@@ -23,7 +31,7 @@ export class PricingUnits extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-    return this._client.getAPIList('/credit-types/list', PricingUnitListResponsesCursorPage, {
+    return this._client.getAPIList('/v1/credit-types/list', PricingUnitListResponsesCursorPage, {
       query,
       ...options,
     });

package/src/resources/{services.ts → v1/services.ts}

@@ -1,7 +1,7 @@
 // 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 "../../resource.js";
+import * as Core from "../../core.js";
 
 export class Services extends APIResource {
   /**
@@ -9,9 +9,14 @@ export class Services extends APIResource {
    * addresses are not necessarily unique between services. In most cases, IP
    * addresses will appear in the list at least 30 days before they are used for the
    * first time.
+   *
+   * @example
+   * ```ts
+   * const services = await client.v1.services.list();
+   * ```
    */
   list(options?: Core.RequestOptions): Core.APIPromise<ServiceListResponse> {
-    return this._client.get('/services', options);
+    return this._client.get('/v1/services', options);
   }
 }