import { BaseResourceAPI, CursorAndAsyncIterator } from '@cognite/sdk-core'; import { ContainerListParams } from './types'; import { ContainerCollectionResponse, ContainerCreateDefinition, ContainerDefinition, ListOfSpaceExternalIdsRequest, ListOfSpaceExternalIdsResponse } from './types.gen'; export declare class ContainersAPI extends BaseResourceAPI { /** * [Upsert containers](https://api-docs.cognite.com/20230101/tag/Containers/operation/ApplyContainers) * * ```js * const containerDefinition = { * "space": "string", * "externalId": "string", * "name": "string", * "description": "string", * "usedFor": "node", * "properties": { * "containerPropertyIdentifier1": {}, * "containerPropertyIdentifier2": {} * }, * "constraints": { * "constraint-identifier1": {}, * "constraint-identifier2": {} * }, * "indexes": { * "index-identifier1": {}, * "index-identifier2": {} * } * } * const response = await client.containers.upsert([ * containerDefinition * ]); * ``` */ upsert: (params: ContainerCreateDefinition[]) => Promise; /** * [Delete containers](https://api-docs.cognite.com/20230101/tag/Containers/operation/deleteContainers) * * ```js * const response = await client.containers.delete([{ * space: "my_space", * externalId: "my_external_id" * }]); * * ``` */ delete: (params: ListOfSpaceExternalIdsRequest["items"]) => Promise; /** * [List containers](https://api-docs.cognite.com/20230101/tag/Containers/operation/listContainers) * * ```js * const response = await client.containers.list({ space: '', includeGlobal: true }); * // List only record containers * const recordContainers = await client.containers.list({ usedFor: ['record'] }); * // List all container types including records * const allContainers = await client.containers.list({ usedFor: ['node', 'edge', 'all', 'record'] }); * ``` */ list: (params?: ContainerListParams) => CursorAndAsyncIterator; /** * [Retrieve containers](https://api-docs.cognite.com/20230101/tag/Containers/operation/byExternalIdsContainers) * * ```js * const response = await client.containers.retrieve([ * { * space: "my_space", * externalId: "my_external_id" * } * ]); * * ``` */ retrieve: (params: ListOfSpaceExternalIdsRequest["items"]) => Promise; }