@openremote/rest 1.30.0 → 1.30.1
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/build/dist/umd/index.bundle.js +1 -0
- package/build/dist/umd/index.js +1 -0
- package/build/lib/index.d.ts.map +1 -0
- package/build/lib/index.js.map +1 -0
- package/{lib → build/lib}/restclient.d.ts +617 -617
- package/build/lib/restclient.d.ts.map +1 -0
- package/build/lib/restclient.js +1 -0
- package/build/lib/restclient.js.map +1 -0
- package/package.json +12 -12
- package/dist/umd/index.bundle.js +0 -1
- package/dist/umd/index.js +0 -1
- package/lib/index.d.ts.map +0 -1
- package/lib/index.js.map +0 -1
- package/lib/restclient.d.ts.map +0 -1
- package/lib/restclient.js +0 -1
- package/lib/restclient.js.map +0 -1
- /package/{lib → build/lib}/index.d.ts +0 -0
- /package/{lib → build/lib}/index.js +0 -0
|
@@ -79,69 +79,162 @@ This operation does not remove existing links from the alarm.
|
|
|
79
79
|
realm?: string;
|
|
80
80
|
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
81
81
|
}
|
|
82
|
-
export declare class
|
|
82
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
83
83
|
protected httpClient: HttpClient<O>;
|
|
84
84
|
constructor(httpClient: HttpClient<O>);
|
|
85
85
|
/**
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
86
|
+
* Requests a TCP tunnel through a connected gateway and returns its allocated local endpoint. When realm is omitted, the authenticated realm is used.
|
|
87
|
+
* Response code 417 - The gateway could not establish the requested tunnel
|
|
88
|
+
* HTTP POST /gateway/tunnel
|
|
89
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
89
90
|
*/
|
|
90
|
-
|
|
91
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
91
92
|
/**
|
|
92
|
-
*
|
|
93
|
-
* HTTP
|
|
94
|
-
* Java method: org.openremote.model.
|
|
93
|
+
* Stops the tunnel identified by the supplied gateway, target, and port information. When realm is omitted, the authenticated realm is used.
|
|
94
|
+
* HTTP DELETE /gateway/tunnel
|
|
95
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
95
96
|
*/
|
|
96
|
-
|
|
97
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
97
98
|
/**
|
|
98
|
-
*
|
|
99
|
-
* HTTP GET /
|
|
100
|
-
* Java method: org.openremote.model.
|
|
99
|
+
* Returns active tunnels for all gateway assets in the requested realm. Restricted users cannot list an entire realm.
|
|
100
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
101
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
101
102
|
*/
|
|
102
|
-
|
|
103
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
104
|
+
/**
|
|
105
|
+
* Returns active tunnels for one gateway asset. Restricted users may query only a linked gateway.
|
|
106
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
107
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
108
|
+
*/
|
|
109
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
110
|
+
/**
|
|
111
|
+
* Returns the tunnel matching realm, gateway, target host, and target port, or null when no active tunnel matches.
|
|
112
|
+
* Response code 204 - No active tunnel matches the requested endpoint
|
|
113
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
114
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
115
|
+
*/
|
|
116
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
117
|
+
}
|
|
118
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
119
|
+
protected httpClient: HttpClient<O>;
|
|
120
|
+
constructor(httpClient: HttpClient<O>);
|
|
121
|
+
/**
|
|
122
|
+
* Queries predicted values for one attribute using the supplied time-range and aggregation criteria. Anonymous access requires public-read access on both asset and attribute.
|
|
123
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
124
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
125
|
+
*/
|
|
126
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
127
|
+
/**
|
|
128
|
+
* Replaces or adds predicted values for one attribute. Anonymous access is allowed only when the asset and attribute are public-write; authenticated callers require attribute-write access.
|
|
129
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
130
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
131
|
+
*/
|
|
132
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
133
|
+
}
|
|
134
|
+
export declare class AgentResourceClient<O> {
|
|
135
|
+
protected httpClient: HttpClient<O>;
|
|
136
|
+
constructor(httpClient: HttpClient<O>);
|
|
137
|
+
/**
|
|
138
|
+
* 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.
|
|
139
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
140
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
141
|
+
*/
|
|
142
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
143
|
+
realm?: string;
|
|
144
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
145
|
+
/**
|
|
146
|
+
* Decodes the supplied FileInfo, asks the agent protocol to import it, persists the returned asset tree below the agent, and returns that tree.
|
|
147
|
+
* Response code 405 - The selected agent protocol does not support asset import
|
|
148
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
149
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
150
|
+
*/
|
|
151
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
152
|
+
realm?: string;
|
|
153
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
154
|
+
/**
|
|
155
|
+
* 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.
|
|
156
|
+
* Response code 415 - The selected agent protocol does not support instance discovery
|
|
157
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
158
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
159
|
+
*/
|
|
160
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
161
|
+
parentId?: string;
|
|
162
|
+
realm?: string;
|
|
163
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
164
|
+
}
|
|
165
|
+
export declare class StatusResourceClient<O> {
|
|
166
|
+
protected httpClient: HttpClient<O>;
|
|
167
|
+
constructor(httpClient: HttpClient<O>);
|
|
168
|
+
/**
|
|
169
|
+
* Returns health data keyed by registered health-provider name. A null provider result is represented as JSON null.
|
|
170
|
+
* HTTP GET /health
|
|
171
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
172
|
+
*/
|
|
173
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
174
|
+
[index: string]: any;
|
|
175
|
+
}>;
|
|
176
|
+
/**
|
|
177
|
+
* Returns public bootstrap information, including the Manager version and identity-provider URL.
|
|
178
|
+
* HTTP GET /info
|
|
179
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
180
|
+
*/
|
|
181
|
+
getInfo(options?: O): RestResponse<{
|
|
103
182
|
[index: string]: any;
|
|
104
183
|
}>;
|
|
105
184
|
}
|
|
106
|
-
export declare class
|
|
185
|
+
export declare class MapResourceClient<O> {
|
|
107
186
|
protected httpClient: HttpClient<O>;
|
|
108
187
|
constructor(httpClient: HttpClient<O>);
|
|
109
188
|
/**
|
|
110
|
-
*
|
|
111
|
-
* HTTP
|
|
112
|
-
* Java method: org.openremote.model.
|
|
189
|
+
* Returns realm-aware public MapLibre settings with externally reachable URLs derived from proxy headers.
|
|
190
|
+
* HTTP GET /map
|
|
191
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
113
192
|
*/
|
|
114
|
-
|
|
193
|
+
getSettings(options?: O): RestResponse<{
|
|
194
|
+
[id: string]: unknown;
|
|
195
|
+
}>;
|
|
115
196
|
/**
|
|
116
|
-
*
|
|
117
|
-
* HTTP PUT /
|
|
118
|
-
* Java method: org.openremote.model.
|
|
197
|
+
* Stores the map configuration and returns the resulting public MapLibre settings.
|
|
198
|
+
* HTTP PUT /map
|
|
199
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
119
200
|
*/
|
|
120
|
-
|
|
201
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
202
|
+
[id: string]: unknown;
|
|
203
|
+
}>;
|
|
121
204
|
/**
|
|
122
|
-
*
|
|
123
|
-
* HTTP
|
|
124
|
-
* Java method: org.openremote.model.
|
|
205
|
+
* Deletes the installed custom MBTiles database and returns the fallback public map settings.
|
|
206
|
+
* HTTP DELETE /map/deleteMap
|
|
207
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
125
208
|
*/
|
|
126
|
-
|
|
209
|
+
deleteMap(options?: O): RestResponse<{
|
|
210
|
+
[id: string]: unknown;
|
|
211
|
+
}>;
|
|
127
212
|
/**
|
|
128
|
-
*
|
|
129
|
-
* HTTP
|
|
130
|
-
* Java method: org.openremote.model.
|
|
213
|
+
* Reports whether custom MBTiles data is installed and the maximum accepted upload size.
|
|
214
|
+
* HTTP GET /map/getCustomMapInfo
|
|
215
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
131
216
|
*/
|
|
132
|
-
|
|
217
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
218
|
+
[id: string]: unknown;
|
|
219
|
+
}>;
|
|
133
220
|
/**
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
*
|
|
221
|
+
* Returns a pre-compressed Mapbox vector tile for the requested zoom, column, and row coordinates.
|
|
222
|
+
* Response code 200 - Gzip-compressed vector tile
|
|
223
|
+
* Response code 204 - No tile exists at the requested coordinates
|
|
224
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
225
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
137
226
|
*/
|
|
138
|
-
|
|
227
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
139
228
|
/**
|
|
140
|
-
*
|
|
141
|
-
* HTTP
|
|
142
|
-
* Java method: org.openremote.model.
|
|
229
|
+
* Stores the raw request body as the realm's custom MBTiles database and returns the resulting public map settings.
|
|
230
|
+
* HTTP POST /map/upload
|
|
231
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
143
232
|
*/
|
|
144
|
-
|
|
233
|
+
uploadMap(queryParams?: {
|
|
234
|
+
filename?: string;
|
|
235
|
+
}, options?: O): RestResponse<{
|
|
236
|
+
[id: string]: unknown;
|
|
237
|
+
}>;
|
|
145
238
|
}
|
|
146
239
|
export declare class SyslogResourceClient<O> {
|
|
147
240
|
protected httpClient: HttpClient<O>;
|
|
@@ -180,48 +273,98 @@ export declare class SyslogResourceClient<O> {
|
|
|
180
273
|
subCategory?: string[];
|
|
181
274
|
}, options?: O): RestResponse<any>;
|
|
182
275
|
}
|
|
183
|
-
export declare class
|
|
276
|
+
export declare class DashboardResourceClient<O> {
|
|
184
277
|
protected httpClient: HttpClient<O>;
|
|
185
278
|
constructor(httpClient: HttpClient<O>);
|
|
186
279
|
/**
|
|
187
|
-
*
|
|
188
|
-
* HTTP
|
|
189
|
-
* Java method: org.openremote.model.
|
|
280
|
+
* Creates a dashboard in an accessible realm. The server assigns the authenticated user as owner and initially stores the dashboard with shared access.
|
|
281
|
+
* HTTP POST /dashboard
|
|
282
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
190
283
|
*/
|
|
191
|
-
|
|
192
|
-
realm?: string[];
|
|
193
|
-
}, options?: O): RestResponse<void>;
|
|
284
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
194
285
|
/**
|
|
195
|
-
*
|
|
196
|
-
* HTTP
|
|
197
|
-
* Java method: org.openremote.model.
|
|
286
|
+
* Updates an existing dashboard when the authenticated user can modify it in the dashboard's realm.
|
|
287
|
+
* HTTP PUT /dashboard
|
|
288
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
198
289
|
*/
|
|
199
|
-
|
|
290
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
200
291
|
/**
|
|
201
|
-
*
|
|
202
|
-
* HTTP
|
|
203
|
-
* Java method: org.openremote.model.
|
|
292
|
+
* 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.
|
|
293
|
+
* HTTP GET /dashboard/all/{realm}
|
|
294
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
204
295
|
*/
|
|
205
|
-
|
|
296
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
206
297
|
/**
|
|
207
|
-
*
|
|
208
|
-
*
|
|
209
|
-
*
|
|
210
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
298
|
+
* 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.
|
|
299
|
+
* HTTP POST /dashboard/query
|
|
300
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
211
301
|
*/
|
|
212
|
-
|
|
302
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
213
303
|
/**
|
|
214
|
-
*
|
|
215
|
-
* HTTP
|
|
216
|
-
* Java method: org.openremote.model.
|
|
304
|
+
* Permanently removes a dashboard when the authenticated user can modify it in the requested realm.
|
|
305
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
306
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
217
307
|
*/
|
|
218
|
-
|
|
308
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
219
309
|
/**
|
|
220
|
-
* Returns
|
|
221
|
-
* HTTP GET /
|
|
222
|
-
* Java method: org.openremote.model.
|
|
310
|
+
* Returns one dashboard only when it is visible to the caller. Inaccessible and nonexistent dashboards both return 404 to avoid disclosing their existence.
|
|
311
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
312
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
223
313
|
*/
|
|
224
|
-
|
|
314
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
315
|
+
}
|
|
316
|
+
export declare class FlowResourceClient<O> {
|
|
317
|
+
protected httpClient: HttpClient<O>;
|
|
318
|
+
constructor(httpClient: HttpClient<O>);
|
|
319
|
+
/**
|
|
320
|
+
* Returns every supported flow node definition except the internal LOG_OUTPUT node.
|
|
321
|
+
* HTTP GET /flow
|
|
322
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
323
|
+
*/
|
|
324
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
325
|
+
/**
|
|
326
|
+
* Resolves one flow node definition by its model name.
|
|
327
|
+
* HTTP GET /flow/{name}
|
|
328
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
329
|
+
*/
|
|
330
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
331
|
+
/**
|
|
332
|
+
* Returns supported flow node definitions whose category matches the requested node type.
|
|
333
|
+
* HTTP GET /flow/{type}
|
|
334
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
335
|
+
*/
|
|
336
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
337
|
+
}
|
|
338
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
339
|
+
protected httpClient: HttpClient<O>;
|
|
340
|
+
constructor(httpClient: HttpClient<O>);
|
|
341
|
+
/**
|
|
342
|
+
* 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.
|
|
343
|
+
* Response code 200 - A ZIP archive containing the exported data
|
|
344
|
+
* HTTP GET /asset/datapoint/export
|
|
345
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
346
|
+
*/
|
|
347
|
+
getDatapointExport(queryParams?: {
|
|
348
|
+
attributeRefs?: string;
|
|
349
|
+
fromTimestamp?: number;
|
|
350
|
+
toTimestamp?: number;
|
|
351
|
+
format?: Model.DatapointExportFormat;
|
|
352
|
+
}, options?: O): RestResponse<any>;
|
|
353
|
+
/**
|
|
354
|
+
* 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.
|
|
355
|
+
* HTTP GET /asset/datapoint/periods
|
|
356
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
357
|
+
*/
|
|
358
|
+
getDatapointPeriod(queryParams?: {
|
|
359
|
+
assetId?: string;
|
|
360
|
+
attributeName?: string;
|
|
361
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
362
|
+
/**
|
|
363
|
+
* 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.
|
|
364
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
365
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
366
|
+
*/
|
|
367
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
225
368
|
}
|
|
226
369
|
export declare class UserResourceClient<O> {
|
|
227
370
|
protected httpClient: HttpClient<O>;
|
|
@@ -361,70 +504,248 @@ export declare class UserResourceClient<O> {
|
|
|
361
504
|
* HTTP GET /user/{realm}/{clientId}/roles
|
|
362
505
|
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
363
506
|
*/
|
|
364
|
-
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
507
|
+
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
508
|
+
/**
|
|
509
|
+
* Creates, updates, or removes role definitions for a named identity-provider client.
|
|
510
|
+
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
511
|
+
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
512
|
+
*/
|
|
513
|
+
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
514
|
+
/**
|
|
515
|
+
* Returns one user when it belongs to the requested accessible realm. Without read-admin permission, callers may retrieve only their own user.
|
|
516
|
+
* HTTP GET /user/{realm}/{userId}
|
|
517
|
+
* Java method: org.openremote.model.security.UserResource.get
|
|
518
|
+
*/
|
|
519
|
+
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
520
|
+
}
|
|
521
|
+
export declare class AssetModelResourceClient<O> {
|
|
522
|
+
protected httpClient: HttpClient<O>;
|
|
523
|
+
constructor(httpClient: HttpClient<O>);
|
|
524
|
+
/**
|
|
525
|
+
* Returns the descriptors used to construct supported asset types, using a gateway model when the optional parent context resolves below a gateway.
|
|
526
|
+
* HTTP GET /model/assetDescriptors
|
|
527
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
528
|
+
*/
|
|
529
|
+
getAssetDescriptors(queryParams?: {
|
|
530
|
+
parentId?: string;
|
|
531
|
+
parentType?: string;
|
|
532
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
533
|
+
/**
|
|
534
|
+
* 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.
|
|
535
|
+
* Response code 204 - No model information is available for the requested asset type
|
|
536
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
537
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
538
|
+
*/
|
|
539
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
540
|
+
parentId?: string;
|
|
541
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
542
|
+
/**
|
|
543
|
+
* 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.
|
|
544
|
+
* HTTP GET /model/assetInfos
|
|
545
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
546
|
+
*/
|
|
547
|
+
getAssetInfos(queryParams?: {
|
|
548
|
+
parentId?: string;
|
|
549
|
+
parentType?: string;
|
|
550
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
551
|
+
/**
|
|
552
|
+
* 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.
|
|
553
|
+
* Response code 200 - The current JSON Schema
|
|
554
|
+
* Response code 304 - The supplied ETag still identifies the current schema
|
|
555
|
+
* HTTP GET /model/getValueDescriptorSchema
|
|
556
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
|
|
557
|
+
*/
|
|
558
|
+
getValueDescriptorSchema(queryParams?: {
|
|
559
|
+
name?: string;
|
|
560
|
+
}, options?: O): RestResponse<any>;
|
|
561
|
+
/**
|
|
562
|
+
* Returns attribute metadata descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
|
|
563
|
+
* HTTP GET /model/metaItemDescriptors
|
|
564
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
565
|
+
*/
|
|
566
|
+
getMetaItemDescriptors(queryParams?: {
|
|
567
|
+
parentId?: string;
|
|
568
|
+
}, options?: O): RestResponse<{
|
|
569
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
570
|
+
}>;
|
|
571
|
+
/**
|
|
572
|
+
* Returns attribute value descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
|
|
573
|
+
* HTTP GET /model/valueDescriptors
|
|
574
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
575
|
+
*/
|
|
576
|
+
getValueDescriptors(queryParams?: {
|
|
577
|
+
parentId?: string;
|
|
578
|
+
}, options?: O): RestResponse<{
|
|
579
|
+
[index: string]: Model.ValueDescriptor;
|
|
580
|
+
}>;
|
|
581
|
+
}
|
|
582
|
+
export declare class ProvisioningResourceClient<O> {
|
|
583
|
+
protected httpClient: HttpClient<O>;
|
|
584
|
+
constructor(httpClient: HttpClient<O>);
|
|
585
|
+
/**
|
|
586
|
+
* Persists a new provisioning configuration and returns its generated numeric identifier. This operation is restricted to a super administrator.
|
|
587
|
+
* HTTP POST /provisioning
|
|
588
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
589
|
+
*/
|
|
590
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
591
|
+
/**
|
|
592
|
+
* Returns every provisioning configuration. This operation is restricted to a super administrator.
|
|
593
|
+
* HTTP GET /provisioning
|
|
594
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
595
|
+
*/
|
|
596
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
597
|
+
/**
|
|
598
|
+
* Permanently removes the provisioning configuration identified by the path. This operation is restricted to a super administrator.
|
|
599
|
+
* HTTP DELETE /provisioning/{id}
|
|
600
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
601
|
+
*/
|
|
602
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
603
|
+
/**
|
|
604
|
+
* Replaces the provisioning configuration identified by the path. This operation is restricted to a super administrator.
|
|
605
|
+
* HTTP PUT /provisioning/{id}
|
|
606
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
607
|
+
*/
|
|
608
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
609
|
+
}
|
|
610
|
+
export declare class AssetResourceClient<O> {
|
|
611
|
+
protected httpClient: HttpClient<O>;
|
|
612
|
+
constructor(httpClient: HttpClient<O>);
|
|
613
|
+
/**
|
|
614
|
+
* Creates an asset in an accessible realm and returns the persisted representation. The server generates an ID when absent; supplied IDs must be globally unique and 22 characters long.
|
|
615
|
+
* HTTP POST /asset
|
|
616
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
617
|
+
*/
|
|
618
|
+
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
619
|
+
/**
|
|
620
|
+
* Permanently deletes every asset identified by repeated assetId query parameters, subject to realm and restricted-user access rules.
|
|
621
|
+
* HTTP DELETE /asset
|
|
622
|
+
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
623
|
+
*/
|
|
624
|
+
delete(queryParams?: {
|
|
625
|
+
assetId?: string[];
|
|
626
|
+
}, options?: O): RestResponse<void>;
|
|
627
|
+
/**
|
|
628
|
+
* Submits a batch of attribute states using current server time and returns one result per input item. Authorization and processing failures are encoded in each AttributeWriteResult rather than returned as an HTTP error.
|
|
629
|
+
* HTTP PUT /asset/attributes
|
|
630
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
631
|
+
*/
|
|
632
|
+
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
633
|
+
/**
|
|
634
|
+
* Submits a batch of complete attribute events and returns one result per input item. Supplied timestamps are preserved; authorization and processing failures are encoded per result rather than returned as an HTTP error.
|
|
635
|
+
* HTTP PUT /asset/attributes/timestamp
|
|
636
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
637
|
+
*/
|
|
638
|
+
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
639
|
+
/**
|
|
640
|
+
* Returns only the number of assets matching an AssetQuery after applying the caller's realm, public, and linked-asset access constraints.
|
|
641
|
+
* HTTP POST /asset/count
|
|
642
|
+
* Java method: org.openremote.model.asset.AssetResource.queryCount
|
|
643
|
+
*/
|
|
644
|
+
queryCount(query: Model.AssetQuery, options?: O): RestResponse<number>;
|
|
645
|
+
/**
|
|
646
|
+
* Clears the parent reference of every asset listed in repeated assetIds query parameters.
|
|
647
|
+
* HTTP DELETE /asset/parent
|
|
648
|
+
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
649
|
+
*/
|
|
650
|
+
updateNoneParent(queryParams?: {
|
|
651
|
+
assetIds?: string[];
|
|
652
|
+
}, options?: O): RestResponse<void>;
|
|
653
|
+
/**
|
|
654
|
+
* Returns the asset identity and properties without loading attributes or path data. The same access rules as getAsset apply.
|
|
655
|
+
* HTTP GET /asset/partial/{assetId}
|
|
656
|
+
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
657
|
+
*/
|
|
658
|
+
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
659
|
+
/**
|
|
660
|
+
* Executes an AssetQuery after constraining realm and linked-asset access. Anonymous callers receive public-readable assets only; the query select clause controls which fields are populated.
|
|
661
|
+
* HTTP POST /asset/query
|
|
662
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
663
|
+
*/
|
|
664
|
+
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
665
|
+
/**
|
|
666
|
+
* Applies the same authorization and selection rules as queryAssets, then returns a hierarchy optimized for tree display rather than a flat asset array.
|
|
667
|
+
* HTTP POST /asset/tree
|
|
668
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssetTree
|
|
669
|
+
*/
|
|
670
|
+
queryAssetTree(query: Model.AssetQuery, options?: O): RestResponse<Model.AssetTree>;
|
|
671
|
+
/**
|
|
672
|
+
* Returns partial linked assets for a restricted user, root assets for an unrestricted realm user, and an empty array for a super user. Attributes and paths are omitted; use getAsset for full details.
|
|
673
|
+
* HTTP GET /asset/user/current
|
|
674
|
+
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
675
|
+
*/
|
|
676
|
+
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
677
|
+
/**
|
|
678
|
+
* Creates all supplied links as one operation. Every item must identify the same realm and user, and every referenced realm, user, and asset must exist.
|
|
679
|
+
* HTTP POST /asset/user/link
|
|
680
|
+
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
681
|
+
*/
|
|
682
|
+
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
683
|
+
/**
|
|
684
|
+
* Returns user-asset links in the required realm, optionally filtered by userId and assetId. Missing users or assets produce an empty result; restricted users cannot call this operation.
|
|
685
|
+
* HTTP GET /asset/user/link
|
|
686
|
+
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
687
|
+
*/
|
|
688
|
+
getUserAssetLinks(queryParams?: {
|
|
689
|
+
realm?: string;
|
|
690
|
+
userId?: string;
|
|
691
|
+
assetId?: string;
|
|
692
|
+
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
693
|
+
/**
|
|
694
|
+
* Removes all supplied links. Every item must identify the same realm and user.
|
|
695
|
+
* HTTP POST /asset/user/link/delete
|
|
696
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
697
|
+
*/
|
|
698
|
+
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
365
699
|
/**
|
|
366
|
-
*
|
|
367
|
-
* HTTP
|
|
368
|
-
* Java method: org.openremote.model.
|
|
700
|
+
* Removes every asset link belonging to the user in the requested realm.
|
|
701
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
702
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
369
703
|
*/
|
|
370
|
-
|
|
704
|
+
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
371
705
|
/**
|
|
372
|
-
*
|
|
373
|
-
* HTTP
|
|
374
|
-
* Java method: org.openremote.model.
|
|
706
|
+
* Removes the link identified by realm, user, and asset. The caller must be allowed to administer asset links in that realm.
|
|
707
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
708
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
375
709
|
*/
|
|
376
|
-
|
|
377
|
-
}
|
|
378
|
-
export declare class AgentResourceClient<O> {
|
|
379
|
-
protected httpClient: HttpClient<O>;
|
|
380
|
-
constructor(httpClient: HttpClient<O>);
|
|
710
|
+
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
381
711
|
/**
|
|
382
|
-
*
|
|
383
|
-
* HTTP GET /
|
|
384
|
-
* Java method: org.openremote.model.asset.
|
|
712
|
+
* Returns a fully loaded asset including its path and attributes. Access is constrained to the caller's realm and, for restricted users, linked assets.
|
|
713
|
+
* HTTP GET /asset/{assetId}
|
|
714
|
+
* Java method: org.openremote.model.asset.AssetResource.get
|
|
385
715
|
*/
|
|
386
|
-
|
|
387
|
-
realm?: string;
|
|
388
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
716
|
+
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
389
717
|
/**
|
|
390
|
-
*
|
|
391
|
-
*
|
|
392
|
-
*
|
|
393
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
718
|
+
* Replaces mutable asset data while preserving the path identifier. Realm, parent, restricted-user, and private-metadata rules are validated; disallowed restricted-user fields may be ignored.
|
|
719
|
+
* HTTP PUT /asset/{assetId}
|
|
720
|
+
* Java method: org.openremote.model.asset.AssetResource.update
|
|
394
721
|
*/
|
|
395
|
-
|
|
396
|
-
realm?: string;
|
|
397
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
722
|
+
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
398
723
|
/**
|
|
399
|
-
*
|
|
400
|
-
* Response code
|
|
401
|
-
*
|
|
402
|
-
*
|
|
724
|
+
* Submits an asynchronous attribute write using the current server time. The result reports whether the event was accepted, not whether downstream processing ultimately succeeded. Anonymous writes require public-write metadata.
|
|
725
|
+
* Response code 400 - The attribute write failed
|
|
726
|
+
* Response code 406 - The supplied value is not valid for the attribute
|
|
727
|
+
* Response code 429 - The attribute event queue is full; retry the write later
|
|
728
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
729
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
403
730
|
*/
|
|
404
|
-
|
|
405
|
-
parentId?: string;
|
|
406
|
-
realm?: string;
|
|
407
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
408
|
-
}
|
|
409
|
-
export declare class StatusResourceClient<O> {
|
|
410
|
-
protected httpClient: HttpClient<O>;
|
|
411
|
-
constructor(httpClient: HttpClient<O>);
|
|
731
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
412
732
|
/**
|
|
413
|
-
*
|
|
414
|
-
*
|
|
415
|
-
*
|
|
733
|
+
* Submits an asynchronous attribute write using the supplied Unix timestamp in milliseconds. The result reports acceptance only; anonymous writes require public-write metadata.
|
|
734
|
+
* Response code 400 - The attribute write failed
|
|
735
|
+
* Response code 406 - The supplied value is not valid for the attribute
|
|
736
|
+
* Response code 429 - The attribute event queue is full; retry the write later
|
|
737
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
738
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
416
739
|
*/
|
|
417
|
-
|
|
418
|
-
[index: string]: any;
|
|
419
|
-
}>;
|
|
740
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
420
741
|
/**
|
|
421
|
-
*
|
|
422
|
-
* HTTP
|
|
423
|
-
* Java method: org.openremote.model.
|
|
742
|
+
* Sets parentAssetId as the parent of every asset listed in repeated assetIds query parameters. Parent and children must satisfy realm, access, and hierarchy constraints.
|
|
743
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
744
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
424
745
|
*/
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
}>;
|
|
746
|
+
updateParent(parentAssetId: string, queryParams?: {
|
|
747
|
+
assetIds?: string[];
|
|
748
|
+
}, options?: O): RestResponse<void>;
|
|
428
749
|
}
|
|
429
750
|
export declare class RealmResourceClient<O> {
|
|
430
751
|
protected httpClient: HttpClient<O>;
|
|
@@ -468,27 +789,15 @@ export declare class RealmResourceClient<O> {
|
|
|
468
789
|
*/
|
|
469
790
|
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
470
791
|
}
|
|
471
|
-
export declare class
|
|
792
|
+
export declare class ConsoleResourceClient<O> {
|
|
472
793
|
protected httpClient: HttpClient<O>;
|
|
473
794
|
constructor(httpClient: HttpClient<O>);
|
|
474
795
|
/**
|
|
475
|
-
*
|
|
476
|
-
* HTTP
|
|
477
|
-
* Java method: org.openremote.model.
|
|
478
|
-
*/
|
|
479
|
-
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
480
|
-
/**
|
|
481
|
-
* Resolves one flow node definition by its model name.
|
|
482
|
-
* HTTP GET /flow/{name}
|
|
483
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
484
|
-
*/
|
|
485
|
-
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
486
|
-
/**
|
|
487
|
-
* Returns supported flow node definitions whose category matches the requested node type.
|
|
488
|
-
* HTTP GET /flow/{type}
|
|
489
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
796
|
+
* 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.
|
|
797
|
+
* HTTP POST /console/register
|
|
798
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
490
799
|
*/
|
|
491
|
-
|
|
800
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
492
801
|
}
|
|
493
802
|
export declare class RulesResourceClient<O> {
|
|
494
803
|
protected httpClient: HttpClient<O>;
|
|
@@ -538,257 +847,87 @@ export declare class RulesResourceClient<O> {
|
|
|
538
847
|
/**
|
|
539
848
|
* Replaces and redeploys one asset ruleset. The ID must match and an existing ruleset cannot be reassigned to another asset.
|
|
540
849
|
* HTTP PUT /rules/asset/{id}
|
|
541
|
-
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
542
|
-
*/
|
|
543
|
-
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
544
|
-
/**
|
|
545
|
-
* Extracts geofence definitions relevant to the asset. Anonymous access requires a public-readable asset; authenticated restricted users require an asset link.
|
|
546
|
-
* HTTP GET /rules/geofences/{assetId}
|
|
547
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
548
|
-
*/
|
|
549
|
-
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
550
|
-
/**
|
|
551
|
-
* Returns runtime status and error counts for an accessible asset engine. Returns null when the asset or its engine does not exist.
|
|
552
|
-
* Response code 204 - The asset or its rules engine does not exist
|
|
553
|
-
* HTTP GET /rules/info/asset/{assetId}
|
|
554
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
555
|
-
*/
|
|
556
|
-
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
557
|
-
/**
|
|
558
|
-
* 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.
|
|
559
|
-
* Response code 204 - The global rules engine is not running
|
|
560
|
-
* HTTP GET /rules/info/global
|
|
561
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
562
|
-
*/
|
|
563
|
-
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
564
|
-
/**
|
|
565
|
-
* 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.
|
|
566
|
-
* Response code 204 - The requested realm rules engine is not running
|
|
567
|
-
* HTTP GET /rules/info/realm/{realm}
|
|
568
|
-
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
569
|
-
*/
|
|
570
|
-
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
571
|
-
/**
|
|
572
|
-
* 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.
|
|
573
|
-
* HTTP POST /rules/realm
|
|
574
|
-
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
575
|
-
*/
|
|
576
|
-
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
577
|
-
/**
|
|
578
|
-
* Returns realm rulesets filtered by language. Anonymous, restricted, or callers without read-rules permission receive public rulesets only; fullyPopulate controls loading of rule source.
|
|
579
|
-
* HTTP GET /rules/realm/for/{realm}
|
|
580
|
-
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
581
|
-
*/
|
|
582
|
-
getRealmRulesets(realm: string, queryParams?: {
|
|
583
|
-
language?: Model.RulesetLang[];
|
|
584
|
-
fullyPopulate?: boolean;
|
|
585
|
-
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
586
|
-
/**
|
|
587
|
-
* Permanently removes and undeploys one ruleset from an accessible realm.
|
|
588
|
-
* HTTP DELETE /rules/realm/{id}
|
|
589
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
590
|
-
*/
|
|
591
|
-
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
592
|
-
/**
|
|
593
|
-
* Returns one fully populated realm ruleset when its realm is accessible to the caller.
|
|
594
|
-
* HTTP GET /rules/realm/{id}
|
|
595
|
-
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
596
|
-
*/
|
|
597
|
-
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
598
|
-
/**
|
|
599
|
-
* Replaces and redeploys one realm ruleset. Path and body IDs and the existing realm must match; legacy JavaScript cannot be updated.
|
|
600
|
-
* HTTP PUT /rules/realm/{id}
|
|
601
|
-
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
602
|
-
*/
|
|
603
|
-
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
604
|
-
/**
|
|
605
|
-
* Permanently removes and undeploys one global ruleset. Super-user access is required.
|
|
606
|
-
* HTTP DELETE /rules/{id}
|
|
607
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
608
|
-
*/
|
|
609
|
-
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
610
|
-
/**
|
|
611
|
-
* Returns one fully populated global ruleset including transient deployment status and errors. Super-user access is required.
|
|
612
|
-
* HTTP GET /rules/{id}
|
|
613
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
614
|
-
*/
|
|
615
|
-
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
616
|
-
/**
|
|
617
|
-
* Replaces and redeploys the identified global ruleset. Path and body IDs must match; legacy JavaScript rulesets cannot be updated.
|
|
618
|
-
* HTTP PUT /rules/{id}
|
|
619
|
-
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
620
|
-
*/
|
|
621
|
-
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
622
|
-
}
|
|
623
|
-
export declare class ConsoleResourceClient<O> {
|
|
624
|
-
protected httpClient: HttpClient<O>;
|
|
625
|
-
constructor(httpClient: HttpClient<O>);
|
|
626
|
-
/**
|
|
627
|
-
* 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.
|
|
628
|
-
* HTTP POST /console/register
|
|
629
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
630
|
-
*/
|
|
631
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
632
|
-
}
|
|
633
|
-
export declare class ProvisioningResourceClient<O> {
|
|
634
|
-
protected httpClient: HttpClient<O>;
|
|
635
|
-
constructor(httpClient: HttpClient<O>);
|
|
636
|
-
/**
|
|
637
|
-
* Persists a new provisioning configuration and returns its generated numeric identifier. This operation is restricted to a super administrator.
|
|
638
|
-
* HTTP POST /provisioning
|
|
639
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
640
|
-
*/
|
|
641
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
642
|
-
/**
|
|
643
|
-
* Returns every provisioning configuration. This operation is restricted to a super administrator.
|
|
644
|
-
* HTTP GET /provisioning
|
|
645
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
646
|
-
*/
|
|
647
|
-
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
648
|
-
/**
|
|
649
|
-
* Permanently removes the provisioning configuration identified by the path. This operation is restricted to a super administrator.
|
|
650
|
-
* HTTP DELETE /provisioning/{id}
|
|
651
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
652
|
-
*/
|
|
653
|
-
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
654
|
-
/**
|
|
655
|
-
* Replaces the provisioning configuration identified by the path. This operation is restricted to a super administrator.
|
|
656
|
-
* HTTP PUT /provisioning/{id}
|
|
657
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
658
|
-
*/
|
|
659
|
-
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
660
|
-
}
|
|
661
|
-
export declare class MapResourceClient<O> {
|
|
662
|
-
protected httpClient: HttpClient<O>;
|
|
663
|
-
constructor(httpClient: HttpClient<O>);
|
|
664
|
-
/**
|
|
665
|
-
* Returns realm-aware public MapLibre settings with externally reachable URLs derived from proxy headers.
|
|
666
|
-
* HTTP GET /map
|
|
667
|
-
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
668
|
-
*/
|
|
669
|
-
getSettings(options?: O): RestResponse<{
|
|
670
|
-
[id: string]: unknown;
|
|
671
|
-
}>;
|
|
672
|
-
/**
|
|
673
|
-
* Stores the map configuration and returns the resulting public MapLibre settings.
|
|
674
|
-
* HTTP PUT /map
|
|
675
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
676
|
-
*/
|
|
677
|
-
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
678
|
-
[id: string]: unknown;
|
|
679
|
-
}>;
|
|
680
|
-
/**
|
|
681
|
-
* Deletes the installed custom MBTiles database and returns the fallback public map settings.
|
|
682
|
-
* HTTP DELETE /map/deleteMap
|
|
683
|
-
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
684
|
-
*/
|
|
685
|
-
deleteMap(options?: O): RestResponse<{
|
|
686
|
-
[id: string]: unknown;
|
|
687
|
-
}>;
|
|
850
|
+
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
851
|
+
*/
|
|
852
|
+
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
688
853
|
/**
|
|
689
|
-
*
|
|
690
|
-
* HTTP GET /
|
|
691
|
-
* Java method: org.openremote.model.
|
|
854
|
+
* Extracts geofence definitions relevant to the asset. Anonymous access requires a public-readable asset; authenticated restricted users require an asset link.
|
|
855
|
+
* HTTP GET /rules/geofences/{assetId}
|
|
856
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
692
857
|
*/
|
|
693
|
-
|
|
694
|
-
[id: string]: unknown;
|
|
695
|
-
}>;
|
|
858
|
+
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
696
859
|
/**
|
|
697
|
-
* Returns
|
|
698
|
-
* Response code
|
|
699
|
-
*
|
|
700
|
-
*
|
|
701
|
-
* Java method: org.openremote.model.map.MapResource.getTile
|
|
860
|
+
* Returns runtime status and error counts for an accessible asset engine. Returns null when the asset or its engine does not exist.
|
|
861
|
+
* Response code 204 - The asset or its rules engine does not exist
|
|
862
|
+
* HTTP GET /rules/info/asset/{assetId}
|
|
863
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
702
864
|
*/
|
|
703
|
-
|
|
865
|
+
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
704
866
|
/**
|
|
705
|
-
*
|
|
706
|
-
*
|
|
707
|
-
*
|
|
867
|
+
* 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.
|
|
868
|
+
* Response code 204 - The global rules engine is not running
|
|
869
|
+
* HTTP GET /rules/info/global
|
|
870
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
708
871
|
*/
|
|
709
|
-
|
|
710
|
-
filename?: string;
|
|
711
|
-
}, options?: O): RestResponse<{
|
|
712
|
-
[id: string]: unknown;
|
|
713
|
-
}>;
|
|
714
|
-
}
|
|
715
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
716
|
-
protected httpClient: HttpClient<O>;
|
|
717
|
-
constructor(httpClient: HttpClient<O>);
|
|
872
|
+
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
718
873
|
/**
|
|
719
|
-
*
|
|
720
|
-
*
|
|
721
|
-
*
|
|
874
|
+
* 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.
|
|
875
|
+
* Response code 204 - The requested realm rules engine is not running
|
|
876
|
+
* HTTP GET /rules/info/realm/{realm}
|
|
877
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
722
878
|
*/
|
|
723
|
-
|
|
879
|
+
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
724
880
|
/**
|
|
725
|
-
*
|
|
726
|
-
* HTTP
|
|
727
|
-
* Java method: org.openremote.model.
|
|
881
|
+
* 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.
|
|
882
|
+
* HTTP POST /rules/realm
|
|
883
|
+
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
728
884
|
*/
|
|
729
|
-
|
|
730
|
-
}
|
|
731
|
-
export declare class ConfigurationResourceClient<O> {
|
|
732
|
-
protected httpClient: HttpClient<O>;
|
|
733
|
-
constructor(httpClient: HttpClient<O>);
|
|
885
|
+
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
734
886
|
/**
|
|
735
|
-
* Returns
|
|
736
|
-
* HTTP GET /
|
|
737
|
-
* Java method: org.openremote.model.
|
|
887
|
+
* Returns realm rulesets filtered by language. Anonymous, restricted, or callers without read-rules permission receive public rulesets only; fullyPopulate controls loading of rule source.
|
|
888
|
+
* HTTP GET /rules/realm/for/{realm}
|
|
889
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
738
890
|
*/
|
|
739
|
-
|
|
891
|
+
getRealmRulesets(realm: string, queryParams?: {
|
|
892
|
+
language?: Model.RulesetLang[];
|
|
893
|
+
fullyPopulate?: boolean;
|
|
894
|
+
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
740
895
|
/**
|
|
741
|
-
*
|
|
742
|
-
* HTTP
|
|
743
|
-
* Java method: org.openremote.model.
|
|
896
|
+
* Permanently removes and undeploys one ruleset from an accessible realm.
|
|
897
|
+
* HTTP DELETE /rules/realm/{id}
|
|
898
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
744
899
|
*/
|
|
745
|
-
|
|
900
|
+
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
746
901
|
/**
|
|
747
|
-
*
|
|
748
|
-
* HTTP
|
|
749
|
-
* Java method: org.openremote.model.
|
|
902
|
+
* Returns one fully populated realm ruleset when its realm is accessible to the caller.
|
|
903
|
+
* HTTP GET /rules/realm/{id}
|
|
904
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
750
905
|
*/
|
|
751
|
-
|
|
752
|
-
path?: string;
|
|
753
|
-
}, options?: O): RestResponse<string>;
|
|
906
|
+
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
754
907
|
/**
|
|
755
|
-
*
|
|
756
|
-
*
|
|
757
|
-
*
|
|
758
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
908
|
+
* Replaces and redeploys one realm ruleset. Path and body IDs and the existing realm must match; legacy JavaScript cannot be updated.
|
|
909
|
+
* HTTP PUT /rules/realm/{id}
|
|
910
|
+
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
759
911
|
*/
|
|
760
|
-
|
|
761
|
-
}
|
|
762
|
-
export declare class AssetDatapointResourceClient<O> {
|
|
763
|
-
protected httpClient: HttpClient<O>;
|
|
764
|
-
constructor(httpClient: HttpClient<O>);
|
|
912
|
+
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
765
913
|
/**
|
|
766
|
-
*
|
|
767
|
-
*
|
|
768
|
-
*
|
|
769
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
914
|
+
* Permanently removes and undeploys one global ruleset. Super-user access is required.
|
|
915
|
+
* HTTP DELETE /rules/{id}
|
|
916
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
770
917
|
*/
|
|
771
|
-
|
|
772
|
-
attributeRefs?: string;
|
|
773
|
-
fromTimestamp?: number;
|
|
774
|
-
toTimestamp?: number;
|
|
775
|
-
format?: Model.DatapointExportFormat;
|
|
776
|
-
}, options?: O): RestResponse<any>;
|
|
918
|
+
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
777
919
|
/**
|
|
778
|
-
* Returns
|
|
779
|
-
* HTTP GET /
|
|
780
|
-
* Java method: org.openremote.model.
|
|
920
|
+
* Returns one fully populated global ruleset including transient deployment status and errors. Super-user access is required.
|
|
921
|
+
* HTTP GET /rules/{id}
|
|
922
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
781
923
|
*/
|
|
782
|
-
|
|
783
|
-
assetId?: string;
|
|
784
|
-
attributeName?: string;
|
|
785
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
924
|
+
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
786
925
|
/**
|
|
787
|
-
*
|
|
788
|
-
* HTTP
|
|
789
|
-
* Java method: org.openremote.model.
|
|
926
|
+
* Replaces and redeploys the identified global ruleset. Path and body IDs must match; legacy JavaScript rulesets cannot be updated.
|
|
927
|
+
* HTTP PUT /rules/{id}
|
|
928
|
+
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
790
929
|
*/
|
|
791
|
-
|
|
930
|
+
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
792
931
|
}
|
|
793
932
|
export declare class NotificationResourceClient<O> {
|
|
794
933
|
protected httpClient: HttpClient<O>;
|
|
@@ -869,145 +1008,103 @@ export declare class NotificationResourceClient<O> {
|
|
|
869
1008
|
targetId?: string;
|
|
870
1009
|
}, options?: O): RestResponse<void>;
|
|
871
1010
|
}
|
|
872
|
-
export declare class
|
|
1011
|
+
export declare class ConfigurationResourceClient<O> {
|
|
873
1012
|
protected httpClient: HttpClient<O>;
|
|
874
1013
|
constructor(httpClient: HttpClient<O>);
|
|
875
1014
|
/**
|
|
876
|
-
*
|
|
877
|
-
* HTTP
|
|
878
|
-
* Java method: org.openremote.model.
|
|
879
|
-
*/
|
|
880
|
-
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
881
|
-
/**
|
|
882
|
-
* Permanently deletes every asset identified by repeated assetId query parameters, subject to realm and restricted-user access rules.
|
|
883
|
-
* HTTP DELETE /asset
|
|
884
|
-
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
1015
|
+
* Returns the public Manager application configuration used by clients before and after authentication.
|
|
1016
|
+
* HTTP GET /configuration/manager
|
|
1017
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
885
1018
|
*/
|
|
886
|
-
|
|
887
|
-
assetId?: string[];
|
|
888
|
-
}, options?: O): RestResponse<void>;
|
|
1019
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
889
1020
|
/**
|
|
890
|
-
*
|
|
891
|
-
* HTTP PUT /
|
|
892
|
-
* Java method: org.openremote.model.
|
|
1021
|
+
* Replaces manager_config.json and returns the stored configuration. This administrative change affects Manager UI branding and behavior.
|
|
1022
|
+
* HTTP PUT /configuration/manager
|
|
1023
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
893
1024
|
*/
|
|
894
|
-
|
|
1025
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
895
1026
|
/**
|
|
896
|
-
*
|
|
897
|
-
* HTTP
|
|
898
|
-
* Java method: org.openremote.model.
|
|
1027
|
+
* Decodes and stores the supplied FileInfo under the requested relative path, then returns its Manager API path.
|
|
1028
|
+
* HTTP POST /configuration/manager/file
|
|
1029
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
899
1030
|
*/
|
|
900
|
-
|
|
1031
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
1032
|
+
path?: string;
|
|
1033
|
+
}, options?: O): RestResponse<string>;
|
|
901
1034
|
/**
|
|
902
|
-
*
|
|
903
|
-
*
|
|
904
|
-
*
|
|
1035
|
+
* Streams a previously uploaded configuration image using its detected media type.
|
|
1036
|
+
* Response code 200 - The image file
|
|
1037
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
1038
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
905
1039
|
*/
|
|
906
|
-
|
|
1040
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
1041
|
+
}
|
|
1042
|
+
export declare class GatewayClientResourceClient<O> {
|
|
1043
|
+
protected httpClient: HttpClient<O>;
|
|
1044
|
+
constructor(httpClient: HttpClient<O>);
|
|
907
1045
|
/**
|
|
908
|
-
*
|
|
909
|
-
* HTTP DELETE /
|
|
910
|
-
* Java method: org.openremote.model.
|
|
1046
|
+
* Removes connections for all repeated realm query parameters. Deleting multiple realms is restricted to super users.
|
|
1047
|
+
* HTTP DELETE /gateway/connection
|
|
1048
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
911
1049
|
*/
|
|
912
|
-
|
|
913
|
-
|
|
1050
|
+
deleteConnections(queryParams?: {
|
|
1051
|
+
realm?: string[];
|
|
914
1052
|
}, options?: O): RestResponse<void>;
|
|
915
1053
|
/**
|
|
916
|
-
* Returns
|
|
917
|
-
* HTTP GET /
|
|
918
|
-
* Java method: org.openremote.model.
|
|
919
|
-
*/
|
|
920
|
-
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
921
|
-
/**
|
|
922
|
-
* Executes an AssetQuery after constraining realm and linked-asset access. Anonymous callers receive public-readable assets only; the query select clause controls which fields are populated.
|
|
923
|
-
* HTTP POST /asset/query
|
|
924
|
-
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
925
|
-
*/
|
|
926
|
-
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
927
|
-
/**
|
|
928
|
-
* Applies the same authorization and selection rules as queryAssets, then returns a hierarchy optimized for tree display rather than a flat asset array.
|
|
929
|
-
* HTTP POST /asset/tree
|
|
930
|
-
* Java method: org.openremote.model.asset.AssetResource.queryAssetTree
|
|
931
|
-
*/
|
|
932
|
-
queryAssetTree(query: Model.AssetQuery, options?: O): RestResponse<Model.AssetTree>;
|
|
933
|
-
/**
|
|
934
|
-
* Returns partial linked assets for a restricted user, root assets for an unrestricted realm user, and an empty array for a super user. Attributes and paths are omitted; use getAsset for full details.
|
|
935
|
-
* HTTP GET /asset/user/current
|
|
936
|
-
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
937
|
-
*/
|
|
938
|
-
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
939
|
-
/**
|
|
940
|
-
* Creates all supplied links as one operation. Every item must identify the same realm and user, and every referenced realm, user, and asset must exist.
|
|
941
|
-
* HTTP POST /asset/user/link
|
|
942
|
-
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
943
|
-
*/
|
|
944
|
-
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
945
|
-
/**
|
|
946
|
-
* Returns user-asset links in the required realm, optionally filtered by userId and assetId. Missing users or assets produce an empty result; restricted users cannot call this operation.
|
|
947
|
-
* HTTP GET /asset/user/link
|
|
948
|
-
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
949
|
-
*/
|
|
950
|
-
getUserAssetLinks(queryParams?: {
|
|
951
|
-
realm?: string;
|
|
952
|
-
userId?: string;
|
|
953
|
-
assetId?: string;
|
|
954
|
-
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
955
|
-
/**
|
|
956
|
-
* Removes all supplied links. Every item must identify the same realm and user.
|
|
957
|
-
* HTTP POST /asset/user/link/delete
|
|
958
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
1054
|
+
* Returns every configured central-manager connection. Unlike the single-realm endpoint, this operation is restricted to super users.
|
|
1055
|
+
* HTTP GET /gateway/connection
|
|
1056
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
959
1057
|
*/
|
|
960
|
-
|
|
1058
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
961
1059
|
/**
|
|
962
|
-
* Removes
|
|
963
|
-
* HTTP DELETE /
|
|
964
|
-
* Java method: org.openremote.model.
|
|
1060
|
+
* Removes the central-manager connection for one realm. Realm administrators can remove their own connection; super users can remove any connection.
|
|
1061
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
1062
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
965
1063
|
*/
|
|
966
|
-
|
|
967
|
-
/**
|
|
968
|
-
*
|
|
969
|
-
*
|
|
970
|
-
*
|
|
1064
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
1065
|
+
/**
|
|
1066
|
+
* 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.
|
|
1067
|
+
* Response code 204 - No gateway connection is configured for the realm
|
|
1068
|
+
* HTTP GET /gateway/connection/{realm}
|
|
1069
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
971
1070
|
*/
|
|
972
|
-
|
|
1071
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
973
1072
|
/**
|
|
974
|
-
*
|
|
975
|
-
* HTTP
|
|
976
|
-
* Java method: org.openremote.model.
|
|
1073
|
+
* 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.
|
|
1074
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
1075
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
977
1076
|
*/
|
|
978
|
-
|
|
1077
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
979
1078
|
/**
|
|
980
|
-
*
|
|
981
|
-
* HTTP
|
|
982
|
-
* Java method: org.openremote.model.
|
|
1079
|
+
* Returns the live connection state for the requested local realm.
|
|
1080
|
+
* HTTP GET /gateway/status/{realm}
|
|
1081
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
983
1082
|
*/
|
|
984
|
-
|
|
1083
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
1084
|
+
}
|
|
1085
|
+
export declare class AppResourceClient<O> {
|
|
1086
|
+
protected httpClient: HttpClient<O>;
|
|
1087
|
+
constructor(httpClient: HttpClient<O>);
|
|
985
1088
|
/**
|
|
986
|
-
*
|
|
987
|
-
*
|
|
988
|
-
*
|
|
989
|
-
* Response code 429 - The attribute event queue is full; retry the write later
|
|
990
|
-
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
991
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
1089
|
+
* Returns the identifiers of applications installed in the Manager web root.
|
|
1090
|
+
* HTTP GET /apps
|
|
1091
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
992
1092
|
*/
|
|
993
|
-
|
|
1093
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
994
1094
|
/**
|
|
995
|
-
*
|
|
996
|
-
*
|
|
997
|
-
*
|
|
998
|
-
* Response code 429 - The attribute event queue is full; retry the write later
|
|
999
|
-
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
1000
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
1095
|
+
* Loads the public console_config.json document used to configure console clients before sign-in.
|
|
1096
|
+
* HTTP GET /apps/consoleConfig
|
|
1097
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
1001
1098
|
*/
|
|
1002
|
-
|
|
1099
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
1003
1100
|
/**
|
|
1004
|
-
*
|
|
1005
|
-
* HTTP
|
|
1006
|
-
* Java method: org.openremote.model.
|
|
1101
|
+
* Loads each installed application's info.json file and returns the documents keyed by application identifier.
|
|
1102
|
+
* HTTP GET /apps/info
|
|
1103
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
1007
1104
|
*/
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
}
|
|
1105
|
+
getAppInfos(options?: O): RestResponse<{
|
|
1106
|
+
[index: string]: any;
|
|
1107
|
+
}>;
|
|
1011
1108
|
}
|
|
1012
1109
|
export declare class ExternalServiceResourceClient<O> {
|
|
1013
1110
|
protected httpClient: HttpClient<O>;
|
|
@@ -1071,150 +1168,53 @@ export declare class ExternalServiceResourceClient<O> {
|
|
|
1071
1168
|
*/
|
|
1072
1169
|
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
1073
1170
|
}
|
|
1074
|
-
export declare class GatewayServiceResourceClient<O> {
|
|
1075
|
-
protected httpClient: HttpClient<O>;
|
|
1076
|
-
constructor(httpClient: HttpClient<O>);
|
|
1077
|
-
/**
|
|
1078
|
-
* Requests a TCP tunnel through a connected gateway and returns its allocated local endpoint. When realm is omitted, the authenticated realm is used.
|
|
1079
|
-
* Response code 417 - The gateway could not establish the requested tunnel
|
|
1080
|
-
* HTTP POST /gateway/tunnel
|
|
1081
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
1082
|
-
*/
|
|
1083
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
1084
|
-
/**
|
|
1085
|
-
* Stops the tunnel identified by the supplied gateway, target, and port information. When realm is omitted, the authenticated realm is used.
|
|
1086
|
-
* HTTP DELETE /gateway/tunnel
|
|
1087
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
1088
|
-
*/
|
|
1089
|
-
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
1090
|
-
/**
|
|
1091
|
-
* Returns active tunnels for all gateway assets in the requested realm. Restricted users cannot list an entire realm.
|
|
1092
|
-
* HTTP GET /gateway/tunnel/{realm}
|
|
1093
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
1094
|
-
*/
|
|
1095
|
-
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
1096
|
-
/**
|
|
1097
|
-
* Returns active tunnels for one gateway asset. Restricted users may query only a linked gateway.
|
|
1098
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
1099
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
1100
|
-
*/
|
|
1101
|
-
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
1102
|
-
/**
|
|
1103
|
-
* Returns the tunnel matching realm, gateway, target host, and target port, or null when no active tunnel matches.
|
|
1104
|
-
* Response code 204 - No active tunnel matches the requested endpoint
|
|
1105
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
1106
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
1107
|
-
*/
|
|
1108
|
-
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
1109
|
-
}
|
|
1110
|
-
export declare class AssetModelResourceClient<O> {
|
|
1111
|
-
protected httpClient: HttpClient<O>;
|
|
1112
|
-
constructor(httpClient: HttpClient<O>);
|
|
1113
|
-
/**
|
|
1114
|
-
* Returns the descriptors used to construct supported asset types, using a gateway model when the optional parent context resolves below a gateway.
|
|
1115
|
-
* HTTP GET /model/assetDescriptors
|
|
1116
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
1117
|
-
*/
|
|
1118
|
-
getAssetDescriptors(queryParams?: {
|
|
1119
|
-
parentId?: string;
|
|
1120
|
-
parentType?: string;
|
|
1121
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
1122
|
-
/**
|
|
1123
|
-
* 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.
|
|
1124
|
-
* Response code 204 - No model information is available for the requested asset type
|
|
1125
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
1126
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
1127
|
-
*/
|
|
1128
|
-
getAssetInfo(assetType: string, queryParams?: {
|
|
1129
|
-
parentId?: string;
|
|
1130
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
1131
|
-
/**
|
|
1132
|
-
* 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.
|
|
1133
|
-
* HTTP GET /model/assetInfos
|
|
1134
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
1135
|
-
*/
|
|
1136
|
-
getAssetInfos(queryParams?: {
|
|
1137
|
-
parentId?: string;
|
|
1138
|
-
parentType?: string;
|
|
1139
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
1140
|
-
/**
|
|
1141
|
-
* 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.
|
|
1142
|
-
* Response code 200 - The current JSON Schema
|
|
1143
|
-
* Response code 304 - The supplied ETag still identifies the current schema
|
|
1144
|
-
* HTTP GET /model/getValueDescriptorSchema
|
|
1145
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
|
|
1146
|
-
*/
|
|
1147
|
-
getValueDescriptorSchema(queryParams?: {
|
|
1148
|
-
name?: string;
|
|
1149
|
-
}, options?: O): RestResponse<any>;
|
|
1150
|
-
/**
|
|
1151
|
-
* Returns attribute metadata descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
|
|
1152
|
-
* HTTP GET /model/metaItemDescriptors
|
|
1153
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
1154
|
-
*/
|
|
1155
|
-
getMetaItemDescriptors(queryParams?: {
|
|
1156
|
-
parentId?: string;
|
|
1157
|
-
}, options?: O): RestResponse<{
|
|
1158
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
1159
|
-
}>;
|
|
1160
|
-
/**
|
|
1161
|
-
* Returns attribute value descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
|
|
1162
|
-
* HTTP GET /model/valueDescriptors
|
|
1163
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
1164
|
-
*/
|
|
1165
|
-
getValueDescriptors(queryParams?: {
|
|
1166
|
-
parentId?: string;
|
|
1167
|
-
}, options?: O): RestResponse<{
|
|
1168
|
-
[index: string]: Model.ValueDescriptor;
|
|
1169
|
-
}>;
|
|
1170
|
-
}
|
|
1171
1171
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
1172
1172
|
export declare class ApiClient {
|
|
1173
1173
|
protected _alarmResource: AxiosAlarmResourceClient;
|
|
1174
|
-
protected
|
|
1175
|
-
protected
|
|
1176
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
1177
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
1178
|
-
protected _userResource: AxiosUserResourceClient;
|
|
1174
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
1175
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
1179
1176
|
protected _agentResource: AxiosAgentResourceClient;
|
|
1180
1177
|
protected _statusResource: AxiosStatusResourceClient;
|
|
1181
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
1182
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
1183
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
1184
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
1185
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
1186
1178
|
protected _mapResource: AxiosMapResourceClient;
|
|
1187
|
-
protected
|
|
1188
|
-
protected
|
|
1179
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
1180
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
1181
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
1189
1182
|
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
1190
|
-
protected
|
|
1183
|
+
protected _userResource: AxiosUserResourceClient;
|
|
1184
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
1185
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
1191
1186
|
protected _assetResource: AxiosAssetResourceClient;
|
|
1187
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
1188
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
1189
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
1190
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
1191
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
1192
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
1193
|
+
protected _appResource: AxiosAppResourceClient;
|
|
1192
1194
|
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
1193
|
-
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
1194
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
1195
1195
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1196
1196
|
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1197
|
-
get
|
|
1198
|
-
get
|
|
1199
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
1200
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1201
|
-
get UserResource(): AxiosUserResourceClient;
|
|
1197
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1198
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
1202
1199
|
get AgentResource(): AxiosAgentResourceClient;
|
|
1203
1200
|
get StatusResource(): AxiosStatusResourceClient;
|
|
1204
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
1205
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
1206
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
1207
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
1208
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1209
1201
|
get MapResource(): AxiosMapResourceClient;
|
|
1210
|
-
get
|
|
1211
|
-
get
|
|
1202
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
1203
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
1204
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
1212
1205
|
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1213
|
-
get
|
|
1206
|
+
get UserResource(): AxiosUserResourceClient;
|
|
1207
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1208
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1214
1209
|
get AssetResource(): AxiosAssetResourceClient;
|
|
1210
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
1211
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
1212
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
1213
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
1214
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
1215
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1216
|
+
get AppResource(): AxiosAppResourceClient;
|
|
1215
1217
|
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
1216
|
-
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1217
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1218
1218
|
}
|
|
1219
1219
|
import * as Axios from "axios";
|
|
1220
1220
|
declare module "axios" {
|
|
@@ -1225,67 +1225,67 @@ declare module "axios" {
|
|
|
1225
1225
|
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1226
1226
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1227
1227
|
}
|
|
1228
|
-
export declare class
|
|
1228
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1229
1229
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1230
1230
|
}
|
|
1231
|
-
export declare class
|
|
1231
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1232
1232
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1233
1233
|
}
|
|
1234
|
-
export declare class
|
|
1234
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1235
1235
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1236
1236
|
}
|
|
1237
|
-
export declare class
|
|
1237
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1238
1238
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1239
1239
|
}
|
|
1240
|
-
export declare class
|
|
1240
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1241
1241
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1242
1242
|
}
|
|
1243
|
-
export declare class
|
|
1243
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1244
1244
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1245
1245
|
}
|
|
1246
|
-
export declare class
|
|
1246
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1247
1247
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1248
1248
|
}
|
|
1249
|
-
export declare class
|
|
1249
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1250
1250
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1251
1251
|
}
|
|
1252
|
-
export declare class
|
|
1252
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1253
1253
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1254
1254
|
}
|
|
1255
|
-
export declare class
|
|
1255
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1256
1256
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1257
1257
|
}
|
|
1258
|
-
export declare class
|
|
1258
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1259
1259
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1260
1260
|
}
|
|
1261
1261
|
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1262
1262
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1263
1263
|
}
|
|
1264
|
-
export declare class
|
|
1264
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1265
1265
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1266
1266
|
}
|
|
1267
|
-
export declare class
|
|
1267
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1268
1268
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1269
1269
|
}
|
|
1270
|
-
export declare class
|
|
1270
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1271
1271
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1272
1272
|
}
|
|
1273
|
-
export declare class
|
|
1273
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1274
1274
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1275
1275
|
}
|
|
1276
1276
|
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1277
1277
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1278
1278
|
}
|
|
1279
|
-
export declare class
|
|
1279
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1280
1280
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1281
1281
|
}
|
|
1282
|
-
export declare class
|
|
1282
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1283
1283
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1284
1284
|
}
|
|
1285
|
-
export declare class
|
|
1285
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1286
1286
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1287
1287
|
}
|
|
1288
|
-
export declare class
|
|
1288
|
+
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1289
1289
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1290
1290
|
}
|
|
1291
1291
|
//# sourceMappingURL=restclient.d.ts.map
|