@openremote/rest 1.0.2 → 1.2.0-snapshot.20240512155932
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/README.md +56 -9
- package/dist/umd/index.bundle.js +1 -0
- package/dist/umd/index.js +1 -0
- package/lib/index.d.ts +18 -0
- package/lib/index.js +1 -0
- package/lib/index.js.map +1 -0
- package/lib/restclient.d.ts +869 -0
- package/lib/restclient.js +1 -0
- package/lib/restclient.js.map +1 -0
- package/package.json +23 -13
- package/dist/index.d.ts +0 -14
- package/dist/index.js +0 -27
- package/dist/index.js.map +0 -1
- package/dist/restclient.d.ts +0 -557
- package/dist/restclient.js +0 -765
- package/dist/restclient.js.map +0 -1
package/dist/restclient.d.ts
DELETED
|
@@ -1,557 +0,0 @@
|
|
|
1
|
-
import * as Model from "@openremote/model";
|
|
2
|
-
export interface HttpClient<O> {
|
|
3
|
-
request<R>(requestConfig: {
|
|
4
|
-
method: string;
|
|
5
|
-
url: string;
|
|
6
|
-
queryParams?: any;
|
|
7
|
-
data?: any;
|
|
8
|
-
copyFn?: (data: R) => R;
|
|
9
|
-
options?: O;
|
|
10
|
-
}): RestResponse<R>;
|
|
11
|
-
}
|
|
12
|
-
export declare class NotificationResourceClient<O> {
|
|
13
|
-
protected httpClient: HttpClient<O>;
|
|
14
|
-
constructor(httpClient: HttpClient<O>);
|
|
15
|
-
/**
|
|
16
|
-
* HTTP GET /notification
|
|
17
|
-
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
18
|
-
*/
|
|
19
|
-
getNotifications(queryParams?: {
|
|
20
|
-
id?: number;
|
|
21
|
-
type?: string;
|
|
22
|
-
from?: number;
|
|
23
|
-
to?: number;
|
|
24
|
-
tenantId?: string;
|
|
25
|
-
userId?: string;
|
|
26
|
-
assetId?: string;
|
|
27
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
28
|
-
/**
|
|
29
|
-
* HTTP DELETE /notification
|
|
30
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
31
|
-
*/
|
|
32
|
-
removeNotifications(queryParams?: {
|
|
33
|
-
id?: number;
|
|
34
|
-
type?: string;
|
|
35
|
-
from?: number;
|
|
36
|
-
to?: number;
|
|
37
|
-
tenantId?: string;
|
|
38
|
-
userId?: string;
|
|
39
|
-
assetId?: string;
|
|
40
|
-
}, options?: O): RestResponse<void>;
|
|
41
|
-
/**
|
|
42
|
-
* HTTP POST /notification/alert
|
|
43
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
44
|
-
*/
|
|
45
|
-
sendNotification(arg1: Model.Notification, options?: O): RestResponse<void>;
|
|
46
|
-
/**
|
|
47
|
-
* HTTP DELETE /notification/{notificationId}
|
|
48
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
49
|
-
*/
|
|
50
|
-
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
51
|
-
/**
|
|
52
|
-
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
53
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
54
|
-
*/
|
|
55
|
-
notificationAcknowledged(notificationId: number, arg3: any, queryParams?: {
|
|
56
|
-
targetId?: string;
|
|
57
|
-
}, options?: O): RestResponse<void>;
|
|
58
|
-
/**
|
|
59
|
-
* HTTP PUT /notification/{notificationId}/delivered
|
|
60
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
61
|
-
*/
|
|
62
|
-
notificationDelivered(notificationId: number, queryParams?: {
|
|
63
|
-
targetId?: string;
|
|
64
|
-
}, options?: O): RestResponse<void>;
|
|
65
|
-
}
|
|
66
|
-
export declare class AssetResourceClient<O> {
|
|
67
|
-
protected httpClient: HttpClient<O>;
|
|
68
|
-
constructor(httpClient: HttpClient<O>);
|
|
69
|
-
/**
|
|
70
|
-
* HTTP POST /asset
|
|
71
|
-
* Java method: org.openremote.model.asset.AssetResource.create
|
|
72
|
-
*/
|
|
73
|
-
create(arg1: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
74
|
-
/**
|
|
75
|
-
* HTTP DELETE /asset/link/{realm}/{userId}/{assetId}
|
|
76
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteUserAsset
|
|
77
|
-
*/
|
|
78
|
-
deleteUserAsset(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
79
|
-
/**
|
|
80
|
-
* HTTP GET /asset/partial/{assetId}
|
|
81
|
-
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
82
|
-
*/
|
|
83
|
-
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
84
|
-
/**
|
|
85
|
-
* HTTP GET /asset/public/query
|
|
86
|
-
* Java method: org.openremote.model.asset.AssetResource.getPublicAssets
|
|
87
|
-
*/
|
|
88
|
-
getPublicAssets(queryParams?: {
|
|
89
|
-
q?: string;
|
|
90
|
-
}, options?: O): RestResponse<Model.Asset[]>;
|
|
91
|
-
/**
|
|
92
|
-
* HTTP POST /asset/public/query
|
|
93
|
-
* Java method: org.openremote.model.asset.AssetResource.queryPublicAssets
|
|
94
|
-
*/
|
|
95
|
-
queryPublicAssets(arg1: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
96
|
-
/**
|
|
97
|
-
* HTTP POST /asset/query
|
|
98
|
-
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
99
|
-
*/
|
|
100
|
-
queryAssets(arg1: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
101
|
-
/**
|
|
102
|
-
* HTTP GET /asset/user/current
|
|
103
|
-
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
104
|
-
*/
|
|
105
|
-
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
106
|
-
/**
|
|
107
|
-
* HTTP POST /asset/user/link
|
|
108
|
-
* Java method: org.openremote.model.asset.AssetResource.createUserAsset
|
|
109
|
-
*/
|
|
110
|
-
createUserAsset(arg1: Model.UserAsset, options?: O): RestResponse<void>;
|
|
111
|
-
/**
|
|
112
|
-
* HTTP GET /asset/user/link
|
|
113
|
-
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
114
|
-
*/
|
|
115
|
-
getUserAssetLinks(queryParams?: {
|
|
116
|
-
realm?: string;
|
|
117
|
-
userId?: string;
|
|
118
|
-
assetId?: string;
|
|
119
|
-
}, options?: O): RestResponse<Model.UserAsset[]>;
|
|
120
|
-
/**
|
|
121
|
-
* HTTP DELETE /asset/{assetId}
|
|
122
|
-
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
123
|
-
*/
|
|
124
|
-
delete(assetId: string, options?: O): RestResponse<void>;
|
|
125
|
-
/**
|
|
126
|
-
* HTTP GET /asset/{assetId}
|
|
127
|
-
* Java method: org.openremote.model.asset.AssetResource.get
|
|
128
|
-
*/
|
|
129
|
-
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
130
|
-
/**
|
|
131
|
-
* HTTP PUT /asset/{assetId}
|
|
132
|
-
* Java method: org.openremote.model.asset.AssetResource.update
|
|
133
|
-
*/
|
|
134
|
-
update(assetId: string, arg2: Model.Asset, options?: O): RestResponse<void>;
|
|
135
|
-
/**
|
|
136
|
-
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
137
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
138
|
-
*/
|
|
139
|
-
writeAttributeValue(assetId: string, attributeName: string, arg3: string, options?: O): RestResponse<void>;
|
|
140
|
-
}
|
|
141
|
-
export declare class StatusResourceClient<O> {
|
|
142
|
-
protected httpClient: HttpClient<O>;
|
|
143
|
-
constructor(httpClient: HttpClient<O>);
|
|
144
|
-
/**
|
|
145
|
-
* HTTP GET /health
|
|
146
|
-
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
147
|
-
*/
|
|
148
|
-
getHealthStatus(options?: O): RestResponse<object>;
|
|
149
|
-
/**
|
|
150
|
-
* HTTP GET /info
|
|
151
|
-
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
152
|
-
*/
|
|
153
|
-
getInfo(options?: O): RestResponse<object>;
|
|
154
|
-
}
|
|
155
|
-
export declare class AssetDatapointResourceClient<O> {
|
|
156
|
-
protected httpClient: HttpClient<O>;
|
|
157
|
-
constructor(httpClient: HttpClient<O>);
|
|
158
|
-
/**
|
|
159
|
-
* HTTP GET /asset/datapoint/{assetId}/attribute/{attributeName}
|
|
160
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getNumberDatapoints
|
|
161
|
-
*/
|
|
162
|
-
getNumberDatapoints(assetId: string, attributeName: string, queryParams?: {
|
|
163
|
-
interval?: Model.DatapointInterval;
|
|
164
|
-
timestamp?: number;
|
|
165
|
-
}, options?: O): RestResponse<Model.NumberDatapoint[]>;
|
|
166
|
-
}
|
|
167
|
-
export declare class AssetModelResourceClient<O> {
|
|
168
|
-
protected httpClient: HttpClient<O>;
|
|
169
|
-
constructor(httpClient: HttpClient<O>);
|
|
170
|
-
/**
|
|
171
|
-
* HTTP GET /model/asset/descriptors
|
|
172
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
173
|
-
*/
|
|
174
|
-
getAssetDescriptors(options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
175
|
-
/**
|
|
176
|
-
* HTTP GET /model/attribute/typeDescriptors
|
|
177
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAttributeDescriptors
|
|
178
|
-
*/
|
|
179
|
-
getAttributeDescriptors(options?: O): RestResponse<Model.AttributeDescriptor[]>;
|
|
180
|
-
/**
|
|
181
|
-
* HTTP GET /model/attribute/valueDescriptors
|
|
182
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAttributeValueDescriptors
|
|
183
|
-
*/
|
|
184
|
-
getAttributeValueDescriptors(options?: O): RestResponse<Model.AttributeValueDescriptor[]>;
|
|
185
|
-
/**
|
|
186
|
-
* HTTP GET /model/metaItem/descriptors
|
|
187
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
188
|
-
*/
|
|
189
|
-
getMetaItemDescriptors(options?: O): RestResponse<Model.MetaItemDescriptor[]>;
|
|
190
|
-
}
|
|
191
|
-
export declare class RulesResourceClient<O> {
|
|
192
|
-
protected httpClient: HttpClient<O>;
|
|
193
|
-
constructor(httpClient: HttpClient<O>);
|
|
194
|
-
/**
|
|
195
|
-
* HTTP POST /rules
|
|
196
|
-
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
197
|
-
*/
|
|
198
|
-
createGlobalRuleset(arg1: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
199
|
-
/**
|
|
200
|
-
* HTTP GET /rules
|
|
201
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
202
|
-
*/
|
|
203
|
-
getGlobalRulesets(queryParams?: {
|
|
204
|
-
language?: Model.RulesetLang;
|
|
205
|
-
fullyPopulate?: boolean;
|
|
206
|
-
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
207
|
-
/**
|
|
208
|
-
* HTTP POST /rules/asset
|
|
209
|
-
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
210
|
-
*/
|
|
211
|
-
createAssetRuleset(arg1: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
212
|
-
/**
|
|
213
|
-
* HTTP GET /rules/asset/for/{assetId}
|
|
214
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
215
|
-
*/
|
|
216
|
-
getAssetRulesets(assetId: string, queryParams?: {
|
|
217
|
-
language?: Model.RulesetLang;
|
|
218
|
-
fullyPopulate?: boolean;
|
|
219
|
-
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
220
|
-
/**
|
|
221
|
-
* HTTP DELETE /rules/asset/{id}
|
|
222
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
223
|
-
*/
|
|
224
|
-
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
225
|
-
/**
|
|
226
|
-
* HTTP GET /rules/asset/{id}
|
|
227
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
228
|
-
*/
|
|
229
|
-
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
230
|
-
/**
|
|
231
|
-
* HTTP PUT /rules/asset/{id}
|
|
232
|
-
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
233
|
-
*/
|
|
234
|
-
updateAssetRuleset(id: number, arg2: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
235
|
-
/**
|
|
236
|
-
* HTTP GET /rules/geofences/{assetId}
|
|
237
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
238
|
-
*/
|
|
239
|
-
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
240
|
-
/**
|
|
241
|
-
* HTTP GET /rules/info/asset/{assetId}
|
|
242
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
243
|
-
*/
|
|
244
|
-
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
245
|
-
/**
|
|
246
|
-
* HTTP GET /rules/info/global
|
|
247
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
248
|
-
*/
|
|
249
|
-
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
250
|
-
/**
|
|
251
|
-
* HTTP GET /rules/info/tenant/{realm}
|
|
252
|
-
* Java method: org.openremote.model.rules.RulesResource.getTenantEngineInfo
|
|
253
|
-
*/
|
|
254
|
-
getTenantEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
255
|
-
/**
|
|
256
|
-
* HTTP POST /rules/tenant
|
|
257
|
-
* Java method: org.openremote.model.rules.RulesResource.createTenantRuleset
|
|
258
|
-
*/
|
|
259
|
-
createTenantRuleset(arg1: Model.TenantRuleset, options?: O): RestResponse<void>;
|
|
260
|
-
/**
|
|
261
|
-
* HTTP GET /rules/tenant/for/{realm}
|
|
262
|
-
* Java method: org.openremote.model.rules.RulesResource.getTenantRulesets
|
|
263
|
-
*/
|
|
264
|
-
getTenantRulesets(realm: string, queryParams?: {
|
|
265
|
-
language?: Model.RulesetLang;
|
|
266
|
-
fullyPopulate?: boolean;
|
|
267
|
-
}, options?: O): RestResponse<Model.TenantRuleset[]>;
|
|
268
|
-
/**
|
|
269
|
-
* HTTP DELETE /rules/tenant/{id}
|
|
270
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteTenantRuleset
|
|
271
|
-
*/
|
|
272
|
-
deleteTenantRuleset(id: number, options?: O): RestResponse<void>;
|
|
273
|
-
/**
|
|
274
|
-
* HTTP GET /rules/tenant/{id}
|
|
275
|
-
* Java method: org.openremote.model.rules.RulesResource.getTenantRuleset
|
|
276
|
-
*/
|
|
277
|
-
getTenantRuleset(id: number, options?: O): RestResponse<Model.TenantRuleset>;
|
|
278
|
-
/**
|
|
279
|
-
* HTTP PUT /rules/tenant/{id}
|
|
280
|
-
* Java method: org.openremote.model.rules.RulesResource.updateTenantRuleset
|
|
281
|
-
*/
|
|
282
|
-
updateTenantRuleset(id: number, arg2: Model.TenantRuleset, options?: O): RestResponse<void>;
|
|
283
|
-
/**
|
|
284
|
-
* HTTP DELETE /rules/{id}
|
|
285
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
286
|
-
*/
|
|
287
|
-
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
288
|
-
/**
|
|
289
|
-
* HTTP GET /rules/{id}
|
|
290
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
291
|
-
*/
|
|
292
|
-
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
293
|
-
/**
|
|
294
|
-
* HTTP PUT /rules/{id}
|
|
295
|
-
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
296
|
-
*/
|
|
297
|
-
updateGlobalRuleset(id: number, arg2: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
298
|
-
}
|
|
299
|
-
export declare class ConsoleResourceClient<O> {
|
|
300
|
-
protected httpClient: HttpClient<O>;
|
|
301
|
-
constructor(httpClient: HttpClient<O>);
|
|
302
|
-
/**
|
|
303
|
-
* HTTP POST /console/register
|
|
304
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
305
|
-
*/
|
|
306
|
-
register(arg1: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
307
|
-
}
|
|
308
|
-
export declare class AgentResourceClient<O> {
|
|
309
|
-
protected httpClient: HttpClient<O>;
|
|
310
|
-
constructor(httpClient: HttpClient<O>);
|
|
311
|
-
/**
|
|
312
|
-
* HTTP GET /agent/configuration/{agentId}/{protocolName}
|
|
313
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.getDiscoveredProtocolConfigurations
|
|
314
|
-
*/
|
|
315
|
-
getDiscoveredProtocolConfigurations(agentId: string, protocolName: string, options?: O): RestResponse<Model.AssetAttribute[]>;
|
|
316
|
-
/**
|
|
317
|
-
* HTTP POST /agent/import/{agentId}/{protocolConfigurationName}
|
|
318
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.importLinkedAttributes
|
|
319
|
-
*/
|
|
320
|
-
importLinkedAttributes(agentId: string, protocolConfigurationName: string, arg5: Model.FileInfo, queryParams?: {
|
|
321
|
-
parentId?: string;
|
|
322
|
-
realm?: string;
|
|
323
|
-
}, options?: O): RestResponse<Model.Asset[]>;
|
|
324
|
-
/**
|
|
325
|
-
* HTTP GET /agent/protocol
|
|
326
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.getAllSupportedProtocols
|
|
327
|
-
*/
|
|
328
|
-
getAllSupportedProtocols(options?: O): RestResponse<{
|
|
329
|
-
[index: string]: Model.ProtocolDescriptor[];
|
|
330
|
-
}>;
|
|
331
|
-
/**
|
|
332
|
-
* HTTP GET /agent/protocol/{agentId}
|
|
333
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.getSupportedProtocols
|
|
334
|
-
*/
|
|
335
|
-
getSupportedProtocols(agentId: string, options?: O): RestResponse<Model.ProtocolDescriptor[]>;
|
|
336
|
-
/**
|
|
337
|
-
* HTTP GET /agent/search/{agentId}/{protocolConfigurationName}
|
|
338
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.searchForLinkedAttributes
|
|
339
|
-
*/
|
|
340
|
-
searchForLinkedAttributes(agentId: string, protocolConfigurationName: string, queryParams?: {
|
|
341
|
-
parentId?: string;
|
|
342
|
-
realm?: string;
|
|
343
|
-
}, options?: O): RestResponse<Model.Asset[]>;
|
|
344
|
-
/**
|
|
345
|
-
* HTTP GET /agent/status/{agentId}
|
|
346
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.getAgentStatus
|
|
347
|
-
*/
|
|
348
|
-
getAgentStatus(agentId: string, options?: O): RestResponse<Model.AgentStatusEvent[]>;
|
|
349
|
-
/**
|
|
350
|
-
* HTTP POST /agent/validate/{agentId}
|
|
351
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.validateProtocolConfiguration
|
|
352
|
-
*/
|
|
353
|
-
validateProtocolConfiguration(agentId: string, arg2: Model.AssetAttribute, options?: O): RestResponse<Model.AttributeValidationResult>;
|
|
354
|
-
}
|
|
355
|
-
export declare class ConsoleAppResourceClient<O> {
|
|
356
|
-
protected httpClient: HttpClient<O>;
|
|
357
|
-
constructor(httpClient: HttpClient<O>);
|
|
358
|
-
/**
|
|
359
|
-
* HTTP GET /app
|
|
360
|
-
* Java method: org.openremote.model.apps.ConsoleAppResource.getInstalledApps
|
|
361
|
-
*/
|
|
362
|
-
getInstalledApps(options?: O): RestResponse<string[]>;
|
|
363
|
-
}
|
|
364
|
-
export declare class UserResourceClient<O> {
|
|
365
|
-
protected httpClient: HttpClient<O>;
|
|
366
|
-
constructor(httpClient: HttpClient<O>);
|
|
367
|
-
/**
|
|
368
|
-
* HTTP POST /user/{realm}
|
|
369
|
-
* Java method: org.openremote.model.security.UserResource.create
|
|
370
|
-
*/
|
|
371
|
-
create(realm: string, arg2: Model.User, options?: O): RestResponse<void>;
|
|
372
|
-
/**
|
|
373
|
-
* HTTP GET /user/{realm}
|
|
374
|
-
* Java method: org.openremote.model.security.UserResource.getAll
|
|
375
|
-
*/
|
|
376
|
-
getAll(realm: string, options?: O): RestResponse<Model.User[]>;
|
|
377
|
-
/**
|
|
378
|
-
* HTTP DELETE /user/{realm}/{userId}
|
|
379
|
-
* Java method: org.openremote.model.security.UserResource.delete
|
|
380
|
-
*/
|
|
381
|
-
delete(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
382
|
-
/**
|
|
383
|
-
* HTTP GET /user/{realm}/{userId}
|
|
384
|
-
* Java method: org.openremote.model.security.UserResource.get
|
|
385
|
-
*/
|
|
386
|
-
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
387
|
-
/**
|
|
388
|
-
* HTTP PUT /user/{realm}/{userId}
|
|
389
|
-
* Java method: org.openremote.model.security.UserResource.update
|
|
390
|
-
*/
|
|
391
|
-
update(realm: string, userId: string, arg3: Model.User, options?: O): RestResponse<void>;
|
|
392
|
-
/**
|
|
393
|
-
* HTTP PUT /user/{realm}/{userId}/reset-password
|
|
394
|
-
* Java method: org.openremote.model.security.UserResource.resetPassword
|
|
395
|
-
*/
|
|
396
|
-
resetPassword(realm: string, userId: string, arg3: Model.Credential, options?: O): RestResponse<void>;
|
|
397
|
-
/**
|
|
398
|
-
* HTTP GET /user/{realm}/{userId}/role
|
|
399
|
-
* Java method: org.openremote.model.security.UserResource.getRoles
|
|
400
|
-
*/
|
|
401
|
-
getRoles(realm: string, userId: string, options?: O): RestResponse<Model.Role[]>;
|
|
402
|
-
/**
|
|
403
|
-
* HTTP PUT /user/{realm}/{userId}/role
|
|
404
|
-
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
405
|
-
*/
|
|
406
|
-
updateRoles(realm: string, userId: string, arg3: Model.Role[], options?: O): RestResponse<void>;
|
|
407
|
-
}
|
|
408
|
-
export declare class SyslogResourceClient<O> {
|
|
409
|
-
protected httpClient: HttpClient<O>;
|
|
410
|
-
constructor(httpClient: HttpClient<O>);
|
|
411
|
-
/**
|
|
412
|
-
* HTTP GET /syslog/config
|
|
413
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
414
|
-
*/
|
|
415
|
-
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
416
|
-
/**
|
|
417
|
-
* HTTP PUT /syslog/config
|
|
418
|
-
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
419
|
-
*/
|
|
420
|
-
updateConfig(arg1: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
421
|
-
/**
|
|
422
|
-
* HTTP DELETE /syslog/event
|
|
423
|
-
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
424
|
-
*/
|
|
425
|
-
clearEvents(options?: O): RestResponse<void>;
|
|
426
|
-
/**
|
|
427
|
-
* HTTP GET /syslog/event
|
|
428
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
429
|
-
*/
|
|
430
|
-
getEvents(queryParams?: {
|
|
431
|
-
level?: Model.SyslogLevel;
|
|
432
|
-
limit?: number;
|
|
433
|
-
}, options?: O): RestResponse<Model.SyslogEvent[]>;
|
|
434
|
-
}
|
|
435
|
-
export declare class TenantResourceClient<O> {
|
|
436
|
-
protected httpClient: HttpClient<O>;
|
|
437
|
-
constructor(httpClient: HttpClient<O>);
|
|
438
|
-
/**
|
|
439
|
-
* HTTP POST /tenant
|
|
440
|
-
* Java method: org.openremote.model.security.TenantResource.create
|
|
441
|
-
*/
|
|
442
|
-
create(arg1: Model.Tenant, options?: O): RestResponse<void>;
|
|
443
|
-
/**
|
|
444
|
-
* HTTP GET /tenant
|
|
445
|
-
* Java method: org.openremote.model.security.TenantResource.getAll
|
|
446
|
-
*/
|
|
447
|
-
getAll(options?: O): RestResponse<Model.Tenant[]>;
|
|
448
|
-
/**
|
|
449
|
-
* HTTP DELETE /tenant/{realm}
|
|
450
|
-
* Java method: org.openremote.model.security.TenantResource.delete
|
|
451
|
-
*/
|
|
452
|
-
delete(realm: string, options?: O): RestResponse<void>;
|
|
453
|
-
/**
|
|
454
|
-
* HTTP GET /tenant/{realm}
|
|
455
|
-
* Java method: org.openremote.model.security.TenantResource.get
|
|
456
|
-
*/
|
|
457
|
-
get(realm: string, options?: O): RestResponse<Model.Tenant>;
|
|
458
|
-
/**
|
|
459
|
-
* HTTP PUT /tenant/{realm}
|
|
460
|
-
* Java method: org.openremote.model.security.TenantResource.update
|
|
461
|
-
*/
|
|
462
|
-
update(realm: string, arg2: Model.Tenant, options?: O): RestResponse<void>;
|
|
463
|
-
}
|
|
464
|
-
export declare class MapResourceClient<O> {
|
|
465
|
-
protected httpClient: HttpClient<O>;
|
|
466
|
-
constructor(httpClient: HttpClient<O>);
|
|
467
|
-
/**
|
|
468
|
-
* HTTP GET /map
|
|
469
|
-
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
470
|
-
*/
|
|
471
|
-
getSettings(options?: O): RestResponse<object>;
|
|
472
|
-
/**
|
|
473
|
-
* HTTP GET /map/js
|
|
474
|
-
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
475
|
-
*/
|
|
476
|
-
getSettingsJs(options?: O): RestResponse<object>;
|
|
477
|
-
/**
|
|
478
|
-
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
479
|
-
* Java method: org.openremote.model.map.MapResource.getTile
|
|
480
|
-
*/
|
|
481
|
-
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
482
|
-
}
|
|
483
|
-
export declare type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
484
|
-
export declare class ApiClient {
|
|
485
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
486
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
487
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
488
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
489
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
490
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
491
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
492
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
493
|
-
protected _consoleAppResource: AxiosConsoleAppResourceClient;
|
|
494
|
-
protected _userResource: AxiosUserResourceClient;
|
|
495
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
496
|
-
protected _tenantResource: AxiosTenantResourceClient;
|
|
497
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
498
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
499
|
-
readonly NotificationResource: AxiosNotificationResourceClient;
|
|
500
|
-
readonly AssetResource: AxiosAssetResourceClient;
|
|
501
|
-
readonly StatusResource: AxiosStatusResourceClient;
|
|
502
|
-
readonly AssetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
503
|
-
readonly AssetModelResource: AxiosAssetModelResourceClient;
|
|
504
|
-
readonly RulesResource: AxiosRulesResourceClient;
|
|
505
|
-
readonly ConsoleResource: AxiosConsoleResourceClient;
|
|
506
|
-
readonly AgentResource: AxiosAgentResourceClient;
|
|
507
|
-
readonly ConsoleAppResource: AxiosConsoleAppResourceClient;
|
|
508
|
-
readonly UserResource: AxiosUserResourceClient;
|
|
509
|
-
readonly SyslogResource: AxiosSyslogResourceClient;
|
|
510
|
-
readonly TenantResource: AxiosTenantResourceClient;
|
|
511
|
-
readonly MapResource: AxiosMapResourceClient;
|
|
512
|
-
}
|
|
513
|
-
import * as Axios from "axios";
|
|
514
|
-
declare module "axios" {
|
|
515
|
-
interface GenericAxiosResponse<R> extends Axios.AxiosResponse {
|
|
516
|
-
data: R;
|
|
517
|
-
}
|
|
518
|
-
}
|
|
519
|
-
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
520
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
521
|
-
}
|
|
522
|
-
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
523
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
524
|
-
}
|
|
525
|
-
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
526
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
527
|
-
}
|
|
528
|
-
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
529
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
530
|
-
}
|
|
531
|
-
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
532
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
533
|
-
}
|
|
534
|
-
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
535
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
536
|
-
}
|
|
537
|
-
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
538
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
539
|
-
}
|
|
540
|
-
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
541
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
542
|
-
}
|
|
543
|
-
export declare class AxiosConsoleAppResourceClient extends ConsoleAppResourceClient<Axios.AxiosRequestConfig> {
|
|
544
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
545
|
-
}
|
|
546
|
-
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
547
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
548
|
-
}
|
|
549
|
-
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
550
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
551
|
-
}
|
|
552
|
-
export declare class AxiosTenantResourceClient extends TenantResourceClient<Axios.AxiosRequestConfig> {
|
|
553
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
554
|
-
}
|
|
555
|
-
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
556
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
557
|
-
}
|