@botpress/webchat 1.3.2 → 1.3.4

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