-
Notifications
You must be signed in to change notification settings - Fork 7
/
labelsApi.ts
59 lines (54 loc) · 1.56 KB
/
labelsApi.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
// Copyright 2020 Cognite AS
import { CursorAndAsyncIterator, BaseResourceAPI } from '@cognite/sdk-core';
import {
ExternalId,
ExternalLabelDefinition,
LabelDefinition,
LabelDefinitionFilterRequest,
} from '../../types';
export class LabelsAPI extends BaseResourceAPI<LabelDefinition> {
/**
* @hidden
*/
protected getDateProps() {
return this.pickDateProps(['items'], ['createdTime']);
}
/**
* [Create labels](https://docs.cognite.com/api/v1/#operation/createLabelDefinitions)
*
* ```js
* const labels = [
* { externalId: 'PUMP', name: "Pump" },
* { externalId: 'ROTATING_EQUIPMENT', name: 'Rotating equipment', description: 'Asset with rotating parts' }
* ];
* const createdLabels = await client.labels.create(labels);
* ```
*/
public create = (
items: ExternalLabelDefinition[]
): Promise<LabelDefinition[]> => {
return super.createEndpoint(items);
};
/**
* [List labels](https://docs.cognite.com/api/v1/#operation/listLabels)
*
* ```js
* const labels = await client.labels.list({ filter: { externalIdPrefix: 'Pu'}});
* ```
*/
public list = (
query?: LabelDefinitionFilterRequest
): CursorAndAsyncIterator<LabelDefinition> => {
return super.listEndpoint(this.callListEndpointWithPost, query);
};
/**
* [Delete labels](https://doc.cognitedata.com/api/v1/#operation/deleteLabels)
*
* ```js
* await client.labels.delete([{externalId: 'PUMP'}, {externalId: 'VALVE'}]);
* ```
*/
public delete = (ids: ExternalId[]) => {
return super.deleteEndpoint(ids);
};
}