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

package/dist/admin.d.ts

@@ -325,15 +325,46 @@ declare const FeatureFlagRolloutMode: {
 	readonly DISABLED_FOR_ORGANIZATIONS: "disabled_for_organizations";
 };
 export type FeatureFlagRolloutMode = typeof FeatureFlagRolloutMode[keyof typeof FeatureFlagRolloutMode];
-export type EntityRelationField = {
-	cardinality: "many" | "one";
-	field: string;
-	id: string;
-	nullable: boolean;
-	reference: "external_id";
-	targetEntityId: string;
+export type KnowledgeRelationFieldEntry = {
+	autocomplete?: {
+		baseFilters?: Array<{
+			caseSensitive?: boolean;
+			field: string;
+			operator: "eq" | "ne" | "in" | "nin" | "contains" | "not_contains" | "starts_with" | "ends_with" | "gt" | "gte" | "lt" | "lte" | "exists" | "is_empty" | "is_not_empty";
+			value: Suspend;
+		}>;
+		fields?: Array<{
+			field: string;
+			scope: "data" | "entity";
+		}>;
+	};
+	cardinality: "one" | "many";
+	display?: {
+		fields: Array<{
+			field: string;
+			scope: "data" | "entity";
+		}>;
+	};
+	maxItems?: number;
+	onDelete?: "clear" | "restrict";
 	targetSchemaFqn: string;
 };
+export type Suspend = null | boolean | number | string | Array<Suspend> | {
+	[key: string]: Suspend;
+};
+declare const KnowledgeFileVisibility: {
+	readonly PUBLIC: "public";
+	readonly PROTECTED: "protected";
+	readonly PRIVATE: "private";
+};
+export type KnowledgeFileVisibility = typeof KnowledgeFileVisibility[keyof typeof KnowledgeFileVisibility];
+export type KnowledgeFileFieldEntry = {
+	accepts: Array<string>;
+	multiple: boolean;
+};
+export type PackageOperationAccepted7 = {
+	operationId: string;
+};
 export type PackageOperationAccepted5 = {
 	operationId: string;
 };
@@ -1505,6 +1536,7 @@ export type ExtensionPackagesUninstallData = {
 	headers: {
 		authorization?: string;
 		"x-organization-id": string;
+		"idempotency-key": string;
 	};
 	path: {
 		fqn: string;
@@ -1892,13 +1924,18 @@ export type RelationSchemasUpdateData = {
 				defaultSearch?: boolean;
 				embedded?: boolean;
 				faceted?: boolean;
+				includeInItemEmbedding?: boolean;
 				indexContent?: boolean;
 				indexOverview?: boolean;
 				indexed?: boolean;
 				managedProjectionSource?: "organization_group" | "organization_user";
-				mediaVisibility?: "public" | "protected" | "private";
+				overviewInputMaxChars?: number | null;
 				queryGuidance?: string;
+				richEnrichment?: boolean | null;
 				unique?: boolean;
+				file?: unknown;
+				mediaVisibility?: unknown;
+				relation?: unknown;
 			};
 		};
 		fqn?: string;
@@ -2001,13 +2038,18 @@ export type RelationSchemasCreateData = {
 				defaultSearch?: boolean;
 				embedded?: boolean;
 				faceted?: boolean;
+				includeInItemEmbedding?: boolean;
 				indexContent?: boolean;
 				indexOverview?: boolean;
 				indexed?: boolean;
 				managedProjectionSource?: "organization_group" | "organization_user";
-				mediaVisibility?: "public" | "protected" | "private";
+				overviewInputMaxChars?: number | null;
 				queryGuidance?: string;
+				richEnrichment?: boolean | null;
 				unique?: boolean;
+				file?: unknown;
+				mediaVisibility?: unknown;
+				relation?: unknown;
 			};
 		};
 		fqn: string;
@@ -2247,13 +2289,18 @@ export type EntitySchemasUpdateData = {
 				defaultSearch?: boolean;
 				embedded?: boolean;
 				faceted?: boolean;
+				includeInItemEmbedding?: boolean;
 				indexContent?: boolean;
 				indexOverview?: boolean;
 				indexed?: boolean;
 				managedProjectionSource?: "organization_group" | "organization_user";
-				mediaVisibility?: "public" | "protected" | "private";
+				overviewInputMaxChars?: number | null;
 				queryGuidance?: string;
+				richEnrichment?: boolean | null;
 				unique?: boolean;
+				file?: KnowledgeFileFieldEntry;
+				mediaVisibility?: KnowledgeFileVisibility;
+				relation?: KnowledgeRelationFieldEntry;
 			};
 		};
 		fqn?: string;
@@ -2274,8 +2321,9 @@ export type EntitySchemasUpdateData = {
 			source: "organization_group" | "organization_group_hierarchy" | "organization_group_membership" | "organization_user";
 		} | null;
 		name?: string;
+		overviewInputMaxChars?: number | null;
 		persistFullFieldContributions?: boolean;
-		relationFields?: Array<EntityRelationField>;
+		richEnrichment?: boolean | null;
 		usableAsDocumentScope?: boolean;
 	};
 	headers: {
@@ -2382,13 +2430,18 @@ export type EntitySchemasCreateData = {
 				defaultSearch?: boolean;
 				embedded?: boolean;
 				faceted?: boolean;
+				includeInItemEmbedding?: boolean;
 				indexContent?: boolean;
 				indexOverview?: boolean;
 				indexed?: boolean;
 				managedProjectionSource?: "organization_group" | "organization_user";
-				mediaVisibility?: "public" | "protected" | "private";
+				overviewInputMaxChars?: number | null;
 				queryGuidance?: string;
+				richEnrichment?: boolean | null;
 				unique?: boolean;
+				file?: KnowledgeFileFieldEntry;
+				mediaVisibility?: KnowledgeFileVisibility;
+				relation?: KnowledgeRelationFieldEntry;
 			};
 		};
 		fqn: string;
@@ -2403,8 +2456,9 @@ export type EntitySchemasCreateData = {
 			source: "organization_group" | "organization_group_hierarchy" | "organization_group_membership" | "organization_user";
 		} | null;
 		name: string;
+		overviewInputMaxChars?: number | null;
 		persistFullFieldContributions?: boolean;
-		relationFields?: Array<EntityRelationField>;
+		richEnrichment?: boolean | null;
 		usableAsDocumentScope?: boolean;
 	};
 	headers: {
@@ -5268,6 +5322,85 @@ declare const createAdministrationApi: (client: Client$1) => {
 					op: "transform";
 					remote: string;
 					transformerId: string;
+				} | {
+					direction: "both" | "inbound" | "outbound";
+					local: string;
+					skipIfNull: boolean;
+					op: "reference";
+					remote: string;
+					target?: string;
+				} | {
+					direction: "both" | "inbound" | "outbound";
+					local: string;
+					skipIfNull: boolean;
+					fieldMap: Array<{
+						direction: "both" | "inbound" | "outbound";
+						local: string;
+						skipIfNull: boolean;
+						op: "path";
+						remote: string;
+					} | {
+						direction: "both" | "inbound" | "outbound";
+						local: string;
+						skipIfNull: boolean;
+						falseValues?: Array<string>;
+						op: "cast";
+						remote: string;
+						trueValues?: Array<string>;
+					} | {
+						direction: "both" | "inbound" | "outbound";
+						local: string;
+						skipIfNull: boolean;
+						op: "default";
+						remote?: string;
+						value: unknown;
+					} | {
+						direction: "both" | "inbound" | "outbound";
+						local: string;
+						skipIfNull: boolean;
+						op: "concat";
+						remote: Array<string>;
+						separator?: string;
+					} | {
+						direction: "both" | "inbound" | "outbound";
+						local: string;
+						skipIfNull: boolean;
+						discardEmpty?: boolean;
+						op: "split";
+						remote: string;
+						separators?: Array<string>;
+						trimItems?: boolean;
+						uniqueItems?: boolean;
+					} | {
+						direction: "both" | "inbound" | "outbound";
+						local: string;
+						skipIfNull: boolean;
+						latitudeKey?: string;
+						longitudeKey?: string;
+						op: "coordinates";
+						remote: [
+							string,
+							string
+						];
+					} | {
+						direction: "both" | "inbound" | "outbound";
+						local: string;
+						skipIfNull: boolean;
+						op: "transform";
+						remote: string;
+						transformerId: string;
+					} | {
+						direction: "both" | "inbound" | "outbound";
+						local: string;
+						skipIfNull: boolean;
+						op: "reference";
+						remote: string;
+						target?: string;
+					}>;
+					op: "embedded";
+					remote: string;
+					remoteId: string;
+					target?: string;
 				}>;
 				fqn: string;
 				outboundStrategy?: "local_first" | "remote_first";
@@ -5369,6 +5502,85 @@ declare const createAdministrationApi: (client: Client$1) => {
 					op: "transform";
 					remote: string;
 					transformerId: string;
+				} | {
+					direction: "both" | "inbound" | "outbound";
+					local: string;
+					skipIfNull: boolean;
+					op: "reference";
+					remote: string;
+					target?: string;
+				} | {
+					direction: "both" | "inbound" | "outbound";
+					local: string;
+					skipIfNull: boolean;
+					fieldMap: Array<{
+						direction: "both" | "inbound" | "outbound";
+						local: string;
+						skipIfNull: boolean;
+						op: "path";
+						remote: string;
+					} | {
+						direction: "both" | "inbound" | "outbound";
+						local: string;
+						skipIfNull: boolean;
+						falseValues?: Array<string>;
+						op: "cast";
+						remote: string;
+						trueValues?: Array<string>;
+					} | {
+						direction: "both" | "inbound" | "outbound";
+						local: string;
+						skipIfNull: boolean;
+						op: "default";
+						remote?: string;
+						value: unknown;
+					} | {
+						direction: "both" | "inbound" | "outbound";
+						local: string;
+						skipIfNull: boolean;
+						op: "concat";
+						remote: Array<string>;
+						separator?: string;
+					} | {
+						direction: "both" | "inbound" | "outbound";
+						local: string;
+						skipIfNull: boolean;
+						discardEmpty?: boolean;
+						op: "split";
+						remote: string;
+						separators?: Array<string>;
+						trimItems?: boolean;
+						uniqueItems?: boolean;
+					} | {
+						direction: "both" | "inbound" | "outbound";
+						local: string;
+						skipIfNull: boolean;
+						latitudeKey?: string;
+						longitudeKey?: string;
+						op: "coordinates";
+						remote: [
+							string,
+							string
+						];
+					} | {
+						direction: "both" | "inbound" | "outbound";
+						local: string;
+						skipIfNull: boolean;
+						op: "transform";
+						remote: string;
+						transformerId: string;
+					} | {
+						direction: "both" | "inbound" | "outbound";
+						local: string;
+						skipIfNull: boolean;
+						op: "reference";
+						remote: string;
+						target?: string;
+					}>;
+					op: "embedded";
+					remote: string;
+					remoteId: string;
+					target?: string;
 				}>;
 				fqn: string;
 				outboundStrategy?: "local_first" | "remote_first";
@@ -5737,6 +5949,85 @@ declare const createAdministrationApi: (client: Client$1) => {
 						op: "transform";
 						remote: string;
 						transformerId: string;
+					} | {
+						direction: "both" | "inbound" | "outbound";
+						local: string;
+						skipIfNull: boolean;
+						op: "reference";
+						remote: string;
+						target?: string;
+					} | {
+						direction: "both" | "inbound" | "outbound";
+						local: string;
+						skipIfNull: boolean;
+						fieldMap: Array<{
+							direction: "both" | "inbound" | "outbound";
+							local: string;
+							skipIfNull: boolean;
+							op: "path";
+							remote: string;
+						} | {
+							direction: "both" | "inbound" | "outbound";
+							local: string;
+							skipIfNull: boolean;
+							falseValues?: Array<string>;
+							op: "cast";
+							remote: string;
+							trueValues?: Array<string>;
+						} | {
+							direction: "both" | "inbound" | "outbound";
+							local: string;
+							skipIfNull: boolean;
+							op: "default";
+							remote?: string;
+							value: unknown;
+						} | {
+							direction: "both" | "inbound" | "outbound";
+							local: string;
+							skipIfNull: boolean;
+							op: "concat";
+							remote: Array<string>;
+							separator?: string;
+						} | {
+							direction: "both" | "inbound" | "outbound";
+							local: string;
+							skipIfNull: boolean;
+							discardEmpty?: boolean;
+							op: "split";
+							remote: string;
+							separators?: Array<string>;
+							trimItems?: boolean;
+							uniqueItems?: boolean;
+						} | {
+							direction: "both" | "inbound" | "outbound";
+							local: string;
+							skipIfNull: boolean;
+							latitudeKey?: string;
+							longitudeKey?: string;
+							op: "coordinates";
+							remote: [
+								string,
+								string
+							];
+						} | {
+							direction: "both" | "inbound" | "outbound";
+							local: string;
+							skipIfNull: boolean;
+							op: "transform";
+							remote: string;
+							transformerId: string;
+						} | {
+							direction: "both" | "inbound" | "outbound";
+							local: string;
+							skipIfNull: boolean;
+							op: "reference";
+							remote: string;
+							target?: string;
+						}>;
+						op: "embedded";
+						remote: string;
+						remoteId: string;
+						target?: string;
 					}>;
 					fqn: string;
 					outboundStrategy?: "local_first" | "remote_first";
@@ -5838,6 +6129,85 @@ declare const createAdministrationApi: (client: Client$1) => {
 						op: "transform";
 						remote: string;
 						transformerId: string;
+					} | {
+						direction: "both" | "inbound" | "outbound";
+						local: string;
+						skipIfNull: boolean;
+						op: "reference";
+						remote: string;
+						target?: string;
+					} | {
+						direction: "both" | "inbound" | "outbound";
+						local: string;
+						skipIfNull: boolean;
+						fieldMap: Array<{
+							direction: "both" | "inbound" | "outbound";
+							local: string;
+							skipIfNull: boolean;
+							op: "path";
+							remote: string;
+						} | {
+							direction: "both" | "inbound" | "outbound";
+							local: string;
+							skipIfNull: boolean;
+							falseValues?: Array<string>;
+							op: "cast";
+							remote: string;
+							trueValues?: Array<string>;
+						} | {
+							direction: "both" | "inbound" | "outbound";
+							local: string;
+							skipIfNull: boolean;
+							op: "default";
+							remote?: string;
+							value: unknown;
+						} | {
+							direction: "both" | "inbound" | "outbound";
+							local: string;
+							skipIfNull: boolean;
+							op: "concat";
+							remote: Array<string>;
+							separator?: string;
+						} | {
+							direction: "both" | "inbound" | "outbound";
+							local: string;
+							skipIfNull: boolean;
+							discardEmpty?: boolean;
+							op: "split";
+							remote: string;
+							separators?: Array<string>;
+							trimItems?: boolean;
+							uniqueItems?: boolean;
+						} | {
+							direction: "both" | "inbound" | "outbound";
+							local: string;
+							skipIfNull: boolean;
+							latitudeKey?: string;
+							longitudeKey?: string;
+							op: "coordinates";
+							remote: [
+								string,
+								string
+							];
+						} | {
+							direction: "both" | "inbound" | "outbound";
+							local: string;
+							skipIfNull: boolean;
+							op: "transform";
+							remote: string;
+							transformerId: string;
+						} | {
+							direction: "both" | "inbound" | "outbound";
+							local: string;
+							skipIfNull: boolean;
+							op: "reference";
+							remote: string;
+							target?: string;
+						}>;
+						op: "embedded";
+						remote: string;
+						remoteId: string;
+						target?: string;
 					}>;
 					fqn: string;
 					outboundStrategy?: "local_first" | "remote_first";
@@ -6368,13 +6738,18 @@ declare const createAdministrationApi: (client: Client$1) => {
 					defaultSearch?: boolean;
 					embedded?: boolean;
 					faceted?: boolean;
+					includeInItemEmbedding?: boolean;
 					indexContent?: boolean;
 					indexOverview?: boolean;
 					indexed?: boolean;
 					managedProjectionSource?: "organization_group" | "organization_user";
-					mediaVisibility?: "public" | "protected" | "private";
+					overviewInputMaxChars?: number | null;
 					queryGuidance?: string;
+					richEnrichment?: boolean | null;
 					unique?: boolean;
+					file?: KnowledgeFileFieldEntry;
+					mediaVisibility?: KnowledgeFileVisibility;
+					relation?: KnowledgeRelationFieldEntry;
 				};
 			};
 			fqn: string;
@@ -6391,9 +6766,10 @@ declare const createAdministrationApi: (client: Client$1) => {
 				source: "organization_group" | "organization_group_hierarchy" | "organization_group_membership" | "organization_user";
 			} | null;
 			name: string;
+			overviewInputMaxChars: number | null;
 			persistFullFieldContributions: boolean;
-			relationFields: Array<EntityRelationField>;
 			removedFields: Array<unknown>;
+			richEnrichment: boolean | null;
 			updatedAt: string | null;
 			usableAsDocumentScope: boolean;
 		}>;
@@ -6474,12 +6850,14 @@ declare const createAdministrationApi: (client: Client$1) => {
 					defaultSearch?: boolean;
 					embedded?: boolean;
 					faceted?: boolean;
+					includeInItemEmbedding?: boolean;
 					indexContent?: boolean;
 					indexOverview?: boolean;
 					indexed?: boolean;
 					managedProjectionSource?: "organization_group" | "organization_user";
-					mediaVisibility?: "public" | "protected" | "private";
+					overviewInputMaxChars?: number | null;
 					queryGuidance?: string;
+					richEnrichment?: boolean | null;
 					unique?: boolean;
 				};
 			};
@@ -6601,13 +6979,18 @@ declare const createAdministrationApi: (client: Client$1) => {
 					defaultSearch?: boolean;
 					embedded?: boolean;
 					faceted?: boolean;
+					includeInItemEmbedding?: boolean;
 					indexContent?: boolean;
 					indexOverview?: boolean;
 					indexed?: boolean;
 					managedProjectionSource?: "organization_group" | "organization_user";
-					mediaVisibility?: "public" | "protected" | "private";
+					overviewInputMaxChars?: number | null;
 					queryGuidance?: string;
+					richEnrichment?: boolean | null;
 					unique?: boolean;
+					file?: KnowledgeFileFieldEntry;
+					mediaVisibility?: KnowledgeFileVisibility;
+					relation?: KnowledgeRelationFieldEntry;
 				};
 			};
 			fqn: string;
@@ -6624,9 +7007,10 @@ declare const createAdministrationApi: (client: Client$1) => {
 				source: "organization_group" | "organization_group_hierarchy" | "organization_group_membership" | "organization_user";
 			} | null;
 			name: string;
+			overviewInputMaxChars: number | null;
 			persistFullFieldContributions: boolean;
-			relationFields: Array<EntityRelationField>;
 			removedFields: Array<unknown>;
+			richEnrichment: boolean | null;
 			updatedAt: string | null;
 			usableAsDocumentScope: boolean;
 		}>;
@@ -6707,12 +7091,14 @@ declare const createAdministrationApi: (client: Client$1) => {
 					defaultSearch?: boolean;
 					embedded?: boolean;
 					faceted?: boolean;
+					includeInItemEmbedding?: boolean;
 					indexContent?: boolean;
 					indexOverview?: boolean;
 					indexed?: boolean;
 					managedProjectionSource?: "organization_group" | "organization_user";
-					mediaVisibility?: "public" | "protected" | "private";
+					overviewInputMaxChars?: number | null;
 					queryGuidance?: string;
+					richEnrichment?: boolean | null;
 					unique?: boolean;
 				};
 			};
@@ -6829,13 +7215,18 @@ declare const createAdministrationApi: (client: Client$1) => {
 						defaultSearch?: boolean;
 						embedded?: boolean;
 						faceted?: boolean;
+						includeInItemEmbedding?: boolean;
 						indexContent?: boolean;
 						indexOverview?: boolean;
 						indexed?: boolean;
 						managedProjectionSource?: "organization_group" | "organization_user";
-						mediaVisibility?: "public" | "protected" | "private";
+						overviewInputMaxChars?: number | null;
 						queryGuidance?: string;
+						richEnrichment?: boolean | null;
 						unique?: boolean;
+						file?: KnowledgeFileFieldEntry;
+						mediaVisibility?: KnowledgeFileVisibility;
+						relation?: KnowledgeRelationFieldEntry;
 					};
 				};
 				fqn: string;
@@ -6852,9 +7243,10 @@ declare const createAdministrationApi: (client: Client$1) => {
 					source: "organization_group" | "organization_group_hierarchy" | "organization_group_membership" | "organization_user";
 				} | null;
 				name: string;
+				overviewInputMaxChars: number | null;
 				persistFullFieldContributions: boolean;
-				relationFields: Array<EntityRelationField>;
 				removedFields: Array<unknown>;
+				richEnrichment: boolean | null;
 				updatedAt: string | null;
 				usableAsDocumentScope: boolean;
 			}>;
@@ -6943,12 +7335,14 @@ declare const createAdministrationApi: (client: Client$1) => {
 						defaultSearch?: boolean;
 						embedded?: boolean;
 						faceted?: boolean;
+						includeInItemEmbedding?: boolean;
 						indexContent?: boolean;
 						indexOverview?: boolean;
 						indexed?: boolean;
 						managedProjectionSource?: "organization_group" | "organization_user";
-						mediaVisibility?: "public" | "protected" | "private";
+						overviewInputMaxChars?: number | null;
 						queryGuidance?: string;
+						richEnrichment?: boolean | null;
 						unique?: boolean;
 					};
 				};
@@ -7123,9 +7517,7 @@ declare const createAdministrationApi: (client: Client$1) => {
 		}[]>;
 		promoteRelease: (options: Pick<Options$1<PackageReleasesPromoteData, true, unknown>, "query" | "body" | "headers" | "path">) => Promise<PackageOperationAccepted2>;
 		publishRelease: (options: Pick<Options$1<PackageReleasesPublishData, true, unknown>, "query" | "body" | "headers" | "path">) => Promise<PackageOperationAccepted1>;
-		uninstall: (options: Pick<Options$1<ExtensionPackagesUninstallData, true, unknown>, "query" | "body" | "headers" | "path">) => Promise<{
-			message: string;
-		}>;
+		uninstall: (options: Pick<Options$1<ExtensionPackagesUninstallData, true, unknown>, "query" | "body" | "headers" | "path">) => Promise<PackageOperationAccepted7>;
 		updateInstallation: (options: Pick<Options$1<PackageReleasesUpdateInstallationData, true, unknown>, "query" | "body" | "headers" | "path">) => Promise<PackageOperationAccepted3>;
 	};
 	reports: {
@@ -7286,8 +7678,10 @@ declare const createAdministrationApi: (client: Client$1) => {
 			layoutProps: unknown | null;
 			name: string;
 			organizationId: string;
+			packageOwned: boolean;
 			publishedDefinitionHash: string | null;
 			publishedVersionId: string | null;
+			readonly: boolean;
 			slug: string;
 			updatedAt: string | null;
 		}>;
@@ -7306,8 +7700,10 @@ declare const createAdministrationApi: (client: Client$1) => {
 			layoutProps: unknown | null;
 			name: string;
 			organizationId: string;
+			packageOwned: boolean;
 			publishedDefinitionHash: string | null;
 			publishedVersionId: string | null;
+			readonly: boolean;
 			slug: string;
 			updatedAt: string | null;
 		}>;
@@ -7324,8 +7720,10 @@ declare const createAdministrationApi: (client: Client$1) => {
 				layoutProps: unknown | null;
 				name: string;
 				organizationId: string;
+				packageOwned: boolean;
 				publishedDefinitionHash: string | null;
 				publishedVersionId: string | null;
+				readonly: boolean;
 				slug: string;
 				updatedAt: string | null;
 			}>;