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