/
datamodelsApi.ts
107 lines (101 loc) · 3 KB
/
datamodelsApi.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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
// Copyright 2023 Cognite AS
import { BaseResourceAPI, CDFHttpClient, MetadataMap } from '@cognite/sdk-core';
import {
AllVersionsQueryParameter,
CursorQueryParameter,
DataModel,
DataModelCollectionResponse,
DataModelCollectionResponseWithCursorResponse,
DataModelCreate,
IncludeGlobalQueryParameter,
InlineViewsQueryParameter,
ListOfAllVersionsReferences,
ListOfVersionReferences,
ReducedLimitQueryParameter,
SpaceQueryParameter,
} from './types.gen';
export class DataModelsAPI extends BaseResourceAPI<DataModel> {
constructor(...args: [string, CDFHttpClient, MetadataMap]) {
super(...args);
}
/**
* [Upsert datamodels](https://api-docs.cognite.com/20230101/tag/Data-models/operation/createDataModels)
*
* const datamodelDefinition = {
* "space": "string",
* "externalId": "string",
* "name": "string",
* "description": "string",
* "version": "string",
* "views": []
* }
*
* ```js
* const response = await client.dataModels.upsert([
* datamodelDefinition
* ]);
* ```
*/
public upsert = async (
params: DataModelCreate[]
): Promise<DataModelCollectionResponse> => {
const response = await this.post<DataModelCollectionResponse>(this.url(), {
data: { items: params },
});
return response.data;
};
/**
* [Delete data models](https://api-docs.cognite.com/20230101/tag/Data-models/operation/deleteDataModels)
*
* ```js
* const response = await client.dataModels.delete([{ externalId: "", space: "", version: ""}]);
*
* ```
*/
public delete = async (
params: ListOfVersionReferences['items']
): Promise<ListOfVersionReferences> => {
const response = await this.post<ListOfVersionReferences>(this.deleteUrl, {
data: { items: params },
});
return response.data;
};
/**
* [List data models](https://api-docs.cognite.com/20230101/tag/Data-models/operation/listDataModels)
*
* ```js
* const response = await client.dataModels.list();
*
* ```
*/
public list = (
params: IncludeGlobalQueryParameter &
SpaceQueryParameter &
CursorQueryParameter &
ReducedLimitQueryParameter &
AllVersionsQueryParameter &
InlineViewsQueryParameter = { includeGlobal: false }
): DataModelCollectionResponseWithCursorResponse => {
return super.listEndpoint(this.callListEndpointWithGet, params);
};
/**
* [Retrieve data models](https://api-docs.cognite.com/20230101/tag/Data-models/operation/byExternalIdsDataModels)
*
* ```js
* const response = await client.dataModels.retrieve([{ externalId: "", space: "", version: "optional"}]);
*
* ```
*/
public retrieve = async (
params: (ListOfVersionReferences | ListOfAllVersionsReferences)['items'],
options: InlineViewsQueryParameter = {}
): Promise<DataModelCollectionResponse> => {
const response = await this.post<DataModelCollectionResponse>(
this.byIdsUrl,
{
data: { items: params, ...options },
}
);
return response.data;
};
}