@stigg/typescript 0.1.0-alpha.2 → 0.1.0-alpha.21

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

@@ -0,0 +1,101 @@
+import { APIResource } from "../../../core/resource.js";
+import { APIPromise } from "../../../core/api-promise.js";
+import { RequestOptions } from "../../../internal/request-options.js";
+/**
+ * Operations related to subscriptions
+ */
+export declare class Usage extends APIResource {
+    /**
+     * Immediately charges usage for a subscription via the billing integration.
+     * Calculates usage since the last charge and creates an invoice.
+     */
+    chargeUsage(id: string, body: UsageChargeUsageParams, options?: RequestOptions): APIPromise<UsageChargeUsageResponse>;
+    /**
+     * Triggers a usage sync for a subscription, reporting current usage to the billing
+     * provider.
+     */
+    sync(id: string, options?: RequestOptions): APIPromise<UsageSyncResponse>;
+}
+/**
+ * Response object
+ */
+export interface UsageChargeUsageResponse {
+    /**
+     * Result of charging subscription usage including the billing period and charged
+     * items.
+     */
+    data: UsageChargeUsageResponse.Data;
+}
+export declare namespace UsageChargeUsageResponse {
+    /**
+     * Result of charging subscription usage including the billing period and charged
+     * items.
+     */
+    interface Data {
+        /**
+         * The invoice ID in the billing integration
+         */
+        invoiceBillingId: string | null;
+        /**
+         * End of the usage billing period
+         */
+        periodEnd: string;
+        /**
+         * Start of the usage billing period
+         */
+        periodStart: string;
+        /**
+         * The subscription ID for which usage was charged
+         */
+        subscriptionId: string;
+        /**
+         * Usage items that were charged
+         */
+        usageCharged: Array<Data.UsageCharged>;
+    }
+    namespace Data {
+        /**
+         * A single usage item that was charged.
+         */
+        interface UsageCharged {
+            /**
+             * The feature ID for which usage was charged
+             */
+            featureId: string | null;
+            /**
+             * The number of units charged
+             */
+            usageAmount: number;
+        }
+    }
+}
+/**
+ * Response object
+ */
+export interface UsageSyncResponse {
+    /**
+     * Result of triggering a subscription usage sync.
+     */
+    data: UsageSyncResponse.Data;
+}
+export declare namespace UsageSyncResponse {
+    /**
+     * Result of triggering a subscription usage sync.
+     */
+    interface Data {
+        /**
+         * Whether usage was synced to the billing provider
+         */
+        triggered: boolean;
+    }
+}
+export interface UsageChargeUsageParams {
+    /**
+     * Cutoff date for usage calculation. If not provided, the current time is used.
+     */
+    untilDate?: string;
+}
+export declare namespace Usage {
+    export { type UsageChargeUsageResponse as UsageChargeUsageResponse, type UsageSyncResponse as UsageSyncResponse, type UsageChargeUsageParams as UsageChargeUsageParams, };
+}
+//# sourceMappingURL=usage.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"usage.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/usage.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;OAGG;IACH,WAAW,CACT,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;;OAGG;IACH,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;CAG1E;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,IAAI,EAAE,wBAAwB,CAAC,IAAI,CAAC;CACrC;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;;OAGG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,YAAY,EAAE,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;KACxC;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,YAAY;YAC3B;;eAEG;YACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;SACrB;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,iBAAiB,CAAC,IAAI,CAAC;CAC9B;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,SAAS,EAAE,OAAO,CAAC;KACpB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}

package/resources/v1/subscriptions/usage.js

@@ -0,0 +1,27 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Usage = void 0;
+const resource_1 = require("../../../core/resource.js");
+const path_1 = require("../../../internal/utils/path.js");
+/**
+ * Operations related to subscriptions
+ */
+class Usage extends resource_1.APIResource {
+    /**
+     * Immediately charges usage for a subscription via the billing integration.
+     * Calculates usage since the last charge and creates an invoice.
+     */
+    chargeUsage(id, body, options) {
+        return this._client.post((0, path_1.path) `/api/v1/subscriptions/${id}/usage/charge`, { body, ...options });
+    }
+    /**
+     * Triggers a usage sync for a subscription, reporting current usage to the billing
+     * provider.
+     */
+    sync(id, options) {
+        return this._client.post((0, path_1.path) `/api/v1/subscriptions/${id}/usage/sync`, options);
+    }
+}
+exports.Usage = Usage;
+//# sourceMappingURL=usage.js.map

package/resources/v1/subscriptions/usage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usage.js","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/usage.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAGrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;OAGG;IACH,WAAW,CACT,EAAU,EACV,IAA4B,EAC5B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,yBAAyB,EAAE,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,EAAU,EAAE,OAAwB;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,yBAAyB,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;CACF;AApBD,sBAoBC"}

package/resources/v1/subscriptions/usage.mjs

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../core/resource.mjs";
+import { path } from "../../../internal/utils/path.mjs";
+/**
+ * Operations related to subscriptions
+ */
+export class Usage extends APIResource {
+    /**
+     * Immediately charges usage for a subscription via the billing integration.
+     * Calculates usage since the last charge and creates an invoice.
+     */
+    chargeUsage(id, body, options) {
+        return this._client.post(path `/api/v1/subscriptions/${id}/usage/charge`, { body, ...options });
+    }
+    /**
+     * Triggers a usage sync for a subscription, reporting current usage to the billing
+     * provider.
+     */
+    sync(id, options) {
+        return this._client.post(path `/api/v1/subscriptions/${id}/usage/sync`, options);
+    }
+}
+//# sourceMappingURL=usage.mjs.map

package/resources/v1/subscriptions/usage.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"usage.mjs","sourceRoot":"","sources":["../../../src/resources/v1/subscriptions/usage.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;OAGG;IACH,WAAW,CACT,EAAU,EACV,IAA4B,EAC5B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,yBAAyB,EAAE,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,EAAU,EAAE,OAAwB;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,yBAAyB,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;CACF"}

package/resources/v1/usage.d.mts

@@ -0,0 +1,238 @@
+import { APIResource } from "../../core/resource.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Operations related to usage & metering
+ */
+export declare class Usage extends APIResource {
+    /**
+     * Retrieves historical usage data for a customer's metered feature over time.
+     */
+    history(featureID: string, params: UsageHistoryParams, options?: RequestOptions): APIPromise<UsageHistoryResponse>;
+    /**
+     * Reports usage measurements for metered features. The reported usage is used to
+     * track, limit, and bill customer consumption.
+     */
+    report(body: UsageReportParams, options?: RequestOptions): APIPromise<UsageReportResponse>;
+}
+/**
+ * Response object
+ */
+export interface UsageHistoryResponse {
+    /**
+     * Historical usage time series
+     */
+    data: UsageHistoryResponse.Data;
+}
+export declare namespace UsageHistoryResponse {
+    /**
+     * Historical usage time series
+     */
+    interface Data {
+        /**
+         * Markers for events that affecting feature usage
+         */
+        markers: Array<Data.Marker>;
+        /**
+         * Series of usage history
+         */
+        series: Array<Data.Series>;
+    }
+    namespace Data {
+        /**
+         * Usage reset or change marker
+         */
+        interface Marker {
+            /**
+             * Timestamp of the marker
+             */
+            timestamp: string;
+            /**
+             * Type of marker for a usage history point
+             */
+            type: 'PERIODIC_RESET' | 'SUBSCRIPTION_CHANGE_RESET';
+        }
+        /**
+         * Usage data points with tags
+         */
+        interface Series {
+            /**
+             * Points in the usage history series
+             */
+            points: Array<Series.Point>;
+            /**
+             * Tags for the usage history series
+             */
+            tags: Array<Series.Tag>;
+        }
+        namespace Series {
+            /**
+             * Single usage data point
+             */
+            interface Point {
+                /**
+                 * Indicates whether there was usage reset in this point, see `markers` for details
+                 */
+                isResetPoint: boolean;
+                /**
+                 * Timestamp of the usage history point
+                 */
+                timestamp: string;
+                /**
+                 * Value of the usage history point
+                 */
+                value: number;
+            }
+            /**
+             * Grouping tag key-value
+             */
+            interface Tag {
+                /**
+                 * Key of the tag
+                 */
+                key: string;
+                /**
+                 * Value of the tag
+                 */
+                value: string;
+            }
+        }
+    }
+}
+/**
+ * Response containing reported usage measurements with current usage values,
+ * period information, and reset dates for each measurement.
+ */
+export interface UsageReportResponse {
+    /**
+     * Array of usage measurements with current values and period info
+     */
+    data: Array<UsageReportResponse.Data>;
+}
+export declare namespace UsageReportResponse {
+    /**
+     * Recorded usage with period info
+     */
+    interface Data {
+        /**
+         * Unique identifier for the entity
+         */
+        id: string;
+        /**
+         * Timestamp of when the record was created
+         */
+        createdAt: string;
+        /**
+         * Customer id
+         */
+        customerId: string;
+        /**
+         * Feature id
+         */
+        featureId: string;
+        /**
+         * Timestamp
+         */
+        timestamp: string;
+        /**
+         * The usage measurement record
+         */
+        value: number;
+        /**
+         * The current measured usage value
+         */
+        currentUsage?: number | null;
+        /**
+         * The date when the next usage reset will occur
+         */
+        nextResetDate?: string | null;
+        /**
+         * Resource id
+         */
+        resourceId?: string | null;
+        /**
+         * The end date of the usage period in which this measurement resides (for
+         * entitlements with a reset period)
+         */
+        usagePeriodEnd?: string | null;
+        /**
+         * The start date of the usage period in which this measurement resides (for
+         * entitlements with a reset period)
+         */
+        usagePeriodStart?: string | null;
+    }
+}
+export interface UsageHistoryParams {
+    /**
+     * Path param: Customer id
+     */
+    customerId: string;
+    /**
+     * Query param: The start date of the range
+     */
+    startDate: string;
+    /**
+     * Query param: The end date of the range
+     */
+    endDate?: string;
+    /**
+     * Query param
+     */
+    groupBy?: string;
+    /**
+     * Query param: When true, includes usage data from the most recent cancelled or
+     * expired subscription
+     */
+    includeInactiveSubscriptions?: boolean;
+    /**
+     * Query param: Resource id
+     */
+    resourceId?: string | null;
+}
+export interface UsageReportParams {
+    /**
+     * A list of usage reports to be submitted in bulk
+     */
+    usages: Array<UsageReportParams.Usage>;
+}
+export declare namespace UsageReportParams {
+    /**
+     * Single usage measurement
+     */
+    interface Usage {
+        /**
+         * Customer id
+         */
+        customerId: string;
+        /**
+         * Feature id
+         */
+        featureId: string;
+        /**
+         * The value to report for usage
+         */
+        value: number;
+        /**
+         * Timestamp of when the record was created
+         */
+        createdAt?: string;
+        /**
+         * Additional dimensions for the usage report
+         */
+        dimensions?: {
+            [key: string]: string | number | boolean;
+        };
+        /**
+         * Resource id
+         */
+        resourceId?: string | null;
+        /**
+         * The method by which the usage value should be updated
+         */
+        updateBehavior?: 'DELTA' | 'SET';
+    }
+}
+export declare namespace Usage {
+    export { type UsageHistoryResponse as UsageHistoryResponse, type UsageReportResponse as UsageReportResponse, type UsageHistoryParams as UsageHistoryParams, type UsageReportParams as UsageReportParams, };
+}
+//# sourceMappingURL=usage.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"usage.d.mts","sourceRoot":"","sources":["../../src/resources/v1/usage.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,OAAO,CACL,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAKnC;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAG3F;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,EAAE,oBAAoB,CAAC,IAAI,CAAC;CACjC;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE5B;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KAC5B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,IAAI,EAAE,gBAAgB,GAAG,2BAA2B,CAAC;SACtD;QAED;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAE5B;;eAEG;YACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SACzB;QAED,UAAiB,MAAM,CAAC;YACtB;;eAEG;YACH,UAAiB,KAAK;gBACpB;;mBAEG;gBACH,YAAY,EAAE,OAAO,CAAC;gBAEtB;;mBAEG;gBACH,SAAS,EAAE,MAAM,CAAC;gBAElB;;mBAEG;gBACH,KAAK,EAAE,MAAM,CAAC;aACf;YAED;;eAEG;YACH,UAAiB,GAAG;gBAClB;;mBAEG;gBACH,GAAG,EAAE,MAAM,CAAC;gBAEZ;;mBAEG;gBACH,KAAK,EAAE,MAAM,CAAC;aACf;SACF;KACF;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;CACvC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B;;;WAGG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IAEvC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;CACxC;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,UAAU,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE1D;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,cAAc,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC;KAClC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/v1/usage.d.ts

@@ -0,0 +1,238 @@
+import { APIResource } from "../../core/resource.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Operations related to usage & metering
+ */
+export declare class Usage extends APIResource {
+    /**
+     * Retrieves historical usage data for a customer's metered feature over time.
+     */
+    history(featureID: string, params: UsageHistoryParams, options?: RequestOptions): APIPromise<UsageHistoryResponse>;
+    /**
+     * Reports usage measurements for metered features. The reported usage is used to
+     * track, limit, and bill customer consumption.
+     */
+    report(body: UsageReportParams, options?: RequestOptions): APIPromise<UsageReportResponse>;
+}
+/**
+ * Response object
+ */
+export interface UsageHistoryResponse {
+    /**
+     * Historical usage time series
+     */
+    data: UsageHistoryResponse.Data;
+}
+export declare namespace UsageHistoryResponse {
+    /**
+     * Historical usage time series
+     */
+    interface Data {
+        /**
+         * Markers for events that affecting feature usage
+         */
+        markers: Array<Data.Marker>;
+        /**
+         * Series of usage history
+         */
+        series: Array<Data.Series>;
+    }
+    namespace Data {
+        /**
+         * Usage reset or change marker
+         */
+        interface Marker {
+            /**
+             * Timestamp of the marker
+             */
+            timestamp: string;
+            /**
+             * Type of marker for a usage history point
+             */
+            type: 'PERIODIC_RESET' | 'SUBSCRIPTION_CHANGE_RESET';
+        }
+        /**
+         * Usage data points with tags
+         */
+        interface Series {
+            /**
+             * Points in the usage history series
+             */
+            points: Array<Series.Point>;
+            /**
+             * Tags for the usage history series
+             */
+            tags: Array<Series.Tag>;
+        }
+        namespace Series {
+            /**
+             * Single usage data point
+             */
+            interface Point {
+                /**
+                 * Indicates whether there was usage reset in this point, see `markers` for details
+                 */
+                isResetPoint: boolean;
+                /**
+                 * Timestamp of the usage history point
+                 */
+                timestamp: string;
+                /**
+                 * Value of the usage history point
+                 */
+                value: number;
+            }
+            /**
+             * Grouping tag key-value
+             */
+            interface Tag {
+                /**
+                 * Key of the tag
+                 */
+                key: string;
+                /**
+                 * Value of the tag
+                 */
+                value: string;
+            }
+        }
+    }
+}
+/**
+ * Response containing reported usage measurements with current usage values,
+ * period information, and reset dates for each measurement.
+ */
+export interface UsageReportResponse {
+    /**
+     * Array of usage measurements with current values and period info
+     */
+    data: Array<UsageReportResponse.Data>;
+}
+export declare namespace UsageReportResponse {
+    /**
+     * Recorded usage with period info
+     */
+    interface Data {
+        /**
+         * Unique identifier for the entity
+         */
+        id: string;
+        /**
+         * Timestamp of when the record was created
+         */
+        createdAt: string;
+        /**
+         * Customer id
+         */
+        customerId: string;
+        /**
+         * Feature id
+         */
+        featureId: string;
+        /**
+         * Timestamp
+         */
+        timestamp: string;
+        /**
+         * The usage measurement record
+         */
+        value: number;
+        /**
+         * The current measured usage value
+         */
+        currentUsage?: number | null;
+        /**
+         * The date when the next usage reset will occur
+         */
+        nextResetDate?: string | null;
+        /**
+         * Resource id
+         */
+        resourceId?: string | null;
+        /**
+         * The end date of the usage period in which this measurement resides (for
+         * entitlements with a reset period)
+         */
+        usagePeriodEnd?: string | null;
+        /**
+         * The start date of the usage period in which this measurement resides (for
+         * entitlements with a reset period)
+         */
+        usagePeriodStart?: string | null;
+    }
+}
+export interface UsageHistoryParams {
+    /**
+     * Path param: Customer id
+     */
+    customerId: string;
+    /**
+     * Query param: The start date of the range
+     */
+    startDate: string;
+    /**
+     * Query param: The end date of the range
+     */
+    endDate?: string;
+    /**
+     * Query param
+     */
+    groupBy?: string;
+    /**
+     * Query param: When true, includes usage data from the most recent cancelled or
+     * expired subscription
+     */
+    includeInactiveSubscriptions?: boolean;
+    /**
+     * Query param: Resource id
+     */
+    resourceId?: string | null;
+}
+export interface UsageReportParams {
+    /**
+     * A list of usage reports to be submitted in bulk
+     */
+    usages: Array<UsageReportParams.Usage>;
+}
+export declare namespace UsageReportParams {
+    /**
+     * Single usage measurement
+     */
+    interface Usage {
+        /**
+         * Customer id
+         */
+        customerId: string;
+        /**
+         * Feature id
+         */
+        featureId: string;
+        /**
+         * The value to report for usage
+         */
+        value: number;
+        /**
+         * Timestamp of when the record was created
+         */
+        createdAt?: string;
+        /**
+         * Additional dimensions for the usage report
+         */
+        dimensions?: {
+            [key: string]: string | number | boolean;
+        };
+        /**
+         * Resource id
+         */
+        resourceId?: string | null;
+        /**
+         * The method by which the usage value should be updated
+         */
+        updateBehavior?: 'DELTA' | 'SET';
+    }
+}
+export declare namespace Usage {
+    export { type UsageHistoryResponse as UsageHistoryResponse, type UsageReportResponse as UsageReportResponse, type UsageHistoryParams as UsageHistoryParams, type UsageReportParams as UsageReportParams, };
+}
+//# 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":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,OAAO,CACL,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAKnC;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAG3F;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,EAAE,oBAAoB,CAAC,IAAI,CAAC;CACjC;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE5B;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KAC5B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,IAAI,EAAE,gBAAgB,GAAG,2BAA2B,CAAC;SACtD;QAED;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAE5B;;eAEG;YACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SACzB;QAED,UAAiB,MAAM,CAAC;YACtB;;eAEG;YACH,UAAiB,KAAK;gBACpB;;mBAEG;gBACH,YAAY,EAAE,OAAO,CAAC;gBAEtB;;mBAEG;gBACH,SAAS,EAAE,MAAM,CAAC;gBAElB;;mBAEG;gBACH,KAAK,EAAE,MAAM,CAAC;aACf;YAED;;eAEG;YACH,UAAiB,GAAG;gBAClB;;mBAEG;gBACH,GAAG,EAAE,MAAM,CAAC;gBAEZ;;mBAEG;gBACH,KAAK,EAAE,MAAM,CAAC;aACf;SACF;KACF;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;CACvC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B;;;WAGG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IAEvC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;CACxC;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,UAAU,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE1D;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,cAAc,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC;KAClC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/v1/usage.js

@@ -0,0 +1,27 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Usage = void 0;
+const resource_1 = require("../../core/resource.js");
+const path_1 = require("../../internal/utils/path.js");
+/**
+ * Operations related to usage & metering
+ */
+class Usage extends resource_1.APIResource {
+    /**
+     * Retrieves historical usage data for a customer's metered feature over time.
+     */
+    history(featureID, params, options) {
+        const { customerId, ...query } = params;
+        return this._client.get((0, path_1.path) `/api/v1/usage/${customerId}/history/${featureID}`, { query, ...options });
+    }
+    /**
+     * Reports usage measurements for metered features. The reported usage is used to
+     * track, limit, and bill customer consumption.
+     */
+    report(body, options) {
+        return this._client.post('/api/v1/usage', { body, ...options });
+    }
+}
+exports.Usage = Usage;
+//# 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,qDAAkD;AAGlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,KAAM,SAAQ,sBAAW;IACpC;;OAEG;IACH,OAAO,CACL,SAAiB,EACjB,MAA0B,EAC1B,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,iBAAiB,UAAU,YAAY,SAAS,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,IAAuB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;CACF;AApBD,sBAoBC"}