@metronome/sdk 0.1.0-beta.8 → 0.1.0

package/resources/v1/plans.mjs

@@ -0,0 +1,74 @@
+// 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";
+export class Plans extends APIResource {
+    list(query = {}, options) {
+        if (isRequestOptions(query)) {
+            return this.list({}, query);
+        }
+        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, options) {
+        const { plan_id } = params;
+        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, options) {
+        const { plan_id, ...query } = params;
+        return this._client.getAPIList(`/v1/planDetails/${plan_id}/charges`, PlanListChargesResponsesCursorPage, {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * 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, options) {
+        const { plan_id, ...query } = params;
+        return this._client.getAPIList(`/v1/planDetails/${plan_id}/customers`, PlanListCustomersResponsesCursorPage, { query, ...options });
+    }
+}
+export class PlanListResponsesCursorPage extends CursorPage {
+}
+export class PlanListChargesResponsesCursorPage extends CursorPage {
+}
+export class PlanListCustomersResponsesCursorPage extends CursorPage {
+}
+Plans.PlanListResponsesCursorPage = PlanListResponsesCursorPage;
+Plans.PlanListChargesResponsesCursorPage = PlanListChargesResponsesCursorPage;
+Plans.PlanListCustomersResponsesCursorPage = PlanListCustomersResponsesCursorPage;
+//# sourceMappingURL=plans.mjs.map

package/resources/v1/plans.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"plans.mjs","sourceRoot":"","sources":["../../src/resources/v1/plans.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAIpB,EAAE,UAAU,EAAyB;AAE5C,MAAM,OAAO,KAAM,SAAQ,WAAW;IAiBpC,IAAI,CACF,QAA8C,EAAE,EAChD,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,WAAW,EAAE,2BAA2B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IAED;;;;;;;;;OASG;IACH,UAAU,CACR,MAA4B,EAC5B,OAA6B;QAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,WAAW,CACT,MAA6B,EAC7B,OAA6B;QAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,OAAO,UAAU,EAAE,kCAAkC,EAAE;YACvG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,MAA+B,EAC/B,OAA6B;QAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,mBAAmB,OAAO,YAAY,EACtC,oCAAoC,EACpC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,2BAA4B,SAAQ,UAA4B;CAAG;AAEhF,MAAM,OAAO,kCAAmC,SAAQ,UAAmC;CAAG;AAE9F,MAAM,OAAO,oCAAqC,SAAQ,UAAqC;CAAG;AAyNlG,KAAK,CAAC,2BAA2B,GAAG,2BAA2B,CAAC;AAChE,KAAK,CAAC,kCAAkC,GAAG,kCAAkC,CAAC;AAC9E,KAAK,CAAC,oCAAoC,GAAG,oCAAoC,CAAC"}

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

@@ -1,9 +1,17 @@
-import { APIResource } from "../resource.js";
-import * as Core from "../core.js";
-import { CursorPage, type CursorPageParams } from "../pagination.js";
+import { APIResource } from "../../resource.js";
+import * as Core from "../../core.js";
+import { CursorPage, type CursorPageParams } from "../../pagination.js";
 export declare 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, options?: Core.RequestOptions): Core.PagePromise<PricingUnitListResponsesCursorPage, PricingUnitListResponse>;
     list(options?: Core.RequestOptions): Core.PagePromise<PricingUnitListResponsesCursorPage, PricingUnitListResponse>;

package/resources/v1/pricing-units.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pricing-units.d.ts","sourceRoot":"","sources":["../../src/resources/v1/pricing-units.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAErE,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,kCAAkC,EAAE,uBAAuB,CAAC;IAChF,IAAI,CACF,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,kCAAkC,EAAE,uBAAuB,CAAC;CAajF;AAED,qBAAa,kCAAmC,SAAQ,UAAU,CAAC,uBAAuB,CAAC;CAAG;AAE9F,MAAM,WAAW,uBAAuB;IACtC,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;CAAG;AAIlE,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,kCAAkC,IAAI,kCAAkC,EACxE,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/{pricing-units.js → v1/pricing-units.js}

@@ -2,15 +2,15 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PricingUnitListResponsesCursorPage = exports.PricingUnits = void 0;
-const resource_1 = require("../resource.js");
-const core_1 = require("../core.js");
-const pagination_1 = require("../pagination.js");
+const resource_1 = require("../../resource.js");
+const core_1 = require("../../core.js");
+const pagination_1 = require("../../pagination.js");
 class PricingUnits extends resource_1.APIResource {
     list(query = {}, options) {
         if ((0, core_1.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/resources/v1/pricing-units.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pricing-units.js","sourceRoot":"","sources":["../../src/resources/v1/pricing-units.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAE9C,oDAAqE;AAErE,MAAa,YAAa,SAAQ,sBAAW;IAmB3C,IAAI,CACF,QAAqD,EAAE,EACvD,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,UAAU,CAAC,uBAAuB,EAAE,kCAAkC,EAAE;YAC1F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA/BD,oCA+BC;AAED,MAAa,kCAAmC,SAAQ,uBAAmC;CAAG;AAA9F,gFAA8F;AAY9F,YAAY,CAAC,kCAAkC,GAAG,kCAAkC,CAAC"}

package/resources/{pricing-units.mjs → v1/pricing-units.mjs}

@@ -1,13 +1,13 @@
 // 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 "../../resource.mjs";
+import { isRequestOptions } from "../../core.mjs";
+import { CursorPage } from "../../pagination.mjs";
 export class PricingUnits extends APIResource {
     list(query = {}, options) {
         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/resources/v1/pricing-units.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"pricing-units.mjs","sourceRoot":"","sources":["../../src/resources/v1/pricing-units.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,UAAU,EAAyB;AAE5C,MAAM,OAAO,YAAa,SAAQ,WAAW;IAmB3C,IAAI,CACF,QAAqD,EAAE,EACvD,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,uBAAuB,EAAE,kCAAkC,EAAE;YAC1F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,OAAO,kCAAmC,SAAQ,UAAmC;CAAG;AAY9F,YAAY,CAAC,kCAAkC,GAAG,kCAAkC,CAAC"}

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

@@ -1,11 +1,16 @@
-import { APIResource } from "../resource.js";
-import * as Core from "../core.js";
+import { APIResource } from "../../resource.js";
+import * as Core from "../../core.js";
 export declare class Services extends APIResource {
     /**
      * Fetches a list of services used by Metronome and the associated IP addresses. IP
      * 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>;
 }

package/resources/v1/services.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"services.d.ts","sourceRoot":"","sources":["../../src/resources/v1/services.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;CAG1E;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,KAAK,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;CAC9C;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,OAAO;QACtB,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEnB,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,wBAAwB,GAAG,wBAAwB,CAAC;KAC5D;CACF;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;CAC5D"}

package/resources/{services.js → v1/services.js}

@@ -2,16 +2,21 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Services = void 0;
-const resource_1 = require("../resource.js");
+const resource_1 = require("../../resource.js");
 class Services extends resource_1.APIResource {
     /**
      * Fetches a list of services used by Metronome and the associated IP addresses. IP
      * 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) {
-        return this._client.get('/services', options);
+        return this._client.get('/v1/services', options);
     }
 }
 exports.Services = Services;

package/resources/v1/services.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"services.js","sourceRoot":"","sources":["../../src/resources/v1/services.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;OAUG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;CACF;AAfD,4BAeC"}

package/resources/{services.mjs → v1/services.mjs}

@@ -1,14 +1,19 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { APIResource } from "../resource.mjs";
+import { APIResource } from "../../resource.mjs";
 export class Services extends APIResource {
     /**
      * Fetches a list of services used by Metronome and the associated IP addresses. IP
      * 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) {
-        return this._client.get('/services', options);
+        return this._client.get('/v1/services', options);
     }
 }
 //# sourceMappingURL=services.mjs.map

package/resources/v1/services.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"services.mjs","sourceRoot":"","sources":["../../src/resources/v1/services.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;CACF"}

package/resources/v1/usage.d.ts

@@ -0,0 +1,325 @@
+import { APIResource } from "../../resource.js";
+import * as Core from "../../core.js";
+import * as Shared from "../shared.js";
+import { CursorPage, type CursorPageParams } from "../../pagination.js";
+export declare class Usage extends APIResource {
+    /**
+     * Fetch aggregated usage data for multiple customers and billable-metrics, broken
+     * into intervals of the specified length.
+     *
+     * @example
+     * ```ts
+     * const usages = await client.v1.usage.list({
+     *   ending_before: '2021-01-03T00:00:00Z',
+     *   starting_on: '2021-01-01T00:00:00Z',
+     *   window_size: 'day',
+     * });
+     * ```
+     */
+    list(params: UsageListParams, options?: Core.RequestOptions): Core.APIPromise<UsageListResponse>;
+    /**
+     * Send usage events to Metronome. The body of this request is expected to be a
+     * JSON array of between 1 and 100 usage events. Compressed request bodies are
+     * supported with a `Content-Encoding: gzip` header. See
+     * [Getting usage into Metronome](https://docs.metronome.com/connect-metronome/) to
+     * learn more about usage events.
+     *
+     * @example
+     * ```ts
+     * await client.v1.usage.ingest([
+     *   {
+     *     customer_id: 'team@example.com',
+     *     event_type: 'heartbeat',
+     *     timestamp: '2021-01-01T00:00:00Z',
+     *     transaction_id: '2021-01-01T00:00:00Z_cluster42',
+     *   },
+     * ]);
+     * ```
+     */
+    ingest(body?: UsageIngestParams, options?: Core.RequestOptions): Core.APIPromise<void>;
+    ingest(options?: Core.RequestOptions): Core.APIPromise<void>;
+    /**
+     * Fetch aggregated usage data for the specified customer, billable-metric, and
+     * optional group, broken into intervals of the specified length.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const usageListWithGroupsResponse of client.v1.usage.listWithGroups(
+     *   {
+     *     billable_metric_id:
+     *       '222796fd-d29c-429e-89b2-549fabda4ed6',
+     *     customer_id: '04ca7e72-4229-4a6e-ab11-9f7376fccbcb',
+     *     window_size: 'day',
+     *     ending_before: '2021-01-03T00:00:00Z',
+     *     group_by: {
+     *       key: 'region',
+     *       values: ['US-East', 'US-West', 'EU-Central'],
+     *     },
+     *     starting_on: '2021-01-01T00:00:00Z',
+     *   },
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    listWithGroups(params: UsageListWithGroupsParams, options?: Core.RequestOptions): Core.PagePromise<UsageListWithGroupsResponsesCursorPage, UsageListWithGroupsResponse>;
+    /**
+     * For a set of events, look up matched billable metrics and customers by
+     * transaction id. This endpoint looks at transactions that occurred in the last 34
+     * days, and is intended for sampling-based testing workflows. It is heavily rate
+     * limited.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.usage.search({
+     *   transactionIds: ['2021-01-01T00:00:00Z_cluster42'],
+     * });
+     * ```
+     */
+    search(body: UsageSearchParams, options?: Core.RequestOptions): Core.APIPromise<UsageSearchResponse>;
+}
+export declare class UsageListWithGroupsResponsesCursorPage extends CursorPage<UsageListWithGroupsResponse> {
+}
+export interface UsageListResponse {
+    data: Array<UsageListResponse.Data>;
+    next_page: string | null;
+}
+export declare namespace UsageListResponse {
+    interface Data {
+        billable_metric_id: string;
+        billable_metric_name: string;
+        customer_id: string;
+        end_timestamp: string;
+        start_timestamp: string;
+        value: number | null;
+        /**
+         * Values will be either a number or null. Null indicates that there were no
+         * matches for the group_by value.
+         */
+        groups?: {
+            [key: string]: number | null;
+        };
+    }
+}
+export interface UsageListWithGroupsResponse {
+    ending_before: string;
+    group_key: string | null;
+    group_value: string | null;
+    starting_on: string;
+    value: number | null;
+}
+export type UsageSearchResponse = Array<UsageSearchResponse.UsageSearchResponseItem>;
+export declare namespace UsageSearchResponse {
+    interface UsageSearchResponseItem {
+        id: string;
+        /**
+         * The ID of the customer in the ingest event body
+         */
+        customer_id: string;
+        event_type: string;
+        timestamp: string;
+        transaction_id: string;
+        is_duplicate?: boolean;
+        matched_billable_metrics?: Array<UsageSearchResponseItem.MatchedBillableMetric>;
+        /**
+         * The customer the event was matched to if a match was found
+         */
+        matched_customer?: UsageSearchResponseItem.MatchedCustomer;
+        processed_at?: string;
+        properties?: {
+            [key: string]: unknown;
+        };
+    }
+    namespace UsageSearchResponseItem {
+        interface MatchedBillableMetric {
+            id: string;
+            name: string;
+            /**
+             * (DEPRECATED) use aggregation_type instead
+             */
+            aggregate?: string;
+            /**
+             * (DEPRECATED) use aggregation_key instead
+             */
+            aggregate_keys?: Array<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;
+            /**
+             * Specifies the type of aggregation performed on matching events.
+             */
+            aggregation_type?: 'COUNT' | 'LATEST' | 'MAX' | 'SUM' | 'UNIQUE';
+            /**
+             * RFC 3339 timestamp indicating when the billable metric was archived. If not
+             * provided, the billable metric is not archived.
+             */
+            archived_at?: string;
+            custom_fields?: {
+                [key: string]: string;
+            };
+            /**
+             * An optional filtering rule to match the 'event_type' property of an event.
+             */
+            event_type_filter?: Shared.EventTypeFilter;
+            /**
+             * (DEPRECATED) use property_filters & event_type_filter instead
+             */
+            filter?: {
+                [key: string]: unknown;
+            };
+            /**
+             * (DEPRECATED) use group_keys instead
+             */
+            group_by?: Array<string>;
+            /**
+             * 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<Shared.PropertyFilter>;
+            /**
+             * The SQL query associated with the billable metric
+             */
+            sql?: string;
+        }
+        /**
+         * The customer the event was matched to if a match was found
+         */
+        interface MatchedCustomer {
+            id?: string;
+            name?: string;
+        }
+    }
+}
+export interface UsageListParams {
+    /**
+     * Body param:
+     */
+    ending_before: string;
+    /**
+     * Body param:
+     */
+    starting_on: string;
+    /**
+     * Body param: A window_size of "day" or "hour" will return the usage for the
+     * specified period segmented into daily or hourly aggregates. A window_size of
+     * "none" will return a single usage aggregate for the entirety of the specified
+     * period.
+     */
+    window_size: 'HOUR' | 'DAY' | 'NONE';
+    /**
+     * Query param: Cursor that indicates where the next page of results should start.
+     */
+    next_page?: string;
+    /**
+     * Body param: A list of billable metrics to fetch usage for. If absent, all
+     * billable metrics will be returned.
+     */
+    billable_metrics?: Array<UsageListParams.BillableMetric>;
+    /**
+     * Body param: A list of Metronome customer IDs to fetch usage for. If absent,
+     * usage for all customers will be returned.
+     */
+    customer_ids?: Array<string>;
+}
+export declare namespace UsageListParams {
+    interface BillableMetric {
+        id: string;
+        group_by?: BillableMetric.GroupBy;
+    }
+    namespace BillableMetric {
+        interface GroupBy {
+            /**
+             * The name of the group_by key to use
+             */
+            key: string;
+            /**
+             * Values of the group_by key to return in the query. If this field is omitted, all
+             * available values will be returned, up to a maximum of 200.
+             */
+            values?: Array<string>;
+        }
+    }
+}
+export type UsageIngestParams = Array<UsageIngestParams.Usage>;
+export declare namespace UsageIngestParams {
+    interface Usage {
+        customer_id: string;
+        event_type: string;
+        /**
+         * RFC 3339 formatted
+         */
+        timestamp: string;
+        transaction_id: string;
+        properties?: {
+            [key: string]: unknown;
+        };
+    }
+}
+export interface UsageListWithGroupsParams extends CursorPageParams {
+    /**
+     * Body param:
+     */
+    billable_metric_id: string;
+    /**
+     * Body param:
+     */
+    customer_id: string;
+    /**
+     * Body param: A window_size of "day" or "hour" will return the usage for the
+     * specified period segmented into daily or hourly aggregates. A window_size of
+     * "none" will return a single usage aggregate for the entirety of the specified
+     * period.
+     */
+    window_size: 'HOUR' | 'DAY' | 'NONE';
+    /**
+     * Body param: If true, will return the usage for the current billing period. Will
+     * return an error if the customer is currently uncontracted or starting_on and
+     * ending_before are specified when this is true.
+     */
+    current_period?: boolean;
+    /**
+     * Body param:
+     */
+    ending_before?: string;
+    /**
+     * Body param:
+     */
+    group_by?: UsageListWithGroupsParams.GroupBy;
+    /**
+     * Body param:
+     */
+    starting_on?: string;
+}
+export declare namespace UsageListWithGroupsParams {
+    interface GroupBy {
+        /**
+         * The name of the group_by key to use
+         */
+        key: string;
+        /**
+         * Values of the group_by key to return in the query. Omit this if you'd like all
+         * values for the key returned.
+         */
+        values?: Array<string>;
+    }
+}
+export interface UsageSearchParams {
+    /**
+     * The transaction IDs of the events to retrieve
+     */
+    transactionIds: Array<string>;
+}
+export declare namespace Usage {
+    export { type UsageListResponse as UsageListResponse, type UsageListWithGroupsResponse as UsageListWithGroupsResponse, type UsageSearchResponse as UsageSearchResponse, UsageListWithGroupsResponsesCursorPage as UsageListWithGroupsResponsesCursorPage, type UsageListParams as UsageListParams, type UsageIngestParams as UsageIngestParams, type UsageListWithGroupsParams as UsageListWithGroupsParams, type UsageSearchParams as UsageSearchParams, };
+}
+//# sourceMappingURL=usage.d.ts.map

package/resources/v1/usage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"usage.d.ts","sourceRoot":"","sources":["../../src/resources/v1/usage.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAErE,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC;IAKhG;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,IAAI,CAAC,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IACtF,MAAM,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAe5D;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,cAAc,CACZ,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,sCAAsC,EAAE,2BAA2B,CAAC;IAUxF;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;CAGrG;AAED,qBAAa,sCAAuC,SAAQ,UAAU,CAAC,2BAA2B,CAAC;CAAG;AAEtG,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAEpC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,IAAI;QACnB,kBAAkB,EAAE,MAAM,CAAC;QAE3B,oBAAoB,EAAE,MAAM,CAAC;QAE7B,WAAW,EAAE,MAAM,CAAC;QAEpB,aAAa,EAAE,MAAM,CAAC;QAEtB,eAAe,EAAE,MAAM,CAAC;QAExB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;;WAGG;QACH,MAAM,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;SAAE,CAAC;KAC3C;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C,aAAa,EAAE,MAAM,CAAC;IAEtB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,WAAW,EAAE,MAAM,CAAC;IAEpB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC,mBAAmB,CAAC,uBAAuB,CAAC,CAAC;AAErF,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,uBAAuB;QACtC,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB,UAAU,EAAE,MAAM,CAAC;QAEnB,SAAS,EAAE,MAAM,CAAC;QAElB,cAAc,EAAE,MAAM,CAAC;QAEvB,YAAY,CAAC,EAAE,OAAO,CAAC;QAEvB,wBAAwB,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,qBAAqB,CAAC,CAAC;QAEhF;;WAEG;QACH,gBAAgB,CAAC,EAAE,uBAAuB,CAAC,eAAe,CAAC;QAE3D,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,UAAU,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;KACzC;IAED,UAAiB,uBAAuB,CAAC;QACvC,UAAiB,qBAAqB;YACpC,EAAE,EAAE,MAAM,CAAC;YAEX,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE/B;;;;eAIG;YACH,eAAe,CAAC,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,KAAK,GAAG,KAAK,GAAG,QAAQ,CAAC;YAEjE;;;eAGG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB,aAAa,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;YAE1C;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,eAAe,CAAC;YAE3C;;eAEG;YACH,MAAM,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAC;YAEpC;;eAEG;YACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAEzB;;;eAGG;YACH,UAAU,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;YAElC;;;;eAIG;YACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;YAEhD;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;SACd;QAED;;WAEG;QACH,UAAiB,eAAe;YAC9B,EAAE,CAAC,EAAE,MAAM,CAAC;YAEZ,IAAI,CAAC,EAAE,MAAM,CAAC;SACf;KACF;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,WAAW,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;IAEzD;;;OAGG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC9B;AAED,yBAAiB,eAAe,CAAC;IAC/B,UAAiB,cAAc;QAC7B,EAAE,EAAE,MAAM,CAAC;QAEX,QAAQ,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC;KACnC;IAED,UAAiB,cAAc,CAAC;QAC9B,UAAiB,OAAO;YACtB;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;YAEZ;;;eAGG;YACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SACxB;KACF;CACF;AAED,MAAM,MAAM,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;AAE/D,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,KAAK;QACpB,WAAW,EAAE,MAAM,CAAC;QAEpB,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB,cAAc,EAAE,MAAM,CAAC;QAEvB,UAAU,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;KACzC;CACF;AAED,MAAM,WAAW,yBAA0B,SAAQ,gBAAgB;IACjE;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,WAAW,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,CAAC;IAErC;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,yBAAyB,CAAC,OAAO,CAAC;IAE7C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,OAAO;QACtB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;;WAGG;QACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACxB;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC/B;AAID,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,sCAAsC,IAAI,sCAAsC,EAChF,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/v1/usage.js

@@ -0,0 +1,92 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UsageListWithGroupsResponsesCursorPage = exports.Usage = void 0;
+const resource_1 = require("../../resource.js");
+const core_1 = require("../../core.js");
+const pagination_1 = require("../../pagination.js");
+class Usage extends resource_1.APIResource {
+    /**
+     * Fetch aggregated usage data for multiple customers and billable-metrics, broken
+     * into intervals of the specified length.
+     *
+     * @example
+     * ```ts
+     * const usages = await client.v1.usage.list({
+     *   ending_before: '2021-01-03T00:00:00Z',
+     *   starting_on: '2021-01-01T00:00:00Z',
+     *   window_size: 'day',
+     * });
+     * ```
+     */
+    list(params, options) {
+        const { next_page, ...body } = params;
+        return this._client.post('/v1/usage', { query: { next_page }, body, ...options });
+    }
+    ingest(body, options) {
+        if ((0, core_1.isRequestOptions)(body)) {
+            return this.ingest(undefined, body);
+        }
+        return this._client.post('/v1/ingest', {
+            body,
+            ...options,
+            headers: { Accept: '*/*', ...options?.headers },
+        });
+    }
+    /**
+     * Fetch aggregated usage data for the specified customer, billable-metric, and
+     * optional group, broken into intervals of the specified length.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const usageListWithGroupsResponse of client.v1.usage.listWithGroups(
+     *   {
+     *     billable_metric_id:
+     *       '222796fd-d29c-429e-89b2-549fabda4ed6',
+     *     customer_id: '04ca7e72-4229-4a6e-ab11-9f7376fccbcb',
+     *     window_size: 'day',
+     *     ending_before: '2021-01-03T00:00:00Z',
+     *     group_by: {
+     *       key: 'region',
+     *       values: ['US-East', 'US-West', 'EU-Central'],
+     *     },
+     *     starting_on: '2021-01-01T00:00:00Z',
+     *   },
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    listWithGroups(params, options) {
+        const { limit, next_page, ...body } = params;
+        return this._client.getAPIList('/v1/usage/groups', UsageListWithGroupsResponsesCursorPage, {
+            query: { limit, next_page },
+            body,
+            method: 'post',
+            ...options,
+        });
+    }
+    /**
+     * For a set of events, look up matched billable metrics and customers by
+     * transaction id. This endpoint looks at transactions that occurred in the last 34
+     * days, and is intended for sampling-based testing workflows. It is heavily rate
+     * limited.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.usage.search({
+     *   transactionIds: ['2021-01-01T00:00:00Z_cluster42'],
+     * });
+     * ```
+     */
+    search(body, options) {
+        return this._client.post('/v1/events/search', { body, ...options });
+    }
+}
+exports.Usage = Usage;
+class UsageListWithGroupsResponsesCursorPage extends pagination_1.CursorPage {
+}
+exports.UsageListWithGroupsResponsesCursorPage = UsageListWithGroupsResponsesCursorPage;
+Usage.UsageListWithGroupsResponsesCursorPage = UsageListWithGroupsResponsesCursorPage;
+//# sourceMappingURL=usage.js.map

package/resources/v1/usage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usage.js","sourceRoot":"","sources":["../../src/resources/v1/usage.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAG9C,oDAAqE;AAErE,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,MAAuB,EAAE,OAA6B;QACzD,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAuBD,MAAM,CACJ,IAA8C,EAC9C,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;SACrC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE;YACrC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,cAAc,CACZ,MAAiC,EACjC,OAA6B;QAE7B,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,sCAAsC,EAAE;YACzF,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;YAC3B,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAuB,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF;AA5GD,sBA4GC;AAED,MAAa,sCAAuC,SAAQ,uBAAuC;CAAG;AAAtG,wFAAsG;AAyStG,KAAK,CAAC,sCAAsC,GAAG,sCAAsC,CAAC"}