@openremote/rest 1.32.1 → 1.32.2
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.
|
@@ -9,97 +9,109 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class RealmResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* Creates
|
|
17
|
-
* HTTP POST /
|
|
18
|
-
* Java method: org.openremote.model.
|
|
16
|
+
* Creates and configures a realm in the identity provider. This operation is restricted to a super user.
|
|
17
|
+
* HTTP POST /realm
|
|
18
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
19
19
|
*/
|
|
20
|
-
create(
|
|
20
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
21
21
|
/**
|
|
22
|
-
*
|
|
23
|
-
* HTTP
|
|
24
|
-
* Java method: org.openremote.model.
|
|
22
|
+
* Returns complete realm records from the identity provider. This operation is restricted to a super user.
|
|
23
|
+
* HTTP GET /realm
|
|
24
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
25
25
|
*/
|
|
26
|
-
|
|
26
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
27
27
|
/**
|
|
28
|
-
* Returns
|
|
29
|
-
* HTTP GET /
|
|
30
|
-
* Java method: org.openremote.model.
|
|
28
|
+
* Returns only realm name and display name. Super users receive all realms; authenticated users receive their realm; anonymous callers receive the request realm.
|
|
29
|
+
* HTTP GET /realm/accessible
|
|
30
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
31
31
|
*/
|
|
32
|
-
|
|
32
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
33
33
|
/**
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
34
|
+
* Permanently deletes a realm from the identity provider. The master realm cannot be deleted; related Manager data is not automatically removed.
|
|
35
|
+
* Response code 405 - The master realm cannot be deleted
|
|
36
|
+
* Response code 409 - Realm cannot be deleted while it still contains assets
|
|
37
|
+
* HTTP DELETE /realm/{name}
|
|
38
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
37
39
|
*/
|
|
38
|
-
|
|
40
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
39
41
|
/**
|
|
40
|
-
*
|
|
41
|
-
* HTTP
|
|
42
|
-
* Java method: org.openremote.model.
|
|
42
|
+
* Returns complete details for a named active realm when it is accessible to the caller. Regular users cannot use this endpoint to inspect other realms.
|
|
43
|
+
* HTTP GET /realm/{name}
|
|
44
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
43
45
|
*/
|
|
44
|
-
|
|
46
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
45
47
|
/**
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
48
|
+
* Updates a realm through the identity provider. Super-user access is required; the master realm cannot be renamed or disabled.
|
|
49
|
+
* Response code 405 - The requested mutation is not allowed for the master realm
|
|
50
|
+
* HTTP PUT /realm/{name}
|
|
51
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
49
52
|
*/
|
|
50
|
-
|
|
53
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
51
54
|
}
|
|
52
|
-
export declare class
|
|
55
|
+
export declare class AssetModelResourceClient<O> {
|
|
53
56
|
protected httpClient: HttpClient<O>;
|
|
54
57
|
constructor(httpClient: HttpClient<O>);
|
|
55
58
|
/**
|
|
56
|
-
* Returns the
|
|
57
|
-
* HTTP GET /
|
|
58
|
-
* Java method: org.openremote.model.
|
|
59
|
-
*/
|
|
60
|
-
getApps(options?: O): RestResponse<string[]>;
|
|
61
|
-
/**
|
|
62
|
-
* Loads the public console_config.json document used to configure console clients before sign-in.
|
|
63
|
-
* HTTP GET /apps/consoleConfig
|
|
64
|
-
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
59
|
+
* Returns the descriptors used to construct supported asset types, using a gateway model when the optional parent context resolves below a gateway.
|
|
60
|
+
* HTTP GET /model/assetDescriptors
|
|
61
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
65
62
|
*/
|
|
66
|
-
|
|
63
|
+
getAssetDescriptors(queryParams?: {
|
|
64
|
+
parentId?: string;
|
|
65
|
+
parentType?: string;
|
|
66
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
67
67
|
/**
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
-
*
|
|
68
|
+
* Returns metadata for one asset type from this Manager or, when parentId is below a gateway, from that gateway's model. An unknown or gateway-provided type that is not locally available returns no content.
|
|
69
|
+
* Response code 204 - No model information is available for the requested asset type
|
|
70
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
71
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
71
72
|
*/
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
}>;
|
|
75
|
-
}
|
|
76
|
-
export declare class ProvisioningResourceClient<O> {
|
|
77
|
-
protected httpClient: HttpClient<O>;
|
|
78
|
-
constructor(httpClient: HttpClient<O>);
|
|
73
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
74
|
+
parentId?: string;
|
|
75
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
79
76
|
/**
|
|
80
|
-
*
|
|
81
|
-
* HTTP
|
|
82
|
-
* Java method: org.openremote.model.
|
|
77
|
+
* Returns type metadata from this Manager by default. When parentId identifies an asset below a gateway, the gateway's model is used instead; parentType can provide type context for a new parent that does not yet exist.
|
|
78
|
+
* HTTP GET /model/assetInfos
|
|
79
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
83
80
|
*/
|
|
84
|
-
|
|
81
|
+
getAssetInfos(queryParams?: {
|
|
82
|
+
parentId?: string;
|
|
83
|
+
parentType?: string;
|
|
84
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
85
85
|
/**
|
|
86
|
-
* Returns
|
|
87
|
-
*
|
|
88
|
-
*
|
|
86
|
+
* Returns the JSON Schema and a weak ETag for the named value descriptor. Send If-None-Match on later requests to receive 304 when the schema has not changed.
|
|
87
|
+
* Response code 200 - The current JSON Schema
|
|
88
|
+
* Response code 304 - The supplied ETag still identifies the current schema
|
|
89
|
+
* HTTP GET /model/getValueDescriptorSchema
|
|
90
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
|
|
89
91
|
*/
|
|
90
|
-
|
|
92
|
+
getValueDescriptorSchema(queryParams?: {
|
|
93
|
+
name?: string;
|
|
94
|
+
}, options?: O): RestResponse<any>;
|
|
91
95
|
/**
|
|
92
|
-
*
|
|
93
|
-
* HTTP
|
|
94
|
-
* Java method: org.openremote.model.
|
|
96
|
+
* Returns attribute metadata descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
|
|
97
|
+
* HTTP GET /model/metaItemDescriptors
|
|
98
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
95
99
|
*/
|
|
96
|
-
|
|
100
|
+
getMetaItemDescriptors(queryParams?: {
|
|
101
|
+
parentId?: string;
|
|
102
|
+
}, options?: O): RestResponse<{
|
|
103
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
104
|
+
}>;
|
|
97
105
|
/**
|
|
98
|
-
*
|
|
99
|
-
* HTTP
|
|
100
|
-
* Java method: org.openremote.model.
|
|
106
|
+
* Returns attribute value descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
|
|
107
|
+
* HTTP GET /model/valueDescriptors
|
|
108
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
101
109
|
*/
|
|
102
|
-
|
|
110
|
+
getValueDescriptors(queryParams?: {
|
|
111
|
+
parentId?: string;
|
|
112
|
+
}, options?: O): RestResponse<{
|
|
113
|
+
[index: string]: Model.ValueDescriptor;
|
|
114
|
+
}>;
|
|
103
115
|
}
|
|
104
116
|
export declare class GatewayServiceResourceClient<O> {
|
|
105
117
|
protected httpClient: HttpClient<O>;
|
|
@@ -137,195 +149,82 @@ export declare class GatewayServiceResourceClient<O> {
|
|
|
137
149
|
*/
|
|
138
150
|
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
139
151
|
}
|
|
140
|
-
export declare class
|
|
152
|
+
export declare class DashboardResourceClient<O> {
|
|
141
153
|
protected httpClient: HttpClient<O>;
|
|
142
154
|
constructor(httpClient: HttpClient<O>);
|
|
143
155
|
/**
|
|
144
|
-
*
|
|
145
|
-
*
|
|
146
|
-
*
|
|
147
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
156
|
+
* Creates a dashboard in an accessible realm. The server assigns the authenticated user as owner and initially stores the dashboard with shared access.
|
|
157
|
+
* HTTP POST /dashboard
|
|
158
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
148
159
|
*/
|
|
149
|
-
|
|
150
|
-
attributeRefs?: string;
|
|
151
|
-
fromTimestamp?: number;
|
|
152
|
-
toTimestamp?: number;
|
|
153
|
-
format?: Model.DatapointExportFormat;
|
|
154
|
-
}, options?: O): RestResponse<any>;
|
|
160
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
155
161
|
/**
|
|
156
|
-
*
|
|
157
|
-
* HTTP
|
|
158
|
-
* Java method: org.openremote.model.
|
|
162
|
+
* Updates an existing dashboard when the authenticated user can modify it in the dashboard's realm.
|
|
163
|
+
* HTTP PUT /dashboard
|
|
164
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
159
165
|
*/
|
|
160
|
-
|
|
161
|
-
assetId?: string;
|
|
162
|
-
attributeName?: string;
|
|
163
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
166
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
164
167
|
/**
|
|
165
|
-
* Returns
|
|
166
|
-
* HTTP
|
|
167
|
-
* Java method: org.openremote.model.
|
|
168
|
+
* Returns dashboards visible to the caller in the requested realm. Anonymous callers receive public dashboards only; authenticated access also depends on roles, ownership, and linked assets.
|
|
169
|
+
* HTTP GET /dashboard/all/{realm}
|
|
170
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
168
171
|
*/
|
|
169
|
-
|
|
170
|
-
}
|
|
171
|
-
export declare class ExternalServiceResourceClient<O> {
|
|
172
|
-
protected httpClient: HttpClient<O>;
|
|
173
|
-
constructor(httpClient: HttpClient<O>);
|
|
172
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
174
173
|
/**
|
|
175
|
-
*
|
|
176
|
-
*
|
|
177
|
-
*
|
|
178
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
174
|
+
* Executes a dashboard query after constraining it to the caller's realm, roles, ownership, and asset access. A missing body uses the request realm and default visibility rules.
|
|
175
|
+
* HTTP POST /dashboard/query
|
|
176
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
179
177
|
*/
|
|
180
|
-
|
|
181
|
-
realm?: string;
|
|
182
|
-
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
178
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
183
179
|
/**
|
|
184
|
-
*
|
|
185
|
-
*
|
|
186
|
-
*
|
|
187
|
-
* Response code 409 - ExternalService instance already registered
|
|
188
|
-
* HTTP POST /service
|
|
189
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
180
|
+
* Permanently removes a dashboard when the authenticated user can modify it in the requested realm.
|
|
181
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
182
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
190
183
|
*/
|
|
191
|
-
|
|
184
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
192
185
|
/**
|
|
193
|
-
* Returns
|
|
194
|
-
*
|
|
195
|
-
*
|
|
196
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
186
|
+
* Returns one dashboard only when it is visible to the caller. Inaccessible and nonexistent dashboards both return 404 to avoid disclosing their existence.
|
|
187
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
188
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
197
189
|
*/
|
|
198
|
-
|
|
190
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
191
|
+
}
|
|
192
|
+
export declare class SyslogResourceClient<O> {
|
|
193
|
+
protected httpClient: HttpClient<O>;
|
|
194
|
+
constructor(httpClient: HttpClient<O>);
|
|
199
195
|
/**
|
|
200
|
-
*
|
|
201
|
-
*
|
|
202
|
-
*
|
|
203
|
-
* Response code 409 - ExternalService instance already registered
|
|
204
|
-
* HTTP POST /service/global
|
|
205
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
196
|
+
* Returns the current log-storage and retention configuration. This operation is restricted to a super administrator.
|
|
197
|
+
* HTTP GET /syslog/config
|
|
198
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
206
199
|
*/
|
|
207
|
-
|
|
200
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
208
201
|
/**
|
|
209
|
-
*
|
|
210
|
-
*
|
|
211
|
-
*
|
|
212
|
-
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
213
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
202
|
+
* Validates and applies log-storage and retention settings. This operation is restricted to a super administrator.
|
|
203
|
+
* HTTP PUT /syslog/config
|
|
204
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
214
205
|
*/
|
|
215
|
-
|
|
206
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
216
207
|
/**
|
|
217
|
-
*
|
|
218
|
-
*
|
|
219
|
-
*
|
|
220
|
-
* HTTP GET /service/{serviceId}/{instanceId}
|
|
221
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
208
|
+
* Permanently removes all events from the configured syslog storage. This operation is restricted to a super administrator.
|
|
209
|
+
* HTTP DELETE /syslog/event
|
|
210
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
222
211
|
*/
|
|
223
|
-
|
|
212
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
224
213
|
/**
|
|
225
|
-
*
|
|
226
|
-
* Response code
|
|
227
|
-
*
|
|
228
|
-
*
|
|
229
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
214
|
+
* Returns a page of log events filtered by severity, Unix-millisecond time range, categories, and subcategories. RFC 8288 Link headers point to the next and last pages.
|
|
215
|
+
* Response code 200 - The requested page of syslog events
|
|
216
|
+
* HTTP GET /syslog/event
|
|
217
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
230
218
|
*/
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
*/
|
|
241
|
-
deleteConnections(queryParams?: {
|
|
242
|
-
realm?: string[];
|
|
243
|
-
}, options?: O): RestResponse<void>;
|
|
244
|
-
/**
|
|
245
|
-
* Returns every configured central-manager connection. Unlike the single-realm endpoint, this operation is restricted to super users.
|
|
246
|
-
* HTTP GET /gateway/connection
|
|
247
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
248
|
-
*/
|
|
249
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
250
|
-
/**
|
|
251
|
-
* Removes the central-manager connection for one realm. Realm administrators can remove their own connection; super users can remove any connection.
|
|
252
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
253
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
254
|
-
*/
|
|
255
|
-
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
256
|
-
/**
|
|
257
|
-
* Returns the central-manager connection configured for a realm, or null when none exists. Realm administrators can read their own realm; super users can read any realm.
|
|
258
|
-
* Response code 204 - No gateway connection is configured for the realm
|
|
259
|
-
* HTTP GET /gateway/connection/{realm}
|
|
260
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
261
|
-
*/
|
|
262
|
-
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
263
|
-
/**
|
|
264
|
-
* Creates or replaces the connection for the path realm. The server forces the local realm, including realm predicates in attribute filters, to match the path.
|
|
265
|
-
* HTTP PUT /gateway/connection/{realm}
|
|
266
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
267
|
-
*/
|
|
268
|
-
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
269
|
-
/**
|
|
270
|
-
* Returns the live connection state for the requested local realm.
|
|
271
|
-
* HTTP GET /gateway/status/{realm}
|
|
272
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
273
|
-
*/
|
|
274
|
-
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
275
|
-
}
|
|
276
|
-
export declare class MapResourceClient<O> {
|
|
277
|
-
protected httpClient: HttpClient<O>;
|
|
278
|
-
constructor(httpClient: HttpClient<O>);
|
|
279
|
-
/**
|
|
280
|
-
* Returns realm-aware public MapLibre settings with externally reachable URLs derived from proxy headers.
|
|
281
|
-
* HTTP GET /map
|
|
282
|
-
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
283
|
-
*/
|
|
284
|
-
getSettings(options?: O): RestResponse<{
|
|
285
|
-
[id: string]: unknown;
|
|
286
|
-
}>;
|
|
287
|
-
/**
|
|
288
|
-
* Stores the map configuration and returns the resulting public MapLibre settings.
|
|
289
|
-
* HTTP PUT /map
|
|
290
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
291
|
-
*/
|
|
292
|
-
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
293
|
-
[id: string]: unknown;
|
|
294
|
-
}>;
|
|
295
|
-
/**
|
|
296
|
-
* Deletes the installed custom MBTiles database and returns the fallback public map settings.
|
|
297
|
-
* HTTP DELETE /map/deleteMap
|
|
298
|
-
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
299
|
-
*/
|
|
300
|
-
deleteMap(options?: O): RestResponse<{
|
|
301
|
-
[id: string]: unknown;
|
|
302
|
-
}>;
|
|
303
|
-
/**
|
|
304
|
-
* Reports whether custom MBTiles data is installed and the maximum accepted upload size.
|
|
305
|
-
* HTTP GET /map/getCustomMapInfo
|
|
306
|
-
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
307
|
-
*/
|
|
308
|
-
getCustomMapInfo(options?: O): RestResponse<{
|
|
309
|
-
[id: string]: unknown;
|
|
310
|
-
}>;
|
|
311
|
-
/**
|
|
312
|
-
* Returns a pre-compressed Mapbox vector tile for the requested zoom, column, and row coordinates.
|
|
313
|
-
* Response code 200 - Gzip-compressed vector tile
|
|
314
|
-
* Response code 204 - No tile exists at the requested coordinates
|
|
315
|
-
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
316
|
-
* Java method: org.openremote.model.map.MapResource.getTile
|
|
317
|
-
*/
|
|
318
|
-
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
319
|
-
/**
|
|
320
|
-
* Stores the raw request body as the realm's custom MBTiles database and returns the resulting public map settings.
|
|
321
|
-
* HTTP POST /map/upload
|
|
322
|
-
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
323
|
-
*/
|
|
324
|
-
uploadMap(queryParams?: {
|
|
325
|
-
filename?: string;
|
|
326
|
-
}, options?: O): RestResponse<{
|
|
327
|
-
[id: string]: unknown;
|
|
328
|
-
}>;
|
|
219
|
+
getEvents(queryParams?: {
|
|
220
|
+
level?: Model.SyslogLevel;
|
|
221
|
+
per_page?: number;
|
|
222
|
+
page?: number;
|
|
223
|
+
from?: number;
|
|
224
|
+
to?: number;
|
|
225
|
+
category?: Model.SyslogCategory[];
|
|
226
|
+
subCategory?: string[];
|
|
227
|
+
}, options?: O): RestResponse<any>;
|
|
329
228
|
}
|
|
330
229
|
export declare class RulesResourceClient<O> {
|
|
331
230
|
protected httpClient: HttpClient<O>;
|
|
@@ -379,115 +278,372 @@ export declare class RulesResourceClient<O> {
|
|
|
379
278
|
*/
|
|
380
279
|
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
381
280
|
/**
|
|
382
|
-
* Extracts geofence definitions relevant to the asset. Anonymous access requires a public-readable asset; authenticated restricted users require an asset link.
|
|
383
|
-
* HTTP GET /rules/geofences/{assetId}
|
|
384
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
281
|
+
* Extracts geofence definitions relevant to the asset. Anonymous access requires a public-readable asset; authenticated restricted users require an asset link.
|
|
282
|
+
* HTTP GET /rules/geofences/{assetId}
|
|
283
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
284
|
+
*/
|
|
285
|
+
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
286
|
+
/**
|
|
287
|
+
* Returns runtime status and error counts for an accessible asset engine. Returns null when the asset or its engine does not exist.
|
|
288
|
+
* Response code 204 - The asset or its rules engine does not exist
|
|
289
|
+
* HTTP GET /rules/info/asset/{assetId}
|
|
290
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
291
|
+
*/
|
|
292
|
+
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
293
|
+
/**
|
|
294
|
+
* Returns runtime status and compilation/execution error counts for the global engine, or null when that engine is not running. Super-user access is required.
|
|
295
|
+
* Response code 204 - The global rules engine is not running
|
|
296
|
+
* HTTP GET /rules/info/global
|
|
297
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
298
|
+
*/
|
|
299
|
+
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
300
|
+
/**
|
|
301
|
+
* Returns runtime status and error counts for an accessible realm engine, or null when that engine is not running. Restricted users cannot inspect realm engines.
|
|
302
|
+
* Response code 204 - The requested realm rules engine is not running
|
|
303
|
+
* HTTP GET /rules/info/realm/{realm}
|
|
304
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
305
|
+
*/
|
|
306
|
+
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
307
|
+
/**
|
|
308
|
+
* Creates and deploys a ruleset in its body realm and returns its numeric ID. Restricted users cannot create realm rulesets; legacy JavaScript is not accepted.
|
|
309
|
+
* HTTP POST /rules/realm
|
|
310
|
+
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
311
|
+
*/
|
|
312
|
+
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
313
|
+
/**
|
|
314
|
+
* Returns realm rulesets filtered by language. Anonymous, restricted, or callers without read-rules permission receive public rulesets only; fullyPopulate controls loading of rule source.
|
|
315
|
+
* HTTP GET /rules/realm/for/{realm}
|
|
316
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
317
|
+
*/
|
|
318
|
+
getRealmRulesets(realm: string, queryParams?: {
|
|
319
|
+
language?: Model.RulesetLang[];
|
|
320
|
+
fullyPopulate?: boolean;
|
|
321
|
+
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
322
|
+
/**
|
|
323
|
+
* Permanently removes and undeploys one ruleset from an accessible realm.
|
|
324
|
+
* HTTP DELETE /rules/realm/{id}
|
|
325
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
326
|
+
*/
|
|
327
|
+
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
328
|
+
/**
|
|
329
|
+
* Returns one fully populated realm ruleset when its realm is accessible to the caller.
|
|
330
|
+
* HTTP GET /rules/realm/{id}
|
|
331
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
332
|
+
*/
|
|
333
|
+
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
334
|
+
/**
|
|
335
|
+
* Replaces and redeploys one realm ruleset. Path and body IDs and the existing realm must match; legacy JavaScript cannot be updated.
|
|
336
|
+
* HTTP PUT /rules/realm/{id}
|
|
337
|
+
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
338
|
+
*/
|
|
339
|
+
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
340
|
+
/**
|
|
341
|
+
* Permanently removes and undeploys one global ruleset. Super-user access is required.
|
|
342
|
+
* HTTP DELETE /rules/{id}
|
|
343
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
344
|
+
*/
|
|
345
|
+
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
346
|
+
/**
|
|
347
|
+
* Returns one fully populated global ruleset including transient deployment status and errors. Super-user access is required.
|
|
348
|
+
* HTTP GET /rules/{id}
|
|
349
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
350
|
+
*/
|
|
351
|
+
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
352
|
+
/**
|
|
353
|
+
* Replaces and redeploys the identified global ruleset. Path and body IDs must match; legacy JavaScript rulesets cannot be updated.
|
|
354
|
+
* HTTP PUT /rules/{id}
|
|
355
|
+
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
356
|
+
*/
|
|
357
|
+
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
358
|
+
}
|
|
359
|
+
export declare class StatusResourceClient<O> {
|
|
360
|
+
protected httpClient: HttpClient<O>;
|
|
361
|
+
constructor(httpClient: HttpClient<O>);
|
|
362
|
+
/**
|
|
363
|
+
* Returns health data keyed by registered health-provider name. A null provider result is represented as JSON null.
|
|
364
|
+
* HTTP GET /health
|
|
365
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
366
|
+
*/
|
|
367
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
368
|
+
[index: string]: any;
|
|
369
|
+
}>;
|
|
370
|
+
/**
|
|
371
|
+
* Returns public bootstrap information, including the Manager version and identity-provider URL.
|
|
372
|
+
* HTTP GET /info
|
|
373
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
374
|
+
*/
|
|
375
|
+
getInfo(options?: O): RestResponse<{
|
|
376
|
+
[index: string]: any;
|
|
377
|
+
}>;
|
|
378
|
+
}
|
|
379
|
+
export declare class ProvisioningResourceClient<O> {
|
|
380
|
+
protected httpClient: HttpClient<O>;
|
|
381
|
+
constructor(httpClient: HttpClient<O>);
|
|
382
|
+
/**
|
|
383
|
+
* Persists a new provisioning configuration and returns its generated numeric identifier. This operation is restricted to a super administrator.
|
|
384
|
+
* HTTP POST /provisioning
|
|
385
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
386
|
+
*/
|
|
387
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
388
|
+
/**
|
|
389
|
+
* Returns every provisioning configuration. This operation is restricted to a super administrator.
|
|
390
|
+
* HTTP GET /provisioning
|
|
391
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
392
|
+
*/
|
|
393
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
394
|
+
/**
|
|
395
|
+
* Permanently removes the provisioning configuration identified by the path. This operation is restricted to a super administrator.
|
|
396
|
+
* HTTP DELETE /provisioning/{id}
|
|
397
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
398
|
+
*/
|
|
399
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
400
|
+
/**
|
|
401
|
+
* Replaces the provisioning configuration identified by the path. This operation is restricted to a super administrator.
|
|
402
|
+
* HTTP PUT /provisioning/{id}
|
|
403
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
404
|
+
*/
|
|
405
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
406
|
+
}
|
|
407
|
+
export declare class ConfigurationResourceClient<O> {
|
|
408
|
+
protected httpClient: HttpClient<O>;
|
|
409
|
+
constructor(httpClient: HttpClient<O>);
|
|
410
|
+
/**
|
|
411
|
+
* Returns the public Manager application configuration used by clients before and after authentication.
|
|
412
|
+
* HTTP GET /configuration/manager
|
|
413
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
414
|
+
*/
|
|
415
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
416
|
+
/**
|
|
417
|
+
* Replaces manager_config.json and returns the stored configuration. This administrative change affects Manager UI branding and behavior. This operation is restricted to a super administrator.
|
|
418
|
+
* HTTP PUT /configuration/manager
|
|
419
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
420
|
+
*/
|
|
421
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
422
|
+
/**
|
|
423
|
+
* Validates and stores the supplied image FileInfo at the requested relative path, replacing an existing image, then returns its Manager API path. This operation is restricted to a super administrator.
|
|
424
|
+
* HTTP POST /configuration/manager/image
|
|
425
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.imageUpload
|
|
426
|
+
*/
|
|
427
|
+
imageUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
428
|
+
path?: string;
|
|
429
|
+
}, options?: O): RestResponse<string>;
|
|
430
|
+
/**
|
|
431
|
+
* Streams a configuration image using a fixed media type determined by its filename extension. Only png, jpg, jpeg, ico, and svg extensions are served, ignoring case; unsupported extensions return 404.
|
|
432
|
+
* Response code 200 - The image file
|
|
433
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
434
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
435
|
+
*/
|
|
436
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
437
|
+
}
|
|
438
|
+
export declare class AlarmResourceClient<O> {
|
|
439
|
+
protected httpClient: HttpClient<O>;
|
|
440
|
+
constructor(httpClient: HttpClient<O>);
|
|
441
|
+
/**
|
|
442
|
+
* Creates a manual alarm in an accessible realm and optionally links it to the supplied asset IDs. The authenticated user or client becomes the alarm source.
|
|
443
|
+
* HTTP POST /alarm
|
|
444
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
445
|
+
*/
|
|
446
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
447
|
+
assetIds?: string[];
|
|
448
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
449
|
+
/**
|
|
450
|
+
* Returns alarms in the requested accessible realm, optionally filtered by status, linked asset, or assignee. When realm is omitted, the authenticated realm is used.
|
|
451
|
+
* HTTP GET /alarm
|
|
452
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
453
|
+
*/
|
|
454
|
+
getAlarms(queryParams?: {
|
|
455
|
+
realm?: string;
|
|
456
|
+
status?: Model.AlarmStatus;
|
|
457
|
+
assetId?: string;
|
|
458
|
+
assigneeId?: string;
|
|
459
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
460
|
+
/**
|
|
461
|
+
* Permanently removes all alarms identified by the request body after verifying access to every alarm's realm.
|
|
462
|
+
* HTTP DELETE /alarm
|
|
463
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
464
|
+
*/
|
|
465
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
466
|
+
/**
|
|
467
|
+
* Adds links between assets and one existing alarm.
|
|
468
|
+
|
|
469
|
+
The request body is a list for backward compatibility, but this operation now has single-alarm semantics:
|
|
470
|
+
every item must contain the same `id.realm` and the same `id.alarmId`. The alarm must exist in that realm,
|
|
471
|
+
every asset must exist in the same realm, and the authenticated user must have access to that realm. Requests
|
|
472
|
+
containing mixed alarm IDs or realms are rejected as bad requests.
|
|
473
|
+
|
|
474
|
+
Existing links are left unchanged; duplicate links in the request or links that already exist are ignored.
|
|
475
|
+
This operation does not remove existing links from the alarm.
|
|
476
|
+
|
|
477
|
+
* HTTP PUT /alarm/assets
|
|
478
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
479
|
+
*/
|
|
480
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
481
|
+
/**
|
|
482
|
+
* Returns one alarm when its realm is active and accessible to the authenticated user.
|
|
483
|
+
* HTTP GET /alarm/{alarmId}
|
|
484
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
485
|
+
*/
|
|
486
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
487
|
+
/**
|
|
488
|
+
* Permanently removes one alarm after verifying access to its realm.
|
|
489
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
490
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
491
|
+
*/
|
|
492
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
493
|
+
/**
|
|
494
|
+
* Updates the mutable state of an existing alarm after verifying access to its current realm.
|
|
495
|
+
* HTTP PUT /alarm/{alarmId}
|
|
496
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
497
|
+
*/
|
|
498
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
499
|
+
/**
|
|
500
|
+
* Returns links from the alarm to assets in the explicitly supplied accessible realm.
|
|
501
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
502
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
503
|
+
*/
|
|
504
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
505
|
+
realm?: string;
|
|
506
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
507
|
+
}
|
|
508
|
+
export declare class AppResourceClient<O> {
|
|
509
|
+
protected httpClient: HttpClient<O>;
|
|
510
|
+
constructor(httpClient: HttpClient<O>);
|
|
511
|
+
/**
|
|
512
|
+
* Returns the identifiers of applications installed in the Manager web root.
|
|
513
|
+
* HTTP GET /apps
|
|
514
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
385
515
|
*/
|
|
386
|
-
|
|
516
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
387
517
|
/**
|
|
388
|
-
*
|
|
389
|
-
*
|
|
390
|
-
*
|
|
391
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
518
|
+
* Loads the public console_config.json document used to configure console clients before sign-in.
|
|
519
|
+
* HTTP GET /apps/consoleConfig
|
|
520
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
392
521
|
*/
|
|
393
|
-
|
|
522
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
394
523
|
/**
|
|
395
|
-
*
|
|
396
|
-
*
|
|
397
|
-
*
|
|
398
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
524
|
+
* Loads each installed application's info.json file and returns the documents keyed by application identifier.
|
|
525
|
+
* HTTP GET /apps/info
|
|
526
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
399
527
|
*/
|
|
400
|
-
|
|
528
|
+
getAppInfos(options?: O): RestResponse<{
|
|
529
|
+
[index: string]: any;
|
|
530
|
+
}>;
|
|
531
|
+
}
|
|
532
|
+
export declare class MapResourceClient<O> {
|
|
533
|
+
protected httpClient: HttpClient<O>;
|
|
534
|
+
constructor(httpClient: HttpClient<O>);
|
|
401
535
|
/**
|
|
402
|
-
* Returns
|
|
403
|
-
*
|
|
404
|
-
*
|
|
405
|
-
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
536
|
+
* Returns realm-aware public MapLibre settings with externally reachable URLs derived from proxy headers.
|
|
537
|
+
* HTTP GET /map
|
|
538
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
406
539
|
*/
|
|
407
|
-
|
|
540
|
+
getSettings(options?: O): RestResponse<{
|
|
541
|
+
[id: string]: unknown;
|
|
542
|
+
}>;
|
|
408
543
|
/**
|
|
409
|
-
*
|
|
410
|
-
* HTTP
|
|
411
|
-
* Java method: org.openremote.model.
|
|
544
|
+
* Stores the map configuration and returns the resulting public MapLibre settings. This operation is restricted to a super administrator.
|
|
545
|
+
* HTTP PUT /map
|
|
546
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
412
547
|
*/
|
|
413
|
-
|
|
548
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
549
|
+
[id: string]: unknown;
|
|
550
|
+
}>;
|
|
414
551
|
/**
|
|
415
|
-
*
|
|
416
|
-
* HTTP
|
|
417
|
-
* Java method: org.openremote.model.
|
|
552
|
+
* Deletes the installed custom MBTiles database and returns the fallback public map settings. This operation is restricted to a super administrator.
|
|
553
|
+
* HTTP DELETE /map/deleteMap
|
|
554
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
418
555
|
*/
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
556
|
+
deleteMap(options?: O): RestResponse<{
|
|
557
|
+
[id: string]: unknown;
|
|
558
|
+
}>;
|
|
423
559
|
/**
|
|
424
|
-
*
|
|
425
|
-
* HTTP
|
|
426
|
-
* Java method: org.openremote.model.
|
|
560
|
+
* Reports whether custom MBTiles data is installed and the maximum accepted upload size.
|
|
561
|
+
* HTTP GET /map/getCustomMapInfo
|
|
562
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
427
563
|
*/
|
|
428
|
-
|
|
564
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
565
|
+
[id: string]: unknown;
|
|
566
|
+
}>;
|
|
429
567
|
/**
|
|
430
|
-
* Returns
|
|
431
|
-
*
|
|
432
|
-
*
|
|
568
|
+
* Returns a pre-compressed Mapbox vector tile for the requested zoom, column, and row coordinates.
|
|
569
|
+
* Response code 200 - Gzip-compressed vector tile
|
|
570
|
+
* Response code 204 - No tile exists at the requested coordinates
|
|
571
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
572
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
433
573
|
*/
|
|
434
|
-
|
|
574
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
435
575
|
/**
|
|
436
|
-
*
|
|
437
|
-
* HTTP
|
|
438
|
-
* Java method: org.openremote.model.
|
|
576
|
+
* Stores the raw request body as the realm's custom MBTiles database and returns the resulting public map settings. This operation is restricted to a super administrator.
|
|
577
|
+
* HTTP POST /map/upload
|
|
578
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
439
579
|
*/
|
|
440
|
-
|
|
580
|
+
uploadMap(queryParams?: {
|
|
581
|
+
filename?: string;
|
|
582
|
+
}, options?: O): RestResponse<{
|
|
583
|
+
[id: string]: unknown;
|
|
584
|
+
}>;
|
|
585
|
+
}
|
|
586
|
+
export declare class ExternalServiceResourceClient<O> {
|
|
587
|
+
protected httpClient: HttpClient<O>;
|
|
588
|
+
constructor(httpClient: HttpClient<O>);
|
|
441
589
|
/**
|
|
442
|
-
*
|
|
443
|
-
*
|
|
444
|
-
*
|
|
590
|
+
* Returns all active realm-scoped service registrations for an active realm accessible to the caller.
|
|
591
|
+
* Response code 200 - List of registered external services
|
|
592
|
+
* HTTP GET /service
|
|
593
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
445
594
|
*/
|
|
446
|
-
|
|
595
|
+
getServices(queryParams?: {
|
|
596
|
+
realm?: string;
|
|
597
|
+
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
447
598
|
/**
|
|
448
|
-
*
|
|
449
|
-
*
|
|
450
|
-
*
|
|
599
|
+
* Registers a realm-scoped service instance for the request realm. The caller must be a service account; the returned object contains the assigned instance ID and initial lease state.
|
|
600
|
+
* Response code 200 - Service registered successfully
|
|
601
|
+
* Response code 400 - Invalid external service object
|
|
602
|
+
* Response code 409 - ExternalService instance already registered
|
|
603
|
+
* HTTP POST /service
|
|
604
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
451
605
|
*/
|
|
452
|
-
|
|
606
|
+
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
453
607
|
/**
|
|
454
|
-
*
|
|
455
|
-
*
|
|
456
|
-
*
|
|
608
|
+
* Returns active registrations marked as globally available across realms.
|
|
609
|
+
* Response code 200 - List of registered external services
|
|
610
|
+
* HTTP GET /service/global
|
|
611
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
457
612
|
*/
|
|
458
|
-
|
|
459
|
-
}
|
|
460
|
-
export declare class ConsoleResourceClient<O> {
|
|
461
|
-
protected httpClient: HttpClient<O>;
|
|
462
|
-
constructor(httpClient: HttpClient<O>);
|
|
613
|
+
getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
|
|
463
614
|
/**
|
|
464
|
-
*
|
|
465
|
-
*
|
|
466
|
-
*
|
|
615
|
+
* Registers a service visible in every realm. The caller must be a super-user service account and the request must use the master realm.
|
|
616
|
+
* Response code 200 - Service registered successfully
|
|
617
|
+
* Response code 400 - Invalid external service object
|
|
618
|
+
* Response code 409 - ExternalService instance already registered
|
|
619
|
+
* HTTP POST /service/global
|
|
620
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
467
621
|
*/
|
|
468
|
-
|
|
469
|
-
}
|
|
470
|
-
export declare class FlowResourceClient<O> {
|
|
471
|
-
protected httpClient: HttpClient<O>;
|
|
472
|
-
constructor(httpClient: HttpClient<O>);
|
|
622
|
+
registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
473
623
|
/**
|
|
474
|
-
*
|
|
475
|
-
*
|
|
476
|
-
*
|
|
624
|
+
* Removes an active service registration. The caller must be the service account that registered it; global-service removal additionally requires a super user.
|
|
625
|
+
* Response code 204 - Service deregistered successfully
|
|
626
|
+
* Response code 404 - Service instance not found
|
|
627
|
+
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
628
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
477
629
|
*/
|
|
478
|
-
|
|
630
|
+
deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
479
631
|
/**
|
|
480
|
-
*
|
|
481
|
-
*
|
|
482
|
-
*
|
|
632
|
+
* Returns one registered instance by stable service ID and numeric instance ID, after verifying access to the service's realm.
|
|
633
|
+
* Response code 200 - ExternalService retrieved successfully
|
|
634
|
+
* Response code 404 - ExternalService not found
|
|
635
|
+
* HTTP GET /service/{serviceId}/{instanceId}
|
|
636
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
483
637
|
*/
|
|
484
|
-
|
|
638
|
+
getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
|
|
485
639
|
/**
|
|
486
|
-
*
|
|
487
|
-
*
|
|
488
|
-
*
|
|
640
|
+
* Extends the lease of one service instance. The caller must be the service account that registered it; global-service heartbeats additionally require a super user.
|
|
641
|
+
* Response code 204 - Heartbeat sent successfully
|
|
642
|
+
* Response code 404 - Service instance not found
|
|
643
|
+
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
644
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
489
645
|
*/
|
|
490
|
-
|
|
646
|
+
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
491
647
|
}
|
|
492
648
|
export declare class UserResourceClient<O> {
|
|
493
649
|
protected httpClient: HttpClient<O>;
|
|
@@ -627,101 +783,22 @@ export declare class UserResourceClient<O> {
|
|
|
627
783
|
delete(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
628
784
|
/**
|
|
629
785
|
* Returns all role definitions exposed by the named identity-provider client. Realm-administrator access is required. The target realm must be active unless the caller is a superuser.
|
|
630
|
-
* HTTP GET /user/{realm}/{clientId}/roles
|
|
631
|
-
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
632
|
-
*/
|
|
633
|
-
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
634
|
-
/**
|
|
635
|
-
* Creates, updates, or removes role definitions for a named identity-provider client. The target realm must be active unless the caller is a superuser.
|
|
636
|
-
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
637
|
-
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
638
|
-
*/
|
|
639
|
-
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
640
|
-
/**
|
|
641
|
-
* Returns one user when it belongs to the requested accessible realm. Without read-admin permission, callers may retrieve only their own user. The target realm must be active unless the caller is a superuser.
|
|
642
|
-
* HTTP GET /user/{realm}/{userId}
|
|
643
|
-
* Java method: org.openremote.model.security.UserResource.get
|
|
644
|
-
*/
|
|
645
|
-
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
646
|
-
}
|
|
647
|
-
export declare class NotificationResourceClient<O> {
|
|
648
|
-
protected httpClient: HttpClient<O>;
|
|
649
|
-
constructor(httpClient: HttpClient<O>);
|
|
650
|
-
/**
|
|
651
|
-
* Returns sent-notification records filtered by identity, message type, time, realm, target, source, sorting, and pagination. Results are realm-scoped and sensitive target/source identifiers are redacted when the caller lacks user or asset read permission.
|
|
652
|
-
* HTTP GET /notification
|
|
653
|
-
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
654
|
-
*/
|
|
655
|
-
getNotifications(queryParams?: {
|
|
656
|
-
id?: number;
|
|
657
|
-
type?: string;
|
|
658
|
-
from?: number;
|
|
659
|
-
to?: number;
|
|
660
|
-
realmId?: string;
|
|
661
|
-
userId?: string;
|
|
662
|
-
assetId?: string;
|
|
663
|
-
source?: Model.NotificationSource;
|
|
664
|
-
sort?: Model.SentNotificationSortField;
|
|
665
|
-
descending?: boolean;
|
|
666
|
-
offset?: number;
|
|
667
|
-
limit?: number;
|
|
668
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
669
|
-
/**
|
|
670
|
-
* Permanently removes all records matching the optional ID, type, time, realm, user, and asset filters. This bulk operation is restricted to a super user.
|
|
671
|
-
* HTTP DELETE /notification
|
|
672
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
673
|
-
*/
|
|
674
|
-
removeNotifications(queryParams?: {
|
|
675
|
-
id?: number;
|
|
676
|
-
type?: string;
|
|
677
|
-
from?: number;
|
|
678
|
-
to?: number;
|
|
679
|
-
realmId?: string;
|
|
680
|
-
userId?: string;
|
|
681
|
-
assetId?: string;
|
|
682
|
-
}, options?: O): RestResponse<void>;
|
|
683
|
-
/**
|
|
684
|
-
* Queues a notification for delivery. Authorization is checked for every target; if any target is inaccessible, the complete request fails rather than sending a partial set.
|
|
685
|
-
* HTTP POST /notification/alert
|
|
686
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
687
|
-
*/
|
|
688
|
-
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
689
|
-
/**
|
|
690
|
-
* Returns the count for the same realm-scoped type, time, target, and source filters supported by getNotifications without loading notification records.
|
|
691
|
-
* HTTP GET /notification/count
|
|
692
|
-
* Java method: org.openremote.model.notification.NotificationResource.getNotificationsCount
|
|
693
|
-
*/
|
|
694
|
-
getNotificationsCount(queryParams?: {
|
|
695
|
-
type?: string;
|
|
696
|
-
from?: number;
|
|
697
|
-
to?: number;
|
|
698
|
-
realmId?: string;
|
|
699
|
-
userId?: string;
|
|
700
|
-
assetId?: string;
|
|
701
|
-
source?: Model.NotificationSource;
|
|
702
|
-
}, options?: O): RestResponse<number>;
|
|
703
|
-
/**
|
|
704
|
-
* Permanently removes one sent-notification record. This operation is restricted to a super user and is idempotent when the ID does not exist.
|
|
705
|
-
* HTTP DELETE /notification/{notificationId}
|
|
706
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
786
|
+
* HTTP GET /user/{realm}/{clientId}/roles
|
|
787
|
+
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
707
788
|
*/
|
|
708
|
-
|
|
789
|
+
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
709
790
|
/**
|
|
710
|
-
*
|
|
711
|
-
* HTTP PUT /
|
|
712
|
-
* Java method: org.openremote.model.
|
|
791
|
+
* Creates, updates, or removes role definitions for a named identity-provider client. The target realm must be active unless the caller is a superuser.
|
|
792
|
+
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
793
|
+
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
713
794
|
*/
|
|
714
|
-
|
|
715
|
-
targetId?: string;
|
|
716
|
-
}, options?: O): RestResponse<void>;
|
|
795
|
+
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
717
796
|
/**
|
|
718
|
-
*
|
|
719
|
-
* HTTP
|
|
720
|
-
* Java method: org.openremote.model.
|
|
797
|
+
* Returns one user when it belongs to the requested accessible realm. Without read-admin permission, callers may retrieve only their own user. The target realm must be active unless the caller is a superuser.
|
|
798
|
+
* HTTP GET /user/{realm}/{userId}
|
|
799
|
+
* Java method: org.openremote.model.security.UserResource.get
|
|
721
800
|
*/
|
|
722
|
-
|
|
723
|
-
targetId?: string;
|
|
724
|
-
}, options?: O): RestResponse<void>;
|
|
801
|
+
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
725
802
|
}
|
|
726
803
|
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
727
804
|
protected httpClient: HttpClient<O>;
|
|
@@ -739,117 +816,70 @@ export declare class AssetPredictedDatapointResourceClient<O> {
|
|
|
739
816
|
*/
|
|
740
817
|
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
741
818
|
}
|
|
742
|
-
export declare class
|
|
819
|
+
export declare class FlowResourceClient<O> {
|
|
743
820
|
protected httpClient: HttpClient<O>;
|
|
744
821
|
constructor(httpClient: HttpClient<O>);
|
|
745
822
|
/**
|
|
746
|
-
* Returns
|
|
747
|
-
* HTTP GET /
|
|
748
|
-
* Java method: org.openremote.model.
|
|
749
|
-
*/
|
|
750
|
-
getAssetDescriptors(queryParams?: {
|
|
751
|
-
parentId?: string;
|
|
752
|
-
parentType?: string;
|
|
753
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
754
|
-
/**
|
|
755
|
-
* Returns metadata for one asset type from this Manager or, when parentId is below a gateway, from that gateway's model. An unknown or gateway-provided type that is not locally available returns no content.
|
|
756
|
-
* Response code 204 - No model information is available for the requested asset type
|
|
757
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
758
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
759
|
-
*/
|
|
760
|
-
getAssetInfo(assetType: string, queryParams?: {
|
|
761
|
-
parentId?: string;
|
|
762
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
763
|
-
/**
|
|
764
|
-
* Returns type metadata from this Manager by default. When parentId identifies an asset below a gateway, the gateway's model is used instead; parentType can provide type context for a new parent that does not yet exist.
|
|
765
|
-
* HTTP GET /model/assetInfos
|
|
766
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
767
|
-
*/
|
|
768
|
-
getAssetInfos(queryParams?: {
|
|
769
|
-
parentId?: string;
|
|
770
|
-
parentType?: string;
|
|
771
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
772
|
-
/**
|
|
773
|
-
* Returns the JSON Schema and a weak ETag for the named value descriptor. Send If-None-Match on later requests to receive 304 when the schema has not changed.
|
|
774
|
-
* Response code 200 - The current JSON Schema
|
|
775
|
-
* Response code 304 - The supplied ETag still identifies the current schema
|
|
776
|
-
* HTTP GET /model/getValueDescriptorSchema
|
|
777
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
|
|
823
|
+
* Returns every supported flow node definition except the internal LOG_OUTPUT node.
|
|
824
|
+
* HTTP GET /flow
|
|
825
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
778
826
|
*/
|
|
779
|
-
|
|
780
|
-
name?: string;
|
|
781
|
-
}, options?: O): RestResponse<any>;
|
|
827
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
782
828
|
/**
|
|
783
|
-
*
|
|
784
|
-
* HTTP GET /
|
|
785
|
-
* Java method: org.openremote.model.
|
|
829
|
+
* Resolves one flow node definition by its model name.
|
|
830
|
+
* HTTP GET /flow/{name}
|
|
831
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
786
832
|
*/
|
|
787
|
-
|
|
788
|
-
parentId?: string;
|
|
789
|
-
}, options?: O): RestResponse<{
|
|
790
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
791
|
-
}>;
|
|
833
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
792
834
|
/**
|
|
793
|
-
* Returns
|
|
794
|
-
* HTTP GET /
|
|
795
|
-
* Java method: org.openremote.model.
|
|
835
|
+
* Returns supported flow node definitions whose category matches the requested node type.
|
|
836
|
+
* HTTP GET /flow/{type}
|
|
837
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
796
838
|
*/
|
|
797
|
-
|
|
798
|
-
parentId?: string;
|
|
799
|
-
}, options?: O): RestResponse<{
|
|
800
|
-
[index: string]: Model.ValueDescriptor;
|
|
801
|
-
}>;
|
|
839
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
802
840
|
}
|
|
803
|
-
export declare class
|
|
841
|
+
export declare class GatewayClientResourceClient<O> {
|
|
804
842
|
protected httpClient: HttpClient<O>;
|
|
805
843
|
constructor(httpClient: HttpClient<O>);
|
|
806
844
|
/**
|
|
807
|
-
*
|
|
808
|
-
* HTTP
|
|
809
|
-
* Java method: org.openremote.model.
|
|
845
|
+
* Removes connections for all repeated realm query parameters. Deleting multiple realms is restricted to super users.
|
|
846
|
+
* HTTP DELETE /gateway/connection
|
|
847
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
810
848
|
*/
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
}>;
|
|
849
|
+
deleteConnections(queryParams?: {
|
|
850
|
+
realm?: string[];
|
|
851
|
+
}, options?: O): RestResponse<void>;
|
|
814
852
|
/**
|
|
815
|
-
* Returns
|
|
816
|
-
* HTTP GET /
|
|
817
|
-
* Java method: org.openremote.model.
|
|
853
|
+
* Returns every configured central-manager connection. Unlike the single-realm endpoint, this operation is restricted to super users.
|
|
854
|
+
* HTTP GET /gateway/connection
|
|
855
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
818
856
|
*/
|
|
819
|
-
|
|
820
|
-
[index: string]: any;
|
|
821
|
-
}>;
|
|
822
|
-
}
|
|
823
|
-
export declare class AgentResourceClient<O> {
|
|
824
|
-
protected httpClient: HttpClient<O>;
|
|
825
|
-
constructor(httpClient: HttpClient<O>);
|
|
857
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
826
858
|
/**
|
|
827
|
-
*
|
|
828
|
-
* HTTP
|
|
829
|
-
* Java method: org.openremote.model.
|
|
859
|
+
* Removes the central-manager connection for one realm. Realm administrators can remove their own connection; super users can remove any connection.
|
|
860
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
861
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
830
862
|
*/
|
|
831
|
-
|
|
832
|
-
realm?: string;
|
|
833
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
863
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
834
864
|
/**
|
|
835
|
-
*
|
|
836
|
-
* Response code
|
|
837
|
-
* HTTP
|
|
838
|
-
* Java method: org.openremote.model.
|
|
865
|
+
* Returns the central-manager connection configured for a realm, or null when none exists. Realm administrators can read their own realm; super users can read any realm.
|
|
866
|
+
* Response code 204 - No gateway connection is configured for the realm
|
|
867
|
+
* HTTP GET /gateway/connection/{realm}
|
|
868
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
839
869
|
*/
|
|
840
|
-
|
|
841
|
-
realm?: string;
|
|
842
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
870
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
843
871
|
/**
|
|
844
|
-
*
|
|
845
|
-
*
|
|
846
|
-
*
|
|
847
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
872
|
+
* Creates or replaces the connection for the path realm. The server forces the local realm, including realm predicates in attribute filters, to match the path.
|
|
873
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
874
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
848
875
|
*/
|
|
849
|
-
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
876
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
877
|
+
/**
|
|
878
|
+
* Returns the live connection state for the requested local realm.
|
|
879
|
+
* HTTP GET /gateway/status/{realm}
|
|
880
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
881
|
+
*/
|
|
882
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
853
883
|
}
|
|
854
884
|
export declare class AssetResourceClient<O> {
|
|
855
885
|
protected httpClient: HttpClient<O>;
|
|
@@ -991,234 +1021,204 @@ export declare class AssetResourceClient<O> {
|
|
|
991
1021
|
assetIds?: string[];
|
|
992
1022
|
}, options?: O): RestResponse<void>;
|
|
993
1023
|
}
|
|
994
|
-
export declare class
|
|
995
|
-
protected httpClient: HttpClient<O>;
|
|
996
|
-
constructor(httpClient: HttpClient<O>);
|
|
997
|
-
/**
|
|
998
|
-
* Creates and configures a realm in the identity provider. This operation is restricted to a super user.
|
|
999
|
-
* HTTP POST /realm
|
|
1000
|
-
* Java method: org.openremote.model.security.RealmResource.create
|
|
1001
|
-
*/
|
|
1002
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
1003
|
-
/**
|
|
1004
|
-
* Returns complete realm records from the identity provider. This operation is restricted to a super user.
|
|
1005
|
-
* HTTP GET /realm
|
|
1006
|
-
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
1007
|
-
*/
|
|
1008
|
-
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
1009
|
-
/**
|
|
1010
|
-
* Returns only realm name and display name. Super users receive all realms; authenticated users receive their realm; anonymous callers receive the request realm.
|
|
1011
|
-
* HTTP GET /realm/accessible
|
|
1012
|
-
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
1013
|
-
*/
|
|
1014
|
-
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
1015
|
-
/**
|
|
1016
|
-
* Permanently deletes a realm from the identity provider. The master realm cannot be deleted; related Manager data is not automatically removed.
|
|
1017
|
-
* Response code 405 - The master realm cannot be deleted
|
|
1018
|
-
* Response code 409 - Realm cannot be deleted while it still contains assets
|
|
1019
|
-
* HTTP DELETE /realm/{name}
|
|
1020
|
-
* Java method: org.openremote.model.security.RealmResource.delete
|
|
1021
|
-
*/
|
|
1022
|
-
delete(name: string, options?: O): RestResponse<void>;
|
|
1023
|
-
/**
|
|
1024
|
-
* Returns complete details for a named active realm when it is accessible to the caller. Regular users cannot use this endpoint to inspect other realms.
|
|
1025
|
-
* HTTP GET /realm/{name}
|
|
1026
|
-
* Java method: org.openremote.model.security.RealmResource.get
|
|
1027
|
-
*/
|
|
1028
|
-
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
1029
|
-
/**
|
|
1030
|
-
* Updates a realm through the identity provider. Super-user access is required; the master realm cannot be renamed or disabled.
|
|
1031
|
-
* Response code 405 - The requested mutation is not allowed for the master realm
|
|
1032
|
-
* HTTP PUT /realm/{name}
|
|
1033
|
-
* Java method: org.openremote.model.security.RealmResource.update
|
|
1034
|
-
*/
|
|
1035
|
-
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
1036
|
-
}
|
|
1037
|
-
export declare class AlarmResourceClient<O> {
|
|
1024
|
+
export declare class NotificationResourceClient<O> {
|
|
1038
1025
|
protected httpClient: HttpClient<O>;
|
|
1039
1026
|
constructor(httpClient: HttpClient<O>);
|
|
1040
1027
|
/**
|
|
1041
|
-
*
|
|
1042
|
-
* HTTP
|
|
1043
|
-
* Java method: org.openremote.model.
|
|
1044
|
-
*/
|
|
1045
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
1046
|
-
assetIds?: string[];
|
|
1047
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
1048
|
-
/**
|
|
1049
|
-
* Returns alarms in the requested accessible realm, optionally filtered by status, linked asset, or assignee. When realm is omitted, the authenticated realm is used.
|
|
1050
|
-
* HTTP GET /alarm
|
|
1051
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
1028
|
+
* Returns sent-notification records filtered by identity, message type, time, realm, target, source, sorting, and pagination. Results are realm-scoped and sensitive target/source identifiers are redacted when the caller lacks user or asset read permission.
|
|
1029
|
+
* HTTP GET /notification
|
|
1030
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
1052
1031
|
*/
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
|
|
1032
|
+
getNotifications(queryParams?: {
|
|
1033
|
+
id?: number;
|
|
1034
|
+
type?: string;
|
|
1035
|
+
from?: number;
|
|
1036
|
+
to?: number;
|
|
1037
|
+
realmId?: string;
|
|
1038
|
+
userId?: string;
|
|
1056
1039
|
assetId?: string;
|
|
1057
|
-
|
|
1058
|
-
|
|
1040
|
+
source?: Model.NotificationSource;
|
|
1041
|
+
sort?: Model.SentNotificationSortField;
|
|
1042
|
+
descending?: boolean;
|
|
1043
|
+
offset?: number;
|
|
1044
|
+
limit?: number;
|
|
1045
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
1059
1046
|
/**
|
|
1060
|
-
* Permanently removes all
|
|
1061
|
-
* HTTP DELETE /
|
|
1062
|
-
* Java method: org.openremote.model.
|
|
1047
|
+
* Permanently removes all records matching the optional ID, type, time, realm, user, and asset filters. This bulk operation is restricted to a super user.
|
|
1048
|
+
* HTTP DELETE /notification
|
|
1049
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
1063
1050
|
*/
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
|
|
1074
|
-
|
|
1075
|
-
|
|
1076
|
-
*
|
|
1077
|
-
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
1051
|
+
removeNotifications(queryParams?: {
|
|
1052
|
+
id?: number;
|
|
1053
|
+
type?: string;
|
|
1054
|
+
from?: number;
|
|
1055
|
+
to?: number;
|
|
1056
|
+
realmId?: string;
|
|
1057
|
+
userId?: string;
|
|
1058
|
+
assetId?: string;
|
|
1059
|
+
}, options?: O): RestResponse<void>;
|
|
1060
|
+
/**
|
|
1061
|
+
* Queues a notification for delivery. Authorization is checked for every target; if any target is inaccessible, the complete request fails rather than sending a partial set.
|
|
1062
|
+
* HTTP POST /notification/alert
|
|
1063
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
1078
1064
|
*/
|
|
1079
|
-
|
|
1065
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
1080
1066
|
/**
|
|
1081
|
-
* Returns
|
|
1082
|
-
* HTTP GET /
|
|
1083
|
-
* Java method: org.openremote.model.
|
|
1067
|
+
* Returns the count for the same realm-scoped type, time, target, and source filters supported by getNotifications without loading notification records.
|
|
1068
|
+
* HTTP GET /notification/count
|
|
1069
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotificationsCount
|
|
1084
1070
|
*/
|
|
1085
|
-
|
|
1071
|
+
getNotificationsCount(queryParams?: {
|
|
1072
|
+
type?: string;
|
|
1073
|
+
from?: number;
|
|
1074
|
+
to?: number;
|
|
1075
|
+
realmId?: string;
|
|
1076
|
+
userId?: string;
|
|
1077
|
+
assetId?: string;
|
|
1078
|
+
source?: Model.NotificationSource;
|
|
1079
|
+
}, options?: O): RestResponse<number>;
|
|
1086
1080
|
/**
|
|
1087
|
-
* Permanently removes one
|
|
1088
|
-
* HTTP DELETE /
|
|
1089
|
-
* Java method: org.openremote.model.
|
|
1081
|
+
* Permanently removes one sent-notification record. This operation is restricted to a super user and is idempotent when the ID does not exist.
|
|
1082
|
+
* HTTP DELETE /notification/{notificationId}
|
|
1083
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
1090
1084
|
*/
|
|
1091
|
-
|
|
1085
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
1092
1086
|
/**
|
|
1093
|
-
*
|
|
1094
|
-
* HTTP PUT /
|
|
1095
|
-
* Java method: org.openremote.model.
|
|
1087
|
+
* Marks one target's notification as acknowledged and stores the optional JSON acknowledgement value. Access rules are identical to notificationDelivered.
|
|
1088
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
1089
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
1096
1090
|
*/
|
|
1097
|
-
|
|
1091
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
1092
|
+
targetId?: string;
|
|
1093
|
+
}, options?: O): RestResponse<void>;
|
|
1098
1094
|
/**
|
|
1099
|
-
*
|
|
1100
|
-
* HTTP
|
|
1101
|
-
* Java method: org.openremote.model.
|
|
1095
|
+
* Marks one target's notification as delivered after matching both notificationId and targetId. Anonymous callers may update notifications sent to a public asset; authenticated callers are constrained to their own user, realm, or accessible assets.
|
|
1096
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
1097
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
1102
1098
|
*/
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
}, options?: O): RestResponse<
|
|
1099
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
1100
|
+
targetId?: string;
|
|
1101
|
+
}, options?: O): RestResponse<void>;
|
|
1106
1102
|
}
|
|
1107
|
-
export declare class
|
|
1103
|
+
export declare class AgentResourceClient<O> {
|
|
1108
1104
|
protected httpClient: HttpClient<O>;
|
|
1109
1105
|
constructor(httpClient: HttpClient<O>);
|
|
1110
1106
|
/**
|
|
1111
|
-
*
|
|
1112
|
-
* HTTP GET /
|
|
1113
|
-
* Java method: org.openremote.model.
|
|
1114
|
-
*/
|
|
1115
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
1116
|
-
/**
|
|
1117
|
-
* Replaces manager_config.json and returns the stored configuration. This administrative change affects Manager UI branding and behavior.
|
|
1118
|
-
* HTTP PUT /configuration/manager
|
|
1119
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
1107
|
+
* Runs the agent protocol's asset discovery, waits up to ten seconds for results, returns the discovered tree, and asynchronously persists discovered assets below the agent.
|
|
1108
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
1109
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
1120
1110
|
*/
|
|
1121
|
-
|
|
1111
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
1112
|
+
realm?: string;
|
|
1113
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
1122
1114
|
/**
|
|
1123
|
-
* Decodes
|
|
1124
|
-
*
|
|
1125
|
-
*
|
|
1115
|
+
* Decodes the supplied FileInfo, asks the agent protocol to import it, persists the returned asset tree below the agent, and returns that tree.
|
|
1116
|
+
* Response code 405 - The selected agent protocol does not support asset import
|
|
1117
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
1118
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
1126
1119
|
*/
|
|
1127
|
-
|
|
1128
|
-
|
|
1129
|
-
}, options?: O): RestResponse<
|
|
1120
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
1121
|
+
realm?: string;
|
|
1122
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
1130
1123
|
/**
|
|
1131
|
-
*
|
|
1132
|
-
* Response code
|
|
1133
|
-
* HTTP GET /
|
|
1134
|
-
* Java method: org.openremote.model.
|
|
1124
|
+
* Runs instance discovery for an agent type and returns candidate Agent assets. parentId selects local versus edge-gateway discovery; non-super users are always constrained to their authenticated realm.
|
|
1125
|
+
* Response code 415 - The selected agent protocol does not support instance discovery
|
|
1126
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
1127
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
1135
1128
|
*/
|
|
1136
|
-
|
|
1129
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
1130
|
+
parentId?: string;
|
|
1131
|
+
realm?: string;
|
|
1132
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
1137
1133
|
}
|
|
1138
|
-
export declare class
|
|
1134
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
1139
1135
|
protected httpClient: HttpClient<O>;
|
|
1140
1136
|
constructor(httpClient: HttpClient<O>);
|
|
1141
1137
|
/**
|
|
1142
|
-
*
|
|
1143
|
-
*
|
|
1144
|
-
*
|
|
1138
|
+
* Streams a ZIP archive containing exported datapoints for one or more attribute references over the requested inclusive time range. attributeRefs is a JSON-encoded array of objects with id and name fields.
|
|
1139
|
+
* Response code 200 - A ZIP archive containing the exported data
|
|
1140
|
+
* HTTP GET /asset/datapoint/export
|
|
1141
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
1145
1142
|
*/
|
|
1146
|
-
|
|
1143
|
+
getDatapointExport(queryParams?: {
|
|
1144
|
+
attributeRefs?: string;
|
|
1145
|
+
fromTimestamp?: number;
|
|
1146
|
+
toTimestamp?: number;
|
|
1147
|
+
format?: Model.DatapointExportFormat;
|
|
1148
|
+
}, options?: O): RestResponse<any>;
|
|
1147
1149
|
/**
|
|
1148
|
-
*
|
|
1149
|
-
* HTTP
|
|
1150
|
-
* Java method: org.openremote.model.
|
|
1150
|
+
* Returns the oldest and newest stored timestamps for one attribute. The asset and attribute must be readable by the authenticated user and configured for datapoint storage.
|
|
1151
|
+
* HTTP GET /asset/datapoint/periods
|
|
1152
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
1151
1153
|
*/
|
|
1152
|
-
|
|
1154
|
+
getDatapointPeriod(queryParams?: {
|
|
1155
|
+
assetId?: string;
|
|
1156
|
+
attributeName?: string;
|
|
1157
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
1153
1158
|
/**
|
|
1154
|
-
*
|
|
1155
|
-
* HTTP
|
|
1156
|
-
* Java method: org.openremote.model.
|
|
1159
|
+
* Returns stored historical values for one attribute. A null body returns the available series; a polymorphic query body controls the time range and retrieval or aggregation strategy. Anonymous access requires public-read access on both asset and attribute.
|
|
1160
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
1161
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
1157
1162
|
*/
|
|
1158
|
-
|
|
1163
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
1164
|
+
}
|
|
1165
|
+
export declare class ConsoleResourceClient<O> {
|
|
1166
|
+
protected httpClient: HttpClient<O>;
|
|
1167
|
+
constructor(httpClient: HttpClient<O>);
|
|
1159
1168
|
/**
|
|
1160
|
-
*
|
|
1161
|
-
*
|
|
1162
|
-
*
|
|
1163
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
1169
|
+
* Creates an anonymous console registration when id is absent, or updates an existing registration when id is present. Authenticated new registrations are linked to the caller; updates require that link. The returned registration contains the durable asset ID for later calls.
|
|
1170
|
+
* HTTP POST /console/register
|
|
1171
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
1164
1172
|
*/
|
|
1165
|
-
|
|
1166
|
-
level?: Model.SyslogLevel;
|
|
1167
|
-
per_page?: number;
|
|
1168
|
-
page?: number;
|
|
1169
|
-
from?: number;
|
|
1170
|
-
to?: number;
|
|
1171
|
-
category?: Model.SyslogCategory[];
|
|
1172
|
-
subCategory?: string[];
|
|
1173
|
-
}, options?: O): RestResponse<any>;
|
|
1173
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
1174
1174
|
}
|
|
1175
1175
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
1176
1176
|
export declare class ApiClient {
|
|
1177
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
1178
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
1179
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
1177
1180
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
1178
|
-
protected
|
|
1181
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
1182
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
1183
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
1179
1184
|
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
1180
|
-
protected
|
|
1181
|
-
protected
|
|
1182
|
-
protected
|
|
1183
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
1185
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
1186
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
1187
|
+
protected _appResource: AxiosAppResourceClient;
|
|
1184
1188
|
protected _mapResource: AxiosMapResourceClient;
|
|
1185
|
-
protected
|
|
1186
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
1187
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
1189
|
+
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
1188
1190
|
protected _userResource: AxiosUserResourceClient;
|
|
1189
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
1190
1191
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
1191
|
-
protected
|
|
1192
|
-
protected
|
|
1193
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
1192
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
1193
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
1194
1194
|
protected _assetResource: AxiosAssetResourceClient;
|
|
1195
|
-
protected
|
|
1196
|
-
protected
|
|
1197
|
-
protected
|
|
1198
|
-
protected
|
|
1195
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
1196
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
1197
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
1198
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
1199
1199
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1200
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
1201
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1202
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1200
1203
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
1201
|
-
get
|
|
1204
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
1205
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
1206
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
1202
1207
|
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1203
|
-
get
|
|
1204
|
-
get
|
|
1205
|
-
get
|
|
1206
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1208
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
1209
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1210
|
+
get AppResource(): AxiosAppResourceClient;
|
|
1207
1211
|
get MapResource(): AxiosMapResourceClient;
|
|
1208
|
-
get
|
|
1209
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
1210
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
1212
|
+
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
1211
1213
|
get UserResource(): AxiosUserResourceClient;
|
|
1212
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
1213
1214
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
1214
|
-
get
|
|
1215
|
-
get
|
|
1216
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
1215
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
1216
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1217
1217
|
get AssetResource(): AxiosAssetResourceClient;
|
|
1218
|
-
get
|
|
1219
|
-
get
|
|
1220
|
-
get
|
|
1221
|
-
get
|
|
1218
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
1219
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
1220
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1221
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
1222
1222
|
}
|
|
1223
1223
|
import * as Axios from "axios";
|
|
1224
1224
|
declare module "axios" {
|
|
@@ -1226,70 +1226,70 @@ declare module "axios" {
|
|
|
1226
1226
|
data: R;
|
|
1227
1227
|
}
|
|
1228
1228
|
}
|
|
1229
|
-
export declare class
|
|
1229
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1230
1230
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1231
1231
|
}
|
|
1232
|
-
export declare class
|
|
1232
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1233
1233
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1234
1234
|
}
|
|
1235
|
-
export declare class
|
|
1235
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1236
1236
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1237
1237
|
}
|
|
1238
|
-
export declare class
|
|
1238
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1239
1239
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1240
1240
|
}
|
|
1241
|
-
export declare class
|
|
1241
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1242
1242
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1243
1243
|
}
|
|
1244
|
-
export declare class
|
|
1244
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1245
1245
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1246
1246
|
}
|
|
1247
|
-
export declare class
|
|
1247
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1248
1248
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1249
1249
|
}
|
|
1250
|
-
export declare class
|
|
1250
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1251
1251
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1252
1252
|
}
|
|
1253
|
-
export declare class
|
|
1253
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1254
1254
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1255
1255
|
}
|
|
1256
|
-
export declare class
|
|
1256
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1257
1257
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1258
1258
|
}
|
|
1259
|
-
export declare class
|
|
1259
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1260
1260
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1261
1261
|
}
|
|
1262
|
-
export declare class
|
|
1262
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1263
1263
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1264
1264
|
}
|
|
1265
|
-
export declare class
|
|
1265
|
+
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1266
1266
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1267
1267
|
}
|
|
1268
|
-
export declare class
|
|
1268
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1269
1269
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1270
1270
|
}
|
|
1271
|
-
export declare class
|
|
1271
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1272
1272
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1273
1273
|
}
|
|
1274
|
-
export declare class
|
|
1274
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1275
1275
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1276
1276
|
}
|
|
1277
|
-
export declare class
|
|
1277
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1278
1278
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1279
1279
|
}
|
|
1280
1280
|
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1281
1281
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1282
1282
|
}
|
|
1283
|
-
export declare class
|
|
1283
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1284
1284
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1285
1285
|
}
|
|
1286
|
-
export declare class
|
|
1286
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1287
1287
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1288
1288
|
}
|
|
1289
|
-
export declare class
|
|
1289
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1290
1290
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1291
1291
|
}
|
|
1292
|
-
export declare class
|
|
1292
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1293
1293
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1294
1294
|
}
|
|
1295
1295
|
//# sourceMappingURL=restclient.d.ts.map
|