@metronome/sdk 0.1.0-beta.9 → 0.1.0

package/src/resources/v1/alerts.ts

@@ -1,12 +1,24 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
-import * as Shared from '../shared';
+import { APIResource } from "../../resource.js";
+import * as Core from "../../core.js";
+import * as Shared from "../shared.js";
 
 export class Alerts extends APIResource {
   /**
    * Create a new alert
+   *
+   * @example
+   * ```ts
+   * const alert = await client.v1.alerts.create({
+   *   alert_type: 'spend_threshold_reached',
+   *   name: '$100 spend threshold reached',
+   *   threshold: 10000,
+   *   credit_grant_type_filters: ['enterprise'],
+   *   credit_type_id: '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+   *   customer_id: '4db51251-61de-4bfe-b9ce-495e244f3491',
+   * });
+   * ```
    */
   create(body: AlertCreateParams, options?: Core.RequestOptions): Core.APIPromise<AlertCreateResponse> {
     return this._client.post('/v1/alerts/create', { body, ...options });
@@ -14,6 +26,13 @@ export class Alerts extends APIResource {
 
   /**
    * Archive an existing alert
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.alerts.archive({
+   *   id: '8deed800-1b7a-495d-a207-6c52bac54dc9',
+   * });
+   * ```
    */
   archive(body: AlertArchiveParams, options?: Core.RequestOptions): Core.APIPromise<AlertArchiveResponse> {
     return this._client.post('/v1/alerts/archive', { body, ...options });
@@ -72,6 +91,11 @@ export interface AlertCreateParams {
    */
   credit_grant_type_filters?: Array<string>;
 
+  /**
+   * ID of the credit's currency, defaults to USD. If the specific alert type
+   * requires a pricing unit/currency, find the ID in the
+   * [Metronome app](https://app.metronome.com/offering/pricing-units).
+   */
   credit_type_id?: string;
 
   /**
@@ -82,7 +106,7 @@ export interface AlertCreateParams {
 
   /**
    * If provided, will create this alert for this specific customer. To create an
-   * alert for all customers, do not specify `customer_id` or `plan_id`.
+   * alert for all customers, do not specify a `customer_id`.
    */
   customer_id?: string;
 
@@ -107,7 +131,7 @@ export interface AlertCreateParams {
 
   /**
    * If provided, will create this alert for this specific plan. To create an alert
-   * for all customers, do not specify `customer_id` or `plan_id`.
+   * for all customers, do not specify a `plan_id`.
    */
   plan_id?: string;
 

package/src/resources/v1/audit-logs.ts

@@ -1,9 +1,9 @@
 // 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 AuditLogs extends APIResource {
   /**
@@ -11,6 +11,14 @@ export class AuditLogs extends APIResource {
    * available, the data array will be empty. As new audit logs are created,
    * subsequent requests using the same next_page value will be in the returned data
    * array, ensuring a continuous and uninterrupted reading of audit logs.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const auditLogListResponse of client.v1.auditLogs.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: AuditLogListParams,

package/src/resources/v1/billable-metrics.ts

@@ -1,14 +1,39 @@
 // 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 { 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 { CursorPage, type CursorPageParams } from "../../pagination.js";
 
 export class BillableMetrics extends APIResource {
   /**
    * Creates a new Billable Metric.
+   *
+   * @example
+   * ```ts
+   * const billableMetric =
+   *   await client.v1.billableMetrics.create({
+   *     name: 'CPU Hours',
+   *     aggregation_key: 'cpu_hours',
+   *     aggregation_type: 'SUM',
+   *     event_type_filter: { in_values: ['cpu_usage'] },
+   *     group_keys: [['region'], ['machine_type']],
+   *     property_filters: [
+   *       { name: 'cpu_hours', exists: true },
+   *       {
+   *         name: 'region',
+   *         exists: true,
+   *         in_values: ['EU', 'NA'],
+   *       },
+   *       {
+   *         name: 'machine_type',
+   *         exists: true,
+   *         in_values: ['slow', 'fast'],
+   *       },
+   *     ],
+   *   });
+   * ```
    */
   create(
     body: BillableMetricCreateParams,
@@ -19,6 +44,15 @@ export class BillableMetrics extends APIResource {
 
   /**
    * Get a billable metric.
+   *
+   * @example
+   * ```ts
+   * const billableMetric =
+   *   await client.v1.billableMetrics.retrieve({
+   *     billable_metric_id:
+   *       '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *   });
+   * ```
    */
   retrieve(
     params: BillableMetricRetrieveParams,
@@ -30,6 +64,14 @@ export class BillableMetrics extends APIResource {
 
   /**
    * List all billable metrics.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const billableMetricListResponse of client.v1.billableMetrics.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: BillableMetricListParams,
@@ -53,6 +95,13 @@ export class BillableMetrics extends APIResource {
 
   /**
    * Archive an existing billable metric.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.billableMetrics.archive({
+   *   id: '8deed800-1b7a-495d-a207-6c52bac54dc9',
+   * });
+   * ```
    */
   archive(
     body: BillableMetricArchiveParams,
@@ -102,7 +151,7 @@ export namespace BillableMetricRetrieveResponse {
      */
     archived_at?: string;
 
-    custom_fields?: Record<string, string>;
+    custom_fields?: { [key: string]: string };
 
     /**
      * An optional filtering rule to match the 'event_type' property of an event.
@@ -158,7 +207,7 @@ export interface BillableMetricListResponse {
    */
   archived_at?: string;
 
-  custom_fields?: Record<string, string>;
+  custom_fields?: { [key: string]: string };
 
   /**
    * An optional filtering rule to match the 'event_type' property of an event.
@@ -208,7 +257,7 @@ export interface BillableMetricCreateParams {
   /**
    * Custom fields to attach to the billable metric.
    */
-  custom_fields?: Record<string, string>;
+  custom_fields?: { [key: string]: string };
 
   /**
    * An optional filtering rule to match the 'event_type' property of an event.