import { BaseResourceAPI, CDFHttpClient, CursorAndAsyncIterator, MetadataMap } from '@cognite/sdk-core'; import { ExternalSequence, IdEither, IgnoreUnknownIds, Sequence, SequenceAggregate, SequenceChange, SequenceFilter, SequenceListScope, SequenceRow, SequenceRowsDelete, SequenceRowsInsert, SequenceRowsRetrieve, SequenceSearchFilter } from '../../types'; export declare class SequencesAPI extends BaseResourceAPI { private sequenceRowsAPI; /** @hidden */ constructor(resourcePath: string, httpClient: CDFHttpClient, map: MetadataMap); /** * @hidden */ protected getDateProps(): [string[], string[]]; /** * [Create sequences](https://docs.cognite.com/api/v1/#operation/createSequence) * * ```js * const sequences = [ * { * externalId: 'sequence_name', * columns: [ * { * externalId: 'one', * valueType: SequenceValueType.LONG, * }, * { * externalId: 'two', * }, * { * externalId: 'three', * valueType: SequenceValueType.STRING, * } * ] * } * ]; * const [sequence] = await client.sequences.create(sequences); * ``` */ create: (items: ExternalSequence[]) => Promise; /** * [List sequences](https://docs.cognite.com/api/v1/#operation/advancedListSequences) * * * ```js * const sequences = await client.sequences.list({ filter: { name: 'sequence_name' } }); * ``` */ list: (scope?: SequenceListScope) => CursorAndAsyncIterator; /** * [Aggregate sequences](https://docs.cognite.com/api/v1/#operation/aggregateSequences) * * ```js * const aggregates = await client.sequences.aggregate({ filter: { name: "Well" } }); * console.log('Number of sequences named Well: ', aggregates[0].count) * ``` */ aggregate: (query: SequenceFilter) => Promise; /** * [Retrieve sequences](https://docs.cognite.com/api/v1/#operation/getSequenceById) * * ```js * const [sequence1, sequence2] = await client.sequences.retrieve([{id: 123}, {externalId: 'abc'}]); * ``` */ retrieve: (ids: IdEither[], params?: SequenceRetrieveParams) => Promise; /** * [Update sequences](https://docs.cognite.com/api/v1/#operation/updateSequences) * * ```js * const [updatedSequence] = await client.sequences.update([{id: 123, update: {name: {set: 'New name'}}}]); * ``` */ update: (changes: SequenceChange[]) => Promise; /** * [Search sequences](https://docs.cognite.com/api/v1/#operation/searchSequences) * * ```js * const sequences = await client.sequences.search({ * filter: { * assetIds: [1, 2] * }, * search: { * query: 'n*m* desc*ion' * } * }); * ``` */ search: (query: SequenceSearchFilter) => Promise; /** * [Delete sequences](https://docs.cognite.com/api/v1/#operation/deleteSequences) * * ```js * await client.sequences.delete([{id: 123}, {externalId: 'abc'}]); * ``` */ delete: (ids: IdEither[]) => Promise; /** * [Insert rows](https://docs.cognite.com/api/v1/#operation/postSequenceData) * * ```js * * const rows = [ * { rowNumber: 0, values: [1, 2.2, 'three'] }, * { rowNumber: 1, values: [4, 5, 'six'] } * ]; * await client.sequences.insertRows([{ id: 123, rows, columns: ['one', 'two', 'three'] }]); * ``` */ insertRows: (items: SequenceRowsInsert[]) => Promise; /** * [Retrieve rows](https://docs.cognite.com/api/v1/#operation/getSequenceData) * * ```js * const rows = await client.sequences.retrieveRows({ externalId: 'sequence1' }).autoPagingToArray({ limit: 100 }); * ``` */ retrieveRows: (query: SequenceRowsRetrieve) => CursorAndAsyncIterator; /** * [Delete rows](https://docs.cognite.com/api/v1/#operation/deleteSequenceData) * * ```js * await client.sequences.deleteRows([{ id: 32423849, rows: [1,2,3] }]); * ``` */ deleteRows: (query: SequenceRowsDelete[]) => Promise; } export type SequenceRetrieveParams = IgnoreUnknownIds;