@botpress/webchat 1.3.3 → 1.3.5

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.
Files changed (36) hide show
  1. package/.turbo/turbo-build.log +23 -0
  2. package/dist/adapters/messaging-to-target.d.ts +15 -15
  3. package/dist/adapters/webchat-to-target.d.ts +3 -3
  4. package/dist/client/PushpinClient/inner-client/index.d.ts +2 -2
  5. package/dist/gen/client/index.d.ts +78 -13
  6. package/dist/gen/client/models.d.ts +210 -0
  7. package/dist/gen/client/operations/addParticipant.d.ts +51 -0
  8. package/dist/gen/client/operations/createConversation.d.ts +39 -0
  9. package/dist/gen/client/operations/createEvent.d.ts +79 -0
  10. package/dist/gen/client/operations/createMessage.d.ts +274 -0
  11. package/dist/gen/client/operations/createUser.d.ts +60 -0
  12. package/dist/gen/client/operations/deleteConversation.d.ts +22 -0
  13. package/dist/gen/client/operations/deleteMessage.d.ts +22 -0
  14. package/dist/gen/client/operations/deleteUser.d.ts +21 -0
  15. package/dist/gen/client/operations/getConversation.d.ts +36 -0
  16. package/dist/gen/client/operations/getEvent.d.ts +58 -0
  17. package/dist/gen/client/operations/getMessage.d.ts +157 -0
  18. package/dist/gen/client/operations/getParticipant.d.ts +48 -0
  19. package/dist/gen/client/operations/getUser.d.ts +46 -0
  20. package/dist/gen/client/operations/listConversationMessages.d.ts +161 -0
  21. package/dist/gen/client/operations/listConversations.d.ts +42 -0
  22. package/dist/gen/client/operations/listParticipants.d.ts +51 -0
  23. package/dist/gen/client/operations/listenConversation.d.ts +22 -0
  24. package/dist/gen/client/operations/removeParticipant.d.ts +23 -0
  25. package/dist/gen/client/operations/updateUser.d.ts +60 -0
  26. package/dist/get-client.d.ts +3 -3
  27. package/dist/hooks/useClient.d.ts +3 -3
  28. package/dist/index.js +32741 -21028
  29. package/dist/index.umd.cjs +278 -95
  30. package/openapi.ts +5 -9
  31. package/package.json +3 -1
  32. package/dist/gen/client/api.d.ts +0 -2039
  33. package/dist/gen/client/base.d.ts +0 -54
  34. package/dist/gen/client/client.d.ts +0 -61
  35. package/dist/gen/client/common.d.ts +0 -65
  36. package/dist/gen/client/configuration.d.ts +0 -83
@@ -1,2039 +0,0 @@
1
- /**
2
- * Webchat API
3
- * API for the Webchat Integration
4
- *
5
- * The version of the OpenAPI document: 0.0.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { Configuration } from './configuration';
13
- import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
14
- import type { RequestArgs } from './base';
15
- import { BaseAPI } from './base';
16
- /**
17
- *
18
- * @export
19
- * @interface AddParticipantBody
20
- */
21
- export interface AddParticipantBody {
22
- /**
23
- * User id
24
- * @type {string}
25
- * @memberof AddParticipantBody
26
- */
27
- 'userId': string;
28
- }
29
- /**
30
- *
31
- * @export
32
- * @interface AddParticipantResponse
33
- */
34
- export interface AddParticipantResponse {
35
- /**
36
- *
37
- * @type {User}
38
- * @memberof AddParticipantResponse
39
- */
40
- 'participant': User;
41
- }
42
- /**
43
- *
44
- * @export
45
- * @interface Conversation
46
- */
47
- export interface Conversation {
48
- /**
49
- * Id of the [Conversation](#schema_conversation)
50
- * @type {string}
51
- * @memberof Conversation
52
- */
53
- 'id': string;
54
- /**
55
- * Creation date of the [Conversation](#schema_conversation) in ISO 8601 format
56
- * @type {string}
57
- * @memberof Conversation
58
- */
59
- 'createdAt': string;
60
- /**
61
- * Updating date of the [Conversation](#schema_conversation) in ISO 8601 format
62
- * @type {string}
63
- * @memberof Conversation
64
- */
65
- 'updatedAt': string;
66
- }
67
- /**
68
- * Conversation properties
69
- * @export
70
- * @interface CreateConversationBody
71
- */
72
- export interface CreateConversationBody {
73
- /**
74
- *
75
- * @type {string}
76
- * @memberof CreateConversationBody
77
- */
78
- '_'?: string;
79
- }
80
- /**
81
- *
82
- * @export
83
- * @interface CreateConversationResponse
84
- */
85
- export interface CreateConversationResponse {
86
- /**
87
- *
88
- * @type {Conversation}
89
- * @memberof CreateConversationResponse
90
- */
91
- 'conversation': Conversation;
92
- }
93
- /**
94
- *
95
- * @export
96
- * @interface CreateEventBody
97
- */
98
- export interface CreateEventBody {
99
- /**
100
- *
101
- * @type {CreateEventBodyPayload}
102
- * @memberof CreateEventBody
103
- */
104
- 'payload': CreateEventBodyPayload;
105
- /**
106
- * ID of the [Conversation](#schema_conversation)
107
- * @type {string}
108
- * @memberof CreateEventBody
109
- */
110
- 'conversationId': string;
111
- }
112
- /**
113
- * @type CreateEventBodyPayload
114
- * Payload is the content type of the event.
115
- * @export
116
- */
117
- export type CreateEventBodyPayload = CreateEventBodyPayloadOneOf | CreateEventBodyPayloadOneOf1;
118
- /**
119
- *
120
- * @export
121
- * @interface CreateEventBodyPayloadOneOf
122
- */
123
- export interface CreateEventBodyPayloadOneOf {
124
- /**
125
- *
126
- * @type {string}
127
- * @memberof CreateEventBodyPayloadOneOf
128
- */
129
- 'type': CreateEventBodyPayloadOneOfTypeEnum;
130
- /**
131
- *
132
- * @type {{ [key: string]: any; }}
133
- * @memberof CreateEventBodyPayloadOneOf
134
- */
135
- 'data': {
136
- [key: string]: any;
137
- };
138
- }
139
- export declare const CreateEventBodyPayloadOneOfTypeEnum: {
140
- readonly Custom: "custom";
141
- };
142
- export type CreateEventBodyPayloadOneOfTypeEnum = typeof CreateEventBodyPayloadOneOfTypeEnum[keyof typeof CreateEventBodyPayloadOneOfTypeEnum];
143
- /**
144
- *
145
- * @export
146
- * @interface CreateEventBodyPayloadOneOf1
147
- */
148
- export interface CreateEventBodyPayloadOneOf1 {
149
- /**
150
- *
151
- * @type {string}
152
- * @memberof CreateEventBodyPayloadOneOf1
153
- */
154
- 'type': CreateEventBodyPayloadOneOf1TypeEnum;
155
- /**
156
- *
157
- * @type {{ [key: string]: any; }}
158
- * @memberof CreateEventBodyPayloadOneOf1
159
- */
160
- 'data': {
161
- [key: string]: any;
162
- };
163
- }
164
- export declare const CreateEventBodyPayloadOneOf1TypeEnum: {
165
- readonly ConversationStarted: "conversation_started";
166
- };
167
- export type CreateEventBodyPayloadOneOf1TypeEnum = typeof CreateEventBodyPayloadOneOf1TypeEnum[keyof typeof CreateEventBodyPayloadOneOf1TypeEnum];
168
- /**
169
- *
170
- * @export
171
- * @interface CreateEventResponse
172
- */
173
- export interface CreateEventResponse {
174
- /**
175
- *
176
- * @type {Event}
177
- * @memberof CreateEventResponse
178
- */
179
- 'event': Event;
180
- }
181
- /**
182
- *
183
- * @export
184
- * @interface CreateMessageBody
185
- */
186
- export interface CreateMessageBody {
187
- /**
188
- *
189
- * @type {CreateMessageBodyPayload}
190
- * @memberof CreateMessageBody
191
- */
192
- 'payload': CreateMessageBodyPayload;
193
- /**
194
- * ID of the [Conversation](#schema_conversation)
195
- * @type {string}
196
- * @memberof CreateMessageBody
197
- */
198
- 'conversationId': string;
199
- }
200
- /**
201
- * @type CreateMessageBodyPayload
202
- * Payload is the content type of the message.
203
- * @export
204
- */
205
- export type CreateMessageBodyPayload = CreateMessageBodyPayloadOneOf | CreateMessageBodyPayloadOneOf1 | CreateMessageBodyPayloadOneOf10 | CreateMessageBodyPayloadOneOf2 | CreateMessageBodyPayloadOneOf3 | CreateMessageBodyPayloadOneOf4 | CreateMessageBodyPayloadOneOf5 | CreateMessageBodyPayloadOneOf6 | CreateMessageBodyPayloadOneOf7 | CreateMessageBodyPayloadOneOf8 | CreateMessageBodyPayloadOneOf9;
206
- /**
207
- *
208
- * @export
209
- * @interface CreateMessageBodyPayloadOneOf
210
- */
211
- export interface CreateMessageBodyPayloadOneOf {
212
- /**
213
- *
214
- * @type {string}
215
- * @memberof CreateMessageBodyPayloadOneOf
216
- */
217
- 'audioUrl': string;
218
- /**
219
- * CSS className to apply to the message
220
- * @type {string}
221
- * @memberof CreateMessageBodyPayloadOneOf
222
- */
223
- 'className'?: string;
224
- /**
225
- *
226
- * @type {string}
227
- * @memberof CreateMessageBodyPayloadOneOf
228
- */
229
- 'type': CreateMessageBodyPayloadOneOfTypeEnum;
230
- }
231
- export declare const CreateMessageBodyPayloadOneOfTypeEnum: {
232
- readonly Audio: "audio";
233
- };
234
- export type CreateMessageBodyPayloadOneOfTypeEnum = typeof CreateMessageBodyPayloadOneOfTypeEnum[keyof typeof CreateMessageBodyPayloadOneOfTypeEnum];
235
- /**
236
- *
237
- * @export
238
- * @interface CreateMessageBodyPayloadOneOf1
239
- */
240
- export interface CreateMessageBodyPayloadOneOf1 {
241
- /**
242
- *
243
- * @type {string}
244
- * @memberof CreateMessageBodyPayloadOneOf1
245
- */
246
- 'title': string;
247
- /**
248
- *
249
- * @type {string}
250
- * @memberof CreateMessageBodyPayloadOneOf1
251
- */
252
- 'subtitle'?: string;
253
- /**
254
- *
255
- * @type {string}
256
- * @memberof CreateMessageBodyPayloadOneOf1
257
- */
258
- 'imageUrl'?: string;
259
- /**
260
- *
261
- * @type {Array<CreateMessageBodyPayloadOneOf1ActionsInner>}
262
- * @memberof CreateMessageBodyPayloadOneOf1
263
- */
264
- 'actions': Array<CreateMessageBodyPayloadOneOf1ActionsInner>;
265
- /**
266
- *
267
- * @type {string}
268
- * @memberof CreateMessageBodyPayloadOneOf1
269
- */
270
- 'type': CreateMessageBodyPayloadOneOf1TypeEnum;
271
- /**
272
- * CSS className to apply to the message
273
- * @type {string}
274
- * @memberof CreateMessageBodyPayloadOneOf1
275
- */
276
- 'className'?: string;
277
- }
278
- export declare const CreateMessageBodyPayloadOneOf1TypeEnum: {
279
- readonly Card: "card";
280
- };
281
- export type CreateMessageBodyPayloadOneOf1TypeEnum = typeof CreateMessageBodyPayloadOneOf1TypeEnum[keyof typeof CreateMessageBodyPayloadOneOf1TypeEnum];
282
- /**
283
- *
284
- * @export
285
- * @interface CreateMessageBodyPayloadOneOf10
286
- */
287
- export interface CreateMessageBodyPayloadOneOf10 {
288
- /**
289
- *
290
- * @type {string}
291
- * @memberof CreateMessageBodyPayloadOneOf10
292
- */
293
- 'videoUrl': string;
294
- /**
295
- * CSS className to apply to the message
296
- * @type {string}
297
- * @memberof CreateMessageBodyPayloadOneOf10
298
- */
299
- 'className'?: string;
300
- /**
301
- *
302
- * @type {string}
303
- * @memberof CreateMessageBodyPayloadOneOf10
304
- */
305
- 'type': CreateMessageBodyPayloadOneOf10TypeEnum;
306
- }
307
- export declare const CreateMessageBodyPayloadOneOf10TypeEnum: {
308
- readonly Video: "video";
309
- };
310
- export type CreateMessageBodyPayloadOneOf10TypeEnum = typeof CreateMessageBodyPayloadOneOf10TypeEnum[keyof typeof CreateMessageBodyPayloadOneOf10TypeEnum];
311
- /**
312
- *
313
- * @export
314
- * @interface CreateMessageBodyPayloadOneOf1ActionsInner
315
- */
316
- export interface CreateMessageBodyPayloadOneOf1ActionsInner {
317
- /**
318
- *
319
- * @type {string}
320
- * @memberof CreateMessageBodyPayloadOneOf1ActionsInner
321
- */
322
- 'action': CreateMessageBodyPayloadOneOf1ActionsInnerActionEnum;
323
- /**
324
- *
325
- * @type {string}
326
- * @memberof CreateMessageBodyPayloadOneOf1ActionsInner
327
- */
328
- 'label': string;
329
- /**
330
- *
331
- * @type {string}
332
- * @memberof CreateMessageBodyPayloadOneOf1ActionsInner
333
- */
334
- 'value': string;
335
- }
336
- export declare const CreateMessageBodyPayloadOneOf1ActionsInnerActionEnum: {
337
- readonly Postback: "postback";
338
- readonly Url: "url";
339
- readonly Say: "say";
340
- };
341
- export type CreateMessageBodyPayloadOneOf1ActionsInnerActionEnum = typeof CreateMessageBodyPayloadOneOf1ActionsInnerActionEnum[keyof typeof CreateMessageBodyPayloadOneOf1ActionsInnerActionEnum];
342
- /**
343
- *
344
- * @export
345
- * @interface CreateMessageBodyPayloadOneOf2
346
- */
347
- export interface CreateMessageBodyPayloadOneOf2 {
348
- /**
349
- *
350
- * @type {Array<CreateMessageBodyPayloadOneOf2ItemsInner>}
351
- * @memberof CreateMessageBodyPayloadOneOf2
352
- */
353
- 'items': Array<CreateMessageBodyPayloadOneOf2ItemsInner>;
354
- /**
355
- * CSS className to apply to the message
356
- * @type {string}
357
- * @memberof CreateMessageBodyPayloadOneOf2
358
- */
359
- 'className'?: string;
360
- /**
361
- *
362
- * @type {string}
363
- * @memberof CreateMessageBodyPayloadOneOf2
364
- */
365
- 'type': CreateMessageBodyPayloadOneOf2TypeEnum;
366
- }
367
- export declare const CreateMessageBodyPayloadOneOf2TypeEnum: {
368
- readonly Carousel: "carousel";
369
- };
370
- export type CreateMessageBodyPayloadOneOf2TypeEnum = typeof CreateMessageBodyPayloadOneOf2TypeEnum[keyof typeof CreateMessageBodyPayloadOneOf2TypeEnum];
371
- /**
372
- *
373
- * @export
374
- * @interface CreateMessageBodyPayloadOneOf2ItemsInner
375
- */
376
- export interface CreateMessageBodyPayloadOneOf2ItemsInner {
377
- /**
378
- *
379
- * @type {string}
380
- * @memberof CreateMessageBodyPayloadOneOf2ItemsInner
381
- */
382
- 'title': string;
383
- /**
384
- *
385
- * @type {string}
386
- * @memberof CreateMessageBodyPayloadOneOf2ItemsInner
387
- */
388
- 'subtitle'?: string;
389
- /**
390
- *
391
- * @type {string}
392
- * @memberof CreateMessageBodyPayloadOneOf2ItemsInner
393
- */
394
- 'imageUrl'?: string;
395
- /**
396
- *
397
- * @type {Array<CreateMessageBodyPayloadOneOf1ActionsInner>}
398
- * @memberof CreateMessageBodyPayloadOneOf2ItemsInner
399
- */
400
- 'actions': Array<CreateMessageBodyPayloadOneOf1ActionsInner>;
401
- /**
402
- * CSS className to apply to the message
403
- * @type {string}
404
- * @memberof CreateMessageBodyPayloadOneOf2ItemsInner
405
- */
406
- 'className'?: string;
407
- }
408
- /**
409
- *
410
- * @export
411
- * @interface CreateMessageBodyPayloadOneOf3
412
- */
413
- export interface CreateMessageBodyPayloadOneOf3 {
414
- /**
415
- *
416
- * @type {string}
417
- * @memberof CreateMessageBodyPayloadOneOf3
418
- */
419
- 'text': string;
420
- /**
421
- *
422
- * @type {Array<CreateMessageBodyPayloadOneOf3OptionsInner>}
423
- * @memberof CreateMessageBodyPayloadOneOf3
424
- */
425
- 'options': Array<CreateMessageBodyPayloadOneOf3OptionsInner>;
426
- /**
427
- * CSS className to apply to the message
428
- * @type {string}
429
- * @memberof CreateMessageBodyPayloadOneOf3
430
- */
431
- 'className'?: string;
432
- /**
433
- *
434
- * @type {string}
435
- * @memberof CreateMessageBodyPayloadOneOf3
436
- */
437
- 'type': CreateMessageBodyPayloadOneOf3TypeEnum;
438
- /**
439
- *
440
- * @type {boolean}
441
- * @memberof CreateMessageBodyPayloadOneOf3
442
- */
443
- 'disableFreeText'?: boolean;
444
- }
445
- export declare const CreateMessageBodyPayloadOneOf3TypeEnum: {
446
- readonly Choice: "choice";
447
- };
448
- export type CreateMessageBodyPayloadOneOf3TypeEnum = typeof CreateMessageBodyPayloadOneOf3TypeEnum[keyof typeof CreateMessageBodyPayloadOneOf3TypeEnum];
449
- /**
450
- *
451
- * @export
452
- * @interface CreateMessageBodyPayloadOneOf3OptionsInner
453
- */
454
- export interface CreateMessageBodyPayloadOneOf3OptionsInner {
455
- /**
456
- *
457
- * @type {string}
458
- * @memberof CreateMessageBodyPayloadOneOf3OptionsInner
459
- */
460
- 'label': string;
461
- /**
462
- *
463
- * @type {string}
464
- * @memberof CreateMessageBodyPayloadOneOf3OptionsInner
465
- */
466
- 'value': string;
467
- }
468
- /**
469
- *
470
- * @export
471
- * @interface CreateMessageBodyPayloadOneOf4
472
- */
473
- export interface CreateMessageBodyPayloadOneOf4 {
474
- /**
475
- *
476
- * @type {string}
477
- * @memberof CreateMessageBodyPayloadOneOf4
478
- */
479
- 'text': string;
480
- /**
481
- *
482
- * @type {Array<CreateMessageBodyPayloadOneOf3OptionsInner>}
483
- * @memberof CreateMessageBodyPayloadOneOf4
484
- */
485
- 'options': Array<CreateMessageBodyPayloadOneOf3OptionsInner>;
486
- /**
487
- * CSS className to apply to the message
488
- * @type {string}
489
- * @memberof CreateMessageBodyPayloadOneOf4
490
- */
491
- 'className'?: string;
492
- /**
493
- *
494
- * @type {string}
495
- * @memberof CreateMessageBodyPayloadOneOf4
496
- */
497
- 'type': CreateMessageBodyPayloadOneOf4TypeEnum;
498
- }
499
- export declare const CreateMessageBodyPayloadOneOf4TypeEnum: {
500
- readonly Dropdown: "dropdown";
501
- };
502
- export type CreateMessageBodyPayloadOneOf4TypeEnum = typeof CreateMessageBodyPayloadOneOf4TypeEnum[keyof typeof CreateMessageBodyPayloadOneOf4TypeEnum];
503
- /**
504
- *
505
- * @export
506
- * @interface CreateMessageBodyPayloadOneOf5
507
- */
508
- export interface CreateMessageBodyPayloadOneOf5 {
509
- /**
510
- *
511
- * @type {string}
512
- * @memberof CreateMessageBodyPayloadOneOf5
513
- */
514
- 'fileUrl': string;
515
- /**
516
- *
517
- * @type {string}
518
- * @memberof CreateMessageBodyPayloadOneOf5
519
- */
520
- 'title'?: string;
521
- /**
522
- * CSS className to apply to the message
523
- * @type {string}
524
- * @memberof CreateMessageBodyPayloadOneOf5
525
- */
526
- 'className'?: string;
527
- /**
528
- *
529
- * @type {string}
530
- * @memberof CreateMessageBodyPayloadOneOf5
531
- */
532
- 'type': CreateMessageBodyPayloadOneOf5TypeEnum;
533
- }
534
- export declare const CreateMessageBodyPayloadOneOf5TypeEnum: {
535
- readonly File: "file";
536
- };
537
- export type CreateMessageBodyPayloadOneOf5TypeEnum = typeof CreateMessageBodyPayloadOneOf5TypeEnum[keyof typeof CreateMessageBodyPayloadOneOf5TypeEnum];
538
- /**
539
- *
540
- * @export
541
- * @interface CreateMessageBodyPayloadOneOf6
542
- */
543
- export interface CreateMessageBodyPayloadOneOf6 {
544
- /**
545
- *
546
- * @type {string}
547
- * @memberof CreateMessageBodyPayloadOneOf6
548
- */
549
- 'imageUrl': string;
550
- /**
551
- * CSS className to apply to the message
552
- * @type {string}
553
- * @memberof CreateMessageBodyPayloadOneOf6
554
- */
555
- 'className'?: string;
556
- /**
557
- *
558
- * @type {string}
559
- * @memberof CreateMessageBodyPayloadOneOf6
560
- */
561
- 'type': CreateMessageBodyPayloadOneOf6TypeEnum;
562
- }
563
- export declare const CreateMessageBodyPayloadOneOf6TypeEnum: {
564
- readonly Image: "image";
565
- };
566
- export type CreateMessageBodyPayloadOneOf6TypeEnum = typeof CreateMessageBodyPayloadOneOf6TypeEnum[keyof typeof CreateMessageBodyPayloadOneOf6TypeEnum];
567
- /**
568
- *
569
- * @export
570
- * @interface CreateMessageBodyPayloadOneOf7
571
- */
572
- export interface CreateMessageBodyPayloadOneOf7 {
573
- /**
574
- *
575
- * @type {number}
576
- * @memberof CreateMessageBodyPayloadOneOf7
577
- */
578
- 'latitude': number;
579
- /**
580
- *
581
- * @type {number}
582
- * @memberof CreateMessageBodyPayloadOneOf7
583
- */
584
- 'longitude': number;
585
- /**
586
- *
587
- * @type {string}
588
- * @memberof CreateMessageBodyPayloadOneOf7
589
- */
590
- 'address'?: string;
591
- /**
592
- *
593
- * @type {string}
594
- * @memberof CreateMessageBodyPayloadOneOf7
595
- */
596
- 'title'?: string;
597
- /**
598
- * CSS className to apply to the message
599
- * @type {string}
600
- * @memberof CreateMessageBodyPayloadOneOf7
601
- */
602
- 'className'?: string;
603
- /**
604
- *
605
- * @type {string}
606
- * @memberof CreateMessageBodyPayloadOneOf7
607
- */
608
- 'type': CreateMessageBodyPayloadOneOf7TypeEnum;
609
- }
610
- export declare const CreateMessageBodyPayloadOneOf7TypeEnum: {
611
- readonly Location: "location";
612
- };
613
- export type CreateMessageBodyPayloadOneOf7TypeEnum = typeof CreateMessageBodyPayloadOneOf7TypeEnum[keyof typeof CreateMessageBodyPayloadOneOf7TypeEnum];
614
- /**
615
- *
616
- * @export
617
- * @interface CreateMessageBodyPayloadOneOf8
618
- */
619
- export interface CreateMessageBodyPayloadOneOf8 {
620
- /**
621
- *
622
- * @type {string}
623
- * @memberof CreateMessageBodyPayloadOneOf8
624
- */
625
- 'markdown': string;
626
- /**
627
- * CSS className to apply to the message
628
- * @type {string}
629
- * @memberof CreateMessageBodyPayloadOneOf8
630
- */
631
- 'className'?: string;
632
- /**
633
- *
634
- * @type {string}
635
- * @memberof CreateMessageBodyPayloadOneOf8
636
- */
637
- 'type': CreateMessageBodyPayloadOneOf8TypeEnum;
638
- }
639
- export declare const CreateMessageBodyPayloadOneOf8TypeEnum: {
640
- readonly Markdown: "markdown";
641
- };
642
- export type CreateMessageBodyPayloadOneOf8TypeEnum = typeof CreateMessageBodyPayloadOneOf8TypeEnum[keyof typeof CreateMessageBodyPayloadOneOf8TypeEnum];
643
- /**
644
- *
645
- * @export
646
- * @interface CreateMessageBodyPayloadOneOf9
647
- */
648
- export interface CreateMessageBodyPayloadOneOf9 {
649
- /**
650
- *
651
- * @type {string}
652
- * @memberof CreateMessageBodyPayloadOneOf9
653
- */
654
- 'text': string;
655
- /**
656
- * CSS className to apply to the message
657
- * @type {string}
658
- * @memberof CreateMessageBodyPayloadOneOf9
659
- */
660
- 'className'?: string;
661
- /**
662
- *
663
- * @type {string}
664
- * @memberof CreateMessageBodyPayloadOneOf9
665
- */
666
- 'type': CreateMessageBodyPayloadOneOf9TypeEnum;
667
- }
668
- export declare const CreateMessageBodyPayloadOneOf9TypeEnum: {
669
- readonly Text: "text";
670
- };
671
- export type CreateMessageBodyPayloadOneOf9TypeEnum = typeof CreateMessageBodyPayloadOneOf9TypeEnum[keyof typeof CreateMessageBodyPayloadOneOf9TypeEnum];
672
- /**
673
- *
674
- * @export
675
- * @interface CreateMessageResponse
676
- */
677
- export interface CreateMessageResponse {
678
- /**
679
- *
680
- * @type {Message}
681
- * @memberof CreateMessageResponse
682
- */
683
- 'message': Message;
684
- }
685
- /**
686
- *
687
- * @export
688
- * @interface CreateUserBody
689
- */
690
- export interface CreateUserBody {
691
- /**
692
- * Name of the [User](#schema_user) (not a unique identifier)
693
- * @type {string}
694
- * @memberof CreateUserBody
695
- */
696
- 'name'?: string;
697
- /**
698
- * Picture url of the [User](#schema_user)
699
- * @type {string}
700
- * @memberof CreateUserBody
701
- */
702
- 'pictureUrl'?: string;
703
- /**
704
- * User data
705
- * @type {{ [key: string]: any; }}
706
- * @memberof CreateUserBody
707
- */
708
- 'userData'?: {
709
- [key: string]: any;
710
- };
711
- }
712
- /**
713
- *
714
- * @export
715
- * @interface CreateUserResponse
716
- */
717
- export interface CreateUserResponse {
718
- /**
719
- *
720
- * @type {User}
721
- * @memberof CreateUserResponse
722
- */
723
- 'user': User;
724
- /**
725
- *
726
- * @type {string}
727
- * @memberof CreateUserResponse
728
- */
729
- 'key': string;
730
- }
731
- /**
732
- *
733
- * @export
734
- * @interface Event
735
- */
736
- export interface Event {
737
- /**
738
- * ID of the [Event](#schema_event).
739
- * @type {string}
740
- * @memberof Event
741
- */
742
- 'id': string;
743
- /**
744
- * Creation date of the [Event](#schema_event) in ISO 8601 format
745
- * @type {string}
746
- * @memberof Event
747
- */
748
- 'createdAt': string;
749
- /**
750
- *
751
- * @type {EventPayload}
752
- * @memberof Event
753
- */
754
- 'payload': EventPayload;
755
- /**
756
- * ID of the [Conversation](#schema_conversation).
757
- * @type {string}
758
- * @memberof Event
759
- */
760
- 'conversationId': string;
761
- /**
762
- * ID of the [User](#schema_user).
763
- * @type {string}
764
- * @memberof Event
765
- */
766
- 'userId': string;
767
- }
768
- /**
769
- * @type EventPayload
770
- * Payload is the content of the event.
771
- * @export
772
- */
773
- export type EventPayload = CreateEventBodyPayloadOneOf | CreateEventBodyPayloadOneOf1;
774
- /**
775
- *
776
- * @export
777
- * @interface GetConversationResponse
778
- */
779
- export interface GetConversationResponse {
780
- /**
781
- *
782
- * @type {Conversation}
783
- * @memberof GetConversationResponse
784
- */
785
- 'conversation': Conversation;
786
- }
787
- /**
788
- *
789
- * @export
790
- * @interface GetEventResponse
791
- */
792
- export interface GetEventResponse {
793
- /**
794
- *
795
- * @type {Event}
796
- * @memberof GetEventResponse
797
- */
798
- 'event': Event;
799
- }
800
- /**
801
- *
802
- * @export
803
- * @interface GetMessageResponse
804
- */
805
- export interface GetMessageResponse {
806
- /**
807
- *
808
- * @type {Message}
809
- * @memberof GetMessageResponse
810
- */
811
- 'message': Message;
812
- }
813
- /**
814
- *
815
- * @export
816
- * @interface GetParticipantResponse
817
- */
818
- export interface GetParticipantResponse {
819
- /**
820
- *
821
- * @type {User}
822
- * @memberof GetParticipantResponse
823
- */
824
- 'participant': User;
825
- }
826
- /**
827
- *
828
- * @export
829
- * @interface GetUserResponse
830
- */
831
- export interface GetUserResponse {
832
- /**
833
- *
834
- * @type {User}
835
- * @memberof GetUserResponse
836
- */
837
- 'user': User;
838
- }
839
- /**
840
- *
841
- * @export
842
- * @interface ListConversationMessagesResponse
843
- */
844
- export interface ListConversationMessagesResponse {
845
- /**
846
- *
847
- * @type {Array<Message>}
848
- * @memberof ListConversationMessagesResponse
849
- */
850
- 'messages': Array<Message>;
851
- /**
852
- *
853
- * @type {ListParticipantsResponseMeta}
854
- * @memberof ListConversationMessagesResponse
855
- */
856
- 'meta': ListParticipantsResponseMeta;
857
- }
858
- /**
859
- *
860
- * @export
861
- * @interface ListConversationsResponse
862
- */
863
- export interface ListConversationsResponse {
864
- /**
865
- *
866
- * @type {Array<ListConversationsResponseConversationsInner>}
867
- * @memberof ListConversationsResponse
868
- */
869
- 'conversations': Array<ListConversationsResponseConversationsInner>;
870
- /**
871
- *
872
- * @type {ListParticipantsResponseMeta}
873
- * @memberof ListConversationsResponse
874
- */
875
- 'meta': ListParticipantsResponseMeta;
876
- }
877
- /**
878
- *
879
- * @export
880
- * @interface ListConversationsResponseConversationsInner
881
- */
882
- export interface ListConversationsResponseConversationsInner {
883
- /**
884
- * Id of the [Conversation](#schema_conversation)
885
- * @type {string}
886
- * @memberof ListConversationsResponseConversationsInner
887
- */
888
- 'id': string;
889
- /**
890
- * Creation date of the [Conversation](#schema_conversation) in ISO 8601 format
891
- * @type {string}
892
- * @memberof ListConversationsResponseConversationsInner
893
- */
894
- 'createdAt': string;
895
- /**
896
- * Updating date of the [Conversation](#schema_conversation) in ISO 8601 format
897
- * @type {string}
898
- * @memberof ListConversationsResponseConversationsInner
899
- */
900
- 'updatedAt': string;
901
- }
902
- /**
903
- *
904
- * @export
905
- * @interface ListParticipantsResponse
906
- */
907
- export interface ListParticipantsResponse {
908
- /**
909
- *
910
- * @type {Array<User>}
911
- * @memberof ListParticipantsResponse
912
- */
913
- 'participants': Array<User>;
914
- /**
915
- *
916
- * @type {ListParticipantsResponseMeta}
917
- * @memberof ListParticipantsResponse
918
- */
919
- 'meta': ListParticipantsResponseMeta;
920
- }
921
- /**
922
- *
923
- * @export
924
- * @interface ListParticipantsResponseMeta
925
- */
926
- export interface ListParticipantsResponseMeta {
927
- /**
928
- * The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint.
929
- * @type {string}
930
- * @memberof ListParticipantsResponseMeta
931
- */
932
- 'nextToken'?: string;
933
- }
934
- /**
935
- * The Message object represents a message in a [Conversation](#schema_conversation) for a specific [User](#schema_user).
936
- * @export
937
- * @interface Message
938
- */
939
- export interface Message {
940
- /**
941
- * Id of the [Message](#schema_message)
942
- * @type {string}
943
- * @memberof Message
944
- */
945
- 'id': string;
946
- /**
947
- * Creation date of the [Message](#schema_message) in ISO 8601 format
948
- * @type {string}
949
- * @memberof Message
950
- */
951
- 'createdAt': string;
952
- /**
953
- *
954
- * @type {CreateMessageBodyPayload}
955
- * @memberof Message
956
- */
957
- 'payload': CreateMessageBodyPayload;
958
- /**
959
- * ID of the [User](#schema_user)
960
- * @type {string}
961
- * @memberof Message
962
- */
963
- 'userId': string;
964
- /**
965
- * ID of the [Conversation](#schema_conversation)
966
- * @type {string}
967
- * @memberof Message
968
- */
969
- 'conversationId': string;
970
- }
971
- /**
972
- *
973
- * @export
974
- * @interface UpdateUserBody
975
- */
976
- export interface UpdateUserBody {
977
- /**
978
- * Name of the [User](#schema_user) (not a unique identifier)
979
- * @type {string}
980
- * @memberof UpdateUserBody
981
- */
982
- 'name'?: string;
983
- /**
984
- * Picture url of the [User](#schema_user)
985
- * @type {string}
986
- * @memberof UpdateUserBody
987
- */
988
- 'pictureUrl'?: string;
989
- /**
990
- * User data
991
- * @type {{ [key: string]: any; }}
992
- * @memberof UpdateUserBody
993
- */
994
- 'userData'?: {
995
- [key: string]: any;
996
- };
997
- }
998
- /**
999
- *
1000
- * @export
1001
- * @interface UpdateUserResponse
1002
- */
1003
- export interface UpdateUserResponse {
1004
- /**
1005
- *
1006
- * @type {User}
1007
- * @memberof UpdateUserResponse
1008
- */
1009
- 'user': User;
1010
- }
1011
- /**
1012
- * The user object represents someone interacting with the bot within a specific integration. The same person interacting with a bot in slack and messenger will be represented with two different users.
1013
- * @export
1014
- * @interface User
1015
- */
1016
- export interface User {
1017
- /**
1018
- * Name of the [User](#schema_user)
1019
- * @type {string}
1020
- * @memberof User
1021
- */
1022
- 'name'?: string;
1023
- /**
1024
- * Picture url of the [User](#schema_user)
1025
- * @type {string}
1026
- * @memberof User
1027
- */
1028
- 'pictureUrl'?: string;
1029
- /**
1030
- * Id of the [User](#schema_user)
1031
- * @type {string}
1032
- * @memberof User
1033
- */
1034
- 'id': string;
1035
- /**
1036
- * Creation date of the [User](#schema_user) in ISO 8601 format
1037
- * @type {string}
1038
- * @memberof User
1039
- */
1040
- 'createdAt': string;
1041
- /**
1042
- * Updating date of the [User](#schema_user) in ISO 8601 format
1043
- * @type {string}
1044
- * @memberof User
1045
- */
1046
- 'updatedAt': string;
1047
- }
1048
- /**
1049
- * DefaultApi - axios parameter creator
1050
- * @export
1051
- */
1052
- export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
1053
- /**
1054
- * Add a [Participant](#schema_user) to a [Conversation](#schema_conversation).
1055
- * @param {string} xUserKey Authentication Key
1056
- * @param {string} id Conversation id
1057
- * @param {AddParticipantBody} [addParticipantBody] Participant data
1058
- * @param {*} [options] Override http request option.
1059
- * @throws {RequiredError}
1060
- */
1061
- addParticipant: (xUserKey: string, id: string, addParticipantBody?: AddParticipantBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1062
- /**
1063
- * Creates a new [Conversation](#schema_conversation)
1064
- * @param {string} xUserKey Authentication Key
1065
- * @param {CreateConversationBody} [createConversationBody] Conversation data
1066
- * @param {*} [options] Override http request option.
1067
- * @throws {RequiredError}
1068
- */
1069
- createConversation: (xUserKey: string, createConversationBody?: CreateConversationBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1070
- /**
1071
- * Creates a new [Event](#schema_event)
1072
- * @param {string} xUserKey Authentication Key
1073
- * @param {CreateEventBody} [createEventBody] Event data
1074
- * @param {*} [options] Override http request option.
1075
- * @throws {RequiredError}
1076
- */
1077
- createEvent: (xUserKey: string, createEventBody?: CreateEventBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1078
- /**
1079
- * Creates a new [Message](#schema_message)
1080
- * @param {string} xUserKey Authentication Key
1081
- * @param {CreateMessageBody} [createMessageBody] Message data
1082
- * @param {*} [options] Override http request option.
1083
- * @throws {RequiredError}
1084
- */
1085
- createMessage: (xUserKey: string, createMessageBody?: CreateMessageBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1086
- /**
1087
- * Creates a new [User](#schema_user)
1088
- * @param {CreateUserBody} [createUserBody] User data
1089
- * @param {*} [options] Override http request option.
1090
- * @throws {RequiredError}
1091
- */
1092
- createUser: (createUserBody?: CreateUserBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1093
- /**
1094
- * Permanently deletes a [Conversation](#schema_conversation). It cannot be undone. Also immediately deletes corresponding [Messages](#schema_message).
1095
- * @param {string} xUserKey Authentication Key
1096
- * @param {string} id Conversation id
1097
- * @param {*} [options] Override http request option.
1098
- * @throws {RequiredError}
1099
- */
1100
- deleteConversation: (xUserKey: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1101
- /**
1102
- * Permanently deletes a [Message](#schema_message). It cannot be undone.
1103
- * @param {string} xUserKey Authentication Key
1104
- * @param {string} id Message id
1105
- * @param {*} [options] Override http request option.
1106
- * @throws {RequiredError}
1107
- */
1108
- deleteMessage: (xUserKey: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1109
- /**
1110
- * Permanently deletes a [User](#schema_user). It cannot be undone.
1111
- * @param {string} xUserKey Authentication Key
1112
- * @param {*} [options] Override http request option.
1113
- * @throws {RequiredError}
1114
- */
1115
- deleteUser: (xUserKey: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1116
- /**
1117
- * Retrieves the [Conversation](#schema_conversation) object for a valid identifier.
1118
- * @param {string} xUserKey Authentication Key
1119
- * @param {string} id Conversation id
1120
- * @param {*} [options] Override http request option.
1121
- * @throws {RequiredError}
1122
- */
1123
- getConversation: (xUserKey: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1124
- /**
1125
- * Retrieves the [Event](#schema_event) object for a valid identifier.
1126
- * @param {string} xUserKey Authentication Key
1127
- * @param {string} id Id of the Event
1128
- * @param {*} [options] Override http request option.
1129
- * @throws {RequiredError}
1130
- */
1131
- getEvent: (xUserKey: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1132
- /**
1133
- * Retrieves the [Message](#schema_message) object for a valid identifier.
1134
- * @param {string} xUserKey Authentication Key
1135
- * @param {string} id Id of the Message
1136
- * @param {*} [options] Override http request option.
1137
- * @throws {RequiredError}
1138
- */
1139
- getMessage: (xUserKey: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1140
- /**
1141
- * Retrieves a [Participant](#schema_user) from a [Conversation](#schema_conversation).
1142
- * @param {string} xUserKey Authentication Key
1143
- * @param {string} id Conversation id
1144
- * @param {string} userId User id
1145
- * @param {*} [options] Override http request option.
1146
- * @throws {RequiredError}
1147
- */
1148
- getParticipant: (xUserKey: string, id: string, userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1149
- /**
1150
- * Retrieves the [User](#schema_user) object for a valid identifier.
1151
- * @param {string} xUserKey Authentication Key
1152
- * @param {*} [options] Override http request option.
1153
- * @throws {RequiredError}
1154
- */
1155
- getUser: (xUserKey: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1156
- /**
1157
- * Retrieves the conversation\'s [Messages](#schema_message)
1158
- * @param {string} xUserKey Authentication Key
1159
- * @param {string} id Conversation id
1160
- * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
1161
- * @param {*} [options] Override http request option.
1162
- * @throws {RequiredError}
1163
- */
1164
- listConversationMessages: (xUserKey: string, id: string, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1165
- /**
1166
- * Returns a list of [Conversation](#schema_conversation) objects
1167
- * @param {string} xUserKey Authentication Key
1168
- * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
1169
- * @param {*} [options] Override http request option.
1170
- * @throws {RequiredError}
1171
- */
1172
- listConversations: (xUserKey: string, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1173
- /**
1174
- * Retrieves a list of [Participants](#schema_user) for a given [Conversation](#schema_conversation).
1175
- * @param {string} xUserKey Authentication Key
1176
- * @param {string} id Conversation id
1177
- * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
1178
- * @param {*} [options] Override http request option.
1179
- * @throws {RequiredError}
1180
- */
1181
- listParticipants: (xUserKey: string, id: string, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1182
- /**
1183
- * Creates a SSE stream to receive messages and events from a conversation
1184
- * @param {string} xUserKey Authentication Key
1185
- * @param {string} id Conversation id
1186
- * @param {*} [options] Override http request option.
1187
- * @throws {RequiredError}
1188
- */
1189
- listenConversation: (xUserKey: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1190
- /**
1191
- * Remove a [Participant](#schema_user) from a [Conversation](#schema_conversation).
1192
- * @param {string} xUserKey Authentication Key
1193
- * @param {string} id Conversation id
1194
- * @param {string} userId User id
1195
- * @param {*} [options] Override http request option.
1196
- * @throws {RequiredError}
1197
- */
1198
- removeParticipant: (xUserKey: string, id: string, userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1199
- /**
1200
- * Update [User](#schema_user)
1201
- * @param {string} xUserKey Authentication Key
1202
- * @param {UpdateUserBody} [updateUserBody] User data
1203
- * @param {*} [options] Override http request option.
1204
- * @throws {RequiredError}
1205
- */
1206
- updateUser: (xUserKey: string, updateUserBody?: UpdateUserBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1207
- };
1208
- /**
1209
- * DefaultApi - functional programming interface
1210
- * @export
1211
- */
1212
- export declare const DefaultApiFp: (configuration?: Configuration) => {
1213
- /**
1214
- * Add a [Participant](#schema_user) to a [Conversation](#schema_conversation).
1215
- * @param {string} xUserKey Authentication Key
1216
- * @param {string} id Conversation id
1217
- * @param {AddParticipantBody} [addParticipantBody] Participant data
1218
- * @param {*} [options] Override http request option.
1219
- * @throws {RequiredError}
1220
- */
1221
- addParticipant(xUserKey: string, id: string, addParticipantBody?: AddParticipantBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddParticipantResponse>>;
1222
- /**
1223
- * Creates a new [Conversation](#schema_conversation)
1224
- * @param {string} xUserKey Authentication Key
1225
- * @param {CreateConversationBody} [createConversationBody] Conversation data
1226
- * @param {*} [options] Override http request option.
1227
- * @throws {RequiredError}
1228
- */
1229
- createConversation(xUserKey: string, createConversationBody?: CreateConversationBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateConversationResponse>>;
1230
- /**
1231
- * Creates a new [Event](#schema_event)
1232
- * @param {string} xUserKey Authentication Key
1233
- * @param {CreateEventBody} [createEventBody] Event data
1234
- * @param {*} [options] Override http request option.
1235
- * @throws {RequiredError}
1236
- */
1237
- createEvent(xUserKey: string, createEventBody?: CreateEventBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateEventResponse>>;
1238
- /**
1239
- * Creates a new [Message](#schema_message)
1240
- * @param {string} xUserKey Authentication Key
1241
- * @param {CreateMessageBody} [createMessageBody] Message data
1242
- * @param {*} [options] Override http request option.
1243
- * @throws {RequiredError}
1244
- */
1245
- createMessage(xUserKey: string, createMessageBody?: CreateMessageBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateMessageResponse>>;
1246
- /**
1247
- * Creates a new [User](#schema_user)
1248
- * @param {CreateUserBody} [createUserBody] User data
1249
- * @param {*} [options] Override http request option.
1250
- * @throws {RequiredError}
1251
- */
1252
- createUser(createUserBody?: CreateUserBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateUserResponse>>;
1253
- /**
1254
- * Permanently deletes a [Conversation](#schema_conversation). It cannot be undone. Also immediately deletes corresponding [Messages](#schema_message).
1255
- * @param {string} xUserKey Authentication Key
1256
- * @param {string} id Conversation id
1257
- * @param {*} [options] Override http request option.
1258
- * @throws {RequiredError}
1259
- */
1260
- deleteConversation(xUserKey: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
1261
- /**
1262
- * Permanently deletes a [Message](#schema_message). It cannot be undone.
1263
- * @param {string} xUserKey Authentication Key
1264
- * @param {string} id Message id
1265
- * @param {*} [options] Override http request option.
1266
- * @throws {RequiredError}
1267
- */
1268
- deleteMessage(xUserKey: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
1269
- /**
1270
- * Permanently deletes a [User](#schema_user). It cannot be undone.
1271
- * @param {string} xUserKey Authentication Key
1272
- * @param {*} [options] Override http request option.
1273
- * @throws {RequiredError}
1274
- */
1275
- deleteUser(xUserKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
1276
- /**
1277
- * Retrieves the [Conversation](#schema_conversation) object for a valid identifier.
1278
- * @param {string} xUserKey Authentication Key
1279
- * @param {string} id Conversation id
1280
- * @param {*} [options] Override http request option.
1281
- * @throws {RequiredError}
1282
- */
1283
- getConversation(xUserKey: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetConversationResponse>>;
1284
- /**
1285
- * Retrieves the [Event](#schema_event) object for a valid identifier.
1286
- * @param {string} xUserKey Authentication Key
1287
- * @param {string} id Id of the Event
1288
- * @param {*} [options] Override http request option.
1289
- * @throws {RequiredError}
1290
- */
1291
- getEvent(xUserKey: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventResponse>>;
1292
- /**
1293
- * Retrieves the [Message](#schema_message) object for a valid identifier.
1294
- * @param {string} xUserKey Authentication Key
1295
- * @param {string} id Id of the Message
1296
- * @param {*} [options] Override http request option.
1297
- * @throws {RequiredError}
1298
- */
1299
- getMessage(xUserKey: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMessageResponse>>;
1300
- /**
1301
- * Retrieves a [Participant](#schema_user) from a [Conversation](#schema_conversation).
1302
- * @param {string} xUserKey Authentication Key
1303
- * @param {string} id Conversation id
1304
- * @param {string} userId User id
1305
- * @param {*} [options] Override http request option.
1306
- * @throws {RequiredError}
1307
- */
1308
- getParticipant(xUserKey: string, id: string, userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetParticipantResponse>>;
1309
- /**
1310
- * Retrieves the [User](#schema_user) object for a valid identifier.
1311
- * @param {string} xUserKey Authentication Key
1312
- * @param {*} [options] Override http request option.
1313
- * @throws {RequiredError}
1314
- */
1315
- getUser(xUserKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUserResponse>>;
1316
- /**
1317
- * Retrieves the conversation\'s [Messages](#schema_message)
1318
- * @param {string} xUserKey Authentication Key
1319
- * @param {string} id Conversation id
1320
- * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
1321
- * @param {*} [options] Override http request option.
1322
- * @throws {RequiredError}
1323
- */
1324
- listConversationMessages(xUserKey: string, id: string, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListConversationMessagesResponse>>;
1325
- /**
1326
- * Returns a list of [Conversation](#schema_conversation) objects
1327
- * @param {string} xUserKey Authentication Key
1328
- * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
1329
- * @param {*} [options] Override http request option.
1330
- * @throws {RequiredError}
1331
- */
1332
- listConversations(xUserKey: string, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListConversationsResponse>>;
1333
- /**
1334
- * Retrieves a list of [Participants](#schema_user) for a given [Conversation](#schema_conversation).
1335
- * @param {string} xUserKey Authentication Key
1336
- * @param {string} id Conversation id
1337
- * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
1338
- * @param {*} [options] Override http request option.
1339
- * @throws {RequiredError}
1340
- */
1341
- listParticipants(xUserKey: string, id: string, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListParticipantsResponse>>;
1342
- /**
1343
- * Creates a SSE stream to receive messages and events from a conversation
1344
- * @param {string} xUserKey Authentication Key
1345
- * @param {string} id Conversation id
1346
- * @param {*} [options] Override http request option.
1347
- * @throws {RequiredError}
1348
- */
1349
- listenConversation(xUserKey: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
1350
- /**
1351
- * Remove a [Participant](#schema_user) from a [Conversation](#schema_conversation).
1352
- * @param {string} xUserKey Authentication Key
1353
- * @param {string} id Conversation id
1354
- * @param {string} userId User id
1355
- * @param {*} [options] Override http request option.
1356
- * @throws {RequiredError}
1357
- */
1358
- removeParticipant(xUserKey: string, id: string, userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
1359
- /**
1360
- * Update [User](#schema_user)
1361
- * @param {string} xUserKey Authentication Key
1362
- * @param {UpdateUserBody} [updateUserBody] User data
1363
- * @param {*} [options] Override http request option.
1364
- * @throws {RequiredError}
1365
- */
1366
- updateUser(xUserKey: string, updateUserBody?: UpdateUserBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateUserResponse>>;
1367
- };
1368
- /**
1369
- * DefaultApi - factory interface
1370
- * @export
1371
- */
1372
- export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1373
- /**
1374
- * Add a [Participant](#schema_user) to a [Conversation](#schema_conversation).
1375
- * @param {DefaultApiAddParticipantRequest} requestParameters Request parameters.
1376
- * @param {*} [options] Override http request option.
1377
- * @throws {RequiredError}
1378
- */
1379
- addParticipant(requestParameters: DefaultApiAddParticipantRequest, options?: AxiosRequestConfig): AxiosPromise<AddParticipantResponse>;
1380
- /**
1381
- * Creates a new [Conversation](#schema_conversation)
1382
- * @param {DefaultApiCreateConversationRequest} requestParameters Request parameters.
1383
- * @param {*} [options] Override http request option.
1384
- * @throws {RequiredError}
1385
- */
1386
- createConversation(requestParameters: DefaultApiCreateConversationRequest, options?: AxiosRequestConfig): AxiosPromise<CreateConversationResponse>;
1387
- /**
1388
- * Creates a new [Event](#schema_event)
1389
- * @param {DefaultApiCreateEventRequest} requestParameters Request parameters.
1390
- * @param {*} [options] Override http request option.
1391
- * @throws {RequiredError}
1392
- */
1393
- createEvent(requestParameters: DefaultApiCreateEventRequest, options?: AxiosRequestConfig): AxiosPromise<CreateEventResponse>;
1394
- /**
1395
- * Creates a new [Message](#schema_message)
1396
- * @param {DefaultApiCreateMessageRequest} requestParameters Request parameters.
1397
- * @param {*} [options] Override http request option.
1398
- * @throws {RequiredError}
1399
- */
1400
- createMessage(requestParameters: DefaultApiCreateMessageRequest, options?: AxiosRequestConfig): AxiosPromise<CreateMessageResponse>;
1401
- /**
1402
- * Creates a new [User](#schema_user)
1403
- * @param {DefaultApiCreateUserRequest} requestParameters Request parameters.
1404
- * @param {*} [options] Override http request option.
1405
- * @throws {RequiredError}
1406
- */
1407
- createUser(requestParameters?: DefaultApiCreateUserRequest, options?: AxiosRequestConfig): AxiosPromise<CreateUserResponse>;
1408
- /**
1409
- * Permanently deletes a [Conversation](#schema_conversation). It cannot be undone. Also immediately deletes corresponding [Messages](#schema_message).
1410
- * @param {DefaultApiDeleteConversationRequest} requestParameters Request parameters.
1411
- * @param {*} [options] Override http request option.
1412
- * @throws {RequiredError}
1413
- */
1414
- deleteConversation(requestParameters: DefaultApiDeleteConversationRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
1415
- /**
1416
- * Permanently deletes a [Message](#schema_message). It cannot be undone.
1417
- * @param {DefaultApiDeleteMessageRequest} requestParameters Request parameters.
1418
- * @param {*} [options] Override http request option.
1419
- * @throws {RequiredError}
1420
- */
1421
- deleteMessage(requestParameters: DefaultApiDeleteMessageRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
1422
- /**
1423
- * Permanently deletes a [User](#schema_user). It cannot be undone.
1424
- * @param {DefaultApiDeleteUserRequest} requestParameters Request parameters.
1425
- * @param {*} [options] Override http request option.
1426
- * @throws {RequiredError}
1427
- */
1428
- deleteUser(requestParameters: DefaultApiDeleteUserRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
1429
- /**
1430
- * Retrieves the [Conversation](#schema_conversation) object for a valid identifier.
1431
- * @param {DefaultApiGetConversationRequest} requestParameters Request parameters.
1432
- * @param {*} [options] Override http request option.
1433
- * @throws {RequiredError}
1434
- */
1435
- getConversation(requestParameters: DefaultApiGetConversationRequest, options?: AxiosRequestConfig): AxiosPromise<GetConversationResponse>;
1436
- /**
1437
- * Retrieves the [Event](#schema_event) object for a valid identifier.
1438
- * @param {DefaultApiGetEventRequest} requestParameters Request parameters.
1439
- * @param {*} [options] Override http request option.
1440
- * @throws {RequiredError}
1441
- */
1442
- getEvent(requestParameters: DefaultApiGetEventRequest, options?: AxiosRequestConfig): AxiosPromise<GetEventResponse>;
1443
- /**
1444
- * Retrieves the [Message](#schema_message) object for a valid identifier.
1445
- * @param {DefaultApiGetMessageRequest} requestParameters Request parameters.
1446
- * @param {*} [options] Override http request option.
1447
- * @throws {RequiredError}
1448
- */
1449
- getMessage(requestParameters: DefaultApiGetMessageRequest, options?: AxiosRequestConfig): AxiosPromise<GetMessageResponse>;
1450
- /**
1451
- * Retrieves a [Participant](#schema_user) from a [Conversation](#schema_conversation).
1452
- * @param {DefaultApiGetParticipantRequest} requestParameters Request parameters.
1453
- * @param {*} [options] Override http request option.
1454
- * @throws {RequiredError}
1455
- */
1456
- getParticipant(requestParameters: DefaultApiGetParticipantRequest, options?: AxiosRequestConfig): AxiosPromise<GetParticipantResponse>;
1457
- /**
1458
- * Retrieves the [User](#schema_user) object for a valid identifier.
1459
- * @param {DefaultApiGetUserRequest} requestParameters Request parameters.
1460
- * @param {*} [options] Override http request option.
1461
- * @throws {RequiredError}
1462
- */
1463
- getUser(requestParameters: DefaultApiGetUserRequest, options?: AxiosRequestConfig): AxiosPromise<GetUserResponse>;
1464
- /**
1465
- * Retrieves the conversation\'s [Messages](#schema_message)
1466
- * @param {DefaultApiListConversationMessagesRequest} requestParameters Request parameters.
1467
- * @param {*} [options] Override http request option.
1468
- * @throws {RequiredError}
1469
- */
1470
- listConversationMessages(requestParameters: DefaultApiListConversationMessagesRequest, options?: AxiosRequestConfig): AxiosPromise<ListConversationMessagesResponse>;
1471
- /**
1472
- * Returns a list of [Conversation](#schema_conversation) objects
1473
- * @param {DefaultApiListConversationsRequest} requestParameters Request parameters.
1474
- * @param {*} [options] Override http request option.
1475
- * @throws {RequiredError}
1476
- */
1477
- listConversations(requestParameters: DefaultApiListConversationsRequest, options?: AxiosRequestConfig): AxiosPromise<ListConversationsResponse>;
1478
- /**
1479
- * Retrieves a list of [Participants](#schema_user) for a given [Conversation](#schema_conversation).
1480
- * @param {DefaultApiListParticipantsRequest} requestParameters Request parameters.
1481
- * @param {*} [options] Override http request option.
1482
- * @throws {RequiredError}
1483
- */
1484
- listParticipants(requestParameters: DefaultApiListParticipantsRequest, options?: AxiosRequestConfig): AxiosPromise<ListParticipantsResponse>;
1485
- /**
1486
- * Creates a SSE stream to receive messages and events from a conversation
1487
- * @param {DefaultApiListenConversationRequest} requestParameters Request parameters.
1488
- * @param {*} [options] Override http request option.
1489
- * @throws {RequiredError}
1490
- */
1491
- listenConversation(requestParameters: DefaultApiListenConversationRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
1492
- /**
1493
- * Remove a [Participant](#schema_user) from a [Conversation](#schema_conversation).
1494
- * @param {DefaultApiRemoveParticipantRequest} requestParameters Request parameters.
1495
- * @param {*} [options] Override http request option.
1496
- * @throws {RequiredError}
1497
- */
1498
- removeParticipant(requestParameters: DefaultApiRemoveParticipantRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
1499
- /**
1500
- * Update [User](#schema_user)
1501
- * @param {DefaultApiUpdateUserRequest} requestParameters Request parameters.
1502
- * @param {*} [options] Override http request option.
1503
- * @throws {RequiredError}
1504
- */
1505
- updateUser(requestParameters: DefaultApiUpdateUserRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateUserResponse>;
1506
- };
1507
- /**
1508
- * Request parameters for addParticipant operation in DefaultApi.
1509
- * @export
1510
- * @interface DefaultApiAddParticipantRequest
1511
- */
1512
- export interface DefaultApiAddParticipantRequest {
1513
- /**
1514
- * Authentication Key
1515
- * @type {string}
1516
- * @memberof DefaultApiAddParticipant
1517
- */
1518
- readonly xUserKey: string;
1519
- /**
1520
- * Conversation id
1521
- * @type {string}
1522
- * @memberof DefaultApiAddParticipant
1523
- */
1524
- readonly id: string;
1525
- /**
1526
- * Participant data
1527
- * @type {AddParticipantBody}
1528
- * @memberof DefaultApiAddParticipant
1529
- */
1530
- readonly addParticipantBody?: AddParticipantBody;
1531
- }
1532
- /**
1533
- * Request parameters for createConversation operation in DefaultApi.
1534
- * @export
1535
- * @interface DefaultApiCreateConversationRequest
1536
- */
1537
- export interface DefaultApiCreateConversationRequest {
1538
- /**
1539
- * Authentication Key
1540
- * @type {string}
1541
- * @memberof DefaultApiCreateConversation
1542
- */
1543
- readonly xUserKey: string;
1544
- /**
1545
- * Conversation data
1546
- * @type {CreateConversationBody}
1547
- * @memberof DefaultApiCreateConversation
1548
- */
1549
- readonly createConversationBody?: CreateConversationBody;
1550
- }
1551
- /**
1552
- * Request parameters for createEvent operation in DefaultApi.
1553
- * @export
1554
- * @interface DefaultApiCreateEventRequest
1555
- */
1556
- export interface DefaultApiCreateEventRequest {
1557
- /**
1558
- * Authentication Key
1559
- * @type {string}
1560
- * @memberof DefaultApiCreateEvent
1561
- */
1562
- readonly xUserKey: string;
1563
- /**
1564
- * Event data
1565
- * @type {CreateEventBody}
1566
- * @memberof DefaultApiCreateEvent
1567
- */
1568
- readonly createEventBody?: CreateEventBody;
1569
- }
1570
- /**
1571
- * Request parameters for createMessage operation in DefaultApi.
1572
- * @export
1573
- * @interface DefaultApiCreateMessageRequest
1574
- */
1575
- export interface DefaultApiCreateMessageRequest {
1576
- /**
1577
- * Authentication Key
1578
- * @type {string}
1579
- * @memberof DefaultApiCreateMessage
1580
- */
1581
- readonly xUserKey: string;
1582
- /**
1583
- * Message data
1584
- * @type {CreateMessageBody}
1585
- * @memberof DefaultApiCreateMessage
1586
- */
1587
- readonly createMessageBody?: CreateMessageBody;
1588
- }
1589
- /**
1590
- * Request parameters for createUser operation in DefaultApi.
1591
- * @export
1592
- * @interface DefaultApiCreateUserRequest
1593
- */
1594
- export interface DefaultApiCreateUserRequest {
1595
- /**
1596
- * User data
1597
- * @type {CreateUserBody}
1598
- * @memberof DefaultApiCreateUser
1599
- */
1600
- readonly createUserBody?: CreateUserBody;
1601
- }
1602
- /**
1603
- * Request parameters for deleteConversation operation in DefaultApi.
1604
- * @export
1605
- * @interface DefaultApiDeleteConversationRequest
1606
- */
1607
- export interface DefaultApiDeleteConversationRequest {
1608
- /**
1609
- * Authentication Key
1610
- * @type {string}
1611
- * @memberof DefaultApiDeleteConversation
1612
- */
1613
- readonly xUserKey: string;
1614
- /**
1615
- * Conversation id
1616
- * @type {string}
1617
- * @memberof DefaultApiDeleteConversation
1618
- */
1619
- readonly id: string;
1620
- }
1621
- /**
1622
- * Request parameters for deleteMessage operation in DefaultApi.
1623
- * @export
1624
- * @interface DefaultApiDeleteMessageRequest
1625
- */
1626
- export interface DefaultApiDeleteMessageRequest {
1627
- /**
1628
- * Authentication Key
1629
- * @type {string}
1630
- * @memberof DefaultApiDeleteMessage
1631
- */
1632
- readonly xUserKey: string;
1633
- /**
1634
- * Message id
1635
- * @type {string}
1636
- * @memberof DefaultApiDeleteMessage
1637
- */
1638
- readonly id: string;
1639
- }
1640
- /**
1641
- * Request parameters for deleteUser operation in DefaultApi.
1642
- * @export
1643
- * @interface DefaultApiDeleteUserRequest
1644
- */
1645
- export interface DefaultApiDeleteUserRequest {
1646
- /**
1647
- * Authentication Key
1648
- * @type {string}
1649
- * @memberof DefaultApiDeleteUser
1650
- */
1651
- readonly xUserKey: string;
1652
- }
1653
- /**
1654
- * Request parameters for getConversation operation in DefaultApi.
1655
- * @export
1656
- * @interface DefaultApiGetConversationRequest
1657
- */
1658
- export interface DefaultApiGetConversationRequest {
1659
- /**
1660
- * Authentication Key
1661
- * @type {string}
1662
- * @memberof DefaultApiGetConversation
1663
- */
1664
- readonly xUserKey: string;
1665
- /**
1666
- * Conversation id
1667
- * @type {string}
1668
- * @memberof DefaultApiGetConversation
1669
- */
1670
- readonly id: string;
1671
- }
1672
- /**
1673
- * Request parameters for getEvent operation in DefaultApi.
1674
- * @export
1675
- * @interface DefaultApiGetEventRequest
1676
- */
1677
- export interface DefaultApiGetEventRequest {
1678
- /**
1679
- * Authentication Key
1680
- * @type {string}
1681
- * @memberof DefaultApiGetEvent
1682
- */
1683
- readonly xUserKey: string;
1684
- /**
1685
- * Id of the Event
1686
- * @type {string}
1687
- * @memberof DefaultApiGetEvent
1688
- */
1689
- readonly id: string;
1690
- }
1691
- /**
1692
- * Request parameters for getMessage operation in DefaultApi.
1693
- * @export
1694
- * @interface DefaultApiGetMessageRequest
1695
- */
1696
- export interface DefaultApiGetMessageRequest {
1697
- /**
1698
- * Authentication Key
1699
- * @type {string}
1700
- * @memberof DefaultApiGetMessage
1701
- */
1702
- readonly xUserKey: string;
1703
- /**
1704
- * Id of the Message
1705
- * @type {string}
1706
- * @memberof DefaultApiGetMessage
1707
- */
1708
- readonly id: string;
1709
- }
1710
- /**
1711
- * Request parameters for getParticipant operation in DefaultApi.
1712
- * @export
1713
- * @interface DefaultApiGetParticipantRequest
1714
- */
1715
- export interface DefaultApiGetParticipantRequest {
1716
- /**
1717
- * Authentication Key
1718
- * @type {string}
1719
- * @memberof DefaultApiGetParticipant
1720
- */
1721
- readonly xUserKey: string;
1722
- /**
1723
- * Conversation id
1724
- * @type {string}
1725
- * @memberof DefaultApiGetParticipant
1726
- */
1727
- readonly id: string;
1728
- /**
1729
- * User id
1730
- * @type {string}
1731
- * @memberof DefaultApiGetParticipant
1732
- */
1733
- readonly userId: string;
1734
- }
1735
- /**
1736
- * Request parameters for getUser operation in DefaultApi.
1737
- * @export
1738
- * @interface DefaultApiGetUserRequest
1739
- */
1740
- export interface DefaultApiGetUserRequest {
1741
- /**
1742
- * Authentication Key
1743
- * @type {string}
1744
- * @memberof DefaultApiGetUser
1745
- */
1746
- readonly xUserKey: string;
1747
- }
1748
- /**
1749
- * Request parameters for listConversationMessages operation in DefaultApi.
1750
- * @export
1751
- * @interface DefaultApiListConversationMessagesRequest
1752
- */
1753
- export interface DefaultApiListConversationMessagesRequest {
1754
- /**
1755
- * Authentication Key
1756
- * @type {string}
1757
- * @memberof DefaultApiListConversationMessages
1758
- */
1759
- readonly xUserKey: string;
1760
- /**
1761
- * Conversation id
1762
- * @type {string}
1763
- * @memberof DefaultApiListConversationMessages
1764
- */
1765
- readonly id: string;
1766
- /**
1767
- * Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
1768
- * @type {string}
1769
- * @memberof DefaultApiListConversationMessages
1770
- */
1771
- readonly nextToken?: string;
1772
- }
1773
- /**
1774
- * Request parameters for listConversations operation in DefaultApi.
1775
- * @export
1776
- * @interface DefaultApiListConversationsRequest
1777
- */
1778
- export interface DefaultApiListConversationsRequest {
1779
- /**
1780
- * Authentication Key
1781
- * @type {string}
1782
- * @memberof DefaultApiListConversations
1783
- */
1784
- readonly xUserKey: string;
1785
- /**
1786
- * Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
1787
- * @type {string}
1788
- * @memberof DefaultApiListConversations
1789
- */
1790
- readonly nextToken?: string;
1791
- }
1792
- /**
1793
- * Request parameters for listParticipants operation in DefaultApi.
1794
- * @export
1795
- * @interface DefaultApiListParticipantsRequest
1796
- */
1797
- export interface DefaultApiListParticipantsRequest {
1798
- /**
1799
- * Authentication Key
1800
- * @type {string}
1801
- * @memberof DefaultApiListParticipants
1802
- */
1803
- readonly xUserKey: string;
1804
- /**
1805
- * Conversation id
1806
- * @type {string}
1807
- * @memberof DefaultApiListParticipants
1808
- */
1809
- readonly id: string;
1810
- /**
1811
- * Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
1812
- * @type {string}
1813
- * @memberof DefaultApiListParticipants
1814
- */
1815
- readonly nextToken?: string;
1816
- }
1817
- /**
1818
- * Request parameters for listenConversation operation in DefaultApi.
1819
- * @export
1820
- * @interface DefaultApiListenConversationRequest
1821
- */
1822
- export interface DefaultApiListenConversationRequest {
1823
- /**
1824
- * Authentication Key
1825
- * @type {string}
1826
- * @memberof DefaultApiListenConversation
1827
- */
1828
- readonly xUserKey: string;
1829
- /**
1830
- * Conversation id
1831
- * @type {string}
1832
- * @memberof DefaultApiListenConversation
1833
- */
1834
- readonly id: string;
1835
- }
1836
- /**
1837
- * Request parameters for removeParticipant operation in DefaultApi.
1838
- * @export
1839
- * @interface DefaultApiRemoveParticipantRequest
1840
- */
1841
- export interface DefaultApiRemoveParticipantRequest {
1842
- /**
1843
- * Authentication Key
1844
- * @type {string}
1845
- * @memberof DefaultApiRemoveParticipant
1846
- */
1847
- readonly xUserKey: string;
1848
- /**
1849
- * Conversation id
1850
- * @type {string}
1851
- * @memberof DefaultApiRemoveParticipant
1852
- */
1853
- readonly id: string;
1854
- /**
1855
- * User id
1856
- * @type {string}
1857
- * @memberof DefaultApiRemoveParticipant
1858
- */
1859
- readonly userId: string;
1860
- }
1861
- /**
1862
- * Request parameters for updateUser operation in DefaultApi.
1863
- * @export
1864
- * @interface DefaultApiUpdateUserRequest
1865
- */
1866
- export interface DefaultApiUpdateUserRequest {
1867
- /**
1868
- * Authentication Key
1869
- * @type {string}
1870
- * @memberof DefaultApiUpdateUser
1871
- */
1872
- readonly xUserKey: string;
1873
- /**
1874
- * User data
1875
- * @type {UpdateUserBody}
1876
- * @memberof DefaultApiUpdateUser
1877
- */
1878
- readonly updateUserBody?: UpdateUserBody;
1879
- }
1880
- /**
1881
- * DefaultApi - object-oriented interface
1882
- * @export
1883
- * @class DefaultApi
1884
- * @extends {BaseAPI}
1885
- */
1886
- export declare class DefaultApi extends BaseAPI {
1887
- /**
1888
- * Add a [Participant](#schema_user) to a [Conversation](#schema_conversation).
1889
- * @param {DefaultApiAddParticipantRequest} requestParameters Request parameters.
1890
- * @param {*} [options] Override http request option.
1891
- * @throws {RequiredError}
1892
- * @memberof DefaultApi
1893
- */
1894
- addParticipant(requestParameters: DefaultApiAddParticipantRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AddParticipantResponse, any>>;
1895
- /**
1896
- * Creates a new [Conversation](#schema_conversation)
1897
- * @param {DefaultApiCreateConversationRequest} requestParameters Request parameters.
1898
- * @param {*} [options] Override http request option.
1899
- * @throws {RequiredError}
1900
- * @memberof DefaultApi
1901
- */
1902
- createConversation(requestParameters: DefaultApiCreateConversationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateConversationResponse, any>>;
1903
- /**
1904
- * Creates a new [Event](#schema_event)
1905
- * @param {DefaultApiCreateEventRequest} requestParameters Request parameters.
1906
- * @param {*} [options] Override http request option.
1907
- * @throws {RequiredError}
1908
- * @memberof DefaultApi
1909
- */
1910
- createEvent(requestParameters: DefaultApiCreateEventRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateEventResponse, any>>;
1911
- /**
1912
- * Creates a new [Message](#schema_message)
1913
- * @param {DefaultApiCreateMessageRequest} requestParameters Request parameters.
1914
- * @param {*} [options] Override http request option.
1915
- * @throws {RequiredError}
1916
- * @memberof DefaultApi
1917
- */
1918
- createMessage(requestParameters: DefaultApiCreateMessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateMessageResponse, any>>;
1919
- /**
1920
- * Creates a new [User](#schema_user)
1921
- * @param {DefaultApiCreateUserRequest} requestParameters Request parameters.
1922
- * @param {*} [options] Override http request option.
1923
- * @throws {RequiredError}
1924
- * @memberof DefaultApi
1925
- */
1926
- createUser(requestParameters?: DefaultApiCreateUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateUserResponse, any>>;
1927
- /**
1928
- * Permanently deletes a [Conversation](#schema_conversation). It cannot be undone. Also immediately deletes corresponding [Messages](#schema_message).
1929
- * @param {DefaultApiDeleteConversationRequest} requestParameters Request parameters.
1930
- * @param {*} [options] Override http request option.
1931
- * @throws {RequiredError}
1932
- * @memberof DefaultApi
1933
- */
1934
- deleteConversation(requestParameters: DefaultApiDeleteConversationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
1935
- /**
1936
- * Permanently deletes a [Message](#schema_message). It cannot be undone.
1937
- * @param {DefaultApiDeleteMessageRequest} requestParameters Request parameters.
1938
- * @param {*} [options] Override http request option.
1939
- * @throws {RequiredError}
1940
- * @memberof DefaultApi
1941
- */
1942
- deleteMessage(requestParameters: DefaultApiDeleteMessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
1943
- /**
1944
- * Permanently deletes a [User](#schema_user). It cannot be undone.
1945
- * @param {DefaultApiDeleteUserRequest} requestParameters Request parameters.
1946
- * @param {*} [options] Override http request option.
1947
- * @throws {RequiredError}
1948
- * @memberof DefaultApi
1949
- */
1950
- deleteUser(requestParameters: DefaultApiDeleteUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
1951
- /**
1952
- * Retrieves the [Conversation](#schema_conversation) object for a valid identifier.
1953
- * @param {DefaultApiGetConversationRequest} requestParameters Request parameters.
1954
- * @param {*} [options] Override http request option.
1955
- * @throws {RequiredError}
1956
- * @memberof DefaultApi
1957
- */
1958
- getConversation(requestParameters: DefaultApiGetConversationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetConversationResponse, any>>;
1959
- /**
1960
- * Retrieves the [Event](#schema_event) object for a valid identifier.
1961
- * @param {DefaultApiGetEventRequest} requestParameters Request parameters.
1962
- * @param {*} [options] Override http request option.
1963
- * @throws {RequiredError}
1964
- * @memberof DefaultApi
1965
- */
1966
- getEvent(requestParameters: DefaultApiGetEventRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventResponse, any>>;
1967
- /**
1968
- * Retrieves the [Message](#schema_message) object for a valid identifier.
1969
- * @param {DefaultApiGetMessageRequest} requestParameters Request parameters.
1970
- * @param {*} [options] Override http request option.
1971
- * @throws {RequiredError}
1972
- * @memberof DefaultApi
1973
- */
1974
- getMessage(requestParameters: DefaultApiGetMessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMessageResponse, any>>;
1975
- /**
1976
- * Retrieves a [Participant](#schema_user) from a [Conversation](#schema_conversation).
1977
- * @param {DefaultApiGetParticipantRequest} requestParameters Request parameters.
1978
- * @param {*} [options] Override http request option.
1979
- * @throws {RequiredError}
1980
- * @memberof DefaultApi
1981
- */
1982
- getParticipant(requestParameters: DefaultApiGetParticipantRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetParticipantResponse, any>>;
1983
- /**
1984
- * Retrieves the [User](#schema_user) object for a valid identifier.
1985
- * @param {DefaultApiGetUserRequest} requestParameters Request parameters.
1986
- * @param {*} [options] Override http request option.
1987
- * @throws {RequiredError}
1988
- * @memberof DefaultApi
1989
- */
1990
- getUser(requestParameters: DefaultApiGetUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserResponse, any>>;
1991
- /**
1992
- * Retrieves the conversation\'s [Messages](#schema_message)
1993
- * @param {DefaultApiListConversationMessagesRequest} requestParameters Request parameters.
1994
- * @param {*} [options] Override http request option.
1995
- * @throws {RequiredError}
1996
- * @memberof DefaultApi
1997
- */
1998
- listConversationMessages(requestParameters: DefaultApiListConversationMessagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListConversationMessagesResponse, any>>;
1999
- /**
2000
- * Returns a list of [Conversation](#schema_conversation) objects
2001
- * @param {DefaultApiListConversationsRequest} requestParameters Request parameters.
2002
- * @param {*} [options] Override http request option.
2003
- * @throws {RequiredError}
2004
- * @memberof DefaultApi
2005
- */
2006
- listConversations(requestParameters: DefaultApiListConversationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListConversationsResponse, any>>;
2007
- /**
2008
- * Retrieves a list of [Participants](#schema_user) for a given [Conversation](#schema_conversation).
2009
- * @param {DefaultApiListParticipantsRequest} requestParameters Request parameters.
2010
- * @param {*} [options] Override http request option.
2011
- * @throws {RequiredError}
2012
- * @memberof DefaultApi
2013
- */
2014
- listParticipants(requestParameters: DefaultApiListParticipantsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListParticipantsResponse, any>>;
2015
- /**
2016
- * Creates a SSE stream to receive messages and events from a conversation
2017
- * @param {DefaultApiListenConversationRequest} requestParameters Request parameters.
2018
- * @param {*} [options] Override http request option.
2019
- * @throws {RequiredError}
2020
- * @memberof DefaultApi
2021
- */
2022
- listenConversation(requestParameters: DefaultApiListenConversationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
2023
- /**
2024
- * Remove a [Participant](#schema_user) from a [Conversation](#schema_conversation).
2025
- * @param {DefaultApiRemoveParticipantRequest} requestParameters Request parameters.
2026
- * @param {*} [options] Override http request option.
2027
- * @throws {RequiredError}
2028
- * @memberof DefaultApi
2029
- */
2030
- removeParticipant(requestParameters: DefaultApiRemoveParticipantRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
2031
- /**
2032
- * Update [User](#schema_user)
2033
- * @param {DefaultApiUpdateUserRequest} requestParameters Request parameters.
2034
- * @param {*} [options] Override http request option.
2035
- * @throws {RequiredError}
2036
- * @memberof DefaultApi
2037
- */
2038
- updateUser(requestParameters: DefaultApiUpdateUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateUserResponse, any>>;
2039
- }