@openremote/rest 1.7.0-snapshot.20250605135340 → 1.7.0-snapshot.20250605141506
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/umd/index.bundle.js +1 -1
- package/dist/umd/index.js +1 -1
- package/lib/restclient.d.ts +448 -448
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +3 -3
package/lib/restclient.d.ts
CHANGED
|
@@ -9,129 +9,156 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class AppResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP GET /
|
|
17
|
-
* Java method: org.openremote.model.
|
|
16
|
+
* HTTP GET /apps
|
|
17
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
18
18
|
*/
|
|
19
|
-
|
|
20
|
-
parentId?: string;
|
|
21
|
-
parentType?: string;
|
|
22
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
19
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
23
20
|
/**
|
|
24
|
-
* HTTP GET /
|
|
25
|
-
* Java method: org.openremote.model.
|
|
21
|
+
* HTTP GET /apps/consoleConfig
|
|
22
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
26
23
|
*/
|
|
27
|
-
|
|
28
|
-
parentId?: string;
|
|
29
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
24
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
30
25
|
/**
|
|
31
|
-
* HTTP GET /
|
|
32
|
-
* Java method: org.openremote.model.
|
|
26
|
+
* HTTP GET /apps/info
|
|
27
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
33
28
|
*/
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
29
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
30
|
+
}
|
|
31
|
+
export declare class RealmResourceClient<O> {
|
|
32
|
+
protected httpClient: HttpClient<O>;
|
|
33
|
+
constructor(httpClient: HttpClient<O>);
|
|
38
34
|
/**
|
|
39
|
-
* HTTP
|
|
40
|
-
* Java method: org.openremote.model.
|
|
35
|
+
* HTTP POST /realm
|
|
36
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
41
37
|
*/
|
|
42
|
-
|
|
43
|
-
parentId?: string;
|
|
44
|
-
}, options?: O): RestResponse<{
|
|
45
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
46
|
-
}>;
|
|
38
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
47
39
|
/**
|
|
48
|
-
* HTTP GET /
|
|
49
|
-
* Java method: org.openremote.model.
|
|
40
|
+
* HTTP GET /realm
|
|
41
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
50
42
|
*/
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
43
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
44
|
+
/**
|
|
45
|
+
* HTTP GET /realm/accessible
|
|
46
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
47
|
+
*/
|
|
48
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
49
|
+
/**
|
|
50
|
+
* HTTP DELETE /realm/{name}
|
|
51
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
52
|
+
*/
|
|
53
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
54
|
+
/**
|
|
55
|
+
* HTTP GET /realm/{name}
|
|
56
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
57
|
+
*/
|
|
58
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
59
|
+
/**
|
|
60
|
+
* HTTP PUT /realm/{name}
|
|
61
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
62
|
+
*/
|
|
63
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
56
64
|
}
|
|
57
|
-
export declare class
|
|
65
|
+
export declare class AgentResourceClient<O> {
|
|
58
66
|
protected httpClient: HttpClient<O>;
|
|
59
67
|
constructor(httpClient: HttpClient<O>);
|
|
60
68
|
/**
|
|
61
|
-
* HTTP GET /
|
|
62
|
-
* Java method: org.openremote.model.
|
|
69
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
70
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
63
71
|
*/
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
toTimestamp?: number;
|
|
68
|
-
}, options?: O): RestResponse<any>;
|
|
72
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
73
|
+
realm?: string;
|
|
74
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
69
75
|
/**
|
|
70
|
-
* HTTP
|
|
71
|
-
* Java method: org.openremote.model.
|
|
76
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
77
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
72
78
|
*/
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
79
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
80
|
+
realm?: string;
|
|
81
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
77
82
|
/**
|
|
78
|
-
* HTTP
|
|
79
|
-
* Java method: org.openremote.model.
|
|
83
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
84
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
80
85
|
*/
|
|
81
|
-
|
|
86
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
87
|
+
parentId?: string;
|
|
88
|
+
realm?: string;
|
|
89
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
82
90
|
}
|
|
83
|
-
export declare class
|
|
91
|
+
export declare class FlowResourceClient<O> {
|
|
84
92
|
protected httpClient: HttpClient<O>;
|
|
85
93
|
constructor(httpClient: HttpClient<O>);
|
|
86
94
|
/**
|
|
87
|
-
* HTTP
|
|
88
|
-
* Java method: org.openremote.model.
|
|
95
|
+
* HTTP GET /flow
|
|
96
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
89
97
|
*/
|
|
90
|
-
|
|
91
|
-
assetIds?: string[];
|
|
92
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
98
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
93
99
|
/**
|
|
94
|
-
* HTTP GET /
|
|
95
|
-
* Java method: org.openremote.model.
|
|
100
|
+
* HTTP GET /flow/{name}
|
|
101
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
96
102
|
*/
|
|
97
|
-
|
|
98
|
-
realm?: string;
|
|
99
|
-
status?: Model.AlarmStatus;
|
|
100
|
-
assetId?: string;
|
|
101
|
-
assigneeId?: string;
|
|
102
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
103
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
103
104
|
/**
|
|
104
|
-
* HTTP
|
|
105
|
-
* Java method: org.openremote.model.
|
|
105
|
+
* HTTP GET /flow/{type}
|
|
106
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
106
107
|
*/
|
|
107
|
-
|
|
108
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
109
|
+
}
|
|
110
|
+
export declare class MapResourceClient<O> {
|
|
111
|
+
protected httpClient: HttpClient<O>;
|
|
112
|
+
constructor(httpClient: HttpClient<O>);
|
|
108
113
|
/**
|
|
109
|
-
* HTTP
|
|
110
|
-
* Java method: org.openremote.model.
|
|
114
|
+
* HTTP GET /map
|
|
115
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
111
116
|
*/
|
|
112
|
-
|
|
117
|
+
getSettings(options?: O): RestResponse<{
|
|
118
|
+
[id: string]: unknown;
|
|
119
|
+
}>;
|
|
113
120
|
/**
|
|
114
|
-
* HTTP
|
|
115
|
-
* Java method: org.openremote.model.
|
|
121
|
+
* HTTP PUT /map
|
|
122
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
116
123
|
*/
|
|
117
|
-
|
|
124
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
125
|
+
[id: string]: unknown;
|
|
126
|
+
}>;
|
|
118
127
|
/**
|
|
119
|
-
* HTTP DELETE /
|
|
120
|
-
* Java method: org.openremote.model.
|
|
128
|
+
* HTTP DELETE /map/deleteMap
|
|
129
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
121
130
|
*/
|
|
122
|
-
|
|
131
|
+
deleteMap(options?: O): RestResponse<{
|
|
132
|
+
[id: string]: unknown;
|
|
133
|
+
}>;
|
|
123
134
|
/**
|
|
124
|
-
* HTTP
|
|
125
|
-
* Java method: org.openremote.model.
|
|
135
|
+
* HTTP GET /map/getCustomMapInfo
|
|
136
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
126
137
|
*/
|
|
127
|
-
|
|
138
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
139
|
+
[id: string]: unknown;
|
|
140
|
+
}>;
|
|
128
141
|
/**
|
|
129
|
-
* HTTP GET /
|
|
130
|
-
* Java method: org.openremote.model.
|
|
142
|
+
* HTTP GET /map/js
|
|
143
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
131
144
|
*/
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
}
|
|
145
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
146
|
+
[id: string]: unknown;
|
|
147
|
+
}>;
|
|
148
|
+
/**
|
|
149
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
150
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
151
|
+
*/
|
|
152
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
153
|
+
/**
|
|
154
|
+
* HTTP POST /map/upload
|
|
155
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
156
|
+
*/
|
|
157
|
+
uploadMap(queryParams?: {
|
|
158
|
+
filename?: string;
|
|
159
|
+
}, options?: O): RestResponse<{
|
|
160
|
+
[id: string]: unknown;
|
|
161
|
+
}>;
|
|
135
162
|
}
|
|
136
163
|
export declare class ProvisioningResourceClient<O> {
|
|
137
164
|
protected httpClient: HttpClient<O>;
|
|
@@ -157,65 +184,39 @@ export declare class ProvisioningResourceClient<O> {
|
|
|
157
184
|
*/
|
|
158
185
|
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
159
186
|
}
|
|
160
|
-
export declare class
|
|
161
|
-
protected httpClient: HttpClient<O>;
|
|
162
|
-
constructor(httpClient: HttpClient<O>);
|
|
163
|
-
/**
|
|
164
|
-
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
165
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
166
|
-
*/
|
|
167
|
-
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
168
|
-
realm?: string;
|
|
169
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
170
|
-
/**
|
|
171
|
-
* HTTP POST /agent/assetImport/{agentId}
|
|
172
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
173
|
-
*/
|
|
174
|
-
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
175
|
-
realm?: string;
|
|
176
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
177
|
-
/**
|
|
178
|
-
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
179
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
180
|
-
*/
|
|
181
|
-
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
182
|
-
parentId?: string;
|
|
183
|
-
realm?: string;
|
|
184
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
185
|
-
}
|
|
186
|
-
export declare class RealmResourceClient<O> {
|
|
187
|
+
export declare class DashboardResourceClient<O> {
|
|
187
188
|
protected httpClient: HttpClient<O>;
|
|
188
189
|
constructor(httpClient: HttpClient<O>);
|
|
189
190
|
/**
|
|
190
|
-
* HTTP POST /
|
|
191
|
-
* Java method: org.openremote.model.
|
|
191
|
+
* HTTP POST /dashboard
|
|
192
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
192
193
|
*/
|
|
193
|
-
create(
|
|
194
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
194
195
|
/**
|
|
195
|
-
* HTTP
|
|
196
|
-
* Java method: org.openremote.model.
|
|
196
|
+
* HTTP PUT /dashboard
|
|
197
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
197
198
|
*/
|
|
198
|
-
|
|
199
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
199
200
|
/**
|
|
200
|
-
* HTTP GET /realm
|
|
201
|
-
* Java method: org.openremote.model.
|
|
201
|
+
* HTTP GET /dashboard/all/{realm}
|
|
202
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
202
203
|
*/
|
|
203
|
-
|
|
204
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
204
205
|
/**
|
|
205
|
-
* HTTP
|
|
206
|
-
* Java method: org.openremote.model.
|
|
206
|
+
* HTTP POST /dashboard/query
|
|
207
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
207
208
|
*/
|
|
208
|
-
|
|
209
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
209
210
|
/**
|
|
210
|
-
* HTTP
|
|
211
|
-
* Java method: org.openremote.model.
|
|
211
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
212
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
212
213
|
*/
|
|
213
|
-
|
|
214
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
214
215
|
/**
|
|
215
|
-
* HTTP
|
|
216
|
-
* Java method: org.openremote.model.
|
|
216
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
217
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
217
218
|
*/
|
|
218
|
-
|
|
219
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
219
220
|
}
|
|
220
221
|
export declare class RulesResourceClient<O> {
|
|
221
222
|
protected httpClient: HttpClient<O>;
|
|
@@ -325,32 +326,6 @@ export declare class RulesResourceClient<O> {
|
|
|
325
326
|
*/
|
|
326
327
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
327
328
|
}
|
|
328
|
-
export declare class ConfigurationResourceClient<O> {
|
|
329
|
-
protected httpClient: HttpClient<O>;
|
|
330
|
-
constructor(httpClient: HttpClient<O>);
|
|
331
|
-
/**
|
|
332
|
-
* HTTP GET /configuration/manager
|
|
333
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
334
|
-
*/
|
|
335
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
336
|
-
/**
|
|
337
|
-
* HTTP PUT /configuration/manager
|
|
338
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
339
|
-
*/
|
|
340
|
-
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
341
|
-
/**
|
|
342
|
-
* HTTP POST /configuration/manager/file
|
|
343
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
344
|
-
*/
|
|
345
|
-
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
346
|
-
path?: string;
|
|
347
|
-
}, options?: O): RestResponse<string>;
|
|
348
|
-
/**
|
|
349
|
-
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
350
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
351
|
-
*/
|
|
352
|
-
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
353
|
-
}
|
|
354
329
|
export declare class GatewayClientResourceClient<O> {
|
|
355
330
|
protected httpClient: HttpClient<O>;
|
|
356
331
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -387,14 +362,109 @@ export declare class GatewayClientResourceClient<O> {
|
|
|
387
362
|
*/
|
|
388
363
|
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
389
364
|
}
|
|
390
|
-
export declare class
|
|
365
|
+
export declare class UserResourceClient<O> {
|
|
391
366
|
protected httpClient: HttpClient<O>;
|
|
392
367
|
constructor(httpClient: HttpClient<O>);
|
|
393
368
|
/**
|
|
394
|
-
* HTTP
|
|
395
|
-
* Java method: org.openremote.model.
|
|
369
|
+
* HTTP PUT /user/locale
|
|
370
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrentUserLocale
|
|
371
|
+
*/
|
|
372
|
+
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
373
|
+
/**
|
|
374
|
+
* HTTP POST /user/query
|
|
375
|
+
* Java method: org.openremote.model.security.UserResource.query
|
|
376
|
+
*/
|
|
377
|
+
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
378
|
+
/**
|
|
379
|
+
* HTTP GET /user/user
|
|
380
|
+
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
381
|
+
*/
|
|
382
|
+
getCurrent(options?: O): RestResponse<Model.User>;
|
|
383
|
+
/**
|
|
384
|
+
* HTTP GET /user/userRealmRoles
|
|
385
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
386
|
+
*/
|
|
387
|
+
getCurrentUserRealmRoles(options?: O): RestResponse<string[]>;
|
|
388
|
+
/**
|
|
389
|
+
* HTTP GET /user/userRoles/{clientId}
|
|
390
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
|
|
391
|
+
*/
|
|
392
|
+
getCurrentUserClientRoles(clientId: string, options?: O): RestResponse<string[]>;
|
|
393
|
+
/**
|
|
394
|
+
* HTTP GET /user/{realm}/disconnect/{sessionID}
|
|
395
|
+
* Java method: org.openremote.model.security.UserResource.disconnectUserSession
|
|
396
|
+
*/
|
|
397
|
+
disconnectUserSession(realm: string, sessionID: string, options?: O): RestResponse<void>;
|
|
398
|
+
/**
|
|
399
|
+
* HTTP PUT /user/{realm}/reset-password/{userId}
|
|
400
|
+
* Java method: org.openremote.model.security.UserResource.resetPassword
|
|
401
|
+
*/
|
|
402
|
+
resetPassword(realm: string, userId: string, credential: Model.Credential, options?: O): RestResponse<void>;
|
|
403
|
+
/**
|
|
404
|
+
* HTTP GET /user/{realm}/reset-secret/{userId}
|
|
405
|
+
* Java method: org.openremote.model.security.UserResource.resetSecret
|
|
406
|
+
*/
|
|
407
|
+
resetSecret(realm: string, userId: string, options?: O): RestResponse<string>;
|
|
408
|
+
/**
|
|
409
|
+
* HTTP PUT /user/{realm}/roles
|
|
410
|
+
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
411
|
+
*/
|
|
412
|
+
updateRoles(realm: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
413
|
+
/**
|
|
414
|
+
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
415
|
+
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
416
|
+
*/
|
|
417
|
+
getUserRealmRoles(realm: string, userId: string, options?: O): RestResponse<string[]>;
|
|
418
|
+
/**
|
|
419
|
+
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
420
|
+
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
421
|
+
*/
|
|
422
|
+
updateUserRealmRoles(realm: string, userId: string, roles: string[], options?: O): RestResponse<void>;
|
|
423
|
+
/**
|
|
424
|
+
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
425
|
+
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
426
|
+
*/
|
|
427
|
+
getUserClientRoles(realm: string, userId: string, clientId: string, options?: O): RestResponse<string[]>;
|
|
428
|
+
/**
|
|
429
|
+
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
430
|
+
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
431
|
+
*/
|
|
432
|
+
updateUserClientRoles(realm: string, userId: string, clientId: string, roles: string[], options?: O): RestResponse<void>;
|
|
433
|
+
/**
|
|
434
|
+
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
435
|
+
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
436
|
+
*/
|
|
437
|
+
getUserSessions(realm: string, userId: string, options?: O): RestResponse<Model.UserSession[]>;
|
|
438
|
+
/**
|
|
439
|
+
* HTTP POST /user/{realm}/users
|
|
440
|
+
* Java method: org.openremote.model.security.UserResource.create
|
|
441
|
+
*/
|
|
442
|
+
create(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
443
|
+
/**
|
|
444
|
+
* HTTP PUT /user/{realm}/users
|
|
445
|
+
* Java method: org.openremote.model.security.UserResource.update
|
|
446
|
+
*/
|
|
447
|
+
update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
448
|
+
/**
|
|
449
|
+
* HTTP DELETE /user/{realm}/users/{userId}
|
|
450
|
+
* Java method: org.openremote.model.security.UserResource.delete
|
|
451
|
+
*/
|
|
452
|
+
delete(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
453
|
+
/**
|
|
454
|
+
* HTTP GET /user/{realm}/{clientId}/roles
|
|
455
|
+
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
456
|
+
*/
|
|
457
|
+
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
458
|
+
/**
|
|
459
|
+
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
460
|
+
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
461
|
+
*/
|
|
462
|
+
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
463
|
+
/**
|
|
464
|
+
* HTTP GET /user/{realm}/{userId}
|
|
465
|
+
* Java method: org.openremote.model.security.UserResource.get
|
|
396
466
|
*/
|
|
397
|
-
|
|
467
|
+
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
398
468
|
}
|
|
399
469
|
export declare class AssetResourceClient<O> {
|
|
400
470
|
protected httpClient: HttpClient<O>;
|
|
@@ -500,128 +570,149 @@ export declare class AssetResourceClient<O> {
|
|
|
500
570
|
assetIds?: string[];
|
|
501
571
|
}, options?: O): RestResponse<void>;
|
|
502
572
|
}
|
|
503
|
-
export declare class
|
|
573
|
+
export declare class SyslogResourceClient<O> {
|
|
504
574
|
protected httpClient: HttpClient<O>;
|
|
505
575
|
constructor(httpClient: HttpClient<O>);
|
|
506
576
|
/**
|
|
507
|
-
* HTTP
|
|
508
|
-
* Java method: org.openremote.model.
|
|
509
|
-
*/
|
|
510
|
-
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
511
|
-
/**
|
|
512
|
-
* HTTP POST /user/query
|
|
513
|
-
* Java method: org.openremote.model.security.UserResource.query
|
|
514
|
-
*/
|
|
515
|
-
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
516
|
-
/**
|
|
517
|
-
* HTTP GET /user/user
|
|
518
|
-
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
519
|
-
*/
|
|
520
|
-
getCurrent(options?: O): RestResponse<Model.User>;
|
|
521
|
-
/**
|
|
522
|
-
* HTTP GET /user/userRealmRoles
|
|
523
|
-
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
577
|
+
* HTTP GET /syslog/config
|
|
578
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
524
579
|
*/
|
|
525
|
-
|
|
580
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
526
581
|
/**
|
|
527
|
-
* HTTP
|
|
528
|
-
* Java method: org.openremote.model.
|
|
582
|
+
* HTTP PUT /syslog/config
|
|
583
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
529
584
|
*/
|
|
530
|
-
|
|
585
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
531
586
|
/**
|
|
532
|
-
* HTTP
|
|
533
|
-
* Java method: org.openremote.model.
|
|
587
|
+
* HTTP DELETE /syslog/event
|
|
588
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
534
589
|
*/
|
|
535
|
-
|
|
590
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
536
591
|
/**
|
|
537
|
-
* HTTP
|
|
538
|
-
* Java method: org.openremote.model.
|
|
592
|
+
* HTTP GET /syslog/event
|
|
593
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
539
594
|
*/
|
|
540
|
-
|
|
595
|
+
getEvents(queryParams?: {
|
|
596
|
+
level?: Model.SyslogLevel;
|
|
597
|
+
per_page?: number;
|
|
598
|
+
page?: number;
|
|
599
|
+
from?: number;
|
|
600
|
+
to?: number;
|
|
601
|
+
category?: Model.SyslogCategory[];
|
|
602
|
+
subCategory?: string[];
|
|
603
|
+
}, options?: O): RestResponse<any>;
|
|
604
|
+
}
|
|
605
|
+
export declare class AlarmResourceClient<O> {
|
|
606
|
+
protected httpClient: HttpClient<O>;
|
|
607
|
+
constructor(httpClient: HttpClient<O>);
|
|
541
608
|
/**
|
|
542
|
-
* HTTP
|
|
543
|
-
* Java method: org.openremote.model.
|
|
609
|
+
* HTTP POST /alarm
|
|
610
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
544
611
|
*/
|
|
545
|
-
|
|
612
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
613
|
+
assetIds?: string[];
|
|
614
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
546
615
|
/**
|
|
547
|
-
* HTTP
|
|
548
|
-
* Java method: org.openremote.model.
|
|
616
|
+
* HTTP GET /alarm
|
|
617
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
549
618
|
*/
|
|
550
|
-
|
|
619
|
+
getAlarms(queryParams?: {
|
|
620
|
+
realm?: string;
|
|
621
|
+
status?: Model.AlarmStatus;
|
|
622
|
+
assetId?: string;
|
|
623
|
+
assigneeId?: string;
|
|
624
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
551
625
|
/**
|
|
552
|
-
* HTTP
|
|
553
|
-
* Java method: org.openremote.model.
|
|
626
|
+
* HTTP DELETE /alarm
|
|
627
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
554
628
|
*/
|
|
555
|
-
|
|
629
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
556
630
|
/**
|
|
557
|
-
* HTTP PUT /
|
|
558
|
-
* Java method: org.openremote.model.
|
|
631
|
+
* HTTP PUT /alarm/assets
|
|
632
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
559
633
|
*/
|
|
560
|
-
|
|
634
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
561
635
|
/**
|
|
562
|
-
* HTTP GET /
|
|
563
|
-
* Java method: org.openremote.model.
|
|
636
|
+
* HTTP GET /alarm/{alarmId}
|
|
637
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
564
638
|
*/
|
|
565
|
-
|
|
639
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
566
640
|
/**
|
|
567
|
-
* HTTP
|
|
568
|
-
* Java method: org.openremote.model.
|
|
641
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
642
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
569
643
|
*/
|
|
570
|
-
|
|
644
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
571
645
|
/**
|
|
572
|
-
* HTTP
|
|
573
|
-
* Java method: org.openremote.model.
|
|
646
|
+
* HTTP PUT /alarm/{alarmId}
|
|
647
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
574
648
|
*/
|
|
575
|
-
|
|
649
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
576
650
|
/**
|
|
577
|
-
* HTTP
|
|
578
|
-
* Java method: org.openremote.model.
|
|
651
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
652
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
579
653
|
*/
|
|
580
|
-
|
|
654
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
655
|
+
realm?: string;
|
|
656
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
657
|
+
}
|
|
658
|
+
export declare class AssetModelResourceClient<O> {
|
|
659
|
+
protected httpClient: HttpClient<O>;
|
|
660
|
+
constructor(httpClient: HttpClient<O>);
|
|
581
661
|
/**
|
|
582
|
-
* HTTP
|
|
583
|
-
* Java method: org.openremote.model.
|
|
662
|
+
* HTTP GET /model/assetDescriptors
|
|
663
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
584
664
|
*/
|
|
585
|
-
|
|
665
|
+
getAssetDescriptors(queryParams?: {
|
|
666
|
+
parentId?: string;
|
|
667
|
+
parentType?: string;
|
|
668
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
586
669
|
/**
|
|
587
|
-
* HTTP
|
|
588
|
-
* Java method: org.openremote.model.
|
|
670
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
671
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
589
672
|
*/
|
|
590
|
-
|
|
673
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
674
|
+
parentId?: string;
|
|
675
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
591
676
|
/**
|
|
592
|
-
* HTTP GET /
|
|
593
|
-
* Java method: org.openremote.model.
|
|
677
|
+
* HTTP GET /model/assetInfos
|
|
678
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
594
679
|
*/
|
|
595
|
-
|
|
680
|
+
getAssetInfos(queryParams?: {
|
|
681
|
+
parentId?: string;
|
|
682
|
+
parentType?: string;
|
|
683
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
596
684
|
/**
|
|
597
|
-
* HTTP
|
|
598
|
-
* Java method: org.openremote.model.
|
|
685
|
+
* HTTP GET /model/metaItemDescriptors
|
|
686
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
599
687
|
*/
|
|
600
|
-
|
|
688
|
+
getMetaItemDescriptors(queryParams?: {
|
|
689
|
+
parentId?: string;
|
|
690
|
+
}, options?: O): RestResponse<{
|
|
691
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
692
|
+
}>;
|
|
601
693
|
/**
|
|
602
|
-
* HTTP GET /
|
|
603
|
-
* Java method: org.openremote.model.
|
|
694
|
+
* HTTP GET /model/valueDescriptors
|
|
695
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
604
696
|
*/
|
|
605
|
-
|
|
697
|
+
getValueDescriptors(queryParams?: {
|
|
698
|
+
parentId?: string;
|
|
699
|
+
}, options?: O): RestResponse<{
|
|
700
|
+
[index: string]: Model.ValueDescriptor;
|
|
701
|
+
}>;
|
|
606
702
|
}
|
|
607
|
-
export declare class
|
|
703
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
608
704
|
protected httpClient: HttpClient<O>;
|
|
609
705
|
constructor(httpClient: HttpClient<O>);
|
|
610
706
|
/**
|
|
611
|
-
* HTTP
|
|
612
|
-
* Java method: org.openremote.model.
|
|
613
|
-
*/
|
|
614
|
-
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
615
|
-
/**
|
|
616
|
-
* HTTP GET /flow/{name}
|
|
617
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
707
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
708
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
618
709
|
*/
|
|
619
|
-
|
|
710
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
620
711
|
/**
|
|
621
|
-
* HTTP
|
|
622
|
-
* Java method: org.openremote.model.
|
|
712
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
713
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
623
714
|
*/
|
|
624
|
-
|
|
715
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
625
716
|
}
|
|
626
717
|
export declare class NotificationResourceClient<O> {
|
|
627
718
|
protected httpClient: HttpClient<O>;
|
|
@@ -647,173 +738,87 @@ export declare class NotificationResourceClient<O> {
|
|
|
647
738
|
id?: number;
|
|
648
739
|
type?: string;
|
|
649
740
|
from?: number;
|
|
650
|
-
to?: number;
|
|
651
|
-
realmId?: string;
|
|
652
|
-
userId?: string;
|
|
653
|
-
assetId?: string;
|
|
654
|
-
}, options?: O): RestResponse<void>;
|
|
655
|
-
/**
|
|
656
|
-
* HTTP POST /notification/alert
|
|
657
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
658
|
-
*/
|
|
659
|
-
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
660
|
-
/**
|
|
661
|
-
* HTTP DELETE /notification/{notificationId}
|
|
662
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
663
|
-
*/
|
|
664
|
-
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
665
|
-
/**
|
|
666
|
-
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
667
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
668
|
-
*/
|
|
669
|
-
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
670
|
-
targetId?: string;
|
|
671
|
-
}, options?: O): RestResponse<void>;
|
|
672
|
-
/**
|
|
673
|
-
* HTTP PUT /notification/{notificationId}/delivered
|
|
674
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
675
|
-
*/
|
|
676
|
-
notificationDelivered(notificationId: number, queryParams?: {
|
|
677
|
-
targetId?: string;
|
|
678
|
-
}, options?: O): RestResponse<void>;
|
|
679
|
-
}
|
|
680
|
-
export declare class StatusResourceClient<O> {
|
|
681
|
-
protected httpClient: HttpClient<O>;
|
|
682
|
-
constructor(httpClient: HttpClient<O>);
|
|
683
|
-
/**
|
|
684
|
-
* HTTP GET /health
|
|
685
|
-
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
686
|
-
*/
|
|
687
|
-
getHealthStatus(options?: O): RestResponse<{
|
|
688
|
-
[index: string]: any;
|
|
689
|
-
}>;
|
|
690
|
-
/**
|
|
691
|
-
* HTTP GET /info
|
|
692
|
-
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
693
|
-
*/
|
|
694
|
-
getInfo(options?: O): RestResponse<{
|
|
695
|
-
[index: string]: any;
|
|
696
|
-
}>;
|
|
697
|
-
}
|
|
698
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
699
|
-
protected httpClient: HttpClient<O>;
|
|
700
|
-
constructor(httpClient: HttpClient<O>);
|
|
701
|
-
/**
|
|
702
|
-
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
703
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
704
|
-
*/
|
|
705
|
-
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
706
|
-
/**
|
|
707
|
-
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
708
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
709
|
-
*/
|
|
710
|
-
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
711
|
-
}
|
|
712
|
-
export declare class DashboardResourceClient<O> {
|
|
713
|
-
protected httpClient: HttpClient<O>;
|
|
714
|
-
constructor(httpClient: HttpClient<O>);
|
|
715
|
-
/**
|
|
716
|
-
* HTTP POST /dashboard
|
|
717
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
718
|
-
*/
|
|
719
|
-
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
720
|
-
/**
|
|
721
|
-
* HTTP PUT /dashboard
|
|
722
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
723
|
-
*/
|
|
724
|
-
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
741
|
+
to?: number;
|
|
742
|
+
realmId?: string;
|
|
743
|
+
userId?: string;
|
|
744
|
+
assetId?: string;
|
|
745
|
+
}, options?: O): RestResponse<void>;
|
|
725
746
|
/**
|
|
726
|
-
* HTTP
|
|
727
|
-
* Java method: org.openremote.model.
|
|
747
|
+
* HTTP POST /notification/alert
|
|
748
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
728
749
|
*/
|
|
729
|
-
|
|
750
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
730
751
|
/**
|
|
731
|
-
* HTTP
|
|
732
|
-
* Java method: org.openremote.model.
|
|
752
|
+
* HTTP DELETE /notification/{notificationId}
|
|
753
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
733
754
|
*/
|
|
734
|
-
|
|
755
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
735
756
|
/**
|
|
736
|
-
* HTTP
|
|
737
|
-
* Java method: org.openremote.model.
|
|
757
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
758
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
738
759
|
*/
|
|
739
|
-
|
|
760
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
761
|
+
targetId?: string;
|
|
762
|
+
}, options?: O): RestResponse<void>;
|
|
740
763
|
/**
|
|
741
|
-
* HTTP
|
|
742
|
-
* Java method: org.openremote.model.
|
|
764
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
765
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
743
766
|
*/
|
|
744
|
-
|
|
767
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
768
|
+
targetId?: string;
|
|
769
|
+
}, options?: O): RestResponse<void>;
|
|
745
770
|
}
|
|
746
|
-
export declare class
|
|
771
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
747
772
|
protected httpClient: HttpClient<O>;
|
|
748
773
|
constructor(httpClient: HttpClient<O>);
|
|
749
774
|
/**
|
|
750
|
-
* HTTP GET /
|
|
751
|
-
* Java method: org.openremote.model.
|
|
775
|
+
* HTTP GET /asset/datapoint/export
|
|
776
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
752
777
|
*/
|
|
753
|
-
|
|
778
|
+
getDatapointExport(queryParams?: {
|
|
779
|
+
attributeRefs?: string;
|
|
780
|
+
fromTimestamp?: number;
|
|
781
|
+
toTimestamp?: number;
|
|
782
|
+
}, options?: O): RestResponse<any>;
|
|
754
783
|
/**
|
|
755
|
-
* HTTP GET /
|
|
756
|
-
* Java method: org.openremote.model.
|
|
784
|
+
* HTTP GET /asset/datapoint/periods
|
|
785
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
757
786
|
*/
|
|
758
|
-
|
|
787
|
+
getDatapointPeriod(queryParams?: {
|
|
788
|
+
assetId?: string;
|
|
789
|
+
attributeName?: string;
|
|
790
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
759
791
|
/**
|
|
760
|
-
* HTTP
|
|
761
|
-
* Java method: org.openremote.model.
|
|
792
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
793
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
762
794
|
*/
|
|
763
|
-
|
|
795
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
764
796
|
}
|
|
765
|
-
export declare class
|
|
797
|
+
export declare class ConfigurationResourceClient<O> {
|
|
766
798
|
protected httpClient: HttpClient<O>;
|
|
767
799
|
constructor(httpClient: HttpClient<O>);
|
|
768
800
|
/**
|
|
769
|
-
* HTTP GET /
|
|
770
|
-
* Java method: org.openremote.model.
|
|
771
|
-
*/
|
|
772
|
-
getSettings(options?: O): RestResponse<{
|
|
773
|
-
[id: string]: unknown;
|
|
774
|
-
}>;
|
|
775
|
-
/**
|
|
776
|
-
* HTTP PUT /map
|
|
777
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
778
|
-
*/
|
|
779
|
-
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
780
|
-
[id: string]: unknown;
|
|
781
|
-
}>;
|
|
782
|
-
/**
|
|
783
|
-
* HTTP DELETE /map/deleteMap
|
|
784
|
-
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
785
|
-
*/
|
|
786
|
-
deleteMap(options?: O): RestResponse<{
|
|
787
|
-
[id: string]: unknown;
|
|
788
|
-
}>;
|
|
789
|
-
/**
|
|
790
|
-
* HTTP GET /map/getCustomMapInfo
|
|
791
|
-
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
801
|
+
* HTTP GET /configuration/manager
|
|
802
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
792
803
|
*/
|
|
793
|
-
|
|
794
|
-
[id: string]: unknown;
|
|
795
|
-
}>;
|
|
804
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
796
805
|
/**
|
|
797
|
-
* HTTP
|
|
798
|
-
* Java method: org.openremote.model.
|
|
806
|
+
* HTTP PUT /configuration/manager
|
|
807
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
799
808
|
*/
|
|
800
|
-
|
|
801
|
-
[id: string]: unknown;
|
|
802
|
-
}>;
|
|
809
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
803
810
|
/**
|
|
804
|
-
* HTTP
|
|
805
|
-
* Java method: org.openremote.model.
|
|
811
|
+
* HTTP POST /configuration/manager/file
|
|
812
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
806
813
|
*/
|
|
807
|
-
|
|
814
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
815
|
+
path?: string;
|
|
816
|
+
}, options?: O): RestResponse<string>;
|
|
808
817
|
/**
|
|
809
|
-
* HTTP
|
|
810
|
-
* Java method: org.openremote.model.
|
|
818
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
819
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
811
820
|
*/
|
|
812
|
-
|
|
813
|
-
filename?: string;
|
|
814
|
-
}, options?: O): RestResponse<{
|
|
815
|
-
[id: string]: unknown;
|
|
816
|
-
}>;
|
|
821
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
817
822
|
}
|
|
818
823
|
export declare class GatewayServiceResourceClient<O> {
|
|
819
824
|
protected httpClient: HttpClient<O>;
|
|
@@ -844,83 +849,78 @@ export declare class GatewayServiceResourceClient<O> {
|
|
|
844
849
|
*/
|
|
845
850
|
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
846
851
|
}
|
|
847
|
-
export declare class
|
|
852
|
+
export declare class ConsoleResourceClient<O> {
|
|
848
853
|
protected httpClient: HttpClient<O>;
|
|
849
854
|
constructor(httpClient: HttpClient<O>);
|
|
850
855
|
/**
|
|
851
|
-
* HTTP
|
|
852
|
-
* Java method: org.openremote.model.
|
|
853
|
-
*/
|
|
854
|
-
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
855
|
-
/**
|
|
856
|
-
* HTTP PUT /syslog/config
|
|
857
|
-
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
856
|
+
* HTTP POST /console/register
|
|
857
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
858
858
|
*/
|
|
859
|
-
|
|
859
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
860
|
+
}
|
|
861
|
+
export declare class StatusResourceClient<O> {
|
|
862
|
+
protected httpClient: HttpClient<O>;
|
|
863
|
+
constructor(httpClient: HttpClient<O>);
|
|
860
864
|
/**
|
|
861
|
-
* HTTP
|
|
862
|
-
* Java method: org.openremote.model.
|
|
865
|
+
* HTTP GET /health
|
|
866
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
863
867
|
*/
|
|
864
|
-
|
|
868
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
869
|
+
[index: string]: any;
|
|
870
|
+
}>;
|
|
865
871
|
/**
|
|
866
|
-
* HTTP GET /
|
|
867
|
-
* Java method: org.openremote.model.
|
|
872
|
+
* HTTP GET /info
|
|
873
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
868
874
|
*/
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
page?: number;
|
|
873
|
-
from?: number;
|
|
874
|
-
to?: number;
|
|
875
|
-
category?: Model.SyslogCategory[];
|
|
876
|
-
subCategory?: string[];
|
|
877
|
-
}, options?: O): RestResponse<any>;
|
|
875
|
+
getInfo(options?: O): RestResponse<{
|
|
876
|
+
[index: string]: any;
|
|
877
|
+
}>;
|
|
878
878
|
}
|
|
879
879
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
880
880
|
export declare class ApiClient {
|
|
881
|
-
protected
|
|
882
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
883
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
884
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
885
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
881
|
+
protected _appResource: AxiosAppResourceClient;
|
|
886
882
|
protected _realmResource: AxiosRealmResourceClient;
|
|
883
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
884
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
885
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
886
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
887
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
887
888
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
888
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
889
889
|
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
890
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
891
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
892
890
|
protected _userResource: AxiosUserResourceClient;
|
|
893
|
-
protected
|
|
894
|
-
protected
|
|
895
|
-
protected
|
|
891
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
892
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
893
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
894
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
896
895
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
897
|
-
protected
|
|
898
|
-
protected
|
|
899
|
-
protected
|
|
896
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
897
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
898
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
900
899
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
901
|
-
protected
|
|
900
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
901
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
902
902
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
903
|
-
get
|
|
904
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
905
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
906
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
907
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
903
|
+
get AppResource(): AxiosAppResourceClient;
|
|
908
904
|
get RealmResource(): AxiosRealmResourceClient;
|
|
905
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
906
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
907
|
+
get MapResource(): AxiosMapResourceClient;
|
|
908
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
909
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
909
910
|
get RulesResource(): AxiosRulesResourceClient;
|
|
910
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
911
911
|
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
912
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
913
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
914
912
|
get UserResource(): AxiosUserResourceClient;
|
|
915
|
-
get
|
|
916
|
-
get
|
|
917
|
-
get
|
|
913
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
914
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
915
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
916
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
918
917
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
919
|
-
get
|
|
920
|
-
get
|
|
921
|
-
get
|
|
918
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
919
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
920
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
922
921
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
923
|
-
get
|
|
922
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
923
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
924
924
|
}
|
|
925
925
|
import * as Axios from "axios";
|
|
926
926
|
declare module "axios" {
|
|
@@ -928,66 +928,66 @@ declare module "axios" {
|
|
|
928
928
|
data: R;
|
|
929
929
|
}
|
|
930
930
|
}
|
|
931
|
-
export declare class
|
|
931
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
932
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
933
|
}
|
|
934
|
-
export declare class
|
|
934
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
935
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
936
|
}
|
|
937
|
-
export declare class
|
|
937
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
938
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
939
|
}
|
|
940
|
-
export declare class
|
|
940
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
941
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
942
|
}
|
|
943
|
-
export declare class
|
|
943
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
944
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
945
|
}
|
|
946
|
-
export declare class
|
|
946
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
947
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
948
|
}
|
|
949
|
-
export declare class
|
|
949
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
950
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
951
|
}
|
|
952
|
-
export declare class
|
|
952
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
953
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
954
|
}
|
|
955
955
|
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
956
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
957
|
}
|
|
958
|
-
export declare class
|
|
958
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
959
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
960
|
}
|
|
961
961
|
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
962
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
963
|
}
|
|
964
|
-
export declare class
|
|
965
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
|
-
}
|
|
967
|
-
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
964
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
968
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
966
|
}
|
|
970
|
-
export declare class
|
|
967
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
971
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
969
|
}
|
|
973
|
-
export declare class
|
|
970
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
974
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
972
|
}
|
|
976
973
|
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
977
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
975
|
}
|
|
979
|
-
export declare class
|
|
976
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
980
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
978
|
}
|
|
982
|
-
export declare class
|
|
979
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
983
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
981
|
}
|
|
985
|
-
export declare class
|
|
982
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
986
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
984
|
}
|
|
988
985
|
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
989
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
987
|
}
|
|
991
|
-
export declare class
|
|
988
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
989
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
|
+
}
|
|
991
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
992
992
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
993
993
|
}
|