@stigg/typescript 0.1.0-beta.65 → 0.1.0-beta.66

package/resources/v1/customers/entities/entitlements.d.mts

@@ -0,0 +1,260 @@
+import { APIResource } from "../../../../core/resource.mjs";
+import { APIPromise } from "../../../../core/api-promise.mjs";
+import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from "../../../../core/pagination.mjs";
+import { RequestOptions } from "../../../../internal/request-options.mjs";
+export declare class Entitlements extends APIResource {
+    /**
+     * Returns a cursor-paginated list of entity entitlements for the given customer.
+     * An entity entitlement ties an entity to a feature or currency with a usage limit
+     * and reset cadence.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const entitlementListResponse of client.v1.customers.entities.entitlements.list(
+     *   'id',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(id: string, params?: EntitlementListParams | null | undefined, options?: RequestOptions): PagePromise<EntitlementListResponsesMyCursorIDPage, EntitlementListResponse>;
+    /**
+     * Batched create-or-update of entity entitlements. Existing entity entitlements
+     * matched by (entityId, featureId or currencyId, scopeEntityIds) are updated; new
+     * ones are created. On update, omitted fields (usageLimit, cadence) are preserved;
+     * on create both are required.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.customers.entities.entitlements.upsert(
+     *     'id',
+     *     {
+     *       entityEntitlements: [
+     *         {
+     *           entityId: 'workspace-001',
+     *           featureId: 'compute-minutes',
+     *           usageLimit: 1000,
+     *           cadence: 'P1M',
+     *         },
+     *         {
+     *           entityId: 'workspace-002',
+     *           currencyId: 'cred-type-tokens',
+     *           usageLimit: 2000,
+     *           cadence: 'P1M',
+     *           parentId: 'workspace-001',
+     *           scopeEntityIds: ['user-1'],
+     *         },
+     *       ],
+     *     },
+     *   );
+     * ```
+     */
+    upsert(id: string, params: EntitlementUpsertParams, options?: RequestOptions): APIPromise<EntitlementUpsertResponse>;
+}
+export type EntitlementListResponsesMyCursorIDPage = MyCursorIDPage<EntitlementListResponse>;
+/**
+ * An entity entitlement for an entity belonging to a customer. Defines how much of
+ * the feature or currency the entity may consume (`usageLimit`) and how often the
+ * counter resets (`cadence`).
+ */
+export interface EntitlementListResponse {
+    /**
+     * Synthetic UUID identifier — also the cursor anchor for paginated lists
+     */
+    id: string;
+    /**
+     * Usage-reset cadence as an ISO-8601 single-unit duration, e.g. `P1M`, `P30D`,
+     * `PT1M`.
+     */
+    cadence: string;
+    /**
+     * Timestamp of when the record was created
+     */
+    createdAt: string;
+    /**
+     * The entity ID this entity entitlement is attached to
+     */
+    entityId: string;
+    /**
+     * Parent entity ID in the hierarchy, or `null` for a root.
+     */
+    parentId: string | null;
+    /**
+     * Dimension-scoped sub-limit key: the set of entity IDs this limit applies to.
+     * Empty is the node-wide limit that always matches; a non-empty set only applies
+     * when every listed entity is present in the resolved set (order-insensitive).
+     */
+    scopeEntityIds: Array<string>;
+    /**
+     * Timestamp of when the record was last updated
+     */
+    updatedAt: string;
+    /**
+     * Maximum usage allowed within one cadence window
+     */
+    usageLimit: number | null;
+    /**
+     * Currency ID this entity entitlement grants (present when it grants a credit
+     * currency).
+     */
+    currencyId?: string;
+    /**
+     * Feature ID this entity entitlement grants (present when it grants a feature).
+     */
+    featureId?: string;
+}
+/**
+ * Entity entitlements after upsert.
+ */
+export interface EntitlementUpsertResponse {
+    data: Array<EntitlementUpsertResponse.Data>;
+}
+export declare namespace EntitlementUpsertResponse {
+    /**
+     * An entity entitlement for an entity belonging to a customer. Defines how much of
+     * the feature or currency the entity may consume (`usageLimit`) and how often the
+     * counter resets (`cadence`).
+     */
+    interface Data {
+        /**
+         * Synthetic UUID identifier — also the cursor anchor for paginated lists
+         */
+        id: string;
+        /**
+         * Usage-reset cadence as an ISO-8601 single-unit duration, e.g. `P1M`, `P30D`,
+         * `PT1M`.
+         */
+        cadence: string;
+        /**
+         * Timestamp of when the record was created
+         */
+        createdAt: string;
+        /**
+         * The entity ID this entity entitlement is attached to
+         */
+        entityId: string;
+        /**
+         * Parent entity ID in the hierarchy, or `null` for a root.
+         */
+        parentId: string | null;
+        /**
+         * Dimension-scoped sub-limit key: the set of entity IDs this limit applies to.
+         * Empty is the node-wide limit that always matches; a non-empty set only applies
+         * when every listed entity is present in the resolved set (order-insensitive).
+         */
+        scopeEntityIds: Array<string>;
+        /**
+         * Timestamp of when the record was last updated
+         */
+        updatedAt: string;
+        /**
+         * Maximum usage allowed within one cadence window
+         */
+        usageLimit: number | null;
+        /**
+         * Currency ID this entity entitlement grants (present when it grants a credit
+         * currency).
+         */
+        currencyId?: string;
+        /**
+         * Feature ID this entity entitlement grants (present when it grants a feature).
+         */
+        featureId?: string;
+    }
+}
+export interface EntitlementListParams extends MyCursorIDPageParams {
+    /**
+     * Query param: Filter entity entitlements to a specific currency, by its ID.
+     * Mutually exclusive with `featureId`.
+     */
+    currencyId?: string;
+    /**
+     * Query param: Filter entity entitlements to a specific entity ID
+     */
+    entityId?: string;
+    /**
+     * Query param: Filter entity entitlements to a specific feature, by its ID.
+     * Mutually exclusive with `currencyId`.
+     */
+    featureId?: string;
+    /**
+     * Header param: Account ID — optional when authenticating with a user JWT (Bearer
+     * token); falls back to the user's first membership. Ignored for API-key auth.
+     */
+    'X-ACCOUNT-ID'?: string;
+    /**
+     * Header param: Environment ID — required when authenticating with a user JWT
+     * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
+     * intrinsic to the key).
+     */
+    'X-ENVIRONMENT-ID'?: string;
+}
+export interface EntitlementUpsertParams {
+    /**
+     * Body param: Entity entitlements to upsert (1–100 per request)
+     */
+    entityEntitlements: Array<EntitlementUpsertParams.EntityEntitlement>;
+    /**
+     * Header param: Account ID — optional when authenticating with a user JWT (Bearer
+     * token); falls back to the user's first membership. Ignored for API-key auth.
+     */
+    'X-ACCOUNT-ID'?: string;
+    /**
+     * Header param: Environment ID — required when authenticating with a user JWT
+     * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
+     * intrinsic to the key).
+     */
+    'X-ENVIRONMENT-ID'?: string;
+}
+export declare namespace EntitlementUpsertParams {
+    /**
+     * A single entity entitlement to create or update. Identify the feature or
+     * currency with exactly one of `featureId` or `currencyId`. The natural key is the
+     * `(entityId, featureId or currencyId, scopeEntityIds)` triple. On create both
+     * `usageLimit` and `cadence` are required; on update they may be omitted
+     * individually to preserve the existing value.
+     */
+    interface EntityEntitlement {
+        /**
+         * The entity ID this entity entitlement is attached to
+         */
+        entityId: string;
+        /**
+         * Usage-reset cadence (required on create) as an ISO-8601 single-unit duration,
+         * e.g. `P1M`, `P30D`, `PT1M`.
+         */
+        cadence?: string;
+        /**
+         * Currency ID this entity entitlement grants (credit limits). Mutually exclusive
+         * with `featureId`.
+         */
+        currencyId?: string;
+        /**
+         * Feature ID this entity entitlement grants. Mutually exclusive with `currencyId`.
+         */
+        featureId?: string;
+        /**
+         * Parent entity ID in the hierarchy. Omit to leave the current parent untouched (a
+         * new node defaults to a root); `null` detaches to a root; an ID sets or changes
+         * the parent. Reparenting or detaching an existing node is leaf-only; place a
+         * parent before its children, or in the same batch.
+         */
+        parentId?: string | null;
+        /**
+         * Dimension-scoped sub-limit: the set of entity IDs this limit applies to
+         * (order-insensitive, unique, at most 5). Omit or leave empty for the node-wide
+         * limit.
+         */
+        scopeEntityIds?: Array<string>;
+        /**
+         * Maximum usage allowed within one cadence window (required on create)
+         */
+        usageLimit?: number | null;
+    }
+}
+export declare namespace Entitlements {
+    export { type EntitlementListResponse as EntitlementListResponse, type EntitlementUpsertResponse as EntitlementUpsertResponse, type EntitlementListResponsesMyCursorIDPage as EntitlementListResponsesMyCursorIDPage, type EntitlementListParams as EntitlementListParams, type EntitlementUpsertParams as EntitlementUpsertParams, };
+}
+//# sourceMappingURL=entitlements.d.mts.map

package/resources/v1/customers/entities/entitlements.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entitlements.d.mts","sourceRoot":"","sources":["../../../../src/resources/v1/customers/entities/entitlements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,sCAAkC;AACxD,OAAO,EAAE,UAAU,EAAE,yCAAqC;AAC1D,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE,wCAAoC;AAErG,OAAO,EAAE,cAAc,EAAE,iDAA6C;AAGtE,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,sCAAsC,EAAE,uBAAuB,CAAC;IAmB/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAczC;AAED,MAAM,MAAM,sCAAsC,GAAG,cAAc,CAAC,uBAAuB,CAAC,CAAC;AAE7F;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;;OAIG;IACH,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,KAAK,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC;CAC7C;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;;;OAIG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;;WAIG;QACH,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE9B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,qBAAsB,SAAQ,oBAAoB;IACjE;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,kBAAkB,EAAE,KAAK,CAAC,uBAAuB,CAAC,iBAAiB,CAAC,CAAC;IAErE;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;;;;;OAMG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;;WAKG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;;WAIG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/v1/customers/entities/entitlements.d.ts

@@ -0,0 +1,260 @@
+import { APIResource } from "../../../../core/resource.js";
+import { APIPromise } from "../../../../core/api-promise.js";
+import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from "../../../../core/pagination.js";
+import { RequestOptions } from "../../../../internal/request-options.js";
+export declare class Entitlements extends APIResource {
+    /**
+     * Returns a cursor-paginated list of entity entitlements for the given customer.
+     * An entity entitlement ties an entity to a feature or currency with a usage limit
+     * and reset cadence.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const entitlementListResponse of client.v1.customers.entities.entitlements.list(
+     *   'id',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(id: string, params?: EntitlementListParams | null | undefined, options?: RequestOptions): PagePromise<EntitlementListResponsesMyCursorIDPage, EntitlementListResponse>;
+    /**
+     * Batched create-or-update of entity entitlements. Existing entity entitlements
+     * matched by (entityId, featureId or currencyId, scopeEntityIds) are updated; new
+     * ones are created. On update, omitted fields (usageLimit, cadence) are preserved;
+     * on create both are required.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.customers.entities.entitlements.upsert(
+     *     'id',
+     *     {
+     *       entityEntitlements: [
+     *         {
+     *           entityId: 'workspace-001',
+     *           featureId: 'compute-minutes',
+     *           usageLimit: 1000,
+     *           cadence: 'P1M',
+     *         },
+     *         {
+     *           entityId: 'workspace-002',
+     *           currencyId: 'cred-type-tokens',
+     *           usageLimit: 2000,
+     *           cadence: 'P1M',
+     *           parentId: 'workspace-001',
+     *           scopeEntityIds: ['user-1'],
+     *         },
+     *       ],
+     *     },
+     *   );
+     * ```
+     */
+    upsert(id: string, params: EntitlementUpsertParams, options?: RequestOptions): APIPromise<EntitlementUpsertResponse>;
+}
+export type EntitlementListResponsesMyCursorIDPage = MyCursorIDPage<EntitlementListResponse>;
+/**
+ * An entity entitlement for an entity belonging to a customer. Defines how much of
+ * the feature or currency the entity may consume (`usageLimit`) and how often the
+ * counter resets (`cadence`).
+ */
+export interface EntitlementListResponse {
+    /**
+     * Synthetic UUID identifier — also the cursor anchor for paginated lists
+     */
+    id: string;
+    /**
+     * Usage-reset cadence as an ISO-8601 single-unit duration, e.g. `P1M`, `P30D`,
+     * `PT1M`.
+     */
+    cadence: string;
+    /**
+     * Timestamp of when the record was created
+     */
+    createdAt: string;
+    /**
+     * The entity ID this entity entitlement is attached to
+     */
+    entityId: string;
+    /**
+     * Parent entity ID in the hierarchy, or `null` for a root.
+     */
+    parentId: string | null;
+    /**
+     * Dimension-scoped sub-limit key: the set of entity IDs this limit applies to.
+     * Empty is the node-wide limit that always matches; a non-empty set only applies
+     * when every listed entity is present in the resolved set (order-insensitive).
+     */
+    scopeEntityIds: Array<string>;
+    /**
+     * Timestamp of when the record was last updated
+     */
+    updatedAt: string;
+    /**
+     * Maximum usage allowed within one cadence window
+     */
+    usageLimit: number | null;
+    /**
+     * Currency ID this entity entitlement grants (present when it grants a credit
+     * currency).
+     */
+    currencyId?: string;
+    /**
+     * Feature ID this entity entitlement grants (present when it grants a feature).
+     */
+    featureId?: string;
+}
+/**
+ * Entity entitlements after upsert.
+ */
+export interface EntitlementUpsertResponse {
+    data: Array<EntitlementUpsertResponse.Data>;
+}
+export declare namespace EntitlementUpsertResponse {
+    /**
+     * An entity entitlement for an entity belonging to a customer. Defines how much of
+     * the feature or currency the entity may consume (`usageLimit`) and how often the
+     * counter resets (`cadence`).
+     */
+    interface Data {
+        /**
+         * Synthetic UUID identifier — also the cursor anchor for paginated lists
+         */
+        id: string;
+        /**
+         * Usage-reset cadence as an ISO-8601 single-unit duration, e.g. `P1M`, `P30D`,
+         * `PT1M`.
+         */
+        cadence: string;
+        /**
+         * Timestamp of when the record was created
+         */
+        createdAt: string;
+        /**
+         * The entity ID this entity entitlement is attached to
+         */
+        entityId: string;
+        /**
+         * Parent entity ID in the hierarchy, or `null` for a root.
+         */
+        parentId: string | null;
+        /**
+         * Dimension-scoped sub-limit key: the set of entity IDs this limit applies to.
+         * Empty is the node-wide limit that always matches; a non-empty set only applies
+         * when every listed entity is present in the resolved set (order-insensitive).
+         */
+        scopeEntityIds: Array<string>;
+        /**
+         * Timestamp of when the record was last updated
+         */
+        updatedAt: string;
+        /**
+         * Maximum usage allowed within one cadence window
+         */
+        usageLimit: number | null;
+        /**
+         * Currency ID this entity entitlement grants (present when it grants a credit
+         * currency).
+         */
+        currencyId?: string;
+        /**
+         * Feature ID this entity entitlement grants (present when it grants a feature).
+         */
+        featureId?: string;
+    }
+}
+export interface EntitlementListParams extends MyCursorIDPageParams {
+    /**
+     * Query param: Filter entity entitlements to a specific currency, by its ID.
+     * Mutually exclusive with `featureId`.
+     */
+    currencyId?: string;
+    /**
+     * Query param: Filter entity entitlements to a specific entity ID
+     */
+    entityId?: string;
+    /**
+     * Query param: Filter entity entitlements to a specific feature, by its ID.
+     * Mutually exclusive with `currencyId`.
+     */
+    featureId?: string;
+    /**
+     * Header param: Account ID — optional when authenticating with a user JWT (Bearer
+     * token); falls back to the user's first membership. Ignored for API-key auth.
+     */
+    'X-ACCOUNT-ID'?: string;
+    /**
+     * Header param: Environment ID — required when authenticating with a user JWT
+     * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
+     * intrinsic to the key).
+     */
+    'X-ENVIRONMENT-ID'?: string;
+}
+export interface EntitlementUpsertParams {
+    /**
+     * Body param: Entity entitlements to upsert (1–100 per request)
+     */
+    entityEntitlements: Array<EntitlementUpsertParams.EntityEntitlement>;
+    /**
+     * Header param: Account ID — optional when authenticating with a user JWT (Bearer
+     * token); falls back to the user's first membership. Ignored for API-key auth.
+     */
+    'X-ACCOUNT-ID'?: string;
+    /**
+     * Header param: Environment ID — required when authenticating with a user JWT
+     * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
+     * intrinsic to the key).
+     */
+    'X-ENVIRONMENT-ID'?: string;
+}
+export declare namespace EntitlementUpsertParams {
+    /**
+     * A single entity entitlement to create or update. Identify the feature or
+     * currency with exactly one of `featureId` or `currencyId`. The natural key is the
+     * `(entityId, featureId or currencyId, scopeEntityIds)` triple. On create both
+     * `usageLimit` and `cadence` are required; on update they may be omitted
+     * individually to preserve the existing value.
+     */
+    interface EntityEntitlement {
+        /**
+         * The entity ID this entity entitlement is attached to
+         */
+        entityId: string;
+        /**
+         * Usage-reset cadence (required on create) as an ISO-8601 single-unit duration,
+         * e.g. `P1M`, `P30D`, `PT1M`.
+         */
+        cadence?: string;
+        /**
+         * Currency ID this entity entitlement grants (credit limits). Mutually exclusive
+         * with `featureId`.
+         */
+        currencyId?: string;
+        /**
+         * Feature ID this entity entitlement grants. Mutually exclusive with `currencyId`.
+         */
+        featureId?: string;
+        /**
+         * Parent entity ID in the hierarchy. Omit to leave the current parent untouched (a
+         * new node defaults to a root); `null` detaches to a root; an ID sets or changes
+         * the parent. Reparenting or detaching an existing node is leaf-only; place a
+         * parent before its children, or in the same batch.
+         */
+        parentId?: string | null;
+        /**
+         * Dimension-scoped sub-limit: the set of entity IDs this limit applies to
+         * (order-insensitive, unique, at most 5). Omit or leave empty for the node-wide
+         * limit.
+         */
+        scopeEntityIds?: Array<string>;
+        /**
+         * Maximum usage allowed within one cadence window (required on create)
+         */
+        usageLimit?: number | null;
+    }
+}
+export declare namespace Entitlements {
+    export { type EntitlementListResponse as EntitlementListResponse, type EntitlementUpsertResponse as EntitlementUpsertResponse, type EntitlementListResponsesMyCursorIDPage as EntitlementListResponsesMyCursorIDPage, type EntitlementListParams as EntitlementListParams, type EntitlementUpsertParams as EntitlementUpsertParams, };
+}
+//# sourceMappingURL=entitlements.d.ts.map

package/resources/v1/customers/entities/entitlements.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entitlements.d.ts","sourceRoot":"","sources":["../../../../src/resources/v1/customers/entities/entitlements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,qCAAkC;AACxD,OAAO,EAAE,UAAU,EAAE,wCAAqC;AAC1D,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE,uCAAoC;AAErG,OAAO,EAAE,cAAc,EAAE,gDAA6C;AAGtE,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,sCAAsC,EAAE,uBAAuB,CAAC;IAmB/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAczC;AAED,MAAM,MAAM,sCAAsC,GAAG,cAAc,CAAC,uBAAuB,CAAC,CAAC;AAE7F;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;;OAIG;IACH,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,KAAK,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC;CAC7C;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;;;OAIG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;;WAIG;QACH,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE9B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,qBAAsB,SAAQ,oBAAoB;IACjE;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,kBAAkB,EAAE,KAAK,CAAC,uBAAuB,CAAC,iBAAiB,CAAC,CAAC;IAErE;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;;;;;OAMG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;;WAKG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;;WAIG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/v1/customers/entities/entitlements.js

@@ -0,0 +1,87 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Entitlements = void 0;
+const resource_1 = require("../../../../core/resource.js");
+const pagination_1 = require("../../../../core/pagination.js");
+const headers_1 = require("../../../../internal/headers.js");
+const path_1 = require("../../../../internal/utils/path.js");
+class Entitlements extends resource_1.APIResource {
+    /**
+     * Returns a cursor-paginated list of entity entitlements for the given customer.
+     * An entity entitlement ties an entity to a feature or currency with a usage limit
+     * and reset cadence.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const entitlementListResponse of client.v1.customers.entities.entitlements.list(
+     *   'id',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(id, params = {}, options) {
+        const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params ?? {};
+        return this._client.getAPIList((0, path_1.path) `/api/v1/customers/${id}/entities/entitlements`, (pagination_1.MyCursorIDPage), {
+            query,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                {
+                    ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+                    ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Batched create-or-update of entity entitlements. Existing entity entitlements
+     * matched by (entityId, featureId or currencyId, scopeEntityIds) are updated; new
+     * ones are created. On update, omitted fields (usageLimit, cadence) are preserved;
+     * on create both are required.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.customers.entities.entitlements.upsert(
+     *     'id',
+     *     {
+     *       entityEntitlements: [
+     *         {
+     *           entityId: 'workspace-001',
+     *           featureId: 'compute-minutes',
+     *           usageLimit: 1000,
+     *           cadence: 'P1M',
+     *         },
+     *         {
+     *           entityId: 'workspace-002',
+     *           currencyId: 'cred-type-tokens',
+     *           usageLimit: 2000,
+     *           cadence: 'P1M',
+     *           parentId: 'workspace-001',
+     *           scopeEntityIds: ['user-1'],
+     *         },
+     *       ],
+     *     },
+     *   );
+     * ```
+     */
+    upsert(id, params, options) {
+        const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+        return this._client.put((0, path_1.path) `/api/v1/customers/${id}/entities/entitlements`, {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                {
+                    ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+                    ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+}
+exports.Entitlements = Entitlements;
+//# sourceMappingURL=entitlements.js.map

package/resources/v1/customers/entities/entitlements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entitlements.js","sourceRoot":"","sources":["../../../../src/resources/v1/customers/entities/entitlements.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,2DAAwD;AAExD,+DAAqG;AACrG,6DAA4D;AAE5D,6DAAuD;AAEvD,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,EAAU,EACV,SAAmD,EAAE,EACrD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAClG,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,qBAAqB,EAAE,wBAAwB,EACnD,CAAA,2BAAuC,CAAA,EACvC;YACE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,MAAM,CACJ,EAAU,EACV,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3F,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,wBAAwB,EAAE;YAC3E,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AAzFD,oCAyFC"}