import { BaseResourceAPI, CursorAndAsyncIterator, ExternalId } from '@cognite/sdk-core'; import { ExternalTemplateInstance, TemplateInstance, TemplateInstanceFilterQuery, TemplateInstancePatch } from '../../types'; export declare class TemplateInstancesApi extends BaseResourceAPI { /** * [Create Template Instances](https://pr-1202.specs.preview.cogniteapp.com/v1.json.html#operation/postApiV1ProjectsProjectTemplategroupsExternalidVersionsVersionInstances) * * ```js * const instances = [ * { externalId: 'Well_a', templateName: "Well", fieldResolvers: { name: "Underwater P23", pressure: "21_PT19" } }, * { externalId: 'Well_b', templateName: "Well", fieldResolvers: { name: "Underwater P01" } }, * ]; * const createdInstances = await client.templates.group("myGroup").version(1).create(instances); * ``` */ create: (items: ExternalTemplateInstance[]) => Promise; /** * [Upsert Template Instances](https://pr-1202.specs.preview.cogniteapp.com/v1.json.html#operation/postApiV1ProjectsProjectTemplategroupsExternalidVersionsVersionInstancesUpsert) * * ```js * const instances = [ * { externalId: "Well_a", templateName: "Well", fieldResolvers: { name: "Underwater P23", pressure: "21_PT19" } }, * { externalId: "Well_b", templateName: "Well", fieldResolvers: { name: "Underwater P01" } }, * ]; * const createdInstances = await client.templates.group("myGroup").version(1).upsert(instances); * ``` */ upsert: (items: ExternalTemplateInstance[]) => Promise; /** * [Update Template Instances](https://pr-1202.specs.preview.cogniteapp.com/v1.json.html#operation/postApiV1ProjectsProjectTemplategroupsExternalidVersionsVersionInstancesUpdate) * * ```js * const instances = await client.templates.group("myGroup").version(1).update( [{ update: { * fieldResolvers: { * set: { * myStringField: "My Field" * } * } * }, externalId: 'someExtId' }] ); * ``` */ update: (changes: TemplateInstancePatch[]) => Promise; /** * [Retrieve Template Instances](https://pr-1202.specs.preview.cogniteapp.com/v1.json.html#operation/postApiV1ProjectsProjectTemplategroupsExternalidVersionsVersionInstancesByids) * * ```js * const instances = await client.templates.group("myGroup").version(1).retrieve([ { externalId: 'Well } ]); * ``` */ retrieve: (ids: ExternalId[], options?: { ignoreUnknownIds: boolean; }) => Promise; /** * [List Template Instances](https://pr-1202.specs.preview.cogniteapp.com/v1.json.html#operation/postApiV1ProjectsProjectTemplategroupsExternalidVersionsVersionInstancesList) * * ```js * const instances = await client.templates.group("myGroup").version(1).list( { templateNames: ["Well"] } ); * ``` */ list: (query?: TemplateInstanceFilterQuery) => CursorAndAsyncIterator; /** * [Delete Template Instances](https://pr-1202.specs.preview.cogniteapp.com/v1.json.html#operation/postApiV1ProjectsProjectTemplategroupsExternalidVersionsVersionInstancesDelete) * * ```js * const instances = await client.templates.group("myGroup").version(1).delete([{ externalId: ["Well_a"] }]); * ``` */ delete: (ids: ExternalId[], options?: { ignoreUnknownIds: boolean; }) => Promise<{}>; }