bem-ai-sdk 0.26.0 → 0.27.0

package/resources/entities/entities.d.ts

@@ -0,0 +1,516 @@
+import { APIResource } from "../../core/resource.js";
+import * as SynonymsAPI from "./synonyms.js";
+import { SynonymAddParams, SynonymAddResponse, SynonymRemoveParams, Synonyms } from "./synonyms.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Entities extends APIResource {
+    synonyms: SynonymsAPI.Synonyms;
+    /**
+     * Update Entity
+     *
+     * @example
+     * ```ts
+     * const entity = await client.entities.update('id', {
+     *   status: 'approved',
+     * });
+     * ```
+     */
+    update(id: string, body: EntityUpdateParams, options?: RequestOptions): APIPromise<EntityUpdateResponse>;
+    /**
+     * Bulk Seed Entities
+     *
+     * @example
+     * ```ts
+     * const response = await client.entities.bulkCreate({
+     *   entities: [
+     *     {
+     *       canonical: 'Acme Corporation',
+     *       type: 'organization',
+     *       description: 'Industrial conglomerate',
+     *       synonyms: ['ACME', 'Acme Corp'],
+     *       attributes: { headquarters: 'Springfield' },
+     *     },
+     *   ],
+     *   onConflict: 'merge',
+     * });
+     * ```
+     */
+    bulkCreate(body: EntityBulkCreateParams, options?: RequestOptions): APIPromise<EntityBulkCreateResponse>;
+    /**
+     * Bulk Validate Entities
+     *
+     * @example
+     * ```ts
+     * const response = await client.entities.bulkValidate({
+     *   entityIDs: ['ent_2abc', 'ent_2def'],
+     *   status: 'approved',
+     * });
+     * ```
+     */
+    bulkValidate(body: EntityBulkValidateParams, options?: RequestOptions): APIPromise<EntityBulkValidateResponse>;
+    /**
+     * Get an Entity's Relations
+     *
+     * @example
+     * ```ts
+     * const response = await client.entities.retrieveRelations(
+     *   'id',
+     * );
+     * ```
+     */
+    retrieveRelations(id: string, query?: EntityRetrieveRelationsParams | null | undefined, options?: RequestOptions): APIPromise<EntityRetrieveRelationsResponse>;
+    /**
+     * Get Seed Job Status
+     *
+     * @example
+     * ```ts
+     * const response = await client.entities.retrieveSeedStatus(
+     *   'id',
+     * );
+     * ```
+     */
+    retrieveSeedStatus(id: string, options?: RequestOptions): APIPromise<EntityRetrieveSeedStatusResponse>;
+}
+/**
+ * An entity record, including its curation status and assigned type.
+ */
+export interface EntityUpdateResponse {
+    /**
+     * The canonical (longest / most descriptive) surface form.
+     */
+    canonical: string;
+    /**
+     * Creation timestamp.
+     */
+    createdAt: string;
+    /**
+     * Public ID (`ent_...`).
+     */
+    entityID: string;
+    /**
+     * Total mentions across parsed documents.
+     */
+    mentionCount: number;
+    /**
+     * Curation lifecycle state.
+     */
+    status: 'extracted' | 'proposed' | 'approved' | 'rejected';
+    /**
+     * Distinct surface forms resolved to this entity.
+     */
+    surfaceForms: Array<string>;
+    /**
+     * The entity's effective type name (assigned type if set, else inferred).
+     */
+    type: string;
+    /**
+     * Last-update timestamp.
+     */
+    updatedAt: string;
+    /**
+     * Free-form description.
+     */
+    description?: string;
+    /**
+     * `ety_...` public ID of the assigned type, when one is set.
+     */
+    typeID?: string;
+    /**
+     * When the entity was approved/rejected. Present only once validated.
+     */
+    validatedAt?: string;
+    /**
+     * `usr_...` public ID of the validating user (dashboard transitions only).
+     */
+    validatedByUserID?: string;
+}
+/**
+ * `200` response for a synchronously processed (small) batch.
+ */
+export interface EntityBulkCreateResponse {
+    /**
+     * Per-row outcomes, in request order.
+     */
+    results: Array<EntityBulkCreateResponse.Result>;
+    /**
+     * Per-outcome tally across a batch.
+     */
+    summary: EntityBulkCreateResponse.Summary;
+}
+export declare namespace EntityBulkCreateResponse {
+    /**
+     * The outcome of seeding one row.
+     */
+    interface Result {
+        /**
+         * The canonical name from the input row.
+         */
+        canonical: string;
+        /**
+         * What happened to this row: `created` (new entity), `merged-with` (matched an
+         * existing entity), or `rejected` (see `reason`).
+         */
+        outcome: 'created' | 'merged-with' | 'rejected';
+        /**
+         * Public ID (`ent_...`) of the created or merged entity. Absent when rejected.
+         */
+        entityID?: string;
+        /**
+         * Human-readable explanation when `outcome` is `rejected`.
+         */
+        reason?: string;
+    }
+    /**
+     * Per-outcome tally across a batch.
+     */
+    interface Summary {
+        /**
+         * Number of rows that created a new entity.
+         */
+        created: number;
+        /**
+         * Number of rows merged into an existing entity.
+         */
+        merged: number;
+        /**
+         * Number of rows rejected.
+         */
+        rejected: number;
+    }
+}
+/**
+ * `200` response for `POST /v3/entities/bulk-validate`.
+ */
+export interface EntityBulkValidateResponse {
+    /**
+     * Per-row outcomes, in request order.
+     */
+    results: Array<EntityBulkValidateResponse.Result>;
+    /**
+     * Per-outcome tally across a bulk-validate batch.
+     */
+    summary: EntityBulkValidateResponse.Summary;
+}
+export declare namespace EntityBulkValidateResponse {
+    /**
+     * The outcome of validating one row.
+     */
+    interface Result {
+        /**
+         * The `ent_...` ID from the request.
+         */
+        entityID: string;
+        /**
+         * `validated` (transition applied), `skipped` (not found or not authorized), or
+         * `rejected-row` (the transition itself was illegal, e.g. already terminal).
+         */
+        outcome: 'validated' | 'skipped' | 'rejected-row';
+        /**
+         * Explanation for a `skipped` or `rejected-row` outcome.
+         */
+        reason?: string;
+    }
+    /**
+     * Per-outcome tally across a bulk-validate batch.
+     */
+    interface Summary {
+        /**
+         * Rows whose transition was illegal.
+         */
+        rejectedRow: number;
+        /**
+         * Rows skipped (not found / not authorized).
+         */
+        skipped: number;
+        /**
+         * Rows whose transition was applied.
+         */
+        validated: number;
+    }
+}
+/**
+ * Response body for `GET /v3/entities/{id}/relations`.
+ */
+export interface EntityRetrieveRelationsResponse {
+    /**
+     * Edges pointing at the queried entity.
+     */
+    inbound: Array<EntityRetrieveRelationsResponse.Inbound>;
+    /**
+     * Edges pointing away from the queried entity.
+     */
+    outbound: Array<EntityRetrieveRelationsResponse.Outbound>;
+    /**
+     * Opaque cursor for the next page of edges, or absent on the last page. Pass it
+     * back as `cursor`.
+     */
+    nextCursor?: string;
+}
+export declare namespace EntityRetrieveRelationsResponse {
+    /**
+     * One edge pointing AT the queried entity (some other entity is the source).
+     */
+    interface Inbound {
+        /**
+         * First-seen timestamp of the edge (RFC 3339).
+         */
+        firstSeenAt: string;
+        /**
+         * How many times this edge has been observed across parsed documents.
+         */
+        mentionCount: number;
+        /**
+         * Free-form relation label (e.g. `author_of`, `affiliated_with`).
+         */
+        relationType: string;
+        /**
+         * A compact view of an entity sitting on the far end of a relation edge — the
+         * stable public id, the canonical name, and the effective type. The full entity is
+         * fetched separately via the entity detail / File System endpoints.
+         */
+        sourceEntity: Inbound.SourceEntity;
+    }
+    namespace Inbound {
+        /**
+         * A compact view of an entity sitting on the far end of a relation edge — the
+         * stable public id, the canonical name, and the effective type. The full entity is
+         * fetched separately via the entity detail / File System endpoints.
+         */
+        interface SourceEntity {
+            /**
+             * Stable public identifier for the entity (`ent_...`).
+             */
+            id: string;
+            /**
+             * Canonical (most descriptive) surface form of the entity.
+             */
+            canonical: string;
+            /**
+             * Effective entity type.
+             */
+            type: string;
+        }
+    }
+    /**
+     * One edge pointing AWAY from the queried entity (it is the source).
+     */
+    interface Outbound {
+        /**
+         * First-seen timestamp of the edge (RFC 3339).
+         */
+        firstSeenAt: string;
+        /**
+         * How many times this edge has been observed across parsed documents.
+         */
+        mentionCount: number;
+        /**
+         * Free-form relation label (e.g. `author_of`, `affiliated_with`).
+         */
+        relationType: string;
+        /**
+         * A compact view of an entity sitting on the far end of a relation edge — the
+         * stable public id, the canonical name, and the effective type. The full entity is
+         * fetched separately via the entity detail / File System endpoints.
+         */
+        targetEntity: Outbound.TargetEntity;
+    }
+    namespace Outbound {
+        /**
+         * A compact view of an entity sitting on the far end of a relation edge — the
+         * stable public id, the canonical name, and the effective type. The full entity is
+         * fetched separately via the entity detail / File System endpoints.
+         */
+        interface TargetEntity {
+            /**
+             * Stable public identifier for the entity (`ent_...`).
+             */
+            id: string;
+            /**
+             * Canonical (most descriptive) surface form of the entity.
+             */
+            canonical: string;
+            /**
+             * Effective entity type.
+             */
+            type: string;
+        }
+    }
+}
+/**
+ * `GET /v3/entities/seed/{id}` response.
+ */
+export interface EntityRetrieveSeedStatusResponse {
+    /**
+     * Rows that created a new entity.
+     */
+    createdCount: number;
+    /**
+     * Rows merged into an existing entity.
+     */
+    mergedCount: number;
+    /**
+     * Rows rejected.
+     */
+    rejectedCount: number;
+    /**
+     * Public ID (`esj_...`) of the seed job.
+     */
+    seedJobID: string;
+    /**
+     * Lifecycle state.
+     */
+    status: 'pending' | 'processing' | 'completed' | 'failed';
+    /**
+     * Total rows in the submitted batch.
+     */
+    totalRows: number;
+    /**
+     * Terminal error message when `status` is `failed`.
+     */
+    error?: string;
+    /**
+     * Per-row outcomes. Present only once `status` is `completed`.
+     */
+    results?: Array<EntityRetrieveSeedStatusResponse.Result>;
+}
+export declare namespace EntityRetrieveSeedStatusResponse {
+    /**
+     * The outcome of seeding one row.
+     */
+    interface Result {
+        /**
+         * The canonical name from the input row.
+         */
+        canonical: string;
+        /**
+         * What happened to this row: `created` (new entity), `merged-with` (matched an
+         * existing entity), or `rejected` (see `reason`).
+         */
+        outcome: 'created' | 'merged-with' | 'rejected';
+        /**
+         * Public ID (`ent_...`) of the created or merged entity. Absent when rejected.
+         */
+        entityID?: string;
+        /**
+         * Human-readable explanation when `outcome` is `rejected`.
+         */
+        reason?: string;
+    }
+}
+export interface EntityUpdateParams {
+    /**
+     * Surface forms to attach as `customer_defined` synonyms.
+     */
+    addSynonyms?: Array<string>;
+    /**
+     * The `ety_...` public ID of the type to assign (overriding the bem-inferred
+     * type). The empty string clears the assignment. Omit to leave unchanged.
+     */
+    assignedTypeID?: string;
+    /**
+     * Replace the entity's canonical surface form (re-derives its normalized form).
+     */
+    canonical?: string;
+    /**
+     * Optional BCP 47 locale tag stamped on any added synonyms.
+     */
+    locale?: string;
+    /**
+     * `esn_...` synonym IDs to soft-delete. Only `customer_defined` / `sme_approved`
+     * synonyms may be removed; an `extracted` synonym is rejected with `409`.
+     */
+    removeSynonymIDs?: Array<string>;
+    /**
+     * Transition the entity's curation status. Only `approved` or `rejected` are
+     * accepted, and only from `extracted` or `proposed` (any other transition is
+     * rejected with `409`).
+     */
+    status?: 'approved' | 'rejected';
+}
+export interface EntityBulkCreateParams {
+    /**
+     * The entities to seed. Must be non-empty.
+     */
+    entities: Array<EntityBulkCreateParams.Entity>;
+    /**
+     * Optional bucket public ID (`bkt_...`) to seed into. Omit to use the
+     * account+environment default bucket.
+     */
+    bucket?: string;
+    /**
+     * Conflict strategy for an entity that already exists. Only `merge` is supported
+     * and it is the default: synonyms are added additively, a longer description
+     * replaces the old one, and attributes are merged with new keys winning.
+     */
+    onConflict?: 'merge';
+}
+export declare namespace EntityBulkCreateParams {
+    /**
+     * One entity to seed in a `POST /v3/entities/bulk` batch.
+     */
+    interface Entity {
+        /**
+         * The canonical (longest / most descriptive) surface form for the entity, e.g.
+         * `Acme Corporation`. Required. Normalized (lowercased, whitespace-folded) for the
+         * uniqueness key.
+         */
+        canonical: string;
+        /**
+         * The entity type name, e.g. `instrument` or `organization`. Required. Resolved
+         * against your taxonomy and created if it does not yet exist.
+         */
+        type: string;
+        /**
+         * Optional per-entity structured attribute values, e.g.
+         * `{ "manufacturer": "Acme", "dosageMg": 50 }`. When the entity's type declares an
+         * attribute schema, keys not present in that schema cause the row to be rejected.
+         */
+        attributes?: unknown;
+        /**
+         * Optional free-form description of the entity.
+         */
+        description?: string;
+        /**
+         * Optional additional surface forms to attach as `customer_defined` synonyms.
+         */
+        synonyms?: Array<string>;
+    }
+}
+export interface EntityBulkValidateParams {
+    /**
+     * The `ent_...` IDs to transition. Must be non-empty.
+     */
+    entityIDs: Array<string>;
+    /**
+     * Terminal status to apply to every entity.
+     */
+    status: 'approved' | 'rejected';
+}
+export interface EntityRetrieveRelationsParams {
+    /**
+     * Optional bucket public ID (`bkt_...`) to scope the read to one bucket. Omit for
+     * the unscoped (all account+environment) view.
+     */
+    bucket?: string;
+    /**
+     * Cursor: return edges whose KSUID sorts after this value.
+     */
+    cursor?: string;
+    /**
+     * Which edges to return relative to the entity. Defaults to `both`.
+     */
+    direction?: 'inbound' | 'outbound' | 'both';
+    /**
+     * Maximum number of edges to return (default 50, max 200).
+     */
+    limit?: number;
+    /**
+     * Exact-match filter on the relation label.
+     */
+    relationType?: string;
+}
+export declare namespace Entities {
+    export { type EntityUpdateResponse as EntityUpdateResponse, type EntityBulkCreateResponse as EntityBulkCreateResponse, type EntityBulkValidateResponse as EntityBulkValidateResponse, type EntityRetrieveRelationsResponse as EntityRetrieveRelationsResponse, type EntityRetrieveSeedStatusResponse as EntityRetrieveSeedStatusResponse, type EntityUpdateParams as EntityUpdateParams, type EntityBulkCreateParams as EntityBulkCreateParams, type EntityBulkValidateParams as EntityBulkValidateParams, type EntityRetrieveRelationsParams as EntityRetrieveRelationsParams, };
+    export { Synonyms as Synonyms, type SynonymAddResponse as SynonymAddResponse, type SynonymAddParams as SynonymAddParams, type SynonymRemoveParams as SynonymRemoveParams, };
+}
+//# sourceMappingURL=entities.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../src/resources/entities/entities.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,QAAQ,EAAE,sBAAmB;AACjG,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,QAAS,SAAQ,WAAW;IACvC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAIxG;;;;;;;;;;;;;;;;;;OAkBG;IACH,UAAU,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAIxG;;;;;;;;;;OAUG;IACH,YAAY,CACV,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAIzC;;;;;;;;;OASG;IACH,iBAAiB,CACf,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C;;;;;;;;;OASG;IACH,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gCAAgC,CAAC;CAGvG;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,UAAU,CAAC;IAE3D;;OAEG;IACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;IAEhD;;OAEG;IACH,OAAO,EAAE,wBAAwB,CAAC,OAAO,CAAC;CAC3C;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,OAAO,EAAE,SAAS,GAAG,aAAa,GAAG,UAAU,CAAC;QAEhD;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC;IAElD;;OAEG;IACH,OAAO,EAAE,0BAA0B,CAAC,OAAO,CAAC;CAC7C;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,OAAO,EAAE,WAAW,GAAG,SAAS,GAAG,cAAc,CAAC;QAElD;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;IAExD;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,+BAA+B,CAAC,QAAQ,CAAC,CAAC;IAE1D;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,+BAA+B,CAAC;IAC/C;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;;;WAIG;QACH,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC;KACpC;IAED,UAAiB,OAAO,CAAC;QACvB;;;;WAIG;QACH,UAAiB,YAAY;YAC3B;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;IAED;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;;;WAIG;QACH,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC;KACrC;IAED,UAAiB,QAAQ,CAAC;QACxB;;;;WAIG;QACH,UAAiB,YAAY;YAC3B;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC;IAE1D;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,gCAAgC,CAAC,MAAM,CAAC,CAAC;CAC1D;AAED,yBAAiB,gCAAgC,CAAC;IAChD;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,OAAO,EAAE,SAAS,GAAG,aAAa,GAAG,UAAU,CAAC;QAEhD;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEjC;;;;OAIG;IACH,MAAM,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC;CAClC;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAE/C;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,MAAM;QACrB;;;;WAIG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;;;WAIG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC1B;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,MAAM,EAAE,UAAU,GAAG,UAAU,CAAC;CACjC;AAED,MAAM,WAAW,6BAA6B;IAC5C;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,MAAM,CAAC;IAE5C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAID,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/entities/entities.js

@@ -0,0 +1,93 @@
+"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 SynonymsAPI = tslib_1.__importStar(require("./synonyms.js"));
+const synonyms_1 = require("./synonyms.js");
+const path_1 = require("../../internal/utils/path.js");
+class Entities extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.synonyms = new SynonymsAPI.Synonyms(this._client);
+    }
+    /**
+     * Update Entity
+     *
+     * @example
+     * ```ts
+     * const entity = await client.entities.update('id', {
+     *   status: 'approved',
+     * });
+     * ```
+     */
+    update(id, body, options) {
+        return this._client.patch((0, path_1.path) `/v3/entities/${id}`, { body, ...options });
+    }
+    /**
+     * Bulk Seed Entities
+     *
+     * @example
+     * ```ts
+     * const response = await client.entities.bulkCreate({
+     *   entities: [
+     *     {
+     *       canonical: 'Acme Corporation',
+     *       type: 'organization',
+     *       description: 'Industrial conglomerate',
+     *       synonyms: ['ACME', 'Acme Corp'],
+     *       attributes: { headquarters: 'Springfield' },
+     *     },
+     *   ],
+     *   onConflict: 'merge',
+     * });
+     * ```
+     */
+    bulkCreate(body, options) {
+        return this._client.post('/v3/entities/bulk', { body, ...options });
+    }
+    /**
+     * Bulk Validate Entities
+     *
+     * @example
+     * ```ts
+     * const response = await client.entities.bulkValidate({
+     *   entityIDs: ['ent_2abc', 'ent_2def'],
+     *   status: 'approved',
+     * });
+     * ```
+     */
+    bulkValidate(body, options) {
+        return this._client.post('/v3/entities/bulk-validate', { body, ...options });
+    }
+    /**
+     * Get an Entity's Relations
+     *
+     * @example
+     * ```ts
+     * const response = await client.entities.retrieveRelations(
+     *   'id',
+     * );
+     * ```
+     */
+    retrieveRelations(id, query = {}, options) {
+        return this._client.get((0, path_1.path) `/v3/entities/${id}/relations`, { query, ...options });
+    }
+    /**
+     * Get Seed Job Status
+     *
+     * @example
+     * ```ts
+     * const response = await client.entities.retrieveSeedStatus(
+     *   'id',
+     * );
+     * ```
+     */
+    retrieveSeedStatus(id, options) {
+        return this._client.get((0, path_1.path) `/v3/entities/seed/${id}`, options);
+    }
+}
+exports.Entities = Entities;
+Entities.Synonyms = synonyms_1.Synonyms;
+//# sourceMappingURL=entities.js.map

package/resources/entities/entities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.js","sourceRoot":"","sources":["../../src/resources/entities/entities.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,mEAA0C;AAC1C,4CAAiG;AAGjG,uDAAiD;AAEjD,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAwF1E,CAAC;IAtFC;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,IAAwB,EAAE,OAAwB;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,UAAU,CAAC,IAA4B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;OAUG;IACH,YAAY,CACV,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;OASG;IACH,iBAAiB,CACf,EAAU,EACV,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;OASG;IACH,kBAAkB,CAAC,EAAU,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;CACF;AAzFD,4BAyFC;AAugBD,QAAQ,CAAC,QAAQ,GAAG,mBAAQ,CAAC"}