@metronome/sdk 0.3.0 → 2.0.0

package/resources/v1/billable-metrics.mjs

@@ -1,10 +1,38 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { APIResource } from "../../resource.mjs";
-import { isRequestOptions } from "../../core.mjs";
-import { CursorPage } from "../../pagination.mjs";
+import { APIResource } from "../../core/resource.mjs";
+import { CursorPage } from "../../core/pagination.mjs";
+import { path } from "../../internal/utils/path.mjs";
 export class BillableMetrics extends APIResource {
     /**
-     * Creates a new Billable Metric.
+     * Create billable metrics programmatically with this endpoint—an essential step in
+     * configuring your pricing and packaging in Metronome.
+     *
+     * A billable metric is a customizable query that filters and aggregates events
+     * from your event stream. These metrics are continuously tracked as usage data
+     * enters Metronome through the ingestion pipeline. The ingestion process
+     * transforms raw usage data into actionable pricing metrics, enabling accurate
+     * metering and billing for your products.
+     *
+     * ### Use this endpoint to:
+     *
+     * - Create individual or multiple billable metrics as part of a setup workflow.
+     * - Automate the entire pricing configuration process, from metric creation to
+     *   customer contract setup.
+     * - Define metrics using either standard filtering/aggregation or a custom SQL
+     *   query.
+     *
+     * ### Key response fields:
+     *
+     * - The ID of the billable metric that was created
+     * - The created billable metric will be available to be used in Products, usage
+     *   endpoints, and alerts.
+     *
+     * ### Usage guidelines:
+     *
+     * - Metrics defined using standard filtering and aggregation are Streaming
+     *   billable metrics, which have been optimized for ultra low latency and high
+     *   throughput workflows.
+     * - Use SQL billable metrics if you require more flexible aggregation options.
      *
      * @example
      * ```ts
@@ -35,7 +63,17 @@ export class BillableMetrics extends APIResource {
         return this._client.post('/v1/billable-metrics/create', { body, ...options });
     }
     /**
-     * Get a billable metric.
+     * Retrieves the complete configuration for a specific billable metric by its ID.
+     * Use this to review billable metric setup before associating it with products.
+     * Returns the metric's `name`, `event_type_filter`, `property_filters`,
+     * `aggregation_type`, `aggregation_key`, `group_keys`, `custom fields`, and
+     * `SQL query` (if it's a SQL billable metric).
+     *
+     * Important:
+     *
+     * - Archived billable metrics will include an `archived_at` timestamp; they no
+     *   longer process new usage events but remain accessible for historical
+     *   reference.
      *
      * @example
      * ```ts
@@ -48,19 +86,39 @@ export class BillableMetrics extends APIResource {
      */
     retrieve(params, options) {
         const { billable_metric_id } = params;
-        return this._client.get(`/v1/billable-metrics/${billable_metric_id}`, options);
+        return this._client.get(path `/v1/billable-metrics/${billable_metric_id}`, options);
     }
+    /**
+     * Retrieves all billable metrics with their complete configurations. Use this for
+     * programmatic discovery and management of billable metrics, such as associating
+     * metrics to products and auditing for orphaned or archived metrics. Important:
+     * Archived metrics are excluded by default; use `include_archived`=`true`
+     * parameter to include them.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const billableMetricListResponse of client.v1.billableMetrics.list()) {
+     *   // ...
+     * }
+     * ```
+     */
     list(query = {}, options) {
-        if (isRequestOptions(query)) {
-            return this.list({}, query);
-        }
-        return this._client.getAPIList('/v1/billable-metrics', BillableMetricListResponsesCursorPage, {
+        return this._client.getAPIList('/v1/billable-metrics', (CursorPage), {
             query,
             ...options,
         });
     }
     /**
-     * Archive an existing billable metric.
+     * Use this endpoint to retire billable metrics that are no longer used. After a
+     * billable metric is archived, that billable metric can no longer be used in any
+     * new Products to define how that product should be metered. If you archive a
+     * billable metric that is already associated with a Product, the Product will
+     * continue to function as usual, metering based on the definition of the archived
+     * billable metric.
+     *
+     * Archived billable metrics will be returned on the `getBillableMetric` and
+     * `listBillableMetrics` endpoints with a populated `archived_at` field.
      *
      * @example
      * ```ts
@@ -73,7 +131,4 @@ export class BillableMetrics extends APIResource {
         return this._client.post('/v1/billable-metrics/archive', { body, ...options });
     }
 }
-export class BillableMetricListResponsesCursorPage extends CursorPage {
-}
-BillableMetrics.BillableMetricListResponsesCursorPage = BillableMetricListResponsesCursorPage;
 //# sourceMappingURL=billable-metrics.mjs.map

package/resources/v1/billable-metrics.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"billable-metrics.mjs","sourceRoot":"","sources":["../../src/resources/v1/billable-metrics.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAGpB,EAAE,UAAU,EAAyB;AAE5C,MAAM,OAAO,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CACJ,IAAgC,EAChC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,MAAoC,EACpC,OAA6B;QAE7B,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,kBAAkB,EAAE,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAoBD,IAAI,CACF,QAAwD,EAAE,EAC1D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,sBAAsB,EAAE,qCAAqC,EAAE;YAC5F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CACL,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,8BAA8B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;CACF;AAED,MAAM,OAAO,qCAAsC,SAAQ,UAAsC;CAAG;AA8LpG,eAAe,CAAC,qCAAqC,GAAG,qCAAqC,CAAC"}
+{"version":3,"file":"billable-metrics.mjs","sourceRoot":"","sources":["../../src/resources/v1/billable-metrics.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,MAAM,CACJ,IAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,QAAQ,CACN,MAAoC,EACpC,OAAwB;QAExB,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,wBAAwB,kBAAkB,EAAE,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,sBAAsB,EAAE,CAAA,UAAsC,CAAA,EAAE;YAC7F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CACL,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,8BAA8B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;CACF"}