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

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

@@ -0,0 +1,332 @@
+import { APIResource } from "../../../../core/resource.js";
+import * as EntitlementsAPI from "./entitlements.js";
+import { EntitlementListParams, EntitlementListResponse, EntitlementListResponsesMyCursorIDPage, EntitlementUpsertParams, EntitlementUpsertResponse, Entitlements } from "./entitlements.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 Entities extends APIResource {
+    entitlements: EntitlementsAPI.Entitlements;
+    /**
+     * Retrieves a single entity for the given customer by its identifier.
+     *
+     * @example
+     * ```ts
+     * const entity = await client.v1.customers.entities.retrieve(
+     *   'x',
+     *   { id: 'id' },
+     * );
+     * ```
+     */
+    retrieve(entityID: string, params: EntityRetrieveParams, options?: RequestOptions): APIPromise<EntityRetrieveResponse>;
+    /**
+     * Retrieves a paginated list of entities for the given customer.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const entityListResponse of client.v1.customers.entities.list(
+     *   'id',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(id: string, params?: EntityListParams | null | undefined, options?: RequestOptions): PagePromise<EntityListResponsesMyCursorIDPage, EntityListResponse>;
+    /**
+     * Archives entities in bulk for the given customer by id. Upsert an archived
+     * entity to restore it.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.customers.entities.archive(
+     *   'id',
+     *   { ids: ['user-7f3a0c1d', 'user-c4d1b2e9'] },
+     * );
+     * ```
+     */
+    archive(id: string, params: EntityArchiveParams, options?: RequestOptions): APIPromise<EntityArchiveResponse>;
+    /**
+     * Creates or updates entities in bulk for the given customer. Existing entities
+     * matched by id are updated; new ids are created. An upsert of an archived entity
+     * restores it. An entity on an archived entity type fails with 400.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.customers.entities.upsert(
+     *   'id',
+     *   {
+     *     entities: [
+     *       {
+     *         id: 'user-7f3a0c1d',
+     *         displayName: 'Jane Doe',
+     *         entityTypeId: 'user',
+     *         metadata: { email: 'jane@acme.com', role: 'admin' },
+     *       },
+     *       {
+     *         id: 'user-c4d1b2e9',
+     *         displayName: 'John Roe',
+     *         entityTypeId: 'user',
+     *         metadata: { email: 'john@acme.com' },
+     *       },
+     *     ],
+     *   },
+     * );
+     * ```
+     */
+    upsert(id: string, params: EntityUpsertParams, options?: RequestOptions): APIPromise<EntityUpsertResponse>;
+}
+export type EntityListResponsesMyCursorIDPage = MyCursorIDPage<EntityListResponse>;
+/**
+ * Response object
+ */
+export interface EntityRetrieveResponse {
+    /**
+     * A stored entity instance tracked by the governance service for a given customer
+     */
+    data: EntityRetrieveResponse.Data;
+}
+export declare namespace EntityRetrieveResponse {
+    /**
+     * A stored entity instance tracked by the governance service for a given customer
+     */
+    interface Data {
+        /**
+         * The unique identifier for the entity
+         */
+        id: string;
+        /**
+         * Timestamp of when the record was deleted
+         */
+        archivedAt: string | null;
+        /**
+         * Timestamp of when the record was created
+         */
+        createdAt: string;
+        /**
+         * Human-readable name for the entity, or null when none is set — in which case
+         * clients display the entity ID
+         */
+        displayName: string | null;
+        /**
+         * The entity type identifier this entity instantiates
+         */
+        entityTypeId: string;
+        /**
+         * Free-form key/value metadata attached to the entity
+         */
+        metadata: {
+            [key: string]: string;
+        };
+        /**
+         * Timestamp of when the record was last updated
+         */
+        updatedAt: string;
+    }
+}
+/**
+ * A stored entity instance tracked by the governance service for a given customer
+ */
+export interface EntityListResponse {
+    /**
+     * The unique identifier for the entity
+     */
+    id: string;
+    /**
+     * Timestamp of when the record was deleted
+     */
+    archivedAt: string | null;
+    /**
+     * Timestamp of when the record was created
+     */
+    createdAt: string;
+    /**
+     * Human-readable name for the entity, or null when none is set — in which case
+     * clients display the entity ID
+     */
+    displayName: string | null;
+    /**
+     * The entity type identifier this entity instantiates
+     */
+    entityTypeId: string;
+    /**
+     * Free-form key/value metadata attached to the entity
+     */
+    metadata: {
+        [key: string]: string;
+    };
+    /**
+     * Timestamp of when the record was last updated
+     */
+    updatedAt: string;
+}
+/**
+ * Wrapped response echoing the ids that were acted on by an archive/unarchive call
+ */
+export interface EntityArchiveResponse {
+    /**
+     * List of entity identifiers that were acted on
+     */
+    data: EntityArchiveResponse.Data;
+}
+export declare namespace EntityArchiveResponse {
+    /**
+     * List of entity identifiers that were acted on
+     */
+    interface Data {
+        /**
+         * Entity identifiers to act on
+         */
+        ids: Array<string>;
+    }
+}
+/**
+ * List of entities created or updated by an upsert request
+ */
+export interface EntityUpsertResponse {
+    data: Array<EntityUpsertResponse.Data>;
+}
+export declare namespace EntityUpsertResponse {
+    /**
+     * A stored entity instance tracked by the governance service for a given customer
+     */
+    interface Data {
+        /**
+         * The unique identifier for the entity
+         */
+        id: string;
+        /**
+         * Timestamp of when the record was deleted
+         */
+        archivedAt: string | null;
+        /**
+         * Timestamp of when the record was created
+         */
+        createdAt: string;
+        /**
+         * Human-readable name for the entity, or null when none is set — in which case
+         * clients display the entity ID
+         */
+        displayName: string | null;
+        /**
+         * The entity type identifier this entity instantiates
+         */
+        entityTypeId: string;
+        /**
+         * Free-form key/value metadata attached to the entity
+         */
+        metadata: {
+            [key: string]: string;
+        };
+        /**
+         * Timestamp of when the record was last updated
+         */
+        updatedAt: string;
+    }
+}
+export interface EntityRetrieveParams {
+    /**
+     * Path param: The customer identifier (owner) the entity belongs to
+     */
+    id: 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 EntityListParams extends MyCursorIDPageParams {
+    /**
+     * Query param: Filter results to entities of a specific entity type, by the type's
+     * ID
+     */
+    entityTypeId?: string;
+    /**
+     * Query param: Whether to include archived entities. One of: true, false
+     */
+    includeArchived?: 'true' | 'false';
+    /**
+     * 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 EntityArchiveParams {
+    /**
+     * Body param: Entity identifiers to act on
+     */
+    ids: Array<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 EntityUpsertParams {
+    /**
+     * Body param: List of entities to create or update (1-100 entries)
+     */
+    entities: Array<EntityUpsertParams.Entity>;
+    /**
+     * 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 EntityUpsertParams {
+    /**
+     * A single entity to create or update.
+     */
+    interface Entity {
+        /**
+         * The unique identifier for the entity
+         */
+        id: string;
+        /**
+         * Human-readable name for the entity. Omit to preserve the stored value, or send
+         * an empty string or null to clear it.
+         */
+        displayName?: string | null;
+        /**
+         * The entity type ID this entity instantiates. Required when creating a new
+         * entity; on a re-upsert may be omitted to preserve the existing type. Governance
+         * returns 400 if missing on create.
+         */
+        entityTypeId?: string;
+        /**
+         * Free-form key/value metadata. Patch semantics: empty-string value removes a key,
+         * omitted keys are preserved.
+         */
+        metadata?: {
+            [key: string]: string;
+        };
+    }
+}
+export declare namespace Entities {
+    export { type EntityRetrieveResponse as EntityRetrieveResponse, type EntityListResponse as EntityListResponse, type EntityArchiveResponse as EntityArchiveResponse, type EntityUpsertResponse as EntityUpsertResponse, type EntityListResponsesMyCursorIDPage as EntityListResponsesMyCursorIDPage, type EntityRetrieveParams as EntityRetrieveParams, type EntityListParams as EntityListParams, type EntityArchiveParams as EntityArchiveParams, type EntityUpsertParams as EntityUpsertParams, };
+    export { Entitlements as Entitlements, type EntitlementListResponse as EntitlementListResponse, type EntitlementUpsertResponse as EntitlementUpsertResponse, type EntitlementListResponsesMyCursorIDPage as EntitlementListResponsesMyCursorIDPage, type EntitlementListParams as EntitlementListParams, type EntitlementUpsertParams as EntitlementUpsertParams, };
+}
+//# sourceMappingURL=entities.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/resources/v1/customers/entities/entities.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,qCAAkC;AACxD,OAAO,KAAK,eAAe,0BAAuB;AAClD,OAAO,EACL,qBAAqB,EACrB,uBAAuB,EACvB,sCAAsC,EACtC,uBAAuB,EACvB,yBAAyB,EACzB,YAAY,EACb,0BAAuB;AACxB,OAAO,EAAE,UAAU,EAAE,wCAAqC;AAC1D,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE,uCAAoC;AAErG,OAAO,EAAE,cAAc,EAAE,gDAA6C;AAGtE,qBAAa,QAAS,SAAQ,WAAW;IACvC,YAAY,EAAE,eAAe,CAAC,YAAY,CAAkD;IAE5F;;;;;;;;;;OAUG;IACH,QAAQ,CACN,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAcrC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,kBAAkB,CAAC;IAmBrE;;;;;;;;;;;OAWG;IACH,OAAO,CACL,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAepC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAc3G;AAED,MAAM,MAAM,iCAAiC,GAAG,cAAc,CAAC,kBAAkB,CAAC,CAAC;AAEnF;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC;CACnC;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEpC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACpB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;CACxC;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEpC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,gBAAiB,SAAQ,oBAAoB;IAC5D;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAEnC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEnB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAE3C;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;KACtC;CACF;AAID,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;IAEF,OAAO,EACL,YAAY,IAAI,YAAY,EAC5B,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/entities.js

@@ -0,0 +1,139 @@
+"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 tslib_1 = require("../../../../internal/tslib.js");
+const resource_1 = require("../../../../core/resource.js");
+const EntitlementsAPI = tslib_1.__importStar(require("./entitlements.js"));
+const entitlements_1 = require("./entitlements.js");
+const pagination_1 = require("../../../../core/pagination.js");
+const headers_1 = require("../../../../internal/headers.js");
+const path_1 = require("../../../../internal/utils/path.js");
+class Entities extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.entitlements = new EntitlementsAPI.Entitlements(this._client);
+    }
+    /**
+     * Retrieves a single entity for the given customer by its identifier.
+     *
+     * @example
+     * ```ts
+     * const entity = await client.v1.customers.entities.retrieve(
+     *   'x',
+     *   { id: 'id' },
+     * );
+     * ```
+     */
+    retrieve(entityID, params, options) {
+        const { id, 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params;
+        return this._client.get((0, path_1.path) `/api/v1/customers/${id}/entities/${entityID}`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                {
+                    ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+                    ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Retrieves a paginated list of entities for the given customer.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const entityListResponse of client.v1.customers.entities.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`, (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,
+            ]),
+        });
+    }
+    /**
+     * Archives entities in bulk for the given customer by id. Upsert an archived
+     * entity to restore it.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.customers.entities.archive(
+     *   'id',
+     *   { ids: ['user-7f3a0c1d', 'user-c4d1b2e9'] },
+     * );
+     * ```
+     */
+    archive(id, params, options) {
+        const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+        return this._client.post((0, path_1.path) `/api/v1/customers/${id}/entities/archive`, {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                {
+                    ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+                    ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Creates or updates entities in bulk for the given customer. Existing entities
+     * matched by id are updated; new ids are created. An upsert of an archived entity
+     * restores it. An entity on an archived entity type fails with 400.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.customers.entities.upsert(
+     *   'id',
+     *   {
+     *     entities: [
+     *       {
+     *         id: 'user-7f3a0c1d',
+     *         displayName: 'Jane Doe',
+     *         entityTypeId: 'user',
+     *         metadata: { email: 'jane@acme.com', role: 'admin' },
+     *       },
+     *       {
+     *         id: 'user-c4d1b2e9',
+     *         displayName: 'John Roe',
+     *         entityTypeId: 'user',
+     *         metadata: { email: 'john@acme.com' },
+     *       },
+     *     ],
+     *   },
+     * );
+     * ```
+     */
+    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`, {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                {
+                    ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+                    ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+}
+exports.Entities = Entities;
+Entities.Entitlements = entitlements_1.Entitlements;
+//# sourceMappingURL=entities.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"entities.js","sourceRoot":"","sources":["../../../../src/resources/v1/customers/entities/entities.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,2DAAwD;AACxD,2EAAkD;AAClD,oDAOwB;AAExB,+DAAqG;AACrG,6DAA4D;AAE5D,6DAAuD;AAEvD,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,iBAAY,GAAiC,IAAI,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA4I9F,CAAC;IA1IC;;;;;;;;;;OAUG;IACH,QAAQ,CACN,QAAgB,EAChB,MAA4B,EAC5B,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC;QACtF,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,aAAa,QAAQ,EAAE,EAAE;YAC1E,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;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAU,EACV,SAA8C,EAAE,EAChD,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,WAAW,EACtC,CAAA,2BAAkC,CAAA,EAClC;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;;;;;;;;;;;OAWG;IACH,OAAO,CACL,EAAU,EACV,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,mBAAmB,EAAE;YACvE,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;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,EAAU,EAAE,MAA0B,EAAE,OAAwB;QACrE,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,WAAW,EAAE;YAC9D,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;AA7ID,4BA6IC;AA+RD,QAAQ,CAAC,YAAY,GAAG,2BAAY,CAAC"}

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

@@ -0,0 +1,134 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../../core/resource.mjs";
+import * as EntitlementsAPI from "./entitlements.mjs";
+import { Entitlements, } from "./entitlements.mjs";
+import { MyCursorIDPage } from "../../../../core/pagination.mjs";
+import { buildHeaders } from "../../../../internal/headers.mjs";
+import { path } from "../../../../internal/utils/path.mjs";
+export class Entities extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.entitlements = new EntitlementsAPI.Entitlements(this._client);
+    }
+    /**
+     * Retrieves a single entity for the given customer by its identifier.
+     *
+     * @example
+     * ```ts
+     * const entity = await client.v1.customers.entities.retrieve(
+     *   'x',
+     *   { id: 'id' },
+     * );
+     * ```
+     */
+    retrieve(entityID, params, options) {
+        const { id, 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params;
+        return this._client.get(path `/api/v1/customers/${id}/entities/${entityID}`, {
+            ...options,
+            headers: buildHeaders([
+                {
+                    ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+                    ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Retrieves a paginated list of entities for the given customer.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const entityListResponse of client.v1.customers.entities.list(
+     *   'id',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(id, params = {}, options) {
+        const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params ?? {};
+        return this._client.getAPIList(path `/api/v1/customers/${id}/entities`, (MyCursorIDPage), {
+            query,
+            ...options,
+            headers: buildHeaders([
+                {
+                    ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+                    ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Archives entities in bulk for the given customer by id. Upsert an archived
+     * entity to restore it.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.customers.entities.archive(
+     *   'id',
+     *   { ids: ['user-7f3a0c1d', 'user-c4d1b2e9'] },
+     * );
+     * ```
+     */
+    archive(id, params, options) {
+        const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+        return this._client.post(path `/api/v1/customers/${id}/entities/archive`, {
+            body,
+            ...options,
+            headers: buildHeaders([
+                {
+                    ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+                    ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Creates or updates entities in bulk for the given customer. Existing entities
+     * matched by id are updated; new ids are created. An upsert of an archived entity
+     * restores it. An entity on an archived entity type fails with 400.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.customers.entities.upsert(
+     *   'id',
+     *   {
+     *     entities: [
+     *       {
+     *         id: 'user-7f3a0c1d',
+     *         displayName: 'Jane Doe',
+     *         entityTypeId: 'user',
+     *         metadata: { email: 'jane@acme.com', role: 'admin' },
+     *       },
+     *       {
+     *         id: 'user-c4d1b2e9',
+     *         displayName: 'John Roe',
+     *         entityTypeId: 'user',
+     *         metadata: { email: 'john@acme.com' },
+     *       },
+     *     ],
+     *   },
+     * );
+     * ```
+     */
+    upsert(id, params, options) {
+        const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
+        return this._client.put(path `/api/v1/customers/${id}/entities`, {
+            body,
+            ...options,
+            headers: buildHeaders([
+                {
+                    ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
+                    ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+}
+Entities.Entitlements = Entitlements;
+//# sourceMappingURL=entities.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"entities.mjs","sourceRoot":"","sources":["../../../../src/resources/v1/customers/entities/entities.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,sCAAkC;AACxD,OAAO,KAAK,eAAe,2BAAuB;AAClD,OAAO,EAML,YAAY,GACb,2BAAuB;AAExB,OAAO,EAAE,cAAc,EAA0C,wCAAoC;AACrG,OAAO,EAAE,YAAY,EAAE,yCAAqC;AAE5D,OAAO,EAAE,IAAI,EAAE,4CAAwC;AAEvD,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,iBAAY,GAAiC,IAAI,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA4I9F,CAAC;IA1IC;;;;;;;;;;OAUG;IACH,QAAQ,CACN,QAAgB,EAChB,MAA4B,EAC5B,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC;QACtF,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,EAAE,aAAa,QAAQ,EAAE,EAAE;YAC1E,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;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;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAU,EACV,SAA8C,EAAE,EAChD,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,IAAI,CAAA,qBAAqB,EAAE,WAAW,EACtC,CAAA,cAAkC,CAAA,EAClC;YACE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;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;;;;;;;;;;;OAWG;IACH,OAAO,CACL,EAAU,EACV,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,qBAAqB,EAAE,mBAAmB,EAAE;YACvE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;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;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,EAAU,EAAE,MAA0B,EAAE,OAAwB;QACrE,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3F,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,EAAE,WAAW,EAAE;YAC9D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;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;AA+RD,QAAQ,CAAC,YAAY,GAAG,YAAY,CAAC"}