import { BaseResourceAPI, CursorAndAsyncIterator } from '@cognite/sdk-core'; import { DataSet, DataSetAggregate, DataSetAggregateQuery, DataSetChange, DataSetFilterRequest, ExternalDataSet, IdEither, IgnoreUnknownIds } from '../../types'; export declare class DataSetsAPI extends BaseResourceAPI { /** * @hidden */ protected getDateProps(): [string[], string[]]; /** * [Create datasets](https://docs.cognite.com/api/v1/#operation/createDataSets) * * ```js * const datasets = [ * { externalId: 'sensitiveData' }, * { writeProtected: true } * ]; * const createdDatasets = await client.datasets.create(datasets); * ``` */ create: (items: ExternalDataSet[]) => Promise; /** * [List data sets](https://docs.cognite.com/api/v1/#operation/listDataSets) * * ```js * const dataSets = await client.datasets.list({ filter: { createdTime: { min: new Date('1 jan 2018'), max: new Date('1 jan 2019') }}}); * ``` */ list: (query?: DataSetFilterRequest) => CursorAndAsyncIterator; /** * [Aggregate datasets](https://docs.cognite.com/api/v1/#operation/aggregateDataSets) * * ```js * const aggregates = await client.datasets.aggregate({ filter: { writeProtected: true } }); * console.log('Number of write protected datasets: ', aggregates[0].count) * ``` */ aggregate: (query: DataSetAggregateQuery) => Promise; /** * [Retrieve data sets](https://docs.cognite.com/api/v1/#operation/getDataSets) * * ```js * const dataSets = await client.datasets.retrieve([{id: 123}, {externalId: 'abc'}]); * ``` */ retrieve: (ids: IdEither[], params?: IgnoreUnknownIds) => Promise; /** * [Update data sets](https://docs.cognite.com/api/v1/#operation/updateDataSets) * * ```js * const dataSets = await client.datasets.update([{id: 123, update: {description: {set: 'New description'}}}]); * ``` */ update: (changes: DataSetChange[]) => Promise; }