@sermas/api-client 1.0.0-alpha.31 → 1.0.0-alpha.33

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