@sermas/api-client 1.0.0-alpha.31 → 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.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, any>;
8
- readonly cookies?: Record<string, any>;
9
- readonly headers?: Record<string, any>;
10
- readonly query?: Record<string, any>;
11
- readonly formData?: Record<string, any>;
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
- #private;
26
- constructor(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void, onCancel: OnCancel) => void);
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: any) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
29
- catch<TResult = never>(onRejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null): Promise<T | TResult>;
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 Resolver<T> = (options: ApiRequestOptions) => Promise<T>;
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
- PASSWORD?: string | Resolver<string> | undefined;
45
- HEADERS?: Headers | Resolver<Headers> | undefined;
46
- ENCODE_PATH?: ((path: string) => string) | undefined;
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 ActuationEventDto = {
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
- actuations: Array<string>;
105
+ refreshToken: string;
106
+ clientSecret?: string;
66
107
  };
67
-
68
- type OrientationDto = {
69
- 'x': number;
70
- 'y': number;
71
- 'z': number;
72
- 'w': number;
108
+ type Point3D = {
109
+ x: number;
110
+ y: number;
111
+ z: number;
73
112
  };
74
-
75
- type PositionDto = {
76
- 'x': number;
77
- 'y': number;
78
- 'z': number;
113
+ type AvatarCameraConfig = {
114
+ position: Point3D;
115
+ rotation: Point3D;
79
116
  };
80
-
81
- type PoseDto = {
82
- position: PositionDto;
83
- orientation: OrientationDto;
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
- type MovementDto = {
87
- targetPosition: PoseDto;
88
- personId: string;
89
- path: Array<string>;
125
+ type RepositoryBackgroundMetadataDto = {
126
+ credits?: string;
90
127
  };
91
-
92
- type MovementEventDto = {
93
- appId: string;
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
- * Reference to the authenticated client the request originated from
169
+ * Resource of the module operation
96
170
  */
97
- clientId?: string;
171
+ resource: string;
98
172
  /**
99
- * Reference to the user interacting with the system
173
+ * Scope of the module operation
100
174
  */
101
- userId?: string;
102
- movement: MovementDto;
103
- };
104
-
105
- type SermasBaseDto = {
106
- appId: string;
175
+ scope: string;
107
176
  /**
108
- * Reference to the authenticated client the request originated from
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
- clientId?: string;
179
+ context?: Array<string>;
111
180
  /**
112
- * Reference to the user interacting with the system
181
+ * Name of the module operation
113
182
  */
114
- userId?: string;
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
- * Reference to the authenticated client the request originated from
185
+ * Description of the module operation
133
186
  */
134
- clientId?: string;
187
+ description?: string;
135
188
  /**
136
- * Reference to the user interacting with the system
189
+ * Unique identifier of the module
137
190
  */
138
- userId?: string;
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
- * move the robot to a specified coordinates. Based on the parameter coordinates, move the robot to that coordinates.
148
- * @param appId
149
- * @param room
150
- * @returns any
151
- * @throws ApiError
193
+ * Operation to call from the module OpenAPI spec
152
194
  */
153
- roboticsAgentControllerMoveToArea(appId: string, room: string): CancelablePromise<any>;
195
+ operationId: string;
154
196
  /**
155
- * get the status of the robot
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
- roboticsAgentControllerStatusDescription(appId: string, robotId: string): CancelablePromise<any>;
199
+ emitEvent?: boolean;
200
+ };
201
+ type ModuleSettingsDto = {
162
202
  /**
163
- * relocate the robot
164
- * @param requestBody
165
- * @returns any
166
- * @throws ApiError
203
+ * Service URL used to load .well-known
167
204
  */
168
- roboticsAgentControllerMove(requestBody: MovementEventDto): CancelablePromise<any>;
205
+ url?: string;
169
206
  /**
170
- * set initial pose of the robot
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
- roboticsAgentControllerInitialPose(requestBody: SermasBaseDto): CancelablePromise<any>;
209
+ openapiSpec: string;
176
210
  /**
177
- * execute an action on the robot
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
- roboticsAgentControllerActuate(requestBody: ActuationEventDto): CancelablePromise<any>;
213
+ asyncapiSpec: string;
183
214
  /**
184
- * get the status of the robot
185
- * @param requestBody
186
- * @returns any
187
- * @throws ApiError
215
+ * List of managed resources and scopes for this module
188
216
  */
189
- roboticsAgentControllerStatus(requestBody: StatusEventDto): CancelablePromise<any>;
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
- type LoginRequestDto = {
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
- * Reference to the user interacting with the system
222
+ * Status of the module. `enabled` by default. can be `disabled`. Set to `failure` if loading generates errors.
230
223
  */
231
- userId?: string;
232
- username: string;
233
- password: string;
234
- };
235
-
236
- type LoginResponseDto = {
237
- access_token: string;
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
- type RefreshTokenRequestDto = {
247
- appId: string;
232
+ type AppClientDto = {
233
+ appId?: string;
234
+ name: string;
248
235
  /**
249
- * Reference to the authenticated client the request originated from
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
- * Reference to the user interacting with the system
241
+ * A list of permissions for this client in the form [resource].[scope] e.g. detection.intent. User *.* for all permission
254
242
  */
255
- userId?: string;
256
- refreshToken: string;
257
- clientSecret?: string;
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
- * Indicate a chunck identifier as timestamp, usually indicating it is part of a stream.
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: string;
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
- * 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
567
+ * Indicate a chunck identifier as timestamp, usually indicating it is part of a stream.
500
568
  */
501
- text?: string;
569
+ text: string;
502
570
  /**
503
571
  * Assistant gender (M or F)
504
572
  */
@@ -519,1459 +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
- * SSML markup to render as speech.
594
+ * Reference to the authenticated client the request originated from
524
595
  */
525
- ssml?: string;
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
- * Import RAG documents
539
- * @param requestBody Documents list
540
- * @returns DialogueDocumentDto
541
- * @throws ApiError
598
+ * Reference to the user interacting with the system
542
599
  */
543
- import(requestBody: Array<DialogueDocumentDto>): CancelablePromise<Array<DialogueDocumentDto>>;
600
+ userId?: string;
601
+ sessionId?: string;
544
602
  /**
545
- * Remove RAG documents
546
- * @param appId
547
- * @param documentId
548
- * @returns any
549
- * @throws ApiError
603
+ * Agent instance associated to the session
550
604
  */
551
- remove(appId: string, documentId: Array<string>): CancelablePromise<any>;
605
+ agentId?: string;
552
606
  /**
553
- * Converts a text to voice as mp3
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
- speak(requestBody: DialogueTextToSpeechDto): CancelablePromise<any>;
609
+ user?: Array<string>;
610
+ modifiedAt: string;
611
+ createdAt: string;
612
+ closedAt: string;
613
+ };
614
+ type AgentHeartBeatEventDto = {
615
+ appId: string;
559
616
  /**
560
- * @param appId
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
- text(appId: string, sessionId: string, sampleRate: number, formData: {
568
- file?: Blob;
569
- }): CancelablePromise<any>;
619
+ clientId?: string;
570
620
  /**
571
- * @param appId
572
- * @param sessionId
573
- * @param requestBody
574
- * @returns any
575
- * @throws ApiError
621
+ * Reference to the user interacting with the system
576
622
  */
577
- chatMessage(appId: string, sessionId: string, requestBody: DialogueMessageDto): CancelablePromise<any>;
623
+ userId?: string;
578
624
  /**
579
- * @param appId
580
- * @param sessionId
581
- * @returns any
582
- * @throws ApiError
625
+ * Track the interaction session, if available
583
626
  */
584
- stopAgentSpeech(appId: string, sessionId: string): CancelablePromise<any>;
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
- * @returns any
587
- * @throws ApiError
634
+ * Reference to the authenticated client the request originated from
588
635
  */
589
- import1(): CancelablePromise<any>;
636
+ clientId?: string;
590
637
  /**
591
- * @param appId
592
- * @param sessionId
593
- * @param requestBody
594
- * @returns any
595
- * @throws ApiError
638
+ * Reference to the user interacting with the system
596
639
  */
597
- getToolsfFromAppId(appId: string, sessionId: string, requestBody: Array<string>): CancelablePromise<any>;
598
- }
599
-
600
- type AccessTokenRequestDto = {
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
- type AppClientDto = {
607
- appId?: string;
608
- name: string;
645
+ type SessionSupportResponseDto = {
646
+ appId: string;
609
647
  /**
610
- * The clientId, must be unique in the client list and in uuid format.
648
+ * Reference to the authenticated client the request originated from
611
649
  */
612
650
  clientId?: string;
613
- secret?: string;
614
651
  /**
615
- * A list of permissions for this client in the form [resource].[scope] e.g. detection.intent. User *.* for all permission
652
+ * Reference to the user interacting with the system
616
653
  */
617
- permissions: Array<string>;
654
+ userId?: string;
655
+ supportId: string;
618
656
  };
619
-
620
- type ModuleResourceDto = {
657
+ type SessionStorageRecordDto = {
658
+ appId: string;
621
659
  /**
622
- * Resource of the module operation
660
+ * Reference to the authenticated client the request originated from
623
661
  */
624
- resource: string;
662
+ clientId?: string;
625
663
  /**
626
- * Scope of the module operation
664
+ * Reference to the user interacting with the system
627
665
  */
628
- scope: string;
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
- * Additional context, added to the request and event topic when triggered. Can contain variable substituted from the payload, such as :appId
685
+ * Clear the UI screen
631
686
  */
632
- context?: Array<string>;
687
+ clearScreen?: boolean;
633
688
  /**
634
- * Name of the module operation
689
+ * Enable agent reading the content (text to speech)
635
690
  */
636
- name?: string;
691
+ ttsEnabled?: boolean;
637
692
  /**
638
- * Description of the module operation
693
+ * Stop the agent speech
639
694
  */
640
- description?: string;
695
+ stopSpeech?: boolean;
696
+ };
697
+ type ImageUIContentDto = {
698
+ appId: string;
641
699
  /**
642
- * Unique identifier of the module
700
+ * Reference to the authenticated client the request originated from
643
701
  */
644
- moduleId: string;
702
+ clientId?: string;
645
703
  /**
646
- * Operation to call from the module OpenAPI spec
704
+ * Reference to the user interacting with the system
647
705
  */
648
- operationId: string;
706
+ userId?: string;
649
707
  /**
650
- * Indicate if an event should be emitted when this module resource is triggered. The format is app/:appId/<resource>/<scope>/[...context]
708
+ * Track the interaction session, if available
651
709
  */
652
- emitEvent?: boolean;
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
- type ModuleSettingsDto = {
656
- /**
657
- * Service URL used to load .well-known
658
- */
659
- url?: string;
660
- /**
661
- * Reference to a openapi specification to use to map requests to the modules
662
- */
663
- openapiSpec: string;
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 a asyncAPI specification to use to map requests to the modules
730
+ * Reference to the authenticated client the request originated from
666
731
  */
667
- asyncapiSpec: string;
732
+ clientId?: string;
668
733
  /**
669
- * List of managed resources and scopes for this module
734
+ * Reference to the user interacting with the system
670
735
  */
671
- resources: Array<ModuleResourceDto>;
672
- };
673
-
674
- type AppModuleConfigDto = {
675
- moduleId: string;
736
+ userId?: string;
676
737
  /**
677
- * Status of the module. `enabled` by default. can be `disabled`. Set to `failure` if loading generates errors.
738
+ * Track the interaction session, if available
678
739
  */
679
- status?: string;
680
- name?: string;
681
- description?: string;
682
- supports: Array<string>;
683
- config: ModuleSettingsDto;
684
- secret?: string;
685
- appId?: string;
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
- type ToolsRequestSchemaAuthBasic = {
703
- username?: string;
704
- password: string;
748
+ type PdfContentDto = {
749
+ url: string;
705
750
  };
706
-
707
- type ToolsRequestSchemaAuthBearer = {
708
- /**
709
- * Supported options are "client_credentials" or "password".
710
- */
711
- clientType?: string;
751
+ type PdfUIContentDto = {
752
+ appId: string;
712
753
  /**
713
- * Required for client type "client_credentials"
754
+ * Reference to the authenticated client the request originated from
714
755
  */
715
756
  clientId?: string;
716
757
  /**
717
- * Required for client type "client_credentials"
718
- */
719
- clientSecret?: string;
720
- /**
721
- * Required for client type "password"
758
+ * Reference to the user interacting with the system
722
759
  */
723
- username?: string;
760
+ userId?: string;
724
761
  /**
725
- * Required for client type "password"
762
+ * Track the interaction session, if available
726
763
  */
727
- password?: string;
728
- audience?: string;
729
- tokenUrl: string;
730
- refreshUrl?: string;
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
- type ToolsRequestSchema = {
772
+ type WebpageContentDto = {
773
+ url: string;
774
+ };
775
+ type WebpageUIContentDto = {
776
+ appId: string;
734
777
  /**
735
- * Supported options are basic, bearer and module. Defaults to module if not specified.
778
+ * Reference to the authenticated client the request originated from
736
779
  */
737
- auth?: string;
780
+ clientId?: string;
738
781
  /**
739
- * Used for "basic" auth type
782
+ * Reference to the user interacting with the system
740
783
  */
741
- basic?: ToolsRequestSchemaAuthBasic;
784
+ userId?: string;
742
785
  /**
743
- * Used for "bearer" auth type
786
+ * Track the interaction session, if available
744
787
  */
745
- bearer?: ToolsRequestSchemaAuthBearer;
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 one of the modules (or clients) available in the app
802
+ * Reference to the authenticated client the request originated from
748
803
  */
749
- moduleId: string;
804
+ clientId?: string;
750
805
  /**
751
- * Url to call with a JSON POST. Leave empty to skip API calling
806
+ * Reference to the user interacting with the system
752
807
  */
753
- url: string;
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
- * Owner of the application
810
+ * Track the interaction session, if available
779
811
  */
780
- ownerId: string;
781
- modules: Array<AppModuleConfigDto>;
782
- repository: RepositoryConfigDto;
783
- clients: Array<AppClientDto>;
784
- settings?: AppSettingsDto;
785
- tools?: Array<AppToolsDTO>;
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
- type JwtTokenDto = {
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
- * Owner of the application
826
+ * Reference to the authenticated client the request originated from
807
827
  */
808
- ownerId: string;
809
- modules: Array<AppModuleConfigDto>;
810
- repository: RepositoryConfigDto;
811
- clients: Array<AppClientDto>;
812
- settings?: AppSettingsDto;
813
- createdAt?: string;
814
- updatedAt?: string;
815
- tools?: Array<AppToolsDTO>;
816
- };
817
-
818
- type PlatformAppExportFilterDto = {
819
- name?: string;
820
- appId?: Array<string>;
821
- };
822
-
823
- type PlatformModuleConfigDto = {
824
- moduleId: string;
828
+ clientId?: string;
825
829
  /**
826
- * Status of the module. `enabled` by default. can be `disabled`. Set to `failure` if loading generates errors.
830
+ * Reference to the user interacting with the system
827
831
  */
828
- status?: string;
829
- name?: string;
830
- description?: string;
831
- supports: Array<string>;
832
- config: ModuleSettingsDto;
833
- secret?: string;
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;
834
843
  };
835
-
836
- type PlatformSettingsDto = {
837
- resources: Record<string, any>;
844
+ type QuizAnswerDto = {
845
+ answer: string;
846
+ reason: string;
847
+ correct: boolean;
838
848
  };
839
-
840
- type Point3D = {
841
- 'x': number;
842
- 'y': number;
843
- 'z': number;
849
+ type QuizContentDto = {
850
+ question: string;
851
+ answers: Array<QuizAnswerDto>;
844
852
  };
845
-
846
- type AvatarCameraConfig = {
847
- position: Point3D;
848
- rotation: Point3D;
853
+ type QuizUIContentDto = {
854
+ appId: string;
855
+ /**
856
+ * Reference to the authenticated client the request originated from
857
+ */
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;
849
873
  };
850
-
851
- type RepositoryAvatarModelDto = {
852
- modelType: 'readyplayerme' | 'custom';
853
- name?: string;
854
- modelPath: string;
855
- gender: 'M' | 'F';
856
- camera?: AvatarCameraConfig;
857
- cameraMobile?: AvatarCameraConfig;
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;
858
894
  };
859
-
860
- type RepositoryMapModelDto = {
861
- imageUrl?: string;
862
- width?: number;
863
- height?: number;
864
- originOffsetX?: number;
865
- originOffsetY?: number;
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;
866
915
  };
867
-
868
- type RepositoryRobotModelDto = {
869
- name?: string;
870
- videoUrl: string;
871
- map?: RepositoryMapModelDto;
916
+ type ButtonDto = {
917
+ value: string;
918
+ id?: string;
919
+ label?: string;
920
+ classes?: Array<string>;
921
+ options?: UIContentOptionsDto;
872
922
  };
873
-
874
- type ViewLogsRequestDto = {
875
- sessionId: string;
876
- type?: 'speech' | 'characterization' | 'speechToText';
877
- ts?: string;
923
+ type ButtonsContentDto = {
924
+ label: string;
925
+ list: Array<ButtonDto>;
878
926
  };
879
-
880
- declare class PlatformService {
881
- readonly httpRequest: BaseHttpRequest;
882
- constructor(httpRequest: BaseHttpRequest);
927
+ type ButtonsUIContentDto = {
928
+ appId: string;
883
929
  /**
884
- * @returns PlatformSettingsDto
885
- * @throws ApiError
930
+ * Reference to the authenticated client the request originated from
886
931
  */
887
- getUserSettings(): CancelablePromise<PlatformSettingsDto>;
932
+ clientId?: string;
888
933
  /**
889
- * @returns PlatformSettingsDto
890
- * @throws ApiError
934
+ * Reference to the user interacting with the system
891
935
  */
892
- getSettings(): CancelablePromise<PlatformSettingsDto>;
936
+ userId?: string;
893
937
  /**
894
- * @param requestBody
895
- * @returns JwtTokenDto Request an access token for an app
896
- * @throws ApiError
938
+ * Track the interaction session, if available
897
939
  */
898
- getClientAccessToken(requestBody: AccessTokenRequestDto): CancelablePromise<JwtTokenDto>;
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;
947
+ };
948
+ type DialogueMessageUIContentDto = {
949
+ appId: string;
899
950
  /**
900
- * @param requestBody
901
- * @returns JwtTokenDto Request an access token for an app
902
- * @throws ApiError
951
+ * Reference to the authenticated client the request originated from
903
952
  */
904
- getClientAccessToken1(requestBody: AccessTokenRequestDto): CancelablePromise<JwtTokenDto>;
953
+ clientId?: string;
905
954
  /**
906
- * @param requestBody
907
- * @returns JwtTokenDto Request a refresh access token for an app
908
- * @throws ApiError
955
+ * Reference to the user interacting with the system
909
956
  */
910
- getClientRefreshToken(requestBody: RefreshTokenRequestDto): CancelablePromise<JwtTokenDto>;
957
+ userId?: string;
911
958
  /**
912
- * @param requestBody
913
- * @returns JwtTokenDto Request a refresh access token for an app
914
- * @throws ApiError
959
+ * Track the interaction session, if available
915
960
  */
916
- getClientRefreshToken1(requestBody: RefreshTokenRequestDto): CancelablePromise<JwtTokenDto>;
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;
968
+ };
969
+ type LinkContentDto = {
970
+ url: string;
971
+ label: string;
972
+ };
973
+ type LinkUIContentDto = {
974
+ appId: string;
917
975
  /**
918
- * @returns PlatformAppDto
919
- * @throws ApiError
976
+ * Reference to the authenticated client the request originated from
920
977
  */
921
- platformAppControllerListApps(): CancelablePromise<Array<PlatformAppDto>>;
978
+ clientId?: string;
922
979
  /**
923
- * @param requestBody
924
- * @returns PlatformAppDto
925
- * @throws ApiError
980
+ * Reference to the user interacting with the system
926
981
  */
927
- createApp(requestBody: CreatePlatformAppDto): CancelablePromise<PlatformAppDto>;
982
+ userId?: string;
928
983
  /**
929
- * @param requestBody
930
- * @returns PlatformAppDto
931
- * @throws ApiError
984
+ * Track the interaction session, if available
932
985
  */
933
- updateApp(requestBody: PlatformAppDto): CancelablePromise<PlatformAppDto>;
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;
934
999
  /**
935
- * @returns PlatformAppDto
936
- * @throws ApiError
1000
+ * Reference to the authenticated client the request originated from
937
1001
  */
938
- listUserApps(): CancelablePromise<Array<PlatformAppDto>>;
1002
+ clientId?: string;
939
1003
  /**
940
- * @param appId
941
- * @param requestBody
942
- * @returns any
943
- * @throws ApiError
1004
+ * Reference to the user interacting with the system
944
1005
  */
945
- updateAppTools(appId: string, requestBody: Array<AppToolsDTO>): CancelablePromise<any>;
1006
+ userId?: string;
946
1007
  /**
947
- * @param appId
948
- * @param requestBody
949
- * @returns any
950
- * @throws ApiError
1008
+ * Track the interaction session, if available
951
1009
  */
952
- updateAppSettings(appId: string, requestBody: Array<AppSettingsDto>): CancelablePromise<any>;
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;
953
1024
  /**
954
- * @param appId
955
- * @returns RepositoryConfigDto
956
- * @throws ApiError
1025
+ * Reference to the authenticated client the request originated from
957
1026
  */
958
- getAppRepository(appId: string): CancelablePromise<RepositoryConfigDto>;
1027
+ clientId?: string;
959
1028
  /**
960
- * @param appId
961
- * @param name
962
- * @returns RepositoryRobotModelDto
963
- * @throws ApiError
1029
+ * Reference to the user interacting with the system
964
1030
  */
965
- getAppRepositoryRobots(appId: string, name: string): CancelablePromise<RepositoryRobotModelDto>;
1031
+ userId?: string;
966
1032
  /**
967
- * @param appId
968
- * @param name
969
- * @returns RepositoryAvatarModelDto
970
- * @throws ApiError
1033
+ * Track the interaction session, if available
971
1034
  */
972
- getAppRepositoryAvatars(appId: string, name: string): CancelablePromise<RepositoryAvatarModelDto>;
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;
973
1050
  /**
974
- * @param appId
975
- * @param name
976
- * @returns RepositoryConfigDto
977
- * @throws ApiError
1051
+ * Reference to the authenticated client the request originated from
978
1052
  */
979
- getAppRepositoryBackgrounds(appId: string, name: string): CancelablePromise<RepositoryConfigDto>;
1053
+ clientId?: string;
980
1054
  /**
981
- * @param appId
982
- * @returns PlatformAppDto
983
- * @throws ApiError
1055
+ * Reference to the user interacting with the system
984
1056
  */
985
- readApp(appId: string): CancelablePromise<PlatformAppDto>;
1057
+ userId?: string;
986
1058
  /**
987
- * @param appId
988
- * @returns any
989
- * @throws ApiError
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
990
1102
  */
991
- removeApp(appId: string): CancelablePromise<any>;
1103
+ markerId?: Array<string>;
992
1104
  /**
993
- * Batch import of applications
994
- * @param skipClients
995
- * @param requestBody
996
- * @returns PlatformAppDto
997
- * @throws ApiError
1105
+ * List of uri to search for
1106
+ */
1107
+ payload?: Array<string>;
1108
+ tags?: Array<string>;
1109
+ };
1110
+ type XRMarkerDto = {
1111
+ appId: string;
1112
+ /**
1113
+ * Reference to the authenticated client the request originated from
998
1114
  */
999
- importApps(skipClients: string, requestBody: Array<PlatformAppDto>): CancelablePromise<Array<PlatformAppDto>>;
1115
+ clientId?: string;
1000
1116
  /**
1001
- * Batch export applications
1002
- * @param requestBody
1003
- * @returns PlatformAppDto
1004
- * @throws ApiError
1117
+ * Reference to the user interacting with the system
1005
1118
  */
1006
- exportApps(requestBody: PlatformAppExportFilterDto): CancelablePromise<Array<PlatformAppDto>>;
1119
+ userId?: string;
1007
1120
  /**
1008
- * Remove applications
1009
- * @param requestBody
1010
- * @returns any
1011
- * @throws ApiError
1121
+ * ID of the marker
1012
1122
  */
1013
- removeApps(requestBody: PlatformAppExportFilterDto): CancelablePromise<any>;
1123
+ markerId?: string;
1014
1124
  /**
1015
- * @param appId
1016
- * @param requestBody
1017
- * @returns AppClientDto
1018
- * @throws ApiError
1125
+ * Payload as decoded from the marker QR code
1019
1126
  */
1020
- createClient(appId: string, requestBody: AppClientDto): CancelablePromise<AppClientDto>;
1127
+ payload: string;
1021
1128
  /**
1022
- * @param appId
1023
- * @param clientId
1024
- * @returns AppClientDto
1025
- * @throws ApiError
1129
+ * A list of tags for the marker
1026
1130
  */
1027
- readClient(appId: string, clientId: string): CancelablePromise<AppClientDto>;
1131
+ tags?: Array<string>;
1132
+ };
1133
+ type XROcclusionResponseDto = {
1134
+ appId: string;
1028
1135
  /**
1029
- * @param clientId
1030
- * @param appId
1031
- * @returns any
1032
- * @throws ApiError
1136
+ * Reference to the authenticated client the request originated from
1033
1137
  */
1034
- removeClient(clientId: string, appId: string): CancelablePromise<any>;
1138
+ clientId?: string;
1035
1139
  /**
1036
- * @param appId
1037
- * @param clientId
1038
- * @returns string
1039
- * @throws ApiError
1140
+ * Reference to the user interacting with the system
1040
1141
  */
1041
- listTopics(appId: string, clientId: string): CancelablePromise<Array<string>>;
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;
1042
1167
  /**
1043
- * Create or update an app module
1044
- * @param appId
1045
- * @param requestBody
1046
- * @returns any
1047
- * @throws ApiError
1168
+ * Reference to the authenticated client the request originated from
1048
1169
  */
1049
- saveAppModule(appId: string, requestBody: AppModuleConfigDto): CancelablePromise<any>;
1170
+ clientId?: string;
1050
1171
  /**
1051
- * Retrieve an app module
1052
- * @param appId
1053
- * @param moduleId
1054
- * @returns any
1055
- * @throws ApiError
1172
+ * Reference to the user interacting with the system
1056
1173
  */
1057
- getAppModule(appId: string, moduleId: string): CancelablePromise<any>;
1174
+ userId?: string;
1175
+ movement: MovementDto;
1176
+ };
1177
+ type SermasBaseDto = {
1178
+ appId: string;
1058
1179
  /**
1059
- * Remove an app module
1060
- * @param appId
1061
- * @param moduleId
1062
- * @returns any
1063
- * @throws ApiError
1180
+ * Reference to the authenticated client the request originated from
1064
1181
  */
1065
- removeAppModule(appId: string, moduleId: string): CancelablePromise<any>;
1182
+ clientId?: string;
1066
1183
  /**
1067
- * Create or update an app module
1068
- * @param requestBody
1069
- * @returns any
1070
- * @throws ApiError
1184
+ * Reference to the user interacting with the system
1071
1185
  */
1072
- savePlatformModule(requestBody: PlatformModuleConfigDto): CancelablePromise<any>;
1186
+ userId?: string;
1187
+ };
1188
+ type ActuationEventDto = {
1189
+ appId: string;
1073
1190
  /**
1074
- * reload app module specs
1075
- * @param moduleId
1076
- * @returns any
1077
- * @throws ApiError
1191
+ * Reference to the authenticated client the request originated from
1078
1192
  */
1079
- refreshPlatformModule(moduleId: string): CancelablePromise<any>;
1193
+ clientId?: string;
1080
1194
  /**
1081
- * Retrieve an app module
1082
- * @param moduleId
1083
- * @returns any
1084
- * @throws ApiError
1195
+ * Reference to the user interacting with the system
1085
1196
  */
1086
- getPlatformModule(moduleId: string): CancelablePromise<any>;
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;
1087
1211
  /**
1088
- * Remove an app module
1089
- * @param moduleId
1090
- * @returns any
1091
- * @throws ApiError
1212
+ * Reference to the authenticated client the request originated from
1092
1213
  */
1093
- removePlatformModule(moduleId: string): CancelablePromise<any>;
1214
+ clientId?: string;
1094
1215
  /**
1095
- * @param appId
1096
- * @param requestBody
1097
- * @returns any
1098
- * @throws ApiError
1216
+ * Reference to the user interacting with the system
1099
1217
  */
1100
- dataLoggerControllerGetLogs(appId: string, requestBody: ViewLogsRequestDto): CancelablePromise<any>;
1101
- }
1218
+ userId?: string;
1219
+ status: StatusDto;
1220
+ robotId: string;
1221
+ };
1102
1222
 
1103
- declare class RoboticsService {
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 {
1104
1244
  readonly httpRequest: BaseHttpRequest;
1105
1245
  constructor(httpRequest: BaseHttpRequest);
1106
1246
  /**
1107
1247
  * move the robot to a specified coordinates. Based on the parameter coordinates, move the robot to that coordinates.
1108
- * @param appId
1109
- * @param room
1110
1248
  * @returns any
1111
1249
  * @throws ApiError
1112
1250
  */
1113
- roboticsAgentControllerMoveToArea(appId: string, room: string): CancelablePromise<any>;
1251
+ roboticsAgentControllerMoveToArea(data: TDataRoboticsAgentControllerMoveToArea$1): CancelablePromise<any>;
1114
1252
  /**
1115
1253
  * get the status of the robot
1116
- * @param appId
1117
- * @param robotId
1118
1254
  * @returns any
1119
1255
  * @throws ApiError
1120
1256
  */
1121
- roboticsAgentControllerStatusDescription(appId: string, robotId: string): CancelablePromise<any>;
1257
+ roboticsAgentControllerStatusDescription(data: TDataRoboticsAgentControllerStatusDescription$1): CancelablePromise<any>;
1122
1258
  /**
1123
1259
  * relocate the robot
1124
- * @param requestBody
1125
1260
  * @returns any
1126
1261
  * @throws ApiError
1127
1262
  */
1128
- roboticsAgentControllerMove(requestBody: MovementEventDto): CancelablePromise<any>;
1263
+ roboticsAgentControllerMove(data: TDataRoboticsAgentControllerMove$1): CancelablePromise<any>;
1129
1264
  /**
1130
1265
  * set initial pose of the robot
1131
- * @param requestBody
1132
1266
  * @returns any
1133
1267
  * @throws ApiError
1134
1268
  */
1135
- roboticsAgentControllerInitialPose(requestBody: SermasBaseDto): CancelablePromise<any>;
1269
+ roboticsAgentControllerInitialPose(data: TDataRoboticsAgentControllerInitialPose$1): CancelablePromise<any>;
1136
1270
  /**
1137
1271
  * execute an action on the robot
1138
- * @param requestBody
1139
1272
  * @returns any
1140
1273
  * @throws ApiError
1141
1274
  */
1142
- roboticsAgentControllerActuate(requestBody: ActuationEventDto): CancelablePromise<any>;
1275
+ roboticsAgentControllerActuate(data: TDataRoboticsAgentControllerActuate$1): CancelablePromise<any>;
1143
1276
  /**
1144
1277
  * get the status of the robot
1145
- * @param requestBody
1146
1278
  * @returns any
1147
1279
  * @throws ApiError
1148
1280
  */
1149
- roboticsAgentControllerStatus(requestBody: StatusEventDto): CancelablePromise<any>;
1281
+ roboticsAgentControllerStatus(data: TDataRoboticsAgentControllerStatus$1): CancelablePromise<any>;
1282
+ }
1283
+
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 {
1304
+ readonly httpRequest: BaseHttpRequest;
1305
+ constructor(httpRequest: BaseHttpRequest);
1150
1306
  /**
1151
- * @returns any
1307
+ * @returns AuthJwtUser
1152
1308
  * @throws ApiError
1153
1309
  */
1154
- navigationControllerSave(): CancelablePromise<any>;
1310
+ whoami(): CancelablePromise<AuthJwtUser>;
1155
1311
  /**
1156
- * @param spaceId
1157
- * @returns any
1312
+ * @returns LoginResponseDto Login user
1158
1313
  * @throws ApiError
1159
1314
  */
1160
- navigationControllerRemove(spaceId: string): CancelablePromise<any>;
1315
+ login(data: TDataLogin): CancelablePromise<LoginResponseDto>;
1161
1316
  /**
1162
- * @param spaceId
1163
- * @returns any
1317
+ * @returns RegistrationResponseDto Register a new user
1164
1318
  * @throws ApiError
1165
1319
  */
1166
- navigationControllerGetById(spaceId: string): CancelablePromise<any>;
1320
+ register(data: TDataRegister): CancelablePromise<RegistrationResponseDto>;
1167
1321
  /**
1168
- * @param appId
1169
- * @param robotId
1170
- * @returns any
1322
+ * @returns LoginResponseDto Refresh token
1171
1323
  * @throws ApiError
1172
1324
  */
1173
- navigationControllerGetStatus(appId: string, robotId: string): CancelablePromise<any>;
1174
- }
1175
-
1176
- type AgentHeartBeatEventDto = {
1177
- appId: string;
1325
+ refreshToken(data: TDataRefreshToken): CancelablePromise<LoginResponseDto>;
1178
1326
  /**
1179
- * Reference to the authenticated client the request originated from
1327
+ * @returns any Updates user data
1328
+ * @throws ApiError
1180
1329
  */
1181
- clientId?: string;
1330
+ edit(data: TDataEdit): CancelablePromise<any>;
1182
1331
  /**
1183
- * Reference to the user interacting with the system
1332
+ * @returns any Deletes a user and all of its resources
1333
+ * @throws ApiError
1184
1334
  */
1185
- userId?: string;
1335
+ delete(data: TDataDelete): CancelablePromise<any>;
1186
1336
  /**
1187
- * Track the interaction session, if available
1337
+ * @returns any
1338
+ * @throws ApiError
1188
1339
  */
1189
- sessionId?: string;
1190
- moduleId: string;
1191
- status: 'unavailable' | 'error' | 'not_ready' | 'ready' | 'loading' | 'interacting' | 'waiting' | 'processing';
1192
- };
1340
+ authAdminControllerSaveUser(data: TDataAuthAdminControllerSaveUser): CancelablePromise<any>;
1341
+ }
1193
1342
 
1194
- type SessionDto = {
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 = {
1195
1357
  appId: string;
1358
+ cameraId: string;
1359
+ overlay: string;
1360
+ };
1361
+ declare class DetectionService {
1362
+ readonly httpRequest: BaseHttpRequest;
1363
+ constructor(httpRequest: BaseHttpRequest);
1196
1364
  /**
1197
- * Reference to the authenticated client the request originated from
1365
+ * @returns any
1366
+ * @throws ApiError
1198
1367
  */
1199
- clientId?: string;
1368
+ detectionControllerSentimentAnalysis(data: TDataDetectionControllerSentimentAnalysis): CancelablePromise<any>;
1200
1369
  /**
1201
- * Reference to the user interacting with the system
1370
+ * @returns any
1371
+ * @throws ApiError
1202
1372
  */
1203
- userId?: string;
1204
- sessionId?: string;
1373
+ detectionControllerInteractionIntention(data: TDataDetectionControllerInteractionIntention): CancelablePromise<any>;
1205
1374
  /**
1206
- * Agent instance associated to the session
1375
+ * @returns any
1376
+ * @throws ApiError
1207
1377
  */
1208
- agentId?: string;
1378
+ detectionControllerSendFrame(data: TDataDetectionControllerSendFrame): CancelablePromise<any>;
1209
1379
  /**
1210
- * Collect inferred identifiers of user interacting with the agent during a session.
1380
+ * @returns any
1381
+ * @throws ApiError
1211
1382
  */
1212
- user?: Array<string>;
1213
- modifiedAt: string;
1214
- createdAt: string;
1215
- closedAt: string;
1216
- };
1383
+ detectionControllerServe(data: TDataDetectionControllerServe): CancelablePromise<any>;
1384
+ }
1217
1385
 
1218
- type SessionStorageRecordDto = {
1219
- appId: string;
1220
- /**
1221
- * Reference to the authenticated client the request originated from
1222
- */
1223
- clientId?: string;
1386
+ type TDataSave = {
1387
+ requestBody: DialogueDocumentDto;
1388
+ };
1389
+ type TDataImport = {
1224
1390
  /**
1225
- * Reference to the user interacting with the system
1391
+ * Documents list
1226
1392
  */
1227
- userId?: string;
1228
- storageId?: string;
1229
- sessionId?: string;
1230
- data: Record<string, any>;
1393
+ requestBody: Array<DialogueDocumentDto>;
1231
1394
  };
1232
-
1233
- type SessionStorageSearchDto = {
1395
+ type TDataRemove = {
1234
1396
  appId: string;
1235
- userId?: Array<string>;
1236
- sessionId?: Array<string>;
1237
- storageId?: Array<string>;
1397
+ documentId: Array<string>;
1238
1398
  };
1239
-
1240
- type SessionSupportRequestDto = {
1399
+ type TDataSpeak = {
1400
+ requestBody: DialogueTextToSpeechDto;
1401
+ };
1402
+ type TDataText = {
1241
1403
  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;
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;
1250
1453
  sessionId: string;
1251
- code: string;
1252
- message: string;
1253
1454
  };
1254
-
1255
- type SessionSupportResponseDto = {
1455
+ type TDataChatMessage = {
1256
1456
  appId: string;
1257
- /**
1258
- * Reference to the authenticated client the request originated from
1259
- */
1260
- clientId?: string;
1261
- /**
1262
- * Reference to the user interacting with the system
1263
- */
1264
- userId?: string;
1265
- supportId: string;
1457
+ requestBody: DialogueMessageDto;
1458
+ sessionId: string;
1266
1459
  };
1267
-
1268
- declare class SessionService {
1460
+ type TDataStopAgentSpeech = {
1461
+ appId: string;
1462
+ sessionId: string;
1463
+ };
1464
+ type TDataGetToolsfFromAppId = {
1465
+ appId: string;
1466
+ requestBody: Array<string>;
1467
+ sessionId: string;
1468
+ };
1469
+ declare class DialogueService {
1269
1470
  readonly httpRequest: BaseHttpRequest;
1270
1471
  constructor(httpRequest: BaseHttpRequest);
1271
1472
  /**
1272
- * Load current user session
1273
- * @param appId
1274
- * @returns any
1473
+ * @returns DialogueDocumentDto Saved document
1275
1474
  * @throws ApiError
1276
1475
  */
1277
- getUserSession(appId: string): CancelablePromise<any>;
1476
+ save(data: TDataSave): CancelablePromise<DialogueDocumentDto>;
1278
1477
  /**
1279
- * Load a session
1280
- * @param sessionId
1281
- * @returns any
1478
+ * Import RAG documents
1479
+ * @returns DialogueDocumentDto
1282
1480
  * @throws ApiError
1283
1481
  */
1284
- readSession(sessionId: string): CancelablePromise<any>;
1482
+ import(data: TDataImport): CancelablePromise<Array<DialogueDocumentDto>>;
1285
1483
  /**
1286
- * Remove session
1287
- * @param sessionId
1484
+ * Remove RAG documents
1288
1485
  * @returns any
1289
1486
  * @throws ApiError
1290
1487
  */
1291
- deleteSession(sessionId: string): CancelablePromise<any>;
1488
+ remove(data: TDataRemove): CancelablePromise<any>;
1292
1489
  /**
1293
- * Create session
1294
- * @param requestBody
1490
+ * Converts a text to voice as mp3
1295
1491
  * @returns any
1296
1492
  * @throws ApiError
1297
1493
  */
1298
- createSession(requestBody: SessionDto): CancelablePromise<any>;
1494
+ speak(data: TDataSpeak): CancelablePromise<any>;
1299
1495
  /**
1300
- * Update session
1301
- * @param requestBody
1302
1496
  * @returns any
1303
1497
  * @throws ApiError
1304
1498
  */
1305
- updateSession(requestBody: SessionDto): CancelablePromise<any>;
1499
+ text(data: TDataText): CancelablePromise<any>;
1306
1500
  /**
1307
- * Notifies of an agent update
1308
- * @param requestBody
1309
1501
  * @returns any
1310
1502
  * @throws ApiError
1311
1503
  */
1312
- agentUpdate(requestBody: AgentHeartBeatEventDto): CancelablePromise<any>;
1313
- /**
1314
- * Request support from human
1315
- * @param requestBody
1316
- * @returns SessionSupportResponseDto Human support requested
1317
- * @throws ApiError
1318
- */
1319
- support(requestBody: SessionSupportRequestDto): CancelablePromise<SessionSupportResponseDto>;
1320
- /**
1321
- * Store user data
1322
- * @param requestBody
1323
- * @returns SessionStorageRecordDto Record stored
1324
- * @throws ApiError
1325
- */
1326
- setRecord(requestBody: SessionStorageRecordDto): CancelablePromise<SessionStorageRecordDto>;
1504
+ chatMessage(data: TDataChatMessage): CancelablePromise<any>;
1327
1505
  /**
1328
- * Store user data
1329
- * @param requestBody
1330
- * @returns SessionStorageRecordDto Record stored
1506
+ * @returns any
1331
1507
  * @throws ApiError
1332
1508
  */
1333
- findRecords(requestBody: SessionStorageSearchDto): CancelablePromise<Array<SessionStorageRecordDto>>;
1509
+ stopAgentSpeech(data: TDataStopAgentSpeech): CancelablePromise<any>;
1334
1510
  /**
1335
- * Retrieve stored data
1336
- * @param storageId
1337
- * @returns SessionStorageRecordDto Record retrieved
1511
+ * @returns any
1338
1512
  * @throws ApiError
1339
1513
  */
1340
- getRecord(storageId: string): CancelablePromise<SessionStorageRecordDto>;
1514
+ import1(): CancelablePromise<any>;
1341
1515
  /**
1342
- * Delete a record
1343
- * @param storageId
1344
- * @returns any Record deleted
1516
+ * @returns any
1345
1517
  * @throws ApiError
1346
1518
  */
1347
- deleteRecord(storageId: string): CancelablePromise<any>;
1519
+ getToolsfFromAppId(data: TDataGetToolsfFromAppId): CancelablePromise<any>;
1348
1520
  }
1349
1521
 
1350
- type Buffer$1 = {};
1351
-
1352
- type UIContentOptionsDto = {
1353
- /**
1354
- * Clear the UI screen
1355
- */
1356
- clearScreen?: boolean;
1357
- /**
1358
- * Enable agent reading the content (text to speech)
1359
- */
1360
- ttsEnabled?: boolean;
1361
- /**
1362
- * Stop the agent speech
1363
- */
1364
- stopSpeech?: boolean;
1522
+ type TDataGetClientAccessToken = {
1523
+ requestBody: AccessTokenRequestDto;
1365
1524
  };
1366
-
1367
- type UIContentDto = {
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 = {
1368
1541
  appId: string;
1369
- /**
1370
- * Reference to the authenticated client the request originated from
1371
- */
1372
- clientId?: string;
1373
- /**
1374
- * Reference to the user interacting with the system
1375
- */
1376
- userId?: string;
1377
- /**
1378
- * Track the interaction session, if available
1379
- */
1380
- sessionId?: string;
1381
- contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
1382
- content: Record<string, any>;
1383
- metadata?: Record<string, any>;
1384
- options?: UIContentOptionsDto;
1385
- chunkId?: number;
1386
- messageId?: string;
1542
+ requestBody: Array<AppToolsDTO>;
1387
1543
  };
1388
-
1389
- type UIInteractionDTO = {
1390
- context: Record<string, any>;
1391
- element: string;
1392
- value: string;
1544
+ type TDataUpdateAppSettings = {
1545
+ appId: string;
1546
+ requestBody: Array<AppSettingsDto>;
1393
1547
  };
1394
-
1395
- type UIModelMapBlendShapesRequestDto = {
1396
- blendShapes: Array<string>;
1548
+ type TDataGetAppRepository = {
1549
+ appId: string;
1397
1550
  };
1398
-
1399
- type UIModelMapBlendShapesResponseDto = {
1400
- blendShapes: Record<string, any>;
1551
+ type TDataGetAppRepositoryRobots = {
1552
+ appId: string;
1553
+ name: string;
1401
1554
  };
1402
-
1403
- declare class UiService {
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 {
1404
1624
  readonly httpRequest: BaseHttpRequest;
1405
1625
  constructor(httpRequest: BaseHttpRequest);
1406
1626
  /**
1407
- * Trigger a UI interaction
1408
- * @param appId
1409
- * @param moduleId
1410
- * @param requestBody
1411
- * @returns any
1627
+ * @returns PlatformSettingsDto
1412
1628
  * @throws ApiError
1413
1629
  */
1414
- notifyInteraction(appId: string, moduleId: string, requestBody: UIInteractionDTO): CancelablePromise<any>;
1630
+ getUserSettings(): CancelablePromise<PlatformSettingsDto>;
1415
1631
  /**
1416
- * Show content
1417
- * @param requestBody
1418
- * @returns UIContentDto Content to show
1632
+ * @returns PlatformSettingsDto
1419
1633
  * @throws ApiError
1420
1634
  */
1421
- showContent(requestBody: UIContentDto): CancelablePromise<UIContentDto>;
1635
+ getSettings(): CancelablePromise<PlatformSettingsDto>;
1422
1636
  /**
1423
- * Tries to map model blend shapes by name similarity
1424
- * @param requestBody
1425
- * @returns UIModelMapBlendShapesResponseDto Map model blend shapes
1637
+ * @returns JwtTokenDto Request an access token for an app
1426
1638
  * @throws ApiError
1427
1639
  */
1428
- uiModelControllerMapBlendShapes(requestBody: UIModelMapBlendShapesRequestDto): CancelablePromise<UIModelMapBlendShapesResponseDto>;
1640
+ getClientAccessToken(data: TDataGetClientAccessToken): CancelablePromise<JwtTokenDto>;
1429
1641
  /**
1430
- * Retrieve an asset
1431
- * @param path
1432
- * @param appId
1433
- * @returns Buffer Download an asset by url
1642
+ * @returns JwtTokenDto Request an access token for an app
1434
1643
  * @throws ApiError
1435
1644
  */
1436
- getAsset(path: string, appId: string): CancelablePromise<Buffer$1>;
1645
+ getClientAccessToken1(data: TDataGetClientAccessToken1): CancelablePromise<JwtTokenDto>;
1437
1646
  /**
1438
- * @param formData
1439
- * @returns any
1647
+ * @returns JwtTokenDto Request a refresh access token for an app
1440
1648
  * @throws ApiError
1441
1649
  */
1442
- saveModel(formData: {
1443
- file?: Blob;
1444
- }): CancelablePromise<any>;
1650
+ getClientRefreshToken(data: TDataGetClientRefreshToken): CancelablePromise<JwtTokenDto>;
1445
1651
  /**
1446
- * @param formData
1447
- * @returns any
1652
+ * @returns JwtTokenDto Request a refresh access token for an app
1448
1653
  * @throws ApiError
1449
1654
  */
1450
- saveBackground(formData: {
1451
- file?: Blob;
1452
- }): CancelablePromise<any>;
1655
+ getClientRefreshToken1(data: TDataGetClientRefreshToken1): CancelablePromise<JwtTokenDto>;
1453
1656
  /**
1454
- * @param formData
1455
- * @returns any
1657
+ * @returns PlatformAppDto
1456
1658
  * @throws ApiError
1457
1659
  */
1458
- saveDocuments(formData: {
1459
- file?: Blob;
1460
- }): CancelablePromise<any>;
1461
- }
1462
-
1463
- type XRMarkerDto = {
1464
- appId: string;
1465
- /**
1466
- * Reference to the authenticated client the request originated from
1467
- */
1468
- clientId?: string;
1469
- /**
1470
- * Reference to the user interacting with the system
1471
- */
1472
- userId?: string;
1473
- /**
1474
- * ID of the marker
1475
- */
1476
- markerId?: string;
1477
- /**
1478
- * Payload as decoded from the marker QR code
1479
- */
1480
- payload: string;
1660
+ platformAppControllerListApps(): CancelablePromise<Array<PlatformAppDto>>;
1481
1661
  /**
1482
- * A list of tags for the marker
1662
+ * @returns PlatformAppDto
1663
+ * @throws ApiError
1483
1664
  */
1484
- tags?: Array<string>;
1485
- };
1486
-
1487
- type XRMarkerListRequestDto = {
1488
- appId: string;
1665
+ createApp(data: TDataCreateApp): CancelablePromise<PlatformAppDto>;
1489
1666
  /**
1490
- * List of marker ID to search for
1667
+ * @returns PlatformAppDto
1668
+ * @throws ApiError
1491
1669
  */
1492
- markerId?: Array<string>;
1670
+ updateApp(data: TDataUpdateApp): CancelablePromise<PlatformAppDto>;
1493
1671
  /**
1494
- * List of uri to search for
1672
+ * @returns PlatformAppDto
1673
+ * @throws ApiError
1495
1674
  */
1496
- payload?: Array<string>;
1497
- tags?: Array<string>;
1498
- };
1499
-
1500
- type XROcclusionResponseDto = {
1501
- appId: string;
1675
+ listUserApps(): CancelablePromise<Array<PlatformAppDto>>;
1502
1676
  /**
1503
- * Reference to the authenticated client the request originated from
1677
+ * @returns any
1678
+ * @throws ApiError
1504
1679
  */
1505
- clientId?: string;
1680
+ updateAppTools(data: TDataUpdateAppTools): CancelablePromise<any>;
1506
1681
  /**
1507
- * Reference to the user interacting with the system
1682
+ * @returns any
1683
+ * @throws ApiError
1508
1684
  */
1509
- userId?: string;
1510
- occlusion: boolean;
1511
- };
1512
-
1513
- declare class XrService {
1514
- readonly httpRequest: BaseHttpRequest;
1515
- constructor(httpRequest: BaseHttpRequest);
1685
+ updateAppSettings(data: TDataUpdateAppSettings): CancelablePromise<any>;
1516
1686
  /**
1517
- * List available markers
1518
- * @param requestBody
1519
- * @returns XRMarkerDto Marker created or updated
1687
+ * @returns RepositoryConfigDto
1520
1688
  * @throws ApiError
1521
1689
  */
1522
- xrMarkerControllerSearchMarker(requestBody: XRMarkerListRequestDto): CancelablePromise<Array<XRMarkerDto>>;
1690
+ getAppRepository(data: TDataGetAppRepository): CancelablePromise<RepositoryConfigDto>;
1523
1691
  /**
1524
- * Save a marker
1525
- * @param requestBody
1526
- * @returns XRMarkerDto Marker saved
1692
+ * @returns RepositoryRobotModelDto
1527
1693
  * @throws ApiError
1528
1694
  */
1529
- xrMarkerControllerSaveMarker(requestBody: XRMarkerDto): CancelablePromise<XRMarkerDto>;
1695
+ getAppRepositoryRobots(data: TDataGetAppRepositoryRobots): CancelablePromise<RepositoryRobotModelDto>;
1530
1696
  /**
1531
- * Delete a marker
1532
- * @param markerId
1533
- * @returns XRMarkerDto Marker deleted
1697
+ * @returns RepositoryAvatarModelDto
1534
1698
  * @throws ApiError
1535
1699
  */
1536
- xrMarkerControllerDeleteMarker(markerId: string): CancelablePromise<XRMarkerDto>;
1700
+ getAppRepositoryAvatars(data: TDataGetAppRepositoryAvatars): CancelablePromise<RepositoryAvatarModelDto>;
1537
1701
  /**
1538
- * Get the marker QR code as image (jpeg)
1539
- * @param markerId
1540
- * @returns binary Marker retrieved
1702
+ * @returns RepositoryConfigDto
1541
1703
  * @throws ApiError
1542
1704
  */
1543
- xrMarkerControllerGetMarkerQrCode(markerId: string): CancelablePromise<Blob>;
1705
+ getAppRepositoryBackgrounds(data: TDataGetAppRepositoryBackgrounds): CancelablePromise<RepositoryConfigDto>;
1544
1706
  /**
1545
- * Indicate if a 3D asset model is occluded by a physical obstacle.
1546
- * @returns XROcclusionResponseDto Got information about 3D model
1707
+ * @returns PlatformAppDto
1547
1708
  * @throws ApiError
1548
- */
1549
- xrOcclusionControllerOcclusion(): CancelablePromise<XROcclusionResponseDto>;
1550
- }
1551
-
1552
- type HttpRequestConstructor = new (config: OpenAPIConfig) => BaseHttpRequest;
1553
- declare class SermasApi {
1554
- readonly agent: AgentService;
1555
- readonly authentication: AuthenticationService;
1556
- readonly detection: DetectionService;
1557
- readonly dialogue: DialogueService;
1558
- readonly platform: PlatformService;
1559
- readonly robotics: RoboticsService;
1560
- readonly session: SessionService;
1561
- readonly ui: UiService;
1562
- readonly xr: XrService;
1563
- readonly request: BaseHttpRequest;
1564
- constructor(config?: Partial<OpenAPIConfig>, HttpRequest?: HttpRequestConstructor);
1565
- }
1566
-
1567
- type ButtonDto = {
1568
- value: string;
1569
- id?: string;
1570
- label?: string;
1571
- classes?: Array<string>;
1572
- options?: UIContentOptionsDto;
1573
- };
1574
-
1575
- type ButtonsContentDto = {
1576
- label: string;
1577
- list: Array<ButtonDto>;
1578
- };
1579
-
1580
- type ButtonsUIContentDto = {
1581
- appId: string;
1709
+ */
1710
+ readApp(data: TDataReadApp): CancelablePromise<PlatformAppDto>;
1582
1711
  /**
1583
- * Reference to the authenticated client the request originated from
1712
+ * @returns any
1713
+ * @throws ApiError
1584
1714
  */
1585
- clientId?: string;
1715
+ removeApp(data: TDataRemoveApp): CancelablePromise<any>;
1586
1716
  /**
1587
- * Reference to the user interacting with the system
1717
+ * Batch import of applications
1718
+ * @returns PlatformAppDto
1719
+ * @throws ApiError
1588
1720
  */
1589
- userId?: string;
1721
+ importApps(data: TDataImportApps): CancelablePromise<Array<PlatformAppDto>>;
1590
1722
  /**
1591
- * Track the interaction session, if available
1723
+ * Batch export applications
1724
+ * @returns PlatformAppDto
1725
+ * @throws ApiError
1592
1726
  */
1593
- sessionId?: string;
1594
- contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
1595
- content: ButtonsContentDto;
1596
- metadata?: Record<string, any>;
1597
- options?: UIContentOptionsDto;
1598
- chunkId?: number;
1599
- messageId?: string;
1600
- };
1601
-
1602
- type ClearScreenDto = {
1603
- appId: string;
1727
+ exportApps(data: TDataExportApps): CancelablePromise<Array<PlatformAppDto>>;
1604
1728
  /**
1605
- * Reference to the authenticated client the request originated from
1729
+ * Remove applications
1730
+ * @returns any
1731
+ * @throws ApiError
1606
1732
  */
1607
- clientId?: string;
1733
+ removeApps(data: TDataRemoveApps): CancelablePromise<any>;
1608
1734
  /**
1609
- * Reference to the user interacting with the system
1735
+ * @returns AppClientDto
1736
+ * @throws ApiError
1610
1737
  */
1611
- userId?: string;
1738
+ createClient(data: TDataCreateClient): CancelablePromise<AppClientDto>;
1612
1739
  /**
1613
- * Track the interaction session, if available
1740
+ * @returns AppClientDto
1741
+ * @throws ApiError
1614
1742
  */
1615
- sessionId?: string;
1616
- contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
1617
- content: Record<string, any>;
1618
- metadata?: Record<string, any>;
1619
- options?: UIContentOptionsDto;
1620
- chunkId?: number;
1621
- messageId?: string;
1622
- };
1623
-
1624
- type ClearUIContentDto = {
1625
- appId: string;
1743
+ readClient(data: TDataReadClient): CancelablePromise<AppClientDto>;
1626
1744
  /**
1627
- * Reference to the authenticated client the request originated from
1745
+ * @returns any
1746
+ * @throws ApiError
1628
1747
  */
1629
- clientId?: string;
1748
+ removeClient(data: TDataRemoveClient): CancelablePromise<any>;
1630
1749
  /**
1631
- * Reference to the user interacting with the system
1750
+ * @returns string
1751
+ * @throws ApiError
1632
1752
  */
1633
- userId?: string;
1753
+ listTopics(data: TDataListTopics): CancelablePromise<Array<string>>;
1634
1754
  /**
1635
- * Track the interaction session, if available
1755
+ * Create or update an app module
1756
+ * @returns any
1757
+ * @throws ApiError
1636
1758
  */
1637
- sessionId?: string;
1638
- contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
1639
- content: Record<string, any>;
1640
- metadata?: Record<string, any>;
1641
- options?: UIContentOptionsDto;
1642
- chunkId?: number;
1643
- messageId?: string;
1644
- };
1645
-
1646
- type DialogueMessageUIContentDto = {
1647
- appId: string;
1759
+ saveAppModule(data: TDataSaveAppModule): CancelablePromise<any>;
1648
1760
  /**
1649
- * Reference to the authenticated client the request originated from
1761
+ * Retrieve an app module
1762
+ * @returns any
1763
+ * @throws ApiError
1650
1764
  */
1651
- clientId?: string;
1765
+ getAppModule(data: TDataGetAppModule): CancelablePromise<any>;
1652
1766
  /**
1653
- * Reference to the user interacting with the system
1767
+ * Remove an app module
1768
+ * @returns any
1769
+ * @throws ApiError
1654
1770
  */
1655
- userId?: string;
1771
+ removeAppModule(data: TDataRemoveAppModule): CancelablePromise<any>;
1656
1772
  /**
1657
- * Track the interaction session, if available
1773
+ * Create or update an app module
1774
+ * @returns any
1775
+ * @throws ApiError
1658
1776
  */
1659
- sessionId?: string;
1660
- contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
1661
- content: DialogueMessageDto;
1662
- metadata?: Record<string, any>;
1663
- options?: UIContentOptionsDto;
1664
- chunkId?: number;
1665
- messageId?: string;
1666
- };
1667
-
1668
- type EmailContentDto = {
1669
- email: string;
1670
- label: string;
1671
- };
1672
-
1673
- type EmailUIContentDto = {
1674
- appId: string;
1777
+ savePlatformModule(data: TDataSavePlatformModule): CancelablePromise<any>;
1675
1778
  /**
1676
- * Reference to the authenticated client the request originated from
1779
+ * reload app module specs
1780
+ * @returns any
1781
+ * @throws ApiError
1677
1782
  */
1678
- clientId?: string;
1783
+ refreshPlatformModule(data: TDataRefreshPlatformModule): CancelablePromise<any>;
1679
1784
  /**
1680
- * Reference to the user interacting with the system
1785
+ * Retrieve an app module
1786
+ * @returns any
1787
+ * @throws ApiError
1681
1788
  */
1682
- userId?: string;
1789
+ getPlatformModule(data: TDataGetPlatformModule): CancelablePromise<any>;
1683
1790
  /**
1684
- * Track the interaction session, if available
1791
+ * Remove an app module
1792
+ * @returns any
1793
+ * @throws ApiError
1685
1794
  */
1686
- sessionId?: string;
1687
- contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
1688
- content: EmailContentDto;
1689
- metadata?: Record<string, any>;
1690
- options?: UIContentOptionsDto;
1691
- chunkId?: number;
1692
- messageId?: string;
1693
- };
1795
+ removePlatformModule(data: TDataRemovePlatformModule): CancelablePromise<any>;
1796
+ /**
1797
+ * @returns any
1798
+ * @throws ApiError
1799
+ */
1800
+ dataLoggerControllerGetLogs(data: TDataDataLoggerControllerGetLogs): CancelablePromise<any>;
1801
+ }
1694
1802
 
1695
- type HtmlContentDto = {
1696
- html: string;
1803
+ type TDataRoboticsAgentControllerMoveToArea = {
1804
+ appId: string;
1805
+ room: string;
1697
1806
  };
1698
-
1699
- type HtmlUIContentDto = {
1807
+ type TDataRoboticsAgentControllerStatusDescription = {
1808
+ appId: string;
1809
+ robotId: string;
1810
+ };
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 = {
1700
1830
  appId: string;
1831
+ robotId: string;
1832
+ };
1833
+ declare class RoboticsService {
1834
+ readonly httpRequest: BaseHttpRequest;
1835
+ constructor(httpRequest: BaseHttpRequest);
1701
1836
  /**
1702
- * Reference to the authenticated client the request originated from
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
1703
1840
  */
1704
- clientId?: string;
1841
+ roboticsAgentControllerMoveToArea(data: TDataRoboticsAgentControllerMoveToArea): CancelablePromise<any>;
1705
1842
  /**
1706
- * Reference to the user interacting with the system
1843
+ * get the status of the robot
1844
+ * @returns any
1845
+ * @throws ApiError
1707
1846
  */
1708
- userId?: string;
1847
+ roboticsAgentControllerStatusDescription(data: TDataRoboticsAgentControllerStatusDescription): CancelablePromise<any>;
1709
1848
  /**
1710
- * Track the interaction session, if available
1849
+ * relocate the robot
1850
+ * @returns any
1851
+ * @throws ApiError
1711
1852
  */
1712
- sessionId?: string;
1713
- contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
1714
- content: HtmlContentDto;
1715
- metadata?: Record<string, any>;
1716
- options?: UIContentOptionsDto;
1717
- chunkId?: number;
1718
- messageId?: string;
1719
- };
1720
-
1721
- type ImageContentDto = {
1722
- src: string;
1723
- width?: number;
1724
- height?: number;
1725
- alt: string;
1726
- };
1727
-
1728
- type ImageUIContentDto = {
1729
- appId: string;
1853
+ roboticsAgentControllerMove(data: TDataRoboticsAgentControllerMove): CancelablePromise<any>;
1730
1854
  /**
1731
- * Reference to the authenticated client the request originated from
1855
+ * set initial pose of the robot
1856
+ * @returns any
1857
+ * @throws ApiError
1732
1858
  */
1733
- clientId?: string;
1859
+ roboticsAgentControllerInitialPose(data: TDataRoboticsAgentControllerInitialPose): CancelablePromise<any>;
1734
1860
  /**
1735
- * Reference to the user interacting with the system
1861
+ * execute an action on the robot
1862
+ * @returns any
1863
+ * @throws ApiError
1736
1864
  */
1737
- userId?: string;
1865
+ roboticsAgentControllerActuate(data: TDataRoboticsAgentControllerActuate): CancelablePromise<any>;
1738
1866
  /**
1739
- * Track the interaction session, if available
1867
+ * get the status of the robot
1868
+ * @returns any
1869
+ * @throws ApiError
1740
1870
  */
1741
- sessionId?: string;
1742
- contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
1743
- content: ImageContentDto;
1744
- metadata?: Record<string, any>;
1745
- options?: UIContentOptionsDto;
1746
- chunkId?: number;
1747
- messageId?: string;
1748
- };
1749
-
1750
- type LinkContentDto = {
1751
- url: string;
1752
- label: string;
1753
- };
1754
-
1755
- type LinkUIContentDto = {
1756
- appId: string;
1871
+ roboticsAgentControllerStatus(data: TDataRoboticsAgentControllerStatus): CancelablePromise<any>;
1757
1872
  /**
1758
- * Reference to the authenticated client the request originated from
1873
+ * @returns any
1874
+ * @throws ApiError
1759
1875
  */
1760
- clientId?: string;
1876
+ navigationControllerSave(): CancelablePromise<any>;
1761
1877
  /**
1762
- * Reference to the user interacting with the system
1878
+ * @returns any
1879
+ * @throws ApiError
1763
1880
  */
1764
- userId?: string;
1881
+ navigationControllerRemove(data: TDataNavigationControllerRemove): CancelablePromise<any>;
1765
1882
  /**
1766
- * Track the interaction session, if available
1883
+ * @returns any
1884
+ * @throws ApiError
1767
1885
  */
1768
- sessionId?: string;
1769
- contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
1770
- content: LinkContentDto;
1771
- metadata?: Record<string, any>;
1772
- options?: UIContentOptionsDto;
1773
- chunkId?: number;
1774
- messageId?: string;
1775
- };
1776
-
1777
- type ObjectContentDto = {
1778
- url: string;
1779
- };
1886
+ navigationControllerGetById(data: TDataNavigationControllerGetById): CancelablePromise<any>;
1887
+ /**
1888
+ * @returns any
1889
+ * @throws ApiError
1890
+ */
1891
+ navigationControllerGetStatus(data: TDataNavigationControllerGetStatus): CancelablePromise<any>;
1892
+ }
1780
1893
 
1781
- type ObjectUIContentDto = {
1894
+ type TDataGetUserSession = {
1782
1895
  appId: string;
1896
+ };
1897
+ type TDataReadSession = {
1898
+ sessionId: string;
1899
+ };
1900
+ type TDataDeleteSession = {
1901
+ sessionId: string;
1902
+ };
1903
+ type TDataCreateSession = {
1904
+ requestBody: SessionDto;
1905
+ };
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);
1783
1930
  /**
1784
- * Reference to the authenticated client the request originated from
1931
+ * Load current user session
1932
+ * @returns any
1933
+ * @throws ApiError
1934
+ */
1935
+ getUserSession(data: TDataGetUserSession): CancelablePromise<any>;
1936
+ /**
1937
+ * Load a session
1938
+ * @returns any
1939
+ * @throws ApiError
1940
+ */
1941
+ readSession(data: TDataReadSession): CancelablePromise<any>;
1942
+ /**
1943
+ * Remove session
1944
+ * @returns any
1945
+ * @throws ApiError
1785
1946
  */
1786
- clientId?: string;
1947
+ deleteSession(data: TDataDeleteSession): CancelablePromise<any>;
1787
1948
  /**
1788
- * Reference to the user interacting with the system
1949
+ * Create session
1950
+ * @returns any
1951
+ * @throws ApiError
1789
1952
  */
1790
- userId?: string;
1953
+ createSession(data: TDataCreateSession): CancelablePromise<any>;
1791
1954
  /**
1792
- * Track the interaction session, if available
1955
+ * Update session
1956
+ * @returns any
1957
+ * @throws ApiError
1793
1958
  */
1794
- sessionId?: string;
1795
- contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
1796
- content: ObjectContentDto;
1797
- metadata?: Record<string, any>;
1798
- options?: UIContentOptionsDto;
1799
- chunkId?: number;
1800
- messageId?: string;
1801
- };
1802
-
1803
- type PdfContentDto = {
1804
- url: string;
1805
- };
1806
-
1807
- type PdfUIContentDto = {
1808
- appId: string;
1959
+ updateSession(data: TDataUpdateSession): CancelablePromise<any>;
1809
1960
  /**
1810
- * Reference to the authenticated client the request originated from
1961
+ * Notifies of an agent update
1962
+ * @returns any
1963
+ * @throws ApiError
1811
1964
  */
1812
- clientId?: string;
1965
+ agentUpdate(data: TDataAgentUpdate): CancelablePromise<any>;
1813
1966
  /**
1814
- * Reference to the user interacting with the system
1967
+ * Request support from human
1968
+ * @returns SessionSupportResponseDto Human support requested
1969
+ * @throws ApiError
1815
1970
  */
1816
- userId?: string;
1971
+ support(data: TDataSupport): CancelablePromise<SessionSupportResponseDto>;
1817
1972
  /**
1818
- * Track the interaction session, if available
1973
+ * Store user data
1974
+ * @returns SessionStorageRecordDto Record stored
1975
+ * @throws ApiError
1819
1976
  */
1820
- sessionId?: string;
1821
- contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
1822
- content: PdfContentDto;
1823
- metadata?: Record<string, any>;
1824
- options?: UIContentOptionsDto;
1825
- chunkId?: number;
1826
- messageId?: string;
1827
- };
1828
-
1829
- type QuizAnswerDto = {
1830
- answer: string;
1831
- reason: string;
1832
- correct: boolean;
1833
- };
1834
-
1835
- type QuizContentDto = {
1836
- question: string;
1837
- answers: Array<QuizAnswerDto>;
1838
- };
1839
-
1840
- type QuizUIContentDto = {
1841
- appId: string;
1977
+ setRecord(data: TDataSetRecord): CancelablePromise<SessionStorageRecordDto>;
1842
1978
  /**
1843
- * Reference to the authenticated client the request originated from
1979
+ * Store user data
1980
+ * @returns SessionStorageRecordDto Record stored
1981
+ * @throws ApiError
1844
1982
  */
1845
- clientId?: string;
1983
+ findRecords(data: TDataFindRecords): CancelablePromise<Array<SessionStorageRecordDto>>;
1846
1984
  /**
1847
- * Reference to the user interacting with the system
1985
+ * Retrieve stored data
1986
+ * @returns SessionStorageRecordDto Record retrieved
1987
+ * @throws ApiError
1848
1988
  */
1849
- userId?: string;
1989
+ getRecord(data: TDataGetRecord): CancelablePromise<SessionStorageRecordDto>;
1850
1990
  /**
1851
- * Track the interaction session, if available
1991
+ * Delete a record
1992
+ * @returns any Record deleted
1993
+ * @throws ApiError
1852
1994
  */
1853
- sessionId?: string;
1854
- contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
1855
- content: QuizContentDto;
1856
- metadata?: Record<string, any>;
1857
- options?: UIContentOptionsDto;
1858
- chunkId?: number;
1859
- messageId?: string;
1860
- };
1995
+ deleteRecord(data: TDataDeleteRecord): CancelablePromise<any>;
1996
+ }
1861
1997
 
1862
- type RepositoryBackgroundMetadataDto = {
1863
- credits?: string;
1998
+ type TDataNotifyInteraction = {
1999
+ appId: string;
2000
+ moduleId: string;
2001
+ requestBody: UIInteractionDTO;
1864
2002
  };
1865
-
1866
- type RepositoryBackgroundModelDto = {
1867
- name?: string;
1868
- path: string;
1869
- metadata?: RepositoryBackgroundMetadataDto;
2003
+ type TDataShowContent = {
2004
+ requestBody: UIContentDto;
1870
2005
  };
1871
-
1872
- type TextContentDto = {
1873
- text: string;
2006
+ type TDataUiModelControllerMapBlendShapes = {
2007
+ requestBody: UIModelMapBlendShapesRequestDto;
1874
2008
  };
1875
-
1876
- type TextUIContentDto = {
2009
+ type TDataGetAsset = {
1877
2010
  appId: string;
2011
+ path: string;
2012
+ };
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
+ };
2023
+ };
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
+ };
2034
+ };
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
+ };
2045
+ };
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);
1878
2060
  /**
1879
- * Reference to the authenticated client the request originated from
2061
+ * Trigger a UI interaction
2062
+ * @returns any
2063
+ * @throws ApiError
1880
2064
  */
1881
- clientId?: string;
2065
+ notifyInteraction(data: TDataNotifyInteraction): CancelablePromise<any>;
1882
2066
  /**
1883
- * Reference to the user interacting with the system
2067
+ * Show content
2068
+ * @returns UIContentDto Content to show
2069
+ * @throws ApiError
1884
2070
  */
1885
- userId?: string;
2071
+ showContent(data: TDataShowContent): CancelablePromise<UIContentDto>;
1886
2072
  /**
1887
- * Track the interaction session, if available
2073
+ * Tries to map model blend shapes by name similarity
2074
+ * @returns UIModelMapBlendShapesResponseDto Map model blend shapes
2075
+ * @throws ApiError
1888
2076
  */
1889
- sessionId?: string;
1890
- contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
1891
- content: TextContentDto;
1892
- metadata?: Record<string, any>;
1893
- options?: UIContentOptionsDto;
1894
- chunkId?: number;
1895
- messageId?: string;
1896
- };
1897
-
1898
- type UIAssetMetadataDto = {};
1899
-
1900
- type UIAssetDto = {
1901
- filename: string;
1902
- appId: string;
1903
- type?: 'models' | 'backgrounds' | 'animations' | 'documents';
1904
- userId?: string;
1905
- ts?: string;
1906
- metadata?: UIAssetMetadataDto;
1907
- };
1908
-
1909
- type UIModelAssetDto = {
1910
- filename: string;
1911
- appId: string;
1912
- type?: 'models' | 'backgrounds' | 'animations' | 'documents';
1913
- userId?: string;
1914
- ts?: string;
1915
- metadata?: UIAssetMetadataDto;
1916
- };
1917
-
1918
- type VideoContentDto = {
1919
- sources: Array<string>;
1920
- description?: string;
1921
- subtitle?: string;
1922
- thumb?: string;
1923
- title?: string;
1924
- width?: number;
1925
- height?: number;
1926
- };
1927
-
1928
- type VideoUIContentDto = {
1929
- appId: string;
2077
+ uiModelControllerMapBlendShapes(data: TDataUiModelControllerMapBlendShapes): CancelablePromise<UIModelMapBlendShapesResponseDto>;
1930
2078
  /**
1931
- * Reference to the authenticated client the request originated from
2079
+ * Retrieve an asset
2080
+ * @returns Buffer Download an asset by url
2081
+ * @throws ApiError
1932
2082
  */
1933
- clientId?: string;
2083
+ getAsset(data: TDataGetAsset): CancelablePromise<Buffer$1>;
1934
2084
  /**
1935
- * Reference to the user interacting with the system
2085
+ * @returns any
2086
+ * @throws ApiError
1936
2087
  */
1937
- userId?: string;
2088
+ saveModel(data: TDataSaveModel): CancelablePromise<any>;
1938
2089
  /**
1939
- * Track the interaction session, if available
2090
+ * @returns any
2091
+ * @throws ApiError
1940
2092
  */
1941
- sessionId?: string;
1942
- contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
1943
- content: VideoContentDto;
1944
- metadata?: Record<string, any>;
1945
- options?: UIContentOptionsDto;
1946
- chunkId?: number;
1947
- messageId?: string;
1948
- };
2093
+ saveBackground(data: TDataSaveBackground): CancelablePromise<any>;
2094
+ /**
2095
+ * @returns any
2096
+ * @throws ApiError
2097
+ */
2098
+ saveDocuments(data: TDataSaveDocuments): CancelablePromise<any>;
2099
+ /**
2100
+ * @returns any
2101
+ * @throws ApiError
2102
+ */
2103
+ saveAsset(data: TDataSaveAsset): CancelablePromise<any>;
2104
+ }
1949
2105
 
1950
- type WebpageContentDto = {
1951
- url: string;
2106
+ type TDataXrMarkerControllerSearchMarker = {
2107
+ requestBody: XRMarkerListRequestDto;
1952
2108
  };
1953
-
1954
- type WebpageUIContentDto = {
1955
- appId: string;
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);
1956
2121
  /**
1957
- * Reference to the authenticated client the request originated from
2122
+ * List available markers
2123
+ * @returns XRMarkerDto Marker created or updated
2124
+ * @throws ApiError
1958
2125
  */
1959
- clientId?: string;
2126
+ xrMarkerControllerSearchMarker(data: TDataXrMarkerControllerSearchMarker): CancelablePromise<Array<XRMarkerDto>>;
1960
2127
  /**
1961
- * Reference to the user interacting with the system
2128
+ * Save a marker
2129
+ * @returns XRMarkerDto Marker saved
2130
+ * @throws ApiError
1962
2131
  */
1963
- userId?: string;
2132
+ xrMarkerControllerSaveMarker(data: TDataXrMarkerControllerSaveMarker): CancelablePromise<XRMarkerDto>;
1964
2133
  /**
1965
- * Track the interaction session, if available
2134
+ * Delete a marker
2135
+ * @returns XRMarkerDto Marker deleted
2136
+ * @throws ApiError
1966
2137
  */
1967
- sessionId?: string;
1968
- contentType: 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
1969
- content: WebpageContentDto;
1970
- metadata?: Record<string, any>;
1971
- options?: UIContentOptionsDto;
1972
- chunkId?: number;
1973
- messageId?: string;
1974
- };
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
+ }
1975
2167
 
1976
2168
  declare class Broker {
1977
2169
  private readonly config;
@@ -2013,11 +2205,13 @@ interface PlatformAppChangedDto {
2013
2205
  operation: string;
2014
2206
  record: PlatformAppDto;
2015
2207
  }
2016
- interface anonymous_schema_60 {
2208
+ type anonymous_schema_36 = 'readyplayerme' | 'custom';
2209
+ type anonymous_schema_39 = 'M' | 'F';
2210
+ interface anonymous_schema_77 {
2017
2211
  username?: string;
2018
2212
  password: string;
2019
2213
  }
2020
- interface anonymous_schema_63 {
2214
+ interface anonymous_schema_80 {
2021
2215
  clientType?: string;
2022
2216
  clientId?: string;
2023
2217
  clientSecret?: string;
@@ -2078,7 +2272,7 @@ interface StringInferenceValue {
2078
2272
  probability: number;
2079
2273
  value: string;
2080
2274
  }
2081
- type anonymous_schema_125 = 'start' | 'stop';
2275
+ type anonymous_schema_142 = 'start' | 'stop';
2082
2276
  interface UserCharacterizationEventDto {
2083
2277
  appId: string;
2084
2278
  clientId?: string;
@@ -2144,7 +2338,7 @@ interface DialogueToolTriggeredEventDto {
2144
2338
  sessionId?: string;
2145
2339
  name: string;
2146
2340
  }
2147
- type anonymous_schema_174 = 'user' | 'agent';
2341
+ type anonymous_schema_191 = 'user' | 'agent';
2148
2342
  interface SermasSessionDto {
2149
2343
  appId: string;
2150
2344
  clientId?: string;
@@ -2163,10 +2357,10 @@ interface AgentDto {
2163
2357
  clientId?: string;
2164
2358
  userId?: string;
2165
2359
  agentId: string;
2166
- status: anonymous_schema_203;
2360
+ status: anonymous_schema_220;
2167
2361
  modules: string[];
2168
2362
  }
2169
- type anonymous_schema_203 = 'unavailable' | 'error' | 'not_ready' | 'ready' | 'loading' | 'interacting' | 'waiting' | 'processing';
2363
+ type anonymous_schema_220 = 'unavailable' | 'error' | 'not_ready' | 'ready' | 'loading' | 'interacting' | 'waiting' | 'processing';
2170
2364
  interface AgentChangedDto {
2171
2365
  appId: string;
2172
2366
  clientId?: string;
@@ -2199,8 +2393,8 @@ interface UIAssetChangedDto {
2199
2393
  operation: string;
2200
2394
  record: UIAssetDto;
2201
2395
  }
2202
- type anonymous_schema_235 = 'models' | 'backgrounds' | 'animations' | 'documents';
2203
- type anonymous_schema_242 = 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'buttons' | 'quiz' | 'clear-screen';
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';
2204
2398
  interface UIInteractionEventDto {
2205
2399
  appId: string;
2206
2400
  clientId?: string;
@@ -2597,4 +2791,4 @@ declare class SermasApiClient {
2597
2791
  login(username: any, password: any, appId?: string): Promise<LoginResponseDto>;
2598
2792
  }
2599
2793
 
2600
- 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 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_125, type anonymous_schema_174, type anonymous_schema_203, type anonymous_schema_235, type anonymous_schema_242, type anonymous_schema_60, type anonymous_schema_63, sleep };
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 };