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