bem-ai-sdk 0.26.0 → 0.28.0

package/resources/review-queue.d.ts

@@ -0,0 +1,192 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+/**
+ * The reviewer-facing read surface for entity curation, available on the
+ * dashboard (JWT) only.
+ *
+ * - **`GET /v3/review-queue`** returns a cursor-paginated set of entities
+ *   awaiting curation, scoped to your account+environment (and optional
+ *   `bucket`). Each row is a full entity plus a small preview (up to 2) of
+ *   its first mentions, so a reviewer can triage without opening every
+ *   entity.
+ *
+ * Filters AND together. `status` (repeatable) defaults to the pre-terminal
+ * states `extracted` + `proposed` when omitted. `type` (repeatable `ety_…`
+ * IDs) matches the entity's *effective* type — its assigned type id, or, for
+ * entities with no assigned type, its bem-inferred type name. `assignedTo`
+ * (`me` or a `usr_…` ID) restricts to entities whose effective type the user
+ * reviews. `since` (RFC3339) filters by creation time. Pagination is
+ * cursor-based on `entityID` ascending; default limit 50, maximum 200.
+ */
+export declare class ReviewQueue extends APIResource {
+    /**
+     * **List entities awaiting curation, for a human reviewer's queue.**
+     *
+     * Returns a cursor-paginated set of entities scoped to your account+environment
+     * (and optional `bucket`), each carrying a small preview of its first mentions so
+     * a reviewer can triage without opening every entity. All filters AND together.
+     *
+     * - **`status`** (repeatable) restricts to the given lifecycle states. Omitting it
+     *   defaults to the pre-terminal states `extracted` and `proposed`.
+     * - **`type`** (repeatable, `ety_...` IDs) matches the entity's _effective_ type:
+     *   an entity matches when its assigned type is one of these IDs, or it has no
+     *   assigned type and its bem-inferred type name matches one of them.
+     * - **`assignedTo`** (`me` or a `usr_...` ID) restricts to entities whose
+     *   effective type the given user reviews. `me` resolves to the calling user.
+     * - **`since`** (RFC3339) restricts to entities created at or after the time.
+     *
+     * Pagination is cursor-based on `entityID` ascending; default limit is 50,
+     * maximum 200.
+     */
+    list(query?: ReviewQueueListParams | null | undefined, options?: RequestOptions): APIPromise<ReviewQueueListResponse>;
+}
+/**
+ * `GET /v3/review-queue` response. Cursor-paginated by `entityID` ascending.
+ */
+export interface ReviewQueueListResponse {
+    /**
+     * The page of entities awaiting curation.
+     */
+    entities: Array<ReviewQueueListResponse.Entity>;
+    /**
+     * Whether more rows exist beyond this page.
+     */
+    hasMore: boolean;
+    /**
+     * Opaque cursor to pass as `?cursor=` for the next page. Empty when `hasMore` is
+     * false.
+     */
+    nextCursor?: string;
+}
+export declare namespace ReviewQueueListResponse {
+    /**
+     * One row of the review queue: an entity plus a small preview of its mentions.
+     */
+    interface Entity {
+        /**
+         * The canonical (longest / most descriptive) surface form.
+         */
+        canonical: string;
+        /**
+         * When the entity was created.
+         */
+        createdAt: string;
+        /**
+         * Public ID (`ent_...`) of the entity.
+         */
+        entityID: string;
+        /**
+         * Total mentions across all parsed documents.
+         */
+        mentionCount: number;
+        /**
+         * A capped preview (up to 2) of the entity's first mentions, ordered by page then
+         * time, so a reviewer can triage without opening each entity.
+         */
+        previewMentions: Array<Entity.PreviewMention>;
+        /**
+         * Curation lifecycle state: `extracted`, `proposed`, `approved`, `rejected`.
+         */
+        status: string;
+        /**
+         * Distinct surface forms that have resolved to this entity.
+         */
+        surfaceForms: Array<string>;
+        /**
+         * The effective type name (assigned override if set, else bem-inferred).
+         */
+        type: string;
+        /**
+         * When the entity was last updated.
+         */
+        updatedAt: string;
+        /**
+         * Free-form description of the entity, when present.
+         */
+        description?: string;
+        /**
+         * Public ID (`ety_...`) of the customer-assigned type, when one is set.
+         */
+        typeID?: string;
+        /**
+         * When a human approved/rejected the entity. Omitted while un-validated.
+         */
+        validatedAt?: string;
+        /**
+         * Public ID (`usr_...`) of the user who validated the entity, when known.
+         */
+        validatedByUserID?: string;
+    }
+    namespace Entity {
+        /**
+         * A single per-document occurrence of an entity, used in review-queue previews.
+         */
+        interface PreviewMention {
+            /**
+             * When this mention was recorded.
+             */
+            createdAt: string;
+            /**
+             * Public ID (`ent_...`) of the entity this mention resolves to.
+             */
+            entityID: string;
+            /**
+             * Public ID (`emn_...`) of this mention.
+             */
+            mentionID: string;
+            /**
+             * 1-indexed page number within the source document.
+             */
+            page: number;
+            /**
+             * The user-provided document handle this mention came from.
+             */
+            referenceID: string;
+            /**
+             * The exact surface string Parse extracted on the page.
+             */
+            surface: string;
+            /**
+             * The parse-emitted section label this mention sat under, when present.
+             */
+            sectionLabel?: string;
+            /**
+             * Public ID of the parse transformation that produced this mention, when known.
+             */
+            transformationID?: string;
+        }
+    }
+}
+export interface ReviewQueueListParams {
+    /**
+     * `me` or a `usr_...` ID — restrict to entities whose effective type that user
+     * reviews.
+     */
+    assignedTo?: string;
+    /**
+     * Optional bucket public ID (`bkt_...`) to scope to. Omit for all buckets.
+     */
+    bucket?: string;
+    /**
+     * Cursor — an `entityID` defining your place in the list.
+     */
+    cursor?: string;
+    limit?: number;
+    /**
+     * RFC3339 timestamp — restrict to entities created at or after this time.
+     */
+    since?: string;
+    /**
+     * Restrict to these lifecycle states. Defaults to `extracted` + `proposed`.
+     */
+    status?: Array<string>;
+    /**
+     * Restrict to entities whose effective type is one of these `ety_...` IDs.
+     */
+    type?: Array<string>;
+}
+export declare namespace ReviewQueue {
+    export { type ReviewQueueListResponse as ReviewQueueListResponse, type ReviewQueueListParams as ReviewQueueListParams, };
+}
+//# sourceMappingURL=review-queue.d.ts.map

package/resources/review-queue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"review-queue.d.ts","sourceRoot":"","sources":["../src/resources/review-queue.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAGvC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAEhD;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAE9C;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE5B;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;KAC5B;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,cAAc;YAC7B;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;SAC3B;KACF;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/review-queue.js

@@ -0,0 +1,49 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReviewQueue = void 0;
+const resource_1 = require("../core/resource.js");
+/**
+ * The reviewer-facing read surface for entity curation, available on the
+ * dashboard (JWT) only.
+ *
+ * - **`GET /v3/review-queue`** returns a cursor-paginated set of entities
+ *   awaiting curation, scoped to your account+environment (and optional
+ *   `bucket`). Each row is a full entity plus a small preview (up to 2) of
+ *   its first mentions, so a reviewer can triage without opening every
+ *   entity.
+ *
+ * Filters AND together. `status` (repeatable) defaults to the pre-terminal
+ * states `extracted` + `proposed` when omitted. `type` (repeatable `ety_…`
+ * IDs) matches the entity's *effective* type — its assigned type id, or, for
+ * entities with no assigned type, its bem-inferred type name. `assignedTo`
+ * (`me` or a `usr_…` ID) restricts to entities whose effective type the user
+ * reviews. `since` (RFC3339) filters by creation time. Pagination is
+ * cursor-based on `entityID` ascending; default limit 50, maximum 200.
+ */
+class ReviewQueue extends resource_1.APIResource {
+    /**
+     * **List entities awaiting curation, for a human reviewer's queue.**
+     *
+     * Returns a cursor-paginated set of entities scoped to your account+environment
+     * (and optional `bucket`), each carrying a small preview of its first mentions so
+     * a reviewer can triage without opening every entity. All filters AND together.
+     *
+     * - **`status`** (repeatable) restricts to the given lifecycle states. Omitting it
+     *   defaults to the pre-terminal states `extracted` and `proposed`.
+     * - **`type`** (repeatable, `ety_...` IDs) matches the entity's _effective_ type:
+     *   an entity matches when its assigned type is one of these IDs, or it has no
+     *   assigned type and its bem-inferred type name matches one of them.
+     * - **`assignedTo`** (`me` or a `usr_...` ID) restricts to entities whose
+     *   effective type the given user reviews. `me` resolves to the calling user.
+     * - **`since`** (RFC3339) restricts to entities created at or after the time.
+     *
+     * Pagination is cursor-based on `entityID` ascending; default limit is 50,
+     * maximum 200.
+     */
+    list(query = {}, options) {
+        return this._client.get('/v3/review-queue', { query, ...options });
+    }
+}
+exports.ReviewQueue = ReviewQueue;
+//# sourceMappingURL=review-queue.js.map

package/resources/review-queue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"review-queue.js","sourceRoot":"","sources":["../src/resources/review-queue.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,CACF,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;CACF;AA1BD,kCA0BC"}

package/resources/review-queue.mjs

@@ -0,0 +1,45 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+/**
+ * The reviewer-facing read surface for entity curation, available on the
+ * dashboard (JWT) only.
+ *
+ * - **`GET /v3/review-queue`** returns a cursor-paginated set of entities
+ *   awaiting curation, scoped to your account+environment (and optional
+ *   `bucket`). Each row is a full entity plus a small preview (up to 2) of
+ *   its first mentions, so a reviewer can triage without opening every
+ *   entity.
+ *
+ * Filters AND together. `status` (repeatable) defaults to the pre-terminal
+ * states `extracted` + `proposed` when omitted. `type` (repeatable `ety_…`
+ * IDs) matches the entity's *effective* type — its assigned type id, or, for
+ * entities with no assigned type, its bem-inferred type name. `assignedTo`
+ * (`me` or a `usr_…` ID) restricts to entities whose effective type the user
+ * reviews. `since` (RFC3339) filters by creation time. Pagination is
+ * cursor-based on `entityID` ascending; default limit 50, maximum 200.
+ */
+export class ReviewQueue extends APIResource {
+    /**
+     * **List entities awaiting curation, for a human reviewer's queue.**
+     *
+     * Returns a cursor-paginated set of entities scoped to your account+environment
+     * (and optional `bucket`), each carrying a small preview of its first mentions so
+     * a reviewer can triage without opening every entity. All filters AND together.
+     *
+     * - **`status`** (repeatable) restricts to the given lifecycle states. Omitting it
+     *   defaults to the pre-terminal states `extracted` and `proposed`.
+     * - **`type`** (repeatable, `ety_...` IDs) matches the entity's _effective_ type:
+     *   an entity matches when its assigned type is one of these IDs, or it has no
+     *   assigned type and its bem-inferred type name matches one of them.
+     * - **`assignedTo`** (`me` or a `usr_...` ID) restricts to entities whose
+     *   effective type the given user reviews. `me` resolves to the calling user.
+     * - **`since`** (RFC3339) restricts to entities created at or after the time.
+     *
+     * Pagination is cursor-based on `entityID` ascending; default limit is 50,
+     * maximum 200.
+     */
+    list(query = {}, options) {
+        return this._client.get('/v3/review-queue', { query, ...options });
+    }
+}
+//# sourceMappingURL=review-queue.mjs.map

package/resources/review-queue.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"review-queue.mjs","sourceRoot":"","sources":["../src/resources/review-queue.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,CACF,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;CACF"}

package/resources/subscriptions.d.mts

@@ -4,11 +4,23 @@ import { RequestOptions } from "../internal/request-options.mjs";
 /**
  * Subscriptions wire up notifications for the events your functions and collections produce.
  *
- * Each subscription targets a single function (by `functionName` or `functionID`) or a single
- * collection (by `collectionName` or `collectionID`) and selects a `type` corresponding to the
+ * Most subscriptions target a single function (by `functionName` or `functionID`) or a single
+ * collection (by `collectionName` or `collectionID`) and select a `type` corresponding to the
  * event you want to receive — for example `transform`, `route`, `join`, `evaluation`, `error`,
  * `enrich`, or `collection_processing`.
  *
+ * Entity-lifecycle events are account-wide and target no function or collection. Set `type` to
+ * one of the following and provide a `webhookURL` (these event types support webhook delivery
+ * only):
+ *
+ * - `entity_proposed` — an entity entered the `proposed` curation status (queued for review).
+ * - `entity_validated` — an entity was approved/validated by a reviewer.
+ * - `entity_rejected` — an entity was rejected by a reviewer.
+ *
+ * Each entity-lifecycle delivery is a JSON POST describing the transition (`entityID`,
+ * `typeName`, `priorStatus`, `newStatus`, optional `actorUserID` and `reason`, and a
+ * `timestamp`).
+ *
  * Deliveries can be sent to any combination of:
  *
  * - `webhookURL` — HTTPS endpoint that receives a JSON POST per event.

package/resources/subscriptions.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"subscriptions.d.mts","sourceRoot":"","sources":["../src/resources/subscriptions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAI5F;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAItF;;;OAGG;IACH,MAAM,CACJ,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;IAI7B;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;OAEG;IACH,MAAM,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM3E;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,EACA,WAAW,GACX,SAAS,GACT,OAAO,GACP,MAAM,GACN,kBAAkB,GAClB,YAAY,GACZ,YAAY,GACZ,OAAO,GACP,iBAAiB,GACjB,QAAQ,GACR,uBAAuB,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,wBAAwB,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;AAE7D,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EACA,WAAW,GACX,SAAS,GACT,OAAO,GACP,MAAM,GACN,kBAAkB,GAClB,YAAY,GACZ,YAAY,GACZ,OAAO,GACP,iBAAiB,GACjB,QAAQ,GACR,uBAAuB,CAAC;IAE5B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EACD,WAAW,GACX,SAAS,GACT,OAAO,GACP,MAAM,GACN,kBAAkB,GAClB,YAAY,GACZ,YAAY,GACZ,OAAO,GACP,iBAAiB,GACjB,QAAQ,GACR,uBAAuB,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,sBAAsB;IACrC;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAE3B;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
+{"version":3,"file":"subscriptions.d.mts","sourceRoot":"","sources":["../src/resources/subscriptions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAI5F;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAItF;;;OAGG;IACH,MAAM,CACJ,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;IAI7B;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;OAEG;IACH,MAAM,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM3E;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,EACA,WAAW,GACX,SAAS,GACT,OAAO,GACP,MAAM,GACN,kBAAkB,GAClB,YAAY,GACZ,YAAY,GACZ,OAAO,GACP,iBAAiB,GACjB,QAAQ,GACR,uBAAuB,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,wBAAwB,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;AAE7D,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EACA,WAAW,GACX,SAAS,GACT,OAAO,GACP,MAAM,GACN,kBAAkB,GAClB,YAAY,GACZ,YAAY,GACZ,OAAO,GACP,iBAAiB,GACjB,QAAQ,GACR,uBAAuB,CAAC;IAE5B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EACD,WAAW,GACX,SAAS,GACT,OAAO,GACP,MAAM,GACN,kBAAkB,GAClB,YAAY,GACZ,YAAY,GACZ,OAAO,GACP,iBAAiB,GACjB,QAAQ,GACR,uBAAuB,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,sBAAsB;IACrC;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAE3B;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}

package/resources/subscriptions.d.ts

@@ -4,11 +4,23 @@ import { RequestOptions } from "../internal/request-options.js";
 /**
  * Subscriptions wire up notifications for the events your functions and collections produce.
  *
- * Each subscription targets a single function (by `functionName` or `functionID`) or a single
- * collection (by `collectionName` or `collectionID`) and selects a `type` corresponding to the
+ * Most subscriptions target a single function (by `functionName` or `functionID`) or a single
+ * collection (by `collectionName` or `collectionID`) and select a `type` corresponding to the
  * event you want to receive — for example `transform`, `route`, `join`, `evaluation`, `error`,
  * `enrich`, or `collection_processing`.
  *
+ * Entity-lifecycle events are account-wide and target no function or collection. Set `type` to
+ * one of the following and provide a `webhookURL` (these event types support webhook delivery
+ * only):
+ *
+ * - `entity_proposed` — an entity entered the `proposed` curation status (queued for review).
+ * - `entity_validated` — an entity was approved/validated by a reviewer.
+ * - `entity_rejected` — an entity was rejected by a reviewer.
+ *
+ * Each entity-lifecycle delivery is a JSON POST describing the transition (`entityID`,
+ * `typeName`, `priorStatus`, `newStatus`, optional `actorUserID` and `reason`, and a
+ * `timestamp`).
+ *
  * Deliveries can be sent to any combination of:
  *
  * - `webhookURL` — HTTPS endpoint that receives a JSON POST per event.

package/resources/subscriptions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../src/resources/subscriptions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAI5F;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAItF;;;OAGG;IACH,MAAM,CACJ,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;IAI7B;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;OAEG;IACH,MAAM,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM3E;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,EACA,WAAW,GACX,SAAS,GACT,OAAO,GACP,MAAM,GACN,kBAAkB,GAClB,YAAY,GACZ,YAAY,GACZ,OAAO,GACP,iBAAiB,GACjB,QAAQ,GACR,uBAAuB,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,wBAAwB,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;AAE7D,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EACA,WAAW,GACX,SAAS,GACT,OAAO,GACP,MAAM,GACN,kBAAkB,GAClB,YAAY,GACZ,YAAY,GACZ,OAAO,GACP,iBAAiB,GACjB,QAAQ,GACR,uBAAuB,CAAC;IAE5B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EACD,WAAW,GACX,SAAS,GACT,OAAO,GACP,MAAM,GACN,kBAAkB,GAClB,YAAY,GACZ,YAAY,GACZ,OAAO,GACP,iBAAiB,GACjB,QAAQ,GACR,uBAAuB,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,sBAAsB;IACrC;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAE3B;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
+{"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../src/resources/subscriptions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAI5F;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAItF;;;OAGG;IACH,MAAM,CACJ,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;IAI7B;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;OAEG;IACH,MAAM,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM3E;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,EACA,WAAW,GACX,SAAS,GACT,OAAO,GACP,MAAM,GACN,kBAAkB,GAClB,YAAY,GACZ,YAAY,GACZ,OAAO,GACP,iBAAiB,GACjB,QAAQ,GACR,uBAAuB,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,wBAAwB,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;AAE7D,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EACA,WAAW,GACX,SAAS,GACT,OAAO,GACP,MAAM,GACN,kBAAkB,GAClB,YAAY,GACZ,YAAY,GACZ,OAAO,GACP,iBAAiB,GACjB,QAAQ,GACR,uBAAuB,CAAC;IAE5B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EACD,WAAW,GACX,SAAS,GACT,OAAO,GACP,MAAM,GACN,kBAAkB,GAClB,YAAY,GACZ,YAAY,GACZ,OAAO,GACP,iBAAiB,GACjB,QAAQ,GACR,uBAAuB,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,sBAAsB;IACrC;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAE3B;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}

package/resources/subscriptions.js

@@ -8,11 +8,23 @@ const path_1 = require("../internal/utils/path.js");
 /**
  * Subscriptions wire up notifications for the events your functions and collections produce.
  *
- * Each subscription targets a single function (by `functionName` or `functionID`) or a single
- * collection (by `collectionName` or `collectionID`) and selects a `type` corresponding to the
+ * Most subscriptions target a single function (by `functionName` or `functionID`) or a single
+ * collection (by `collectionName` or `collectionID`) and select a `type` corresponding to the
  * event you want to receive — for example `transform`, `route`, `join`, `evaluation`, `error`,
  * `enrich`, or `collection_processing`.
  *
+ * Entity-lifecycle events are account-wide and target no function or collection. Set `type` to
+ * one of the following and provide a `webhookURL` (these event types support webhook delivery
+ * only):
+ *
+ * - `entity_proposed` — an entity entered the `proposed` curation status (queued for review).
+ * - `entity_validated` — an entity was approved/validated by a reviewer.
+ * - `entity_rejected` — an entity was rejected by a reviewer.
+ *
+ * Each entity-lifecycle delivery is a JSON POST describing the transition (`entityID`,
+ * `typeName`, `priorStatus`, `newStatus`, optional `actorUserID` and `reason`, and a
+ * `timestamp`).
+ *
  * Deliveries can be sent to any combination of:
  *
  * - `webhookURL` — HTTPS endpoint that receives a JSON POST per event.

package/resources/subscriptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"subscriptions.js","sourceRoot":"","sources":["../src/resources/subscriptions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAEnD,oDAA8C;AAE9C;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;OAEG;IACH,MAAM,CAAC,IAA8B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,cAAsB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,cAAc,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;IAED;;;OAGG;IACH,MAAM,CACJ,cAAsB,EACtB,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,qBAAqB,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,cAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,qBAAqB,cAAc,EAAE,EAAE;YACpE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AA9CD,sCA8CC"}
+{"version":3,"file":"subscriptions.js","sourceRoot":"","sources":["../src/resources/subscriptions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAEnD,oDAA8C;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;OAEG;IACH,MAAM,CAAC,IAA8B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,cAAsB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,cAAc,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;IAED;;;OAGG;IACH,MAAM,CACJ,cAAsB,EACtB,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,qBAAqB,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,cAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,qBAAqB,cAAc,EAAE,EAAE;YACpE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AA9CD,sCA8CC"}

package/resources/subscriptions.mjs

@@ -5,11 +5,23 @@ import { path } from "../internal/utils/path.mjs";
 /**
  * Subscriptions wire up notifications for the events your functions and collections produce.
  *
- * Each subscription targets a single function (by `functionName` or `functionID`) or a single
- * collection (by `collectionName` or `collectionID`) and selects a `type` corresponding to the
+ * Most subscriptions target a single function (by `functionName` or `functionID`) or a single
+ * collection (by `collectionName` or `collectionID`) and select a `type` corresponding to the
  * event you want to receive — for example `transform`, `route`, `join`, `evaluation`, `error`,
  * `enrich`, or `collection_processing`.
  *
+ * Entity-lifecycle events are account-wide and target no function or collection. Set `type` to
+ * one of the following and provide a `webhookURL` (these event types support webhook delivery
+ * only):
+ *
+ * - `entity_proposed` — an entity entered the `proposed` curation status (queued for review).
+ * - `entity_validated` — an entity was approved/validated by a reviewer.
+ * - `entity_rejected` — an entity was rejected by a reviewer.
+ *
+ * Each entity-lifecycle delivery is a JSON POST describing the transition (`entityID`,
+ * `typeName`, `priorStatus`, `newStatus`, optional `actorUserID` and `reason`, and a
+ * `timestamp`).
+ *
  * Deliveries can be sent to any combination of:
  *
  * - `webhookURL` — HTTPS endpoint that receives a JSON POST per event.

package/resources/subscriptions.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"subscriptions.mjs","sourceRoot":"","sources":["../src/resources/subscriptions.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;OAEG;IACH,MAAM,CAAC,IAA8B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,cAAsB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,cAAc,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;IAED;;;OAGG;IACH,MAAM,CACJ,cAAsB,EACtB,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,qBAAqB,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,cAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,qBAAqB,cAAc,EAAE,EAAE;YACpE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"subscriptions.mjs","sourceRoot":"","sources":["../src/resources/subscriptions.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;OAEG;IACH,MAAM,CAAC,IAA8B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,cAAsB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,cAAc,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;IAED;;;OAGG;IACH,MAAM,CACJ,cAAsB,EACtB,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,qBAAqB,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,cAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,qBAAqB,cAAc,EAAE,EAAE;YACpE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/users.d.mts

@@ -0,0 +1,62 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * Reviewer assignments link users to the entity types they are responsible
+ * for reviewing, scoped to an account+environment. These are dashboard-only
+ * endpoints: an assignment needs a user identity, which only the dashboard
+ * (JWT) surface carries.
+ *
+ * - **`POST /v3/entity-types/{typeID}/reviewers`** assigns a user as a
+ *   reviewer of the type. The assignment is idempotent: re-assigning an
+ *   existing reviewer returns the existing assignment. Requires the `admin`
+ *   role.
+ * - **`GET /v3/entity-types/{typeID}/reviewers`** lists the users assigned
+ *   to review the type, with each user's email and role. Requires the
+ *   `operator` role.
+ * - **`DELETE /v3/entity-types/{typeID}/reviewers/{userID}`** removes an
+ *   assignment. Requires the `admin` role.
+ * - **`GET /v3/users/{userID}/reviewer-assignments`** is the reverse lookup:
+ *   the entity types a user reviews. A user may read their own assignments;
+ *   reading another user's assignments requires the `admin` role.
+ */
+export declare class Users extends APIResource {
+    /**
+     * List a User's Reviewer Assignments
+     */
+    listReviewerAssignments(userID: string, options?: RequestOptions): APIPromise<UserListReviewerAssignmentsResponse>;
+}
+/**
+ * Response body for the reverse lookup of a user's reviewer assignments.
+ */
+export interface UserListReviewerAssignmentsResponse {
+    assignments: Array<UserListReviewerAssignmentsResponse.Assignment>;
+}
+export declare namespace UserListReviewerAssignmentsResponse {
+    /**
+     * One entity type a user reviews, as returned by the reverse-lookup endpoint. The
+     * type is exposed via its public ID plus its name and description.
+     */
+    interface Assignment {
+        /**
+         * When the assignment was created (RFC 3339).
+         */
+        createdAt: string;
+        /**
+         * The entity type's description.
+         */
+        description: string;
+        /**
+         * The entity type's human-facing name.
+         */
+        name: string;
+        /**
+         * Public ID (`ety_...`) of the entity type the user reviews.
+         */
+        typeID: string;
+    }
+}
+export declare namespace Users {
+    export { type UserListReviewerAssignmentsResponse as UserListReviewerAssignmentsResponse };
+}
+//# sourceMappingURL=users.d.mts.map

package/resources/users.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"users.d.mts","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,uBAAuB,CACrB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;CAGnD;AAED;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAClD,WAAW,EAAE,KAAK,CAAC,mCAAmC,CAAC,UAAU,CAAC,CAAC;CACpE;AAED,yBAAiB,mCAAmC,CAAC;IACnD;;;OAGG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EAAE,KAAK,mCAAmC,IAAI,mCAAmC,EAAE,CAAC;CAC5F"}

package/resources/users.d.ts

@@ -0,0 +1,62 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Reviewer assignments link users to the entity types they are responsible
+ * for reviewing, scoped to an account+environment. These are dashboard-only
+ * endpoints: an assignment needs a user identity, which only the dashboard
+ * (JWT) surface carries.
+ *
+ * - **`POST /v3/entity-types/{typeID}/reviewers`** assigns a user as a
+ *   reviewer of the type. The assignment is idempotent: re-assigning an
+ *   existing reviewer returns the existing assignment. Requires the `admin`
+ *   role.
+ * - **`GET /v3/entity-types/{typeID}/reviewers`** lists the users assigned
+ *   to review the type, with each user's email and role. Requires the
+ *   `operator` role.
+ * - **`DELETE /v3/entity-types/{typeID}/reviewers/{userID}`** removes an
+ *   assignment. Requires the `admin` role.
+ * - **`GET /v3/users/{userID}/reviewer-assignments`** is the reverse lookup:
+ *   the entity types a user reviews. A user may read their own assignments;
+ *   reading another user's assignments requires the `admin` role.
+ */
+export declare class Users extends APIResource {
+    /**
+     * List a User's Reviewer Assignments
+     */
+    listReviewerAssignments(userID: string, options?: RequestOptions): APIPromise<UserListReviewerAssignmentsResponse>;
+}
+/**
+ * Response body for the reverse lookup of a user's reviewer assignments.
+ */
+export interface UserListReviewerAssignmentsResponse {
+    assignments: Array<UserListReviewerAssignmentsResponse.Assignment>;
+}
+export declare namespace UserListReviewerAssignmentsResponse {
+    /**
+     * One entity type a user reviews, as returned by the reverse-lookup endpoint. The
+     * type is exposed via its public ID plus its name and description.
+     */
+    interface Assignment {
+        /**
+         * When the assignment was created (RFC 3339).
+         */
+        createdAt: string;
+        /**
+         * The entity type's description.
+         */
+        description: string;
+        /**
+         * The entity type's human-facing name.
+         */
+        name: string;
+        /**
+         * Public ID (`ety_...`) of the entity type the user reviews.
+         */
+        typeID: string;
+    }
+}
+export declare namespace Users {
+    export { type UserListReviewerAssignmentsResponse as UserListReviewerAssignmentsResponse };
+}
+//# sourceMappingURL=users.d.ts.map

package/resources/users.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,uBAAuB,CACrB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;CAGnD;AAED;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAClD,WAAW,EAAE,KAAK,CAAC,mCAAmC,CAAC,UAAU,CAAC,CAAC;CACpE;AAED,yBAAiB,mCAAmC,CAAC;IACnD;;;OAGG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EAAE,KAAK,mCAAmC,IAAI,mCAAmC,EAAE,CAAC;CAC5F"}

package/resources/users.js

@@ -0,0 +1,35 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Users = void 0;
+const resource_1 = require("../core/resource.js");
+const path_1 = require("../internal/utils/path.js");
+/**
+ * Reviewer assignments link users to the entity types they are responsible
+ * for reviewing, scoped to an account+environment. These are dashboard-only
+ * endpoints: an assignment needs a user identity, which only the dashboard
+ * (JWT) surface carries.
+ *
+ * - **`POST /v3/entity-types/{typeID}/reviewers`** assigns a user as a
+ *   reviewer of the type. The assignment is idempotent: re-assigning an
+ *   existing reviewer returns the existing assignment. Requires the `admin`
+ *   role.
+ * - **`GET /v3/entity-types/{typeID}/reviewers`** lists the users assigned
+ *   to review the type, with each user's email and role. Requires the
+ *   `operator` role.
+ * - **`DELETE /v3/entity-types/{typeID}/reviewers/{userID}`** removes an
+ *   assignment. Requires the `admin` role.
+ * - **`GET /v3/users/{userID}/reviewer-assignments`** is the reverse lookup:
+ *   the entity types a user reviews. A user may read their own assignments;
+ *   reading another user's assignments requires the `admin` role.
+ */
+class Users extends resource_1.APIResource {
+    /**
+     * List a User's Reviewer Assignments
+     */
+    listReviewerAssignments(userID, options) {
+        return this._client.get((0, path_1.path) `/v3/users/${userID}/reviewer-assignments`, options);
+    }
+}
+exports.Users = Users;
+//# sourceMappingURL=users.js.map

package/resources/users.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"users.js","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAa,KAAM,SAAQ,sBAAW;IACpC;;OAEG;IACH,uBAAuB,CACrB,MAAc,EACd,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,MAAM,uBAAuB,EAAE,OAAO,CAAC,CAAC;IACnF,CAAC;CACF;AAVD,sBAUC"}