@sermas/api-client 1.0.0-alpha.30 → 1.0.0-alpha.32
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/index.cjs +1 -1
- package/index.cjs.map +1 -1
- package/index.d.cts +1528 -1296
- package/index.d.ts +1528 -1296
- package/index.js +1 -1
- package/index.js.map +1 -1
- package/package.json +4 -5
package/index.d.ts
CHANGED
|
@@ -1,14 +1,15 @@
|
|
|
1
|
+
import { AxiosRequestConfig, AxiosResponse } from 'axios';
|
|
1
2
|
import mqtt from 'mqtt';
|
|
2
3
|
export { MqttClient } from 'mqtt';
|
|
3
4
|
|
|
4
5
|
type ApiRequestOptions = {
|
|
5
6
|
readonly method: 'GET' | 'PUT' | 'POST' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'PATCH';
|
|
6
7
|
readonly url: string;
|
|
7
|
-
readonly path?: Record<string,
|
|
8
|
-
readonly cookies?: Record<string,
|
|
9
|
-
readonly headers?: Record<string,
|
|
10
|
-
readonly query?: Record<string,
|
|
11
|
-
readonly formData?: Record<string,
|
|
8
|
+
readonly path?: Record<string, unknown>;
|
|
9
|
+
readonly cookies?: Record<string, unknown>;
|
|
10
|
+
readonly headers?: Record<string, unknown>;
|
|
11
|
+
readonly query?: Record<string, unknown>;
|
|
12
|
+
readonly formData?: Record<string, unknown>;
|
|
12
13
|
readonly body?: any;
|
|
13
14
|
readonly mediaType?: string;
|
|
14
15
|
readonly responseHeader?: string;
|
|
@@ -22,28 +23,48 @@ interface OnCancel {
|
|
|
22
23
|
(cancelHandler: () => void): void;
|
|
23
24
|
}
|
|
24
25
|
declare class CancelablePromise<T> implements Promise<T> {
|
|
25
|
-
|
|
26
|
-
|
|
26
|
+
private _isResolved;
|
|
27
|
+
private _isRejected;
|
|
28
|
+
private _isCancelled;
|
|
29
|
+
readonly cancelHandlers: (() => void)[];
|
|
30
|
+
readonly promise: Promise<T>;
|
|
31
|
+
private _resolve?;
|
|
32
|
+
private _reject?;
|
|
33
|
+
constructor(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: unknown) => void, onCancel: OnCancel) => void);
|
|
27
34
|
get [Symbol.toStringTag](): string;
|
|
28
|
-
then<TResult1 = T, TResult2 = never>(onFulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null, onRejected?: ((reason:
|
|
29
|
-
catch<TResult = never>(onRejected?: ((reason:
|
|
35
|
+
then<TResult1 = T, TResult2 = never>(onFulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null, onRejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
|
|
36
|
+
catch<TResult = never>(onRejected?: ((reason: unknown) => TResult | PromiseLike<TResult>) | null): Promise<T | TResult>;
|
|
30
37
|
finally(onFinally?: (() => void) | null): Promise<T>;
|
|
31
38
|
cancel(): void;
|
|
32
39
|
get isCancelled(): boolean;
|
|
33
40
|
}
|
|
34
41
|
|
|
35
|
-
type
|
|
42
|
+
type TResult = 'body' | 'raw';
|
|
43
|
+
|
|
36
44
|
type Headers = Record<string, string>;
|
|
45
|
+
type Middleware<T> = (value: T) => T | Promise<T>;
|
|
46
|
+
type Resolver<T> = (options: ApiRequestOptions) => Promise<T>;
|
|
47
|
+
declare class Interceptors<T> {
|
|
48
|
+
_fns: Middleware<T>[];
|
|
49
|
+
constructor();
|
|
50
|
+
eject(fn: Middleware<T>): void;
|
|
51
|
+
use(fn: Middleware<T>): void;
|
|
52
|
+
}
|
|
37
53
|
type OpenAPIConfig = {
|
|
38
54
|
BASE: string;
|
|
39
|
-
VERSION: string;
|
|
40
|
-
WITH_CREDENTIALS: boolean;
|
|
41
55
|
CREDENTIALS: 'include' | 'omit' | 'same-origin';
|
|
56
|
+
ENCODE_PATH?: ((path: string) => string) | undefined;
|
|
57
|
+
HEADERS?: Headers | Resolver<Headers> | undefined;
|
|
58
|
+
PASSWORD?: string | Resolver<string> | undefined;
|
|
59
|
+
RESULT?: TResult;
|
|
42
60
|
TOKEN?: string | Resolver<string> | undefined;
|
|
43
61
|
USERNAME?: string | Resolver<string> | undefined;
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
62
|
+
VERSION: string;
|
|
63
|
+
WITH_CREDENTIALS: boolean;
|
|
64
|
+
interceptors: {
|
|
65
|
+
request: Interceptors<AxiosRequestConfig>;
|
|
66
|
+
response: Interceptors<AxiosResponse>;
|
|
67
|
+
};
|
|
47
68
|
};
|
|
48
69
|
|
|
49
70
|
declare abstract class BaseHttpRequest {
|
|
@@ -52,7 +73,26 @@ declare abstract class BaseHttpRequest {
|
|
|
52
73
|
abstract request<T>(options: ApiRequestOptions): CancelablePromise<T>;
|
|
53
74
|
}
|
|
54
75
|
|
|
55
|
-
type
|
|
76
|
+
type PlatformSettingsDto = {
|
|
77
|
+
resources: Record<string, Array<string>>;
|
|
78
|
+
};
|
|
79
|
+
type AccessTokenRequestDto = {
|
|
80
|
+
appId?: string;
|
|
81
|
+
clientId: string;
|
|
82
|
+
clientSecret?: string;
|
|
83
|
+
};
|
|
84
|
+
type JwtTokenDto = {
|
|
85
|
+
access_token: string;
|
|
86
|
+
expires_in: number;
|
|
87
|
+
refresh_expires_in: number;
|
|
88
|
+
refresh_token: string;
|
|
89
|
+
token_type: string;
|
|
90
|
+
id_token: string;
|
|
91
|
+
'not-before-policy': number;
|
|
92
|
+
session_state: string;
|
|
93
|
+
scope: string;
|
|
94
|
+
};
|
|
95
|
+
type RefreshTokenRequestDto = {
|
|
56
96
|
appId: string;
|
|
57
97
|
/**
|
|
58
98
|
* Reference to the authenticated client the request originated from
|
|
@@ -62,201 +102,316 @@ type ActuationEventDto = {
|
|
|
62
102
|
* Reference to the user interacting with the system
|
|
63
103
|
*/
|
|
64
104
|
userId?: string;
|
|
65
|
-
|
|
105
|
+
refreshToken: string;
|
|
106
|
+
clientSecret?: string;
|
|
66
107
|
};
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
'z': number;
|
|
72
|
-
'w': number;
|
|
108
|
+
type Point3D = {
|
|
109
|
+
x: number;
|
|
110
|
+
y: number;
|
|
111
|
+
z: number;
|
|
73
112
|
};
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
'y': number;
|
|
78
|
-
'z': number;
|
|
113
|
+
type AvatarCameraConfig = {
|
|
114
|
+
position: Point3D;
|
|
115
|
+
rotation: Point3D;
|
|
79
116
|
};
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
117
|
+
type RepositoryAvatarModelDto = {
|
|
118
|
+
modelType: 'readyplayerme' | 'custom';
|
|
119
|
+
name: string;
|
|
120
|
+
modelPath: string;
|
|
121
|
+
gender: 'M' | 'F';
|
|
122
|
+
camera?: AvatarCameraConfig;
|
|
123
|
+
cameraMobile?: AvatarCameraConfig;
|
|
84
124
|
};
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
targetPosition: PoseDto;
|
|
88
|
-
personId: string;
|
|
89
|
-
path: Array<string>;
|
|
125
|
+
type RepositoryBackgroundMetadataDto = {
|
|
126
|
+
credits?: string;
|
|
90
127
|
};
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
128
|
+
type RepositoryBackgroundModelDto = {
|
|
129
|
+
name: string;
|
|
130
|
+
path: string;
|
|
131
|
+
metadata?: RepositoryBackgroundMetadataDto;
|
|
132
|
+
};
|
|
133
|
+
type RepositoryMapModelDto = {
|
|
134
|
+
imageUrl?: string;
|
|
135
|
+
width?: number;
|
|
136
|
+
height?: number;
|
|
137
|
+
originOffsetX?: number;
|
|
138
|
+
originOffsetY?: number;
|
|
139
|
+
};
|
|
140
|
+
type RepositoryRobotModelDto = {
|
|
141
|
+
name: string;
|
|
142
|
+
videoUrl: string;
|
|
143
|
+
map?: RepositoryMapModelDto;
|
|
144
|
+
};
|
|
145
|
+
type RepositoryConfigDto = {
|
|
146
|
+
avatars: Array<RepositoryAvatarModelDto>;
|
|
147
|
+
backgrounds: Array<RepositoryBackgroundModelDto>;
|
|
148
|
+
robots?: Array<RepositoryRobotModelDto>;
|
|
149
|
+
};
|
|
150
|
+
type KeycloakCredentials = {
|
|
151
|
+
credentialData: string;
|
|
152
|
+
temporary: boolean;
|
|
153
|
+
};
|
|
154
|
+
type AppUserDto = {
|
|
155
|
+
enabled: boolean;
|
|
156
|
+
username: string;
|
|
157
|
+
email: string;
|
|
158
|
+
emailVerified: boolean;
|
|
159
|
+
credentials: KeycloakCredentials;
|
|
160
|
+
realmRoles: Array<string>;
|
|
161
|
+
clientRoles: Array<string>;
|
|
162
|
+
groups: Array<string>;
|
|
163
|
+
password: string;
|
|
164
|
+
attributes: Record<string, unknown>;
|
|
165
|
+
appId?: string;
|
|
166
|
+
};
|
|
167
|
+
type ModuleResourceDto = {
|
|
94
168
|
/**
|
|
95
|
-
*
|
|
169
|
+
* Resource of the module operation
|
|
96
170
|
*/
|
|
97
|
-
|
|
171
|
+
resource: string;
|
|
98
172
|
/**
|
|
99
|
-
*
|
|
173
|
+
* Scope of the module operation
|
|
100
174
|
*/
|
|
101
|
-
|
|
102
|
-
movement: MovementDto;
|
|
103
|
-
};
|
|
104
|
-
|
|
105
|
-
type SermasBaseDto = {
|
|
106
|
-
appId: string;
|
|
175
|
+
scope: string;
|
|
107
176
|
/**
|
|
108
|
-
*
|
|
177
|
+
* Additional context, added to the request and event topic when triggered. Can contain variable substituted from the payload, such as :appId
|
|
109
178
|
*/
|
|
110
|
-
|
|
179
|
+
context?: Array<string>;
|
|
111
180
|
/**
|
|
112
|
-
*
|
|
181
|
+
* Name of the module operation
|
|
113
182
|
*/
|
|
114
|
-
|
|
115
|
-
};
|
|
116
|
-
|
|
117
|
-
type LinearVelocityDto = {};
|
|
118
|
-
|
|
119
|
-
type VelocityDto = {
|
|
120
|
-
linear: LinearVelocityDto;
|
|
121
|
-
angular: LinearVelocityDto;
|
|
122
|
-
};
|
|
123
|
-
|
|
124
|
-
type StatusDto = {
|
|
125
|
-
actualPosition: PoseDto;
|
|
126
|
-
velocity: VelocityDto;
|
|
127
|
-
};
|
|
128
|
-
|
|
129
|
-
type StatusEventDto = {
|
|
130
|
-
appId: string;
|
|
183
|
+
name?: string;
|
|
131
184
|
/**
|
|
132
|
-
*
|
|
185
|
+
* Description of the module operation
|
|
133
186
|
*/
|
|
134
|
-
|
|
187
|
+
description?: string;
|
|
135
188
|
/**
|
|
136
|
-
*
|
|
189
|
+
* Unique identifier of the module
|
|
137
190
|
*/
|
|
138
|
-
|
|
139
|
-
status: StatusDto;
|
|
140
|
-
robotId: string;
|
|
141
|
-
};
|
|
142
|
-
|
|
143
|
-
declare class AgentService {
|
|
144
|
-
readonly httpRequest: BaseHttpRequest;
|
|
145
|
-
constructor(httpRequest: BaseHttpRequest);
|
|
191
|
+
moduleId: string;
|
|
146
192
|
/**
|
|
147
|
-
*
|
|
148
|
-
* @param appId
|
|
149
|
-
* @param room
|
|
150
|
-
* @returns any
|
|
151
|
-
* @throws ApiError
|
|
193
|
+
* Operation to call from the module OpenAPI spec
|
|
152
194
|
*/
|
|
153
|
-
|
|
195
|
+
operationId: string;
|
|
154
196
|
/**
|
|
155
|
-
*
|
|
156
|
-
* @param appId
|
|
157
|
-
* @param robotId
|
|
158
|
-
* @returns any
|
|
159
|
-
* @throws ApiError
|
|
197
|
+
* Indicate if an event should be emitted when this module resource is triggered. The format is app/:appId/<resource>/<scope>/[...context]
|
|
160
198
|
*/
|
|
161
|
-
|
|
199
|
+
emitEvent?: boolean;
|
|
200
|
+
};
|
|
201
|
+
type ModuleSettingsDto = {
|
|
162
202
|
/**
|
|
163
|
-
*
|
|
164
|
-
* @param requestBody
|
|
165
|
-
* @returns any
|
|
166
|
-
* @throws ApiError
|
|
203
|
+
* Service URL used to load .well-known
|
|
167
204
|
*/
|
|
168
|
-
|
|
205
|
+
url?: string;
|
|
169
206
|
/**
|
|
170
|
-
*
|
|
171
|
-
* @param requestBody
|
|
172
|
-
* @returns any
|
|
173
|
-
* @throws ApiError
|
|
207
|
+
* Reference to a openapi specification to use to map requests to the modules
|
|
174
208
|
*/
|
|
175
|
-
|
|
209
|
+
openapiSpec: string;
|
|
176
210
|
/**
|
|
177
|
-
*
|
|
178
|
-
* @param requestBody
|
|
179
|
-
* @returns any
|
|
180
|
-
* @throws ApiError
|
|
211
|
+
* Reference to a asyncAPI specification to use to map requests to the modules
|
|
181
212
|
*/
|
|
182
|
-
|
|
213
|
+
asyncapiSpec: string;
|
|
183
214
|
/**
|
|
184
|
-
*
|
|
185
|
-
* @param requestBody
|
|
186
|
-
* @returns any
|
|
187
|
-
* @throws ApiError
|
|
215
|
+
* List of managed resources and scopes for this module
|
|
188
216
|
*/
|
|
189
|
-
|
|
190
|
-
}
|
|
191
|
-
|
|
192
|
-
type KeycloakJwtTokenResourceAccess = {};
|
|
193
|
-
|
|
194
|
-
type AuthJwtUser = {
|
|
195
|
-
exp: number;
|
|
196
|
-
iat: number;
|
|
197
|
-
auth_time: number;
|
|
198
|
-
jti: string;
|
|
199
|
-
iss: string;
|
|
200
|
-
aud: string;
|
|
201
|
-
sub: string;
|
|
202
|
-
typ: string;
|
|
203
|
-
azp: string;
|
|
204
|
-
nonce: string;
|
|
205
|
-
session_state: string;
|
|
206
|
-
acr: string;
|
|
207
|
-
scope: string;
|
|
208
|
-
sid: string;
|
|
209
|
-
email_verified: boolean;
|
|
210
|
-
name: string;
|
|
211
|
-
preferred_username: string;
|
|
212
|
-
given_name: string;
|
|
213
|
-
family_name: string;
|
|
214
|
-
email: string;
|
|
215
|
-
realm_access: KeycloakJwtTokenResourceAccess;
|
|
216
|
-
resource_access: KeycloakJwtTokenResourceAccess;
|
|
217
|
-
role: string;
|
|
218
|
-
appId: Array<string>;
|
|
219
|
-
roles: Array<string>;
|
|
217
|
+
resources: Array<ModuleResourceDto>;
|
|
220
218
|
};
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
appId: string;
|
|
224
|
-
/**
|
|
225
|
-
* Reference to the authenticated client the request originated from
|
|
226
|
-
*/
|
|
227
|
-
clientId?: string;
|
|
219
|
+
type AppModuleConfigDto = {
|
|
220
|
+
moduleId: string;
|
|
228
221
|
/**
|
|
229
|
-
*
|
|
222
|
+
* Status of the module. `enabled` by default. can be `disabled`. Set to `failure` if loading generates errors.
|
|
230
223
|
*/
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
expires_in: number;
|
|
239
|
-
refresh_expires_in: number;
|
|
240
|
-
refresh_token: string;
|
|
241
|
-
token_type: string;
|
|
242
|
-
session_state: string;
|
|
243
|
-
scope: string;
|
|
224
|
+
status?: string;
|
|
225
|
+
name?: string;
|
|
226
|
+
description?: string;
|
|
227
|
+
supports: Array<string>;
|
|
228
|
+
config: ModuleSettingsDto;
|
|
229
|
+
secret?: string;
|
|
230
|
+
appId?: string;
|
|
244
231
|
};
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
232
|
+
type AppClientDto = {
|
|
233
|
+
appId?: string;
|
|
234
|
+
name: string;
|
|
248
235
|
/**
|
|
249
|
-
*
|
|
236
|
+
* The clientId, must be unique in the client list and in uuid format.
|
|
250
237
|
*/
|
|
251
238
|
clientId?: string;
|
|
239
|
+
secret?: string;
|
|
252
240
|
/**
|
|
253
|
-
*
|
|
241
|
+
* A list of permissions for this client in the form [resource].[scope] e.g. detection.intent. User *.* for all permission
|
|
254
242
|
*/
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
243
|
+
permissions: Array<string>;
|
|
244
|
+
};
|
|
245
|
+
type AppPromptDto = {
|
|
246
|
+
text: string;
|
|
247
|
+
};
|
|
248
|
+
type AppSettingsDto = {
|
|
249
|
+
ttsEnabled?: boolean;
|
|
250
|
+
login?: boolean;
|
|
251
|
+
avatar: string;
|
|
252
|
+
language?: string;
|
|
253
|
+
llm?: string;
|
|
254
|
+
background: string;
|
|
255
|
+
prompt?: AppPromptDto;
|
|
256
|
+
};
|
|
257
|
+
type ToolsRequestSchemaAuthBasic = {
|
|
258
|
+
username?: string;
|
|
259
|
+
password: string;
|
|
260
|
+
};
|
|
261
|
+
type ToolsRequestSchemaAuthBearer = {
|
|
262
|
+
/**
|
|
263
|
+
* Supported options are "client_credentials" or "password".
|
|
264
|
+
*/
|
|
265
|
+
clientType?: string;
|
|
266
|
+
/**
|
|
267
|
+
* Required for client type "client_credentials"
|
|
268
|
+
*/
|
|
269
|
+
clientId?: string;
|
|
270
|
+
/**
|
|
271
|
+
* Required for client type "client_credentials"
|
|
272
|
+
*/
|
|
273
|
+
clientSecret?: string;
|
|
274
|
+
/**
|
|
275
|
+
* Required for client type "password"
|
|
276
|
+
*/
|
|
277
|
+
username?: string;
|
|
278
|
+
/**
|
|
279
|
+
* Required for client type "password"
|
|
280
|
+
*/
|
|
281
|
+
password?: string;
|
|
282
|
+
audience?: string;
|
|
283
|
+
tokenUrl: string;
|
|
284
|
+
refreshUrl?: string;
|
|
285
|
+
};
|
|
286
|
+
type ToolsRequestSchema = {
|
|
287
|
+
/**
|
|
288
|
+
* Supported options are basic, bearer and module. Defaults to module if not specified.
|
|
289
|
+
*/
|
|
290
|
+
auth?: string;
|
|
291
|
+
/**
|
|
292
|
+
* Used for "basic" auth type
|
|
293
|
+
*/
|
|
294
|
+
basic?: ToolsRequestSchemaAuthBasic;
|
|
295
|
+
/**
|
|
296
|
+
* Used for "bearer" auth type
|
|
297
|
+
*/
|
|
298
|
+
bearer?: ToolsRequestSchemaAuthBearer;
|
|
299
|
+
/**
|
|
300
|
+
* Reference to one of the modules (or clients) available in the app
|
|
301
|
+
*/
|
|
302
|
+
moduleId: string;
|
|
303
|
+
/**
|
|
304
|
+
* Url to call with a JSON POST. Leave empty to skip API calling
|
|
305
|
+
*/
|
|
306
|
+
url: string;
|
|
307
|
+
headers?: Record<string, unknown>;
|
|
308
|
+
};
|
|
309
|
+
type AppToolsDTO = {
|
|
310
|
+
name: string;
|
|
311
|
+
description: string;
|
|
312
|
+
schema?: Array<string>;
|
|
313
|
+
request?: ToolsRequestSchema;
|
|
314
|
+
emitter?: string;
|
|
315
|
+
returnDirect?: boolean;
|
|
316
|
+
url?: string;
|
|
317
|
+
};
|
|
318
|
+
type PlatformAppDto = {
|
|
319
|
+
appId: string;
|
|
320
|
+
public?: boolean;
|
|
321
|
+
name: string;
|
|
322
|
+
description: string;
|
|
323
|
+
/**
|
|
324
|
+
* Owner of the application
|
|
325
|
+
*/
|
|
326
|
+
ownerId: string;
|
|
327
|
+
modules: Array<AppModuleConfigDto>;
|
|
328
|
+
repository: RepositoryConfigDto;
|
|
329
|
+
clients: Array<AppClientDto>;
|
|
330
|
+
settings?: AppSettingsDto;
|
|
331
|
+
createdAt?: string;
|
|
332
|
+
updatedAt?: string;
|
|
333
|
+
tools?: Array<AppToolsDTO>;
|
|
334
|
+
};
|
|
335
|
+
type CreatePlatformAppDto = {
|
|
336
|
+
public?: boolean;
|
|
337
|
+
name: string;
|
|
338
|
+
description: string;
|
|
339
|
+
/**
|
|
340
|
+
* Owner of the application
|
|
341
|
+
*/
|
|
342
|
+
ownerId: string;
|
|
343
|
+
modules: Array<AppModuleConfigDto>;
|
|
344
|
+
repository: RepositoryConfigDto;
|
|
345
|
+
clients: Array<AppClientDto>;
|
|
346
|
+
settings?: AppSettingsDto;
|
|
347
|
+
tools?: Array<AppToolsDTO>;
|
|
348
|
+
};
|
|
349
|
+
type PlatformAppExportFilterDto = {
|
|
350
|
+
name?: string;
|
|
351
|
+
appId?: Array<string>;
|
|
352
|
+
};
|
|
353
|
+
type PlatformModuleConfigDto = {
|
|
354
|
+
moduleId: string;
|
|
355
|
+
/**
|
|
356
|
+
* Status of the module. `enabled` by default. can be `disabled`. Set to `failure` if loading generates errors.
|
|
357
|
+
*/
|
|
358
|
+
status?: string;
|
|
359
|
+
name?: string;
|
|
360
|
+
description?: string;
|
|
361
|
+
supports: Array<string>;
|
|
362
|
+
config: ModuleSettingsDto;
|
|
363
|
+
secret?: string;
|
|
364
|
+
};
|
|
365
|
+
type KeycloakJwtTokenResourceAccess = {};
|
|
366
|
+
type AuthJwtUser = {
|
|
367
|
+
exp: number;
|
|
368
|
+
iat: number;
|
|
369
|
+
auth_time: number;
|
|
370
|
+
jti: string;
|
|
371
|
+
iss: string;
|
|
372
|
+
aud: string;
|
|
373
|
+
sub: string;
|
|
374
|
+
typ: string;
|
|
375
|
+
azp: string;
|
|
376
|
+
nonce: string;
|
|
377
|
+
session_state: string;
|
|
378
|
+
acr: string;
|
|
379
|
+
scope: string;
|
|
380
|
+
sid: string;
|
|
381
|
+
email_verified: boolean;
|
|
382
|
+
name: string;
|
|
383
|
+
preferred_username: string;
|
|
384
|
+
given_name: string;
|
|
385
|
+
family_name: string;
|
|
386
|
+
email: string;
|
|
387
|
+
realm_access: KeycloakJwtTokenResourceAccess;
|
|
388
|
+
resource_access: KeycloakJwtTokenResourceAccess;
|
|
389
|
+
role: string;
|
|
390
|
+
appId: Array<string>;
|
|
391
|
+
roles: Array<string>;
|
|
392
|
+
};
|
|
393
|
+
type LoginRequestDto = {
|
|
394
|
+
appId: string;
|
|
395
|
+
/**
|
|
396
|
+
* Reference to the authenticated client the request originated from
|
|
397
|
+
*/
|
|
398
|
+
clientId?: string;
|
|
399
|
+
/**
|
|
400
|
+
* Reference to the user interacting with the system
|
|
401
|
+
*/
|
|
402
|
+
userId?: string;
|
|
403
|
+
username: string;
|
|
404
|
+
password: string;
|
|
405
|
+
};
|
|
406
|
+
type LoginResponseDto = {
|
|
407
|
+
access_token: string;
|
|
408
|
+
expires_in: number;
|
|
409
|
+
refresh_expires_in: number;
|
|
410
|
+
refresh_token: string;
|
|
411
|
+
token_type: string;
|
|
412
|
+
session_state: string;
|
|
413
|
+
scope: string;
|
|
258
414
|
};
|
|
259
|
-
|
|
260
415
|
type RegistrationRequestDto = {
|
|
261
416
|
appId: string;
|
|
262
417
|
/**
|
|
@@ -271,17 +426,14 @@ type RegistrationRequestDto = {
|
|
|
271
426
|
email: string;
|
|
272
427
|
password: string;
|
|
273
428
|
};
|
|
274
|
-
|
|
275
429
|
type RegistrationResponseDto = {
|
|
276
430
|
userId: string;
|
|
277
431
|
};
|
|
278
|
-
|
|
279
432
|
type AuthorizationUser = {
|
|
280
433
|
moduleId: string;
|
|
281
434
|
resource: Array<string>;
|
|
282
435
|
scopes: Array<string>;
|
|
283
436
|
};
|
|
284
|
-
|
|
285
437
|
type UpdateUserRequestDto = {
|
|
286
438
|
appId: string;
|
|
287
439
|
/**
|
|
@@ -297,54 +449,6 @@ type UpdateUserRequestDto = {
|
|
|
297
449
|
enabled?: boolean;
|
|
298
450
|
authorization?: Array<AuthorizationUser>;
|
|
299
451
|
};
|
|
300
|
-
|
|
301
|
-
declare class AuthenticationService {
|
|
302
|
-
readonly httpRequest: BaseHttpRequest;
|
|
303
|
-
constructor(httpRequest: BaseHttpRequest);
|
|
304
|
-
/**
|
|
305
|
-
* @returns AuthJwtUser
|
|
306
|
-
* @throws ApiError
|
|
307
|
-
*/
|
|
308
|
-
whoami(): CancelablePromise<AuthJwtUser>;
|
|
309
|
-
/**
|
|
310
|
-
* @param requestBody
|
|
311
|
-
* @returns LoginResponseDto Login user
|
|
312
|
-
* @throws ApiError
|
|
313
|
-
*/
|
|
314
|
-
login(requestBody: LoginRequestDto): CancelablePromise<LoginResponseDto>;
|
|
315
|
-
/**
|
|
316
|
-
* @param requestBody
|
|
317
|
-
* @returns RegistrationResponseDto Register a new user
|
|
318
|
-
* @throws ApiError
|
|
319
|
-
*/
|
|
320
|
-
register(requestBody: RegistrationRequestDto): CancelablePromise<RegistrationResponseDto>;
|
|
321
|
-
/**
|
|
322
|
-
* @param requestBody
|
|
323
|
-
* @returns LoginResponseDto Refresh token
|
|
324
|
-
* @throws ApiError
|
|
325
|
-
*/
|
|
326
|
-
refreshToken(requestBody: RefreshTokenRequestDto): CancelablePromise<LoginResponseDto>;
|
|
327
|
-
/**
|
|
328
|
-
* @param userId
|
|
329
|
-
* @param requestBody
|
|
330
|
-
* @returns any Updates user data
|
|
331
|
-
* @throws ApiError
|
|
332
|
-
*/
|
|
333
|
-
edit(userId: string, requestBody: UpdateUserRequestDto): CancelablePromise<any>;
|
|
334
|
-
/**
|
|
335
|
-
* @param userId
|
|
336
|
-
* @returns any Deletes a user and all of its resources
|
|
337
|
-
* @throws ApiError
|
|
338
|
-
*/
|
|
339
|
-
delete(userId: string): CancelablePromise<any>;
|
|
340
|
-
/**
|
|
341
|
-
* @param requestBody
|
|
342
|
-
* @returns any
|
|
343
|
-
* @throws ApiError
|
|
344
|
-
*/
|
|
345
|
-
authAdminControllerSaveUser(requestBody: RegistrationRequestDto): CancelablePromise<any>;
|
|
346
|
-
}
|
|
347
|
-
|
|
348
452
|
type SentimentAnalysisRequest = {
|
|
349
453
|
appId: string;
|
|
350
454
|
/**
|
|
@@ -357,7 +461,6 @@ type SentimentAnalysisRequest = {
|
|
|
357
461
|
userId?: string;
|
|
358
462
|
text: string;
|
|
359
463
|
};
|
|
360
|
-
|
|
361
464
|
type UserInteractionIntentionDto = {
|
|
362
465
|
appId: string;
|
|
363
466
|
/**
|
|
@@ -377,55 +480,17 @@ type UserInteractionIntentionDto = {
|
|
|
377
480
|
interactionType: 'start' | 'stop';
|
|
378
481
|
sessionId: string;
|
|
379
482
|
};
|
|
380
|
-
|
|
381
|
-
declare class DetectionService {
|
|
382
|
-
readonly httpRequest: BaseHttpRequest;
|
|
383
|
-
constructor(httpRequest: BaseHttpRequest);
|
|
384
|
-
/**
|
|
385
|
-
* @param requestBody
|
|
386
|
-
* @returns any
|
|
387
|
-
* @throws ApiError
|
|
388
|
-
*/
|
|
389
|
-
detectionControllerSentimentAnalysis(requestBody: SentimentAnalysisRequest): CancelablePromise<any>;
|
|
390
|
-
/**
|
|
391
|
-
* @param requestBody
|
|
392
|
-
* @returns any
|
|
393
|
-
* @throws ApiError
|
|
394
|
-
*/
|
|
395
|
-
detectionControllerInteractionIntention(requestBody: UserInteractionIntentionDto): CancelablePromise<any>;
|
|
396
|
-
/**
|
|
397
|
-
* @param appId
|
|
398
|
-
* @param cameraId
|
|
399
|
-
* @param formData
|
|
400
|
-
* @returns any
|
|
401
|
-
* @throws ApiError
|
|
402
|
-
*/
|
|
403
|
-
detectionControllerSendFrame(appId: string, cameraId: string, formData: {
|
|
404
|
-
file?: Blob;
|
|
405
|
-
}): CancelablePromise<any>;
|
|
406
|
-
/**
|
|
407
|
-
* @param appId
|
|
408
|
-
* @param cameraId
|
|
409
|
-
* @param overlay
|
|
410
|
-
* @returns any
|
|
411
|
-
* @throws ApiError
|
|
412
|
-
*/
|
|
413
|
-
detectionControllerServe(appId: string, cameraId: string, overlay: string): CancelablePromise<any>;
|
|
414
|
-
}
|
|
415
|
-
|
|
416
483
|
type DialogueDocumentMetadataDto = {
|
|
417
484
|
uri?: string;
|
|
418
485
|
source?: string;
|
|
419
486
|
};
|
|
420
|
-
|
|
421
487
|
type DialogueDocumentDto = {
|
|
422
488
|
appId: string;
|
|
423
489
|
documentId: string;
|
|
424
490
|
content: string;
|
|
425
491
|
metadata: DialogueDocumentMetadataDto;
|
|
426
492
|
};
|
|
427
|
-
|
|
428
|
-
type DialogueMessageDto = {
|
|
493
|
+
type DialogueTextToSpeechDto = {
|
|
429
494
|
appId: string;
|
|
430
495
|
/**
|
|
431
496
|
* Reference to the authenticated client the request originated from
|
|
@@ -448,9 +513,9 @@ type DialogueMessageDto = {
|
|
|
448
513
|
*/
|
|
449
514
|
actor?: 'user' | 'agent';
|
|
450
515
|
/**
|
|
451
|
-
*
|
|
516
|
+
* Text to convert to speech. If emotion field is set, it will be converted to SSML. If also `ssml` field is set, this field will be ignored
|
|
452
517
|
*/
|
|
453
|
-
text
|
|
518
|
+
text?: string;
|
|
454
519
|
/**
|
|
455
520
|
* Assistant gender (M or F)
|
|
456
521
|
*/
|
|
@@ -471,9 +536,12 @@ type DialogueMessageDto = {
|
|
|
471
536
|
* Indicate a chunck identifier as timestamp, usually indicating it is part of a stream.
|
|
472
537
|
*/
|
|
473
538
|
chunkId?: number;
|
|
539
|
+
/**
|
|
540
|
+
* SSML markup to render as speech.
|
|
541
|
+
*/
|
|
542
|
+
ssml?: string;
|
|
474
543
|
};
|
|
475
|
-
|
|
476
|
-
type DialogueTextToSpeechDto = {
|
|
544
|
+
type DialogueMessageDto = {
|
|
477
545
|
appId: string;
|
|
478
546
|
/**
|
|
479
547
|
* Reference to the authenticated client the request originated from
|
|
@@ -496,9 +564,9 @@ type DialogueTextToSpeechDto = {
|
|
|
496
564
|
*/
|
|
497
565
|
actor?: 'user' | 'agent';
|
|
498
566
|
/**
|
|
499
|
-
*
|
|
567
|
+
* Indicate a chunck identifier as timestamp, usually indicating it is part of a stream.
|
|
500
568
|
*/
|
|
501
|
-
text
|
|
569
|
+
text: string;
|
|
502
570
|
/**
|
|
503
571
|
* Assistant gender (M or F)
|
|
504
572
|
*/
|
|
@@ -519,1420 +587,1583 @@ type DialogueTextToSpeechDto = {
|
|
|
519
587
|
* Indicate a chunck identifier as timestamp, usually indicating it is part of a stream.
|
|
520
588
|
*/
|
|
521
589
|
chunkId?: number;
|
|
590
|
+
};
|
|
591
|
+
type SessionDto = {
|
|
592
|
+
appId: string;
|
|
522
593
|
/**
|
|
523
|
-
*
|
|
594
|
+
* Reference to the authenticated client the request originated from
|
|
524
595
|
*/
|
|
525
|
-
|
|
526
|
-
};
|
|
527
|
-
|
|
528
|
-
declare class DialogueService {
|
|
529
|
-
readonly httpRequest: BaseHttpRequest;
|
|
530
|
-
constructor(httpRequest: BaseHttpRequest);
|
|
531
|
-
/**
|
|
532
|
-
* @param requestBody
|
|
533
|
-
* @returns DialogueDocumentDto Saved document
|
|
534
|
-
* @throws ApiError
|
|
535
|
-
*/
|
|
536
|
-
save(requestBody: DialogueDocumentDto): CancelablePromise<DialogueDocumentDto>;
|
|
596
|
+
clientId?: string;
|
|
537
597
|
/**
|
|
538
|
-
*
|
|
539
|
-
* @param requestBody Documents list
|
|
540
|
-
* @returns DialogueDocumentDto
|
|
541
|
-
* @throws ApiError
|
|
598
|
+
* Reference to the user interacting with the system
|
|
542
599
|
*/
|
|
543
|
-
|
|
600
|
+
userId?: string;
|
|
601
|
+
sessionId?: string;
|
|
544
602
|
/**
|
|
545
|
-
*
|
|
546
|
-
* @param appId
|
|
547
|
-
* @param documentId
|
|
548
|
-
* @returns any
|
|
549
|
-
* @throws ApiError
|
|
603
|
+
* Agent instance associated to the session
|
|
550
604
|
*/
|
|
551
|
-
|
|
605
|
+
agentId?: string;
|
|
552
606
|
/**
|
|
553
|
-
*
|
|
554
|
-
* @param requestBody
|
|
555
|
-
* @returns any
|
|
556
|
-
* @throws ApiError
|
|
607
|
+
* Collect inferred identifiers of user interacting with the agent during a session.
|
|
557
608
|
*/
|
|
558
|
-
|
|
609
|
+
user?: Array<string>;
|
|
610
|
+
modifiedAt: string;
|
|
611
|
+
createdAt: string;
|
|
612
|
+
closedAt: string;
|
|
613
|
+
};
|
|
614
|
+
type AgentHeartBeatEventDto = {
|
|
615
|
+
appId: string;
|
|
559
616
|
/**
|
|
560
|
-
*
|
|
561
|
-
* @param sessionId
|
|
562
|
-
* @param sampleRate
|
|
563
|
-
* @param formData
|
|
564
|
-
* @returns any
|
|
565
|
-
* @throws ApiError
|
|
617
|
+
* Reference to the authenticated client the request originated from
|
|
566
618
|
*/
|
|
567
|
-
|
|
568
|
-
file?: Blob;
|
|
569
|
-
}): CancelablePromise<any>;
|
|
619
|
+
clientId?: string;
|
|
570
620
|
/**
|
|
571
|
-
*
|
|
572
|
-
* @param sessionId
|
|
573
|
-
* @param requestBody
|
|
574
|
-
* @returns any
|
|
575
|
-
* @throws ApiError
|
|
621
|
+
* Reference to the user interacting with the system
|
|
576
622
|
*/
|
|
577
|
-
|
|
623
|
+
userId?: string;
|
|
578
624
|
/**
|
|
579
|
-
*
|
|
580
|
-
* @param sessionId
|
|
581
|
-
* @returns any
|
|
582
|
-
* @throws ApiError
|
|
625
|
+
* Track the interaction session, if available
|
|
583
626
|
*/
|
|
584
|
-
|
|
627
|
+
sessionId?: string;
|
|
628
|
+
moduleId: string;
|
|
629
|
+
status: 'unavailable' | 'error' | 'not_ready' | 'ready' | 'loading' | 'interacting' | 'waiting' | 'processing';
|
|
630
|
+
};
|
|
631
|
+
type SessionSupportRequestDto = {
|
|
632
|
+
appId: string;
|
|
585
633
|
/**
|
|
586
|
-
*
|
|
587
|
-
* @throws ApiError
|
|
634
|
+
* Reference to the authenticated client the request originated from
|
|
588
635
|
*/
|
|
589
|
-
|
|
636
|
+
clientId?: string;
|
|
590
637
|
/**
|
|
591
|
-
*
|
|
592
|
-
* @param sessionId
|
|
593
|
-
* @param requestBody
|
|
594
|
-
* @returns any
|
|
595
|
-
* @throws ApiError
|
|
638
|
+
* Reference to the user interacting with the system
|
|
596
639
|
*/
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
appId?: string;
|
|
602
|
-
clientId: string;
|
|
603
|
-
clientSecret?: string;
|
|
640
|
+
userId?: string;
|
|
641
|
+
sessionId: string;
|
|
642
|
+
code: string;
|
|
643
|
+
message: string;
|
|
604
644
|
};
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
appId?: string;
|
|
608
|
-
name: string;
|
|
645
|
+
type SessionSupportResponseDto = {
|
|
646
|
+
appId: string;
|
|
609
647
|
/**
|
|
610
|
-
*
|
|
648
|
+
* Reference to the authenticated client the request originated from
|
|
611
649
|
*/
|
|
612
650
|
clientId?: string;
|
|
613
|
-
secret?: string;
|
|
614
651
|
/**
|
|
615
|
-
*
|
|
652
|
+
* Reference to the user interacting with the system
|
|
616
653
|
*/
|
|
617
|
-
|
|
654
|
+
userId?: string;
|
|
655
|
+
supportId: string;
|
|
618
656
|
};
|
|
619
|
-
|
|
620
|
-
|
|
657
|
+
type SessionStorageRecordDto = {
|
|
658
|
+
appId: string;
|
|
621
659
|
/**
|
|
622
|
-
*
|
|
660
|
+
* Reference to the authenticated client the request originated from
|
|
623
661
|
*/
|
|
624
|
-
|
|
662
|
+
clientId?: string;
|
|
625
663
|
/**
|
|
626
|
-
*
|
|
664
|
+
* Reference to the user interacting with the system
|
|
627
665
|
*/
|
|
628
|
-
|
|
666
|
+
userId?: string;
|
|
667
|
+
storageId?: string;
|
|
668
|
+
sessionId?: string;
|
|
669
|
+
data: Record<string, unknown>;
|
|
670
|
+
};
|
|
671
|
+
type SessionStorageSearchDto = {
|
|
672
|
+
appId: string;
|
|
673
|
+
userId?: Array<string>;
|
|
674
|
+
sessionId?: Array<string>;
|
|
675
|
+
storageId?: Array<string>;
|
|
676
|
+
};
|
|
677
|
+
type ImageContentDto = {
|
|
678
|
+
src: string;
|
|
679
|
+
width?: number;
|
|
680
|
+
height?: number;
|
|
681
|
+
alt: string;
|
|
682
|
+
};
|
|
683
|
+
type UIContentOptionsDto = {
|
|
629
684
|
/**
|
|
630
|
-
*
|
|
685
|
+
* Clear the UI screen
|
|
631
686
|
*/
|
|
632
|
-
|
|
687
|
+
clearScreen?: boolean;
|
|
633
688
|
/**
|
|
634
|
-
*
|
|
689
|
+
* Enable agent reading the content (text to speech)
|
|
635
690
|
*/
|
|
636
|
-
|
|
691
|
+
ttsEnabled?: boolean;
|
|
637
692
|
/**
|
|
638
|
-
*
|
|
693
|
+
* Stop the agent speech
|
|
639
694
|
*/
|
|
640
|
-
|
|
695
|
+
stopSpeech?: boolean;
|
|
696
|
+
};
|
|
697
|
+
type ImageUIContentDto = {
|
|
698
|
+
appId: string;
|
|
641
699
|
/**
|
|
642
|
-
*
|
|
700
|
+
* Reference to the authenticated client the request originated from
|
|
643
701
|
*/
|
|
644
|
-
|
|
702
|
+
clientId?: string;
|
|
645
703
|
/**
|
|
646
|
-
*
|
|
704
|
+
* Reference to the user interacting with the system
|
|
647
705
|
*/
|
|
648
|
-
|
|
706
|
+
userId?: string;
|
|
649
707
|
/**
|
|
650
|
-
*
|
|
708
|
+
* Track the interaction session, if available
|
|
651
709
|
*/
|
|
652
|
-
|
|
710
|
+
sessionId?: string;
|
|
711
|
+
contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
712
|
+
content: ImageContentDto;
|
|
713
|
+
metadata?: Record<string, unknown>;
|
|
714
|
+
options?: UIContentOptionsDto;
|
|
715
|
+
chunkId?: number;
|
|
716
|
+
messageId?: string;
|
|
653
717
|
};
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
718
|
+
type VideoContentDto = {
|
|
719
|
+
sources: Array<string>;
|
|
720
|
+
description?: string;
|
|
721
|
+
subtitle?: string;
|
|
722
|
+
thumb?: string;
|
|
723
|
+
title?: string;
|
|
724
|
+
width?: number;
|
|
725
|
+
height?: number;
|
|
726
|
+
};
|
|
727
|
+
type VideoUIContentDto = {
|
|
728
|
+
appId: string;
|
|
664
729
|
/**
|
|
665
|
-
* Reference to
|
|
730
|
+
* Reference to the authenticated client the request originated from
|
|
666
731
|
*/
|
|
667
|
-
|
|
732
|
+
clientId?: string;
|
|
668
733
|
/**
|
|
669
|
-
*
|
|
734
|
+
* Reference to the user interacting with the system
|
|
670
735
|
*/
|
|
671
|
-
|
|
672
|
-
};
|
|
673
|
-
|
|
674
|
-
type AppModuleConfigDto = {
|
|
675
|
-
moduleId: string;
|
|
736
|
+
userId?: string;
|
|
676
737
|
/**
|
|
677
|
-
*
|
|
738
|
+
* Track the interaction session, if available
|
|
678
739
|
*/
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
};
|
|
687
|
-
|
|
688
|
-
type AppPromptDto = {
|
|
689
|
-
text: string;
|
|
690
|
-
};
|
|
691
|
-
|
|
692
|
-
type AppSettingsDto = {
|
|
693
|
-
ttsEnabled?: boolean;
|
|
694
|
-
login?: boolean;
|
|
695
|
-
avatar: string;
|
|
696
|
-
language?: string;
|
|
697
|
-
llm?: string;
|
|
698
|
-
background: string;
|
|
699
|
-
prompt?: AppPromptDto;
|
|
740
|
+
sessionId?: string;
|
|
741
|
+
contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
742
|
+
content: VideoContentDto;
|
|
743
|
+
metadata?: Record<string, unknown>;
|
|
744
|
+
options?: UIContentOptionsDto;
|
|
745
|
+
chunkId?: number;
|
|
746
|
+
messageId?: string;
|
|
700
747
|
};
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
username?: string;
|
|
704
|
-
password: string;
|
|
748
|
+
type PdfContentDto = {
|
|
749
|
+
url: string;
|
|
705
750
|
};
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
/**
|
|
709
|
-
* Supported options are "client_credentials" or "password".
|
|
710
|
-
*/
|
|
711
|
-
clientType?: string;
|
|
751
|
+
type PdfUIContentDto = {
|
|
752
|
+
appId: string;
|
|
712
753
|
/**
|
|
713
|
-
*
|
|
754
|
+
* Reference to the authenticated client the request originated from
|
|
714
755
|
*/
|
|
715
756
|
clientId?: string;
|
|
716
757
|
/**
|
|
717
|
-
*
|
|
718
|
-
*/
|
|
719
|
-
clientSecret?: string;
|
|
720
|
-
/**
|
|
721
|
-
* Required for client type "password"
|
|
758
|
+
* Reference to the user interacting with the system
|
|
722
759
|
*/
|
|
723
|
-
|
|
760
|
+
userId?: string;
|
|
724
761
|
/**
|
|
725
|
-
*
|
|
762
|
+
* Track the interaction session, if available
|
|
726
763
|
*/
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
764
|
+
sessionId?: string;
|
|
765
|
+
contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
766
|
+
content: PdfContentDto;
|
|
767
|
+
metadata?: Record<string, unknown>;
|
|
768
|
+
options?: UIContentOptionsDto;
|
|
769
|
+
chunkId?: number;
|
|
770
|
+
messageId?: string;
|
|
731
771
|
};
|
|
732
|
-
|
|
733
|
-
|
|
772
|
+
type WebpageContentDto = {
|
|
773
|
+
url: string;
|
|
774
|
+
};
|
|
775
|
+
type WebpageUIContentDto = {
|
|
776
|
+
appId: string;
|
|
734
777
|
/**
|
|
735
|
-
*
|
|
778
|
+
* Reference to the authenticated client the request originated from
|
|
736
779
|
*/
|
|
737
|
-
|
|
780
|
+
clientId?: string;
|
|
738
781
|
/**
|
|
739
|
-
*
|
|
782
|
+
* Reference to the user interacting with the system
|
|
740
783
|
*/
|
|
741
|
-
|
|
784
|
+
userId?: string;
|
|
742
785
|
/**
|
|
743
|
-
*
|
|
786
|
+
* Track the interaction session, if available
|
|
744
787
|
*/
|
|
745
|
-
|
|
788
|
+
sessionId?: string;
|
|
789
|
+
contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
790
|
+
content: WebpageContentDto;
|
|
791
|
+
metadata?: Record<string, unknown>;
|
|
792
|
+
options?: UIContentOptionsDto;
|
|
793
|
+
chunkId?: number;
|
|
794
|
+
messageId?: string;
|
|
795
|
+
};
|
|
796
|
+
type ObjectContentDto = {
|
|
797
|
+
url: string;
|
|
798
|
+
};
|
|
799
|
+
type ObjectUIContentDto = {
|
|
800
|
+
appId: string;
|
|
746
801
|
/**
|
|
747
|
-
* Reference to
|
|
802
|
+
* Reference to the authenticated client the request originated from
|
|
748
803
|
*/
|
|
749
|
-
|
|
804
|
+
clientId?: string;
|
|
750
805
|
/**
|
|
751
|
-
*
|
|
806
|
+
* Reference to the user interacting with the system
|
|
752
807
|
*/
|
|
753
|
-
|
|
754
|
-
headers?: Record<string, any>;
|
|
755
|
-
};
|
|
756
|
-
|
|
757
|
-
type AppToolsDTO = {
|
|
758
|
-
name: string;
|
|
759
|
-
description: string;
|
|
760
|
-
schema?: Array<string>;
|
|
761
|
-
request?: ToolsRequestSchema;
|
|
762
|
-
emitter?: string;
|
|
763
|
-
returnDirect?: boolean;
|
|
764
|
-
url?: string;
|
|
765
|
-
};
|
|
766
|
-
|
|
767
|
-
type RepositoryConfigDto = {
|
|
768
|
-
avatars: Record<string, any>;
|
|
769
|
-
backgrounds: Record<string, any>;
|
|
770
|
-
robots?: Record<string, any>;
|
|
771
|
-
};
|
|
772
|
-
|
|
773
|
-
type CreatePlatformAppDto = {
|
|
774
|
-
public?: boolean;
|
|
775
|
-
name: string;
|
|
776
|
-
description: string;
|
|
808
|
+
userId?: string;
|
|
777
809
|
/**
|
|
778
|
-
*
|
|
810
|
+
* Track the interaction session, if available
|
|
779
811
|
*/
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
812
|
+
sessionId?: string;
|
|
813
|
+
contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
814
|
+
content: ObjectContentDto;
|
|
815
|
+
metadata?: Record<string, unknown>;
|
|
816
|
+
options?: UIContentOptionsDto;
|
|
817
|
+
chunkId?: number;
|
|
818
|
+
messageId?: string;
|
|
786
819
|
};
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
access_token: string;
|
|
790
|
-
expires_in: number;
|
|
791
|
-
refresh_expires_in: number;
|
|
792
|
-
refresh_token: string;
|
|
793
|
-
token_type: string;
|
|
794
|
-
id_token: string;
|
|
795
|
-
'not-before-policy': number;
|
|
796
|
-
session_state: string;
|
|
797
|
-
scope: string;
|
|
820
|
+
type TextContentDto = {
|
|
821
|
+
text: string;
|
|
798
822
|
};
|
|
799
|
-
|
|
800
|
-
type PlatformAppDto = {
|
|
823
|
+
type TextUIContentDto = {
|
|
801
824
|
appId: string;
|
|
802
|
-
public?: boolean;
|
|
803
|
-
name: string;
|
|
804
|
-
description: string;
|
|
805
825
|
/**
|
|
806
|
-
*
|
|
826
|
+
* Reference to the authenticated client the request originated from
|
|
807
827
|
*/
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
828
|
+
clientId?: string;
|
|
829
|
+
/**
|
|
830
|
+
* Reference to the user interacting with the system
|
|
831
|
+
*/
|
|
832
|
+
userId?: string;
|
|
833
|
+
/**
|
|
834
|
+
* Track the interaction session, if available
|
|
835
|
+
*/
|
|
836
|
+
sessionId?: string;
|
|
837
|
+
contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
838
|
+
content: TextContentDto;
|
|
839
|
+
metadata?: Record<string, unknown>;
|
|
840
|
+
options?: UIContentOptionsDto;
|
|
841
|
+
chunkId?: number;
|
|
842
|
+
messageId?: string;
|
|
816
843
|
};
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
844
|
+
type QuizAnswerDto = {
|
|
845
|
+
answer: string;
|
|
846
|
+
reason: string;
|
|
847
|
+
correct: boolean;
|
|
821
848
|
};
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
849
|
+
type QuizContentDto = {
|
|
850
|
+
question: string;
|
|
851
|
+
answers: Array<QuizAnswerDto>;
|
|
852
|
+
};
|
|
853
|
+
type QuizUIContentDto = {
|
|
854
|
+
appId: string;
|
|
825
855
|
/**
|
|
826
|
-
*
|
|
856
|
+
* Reference to the authenticated client the request originated from
|
|
827
857
|
*/
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
858
|
+
clientId?: string;
|
|
859
|
+
/**
|
|
860
|
+
* Reference to the user interacting with the system
|
|
861
|
+
*/
|
|
862
|
+
userId?: string;
|
|
863
|
+
/**
|
|
864
|
+
* Track the interaction session, if available
|
|
865
|
+
*/
|
|
866
|
+
sessionId?: string;
|
|
867
|
+
contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
868
|
+
content: QuizContentDto;
|
|
869
|
+
metadata?: Record<string, unknown>;
|
|
870
|
+
options?: UIContentOptionsDto;
|
|
871
|
+
chunkId?: number;
|
|
872
|
+
messageId?: string;
|
|
834
873
|
};
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
874
|
+
type ClearUIContentDto = {
|
|
875
|
+
appId: string;
|
|
876
|
+
/**
|
|
877
|
+
* Reference to the authenticated client the request originated from
|
|
878
|
+
*/
|
|
879
|
+
clientId?: string;
|
|
880
|
+
/**
|
|
881
|
+
* Reference to the user interacting with the system
|
|
882
|
+
*/
|
|
883
|
+
userId?: string;
|
|
884
|
+
/**
|
|
885
|
+
* Track the interaction session, if available
|
|
886
|
+
*/
|
|
887
|
+
sessionId?: string;
|
|
888
|
+
contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
889
|
+
content: Record<string, unknown>;
|
|
890
|
+
metadata?: Record<string, unknown>;
|
|
891
|
+
options?: UIContentOptionsDto;
|
|
892
|
+
chunkId?: number;
|
|
893
|
+
messageId?: string;
|
|
838
894
|
};
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
895
|
+
type ClearScreenDto = {
|
|
896
|
+
appId: string;
|
|
897
|
+
/**
|
|
898
|
+
* Reference to the authenticated client the request originated from
|
|
899
|
+
*/
|
|
900
|
+
clientId?: string;
|
|
901
|
+
/**
|
|
902
|
+
* Reference to the user interacting with the system
|
|
903
|
+
*/
|
|
904
|
+
userId?: string;
|
|
905
|
+
/**
|
|
906
|
+
* Track the interaction session, if available
|
|
907
|
+
*/
|
|
908
|
+
sessionId?: string;
|
|
909
|
+
contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
910
|
+
content: Record<string, unknown>;
|
|
911
|
+
metadata?: Record<string, unknown>;
|
|
912
|
+
options?: UIContentOptionsDto;
|
|
913
|
+
chunkId?: number;
|
|
914
|
+
messageId?: string;
|
|
844
915
|
};
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
|
|
916
|
+
type ButtonDto = {
|
|
917
|
+
value: string;
|
|
918
|
+
id?: string;
|
|
919
|
+
label?: string;
|
|
920
|
+
classes?: Array<string>;
|
|
921
|
+
options?: UIContentOptionsDto;
|
|
849
922
|
};
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
name?: string;
|
|
854
|
-
modelPath: string;
|
|
855
|
-
gender: 'M' | 'F';
|
|
856
|
-
camera?: AvatarCameraConfig;
|
|
857
|
-
cameraMobile?: AvatarCameraConfig;
|
|
923
|
+
type ButtonsContentDto = {
|
|
924
|
+
label: string;
|
|
925
|
+
list: Array<ButtonDto>;
|
|
858
926
|
};
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
|
|
865
|
-
|
|
927
|
+
type ButtonsUIContentDto = {
|
|
928
|
+
appId: string;
|
|
929
|
+
/**
|
|
930
|
+
* Reference to the authenticated client the request originated from
|
|
931
|
+
*/
|
|
932
|
+
clientId?: string;
|
|
933
|
+
/**
|
|
934
|
+
* Reference to the user interacting with the system
|
|
935
|
+
*/
|
|
936
|
+
userId?: string;
|
|
937
|
+
/**
|
|
938
|
+
* Track the interaction session, if available
|
|
939
|
+
*/
|
|
940
|
+
sessionId?: string;
|
|
941
|
+
contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
942
|
+
content: ButtonsContentDto;
|
|
943
|
+
metadata?: Record<string, unknown>;
|
|
944
|
+
options?: UIContentOptionsDto;
|
|
945
|
+
chunkId?: number;
|
|
946
|
+
messageId?: string;
|
|
866
947
|
};
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
948
|
+
type DialogueMessageUIContentDto = {
|
|
949
|
+
appId: string;
|
|
950
|
+
/**
|
|
951
|
+
* Reference to the authenticated client the request originated from
|
|
952
|
+
*/
|
|
953
|
+
clientId?: string;
|
|
954
|
+
/**
|
|
955
|
+
* Reference to the user interacting with the system
|
|
956
|
+
*/
|
|
957
|
+
userId?: string;
|
|
958
|
+
/**
|
|
959
|
+
* Track the interaction session, if available
|
|
960
|
+
*/
|
|
961
|
+
sessionId?: string;
|
|
962
|
+
contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
963
|
+
content: DialogueMessageDto;
|
|
964
|
+
metadata?: Record<string, unknown>;
|
|
965
|
+
options?: UIContentOptionsDto;
|
|
966
|
+
chunkId?: number;
|
|
967
|
+
messageId?: string;
|
|
872
968
|
};
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
|
|
876
|
-
type?: 'speech' | 'characterization' | 'speechToText';
|
|
877
|
-
ts?: string;
|
|
969
|
+
type LinkContentDto = {
|
|
970
|
+
url: string;
|
|
971
|
+
label: string;
|
|
878
972
|
};
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
readonly httpRequest: BaseHttpRequest;
|
|
882
|
-
constructor(httpRequest: BaseHttpRequest);
|
|
973
|
+
type LinkUIContentDto = {
|
|
974
|
+
appId: string;
|
|
883
975
|
/**
|
|
884
|
-
*
|
|
885
|
-
* @throws ApiError
|
|
976
|
+
* Reference to the authenticated client the request originated from
|
|
886
977
|
*/
|
|
887
|
-
|
|
978
|
+
clientId?: string;
|
|
888
979
|
/**
|
|
889
|
-
*
|
|
890
|
-
* @throws ApiError
|
|
980
|
+
* Reference to the user interacting with the system
|
|
891
981
|
*/
|
|
892
|
-
|
|
982
|
+
userId?: string;
|
|
893
983
|
/**
|
|
894
|
-
*
|
|
895
|
-
* @returns JwtTokenDto Request an access token for an app
|
|
896
|
-
* @throws ApiError
|
|
984
|
+
* Track the interaction session, if available
|
|
897
985
|
*/
|
|
898
|
-
|
|
986
|
+
sessionId?: string;
|
|
987
|
+
contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
988
|
+
content: LinkContentDto;
|
|
989
|
+
metadata?: Record<string, unknown>;
|
|
990
|
+
options?: UIContentOptionsDto;
|
|
991
|
+
chunkId?: number;
|
|
992
|
+
messageId?: string;
|
|
993
|
+
};
|
|
994
|
+
type HtmlContentDto = {
|
|
995
|
+
html: string;
|
|
996
|
+
};
|
|
997
|
+
type HtmlUIContentDto = {
|
|
998
|
+
appId: string;
|
|
899
999
|
/**
|
|
900
|
-
*
|
|
901
|
-
* @returns JwtTokenDto Request an access token for an app
|
|
902
|
-
* @throws ApiError
|
|
1000
|
+
* Reference to the authenticated client the request originated from
|
|
903
1001
|
*/
|
|
904
|
-
|
|
1002
|
+
clientId?: string;
|
|
905
1003
|
/**
|
|
906
|
-
*
|
|
907
|
-
* @returns JwtTokenDto Request a refresh access token for an app
|
|
908
|
-
* @throws ApiError
|
|
1004
|
+
* Reference to the user interacting with the system
|
|
909
1005
|
*/
|
|
910
|
-
|
|
1006
|
+
userId?: string;
|
|
911
1007
|
/**
|
|
912
|
-
*
|
|
913
|
-
* @returns JwtTokenDto Request a refresh access token for an app
|
|
914
|
-
* @throws ApiError
|
|
1008
|
+
* Track the interaction session, if available
|
|
915
1009
|
*/
|
|
916
|
-
|
|
1010
|
+
sessionId?: string;
|
|
1011
|
+
contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
1012
|
+
content: HtmlContentDto;
|
|
1013
|
+
metadata?: Record<string, unknown>;
|
|
1014
|
+
options?: UIContentOptionsDto;
|
|
1015
|
+
chunkId?: number;
|
|
1016
|
+
messageId?: string;
|
|
1017
|
+
};
|
|
1018
|
+
type EmailContentDto = {
|
|
1019
|
+
email: string;
|
|
1020
|
+
label: string;
|
|
1021
|
+
};
|
|
1022
|
+
type EmailUIContentDto = {
|
|
1023
|
+
appId: string;
|
|
917
1024
|
/**
|
|
918
|
-
*
|
|
919
|
-
* @throws ApiError
|
|
1025
|
+
* Reference to the authenticated client the request originated from
|
|
920
1026
|
*/
|
|
921
|
-
|
|
1027
|
+
clientId?: string;
|
|
922
1028
|
/**
|
|
923
|
-
*
|
|
924
|
-
* @returns PlatformAppDto
|
|
925
|
-
* @throws ApiError
|
|
1029
|
+
* Reference to the user interacting with the system
|
|
926
1030
|
*/
|
|
927
|
-
|
|
1031
|
+
userId?: string;
|
|
928
1032
|
/**
|
|
929
|
-
*
|
|
930
|
-
* @returns PlatformAppDto
|
|
931
|
-
* @throws ApiError
|
|
1033
|
+
* Track the interaction session, if available
|
|
932
1034
|
*/
|
|
933
|
-
|
|
1035
|
+
sessionId?: string;
|
|
1036
|
+
contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
1037
|
+
content: EmailContentDto;
|
|
1038
|
+
metadata?: Record<string, unknown>;
|
|
1039
|
+
options?: UIContentOptionsDto;
|
|
1040
|
+
chunkId?: number;
|
|
1041
|
+
messageId?: string;
|
|
1042
|
+
};
|
|
1043
|
+
type UIInteractionDTO = {
|
|
1044
|
+
context: Record<string, unknown>;
|
|
1045
|
+
element: string;
|
|
1046
|
+
value: string;
|
|
1047
|
+
};
|
|
1048
|
+
type UIContentDto = {
|
|
1049
|
+
appId: string;
|
|
934
1050
|
/**
|
|
935
|
-
*
|
|
936
|
-
* @throws ApiError
|
|
1051
|
+
* Reference to the authenticated client the request originated from
|
|
937
1052
|
*/
|
|
938
|
-
|
|
1053
|
+
clientId?: string;
|
|
939
1054
|
/**
|
|
940
|
-
*
|
|
941
|
-
|
|
942
|
-
|
|
943
|
-
|
|
1055
|
+
* Reference to the user interacting with the system
|
|
1056
|
+
*/
|
|
1057
|
+
userId?: string;
|
|
1058
|
+
/**
|
|
1059
|
+
* Track the interaction session, if available
|
|
1060
|
+
*/
|
|
1061
|
+
sessionId?: string;
|
|
1062
|
+
contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
1063
|
+
content: Record<string, unknown>;
|
|
1064
|
+
metadata?: Record<string, unknown>;
|
|
1065
|
+
options?: UIContentOptionsDto;
|
|
1066
|
+
chunkId?: number;
|
|
1067
|
+
messageId?: string;
|
|
1068
|
+
};
|
|
1069
|
+
type UIModelMapBlendShapesRequestDto = {
|
|
1070
|
+
blendShapes: Array<string>;
|
|
1071
|
+
};
|
|
1072
|
+
type UIModelMapBlendShapesResponseDto = {
|
|
1073
|
+
blendShapes: Record<string, unknown>;
|
|
1074
|
+
};
|
|
1075
|
+
type UIAssetMetadataDto = {};
|
|
1076
|
+
type UIAssetDto = {
|
|
1077
|
+
filename: string;
|
|
1078
|
+
appId: string;
|
|
1079
|
+
type?: 'models' | 'backgrounds' | 'animations' | 'documents';
|
|
1080
|
+
userId?: string;
|
|
1081
|
+
ts?: string;
|
|
1082
|
+
metadata?: UIAssetMetadataDto;
|
|
1083
|
+
};
|
|
1084
|
+
type UIModelAssetDto = {
|
|
1085
|
+
filename: string;
|
|
1086
|
+
appId: string;
|
|
1087
|
+
type?: 'models' | 'backgrounds' | 'animations' | 'documents';
|
|
1088
|
+
userId?: string;
|
|
1089
|
+
ts?: string;
|
|
1090
|
+
metadata?: UIAssetMetadataDto;
|
|
1091
|
+
};
|
|
1092
|
+
type Buffer$1 = {};
|
|
1093
|
+
type ViewLogsRequestDto = {
|
|
1094
|
+
sessionId: string;
|
|
1095
|
+
type?: 'speech' | 'characterization' | 'speechToText';
|
|
1096
|
+
ts?: string;
|
|
1097
|
+
};
|
|
1098
|
+
type XRMarkerListRequestDto = {
|
|
1099
|
+
appId: string;
|
|
1100
|
+
/**
|
|
1101
|
+
* List of marker ID to search for
|
|
944
1102
|
*/
|
|
945
|
-
|
|
1103
|
+
markerId?: Array<string>;
|
|
946
1104
|
/**
|
|
947
|
-
*
|
|
948
|
-
* @param requestBody
|
|
949
|
-
* @returns any
|
|
950
|
-
* @throws ApiError
|
|
1105
|
+
* List of uri to search for
|
|
951
1106
|
*/
|
|
952
|
-
|
|
1107
|
+
payload?: Array<string>;
|
|
1108
|
+
tags?: Array<string>;
|
|
1109
|
+
};
|
|
1110
|
+
type XRMarkerDto = {
|
|
1111
|
+
appId: string;
|
|
953
1112
|
/**
|
|
954
|
-
*
|
|
955
|
-
* @returns RepositoryConfigDto
|
|
956
|
-
* @throws ApiError
|
|
1113
|
+
* Reference to the authenticated client the request originated from
|
|
957
1114
|
*/
|
|
958
|
-
|
|
1115
|
+
clientId?: string;
|
|
959
1116
|
/**
|
|
960
|
-
*
|
|
961
|
-
* @param name
|
|
962
|
-
* @returns RepositoryRobotModelDto
|
|
963
|
-
* @throws ApiError
|
|
1117
|
+
* Reference to the user interacting with the system
|
|
964
1118
|
*/
|
|
965
|
-
|
|
1119
|
+
userId?: string;
|
|
966
1120
|
/**
|
|
967
|
-
*
|
|
968
|
-
* @param name
|
|
969
|
-
* @returns RepositoryAvatarModelDto
|
|
970
|
-
* @throws ApiError
|
|
1121
|
+
* ID of the marker
|
|
971
1122
|
*/
|
|
972
|
-
|
|
1123
|
+
markerId?: string;
|
|
973
1124
|
/**
|
|
974
|
-
*
|
|
975
|
-
* @param name
|
|
976
|
-
* @returns RepositoryConfigDto
|
|
977
|
-
* @throws ApiError
|
|
1125
|
+
* Payload as decoded from the marker QR code
|
|
978
1126
|
*/
|
|
979
|
-
|
|
1127
|
+
payload: string;
|
|
980
1128
|
/**
|
|
981
|
-
*
|
|
982
|
-
* @returns PlatformAppDto
|
|
983
|
-
* @throws ApiError
|
|
1129
|
+
* A list of tags for the marker
|
|
984
1130
|
*/
|
|
985
|
-
|
|
1131
|
+
tags?: Array<string>;
|
|
1132
|
+
};
|
|
1133
|
+
type XROcclusionResponseDto = {
|
|
1134
|
+
appId: string;
|
|
986
1135
|
/**
|
|
987
|
-
*
|
|
988
|
-
* @returns any
|
|
989
|
-
* @throws ApiError
|
|
1136
|
+
* Reference to the authenticated client the request originated from
|
|
990
1137
|
*/
|
|
991
|
-
|
|
1138
|
+
clientId?: string;
|
|
992
1139
|
/**
|
|
993
|
-
*
|
|
994
|
-
* @param skipClients
|
|
995
|
-
* @param requestBody
|
|
996
|
-
* @returns PlatformAppDto
|
|
997
|
-
* @throws ApiError
|
|
1140
|
+
* Reference to the user interacting with the system
|
|
998
1141
|
*/
|
|
999
|
-
|
|
1142
|
+
userId?: string;
|
|
1143
|
+
occlusion: boolean;
|
|
1144
|
+
};
|
|
1145
|
+
type PositionDto = {
|
|
1146
|
+
x: number;
|
|
1147
|
+
y: number;
|
|
1148
|
+
z: number;
|
|
1149
|
+
};
|
|
1150
|
+
type OrientationDto = {
|
|
1151
|
+
x: number;
|
|
1152
|
+
y: number;
|
|
1153
|
+
z: number;
|
|
1154
|
+
w: number;
|
|
1155
|
+
};
|
|
1156
|
+
type PoseDto = {
|
|
1157
|
+
position: PositionDto;
|
|
1158
|
+
orientation: OrientationDto;
|
|
1159
|
+
};
|
|
1160
|
+
type MovementDto = {
|
|
1161
|
+
targetPosition: PoseDto;
|
|
1162
|
+
personId: string;
|
|
1163
|
+
path: Array<string>;
|
|
1164
|
+
};
|
|
1165
|
+
type MovementEventDto = {
|
|
1166
|
+
appId: string;
|
|
1000
1167
|
/**
|
|
1001
|
-
*
|
|
1002
|
-
* @param requestBody
|
|
1003
|
-
* @returns PlatformAppDto
|
|
1004
|
-
* @throws ApiError
|
|
1168
|
+
* Reference to the authenticated client the request originated from
|
|
1005
1169
|
*/
|
|
1006
|
-
|
|
1170
|
+
clientId?: string;
|
|
1007
1171
|
/**
|
|
1008
|
-
*
|
|
1009
|
-
* @param requestBody
|
|
1010
|
-
* @returns any
|
|
1011
|
-
* @throws ApiError
|
|
1172
|
+
* Reference to the user interacting with the system
|
|
1012
1173
|
*/
|
|
1013
|
-
|
|
1174
|
+
userId?: string;
|
|
1175
|
+
movement: MovementDto;
|
|
1176
|
+
};
|
|
1177
|
+
type SermasBaseDto = {
|
|
1178
|
+
appId: string;
|
|
1014
1179
|
/**
|
|
1015
|
-
*
|
|
1016
|
-
* @param requestBody
|
|
1017
|
-
* @returns AppClientDto
|
|
1018
|
-
* @throws ApiError
|
|
1180
|
+
* Reference to the authenticated client the request originated from
|
|
1019
1181
|
*/
|
|
1020
|
-
|
|
1182
|
+
clientId?: string;
|
|
1021
1183
|
/**
|
|
1022
|
-
*
|
|
1023
|
-
* @param clientId
|
|
1024
|
-
* @returns AppClientDto
|
|
1025
|
-
* @throws ApiError
|
|
1184
|
+
* Reference to the user interacting with the system
|
|
1026
1185
|
*/
|
|
1027
|
-
|
|
1186
|
+
userId?: string;
|
|
1187
|
+
};
|
|
1188
|
+
type ActuationEventDto = {
|
|
1189
|
+
appId: string;
|
|
1028
1190
|
/**
|
|
1029
|
-
*
|
|
1030
|
-
* @param appId
|
|
1031
|
-
* @returns any
|
|
1032
|
-
* @throws ApiError
|
|
1191
|
+
* Reference to the authenticated client the request originated from
|
|
1033
1192
|
*/
|
|
1034
|
-
|
|
1193
|
+
clientId?: string;
|
|
1035
1194
|
/**
|
|
1036
|
-
*
|
|
1037
|
-
* @param clientId
|
|
1038
|
-
* @returns string
|
|
1039
|
-
* @throws ApiError
|
|
1195
|
+
* Reference to the user interacting with the system
|
|
1040
1196
|
*/
|
|
1041
|
-
|
|
1197
|
+
userId?: string;
|
|
1198
|
+
actuations: Array<string>;
|
|
1199
|
+
};
|
|
1200
|
+
type LinearVelocityDto = {};
|
|
1201
|
+
type VelocityDto = {
|
|
1202
|
+
linear: LinearVelocityDto;
|
|
1203
|
+
angular: LinearVelocityDto;
|
|
1204
|
+
};
|
|
1205
|
+
type StatusDto = {
|
|
1206
|
+
actualPosition: PoseDto;
|
|
1207
|
+
velocity: VelocityDto;
|
|
1208
|
+
};
|
|
1209
|
+
type StatusEventDto = {
|
|
1210
|
+
appId: string;
|
|
1042
1211
|
/**
|
|
1043
|
-
*
|
|
1044
|
-
* @param appId
|
|
1045
|
-
* @param requestBody
|
|
1046
|
-
* @returns any
|
|
1047
|
-
* @throws ApiError
|
|
1212
|
+
* Reference to the authenticated client the request originated from
|
|
1048
1213
|
*/
|
|
1049
|
-
|
|
1214
|
+
clientId?: string;
|
|
1050
1215
|
/**
|
|
1051
|
-
*
|
|
1052
|
-
* @param appId
|
|
1053
|
-
* @param moduleId
|
|
1054
|
-
* @returns any
|
|
1055
|
-
* @throws ApiError
|
|
1216
|
+
* Reference to the user interacting with the system
|
|
1056
1217
|
*/
|
|
1057
|
-
|
|
1218
|
+
userId?: string;
|
|
1219
|
+
status: StatusDto;
|
|
1220
|
+
robotId: string;
|
|
1221
|
+
};
|
|
1222
|
+
|
|
1223
|
+
type TDataRoboticsAgentControllerMoveToArea$1 = {
|
|
1224
|
+
appId: string;
|
|
1225
|
+
room: string;
|
|
1226
|
+
};
|
|
1227
|
+
type TDataRoboticsAgentControllerStatusDescription$1 = {
|
|
1228
|
+
appId: string;
|
|
1229
|
+
robotId: string;
|
|
1230
|
+
};
|
|
1231
|
+
type TDataRoboticsAgentControllerMove$1 = {
|
|
1232
|
+
requestBody: MovementEventDto;
|
|
1233
|
+
};
|
|
1234
|
+
type TDataRoboticsAgentControllerInitialPose$1 = {
|
|
1235
|
+
requestBody: SermasBaseDto;
|
|
1236
|
+
};
|
|
1237
|
+
type TDataRoboticsAgentControllerActuate$1 = {
|
|
1238
|
+
requestBody: ActuationEventDto;
|
|
1239
|
+
};
|
|
1240
|
+
type TDataRoboticsAgentControllerStatus$1 = {
|
|
1241
|
+
requestBody: StatusEventDto;
|
|
1242
|
+
};
|
|
1243
|
+
declare class AgentService {
|
|
1244
|
+
readonly httpRequest: BaseHttpRequest;
|
|
1245
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
1058
1246
|
/**
|
|
1059
|
-
*
|
|
1060
|
-
* @param appId
|
|
1061
|
-
* @param moduleId
|
|
1247
|
+
* move the robot to a specified coordinates. Based on the parameter coordinates, move the robot to that coordinates.
|
|
1062
1248
|
* @returns any
|
|
1063
1249
|
* @throws ApiError
|
|
1064
1250
|
*/
|
|
1065
|
-
|
|
1251
|
+
roboticsAgentControllerMoveToArea(data: TDataRoboticsAgentControllerMoveToArea$1): CancelablePromise<any>;
|
|
1066
1252
|
/**
|
|
1067
|
-
*
|
|
1068
|
-
* @param requestBody
|
|
1253
|
+
* get the status of the robot
|
|
1069
1254
|
* @returns any
|
|
1070
1255
|
* @throws ApiError
|
|
1071
1256
|
*/
|
|
1072
|
-
|
|
1257
|
+
roboticsAgentControllerStatusDescription(data: TDataRoboticsAgentControllerStatusDescription$1): CancelablePromise<any>;
|
|
1073
1258
|
/**
|
|
1074
|
-
*
|
|
1075
|
-
* @param moduleId
|
|
1259
|
+
* relocate the robot
|
|
1076
1260
|
* @returns any
|
|
1077
1261
|
* @throws ApiError
|
|
1078
1262
|
*/
|
|
1079
|
-
|
|
1263
|
+
roboticsAgentControllerMove(data: TDataRoboticsAgentControllerMove$1): CancelablePromise<any>;
|
|
1080
1264
|
/**
|
|
1081
|
-
*
|
|
1082
|
-
* @param moduleId
|
|
1265
|
+
* set initial pose of the robot
|
|
1083
1266
|
* @returns any
|
|
1084
1267
|
* @throws ApiError
|
|
1085
1268
|
*/
|
|
1086
|
-
|
|
1269
|
+
roboticsAgentControllerInitialPose(data: TDataRoboticsAgentControllerInitialPose$1): CancelablePromise<any>;
|
|
1087
1270
|
/**
|
|
1088
|
-
*
|
|
1089
|
-
* @param moduleId
|
|
1271
|
+
* execute an action on the robot
|
|
1090
1272
|
* @returns any
|
|
1091
1273
|
* @throws ApiError
|
|
1092
1274
|
*/
|
|
1093
|
-
|
|
1275
|
+
roboticsAgentControllerActuate(data: TDataRoboticsAgentControllerActuate$1): CancelablePromise<any>;
|
|
1094
1276
|
/**
|
|
1095
|
-
*
|
|
1096
|
-
* @param requestBody
|
|
1277
|
+
* get the status of the robot
|
|
1097
1278
|
* @returns any
|
|
1098
1279
|
* @throws ApiError
|
|
1099
1280
|
*/
|
|
1100
|
-
|
|
1281
|
+
roboticsAgentControllerStatus(data: TDataRoboticsAgentControllerStatus$1): CancelablePromise<any>;
|
|
1101
1282
|
}
|
|
1102
1283
|
|
|
1103
|
-
|
|
1284
|
+
type TDataLogin = {
|
|
1285
|
+
requestBody: LoginRequestDto;
|
|
1286
|
+
};
|
|
1287
|
+
type TDataRegister = {
|
|
1288
|
+
requestBody: RegistrationRequestDto;
|
|
1289
|
+
};
|
|
1290
|
+
type TDataRefreshToken = {
|
|
1291
|
+
requestBody: RefreshTokenRequestDto;
|
|
1292
|
+
};
|
|
1293
|
+
type TDataEdit = {
|
|
1294
|
+
requestBody: UpdateUserRequestDto;
|
|
1295
|
+
userId: string;
|
|
1296
|
+
};
|
|
1297
|
+
type TDataDelete = {
|
|
1298
|
+
userId: string;
|
|
1299
|
+
};
|
|
1300
|
+
type TDataAuthAdminControllerSaveUser = {
|
|
1301
|
+
requestBody: RegistrationRequestDto;
|
|
1302
|
+
};
|
|
1303
|
+
declare class AuthenticationService {
|
|
1104
1304
|
readonly httpRequest: BaseHttpRequest;
|
|
1105
1305
|
constructor(httpRequest: BaseHttpRequest);
|
|
1106
1306
|
/**
|
|
1107
|
-
*
|
|
1108
|
-
* @param appId
|
|
1109
|
-
* @param room
|
|
1110
|
-
* @returns any
|
|
1307
|
+
* @returns AuthJwtUser
|
|
1111
1308
|
* @throws ApiError
|
|
1112
1309
|
*/
|
|
1113
|
-
|
|
1310
|
+
whoami(): CancelablePromise<AuthJwtUser>;
|
|
1114
1311
|
/**
|
|
1115
|
-
*
|
|
1116
|
-
* @param appId
|
|
1117
|
-
* @param robotId
|
|
1118
|
-
* @returns any
|
|
1312
|
+
* @returns LoginResponseDto Login user
|
|
1119
1313
|
* @throws ApiError
|
|
1120
1314
|
*/
|
|
1121
|
-
|
|
1315
|
+
login(data: TDataLogin): CancelablePromise<LoginResponseDto>;
|
|
1122
1316
|
/**
|
|
1123
|
-
*
|
|
1124
|
-
* @param requestBody
|
|
1125
|
-
* @returns any
|
|
1317
|
+
* @returns RegistrationResponseDto Register a new user
|
|
1126
1318
|
* @throws ApiError
|
|
1127
1319
|
*/
|
|
1128
|
-
|
|
1320
|
+
register(data: TDataRegister): CancelablePromise<RegistrationResponseDto>;
|
|
1129
1321
|
/**
|
|
1130
|
-
*
|
|
1131
|
-
* @param requestBody
|
|
1132
|
-
* @returns any
|
|
1322
|
+
* @returns LoginResponseDto Refresh token
|
|
1133
1323
|
* @throws ApiError
|
|
1134
1324
|
*/
|
|
1135
|
-
|
|
1325
|
+
refreshToken(data: TDataRefreshToken): CancelablePromise<LoginResponseDto>;
|
|
1136
1326
|
/**
|
|
1137
|
-
*
|
|
1138
|
-
* @param requestBody
|
|
1139
|
-
* @returns any
|
|
1327
|
+
* @returns any Updates user data
|
|
1140
1328
|
* @throws ApiError
|
|
1141
1329
|
*/
|
|
1142
|
-
|
|
1330
|
+
edit(data: TDataEdit): CancelablePromise<any>;
|
|
1331
|
+
/**
|
|
1332
|
+
* @returns any Deletes a user and all of its resources
|
|
1333
|
+
* @throws ApiError
|
|
1334
|
+
*/
|
|
1335
|
+
delete(data: TDataDelete): CancelablePromise<any>;
|
|
1143
1336
|
/**
|
|
1144
|
-
* get the status of the robot
|
|
1145
|
-
* @param requestBody
|
|
1146
1337
|
* @returns any
|
|
1147
1338
|
* @throws ApiError
|
|
1148
1339
|
*/
|
|
1149
|
-
|
|
1340
|
+
authAdminControllerSaveUser(data: TDataAuthAdminControllerSaveUser): CancelablePromise<any>;
|
|
1341
|
+
}
|
|
1342
|
+
|
|
1343
|
+
type TDataDetectionControllerSentimentAnalysis = {
|
|
1344
|
+
requestBody: SentimentAnalysisRequest;
|
|
1345
|
+
};
|
|
1346
|
+
type TDataDetectionControllerInteractionIntention = {
|
|
1347
|
+
requestBody: UserInteractionIntentionDto;
|
|
1348
|
+
};
|
|
1349
|
+
type TDataDetectionControllerSendFrame = {
|
|
1350
|
+
appId: string;
|
|
1351
|
+
cameraId: string;
|
|
1352
|
+
formData: {
|
|
1353
|
+
file?: Blob | File;
|
|
1354
|
+
};
|
|
1355
|
+
};
|
|
1356
|
+
type TDataDetectionControllerServe = {
|
|
1357
|
+
appId: string;
|
|
1358
|
+
cameraId: string;
|
|
1359
|
+
overlay: string;
|
|
1360
|
+
};
|
|
1361
|
+
declare class DetectionService {
|
|
1362
|
+
readonly httpRequest: BaseHttpRequest;
|
|
1363
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
1150
1364
|
/**
|
|
1151
1365
|
* @returns any
|
|
1152
1366
|
* @throws ApiError
|
|
1153
1367
|
*/
|
|
1154
|
-
|
|
1368
|
+
detectionControllerSentimentAnalysis(data: TDataDetectionControllerSentimentAnalysis): CancelablePromise<any>;
|
|
1155
1369
|
/**
|
|
1156
|
-
* @param spaceId
|
|
1157
1370
|
* @returns any
|
|
1158
1371
|
* @throws ApiError
|
|
1159
1372
|
*/
|
|
1160
|
-
|
|
1373
|
+
detectionControllerInteractionIntention(data: TDataDetectionControllerInteractionIntention): CancelablePromise<any>;
|
|
1161
1374
|
/**
|
|
1162
|
-
* @param spaceId
|
|
1163
1375
|
* @returns any
|
|
1164
1376
|
* @throws ApiError
|
|
1165
1377
|
*/
|
|
1166
|
-
|
|
1378
|
+
detectionControllerSendFrame(data: TDataDetectionControllerSendFrame): CancelablePromise<any>;
|
|
1167
1379
|
/**
|
|
1168
|
-
* @param appId
|
|
1169
|
-
* @param robotId
|
|
1170
1380
|
* @returns any
|
|
1171
1381
|
* @throws ApiError
|
|
1172
1382
|
*/
|
|
1173
|
-
|
|
1383
|
+
detectionControllerServe(data: TDataDetectionControllerServe): CancelablePromise<any>;
|
|
1174
1384
|
}
|
|
1175
1385
|
|
|
1176
|
-
type
|
|
1177
|
-
|
|
1178
|
-
|
|
1179
|
-
|
|
1180
|
-
*/
|
|
1181
|
-
clientId?: string;
|
|
1182
|
-
/**
|
|
1183
|
-
* Reference to the user interacting with the system
|
|
1184
|
-
*/
|
|
1185
|
-
userId?: string;
|
|
1386
|
+
type TDataSave = {
|
|
1387
|
+
requestBody: DialogueDocumentDto;
|
|
1388
|
+
};
|
|
1389
|
+
type TDataImport = {
|
|
1186
1390
|
/**
|
|
1187
|
-
*
|
|
1391
|
+
* Documents list
|
|
1188
1392
|
*/
|
|
1189
|
-
|
|
1190
|
-
moduleId: string;
|
|
1191
|
-
status: 'unavailable' | 'error' | 'not_ready' | 'ready' | 'loading' | 'interacting' | 'waiting' | 'processing';
|
|
1393
|
+
requestBody: Array<DialogueDocumentDto>;
|
|
1192
1394
|
};
|
|
1193
|
-
|
|
1194
|
-
type SessionDto = {
|
|
1395
|
+
type TDataRemove = {
|
|
1195
1396
|
appId: string;
|
|
1196
|
-
|
|
1197
|
-
* Reference to the authenticated client the request originated from
|
|
1198
|
-
*/
|
|
1199
|
-
clientId?: string;
|
|
1200
|
-
/**
|
|
1201
|
-
* Reference to the user interacting with the system
|
|
1202
|
-
*/
|
|
1203
|
-
userId?: string;
|
|
1204
|
-
sessionId?: string;
|
|
1205
|
-
/**
|
|
1206
|
-
* Agent instance associated to the session
|
|
1207
|
-
*/
|
|
1208
|
-
agentId?: string;
|
|
1209
|
-
/**
|
|
1210
|
-
* Collect inferred identifiers of user interacting with the agent during a session.
|
|
1211
|
-
*/
|
|
1212
|
-
user?: Array<string>;
|
|
1213
|
-
modifiedAt: string;
|
|
1214
|
-
createdAt: string;
|
|
1215
|
-
closedAt: string;
|
|
1397
|
+
documentId: Array<string>;
|
|
1216
1398
|
};
|
|
1217
|
-
|
|
1218
|
-
|
|
1399
|
+
type TDataSpeak = {
|
|
1400
|
+
requestBody: DialogueTextToSpeechDto;
|
|
1401
|
+
};
|
|
1402
|
+
type TDataText = {
|
|
1219
1403
|
appId: string;
|
|
1220
|
-
|
|
1221
|
-
|
|
1222
|
-
|
|
1223
|
-
|
|
1224
|
-
|
|
1225
|
-
|
|
1226
|
-
|
|
1227
|
-
|
|
1228
|
-
|
|
1229
|
-
|
|
1230
|
-
|
|
1404
|
+
formData: {
|
|
1405
|
+
appId?: string;
|
|
1406
|
+
/**
|
|
1407
|
+
* Reference to the authenticated client the request originated from
|
|
1408
|
+
*/
|
|
1409
|
+
clientId?: string;
|
|
1410
|
+
/**
|
|
1411
|
+
* Reference to the user interacting with the system
|
|
1412
|
+
*/
|
|
1413
|
+
userId?: string;
|
|
1414
|
+
/**
|
|
1415
|
+
* User session identifier
|
|
1416
|
+
*/
|
|
1417
|
+
sessionId?: string;
|
|
1418
|
+
/**
|
|
1419
|
+
* Unique identifier of the message
|
|
1420
|
+
*/
|
|
1421
|
+
messageId?: string;
|
|
1422
|
+
/**
|
|
1423
|
+
* Actor providing the text, can be user or agent
|
|
1424
|
+
*/
|
|
1425
|
+
actor?: 'user' | 'agent';
|
|
1426
|
+
/**
|
|
1427
|
+
* Indicate a chunck identifier as timestamp, usually indicating it is part of a stream.
|
|
1428
|
+
*/
|
|
1429
|
+
text?: string;
|
|
1430
|
+
/**
|
|
1431
|
+
* Assistant gender (M or F)
|
|
1432
|
+
*/
|
|
1433
|
+
gender?: string;
|
|
1434
|
+
/**
|
|
1435
|
+
* Text language
|
|
1436
|
+
*/
|
|
1437
|
+
language?: string;
|
|
1438
|
+
/**
|
|
1439
|
+
* User emotion, if available
|
|
1440
|
+
*/
|
|
1441
|
+
emotion?: string;
|
|
1442
|
+
/**
|
|
1443
|
+
* LLM engine to use
|
|
1444
|
+
*/
|
|
1445
|
+
llm?: string;
|
|
1446
|
+
/**
|
|
1447
|
+
* Indicate a chunck identifier as timestamp, usually indicating it is part of a stream.
|
|
1448
|
+
*/
|
|
1449
|
+
chunkId?: number;
|
|
1450
|
+
file?: Blob | File;
|
|
1451
|
+
};
|
|
1452
|
+
sampleRate: number;
|
|
1453
|
+
sessionId: string;
|
|
1231
1454
|
};
|
|
1232
|
-
|
|
1233
|
-
type SessionStorageSearchDto = {
|
|
1455
|
+
type TDataChatMessage = {
|
|
1234
1456
|
appId: string;
|
|
1235
|
-
|
|
1236
|
-
sessionId
|
|
1237
|
-
storageId?: Array<string>;
|
|
1457
|
+
requestBody: DialogueMessageDto;
|
|
1458
|
+
sessionId: string;
|
|
1238
1459
|
};
|
|
1239
|
-
|
|
1240
|
-
type SessionSupportRequestDto = {
|
|
1460
|
+
type TDataStopAgentSpeech = {
|
|
1241
1461
|
appId: string;
|
|
1242
|
-
/**
|
|
1243
|
-
* Reference to the authenticated client the request originated from
|
|
1244
|
-
*/
|
|
1245
|
-
clientId?: string;
|
|
1246
|
-
/**
|
|
1247
|
-
* Reference to the user interacting with the system
|
|
1248
|
-
*/
|
|
1249
|
-
userId?: string;
|
|
1250
1462
|
sessionId: string;
|
|
1251
|
-
code: string;
|
|
1252
|
-
message: string;
|
|
1253
1463
|
};
|
|
1254
|
-
|
|
1255
|
-
type SessionSupportResponseDto = {
|
|
1464
|
+
type TDataGetToolsfFromAppId = {
|
|
1256
1465
|
appId: string;
|
|
1466
|
+
requestBody: Array<string>;
|
|
1467
|
+
sessionId: string;
|
|
1468
|
+
};
|
|
1469
|
+
declare class DialogueService {
|
|
1470
|
+
readonly httpRequest: BaseHttpRequest;
|
|
1471
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
1257
1472
|
/**
|
|
1258
|
-
*
|
|
1473
|
+
* @returns DialogueDocumentDto Saved document
|
|
1474
|
+
* @throws ApiError
|
|
1259
1475
|
*/
|
|
1260
|
-
|
|
1476
|
+
save(data: TDataSave): CancelablePromise<DialogueDocumentDto>;
|
|
1261
1477
|
/**
|
|
1262
|
-
*
|
|
1478
|
+
* Import RAG documents
|
|
1479
|
+
* @returns DialogueDocumentDto
|
|
1480
|
+
* @throws ApiError
|
|
1263
1481
|
*/
|
|
1264
|
-
|
|
1265
|
-
supportId: string;
|
|
1266
|
-
};
|
|
1267
|
-
|
|
1268
|
-
declare class SessionService {
|
|
1269
|
-
readonly httpRequest: BaseHttpRequest;
|
|
1270
|
-
constructor(httpRequest: BaseHttpRequest);
|
|
1482
|
+
import(data: TDataImport): CancelablePromise<Array<DialogueDocumentDto>>;
|
|
1271
1483
|
/**
|
|
1272
|
-
*
|
|
1273
|
-
* @param appId
|
|
1484
|
+
* Remove RAG documents
|
|
1274
1485
|
* @returns any
|
|
1275
1486
|
* @throws ApiError
|
|
1276
1487
|
*/
|
|
1277
|
-
|
|
1488
|
+
remove(data: TDataRemove): CancelablePromise<any>;
|
|
1278
1489
|
/**
|
|
1279
|
-
*
|
|
1280
|
-
* @param sessionId
|
|
1490
|
+
* Converts a text to voice as mp3
|
|
1281
1491
|
* @returns any
|
|
1282
1492
|
* @throws ApiError
|
|
1283
1493
|
*/
|
|
1284
|
-
|
|
1494
|
+
speak(data: TDataSpeak): CancelablePromise<any>;
|
|
1285
1495
|
/**
|
|
1286
|
-
* Remove session
|
|
1287
|
-
* @param sessionId
|
|
1288
1496
|
* @returns any
|
|
1289
1497
|
* @throws ApiError
|
|
1290
1498
|
*/
|
|
1291
|
-
|
|
1499
|
+
text(data: TDataText): CancelablePromise<any>;
|
|
1292
1500
|
/**
|
|
1293
|
-
* Create session
|
|
1294
|
-
* @param requestBody
|
|
1295
1501
|
* @returns any
|
|
1296
1502
|
* @throws ApiError
|
|
1297
1503
|
*/
|
|
1298
|
-
|
|
1504
|
+
chatMessage(data: TDataChatMessage): CancelablePromise<any>;
|
|
1299
1505
|
/**
|
|
1300
|
-
* Update session
|
|
1301
|
-
* @param requestBody
|
|
1302
1506
|
* @returns any
|
|
1303
1507
|
* @throws ApiError
|
|
1304
1508
|
*/
|
|
1305
|
-
|
|
1509
|
+
stopAgentSpeech(data: TDataStopAgentSpeech): CancelablePromise<any>;
|
|
1306
1510
|
/**
|
|
1307
|
-
* Notifies of an agent update
|
|
1308
|
-
* @param requestBody
|
|
1309
1511
|
* @returns any
|
|
1310
1512
|
* @throws ApiError
|
|
1311
1513
|
*/
|
|
1312
|
-
|
|
1514
|
+
import1(): CancelablePromise<any>;
|
|
1313
1515
|
/**
|
|
1314
|
-
*
|
|
1315
|
-
* @param requestBody
|
|
1316
|
-
* @returns SessionSupportResponseDto Human support requested
|
|
1516
|
+
* @returns any
|
|
1317
1517
|
* @throws ApiError
|
|
1318
1518
|
*/
|
|
1319
|
-
|
|
1519
|
+
getToolsfFromAppId(data: TDataGetToolsfFromAppId): CancelablePromise<any>;
|
|
1520
|
+
}
|
|
1521
|
+
|
|
1522
|
+
type TDataGetClientAccessToken = {
|
|
1523
|
+
requestBody: AccessTokenRequestDto;
|
|
1524
|
+
};
|
|
1525
|
+
type TDataGetClientAccessToken1 = {
|
|
1526
|
+
requestBody: AccessTokenRequestDto;
|
|
1527
|
+
};
|
|
1528
|
+
type TDataGetClientRefreshToken = {
|
|
1529
|
+
requestBody: RefreshTokenRequestDto;
|
|
1530
|
+
};
|
|
1531
|
+
type TDataGetClientRefreshToken1 = {
|
|
1532
|
+
requestBody: RefreshTokenRequestDto;
|
|
1533
|
+
};
|
|
1534
|
+
type TDataCreateApp = {
|
|
1535
|
+
requestBody: CreatePlatformAppDto;
|
|
1536
|
+
};
|
|
1537
|
+
type TDataUpdateApp = {
|
|
1538
|
+
requestBody: PlatformAppDto;
|
|
1539
|
+
};
|
|
1540
|
+
type TDataUpdateAppTools = {
|
|
1541
|
+
appId: string;
|
|
1542
|
+
requestBody: Array<AppToolsDTO>;
|
|
1543
|
+
};
|
|
1544
|
+
type TDataUpdateAppSettings = {
|
|
1545
|
+
appId: string;
|
|
1546
|
+
requestBody: Array<AppSettingsDto>;
|
|
1547
|
+
};
|
|
1548
|
+
type TDataGetAppRepository = {
|
|
1549
|
+
appId: string;
|
|
1550
|
+
};
|
|
1551
|
+
type TDataGetAppRepositoryRobots = {
|
|
1552
|
+
appId: string;
|
|
1553
|
+
name: string;
|
|
1554
|
+
};
|
|
1555
|
+
type TDataGetAppRepositoryAvatars = {
|
|
1556
|
+
appId: string;
|
|
1557
|
+
name: string;
|
|
1558
|
+
};
|
|
1559
|
+
type TDataGetAppRepositoryBackgrounds = {
|
|
1560
|
+
appId: string;
|
|
1561
|
+
name: string;
|
|
1562
|
+
};
|
|
1563
|
+
type TDataReadApp = {
|
|
1564
|
+
appId: string;
|
|
1565
|
+
};
|
|
1566
|
+
type TDataRemoveApp = {
|
|
1567
|
+
appId: string;
|
|
1568
|
+
};
|
|
1569
|
+
type TDataImportApps = {
|
|
1570
|
+
requestBody: Array<PlatformAppDto>;
|
|
1571
|
+
skipClients: string;
|
|
1572
|
+
};
|
|
1573
|
+
type TDataExportApps = {
|
|
1574
|
+
requestBody: PlatformAppExportFilterDto;
|
|
1575
|
+
};
|
|
1576
|
+
type TDataRemoveApps = {
|
|
1577
|
+
requestBody: PlatformAppExportFilterDto;
|
|
1578
|
+
};
|
|
1579
|
+
type TDataCreateClient = {
|
|
1580
|
+
appId: string;
|
|
1581
|
+
requestBody: AppClientDto;
|
|
1582
|
+
};
|
|
1583
|
+
type TDataReadClient = {
|
|
1584
|
+
appId: string;
|
|
1585
|
+
clientId: string;
|
|
1586
|
+
};
|
|
1587
|
+
type TDataRemoveClient = {
|
|
1588
|
+
appId: string;
|
|
1589
|
+
clientId: string;
|
|
1590
|
+
};
|
|
1591
|
+
type TDataListTopics = {
|
|
1592
|
+
appId: string;
|
|
1593
|
+
clientId: string;
|
|
1594
|
+
};
|
|
1595
|
+
type TDataSaveAppModule = {
|
|
1596
|
+
appId: string;
|
|
1597
|
+
requestBody: AppModuleConfigDto;
|
|
1598
|
+
};
|
|
1599
|
+
type TDataGetAppModule = {
|
|
1600
|
+
appId: string;
|
|
1601
|
+
moduleId: string;
|
|
1602
|
+
};
|
|
1603
|
+
type TDataRemoveAppModule = {
|
|
1604
|
+
appId: string;
|
|
1605
|
+
moduleId: string;
|
|
1606
|
+
};
|
|
1607
|
+
type TDataSavePlatformModule = {
|
|
1608
|
+
requestBody: PlatformModuleConfigDto;
|
|
1609
|
+
};
|
|
1610
|
+
type TDataRefreshPlatformModule = {
|
|
1611
|
+
moduleId: string;
|
|
1612
|
+
};
|
|
1613
|
+
type TDataGetPlatformModule = {
|
|
1614
|
+
moduleId: string;
|
|
1615
|
+
};
|
|
1616
|
+
type TDataRemovePlatformModule = {
|
|
1617
|
+
moduleId: string;
|
|
1618
|
+
};
|
|
1619
|
+
type TDataDataLoggerControllerGetLogs = {
|
|
1620
|
+
appId: string;
|
|
1621
|
+
requestBody: ViewLogsRequestDto;
|
|
1622
|
+
};
|
|
1623
|
+
declare class PlatformService {
|
|
1624
|
+
readonly httpRequest: BaseHttpRequest;
|
|
1625
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
1320
1626
|
/**
|
|
1321
|
-
*
|
|
1322
|
-
* @param requestBody
|
|
1323
|
-
* @returns SessionStorageRecordDto Record stored
|
|
1627
|
+
* @returns PlatformSettingsDto
|
|
1324
1628
|
* @throws ApiError
|
|
1325
1629
|
*/
|
|
1326
|
-
|
|
1630
|
+
getUserSettings(): CancelablePromise<PlatformSettingsDto>;
|
|
1327
1631
|
/**
|
|
1328
|
-
*
|
|
1329
|
-
* @param requestBody
|
|
1330
|
-
* @returns SessionStorageRecordDto Record stored
|
|
1632
|
+
* @returns PlatformSettingsDto
|
|
1331
1633
|
* @throws ApiError
|
|
1332
1634
|
*/
|
|
1333
|
-
|
|
1635
|
+
getSettings(): CancelablePromise<PlatformSettingsDto>;
|
|
1334
1636
|
/**
|
|
1335
|
-
*
|
|
1336
|
-
* @param storageId
|
|
1337
|
-
* @returns SessionStorageRecordDto Record retrieved
|
|
1637
|
+
* @returns JwtTokenDto Request an access token for an app
|
|
1338
1638
|
* @throws ApiError
|
|
1339
1639
|
*/
|
|
1340
|
-
|
|
1640
|
+
getClientAccessToken(data: TDataGetClientAccessToken): CancelablePromise<JwtTokenDto>;
|
|
1341
1641
|
/**
|
|
1342
|
-
*
|
|
1343
|
-
* @param storageId
|
|
1344
|
-
* @returns any Record deleted
|
|
1642
|
+
* @returns JwtTokenDto Request an access token for an app
|
|
1345
1643
|
* @throws ApiError
|
|
1346
1644
|
*/
|
|
1347
|
-
|
|
1348
|
-
}
|
|
1349
|
-
|
|
1350
|
-
type UIContentOptionsDto = {
|
|
1645
|
+
getClientAccessToken1(data: TDataGetClientAccessToken1): CancelablePromise<JwtTokenDto>;
|
|
1351
1646
|
/**
|
|
1352
|
-
*
|
|
1647
|
+
* @returns JwtTokenDto Request a refresh access token for an app
|
|
1648
|
+
* @throws ApiError
|
|
1353
1649
|
*/
|
|
1354
|
-
|
|
1650
|
+
getClientRefreshToken(data: TDataGetClientRefreshToken): CancelablePromise<JwtTokenDto>;
|
|
1355
1651
|
/**
|
|
1356
|
-
*
|
|
1652
|
+
* @returns JwtTokenDto Request a refresh access token for an app
|
|
1653
|
+
* @throws ApiError
|
|
1357
1654
|
*/
|
|
1358
|
-
|
|
1655
|
+
getClientRefreshToken1(data: TDataGetClientRefreshToken1): CancelablePromise<JwtTokenDto>;
|
|
1359
1656
|
/**
|
|
1360
|
-
*
|
|
1657
|
+
* @returns PlatformAppDto
|
|
1658
|
+
* @throws ApiError
|
|
1361
1659
|
*/
|
|
1362
|
-
|
|
1363
|
-
};
|
|
1364
|
-
|
|
1365
|
-
type UIContentDto = {
|
|
1366
|
-
appId: string;
|
|
1660
|
+
platformAppControllerListApps(): CancelablePromise<Array<PlatformAppDto>>;
|
|
1367
1661
|
/**
|
|
1368
|
-
*
|
|
1662
|
+
* @returns PlatformAppDto
|
|
1663
|
+
* @throws ApiError
|
|
1369
1664
|
*/
|
|
1370
|
-
|
|
1665
|
+
createApp(data: TDataCreateApp): CancelablePromise<PlatformAppDto>;
|
|
1371
1666
|
/**
|
|
1372
|
-
*
|
|
1667
|
+
* @returns PlatformAppDto
|
|
1668
|
+
* @throws ApiError
|
|
1373
1669
|
*/
|
|
1374
|
-
|
|
1670
|
+
updateApp(data: TDataUpdateApp): CancelablePromise<PlatformAppDto>;
|
|
1375
1671
|
/**
|
|
1376
|
-
*
|
|
1672
|
+
* @returns PlatformAppDto
|
|
1673
|
+
* @throws ApiError
|
|
1377
1674
|
*/
|
|
1378
|
-
|
|
1379
|
-
contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
1380
|
-
content: Record<string, any>;
|
|
1381
|
-
metadata?: Record<string, any>;
|
|
1382
|
-
options?: UIContentOptionsDto;
|
|
1383
|
-
chunkId?: number;
|
|
1384
|
-
messageId?: string;
|
|
1385
|
-
};
|
|
1386
|
-
|
|
1387
|
-
type UIInteractionDTO = {
|
|
1388
|
-
context: Record<string, any>;
|
|
1389
|
-
element: string;
|
|
1390
|
-
value: string;
|
|
1391
|
-
};
|
|
1392
|
-
|
|
1393
|
-
type UIModelMapBlendShapesRequestDto = {
|
|
1394
|
-
blendShapes: Array<string>;
|
|
1395
|
-
};
|
|
1396
|
-
|
|
1397
|
-
type UIModelMapBlendShapesResponseDto = {
|
|
1398
|
-
blendShapes: Record<string, any>;
|
|
1399
|
-
};
|
|
1400
|
-
|
|
1401
|
-
declare class UiService {
|
|
1402
|
-
readonly httpRequest: BaseHttpRequest;
|
|
1403
|
-
constructor(httpRequest: BaseHttpRequest);
|
|
1675
|
+
listUserApps(): CancelablePromise<Array<PlatformAppDto>>;
|
|
1404
1676
|
/**
|
|
1405
|
-
* Trigger a UI interaction
|
|
1406
|
-
* @param appId
|
|
1407
|
-
* @param moduleId
|
|
1408
|
-
* @param requestBody
|
|
1409
1677
|
* @returns any
|
|
1410
1678
|
* @throws ApiError
|
|
1411
1679
|
*/
|
|
1412
|
-
|
|
1680
|
+
updateAppTools(data: TDataUpdateAppTools): CancelablePromise<any>;
|
|
1413
1681
|
/**
|
|
1414
|
-
*
|
|
1415
|
-
* @param requestBody
|
|
1416
|
-
* @returns UIContentDto Content to show
|
|
1682
|
+
* @returns any
|
|
1417
1683
|
* @throws ApiError
|
|
1418
1684
|
*/
|
|
1419
|
-
|
|
1685
|
+
updateAppSettings(data: TDataUpdateAppSettings): CancelablePromise<any>;
|
|
1420
1686
|
/**
|
|
1421
|
-
*
|
|
1422
|
-
* @param requestBody
|
|
1423
|
-
* @returns UIModelMapBlendShapesResponseDto Map model blend shapes
|
|
1687
|
+
* @returns RepositoryConfigDto
|
|
1424
1688
|
* @throws ApiError
|
|
1425
1689
|
*/
|
|
1426
|
-
|
|
1427
|
-
}
|
|
1428
|
-
|
|
1429
|
-
type XRMarkerDto = {
|
|
1430
|
-
appId: string;
|
|
1690
|
+
getAppRepository(data: TDataGetAppRepository): CancelablePromise<RepositoryConfigDto>;
|
|
1431
1691
|
/**
|
|
1432
|
-
*
|
|
1692
|
+
* @returns RepositoryRobotModelDto
|
|
1693
|
+
* @throws ApiError
|
|
1433
1694
|
*/
|
|
1434
|
-
|
|
1695
|
+
getAppRepositoryRobots(data: TDataGetAppRepositoryRobots): CancelablePromise<RepositoryRobotModelDto>;
|
|
1435
1696
|
/**
|
|
1436
|
-
*
|
|
1697
|
+
* @returns RepositoryAvatarModelDto
|
|
1698
|
+
* @throws ApiError
|
|
1437
1699
|
*/
|
|
1438
|
-
|
|
1700
|
+
getAppRepositoryAvatars(data: TDataGetAppRepositoryAvatars): CancelablePromise<RepositoryAvatarModelDto>;
|
|
1439
1701
|
/**
|
|
1440
|
-
*
|
|
1702
|
+
* @returns RepositoryConfigDto
|
|
1703
|
+
* @throws ApiError
|
|
1441
1704
|
*/
|
|
1442
|
-
|
|
1705
|
+
getAppRepositoryBackgrounds(data: TDataGetAppRepositoryBackgrounds): CancelablePromise<RepositoryConfigDto>;
|
|
1443
1706
|
/**
|
|
1444
|
-
*
|
|
1707
|
+
* @returns PlatformAppDto
|
|
1708
|
+
* @throws ApiError
|
|
1445
1709
|
*/
|
|
1446
|
-
|
|
1710
|
+
readApp(data: TDataReadApp): CancelablePromise<PlatformAppDto>;
|
|
1447
1711
|
/**
|
|
1448
|
-
*
|
|
1712
|
+
* @returns any
|
|
1713
|
+
* @throws ApiError
|
|
1449
1714
|
*/
|
|
1450
|
-
|
|
1451
|
-
};
|
|
1452
|
-
|
|
1453
|
-
type XRMarkerListRequestDto = {
|
|
1454
|
-
appId: string;
|
|
1715
|
+
removeApp(data: TDataRemoveApp): CancelablePromise<any>;
|
|
1455
1716
|
/**
|
|
1456
|
-
*
|
|
1717
|
+
* Batch import of applications
|
|
1718
|
+
* @returns PlatformAppDto
|
|
1719
|
+
* @throws ApiError
|
|
1457
1720
|
*/
|
|
1458
|
-
|
|
1721
|
+
importApps(data: TDataImportApps): CancelablePromise<Array<PlatformAppDto>>;
|
|
1459
1722
|
/**
|
|
1460
|
-
*
|
|
1723
|
+
* Batch export applications
|
|
1724
|
+
* @returns PlatformAppDto
|
|
1725
|
+
* @throws ApiError
|
|
1461
1726
|
*/
|
|
1462
|
-
|
|
1463
|
-
tags?: Array<string>;
|
|
1464
|
-
};
|
|
1465
|
-
|
|
1466
|
-
type XROcclusionResponseDto = {
|
|
1467
|
-
appId: string;
|
|
1727
|
+
exportApps(data: TDataExportApps): CancelablePromise<Array<PlatformAppDto>>;
|
|
1468
1728
|
/**
|
|
1469
|
-
*
|
|
1729
|
+
* Remove applications
|
|
1730
|
+
* @returns any
|
|
1731
|
+
* @throws ApiError
|
|
1470
1732
|
*/
|
|
1471
|
-
|
|
1733
|
+
removeApps(data: TDataRemoveApps): CancelablePromise<any>;
|
|
1472
1734
|
/**
|
|
1473
|
-
*
|
|
1735
|
+
* @returns AppClientDto
|
|
1736
|
+
* @throws ApiError
|
|
1737
|
+
*/
|
|
1738
|
+
createClient(data: TDataCreateClient): CancelablePromise<AppClientDto>;
|
|
1739
|
+
/**
|
|
1740
|
+
* @returns AppClientDto
|
|
1741
|
+
* @throws ApiError
|
|
1742
|
+
*/
|
|
1743
|
+
readClient(data: TDataReadClient): CancelablePromise<AppClientDto>;
|
|
1744
|
+
/**
|
|
1745
|
+
* @returns any
|
|
1746
|
+
* @throws ApiError
|
|
1747
|
+
*/
|
|
1748
|
+
removeClient(data: TDataRemoveClient): CancelablePromise<any>;
|
|
1749
|
+
/**
|
|
1750
|
+
* @returns string
|
|
1751
|
+
* @throws ApiError
|
|
1752
|
+
*/
|
|
1753
|
+
listTopics(data: TDataListTopics): CancelablePromise<Array<string>>;
|
|
1754
|
+
/**
|
|
1755
|
+
* Create or update an app module
|
|
1756
|
+
* @returns any
|
|
1757
|
+
* @throws ApiError
|
|
1758
|
+
*/
|
|
1759
|
+
saveAppModule(data: TDataSaveAppModule): CancelablePromise<any>;
|
|
1760
|
+
/**
|
|
1761
|
+
* Retrieve an app module
|
|
1762
|
+
* @returns any
|
|
1763
|
+
* @throws ApiError
|
|
1764
|
+
*/
|
|
1765
|
+
getAppModule(data: TDataGetAppModule): CancelablePromise<any>;
|
|
1766
|
+
/**
|
|
1767
|
+
* Remove an app module
|
|
1768
|
+
* @returns any
|
|
1769
|
+
* @throws ApiError
|
|
1474
1770
|
*/
|
|
1475
|
-
|
|
1476
|
-
occlusion: boolean;
|
|
1477
|
-
};
|
|
1478
|
-
|
|
1479
|
-
declare class XrService {
|
|
1480
|
-
readonly httpRequest: BaseHttpRequest;
|
|
1481
|
-
constructor(httpRequest: BaseHttpRequest);
|
|
1771
|
+
removeAppModule(data: TDataRemoveAppModule): CancelablePromise<any>;
|
|
1482
1772
|
/**
|
|
1483
|
-
*
|
|
1484
|
-
* @
|
|
1485
|
-
* @returns XRMarkerDto Marker created or updated
|
|
1773
|
+
* Create or update an app module
|
|
1774
|
+
* @returns any
|
|
1486
1775
|
* @throws ApiError
|
|
1487
1776
|
*/
|
|
1488
|
-
|
|
1777
|
+
savePlatformModule(data: TDataSavePlatformModule): CancelablePromise<any>;
|
|
1489
1778
|
/**
|
|
1490
|
-
*
|
|
1491
|
-
* @
|
|
1492
|
-
* @returns XRMarkerDto Marker saved
|
|
1779
|
+
* reload app module specs
|
|
1780
|
+
* @returns any
|
|
1493
1781
|
* @throws ApiError
|
|
1494
1782
|
*/
|
|
1495
|
-
|
|
1783
|
+
refreshPlatformModule(data: TDataRefreshPlatformModule): CancelablePromise<any>;
|
|
1496
1784
|
/**
|
|
1497
|
-
*
|
|
1498
|
-
* @
|
|
1499
|
-
* @returns XRMarkerDto Marker deleted
|
|
1785
|
+
* Retrieve an app module
|
|
1786
|
+
* @returns any
|
|
1500
1787
|
* @throws ApiError
|
|
1501
1788
|
*/
|
|
1502
|
-
|
|
1789
|
+
getPlatformModule(data: TDataGetPlatformModule): CancelablePromise<any>;
|
|
1503
1790
|
/**
|
|
1504
|
-
*
|
|
1505
|
-
* @
|
|
1506
|
-
* @returns binary Marker retrieved
|
|
1791
|
+
* Remove an app module
|
|
1792
|
+
* @returns any
|
|
1507
1793
|
* @throws ApiError
|
|
1508
1794
|
*/
|
|
1509
|
-
|
|
1795
|
+
removePlatformModule(data: TDataRemovePlatformModule): CancelablePromise<any>;
|
|
1510
1796
|
/**
|
|
1511
|
-
*
|
|
1512
|
-
* @returns XROcclusionResponseDto Got information about 3D model
|
|
1797
|
+
* @returns any
|
|
1513
1798
|
* @throws ApiError
|
|
1514
1799
|
*/
|
|
1515
|
-
|
|
1516
|
-
}
|
|
1517
|
-
|
|
1518
|
-
type HttpRequestConstructor = new (config: OpenAPIConfig) => BaseHttpRequest;
|
|
1519
|
-
declare class SermasApi {
|
|
1520
|
-
readonly agent: AgentService;
|
|
1521
|
-
readonly authentication: AuthenticationService;
|
|
1522
|
-
readonly detection: DetectionService;
|
|
1523
|
-
readonly dialogue: DialogueService;
|
|
1524
|
-
readonly platform: PlatformService;
|
|
1525
|
-
readonly robotics: RoboticsService;
|
|
1526
|
-
readonly session: SessionService;
|
|
1527
|
-
readonly ui: UiService;
|
|
1528
|
-
readonly xr: XrService;
|
|
1529
|
-
readonly request: BaseHttpRequest;
|
|
1530
|
-
constructor(config?: Partial<OpenAPIConfig>, HttpRequest?: HttpRequestConstructor);
|
|
1800
|
+
dataLoggerControllerGetLogs(data: TDataDataLoggerControllerGetLogs): CancelablePromise<any>;
|
|
1531
1801
|
}
|
|
1532
1802
|
|
|
1533
|
-
type
|
|
1534
|
-
|
|
1535
|
-
|
|
1536
|
-
label?: string;
|
|
1537
|
-
classes?: Array<string>;
|
|
1538
|
-
options?: UIContentOptionsDto;
|
|
1803
|
+
type TDataRoboticsAgentControllerMoveToArea = {
|
|
1804
|
+
appId: string;
|
|
1805
|
+
room: string;
|
|
1539
1806
|
};
|
|
1540
|
-
|
|
1541
|
-
|
|
1542
|
-
|
|
1543
|
-
list: Array<ButtonDto>;
|
|
1807
|
+
type TDataRoboticsAgentControllerStatusDescription = {
|
|
1808
|
+
appId: string;
|
|
1809
|
+
robotId: string;
|
|
1544
1810
|
};
|
|
1545
|
-
|
|
1546
|
-
|
|
1811
|
+
type TDataRoboticsAgentControllerMove = {
|
|
1812
|
+
requestBody: MovementEventDto;
|
|
1813
|
+
};
|
|
1814
|
+
type TDataRoboticsAgentControllerInitialPose = {
|
|
1815
|
+
requestBody: SermasBaseDto;
|
|
1816
|
+
};
|
|
1817
|
+
type TDataRoboticsAgentControllerActuate = {
|
|
1818
|
+
requestBody: ActuationEventDto;
|
|
1819
|
+
};
|
|
1820
|
+
type TDataRoboticsAgentControllerStatus = {
|
|
1821
|
+
requestBody: StatusEventDto;
|
|
1822
|
+
};
|
|
1823
|
+
type TDataNavigationControllerRemove = {
|
|
1824
|
+
spaceId: string;
|
|
1825
|
+
};
|
|
1826
|
+
type TDataNavigationControllerGetById = {
|
|
1827
|
+
spaceId: string;
|
|
1828
|
+
};
|
|
1829
|
+
type TDataNavigationControllerGetStatus = {
|
|
1547
1830
|
appId: string;
|
|
1831
|
+
robotId: string;
|
|
1832
|
+
};
|
|
1833
|
+
declare class RoboticsService {
|
|
1834
|
+
readonly httpRequest: BaseHttpRequest;
|
|
1835
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
1548
1836
|
/**
|
|
1549
|
-
*
|
|
1550
|
-
|
|
1551
|
-
|
|
1552
|
-
/**
|
|
1553
|
-
* Reference to the user interacting with the system
|
|
1554
|
-
*/
|
|
1555
|
-
userId?: string;
|
|
1556
|
-
/**
|
|
1557
|
-
* Track the interaction session, if available
|
|
1837
|
+
* move the robot to a specified coordinates. Based on the parameter coordinates, move the robot to that coordinates.
|
|
1838
|
+
* @returns any
|
|
1839
|
+
* @throws ApiError
|
|
1558
1840
|
*/
|
|
1559
|
-
|
|
1560
|
-
contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
1561
|
-
content: ButtonsContentDto;
|
|
1562
|
-
metadata?: Record<string, any>;
|
|
1563
|
-
options?: UIContentOptionsDto;
|
|
1564
|
-
chunkId?: number;
|
|
1565
|
-
messageId?: string;
|
|
1566
|
-
};
|
|
1567
|
-
|
|
1568
|
-
type ClearScreenDto = {
|
|
1569
|
-
appId: string;
|
|
1841
|
+
roboticsAgentControllerMoveToArea(data: TDataRoboticsAgentControllerMoveToArea): CancelablePromise<any>;
|
|
1570
1842
|
/**
|
|
1571
|
-
*
|
|
1843
|
+
* get the status of the robot
|
|
1844
|
+
* @returns any
|
|
1845
|
+
* @throws ApiError
|
|
1572
1846
|
*/
|
|
1573
|
-
|
|
1847
|
+
roboticsAgentControllerStatusDescription(data: TDataRoboticsAgentControllerStatusDescription): CancelablePromise<any>;
|
|
1574
1848
|
/**
|
|
1575
|
-
*
|
|
1849
|
+
* relocate the robot
|
|
1850
|
+
* @returns any
|
|
1851
|
+
* @throws ApiError
|
|
1576
1852
|
*/
|
|
1577
|
-
|
|
1853
|
+
roboticsAgentControllerMove(data: TDataRoboticsAgentControllerMove): CancelablePromise<any>;
|
|
1578
1854
|
/**
|
|
1579
|
-
*
|
|
1855
|
+
* set initial pose of the robot
|
|
1856
|
+
* @returns any
|
|
1857
|
+
* @throws ApiError
|
|
1580
1858
|
*/
|
|
1581
|
-
|
|
1582
|
-
contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
1583
|
-
content: Record<string, any>;
|
|
1584
|
-
metadata?: Record<string, any>;
|
|
1585
|
-
options?: UIContentOptionsDto;
|
|
1586
|
-
chunkId?: number;
|
|
1587
|
-
messageId?: string;
|
|
1588
|
-
};
|
|
1589
|
-
|
|
1590
|
-
type ClearUIContentDto = {
|
|
1591
|
-
appId: string;
|
|
1859
|
+
roboticsAgentControllerInitialPose(data: TDataRoboticsAgentControllerInitialPose): CancelablePromise<any>;
|
|
1592
1860
|
/**
|
|
1593
|
-
*
|
|
1861
|
+
* execute an action on the robot
|
|
1862
|
+
* @returns any
|
|
1863
|
+
* @throws ApiError
|
|
1594
1864
|
*/
|
|
1595
|
-
|
|
1865
|
+
roboticsAgentControllerActuate(data: TDataRoboticsAgentControllerActuate): CancelablePromise<any>;
|
|
1596
1866
|
/**
|
|
1597
|
-
*
|
|
1867
|
+
* get the status of the robot
|
|
1868
|
+
* @returns any
|
|
1869
|
+
* @throws ApiError
|
|
1598
1870
|
*/
|
|
1599
|
-
|
|
1871
|
+
roboticsAgentControllerStatus(data: TDataRoboticsAgentControllerStatus): CancelablePromise<any>;
|
|
1600
1872
|
/**
|
|
1601
|
-
*
|
|
1873
|
+
* @returns any
|
|
1874
|
+
* @throws ApiError
|
|
1602
1875
|
*/
|
|
1603
|
-
|
|
1604
|
-
contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
1605
|
-
content: Record<string, any>;
|
|
1606
|
-
metadata?: Record<string, any>;
|
|
1607
|
-
options?: UIContentOptionsDto;
|
|
1608
|
-
chunkId?: number;
|
|
1609
|
-
messageId?: string;
|
|
1610
|
-
};
|
|
1611
|
-
|
|
1612
|
-
type DialogueMessageUIContentDto = {
|
|
1613
|
-
appId: string;
|
|
1876
|
+
navigationControllerSave(): CancelablePromise<any>;
|
|
1614
1877
|
/**
|
|
1615
|
-
*
|
|
1878
|
+
* @returns any
|
|
1879
|
+
* @throws ApiError
|
|
1616
1880
|
*/
|
|
1617
|
-
|
|
1881
|
+
navigationControllerRemove(data: TDataNavigationControllerRemove): CancelablePromise<any>;
|
|
1618
1882
|
/**
|
|
1619
|
-
*
|
|
1883
|
+
* @returns any
|
|
1884
|
+
* @throws ApiError
|
|
1620
1885
|
*/
|
|
1621
|
-
|
|
1886
|
+
navigationControllerGetById(data: TDataNavigationControllerGetById): CancelablePromise<any>;
|
|
1622
1887
|
/**
|
|
1623
|
-
*
|
|
1888
|
+
* @returns any
|
|
1889
|
+
* @throws ApiError
|
|
1624
1890
|
*/
|
|
1625
|
-
|
|
1626
|
-
|
|
1627
|
-
content: DialogueMessageDto;
|
|
1628
|
-
metadata?: Record<string, any>;
|
|
1629
|
-
options?: UIContentOptionsDto;
|
|
1630
|
-
chunkId?: number;
|
|
1631
|
-
messageId?: string;
|
|
1632
|
-
};
|
|
1633
|
-
|
|
1634
|
-
type EmailContentDto = {
|
|
1635
|
-
email: string;
|
|
1636
|
-
label: string;
|
|
1637
|
-
};
|
|
1891
|
+
navigationControllerGetStatus(data: TDataNavigationControllerGetStatus): CancelablePromise<any>;
|
|
1892
|
+
}
|
|
1638
1893
|
|
|
1639
|
-
type
|
|
1894
|
+
type TDataGetUserSession = {
|
|
1640
1895
|
appId: string;
|
|
1641
|
-
/**
|
|
1642
|
-
* Reference to the authenticated client the request originated from
|
|
1643
|
-
*/
|
|
1644
|
-
clientId?: string;
|
|
1645
|
-
/**
|
|
1646
|
-
* Reference to the user interacting with the system
|
|
1647
|
-
*/
|
|
1648
|
-
userId?: string;
|
|
1649
|
-
/**
|
|
1650
|
-
* Track the interaction session, if available
|
|
1651
|
-
*/
|
|
1652
|
-
sessionId?: string;
|
|
1653
|
-
contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
1654
|
-
content: EmailContentDto;
|
|
1655
|
-
metadata?: Record<string, any>;
|
|
1656
|
-
options?: UIContentOptionsDto;
|
|
1657
|
-
chunkId?: number;
|
|
1658
|
-
messageId?: string;
|
|
1659
1896
|
};
|
|
1660
|
-
|
|
1661
|
-
|
|
1662
|
-
html: string;
|
|
1897
|
+
type TDataReadSession = {
|
|
1898
|
+
sessionId: string;
|
|
1663
1899
|
};
|
|
1664
|
-
|
|
1665
|
-
|
|
1666
|
-
appId: string;
|
|
1667
|
-
/**
|
|
1668
|
-
* Reference to the authenticated client the request originated from
|
|
1669
|
-
*/
|
|
1670
|
-
clientId?: string;
|
|
1671
|
-
/**
|
|
1672
|
-
* Reference to the user interacting with the system
|
|
1673
|
-
*/
|
|
1674
|
-
userId?: string;
|
|
1675
|
-
/**
|
|
1676
|
-
* Track the interaction session, if available
|
|
1677
|
-
*/
|
|
1678
|
-
sessionId?: string;
|
|
1679
|
-
contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
1680
|
-
content: HtmlContentDto;
|
|
1681
|
-
metadata?: Record<string, any>;
|
|
1682
|
-
options?: UIContentOptionsDto;
|
|
1683
|
-
chunkId?: number;
|
|
1684
|
-
messageId?: string;
|
|
1900
|
+
type TDataDeleteSession = {
|
|
1901
|
+
sessionId: string;
|
|
1685
1902
|
};
|
|
1686
|
-
|
|
1687
|
-
|
|
1688
|
-
src: string;
|
|
1689
|
-
width?: number;
|
|
1690
|
-
height?: number;
|
|
1691
|
-
alt: string;
|
|
1903
|
+
type TDataCreateSession = {
|
|
1904
|
+
requestBody: SessionDto;
|
|
1692
1905
|
};
|
|
1693
|
-
|
|
1694
|
-
|
|
1695
|
-
|
|
1696
|
-
|
|
1697
|
-
|
|
1698
|
-
|
|
1699
|
-
|
|
1906
|
+
type TDataUpdateSession = {
|
|
1907
|
+
requestBody: SessionDto;
|
|
1908
|
+
};
|
|
1909
|
+
type TDataAgentUpdate = {
|
|
1910
|
+
requestBody: AgentHeartBeatEventDto;
|
|
1911
|
+
};
|
|
1912
|
+
type TDataSupport = {
|
|
1913
|
+
requestBody: SessionSupportRequestDto;
|
|
1914
|
+
};
|
|
1915
|
+
type TDataSetRecord = {
|
|
1916
|
+
requestBody: SessionStorageRecordDto;
|
|
1917
|
+
};
|
|
1918
|
+
type TDataFindRecords = {
|
|
1919
|
+
requestBody: SessionStorageSearchDto;
|
|
1920
|
+
};
|
|
1921
|
+
type TDataGetRecord = {
|
|
1922
|
+
storageId: string;
|
|
1923
|
+
};
|
|
1924
|
+
type TDataDeleteRecord = {
|
|
1925
|
+
storageId: string;
|
|
1926
|
+
};
|
|
1927
|
+
declare class SessionService {
|
|
1928
|
+
readonly httpRequest: BaseHttpRequest;
|
|
1929
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
1700
1930
|
/**
|
|
1701
|
-
*
|
|
1931
|
+
* Load current user session
|
|
1932
|
+
* @returns any
|
|
1933
|
+
* @throws ApiError
|
|
1702
1934
|
*/
|
|
1703
|
-
|
|
1935
|
+
getUserSession(data: TDataGetUserSession): CancelablePromise<any>;
|
|
1704
1936
|
/**
|
|
1705
|
-
*
|
|
1937
|
+
* Load a session
|
|
1938
|
+
* @returns any
|
|
1939
|
+
* @throws ApiError
|
|
1706
1940
|
*/
|
|
1707
|
-
|
|
1708
|
-
contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
1709
|
-
content: ImageContentDto;
|
|
1710
|
-
metadata?: Record<string, any>;
|
|
1711
|
-
options?: UIContentOptionsDto;
|
|
1712
|
-
chunkId?: number;
|
|
1713
|
-
messageId?: string;
|
|
1714
|
-
};
|
|
1715
|
-
|
|
1716
|
-
type LinkContentDto = {
|
|
1717
|
-
url: string;
|
|
1718
|
-
label: string;
|
|
1719
|
-
};
|
|
1720
|
-
|
|
1721
|
-
type LinkUIContentDto = {
|
|
1722
|
-
appId: string;
|
|
1941
|
+
readSession(data: TDataReadSession): CancelablePromise<any>;
|
|
1723
1942
|
/**
|
|
1724
|
-
*
|
|
1943
|
+
* Remove session
|
|
1944
|
+
* @returns any
|
|
1945
|
+
* @throws ApiError
|
|
1725
1946
|
*/
|
|
1726
|
-
|
|
1947
|
+
deleteSession(data: TDataDeleteSession): CancelablePromise<any>;
|
|
1727
1948
|
/**
|
|
1728
|
-
*
|
|
1949
|
+
* Create session
|
|
1950
|
+
* @returns any
|
|
1951
|
+
* @throws ApiError
|
|
1729
1952
|
*/
|
|
1730
|
-
|
|
1953
|
+
createSession(data: TDataCreateSession): CancelablePromise<any>;
|
|
1731
1954
|
/**
|
|
1732
|
-
*
|
|
1955
|
+
* Update session
|
|
1956
|
+
* @returns any
|
|
1957
|
+
* @throws ApiError
|
|
1733
1958
|
*/
|
|
1734
|
-
|
|
1735
|
-
contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
1736
|
-
content: LinkContentDto;
|
|
1737
|
-
metadata?: Record<string, any>;
|
|
1738
|
-
options?: UIContentOptionsDto;
|
|
1739
|
-
chunkId?: number;
|
|
1740
|
-
messageId?: string;
|
|
1741
|
-
};
|
|
1742
|
-
|
|
1743
|
-
type ObjectContentDto = {
|
|
1744
|
-
url: string;
|
|
1745
|
-
};
|
|
1746
|
-
|
|
1747
|
-
type ObjectUIContentDto = {
|
|
1748
|
-
appId: string;
|
|
1959
|
+
updateSession(data: TDataUpdateSession): CancelablePromise<any>;
|
|
1749
1960
|
/**
|
|
1750
|
-
*
|
|
1961
|
+
* Notifies of an agent update
|
|
1962
|
+
* @returns any
|
|
1963
|
+
* @throws ApiError
|
|
1751
1964
|
*/
|
|
1752
|
-
|
|
1965
|
+
agentUpdate(data: TDataAgentUpdate): CancelablePromise<any>;
|
|
1753
1966
|
/**
|
|
1754
|
-
*
|
|
1967
|
+
* Request support from human
|
|
1968
|
+
* @returns SessionSupportResponseDto Human support requested
|
|
1969
|
+
* @throws ApiError
|
|
1755
1970
|
*/
|
|
1756
|
-
|
|
1971
|
+
support(data: TDataSupport): CancelablePromise<SessionSupportResponseDto>;
|
|
1757
1972
|
/**
|
|
1758
|
-
*
|
|
1973
|
+
* Store user data
|
|
1974
|
+
* @returns SessionStorageRecordDto Record stored
|
|
1975
|
+
* @throws ApiError
|
|
1759
1976
|
*/
|
|
1760
|
-
|
|
1761
|
-
contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
1762
|
-
content: ObjectContentDto;
|
|
1763
|
-
metadata?: Record<string, any>;
|
|
1764
|
-
options?: UIContentOptionsDto;
|
|
1765
|
-
chunkId?: number;
|
|
1766
|
-
messageId?: string;
|
|
1767
|
-
};
|
|
1768
|
-
|
|
1769
|
-
type PdfContentDto = {
|
|
1770
|
-
url: string;
|
|
1771
|
-
};
|
|
1772
|
-
|
|
1773
|
-
type PdfUIContentDto = {
|
|
1774
|
-
appId: string;
|
|
1977
|
+
setRecord(data: TDataSetRecord): CancelablePromise<SessionStorageRecordDto>;
|
|
1775
1978
|
/**
|
|
1776
|
-
*
|
|
1979
|
+
* Store user data
|
|
1980
|
+
* @returns SessionStorageRecordDto Record stored
|
|
1981
|
+
* @throws ApiError
|
|
1777
1982
|
*/
|
|
1778
|
-
|
|
1983
|
+
findRecords(data: TDataFindRecords): CancelablePromise<Array<SessionStorageRecordDto>>;
|
|
1779
1984
|
/**
|
|
1780
|
-
*
|
|
1985
|
+
* Retrieve stored data
|
|
1986
|
+
* @returns SessionStorageRecordDto Record retrieved
|
|
1987
|
+
* @throws ApiError
|
|
1781
1988
|
*/
|
|
1782
|
-
|
|
1989
|
+
getRecord(data: TDataGetRecord): CancelablePromise<SessionStorageRecordDto>;
|
|
1783
1990
|
/**
|
|
1784
|
-
*
|
|
1991
|
+
* Delete a record
|
|
1992
|
+
* @returns any Record deleted
|
|
1993
|
+
* @throws ApiError
|
|
1785
1994
|
*/
|
|
1786
|
-
|
|
1787
|
-
|
|
1788
|
-
content: PdfContentDto;
|
|
1789
|
-
metadata?: Record<string, any>;
|
|
1790
|
-
options?: UIContentOptionsDto;
|
|
1791
|
-
chunkId?: number;
|
|
1792
|
-
messageId?: string;
|
|
1793
|
-
};
|
|
1995
|
+
deleteRecord(data: TDataDeleteRecord): CancelablePromise<any>;
|
|
1996
|
+
}
|
|
1794
1997
|
|
|
1795
|
-
type
|
|
1796
|
-
|
|
1797
|
-
|
|
1798
|
-
|
|
1998
|
+
type TDataNotifyInteraction = {
|
|
1999
|
+
appId: string;
|
|
2000
|
+
moduleId: string;
|
|
2001
|
+
requestBody: UIInteractionDTO;
|
|
1799
2002
|
};
|
|
1800
|
-
|
|
1801
|
-
|
|
1802
|
-
question: string;
|
|
1803
|
-
answers: Array<QuizAnswerDto>;
|
|
2003
|
+
type TDataShowContent = {
|
|
2004
|
+
requestBody: UIContentDto;
|
|
1804
2005
|
};
|
|
1805
|
-
|
|
1806
|
-
|
|
2006
|
+
type TDataUiModelControllerMapBlendShapes = {
|
|
2007
|
+
requestBody: UIModelMapBlendShapesRequestDto;
|
|
2008
|
+
};
|
|
2009
|
+
type TDataGetAsset = {
|
|
1807
2010
|
appId: string;
|
|
1808
|
-
|
|
1809
|
-
* Reference to the authenticated client the request originated from
|
|
1810
|
-
*/
|
|
1811
|
-
clientId?: string;
|
|
1812
|
-
/**
|
|
1813
|
-
* Reference to the user interacting with the system
|
|
1814
|
-
*/
|
|
1815
|
-
userId?: string;
|
|
1816
|
-
/**
|
|
1817
|
-
* Track the interaction session, if available
|
|
1818
|
-
*/
|
|
1819
|
-
sessionId?: string;
|
|
1820
|
-
contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
1821
|
-
content: QuizContentDto;
|
|
1822
|
-
metadata?: Record<string, any>;
|
|
1823
|
-
options?: UIContentOptionsDto;
|
|
1824
|
-
chunkId?: number;
|
|
1825
|
-
messageId?: string;
|
|
2011
|
+
path: string;
|
|
1826
2012
|
};
|
|
1827
|
-
|
|
1828
|
-
|
|
1829
|
-
|
|
2013
|
+
type TDataSaveModel = {
|
|
2014
|
+
formData: {
|
|
2015
|
+
filename?: string;
|
|
2016
|
+
appId?: string;
|
|
2017
|
+
type?: 'models' | 'backgrounds' | 'animations' | 'documents';
|
|
2018
|
+
userId?: string;
|
|
2019
|
+
ts?: string;
|
|
2020
|
+
metadata?: UIAssetMetadataDto;
|
|
2021
|
+
file?: Blob | File;
|
|
2022
|
+
};
|
|
1830
2023
|
};
|
|
1831
|
-
|
|
1832
|
-
|
|
1833
|
-
|
|
1834
|
-
|
|
1835
|
-
|
|
2024
|
+
type TDataSaveBackground = {
|
|
2025
|
+
formData: {
|
|
2026
|
+
filename?: string;
|
|
2027
|
+
appId?: string;
|
|
2028
|
+
type?: 'models' | 'backgrounds' | 'animations' | 'documents';
|
|
2029
|
+
userId?: string;
|
|
2030
|
+
ts?: string;
|
|
2031
|
+
metadata?: UIAssetMetadataDto;
|
|
2032
|
+
file?: Blob | File;
|
|
2033
|
+
};
|
|
1836
2034
|
};
|
|
1837
|
-
|
|
1838
|
-
|
|
1839
|
-
|
|
2035
|
+
type TDataSaveDocuments = {
|
|
2036
|
+
formData: {
|
|
2037
|
+
filename?: string;
|
|
2038
|
+
appId?: string;
|
|
2039
|
+
type?: 'models' | 'backgrounds' | 'animations' | 'documents';
|
|
2040
|
+
userId?: string;
|
|
2041
|
+
ts?: string;
|
|
2042
|
+
metadata?: UIAssetMetadataDto;
|
|
2043
|
+
file?: Blob | File;
|
|
2044
|
+
};
|
|
1840
2045
|
};
|
|
1841
|
-
|
|
1842
|
-
|
|
1843
|
-
|
|
2046
|
+
type TDataSaveAsset = {
|
|
2047
|
+
formData: {
|
|
2048
|
+
filename?: string;
|
|
2049
|
+
appId?: string;
|
|
2050
|
+
type?: 'models' | 'backgrounds' | 'animations' | 'documents';
|
|
2051
|
+
userId?: string;
|
|
2052
|
+
ts?: string;
|
|
2053
|
+
metadata?: UIAssetMetadataDto;
|
|
2054
|
+
file?: Blob | File;
|
|
2055
|
+
};
|
|
2056
|
+
};
|
|
2057
|
+
declare class UiService {
|
|
2058
|
+
readonly httpRequest: BaseHttpRequest;
|
|
2059
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
1844
2060
|
/**
|
|
1845
|
-
*
|
|
2061
|
+
* Trigger a UI interaction
|
|
2062
|
+
* @returns any
|
|
2063
|
+
* @throws ApiError
|
|
1846
2064
|
*/
|
|
1847
|
-
|
|
2065
|
+
notifyInteraction(data: TDataNotifyInteraction): CancelablePromise<any>;
|
|
1848
2066
|
/**
|
|
1849
|
-
*
|
|
2067
|
+
* Show content
|
|
2068
|
+
* @returns UIContentDto Content to show
|
|
2069
|
+
* @throws ApiError
|
|
1850
2070
|
*/
|
|
1851
|
-
|
|
2071
|
+
showContent(data: TDataShowContent): CancelablePromise<UIContentDto>;
|
|
1852
2072
|
/**
|
|
1853
|
-
*
|
|
2073
|
+
* Tries to map model blend shapes by name similarity
|
|
2074
|
+
* @returns UIModelMapBlendShapesResponseDto Map model blend shapes
|
|
2075
|
+
* @throws ApiError
|
|
1854
2076
|
*/
|
|
1855
|
-
|
|
1856
|
-
contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
1857
|
-
content: TextContentDto;
|
|
1858
|
-
metadata?: Record<string, any>;
|
|
1859
|
-
options?: UIContentOptionsDto;
|
|
1860
|
-
chunkId?: number;
|
|
1861
|
-
messageId?: string;
|
|
1862
|
-
};
|
|
1863
|
-
|
|
1864
|
-
type UILoaderResponseDto = {
|
|
1865
|
-
appId: string;
|
|
2077
|
+
uiModelControllerMapBlendShapes(data: TDataUiModelControllerMapBlendShapes): CancelablePromise<UIModelMapBlendShapesResponseDto>;
|
|
1866
2078
|
/**
|
|
1867
|
-
*
|
|
2079
|
+
* Retrieve an asset
|
|
2080
|
+
* @returns Buffer Download an asset by url
|
|
2081
|
+
* @throws ApiError
|
|
1868
2082
|
*/
|
|
1869
|
-
|
|
2083
|
+
getAsset(data: TDataGetAsset): CancelablePromise<Buffer$1>;
|
|
1870
2084
|
/**
|
|
1871
|
-
*
|
|
2085
|
+
* @returns any
|
|
2086
|
+
* @throws ApiError
|
|
1872
2087
|
*/
|
|
1873
|
-
|
|
1874
|
-
assetId: string;
|
|
1875
|
-
status: string;
|
|
1876
|
-
visible: boolean;
|
|
1877
|
-
};
|
|
1878
|
-
|
|
1879
|
-
type VideoContentDto = {
|
|
1880
|
-
sources: Array<string>;
|
|
1881
|
-
description?: string;
|
|
1882
|
-
subtitle?: string;
|
|
1883
|
-
thumb?: string;
|
|
1884
|
-
title?: string;
|
|
1885
|
-
width?: number;
|
|
1886
|
-
height?: number;
|
|
1887
|
-
};
|
|
1888
|
-
|
|
1889
|
-
type VideoUIContentDto = {
|
|
1890
|
-
appId: string;
|
|
2088
|
+
saveModel(data: TDataSaveModel): CancelablePromise<any>;
|
|
1891
2089
|
/**
|
|
1892
|
-
*
|
|
2090
|
+
* @returns any
|
|
2091
|
+
* @throws ApiError
|
|
1893
2092
|
*/
|
|
1894
|
-
|
|
2093
|
+
saveBackground(data: TDataSaveBackground): CancelablePromise<any>;
|
|
1895
2094
|
/**
|
|
1896
|
-
*
|
|
2095
|
+
* @returns any
|
|
2096
|
+
* @throws ApiError
|
|
1897
2097
|
*/
|
|
1898
|
-
|
|
2098
|
+
saveDocuments(data: TDataSaveDocuments): CancelablePromise<any>;
|
|
1899
2099
|
/**
|
|
1900
|
-
*
|
|
2100
|
+
* @returns any
|
|
2101
|
+
* @throws ApiError
|
|
1901
2102
|
*/
|
|
1902
|
-
|
|
1903
|
-
|
|
1904
|
-
content: VideoContentDto;
|
|
1905
|
-
metadata?: Record<string, any>;
|
|
1906
|
-
options?: UIContentOptionsDto;
|
|
1907
|
-
chunkId?: number;
|
|
1908
|
-
messageId?: string;
|
|
1909
|
-
};
|
|
2103
|
+
saveAsset(data: TDataSaveAsset): CancelablePromise<any>;
|
|
2104
|
+
}
|
|
1910
2105
|
|
|
1911
|
-
type
|
|
1912
|
-
|
|
2106
|
+
type TDataXrMarkerControllerSearchMarker = {
|
|
2107
|
+
requestBody: XRMarkerListRequestDto;
|
|
1913
2108
|
};
|
|
1914
|
-
|
|
1915
|
-
|
|
1916
|
-
|
|
2109
|
+
type TDataXrMarkerControllerSaveMarker = {
|
|
2110
|
+
requestBody: XRMarkerDto;
|
|
2111
|
+
};
|
|
2112
|
+
type TDataXrMarkerControllerDeleteMarker = {
|
|
2113
|
+
markerId: string;
|
|
2114
|
+
};
|
|
2115
|
+
type TDataXrMarkerControllerGetMarkerQrCode = {
|
|
2116
|
+
markerId: string;
|
|
2117
|
+
};
|
|
2118
|
+
declare class XrService {
|
|
2119
|
+
readonly httpRequest: BaseHttpRequest;
|
|
2120
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
1917
2121
|
/**
|
|
1918
|
-
*
|
|
2122
|
+
* List available markers
|
|
2123
|
+
* @returns XRMarkerDto Marker created or updated
|
|
2124
|
+
* @throws ApiError
|
|
1919
2125
|
*/
|
|
1920
|
-
|
|
2126
|
+
xrMarkerControllerSearchMarker(data: TDataXrMarkerControllerSearchMarker): CancelablePromise<Array<XRMarkerDto>>;
|
|
1921
2127
|
/**
|
|
1922
|
-
*
|
|
2128
|
+
* Save a marker
|
|
2129
|
+
* @returns XRMarkerDto Marker saved
|
|
2130
|
+
* @throws ApiError
|
|
1923
2131
|
*/
|
|
1924
|
-
|
|
2132
|
+
xrMarkerControllerSaveMarker(data: TDataXrMarkerControllerSaveMarker): CancelablePromise<XRMarkerDto>;
|
|
1925
2133
|
/**
|
|
1926
|
-
*
|
|
2134
|
+
* Delete a marker
|
|
2135
|
+
* @returns XRMarkerDto Marker deleted
|
|
2136
|
+
* @throws ApiError
|
|
1927
2137
|
*/
|
|
1928
|
-
|
|
1929
|
-
|
|
1930
|
-
|
|
1931
|
-
|
|
1932
|
-
|
|
1933
|
-
|
|
1934
|
-
|
|
1935
|
-
|
|
2138
|
+
xrMarkerControllerDeleteMarker(data: TDataXrMarkerControllerDeleteMarker): CancelablePromise<XRMarkerDto>;
|
|
2139
|
+
/**
|
|
2140
|
+
* Get the marker QR code as image (jpeg)
|
|
2141
|
+
* @returns binary Marker retrieved
|
|
2142
|
+
* @throws ApiError
|
|
2143
|
+
*/
|
|
2144
|
+
xrMarkerControllerGetMarkerQrCode(data: TDataXrMarkerControllerGetMarkerQrCode): CancelablePromise<Blob | File>;
|
|
2145
|
+
/**
|
|
2146
|
+
* Indicate if a 3D asset model is occluded by a physical obstacle.
|
|
2147
|
+
* @returns XROcclusionResponseDto Got information about 3D model
|
|
2148
|
+
* @throws ApiError
|
|
2149
|
+
*/
|
|
2150
|
+
xrOcclusionControllerOcclusion(): CancelablePromise<XROcclusionResponseDto>;
|
|
2151
|
+
}
|
|
2152
|
+
|
|
2153
|
+
type HttpRequestConstructor = new (config: OpenAPIConfig) => BaseHttpRequest;
|
|
2154
|
+
declare class SermasApi {
|
|
2155
|
+
readonly agent: AgentService;
|
|
2156
|
+
readonly authentication: AuthenticationService;
|
|
2157
|
+
readonly detection: DetectionService;
|
|
2158
|
+
readonly dialogue: DialogueService;
|
|
2159
|
+
readonly platform: PlatformService;
|
|
2160
|
+
readonly robotics: RoboticsService;
|
|
2161
|
+
readonly session: SessionService;
|
|
2162
|
+
readonly ui: UiService;
|
|
2163
|
+
readonly xr: XrService;
|
|
2164
|
+
readonly request: BaseHttpRequest;
|
|
2165
|
+
constructor(config?: Partial<OpenAPIConfig>, HttpRequest?: HttpRequestConstructor);
|
|
2166
|
+
}
|
|
1936
2167
|
|
|
1937
2168
|
declare class Broker {
|
|
1938
2169
|
private readonly config;
|
|
@@ -1974,11 +2205,13 @@ interface PlatformAppChangedDto {
|
|
|
1974
2205
|
operation: string;
|
|
1975
2206
|
record: PlatformAppDto;
|
|
1976
2207
|
}
|
|
1977
|
-
|
|
2208
|
+
type anonymous_schema_36 = 'readyplayerme' | 'custom';
|
|
2209
|
+
type anonymous_schema_39 = 'M' | 'F';
|
|
2210
|
+
interface anonymous_schema_77 {
|
|
1978
2211
|
username?: string;
|
|
1979
2212
|
password: string;
|
|
1980
2213
|
}
|
|
1981
|
-
interface
|
|
2214
|
+
interface anonymous_schema_80 {
|
|
1982
2215
|
clientType?: string;
|
|
1983
2216
|
clientId?: string;
|
|
1984
2217
|
clientSecret?: string;
|
|
@@ -2039,7 +2272,7 @@ interface StringInferenceValue {
|
|
|
2039
2272
|
probability: number;
|
|
2040
2273
|
value: string;
|
|
2041
2274
|
}
|
|
2042
|
-
type
|
|
2275
|
+
type anonymous_schema_142 = 'start' | 'stop';
|
|
2043
2276
|
interface UserCharacterizationEventDto {
|
|
2044
2277
|
appId: string;
|
|
2045
2278
|
clientId?: string;
|
|
@@ -2105,8 +2338,7 @@ interface DialogueToolTriggeredEventDto {
|
|
|
2105
2338
|
sessionId?: string;
|
|
2106
2339
|
name: string;
|
|
2107
2340
|
}
|
|
2108
|
-
type
|
|
2109
|
-
type Buffer$1 = Record<string, any>;
|
|
2341
|
+
type anonymous_schema_191 = 'user' | 'agent';
|
|
2110
2342
|
interface SermasSessionDto {
|
|
2111
2343
|
appId: string;
|
|
2112
2344
|
clientId?: string;
|
|
@@ -2125,10 +2357,10 @@ interface AgentDto {
|
|
|
2125
2357
|
clientId?: string;
|
|
2126
2358
|
userId?: string;
|
|
2127
2359
|
agentId: string;
|
|
2128
|
-
status:
|
|
2360
|
+
status: anonymous_schema_220;
|
|
2129
2361
|
modules: string[];
|
|
2130
2362
|
}
|
|
2131
|
-
type
|
|
2363
|
+
type anonymous_schema_220 = 'unavailable' | 'error' | 'not_ready' | 'ready' | 'loading' | 'interacting' | 'waiting' | 'processing';
|
|
2132
2364
|
interface AgentChangedDto {
|
|
2133
2365
|
appId: string;
|
|
2134
2366
|
clientId?: string;
|
|
@@ -2154,15 +2386,15 @@ interface SessionStorageEventDto {
|
|
|
2154
2386
|
operation: string;
|
|
2155
2387
|
record: SessionStorageRecordDto;
|
|
2156
2388
|
}
|
|
2157
|
-
interface
|
|
2389
|
+
interface UIAssetChangedDto {
|
|
2158
2390
|
appId: string;
|
|
2159
2391
|
clientId?: string;
|
|
2160
2392
|
userId?: string;
|
|
2161
|
-
|
|
2162
|
-
|
|
2163
|
-
visible: boolean;
|
|
2393
|
+
operation: string;
|
|
2394
|
+
record: UIAssetDto;
|
|
2164
2395
|
}
|
|
2165
|
-
type
|
|
2396
|
+
type anonymous_schema_252 = 'models' | 'backgrounds' | 'animations' | 'documents';
|
|
2397
|
+
type anonymous_schema_259 = 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
|
|
2166
2398
|
interface UIInteractionEventDto {
|
|
2167
2399
|
appId: string;
|
|
2168
2400
|
clientId?: string;
|
|
@@ -2394,10 +2626,10 @@ declare class Session {
|
|
|
2394
2626
|
declare class Ui {
|
|
2395
2627
|
private readonly broker;
|
|
2396
2628
|
constructor(broker: Broker);
|
|
2397
|
-
|
|
2629
|
+
assetChanged(event: UIAssetChangedDto, params?: {
|
|
2398
2630
|
appId?: string;
|
|
2399
2631
|
}): Promise<boolean>;
|
|
2400
|
-
|
|
2632
|
+
onAssetChanged(fn: (event: UIAssetChangedDto) => void | Promise<void>, params?: {
|
|
2401
2633
|
appId?: string;
|
|
2402
2634
|
}): Promise<() => void>;
|
|
2403
2635
|
content(event: UIContentDto, params?: {
|
|
@@ -2559,4 +2791,4 @@ declare class SermasApiClient {
|
|
|
2559
2791
|
login(username: any, password: any, appId?: string): Promise<LoginResponseDto>;
|
|
2560
2792
|
}
|
|
2561
2793
|
|
|
2562
|
-
export { type AccessTokenRequestDto, type ActuationEventDto, type AgentChangedDto, type AgentDto, type AgentHeartBeatEventDto, type AppClientDto, type AppModuleConfigDto, type AppPromptDto, type AppSettingsDto, type AppToolsDTO, type AudioClassificationEventDto, type AudioClassificationValue, type AuthJwtUser, type AuthorizationUser, type AvatarCameraConfig, type BoundingBox, Broker, type Buffer$1 as Buffer, type ButtonDto, type ButtonsContentDto, type ButtonsUIContentDto, type ClearScreenDto, type ClearUIContentDto, type CreatePlatformAppDto, type DialogueDocumentDto, type DialogueDocumentMetadataDto, type DialogueMessageDto, type DialogueMessageUIContentDto, type DialogueTextToSpeechDto, type DialogueToolTriggeredEventDto, type EmailContentDto, type EmailUIContentDto, type HtmlContentDto, type HtmlUIContentDto, type ImageContentDto, type ImageUIContentDto, type InitialPoseDto, type InitialPoseEventDto, type JwtTokenDto, type KeycloakJwtTokenResourceAccess, type LinearVelocityDto, type LinkContentDto, type LinkUIContentDto, type LoginRequestDto, type LoginResponseDto, type ModuleConfigEventDto, type ModuleResourceDto, type ModuleSettingsDto, type MovementDto, type MovementEventDto, type NoiseEventDto, type ObjectContentDto, type ObjectDetectionDto, type ObjectDetectionEventDto, type ObjectUIContentDto, type OrientationDto, type PdfContentDto, type PdfUIContentDto, type PlatformAppChangedDto, type PlatformAppClientChangedDto, type PlatformAppDto, type PlatformAppExportFilterDto, type PlatformAppModuleConfigEventDto, type PlatformModuleConfigDto, type PlatformSettingsDto, type PlatformTokenDto, type Point3D, type PoseDto, type PositionDto, type QRCodeEventDto, type QuizAnswerDto, type QuizContentDto, type QuizUIContentDto, type RefreshTokenRequestDto, type RegistrationRequestDto, type RegistrationResponseDto, type RepositoryAvatarModelDto, type RepositoryBackgroundMetadataDto, type RepositoryBackgroundModelDto, type RepositoryConfigDto, type RepositoryMapModelDto, type RepositoryRobotModelDto, type SentimentAnalysisRequest, SermasApiClient, type SermasApiClientConfig, type SermasBaseDto, type SermasEnvType, type SermasSessionDto, type SessionChangedDto, type SessionDto, type SessionStorageEventDto, type SessionStorageRecordDto, type SessionStorageSearchDto, type SessionSupportEventDto, type SessionSupportRequestDto, type SessionSupportResponseDto, type StatusDto, type StatusEventDto, type StringInferenceValue, type TextContentDto, type TextUIContentDto, type ToolsRequestSchema, type ToolsRequestSchemaAuthBasic, type ToolsRequestSchemaAuthBearer, type UIContentDto, type UIContentOptionsDto, type UIInteractionDTO, type UIInteractionEventDto, type
|
|
2794
|
+
export { type AccessTokenRequestDto, type ActuationEventDto, type AgentChangedDto, type AgentDto, type AgentHeartBeatEventDto, type AppClientDto, type AppModuleConfigDto, type AppPromptDto, type AppSettingsDto, type AppToolsDTO, type AppUserDto, type AudioClassificationEventDto, type AudioClassificationValue, type AuthJwtUser, type AuthorizationUser, type AvatarCameraConfig, type BoundingBox, Broker, type Buffer$1 as Buffer, type ButtonDto, type ButtonsContentDto, type ButtonsUIContentDto, type ClearScreenDto, type ClearUIContentDto, type CreatePlatformAppDto, type DialogueDocumentDto, type DialogueDocumentMetadataDto, type DialogueMessageDto, type DialogueMessageUIContentDto, type DialogueTextToSpeechDto, type DialogueToolTriggeredEventDto, type EmailContentDto, type EmailUIContentDto, type HtmlContentDto, type HtmlUIContentDto, type ImageContentDto, type ImageUIContentDto, type InitialPoseDto, type InitialPoseEventDto, type JwtTokenDto, type KeycloakCredentials, type KeycloakJwtTokenResourceAccess, type LinearVelocityDto, type LinkContentDto, type LinkUIContentDto, type LoginRequestDto, type LoginResponseDto, type ModuleConfigEventDto, type ModuleResourceDto, type ModuleSettingsDto, type MovementDto, type MovementEventDto, type NoiseEventDto, type ObjectContentDto, type ObjectDetectionDto, type ObjectDetectionEventDto, type ObjectUIContentDto, type OrientationDto, type PdfContentDto, type PdfUIContentDto, type PlatformAppChangedDto, type PlatformAppClientChangedDto, type PlatformAppDto, type PlatformAppExportFilterDto, type PlatformAppModuleConfigEventDto, type PlatformModuleConfigDto, type PlatformSettingsDto, type PlatformTokenDto, type Point3D, type PoseDto, type PositionDto, type QRCodeEventDto, type QuizAnswerDto, type QuizContentDto, type QuizUIContentDto, type RefreshTokenRequestDto, type RegistrationRequestDto, type RegistrationResponseDto, type RepositoryAvatarModelDto, type RepositoryBackgroundMetadataDto, type RepositoryBackgroundModelDto, type RepositoryConfigDto, type RepositoryMapModelDto, type RepositoryRobotModelDto, type SentimentAnalysisRequest, SermasApiClient, type SermasApiClientConfig, type SermasBaseDto, type SermasEnvType, type SermasSessionDto, type SessionChangedDto, type SessionDto, type SessionStorageEventDto, type SessionStorageRecordDto, type SessionStorageSearchDto, type SessionSupportEventDto, type SessionSupportRequestDto, type SessionSupportResponseDto, type StatusDto, type StatusEventDto, type StringInferenceValue, type TextContentDto, type TextUIContentDto, type ToolsRequestSchema, type ToolsRequestSchemaAuthBasic, type ToolsRequestSchemaAuthBearer, type UIAssetChangedDto, type UIAssetDto, type UIAssetMetadataDto, type UIContentDto, type UIContentOptionsDto, type UIInteractionDTO, type UIInteractionEventDto, type UIModelAssetDto, type UIModelMapBlendShapesRequestDto, type UIModelMapBlendShapesResponseDto, type UpdateUserEventDto, type UpdateUserRequestDto, type UserAgeValue, type UserCharacterizationDto, type UserCharacterizationEventDto, type UserDetectionDto, type UserDetectionEventDto, type UserEmotionValue, type UserInteractionIntentionDto, type VelocityDto, type VideoContentDto, type VideoUIContentDto, type ViewLogsRequestDto, type WebpageContentDto, type WebpageUIContentDto, type XRMarkerChangedDto, type XRMarkerDto, type XRMarkerListRequestDto, type XROcclusionDto, type XROcclusionResponseDto, type anonymous_schema_142, type anonymous_schema_191, type anonymous_schema_220, type anonymous_schema_252, type anonymous_schema_259, type anonymous_schema_36, type anonymous_schema_39, type anonymous_schema_77, type anonymous_schema_80, sleep };
|