@opencx/widget-core 4.0.54 → 4.0.55
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/dist/index.cjs +2 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +177 -185
- package/dist/index.js.map +1 -1
- package/dist/src/__tests__/test-utils.d.ts +10 -21
- package/dist/src/__tests__/test-utils.d.ts.map +1 -1
- package/dist/src/api/api-caller.d.ts +11 -23
- package/dist/src/api/api-caller.d.ts.map +1 -1
- package/dist/src/api/schema.d.ts +609 -831
- package/dist/src/api/schema.d.ts.map +1 -1
- package/dist/src/context/active-session-polling.ctx.d.ts +1 -2
- package/dist/src/context/active-session-polling.ctx.d.ts.map +1 -1
- package/dist/src/context/session.ctx.d.ts +8 -0
- package/dist/src/context/session.ctx.d.ts.map +1 -1
- package/dist/src/types/dtos.d.ts +1 -0
- package/dist/src/types/dtos.d.ts.map +1 -1
- package/package.json +4 -4
package/dist/src/api/schema.d.ts
CHANGED
|
@@ -10,7 +10,37 @@ export interface paths {
|
|
|
10
10
|
path?: never;
|
|
11
11
|
cookie?: never;
|
|
12
12
|
};
|
|
13
|
-
get:
|
|
13
|
+
get: {
|
|
14
|
+
parameters: {
|
|
15
|
+
query?: never;
|
|
16
|
+
header: {
|
|
17
|
+
'x-bot-token': string;
|
|
18
|
+
};
|
|
19
|
+
path?: never;
|
|
20
|
+
cookie?: never;
|
|
21
|
+
};
|
|
22
|
+
requestBody?: never;
|
|
23
|
+
responses: {
|
|
24
|
+
/** @description Default Response */
|
|
25
|
+
200: {
|
|
26
|
+
headers: {
|
|
27
|
+
[name: string]: unknown;
|
|
28
|
+
};
|
|
29
|
+
content: {
|
|
30
|
+
'application/json': components['schemas']['WidgetConfigDto'] | components['schemas']['WidgetPreludeDto'];
|
|
31
|
+
};
|
|
32
|
+
};
|
|
33
|
+
/** @description Internal Server Error */
|
|
34
|
+
500: {
|
|
35
|
+
headers: {
|
|
36
|
+
[name: string]: unknown;
|
|
37
|
+
};
|
|
38
|
+
content: {
|
|
39
|
+
'application/json': components['schemas']['ErrorDto'];
|
|
40
|
+
};
|
|
41
|
+
};
|
|
42
|
+
};
|
|
43
|
+
};
|
|
14
44
|
put?: never;
|
|
15
45
|
post?: never;
|
|
16
46
|
delete?: never;
|
|
@@ -19,16 +49,50 @@ export interface paths {
|
|
|
19
49
|
patch?: never;
|
|
20
50
|
trace?: never;
|
|
21
51
|
};
|
|
22
|
-
'/backend/widget/v2/
|
|
52
|
+
'/backend/widget/v2/contact/create-unverified': {
|
|
23
53
|
parameters: {
|
|
24
54
|
query?: never;
|
|
25
55
|
header?: never;
|
|
26
56
|
path?: never;
|
|
27
57
|
cookie?: never;
|
|
28
58
|
};
|
|
29
|
-
get
|
|
59
|
+
get?: never;
|
|
30
60
|
put?: never;
|
|
31
|
-
post
|
|
61
|
+
post: {
|
|
62
|
+
parameters: {
|
|
63
|
+
query?: never;
|
|
64
|
+
header: {
|
|
65
|
+
'x-bot-token': string;
|
|
66
|
+
};
|
|
67
|
+
path?: never;
|
|
68
|
+
cookie?: never;
|
|
69
|
+
};
|
|
70
|
+
requestBody: {
|
|
71
|
+
content: {
|
|
72
|
+
'application/json': components['schemas']['CreateUnverifiedContactDto'];
|
|
73
|
+
};
|
|
74
|
+
};
|
|
75
|
+
responses: {
|
|
76
|
+
/** @description Default Response */
|
|
77
|
+
200: {
|
|
78
|
+
headers: {
|
|
79
|
+
[name: string]: unknown;
|
|
80
|
+
};
|
|
81
|
+
content: {
|
|
82
|
+
'application/json': components['schemas']['WidgetContactTokenResponseDto'];
|
|
83
|
+
};
|
|
84
|
+
};
|
|
85
|
+
/** @description Internal Server Error */
|
|
86
|
+
500: {
|
|
87
|
+
headers: {
|
|
88
|
+
[name: string]: unknown;
|
|
89
|
+
};
|
|
90
|
+
content: {
|
|
91
|
+
'application/json': components['schemas']['ErrorDto'];
|
|
92
|
+
};
|
|
93
|
+
};
|
|
94
|
+
};
|
|
95
|
+
};
|
|
32
96
|
delete?: never;
|
|
33
97
|
options?: never;
|
|
34
98
|
head?: never;
|
|
@@ -42,7 +106,38 @@ export interface paths {
|
|
|
42
106
|
path?: never;
|
|
43
107
|
cookie?: never;
|
|
44
108
|
};
|
|
45
|
-
get:
|
|
109
|
+
get: {
|
|
110
|
+
parameters: {
|
|
111
|
+
query: {
|
|
112
|
+
filters: string;
|
|
113
|
+
offset?: string;
|
|
114
|
+
};
|
|
115
|
+
header?: never;
|
|
116
|
+
path?: never;
|
|
117
|
+
cookie?: never;
|
|
118
|
+
};
|
|
119
|
+
requestBody?: never;
|
|
120
|
+
responses: {
|
|
121
|
+
/** @description Default Response */
|
|
122
|
+
200: {
|
|
123
|
+
headers: {
|
|
124
|
+
[name: string]: unknown;
|
|
125
|
+
};
|
|
126
|
+
content: {
|
|
127
|
+
'application/json': components['schemas']['PaginatedWidgetSessionsDto'];
|
|
128
|
+
};
|
|
129
|
+
};
|
|
130
|
+
/** @description Internal Server Error */
|
|
131
|
+
500: {
|
|
132
|
+
headers: {
|
|
133
|
+
[name: string]: unknown;
|
|
134
|
+
};
|
|
135
|
+
content: {
|
|
136
|
+
'application/json': components['schemas']['ErrorDto'];
|
|
137
|
+
};
|
|
138
|
+
};
|
|
139
|
+
};
|
|
140
|
+
};
|
|
46
141
|
put?: never;
|
|
47
142
|
post?: never;
|
|
48
143
|
delete?: never;
|
|
@@ -58,7 +153,37 @@ export interface paths {
|
|
|
58
153
|
path?: never;
|
|
59
154
|
cookie?: never;
|
|
60
155
|
};
|
|
61
|
-
get:
|
|
156
|
+
get: {
|
|
157
|
+
parameters: {
|
|
158
|
+
query?: never;
|
|
159
|
+
header?: never;
|
|
160
|
+
path: {
|
|
161
|
+
sessionId: string;
|
|
162
|
+
};
|
|
163
|
+
cookie?: never;
|
|
164
|
+
};
|
|
165
|
+
requestBody?: never;
|
|
166
|
+
responses: {
|
|
167
|
+
/** @description Default Response */
|
|
168
|
+
200: {
|
|
169
|
+
headers: {
|
|
170
|
+
[name: string]: unknown;
|
|
171
|
+
};
|
|
172
|
+
content: {
|
|
173
|
+
'application/json': components['schemas']['WidgetHistoryDto'][];
|
|
174
|
+
};
|
|
175
|
+
};
|
|
176
|
+
/** @description Internal Server Error */
|
|
177
|
+
500: {
|
|
178
|
+
headers: {
|
|
179
|
+
[name: string]: unknown;
|
|
180
|
+
};
|
|
181
|
+
content: {
|
|
182
|
+
'application/json': components['schemas']['ErrorDto'];
|
|
183
|
+
};
|
|
184
|
+
};
|
|
185
|
+
};
|
|
186
|
+
};
|
|
62
187
|
put?: never;
|
|
63
188
|
post?: never;
|
|
64
189
|
delete?: never;
|
|
@@ -74,7 +199,37 @@ export interface paths {
|
|
|
74
199
|
path?: never;
|
|
75
200
|
cookie?: never;
|
|
76
201
|
};
|
|
77
|
-
get:
|
|
202
|
+
get: {
|
|
203
|
+
parameters: {
|
|
204
|
+
query?: never;
|
|
205
|
+
header?: never;
|
|
206
|
+
path: {
|
|
207
|
+
sessionId: string;
|
|
208
|
+
};
|
|
209
|
+
cookie?: never;
|
|
210
|
+
};
|
|
211
|
+
requestBody?: never;
|
|
212
|
+
responses: {
|
|
213
|
+
/** @description Default Response */
|
|
214
|
+
200: {
|
|
215
|
+
headers: {
|
|
216
|
+
[name: string]: unknown;
|
|
217
|
+
};
|
|
218
|
+
content: {
|
|
219
|
+
'application/json': components['schemas']['WidgetSessionAndHistoryDto'];
|
|
220
|
+
};
|
|
221
|
+
};
|
|
222
|
+
/** @description Internal Server Error */
|
|
223
|
+
500: {
|
|
224
|
+
headers: {
|
|
225
|
+
[name: string]: unknown;
|
|
226
|
+
};
|
|
227
|
+
content: {
|
|
228
|
+
'application/json': components['schemas']['ErrorDto'];
|
|
229
|
+
};
|
|
230
|
+
};
|
|
231
|
+
};
|
|
232
|
+
};
|
|
78
233
|
put?: never;
|
|
79
234
|
post?: never;
|
|
80
235
|
delete?: never;
|
|
@@ -92,7 +247,39 @@ export interface paths {
|
|
|
92
247
|
};
|
|
93
248
|
get?: never;
|
|
94
249
|
put?: never;
|
|
95
|
-
post:
|
|
250
|
+
post: {
|
|
251
|
+
parameters: {
|
|
252
|
+
query?: never;
|
|
253
|
+
header?: never;
|
|
254
|
+
path?: never;
|
|
255
|
+
cookie?: never;
|
|
256
|
+
};
|
|
257
|
+
requestBody: {
|
|
258
|
+
content: {
|
|
259
|
+
'application/json': components['schemas']['CreateWidgetSessionDto'];
|
|
260
|
+
};
|
|
261
|
+
};
|
|
262
|
+
responses: {
|
|
263
|
+
/** @description WidgetSession */
|
|
264
|
+
200: {
|
|
265
|
+
headers: {
|
|
266
|
+
[name: string]: unknown;
|
|
267
|
+
};
|
|
268
|
+
content: {
|
|
269
|
+
'application/json': components['schemas']['WidgetSessionDto'];
|
|
270
|
+
};
|
|
271
|
+
};
|
|
272
|
+
/** @description Internal Server Error */
|
|
273
|
+
500: {
|
|
274
|
+
headers: {
|
|
275
|
+
[name: string]: unknown;
|
|
276
|
+
};
|
|
277
|
+
content: {
|
|
278
|
+
'application/json': components['schemas']['ErrorDto'];
|
|
279
|
+
};
|
|
280
|
+
};
|
|
281
|
+
};
|
|
282
|
+
};
|
|
96
283
|
delete?: never;
|
|
97
284
|
options?: never;
|
|
98
285
|
head?: never;
|
|
@@ -108,7 +295,39 @@ export interface paths {
|
|
|
108
295
|
};
|
|
109
296
|
get?: never;
|
|
110
297
|
put?: never;
|
|
111
|
-
post:
|
|
298
|
+
post: {
|
|
299
|
+
parameters: {
|
|
300
|
+
query?: never;
|
|
301
|
+
header?: never;
|
|
302
|
+
path?: never;
|
|
303
|
+
cookie?: never;
|
|
304
|
+
};
|
|
305
|
+
requestBody: {
|
|
306
|
+
content: {
|
|
307
|
+
'application/json': components['schemas']['WidgetSendMessageInputDto'];
|
|
308
|
+
};
|
|
309
|
+
};
|
|
310
|
+
responses: {
|
|
311
|
+
/** @description Default Response */
|
|
312
|
+
200: {
|
|
313
|
+
headers: {
|
|
314
|
+
[name: string]: unknown;
|
|
315
|
+
};
|
|
316
|
+
content: {
|
|
317
|
+
'application/json': components['schemas']['WidgetSendMessageOutputDto'];
|
|
318
|
+
};
|
|
319
|
+
};
|
|
320
|
+
/** @description Internal Server Error */
|
|
321
|
+
500: {
|
|
322
|
+
headers: {
|
|
323
|
+
[name: string]: unknown;
|
|
324
|
+
};
|
|
325
|
+
content: {
|
|
326
|
+
'application/json': components['schemas']['ErrorDto'];
|
|
327
|
+
};
|
|
328
|
+
};
|
|
329
|
+
};
|
|
330
|
+
};
|
|
112
331
|
delete?: never;
|
|
113
332
|
options?: never;
|
|
114
333
|
head?: never;
|
|
@@ -124,7 +343,39 @@ export interface paths {
|
|
|
124
343
|
};
|
|
125
344
|
get?: never;
|
|
126
345
|
put?: never;
|
|
127
|
-
post:
|
|
346
|
+
post: {
|
|
347
|
+
parameters: {
|
|
348
|
+
query?: never;
|
|
349
|
+
header?: never;
|
|
350
|
+
path?: never;
|
|
351
|
+
cookie?: never;
|
|
352
|
+
};
|
|
353
|
+
requestBody: {
|
|
354
|
+
content: {
|
|
355
|
+
'application/json': components['schemas']['WidgetCreateStateCheckpointInputDto'];
|
|
356
|
+
};
|
|
357
|
+
};
|
|
358
|
+
responses: {
|
|
359
|
+
/** @description Default Response */
|
|
360
|
+
200: {
|
|
361
|
+
headers: {
|
|
362
|
+
[name: string]: unknown;
|
|
363
|
+
};
|
|
364
|
+
content: {
|
|
365
|
+
'application/json': components['schemas']['WidgetCreateStateCheckpointOutputDto'];
|
|
366
|
+
};
|
|
367
|
+
};
|
|
368
|
+
/** @description Internal Server Error */
|
|
369
|
+
500: {
|
|
370
|
+
headers: {
|
|
371
|
+
[name: string]: unknown;
|
|
372
|
+
};
|
|
373
|
+
content: {
|
|
374
|
+
'application/json': components['schemas']['ErrorDto'];
|
|
375
|
+
};
|
|
376
|
+
};
|
|
377
|
+
};
|
|
378
|
+
};
|
|
128
379
|
delete?: never;
|
|
129
380
|
options?: never;
|
|
130
381
|
head?: never;
|
|
@@ -140,23 +391,39 @@ export interface paths {
|
|
|
140
391
|
};
|
|
141
392
|
get?: never;
|
|
142
393
|
put?: never;
|
|
143
|
-
post:
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
394
|
+
post: {
|
|
395
|
+
parameters: {
|
|
396
|
+
query?: never;
|
|
397
|
+
header?: never;
|
|
398
|
+
path?: never;
|
|
399
|
+
cookie?: never;
|
|
400
|
+
};
|
|
401
|
+
requestBody: {
|
|
402
|
+
content: {
|
|
403
|
+
'application/json': components['schemas']['FileUploadDto'];
|
|
404
|
+
};
|
|
405
|
+
};
|
|
406
|
+
responses: {
|
|
407
|
+
/** @description Default Response */
|
|
408
|
+
200: {
|
|
409
|
+
headers: {
|
|
410
|
+
[name: string]: unknown;
|
|
411
|
+
};
|
|
412
|
+
content: {
|
|
413
|
+
'application/json': components['schemas']['UploadWidgetFileResponseDto'];
|
|
414
|
+
};
|
|
415
|
+
};
|
|
416
|
+
/** @description Internal Server Error */
|
|
417
|
+
500: {
|
|
418
|
+
headers: {
|
|
419
|
+
[name: string]: unknown;
|
|
420
|
+
};
|
|
421
|
+
content: {
|
|
422
|
+
'application/json': components['schemas']['ErrorDto'];
|
|
423
|
+
};
|
|
424
|
+
};
|
|
425
|
+
};
|
|
156
426
|
};
|
|
157
|
-
get?: never;
|
|
158
|
-
put?: never;
|
|
159
|
-
post: operations['uploadFileV2'];
|
|
160
427
|
delete?: never;
|
|
161
428
|
options?: never;
|
|
162
429
|
head?: never;
|
|
@@ -172,7 +439,39 @@ export interface paths {
|
|
|
172
439
|
};
|
|
173
440
|
get?: never;
|
|
174
441
|
put?: never;
|
|
175
|
-
post:
|
|
442
|
+
post: {
|
|
443
|
+
parameters: {
|
|
444
|
+
query?: never;
|
|
445
|
+
header?: never;
|
|
446
|
+
path?: never;
|
|
447
|
+
cookie?: never;
|
|
448
|
+
};
|
|
449
|
+
requestBody: {
|
|
450
|
+
content: {
|
|
451
|
+
'application/json': components['schemas']['WidgetVoteDto'];
|
|
452
|
+
};
|
|
453
|
+
};
|
|
454
|
+
responses: {
|
|
455
|
+
/** @description Default Response */
|
|
456
|
+
200: {
|
|
457
|
+
headers: {
|
|
458
|
+
[name: string]: unknown;
|
|
459
|
+
};
|
|
460
|
+
content: {
|
|
461
|
+
'application/json': components['schemas']['WidgetVoteResponseDto'];
|
|
462
|
+
};
|
|
463
|
+
};
|
|
464
|
+
/** @description Internal Server Error */
|
|
465
|
+
500: {
|
|
466
|
+
headers: {
|
|
467
|
+
[name: string]: unknown;
|
|
468
|
+
};
|
|
469
|
+
content: {
|
|
470
|
+
'application/json': components['schemas']['ErrorDto'];
|
|
471
|
+
};
|
|
472
|
+
};
|
|
473
|
+
};
|
|
474
|
+
};
|
|
176
475
|
delete?: never;
|
|
177
476
|
options?: never;
|
|
178
477
|
head?: never;
|
|
@@ -188,23 +487,39 @@ export interface paths {
|
|
|
188
487
|
};
|
|
189
488
|
get?: never;
|
|
190
489
|
put?: never;
|
|
191
|
-
post:
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
490
|
+
post: {
|
|
491
|
+
parameters: {
|
|
492
|
+
query?: never;
|
|
493
|
+
header?: never;
|
|
494
|
+
path?: never;
|
|
495
|
+
cookie?: never;
|
|
496
|
+
};
|
|
497
|
+
requestBody: {
|
|
498
|
+
content: {
|
|
499
|
+
'application/json': components['schemas']['WidgetResolveSessionInputDto'];
|
|
500
|
+
};
|
|
501
|
+
};
|
|
502
|
+
responses: {
|
|
503
|
+
/** @description WidgetSession */
|
|
504
|
+
200: {
|
|
505
|
+
headers: {
|
|
506
|
+
[name: string]: unknown;
|
|
507
|
+
};
|
|
508
|
+
content: {
|
|
509
|
+
'application/json': components['schemas']['WidgetSessionDto'];
|
|
510
|
+
};
|
|
511
|
+
};
|
|
512
|
+
/** @description Internal Server Error */
|
|
513
|
+
500: {
|
|
514
|
+
headers: {
|
|
515
|
+
[name: string]: unknown;
|
|
516
|
+
};
|
|
517
|
+
content: {
|
|
518
|
+
'application/json': components['schemas']['ErrorDto'];
|
|
519
|
+
};
|
|
520
|
+
};
|
|
521
|
+
};
|
|
204
522
|
};
|
|
205
|
-
get?: never;
|
|
206
|
-
put?: never;
|
|
207
|
-
post: operations['createUnverifiedContact'];
|
|
208
523
|
delete?: never;
|
|
209
524
|
options?: never;
|
|
210
525
|
head?: never;
|
|
@@ -220,7 +535,39 @@ export interface paths {
|
|
|
220
535
|
};
|
|
221
536
|
get?: never;
|
|
222
537
|
put?: never;
|
|
223
|
-
post:
|
|
538
|
+
post: {
|
|
539
|
+
parameters: {
|
|
540
|
+
query?: never;
|
|
541
|
+
header?: never;
|
|
542
|
+
path?: never;
|
|
543
|
+
cookie?: never;
|
|
544
|
+
};
|
|
545
|
+
requestBody: {
|
|
546
|
+
content: {
|
|
547
|
+
'application/json': components['schemas']['WidgetActionFormSubmissionInputDto'];
|
|
548
|
+
};
|
|
549
|
+
};
|
|
550
|
+
responses: {
|
|
551
|
+
/** @description Default Response */
|
|
552
|
+
200: {
|
|
553
|
+
headers: {
|
|
554
|
+
[name: string]: unknown;
|
|
555
|
+
};
|
|
556
|
+
content: {
|
|
557
|
+
'application/json': components['schemas']['WidgetActionFormSubmissionOutputDto'];
|
|
558
|
+
};
|
|
559
|
+
};
|
|
560
|
+
/** @description Internal Server Error */
|
|
561
|
+
500: {
|
|
562
|
+
headers: {
|
|
563
|
+
[name: string]: unknown;
|
|
564
|
+
};
|
|
565
|
+
content: {
|
|
566
|
+
'application/json': components['schemas']['ErrorDto'];
|
|
567
|
+
};
|
|
568
|
+
};
|
|
569
|
+
};
|
|
570
|
+
};
|
|
224
571
|
delete?: never;
|
|
225
572
|
options?: never;
|
|
226
573
|
head?: never;
|
|
@@ -236,7 +583,39 @@ export interface paths {
|
|
|
236
583
|
};
|
|
237
584
|
get?: never;
|
|
238
585
|
put?: never;
|
|
239
|
-
post:
|
|
586
|
+
post: {
|
|
587
|
+
parameters: {
|
|
588
|
+
query?: never;
|
|
589
|
+
header?: never;
|
|
590
|
+
path?: never;
|
|
591
|
+
cookie?: never;
|
|
592
|
+
};
|
|
593
|
+
requestBody: {
|
|
594
|
+
content: {
|
|
595
|
+
'application/json': components['schemas']['WidgetSubmitCsatInputDto'];
|
|
596
|
+
};
|
|
597
|
+
};
|
|
598
|
+
responses: {
|
|
599
|
+
/** @description Default Response */
|
|
600
|
+
200: {
|
|
601
|
+
headers: {
|
|
602
|
+
[name: string]: unknown;
|
|
603
|
+
};
|
|
604
|
+
content: {
|
|
605
|
+
'application/json': components['schemas']['WidgetSubmitCsatOutputDto'];
|
|
606
|
+
};
|
|
607
|
+
};
|
|
608
|
+
/** @description Internal Server Error */
|
|
609
|
+
500: {
|
|
610
|
+
headers: {
|
|
611
|
+
[name: string]: unknown;
|
|
612
|
+
};
|
|
613
|
+
content: {
|
|
614
|
+
'application/json': components['schemas']['ErrorDto'];
|
|
615
|
+
};
|
|
616
|
+
};
|
|
617
|
+
};
|
|
618
|
+
};
|
|
240
619
|
delete?: never;
|
|
241
620
|
options?: never;
|
|
242
621
|
head?: never;
|
|
@@ -247,79 +626,89 @@ export interface paths {
|
|
|
247
626
|
export type webhooks = Record<string, never>;
|
|
248
627
|
export interface components {
|
|
249
628
|
schemas: {
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
629
|
+
ErrorDto: {
|
|
630
|
+
statusCode?: number;
|
|
631
|
+
message?: string;
|
|
632
|
+
error?: string;
|
|
633
|
+
};
|
|
634
|
+
ChatAttachmentDto: {
|
|
635
|
+
id: string;
|
|
636
|
+
name: string;
|
|
637
|
+
size: number;
|
|
638
|
+
type: string;
|
|
639
|
+
url: string;
|
|
640
|
+
openai_file_id?: string;
|
|
258
641
|
};
|
|
642
|
+
FileUploadDto: {
|
|
643
|
+
/**
|
|
644
|
+
* Format: binary
|
|
645
|
+
* @description The file to upload. 5MB max.
|
|
646
|
+
*/
|
|
647
|
+
file: string;
|
|
648
|
+
} | null;
|
|
259
649
|
CreateWidgetSessionDto: {
|
|
260
650
|
customData?: {
|
|
261
651
|
[key: string]: string | number | boolean;
|
|
262
652
|
};
|
|
263
|
-
};
|
|
264
|
-
|
|
265
|
-
/** Format:
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
653
|
+
} | null;
|
|
654
|
+
WidgetSendMessageInputDto: {
|
|
655
|
+
/** Format: uuid */
|
|
656
|
+
uuid: string;
|
|
657
|
+
content: string;
|
|
658
|
+
session_id: string;
|
|
659
|
+
bot_token: string;
|
|
660
|
+
/** @description Additional headers to be included in the request of action calls */
|
|
661
|
+
headers?: {
|
|
662
|
+
[key: string]: string;
|
|
663
|
+
} | null;
|
|
664
|
+
/** @description Additional query parameters to be included in the query of action calls */
|
|
665
|
+
query_params?: {
|
|
666
|
+
[key: string]: string;
|
|
667
|
+
} | null;
|
|
668
|
+
/** @description Additional body properties to be included in the body of action calls */
|
|
669
|
+
body_properties?: {
|
|
670
|
+
[key: string]: unknown;
|
|
671
|
+
} | null;
|
|
672
|
+
language?: string | null;
|
|
673
|
+
attachments?: components['schemas']['ChatAttachmentDto'][] | null;
|
|
674
|
+
/** @description Context for the AI to be sent with each contact message */
|
|
675
|
+
clientContext?: {
|
|
676
|
+
[key: string]: unknown;
|
|
677
|
+
} | null;
|
|
678
|
+
/** @description Custom data to be sent with each contact message */
|
|
679
|
+
custom_data?: {
|
|
680
|
+
[key: string]: unknown;
|
|
681
|
+
} | null;
|
|
682
|
+
/** @description If there is an active mode, it will be exited and the prompt will be given to the AI for a customized response */
|
|
683
|
+
exit_mode_prompt?: string;
|
|
684
|
+
/** @description A prompt to be given to the AI for a customized response, should be used after an action form is submitted */
|
|
685
|
+
action_form_submitted_prompt?: string;
|
|
686
|
+
initial_messages?: {
|
|
687
|
+
uuid: string;
|
|
688
|
+
content: string;
|
|
292
689
|
}[];
|
|
293
|
-
/** @description The `cursor` for the request to get the next set of items. Null if there is no more data. */
|
|
294
|
-
next: string | null;
|
|
295
690
|
};
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
SystemMessagePayload: {
|
|
299
|
-
/** @enum {string} */
|
|
300
|
-
type: 'state_checkpoint';
|
|
691
|
+
WidgetCreateStateCheckpointInputDto: {
|
|
692
|
+
session_id: string;
|
|
301
693
|
payload: {
|
|
302
694
|
[key: string]: unknown;
|
|
303
|
-
} | null;
|
|
304
|
-
} | {
|
|
305
|
-
/** @enum {string} */
|
|
306
|
-
type: 'csat_requested';
|
|
307
|
-
payload?: unknown;
|
|
308
|
-
} | {
|
|
309
|
-
/** @enum {string} */
|
|
310
|
-
type: 'csat_submitted';
|
|
311
|
-
payload: {
|
|
312
|
-
score?: number | null;
|
|
313
|
-
feedback?: string | null;
|
|
314
695
|
};
|
|
315
|
-
}
|
|
696
|
+
};
|
|
697
|
+
WidgetVoteDto: {
|
|
316
698
|
/** @enum {string} */
|
|
317
|
-
|
|
318
|
-
|
|
699
|
+
action: 'upvote' | 'downvote';
|
|
700
|
+
sessionId: string;
|
|
701
|
+
messagePublicId: string;
|
|
319
702
|
};
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
703
|
+
WidgetResolveSessionInputDto: {
|
|
704
|
+
session_id: string;
|
|
705
|
+
};
|
|
706
|
+
CreateUnverifiedContactDto: {
|
|
707
|
+
email?: string | null;
|
|
708
|
+
non_verified_name?: string | null;
|
|
709
|
+
non_verified_custom_data?: {
|
|
710
|
+
[key: string]: string | number | boolean;
|
|
711
|
+
} | null;
|
|
323
712
|
};
|
|
324
713
|
WidgetActionFormSubmissionInputDto: {
|
|
325
714
|
sessionId: string;
|
|
@@ -340,11 +729,16 @@ export interface components {
|
|
|
340
729
|
};
|
|
341
730
|
};
|
|
342
731
|
};
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
732
|
+
WidgetSubmitCsatInputDto: {
|
|
733
|
+
session_id: string;
|
|
734
|
+
score: number;
|
|
735
|
+
feedback?: string;
|
|
736
|
+
system_message_uuid?: string;
|
|
737
|
+
};
|
|
738
|
+
WidgetVoteResponseDto: {
|
|
739
|
+
messagePublicId: string | null;
|
|
740
|
+
success: boolean;
|
|
741
|
+
};
|
|
348
742
|
WidgetConfigDto: {
|
|
349
743
|
org: {
|
|
350
744
|
id: string;
|
|
@@ -358,18 +752,53 @@ export interface components {
|
|
|
358
752
|
slug?: string | null;
|
|
359
753
|
}[];
|
|
360
754
|
};
|
|
755
|
+
WidgetPreludeDto: {
|
|
756
|
+
org: {
|
|
757
|
+
id: string;
|
|
758
|
+
name: string;
|
|
759
|
+
};
|
|
760
|
+
sessionsPollingIntervalSeconds: number;
|
|
761
|
+
sessionPollingIntervalSeconds: number;
|
|
762
|
+
modes: {
|
|
763
|
+
id: string;
|
|
764
|
+
name: string;
|
|
765
|
+
slug?: string | null;
|
|
766
|
+
}[];
|
|
767
|
+
};
|
|
361
768
|
WidgetContactTokenResponseDto: {
|
|
362
769
|
/** @description The JWT token to use for further requests */
|
|
363
770
|
token: string;
|
|
364
771
|
};
|
|
365
|
-
|
|
366
|
-
|
|
772
|
+
WidgetCreateStateCheckpointOutputDto: {
|
|
773
|
+
success: boolean;
|
|
774
|
+
};
|
|
775
|
+
/** @enum {string} */
|
|
776
|
+
AssigneeKindEnum: 'human' | 'ai' | 'none';
|
|
777
|
+
/** @enum {string} */
|
|
778
|
+
MessageTypeEnum: 'agent_assigned_by_integration' | 'agent_assigned_by_system' | 'agent_assigned_by_user' | 'agent_changed' | 'agent_comment' | 'agent_initiated_session' | 'agent_joined' | 'agent_message' | 'agent_reopened_session' | 'agent_took_session_from_ai' | 'agent_unassigned_by_integration' | 'agent_unassigned_by_system' | 'agent_unassigned_by_user' | 'ai_assumed_the_session_resolved' | 'ai_decided_to_not_reply' | 'ai_decided_to_resolve_the_issue' | 'ai_reopened_session' | 'ai_response_cancelled' | 'ai_resumed_by_system' | 'call_history' | 'call_transferred' | 'closed_resolved_by_agent' | 'closed_resolved_by_api' | 'closed_resolved_by_contact' | 'closed_resolved_by_integration' | 'closed_resolved_by_system' | 'closed_unresolved_by_agent' | 'closed_unresolved_by_api' | 'closed_unresolved_by_system' | 'contact_data_updated' | 'csat_requested' | 'csat_submitted' | 'email_draft_message' | 'handoff' | 'handoff_to_salesforce_miaw' | 'handoff_to_zendesk' | 'integration_reopened_session' | 'message' | 'prohibited_topic_detected' | 'sequence_message' | 'skills_added_by_system' | 'sla_applied_by_agent' | 'sla_applied_by_system' | 'sla_first_reply_breached' | 'sla_first_reply_completed_after_breach' | 'sla_first_reply_fulfilled' | 'sla_first_reply_metric_started' | 'sla_freezed_office_hours_ended' | 'sla_freezed_snoozed' | 'sla_next_reply_breached' | 'sla_next_reply_completed_after_breach' | 'sla_next_reply_fulfilled' | 'sla_next_reply_metric_started' | 'sla_removed_by_agent' | 'sla_removed_by_system' | 'sla_resolution_breached' | 'sla_resolution_completed_after_breach' | 'sla_resolution_fulfilled' | 'sla_resolution_metric_started' | 'sla_resolution_paused_resolved' | 'sla_resolution_paused_waiting_on_customer' | 'sla_resolution_resumed_customer_replied' | 'sla_resolution_resumed_reopened' | 'sla_resumed_office_hours_started' | 'sla_resumed_snooze_cancelled' | 'sla_resumed_snooze_expired' | 'state_checkpoint' | 'sub_status_removed_by_agent' | 'sub_status_removed_by_api' | 'sub_status_removed_by_integration' | 'sub_status_removed_by_system' | 'sub_status_set_by_agent' | 'sub_status_set_by_api' | 'sub_status_set_by_integration' | 'sub_status_set_by_system' | 'system_reopened_session' | 'tag_added_by_agent' | 'tag_added_by_api' | 'tag_added_by_integration' | 'tag_added_by_system' | 'tag_removed_by_agent' | 'tag_removed_by_api' | 'tag_removed_by_integration' | 'tag_removed_by_system' | 'team_assigned_by_system' | 'team_assigned_by_user' | 'team_unassigned_by_system' | 'team_unassigned_by_user' | 'user_confirmed_the_session_resolved' | 'workflow_message' | 'workflow_note' | 'workflow_triggered';
|
|
779
|
+
/** @enum {string} */
|
|
780
|
+
SenderTypeEnum: 'user' | 'agent' | 'ai' | 'system' | 'unknown';
|
|
781
|
+
SystemMessagePayload: (({
|
|
782
|
+
/** @constant */
|
|
783
|
+
type: 'state_checkpoint';
|
|
367
784
|
payload: {
|
|
368
785
|
[key: string]: unknown;
|
|
786
|
+
} | null;
|
|
787
|
+
} | {
|
|
788
|
+
/** @constant */
|
|
789
|
+
type: 'csat_requested';
|
|
790
|
+
payload?: null;
|
|
791
|
+
}) | {
|
|
792
|
+
/** @constant */
|
|
793
|
+
type: 'csat_submitted';
|
|
794
|
+
payload: {
|
|
795
|
+
score?: number | null;
|
|
796
|
+
feedback?: string | null;
|
|
369
797
|
};
|
|
370
|
-
}
|
|
371
|
-
|
|
372
|
-
|
|
798
|
+
}) | {
|
|
799
|
+
/** @constant */
|
|
800
|
+
type: 'none';
|
|
801
|
+
payload?: null;
|
|
373
802
|
};
|
|
374
803
|
WidgetHistoryDto: {
|
|
375
804
|
publicId: string;
|
|
@@ -385,127 +814,62 @@ export interface components {
|
|
|
385
814
|
sentAt?: string | null;
|
|
386
815
|
actionCalls?: {
|
|
387
816
|
actionName: string;
|
|
388
|
-
args
|
|
389
|
-
result
|
|
817
|
+
args: unknown;
|
|
818
|
+
result: unknown;
|
|
390
819
|
action: {
|
|
391
820
|
name: string;
|
|
392
821
|
id: string;
|
|
393
822
|
openapi?: {
|
|
394
823
|
openapi_spec_id?: string;
|
|
395
|
-
operation_spec
|
|
824
|
+
operation_spec: unknown;
|
|
396
825
|
operation_id?: string;
|
|
397
826
|
operation_method?: string;
|
|
398
827
|
};
|
|
399
|
-
metadata
|
|
828
|
+
metadata: unknown;
|
|
400
829
|
required_form_submission?: boolean;
|
|
401
830
|
is_handoff_like?: boolean;
|
|
402
831
|
};
|
|
403
832
|
}[] | null;
|
|
404
|
-
attachments?:
|
|
405
|
-
id: string;
|
|
406
|
-
name: string;
|
|
407
|
-
size: number;
|
|
408
|
-
type: string;
|
|
409
|
-
url: string;
|
|
410
|
-
}[] | null;
|
|
833
|
+
attachments?: components['schemas']['ChatAttachmentDto'][] | null;
|
|
411
834
|
systemMessagePayload: components['schemas']['SystemMessagePayload'];
|
|
412
835
|
};
|
|
413
|
-
|
|
414
|
-
initialQuestions: string[];
|
|
415
|
-
aiEnabled: boolean;
|
|
416
|
-
officeHours: unknown & {
|
|
417
|
-
monday?: {
|
|
418
|
-
from: string;
|
|
419
|
-
to: string;
|
|
420
|
-
};
|
|
421
|
-
tuesday?: {
|
|
422
|
-
from: string;
|
|
423
|
-
to: string;
|
|
424
|
-
};
|
|
425
|
-
wednesday?: {
|
|
426
|
-
from: string;
|
|
427
|
-
to: string;
|
|
428
|
-
};
|
|
429
|
-
thursday?: {
|
|
430
|
-
from: string;
|
|
431
|
-
to: string;
|
|
432
|
-
};
|
|
433
|
-
friday?: {
|
|
434
|
-
from: string;
|
|
435
|
-
to: string;
|
|
436
|
-
};
|
|
437
|
-
saturday?: {
|
|
438
|
-
from: string;
|
|
439
|
-
to: string;
|
|
440
|
-
};
|
|
441
|
-
sunday?: {
|
|
442
|
-
from: string;
|
|
443
|
-
to: string;
|
|
444
|
-
};
|
|
445
|
-
Everyday?: {
|
|
446
|
-
from: string;
|
|
447
|
-
to: string;
|
|
448
|
-
};
|
|
449
|
-
WeekDays?: {
|
|
450
|
-
from: string;
|
|
451
|
-
to: string;
|
|
452
|
-
};
|
|
453
|
-
};
|
|
454
|
-
officeHoursTimezone: string | null;
|
|
455
|
-
organizationName: string;
|
|
456
|
-
};
|
|
457
|
-
WidgetResolveSessionInputDto: {
|
|
458
|
-
session_id: string;
|
|
459
|
-
};
|
|
460
|
-
WidgetSendMessageInputDto: {
|
|
836
|
+
WidgetSessionDto: {
|
|
461
837
|
/** Format: uuid */
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
name: string;
|
|
482
|
-
size: number;
|
|
483
|
-
type: string;
|
|
484
|
-
url: string;
|
|
485
|
-
}[] | null;
|
|
486
|
-
/** @description Context for the AI to be sent with each contact message */
|
|
487
|
-
clientContext?: {
|
|
488
|
-
[key: string]: unknown;
|
|
489
|
-
} | null;
|
|
490
|
-
/** @description Custom data to be sent with each contact message */
|
|
491
|
-
custom_data?: {
|
|
838
|
+
id: string;
|
|
839
|
+
ticketNumber: number;
|
|
840
|
+
title: string | null;
|
|
841
|
+
/** Format: date-time */
|
|
842
|
+
createdAt: string;
|
|
843
|
+
/** Format: date-time */
|
|
844
|
+
updatedAt: string;
|
|
845
|
+
isHandedOff: boolean;
|
|
846
|
+
isOpened: boolean;
|
|
847
|
+
assignee: {
|
|
848
|
+
kind: components['schemas']['AssigneeKindEnum'];
|
|
849
|
+
name: string | null;
|
|
850
|
+
avatarUrl: string | null;
|
|
851
|
+
};
|
|
852
|
+
channel: string;
|
|
853
|
+
isVerified: boolean;
|
|
854
|
+
lastMessage: string | null;
|
|
855
|
+
modeId: string | null;
|
|
856
|
+
latestStateCheckpointPayload: {
|
|
492
857
|
[key: string]: unknown;
|
|
493
858
|
} | null;
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
}[];
|
|
859
|
+
sessionAttributes: {
|
|
860
|
+
[key: string]: string | number | boolean;
|
|
861
|
+
};
|
|
862
|
+
};
|
|
863
|
+
PaginatedWidgetSessionsDto: {
|
|
864
|
+
items: components['schemas']['WidgetSessionDto'][];
|
|
865
|
+
next: string | null;
|
|
502
866
|
};
|
|
503
867
|
WidgetSendMessageOutputDto: {
|
|
504
|
-
/** @
|
|
868
|
+
/** @constant */
|
|
505
869
|
success: true;
|
|
506
|
-
code?: string | 'session_assigned_to_human_agent' | 'response_cancelled' | 'skipping_unuseful_response';
|
|
870
|
+
code?: string | 'session_assigned_to_human_agent' | 'response_cancelled' | 'skipping_unuseful_response' | 'duplicate_message_ignored';
|
|
507
871
|
autopilotResponse?: {
|
|
508
|
-
/** @
|
|
872
|
+
/** @constant */
|
|
509
873
|
type: 'text';
|
|
510
874
|
value: {
|
|
511
875
|
error: boolean;
|
|
@@ -522,12 +886,12 @@ export interface components {
|
|
|
522
886
|
didExitMode?: boolean;
|
|
523
887
|
};
|
|
524
888
|
uiResponse?: {
|
|
525
|
-
/** @
|
|
889
|
+
/** @constant */
|
|
526
890
|
type: 'ui';
|
|
527
891
|
value: {
|
|
528
|
-
/** @
|
|
892
|
+
/** @constant */
|
|
529
893
|
type: 'ui_component';
|
|
530
|
-
request_response
|
|
894
|
+
request_response: unknown;
|
|
531
895
|
name: string;
|
|
532
896
|
content?: string;
|
|
533
897
|
};
|
|
@@ -538,645 +902,59 @@ export interface components {
|
|
|
538
902
|
id: string;
|
|
539
903
|
openapi?: {
|
|
540
904
|
openapi_spec_id?: string;
|
|
541
|
-
operation_spec
|
|
905
|
+
operation_spec: unknown;
|
|
542
906
|
operation_id?: string;
|
|
543
907
|
operation_method?: string;
|
|
544
908
|
};
|
|
545
|
-
metadata
|
|
909
|
+
metadata: unknown;
|
|
546
910
|
required_form_submission?: boolean;
|
|
547
911
|
is_handoff_like?: boolean;
|
|
548
912
|
};
|
|
549
913
|
sessionIsHandedOff?: boolean;
|
|
550
914
|
/** @description WidgetSession */
|
|
551
|
-
session?:
|
|
552
|
-
/** Format: uuid */
|
|
553
|
-
id: string;
|
|
554
|
-
ticketNumber: number;
|
|
555
|
-
createdAt: string;
|
|
556
|
-
updatedAt: string;
|
|
557
|
-
isHandedOff: boolean;
|
|
558
|
-
isOpened: boolean;
|
|
559
|
-
assignee: {
|
|
560
|
-
kind: components['schemas']['AssigneeKindEnum'];
|
|
561
|
-
name: string | null;
|
|
562
|
-
avatarUrl: string | null;
|
|
563
|
-
};
|
|
564
|
-
channel: string;
|
|
565
|
-
isVerified: boolean;
|
|
566
|
-
lastMessage: string | null;
|
|
567
|
-
modeId: string | null;
|
|
568
|
-
latestStateCheckpointPayload: {
|
|
569
|
-
[key: string]: unknown;
|
|
570
|
-
} | null;
|
|
571
|
-
};
|
|
915
|
+
session?: components['schemas']['WidgetSessionDto'];
|
|
572
916
|
} | {
|
|
573
|
-
/** @
|
|
917
|
+
/** @constant */
|
|
574
918
|
success: false;
|
|
575
919
|
error: {
|
|
576
920
|
code?: string;
|
|
577
921
|
message?: string;
|
|
578
922
|
};
|
|
579
923
|
};
|
|
580
|
-
WidgetSessionAndHistoryDto: {
|
|
581
|
-
/** @description WidgetSession */
|
|
582
|
-
session: {
|
|
583
|
-
/** Format: uuid */
|
|
584
|
-
id: string;
|
|
585
|
-
ticketNumber: number;
|
|
586
|
-
createdAt: string;
|
|
587
|
-
updatedAt: string;
|
|
588
|
-
isHandedOff: boolean;
|
|
589
|
-
isOpened: boolean;
|
|
590
|
-
assignee: {
|
|
591
|
-
kind: components['schemas']['AssigneeKindEnum'];
|
|
592
|
-
name: string | null;
|
|
593
|
-
avatarUrl: string | null;
|
|
594
|
-
};
|
|
595
|
-
channel: string;
|
|
596
|
-
isVerified: boolean;
|
|
597
|
-
lastMessage: string | null;
|
|
598
|
-
modeId: string | null;
|
|
599
|
-
latestStateCheckpointPayload: {
|
|
600
|
-
[key: string]: unknown;
|
|
601
|
-
} | null;
|
|
602
|
-
};
|
|
603
|
-
history: {
|
|
604
|
-
publicId: string;
|
|
605
|
-
type: components['schemas']['MessageTypeEnum'];
|
|
606
|
-
content: {
|
|
607
|
-
text?: string | null;
|
|
608
|
-
};
|
|
609
|
-
sender: {
|
|
610
|
-
kind: components['schemas']['SenderTypeEnum'];
|
|
611
|
-
name?: string | null;
|
|
612
|
-
avatar?: string | null;
|
|
613
|
-
};
|
|
614
|
-
sentAt?: string | null;
|
|
615
|
-
actionCalls?: {
|
|
616
|
-
actionName: string;
|
|
617
|
-
args?: unknown;
|
|
618
|
-
result?: unknown;
|
|
619
|
-
action: {
|
|
620
|
-
name: string;
|
|
621
|
-
id: string;
|
|
622
|
-
openapi?: {
|
|
623
|
-
openapi_spec_id?: string;
|
|
624
|
-
operation_spec?: unknown;
|
|
625
|
-
operation_id?: string;
|
|
626
|
-
operation_method?: string;
|
|
627
|
-
};
|
|
628
|
-
metadata?: unknown;
|
|
629
|
-
required_form_submission?: boolean;
|
|
630
|
-
is_handoff_like?: boolean;
|
|
631
|
-
};
|
|
632
|
-
}[] | null;
|
|
633
|
-
attachments?: {
|
|
634
|
-
id: string;
|
|
635
|
-
name: string;
|
|
636
|
-
size: number;
|
|
637
|
-
type: string;
|
|
638
|
-
url: string;
|
|
639
|
-
}[] | null;
|
|
640
|
-
systemMessagePayload: components['schemas']['SystemMessagePayload'];
|
|
641
|
-
}[];
|
|
642
|
-
};
|
|
643
|
-
/** @description WidgetSession */
|
|
644
|
-
WidgetSessionDto: {
|
|
645
|
-
/** Format: uuid */
|
|
646
|
-
id: string;
|
|
647
|
-
ticketNumber: number;
|
|
648
|
-
createdAt: string;
|
|
649
|
-
updatedAt: string;
|
|
650
|
-
isHandedOff: boolean;
|
|
651
|
-
isOpened: boolean;
|
|
652
|
-
assignee: {
|
|
653
|
-
kind: components['schemas']['AssigneeKindEnum'];
|
|
654
|
-
name: string | null;
|
|
655
|
-
avatarUrl: string | null;
|
|
656
|
-
};
|
|
657
|
-
channel: string;
|
|
658
|
-
isVerified: boolean;
|
|
659
|
-
lastMessage: string | null;
|
|
660
|
-
modeId: string | null;
|
|
661
|
-
latestStateCheckpointPayload: {
|
|
662
|
-
[key: string]: unknown;
|
|
663
|
-
} | null;
|
|
664
|
-
};
|
|
665
|
-
WidgetSubmitCsatInputDto: {
|
|
666
|
-
session_id: string;
|
|
667
|
-
score: number;
|
|
668
|
-
feedback?: string;
|
|
669
|
-
system_message_uuid?: string;
|
|
670
|
-
};
|
|
671
924
|
WidgetSubmitCsatOutputDto: {
|
|
672
925
|
success: boolean;
|
|
673
926
|
};
|
|
674
|
-
|
|
675
|
-
/** @
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
messagePublicId: string;
|
|
679
|
-
};
|
|
680
|
-
WidgetVoteResponseDto: {
|
|
681
|
-
messagePublicId: string | null;
|
|
682
|
-
success: boolean;
|
|
683
|
-
};
|
|
684
|
-
ErrorDto: {
|
|
685
|
-
statusCode?: number;
|
|
686
|
-
message?: string;
|
|
687
|
-
error?: string;
|
|
688
|
-
};
|
|
689
|
-
};
|
|
690
|
-
responses: never;
|
|
691
|
-
parameters: never;
|
|
692
|
-
requestBodies: never;
|
|
693
|
-
headers: never;
|
|
694
|
-
pathItems: never;
|
|
695
|
-
}
|
|
696
|
-
export type $defs = Record<string, never>;
|
|
697
|
-
export interface operations {
|
|
698
|
-
getWidgetConfig: {
|
|
699
|
-
parameters: {
|
|
700
|
-
query?: never;
|
|
701
|
-
header: {
|
|
702
|
-
'X-Bot-Token': string;
|
|
703
|
-
};
|
|
704
|
-
path?: never;
|
|
705
|
-
cookie?: never;
|
|
706
|
-
};
|
|
707
|
-
requestBody?: never;
|
|
708
|
-
responses: {
|
|
709
|
-
200: {
|
|
710
|
-
headers: {
|
|
711
|
-
[name: string]: unknown;
|
|
712
|
-
};
|
|
713
|
-
content: {
|
|
714
|
-
'application/json': components['schemas']['WidgetConfigDto'];
|
|
715
|
-
};
|
|
716
|
-
};
|
|
717
|
-
/** @description Internal Server Error */
|
|
718
|
-
500: {
|
|
719
|
-
headers: {
|
|
720
|
-
[name: string]: unknown;
|
|
721
|
-
};
|
|
722
|
-
content: {
|
|
723
|
-
'application/json': components['schemas']['ErrorDto'];
|
|
724
|
-
};
|
|
725
|
-
};
|
|
726
|
-
};
|
|
727
|
-
};
|
|
728
|
-
widgetPrelude: {
|
|
729
|
-
parameters: {
|
|
730
|
-
query?: never;
|
|
731
|
-
header: {
|
|
732
|
-
'X-Bot-Token': string;
|
|
733
|
-
};
|
|
734
|
-
path?: never;
|
|
735
|
-
cookie?: never;
|
|
736
|
-
};
|
|
737
|
-
requestBody?: never;
|
|
738
|
-
responses: {
|
|
739
|
-
200: {
|
|
740
|
-
headers: {
|
|
741
|
-
[name: string]: unknown;
|
|
742
|
-
};
|
|
743
|
-
content: {
|
|
744
|
-
'application/json': components['schemas']['WidgetPreludeDto'];
|
|
745
|
-
};
|
|
746
|
-
};
|
|
747
|
-
/** @description Internal Server Error */
|
|
748
|
-
500: {
|
|
749
|
-
headers: {
|
|
750
|
-
[name: string]: unknown;
|
|
751
|
-
};
|
|
752
|
-
content: {
|
|
753
|
-
'application/json': components['schemas']['ErrorDto'];
|
|
754
|
-
};
|
|
755
|
-
};
|
|
756
|
-
};
|
|
757
|
-
};
|
|
758
|
-
getSessions: {
|
|
759
|
-
parameters: {
|
|
760
|
-
query: {
|
|
761
|
-
/** @description A JSON-stringified Record<string, string>. These filters will be compared against the sessions' custom_data */
|
|
762
|
-
filters: string;
|
|
763
|
-
/** @description Pagination cursor to fetch the next set of results */
|
|
764
|
-
cursor?: string;
|
|
765
|
-
};
|
|
766
|
-
header?: never;
|
|
767
|
-
path?: never;
|
|
768
|
-
cookie?: never;
|
|
769
|
-
};
|
|
770
|
-
requestBody?: never;
|
|
771
|
-
responses: {
|
|
772
|
-
200: {
|
|
773
|
-
headers: {
|
|
774
|
-
[name: string]: unknown;
|
|
775
|
-
};
|
|
776
|
-
content: {
|
|
777
|
-
'application/json': components['schemas']['PaginatedWidgetSessionsDto'];
|
|
778
|
-
};
|
|
779
|
-
};
|
|
780
|
-
/** @description Internal Server Error */
|
|
781
|
-
500: {
|
|
782
|
-
headers: {
|
|
783
|
-
[name: string]: unknown;
|
|
784
|
-
};
|
|
785
|
-
content: {
|
|
786
|
-
'application/json': components['schemas']['ErrorDto'];
|
|
787
|
-
};
|
|
788
|
-
};
|
|
789
|
-
};
|
|
790
|
-
};
|
|
791
|
-
getSessionHistory: {
|
|
792
|
-
parameters: {
|
|
793
|
-
query?: {
|
|
794
|
-
/** @description The timestamp of the last message received by the widget in order to get any messages after. */
|
|
795
|
-
lastMessageTimestamp?: string;
|
|
796
|
-
};
|
|
797
|
-
header?: never;
|
|
798
|
-
path: {
|
|
799
|
-
sessionId: string;
|
|
800
|
-
};
|
|
801
|
-
cookie?: never;
|
|
802
|
-
};
|
|
803
|
-
requestBody?: never;
|
|
804
|
-
responses: {
|
|
805
|
-
200: {
|
|
806
|
-
headers: {
|
|
807
|
-
[name: string]: unknown;
|
|
808
|
-
};
|
|
809
|
-
content: {
|
|
810
|
-
'application/json': components['schemas']['WidgetHistoryDto'][];
|
|
811
|
-
};
|
|
812
|
-
};
|
|
813
|
-
/** @description Internal Server Error */
|
|
814
|
-
500: {
|
|
815
|
-
headers: {
|
|
816
|
-
[name: string]: unknown;
|
|
817
|
-
};
|
|
818
|
-
content: {
|
|
819
|
-
'application/json': components['schemas']['ErrorDto'];
|
|
820
|
-
};
|
|
821
|
-
};
|
|
822
|
-
};
|
|
823
|
-
};
|
|
824
|
-
pollSessionAndHistory: {
|
|
825
|
-
parameters: {
|
|
826
|
-
query?: {
|
|
827
|
-
/** @description The timestamp of the last message received by the widget in order to get any messages after. */
|
|
828
|
-
lastMessageTimestamp?: string;
|
|
829
|
-
};
|
|
830
|
-
header?: never;
|
|
831
|
-
path: {
|
|
832
|
-
sessionId: string;
|
|
833
|
-
};
|
|
834
|
-
cookie?: never;
|
|
835
|
-
};
|
|
836
|
-
requestBody?: never;
|
|
837
|
-
responses: {
|
|
838
|
-
200: {
|
|
839
|
-
headers: {
|
|
840
|
-
[name: string]: unknown;
|
|
841
|
-
};
|
|
842
|
-
content: {
|
|
843
|
-
'application/json': components['schemas']['WidgetSessionAndHistoryDto'];
|
|
844
|
-
};
|
|
845
|
-
};
|
|
846
|
-
/** @description Internal Server Error */
|
|
847
|
-
500: {
|
|
848
|
-
headers: {
|
|
849
|
-
[name: string]: unknown;
|
|
850
|
-
};
|
|
851
|
-
content: {
|
|
852
|
-
'application/json': components['schemas']['ErrorDto'];
|
|
853
|
-
};
|
|
854
|
-
};
|
|
855
|
-
};
|
|
856
|
-
};
|
|
857
|
-
createChatSession: {
|
|
858
|
-
parameters: {
|
|
859
|
-
query?: never;
|
|
860
|
-
header?: never;
|
|
861
|
-
path?: never;
|
|
862
|
-
cookie?: never;
|
|
863
|
-
};
|
|
864
|
-
requestBody: {
|
|
865
|
-
content: {
|
|
866
|
-
'application/json': components['schemas']['CreateWidgetSessionDto'];
|
|
867
|
-
};
|
|
868
|
-
};
|
|
869
|
-
responses: {
|
|
870
|
-
200: {
|
|
871
|
-
headers: {
|
|
872
|
-
[name: string]: unknown;
|
|
873
|
-
};
|
|
874
|
-
content: {
|
|
875
|
-
'application/json': components['schemas']['WidgetSessionDto'];
|
|
876
|
-
};
|
|
877
|
-
};
|
|
878
|
-
/** @description Internal Server Error */
|
|
879
|
-
500: {
|
|
880
|
-
headers: {
|
|
881
|
-
[name: string]: unknown;
|
|
882
|
-
};
|
|
883
|
-
content: {
|
|
884
|
-
'application/json': components['schemas']['ErrorDto'];
|
|
885
|
-
};
|
|
886
|
-
};
|
|
887
|
-
};
|
|
888
|
-
};
|
|
889
|
-
chatSend: {
|
|
890
|
-
parameters: {
|
|
891
|
-
query?: never;
|
|
892
|
-
header?: never;
|
|
893
|
-
path?: never;
|
|
894
|
-
cookie?: never;
|
|
895
|
-
};
|
|
896
|
-
requestBody: {
|
|
897
|
-
content: {
|
|
898
|
-
'application/json': components['schemas']['WidgetSendMessageInputDto'];
|
|
899
|
-
};
|
|
900
|
-
};
|
|
901
|
-
responses: {
|
|
902
|
-
200: {
|
|
903
|
-
headers: {
|
|
904
|
-
[name: string]: unknown;
|
|
905
|
-
};
|
|
906
|
-
content: {
|
|
907
|
-
'application/json': components['schemas']['WidgetSendMessageOutputDto'];
|
|
908
|
-
};
|
|
909
|
-
};
|
|
910
|
-
/** @description Internal Server Error */
|
|
911
|
-
500: {
|
|
912
|
-
headers: {
|
|
913
|
-
[name: string]: unknown;
|
|
914
|
-
};
|
|
915
|
-
content: {
|
|
916
|
-
'application/json': components['schemas']['ErrorDto'];
|
|
917
|
-
};
|
|
918
|
-
};
|
|
919
|
-
};
|
|
920
|
-
};
|
|
921
|
-
createStateCheckpoint: {
|
|
922
|
-
parameters: {
|
|
923
|
-
query?: never;
|
|
924
|
-
header?: never;
|
|
925
|
-
path?: never;
|
|
926
|
-
cookie?: never;
|
|
927
|
-
};
|
|
928
|
-
requestBody: {
|
|
929
|
-
content: {
|
|
930
|
-
'application/json': components['schemas']['WidgetCreateStateCheckpointInputDto'];
|
|
931
|
-
};
|
|
932
|
-
};
|
|
933
|
-
responses: {
|
|
934
|
-
200: {
|
|
935
|
-
headers: {
|
|
936
|
-
[name: string]: unknown;
|
|
937
|
-
};
|
|
938
|
-
content: {
|
|
939
|
-
'application/json': components['schemas']['WidgetCreateStateCheckpointOutputDto'];
|
|
940
|
-
};
|
|
941
|
-
};
|
|
942
|
-
/** @description Internal Server Error */
|
|
943
|
-
500: {
|
|
944
|
-
headers: {
|
|
945
|
-
[name: string]: unknown;
|
|
946
|
-
};
|
|
947
|
-
content: {
|
|
948
|
-
'application/json': components['schemas']['ErrorDto'];
|
|
949
|
-
};
|
|
950
|
-
};
|
|
951
|
-
};
|
|
952
|
-
};
|
|
953
|
-
uploadFile: {
|
|
954
|
-
parameters: {
|
|
955
|
-
query?: never;
|
|
956
|
-
header?: never;
|
|
957
|
-
path?: never;
|
|
958
|
-
cookie?: never;
|
|
959
|
-
};
|
|
960
|
-
/** @description The file to upload */
|
|
961
|
-
requestBody: {
|
|
962
|
-
content: {
|
|
963
|
-
'multipart/form-data': components['schemas']['FileUploadDto'];
|
|
964
|
-
};
|
|
965
|
-
};
|
|
966
|
-
responses: {
|
|
967
|
-
200: {
|
|
968
|
-
headers: {
|
|
969
|
-
[name: string]: unknown;
|
|
970
|
-
};
|
|
971
|
-
content: {
|
|
972
|
-
'application/json': components['schemas']['UploadWidgetFileResponseDto'];
|
|
973
|
-
};
|
|
974
|
-
};
|
|
975
|
-
/** @description Internal Server Error */
|
|
976
|
-
500: {
|
|
977
|
-
headers: {
|
|
978
|
-
[name: string]: unknown;
|
|
979
|
-
};
|
|
980
|
-
content: {
|
|
981
|
-
'application/json': components['schemas']['ErrorDto'];
|
|
982
|
-
};
|
|
983
|
-
};
|
|
984
|
-
};
|
|
985
|
-
};
|
|
986
|
-
uploadFileV2: {
|
|
987
|
-
parameters: {
|
|
988
|
-
query?: never;
|
|
989
|
-
header?: never;
|
|
990
|
-
path?: never;
|
|
991
|
-
cookie?: never;
|
|
992
|
-
};
|
|
993
|
-
/** @description The file to upload */
|
|
994
|
-
requestBody: {
|
|
995
|
-
content: {
|
|
996
|
-
'multipart/form-data': components['schemas']['FileUploadDto'];
|
|
997
|
-
};
|
|
998
|
-
};
|
|
999
|
-
responses: {
|
|
1000
|
-
200: {
|
|
1001
|
-
headers: {
|
|
1002
|
-
[name: string]: unknown;
|
|
1003
|
-
};
|
|
1004
|
-
content: {
|
|
1005
|
-
'application/json': components['schemas']['UploadWidgetFileResponseDto'];
|
|
1006
|
-
};
|
|
1007
|
-
};
|
|
1008
|
-
/** @description Internal Server Error */
|
|
1009
|
-
500: {
|
|
1010
|
-
headers: {
|
|
1011
|
-
[name: string]: unknown;
|
|
1012
|
-
};
|
|
1013
|
-
content: {
|
|
1014
|
-
'application/json': components['schemas']['ErrorDto'];
|
|
1015
|
-
};
|
|
1016
|
-
};
|
|
1017
|
-
};
|
|
1018
|
-
};
|
|
1019
|
-
voteMessage: {
|
|
1020
|
-
parameters: {
|
|
1021
|
-
query?: never;
|
|
1022
|
-
header?: never;
|
|
1023
|
-
path?: never;
|
|
1024
|
-
cookie?: never;
|
|
1025
|
-
};
|
|
1026
|
-
requestBody: {
|
|
1027
|
-
content: {
|
|
1028
|
-
'application/json': components['schemas']['WidgetVoteDto'];
|
|
1029
|
-
};
|
|
1030
|
-
};
|
|
1031
|
-
responses: {
|
|
1032
|
-
200: {
|
|
1033
|
-
headers: {
|
|
1034
|
-
[name: string]: unknown;
|
|
1035
|
-
};
|
|
1036
|
-
content: {
|
|
1037
|
-
'application/json': components['schemas']['WidgetVoteResponseDto'];
|
|
1038
|
-
};
|
|
1039
|
-
};
|
|
1040
|
-
/** @description Internal Server Error */
|
|
1041
|
-
500: {
|
|
1042
|
-
headers: {
|
|
1043
|
-
[name: string]: unknown;
|
|
1044
|
-
};
|
|
1045
|
-
content: {
|
|
1046
|
-
'application/json': components['schemas']['ErrorDto'];
|
|
1047
|
-
};
|
|
1048
|
-
};
|
|
1049
|
-
};
|
|
1050
|
-
};
|
|
1051
|
-
resolveSession: {
|
|
1052
|
-
parameters: {
|
|
1053
|
-
query?: never;
|
|
1054
|
-
header?: never;
|
|
1055
|
-
path?: never;
|
|
1056
|
-
cookie?: never;
|
|
1057
|
-
};
|
|
1058
|
-
requestBody: {
|
|
1059
|
-
content: {
|
|
1060
|
-
'application/json': components['schemas']['WidgetResolveSessionInputDto'];
|
|
1061
|
-
};
|
|
1062
|
-
};
|
|
1063
|
-
responses: {
|
|
1064
|
-
200: {
|
|
1065
|
-
headers: {
|
|
1066
|
-
[name: string]: unknown;
|
|
1067
|
-
};
|
|
1068
|
-
content: {
|
|
1069
|
-
'application/json': components['schemas']['WidgetSessionDto'];
|
|
1070
|
-
};
|
|
1071
|
-
};
|
|
1072
|
-
/** @description Internal Server Error */
|
|
1073
|
-
500: {
|
|
1074
|
-
headers: {
|
|
1075
|
-
[name: string]: unknown;
|
|
1076
|
-
};
|
|
1077
|
-
content: {
|
|
1078
|
-
'application/json': components['schemas']['ErrorDto'];
|
|
1079
|
-
};
|
|
1080
|
-
};
|
|
1081
|
-
};
|
|
1082
|
-
};
|
|
1083
|
-
createUnverifiedContact: {
|
|
1084
|
-
parameters: {
|
|
1085
|
-
query?: never;
|
|
1086
|
-
header: {
|
|
1087
|
-
'x-bot-token': string;
|
|
1088
|
-
};
|
|
1089
|
-
path?: never;
|
|
1090
|
-
cookie?: never;
|
|
927
|
+
WidgetSessionAndHistoryDto: {
|
|
928
|
+
/** @description WidgetSession */
|
|
929
|
+
session: components['schemas']['WidgetSessionDto'];
|
|
930
|
+
history: components['schemas']['WidgetHistoryDto'][];
|
|
1091
931
|
};
|
|
1092
|
-
|
|
1093
|
-
|
|
1094
|
-
|
|
932
|
+
WidgetActionFormSubmissionOutputDto: {
|
|
933
|
+
action: {
|
|
934
|
+
response: unknown;
|
|
1095
935
|
};
|
|
1096
936
|
};
|
|
1097
|
-
|
|
1098
|
-
|
|
1099
|
-
|
|
1100
|
-
[name: string]: unknown;
|
|
1101
|
-
};
|
|
1102
|
-
content: {
|
|
1103
|
-
'application/json': components['schemas']['WidgetContactTokenResponseDto'];
|
|
1104
|
-
};
|
|
1105
|
-
};
|
|
1106
|
-
/** @description Internal Server Error */
|
|
1107
|
-
500: {
|
|
1108
|
-
headers: {
|
|
1109
|
-
[name: string]: unknown;
|
|
1110
|
-
};
|
|
1111
|
-
content: {
|
|
1112
|
-
'application/json': components['schemas']['ErrorDto'];
|
|
1113
|
-
};
|
|
1114
|
-
};
|
|
937
|
+
UploadWidgetFileResponseDto: {
|
|
938
|
+
fileName: string;
|
|
939
|
+
fileUrl: string;
|
|
1115
940
|
};
|
|
1116
941
|
};
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
|
|
1122
|
-
cookie?: never;
|
|
1123
|
-
};
|
|
1124
|
-
requestBody: {
|
|
1125
|
-
content: {
|
|
1126
|
-
'application/json': components['schemas']['WidgetActionFormSubmissionInputDto'];
|
|
942
|
+
responses: {
|
|
943
|
+
/** @description Internal Server Error */
|
|
944
|
+
500: {
|
|
945
|
+
headers: {
|
|
946
|
+
[name: string]: unknown;
|
|
1127
947
|
};
|
|
1128
|
-
};
|
|
1129
|
-
responses: {
|
|
1130
|
-
200: {
|
|
1131
|
-
headers: {
|
|
1132
|
-
[name: string]: unknown;
|
|
1133
|
-
};
|
|
1134
|
-
content: {
|
|
1135
|
-
'application/json': components['schemas']['WidgetActionFormSubmissionOutputDto'];
|
|
1136
|
-
};
|
|
1137
|
-
};
|
|
1138
|
-
/** @description Internal Server Error */
|
|
1139
|
-
500: {
|
|
1140
|
-
headers: {
|
|
1141
|
-
[name: string]: unknown;
|
|
1142
|
-
};
|
|
1143
|
-
content: {
|
|
1144
|
-
'application/json': components['schemas']['ErrorDto'];
|
|
1145
|
-
};
|
|
1146
|
-
};
|
|
1147
|
-
};
|
|
1148
|
-
};
|
|
1149
|
-
submitCsat: {
|
|
1150
|
-
parameters: {
|
|
1151
|
-
query?: never;
|
|
1152
|
-
header?: never;
|
|
1153
|
-
path?: never;
|
|
1154
|
-
cookie?: never;
|
|
1155
|
-
};
|
|
1156
|
-
requestBody: {
|
|
1157
948
|
content: {
|
|
1158
|
-
'application/json': components['schemas']['
|
|
1159
|
-
};
|
|
1160
|
-
};
|
|
1161
|
-
responses: {
|
|
1162
|
-
200: {
|
|
1163
|
-
headers: {
|
|
1164
|
-
[name: string]: unknown;
|
|
1165
|
-
};
|
|
1166
|
-
content: {
|
|
1167
|
-
'application/json': components['schemas']['WidgetSubmitCsatOutputDto'];
|
|
1168
|
-
};
|
|
1169
|
-
};
|
|
1170
|
-
/** @description Internal Server Error */
|
|
1171
|
-
500: {
|
|
1172
|
-
headers: {
|
|
1173
|
-
[name: string]: unknown;
|
|
1174
|
-
};
|
|
1175
|
-
content: {
|
|
1176
|
-
'application/json': components['schemas']['ErrorDto'];
|
|
1177
|
-
};
|
|
949
|
+
'application/json': components['schemas']['ErrorDto'];
|
|
1178
950
|
};
|
|
1179
951
|
};
|
|
1180
952
|
};
|
|
953
|
+
parameters: never;
|
|
954
|
+
requestBodies: never;
|
|
955
|
+
headers: never;
|
|
956
|
+
pathItems: never;
|
|
1181
957
|
}
|
|
958
|
+
export type $defs = Record<string, never>;
|
|
959
|
+
export type operations = Record<string, never>;
|
|
1182
960
|
//# sourceMappingURL=schema.d.ts.map
|