@stigg/typescript 0.1.0-beta.2 → 0.1.0-beta.21

package/resources/v1/events/beta/customers/entities.d.mts

@@ -0,0 +1,360 @@
+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 Entities extends APIResource {
+    /**
+     * Retrieves a single entity for the given customer by its identifier.
+     *
+     * @example
+     * ```ts
+     * const entity =
+     *   await client.v1.events.beta.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.events.beta.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.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.events.beta.customers.entities.archive(
+     *     'id',
+     *     { ids: ['user-7f3a0c1d', 'user-c4d1b2e9'] },
+     *   );
+     * ```
+     */
+    archive(id: string, params: EntityArchiveParams, options?: RequestOptions): APIPromise<EntityArchiveResponse>;
+    /**
+     * Restores previously archived entities in bulk for the given customer by id.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.events.beta.customers.entities.unarchive(
+     *     'id',
+     *     { ids: ['user-7f3a0c1d', 'user-c4d1b2e9'] },
+     *   );
+     * ```
+     */
+    unarchive(id: string, params: EntityUnarchiveParams, options?: RequestOptions): APIPromise<EntityUnarchiveResponse>;
+    /**
+     * 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.v1.events.beta.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: 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;
+        /**
+         * Free-form key/value metadata attached to the entity
+         */
+        metadata: {
+            [key: string]: string;
+        };
+        /**
+         * The entity type identifier this entity instantiates
+         */
+        typeId: 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;
+    /**
+     * Free-form key/value metadata attached to the entity
+     */
+    metadata: {
+        [key: string]: string;
+    };
+    /**
+     * The entity type identifier this entity instantiates
+     */
+    typeId: 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>;
+    }
+}
+/**
+ * Wrapped response echoing the ids that were acted on by an archive/unarchive call
+ */
+export interface EntityUnarchiveResponse {
+    /**
+     * List of entity identifiers that were acted on
+     */
+    data: EntityUnarchiveResponse.Data;
+}
+export declare namespace EntityUnarchiveResponse {
+    /**
+     * 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;
+        /**
+         * Free-form key/value metadata attached to the entity
+         */
+        metadata: {
+            [key: string]: string;
+        };
+        /**
+         * The entity type identifier this entity instantiates
+         */
+        typeId: 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: Whether to include archived entities. One of: true, false
+     */
+    includeArchived?: 'true' | 'false';
+    /**
+     * Query param: Filter results to entities of a specific entity type, by the type's
+     * refId
+     */
+    typeRefId?: 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 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 EntityUnarchiveParams {
+    /**
+     * 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;
+        /**
+         * Free-form key/value metadata. Patch semantics: empty-string value removes a key,
+         * omitted keys are preserved.
+         */
+        metadata?: {
+            [key: string]: string;
+        };
+        /**
+         * The entity type refId 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.
+         */
+        typeRefId?: string;
+    }
+}
+export declare namespace Entities {
+    export { type EntityRetrieveResponse as EntityRetrieveResponse, type EntityListResponse as EntityListResponse, type EntityArchiveResponse as EntityArchiveResponse, type EntityUnarchiveResponse as EntityUnarchiveResponse, type EntityUpsertResponse as EntityUpsertResponse, type EntityListResponsesMyCursorIDPage as EntityListResponsesMyCursorIDPage, type EntityRetrieveParams as EntityRetrieveParams, type EntityListParams as EntityListParams, type EntityArchiveParams as EntityArchiveParams, type EntityUnarchiveParams as EntityUnarchiveParams, type EntityUpsertParams as EntityUpsertParams, };
+}
+//# sourceMappingURL=entities.d.mts.map

package/resources/v1/events/beta/customers/entities.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.d.mts","sourceRoot":"","sources":["../../../../../src/resources/v1/events/beta/customers/entities.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,yCAAqC;AAC3D,OAAO,EAAE,UAAU,EAAE,4CAAwC;AAC7D,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE,2CAAuC;AAExG,OAAO,EAAE,cAAc,EAAE,oDAAgD;AAGzE,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;OAWG;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;;;;;;;;;;;OAWG;IACH,SAAS,CACP,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAetC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;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;;WAEG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEpC;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;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;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;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,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;CACpC;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;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;;WAEG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEpC;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;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;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAEnC;;;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,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,qBAAqB;IACpC;;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,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAErC;;;;WAIG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,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,uBAAuB,IAAI,uBAAuB,EACvD,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,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}