/** * Palantir Foundry Ontologies API. * Ontologies, Object Types, Objects, Actions, Functions, Queries, Links, * Interface Types, object counts, and full metadata. * * @see https://www.palantir.com/docs/foundry/api/v2/ontologies-v2-resources/ */ import type { PalantirClient } from "./client.js"; import type { Ontology, ObjectType, OntologyObject, ActionType, ApplyActionParams, ApplyActionResponse, FunctionType, ExecuteFunctionParams, QueryType, ListObjectsParams, PageResponse, PageParams } from "./types.js"; /** An interface type in an ontology. */ export interface InterfaceType { apiName: string; displayName?: string; description?: string; rid: string; sharedPropertyTypes?: unknown[]; objectTypes?: unknown[]; } export declare class OntologiesNamespace { private client; constructor(client: PalantirClient); /** List all ontologies visible to the current user. */ list(params?: PageParams): Promise>; /** Get a specific ontology by API name or RID. */ get(ontology: string): Promise; /** * Get full ontology metadata (object types, action types, link types, * interface types, query types, function types) in a single call. */ getFullMetadata(ontology: string): Promise; /** List object types for an ontology. */ listObjectTypes(ontology: string, params?: PageParams): Promise>; /** Get a specific object type. */ getObjectType(ontology: string, objectType: string): Promise; /** List objects for an ontology object type. */ listObjects(ontology: string, objectType: string, params?: ListObjectsParams): Promise>; /** Get a single object by primary key. */ getObject(ontology: string, objectType: string, primaryKey: string | number, params?: { select?: string[]; branch?: string; }): Promise; /** Create a new object. */ createObject(ontology: string, objectType: string, params: { properties: Record; branch?: string; }): Promise; /** Update object properties. */ updateObject(ontology: string, objectType: string, primaryKey: string | number, params: { properties: Record; branch?: string; }): Promise; /** Delete an object. */ deleteObject(ontology: string, objectType: string, primaryKey: string | number, params?: { branch?: string; }): Promise; /** Count objects matching filters. */ countObjects(ontology: string, objectType: string, params?: { where?: Record; branch?: string; }): Promise<{ totalCount: number; }>; /** Aggregate objects. */ aggregate(ontology: string, objectType: string, params: { aggregation: Record; groupBy?: Record; where?: Record; branch?: string; }): Promise; /** Search objects. */ search(ontology: string, objectType: string, params: { where?: Record; orderBy?: Record; select?: string[]; pageSize?: number; pageToken?: string; branch?: string; }): Promise>; /** List action types for an ontology. */ listActionTypes(ontology: string, params?: PageParams & { branch?: string; }): Promise>; /** Get a specific action type. */ getActionType(ontology: string, actionType: string, params?: { branch?: string; }): Promise; /** Validate action parameters without executing. */ validateAction(ontology: string, actionType: string, params: ApplyActionParams): Promise>; /** Apply (execute) an action. */ applyAction(ontology: string, actionType: string, params: ApplyActionParams): Promise; /** List function types for an ontology. */ listFunctions(ontology: string, params?: PageParams): Promise>; /** Get a specific function type. */ getFunction(ontology: string, functionApiName: string, params?: { branch?: string; }): Promise; /** Execute a function. */ executeFunction(ontology: string, functionApiName: string, params: ExecuteFunctionParams): Promise; /** List query types for an ontology. */ listQueries(ontology: string, params?: PageParams): Promise>; /** Execute a query. */ executeQuery(ontology: string, queryApiName: string, params: Record & { branch?: string; }): Promise; /** List interface types for an ontology. */ listInterfaceTypes(ontology: string, params?: PageParams): Promise>; /** Get a specific interface type. */ getInterfaceType(ontology: string, interfaceType: string): Promise; /** List linked objects. */ listLinkedObjects(ontology: string, objectType: string, primaryKey: string | number, linkType: string, params?: PageParams & { branch?: string; }): Promise>; /** Create a link between objects. */ createLink(ontology: string, objectType: string, primaryKey: string | number, linkType: string, params: { targetPrimaryKey: string | number; branch?: string; }): Promise; /** Delete a link between objects. */ deleteLink(ontology: string, objectType: string, primaryKey: string | number, linkType: string, targetPrimaryKey: string | number, params?: { branch?: string; }): Promise; } //# sourceMappingURL=ontologies.d.ts.map