@metronome/sdk 0.1.0-alpha.0

package/resources/alerts.d.ts

@@ -0,0 +1,103 @@
+import * as Core from '@metronome/sdk/core';
+import { APIResource } from '@metronome/sdk/resource';
+import * as AlertsAPI from '@metronome/sdk/resources/alerts';
+import * as Shared from '@metronome/sdk/resources/shared';
+export declare class Alerts extends APIResource {
+    /**
+     * Create a new alert
+     */
+    create(body: AlertCreateParams, options?: Core.RequestOptions): Core.APIPromise<AlertCreateResponse>;
+    /**
+     * Archive an existing alert
+     */
+    archive(body: AlertArchiveParams, options?: Core.RequestOptions): Core.APIPromise<AlertArchiveResponse>;
+}
+export interface AlertCreateResponse {
+    data: Shared.ID;
+}
+export interface AlertArchiveResponse {
+    data: Shared.ID;
+}
+export interface AlertCreateParams {
+    /**
+     * Type of the alert
+     */
+    alert_type: 'low_credit_balance_reached' | 'spend_threshold_reached' | 'monthly_invoice_total_spend_threshold_reached' | 'low_remaining_days_in_plan_reached' | 'low_remaining_credit_percentage_reached' | 'usage_threshold_reached' | 'low_remaining_days_for_commit_segment_reached' | 'low_remaining_commit_balance_reached' | 'low_remaining_commit_percentage_reached' | 'low_remaining_days_for_contract_credit_segment_reached' | 'low_remaining_contract_credit_balance_reached' | 'low_remaining_contract_credit_percentage_reached' | 'invoice_total_reached';
+    /**
+     * Name of the alert
+     */
+    name: string;
+    /**
+     * Threshold value of the alert policy
+     */
+    threshold: number;
+    /**
+     * For alerts of type `usage_threshold_reached`, specifies which billable metric to
+     * track the usage for.
+     */
+    billable_metric_id?: string;
+    credit_type_id?: string;
+    /**
+     * Only present for beta contract invoices. This field's availability is dependent
+     * on your client's configuration. A list of custom field filters for alert types
+     * that support advanced filtering
+     */
+    custom_field_filters?: Array<AlertCreateParams.CustomFieldFilter>;
+    /**
+     * 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`.
+     */
+    customer_id?: string;
+    /**
+     * If true, the alert will evaluate immediately on customers that already meet the
+     * alert threshold. If false, it will only evaluate on future customers that
+     * trigger the alert threshold. Defaults to true.
+     */
+    evaluate_on_create?: boolean;
+    /**
+     * Scopes alert evaluation to a specific presentation group key on individual line
+     * items. Only present for spend alerts.
+     */
+    group_key_filter?: AlertCreateParams.GroupKeyFilter;
+    /**
+     * Only supported for invoice_total_reached alerts. A list of invoice types to
+     * evaluate.
+     */
+    invoice_types_filter?: Array<string>;
+    /**
+     * 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`.
+     */
+    plan_id?: string;
+    /**
+     * Prevents the creation of duplicates. If a request to create a record is made
+     * with a previously used uniqueness key, a new record will not be created and the
+     * request will fail with a 409 error.
+     */
+    uniqueness_key?: string;
+}
+export declare namespace AlertCreateParams {
+    interface CustomFieldFilter {
+        entity: 'Contract' | 'Commit' | 'ContractCredit';
+        key: string;
+        value: string;
+    }
+    /**
+     * Scopes alert evaluation to a specific presentation group key on individual line
+     * items. Only present for spend alerts.
+     */
+    interface GroupKeyFilter {
+        key: string;
+        value: string;
+    }
+}
+export interface AlertArchiveParams {
+    id: string;
+}
+export declare namespace Alerts {
+    export import AlertCreateResponse = AlertsAPI.AlertCreateResponse;
+    export import AlertArchiveResponse = AlertsAPI.AlertArchiveResponse;
+    export import AlertCreateParams = AlertsAPI.AlertCreateParams;
+    export import AlertArchiveParams = AlertsAPI.AlertArchiveParams;
+}
+//# sourceMappingURL=alerts.d.ts.map

package/resources/alerts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"alerts.d.ts","sourceRoot":"","sources":["../src/resources/alerts.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,qBAAqB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,KAAK,SAAS,MAAM,iCAAiC,CAAC;AAC7D,OAAO,KAAK,MAAM,MAAM,iCAAiC,CAAC;AAE1D,qBAAa,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAIpG;;OAEG;IACH,OAAO,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;CAGxG;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,UAAU,EACN,4BAA4B,GAC5B,yBAAyB,GACzB,+CAA+C,GAC/C,oCAAoC,GACpC,yCAAyC,GACzC,yBAAyB,GACzB,+CAA+C,GAC/C,sCAAsC,GACtC,yCAAyC,GACzC,wDAAwD,GACxD,+CAA+C,GAC/C,kDAAkD,GAClD,uBAAuB,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;IAElE;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,iBAAiB,CAAC,cAAc,CAAC;IAEpD;;;OAGG;IACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAErC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,iBAAiB;QAChC,MAAM,EAAE,UAAU,GAAG,QAAQ,GAAG,gBAAgB,CAAC;QAEjD,GAAG,EAAE,MAAM,CAAC;QAEZ,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;;OAGG;IACH,UAAiB,cAAc;QAC7B,GAAG,EAAE,MAAM,CAAC;QAEZ,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,yBAAiB,MAAM,CAAC;IACtB,MAAM,QAAQ,mBAAmB,GAAG,SAAS,CAAC,mBAAmB,CAAC;IAClE,MAAM,QAAQ,oBAAoB,GAAG,SAAS,CAAC,oBAAoB,CAAC;IACpE,MAAM,QAAQ,iBAAiB,GAAG,SAAS,CAAC,iBAAiB,CAAC;IAC9D,MAAM,QAAQ,kBAAkB,GAAG,SAAS,CAAC,kBAAkB,CAAC;CACjE"}

package/resources/alerts.js

@@ -0,0 +1,23 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Alerts = void 0;
+const resource_1 = require("@metronome/sdk/resource");
+class Alerts extends resource_1.APIResource {
+    /**
+     * Create a new alert
+     */
+    create(body, options) {
+        return this._client.post('/alerts/create', { body, ...options });
+    }
+    /**
+     * Archive an existing alert
+     */
+    archive(body, options) {
+        return this._client.post('/alerts/archive', { body, ...options });
+    }
+}
+exports.Alerts = Alerts;
+(function (Alerts) {
+})(Alerts = exports.Alerts || (exports.Alerts = {}));
+//# sourceMappingURL=alerts.js.map

package/resources/alerts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"alerts.js","sourceRoot":"","sources":["../src/resources/alerts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAGtF,sDAAsD;AAItD,MAAa,MAAO,SAAQ,sBAAW;IACrC;;OAEG;IACH,MAAM,CAAC,IAAuB,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,IAAwB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;CACF;AAdD,wBAcC;AAqHD,WAAiB,MAAM;AAKvB,CAAC,EALgB,MAAM,GAAN,cAAM,KAAN,cAAM,QAKtB"}

package/resources/alerts.mjs

@@ -0,0 +1,19 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from '@metronome/sdk/resource';
+export class Alerts extends APIResource {
+    /**
+     * Create a new alert
+     */
+    create(body, options) {
+        return this._client.post('/alerts/create', { body, ...options });
+    }
+    /**
+     * Archive an existing alert
+     */
+    archive(body, options) {
+        return this._client.post('/alerts/archive', { body, ...options });
+    }
+}
+(function (Alerts) {
+})(Alerts || (Alerts = {}));
+//# sourceMappingURL=alerts.mjs.map

package/resources/alerts.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"alerts.mjs","sourceRoot":"","sources":["../src/resources/alerts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAG/E,EAAE,WAAW,EAAE,MAAM,yBAAyB;AAIrD,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,MAAM,CAAC,IAAuB,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,IAAwB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;CACF;AAqHD,WAAiB,MAAM;AAKvB,CAAC,EALgB,MAAM,KAAN,MAAM,QAKtB"}

package/resources/audit-logs.d.ts

@@ -0,0 +1,83 @@
+import * as Core from '@metronome/sdk/core';
+import { APIResource } from '@metronome/sdk/resource';
+import * as AuditLogsAPI from '@metronome/sdk/resources/audit-logs';
+export declare class AuditLogs extends APIResource {
+    /**
+     * Retrieves a range of audit logs. If no further audit logs are currently
+     * 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.
+     */
+    list(query?: AuditLogListParams, options?: Core.RequestOptions): Core.APIPromise<AuditLogListResponse>;
+    list(options?: Core.RequestOptions): Core.APIPromise<AuditLogListResponse>;
+}
+export interface AuditLogListResponse {
+    data: Array<AuditLogListResponse.Data>;
+    /**
+     * The next_page parameter is always returned to support ongoing log retrieval. It
+     * enables continuous querying, even when some requests return no new data. Save
+     * the next_page token from each response and use it for future requests to ensure
+     * no logs are missed. This setup is ideal for regular updates via automated
+     * processes, like cron jobs, to fetch logs continuously as they become available.
+     * When you receive an empty data array, it indicates a temporary absence of new
+     * logs, but subsequent requests might return new data.
+     */
+    next_page: string | null;
+}
+export declare namespace AuditLogListResponse {
+    interface Data {
+        id: string;
+        timestamp: string;
+        action?: string;
+        actor?: Data.Actor;
+        description?: string;
+        resource_id?: string;
+        resource_type?: string;
+        status?: 'success' | 'failure' | 'pending';
+    }
+    namespace Data {
+        interface Actor {
+            id: string;
+            name: string;
+            email?: string;
+        }
+    }
+}
+export interface AuditLogListParams {
+    /**
+     * RFC 3339 timestamp (exclusive). Cannot be used with 'next_page'.
+     */
+    ending_before?: string;
+    /**
+     * Max number of results that should be returned
+     */
+    limit?: number;
+    /**
+     * Cursor that indicates where the next page of results should start.
+     */
+    next_page?: string;
+    /**
+     * Optional parameter that can be used to filter which audit logs are returned. If
+     * you specify resource_id, you must also specify resource_type.
+     */
+    resource_id?: string;
+    /**
+     * Optional parameter that can be used to filter which audit logs are returned. If
+     * you specify resource_type, you must also specify resource_id.
+     */
+    resource_type?: string;
+    /**
+     * Sort order by timestamp, e.g. date_asc or date_desc. Defaults to date_asc.
+     */
+    sort?: 'date_asc' | 'date_desc';
+    /**
+     * RFC 3339 timestamp of the earliest audit log to return. Cannot be used with
+     * 'next_page'.
+     */
+    starting_on?: string;
+}
+export declare namespace AuditLogs {
+    export import AuditLogListResponse = AuditLogsAPI.AuditLogListResponse;
+    export import AuditLogListParams = AuditLogsAPI.AuditLogListParams;
+}
+//# sourceMappingURL=audit-logs.d.ts.map

package/resources/audit-logs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"audit-logs.d.ts","sourceRoot":"","sources":["../src/resources/audit-logs.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,qBAAqB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAEtD,OAAO,KAAK,YAAY,MAAM,qCAAqC,CAAC;AAEpE,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;OAKG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;IACtG,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;CAU3E;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IAEvC;;;;;;;;OAQG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,MAAM,CAAC;QAElB,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,KAAK,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC;QAEnB,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;KAC5C;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,KAAK;YACpB,EAAE,EAAE,MAAM,CAAC;YAEX,IAAI,EAAE,MAAM,CAAC;YAEb,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;KACF;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;IAEhC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yBAAiB,SAAS,CAAC;IACzB,MAAM,QAAQ,oBAAoB,GAAG,YAAY,CAAC,oBAAoB,CAAC;IACvE,MAAM,QAAQ,kBAAkB,GAAG,YAAY,CAAC,kBAAkB,CAAC;CACpE"}

package/resources/audit-logs.js

@@ -0,0 +1,18 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditLogs = void 0;
+const resource_1 = require("@metronome/sdk/resource");
+const core_1 = require("@metronome/sdk/core");
+class AuditLogs extends resource_1.APIResource {
+    list(query = {}, options) {
+        if ((0, core_1.isRequestOptions)(query)) {
+            return this.list({}, query);
+        }
+        return this._client.get('/auditLogs', { query, ...options });
+    }
+}
+exports.AuditLogs = AuditLogs;
+(function (AuditLogs) {
+})(AuditLogs = exports.AuditLogs || (exports.AuditLogs = {}));
+//# sourceMappingURL=audit-logs.js.map

package/resources/audit-logs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"audit-logs.js","sourceRoot":"","sources":["../src/resources/audit-logs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAGtF,sDAAsD;AACtD,8CAAuD;AAGvD,MAAa,SAAU,SAAQ,sBAAW;IASxC,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;CACF;AAlBD,8BAkBC;AAuFD,WAAiB,SAAS;AAG1B,CAAC,EAHgB,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGzB"}

package/resources/audit-logs.mjs

@@ -0,0 +1,14 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from '@metronome/sdk/resource';
+import { isRequestOptions } from '@metronome/sdk/core';
+export class AuditLogs extends APIResource {
+    list(query = {}, options) {
+        if (isRequestOptions(query)) {
+            return this.list({}, query);
+        }
+        return this._client.get('/auditLogs', { query, ...options });
+    }
+}
+(function (AuditLogs) {
+})(AuditLogs || (AuditLogs = {}));
+//# sourceMappingURL=audit-logs.mjs.map

package/resources/audit-logs.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"audit-logs.mjs","sourceRoot":"","sources":["../src/resources/audit-logs.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAG/E,EAAE,WAAW,EAAE,MAAM,yBAAyB;OAC9C,EAAE,gBAAgB,EAAE,MAAM,qBAAqB;AAGtD,MAAM,OAAO,SAAU,SAAQ,WAAW;IASxC,IAAI,CACF,QAAkD,EAAE,EACpD,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,GAAG,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;CACF;AAuFD,WAAiB,SAAS;AAG1B,CAAC,EAHgB,SAAS,KAAT,SAAS,QAGzB"}

package/resources/billable-metrics.d.ts

@@ -0,0 +1,236 @@
+import * as Core from '@metronome/sdk/core';
+import { APIResource } from '@metronome/sdk/resource';
+import * as BillableMetricsAPI from '@metronome/sdk/resources/billable-metrics';
+import * as Shared from '@metronome/sdk/resources/shared';
+export declare class BillableMetrics extends APIResource {
+    /**
+     * Creates a new Billable Metric.
+     */
+    create(body: BillableMetricCreateParams, options?: Core.RequestOptions): Core.APIPromise<BillableMetricCreateResponse>;
+    /**
+     * Get a billable metric
+     */
+    retrieve(billableMetricId: string, options?: Core.RequestOptions): Core.APIPromise<BillableMetricRetrieveResponse>;
+    /**
+     * List all billable metrics.
+     */
+    list(customerId: string, query?: BillableMetricListParams, options?: Core.RequestOptions): Core.APIPromise<BillableMetricListResponse>;
+    list(customerId: string, options?: Core.RequestOptions): Core.APIPromise<BillableMetricListResponse>;
+    /**
+     * Archive an existing billable metric
+     */
+    archive(body: BillableMetricArchiveParams, options?: Core.RequestOptions): Core.APIPromise<BillableMetricArchiveResponse>;
+}
+export interface BillableMetricCreateResponse {
+    data: Shared.ID;
+}
+export interface BillableMetricRetrieveResponse {
+    data: BillableMetricRetrieveResponse.Data;
+}
+export declare namespace BillableMetricRetrieveResponse {
+    interface Data {
+        /**
+         * ID of the billable metric
+         */
+        id: string;
+        /**
+         * Specifies the type of aggregation performed on matching events.
+         */
+        aggregation_type: 'count' | 'Count' | 'COUNT' | 'latest' | 'Latest' | 'LATEST' | 'max' | 'Max' | 'MAX' | 'sum' | 'Sum' | 'SUM' | 'unique' | 'Unique' | 'UNIQUE';
+        /**
+         * The display name of the billable metric.
+         */
+        name: string;
+        /**
+         * A key that specifies which property of the event is used to aggregate data. This
+         * key must be one of the property filter names and is not applicable when the
+         * aggregation type is 'count'.
+         */
+        aggregation_key?: string;
+        custom_fields?: Record<string, string>;
+        /**
+         * An optional filtering rule to match the 'event_type' property of an event.
+         */
+        event_type_filter?: Data.EventTypeFilter;
+        /**
+         * Property names that are used to group usage costs on an invoice. Each entry
+         * represents a set of properties used to slice events into distinct buckets.
+         */
+        group_keys?: Array<Array<string>>;
+        /**
+         * A list of filters to match events to this billable metric. Each filter defines a
+         * rule on an event property. All rules must pass for the event to match the
+         * billable metric.
+         */
+        property_filters?: Array<Data.PropertyFilter>;
+    }
+    namespace Data {
+        /**
+         * An optional filtering rule to match the 'event_type' property of an event.
+         */
+        interface EventTypeFilter {
+            /**
+             * A list of event types that are explicitly included in the billable metric. If
+             * specified, only events of these types will match the billable metric. Must be
+             * non-empty if present.
+             */
+            in_values?: Array<string>;
+            /**
+             * A list of event types that are explicitly excluded from the billable metric. If
+             * specified, events of these types will not match the billable metric. Must be
+             * non-empty if present.
+             */
+            not_in_values?: Array<string>;
+        }
+        interface PropertyFilter {
+            /**
+             * The name of the event property.
+             */
+            name: string;
+            /**
+             * Determines whether the property must exist in the event. If true, only events
+             * with this property will pass the filter. If false, only events without this
+             * property will pass the filter. If null or omitted, the existence of the property
+             * is optional.
+             */
+            exists?: boolean;
+            /**
+             * Specifies the allowed values for the property to match an event. An event will
+             * pass the filter only if its property value is included in this list. If
+             * undefined, all property values will pass the filter. Must be non-empty if
+             * present.
+             */
+            in_values?: Array<string>;
+            /**
+             * Specifies the values that prevent an event from matching the filter. An event
+             * will not pass the filter if its property value is included in this list. If null
+             * or empty, all property values will pass the filter. Must be non-empty if
+             * present.
+             */
+            not_in_values?: Array<string>;
+        }
+    }
+}
+export interface BillableMetricListResponse {
+    data: Array<BillableMetricListResponse.Data>;
+    next_page: string | null;
+}
+export declare namespace BillableMetricListResponse {
+    interface Data {
+        id: string;
+        name: string;
+        group_by?: Array<string>;
+    }
+}
+export interface BillableMetricArchiveResponse {
+    data: Shared.ID;
+}
+export interface BillableMetricCreateParams {
+    /**
+     * Specifies the type of aggregation performed on matching events.
+     */
+    aggregation_type: 'count' | 'Count' | 'COUNT' | 'latest' | 'Latest' | 'LATEST' | 'max' | 'Max' | 'MAX' | 'sum' | 'Sum' | 'SUM' | 'unique' | 'Unique' | 'UNIQUE';
+    /**
+     * The display name of the billable metric.
+     */
+    name: string;
+    /**
+     * A key that specifies which property of the event is used to aggregate data. This
+     * key must be one of the property filter names and is not applicable when the
+     * aggregation type is 'count'.
+     */
+    aggregation_key?: string;
+    /**
+     * Custom fields to attach to the billable metric.
+     */
+    custom_fields?: Record<string, string>;
+    /**
+     * An optional filtering rule to match the 'event_type' property of an event.
+     */
+    event_type_filter?: BillableMetricCreateParams.EventTypeFilter;
+    /**
+     * Property names that are used to group usage costs on an invoice. Each entry
+     * represents a set of properties used to slice events into distinct buckets.
+     */
+    group_keys?: Array<Array<string>>;
+    /**
+     * A list of filters to match events to this billable metric. Each filter defines a
+     * rule on an event property. All rules must pass for the event to match the
+     * billable metric.
+     */
+    property_filters?: Array<BillableMetricCreateParams.PropertyFilter>;
+}
+export declare namespace BillableMetricCreateParams {
+    /**
+     * An optional filtering rule to match the 'event_type' property of an event.
+     */
+    interface EventTypeFilter {
+        /**
+         * A list of event types that are explicitly included in the billable metric. If
+         * specified, only events of these types will match the billable metric. Must be
+         * non-empty if present.
+         */
+        in_values?: Array<string>;
+        /**
+         * A list of event types that are explicitly excluded from the billable metric. If
+         * specified, events of these types will not match the billable metric. Must be
+         * non-empty if present.
+         */
+        not_in_values?: Array<string>;
+    }
+    interface PropertyFilter {
+        /**
+         * The name of the event property.
+         */
+        name: string;
+        /**
+         * Determines whether the property must exist in the event. If true, only events
+         * with this property will pass the filter. If false, only events without this
+         * property will pass the filter. If null or omitted, the existence of the property
+         * is optional.
+         */
+        exists?: boolean;
+        /**
+         * Specifies the allowed values for the property to match an event. An event will
+         * pass the filter only if its property value is included in this list. If
+         * undefined, all property values will pass the filter. Must be non-empty if
+         * present.
+         */
+        in_values?: Array<string>;
+        /**
+         * Specifies the values that prevent an event from matching the filter. An event
+         * will not pass the filter if its property value is included in this list. If null
+         * or empty, all property values will pass the filter. Must be non-empty if
+         * present.
+         */
+        not_in_values?: Array<string>;
+    }
+}
+export interface BillableMetricListParams {
+    /**
+     * Max number of results that should be returned
+     */
+    limit?: number;
+    /**
+     * Cursor that indicates where the next page of results should start.
+     */
+    next_page?: string;
+    /**
+     * If true, the list of metrics will be filtered to just ones that are on the
+     * customer's current plan
+     */
+    on_current_plan?: boolean;
+}
+export interface BillableMetricArchiveParams {
+    id: string;
+}
+export declare namespace BillableMetrics {
+    export import BillableMetricCreateResponse = BillableMetricsAPI.BillableMetricCreateResponse;
+    export import BillableMetricRetrieveResponse = BillableMetricsAPI.BillableMetricRetrieveResponse;
+    export import BillableMetricListResponse = BillableMetricsAPI.BillableMetricListResponse;
+    export import BillableMetricArchiveResponse = BillableMetricsAPI.BillableMetricArchiveResponse;
+    export import BillableMetricCreateParams = BillableMetricsAPI.BillableMetricCreateParams;
+    export import BillableMetricListParams = BillableMetricsAPI.BillableMetricListParams;
+    export import BillableMetricArchiveParams = BillableMetricsAPI.BillableMetricArchiveParams;
+}
+//# sourceMappingURL=billable-metrics.d.ts.map

package/resources/billable-metrics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"billable-metrics.d.ts","sourceRoot":"","sources":["../src/resources/billable-metrics.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,qBAAqB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAEtD,OAAO,KAAK,kBAAkB,MAAM,2CAA2C,CAAC;AAChF,OAAO,KAAK,MAAM,MAAM,iCAAiC,CAAC;AAE1D,qBAAa,eAAgB,SAAQ,WAAW;IAC9C;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;IAIhD;;OAEG;IACH,QAAQ,CACN,gBAAgB,EAAE,MAAM,EACxB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,8BAA8B,CAAC;IAIlD;;OAEG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,0BAA0B,CAAC;IAC9C,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,0BAA0B,CAAC;IAYpG;;OAEG;IACH,OAAO,CACL,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,6BAA6B,CAAC;CAGlD;AAED,MAAM,WAAW,4BAA4B;IAC3C,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,8BAA8B;IAC7C,IAAI,EAAE,8BAA8B,CAAC,IAAI,CAAC;CAC3C;AAED,yBAAiB,8BAA8B,CAAC;IAC9C,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,gBAAgB,EACZ,OAAO,GACP,OAAO,GACP,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,QAAQ,GACR,QAAQ,GACR,QAAQ,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;;;WAIG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAEvC;;WAEG;QACH,iBAAiB,CAAC,EAAE,IAAI,CAAC,eAAe,CAAC;QAEzC;;;WAGG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;QAElC;;;;WAIG;QACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;KAC/C;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,eAAe;YAC9B;;;;eAIG;YACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE1B;;;;eAIG;YACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SAC/B;QAED,UAAiB,cAAc;YAC7B;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;;;;eAKG;YACH,MAAM,CAAC,EAAE,OAAO,CAAC;YAEjB;;;;;eAKG;YACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE1B;;;;;eAKG;YACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SAC/B;KACF;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,KAAK,CAAC,0BAA0B,CAAC,IAAI,CAAC,CAAC;IAE7C,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,IAAI,EAAE,MAAM,CAAC;QAEb,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC1B;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,gBAAgB,EACZ,OAAO,GACP,OAAO,GACP,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,QAAQ,GACR,QAAQ,GACR,QAAQ,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEvC;;OAEG;IACH,iBAAiB,CAAC,EAAE,0BAA0B,CAAC,eAAe,CAAC;IAE/D;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IAElC;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,0BAA0B,CAAC,cAAc,CAAC,CAAC;CACrE;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,eAAe;QAC9B;;;;WAIG;QACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;;;WAIG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC/B;IAED,UAAiB,cAAc;QAC7B;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;;;;WAKG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB;;;;;WAKG;QACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;;;;WAKG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC/B;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,2BAA2B;IAC1C,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,yBAAiB,eAAe,CAAC;IAC/B,MAAM,QAAQ,4BAA4B,GAAG,kBAAkB,CAAC,4BAA4B,CAAC;IAC7F,MAAM,QAAQ,8BAA8B,GAAG,kBAAkB,CAAC,8BAA8B,CAAC;IACjG,MAAM,QAAQ,0BAA0B,GAAG,kBAAkB,CAAC,0BAA0B,CAAC;IACzF,MAAM,QAAQ,6BAA6B,GAAG,kBAAkB,CAAC,6BAA6B,CAAC;IAC/F,MAAM,QAAQ,0BAA0B,GAAG,kBAAkB,CAAC,0BAA0B,CAAC;IACzF,MAAM,QAAQ,wBAAwB,GAAG,kBAAkB,CAAC,wBAAwB,CAAC;IACrF,MAAM,QAAQ,2BAA2B,GAAG,kBAAkB,CAAC,2BAA2B,CAAC;CAC5F"}

package/resources/billable-metrics.js

@@ -0,0 +1,36 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillableMetrics = void 0;
+const resource_1 = require("@metronome/sdk/resource");
+const core_1 = require("@metronome/sdk/core");
+class BillableMetrics extends resource_1.APIResource {
+    /**
+     * Creates a new Billable Metric.
+     */
+    create(body, options) {
+        return this._client.post('/billable-metrics/create', { body, ...options });
+    }
+    /**
+     * Get a billable metric
+     */
+    retrieve(billableMetricId, options) {
+        return this._client.get(`/billable-metrics/${billableMetricId}`, options);
+    }
+    list(customerId, query = {}, options) {
+        if ((0, core_1.isRequestOptions)(query)) {
+            return this.list(customerId, {}, query);
+        }
+        return this._client.get(`/customers/${customerId}/billable-metrics`, { query, ...options });
+    }
+    /**
+     * Archive an existing billable metric
+     */
+    archive(body, options) {
+        return this._client.post('/billable-metrics/archive', { body, ...options });
+    }
+}
+exports.BillableMetrics = BillableMetrics;
+(function (BillableMetrics) {
+})(BillableMetrics = exports.BillableMetrics || (exports.BillableMetrics = {}));
+//# sourceMappingURL=billable-metrics.js.map

package/resources/billable-metrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"billable-metrics.js","sourceRoot":"","sources":["../src/resources/billable-metrics.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAGtF,sDAAsD;AACtD,8CAAuD;AAIvD,MAAa,eAAgB,SAAQ,sBAAW;IAC9C;;OAEG;IACH,MAAM,CACJ,IAAgC,EAChC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,gBAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,gBAAgB,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAWD,IAAI,CACF,UAAkB,EAClB,QAAwD,EAAE,EAC1D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,UAAU,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;OAEG;IACH,OAAO,CACL,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;CACF;AAlDD,0CAkDC;AAkRD,WAAiB,eAAe;AAQhC,CAAC,EARgB,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAQ/B"}

package/resources/billable-metrics.mjs

@@ -0,0 +1,32 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from '@metronome/sdk/resource';
+import { isRequestOptions } from '@metronome/sdk/core';
+export class BillableMetrics extends APIResource {
+    /**
+     * Creates a new Billable Metric.
+     */
+    create(body, options) {
+        return this._client.post('/billable-metrics/create', { body, ...options });
+    }
+    /**
+     * Get a billable metric
+     */
+    retrieve(billableMetricId, options) {
+        return this._client.get(`/billable-metrics/${billableMetricId}`, options);
+    }
+    list(customerId, query = {}, options) {
+        if (isRequestOptions(query)) {
+            return this.list(customerId, {}, query);
+        }
+        return this._client.get(`/customers/${customerId}/billable-metrics`, { query, ...options });
+    }
+    /**
+     * Archive an existing billable metric
+     */
+    archive(body, options) {
+        return this._client.post('/billable-metrics/archive', { body, ...options });
+    }
+}
+(function (BillableMetrics) {
+})(BillableMetrics || (BillableMetrics = {}));
+//# sourceMappingURL=billable-metrics.mjs.map

package/resources/billable-metrics.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"billable-metrics.mjs","sourceRoot":"","sources":["../src/resources/billable-metrics.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAG/E,EAAE,WAAW,EAAE,MAAM,yBAAyB;OAC9C,EAAE,gBAAgB,EAAE,MAAM,qBAAqB;AAItD,MAAM,OAAO,eAAgB,SAAQ,WAAW;IAC9C;;OAEG;IACH,MAAM,CACJ,IAAgC,EAChC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,gBAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,gBAAgB,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAWD,IAAI,CACF,UAAkB,EAClB,QAAwD,EAAE,EAC1D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,UAAU,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;OAEG;IACH,OAAO,CACL,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;CACF;AAkRD,WAAiB,eAAe;AAQhC,CAAC,EARgB,eAAe,KAAf,eAAe,QAQ/B"}