@openmeter/sdk 1.0.0-beta.1 → 1.0.0-beta.101

package/dist/clients/feature.d.ts

@@ -0,0 +1,40 @@
+import { components, operations } from '../schemas/openapi.js';
+import { RequestOptions, BaseClient, OpenMeterConfig } from './client.js';
+export type Feature = components['schemas']['Feature'];
+export type FeatureCreateInputs = components['schemas']['FeatureCreateInputs'];
+export type ListFeatureQueryParams = operations['listFeatures']['parameters']['query'];
+export declare class FeatureClient extends BaseClient {
+    constructor(config: OpenMeterConfig);
+    /**
+     * Create Feature
+     * Features are the building blocks of your entitlements, part of your product offering.
+     *
+     * @example
+     * const feature = await openmeter.features.create({
+     *  key: 'ai_tokens',
+     *  name: 'AI Tokens',
+     *  // optional
+     *  meterSlug: 'tokens_total',
+     * })
+     */
+    create(input: FeatureCreateInputs, options?: RequestOptions): Promise<Feature>;
+    /**
+     * Get Feature by ID or Key
+     *
+     * @example
+     * const feature = await openmeter.features.get('ai_tokens')
+     */
+    get(idOrKey: string, options?: RequestOptions): Promise<Feature>;
+    /**
+     * List features
+     * @example
+     * const feature = await openmeter.features.list()
+     */
+    list(params?: ListFeatureQueryParams, options?: RequestOptions): Promise<Feature[]>;
+    /**
+     * Delete feature by ID or Key
+     * @example
+     * await openmeter.delete('ai_tokens')
+     */
+    delete(idOrKey: string, options?: RequestOptions): Promise<void>;
+}

package/dist/clients/feature.js

@@ -0,0 +1,71 @@
+import { BaseClient } from './client.js';
+export class FeatureClient extends BaseClient {
+    constructor(config) {
+        super(config);
+    }
+    /**
+     * Create Feature
+     * Features are the building blocks of your entitlements, part of your product offering.
+     *
+     * @example
+     * const feature = await openmeter.features.create({
+     *  key: 'ai_tokens',
+     *  name: 'AI Tokens',
+     *  // optional
+     *  meterSlug: 'tokens_total',
+     * })
+     */
+    async create(input, options) {
+        return await this.request({
+            path: '/api/v1/features',
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+            },
+            body: JSON.stringify(input),
+            options,
+        });
+    }
+    /**
+     * Get Feature by ID or Key
+     *
+     * @example
+     * const feature = await openmeter.features.get('ai_tokens')
+     */
+    async get(idOrKey, options) {
+        return await this.request({
+            path: `/api/v1/features/${idOrKey}`,
+            method: 'GET',
+            options,
+        });
+    }
+    /**
+     * List features
+     * @example
+     * const feature = await openmeter.features.list()
+     */
+    async list(params, options) {
+        const searchParams = params
+            ? BaseClient.toURLSearchParams(params)
+            : undefined;
+        return await this.request({
+            path: '/api/v1/features',
+            method: 'GET',
+            searchParams,
+            options,
+        });
+    }
+    /**
+     * Delete feature by ID or Key
+     * @example
+     * await openmeter.delete('ai_tokens')
+     */
+    async delete(idOrKey, options) {
+        return await this.request({
+            path: `/api/v1/features/${idOrKey}`,
+            method: 'DELETE',
+            options,
+        });
+    }
+}
+//# sourceMappingURL=feature.js.map

package/dist/clients/feature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"feature.js","sourceRoot":"","sources":["../../clients/feature.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,UAAU,EAAmB,MAAM,aAAa,CAAA;AAOzE,MAAM,OAAO,aAAc,SAAQ,UAAU;IAC3C,YAAY,MAAuB;QACjC,KAAK,CAAC,MAAM,CAAC,CAAA;IACf,CAAC;IAED;;;;;;;;;;;OAWG;IACI,KAAK,CAAC,MAAM,CACjB,KAA0B,EAC1B,OAAwB;QAExB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,kBAAkB;YACxB,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;YAC3B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,GAAG,CACd,OAAe,EACf,OAAwB;QAExB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,oBAAoB,OAAO,EAAE;YACnC,MAAM,EAAE,KAAK;YACb,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,CACf,MAA+B,EAC/B,OAAwB;QAExB,MAAM,YAAY,GAAG,MAAM;YACzB,CAAC,CAAC,UAAU,CAAC,iBAAiB,CAAC,MAAM,CAAC;YACtC,CAAC,CAAC,SAAS,CAAA;QACb,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,kBAAkB;YACxB,MAAM,EAAE,KAAK;YACb,YAAY;YACZ,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,MAAM,CACjB,OAAe,EACf,OAAwB;QAExB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,oBAAoB,OAAO,EAAE;YACnC,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;CACF"}

package/dist/clients/grant.d.ts

@@ -0,0 +1,15 @@
+import { components, operations } from '../schemas/openapi.js';
+import { RequestOptions, BaseClient, OpenMeterConfig } from './client.js';
+export type EntitlementGrant = components['schemas']['EntitlementGrant'];
+export type EntitlementGrantCreateInput = components['schemas']['EntitlementGrantCreateInput'];
+export type ListGrantQueryParams = operations['listGrants']['parameters']['query'];
+export type ListEntitlementGrantQueryParams = operations['listEntitlementGrants']['parameters']['query'];
+export declare class GrantClient extends BaseClient {
+    constructor(config: OpenMeterConfig);
+    /**
+     * List grants
+     * @example
+     * const grant = await openmeter.grants.list()
+     */
+    list(params?: ListGrantQueryParams, options?: RequestOptions): Promise<EntitlementGrant[]>;
+}

package/dist/clients/grant.js

@@ -0,0 +1,23 @@
+import { BaseClient } from './client.js';
+export class GrantClient extends BaseClient {
+    constructor(config) {
+        super(config);
+    }
+    /**
+     * List grants
+     * @example
+     * const grant = await openmeter.grants.list()
+     */
+    async list(params, options) {
+        const searchParams = params
+            ? BaseClient.toURLSearchParams(params)
+            : undefined;
+        return await this.request({
+            path: '/api/v1/grants',
+            method: 'GET',
+            searchParams,
+            options,
+        });
+    }
+}
+//# sourceMappingURL=grant.js.map

package/dist/clients/grant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"grant.js","sourceRoot":"","sources":["../../clients/grant.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,UAAU,EAAmB,MAAM,aAAa,CAAA;AAUzE,MAAM,OAAO,WAAY,SAAQ,UAAU;IACzC,YAAY,MAAuB;QACjC,KAAK,CAAC,MAAM,CAAC,CAAA;IACf,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,CACf,MAA6B,EAC7B,OAAwB;QAExB,MAAM,YAAY,GAAG,MAAM;YACzB,CAAC,CAAC,UAAU,CAAC,iBAAiB,CAAC,MAAM,CAAC;YACtC,CAAC,CAAC,SAAS,CAAA;QACb,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,gBAAgB;YACtB,MAAM,EAAE,KAAK;YACb,YAAY;YACZ,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;CACF"}

package/dist/clients/meter.d.ts

@@ -13,7 +13,11 @@ export declare enum MeterAggregation {
     MAX = "MAX"
 }
 export type MeterQueryParams = {
-    subject?: string;
+    /**
+     * @description Subject(s) to filter by.
+     * @example ["customer-1", "customer-2"]
+     */
+    subject?: string[];
     /**
      * @description Start date.
      * Must be aligned with the window size.
@@ -26,13 +30,28 @@ export type MeterQueryParams = {
      * Inclusive.
      */
     to?: Date;
-    /** @description If not specified, a single usage aggregate will be returned for the entirety of the specified period for each subject and group. */
+    /**
+     * @description Window Size
+     * If not specified, a single usage aggregate will be returned for the entirety of
+     * the specified period for each subject and group.
+     */
     windowSize?: WindowSizeType;
-    /** @description If not specified a single aggregate will be returned for each subject and time window. */
+    /**
+     * @description The value is the name of the time zone as defined in the IANA Time Zone Database (http://www.iana.org/time-zones).
+     * If not specified, the UTC timezone will be used.
+     */
+    windowTimeZone?: string;
+    /**
+     * @description Group By
+     * If not specified a single aggregate will be returned for each subject and time window.
+     */
     groupBy?: string[];
+    /**
+     * @description Filter by group by
+     */
+    filterGroupBy?: Record<string, string>;
 };
-export type MeterQueryResponse = paths['/api/v1/meters/{meterIdOrSlug}/values']['get']['responses']['200']['content']['application/json'];
-export type MeterValue = components['schemas']['MeterValue'];
+export type MeterQueryResponse = paths['/api/v1/meters/{meterIdOrSlug}/query']['get']['responses']['200']['content']['application/json'];
 export type Meter = components['schemas']['Meter'];
 export type WindowSizeType = components['schemas']['WindowSize'];
 export declare class MetersClient extends BaseClient {
@@ -46,7 +65,11 @@ export declare class MetersClient extends BaseClient {
      */
     list(options?: RequestOptions): Promise<Meter[]>;
     /**
-     * Get aggregated values of a meter
+     * Query a meter
+     */
+    query(slug: string, params?: MeterQueryParams, options?: RequestOptions): Promise<MeterQueryResponse>;
+    /**
+     * List subjects of a meter
      */
-    values(slug: string, params?: MeterQueryParams, options?: RequestOptions): Promise<MeterQueryResponse>;
+    subjects(slug: string, options?: RequestOptions): Promise<string[]>;
 }

package/dist/clients/meter.js

@@ -38,15 +38,28 @@ export class MetersClient extends BaseClient {
         });
     }
     /**
-     * Get aggregated values of a meter
+     * Query a meter
      */
-    async values(slug, params, options) {
-        const searchParams = params ? BaseClient.toURLSearchParams(params) : undefined;
+    async query(slug, params, options) {
+        const searchParams = params
+            ? BaseClient.toURLSearchParams(params)
+            : undefined;
         return this.request({
             method: 'GET',
-            path: `/api/v1/meters/${slug}/values`,
+            path: `/api/v1/meters/${slug}/query`,
             searchParams,
             options,
         });
     }
+    /**
+     * List subjects of a meter
+     */
+    async subjects(slug, options) {
+        return this.request({
+            method: 'GET',
+            path: `/api/v1/meters/${slug}/subjects`,
+            options,
+        });
+    }
 }
+//# sourceMappingURL=meter.js.map

package/dist/clients/meter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"meter.js","sourceRoot":"","sources":["../../clients/meter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAmC,MAAM,aAAa,CAAA;AAEzE,MAAM,CAAN,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,+BAAiB,CAAA;IACjB,2BAAa,CAAA;IACb,yBAAW,CAAA;AACb,CAAC,EAJW,UAAU,KAAV,UAAU,QAIrB;AAED,MAAM,CAAN,IAAY,gBAMX;AAND,WAAY,gBAAgB;IAC1B,+BAAW,CAAA;IACX,mCAAe,CAAA;IACf,+BAAW,CAAA;IACX,+BAAW,CAAA;IACX,+BAAW,CAAA;AACb,CAAC,EANW,gBAAgB,KAAhB,gBAAgB,QAM3B;AAgDD,MAAM,OAAO,YAAa,SAAQ,UAAU;IAC1C,YAAY,MAAuB;QACjC,KAAK,CAAC,MAAM,CAAC,CAAA;IACf,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,GAAG,CAAC,IAAY,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAQ;YACzB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,kBAAkB,IAAI,EAAE;YAC9B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI,CAAC,OAAwB;QACxC,OAAO,IAAI,CAAC,OAAO,CAAU;YAC3B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,gBAAgB;YACtB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,KAAK,CAChB,IAAY,EACZ,MAAyB,EACzB,OAAwB;QAExB,MAAM,YAAY,GAAG,MAAM;YACzB,CAAC,CAAC,UAAU,CAAC,iBAAiB,CAAC,MAAM,CAAC;YACtC,CAAC,CAAC,SAAS,CAAA;QACb,OAAO,IAAI,CAAC,OAAO,CAAqB;YACtC,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,kBAAkB,IAAI,QAAQ;YACpC,YAAY;YACZ,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,QAAQ,CACnB,IAAY,EACZ,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAW;YAC5B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,kBAAkB,IAAI,WAAW;YACvC,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;CACF"}

package/dist/clients/portal.d.ts

@@ -0,0 +1,22 @@
+import { components } from '../schemas/openapi.js';
+import { RequestOptions, BaseClient, OpenMeterConfig } from './client.js';
+export type PortalToken = components['schemas']['PortalToken'];
+export declare class PortalClient extends BaseClient {
+    constructor(config: OpenMeterConfig);
+    /**
+     * Create portal token
+     * Useful for creating a token sharable with your customer to query their own usage
+     */
+    createToken(token: {
+        subject: string;
+        expiresAt?: Date;
+        allowedMeterSlugs?: string[];
+    }, options?: RequestOptions): Promise<PortalToken>;
+    /**
+     * Invalidate portal token
+     * @note OpenMeter Cloud only feature
+     */
+    invalidateTokens(invalidate?: {
+        subject?: string;
+    }, options?: RequestOptions): Promise<void>;
+}

package/dist/clients/portal.js

@@ -0,0 +1,37 @@
+import { BaseClient } from './client.js';
+export class PortalClient extends BaseClient {
+    constructor(config) {
+        super(config);
+    }
+    /**
+     * Create portal token
+     * Useful for creating a token sharable with your customer to query their own usage
+     */
+    async createToken(token, options) {
+        return await this.request({
+            path: '/api/v1/portal/tokens',
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+            },
+            body: JSON.stringify(token),
+            options,
+        });
+    }
+    /**
+     * Invalidate portal token
+     * @note OpenMeter Cloud only feature
+     */
+    async invalidateTokens(invalidate = {}, options) {
+        return await this.request({
+            path: '/api/v1/portal/tokens/invalidate',
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+            },
+            body: JSON.stringify(invalidate),
+            options,
+        });
+    }
+}
+//# sourceMappingURL=portal.js.map

package/dist/clients/portal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"portal.js","sourceRoot":"","sources":["../../clients/portal.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,UAAU,EAAmB,MAAM,aAAa,CAAA;AAIzE,MAAM,OAAO,YAAa,SAAQ,UAAU;IAC1C,YAAY,MAAuB;QACjC,KAAK,CAAC,MAAM,CAAC,CAAA;IACf,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,WAAW,CACtB,KAIC,EACD,OAAwB;QAExB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,uBAAuB;YAC7B,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;YAC3B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,gBAAgB,CAC3B,aAAmC,EAAE,EACrC,OAAwB;QAExB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,kCAAkC;YACxC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC;YAChC,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;CACF"}

package/dist/clients/subject.d.ts

@@ -0,0 +1,117 @@
+import { components } from '../schemas/openapi.js';
+import { RequestOptions, BaseClient, OpenMeterConfig } from './client.js';
+import { Entitlement, EntitlementCreateInputs, EntitlementResetInputs, EntitlementValue, GetEntitlementHistoryQueryParams, ListEntitlementQueryParams, WindowedBalanceHistory } from './entitlement.js';
+import { EntitlementGrant, EntitlementGrantCreateInput, ListEntitlementGrantQueryParams } from './grant.js';
+export type Subject = components['schemas']['Subject'];
+export declare class SubjectClient extends BaseClient {
+    constructor(config: OpenMeterConfig);
+    /**
+     * Upsert subject
+     * Useful to map display name and metadata to subjects
+     * @note OpenMeter Cloud only feature
+     */
+    upsert(subject: Omit<Subject, 'id'>[], options?: RequestOptions): Promise<Subject[]>;
+    /**
+     * Get subject by id or key
+     * @note OpenMeter Cloud only feature
+     */
+    get(idOrKey: string, options?: RequestOptions): Promise<Subject>;
+    /**
+     * List subjects
+     * @note OpenMeter Cloud only feature
+     */
+    list(options?: RequestOptions): Promise<Subject[]>;
+    /**
+     * Delete subject by id or key
+     * @note OpenMeter Cloud only feature
+     */
+    delete(idOrKey: string, options?: RequestOptions): Promise<void>;
+    /** Entitlements **/
+    /**
+     * Create Entitlement
+     * Entitlements allows you to manage subject feature access, balances, and usage limits.
+     *
+     * @example
+     * // Issue 10,000,000 tokens every month
+     * const entitlement = await openmeter.subjects.createEntitlement('customer-1', {
+     *    type: 'metered',
+     *    featureKey: 'ai_tokens',
+     *    usagePeriod: {
+     *      interval: 'MONTH',
+     *    },
+     *    issueAfterReset: 10000000,
+     * })
+     */
+    createEntitlement(subjectIdOrKey: string, input: EntitlementCreateInputs, options?: RequestOptions): Promise<Entitlement>;
+    /**
+     * List entitlements
+     * @example
+     * const entitlement = await openmeter.subjects.listEntitlements('customer-1')
+     */
+    listEntitlements(subjectIdOrKey: string, params?: ListEntitlementQueryParams, options?: RequestOptions): Promise<Entitlement[]>;
+    /**
+     * Get entitlement by ID by Feature ID or by Feature Key
+     *
+     * @example
+     * const entitlement = await openmeter.subjects.getEntitlement('customer-1', 'ai_tokens')
+     */
+    getEntitlement(subjectIdOrKey: string, entitlementIdOrFeatureIdOrFeatureKey: string, options?: RequestOptions): Promise<Entitlement>;
+    /**
+     * Delete entitlement by ID by Feature ID or by Feature Key
+     * @example
+     * await openmeter.deleteEntitlement('customer-1', 'ai_tokens')
+     */
+    deleteEntitlement(subjectIdOrKey: string, entitlementIdOrFeatureIdOrFeatureKey: string, options?: RequestOptions): Promise<void>;
+    /**
+     * Get entitlement value by ID by Feature ID or by Feature Key
+     *
+     * @example
+     * const value = await openmeter.subjects.getEntitlementValue('customer-1', 'ai_tokens')
+     */
+    getEntitlementValue(subjectIdOrKey: string, entitlementIdOrFeatureIdOrFeatureKey: string, options?: RequestOptions): Promise<EntitlementValue>;
+    /**
+     * Get entitlement history by ID by Feature ID or by Feature Key
+     * @example
+     * const entitlement = await openmeter.subjects.getEntitlementHistory('customer-1', 'ai_tokens')
+     */
+    getEntitlementHistory(subjectIdOrKey: string, entitlementIdOrFeatureIdOrFeatureKey: string, params?: GetEntitlementHistoryQueryParams, options?: RequestOptions): Promise<WindowedBalanceHistory[]>;
+    /**
+     * Reset Entitlement Usage
+     * Reset the entitlement usage and start a new period. Eligible grants will be rolled over
+     *
+     * @example
+     * const entitlement = await openmeter.subjects.resetEntitlementUsage('customer-1', 'ai_tokens', {
+     *    retainAnchor: true
+     * })
+     */
+    resetEntitlementUsage(subjectIdOrKey: string, entitlementIdOrFeatureIdOrFeatureKey: string, input: EntitlementResetInputs, options?: RequestOptions): Promise<Entitlement>;
+    /** Entitlement Grant **/
+    /**
+     * Create Entitlement Grant
+     * Create a grant for an entitlement.
+     *
+     * @example
+     * const grant = await openmeter.subjects.createEntitlementGrant('customer-1', 'ai_tokens', {
+     *    amount: 100,
+     *    priority: 1,
+     *    effectiveAt: '2023-01-01T00:00:00Z',
+     *    expiration: {
+     *      duration: 'HOUR',
+     *      count: 12,
+     *    },
+     *    minRolloverAmount: 100,
+     *    maxRolloverAmount: 100,
+     *    recurrence: {
+     *      interval: 'MONTH',
+     *      anchor: '2024-06-28T18:29:44.867Z',
+     *    },
+     * })
+     */
+    createEntitlementGrant(subjectIdOrKey: string, entitlementIdOrFeatureIdOrFeatureKey: string, input: EntitlementGrantCreateInput, options?: RequestOptions): Promise<EntitlementGrant>;
+    /**
+     * List entitlement grants
+     * @example
+     * const entitlement = await openmeter.subjects.listEntitlementGrants('customer-1', 'ai_tokens)
+     */
+    listEntitlementGrants(subjectIdOrKey: string, entitlementIdOrFeatureIdOrFeatureKey: string, params?: ListEntitlementGrantQueryParams, options?: RequestOptions): Promise<EntitlementGrant[]>;
+}

package/dist/clients/subject.js

@@ -0,0 +1,222 @@
+import { BaseClient } from './client.js';
+export class SubjectClient extends BaseClient {
+    constructor(config) {
+        super(config);
+    }
+    /**
+     * Upsert subject
+     * Useful to map display name and metadata to subjects
+     * @note OpenMeter Cloud only feature
+     */
+    async upsert(subject, options) {
+        return await this.request({
+            path: '/api/v1/subjects',
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+            },
+            body: JSON.stringify(subject),
+            options,
+        });
+    }
+    /**
+     * Get subject by id or key
+     * @note OpenMeter Cloud only feature
+     */
+    async get(idOrKey, options) {
+        return await this.request({
+            path: `/api/v1/subjects/${idOrKey}`,
+            method: 'GET',
+            options,
+        });
+    }
+    /**
+     * List subjects
+     * @note OpenMeter Cloud only feature
+     */
+    async list(options) {
+        return await this.request({
+            path: '/api/v1/subjects',
+            method: 'GET',
+            options,
+        });
+    }
+    /**
+     * Delete subject by id or key
+     * @note OpenMeter Cloud only feature
+     */
+    async delete(idOrKey, options) {
+        return await this.request({
+            path: `/api/v1/subjects/${idOrKey}`,
+            method: 'DELETE',
+            options,
+        });
+    }
+    /** Entitlements **/
+    /**
+     * Create Entitlement
+     * Entitlements allows you to manage subject feature access, balances, and usage limits.
+     *
+     * @example
+     * // Issue 10,000,000 tokens every month
+     * const entitlement = await openmeter.subjects.createEntitlement('customer-1', {
+     *    type: 'metered',
+     *    featureKey: 'ai_tokens',
+     *    usagePeriod: {
+     *      interval: 'MONTH',
+     *    },
+     *    issueAfterReset: 10000000,
+     * })
+     */
+    async createEntitlement(subjectIdOrKey, input, options) {
+        return await this.request({
+            path: `/api/v1/subjects/${subjectIdOrKey}/entitlements`,
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+            },
+            body: JSON.stringify(input),
+            options,
+        });
+    }
+    /**
+     * List entitlements
+     * @example
+     * const entitlement = await openmeter.subjects.listEntitlements('customer-1')
+     */
+    async listEntitlements(subjectIdOrKey, params, options) {
+        const searchParams = params
+            ? BaseClient.toURLSearchParams(params)
+            : undefined;
+        return await this.request({
+            path: `/api/v1/subjects/${subjectIdOrKey}/entitlements`,
+            method: 'GET',
+            searchParams,
+            options,
+        });
+    }
+    /**
+     * Get entitlement by ID by Feature ID or by Feature Key
+     *
+     * @example
+     * const entitlement = await openmeter.subjects.getEntitlement('customer-1', 'ai_tokens')
+     */
+    async getEntitlement(subjectIdOrKey, entitlementIdOrFeatureIdOrFeatureKey, options) {
+        return await this.request({
+            path: `/api/v1/subjects/${subjectIdOrKey}/entitlements/${entitlementIdOrFeatureIdOrFeatureKey}`,
+            method: 'GET',
+            options,
+        });
+    }
+    /**
+     * Delete entitlement by ID by Feature ID or by Feature Key
+     * @example
+     * await openmeter.deleteEntitlement('customer-1', 'ai_tokens')
+     */
+    async deleteEntitlement(subjectIdOrKey, entitlementIdOrFeatureIdOrFeatureKey, options) {
+        return await this.request({
+            path: `/api/v1/subjects/${subjectIdOrKey}/entitlements/${entitlementIdOrFeatureIdOrFeatureKey}`,
+            method: 'DELETE',
+            options,
+        });
+    }
+    /**
+     * Get entitlement value by ID by Feature ID or by Feature Key
+     *
+     * @example
+     * const value = await openmeter.subjects.getEntitlementValue('customer-1', 'ai_tokens')
+     */
+    async getEntitlementValue(subjectIdOrKey, entitlementIdOrFeatureIdOrFeatureKey, options) {
+        return await this.request({
+            path: `/api/v1/subjects/${subjectIdOrKey}/entitlements/${entitlementIdOrFeatureIdOrFeatureKey}/value`,
+            method: 'GET',
+            options,
+        });
+    }
+    /**
+     * Get entitlement history by ID by Feature ID or by Feature Key
+     * @example
+     * const entitlement = await openmeter.subjects.getEntitlementHistory('customer-1', 'ai_tokens')
+     */
+    async getEntitlementHistory(subjectIdOrKey, entitlementIdOrFeatureIdOrFeatureKey, params, options) {
+        const searchParams = params
+            ? BaseClient.toURLSearchParams(params)
+            : undefined;
+        return await this.request({
+            path: `/api/v1/subjects/${subjectIdOrKey}/entitlements/${entitlementIdOrFeatureIdOrFeatureKey}/history`,
+            method: 'GET',
+            searchParams,
+            options,
+        });
+    }
+    /**
+     * Reset Entitlement Usage
+     * Reset the entitlement usage and start a new period. Eligible grants will be rolled over
+     *
+     * @example
+     * const entitlement = await openmeter.subjects.resetEntitlementUsage('customer-1', 'ai_tokens', {
+     *    retainAnchor: true
+     * })
+     */
+    async resetEntitlementUsage(subjectIdOrKey, entitlementIdOrFeatureIdOrFeatureKey, input, options) {
+        return await this.request({
+            path: `/api/v1/subjects/${subjectIdOrKey}/entitlements/${entitlementIdOrFeatureIdOrFeatureKey}/reset`,
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+            },
+            body: JSON.stringify(input),
+            options,
+        });
+    }
+    /** Entitlement Grant **/
+    /**
+     * Create Entitlement Grant
+     * Create a grant for an entitlement.
+     *
+     * @example
+     * const grant = await openmeter.subjects.createEntitlementGrant('customer-1', 'ai_tokens', {
+     *    amount: 100,
+     *    priority: 1,
+     *    effectiveAt: '2023-01-01T00:00:00Z',
+     *    expiration: {
+     *      duration: 'HOUR',
+     *      count: 12,
+     *    },
+     *    minRolloverAmount: 100,
+     *    maxRolloverAmount: 100,
+     *    recurrence: {
+     *      interval: 'MONTH',
+     *      anchor: '2024-06-28T18:29:44.867Z',
+     *    },
+     * })
+     */
+    async createEntitlementGrant(subjectIdOrKey, entitlementIdOrFeatureIdOrFeatureKey, input, options) {
+        return await this.request({
+            path: `/api/v1/subjects/${subjectIdOrKey}/entitlements/${entitlementIdOrFeatureIdOrFeatureKey}/grants`,
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+            },
+            body: JSON.stringify(input),
+            options,
+        });
+    }
+    /**
+     * List entitlement grants
+     * @example
+     * const entitlement = await openmeter.subjects.listEntitlementGrants('customer-1', 'ai_tokens)
+     */
+    async listEntitlementGrants(subjectIdOrKey, entitlementIdOrFeatureIdOrFeatureKey, params, options) {
+        const searchParams = params
+            ? BaseClient.toURLSearchParams(params)
+            : undefined;
+        return await this.request({
+            path: `/api/v1/subjects/${subjectIdOrKey}/entitlements/${entitlementIdOrFeatureIdOrFeatureKey}/grants`,
+            method: 'GET',
+            searchParams,
+            options,
+        });
+    }
+}
+//# sourceMappingURL=subject.js.map

package/dist/clients/subject.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subject.js","sourceRoot":"","sources":["../../clients/subject.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,UAAU,EAAmB,MAAM,aAAa,CAAA;AAkBzE,MAAM,OAAO,aAAc,SAAQ,UAAU;IAC3C,YAAY,MAAuB;QACjC,KAAK,CAAC,MAAM,CAAC,CAAA;IACf,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,MAAM,CACjB,OAA8B,EAC9B,OAAwB;QAExB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,kBAAkB;YACxB,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC7B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,GAAG,CACd,OAAe,EACf,OAAwB;QAExB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,oBAAoB,OAAO,EAAE;YACnC,MAAM,EAAE,KAAK;YACb,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI,CAAC,OAAwB;QACxC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,kBAAkB;YACxB,MAAM,EAAE,KAAK;YACb,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM,CACjB,OAAe,EACf,OAAwB;QAExB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,oBAAoB,OAAO,EAAE;YACnC,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED,oBAAoB;IAEpB;;;;;;;;;;;;;;OAcG;IACI,KAAK,CAAC,iBAAiB,CAC5B,cAAsB,EACtB,KAA8B,EAC9B,OAAwB;QAExB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,oBAAoB,cAAc,eAAe;YACvD,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;YAC3B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,gBAAgB,CAC3B,cAAsB,EACtB,MAAmC,EACnC,OAAwB;QAExB,MAAM,YAAY,GAAG,MAAM;YACzB,CAAC,CAAC,UAAU,CAAC,iBAAiB,CAAC,MAAM,CAAC;YACtC,CAAC,CAAC,SAAS,CAAA;QACb,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,oBAAoB,cAAc,eAAe;YACvD,MAAM,EAAE,KAAK;YACb,YAAY;YACZ,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,cAAc,CACzB,cAAsB,EACtB,oCAA4C,EAC5C,OAAwB;QAExB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,oBAAoB,cAAc,iBAAiB,oCAAoC,EAAE;YAC/F,MAAM,EAAE,KAAK;YACb,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,iBAAiB,CAC5B,cAAsB,EACtB,oCAA4C,EAC5C,OAAwB;QAExB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,oBAAoB,cAAc,iBAAiB,oCAAoC,EAAE;YAC/F,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,mBAAmB,CAC9B,cAAsB,EACtB,oCAA4C,EAC5C,OAAwB;QAExB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,oBAAoB,cAAc,iBAAiB,oCAAoC,QAAQ;YACrG,MAAM,EAAE,KAAK;YACb,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,qBAAqB,CAChC,cAAsB,EACtB,oCAA4C,EAC5C,MAAyC,EACzC,OAAwB;QAExB,MAAM,YAAY,GAAG,MAAM;YACzB,CAAC,CAAC,UAAU,CAAC,iBAAiB,CAAC,MAAM,CAAC;YACtC,CAAC,CAAC,SAAS,CAAA;QACb,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,oBAAoB,cAAc,iBAAiB,oCAAoC,UAAU;YACvG,MAAM,EAAE,KAAK;YACb,YAAY;YACZ,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,qBAAqB,CAChC,cAAsB,EACtB,oCAA4C,EAC5C,KAA6B,EAC7B,OAAwB;QAExB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,oBAAoB,cAAc,iBAAiB,oCAAoC,QAAQ;YACrG,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;YAC3B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED,yBAAyB;IAEzB;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,KAAK,CAAC,sBAAsB,CACjC,cAAsB,EACtB,oCAA4C,EAC5C,KAAkC,EAClC,OAAwB;QAExB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,oBAAoB,cAAc,iBAAiB,oCAAoC,SAAS;YACtG,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;YAC3B,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,qBAAqB,CAChC,cAAsB,EACtB,oCAA4C,EAC5C,MAAwC,EACxC,OAAwB;QAExB,MAAM,YAAY,GAAG,MAAM;YACzB,CAAC,CAAC,UAAU,CAAC,iBAAiB,CAAC,MAAM,CAAC;YACtC,CAAC,CAAC,SAAS,CAAA;QACb,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,oBAAoB,cAAc,iBAAiB,oCAAoC,SAAS;YACtG,MAAM,EAAE,KAAK;YACb,YAAY;YACZ,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;CACF"}