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