@openmeter/sdk 1.0.0-beta.13 → 1.0.0-beta.130

package/dist/clients/subject.js

@@ -0,0 +1,238 @@
+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.
+     * @remarks
+     * Input should be either `EntitlementMeteredCreateInputs`, `EntitlementStaticCreateInputs`, or `EntitlementBooleanCreateInputs`
+     * @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 of a subject
+     * @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
+     *
+     * @example
+     * const entitlement = await openmeter.subjects.getEntitlement('customer-1', '01J1SD3QDV86GP77TQ4PZZ4EXE')
+     */
+    async getEntitlement(subjectIdOrKey, entitlementId, options) {
+        return await this.request({
+            path: `/api/v1/subjects/${subjectIdOrKey}/entitlements/${entitlementId}`,
+            method: 'GET',
+            options,
+        });
+    }
+    /**
+     * Delete entitlement
+     * @example
+     * await openmeter.deleteEntitlement('customer-1', '01J1SD3QDV86GP77TQ4PZZ4EXE')
+     */
+    async deleteEntitlement(subjectIdOrKey, entitlementId, options) {
+        return await this.request({
+            path: `/api/v1/subjects/${subjectIdOrKey}/entitlements/${entitlementId}`,
+            method: 'DELETE',
+            options,
+        });
+    }
+    /**
+     * Get entitlement value by ID or Feature Key
+     *
+     * @example
+     * const value = await openmeter.subjects.getEntitlementValue('customer-1', 'ai_tokens')
+     */
+    async getEntitlementValue(subjectIdOrKey, entitlementIdOrFeatureKey, options) {
+        return await this.request({
+            path: `/api/v1/subjects/${subjectIdOrKey}/entitlements/${entitlementIdOrFeatureKey}/value`,
+            method: 'GET',
+            options,
+        });
+    }
+    /**
+     * Get entitlement value at a specific time.
+     *
+     * @example
+     * const value = await openmeter.subjects.getEntitlementValueAt('customer-1', 'ai_tokens', new Date('2024-01-01'))
+     */
+    async getEntitlementValueAt(subjectIdOrKey, entitlementIdOrFeatureKey, at, options) {
+        const searchParams = BaseClient.toURLSearchParams({ time: at });
+        return await this.request({
+            path: `/api/v1/subjects/${subjectIdOrKey}/entitlements/${entitlementIdOrFeatureKey}/value`,
+            method: 'GET',
+            options,
+            searchParams,
+        });
+    }
+    /**
+     * Get entitlement history
+     * @example
+     * const entitlement = await openmeter.subjects.getEntitlementHistory('customer-1', '01J1SD3QDV86GP77TQ4PZZ4EXE')
+     */
+    async getEntitlementHistory(subjectIdOrKey, entitlementId, params, options) {
+        const searchParams = params
+            ? BaseClient.toURLSearchParams(params)
+            : undefined;
+        return await this.request({
+            path: `/api/v1/subjects/${subjectIdOrKey}/entitlements/${entitlementId}/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', '01J1SD3QDV86GP77TQ4PZZ4EXE', {
+     *    retainAnchor: true
+     * })
+     */
+    async resetEntitlementUsage(subjectIdOrKey, entitlementId, input, options) {
+        return await this.request({
+            path: `/api/v1/subjects/${subjectIdOrKey}/entitlements/${entitlementId}/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', '01J1SD3QDV86GP77TQ4PZZ4EXE', {
+     *    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, entitlementIdOrFeatureKey, input, options) {
+        return await this.request({
+            path: `/api/v1/subjects/${subjectIdOrKey}/entitlements/${entitlementIdOrFeatureKey}/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', '01J1SD3QDV86GP77TQ4PZZ4EXE')
+     */
+    async listEntitlementGrants(subjectIdOrKey, entitlementIdOrFeatureKey, params, options) {
+        const searchParams = params
+            ? BaseClient.toURLSearchParams(params)
+            : undefined;
+        return await this.request({
+            path: `/api/v1/subjects/${subjectIdOrKey}/entitlements/${entitlementIdOrFeatureKey}/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;;;;;;;;;;;;;;;OAeG;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,aAAqB,EACrB,OAAwB;QAExB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,oBAAoB,cAAc,iBAAiB,aAAa,EAAE;YACxE,MAAM,EAAE,KAAK;YACb,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,iBAAiB,CAC5B,cAAsB,EACtB,aAAqB,EACrB,OAAwB;QAExB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,oBAAoB,cAAc,iBAAiB,aAAa,EAAE;YACxE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,mBAAmB,CAC9B,cAAsB,EACtB,yBAAiC,EACjC,OAAwB;QAExB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,oBAAoB,cAAc,iBAAiB,yBAAyB,QAAQ;YAC1F,MAAM,EAAE,KAAK;YACb,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,qBAAqB,CAChC,cAAsB,EACtB,yBAAiC,EACjC,EAAQ,EACR,OAAwB;QAExB,MAAM,YAAY,GAAG,UAAU,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAA;QAC/D,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,oBAAoB,cAAc,iBAAiB,yBAAyB,QAAQ;YAC1F,MAAM,EAAE,KAAK;YACb,OAAO;YACP,YAAY;SACb,CAAC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,qBAAqB,CAChC,cAAsB,EACtB,aAAqB,EACrB,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,aAAa,UAAU;YAChF,MAAM,EAAE,KAAK;YACb,YAAY;YACZ,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,qBAAqB,CAChC,cAAsB,EACtB,aAAqB,EACrB,KAA6B,EAC7B,OAAwB;QAExB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,oBAAoB,cAAc,iBAAiB,aAAa,QAAQ;YAC9E,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,yBAAiC,EACjC,KAAkC,EAClC,OAAwB;QAExB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,oBAAoB,cAAc,iBAAiB,yBAAyB,SAAS;YAC3F,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,yBAAiC,EACjC,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,yBAAyB,SAAS;YAC3F,MAAM,EAAE,KAAK;YACb,YAAY;YACZ,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;CACF"}

package/dist/index.d.ts

@@ -1,12 +1,21 @@
 import { OpenMeterConfig } from './clients/client.js';
+import { EntitlementClient } from './clients/entitlement.js';
 import { EventsClient } from './clients/event.js';
+import { FeatureClient } from './clients/feature.js';
+import { GrantClient } from './clients/grant.js';
 import { MetersClient } from './clients/meter.js';
+import { PortalClient } from './clients/portal.js';
+import { SubjectClient } from './clients/subject.js';
 export { OpenMeterConfig, RequestOptions } from './clients/client.js';
-export { Event } from './clients/event.js';
+export { Event, IngestedEvent, CloudEvent } from './clients/event.js';
 export { Meter, MeterAggregation, WindowSize } from './clients/meter.js';
-export { createOpenAIStreamCallback } from './next.js';
 export declare class OpenMeter {
     events: EventsClient;
     meters: MetersClient;
+    portal: PortalClient;
+    subjects: SubjectClient;
+    features: FeatureClient;
+    entitlements: EntitlementClient;
+    grants: GrantClient;
     constructor(config: OpenMeterConfig);
 }

package/dist/index.js

@@ -1,12 +1,27 @@
+import { EntitlementClient } from './clients/entitlement.js';
 import { EventsClient } from './clients/event.js';
+import { FeatureClient } from './clients/feature.js';
+import { GrantClient } from './clients/grant.js';
 import { MetersClient } from './clients/meter.js';
+import { PortalClient } from './clients/portal.js';
+import { SubjectClient } from './clients/subject.js';
 export { MeterAggregation, WindowSize } from './clients/meter.js';
-export { createOpenAIStreamCallback } from './next.js';
 export class OpenMeter {
     events;
     meters;
+    portal;
+    subjects;
+    features;
+    entitlements;
+    grants;
     constructor(config) {
         this.events = new EventsClient(config);
         this.meters = new MetersClient(config);
+        this.portal = new PortalClient(config);
+        this.subjects = new SubjectClient(config);
+        this.features = new FeatureClient(config);
+        this.entitlements = new EntitlementClient(config);
+        this.grants = new GrantClient(config);
     }
 }
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AAIpD,OAAO,EAAS,gBAAgB,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAExE,MAAM,OAAO,SAAS;IACb,MAAM,CAAc;IACpB,MAAM,CAAc;IACpB,MAAM,CAAc;IACpB,QAAQ,CAAe;IACvB,QAAQ,CAAe;IACvB,YAAY,CAAmB;IAC/B,MAAM,CAAa;IAE1B,YAAY,MAAuB;QACjC,IAAI,CAAC,MAAM,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,CAAA;QACtC,IAAI,CAAC,MAAM,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,CAAA;QACtC,IAAI,CAAC,MAAM,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,CAAA;QACtC,IAAI,CAAC,QAAQ,GAAG,IAAI,aAAa,CAAC,MAAM,CAAC,CAAA;QACzC,IAAI,CAAC,QAAQ,GAAG,IAAI,aAAa,CAAC,MAAM,CAAC,CAAA;QACzC,IAAI,CAAC,YAAY,GAAG,IAAI,iBAAiB,CAAC,MAAM,CAAC,CAAA;QACjD,IAAI,CAAC,MAAM,GAAG,IAAI,WAAW,CAAC,MAAM,CAAC,CAAA;IACvC,CAAC;CACF"}