@collective-intelligence/external-apps-server-sdk 0.1.9 → 0.1.10

package/dist/resources.d.ts

@@ -65,13 +65,21 @@ export type ResourceDefinition<Entity, Create = Entity, Update = Partial<Entity>
 	}>;
 }>;
 export type FilterValue = ResourceJsonValue | readonly ResourceJsonValue[];
+/**
+ * A filter predicate. `field` names a declared filterable field, or a path
+ * through at most three fields that hold Entity References to a field of
+ * the last target, such as `company.industry` or
+ * `contacts.company.parent.industry`. On a field that holds Entity
+ * References, `is_empty` means no reference, and `contains_any` and
+ * `contains_all` compare the ids of a field that holds many.
+ */
 export type ResourceFilter = Readonly<{
 	field: string;
-	operator: "contains" | "ends_with" | "eq" | "gt" | "gte" | "in" | "lt" | "lte" | "ne" | "not_in" | "starts_with";
+	operator: "contains" | "contains_all" | "contains_any" | "ends_with" | "eq" | "gt" | "gte" | "in" | "lt" | "lte" | "ne" | "not_in" | "starts_with";
 	value: FilterValue;
 }> | Readonly<{
 	field: string;
-	operator: "is_not_null" | "is_null";
+	operator: "is_empty" | "is_not_null" | "is_null";
 }> | Readonly<{
 	filters: readonly ResourceFilter[];
 	operator: "and" | "or";
@@ -94,6 +102,11 @@ export type ResourcePagination = Readonly<{
 }>;
 export type ResourceListQuery = Readonly<{
 	filter?: ResourceFilter;
+	/**
+	 * Include Paths, such as `["company", "contacts.company"]`: relation
+	 * fields whose records each item carries in `included`.
+	 */
+	include?: readonly string[];
 	includeDeleted?: boolean;
 	pagination: ResourcePagination;
 	sort?: readonly ResourceSort[];
@@ -102,7 +115,15 @@ export type ResourceListQuery = Readonly<{
 export type ResourceRecord<Entity> = Readonly<{
 	deletedAt?: string;
 	id: ResourceRecordId;
+	/**
+	 * The records of the read's Include Paths by relation field key: one
+	 * record, or the records of a `many` field in reference order. Untyped:
+	 * the target schemas are CI's.
+	 */
+	included?: Readonly<Record<string, ResourceJsonValue>>;
 	revision: ResourceRevision;
+	/** The keys whose included records were cut to the first 100. */
+	truncated?: readonly string[];
 	value: Entity;
 }>;
 export type ResourceListResult<Entity> = Readonly<{
@@ -230,6 +251,7 @@ export type EntityRequest<Create = unknown, Patch = unknown> = EntityRequestIden
 }> | Readonly<{
 	operation: "get";
 	id: ResourceRecordId;
+	include?: readonly string[];
 }> | (Readonly<{
 	operation: "create";
 }> & EntityCreateInput<Create>) | (Readonly<{