import { BaseResourceAPI, CursorAndAsyncIterator } from '@cognite/sdk-core'; import { AllVersionsQueryParameter, CursorQueryParameter, IncludeGlobalQueryParameter, IncludeInheritedPropertiesQueryParameter, ListOfAllVersionsReferences, ListOfVersionReferences, ReducedLimitQueryParameter, SpaceQueryParameter, ViewCollectionResponse, ViewCreateDefinition, ViewDefinition } from './types.gen'; export declare class ViewsAPI extends BaseResourceAPI { /** * [Upsert Views](https://api-docs.cognite.com/20230101/tag/Views/operation/ApplyViews) * * ```js * const viewDefinition = { * "externalId": "string", * "space": "string", * "name": "string", * "description": "string", * "filter": { * "and": [] * }, * "implements": [ * { * "type": "view", * "space": "string", * "externalId": "string", * "version": "string" * } * ], * "version": "string", * "properties": {} * }; * * const response = await client.views.upsert([ * viewDefinition * ]); * ``` */ upsert: (params: ViewCreateDefinition[]) => Promise; /** * [Delete Views](https://api-docs.cognite.com/20230101/tag/Views/operation/deleteViews) * * ```js * const response = await client.views.delete([{ * space: "my_space", * externalId: "my_external_id", * version: "my_version" * }]); * * ``` */ delete: (params: ListOfVersionReferences["items"]) => Promise; /** * [List Views](https://api-docs.cognite.com/20230101/tag/Views/operation/listViews) * * ```js * const response = await client.views.list(); * * ``` */ list: (params?: IncludeGlobalQueryParameter & CursorQueryParameter & ReducedLimitQueryParameter & SpaceQueryParameter & IncludeInheritedPropertiesQueryParameter & AllVersionsQueryParameter) => CursorAndAsyncIterator; /** * [Retrieve Views](https://api-docs.cognite.com/20230101/tag/Views/operation/byExternalIdsViews) * * ```js * const response = await client.views.retrieve([ * { * space: "my_space", * externalId: "my_external_id", * version: "my_optional_version" * } * ]); * * ``` */ retrieve: (params: (ListOfVersionReferences | ListOfAllVersionsReferences)["items"], options?: IncludeInheritedPropertiesQueryParameter) => Promise; }