/
spacesApi.ts
100 lines (94 loc) · 2.54 KB
/
spacesApi.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
// Copyright 2023 Cognite AS
import {
BaseResourceAPI,
CDFHttpClient,
CursorAndAsyncIterator,
MetadataMap,
} from '@cognite/sdk-core';
import {
CursorQueryParameter,
IncludeGlobalQueryParameter,
ReducedLimitQueryParameter,
SpaceCollectionResponseV3Response,
SpaceCreateDefinition,
SpaceDefinition,
} from './types.gen';
export class SpacesAPI extends BaseResourceAPI<SpaceDefinition> {
constructor(...args: [string, CDFHttpClient, MetadataMap]) {
super(...args);
}
/**
* [Upsert spaces](https://api-docs.cognite.com/20230101/tag/Spaces/operation/ApplySpaces)
*
* const spaceDefinition = {
* space: 'my_space',
* name: 'my_space',
* description: 'My space for data',
* };
*
* ```js
* const response = await client.spaces.upsert([
* spaceDefinition
* ]);
* ```
*/
public upsert = async (
params: SpaceCreateDefinition[]
): Promise<SpaceCollectionResponseV3Response> => {
const response = await this.post<SpaceCollectionResponseV3Response>(
this.url(),
{
data: { items: params },
}
);
return response.data;
};
/**
* [Delete spaces](https://api-docs.cognite.com/20230101/tag/Spaces/operation/deleteSpacesV3)
*
* ```js
* const response = await client.instances.delete(["my_space"]);
*
* ```
*/
public delete = async (params: string[]): Promise<{ items: string[] }> => {
const response = await this.post<{ items: string[] }>(this.deleteUrl, {
data: { items: params.map((space) => ({ space })) },
});
return response.data;
};
/**
* [List spaces](https://api-docs.cognite.com/20230101/tag/Spaces/operation/listSpacesV3)
*
* ```js
* const response = await client.instances.list(["my_space"]);
*
* ```
*/
public list = (
params: IncludeGlobalQueryParameter &
CursorQueryParameter &
ReducedLimitQueryParameter = { includeGlobal: false }
): CursorAndAsyncIterator<SpaceDefinition> => {
return super.listEndpoint(this.callListEndpointWithGet, params);
};
/**
* [Retrieve spaces](https://api-docs.cognite.com/20230101/tag/Spaces/operation/bySpaceIdsSpaces)
*
* ```js
* const response = await client.instances.retrieve(["my_space"]);
*
* ```
*/
public retrieve = async (
params: string[]
): Promise<SpaceCollectionResponseV3Response> => {
const response = await this.post<SpaceCollectionResponseV3Response>(
this.byIdsUrl,
{
data: { items: params.map((space) => ({ space })) },
}
);
return response.data;
};
}