@stigg/typescript 0.1.0-beta.1 → 0.1.0-beta.10

package/resources/v1-beta/customers/entities.js

@@ -0,0 +1,96 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Entities = void 0;
+const resource_1 = require("../../../core/resource.js");
+const pagination_1 = require("../../../core/pagination.js");
+const path_1 = require("../../../internal/utils/path.js");
+class Entities extends resource_1.APIResource {
+    /**
+     * Retrieves a single entity for the given customer by its identifier.
+     *
+     * @example
+     * ```ts
+     * const entity =
+     *   await client.v1Beta.customers.entities.retrieve('x', {
+     *     id: 'id',
+     *   });
+     * ```
+     */
+    retrieve(entityID, params, options) {
+        const { id } = params;
+        return this._client.get((0, path_1.path) `/api/v1-beta/customers/${id}/entities/${entityID}`, options);
+    }
+    /**
+     * Retrieves a paginated list of entities for the given customer.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const entityListResponse of client.v1Beta.customers.entities.list(
+     *   'id',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(id, query = {}, options) {
+        return this._client.getAPIList((0, path_1.path) `/api/v1-beta/customers/${id}/entities`, (pagination_1.MyCursorIDPage), { query, ...options });
+    }
+    /**
+     * Archives entities in bulk for the given customer by id.
+     *
+     * @example
+     * ```ts
+     * const entityIDsActionResponseDto =
+     *   await client.v1Beta.customers.entities.archive('id', {
+     *     ids: ['user-7f3a0c1d', 'user-c4d1b2e9'],
+     *   });
+     * ```
+     */
+    archive(id, body, options) {
+        return this._client.post((0, path_1.path) `/api/v1-beta/customers/${id}/entities/archive`, { body, ...options });
+    }
+    /**
+     * Restores previously archived entities in bulk for the given customer by id.
+     *
+     * @example
+     * ```ts
+     * const entityIDsActionResponseDto =
+     *   await client.v1Beta.customers.entities.unarchive('id', {
+     *     ids: ['user-7f3a0c1d', 'user-c4d1b2e9'],
+     *   });
+     * ```
+     */
+    unarchive(id, body, options) {
+        return this._client.post((0, path_1.path) `/api/v1-beta/customers/${id}/entities/unarchive`, { body, ...options });
+    }
+    /**
+     * Creates or updates entities in bulk for the given customer. Existing entities
+     * matched by id are updated; new ids are created.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1Beta.customers.entities.upsert('id', {
+     *     entities: [
+     *       {
+     *         id: 'user-7f3a0c1d',
+     *         typeRefId: 'user',
+     *         metadata: { email: 'jane@acme.com', role: 'admin' },
+     *       },
+     *       {
+     *         id: 'user-c4d1b2e9',
+     *         typeRefId: 'user',
+     *         metadata: { email: 'john@acme.com' },
+     *       },
+     *     ],
+     *   });
+     * ```
+     */
+    upsert(id, body, options) {
+        return this._client.put((0, path_1.path) `/api/v1-beta/customers/${id}/entities`, { body, ...options });
+    }
+}
+exports.Entities = Entities;
+//# sourceMappingURL=entities.js.map

package/resources/v1-beta/customers/entities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.js","sourceRoot":"","sources":["../../../src/resources/v1-beta/customers/entities.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,4DAAkG;AAElG,0DAAoD;AAEpD,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;OAUG;IACH,QAAQ,CACN,QAAgB,EAChB,MAA4B,EAC5B,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,aAAa,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAU,EACV,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,0BAA0B,EAAE,WAAW,EAC3C,CAAA,2BAAkC,CAAA,EAClC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CACL,EAAU,EACV,IAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;;;OAUG;IACH,SAAS,CACP,EAAU,EACV,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,EAAU,EAAE,IAAwB,EAAE,OAAwB;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,EAAE,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;CACF;AA9GD,4BA8GC"}

package/resources/v1-beta/customers/entities.mjs

@@ -0,0 +1,92 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../core/resource.mjs";
+import { MyCursorIDPage } from "../../../core/pagination.mjs";
+import { path } from "../../../internal/utils/path.mjs";
+export class Entities extends APIResource {
+    /**
+     * Retrieves a single entity for the given customer by its identifier.
+     *
+     * @example
+     * ```ts
+     * const entity =
+     *   await client.v1Beta.customers.entities.retrieve('x', {
+     *     id: 'id',
+     *   });
+     * ```
+     */
+    retrieve(entityID, params, options) {
+        const { id } = params;
+        return this._client.get(path `/api/v1-beta/customers/${id}/entities/${entityID}`, options);
+    }
+    /**
+     * Retrieves a paginated list of entities for the given customer.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const entityListResponse of client.v1Beta.customers.entities.list(
+     *   'id',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(id, query = {}, options) {
+        return this._client.getAPIList(path `/api/v1-beta/customers/${id}/entities`, (MyCursorIDPage), { query, ...options });
+    }
+    /**
+     * Archives entities in bulk for the given customer by id.
+     *
+     * @example
+     * ```ts
+     * const entityIDsActionResponseDto =
+     *   await client.v1Beta.customers.entities.archive('id', {
+     *     ids: ['user-7f3a0c1d', 'user-c4d1b2e9'],
+     *   });
+     * ```
+     */
+    archive(id, body, options) {
+        return this._client.post(path `/api/v1-beta/customers/${id}/entities/archive`, { body, ...options });
+    }
+    /**
+     * Restores previously archived entities in bulk for the given customer by id.
+     *
+     * @example
+     * ```ts
+     * const entityIDsActionResponseDto =
+     *   await client.v1Beta.customers.entities.unarchive('id', {
+     *     ids: ['user-7f3a0c1d', 'user-c4d1b2e9'],
+     *   });
+     * ```
+     */
+    unarchive(id, body, options) {
+        return this._client.post(path `/api/v1-beta/customers/${id}/entities/unarchive`, { body, ...options });
+    }
+    /**
+     * Creates or updates entities in bulk for the given customer. Existing entities
+     * matched by id are updated; new ids are created.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1Beta.customers.entities.upsert('id', {
+     *     entities: [
+     *       {
+     *         id: 'user-7f3a0c1d',
+     *         typeRefId: 'user',
+     *         metadata: { email: 'jane@acme.com', role: 'admin' },
+     *       },
+     *       {
+     *         id: 'user-c4d1b2e9',
+     *         typeRefId: 'user',
+     *         metadata: { email: 'john@acme.com' },
+     *       },
+     *     ],
+     *   });
+     * ```
+     */
+    upsert(id, body, options) {
+        return this._client.put(path `/api/v1-beta/customers/${id}/entities`, { body, ...options });
+    }
+}
+//# sourceMappingURL=entities.mjs.map

package/resources/v1-beta/customers/entities.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.mjs","sourceRoot":"","sources":["../../../src/resources/v1-beta/customers/entities.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAErD,OAAO,EAAE,cAAc,EAA0C,qCAAiC;AAElG,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,QAAQ,CACN,QAAgB,EAChB,MAA4B,EAC5B,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,EAAE,aAAa,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAU,EACV,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,0BAA0B,EAAE,WAAW,EAC3C,CAAA,cAAkC,CAAA,EAClC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CACL,EAAU,EACV,IAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,0BAA0B,EAAE,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;;;OAUG;IACH,SAAS,CACP,EAAU,EACV,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,0BAA0B,EAAE,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,EAAU,EAAE,IAAwB,EAAE,OAAwB;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,EAAE,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;CACF"}

package/resources/v1-beta/customers/entitlements.d.mts

@@ -0,0 +1,236 @@
+import { APIResource } from "../../../core/resource.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
+export declare class Entitlements extends APIResource {
+    /**
+     * Experimental — request and response shapes may change without notice. Same
+     * semantics as `Check entitlement`, plus an optional `dimensions` query param that
+     * resolves to per-entity governance limits surfaced as `chains` on the response.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1Beta.customers.entitlements.check('x');
+     * ```
+     */
+    check(id: string, query?: EntitlementCheckParams | null | undefined, options?: RequestOptions): APIPromise<EntitlementCheckResponse>;
+}
+/**
+ * Response object
+ */
+export interface EntitlementCheckResponse {
+    /**
+     * Feature entitlement with optional governance chains attached.
+     */
+    data: EntitlementCheckResponse.Feature | EntitlementCheckResponse.Credit;
+}
+export declare namespace EntitlementCheckResponse {
+    /**
+     * Feature entitlement with optional governance chains attached.
+     */
+    interface Feature {
+        accessDeniedReason: 'FeatureNotFound' | 'CustomerNotFound' | 'CustomerIsArchived' | 'CustomerResourceNotFound' | 'NoActiveSubscription' | 'NoFeatureEntitlementInSubscription' | 'RequestedUsageExceedingLimit' | 'RequestedValuesMismatch' | 'BudgetExceeded' | 'Unknown' | 'FeatureTypeMismatch' | 'Revoked' | 'InsufficientCredits' | 'EntitlementNotFound' | null;
+        isGranted: boolean;
+        type: 'FEATURE';
+        /**
+         * Per-entity rollups, one chain per resolved dimension. Omitted when dimensions
+         * was not provided.
+         */
+        chains?: Array<Array<Feature.Chain>>;
+        currentUsage?: number;
+        /**
+         * Timestamp of the last update to the entitlement grant or configuration.
+         */
+        entitlementUpdatedAt?: string;
+        feature?: Feature.Feature;
+        hasUnlimitedUsage?: boolean;
+        resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | null;
+        usageLimit?: number | null;
+        /**
+         * The anchor for calculating the usage period for metered entitlements with a
+         * reset period configured
+         */
+        usagePeriodAnchor?: string;
+        /**
+         * The end date of the usage period for metered entitlements with a reset period
+         * configured
+         */
+        usagePeriodEnd?: string;
+        /**
+         * The start date of the usage period for metered entitlements with a reset period
+         * configured
+         */
+        usagePeriodStart?: string;
+        /**
+         * The next time the entitlement should be recalculated
+         */
+        validUntil?: string;
+    }
+    namespace Feature {
+        /**
+         * Per-entity governance node — limit and current usage for a single resolved
+         * entity.
+         */
+        interface Chain {
+            /**
+             * Amount consumed by this entity in the current cadence period.
+             */
+            currentUsage: number;
+            /**
+             * External id of the entity within the customer.
+             */
+            entityId: string;
+            /**
+             * Whether this node alone permits the requested usage.
+             */
+            isGranted: boolean;
+            /**
+             * Hard usage limit for this node; null when no assignment is configured.
+             */
+            usageLimit: number | null;
+        }
+        interface Feature {
+            /**
+             * The unique reference ID of the entitlement.
+             */
+            id: string;
+            /**
+             * The human-readable name of the entitlement, shown in UI elements.
+             */
+            displayName: string;
+            /**
+             * The current status of the feature.
+             */
+            featureStatus: 'NEW' | 'SUSPENDED' | 'ACTIVE';
+            /**
+             * The type of feature associated with the entitlement.
+             */
+            featureType: 'BOOLEAN' | 'NUMBER' | 'ENUM';
+        }
+    }
+    /**
+     * Credit entitlement with optional governance chains attached.
+     */
+    interface Credit {
+        accessDeniedReason: 'FeatureNotFound' | 'CustomerNotFound' | 'CustomerIsArchived' | 'CustomerResourceNotFound' | 'NoActiveSubscription' | 'NoFeatureEntitlementInSubscription' | 'RequestedUsageExceedingLimit' | 'RequestedValuesMismatch' | 'BudgetExceeded' | 'Unknown' | 'FeatureTypeMismatch' | 'Revoked' | 'InsufficientCredits' | 'EntitlementNotFound' | null;
+        /**
+         * The currency associated with a credit entitlement.
+         */
+        currency: Credit.Currency;
+        currentUsage: number;
+        isGranted: boolean;
+        type: 'CREDIT';
+        usageLimit: number;
+        /**
+         * Timestamp of the last update to the credit usage.
+         */
+        usageUpdatedAt: string;
+        /**
+         * Per-entity rollups, one chain per resolved dimension. Omitted when dimensions
+         * was not provided.
+         */
+        chains?: Array<Array<Credit.Chain>>;
+        /**
+         * Timestamp of the last update to the entitlement grant or configuration.
+         */
+        entitlementUpdatedAt?: string;
+        /**
+         * The end date of the current billing period for recurring credit grants.
+         */
+        usagePeriodEnd?: string;
+        /**
+         * The next time the entitlement should be recalculated
+         */
+        validUntil?: string;
+    }
+    namespace Credit {
+        /**
+         * The currency associated with a credit entitlement.
+         */
+        interface Currency {
+            /**
+             * The unique identifier of the custom currency.
+             */
+            currencyId: string;
+            /**
+             * The display name of the currency.
+             */
+            displayName: string;
+            /**
+             * A description of the currency.
+             */
+            description?: string | null;
+            /**
+             * Additional metadata associated with the currency.
+             */
+            metadata?: {
+                [key: string]: string;
+            } | null;
+            /**
+             * The plural form of the currency unit.
+             */
+            unitPlural?: string | null;
+            /**
+             * The singular form of the currency unit.
+             */
+            unitSingular?: string | null;
+        }
+        /**
+         * Per-entity governance node — limit and current usage for a single resolved
+         * entity.
+         */
+        interface Chain {
+            /**
+             * Amount consumed by this entity in the current cadence period.
+             */
+            currentUsage: number;
+            /**
+             * External id of the entity within the customer.
+             */
+            entityId: string;
+            /**
+             * Whether this node alone permits the requested usage.
+             */
+            isGranted: boolean;
+            /**
+             * Hard usage limit for this node; null when no assignment is configured.
+             */
+            usageLimit: number | null;
+        }
+    }
+}
+export interface EntitlementCheckParams {
+    /**
+     * Currency ID (refId) to check for credit entitlements. Mutually exclusive with
+     * `featureId`.
+     */
+    currencyId?: string;
+    /**
+     * Optional attribution map (e.g. `dimensions[userId]=u1`). When provided, the
+     * response includes a `chains` array with per-entity governance limits.
+     */
+    dimensions?: {
+        [key: string]: string;
+    };
+    /**
+     * Feature ID (refId) to check. Mutually exclusive with `currencyId`.
+     */
+    featureId?: string;
+    /**
+     * Requested usage amount to evaluate against the entitlement limit (numeric
+     * features only)
+     */
+    requestedUsage?: number;
+    /**
+     * Requested values to evaluate against allowed values (enum features only)
+     */
+    requestedValues?: Array<string>;
+    /**
+     * Resource ID to scope the entitlement check to a specific resource
+     */
+    resourceId?: string;
+}
+export declare namespace Entitlements {
+    export { type EntitlementCheckResponse as EntitlementCheckResponse, type EntitlementCheckParams as EntitlementCheckParams, };
+}
+//# sourceMappingURL=entitlements.d.mts.map

package/resources/v1-beta/customers/entitlements.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entitlements.d.mts","sourceRoot":"","sources":["../../../src/resources/v1-beta/customers/entitlements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;OAUG;IACH,KAAK,CACH,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;CAGxC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,wBAAwB,CAAC,OAAO,GAAG,wBAAwB,CAAC,MAAM,CAAC;CAC1E;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,OAAO;QACtB,kBAAkB,EACd,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,0BAA0B,GAC1B,sBAAsB,GACtB,oCAAoC,GACpC,8BAA8B,GAC9B,yBAAyB,GACzB,gBAAgB,GAChB,SAAS,GACT,qBAAqB,GACrB,SAAS,GACT,qBAAqB,GACrB,qBAAqB,GACrB,IAAI,CAAC;QAET,SAAS,EAAE,OAAO,CAAC;QAEnB,IAAI,EAAE,SAAS,CAAC;QAEhB;;;WAGG;QACH,MAAM,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;QAErC,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC;QAE1B,iBAAiB,CAAC,EAAE,OAAO,CAAC;QAE5B,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;QAEhE,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAED,UAAiB,OAAO,CAAC;QACvB;;;WAGG;QACH,UAAiB,KAAK;YACpB;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,SAAS,EAAE,OAAO,CAAC;YAEnB;;eAEG;YACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;SAC3B;QAED,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,aAAa,EAAE,KAAK,GAAG,WAAW,GAAG,QAAQ,CAAC;YAE9C;;eAEG;YACH,WAAW,EAAE,SAAS,GAAG,QAAQ,GAAG,MAAM,CAAC;SAC5C;KACF;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB,kBAAkB,EACd,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,0BAA0B,GAC1B,sBAAsB,GACtB,oCAAoC,GACpC,8BAA8B,GAC9B,yBAAyB,GACzB,gBAAgB,GAChB,SAAS,GACT,qBAAqB,GACrB,SAAS,GACT,qBAAqB,GACrB,qBAAqB,GACrB,IAAI,CAAC;QAET;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;QAE1B,YAAY,EAAE,MAAM,CAAC;QAErB,SAAS,EAAE,OAAO,CAAC;QAEnB,IAAI,EAAE,QAAQ,CAAC;QAEf,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,MAAM,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAEpC;;WAEG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,QAAQ,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,GAAG,IAAI,CAAC;YAE5C;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC9B;QAED;;;WAGG;QACH,UAAiB,KAAK;YACpB;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,SAAS,EAAE,OAAO,CAAC;YAEnB;;eAEG;YACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;SAC3B;KACF;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEvC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}

package/resources/v1-beta/customers/entitlements.d.ts

@@ -0,0 +1,236 @@
+import { APIResource } from "../../../core/resource.js";
+import { APIPromise } from "../../../core/api-promise.js";
+import { RequestOptions } from "../../../internal/request-options.js";
+export declare class Entitlements extends APIResource {
+    /**
+     * Experimental — request and response shapes may change without notice. Same
+     * semantics as `Check entitlement`, plus an optional `dimensions` query param that
+     * resolves to per-entity governance limits surfaced as `chains` on the response.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1Beta.customers.entitlements.check('x');
+     * ```
+     */
+    check(id: string, query?: EntitlementCheckParams | null | undefined, options?: RequestOptions): APIPromise<EntitlementCheckResponse>;
+}
+/**
+ * Response object
+ */
+export interface EntitlementCheckResponse {
+    /**
+     * Feature entitlement with optional governance chains attached.
+     */
+    data: EntitlementCheckResponse.Feature | EntitlementCheckResponse.Credit;
+}
+export declare namespace EntitlementCheckResponse {
+    /**
+     * Feature entitlement with optional governance chains attached.
+     */
+    interface Feature {
+        accessDeniedReason: 'FeatureNotFound' | 'CustomerNotFound' | 'CustomerIsArchived' | 'CustomerResourceNotFound' | 'NoActiveSubscription' | 'NoFeatureEntitlementInSubscription' | 'RequestedUsageExceedingLimit' | 'RequestedValuesMismatch' | 'BudgetExceeded' | 'Unknown' | 'FeatureTypeMismatch' | 'Revoked' | 'InsufficientCredits' | 'EntitlementNotFound' | null;
+        isGranted: boolean;
+        type: 'FEATURE';
+        /**
+         * Per-entity rollups, one chain per resolved dimension. Omitted when dimensions
+         * was not provided.
+         */
+        chains?: Array<Array<Feature.Chain>>;
+        currentUsage?: number;
+        /**
+         * Timestamp of the last update to the entitlement grant or configuration.
+         */
+        entitlementUpdatedAt?: string;
+        feature?: Feature.Feature;
+        hasUnlimitedUsage?: boolean;
+        resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | null;
+        usageLimit?: number | null;
+        /**
+         * The anchor for calculating the usage period for metered entitlements with a
+         * reset period configured
+         */
+        usagePeriodAnchor?: string;
+        /**
+         * The end date of the usage period for metered entitlements with a reset period
+         * configured
+         */
+        usagePeriodEnd?: string;
+        /**
+         * The start date of the usage period for metered entitlements with a reset period
+         * configured
+         */
+        usagePeriodStart?: string;
+        /**
+         * The next time the entitlement should be recalculated
+         */
+        validUntil?: string;
+    }
+    namespace Feature {
+        /**
+         * Per-entity governance node — limit and current usage for a single resolved
+         * entity.
+         */
+        interface Chain {
+            /**
+             * Amount consumed by this entity in the current cadence period.
+             */
+            currentUsage: number;
+            /**
+             * External id of the entity within the customer.
+             */
+            entityId: string;
+            /**
+             * Whether this node alone permits the requested usage.
+             */
+            isGranted: boolean;
+            /**
+             * Hard usage limit for this node; null when no assignment is configured.
+             */
+            usageLimit: number | null;
+        }
+        interface Feature {
+            /**
+             * The unique reference ID of the entitlement.
+             */
+            id: string;
+            /**
+             * The human-readable name of the entitlement, shown in UI elements.
+             */
+            displayName: string;
+            /**
+             * The current status of the feature.
+             */
+            featureStatus: 'NEW' | 'SUSPENDED' | 'ACTIVE';
+            /**
+             * The type of feature associated with the entitlement.
+             */
+            featureType: 'BOOLEAN' | 'NUMBER' | 'ENUM';
+        }
+    }
+    /**
+     * Credit entitlement with optional governance chains attached.
+     */
+    interface Credit {
+        accessDeniedReason: 'FeatureNotFound' | 'CustomerNotFound' | 'CustomerIsArchived' | 'CustomerResourceNotFound' | 'NoActiveSubscription' | 'NoFeatureEntitlementInSubscription' | 'RequestedUsageExceedingLimit' | 'RequestedValuesMismatch' | 'BudgetExceeded' | 'Unknown' | 'FeatureTypeMismatch' | 'Revoked' | 'InsufficientCredits' | 'EntitlementNotFound' | null;
+        /**
+         * The currency associated with a credit entitlement.
+         */
+        currency: Credit.Currency;
+        currentUsage: number;
+        isGranted: boolean;
+        type: 'CREDIT';
+        usageLimit: number;
+        /**
+         * Timestamp of the last update to the credit usage.
+         */
+        usageUpdatedAt: string;
+        /**
+         * Per-entity rollups, one chain per resolved dimension. Omitted when dimensions
+         * was not provided.
+         */
+        chains?: Array<Array<Credit.Chain>>;
+        /**
+         * Timestamp of the last update to the entitlement grant or configuration.
+         */
+        entitlementUpdatedAt?: string;
+        /**
+         * The end date of the current billing period for recurring credit grants.
+         */
+        usagePeriodEnd?: string;
+        /**
+         * The next time the entitlement should be recalculated
+         */
+        validUntil?: string;
+    }
+    namespace Credit {
+        /**
+         * The currency associated with a credit entitlement.
+         */
+        interface Currency {
+            /**
+             * The unique identifier of the custom currency.
+             */
+            currencyId: string;
+            /**
+             * The display name of the currency.
+             */
+            displayName: string;
+            /**
+             * A description of the currency.
+             */
+            description?: string | null;
+            /**
+             * Additional metadata associated with the currency.
+             */
+            metadata?: {
+                [key: string]: string;
+            } | null;
+            /**
+             * The plural form of the currency unit.
+             */
+            unitPlural?: string | null;
+            /**
+             * The singular form of the currency unit.
+             */
+            unitSingular?: string | null;
+        }
+        /**
+         * Per-entity governance node — limit and current usage for a single resolved
+         * entity.
+         */
+        interface Chain {
+            /**
+             * Amount consumed by this entity in the current cadence period.
+             */
+            currentUsage: number;
+            /**
+             * External id of the entity within the customer.
+             */
+            entityId: string;
+            /**
+             * Whether this node alone permits the requested usage.
+             */
+            isGranted: boolean;
+            /**
+             * Hard usage limit for this node; null when no assignment is configured.
+             */
+            usageLimit: number | null;
+        }
+    }
+}
+export interface EntitlementCheckParams {
+    /**
+     * Currency ID (refId) to check for credit entitlements. Mutually exclusive with
+     * `featureId`.
+     */
+    currencyId?: string;
+    /**
+     * Optional attribution map (e.g. `dimensions[userId]=u1`). When provided, the
+     * response includes a `chains` array with per-entity governance limits.
+     */
+    dimensions?: {
+        [key: string]: string;
+    };
+    /**
+     * Feature ID (refId) to check. Mutually exclusive with `currencyId`.
+     */
+    featureId?: string;
+    /**
+     * Requested usage amount to evaluate against the entitlement limit (numeric
+     * features only)
+     */
+    requestedUsage?: number;
+    /**
+     * Requested values to evaluate against allowed values (enum features only)
+     */
+    requestedValues?: Array<string>;
+    /**
+     * Resource ID to scope the entitlement check to a specific resource
+     */
+    resourceId?: string;
+}
+export declare namespace Entitlements {
+    export { type EntitlementCheckResponse as EntitlementCheckResponse, type EntitlementCheckParams as EntitlementCheckParams, };
+}
+//# sourceMappingURL=entitlements.d.ts.map

package/resources/v1-beta/customers/entitlements.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entitlements.d.ts","sourceRoot":"","sources":["../../../src/resources/v1-beta/customers/entitlements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;OAUG;IACH,KAAK,CACH,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;CAGxC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,wBAAwB,CAAC,OAAO,GAAG,wBAAwB,CAAC,MAAM,CAAC;CAC1E;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,OAAO;QACtB,kBAAkB,EACd,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,0BAA0B,GAC1B,sBAAsB,GACtB,oCAAoC,GACpC,8BAA8B,GAC9B,yBAAyB,GACzB,gBAAgB,GAChB,SAAS,GACT,qBAAqB,GACrB,SAAS,GACT,qBAAqB,GACrB,qBAAqB,GACrB,IAAI,CAAC;QAET,SAAS,EAAE,OAAO,CAAC;QAEnB,IAAI,EAAE,SAAS,CAAC;QAEhB;;;WAGG;QACH,MAAM,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;QAErC,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC;QAE1B,iBAAiB,CAAC,EAAE,OAAO,CAAC;QAE5B,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;QAEhE,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAED,UAAiB,OAAO,CAAC;QACvB;;;WAGG;QACH,UAAiB,KAAK;YACpB;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,SAAS,EAAE,OAAO,CAAC;YAEnB;;eAEG;YACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;SAC3B;QAED,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,aAAa,EAAE,KAAK,GAAG,WAAW,GAAG,QAAQ,CAAC;YAE9C;;eAEG;YACH,WAAW,EAAE,SAAS,GAAG,QAAQ,GAAG,MAAM,CAAC;SAC5C;KACF;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB,kBAAkB,EACd,iBAAiB,GACjB,kBAAkB,GAClB,oBAAoB,GACpB,0BAA0B,GAC1B,sBAAsB,GACtB,oCAAoC,GACpC,8BAA8B,GAC9B,yBAAyB,GACzB,gBAAgB,GAChB,SAAS,GACT,qBAAqB,GACrB,SAAS,GACT,qBAAqB,GACrB,qBAAqB,GACrB,IAAI,CAAC;QAET;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;QAE1B,YAAY,EAAE,MAAM,CAAC;QAErB,SAAS,EAAE,OAAO,CAAC;QAEnB,IAAI,EAAE,QAAQ,CAAC;QAEf,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,MAAM,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAEpC;;WAEG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,QAAQ,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,GAAG,IAAI,CAAC;YAE5C;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC9B;QAED;;;WAGG;QACH,UAAiB,KAAK;YACpB;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,SAAS,EAAE,OAAO,CAAC;YAEnB;;eAEG;YACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;SAC3B;KACF;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEvC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}