@openmeter/sdk 1.0.0-beta.22 → 1.0.0-beta.221

package/dist/cjs/src/client/entitlements.cjs

@@ -0,0 +1,281 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Grants = exports.Entitlements = void 0;
+const utils_js_1 = require("./utils.cjs");
+/**
+ * Entitlements
+ * @description With Entitlements, you can define and enforce usage limits, implement quota-based pricing, and manage access to features in your application.
+ */
+class Entitlements {
+    client;
+    grants;
+    constructor(client) {
+        this.client = client;
+        this.grants = new Grants(client);
+    }
+    /**
+     * Create an entitlement
+     *
+     *     - Boolean entitlements define static feature access, e.g. "Can use SSO authentication".
+     *     - Static entitlements let you pass along a configuration while granting access, e.g. "Using this feature with X Y settings" (passed in the config).
+     *     - Metered entitlements have many use cases, from setting up usage-based access to implementing complex credit systems.  Example: The customer can use 10000 AI tokens during the usage period of the entitlement.
+     *
+     *     A given subject can only have one active (non-deleted) entitlement per featureKey. If you try to create a new entitlement for a featureKey that already has an active entitlement, the request will fail with a 409 error.
+     *
+     *     Once an entitlement is created you cannot modify it, only delete it.
+     *
+     * @param subjectIdOrKey - The ID or key of the subject
+     * @param entitlement - The entitlement to create
+     * @param signal - An optional abort signal
+     * @returns The created entitlement
+     */
+    async create(subjectIdOrKey, entitlement, options) {
+        const resp = await this.client.POST('/api/v1/subjects/{subjectIdOrKey}/entitlements', {
+            body: entitlement,
+            params: {
+                path: {
+                    subjectIdOrKey: subjectIdOrKey,
+                },
+            },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Get an entitlement by ID
+     *
+     * @param id - The ID of the entitlement
+     * @param signal - An optional abort signal
+     * @returns The entitlement
+     */
+    async get(id, options) {
+        const resp = await this.client.GET('/api/v1/entitlements/{entitlementId}', {
+            params: {
+                path: {
+                    entitlementId: id,
+                },
+            },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * List entitlements
+     *
+     * @param query - The query parameters
+     * @param signal - An optional abort signal
+     * @returns The entitlements
+     */
+    async list(query, options) {
+        const resp = await this.client.GET('/api/v1/entitlements', {
+            params: {
+                query,
+            },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Delete an entitlement
+     *
+     * @param subjectIdOrKey - The ID or key of the subject
+     * @param entitlementId - The ID of the entitlement
+     * @param signal - An optional abort signal
+     * @returns The deleted entitlement
+     */
+    async delete(subjectIdOrKey, entitlementId, options) {
+        const resp = await this.client.DELETE('/api/v1/subjects/{subjectIdOrKey}/entitlements/{entitlementId}', {
+            params: {
+                path: {
+                    entitlementId,
+                    subjectIdOrKey,
+                },
+            },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Get the value of an entitlement to check access
+     * All entitlement types share the hasAccess property in their value response, but multiple other properties are returned based on the entitlement type.
+     *
+     * @param subjectIdOrKey - The ID or key of the subject
+     * @param entitlementIdOrFeatureKey - The ID or feature key of the entitlement
+     * @param query - The query parameters
+     * @param signal - An optional abort signal
+     * @returns The entitlement value
+     */
+    async value(subjectIdOrKey, entitlementIdOrFeatureKey, query, options) {
+        const resp = await this.client.GET('/api/v1/subjects/{subjectIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/value', {
+            params: {
+                path: {
+                    entitlementIdOrFeatureKey,
+                    subjectIdOrKey,
+                },
+                query,
+            },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Get the history of an entitlement
+     * Returns historical balance and usage data for the entitlement. The queried history can span accross multiple reset events.
+     *
+     * @param subjectIdOrKey - The ID or key of the subject
+     * @param entitlementId - The ID of the entitlement
+     * @param query - The query parameters
+     * @param signal - An optional abort signal
+     * @returns The history of the entitlement
+     */
+    async history(subjectIdOrKey, entitlementId, query, options) {
+        const resp = await this.client.GET('/api/v1/subjects/{subjectIdOrKey}/entitlements/{entitlementId}/history', {
+            params: {
+                path: {
+                    entitlementId,
+                    subjectIdOrKey,
+                },
+                query,
+            },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Override an entitlement
+     * This is useful for upgrades, downgrades, or other changes to entitlements that require a new entitlement to be created with zero downtime.
+     *
+     * @param subjectIdOrKey - The ID or key of the subject
+     * @param entitlementIdOrFeatureKey - The ID or feature key of the entitlement
+     * @param override - The override to create
+     * @param signal - An optional abort signal
+     * @returns The overridden entitlement
+     */
+    async override(subjectIdOrKey, entitlementIdOrFeatureKey, override, options) {
+        const resp = await this.client.PUT('/api/v1/subjects/{subjectIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/override', {
+            body: override,
+            params: {
+                path: {
+                    entitlementIdOrFeatureKey,
+                    subjectIdOrKey,
+                },
+            },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Reset entitlement usage
+     * - Reset marks the start of a new usage period for the entitlement and initiates grant rollover. At the start of a period usage is zerod out and grants are rolled over based on their rollover settings. It would typically be synced with the subjects billing period to enforce usage based on their subscription.
+     * - Usage is automatically reset for metered entitlements based on their usage period, but this endpoint allows to manually reset it at any time. When doing so the period anchor of the entitlement can be changed if needed.
+     *
+     * @param subjectIdOrKey - The ID or key of the subject
+     * @param entitlementId - The ID of the entitlement
+     * @param body - The body of the request
+     * @param signal - An optional abort signal
+     * @returns The reset entitlement
+     */
+    async reset(subjectIdOrKey, entitlementId, body, options) {
+        const resp = await this.client.POST('/api/v1/subjects/{subjectIdOrKey}/entitlements/{entitlementId}/reset', {
+            body,
+            params: {
+                path: {
+                    entitlementId,
+                    subjectIdOrKey,
+                },
+            },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+}
+exports.Entitlements = Entitlements;
+class Grants {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Grant usage to a subject for an entitlement
+     *
+     * @param subjectIdOrKey - The ID or key of the subject
+     * @param entitlementIdOrFeatureKey - The ID or feature key of the entitlement
+     * @param grant - The grant to create
+     * @param signal - An optional abort signal
+     * @returns The created grant
+     */
+    async create(subjectIdOrKey, entitlementIdOrFeatureKey, grant, options) {
+        const resp = await this.client.POST('/api/v1/subjects/{subjectIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants', {
+            body: grant,
+            params: {
+                path: {
+                    entitlementIdOrFeatureKey,
+                    subjectIdOrKey,
+                },
+            },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * List grants for an entitlement
+     *
+     * @param subjectIdOrKey - The ID or key of the subject
+     * @param entitlementIdOrFeatureKey - The ID or feature key of the entitlement
+     * @param signal - An optional abort signal
+     * @returns The grants
+     */
+    async list(subjectIdOrKey, entitlementIdOrFeatureKey, query, options) {
+        const resp = await this.client.GET('/api/v1/subjects/{subjectIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants', {
+            params: {
+                path: {
+                    entitlementIdOrFeatureKey,
+                    subjectIdOrKey,
+                },
+                query,
+            },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * List all grants
+     * List all grants for all the subjects and entitlements.
+     *
+     * @param query - The query parameters
+     * @param options - The request options
+     * @returns The grants
+     */
+    async listAll(query, options) {
+        const resp = await this.client.GET('/api/v1/grants', {
+            params: {
+                query,
+            },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Void a grant
+     * Voiding a grant means it is no longer valid, it doesn't take part in further balance calculations.
+     * Voiding a grant does not retroactively take effect, meaning any usage that has already been attributed
+     * to the grant will remain, but future usage cannot be burnt down from the grant.
+     *
+     * @param grantId - The ID of the grant
+     * @param options - The request options
+     * @returns The voided grant
+     */
+    async void(grantId, options) {
+        const resp = await this.client.DELETE('/api/v1/grants/{grantId}', {
+            params: {
+                path: {
+                    grantId,
+                },
+            },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+}
+exports.Grants = Grants;
+//# sourceMappingURL=entitlements.js.map