@openremote/rest 1.4.0-snapshot.20250317153938 → 1.4.0-snapshot.20250318122506
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/umd/index.bundle.js +1 -1
- package/dist/umd/index.js +1 -1
- package/lib/restclient.d.ts +421 -421
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +3 -3
package/lib/restclient.d.ts
CHANGED
|
@@ -9,162 +9,162 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class AppResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP GET /
|
|
17
|
-
* Java method: org.openremote.model.
|
|
16
|
+
* HTTP GET /apps
|
|
17
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
18
18
|
*/
|
|
19
|
-
|
|
19
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
20
20
|
/**
|
|
21
|
-
* HTTP GET /
|
|
22
|
-
* Java method: org.openremote.model.
|
|
21
|
+
* HTTP GET /apps/consoleConfig
|
|
22
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
23
23
|
*/
|
|
24
|
-
|
|
24
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
25
25
|
/**
|
|
26
|
-
* HTTP GET /
|
|
27
|
-
* Java method: org.openremote.model.
|
|
26
|
+
* HTTP GET /apps/info
|
|
27
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
28
28
|
*/
|
|
29
|
-
|
|
29
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
30
30
|
}
|
|
31
|
-
export declare class
|
|
31
|
+
export declare class AssetResourceClient<O> {
|
|
32
32
|
protected httpClient: HttpClient<O>;
|
|
33
33
|
constructor(httpClient: HttpClient<O>);
|
|
34
34
|
/**
|
|
35
|
-
* HTTP POST /
|
|
36
|
-
* Java method: org.openremote.model.
|
|
35
|
+
* HTTP POST /asset
|
|
36
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
37
37
|
*/
|
|
38
|
-
|
|
38
|
+
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
39
39
|
/**
|
|
40
|
-
* HTTP
|
|
41
|
-
* Java method: org.openremote.model.
|
|
40
|
+
* HTTP DELETE /asset
|
|
41
|
+
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
42
42
|
*/
|
|
43
|
-
|
|
43
|
+
delete(queryParams?: {
|
|
44
|
+
assetId?: string[];
|
|
45
|
+
}, options?: O): RestResponse<void>;
|
|
44
46
|
/**
|
|
45
|
-
* HTTP
|
|
46
|
-
* Java method: org.openremote.model.
|
|
47
|
+
* HTTP PUT /asset/attributes
|
|
48
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
47
49
|
*/
|
|
48
|
-
|
|
50
|
+
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
49
51
|
/**
|
|
50
|
-
* HTTP PUT /
|
|
51
|
-
* Java method: org.openremote.model.
|
|
52
|
+
* HTTP PUT /asset/attributes/timestamp
|
|
53
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
52
54
|
*/
|
|
53
|
-
|
|
54
|
-
}
|
|
55
|
-
export declare class GatewayServiceResourceClient<O> {
|
|
56
|
-
protected httpClient: HttpClient<O>;
|
|
57
|
-
constructor(httpClient: HttpClient<O>);
|
|
55
|
+
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
58
56
|
/**
|
|
59
|
-
* HTTP
|
|
60
|
-
* Java method: org.openremote.model.
|
|
57
|
+
* HTTP DELETE /asset/parent
|
|
58
|
+
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
61
59
|
*/
|
|
62
|
-
|
|
60
|
+
updateNoneParent(queryParams?: {
|
|
61
|
+
assetIds?: string[];
|
|
62
|
+
}, options?: O): RestResponse<void>;
|
|
63
63
|
/**
|
|
64
|
-
* HTTP
|
|
65
|
-
* Java method: org.openremote.model.
|
|
64
|
+
* HTTP GET /asset/partial/{assetId}
|
|
65
|
+
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
66
66
|
*/
|
|
67
|
-
|
|
67
|
+
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
68
68
|
/**
|
|
69
|
-
* HTTP
|
|
70
|
-
* Java method: org.openremote.model.
|
|
69
|
+
* HTTP POST /asset/query
|
|
70
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
71
71
|
*/
|
|
72
|
-
|
|
72
|
+
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
73
73
|
/**
|
|
74
|
-
* HTTP GET /
|
|
75
|
-
* Java method: org.openremote.model.
|
|
74
|
+
* HTTP GET /asset/user/current
|
|
75
|
+
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
76
76
|
*/
|
|
77
|
-
|
|
77
|
+
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
78
78
|
/**
|
|
79
|
-
* HTTP
|
|
80
|
-
* Java method: org.openremote.model.
|
|
79
|
+
* HTTP POST /asset/user/link
|
|
80
|
+
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
81
81
|
*/
|
|
82
|
-
|
|
83
|
-
}
|
|
84
|
-
export declare class StatusResourceClient<O> {
|
|
85
|
-
protected httpClient: HttpClient<O>;
|
|
86
|
-
constructor(httpClient: HttpClient<O>);
|
|
82
|
+
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
87
83
|
/**
|
|
88
|
-
* HTTP GET /
|
|
89
|
-
* Java method: org.openremote.model.
|
|
84
|
+
* HTTP GET /asset/user/link
|
|
85
|
+
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
90
86
|
*/
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
87
|
+
getUserAssetLinks(queryParams?: {
|
|
88
|
+
realm?: string;
|
|
89
|
+
userId?: string;
|
|
90
|
+
assetId?: string;
|
|
91
|
+
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
94
92
|
/**
|
|
95
|
-
* HTTP
|
|
96
|
-
* Java method: org.openremote.model.
|
|
93
|
+
* HTTP POST /asset/user/link/delete
|
|
94
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
97
95
|
*/
|
|
98
|
-
|
|
99
|
-
[index: string]: any;
|
|
100
|
-
}>;
|
|
101
|
-
}
|
|
102
|
-
export declare class SyslogResourceClient<O> {
|
|
103
|
-
protected httpClient: HttpClient<O>;
|
|
104
|
-
constructor(httpClient: HttpClient<O>);
|
|
96
|
+
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
105
97
|
/**
|
|
106
|
-
* HTTP
|
|
107
|
-
* Java method: org.openremote.model.
|
|
98
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
99
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
108
100
|
*/
|
|
109
|
-
|
|
101
|
+
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
110
102
|
/**
|
|
111
|
-
* HTTP
|
|
112
|
-
* Java method: org.openremote.model.
|
|
103
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
104
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
113
105
|
*/
|
|
114
|
-
|
|
106
|
+
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
115
107
|
/**
|
|
116
|
-
* HTTP
|
|
117
|
-
* Java method: org.openremote.model.
|
|
108
|
+
* HTTP GET /asset/{assetId}
|
|
109
|
+
* Java method: org.openremote.model.asset.AssetResource.get
|
|
118
110
|
*/
|
|
119
|
-
|
|
111
|
+
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
120
112
|
/**
|
|
121
|
-
* HTTP
|
|
122
|
-
* Java method: org.openremote.model.
|
|
113
|
+
* HTTP PUT /asset/{assetId}
|
|
114
|
+
* Java method: org.openremote.model.asset.AssetResource.update
|
|
123
115
|
*/
|
|
124
|
-
|
|
125
|
-
level?: Model.SyslogLevel;
|
|
126
|
-
per_page?: number;
|
|
127
|
-
page?: number;
|
|
128
|
-
from?: number;
|
|
129
|
-
to?: number;
|
|
130
|
-
category?: Model.SyslogCategory[];
|
|
131
|
-
subCategory?: string[];
|
|
132
|
-
}, options?: O): RestResponse<any>;
|
|
133
|
-
}
|
|
134
|
-
export declare class ConsoleResourceClient<O> {
|
|
135
|
-
protected httpClient: HttpClient<O>;
|
|
136
|
-
constructor(httpClient: HttpClient<O>);
|
|
116
|
+
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
137
117
|
/**
|
|
138
|
-
* HTTP
|
|
139
|
-
* Java method: org.openremote.model.
|
|
118
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
119
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
140
120
|
*/
|
|
141
|
-
|
|
121
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
122
|
+
/**
|
|
123
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
124
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
125
|
+
*/
|
|
126
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
127
|
+
/**
|
|
128
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
129
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
130
|
+
*/
|
|
131
|
+
updateParent(parentAssetId: string, queryParams?: {
|
|
132
|
+
assetIds?: string[];
|
|
133
|
+
}, options?: O): RestResponse<void>;
|
|
142
134
|
}
|
|
143
|
-
export declare class
|
|
135
|
+
export declare class DashboardResourceClient<O> {
|
|
144
136
|
protected httpClient: HttpClient<O>;
|
|
145
137
|
constructor(httpClient: HttpClient<O>);
|
|
146
138
|
/**
|
|
147
|
-
* HTTP
|
|
148
|
-
* Java method: org.openremote.model.
|
|
139
|
+
* HTTP POST /dashboard
|
|
140
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
149
141
|
*/
|
|
150
|
-
|
|
151
|
-
realm?: string;
|
|
152
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
142
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
153
143
|
/**
|
|
154
|
-
* HTTP
|
|
155
|
-
* Java method: org.openremote.model.
|
|
144
|
+
* HTTP PUT /dashboard
|
|
145
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
156
146
|
*/
|
|
157
|
-
|
|
158
|
-
realm?: string;
|
|
159
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
147
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
160
148
|
/**
|
|
161
|
-
* HTTP GET /
|
|
162
|
-
* Java method: org.openremote.model.
|
|
149
|
+
* HTTP GET /dashboard/all/{realm}
|
|
150
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
163
151
|
*/
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
152
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
153
|
+
/**
|
|
154
|
+
* HTTP POST /dashboard/query
|
|
155
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
156
|
+
*/
|
|
157
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
158
|
+
/**
|
|
159
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
160
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
161
|
+
*/
|
|
162
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
163
|
+
/**
|
|
164
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
165
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
166
|
+
*/
|
|
167
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
168
168
|
}
|
|
169
169
|
export declare class UserResourceClient<O> {
|
|
170
170
|
protected httpClient: HttpClient<O>;
|
|
@@ -290,183 +290,154 @@ export declare class UserResourceClient<O> {
|
|
|
290
290
|
*/
|
|
291
291
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
292
292
|
}
|
|
293
|
-
export declare class
|
|
293
|
+
export declare class ProvisioningResourceClient<O> {
|
|
294
294
|
protected httpClient: HttpClient<O>;
|
|
295
295
|
constructor(httpClient: HttpClient<O>);
|
|
296
296
|
/**
|
|
297
|
-
* HTTP
|
|
298
|
-
* Java method: org.openremote.model.
|
|
297
|
+
* HTTP POST /provisioning
|
|
298
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
299
299
|
*/
|
|
300
|
-
|
|
300
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
301
301
|
/**
|
|
302
|
-
* HTTP
|
|
303
|
-
* Java method: org.openremote.model.
|
|
302
|
+
* HTTP GET /provisioning
|
|
303
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
304
304
|
*/
|
|
305
|
-
|
|
305
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
306
306
|
/**
|
|
307
|
-
* HTTP
|
|
308
|
-
* Java method: org.openremote.model.
|
|
307
|
+
* HTTP DELETE /provisioning/{id}
|
|
308
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
309
309
|
*/
|
|
310
|
-
|
|
311
|
-
path?: string;
|
|
312
|
-
}, options?: O): RestResponse<string>;
|
|
310
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
313
311
|
/**
|
|
314
|
-
* HTTP
|
|
315
|
-
* Java method: org.openremote.model.
|
|
312
|
+
* HTTP PUT /provisioning/{id}
|
|
313
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
316
314
|
*/
|
|
317
|
-
|
|
315
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
318
316
|
}
|
|
319
|
-
export declare class
|
|
317
|
+
export declare class NotificationResourceClient<O> {
|
|
320
318
|
protected httpClient: HttpClient<O>;
|
|
321
319
|
constructor(httpClient: HttpClient<O>);
|
|
322
320
|
/**
|
|
323
|
-
* HTTP
|
|
324
|
-
* Java method: org.openremote.model.
|
|
321
|
+
* HTTP GET /notification
|
|
322
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
325
323
|
*/
|
|
326
|
-
|
|
324
|
+
getNotifications(queryParams?: {
|
|
325
|
+
id?: number;
|
|
326
|
+
type?: string;
|
|
327
|
+
from?: number;
|
|
328
|
+
to?: number;
|
|
329
|
+
realmId?: string;
|
|
330
|
+
userId?: string;
|
|
331
|
+
assetId?: string;
|
|
332
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
327
333
|
/**
|
|
328
|
-
* HTTP
|
|
329
|
-
* Java method: org.openremote.model.
|
|
334
|
+
* HTTP DELETE /notification
|
|
335
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
330
336
|
*/
|
|
331
|
-
|
|
337
|
+
removeNotifications(queryParams?: {
|
|
338
|
+
id?: number;
|
|
339
|
+
type?: string;
|
|
340
|
+
from?: number;
|
|
341
|
+
to?: number;
|
|
342
|
+
realmId?: string;
|
|
343
|
+
userId?: string;
|
|
344
|
+
assetId?: string;
|
|
345
|
+
}, options?: O): RestResponse<void>;
|
|
332
346
|
/**
|
|
333
|
-
* HTTP
|
|
334
|
-
* Java method: org.openremote.model.
|
|
347
|
+
* HTTP POST /notification/alert
|
|
348
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
335
349
|
*/
|
|
336
|
-
|
|
350
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
337
351
|
/**
|
|
338
|
-
* HTTP
|
|
339
|
-
* Java method: org.openremote.model.
|
|
352
|
+
* HTTP DELETE /notification/{notificationId}
|
|
353
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
340
354
|
*/
|
|
341
|
-
|
|
355
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
342
356
|
/**
|
|
343
|
-
* HTTP
|
|
344
|
-
* Java method: org.openremote.model.
|
|
357
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
358
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
345
359
|
*/
|
|
346
|
-
|
|
360
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
361
|
+
targetId?: string;
|
|
362
|
+
}, options?: O): RestResponse<void>;
|
|
347
363
|
/**
|
|
348
|
-
* HTTP
|
|
349
|
-
* Java method: org.openremote.model.
|
|
364
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
365
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
350
366
|
*/
|
|
351
|
-
|
|
367
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
368
|
+
targetId?: string;
|
|
369
|
+
}, options?: O): RestResponse<void>;
|
|
352
370
|
}
|
|
353
|
-
export declare class
|
|
371
|
+
export declare class ConfigurationResourceClient<O> {
|
|
354
372
|
protected httpClient: HttpClient<O>;
|
|
355
373
|
constructor(httpClient: HttpClient<O>);
|
|
356
374
|
/**
|
|
357
|
-
* HTTP GET /
|
|
358
|
-
* Java method: org.openremote.model.
|
|
359
|
-
*/
|
|
360
|
-
getAssetDescriptors(queryParams?: {
|
|
361
|
-
parentId?: string;
|
|
362
|
-
parentType?: string;
|
|
363
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
364
|
-
/**
|
|
365
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
366
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
375
|
+
* HTTP GET /configuration/manager
|
|
376
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
367
377
|
*/
|
|
368
|
-
|
|
369
|
-
parentId?: string;
|
|
370
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
378
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
371
379
|
/**
|
|
372
|
-
* HTTP
|
|
373
|
-
* Java method: org.openremote.model.
|
|
380
|
+
* HTTP PUT /configuration/manager
|
|
381
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
374
382
|
*/
|
|
375
|
-
|
|
376
|
-
parentId?: string;
|
|
377
|
-
parentType?: string;
|
|
378
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
383
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
379
384
|
/**
|
|
380
|
-
* HTTP
|
|
381
|
-
* Java method: org.openremote.model.
|
|
385
|
+
* HTTP POST /configuration/manager/file
|
|
386
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
382
387
|
*/
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
}, options?: O): RestResponse<
|
|
386
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
387
|
-
}>;
|
|
388
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
389
|
+
path?: string;
|
|
390
|
+
}, options?: O): RestResponse<string>;
|
|
388
391
|
/**
|
|
389
|
-
* HTTP GET /
|
|
390
|
-
* Java method: org.openremote.model.
|
|
392
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
393
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
391
394
|
*/
|
|
392
|
-
|
|
393
|
-
parentId?: string;
|
|
394
|
-
}, options?: O): RestResponse<{
|
|
395
|
-
[index: string]: Model.ValueDescriptor;
|
|
396
|
-
}>;
|
|
395
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
397
396
|
}
|
|
398
|
-
export declare class
|
|
397
|
+
export declare class AgentResourceClient<O> {
|
|
399
398
|
protected httpClient: HttpClient<O>;
|
|
400
399
|
constructor(httpClient: HttpClient<O>);
|
|
401
400
|
/**
|
|
402
|
-
* HTTP GET /
|
|
403
|
-
* Java method: org.openremote.model.
|
|
401
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
402
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
404
403
|
*/
|
|
405
|
-
|
|
404
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
405
|
+
realm?: string;
|
|
406
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
406
407
|
/**
|
|
407
|
-
* HTTP
|
|
408
|
-
* Java method: org.openremote.model.
|
|
408
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
409
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
409
410
|
*/
|
|
410
|
-
|
|
411
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
412
|
+
realm?: string;
|
|
413
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
411
414
|
/**
|
|
412
|
-
* HTTP GET /
|
|
413
|
-
* Java method: org.openremote.model.
|
|
415
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
416
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
414
417
|
*/
|
|
415
|
-
|
|
418
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
419
|
+
parentId?: string;
|
|
420
|
+
realm?: string;
|
|
421
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
416
422
|
}
|
|
417
|
-
export declare class
|
|
423
|
+
export declare class FlowResourceClient<O> {
|
|
418
424
|
protected httpClient: HttpClient<O>;
|
|
419
425
|
constructor(httpClient: HttpClient<O>);
|
|
420
426
|
/**
|
|
421
|
-
* HTTP GET /
|
|
422
|
-
* Java method: org.openremote.model.
|
|
423
|
-
*/
|
|
424
|
-
getNotifications(queryParams?: {
|
|
425
|
-
id?: number;
|
|
426
|
-
type?: string;
|
|
427
|
-
from?: number;
|
|
428
|
-
to?: number;
|
|
429
|
-
realmId?: string;
|
|
430
|
-
userId?: string;
|
|
431
|
-
assetId?: string;
|
|
432
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
433
|
-
/**
|
|
434
|
-
* HTTP DELETE /notification
|
|
435
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
436
|
-
*/
|
|
437
|
-
removeNotifications(queryParams?: {
|
|
438
|
-
id?: number;
|
|
439
|
-
type?: string;
|
|
440
|
-
from?: number;
|
|
441
|
-
to?: number;
|
|
442
|
-
realmId?: string;
|
|
443
|
-
userId?: string;
|
|
444
|
-
assetId?: string;
|
|
445
|
-
}, options?: O): RestResponse<void>;
|
|
446
|
-
/**
|
|
447
|
-
* HTTP POST /notification/alert
|
|
448
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
449
|
-
*/
|
|
450
|
-
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
451
|
-
/**
|
|
452
|
-
* HTTP DELETE /notification/{notificationId}
|
|
453
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
427
|
+
* HTTP GET /flow
|
|
428
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
454
429
|
*/
|
|
455
|
-
|
|
430
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
456
431
|
/**
|
|
457
|
-
* HTTP
|
|
458
|
-
* Java method: org.openremote.model.
|
|
432
|
+
* HTTP GET /flow/{name}
|
|
433
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
459
434
|
*/
|
|
460
|
-
|
|
461
|
-
targetId?: string;
|
|
462
|
-
}, options?: O): RestResponse<void>;
|
|
435
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
463
436
|
/**
|
|
464
|
-
* HTTP
|
|
465
|
-
* Java method: org.openremote.model.
|
|
437
|
+
* HTTP GET /flow/{type}
|
|
438
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
466
439
|
*/
|
|
467
|
-
|
|
468
|
-
targetId?: string;
|
|
469
|
-
}, options?: O): RestResponse<void>;
|
|
440
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
470
441
|
}
|
|
471
442
|
export declare class RealmResourceClient<O> {
|
|
472
443
|
protected httpClient: HttpClient<O>;
|
|
@@ -502,49 +473,60 @@ export declare class RealmResourceClient<O> {
|
|
|
502
473
|
*/
|
|
503
474
|
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
504
475
|
}
|
|
505
|
-
export declare class
|
|
476
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
506
477
|
protected httpClient: HttpClient<O>;
|
|
507
478
|
constructor(httpClient: HttpClient<O>);
|
|
508
479
|
/**
|
|
509
|
-
* HTTP
|
|
510
|
-
* Java method: org.openremote.model.
|
|
511
|
-
*/
|
|
512
|
-
getSettings(options?: O): RestResponse<{
|
|
513
|
-
[id: string]: unknown;
|
|
514
|
-
}>;
|
|
515
|
-
/**
|
|
516
|
-
* HTTP PUT /map
|
|
517
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
480
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
481
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
518
482
|
*/
|
|
519
|
-
|
|
520
|
-
[index: string]: Model.MapRealmConfig;
|
|
521
|
-
}, options?: O): RestResponse<any>;
|
|
483
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
522
484
|
/**
|
|
523
|
-
* HTTP
|
|
524
|
-
* Java method: org.openremote.model.
|
|
485
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
486
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
525
487
|
*/
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
488
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
489
|
+
}
|
|
490
|
+
export declare class ConsoleResourceClient<O> {
|
|
491
|
+
protected httpClient: HttpClient<O>;
|
|
492
|
+
constructor(httpClient: HttpClient<O>);
|
|
529
493
|
/**
|
|
530
|
-
* HTTP
|
|
531
|
-
* Java method: org.openremote.model.
|
|
494
|
+
* HTTP POST /console/register
|
|
495
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
532
496
|
*/
|
|
533
|
-
|
|
497
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
534
498
|
}
|
|
535
|
-
export declare class
|
|
499
|
+
export declare class SyslogResourceClient<O> {
|
|
536
500
|
protected httpClient: HttpClient<O>;
|
|
537
501
|
constructor(httpClient: HttpClient<O>);
|
|
538
502
|
/**
|
|
539
|
-
* HTTP
|
|
540
|
-
* Java method: org.openremote.model.
|
|
503
|
+
* HTTP GET /syslog/config
|
|
504
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
541
505
|
*/
|
|
542
|
-
|
|
506
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
543
507
|
/**
|
|
544
|
-
* HTTP PUT /
|
|
545
|
-
* Java method: org.openremote.model.
|
|
508
|
+
* HTTP PUT /syslog/config
|
|
509
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
546
510
|
*/
|
|
547
|
-
|
|
511
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
512
|
+
/**
|
|
513
|
+
* HTTP DELETE /syslog/event
|
|
514
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
515
|
+
*/
|
|
516
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
517
|
+
/**
|
|
518
|
+
* HTTP GET /syslog/event
|
|
519
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
520
|
+
*/
|
|
521
|
+
getEvents(queryParams?: {
|
|
522
|
+
level?: Model.SyslogLevel;
|
|
523
|
+
per_page?: number;
|
|
524
|
+
page?: number;
|
|
525
|
+
from?: number;
|
|
526
|
+
to?: number;
|
|
527
|
+
category?: Model.SyslogCategory[];
|
|
528
|
+
subCategory?: string[];
|
|
529
|
+
}, options?: O): RestResponse<any>;
|
|
548
530
|
}
|
|
549
531
|
export declare class AssetDatapointResourceClient<O> {
|
|
550
532
|
protected httpClient: HttpClient<O>;
|
|
@@ -572,109 +554,151 @@ export declare class AssetDatapointResourceClient<O> {
|
|
|
572
554
|
*/
|
|
573
555
|
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
574
556
|
}
|
|
575
|
-
export declare class
|
|
557
|
+
export declare class StatusResourceClient<O> {
|
|
576
558
|
protected httpClient: HttpClient<O>;
|
|
577
559
|
constructor(httpClient: HttpClient<O>);
|
|
578
560
|
/**
|
|
579
|
-
* HTTP
|
|
580
|
-
* Java method: org.openremote.model.
|
|
561
|
+
* HTTP GET /health
|
|
562
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
581
563
|
*/
|
|
582
|
-
|
|
564
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
565
|
+
[index: string]: any;
|
|
566
|
+
}>;
|
|
583
567
|
/**
|
|
584
|
-
* HTTP
|
|
585
|
-
* Java method: org.openremote.model.
|
|
568
|
+
* HTTP GET /info
|
|
569
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
586
570
|
*/
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
}
|
|
571
|
+
getInfo(options?: O): RestResponse<{
|
|
572
|
+
[index: string]: any;
|
|
573
|
+
}>;
|
|
574
|
+
}
|
|
575
|
+
export declare class AssetModelResourceClient<O> {
|
|
576
|
+
protected httpClient: HttpClient<O>;
|
|
577
|
+
constructor(httpClient: HttpClient<O>);
|
|
590
578
|
/**
|
|
591
|
-
* HTTP
|
|
592
|
-
* Java method: org.openremote.model.asset.
|
|
579
|
+
* HTTP GET /model/assetDescriptors
|
|
580
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
593
581
|
*/
|
|
594
|
-
|
|
582
|
+
getAssetDescriptors(queryParams?: {
|
|
583
|
+
parentId?: string;
|
|
584
|
+
parentType?: string;
|
|
585
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
595
586
|
/**
|
|
596
|
-
* HTTP
|
|
597
|
-
* Java method: org.openremote.model.asset.
|
|
587
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
588
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
598
589
|
*/
|
|
599
|
-
|
|
590
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
591
|
+
parentId?: string;
|
|
592
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
600
593
|
/**
|
|
601
|
-
* HTTP
|
|
602
|
-
* Java method: org.openremote.model.asset.
|
|
594
|
+
* HTTP GET /model/assetInfos
|
|
595
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
603
596
|
*/
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
597
|
+
getAssetInfos(queryParams?: {
|
|
598
|
+
parentId?: string;
|
|
599
|
+
parentType?: string;
|
|
600
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
607
601
|
/**
|
|
608
|
-
* HTTP GET /
|
|
609
|
-
* Java method: org.openremote.model.asset.
|
|
602
|
+
* HTTP GET /model/metaItemDescriptors
|
|
603
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
610
604
|
*/
|
|
611
|
-
|
|
605
|
+
getMetaItemDescriptors(queryParams?: {
|
|
606
|
+
parentId?: string;
|
|
607
|
+
}, options?: O): RestResponse<{
|
|
608
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
609
|
+
}>;
|
|
612
610
|
/**
|
|
613
|
-
* HTTP
|
|
614
|
-
* Java method: org.openremote.model.asset.
|
|
611
|
+
* HTTP GET /model/valueDescriptors
|
|
612
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
615
613
|
*/
|
|
616
|
-
|
|
614
|
+
getValueDescriptors(queryParams?: {
|
|
615
|
+
parentId?: string;
|
|
616
|
+
}, options?: O): RestResponse<{
|
|
617
|
+
[index: string]: Model.ValueDescriptor;
|
|
618
|
+
}>;
|
|
619
|
+
}
|
|
620
|
+
export declare class AlarmResourceClient<O> {
|
|
621
|
+
protected httpClient: HttpClient<O>;
|
|
622
|
+
constructor(httpClient: HttpClient<O>);
|
|
617
623
|
/**
|
|
618
|
-
* HTTP
|
|
619
|
-
* Java method: org.openremote.model.
|
|
624
|
+
* HTTP POST /alarm
|
|
625
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
620
626
|
*/
|
|
621
|
-
|
|
627
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
628
|
+
assetIds?: string[];
|
|
629
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
630
|
+
/**
|
|
631
|
+
* HTTP GET /alarm
|
|
632
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
633
|
+
*/
|
|
634
|
+
getAlarms(queryParams?: {
|
|
635
|
+
realm?: string;
|
|
636
|
+
status?: Model.AlarmStatus;
|
|
637
|
+
assetId?: string;
|
|
638
|
+
assigneeId?: string;
|
|
639
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
622
640
|
/**
|
|
623
|
-
* HTTP
|
|
624
|
-
* Java method: org.openremote.model.
|
|
641
|
+
* HTTP DELETE /alarm
|
|
642
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
625
643
|
*/
|
|
626
|
-
|
|
644
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
627
645
|
/**
|
|
628
|
-
* HTTP
|
|
629
|
-
* Java method: org.openremote.model.
|
|
646
|
+
* HTTP PUT /alarm/assets
|
|
647
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
630
648
|
*/
|
|
631
|
-
|
|
632
|
-
realm?: string;
|
|
633
|
-
userId?: string;
|
|
634
|
-
assetId?: string;
|
|
635
|
-
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
649
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
636
650
|
/**
|
|
637
|
-
* HTTP
|
|
638
|
-
* Java method: org.openremote.model.
|
|
651
|
+
* HTTP GET /alarm/{alarmId}
|
|
652
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
639
653
|
*/
|
|
640
|
-
|
|
654
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
641
655
|
/**
|
|
642
|
-
* HTTP DELETE /
|
|
643
|
-
* Java method: org.openremote.model.
|
|
656
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
657
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
644
658
|
*/
|
|
645
|
-
|
|
659
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
646
660
|
/**
|
|
647
|
-
* HTTP
|
|
648
|
-
* Java method: org.openremote.model.
|
|
661
|
+
* HTTP PUT /alarm/{alarmId}
|
|
662
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
649
663
|
*/
|
|
650
|
-
|
|
664
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
651
665
|
/**
|
|
652
|
-
* HTTP GET /
|
|
653
|
-
* Java method: org.openremote.model.
|
|
666
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
667
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
654
668
|
*/
|
|
655
|
-
|
|
669
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
670
|
+
realm?: string;
|
|
671
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
672
|
+
}
|
|
673
|
+
export declare class MapResourceClient<O> {
|
|
674
|
+
protected httpClient: HttpClient<O>;
|
|
675
|
+
constructor(httpClient: HttpClient<O>);
|
|
656
676
|
/**
|
|
657
|
-
* HTTP
|
|
658
|
-
* Java method: org.openremote.model.
|
|
677
|
+
* HTTP GET /map
|
|
678
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
659
679
|
*/
|
|
660
|
-
|
|
680
|
+
getSettings(options?: O): RestResponse<{
|
|
681
|
+
[id: string]: unknown;
|
|
682
|
+
}>;
|
|
661
683
|
/**
|
|
662
|
-
* HTTP PUT /
|
|
663
|
-
* Java method: org.openremote.model.
|
|
684
|
+
* HTTP PUT /map
|
|
685
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
664
686
|
*/
|
|
665
|
-
|
|
687
|
+
saveSettings(mapConfig: {
|
|
688
|
+
[index: string]: Model.MapRealmConfig;
|
|
689
|
+
}, options?: O): RestResponse<any>;
|
|
666
690
|
/**
|
|
667
|
-
* HTTP
|
|
668
|
-
* Java method: org.openremote.model.
|
|
691
|
+
* HTTP GET /map/js
|
|
692
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
669
693
|
*/
|
|
670
|
-
|
|
694
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
695
|
+
[id: string]: unknown;
|
|
696
|
+
}>;
|
|
671
697
|
/**
|
|
672
|
-
* HTTP
|
|
673
|
-
* Java method: org.openremote.model.
|
|
698
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
699
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
674
700
|
*/
|
|
675
|
-
|
|
676
|
-
assetIds?: string[];
|
|
677
|
-
}, options?: O): RestResponse<void>;
|
|
701
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
678
702
|
}
|
|
679
703
|
export declare class RulesResourceClient<O> {
|
|
680
704
|
protected httpClient: HttpClient<O>;
|
|
@@ -784,6 +808,35 @@ export declare class RulesResourceClient<O> {
|
|
|
784
808
|
*/
|
|
785
809
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
786
810
|
}
|
|
811
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
812
|
+
protected httpClient: HttpClient<O>;
|
|
813
|
+
constructor(httpClient: HttpClient<O>);
|
|
814
|
+
/**
|
|
815
|
+
* HTTP POST /gateway/tunnel
|
|
816
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
817
|
+
*/
|
|
818
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
819
|
+
/**
|
|
820
|
+
* HTTP DELETE /gateway/tunnel
|
|
821
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
822
|
+
*/
|
|
823
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
824
|
+
/**
|
|
825
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
826
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
827
|
+
*/
|
|
828
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
829
|
+
/**
|
|
830
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
831
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
832
|
+
*/
|
|
833
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
834
|
+
/**
|
|
835
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
836
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
837
|
+
*/
|
|
838
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
839
|
+
}
|
|
787
840
|
export declare class GatewayClientResourceClient<O> {
|
|
788
841
|
protected httpClient: HttpClient<O>;
|
|
789
842
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -820,104 +873,51 @@ export declare class GatewayClientResourceClient<O> {
|
|
|
820
873
|
*/
|
|
821
874
|
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
822
875
|
}
|
|
823
|
-
export declare class AlarmResourceClient<O> {
|
|
824
|
-
protected httpClient: HttpClient<O>;
|
|
825
|
-
constructor(httpClient: HttpClient<O>);
|
|
826
|
-
/**
|
|
827
|
-
* HTTP POST /alarm
|
|
828
|
-
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
829
|
-
*/
|
|
830
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
831
|
-
assetIds?: string[];
|
|
832
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
833
|
-
/**
|
|
834
|
-
* HTTP GET /alarm
|
|
835
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
836
|
-
*/
|
|
837
|
-
getAlarms(queryParams?: {
|
|
838
|
-
realm?: string;
|
|
839
|
-
status?: Model.AlarmStatus;
|
|
840
|
-
assetId?: string;
|
|
841
|
-
assigneeId?: string;
|
|
842
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
843
|
-
/**
|
|
844
|
-
* HTTP DELETE /alarm
|
|
845
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
846
|
-
*/
|
|
847
|
-
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
848
|
-
/**
|
|
849
|
-
* HTTP PUT /alarm/assets
|
|
850
|
-
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
851
|
-
*/
|
|
852
|
-
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
853
|
-
/**
|
|
854
|
-
* HTTP GET /alarm/{alarmId}
|
|
855
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
856
|
-
*/
|
|
857
|
-
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
858
|
-
/**
|
|
859
|
-
* HTTP DELETE /alarm/{alarmId}
|
|
860
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
861
|
-
*/
|
|
862
|
-
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
863
|
-
/**
|
|
864
|
-
* HTTP PUT /alarm/{alarmId}
|
|
865
|
-
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
866
|
-
*/
|
|
867
|
-
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
868
|
-
/**
|
|
869
|
-
* HTTP GET /alarm/{alarmId}/assets
|
|
870
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
871
|
-
*/
|
|
872
|
-
getAssetLinks(alarmId: number, queryParams?: {
|
|
873
|
-
realm?: string;
|
|
874
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
875
|
-
}
|
|
876
876
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
877
877
|
export declare class ApiClient {
|
|
878
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
879
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
880
|
-
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
881
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
882
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
883
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
884
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
885
|
-
protected _userResource: AxiosUserResourceClient;
|
|
886
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
887
|
-
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
888
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
889
878
|
protected _appResource: AxiosAppResourceClient;
|
|
879
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
880
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
881
|
+
protected _userResource: AxiosUserResourceClient;
|
|
882
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
890
883
|
protected _notificationResource: AxiosNotificationResourceClient;
|
|
884
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
885
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
886
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
891
887
|
protected _realmResource: AxiosRealmResourceClient;
|
|
892
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
893
888
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
889
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
890
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
894
891
|
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
895
|
-
protected
|
|
892
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
893
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
894
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
895
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
896
896
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
897
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
897
898
|
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
898
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
899
899
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
900
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
901
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
902
|
-
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
903
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
904
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
905
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
906
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
907
|
-
get UserResource(): AxiosUserResourceClient;
|
|
908
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
909
|
-
get DashboardResource(): AxiosDashboardResourceClient;
|
|
910
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
911
900
|
get AppResource(): AxiosAppResourceClient;
|
|
901
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
902
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
903
|
+
get UserResource(): AxiosUserResourceClient;
|
|
904
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
912
905
|
get NotificationResource(): AxiosNotificationResourceClient;
|
|
906
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
907
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
908
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
913
909
|
get RealmResource(): AxiosRealmResourceClient;
|
|
914
|
-
get MapResource(): AxiosMapResourceClient;
|
|
915
910
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
911
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
912
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
916
913
|
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
917
|
-
get
|
|
914
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
915
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
916
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
917
|
+
get MapResource(): AxiosMapResourceClient;
|
|
918
918
|
get RulesResource(): AxiosRulesResourceClient;
|
|
919
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
919
920
|
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
920
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
921
921
|
}
|
|
922
922
|
import * as Axios from "axios";
|
|
923
923
|
declare module "axios" {
|
|
@@ -925,66 +925,66 @@ declare module "axios" {
|
|
|
925
925
|
data: R;
|
|
926
926
|
}
|
|
927
927
|
}
|
|
928
|
-
export declare class
|
|
928
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
929
929
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
930
930
|
}
|
|
931
|
-
export declare class
|
|
931
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
932
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
933
|
}
|
|
934
|
-
export declare class
|
|
934
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
935
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
936
|
}
|
|
937
|
-
export declare class
|
|
937
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
938
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
939
|
}
|
|
940
|
-
export declare class
|
|
940
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
941
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
942
|
}
|
|
943
|
-
export declare class
|
|
943
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
944
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
945
|
}
|
|
946
|
-
export declare class
|
|
946
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
947
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
948
|
}
|
|
949
|
-
export declare class
|
|
949
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
950
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
951
|
}
|
|
952
|
-
export declare class
|
|
952
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
953
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
954
|
}
|
|
955
|
-
export declare class
|
|
955
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
956
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
957
|
}
|
|
958
|
-
export declare class
|
|
958
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
959
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
960
|
}
|
|
961
|
-
export declare class
|
|
961
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
962
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
963
|
}
|
|
964
|
-
export declare class
|
|
964
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
965
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
966
|
}
|
|
967
|
-
export declare class
|
|
967
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
968
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
969
|
}
|
|
970
|
-
export declare class
|
|
970
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
971
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
972
|
}
|
|
973
|
-
export declare class
|
|
973
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
974
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
975
|
}
|
|
976
|
-
export declare class
|
|
976
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
977
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
978
|
}
|
|
979
|
-
export declare class
|
|
979
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
980
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
981
|
}
|
|
982
982
|
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
983
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
984
|
}
|
|
985
|
-
export declare class
|
|
985
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
986
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
987
|
}
|
|
988
|
-
export declare class
|
|
988
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
989
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
990
|
}
|