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