import { BaseResourceAPI, CDFHttpClient, CursorAndAsyncIterator, IdEitherWithInstance, MetadataMap } from '@cognite/sdk-core'; import { IdEither, IgnoreUnknownIds } from '../../types'; import { DataPointSubscriptionsAPI } from './subscriptions/dataPointSubscriptionsApi'; import { SyntheticQuery, TimeSeries, TimeSeriesAggregate, TimeSeriesAggregateQuery, TimeSeriesCreate, TimeSeriesFilterQuery, TimeSeriesSearchFilter, TimeSeriesUpdate } from './types'; export declare class TimeSeriesAPI extends BaseResourceAPI { private syntheticTimeseriesApi; private readonly dataPointSubscriptionsApi; /** @hidden */ constructor(resourcePath: string, ...args: [CDFHttpClient, MetadataMap]); /** * [Data point subscriptions](https://docs.cognite.com/api/v1/#tag/Data-point-subscriptions) */ get subscriptions(): DataPointSubscriptionsAPI; /** * @hidden */ protected getDateProps(): [string[], string[]]; /** * [Create time series](https://doc.cognitedata.com/api/v1/#operation/postTimeSeries) * * ```js * const timeseries = [ * { name: 'Pressure sensor', assetId: 123 }, * { name: 'Temperature sensor', description: 'Pump abc', unit: 'C' }, * ]; * const createdTimeseries = await client.timeseries.create(timeseries); * ``` */ create: (items: TimeSeriesCreate[]) => Promise; /** * [List time series](https://doc.cognitedata.com/api/v1/#operation/getTimeSeries) * * ```js * const timeseries = await client.timeseries.list({ filter: { assetIds: [1, 2] }}); * ``` */ list: (scope?: TimeSeriesFilterQuery) => CursorAndAsyncIterator; /** * [Aggregate timeseries](https://docs.cognite.com/api/v1/#operation/aggregateTimeSeries) * * ```js * const aggregates = await client.timeseries.aggregate({ filter: { isString: true } }); * console.log('Number of string timeseries: ', aggregates[0].count) * ``` */ aggregate: (query: TimeSeriesAggregateQuery) => Promise; /** * [Retrieve time series](https://doc.cognitedata.com/api/v1/#operation/getTimeSeriesByIds) * * ```js * const timeseries = await client.timeseries.retrieve([ * { id: 123 }, * { externalId: 'abc' } * ]); * ``` */ retrieve: (ids: IdEitherWithInstance[], params?: IgnoreUnknownIds) => Promise; /** * [Update time series](https://doc.cognitedata.com/api/v1/#operation/alterTimeSeries) * * ```js * const timeseries = await client.timeseries.update([{ * id: 3785438579439, * update: { * name: { set: 'New name' } * } * }]); * ``` */ update: (changes: TimeSeriesUpdate[]) => Promise; /** * [Search for time series](https://doc.cognitedata.com/api/v1/#operation/searchTimeSeries) * * ```js * const timeseries = await client.timeseries.search({ * filter: { * isString: false, * }, * search: { * query: 'Temperature' * } * }); * ``` */ search: (query: TimeSeriesSearchFilter) => Promise; /** * [Delete time series](https://doc.cognitedata.com/api/v1/#operation/deleteTimeSeries) * * ```js * await client.timeseries.delete([ * { id: 123 }, * { externalId: 'abc' } * ]); * ``` */ delete: (ids: IdEither[]) => Promise<{}>; /** * [Synthetic Query](https://docs.cognite.com/api/v1/#operation/querySyntheticTimeseries) * * ```js * await client.timeseries.syntheticQuery([ * { * expression: "24 * TS{externalId='production/hour', aggregate='average', granularity='1d'}", * start: '48h-ago', * end: 'now', * limit: 100 * } * ]); * ``` */ syntheticQuery: (items: SyntheticQuery[]) => Promise; }