@openmeter/sdk 1.0.0-beta.100 → 1.0.0-beta.102

package/README.md

@@ -114,7 +114,7 @@ const subjects = await openmeter.meters.subjects('my-meter-slug')
 
 #### createToken
 
-Create subject specific tokens.
+Create subject-specific tokens.
 Useful to build consumer dashboards.
 
 ```ts
@@ -141,8 +141,8 @@ Upsert subjects.
 const subjects = await openmeter.subjects.upsert([
   {
     key: 'customer-1',
-    displayName: 'ACME'
-  }
+    displayName: 'ACME',
+  },
 ])
 ```
 
@@ -170,3 +170,169 @@ It doesn't delete corresponding usage.
 ```ts
 await openmeter.subjects.delete('customer-1')
 ```
+
+#### createEntitlement
+
+Create entitlement for a subject.
+Entitlements allow you to manage subject feature access, balances, and usage limits.
+
+```ts
+// 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,
+})
+```
+
+#### listEntitlements
+
+List subject entitlements.
+
+```ts
+const entitlement = await openmeter.subjects.listEntitlements('customer-1')
+```
+
+#### getEntitlement
+
+Get a subject entitlement by ID by Feature ID or by Feature Key.
+
+```ts
+const entitlement = await openmeter.subjects.getEntitlement(
+  'customer-1',
+  'ai_tokens'
+)
+```
+
+#### deleteEntitlement
+
+Delete a subject entitlement by ID by Feature ID or by Feature Key.
+
+```ts
+await openmeter.subjects.deleteEntitlement('customer-1', 'ai_tokens')
+```
+
+#### getEntitlementValue
+
+Get entitlement value by ID by Feature ID or by Feature Key.
+
+```ts
+const value = await openmeter.subjects.getEntitlementValue(
+  'customer-1',
+  'ai_tokens'
+)
+```
+
+#### getEntitlementHistory
+
+Get entitlement history by ID by Feature ID or by Feature Key
+
+```ts
+const entitlement = await openmeter.subjects.getEntitlementHistory(
+  'customer-1',
+  'ai_tokens'
+)
+```
+
+#### resetEntitlementUsage
+
+Reset the entitlement usage and start a new period. Eligible grants will be rolled over.
+
+```ts
+const entitlement = await openmeter.subjects.resetEntitlementUsage(
+  'customer-1',
+  {
+    retainAnchor: true,
+  }
+)
+```
+
+#### createEntitlementGrant
+
+Create a grant for an entitlement.
+
+```ts
+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',
+    },
+  }
+)
+```
+
+#### listEntitlementGrants
+
+List entitlement grants
+
+```ts
+const entitlement = await openmeter.subjects.listEntitlementGrants('customer-1', 'ai_tokens)
+```
+
+## Features
+
+Features are the building blocks of your entitlements, part of your product offering.
+
+#### create
+
+Upsert subjects.
+
+```ts
+const feature = await openmeter.features.create({
+  key: 'ai_tokens',
+  name: 'AI Tokens',
+  // optional
+  meterSlug: 'tokens_total',
+})
+```
+
+#### list
+
+List features.
+
+```ts
+const features = await openmeter.features.list()
+```
+
+#### get
+
+Get feature by key.
+
+```ts
+const feature = await openmeter.features.get('ai_tokens')
+```
+
+#### delete
+
+Delete feature by key.
+
+```ts
+await openmeter.features.delete('ai_tokens')
+```
+
+## Grants
+
+Entitlement grants allow to issue of additional one-time or recurring allowances on a subject's entitlement.
+
+#### list
+
+List grants.
+
+```ts
+const grants = await openmeter.grants.list()
+```

package/dist/cjs/clients/client.cjs

@@ -87,6 +87,9 @@ class BaseClient {
                     searchParams.append(key, item);
                 }
             }
+            else if (typeof value === 'boolean') {
+                searchParams.append(key, value.toString());
+            }
             else if (value instanceof Date) {
                 searchParams.append(key, value.toISOString());
             }

package/dist/cjs/clients/client.d.cts

@@ -28,7 +28,7 @@ export declare class BaseClient {
     }): Promise<T>;
     protected getUrl(path: string, searchParams?: URLSearchParams): import("url").URL;
     protected getAuthHeaders(): IncomingHttpHeaders;
-    protected static toURLSearchParams(params: Record<string, string | number | Date | string[] | Record<string, string> | undefined>): URLSearchParams;
+    protected static toURLSearchParams(params: Record<string, string | boolean | number | Date | string[] | Record<string, string> | undefined>): URLSearchParams;
 }
 export declare class HttpError extends Error {
     statusCode: number;

package/dist/cjs/clients/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../clients/client.ts"],"names":[],"mappings":";;;AACA,mCAA4C;AAuB5C,MAAa,UAAU;IACX,MAAM,CAAiB;IAEjC,YAAY,MAAuB;QACjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAES,KAAK,CAAC,OAAO,CAAI,EACzB,IAAI,EACJ,MAAM,EACN,YAAY,EACZ,OAAO,EACP,IAAI,EACJ,OAAO,GAQR;QACC,eAAe;QACf,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;QAE3C,kBAAkB;QAClB,MAAM,UAAU,GAAwB;YACtC,MAAM,EAAE,kBAAkB;YAC1B,GAAG,OAAO;YACV,GAAG,IAAI,CAAC,cAAc,EAAE;YACxB,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO;YACtB,GAAG,OAAO,EAAE,OAAO;SACpB,CAAA;QACD,MAAM,OAAO,GAAyB;YACpC,MAAM;YACN,OAAO,EAAE,UAAU;SACpB,CAAA;QAED,gBAAgB;QAChB,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;gBAC/D,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAA;YACvD,CAAC;YAED,OAAO,CAAC,IAAI,GAAG,IAAI,CAAA;QACrB,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,IAAA,gBAAO,EAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAExC,iBAAiB;QACjB,IAAI,IAAI,CAAC,UAAU,GAAG,GAAG,EAAE,CAAC;YAC1B,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,0BAA0B,EAAE,CAAC;gBAChE,MAAM,OAAO,GAAG,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAY,CAAA;gBACnD,MAAM,IAAI,SAAS,CAAC;oBAClB,UAAU,EAAE,IAAI,CAAC,UAAU;oBAC3B,OAAO;iBACR,CAAC,CAAA;YACJ,CAAC;YAED,wEAAwE;YACxE,MAAM,IAAI,SAAS,CAAC;gBAClB,UAAU,EAAE,IAAI,CAAC,UAAU;aAC5B,CAAC,CAAA;QACJ,CAAC;QAED,mBAAmB;QACnB,IAAI,IAAI,CAAC,UAAU,KAAK,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,KAAK,GAAG,EAAE,CAAC;YACtE,OAAO,SAAyB,CAAA;QAClC,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,kBAAkB,EAAE,CAAC;YACxD,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAM,CAAA;QACtC,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;QACzC,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,yBAAyB,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC,CAAA;IAC1E,CAAC;IAES,MAAM,CAAC,IAAY,EAAE,YAA8B;QAC3D,IAAI,EAAE,GAAG,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;QACpD,EAAE,GAAG,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;QAClC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,EAAE,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QACxD,OAAO,GAAG,CAAA;IACZ,CAAC;IAES,cAAc;QACtB,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YACtB,OAAO;gBACL,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE;aAC7C,CAAA;QACH,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YACjD,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAClD,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;YACpB,OAAO;gBACL,aAAa,EAAE,SAAS,OAAO,EAAE;aAClC,CAAA;QACH,CAAC;QAED,OAAO,EAAE,CAAA;IACX,CAAC;IAES,MAAM,CAAC,iBAAiB,CAChC,MAA8F;QAE9F,MAAM,YAAY,GAAG,IAAI,eAAe,EAAE,CAAA;QAE1C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAClD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,SAAQ;YACV,CAAC;YAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;oBACzB,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;gBAChC,CAAC;YACH,CAAC;iBAAM,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;gBACjC,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC,CAAA;YAC/C,CAAC;iBAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBACrC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;oBACvC,YAAY,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;gBACxC,CAAC,CAAC,CAAA;YACJ,CAAC;iBAAM,CAAC;gBACN,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;YAC5C,CAAC;QACH,CAAC;QAED,OAAO,YAAY,CAAA;IACrB,CAAC;CACF;AApID,gCAoIC;AAED,MAAa,SAAU,SAAQ,KAAK;IAC3B,UAAU,CAAQ;IAClB,OAAO,CAAU;IAExB,YAAY,EACV,UAAU,EACV,OAAO,GAIR;QACC,KAAK,CAAC,OAAO,EAAE,IAAI,IAAI,wBAAwB,CAAC,CAAA;QAChD,IAAI,CAAC,IAAI,GAAG,WAAW,CAAA;QACvB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;CACF;AAhBD,8BAgBC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../clients/client.ts"],"names":[],"mappings":";;;AACA,mCAA4C;AAuB5C,MAAa,UAAU;IACX,MAAM,CAAiB;IAEjC,YAAY,MAAuB;QACjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAES,KAAK,CAAC,OAAO,CAAI,EACzB,IAAI,EACJ,MAAM,EACN,YAAY,EACZ,OAAO,EACP,IAAI,EACJ,OAAO,GAQR;QACC,eAAe;QACf,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;QAE3C,kBAAkB;QAClB,MAAM,UAAU,GAAwB;YACtC,MAAM,EAAE,kBAAkB;YAC1B,GAAG,OAAO;YACV,GAAG,IAAI,CAAC,cAAc,EAAE;YACxB,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO;YACtB,GAAG,OAAO,EAAE,OAAO;SACpB,CAAA;QACD,MAAM,OAAO,GAAyB;YACpC,MAAM;YACN,OAAO,EAAE,UAAU;SACpB,CAAA;QAED,gBAAgB;QAChB,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;gBAC/D,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAA;YACvD,CAAC;YAED,OAAO,CAAC,IAAI,GAAG,IAAI,CAAA;QACrB,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,IAAA,gBAAO,EAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAExC,iBAAiB;QACjB,IAAI,IAAI,CAAC,UAAU,GAAG,GAAG,EAAE,CAAC;YAC1B,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,0BAA0B,EAAE,CAAC;gBAChE,MAAM,OAAO,GAAG,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAY,CAAA;gBACnD,MAAM,IAAI,SAAS,CAAC;oBAClB,UAAU,EAAE,IAAI,CAAC,UAAU;oBAC3B,OAAO;iBACR,CAAC,CAAA;YACJ,CAAC;YAED,wEAAwE;YACxE,MAAM,IAAI,SAAS,CAAC;gBAClB,UAAU,EAAE,IAAI,CAAC,UAAU;aAC5B,CAAC,CAAA;QACJ,CAAC;QAED,mBAAmB;QACnB,IAAI,IAAI,CAAC,UAAU,KAAK,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,KAAK,GAAG,EAAE,CAAC;YACtE,OAAO,SAAyB,CAAA;QAClC,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,kBAAkB,EAAE,CAAC;YACxD,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAM,CAAA;QACtC,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;QACzC,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,yBAAyB,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC,CAAA;IAC1E,CAAC;IAES,MAAM,CAAC,IAAY,EAAE,YAA8B;QAC3D,IAAI,EAAE,GAAG,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;QACpD,EAAE,GAAG,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;QAClC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,EAAE,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QACxD,OAAO,GAAG,CAAA;IACZ,CAAC;IAES,cAAc;QACtB,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YACtB,OAAO;gBACL,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE;aAC7C,CAAA;QACH,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YACjD,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAClD,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;YACpB,OAAO;gBACL,aAAa,EAAE,SAAS,OAAO,EAAE;aAClC,CAAA;QACH,CAAC;QAED,OAAO,EAAE,CAAA;IACX,CAAC;IAES,MAAM,CAAC,iBAAiB,CAChC,MASC;QAED,MAAM,YAAY,GAAG,IAAI,eAAe,EAAE,CAAA;QAE1C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAClD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,SAAQ;YACV,CAAC;YAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;oBACzB,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;gBAChC,CAAC;YACH,CAAC;iBAAM,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;gBACtC,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;YAC5C,CAAC;iBAAM,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;gBACjC,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC,CAAA;YAC/C,CAAC;iBAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBACrC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;oBACvC,YAAY,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;gBACxC,CAAC,CAAC,CAAA;YACJ,CAAC;iBAAM,CAAC;gBACN,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;YAC5C,CAAC;QACH,CAAC;QAED,OAAO,YAAY,CAAA;IACrB,CAAC;CACF;AA/ID,gCA+IC;AAED,MAAa,SAAU,SAAQ,KAAK;IAC3B,UAAU,CAAQ;IAClB,OAAO,CAAU;IAExB,YAAY,EACV,UAAU,EACV,OAAO,GAIR;QACC,KAAK,CAAC,OAAO,EAAE,IAAI,IAAI,wBAAwB,CAAC,CAAA;QAChD,IAAI,CAAC,IAAI,GAAG,WAAW,CAAA;QACvB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;CACF;AAhBD,8BAgBC"}

package/dist/cjs/clients/entitlement.cjs

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntitlementClient = void 0;
+const client_js_1 = require("./client.cjs");
+class EntitlementClient extends client_js_1.BaseClient {
+    constructor(config) {
+        super(config);
+    }
+    /**
+     * List entitlements
+     * @example
+     * const entitlement = await openmeter.entitlements.list()
+     */
+    async list(params, options) {
+        const searchParams = params
+            ? client_js_1.BaseClient.toURLSearchParams(params)
+            : undefined;
+        return await this.request({
+            path: '/api/v1/entitlements',
+            method: 'GET',
+            searchParams,
+            options,
+        });
+    }
+}
+exports.EntitlementClient = EntitlementClient;
+//# sourceMappingURL=entitlement.js.map

package/dist/cjs/clients/entitlement.d.cts

@@ -0,0 +1,25 @@
+import { components, operations } from '../schemas/openapi.cjs';
+import { RequestOptions, BaseClient, OpenMeterConfig } from './client.cjs';
+export type Entitlement = EntitlementMetered | EntitlementStatic | EntitlementBoolean;
+export type EntitlementMetered = components['schemas']['EntitlementMetered'];
+export type EntitlementStatic = components['schemas']['EntitlementStatic'];
+export type EntitlementBoolean = components['schemas']['EntitlementBoolean'];
+export type RecurringPeriodEnum = components['schemas']['RecurringPeriodEnum'];
+export type EntitlementValue = components['schemas']['EntitlementValue'];
+export type WindowedBalanceHistory = components['schemas']['WindowedBalanceHistory'];
+export type EntitlementCreateInputs = EntitlementMeteredCreateInputs | EntitlementStaticCreateInputs | EntitlementBooleanCreateInputs;
+export type EntitlementMeteredCreateInputs = components['schemas']['EntitlementMeteredCreateInputs'];
+export type EntitlementStaticCreateInputs = components['schemas']['EntitlementStaticCreateInputs'];
+export type EntitlementBooleanCreateInputs = components['schemas']['EntitlementBooleanCreateInputs'];
+export type EntitlementResetInputs = operations['resetEntitlementUsage']['requestBody']['content']['application/json'];
+export type ListEntitlementQueryParams = operations['listEntitlements']['parameters']['query'];
+export type GetEntitlementHistoryQueryParams = operations['getEntitlementHistory']['parameters']['query'];
+export declare class EntitlementClient extends BaseClient {
+    constructor(config: OpenMeterConfig);
+    /**
+     * List entitlements
+     * @example
+     * const entitlement = await openmeter.entitlements.list()
+     */
+    list(params?: ListEntitlementQueryParams, options?: RequestOptions): Promise<Entitlement[]>;
+}

package/dist/cjs/clients/entitlement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entitlement.js","sourceRoot":"","sources":["../../../clients/entitlement.ts"],"names":[],"mappings":";;;AACA,2CAAyE;AA8BzE,MAAa,iBAAkB,SAAQ,sBAAU;IAC/C,YAAY,MAAuB;QACjC,KAAK,CAAC,MAAM,CAAC,CAAA;IACf,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,CACf,MAAmC,EACnC,OAAwB;QAExB,MAAM,YAAY,GAAG,MAAM;YACzB,CAAC,CAAC,sBAAU,CAAC,iBAAiB,CAAC,MAAM,CAAC;YACtC,CAAC,CAAC,SAAS,CAAA;QACb,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,sBAAsB;YAC5B,MAAM,EAAE,KAAK;YACb,YAAY;YACZ,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;CACF;AAxBD,8CAwBC"}

package/dist/cjs/clients/feature.cjs

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FeatureClient = void 0;
+const client_js_1 = require("./client.cjs");
+class FeatureClient extends client_js_1.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
+            ? client_js_1.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,
+        });
+    }
+}
+exports.FeatureClient = FeatureClient;
+//# sourceMappingURL=feature.js.map

package/dist/cjs/clients/feature.d.cts

@@ -0,0 +1,40 @@
+import { components, operations } from '../schemas/openapi.cjs';
+import { RequestOptions, BaseClient, OpenMeterConfig } from './client.cjs';
+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/cjs/clients/feature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"feature.js","sourceRoot":"","sources":["../../../clients/feature.ts"],"names":[],"mappings":";;;AACA,2CAAyE;AAOzE,MAAa,aAAc,SAAQ,sBAAU;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,sBAAU,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;AApFD,sCAoFC"}

package/dist/cjs/clients/grant.cjs

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GrantClient = void 0;
+const client_js_1 = require("./client.cjs");
+class GrantClient extends client_js_1.BaseClient {
+    constructor(config) {
+        super(config);
+    }
+    /**
+     * List grants
+     * @example
+     * const grant = await openmeter.grants.list()
+     */
+    async list(params, options) {
+        const searchParams = params
+            ? client_js_1.BaseClient.toURLSearchParams(params)
+            : undefined;
+        return await this.request({
+            path: '/api/v1/grants',
+            method: 'GET',
+            searchParams,
+            options,
+        });
+    }
+}
+exports.GrantClient = GrantClient;
+//# sourceMappingURL=grant.js.map

package/dist/cjs/clients/grant.d.cts

@@ -0,0 +1,15 @@
+import { components, operations } from '../schemas/openapi.cjs';
+import { RequestOptions, BaseClient, OpenMeterConfig } from './client.cjs';
+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/cjs/clients/grant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"grant.js","sourceRoot":"","sources":["../../../clients/grant.ts"],"names":[],"mappings":";;;AACA,2CAAyE;AAUzE,MAAa,WAAY,SAAQ,sBAAU;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,sBAAU,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;AAxBD,kCAwBC"}

package/dist/cjs/clients/subject.cjs

@@ -55,6 +55,172 @@ class SubjectClient extends client_js_1.BaseClient {
             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
+            ? client_js_1.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
+            ? client_js_1.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
+            ? client_js_1.BaseClient.toURLSearchParams(params)
+            : undefined;
+        return await this.request({
+            path: `/api/v1/subjects/${subjectIdOrKey}/entitlements/${entitlementIdOrFeatureIdOrFeatureKey}/grants`,
+            method: 'GET',
+            searchParams,
+            options,
+        });
+    }
 }
 exports.SubjectClient = SubjectClient;
 //# sourceMappingURL=subject.js.map