import { BaseResourceAPI } from '@cognite/sdk-core'; import { AggregationRequest, AggregationResponse, ByIdsResponse, InstanceInspectRequest, InstanceInspectResponse, ListOfSpaceExternalIdsRequestWithTyping, NodeAndEdgeCollectionResponseWithCursorV3Response, NodeAndEdgeCreateCollection, NodeOrEdge, NodeOrEdgeDeleteRequest, NodeOrEdgeListRequestV3, NodeOrEdgeSearchRequest, QueryRequest, QueryResponse, SlimNodeAndEdgeCollectionResponse, SyncRequest } from './types.gen'; export declare class InstancesAPI extends BaseResourceAPI { /** * [Search instances](https://developer.cognite.com/api#tag/Instances/operation/searchInstances) * * ```js * const response = await client.instances.search({ * view: { * externalId: 'Describable', * space: 'cdf_core', * type: 'view', * version: 'v1', * }, * query: 'your_query', * filter: { * equals: { * property: ['title'], * value: 'your title', * }, * }, * limit: 1000, * }); * ``` */ search: (params: NodeOrEdgeSearchRequest) => Promise; /** * [List instances](https://developer.cognite.com/api#tag/Instances/operation/advancedListInstance) * * ```js * const response = await client.instances.list({ * instanceType: 'node', * sources: [{ * source: { * externalId: 'Describable', * space: 'cdf_core', * type: 'view', * version: 'v1', * }, * }], * filter: { * equals: { * property: ['title'], * value: 'your title', * }, * }, * sort: [ * { property: ['title'], direction: 'ascending', nullsFirst: false }, * ], * limit: 1000, *}); * ``` */ list: (params: NodeOrEdgeListRequestV3) => Promise; /** * [Retrieve instances](https://developer.cognite.com/api#tag/Instances/operation/byExternalIdsInstances) * * ```js * const response = await client.instances.retrieve({ * sources: [{ source: { * externalId: 'Describable', * space: 'cdf_core', * type: 'view', * version: 'v1', * } * }], * items: [ * { * externalId: "node-external-id", * space: "node-space", * instanceType: 'node', * }, * ], * }); * ``` */ retrieve: (params: ListOfSpaceExternalIdsRequestWithTyping) => Promise; /** * [Upsert instances](https://developer.cognite.com/api#tag/Instances/operation/applyNodeAndEdges) * * ```js * await client.instances.upsert({ * items: [ * { * instanceType: 'node', * externalId: 'node-external-id', * space: 'node-space', * sources: [ * { * source: { * externalId: 'Describable', * space: 'cdf_core', * type: 'view', * version: 'v1', * }, * properties: { * title: 'node-title', * description: 'node-description', * labels: 'node-labels', * }, * }, * ], * }, * ], * }); * ``` */ upsert: (params: NodeAndEdgeCreateCollection) => Promise; /** * [Delete instances](https://developer.cognite.com/api#tag/Instances/operation/deleteBulk) * * ```js * await client.instances.delete([ * { * instanceType: "node", * externalId: "node-external-id", * space: "node-space", * }, * ]); * ``` */ delete: (items: NodeOrEdgeDeleteRequest["items"]) => Promise<{}>; /** * [Aggregate instances](https://developer.cognite.com/api#tag/Instances/operation/aggregateInstances) * * ```js * const response = await client.instances.aggregate({ * view: { * externalId: 'Describable', * space: 'cdf_core', * type: 'view', * version: 'v1', * }, * groupBy: ['externalId'], * aggregates: [{ count: { property: 'externalId' } }], * filter: { * prefix: { * property: ['title'], * value: 'titl', * }, * }, * limit: 1, * }); * ``` */ aggregate: (params: AggregationRequest) => Promise; /** * [Query instances](https://developer.cognite.com/api#tag/Instances/operation/queryContent) * * ```js * const response = await client.instances.query({ * with: { * result_set_1: { * nodes: { * filter: { * equals: { * property: ['node', 'externalId'], * value: "node-external-id", * }, * }, * }, * }, * }, * select: { * result_set_1: {}, * }, * }); * ``` */ query: (params: QueryRequest) => Promise; /** * [Sync instances](https://developer.cognite.com/api#tag/Instances/operation/syncContent) * * ```js * const response = await client.instances.sync({ * with: { * result_set_1: { * nodes: { * filter: { * equals: { * property: ['node', 'externalId'], * value: "node-external-id", * }, * }, * }, * }, * }, * select: { * result_set_1: {}, * }, * }); * ``` */ sync: (params: SyncRequest) => Promise; /** * [Inspect instances](https://developer.cognite.com/api#tag/Instances/operation/instanceInspect) * * ```js * const response = await client.instances.inspect({ * inspectionOperations: { * involvedViews: { * allVersions: true, * }, * }, * items: [ * { * instanceType: 'node', * externalId: 'my-node-id', * space: 'my-space', * }, * ], * }); * ``` */ inspect: (params: InstanceInspectRequest) => Promise; }