@robotbas/robotcloud-client 0.2.22 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/helpers/index.d.mts +1 -1
- package/dist/helpers/index.d.ts +1 -1
- package/dist/helpers/index.js +209 -20
- package/dist/helpers/index.js.map +1 -1
- package/dist/helpers/index.mjs +209 -20
- package/dist/helpers/index.mjs.map +1 -1
- package/dist/{index-BQ8vrXpV.d.mts → index-9RfDay_a.d.mts} +295 -99
- package/dist/{index-BQ8vrXpV.d.ts → index-9RfDay_a.d.ts} +295 -99
- package/dist/index.d.mts +351 -164
- package/dist/index.d.ts +351 -164
- package/dist/index.js +545 -178
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +539 -178
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
- package/types/ProjectClassifer.d.ts +11 -1
- package/types/ProjectLocation.d.ts +24 -0
- package/types/ProjectSubsystem.d.ts +4 -0
- package/types/ProjectTag.d.ts +8 -1
- package/types/RobotCloudClient.d.ts +195 -9
- package/types/ServiceInstance.d.ts +27 -5
- package/types/Token.d.ts +15 -7
- package/types/alerts.d.ts +88 -0
- package/types/services-configuration.d.ts +35 -26
- package/types/services-data.d.ts +38 -38
package/dist/index.d.mts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import * as axios from 'axios';
|
|
2
|
-
import { AxiosResponse } from 'axios';
|
|
3
|
-
import { R as RegimState, T as TemperatureUnit,
|
|
4
|
-
export {
|
|
2
|
+
import { AxiosResponse, AxiosInstance } from 'axios';
|
|
3
|
+
import { R as RobotCloudOrganizations, a as RobotCloudCreateOrganization, b as RobotCloudOrganizationDetails, c as RobotCloudPutOrganization, d as RobotCloudDelete, e as RobotCloudOrganizationUsers, f as RobotCloudOrganizationCreateUser, g as RobotCloudUsers, h as RobotCloudUserDetails, i as RobotCloudPutUserDetails, j as RobotCloudUserOrganization, k as RobotCloudUserProject, l as RobotCloudPostUserProject, m as RobotCloudPutProjectUser, A as AlertsProjectStatsRequestParams, n as AlertLogsListRequestParams, o as RobotCloudNamedItem, p as RobotCloudUserSimple, q as AlertAggregatedLogsRequestParams, S as SubsystemRequestParams, r as RobotCloudDescribedItem, s as RobotCloudCreateApplication, t as RobotCloudGetApplication, u as RobotCloudPutApplication, v as RegimState, T as TemperatureUnit, w as ServiceInstanceConfigClient, x as ServiceTypeClient, y as RoomClime1AlertEventValue, z as ServiceDataRequestParams, B as ServiceDataMeasurement, C as ServiceInstanceDataRequestParams, D as ServiceInstanceHistoricParams, H as HistoricAggregateFunction, E as ServiceInstanceHistoricAggregateParams, F as RoomGuestStatus1AlertEventValue, G as AirQuality1AlertEventValue, I as AirQuality1DataEventValue, J as RoomConsumes1AlertEventValue, P as ProjectClassifiersRequestParams, K as RobotCloudRobotCloudDeviceCreate, L as RobotCloudDeviceDetails, M as RobotCloudRobotCloudDeviceModify, N as RobotCloudDeviceConfiguration, O as ProjectLocationsRequestParams, Q as RobotCloudProject, U as RobotCloudCreateProject, V as ProjectsRequestParams, W as ProjectDetailsRequestParams, X as RobotCloudProjectDetails, Y as RobotCloudPutProject, Z as RobotCloudProjectUsers, _ as RobotCloudProjectApplications, $ as RobotCloudApplicationEnable, a0 as ServiceInstancesRequestParams, a1 as RobotCloudServiceTypeDetails, a2 as LocationServiceInstancesRequestParams, a3 as ServiceInstanceRead } from './index-9RfDay_a.mjs';
|
|
4
|
+
export { ak as AppAccessLevel, ag as BaseFullPaginableRequestParams, am as FancoilSpeedState, aq as MeasurementStatus, ai as OrganizationAccessLevel, ad as PaginableRequestParams, aj as ProjectAccessLevel, ab as ProjectModifyTag, aa as ProjectTag, ac as ProjectTagDetails, ah as ProjectTagRequestParams, a8 as ProjectTagTreeNode, a9 as ProjectTagsTree, ao as RobotCloudCreateUser, a7 as RobotCloudPermissionsHelper, ap as RobotCloudProjectInstances, al as RobotCloudServiceType, an as RobotCloudUserAppAccess, ae as SortableListRequestParams, af as SubsystemTagsRequestParams, a6 as robotCloudPermissionsHelper, a4 as tagsClient, a5 as tagsHelper } from './index-9RfDay_a.mjs';
|
|
5
5
|
|
|
6
6
|
declare const robotcloudApi: axios.AxiosInstance;
|
|
7
7
|
|
|
@@ -16,17 +16,25 @@ declare class RobotCloudClientConfig {
|
|
|
16
16
|
}
|
|
17
17
|
declare const clientConfig: RobotCloudClientConfig;
|
|
18
18
|
|
|
19
|
+
interface TokenResponse {
|
|
20
|
+
token: string;
|
|
21
|
+
expiration: string; // ISO 8601 date string (YYYY-MM-DDTHH:MM:SS.SSSZ)
|
|
22
|
+
}
|
|
23
|
+
interface SessionTokenResponse {
|
|
24
|
+
access: TokenResponse;
|
|
25
|
+
renew: TokenResponse;
|
|
26
|
+
}
|
|
19
27
|
interface CheckTokenResponse {
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
28
|
+
renewed: boolean;
|
|
29
|
+
invalid: boolean;
|
|
30
|
+
access: string;
|
|
31
|
+
renew: string;
|
|
24
32
|
}
|
|
25
33
|
|
|
26
34
|
interface RobotCloudJWTPayload {
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
35
|
+
exp: number;
|
|
36
|
+
sub: string; // username
|
|
37
|
+
org: string; // organization
|
|
30
38
|
}
|
|
31
39
|
|
|
32
40
|
interface RobotCloudNewTokenResponse {
|
|
@@ -49,54 +57,179 @@ declare namespace robotCloudToken {
|
|
|
49
57
|
export { type robotCloudToken_RobotCloudNewTokenResponse as RobotCloudNewTokenResponse, robotCloudToken_decodeToken as decodeToken, robotCloudToken_isExpired as isExpired, robotCloudToken_needRenew as needRenew, robotCloudToken_renewToken as renewToken, robotCloudToken_validateToken as validateToken };
|
|
50
58
|
}
|
|
51
59
|
|
|
60
|
+
interface LoginClient {
|
|
61
|
+
login(username: string, password: string, apiKey: string): Promise<AxiosResponse<SessionTokenResponse>>;
|
|
62
|
+
renewToken(token: string): Promise<AxiosResponse<SessionTokenResponse>>;
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
declare class OrganizationsClient {
|
|
66
|
+
private robotcloudApi;
|
|
67
|
+
private logger;
|
|
68
|
+
constructor(robotcloudApi: AxiosInstance);
|
|
69
|
+
getOrganizations: () => Promise<AxiosResponse<RobotCloudOrganizations[]>>;
|
|
70
|
+
postOrganizations: () => Promise<AxiosResponse<RobotCloudCreateOrganization>>;
|
|
71
|
+
getOrganization: (organizationId: string) => Promise<AxiosResponse<RobotCloudOrganizationDetails>>;
|
|
72
|
+
putOrganization: (organizationId: string) => Promise<AxiosResponse<RobotCloudPutOrganization>>;
|
|
73
|
+
deleteOrganization: (organizationId: string) => Promise<AxiosResponse<RobotCloudDelete>>;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
declare class UsersClient {
|
|
77
|
+
private robotcloudApi;
|
|
78
|
+
private logger;
|
|
79
|
+
constructor(robotcloudApi: AxiosInstance);
|
|
80
|
+
getOrganizationUsers: (organizationId: string) => Promise<AxiosResponse<RobotCloudOrganizationUsers[]>>;
|
|
81
|
+
postOrganizationUsers: (organizationId: string) => Promise<AxiosResponse<RobotCloudOrganizationCreateUser>>;
|
|
82
|
+
getUsers: () => Promise<AxiosResponse<RobotCloudUsers[]>>;
|
|
83
|
+
getUser: (username: string) => Promise<AxiosResponse<RobotCloudUserDetails>>;
|
|
84
|
+
putUser: (username: string) => Promise<AxiosResponse<RobotCloudPutUserDetails>>;
|
|
85
|
+
deleteUser: (username: string) => Promise<AxiosResponse<RobotCloudDelete>>;
|
|
86
|
+
getUserOrganizations: (username: string) => Promise<AxiosResponse<RobotCloudUserOrganization[]>>;
|
|
87
|
+
getUserProjects: (username: string) => Promise<AxiosResponse<RobotCloudUserProject[]>>;
|
|
88
|
+
postUserProjects: (username: string) => Promise<AxiosResponse<RobotCloudPostUserProject>>;
|
|
89
|
+
getProjectToUser: (username: string, projectId: string) => Promise<AxiosResponse<RobotCloudUserProject>>;
|
|
90
|
+
putProjectToUser: (username: string, projectId: string) => Promise<AxiosResponse<RobotCloudPutProjectUser>>;
|
|
91
|
+
deleteProjectToUser: (username: string, projectId: string) => Promise<AxiosResponse<RobotCloudDelete>>;
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
interface AlertsLogsStats {
|
|
95
|
+
total: number;
|
|
96
|
+
active: number;
|
|
97
|
+
noack: number;
|
|
98
|
+
active_noack: number;
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
interface AlertLogLine {
|
|
102
|
+
id: string;
|
|
103
|
+
service: string;
|
|
104
|
+
instance: string;
|
|
105
|
+
location: RobotCloudNamedItem;
|
|
106
|
+
classifier: RobotCloudNamedItem;
|
|
107
|
+
alert_name: string;
|
|
108
|
+
acknowledged: boolean;
|
|
109
|
+
ack_time: string;
|
|
110
|
+
ack_user: RobotCloudUserSimple;
|
|
111
|
+
active: boolean;
|
|
112
|
+
active_time: string;
|
|
113
|
+
deactive_time: string;
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
interface AlertsLogsList {
|
|
117
|
+
total_size: number;
|
|
118
|
+
initial_index: number;
|
|
119
|
+
alerts: AlertLogLine[];
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
interface AlertsLogsAggregatedAlertRecord {
|
|
123
|
+
periode_start: string,
|
|
124
|
+
periode_end: string,
|
|
125
|
+
activation_count: number,
|
|
126
|
+
active_seconds: number
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
interface AlertsLogsAggregatedAlert {
|
|
130
|
+
service: string;
|
|
131
|
+
alert_name: string;
|
|
132
|
+
aggregates: AlertsLogsAggregatedAlertRecord[];
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
interface AlertsLogsAggregated {
|
|
136
|
+
alerts: AlertsLogsAggregatedAlert[];
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
interface AlertLogAckItem {
|
|
140
|
+
id: string;
|
|
141
|
+
acknowledged: boolean;
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
interface AlertLogAckAlerts {
|
|
145
|
+
alerts: AlertLogAckItem[];
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
interface AlertsClient {
|
|
149
|
+
getProjectStats(
|
|
150
|
+
projectId: string,
|
|
151
|
+
params?: AlertsProjectStatsRequestParams
|
|
152
|
+
): Promise<AxiosResponse<AlertsLogsStats>>;
|
|
153
|
+
|
|
154
|
+
getProjectLog(
|
|
155
|
+
projectId: string,
|
|
156
|
+
params: AlertLogsListRequestParams
|
|
157
|
+
): Promise<AxiosResponse<AlertsLogsList>>;
|
|
158
|
+
|
|
159
|
+
acknowledge(
|
|
160
|
+
projectId: string,
|
|
161
|
+
data: AlertLogAckAlerts
|
|
162
|
+
): Promise<AxiosResponse<AlertsLogsList>>;
|
|
163
|
+
|
|
164
|
+
getAggregatedLogs(
|
|
165
|
+
projectId: string,
|
|
166
|
+
params: AlertAggregatedLogsRequestParams
|
|
167
|
+
): Promise<AxiosResponse<AlertsLogsAggregated>>;
|
|
168
|
+
|
|
169
|
+
getAvailableAlerts(projectId: string, params?: SubsystemRequestParams): Promise<AxiosResponse<string[]>>;
|
|
170
|
+
|
|
171
|
+
getServiceTypeAlertKeys(serviceType: string): string[];
|
|
172
|
+
}
|
|
173
|
+
|
|
174
|
+
declare class ApplicationsClient {
|
|
175
|
+
private robotcloudApi;
|
|
176
|
+
private logger;
|
|
177
|
+
constructor(robotcloudApi: AxiosInstance);
|
|
178
|
+
getApplications: () => Promise<AxiosResponse<RobotCloudDescribedItem[]>>;
|
|
179
|
+
postOrganizations: () => Promise<AxiosResponse<RobotCloudCreateApplication>>;
|
|
180
|
+
getApplication: (applicationId: string) => Promise<AxiosResponse<RobotCloudGetApplication>>;
|
|
181
|
+
putApplication: (applicationId: string) => Promise<AxiosResponse<RobotCloudPutApplication>>;
|
|
182
|
+
deleteApplication: (applicationId: string) => Promise<AxiosResponse<RobotCloudDelete>>;
|
|
183
|
+
}
|
|
184
|
+
|
|
52
185
|
interface RoomClime1Data {
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
186
|
+
demandRF: boolean;
|
|
187
|
+
eco_mode: "STANDBY" | "ECO" | "VIP";
|
|
188
|
+
fancoil_manual: boolean;
|
|
189
|
+
fancoil_speed: number;
|
|
190
|
+
humidity: number;
|
|
191
|
+
humidity_set_point: number;
|
|
192
|
+
|
|
193
|
+
on: boolean;
|
|
194
|
+
onRF: boolean;
|
|
62
195
|
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
196
|
+
temperature: number;
|
|
197
|
+
temperature_set_point: number;
|
|
198
|
+
regim: RegimState;
|
|
66
199
|
}
|
|
67
200
|
|
|
68
201
|
interface RoomConsumes1Data {
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
202
|
+
energy_electric: number;
|
|
203
|
+
energy_thermal: number;
|
|
204
|
+
hot_water: number;
|
|
205
|
+
cold_water: number;
|
|
206
|
+
|
|
207
|
+
daily_energy_electric: number;
|
|
208
|
+
daily_energy_thermal: number;
|
|
209
|
+
daily_hot_water: number;
|
|
210
|
+
daily_cold_water: number;
|
|
211
|
+
daily_co2_footprint: number;
|
|
212
|
+
daily_tree_equivalent: number;
|
|
213
|
+
|
|
214
|
+
guest_energy_electric: number;
|
|
215
|
+
guest_energy_thermal: number;
|
|
216
|
+
guest_hot_water: number;
|
|
217
|
+
guest_cold_water: number;
|
|
218
|
+
guest_co2_footprint: number;
|
|
219
|
+
guest_tree_equivalent: number;
|
|
87
220
|
}
|
|
88
221
|
|
|
89
222
|
interface RoomGuestStatus1Data {
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
223
|
+
sold: boolean;
|
|
224
|
+
vip: boolean;
|
|
225
|
+
occupied: boolean;
|
|
226
|
+
do_not_disturb: boolean;
|
|
227
|
+
make_up_room: boolean;
|
|
228
|
+
tray_status: "IDLE" | 'READY' | 'FINISH';
|
|
229
|
+
remote_occupation: boolean;
|
|
230
|
+
door_open: boolean;
|
|
231
|
+
window_open: boolean;
|
|
232
|
+
medical_alarm: boolean;
|
|
100
233
|
}
|
|
101
234
|
|
|
102
235
|
interface ServiceInstanceDeviceConfig {
|
|
@@ -117,35 +250,44 @@ interface RoomGrouping1DataEventValue {
|
|
|
117
250
|
}
|
|
118
251
|
|
|
119
252
|
interface RoomClimeConfigurationParams {
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
253
|
+
temperature_set_point?: number;
|
|
254
|
+
humidity_set_point?: number;
|
|
255
|
+
regim?: RegimState;
|
|
256
|
+
eco_mode?: "STANDBY" | "ECO" | "VIP";
|
|
257
|
+
fancoil_speed?: 0 | 1 | 2 | 3;
|
|
258
|
+
on?: boolean;
|
|
259
|
+
|
|
260
|
+
hasFC?: boolean;
|
|
261
|
+
hasRF?: boolean;
|
|
262
|
+
isRFLinked?: boolean;
|
|
263
|
+
|
|
264
|
+
onRF?: boolean;
|
|
265
|
+
|
|
266
|
+
high_temperature_level?: number;
|
|
267
|
+
low_temperature_level?: number;
|
|
268
|
+
high_humidity_level?: number;
|
|
269
|
+
fancoil_on_time_limit?: number;
|
|
270
|
+
temperature_units?: TemperatureUnit;
|
|
138
271
|
}
|
|
139
272
|
|
|
140
273
|
interface RoomGuestStatusConfigurationParams {
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
274
|
+
sold?: boolean;
|
|
275
|
+
vip?: boolean;
|
|
276
|
+
do_not_disturb?: boolean;
|
|
277
|
+
make_up_room?: boolean;
|
|
278
|
+
remote_occupation?: boolean;
|
|
279
|
+
door_open_time_limit?: number;
|
|
280
|
+
window_open_time_limit?: number;
|
|
281
|
+
medical_alarm?: boolean;
|
|
282
|
+
}
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
interface RoomGroupingConfigurationParams {
|
|
286
|
+
replica_1_active: boolean;
|
|
287
|
+
replica_2_active: boolean;
|
|
288
|
+
replica_3_active: boolean;
|
|
289
|
+
associate_clime: boolean;
|
|
290
|
+
associate_presence: boolean;
|
|
149
291
|
}
|
|
150
292
|
|
|
151
293
|
declare class GenericInstanceConfigClient<T> implements ServiceInstanceConfigClient<T> {
|
|
@@ -216,10 +358,35 @@ declare class RoomConsumesClient implements ServiceTypeClient<RoomConsumes1Alert
|
|
|
216
358
|
}
|
|
217
359
|
declare const roomConsumesClient: RoomConsumesClient;
|
|
218
360
|
|
|
361
|
+
declare class RoomGroupingConfigClient extends GenericInstanceConfigClient<RoomGroupingConfigurationParams> {
|
|
362
|
+
constructor();
|
|
363
|
+
}
|
|
364
|
+
declare class RoomGroupingClient implements ServiceTypeClient<any, RoomGrouping1DataEventValue> {
|
|
365
|
+
private _configurationClient;
|
|
366
|
+
get configuration(): RoomGroupingConfigClient;
|
|
367
|
+
constructor();
|
|
368
|
+
getAlerts(prjId: string, params?: ServiceDataRequestParams): Promise<AxiosResponse<ServiceDataMeasurement<any>[]>>;
|
|
369
|
+
getData(prjId: string, params?: ServiceDataRequestParams): Promise<AxiosResponse<ServiceDataMeasurement<RoomGrouping1DataEventValue>[]>>;
|
|
370
|
+
getInstanceData: (prjId: string, instanceId: string, params?: ServiceInstanceDataRequestParams) => Promise<AxiosResponse<ServiceDataMeasurement<RoomGrouping1DataEventValue>>>;
|
|
371
|
+
getInstanceHistoric(prjId: string, instanceId: string, startTime: Date, endTime: Date, params: ServiceInstanceHistoricParams): Promise<AxiosResponse<ServiceDataMeasurement<RoomGrouping1DataEventValue>[]>>;
|
|
372
|
+
getInstanceHistoricAggregate(prjId: string, instanceId: string, startTime: Date, endTime: Date, aggFunction: HistoricAggregateFunction, periode: string, params: ServiceInstanceHistoricAggregateParams): Promise<AxiosResponse<ServiceDataMeasurement<RoomGrouping1DataEventValue>[]>>;
|
|
373
|
+
}
|
|
374
|
+
declare const roomGroupingClient: RoomGroupingClient;
|
|
375
|
+
|
|
219
376
|
interface Classifier {
|
|
220
377
|
id: string;
|
|
221
378
|
name: string;
|
|
222
|
-
description
|
|
379
|
+
description?: string;
|
|
380
|
+
}
|
|
381
|
+
|
|
382
|
+
interface ClassifierCreate {
|
|
383
|
+
name: string
|
|
384
|
+
description?: string
|
|
385
|
+
}
|
|
386
|
+
|
|
387
|
+
interface ClassifierModify {
|
|
388
|
+
name?: string
|
|
389
|
+
description?: string
|
|
223
390
|
}
|
|
224
391
|
|
|
225
392
|
interface ClassifierDetails extends Classifier {
|
|
@@ -227,135 +394,155 @@ interface ClassifierDetails extends Classifier {
|
|
|
227
394
|
|
|
228
395
|
declare class ClassifiersClient {
|
|
229
396
|
getProjectClassifiers: (prjId: string, params?: ProjectClassifiersRequestParams) => Promise<AxiosResponse<Classifier[]>>;
|
|
230
|
-
getClassifier: (classifierId: string) => Promise<AxiosResponse<ClassifierDetails
|
|
397
|
+
getClassifier: (classifierId: string) => Promise<AxiosResponse<ClassifierDetails>>;
|
|
398
|
+
putClassifier: (classifierId: string) => Promise<AxiosResponse<ClassifierModify>>;
|
|
399
|
+
postClassifier: (classifierId: string) => Promise<AxiosResponse<ClassifierCreate>>;
|
|
400
|
+
deleteClassifier: (classifierId: string) => Promise<AxiosResponse<RobotCloudDelete>>;
|
|
231
401
|
}
|
|
232
402
|
declare const classifiersClient: ClassifiersClient;
|
|
233
403
|
|
|
234
404
|
declare class DevicesClient {
|
|
235
405
|
getProjectDevices: (projectId: string) => Promise<AxiosResponse<RobotCloudNamedItem[]>>;
|
|
406
|
+
getProjectDevicesLocation: (locationId: string) => Promise<AxiosResponse<RobotCloudNamedItem[]>>;
|
|
407
|
+
postProjectDeviceLocation: (locationId: string) => Promise<AxiosResponse<RobotCloudRobotCloudDeviceCreate>>;
|
|
236
408
|
getDeviceDetails: (deviceId: string) => Promise<AxiosResponse<RobotCloudDeviceDetails>>;
|
|
409
|
+
putDeviceDetails: (deviceId: string) => Promise<AxiosResponse<RobotCloudRobotCloudDeviceModify>>;
|
|
410
|
+
deleteDevice: (deviceId: string) => Promise<AxiosResponse<RobotCloudDelete>>;
|
|
411
|
+
getDeviceConfiguration: (deviceId: string) => Promise<AxiosResponse<RobotCloudDeviceConfiguration>>;
|
|
237
412
|
}
|
|
238
413
|
declare const devicesClient: DevicesClient;
|
|
239
414
|
|
|
240
|
-
interface
|
|
241
|
-
|
|
242
|
-
|
|
415
|
+
interface ProjectLocations {
|
|
416
|
+
id: string
|
|
417
|
+
name: string
|
|
243
418
|
}
|
|
244
419
|
|
|
245
|
-
interface
|
|
246
|
-
|
|
420
|
+
interface RobotCloudLocationCreate {
|
|
421
|
+
name: string
|
|
422
|
+
description?: string;
|
|
423
|
+
tags?: string[];
|
|
247
424
|
}
|
|
248
425
|
|
|
249
|
-
interface
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
tags
|
|
253
|
-
subsystems: string[];
|
|
254
|
-
classifier: string;
|
|
426
|
+
interface RobotCloudLocationModify {
|
|
427
|
+
name?: string
|
|
428
|
+
description?: string;
|
|
429
|
+
tags?: string[];
|
|
255
430
|
}
|
|
256
431
|
|
|
257
432
|
interface RobotCloudLocationDetails {
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
433
|
+
id: string;
|
|
434
|
+
name: string;
|
|
435
|
+
description?: string;
|
|
436
|
+
project: string;
|
|
437
|
+
tags?: string[];
|
|
263
438
|
}
|
|
439
|
+
|
|
264
440
|
declare class LocationsClient {
|
|
265
|
-
getLocationServiceInstances: (prjId: string, locId: string, service_type: RobotCloudServiceType, params?: LocationServiceInstancesRequestParams) => Promise<AxiosResponse<RobotCloudServiceInstance[]>>;
|
|
266
441
|
getLocations: (prjId: string, params?: ProjectLocationsRequestParams) => Promise<AxiosResponse<RobotCloudNamedItem[]>>;
|
|
442
|
+
postLocations: (prjId: string, params?: ProjectLocationsRequestParams) => Promise<AxiosResponse<RobotCloudLocationCreate[]>>;
|
|
267
443
|
getLocation: (locationId: string) => Promise<AxiosResponse<RobotCloudLocationDetails>>;
|
|
444
|
+
putLocation: (locationId: string) => Promise<AxiosResponse<RobotCloudLocationModify>>;
|
|
445
|
+
deleteLocation: (locationId: string) => Promise<AxiosResponse<RobotCloudDelete>>;
|
|
268
446
|
}
|
|
269
447
|
declare const locationsClient: LocationsClient;
|
|
270
448
|
|
|
271
449
|
declare class ProjectsClient {
|
|
450
|
+
getOrganizationProjects: (organizationId: string) => Promise<AxiosResponse<RobotCloudProject[]>>;
|
|
451
|
+
postOrganizationProjects: (organizationId: string) => Promise<AxiosResponse<RobotCloudCreateProject>>;
|
|
272
452
|
getProjects: (params?: ProjectsRequestParams) => Promise<AxiosResponse<RobotCloudProject[]>>;
|
|
273
453
|
getProjectDetails: (prjId: string, params?: ProjectDetailsRequestParams) => Promise<AxiosResponse<RobotCloudProjectDetails>>;
|
|
274
|
-
|
|
454
|
+
putProjectDetails: (prjId: string, params?: ProjectDetailsRequestParams) => Promise<AxiosResponse<RobotCloudPutProject>>;
|
|
455
|
+
deleteProject: (prjId: string, params?: ProjectDetailsRequestParams) => Promise<AxiosResponse<RobotCloudDelete>>;
|
|
456
|
+
getProjectUsers: (prjId: string, params?: ProjectDetailsRequestParams) => Promise<AxiosResponse<RobotCloudProjectUsers>>;
|
|
457
|
+
getProjectApplications: (prjId: string, params?: ProjectDetailsRequestParams) => Promise<AxiosResponse<RobotCloudProjectApplications[]>>;
|
|
458
|
+
getProjectApplication: (prjId: string, appId: string) => Promise<AxiosResponse<RobotCloudProjectApplications>>;
|
|
459
|
+
putProjectApplication: (prjId: string, appId: string) => Promise<AxiosResponse<RobotCloudApplicationEnable>>;
|
|
275
460
|
}
|
|
276
461
|
declare const projectsClient: ProjectsClient;
|
|
277
462
|
|
|
463
|
+
interface ServiceInstanceDevicesInfo {
|
|
464
|
+
device: string;
|
|
465
|
+
index?: number;
|
|
466
|
+
}
|
|
467
|
+
|
|
468
|
+
interface RobotCloudServiceInstance extends RobotCloudNamedItem {
|
|
469
|
+
service: string;
|
|
470
|
+
}
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
interface ServiceInstanceDetails extends RobotCloudServiceInstance {
|
|
474
|
+
description?: string;
|
|
475
|
+
location?: string;
|
|
476
|
+
tags?: string[];
|
|
477
|
+
subsystems?: string[];
|
|
478
|
+
classifier?: string;
|
|
479
|
+
}
|
|
480
|
+
|
|
481
|
+
interface ModifyServiceInstanceDetails {
|
|
482
|
+
description?: string;
|
|
483
|
+
name?: string;
|
|
484
|
+
tags?: string[];
|
|
485
|
+
subsystems?: string[];
|
|
486
|
+
classifier?: string;
|
|
487
|
+
}
|
|
488
|
+
|
|
489
|
+
interface CreateServiceInstance extends RobotCloudServiceInstance {
|
|
490
|
+
description?: string;
|
|
491
|
+
name: string
|
|
492
|
+
tags?: string[];
|
|
493
|
+
subsystems?: string[];
|
|
494
|
+
classifier?: string;
|
|
495
|
+
}
|
|
496
|
+
|
|
497
|
+
interface ProjectSizeInstances {
|
|
498
|
+
total: number
|
|
499
|
+
filtered: number
|
|
500
|
+
}
|
|
501
|
+
|
|
278
502
|
declare class ServiceInstancesClient {
|
|
279
503
|
getAll: (prjId: string, params?: ServiceInstancesRequestParams) => Promise<AxiosResponse<RobotCloudServiceInstance[]>>;
|
|
280
504
|
getServiceInstances: (prjId: string, service_type: string, params?: ServiceInstancesRequestParams) => Promise<AxiosResponse<RobotCloudServiceInstance[]>>;
|
|
281
|
-
|
|
282
|
-
|
|
505
|
+
getProjectServiceTypes: (prjId: string, params?: ProjectDetailsRequestParams) => Promise<AxiosResponse<RobotCloudServiceTypeDetails[]>>;
|
|
506
|
+
getLocationServiceInstances: (prjId: string, locId: string, service_type: string, params?: LocationServiceInstancesRequestParams) => Promise<AxiosResponse<RobotCloudServiceInstance[]>>;
|
|
507
|
+
postLocationServiceInstances: (prjId: string, locId: string, service_type: string, params?: LocationServiceInstancesRequestParams) => Promise<AxiosResponse<CreateServiceInstance>>;
|
|
508
|
+
getServiceInstance: (prjId: string, service_type: string, instance_id: string) => Promise<AxiosResponse<ServiceInstanceDetails, any, {}>>;
|
|
509
|
+
putServiceInstance: (prjId: string, service_type: string, instance_id: string) => Promise<AxiosResponse<ModifyServiceInstanceDetails, any, {}>>;
|
|
510
|
+
deleteServiceInstance: (prjId: string, service_type: string, instance_id: string) => Promise<AxiosResponse<RobotCloudDelete, any, {}>>;
|
|
511
|
+
getServiceInstanceDevicesInfo: (prjId: string, service_type: string, instance_id: string) => Promise<AxiosResponse<Record<string, ServiceInstanceDevicesInfo>, any, {}>>;
|
|
512
|
+
putServiceInstanceDevicesInfo: (prjId: string, service_type: string, instance_id: string) => Promise<AxiosResponse<Record<string, ServiceInstanceDevicesInfo>, any, {}>>;
|
|
283
513
|
getServiceAllInstancesData(prjId: string, service_type: string): Promise<AxiosResponse<ServiceDataMeasurement<any>[]>>;
|
|
514
|
+
getServiceInstancesData(prjId: string, service_type: string, instance_id: string): Promise<AxiosResponse<ServiceDataMeasurement<any>[]>>;
|
|
284
515
|
getServiceAllInstancesAlerts(prjId: string, service_type: string): Promise<AxiosResponse<ServiceInstanceRead<any>[]>>;
|
|
516
|
+
getServiceInstancesAlerts(prjId: string, service_type: string, instance_id: string): Promise<AxiosResponse<ServiceDataMeasurement<any>[]>>;
|
|
517
|
+
getServiceInstancesConfiguration(prjId: string, service_type: string, instance_id: string): Promise<AxiosResponse<ServiceDataMeasurement<any>[]>>;
|
|
518
|
+
putServiceInstancesConfiguration(prjId: string, service_type: string, instance_id: string): Promise<AxiosResponse<ServiceDataMeasurement<any>[]>>;
|
|
519
|
+
getServiceInstancesHistoricData(prjId: string, service_type: string, instance_id: string): Promise<AxiosResponse<ServiceDataMeasurement<any>[]>>;
|
|
520
|
+
getServiceInstancesHistoricDataAggregate(prjId: string, service_type: string, instance_id: string): Promise<AxiosResponse<ServiceDataMeasurement<any>[]>>;
|
|
521
|
+
getServiceLocation(prjId: string, locationId: string): Promise<AxiosResponse<RobotCloudServiceTypeDetails[]>>;
|
|
522
|
+
getSizeProjectInstances(prjId: string): Promise<AxiosResponse<ProjectSizeInstances>>;
|
|
523
|
+
getSizeProjectServicesInstances(prjId: string, service_type: string): Promise<AxiosResponse<ProjectSizeInstances>>;
|
|
285
524
|
}
|
|
286
525
|
declare const serviceInstancesClient: ServiceInstancesClient;
|
|
287
526
|
|
|
527
|
+
interface putProjectSubsystem {
|
|
528
|
+
name?: string
|
|
529
|
+
description?: string
|
|
530
|
+
}
|
|
531
|
+
|
|
288
532
|
declare class SubsystemsClient {
|
|
289
|
-
getProjectSubsystems: (prjId: string) => Promise<
|
|
290
|
-
getProjectSubsystem: (prjId: string, subsysId: string) => Promise<
|
|
533
|
+
getProjectSubsystems: (prjId: string) => Promise<AxiosResponse<RobotCloudDescribedItem[]>>;
|
|
534
|
+
getProjectSubsystem: (prjId: string, subsysId: string) => Promise<AxiosResponse<RobotCloudDescribedItem>>;
|
|
535
|
+
postProjectSubsystem: (prjId: string) => Promise<AxiosResponse<RobotCloudDescribedItem>>;
|
|
536
|
+
putProjectSubsystem: (prjId: string, subsysId: string) => Promise<AxiosResponse<putProjectSubsystem>>;
|
|
537
|
+
deleteSubsystem: (prjId: string, subsysId: string) => Promise<AxiosResponse<RobotCloudDelete>>;
|
|
538
|
+
getProjectSubsystemLocations: (prjId: string, subsysId: string) => Promise<AxiosResponse<ProjectLocations>>;
|
|
291
539
|
}
|
|
292
540
|
declare const subsystemsClient: SubsystemsClient;
|
|
293
541
|
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
active: number;
|
|
297
|
-
noack: number;
|
|
298
|
-
active_noack: number;
|
|
299
|
-
}
|
|
300
|
-
interface AlertLogLine {
|
|
301
|
-
id: string;
|
|
302
|
-
service: string;
|
|
303
|
-
instance: string;
|
|
304
|
-
location: RobotCloudNamedItem;
|
|
305
|
-
classifier: RobotCloudNamedItem;
|
|
306
|
-
alert_name: string;
|
|
307
|
-
acknowledged: boolean;
|
|
308
|
-
ack_time: string;
|
|
309
|
-
ack_user: RobotCloudUserSimple;
|
|
310
|
-
active: boolean;
|
|
311
|
-
active_time: string;
|
|
312
|
-
deactive_time: string;
|
|
313
|
-
}
|
|
314
|
-
interface AlertsLogsList {
|
|
315
|
-
total_size: number;
|
|
316
|
-
initial_index: number;
|
|
317
|
-
alerts: AlertLogLine[];
|
|
318
|
-
}
|
|
319
|
-
interface AlertsLogsAggregatedAlertRecord {
|
|
320
|
-
periode_start: string;
|
|
321
|
-
periode_end: string;
|
|
322
|
-
activation_count: number;
|
|
323
|
-
active_seconds: number;
|
|
324
|
-
}
|
|
325
|
-
interface AlertsLogsAggregatedAlert {
|
|
326
|
-
service: string;
|
|
327
|
-
alert_name: string;
|
|
328
|
-
aggregates: AlertsLogsAggregatedAlertRecord[];
|
|
329
|
-
}
|
|
330
|
-
interface AlertsLogsAggregated {
|
|
331
|
-
alerts: AlertsLogsAggregatedAlert[];
|
|
332
|
-
}
|
|
333
|
-
interface AlertLogAckItem {
|
|
334
|
-
id: string;
|
|
335
|
-
acknowledged: boolean;
|
|
336
|
-
}
|
|
337
|
-
interface AlertLogAckAlerts {
|
|
338
|
-
alerts: AlertLogAckItem[];
|
|
339
|
-
}
|
|
340
|
-
interface AlertsClient {
|
|
341
|
-
getProjectStats(projectId: string, params?: AlertsProjectStatsRequestParams): Promise<AxiosResponse<AlertsLogsStats>>;
|
|
342
|
-
getProjectLog(projectId: string, params: AlertLogsListRequestParams): Promise<AxiosResponse<AlertsLogsList>>;
|
|
343
|
-
acknowledge(projectId: string, data: AlertLogAckAlerts): Promise<AxiosResponse<AlertsLogsList>>;
|
|
344
|
-
getAggregatedLogs(projectId: string, params: AlertAggregatedLogsRequestParams): Promise<AxiosResponse<AlertsLogsAggregated>>;
|
|
345
|
-
getAvailableAlerts(projectId: string, params?: SubsystemRequestParams): Promise<AxiosResponse<string[]>>;
|
|
346
|
-
}
|
|
542
|
+
declare const applicationsClient: ApplicationsClient;
|
|
543
|
+
declare const loginClient: LoginClient;
|
|
347
544
|
declare const alertsClient: AlertsClient;
|
|
348
|
-
|
|
349
|
-
declare class OrganizationsClient {
|
|
350
|
-
getOrganization: (organizationId: string) => Promise<AxiosResponse<RobotCloudOrganizationDetails>>;
|
|
351
|
-
getOrganizationProjects: (organizationId: string) => Promise<AxiosResponse<RobotCloudProject[]>>;
|
|
352
|
-
}
|
|
353
545
|
declare const organizationsClient: OrganizationsClient;
|
|
354
|
-
|
|
355
|
-
declare class UsersClient {
|
|
356
|
-
getUser: (username: string) => Promise<AxiosResponse<RobotCloudUserDetails>>;
|
|
357
|
-
getUserProjects: (username: string) => Promise<AxiosResponse<RobotCloudUserProject[]>>;
|
|
358
|
-
}
|
|
359
546
|
declare const usersClient: UsersClient;
|
|
360
547
|
|
|
361
|
-
export { AirQuality1AlertEventValue, AirQuality1DataEventValue, AlertAggregatedLogsRequestParams, type AlertLogLine, AlertLogsListRequestParams, type AlertsClient, type AlertsLogsAggregated, type AlertsLogsStats, AlertsProjectStatsRequestParams, type CheckTokenResponse, type Classifier, type ClassifierDetails, HistoricAggregateFunction, LocationServiceInstancesRequestParams, ProjectClassifiersRequestParams, ProjectDetailsRequestParams, ProjectLocationsRequestParams, ProjectsRequestParams, RegimState, RobotCloudClientConfig, RobotCloudDescribedItem, RobotCloudDeviceDetails, type RobotCloudJWTPayload, RobotCloudNamedItem, RobotCloudOrganizationDetails, RobotCloudProject, RobotCloudProjectDetails, type RobotCloudServiceInstance,
|
|
548
|
+
export { AirQuality1AlertEventValue, AirQuality1DataEventValue, AlertAggregatedLogsRequestParams, type AlertLogAckAlerts, type AlertLogLine, AlertLogsListRequestParams, type AlertsClient, type AlertsLogsAggregated, type AlertsLogsList, type AlertsLogsStats, AlertsProjectStatsRequestParams, ApplicationsClient, type CheckTokenResponse, type Classifier, type ClassifierCreate, type ClassifierDetails, type ClassifierModify, type CreateServiceInstance, HistoricAggregateFunction, LocationServiceInstancesRequestParams, type LoginClient, type ModifyServiceInstanceDetails, OrganizationsClient, ProjectClassifiersRequestParams, ProjectDetailsRequestParams, ProjectLocationsRequestParams, type ProjectSizeInstances, ProjectsRequestParams, RegimState, RobotCloudApplicationEnable, RobotCloudClientConfig, RobotCloudCreateApplication, RobotCloudCreateOrganization, RobotCloudCreateProject, RobotCloudDelete, RobotCloudDescribedItem, RobotCloudDeviceConfiguration, RobotCloudDeviceDetails, RobotCloudGetApplication, type RobotCloudJWTPayload, RobotCloudNamedItem, RobotCloudOrganizationCreateUser, RobotCloudOrganizationDetails, RobotCloudOrganizationUsers, RobotCloudOrganizations, RobotCloudPostUserProject, RobotCloudProject, RobotCloudProjectApplications, RobotCloudProjectDetails, RobotCloudProjectUsers, RobotCloudPutApplication, RobotCloudPutOrganization, RobotCloudPutProject, RobotCloudPutProjectUser, RobotCloudPutUserDetails, RobotCloudRobotCloudDeviceCreate, RobotCloudRobotCloudDeviceModify, type RobotCloudServiceInstance, RobotCloudServiceTypeDetails, RobotCloudUserDetails, RobotCloudUserOrganization, RobotCloudUserProject, RobotCloudUserSimple, RobotCloudUsers, RoomClime1AlertEventValue, type RoomClime1Data, type RoomClimeAlertsKeys, RoomClimeClient, type RoomClimeConfigurationParams, RoomConsumes1AlertEventValue, type RoomConsumes1Data, type RoomGrouping1DataEventValue, type RoomGrouping1InstanceDeviceConfig, type RoomGroupingConfigurationParams, RoomGuestStatus1AlertEventValue, type RoomGuestStatus1Data, type RoomGuestStatusConfigurationParams, ServiceDataMeasurement, ServiceDataRequestParams, ServiceInstanceConfigClient, ServiceInstanceDataRequestParams, type ServiceInstanceDetails, type ServiceInstanceDeviceConfig, type ServiceInstanceDevicesInfo, ServiceInstanceHistoricAggregateParams, ServiceInstanceHistoricParams, ServiceInstanceRead, ServiceInstancesRequestParams, ServiceTypeClient, type SessionTokenResponse, SubsystemRequestParams, TemperatureUnit, type TokenResponse, UsersClient, airQualityClient, alertsClient, applicationsClient, classifiersClient, clientConfig, devicesClient, locationsClient, loginClient, organizationsClient, projectsClient, robotCloudToken, robotcloudApi, roomClimeClient, roomConsumesClient, roomGroupingClient, roomGuestStatusClient, serviceInstancesClient, subsystemsClient, usersClient };
|