@botpress/api 0.2.0

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.
@@ -0,0 +1,4015 @@
1
+ export declare const state: {
2
+ operations: {
3
+ createConversation: {
4
+ name: string;
5
+ description: string;
6
+ method: "post";
7
+ path: string;
8
+ requestBody: {
9
+ description: string;
10
+ schema: {
11
+ type: "object";
12
+ properties: {
13
+ channel: {
14
+ type: "string";
15
+ description: string;
16
+ };
17
+ tags: {
18
+ type: "object";
19
+ additionalProperties: {
20
+ type: "string";
21
+ maxLength: number;
22
+ };
23
+ description: string;
24
+ };
25
+ integrationName: {
26
+ type: "string";
27
+ description: string;
28
+ };
29
+ };
30
+ required: string[];
31
+ title: string;
32
+ additionalProperties: false;
33
+ };
34
+ };
35
+ section: "conversation";
36
+ response: {
37
+ description: string;
38
+ status: 201;
39
+ schema: {
40
+ type: "object";
41
+ properties: {
42
+ conversation: {
43
+ $ref: string;
44
+ };
45
+ };
46
+ required: string[];
47
+ title: string;
48
+ additionalProperties: false;
49
+ };
50
+ };
51
+ parameters: {};
52
+ };
53
+ getConversation: {
54
+ name: string;
55
+ description: string;
56
+ method: "get";
57
+ path: string;
58
+ parameters: {
59
+ id: {
60
+ in: "path";
61
+ type: "string";
62
+ description: string;
63
+ };
64
+ };
65
+ section: "conversation";
66
+ response: {
67
+ description: string;
68
+ schema: {
69
+ type: "object";
70
+ properties: {
71
+ conversation: {
72
+ $ref: string;
73
+ };
74
+ };
75
+ required: string[];
76
+ title: string;
77
+ additionalProperties: false;
78
+ };
79
+ };
80
+ };
81
+ listConversations: {
82
+ name: string;
83
+ description: string;
84
+ method: "get";
85
+ path: string;
86
+ parameters: {
87
+ nextToken: {
88
+ in: "query";
89
+ description: string;
90
+ type: "string";
91
+ };
92
+ tags: {
93
+ in: "query";
94
+ type: "object";
95
+ schema: {
96
+ type: "object";
97
+ additionalProperties: {
98
+ type: "string";
99
+ };
100
+ };
101
+ description: string;
102
+ };
103
+ participantIds: {
104
+ in: "query";
105
+ type: "string[]";
106
+ description: string;
107
+ };
108
+ };
109
+ section: "conversation";
110
+ response: {
111
+ description: string;
112
+ schema: {
113
+ type: "object";
114
+ properties: {
115
+ conversations: {
116
+ type: "array";
117
+ items: {
118
+ $ref: string;
119
+ };
120
+ };
121
+ meta: {
122
+ type: "object";
123
+ properties: {
124
+ nextToken: {
125
+ type: "string";
126
+ description: string;
127
+ };
128
+ };
129
+ additionalProperties: false;
130
+ };
131
+ };
132
+ required: string[];
133
+ title: string;
134
+ additionalProperties: false;
135
+ };
136
+ };
137
+ };
138
+ getOrCreateConversation: {
139
+ name: string;
140
+ description: string;
141
+ method: "post";
142
+ path: string;
143
+ requestBody: {
144
+ description: string;
145
+ schema: {
146
+ type: "object";
147
+ properties: {
148
+ channel: {
149
+ type: "string";
150
+ description: string;
151
+ };
152
+ tags: {
153
+ type: "object";
154
+ additionalProperties: {
155
+ type: "string";
156
+ maxLength: number;
157
+ };
158
+ description: string;
159
+ };
160
+ integrationName: {
161
+ type: "string";
162
+ description: string;
163
+ };
164
+ };
165
+ required: string[];
166
+ title: string;
167
+ additionalProperties: false;
168
+ };
169
+ };
170
+ section: "conversation";
171
+ response: {
172
+ description: string;
173
+ schema: {
174
+ type: "object";
175
+ properties: {
176
+ conversation: {
177
+ $ref: string;
178
+ };
179
+ };
180
+ required: string[];
181
+ title: string;
182
+ additionalProperties: false;
183
+ };
184
+ };
185
+ parameters: {};
186
+ };
187
+ updateConversation: {
188
+ name: string;
189
+ description: string;
190
+ method: "put";
191
+ path: string;
192
+ parameters: {
193
+ id: {
194
+ in: "path";
195
+ type: "string";
196
+ description: string;
197
+ };
198
+ };
199
+ requestBody: {
200
+ description: string;
201
+ schema: {
202
+ type: "object";
203
+ properties: {
204
+ tags: {
205
+ type: "object";
206
+ additionalProperties: {
207
+ type: "string";
208
+ };
209
+ description: string;
210
+ };
211
+ participantIds: {
212
+ type: "array";
213
+ items: {
214
+ type: "string";
215
+ };
216
+ description: string;
217
+ };
218
+ };
219
+ required: string[];
220
+ title: string;
221
+ additionalProperties: false;
222
+ };
223
+ };
224
+ section: "conversation";
225
+ response: {
226
+ description: string;
227
+ schema: {
228
+ type: "object";
229
+ properties: {
230
+ conversation: {
231
+ $ref: string;
232
+ };
233
+ };
234
+ required: string[];
235
+ title: string;
236
+ additionalProperties: false;
237
+ };
238
+ };
239
+ };
240
+ deleteConversation: {
241
+ name: string;
242
+ description: string;
243
+ method: "delete";
244
+ path: string;
245
+ parameters: {
246
+ id: {
247
+ in: "path";
248
+ type: "string";
249
+ description: string;
250
+ };
251
+ };
252
+ section: "conversation";
253
+ response: {
254
+ description: string;
255
+ schema: {
256
+ type: "object";
257
+ title: string;
258
+ additionalProperties: false;
259
+ };
260
+ };
261
+ };
262
+ createEvent: {
263
+ name: string;
264
+ description: string;
265
+ method: "post";
266
+ path: string;
267
+ section: "event";
268
+ requestBody: {
269
+ description: string;
270
+ schema: {
271
+ type: "object";
272
+ properties: {
273
+ type: {
274
+ type: "string";
275
+ description: string;
276
+ };
277
+ payload: {
278
+ type: "object";
279
+ additionalProperties: true;
280
+ description: string;
281
+ };
282
+ schedule: {
283
+ type: "object";
284
+ properties: {
285
+ dateTime: {
286
+ type: "string";
287
+ description: string;
288
+ };
289
+ delay: {
290
+ type: "number";
291
+ description: string;
292
+ };
293
+ };
294
+ description: string;
295
+ additionalProperties: false;
296
+ };
297
+ };
298
+ required: string[];
299
+ title: string;
300
+ additionalProperties: false;
301
+ };
302
+ };
303
+ response: {
304
+ description: string;
305
+ status: 201;
306
+ schema: {
307
+ type: "object";
308
+ properties: {
309
+ event: {
310
+ $ref: string;
311
+ };
312
+ };
313
+ required: string[];
314
+ title: string;
315
+ additionalProperties: false;
316
+ };
317
+ };
318
+ parameters: {};
319
+ };
320
+ getEvent: {
321
+ name: string;
322
+ description: string;
323
+ method: "get";
324
+ path: string;
325
+ parameters: {
326
+ id: {
327
+ in: "path";
328
+ type: "string";
329
+ description: string;
330
+ };
331
+ };
332
+ section: "event";
333
+ response: {
334
+ description: string;
335
+ schema: {
336
+ type: "object";
337
+ properties: {
338
+ event: {
339
+ $ref: string;
340
+ };
341
+ };
342
+ required: string[];
343
+ title: string;
344
+ additionalProperties: false;
345
+ };
346
+ };
347
+ };
348
+ listEvents: {
349
+ name: string;
350
+ description: string;
351
+ method: "get";
352
+ path: string;
353
+ section: "event";
354
+ parameters: {
355
+ nextToken: {
356
+ in: "query";
357
+ description: string;
358
+ type: "string";
359
+ };
360
+ type: {
361
+ in: "query";
362
+ type: "string";
363
+ description: string;
364
+ };
365
+ };
366
+ response: {
367
+ description: string;
368
+ schema: {
369
+ type: "object";
370
+ properties: {
371
+ events: {
372
+ type: "array";
373
+ items: {
374
+ $ref: string;
375
+ };
376
+ };
377
+ meta: {
378
+ type: "object";
379
+ properties: {
380
+ nextToken: {
381
+ type: "string";
382
+ description: string;
383
+ };
384
+ };
385
+ additionalProperties: false;
386
+ };
387
+ };
388
+ required: string[];
389
+ title: string;
390
+ additionalProperties: false;
391
+ };
392
+ };
393
+ };
394
+ createMessage: {
395
+ name: string;
396
+ description: string;
397
+ method: "post";
398
+ path: string;
399
+ requestBody: {
400
+ description: string;
401
+ schema: {
402
+ type: "object";
403
+ properties: {
404
+ payload: {
405
+ type: "object";
406
+ additionalProperties: true;
407
+ description: string;
408
+ };
409
+ userId: {
410
+ type: "string";
411
+ description: string;
412
+ };
413
+ conversationId: {
414
+ type: "string";
415
+ description: string;
416
+ };
417
+ type: {
418
+ type: "string";
419
+ description: string;
420
+ };
421
+ tags: {
422
+ type: "object";
423
+ additionalProperties: {
424
+ type: "string";
425
+ maxLength: number;
426
+ };
427
+ description: string;
428
+ };
429
+ schedule: {
430
+ type: "object";
431
+ properties: {
432
+ dateTime: {
433
+ type: "string";
434
+ description: string;
435
+ };
436
+ delay: {
437
+ type: "number";
438
+ description: string;
439
+ };
440
+ };
441
+ description: string;
442
+ additionalProperties: false;
443
+ };
444
+ };
445
+ required: string[];
446
+ title: string;
447
+ additionalProperties: false;
448
+ };
449
+ };
450
+ section: "message";
451
+ response: {
452
+ description: string;
453
+ status: 201;
454
+ schema: {
455
+ type: "object";
456
+ properties: {
457
+ message: {
458
+ $ref: string;
459
+ };
460
+ };
461
+ required: string[];
462
+ title: string;
463
+ additionalProperties: false;
464
+ };
465
+ };
466
+ parameters: {};
467
+ };
468
+ getOrCreateMessage: {
469
+ name: string;
470
+ description: string;
471
+ method: "post";
472
+ path: string;
473
+ requestBody: {
474
+ description: string;
475
+ schema: {
476
+ type: "object";
477
+ properties: {
478
+ payload: {
479
+ type: "object";
480
+ additionalProperties: true;
481
+ description: string;
482
+ };
483
+ userId: {
484
+ type: "string";
485
+ description: string;
486
+ };
487
+ conversationId: {
488
+ type: "string";
489
+ description: string;
490
+ };
491
+ type: {
492
+ type: "string";
493
+ description: string;
494
+ };
495
+ tags: {
496
+ type: "object";
497
+ additionalProperties: {
498
+ type: "string";
499
+ maxLength: number;
500
+ };
501
+ description: string;
502
+ };
503
+ schedule: {
504
+ type: "object";
505
+ properties: {
506
+ dateTime: {
507
+ type: "string";
508
+ description: string;
509
+ };
510
+ delay: {
511
+ type: "number";
512
+ description: string;
513
+ };
514
+ };
515
+ description: string;
516
+ additionalProperties: false;
517
+ };
518
+ };
519
+ required: string[];
520
+ title: string;
521
+ additionalProperties: false;
522
+ };
523
+ };
524
+ section: "message";
525
+ response: {
526
+ description: string;
527
+ schema: {
528
+ type: "object";
529
+ properties: {
530
+ message: {
531
+ $ref: string;
532
+ };
533
+ };
534
+ required: string[];
535
+ title: string;
536
+ additionalProperties: false;
537
+ };
538
+ };
539
+ parameters: {};
540
+ };
541
+ getMessage: {
542
+ name: string;
543
+ description: string;
544
+ method: "get";
545
+ path: string;
546
+ parameters: {
547
+ id: {
548
+ in: "path";
549
+ type: "string";
550
+ description: string;
551
+ };
552
+ };
553
+ section: "message";
554
+ response: {
555
+ description: string;
556
+ schema: {
557
+ type: "object";
558
+ properties: {
559
+ message: {
560
+ $ref: string;
561
+ };
562
+ };
563
+ required: string[];
564
+ title: string;
565
+ additionalProperties: false;
566
+ };
567
+ };
568
+ };
569
+ updateMessage: {
570
+ name: string;
571
+ description: string;
572
+ method: "put";
573
+ path: string;
574
+ parameters: {
575
+ id: {
576
+ in: "path";
577
+ type: "string";
578
+ description: string;
579
+ };
580
+ };
581
+ section: "message";
582
+ requestBody: {
583
+ description: string;
584
+ schema: {
585
+ type: "object";
586
+ properties: {
587
+ tags: {
588
+ type: "object";
589
+ additionalProperties: {
590
+ type: "string";
591
+ };
592
+ description: string;
593
+ };
594
+ };
595
+ required: string[];
596
+ title: string;
597
+ additionalProperties: false;
598
+ };
599
+ };
600
+ response: {
601
+ description: string;
602
+ schema: {
603
+ type: "object";
604
+ properties: {
605
+ message: {
606
+ $ref: string;
607
+ };
608
+ };
609
+ required: string[];
610
+ title: string;
611
+ additionalProperties: false;
612
+ };
613
+ };
614
+ };
615
+ listMessages: {
616
+ name: string;
617
+ description: string;
618
+ method: "get";
619
+ path: string;
620
+ parameters: {
621
+ nextToken: {
622
+ in: "query";
623
+ description: string;
624
+ type: "string";
625
+ };
626
+ conversationId: {
627
+ in: "query";
628
+ type: "string";
629
+ description: string;
630
+ };
631
+ tags: {
632
+ in: "query";
633
+ type: "object";
634
+ schema: {
635
+ type: "object";
636
+ additionalProperties: {
637
+ type: "string";
638
+ };
639
+ };
640
+ description: string;
641
+ };
642
+ };
643
+ section: "message";
644
+ response: {
645
+ description: string;
646
+ schema: {
647
+ type: "object";
648
+ properties: {
649
+ messages: {
650
+ type: "array";
651
+ items: {
652
+ $ref: string;
653
+ };
654
+ };
655
+ meta: {
656
+ type: "object";
657
+ properties: {
658
+ nextToken: {
659
+ type: "string";
660
+ description: string;
661
+ };
662
+ };
663
+ additionalProperties: false;
664
+ };
665
+ };
666
+ required: string[];
667
+ title: string;
668
+ additionalProperties: false;
669
+ };
670
+ };
671
+ };
672
+ deleteMessage: {
673
+ name: string;
674
+ description: string;
675
+ method: "delete";
676
+ path: string;
677
+ parameters: {
678
+ id: {
679
+ in: "path";
680
+ type: "string";
681
+ description: string;
682
+ };
683
+ };
684
+ section: "message";
685
+ response: {
686
+ description: string;
687
+ schema: {
688
+ type: "object";
689
+ title: string;
690
+ additionalProperties: false;
691
+ };
692
+ };
693
+ };
694
+ createUser: {
695
+ name: string;
696
+ description: string;
697
+ method: "post";
698
+ path: string;
699
+ requestBody: {
700
+ description: string;
701
+ schema: {
702
+ type: "object";
703
+ properties: {
704
+ tags: {
705
+ type: "object";
706
+ additionalProperties: {
707
+ type: "string";
708
+ maxLength: number;
709
+ };
710
+ description: string;
711
+ };
712
+ integrationName: {
713
+ type: "string";
714
+ description: string;
715
+ };
716
+ };
717
+ required: string[];
718
+ title: string;
719
+ additionalProperties: false;
720
+ };
721
+ };
722
+ section: "user";
723
+ response: {
724
+ description: string;
725
+ status: 201;
726
+ schema: {
727
+ type: "object";
728
+ properties: {
729
+ user: {
730
+ $ref: string;
731
+ };
732
+ };
733
+ required: string[];
734
+ title: string;
735
+ additionalProperties: false;
736
+ };
737
+ };
738
+ parameters: {};
739
+ };
740
+ getUser: {
741
+ name: string;
742
+ description: string;
743
+ method: "get";
744
+ path: string;
745
+ parameters: {
746
+ id: {
747
+ in: "path";
748
+ type: "string";
749
+ description: string;
750
+ };
751
+ };
752
+ section: "user";
753
+ response: {
754
+ description: string;
755
+ schema: {
756
+ type: "object";
757
+ properties: {
758
+ user: {
759
+ $ref: string;
760
+ };
761
+ };
762
+ required: string[];
763
+ title: string;
764
+ additionalProperties: false;
765
+ };
766
+ };
767
+ };
768
+ listUsers: {
769
+ name: string;
770
+ description: string;
771
+ method: "get";
772
+ path: string;
773
+ parameters: {
774
+ nextToken: {
775
+ in: "query";
776
+ description: string;
777
+ type: "string";
778
+ };
779
+ conversationId: {
780
+ in: "query";
781
+ type: "string";
782
+ description: string;
783
+ };
784
+ tags: {
785
+ in: "query";
786
+ type: "object";
787
+ schema: {
788
+ type: "object";
789
+ additionalProperties: {
790
+ type: "string";
791
+ };
792
+ };
793
+ description: string;
794
+ };
795
+ };
796
+ section: "user";
797
+ response: {
798
+ description: string;
799
+ schema: {
800
+ type: "object";
801
+ properties: {
802
+ users: {
803
+ type: "array";
804
+ items: {
805
+ $ref: string;
806
+ };
807
+ };
808
+ meta: {
809
+ type: "object";
810
+ properties: {
811
+ nextToken: {
812
+ type: "string";
813
+ description: string;
814
+ };
815
+ };
816
+ additionalProperties: false;
817
+ };
818
+ };
819
+ required: string[];
820
+ title: string;
821
+ additionalProperties: false;
822
+ };
823
+ };
824
+ };
825
+ getOrCreateUser: {
826
+ name: string;
827
+ description: string;
828
+ method: "post";
829
+ path: string;
830
+ requestBody: {
831
+ description: string;
832
+ schema: {
833
+ type: "object";
834
+ properties: {
835
+ tags: {
836
+ type: "object";
837
+ additionalProperties: {
838
+ type: "string";
839
+ maxLength: number;
840
+ };
841
+ description: string;
842
+ };
843
+ integrationName: {
844
+ type: "string";
845
+ description: string;
846
+ };
847
+ };
848
+ required: string[];
849
+ title: string;
850
+ additionalProperties: false;
851
+ };
852
+ };
853
+ section: "user";
854
+ response: {
855
+ description: string;
856
+ schema: {
857
+ type: "object";
858
+ properties: {
859
+ user: {
860
+ $ref: string;
861
+ };
862
+ };
863
+ required: string[];
864
+ title: string;
865
+ additionalProperties: false;
866
+ };
867
+ };
868
+ parameters: {};
869
+ };
870
+ updateUser: {
871
+ name: string;
872
+ description: string;
873
+ method: "put";
874
+ path: string;
875
+ parameters: {
876
+ id: {
877
+ in: "path";
878
+ type: "string";
879
+ description: string;
880
+ };
881
+ };
882
+ requestBody: {
883
+ description: string;
884
+ schema: {
885
+ type: "object";
886
+ properties: {
887
+ tags: {
888
+ type: "object";
889
+ additionalProperties: {
890
+ type: "string";
891
+ };
892
+ description: string;
893
+ };
894
+ };
895
+ required: string[];
896
+ title: string;
897
+ additionalProperties: false;
898
+ };
899
+ };
900
+ section: "user";
901
+ response: {
902
+ description: string;
903
+ schema: {
904
+ type: "object";
905
+ properties: {
906
+ user: {
907
+ $ref: string;
908
+ };
909
+ };
910
+ required: string[];
911
+ title: string;
912
+ additionalProperties: false;
913
+ };
914
+ };
915
+ };
916
+ deleteUser: {
917
+ name: string;
918
+ description: string;
919
+ method: "delete";
920
+ path: string;
921
+ parameters: {
922
+ id: {
923
+ in: "path";
924
+ type: "string";
925
+ description: string;
926
+ };
927
+ };
928
+ section: "user";
929
+ response: {
930
+ description: string;
931
+ schema: {
932
+ type: "object";
933
+ title: string;
934
+ additionalProperties: false;
935
+ };
936
+ };
937
+ };
938
+ getState: {
939
+ name: string;
940
+ description: string;
941
+ method: "get";
942
+ path: string;
943
+ parameters: {
944
+ type: {
945
+ in: "path";
946
+ type: "string";
947
+ description: string;
948
+ enum: string[];
949
+ };
950
+ id: {
951
+ in: "path";
952
+ type: "string";
953
+ description: string;
954
+ };
955
+ name: {
956
+ in: "path";
957
+ type: "string";
958
+ description: string;
959
+ };
960
+ };
961
+ section: "state";
962
+ response: {
963
+ description: string;
964
+ schema: {
965
+ type: "object";
966
+ properties: {
967
+ state: {
968
+ $ref: string;
969
+ };
970
+ };
971
+ required: string[];
972
+ title: string;
973
+ additionalProperties: false;
974
+ };
975
+ };
976
+ };
977
+ setState: {
978
+ name: string;
979
+ description: string;
980
+ method: "post";
981
+ path: string;
982
+ parameters: {
983
+ type: {
984
+ in: "path";
985
+ type: "string";
986
+ description: string;
987
+ enum: string[];
988
+ };
989
+ id: {
990
+ in: "path";
991
+ type: "string";
992
+ description: string;
993
+ };
994
+ name: {
995
+ in: "path";
996
+ type: "string";
997
+ description: string;
998
+ };
999
+ };
1000
+ requestBody: {
1001
+ description: string;
1002
+ schema: {
1003
+ type: "object";
1004
+ properties: {
1005
+ payload: {
1006
+ type: "object";
1007
+ additionalProperties: true;
1008
+ nullable: true;
1009
+ description: string;
1010
+ };
1011
+ expiry: {
1012
+ type: "number";
1013
+ minimum: number;
1014
+ description: string;
1015
+ };
1016
+ };
1017
+ required: string[];
1018
+ title: string;
1019
+ additionalProperties: false;
1020
+ };
1021
+ };
1022
+ section: "state";
1023
+ response: {
1024
+ description: string;
1025
+ schema: {
1026
+ type: "object";
1027
+ properties: {
1028
+ state: {
1029
+ $ref: string;
1030
+ };
1031
+ };
1032
+ required: string[];
1033
+ title: string;
1034
+ additionalProperties: false;
1035
+ };
1036
+ };
1037
+ };
1038
+ patchState: {
1039
+ name: string;
1040
+ description: string;
1041
+ method: "patch";
1042
+ path: string;
1043
+ parameters: {
1044
+ type: {
1045
+ in: "path";
1046
+ type: "string";
1047
+ description: string;
1048
+ enum: string[];
1049
+ };
1050
+ id: {
1051
+ in: "path";
1052
+ type: "string";
1053
+ description: string;
1054
+ };
1055
+ name: {
1056
+ in: "path";
1057
+ type: "string";
1058
+ description: string;
1059
+ };
1060
+ };
1061
+ requestBody: {
1062
+ description: string;
1063
+ schema: {
1064
+ type: "object";
1065
+ properties: {
1066
+ payload: {
1067
+ type: "object";
1068
+ additionalProperties: true;
1069
+ description: string;
1070
+ };
1071
+ };
1072
+ required: string[];
1073
+ title: string;
1074
+ additionalProperties: false;
1075
+ };
1076
+ };
1077
+ section: "state";
1078
+ response: {
1079
+ description: string;
1080
+ schema: {
1081
+ type: "object";
1082
+ properties: {
1083
+ state: {
1084
+ $ref: string;
1085
+ };
1086
+ };
1087
+ required: string[];
1088
+ title: string;
1089
+ additionalProperties: false;
1090
+ };
1091
+ };
1092
+ };
1093
+ callAction: {
1094
+ name: string;
1095
+ description: string;
1096
+ method: "post";
1097
+ path: string;
1098
+ section: "action";
1099
+ requestBody: {
1100
+ description: string;
1101
+ schema: {
1102
+ type: "object";
1103
+ properties: {
1104
+ type: {
1105
+ type: "string";
1106
+ description: string;
1107
+ };
1108
+ input: {
1109
+ type: "object";
1110
+ additionalProperties: true;
1111
+ description: string;
1112
+ };
1113
+ };
1114
+ required: string[];
1115
+ title: string;
1116
+ additionalProperties: false;
1117
+ };
1118
+ };
1119
+ response: {
1120
+ description: string;
1121
+ schema: {
1122
+ type: "object";
1123
+ properties: {
1124
+ output: {
1125
+ type: "object";
1126
+ additionalProperties: true;
1127
+ description: string;
1128
+ };
1129
+ };
1130
+ required: string[];
1131
+ title: string;
1132
+ additionalProperties: false;
1133
+ };
1134
+ };
1135
+ parameters: {};
1136
+ };
1137
+ configureIntegration: {
1138
+ name: string;
1139
+ description: string;
1140
+ method: "post";
1141
+ path: string;
1142
+ requestBody: {
1143
+ description: string;
1144
+ schema: {
1145
+ type: "object";
1146
+ properties: {
1147
+ identifier: {
1148
+ type: "string";
1149
+ description: string;
1150
+ };
1151
+ };
1152
+ required: string[];
1153
+ title: string;
1154
+ additionalProperties: false;
1155
+ };
1156
+ };
1157
+ response: {
1158
+ description: string;
1159
+ schema: {
1160
+ type: "object";
1161
+ title: string;
1162
+ additionalProperties: false;
1163
+ };
1164
+ };
1165
+ parameters: {};
1166
+ };
1167
+ listPublicIntegrations: {
1168
+ name: string;
1169
+ description: string;
1170
+ method: "get";
1171
+ section: "hub";
1172
+ path: string;
1173
+ disableDefaultParameters: {
1174
+ "x-workspace-id": boolean;
1175
+ };
1176
+ parameters: {
1177
+ nextToken: {
1178
+ in: "query";
1179
+ description: string;
1180
+ type: "string";
1181
+ };
1182
+ name: {
1183
+ type: "string";
1184
+ description: string;
1185
+ in: "query";
1186
+ };
1187
+ version: {
1188
+ type: "string";
1189
+ description: string;
1190
+ in: "query";
1191
+ };
1192
+ };
1193
+ response: {
1194
+ description: string;
1195
+ schema: {
1196
+ type: "object";
1197
+ properties: {
1198
+ integrations: {
1199
+ type: "array";
1200
+ items: {
1201
+ type: "object";
1202
+ properties: {
1203
+ id: {
1204
+ type: "string";
1205
+ description: string;
1206
+ };
1207
+ name: {
1208
+ type: "string";
1209
+ description: string;
1210
+ };
1211
+ version: {
1212
+ type: "string";
1213
+ description: string;
1214
+ };
1215
+ createdAt: {
1216
+ type: "string";
1217
+ format: string;
1218
+ description: string;
1219
+ };
1220
+ updatedAt: {
1221
+ type: "string";
1222
+ format: string;
1223
+ description: string;
1224
+ };
1225
+ title: {
1226
+ type: "string";
1227
+ minLength: number;
1228
+ maxLength: number;
1229
+ description: string;
1230
+ };
1231
+ description: {
1232
+ type: "string";
1233
+ maxLength: number;
1234
+ description: string;
1235
+ };
1236
+ iconUrl: {
1237
+ type: "string";
1238
+ description: string;
1239
+ };
1240
+ };
1241
+ required: string[];
1242
+ };
1243
+ };
1244
+ meta: {
1245
+ type: "object";
1246
+ properties: {
1247
+ nextToken: {
1248
+ type: "string";
1249
+ description: string;
1250
+ };
1251
+ };
1252
+ additionalProperties: false;
1253
+ };
1254
+ };
1255
+ required: string[];
1256
+ title: string;
1257
+ additionalProperties: false;
1258
+ };
1259
+ };
1260
+ };
1261
+ getPublicIntegrationById: {
1262
+ name: string;
1263
+ description: string;
1264
+ method: "get";
1265
+ section: "hub";
1266
+ path: string;
1267
+ disableDefaultParameters: {
1268
+ "x-workspace-id": boolean;
1269
+ };
1270
+ parameters: {
1271
+ id: {
1272
+ type: "string";
1273
+ description: string;
1274
+ in: "path";
1275
+ };
1276
+ };
1277
+ response: {
1278
+ description: string;
1279
+ schema: {
1280
+ type: "object";
1281
+ properties: {
1282
+ integration: {
1283
+ $ref: string;
1284
+ };
1285
+ };
1286
+ required: string[];
1287
+ title: string;
1288
+ additionalProperties: false;
1289
+ };
1290
+ };
1291
+ };
1292
+ getPublicIntegration: {
1293
+ name: string;
1294
+ description: string;
1295
+ method: "get";
1296
+ section: "hub";
1297
+ path: string;
1298
+ disableDefaultParameters: {
1299
+ "x-workspace-id": boolean;
1300
+ };
1301
+ parameters: {
1302
+ name: {
1303
+ type: "string";
1304
+ description: string;
1305
+ in: "path";
1306
+ };
1307
+ version: {
1308
+ type: "string";
1309
+ description: string;
1310
+ in: "path";
1311
+ };
1312
+ };
1313
+ response: {
1314
+ description: string;
1315
+ schema: {
1316
+ type: "object";
1317
+ properties: {
1318
+ integration: {
1319
+ $ref: string;
1320
+ };
1321
+ };
1322
+ required: string[];
1323
+ title: string;
1324
+ additionalProperties: false;
1325
+ };
1326
+ };
1327
+ };
1328
+ createBot: {
1329
+ name: string;
1330
+ description: string;
1331
+ method: "post";
1332
+ section: "bot";
1333
+ path: string;
1334
+ requestBody: {
1335
+ description: string;
1336
+ schema: {
1337
+ type: "object";
1338
+ properties: {
1339
+ states: {
1340
+ type: "object";
1341
+ additionalProperties: {
1342
+ type: "object";
1343
+ properties: {
1344
+ type: {
1345
+ type: "string";
1346
+ enum: string[];
1347
+ description: string;
1348
+ };
1349
+ schema: {
1350
+ type: "object";
1351
+ additionalProperties: true;
1352
+ description: string;
1353
+ };
1354
+ expiry: {
1355
+ type: "number";
1356
+ minimum: number;
1357
+ description: string;
1358
+ };
1359
+ };
1360
+ required: string[];
1361
+ additionalProperties: false;
1362
+ };
1363
+ description: string;
1364
+ };
1365
+ tags: {
1366
+ type: "object";
1367
+ properties: {
1368
+ messages: {
1369
+ default: never[];
1370
+ type: "array";
1371
+ items: {
1372
+ type: "string";
1373
+ };
1374
+ };
1375
+ conversations: {
1376
+ default: never[];
1377
+ type: "array";
1378
+ items: {
1379
+ type: "string";
1380
+ };
1381
+ };
1382
+ users: {
1383
+ default: never[];
1384
+ type: "array";
1385
+ items: {
1386
+ type: "string";
1387
+ };
1388
+ };
1389
+ };
1390
+ description: string;
1391
+ additionalProperties: false;
1392
+ };
1393
+ events: {
1394
+ type: "object";
1395
+ additionalProperties: {
1396
+ type: "object";
1397
+ properties: {
1398
+ schema: {
1399
+ type: "object";
1400
+ additionalProperties: true;
1401
+ };
1402
+ };
1403
+ required: string[];
1404
+ description: string;
1405
+ additionalProperties: false;
1406
+ };
1407
+ description: string;
1408
+ };
1409
+ recurringEvents: {
1410
+ type: "object";
1411
+ additionalProperties: {
1412
+ type: "object";
1413
+ properties: {
1414
+ schedule: {
1415
+ type: "object";
1416
+ properties: {
1417
+ cron: {
1418
+ type: "string";
1419
+ };
1420
+ };
1421
+ required: string[];
1422
+ additionalProperties: false;
1423
+ };
1424
+ type: {
1425
+ type: "string";
1426
+ };
1427
+ payload: {
1428
+ type: "object";
1429
+ additionalProperties: true;
1430
+ };
1431
+ };
1432
+ required: string[];
1433
+ additionalProperties: false;
1434
+ };
1435
+ description: string;
1436
+ };
1437
+ configuration: {
1438
+ type: "object";
1439
+ properties: {
1440
+ data: {
1441
+ type: "object";
1442
+ additionalProperties: true;
1443
+ description: string;
1444
+ };
1445
+ schema: {
1446
+ type: "object";
1447
+ additionalProperties: true;
1448
+ description: string;
1449
+ };
1450
+ };
1451
+ additionalProperties: false;
1452
+ };
1453
+ code: {
1454
+ type: "string";
1455
+ description: string;
1456
+ };
1457
+ name: {
1458
+ type: "string";
1459
+ minLength: number;
1460
+ description: string;
1461
+ };
1462
+ medias: {
1463
+ type: "array";
1464
+ items: {
1465
+ type: "object";
1466
+ properties: {
1467
+ url: {
1468
+ type: "string";
1469
+ };
1470
+ name: {
1471
+ type: "string";
1472
+ };
1473
+ };
1474
+ required: string[];
1475
+ };
1476
+ description: string;
1477
+ };
1478
+ url: {
1479
+ type: "string";
1480
+ description: string;
1481
+ };
1482
+ dev: {
1483
+ type: "boolean";
1484
+ description: string;
1485
+ };
1486
+ };
1487
+ title: string;
1488
+ additionalProperties: false;
1489
+ };
1490
+ };
1491
+ response: {
1492
+ description: string;
1493
+ schema: {
1494
+ type: "object";
1495
+ properties: {
1496
+ bot: {
1497
+ $ref: string;
1498
+ };
1499
+ };
1500
+ required: string[];
1501
+ title: string;
1502
+ additionalProperties: false;
1503
+ };
1504
+ };
1505
+ parameters: {};
1506
+ };
1507
+ updateBot: {
1508
+ name: string;
1509
+ description: string;
1510
+ method: "put";
1511
+ section: "bot";
1512
+ path: string;
1513
+ parameters: {
1514
+ id: {
1515
+ type: "string";
1516
+ description: string;
1517
+ in: "path";
1518
+ };
1519
+ };
1520
+ requestBody: {
1521
+ description: string;
1522
+ schema: {
1523
+ type: "object";
1524
+ properties: {
1525
+ url: {
1526
+ type: "string";
1527
+ description: string;
1528
+ };
1529
+ authentication: {
1530
+ type: "string";
1531
+ enum: string[];
1532
+ description: string;
1533
+ };
1534
+ states: {
1535
+ type: "object";
1536
+ additionalProperties: {
1537
+ type: "object";
1538
+ properties: {
1539
+ type: {
1540
+ type: "string";
1541
+ enum: string[];
1542
+ description: string;
1543
+ };
1544
+ schema: {
1545
+ type: "object";
1546
+ additionalProperties: true;
1547
+ description: string;
1548
+ };
1549
+ expiry: {
1550
+ type: "number";
1551
+ minimum: number;
1552
+ description: string;
1553
+ };
1554
+ };
1555
+ required: string[];
1556
+ additionalProperties: false;
1557
+ };
1558
+ description: string;
1559
+ };
1560
+ tags: {
1561
+ type: "object";
1562
+ properties: {
1563
+ messages: {
1564
+ default: never[];
1565
+ type: "array";
1566
+ items: {
1567
+ type: "string";
1568
+ };
1569
+ };
1570
+ conversations: {
1571
+ default: never[];
1572
+ type: "array";
1573
+ items: {
1574
+ type: "string";
1575
+ };
1576
+ };
1577
+ users: {
1578
+ default: never[];
1579
+ type: "array";
1580
+ items: {
1581
+ type: "string";
1582
+ };
1583
+ };
1584
+ };
1585
+ description: string;
1586
+ additionalProperties: false;
1587
+ };
1588
+ events: {
1589
+ type: "object";
1590
+ additionalProperties: {
1591
+ type: "object";
1592
+ properties: {
1593
+ schema: {
1594
+ type: "object";
1595
+ additionalProperties: true;
1596
+ };
1597
+ };
1598
+ required: string[];
1599
+ description: string;
1600
+ additionalProperties: false;
1601
+ };
1602
+ description: string;
1603
+ };
1604
+ recurringEvents: {
1605
+ type: "object";
1606
+ additionalProperties: {
1607
+ type: "object";
1608
+ properties: {
1609
+ schedule: {
1610
+ type: "object";
1611
+ properties: {
1612
+ cron: {
1613
+ type: "string";
1614
+ };
1615
+ };
1616
+ required: string[];
1617
+ additionalProperties: false;
1618
+ };
1619
+ type: {
1620
+ type: "string";
1621
+ };
1622
+ payload: {
1623
+ type: "object";
1624
+ additionalProperties: true;
1625
+ };
1626
+ };
1627
+ required: string[];
1628
+ additionalProperties: false;
1629
+ };
1630
+ description: string;
1631
+ };
1632
+ configuration: {
1633
+ type: "object";
1634
+ properties: {
1635
+ data: {
1636
+ type: "object";
1637
+ additionalProperties: true;
1638
+ description: string;
1639
+ };
1640
+ schema: {
1641
+ type: "object";
1642
+ additionalProperties: true;
1643
+ description: string;
1644
+ };
1645
+ };
1646
+ additionalProperties: false;
1647
+ };
1648
+ blocked: {
1649
+ type: "boolean";
1650
+ };
1651
+ integrations: {
1652
+ type: "object";
1653
+ additionalProperties: {
1654
+ type: "object";
1655
+ properties: {
1656
+ enabled: {
1657
+ type: "boolean";
1658
+ };
1659
+ configuration: {
1660
+ type: "object";
1661
+ additionalProperties: true;
1662
+ };
1663
+ };
1664
+ required: string[];
1665
+ nullable: true;
1666
+ additionalProperties: false;
1667
+ };
1668
+ };
1669
+ code: {
1670
+ type: "string";
1671
+ description: string;
1672
+ };
1673
+ name: {
1674
+ type: "string";
1675
+ minLength: number;
1676
+ description: string;
1677
+ };
1678
+ medias: {
1679
+ type: "array";
1680
+ items: {
1681
+ type: "object";
1682
+ properties: {
1683
+ url: {
1684
+ type: "string";
1685
+ };
1686
+ name: {
1687
+ type: "string";
1688
+ };
1689
+ };
1690
+ required: string[];
1691
+ };
1692
+ description: string;
1693
+ };
1694
+ };
1695
+ title: string;
1696
+ additionalProperties: false;
1697
+ };
1698
+ };
1699
+ response: {
1700
+ description: string;
1701
+ schema: {
1702
+ type: "object";
1703
+ properties: {
1704
+ bot: {
1705
+ $ref: string;
1706
+ };
1707
+ };
1708
+ required: string[];
1709
+ title: string;
1710
+ additionalProperties: false;
1711
+ };
1712
+ };
1713
+ };
1714
+ transferBot: {
1715
+ name: string;
1716
+ description: string;
1717
+ method: "post";
1718
+ section: "bot";
1719
+ path: string;
1720
+ parameters: {
1721
+ id: {
1722
+ type: "string";
1723
+ description: string;
1724
+ in: "path";
1725
+ };
1726
+ };
1727
+ requestBody: {
1728
+ description: string;
1729
+ schema: {
1730
+ type: "object";
1731
+ properties: {
1732
+ targetWorkspaceId: {
1733
+ type: "string";
1734
+ format: string;
1735
+ description: string;
1736
+ };
1737
+ };
1738
+ required: string[];
1739
+ title: string;
1740
+ additionalProperties: false;
1741
+ };
1742
+ };
1743
+ response: {
1744
+ description: string;
1745
+ schema: {
1746
+ type: "object";
1747
+ title: string;
1748
+ additionalProperties: false;
1749
+ };
1750
+ };
1751
+ };
1752
+ listBots: {
1753
+ name: string;
1754
+ description: string;
1755
+ method: "get";
1756
+ path: string;
1757
+ parameters: {
1758
+ nextToken: {
1759
+ in: "query";
1760
+ description: string;
1761
+ type: "string";
1762
+ };
1763
+ };
1764
+ section: "bot";
1765
+ response: {
1766
+ description: string;
1767
+ schema: {
1768
+ type: "object";
1769
+ properties: {
1770
+ bots: {
1771
+ type: "array";
1772
+ items: {
1773
+ type: "object";
1774
+ properties: {
1775
+ id: {
1776
+ type: "string";
1777
+ format: string;
1778
+ description: string;
1779
+ };
1780
+ createdAt: {
1781
+ type: "string";
1782
+ format: string;
1783
+ description: string;
1784
+ };
1785
+ updatedAt: {
1786
+ type: "string";
1787
+ format: string;
1788
+ description: string;
1789
+ };
1790
+ name: {
1791
+ type: "string";
1792
+ };
1793
+ deployedAt: {
1794
+ type: "string";
1795
+ format: string;
1796
+ };
1797
+ };
1798
+ required: string[];
1799
+ };
1800
+ };
1801
+ meta: {
1802
+ type: "object";
1803
+ properties: {
1804
+ nextToken: {
1805
+ type: "string";
1806
+ description: string;
1807
+ };
1808
+ };
1809
+ additionalProperties: false;
1810
+ };
1811
+ };
1812
+ required: string[];
1813
+ title: string;
1814
+ additionalProperties: false;
1815
+ };
1816
+ };
1817
+ };
1818
+ getBot: {
1819
+ name: string;
1820
+ description: string;
1821
+ method: "get";
1822
+ section: "bot";
1823
+ path: string;
1824
+ parameters: {
1825
+ id: {
1826
+ type: "string";
1827
+ description: string;
1828
+ in: "path";
1829
+ };
1830
+ };
1831
+ response: {
1832
+ description: string;
1833
+ schema: {
1834
+ type: "object";
1835
+ properties: {
1836
+ bot: {
1837
+ $ref: string;
1838
+ };
1839
+ };
1840
+ required: string[];
1841
+ title: string;
1842
+ additionalProperties: false;
1843
+ };
1844
+ };
1845
+ };
1846
+ deleteBot: {
1847
+ name: string;
1848
+ description: string;
1849
+ method: "delete";
1850
+ path: string;
1851
+ section: "bot";
1852
+ parameters: {
1853
+ id: {
1854
+ type: "string";
1855
+ description: string;
1856
+ in: "path";
1857
+ };
1858
+ };
1859
+ response: {
1860
+ description: string;
1861
+ schema: {
1862
+ type: "object";
1863
+ title: string;
1864
+ additionalProperties: false;
1865
+ };
1866
+ };
1867
+ };
1868
+ getBotLogs: {
1869
+ name: string;
1870
+ description: string;
1871
+ method: "get";
1872
+ path: string;
1873
+ section: "bot";
1874
+ parameters: {
1875
+ id: {
1876
+ type: "string";
1877
+ description: string;
1878
+ in: "path";
1879
+ };
1880
+ };
1881
+ response: {
1882
+ description: string;
1883
+ schema: {
1884
+ type: "object";
1885
+ properties: {
1886
+ logs: {
1887
+ type: "array";
1888
+ items: {
1889
+ type: "object";
1890
+ properties: {
1891
+ timestamp: {
1892
+ type: "string";
1893
+ };
1894
+ level: {
1895
+ type: "string";
1896
+ };
1897
+ message: {
1898
+ type: "string";
1899
+ };
1900
+ };
1901
+ required: string[];
1902
+ };
1903
+ };
1904
+ };
1905
+ required: string[];
1906
+ title: string;
1907
+ additionalProperties: false;
1908
+ };
1909
+ };
1910
+ };
1911
+ getBotWebchat: {
1912
+ name: string;
1913
+ description: string;
1914
+ method: "get";
1915
+ path: string;
1916
+ section: "bot";
1917
+ parameters: {
1918
+ id: {
1919
+ type: "string";
1920
+ description: string;
1921
+ in: "path";
1922
+ };
1923
+ type: {
1924
+ in: "query";
1925
+ description: string;
1926
+ type: "string";
1927
+ required: true;
1928
+ enum: string[];
1929
+ };
1930
+ };
1931
+ response: {
1932
+ description: string;
1933
+ schema: {
1934
+ type: "object";
1935
+ properties: {
1936
+ code: {
1937
+ type: "string";
1938
+ };
1939
+ };
1940
+ required: string[];
1941
+ title: string;
1942
+ additionalProperties: false;
1943
+ };
1944
+ };
1945
+ };
1946
+ getBotAnalytics: {
1947
+ name: string;
1948
+ description: string;
1949
+ method: "get";
1950
+ path: string;
1951
+ section: "bot";
1952
+ parameters: {
1953
+ id: {
1954
+ type: "string";
1955
+ description: string;
1956
+ in: "path";
1957
+ };
1958
+ startDate: {
1959
+ in: "query";
1960
+ description: string;
1961
+ type: "string";
1962
+ required: true;
1963
+ };
1964
+ endDate: {
1965
+ in: "query";
1966
+ description: string;
1967
+ type: "string";
1968
+ required: true;
1969
+ };
1970
+ };
1971
+ response: {
1972
+ description: string;
1973
+ schema: {
1974
+ type: "object";
1975
+ properties: {
1976
+ records: {
1977
+ type: "array";
1978
+ items: {
1979
+ type: "object";
1980
+ properties: {
1981
+ startDateTimeUtc: {
1982
+ type: "string";
1983
+ description: string;
1984
+ };
1985
+ endDateTimeUtc: {
1986
+ type: "string";
1987
+ description: string;
1988
+ };
1989
+ returningUsers: {
1990
+ type: "number";
1991
+ };
1992
+ newUsers: {
1993
+ type: "number";
1994
+ };
1995
+ sessions: {
1996
+ type: "number";
1997
+ };
1998
+ messages: {
1999
+ type: "number";
2000
+ };
2001
+ };
2002
+ required: string[];
2003
+ };
2004
+ };
2005
+ };
2006
+ required: string[];
2007
+ title: string;
2008
+ additionalProperties: false;
2009
+ };
2010
+ };
2011
+ };
2012
+ getWorkspace: {
2013
+ name: string;
2014
+ description: string;
2015
+ method: "get";
2016
+ path: string;
2017
+ disableDefaultParameters: {
2018
+ "x-workspace-id": boolean;
2019
+ };
2020
+ parameters: {
2021
+ id: {
2022
+ type: "string";
2023
+ description: string;
2024
+ in: "path";
2025
+ };
2026
+ };
2027
+ response: {
2028
+ description: string;
2029
+ schema: {
2030
+ type: "object";
2031
+ properties: {
2032
+ id: {
2033
+ type: "string";
2034
+ };
2035
+ name: {
2036
+ type: "string";
2037
+ };
2038
+ ownerId: {
2039
+ type: "string";
2040
+ };
2041
+ createdAt: {
2042
+ type: "string";
2043
+ };
2044
+ updatedAt: {
2045
+ type: "string";
2046
+ };
2047
+ accountType: {
2048
+ type: "string";
2049
+ };
2050
+ blocked: {
2051
+ type: "boolean";
2052
+ };
2053
+ spendingLimit: {
2054
+ type: "number";
2055
+ };
2056
+ };
2057
+ required: string[];
2058
+ title: string;
2059
+ additionalProperties: false;
2060
+ };
2061
+ };
2062
+ };
2063
+ listWorkspaces: {
2064
+ name: string;
2065
+ description: string;
2066
+ method: "get";
2067
+ path: string;
2068
+ disableDefaultParameters: {
2069
+ "x-workspace-id": boolean;
2070
+ };
2071
+ parameters: {
2072
+ nextToken: {
2073
+ in: "query";
2074
+ description: string;
2075
+ type: "string";
2076
+ };
2077
+ };
2078
+ response: {
2079
+ description: string;
2080
+ schema: {
2081
+ type: "object";
2082
+ properties: {
2083
+ workspaces: {
2084
+ type: "array";
2085
+ items: {
2086
+ type: "object";
2087
+ properties: {
2088
+ id: {
2089
+ type: "string";
2090
+ };
2091
+ name: {
2092
+ type: "string";
2093
+ };
2094
+ ownerId: {
2095
+ type: "string";
2096
+ };
2097
+ createdAt: {
2098
+ type: "string";
2099
+ };
2100
+ updatedAt: {
2101
+ type: "string";
2102
+ };
2103
+ };
2104
+ required: string[];
2105
+ };
2106
+ };
2107
+ meta: {
2108
+ type: "object";
2109
+ properties: {
2110
+ nextToken: {
2111
+ type: "string";
2112
+ description: string;
2113
+ };
2114
+ };
2115
+ additionalProperties: false;
2116
+ };
2117
+ };
2118
+ required: string[];
2119
+ title: string;
2120
+ additionalProperties: false;
2121
+ };
2122
+ };
2123
+ };
2124
+ createIntegration: {
2125
+ name: string;
2126
+ description: string;
2127
+ method: "post";
2128
+ section: "integration";
2129
+ path: string;
2130
+ requestBody: {
2131
+ description: string;
2132
+ schema: {
2133
+ type: "object";
2134
+ properties: {
2135
+ name: {
2136
+ type: "string";
2137
+ description: string;
2138
+ };
2139
+ version: {
2140
+ type: "string";
2141
+ description: string;
2142
+ };
2143
+ tags: {
2144
+ type: "object";
2145
+ properties: {
2146
+ users: {
2147
+ default: never[];
2148
+ type: "array";
2149
+ items: {
2150
+ type: "string";
2151
+ };
2152
+ };
2153
+ };
2154
+ description: string;
2155
+ additionalProperties: false;
2156
+ };
2157
+ channels: {
2158
+ type: "object";
2159
+ additionalProperties: {
2160
+ type: "object";
2161
+ properties: {
2162
+ tags: {
2163
+ type: "object";
2164
+ properties: {
2165
+ messages: {
2166
+ default: never[];
2167
+ type: "array";
2168
+ items: {
2169
+ type: "string";
2170
+ };
2171
+ };
2172
+ conversations: {
2173
+ default: never[];
2174
+ type: "array";
2175
+ items: {
2176
+ type: "string";
2177
+ };
2178
+ };
2179
+ };
2180
+ additionalProperties: false;
2181
+ };
2182
+ messages: {
2183
+ type: "object";
2184
+ additionalProperties: {
2185
+ type: "object";
2186
+ properties: {
2187
+ schema: {
2188
+ type: "object";
2189
+ additionalProperties: true;
2190
+ };
2191
+ };
2192
+ required: string[];
2193
+ additionalProperties: false;
2194
+ };
2195
+ };
2196
+ conversation: {
2197
+ type: "object";
2198
+ properties: {
2199
+ creation: {
2200
+ type: "object";
2201
+ properties: {
2202
+ enabled: {
2203
+ type: "boolean";
2204
+ description: string;
2205
+ };
2206
+ requiredTags: {
2207
+ type: "array";
2208
+ items: {
2209
+ type: "string";
2210
+ };
2211
+ description: string;
2212
+ };
2213
+ };
2214
+ required: string[];
2215
+ description: string;
2216
+ additionalProperties: false;
2217
+ };
2218
+ };
2219
+ required: string[];
2220
+ additionalProperties: false;
2221
+ };
2222
+ };
2223
+ required: string[];
2224
+ additionalProperties: false;
2225
+ };
2226
+ description: string;
2227
+ };
2228
+ states: {
2229
+ type: "object";
2230
+ additionalProperties: {
2231
+ type: "object";
2232
+ properties: {
2233
+ type: {
2234
+ type: "string";
2235
+ enum: string[];
2236
+ description: string;
2237
+ };
2238
+ schema: {
2239
+ type: "object";
2240
+ additionalProperties: true;
2241
+ description: string;
2242
+ };
2243
+ };
2244
+ required: string[];
2245
+ additionalProperties: false;
2246
+ };
2247
+ description: string;
2248
+ };
2249
+ configuration: {
2250
+ type: "object";
2251
+ properties: {
2252
+ schema: {
2253
+ type: "object";
2254
+ additionalProperties: true;
2255
+ description: string;
2256
+ };
2257
+ };
2258
+ required: string[];
2259
+ description: string;
2260
+ additionalProperties: false;
2261
+ };
2262
+ events: {
2263
+ type: "object";
2264
+ additionalProperties: {
2265
+ type: "object";
2266
+ properties: {
2267
+ schema: {
2268
+ type: "object";
2269
+ additionalProperties: true;
2270
+ };
2271
+ };
2272
+ required: string[];
2273
+ description: string;
2274
+ additionalProperties: false;
2275
+ };
2276
+ description: string;
2277
+ };
2278
+ actions: {
2279
+ type: "object";
2280
+ additionalProperties: {
2281
+ type: "object";
2282
+ properties: {
2283
+ input: {
2284
+ type: "object";
2285
+ properties: {
2286
+ schema: {
2287
+ type: "object";
2288
+ additionalProperties: true;
2289
+ };
2290
+ };
2291
+ required: string[];
2292
+ additionalProperties: false;
2293
+ };
2294
+ output: {
2295
+ type: "object";
2296
+ properties: {
2297
+ schema: {
2298
+ type: "object";
2299
+ additionalProperties: true;
2300
+ };
2301
+ };
2302
+ required: string[];
2303
+ additionalProperties: false;
2304
+ };
2305
+ };
2306
+ required: string[];
2307
+ additionalProperties: false;
2308
+ };
2309
+ description: string;
2310
+ };
2311
+ user: {
2312
+ type: "object";
2313
+ properties: {
2314
+ creation: {
2315
+ type: "object";
2316
+ properties: {
2317
+ enabled: {
2318
+ type: "boolean";
2319
+ description: string;
2320
+ };
2321
+ requiredTags: {
2322
+ type: "array";
2323
+ items: {
2324
+ type: "string";
2325
+ };
2326
+ description: string;
2327
+ };
2328
+ };
2329
+ required: string[];
2330
+ description: string;
2331
+ additionalProperties: false;
2332
+ };
2333
+ };
2334
+ required: string[];
2335
+ additionalProperties: false;
2336
+ };
2337
+ code: {
2338
+ type: "string";
2339
+ description: string;
2340
+ };
2341
+ public: {
2342
+ type: "boolean";
2343
+ description: string;
2344
+ };
2345
+ url: {
2346
+ type: "string";
2347
+ description: string;
2348
+ };
2349
+ dev: {
2350
+ type: "boolean";
2351
+ description: string;
2352
+ };
2353
+ icon: {
2354
+ type: "string";
2355
+ description: string;
2356
+ };
2357
+ readme: {
2358
+ type: "string";
2359
+ description: string;
2360
+ };
2361
+ title: {
2362
+ type: "string";
2363
+ minLength: number;
2364
+ maxLength: number;
2365
+ description: string;
2366
+ };
2367
+ description: {
2368
+ type: "string";
2369
+ maxLength: number;
2370
+ description: string;
2371
+ };
2372
+ };
2373
+ required: string[];
2374
+ title: string;
2375
+ additionalProperties: false;
2376
+ };
2377
+ };
2378
+ response: {
2379
+ description: string;
2380
+ schema: {
2381
+ type: "object";
2382
+ properties: {
2383
+ integration: {
2384
+ $ref: string;
2385
+ };
2386
+ };
2387
+ required: string[];
2388
+ title: string;
2389
+ additionalProperties: false;
2390
+ };
2391
+ };
2392
+ parameters: {};
2393
+ };
2394
+ updateIntegration: {
2395
+ name: string;
2396
+ description: string;
2397
+ method: "put";
2398
+ path: string;
2399
+ section: "integration";
2400
+ parameters: {
2401
+ id: {
2402
+ type: "string";
2403
+ description: string;
2404
+ in: "path";
2405
+ };
2406
+ };
2407
+ requestBody: {
2408
+ description: string;
2409
+ schema: {
2410
+ type: "object";
2411
+ properties: {
2412
+ tags: {
2413
+ type: "object";
2414
+ properties: {
2415
+ users: {
2416
+ default: never[];
2417
+ type: "array";
2418
+ items: {
2419
+ type: "string";
2420
+ };
2421
+ };
2422
+ };
2423
+ description: string;
2424
+ additionalProperties: false;
2425
+ };
2426
+ channels: {
2427
+ type: "object";
2428
+ additionalProperties: {
2429
+ type: "object";
2430
+ properties: {
2431
+ tags: {
2432
+ type: "object";
2433
+ properties: {
2434
+ messages: {
2435
+ default: never[];
2436
+ type: "array";
2437
+ items: {
2438
+ type: "string";
2439
+ };
2440
+ };
2441
+ conversations: {
2442
+ default: never[];
2443
+ type: "array";
2444
+ items: {
2445
+ type: "string";
2446
+ };
2447
+ };
2448
+ };
2449
+ additionalProperties: false;
2450
+ };
2451
+ messages: {
2452
+ type: "object";
2453
+ additionalProperties: {
2454
+ type: "object";
2455
+ properties: {
2456
+ schema: {
2457
+ type: "object";
2458
+ additionalProperties: true;
2459
+ };
2460
+ };
2461
+ required: string[];
2462
+ additionalProperties: false;
2463
+ };
2464
+ };
2465
+ conversation: {
2466
+ type: "object";
2467
+ properties: {
2468
+ creation: {
2469
+ type: "object";
2470
+ properties: {
2471
+ enabled: {
2472
+ type: "boolean";
2473
+ description: string;
2474
+ };
2475
+ requiredTags: {
2476
+ type: "array";
2477
+ items: {
2478
+ type: "string";
2479
+ };
2480
+ description: string;
2481
+ };
2482
+ };
2483
+ required: string[];
2484
+ description: string;
2485
+ additionalProperties: false;
2486
+ };
2487
+ };
2488
+ required: string[];
2489
+ additionalProperties: false;
2490
+ };
2491
+ };
2492
+ required: string[];
2493
+ additionalProperties: false;
2494
+ };
2495
+ description: string;
2496
+ };
2497
+ states: {
2498
+ type: "object";
2499
+ additionalProperties: {
2500
+ type: "object";
2501
+ properties: {
2502
+ type: {
2503
+ type: "string";
2504
+ enum: string[];
2505
+ description: string;
2506
+ };
2507
+ schema: {
2508
+ type: "object";
2509
+ additionalProperties: true;
2510
+ description: string;
2511
+ };
2512
+ };
2513
+ required: string[];
2514
+ additionalProperties: false;
2515
+ };
2516
+ description: string;
2517
+ };
2518
+ configuration: {
2519
+ type: "object";
2520
+ properties: {
2521
+ schema: {
2522
+ type: "object";
2523
+ additionalProperties: true;
2524
+ description: string;
2525
+ };
2526
+ };
2527
+ required: string[];
2528
+ description: string;
2529
+ additionalProperties: false;
2530
+ };
2531
+ events: {
2532
+ type: "object";
2533
+ additionalProperties: {
2534
+ type: "object";
2535
+ properties: {
2536
+ schema: {
2537
+ type: "object";
2538
+ additionalProperties: true;
2539
+ };
2540
+ };
2541
+ required: string[];
2542
+ description: string;
2543
+ additionalProperties: false;
2544
+ };
2545
+ description: string;
2546
+ };
2547
+ actions: {
2548
+ type: "object";
2549
+ additionalProperties: {
2550
+ type: "object";
2551
+ properties: {
2552
+ input: {
2553
+ type: "object";
2554
+ properties: {
2555
+ schema: {
2556
+ type: "object";
2557
+ additionalProperties: true;
2558
+ };
2559
+ };
2560
+ required: string[];
2561
+ additionalProperties: false;
2562
+ };
2563
+ output: {
2564
+ type: "object";
2565
+ properties: {
2566
+ schema: {
2567
+ type: "object";
2568
+ additionalProperties: true;
2569
+ };
2570
+ };
2571
+ required: string[];
2572
+ additionalProperties: false;
2573
+ };
2574
+ };
2575
+ required: string[];
2576
+ additionalProperties: false;
2577
+ };
2578
+ description: string;
2579
+ };
2580
+ user: {
2581
+ type: "object";
2582
+ properties: {
2583
+ creation: {
2584
+ type: "object";
2585
+ properties: {
2586
+ enabled: {
2587
+ type: "boolean";
2588
+ description: string;
2589
+ };
2590
+ requiredTags: {
2591
+ type: "array";
2592
+ items: {
2593
+ type: "string";
2594
+ };
2595
+ description: string;
2596
+ };
2597
+ };
2598
+ required: string[];
2599
+ description: string;
2600
+ additionalProperties: false;
2601
+ };
2602
+ };
2603
+ required: string[];
2604
+ additionalProperties: false;
2605
+ };
2606
+ code: {
2607
+ type: "string";
2608
+ description: string;
2609
+ };
2610
+ public: {
2611
+ type: "boolean";
2612
+ description: string;
2613
+ };
2614
+ url: {
2615
+ type: "string";
2616
+ description: string;
2617
+ };
2618
+ icon: {
2619
+ type: "string";
2620
+ description: string;
2621
+ };
2622
+ readme: {
2623
+ type: "string";
2624
+ description: string;
2625
+ };
2626
+ title: {
2627
+ type: "string";
2628
+ minLength: number;
2629
+ maxLength: number;
2630
+ description: string;
2631
+ };
2632
+ description: {
2633
+ type: "string";
2634
+ maxLength: number;
2635
+ description: string;
2636
+ };
2637
+ };
2638
+ title: string;
2639
+ additionalProperties: false;
2640
+ };
2641
+ };
2642
+ response: {
2643
+ description: string;
2644
+ schema: {
2645
+ type: "object";
2646
+ properties: {
2647
+ integration: {
2648
+ $ref: string;
2649
+ };
2650
+ };
2651
+ required: string[];
2652
+ title: string;
2653
+ additionalProperties: false;
2654
+ };
2655
+ };
2656
+ };
2657
+ listIntegrations: {
2658
+ name: string;
2659
+ description: string;
2660
+ method: "get";
2661
+ section: "integration";
2662
+ path: string;
2663
+ parameters: {
2664
+ nextToken: {
2665
+ in: "query";
2666
+ description: string;
2667
+ type: "string";
2668
+ };
2669
+ name: {
2670
+ type: "string";
2671
+ description: string;
2672
+ in: "query";
2673
+ };
2674
+ version: {
2675
+ type: "string";
2676
+ description: string;
2677
+ in: "query";
2678
+ };
2679
+ };
2680
+ response: {
2681
+ description: string;
2682
+ schema: {
2683
+ type: "object";
2684
+ properties: {
2685
+ integrations: {
2686
+ type: "array";
2687
+ items: {
2688
+ type: "object";
2689
+ properties: {
2690
+ id: {
2691
+ type: "string";
2692
+ description: string;
2693
+ };
2694
+ name: {
2695
+ type: "string";
2696
+ description: string;
2697
+ };
2698
+ version: {
2699
+ type: "string";
2700
+ description: string;
2701
+ };
2702
+ createdAt: {
2703
+ type: "string";
2704
+ format: string;
2705
+ description: string;
2706
+ };
2707
+ updatedAt: {
2708
+ type: "string";
2709
+ format: string;
2710
+ description: string;
2711
+ };
2712
+ title: {
2713
+ type: "string";
2714
+ minLength: number;
2715
+ maxLength: number;
2716
+ description: string;
2717
+ };
2718
+ description: {
2719
+ type: "string";
2720
+ maxLength: number;
2721
+ description: string;
2722
+ };
2723
+ iconUrl: {
2724
+ type: "string";
2725
+ description: string;
2726
+ };
2727
+ };
2728
+ required: string[];
2729
+ };
2730
+ };
2731
+ meta: {
2732
+ type: "object";
2733
+ properties: {
2734
+ nextToken: {
2735
+ type: "string";
2736
+ description: string;
2737
+ };
2738
+ };
2739
+ additionalProperties: false;
2740
+ };
2741
+ };
2742
+ required: string[];
2743
+ title: string;
2744
+ additionalProperties: false;
2745
+ };
2746
+ };
2747
+ };
2748
+ getIntegration: {
2749
+ name: string;
2750
+ description: string;
2751
+ method: "get";
2752
+ section: "integration";
2753
+ path: string;
2754
+ parameters: {
2755
+ id: {
2756
+ type: "string";
2757
+ description: string;
2758
+ in: "path";
2759
+ };
2760
+ };
2761
+ response: {
2762
+ description: string;
2763
+ schema: {
2764
+ type: "object";
2765
+ properties: {
2766
+ integration: {
2767
+ $ref: string;
2768
+ };
2769
+ };
2770
+ required: string[];
2771
+ title: string;
2772
+ additionalProperties: false;
2773
+ };
2774
+ };
2775
+ };
2776
+ getIntegrationLogs: {
2777
+ name: string;
2778
+ description: string;
2779
+ method: "get";
2780
+ section: "integration";
2781
+ path: string;
2782
+ parameters: {
2783
+ id: {
2784
+ type: "string";
2785
+ description: string;
2786
+ in: "path";
2787
+ };
2788
+ };
2789
+ response: {
2790
+ description: string;
2791
+ schema: {
2792
+ type: "object";
2793
+ properties: {
2794
+ logs: {
2795
+ type: "array";
2796
+ items: {
2797
+ type: "object";
2798
+ properties: {
2799
+ timestamp: {
2800
+ type: "string";
2801
+ };
2802
+ level: {
2803
+ type: "string";
2804
+ };
2805
+ message: {
2806
+ type: "string";
2807
+ };
2808
+ };
2809
+ required: string[];
2810
+ };
2811
+ };
2812
+ };
2813
+ required: string[];
2814
+ title: string;
2815
+ additionalProperties: false;
2816
+ };
2817
+ };
2818
+ };
2819
+ getIntegrationByName: {
2820
+ name: string;
2821
+ description: string;
2822
+ method: "get";
2823
+ section: "integration";
2824
+ path: string;
2825
+ parameters: {
2826
+ name: {
2827
+ type: "string";
2828
+ description: string;
2829
+ in: "path";
2830
+ };
2831
+ version: {
2832
+ type: "string";
2833
+ description: string;
2834
+ in: "path";
2835
+ };
2836
+ };
2837
+ response: {
2838
+ description: string;
2839
+ schema: {
2840
+ type: "object";
2841
+ properties: {
2842
+ integration: {
2843
+ $ref: string;
2844
+ };
2845
+ };
2846
+ required: string[];
2847
+ title: string;
2848
+ additionalProperties: false;
2849
+ };
2850
+ };
2851
+ };
2852
+ deleteIntegration: {
2853
+ name: string;
2854
+ description: string;
2855
+ method: "delete";
2856
+ section: "integration";
2857
+ path: string;
2858
+ parameters: {
2859
+ id: {
2860
+ type: "string";
2861
+ description: string;
2862
+ in: "path";
2863
+ };
2864
+ };
2865
+ response: {
2866
+ description: string;
2867
+ schema: {
2868
+ type: "object";
2869
+ title: string;
2870
+ additionalProperties: false;
2871
+ };
2872
+ };
2873
+ };
2874
+ introspect: {
2875
+ name: string;
2876
+ description: string;
2877
+ method: "post";
2878
+ path: string;
2879
+ disableDefaultParameters: {
2880
+ "x-workspace-id": boolean;
2881
+ };
2882
+ requestBody: {
2883
+ description: string;
2884
+ schema: {
2885
+ type: "object";
2886
+ properties: {
2887
+ botId: {
2888
+ type: "string";
2889
+ };
2890
+ };
2891
+ required: string[];
2892
+ title: string;
2893
+ additionalProperties: false;
2894
+ };
2895
+ };
2896
+ response: {
2897
+ description: string;
2898
+ schema: {
2899
+ type: "object";
2900
+ properties: {
2901
+ workspaceId: {
2902
+ type: "string";
2903
+ };
2904
+ botId: {
2905
+ type: "string";
2906
+ };
2907
+ userId: {
2908
+ type: "string";
2909
+ };
2910
+ };
2911
+ required: string[];
2912
+ title: string;
2913
+ additionalProperties: false;
2914
+ };
2915
+ };
2916
+ parameters: {};
2917
+ };
2918
+ createFile: {
2919
+ name: string;
2920
+ description: string;
2921
+ method: "post";
2922
+ path: string;
2923
+ section: "file";
2924
+ requestBody: {
2925
+ description: string;
2926
+ schema: {
2927
+ type: "object";
2928
+ properties: {
2929
+ botId: {
2930
+ type: "string";
2931
+ format: string;
2932
+ description: string;
2933
+ };
2934
+ contents: {
2935
+ type: "string";
2936
+ description: string;
2937
+ };
2938
+ name: {
2939
+ type: "string";
2940
+ description: string;
2941
+ };
2942
+ accessType: {
2943
+ type: "string";
2944
+ enum: string[];
2945
+ description: string;
2946
+ };
2947
+ };
2948
+ required: string[];
2949
+ title: string;
2950
+ additionalProperties: false;
2951
+ };
2952
+ };
2953
+ response: {
2954
+ description: string;
2955
+ schema: {
2956
+ type: "object";
2957
+ properties: {
2958
+ file: {
2959
+ $ref: string;
2960
+ };
2961
+ };
2962
+ required: string[];
2963
+ title: string;
2964
+ additionalProperties: false;
2965
+ };
2966
+ };
2967
+ parameters: {};
2968
+ };
2969
+ getFile: {
2970
+ name: string;
2971
+ description: string;
2972
+ method: "get";
2973
+ path: string;
2974
+ section: "file";
2975
+ parameters: {
2976
+ id: {
2977
+ type: "string";
2978
+ description: string;
2979
+ in: "path";
2980
+ };
2981
+ };
2982
+ response: {
2983
+ description: string;
2984
+ schema: {
2985
+ type: "object";
2986
+ properties: {
2987
+ file: {
2988
+ $ref: string;
2989
+ };
2990
+ };
2991
+ required: string[];
2992
+ title: string;
2993
+ additionalProperties: false;
2994
+ };
2995
+ };
2996
+ };
2997
+ downloadFile: {
2998
+ name: string;
2999
+ description: string;
3000
+ method: "get";
3001
+ path: string;
3002
+ section: "file";
3003
+ parameters: {
3004
+ id: {
3005
+ type: "string";
3006
+ description: string;
3007
+ in: "path";
3008
+ };
3009
+ };
3010
+ response: {
3011
+ description: string;
3012
+ schema: {
3013
+ nullable: true;
3014
+ title: string;
3015
+ };
3016
+ };
3017
+ };
3018
+ deleteFile: {
3019
+ name: string;
3020
+ description: string;
3021
+ method: "delete";
3022
+ path: string;
3023
+ section: "file";
3024
+ parameters: {
3025
+ id: {
3026
+ type: "string";
3027
+ description: string;
3028
+ in: "path";
3029
+ };
3030
+ };
3031
+ response: {
3032
+ description: string;
3033
+ schema: {
3034
+ type: "object";
3035
+ title: string;
3036
+ additionalProperties: false;
3037
+ };
3038
+ };
3039
+ };
3040
+ listFiles: {
3041
+ name: string;
3042
+ description: string;
3043
+ method: "get";
3044
+ path: string;
3045
+ section: "file";
3046
+ parameters: {
3047
+ nextToken: {
3048
+ in: "query";
3049
+ description: string;
3050
+ type: "string";
3051
+ };
3052
+ botId: {
3053
+ in: "query";
3054
+ type: "string";
3055
+ description: string;
3056
+ required: true;
3057
+ };
3058
+ };
3059
+ response: {
3060
+ description: string;
3061
+ schema: {
3062
+ type: "object";
3063
+ properties: {
3064
+ files: {
3065
+ type: "array";
3066
+ items: {
3067
+ $ref: string;
3068
+ };
3069
+ };
3070
+ meta: {
3071
+ type: "object";
3072
+ properties: {
3073
+ nextToken: {
3074
+ type: "string";
3075
+ description: string;
3076
+ };
3077
+ };
3078
+ additionalProperties: false;
3079
+ };
3080
+ };
3081
+ required: string[];
3082
+ title: string;
3083
+ additionalProperties: false;
3084
+ };
3085
+ };
3086
+ };
3087
+ };
3088
+ metadata: {
3089
+ title: string;
3090
+ description: string;
3091
+ server: string;
3092
+ version: string;
3093
+ prefix: string;
3094
+ };
3095
+ errors: ({
3096
+ status: 500;
3097
+ type: string;
3098
+ description: string;
3099
+ } | {
3100
+ status: 401;
3101
+ type: string;
3102
+ description: string;
3103
+ } | {
3104
+ status: 403;
3105
+ type: string;
3106
+ description: string;
3107
+ } | {
3108
+ status: 413;
3109
+ type: string;
3110
+ description: string;
3111
+ } | {
3112
+ status: 400;
3113
+ type: string;
3114
+ description: string;
3115
+ } | {
3116
+ status: 415;
3117
+ type: string;
3118
+ description: string;
3119
+ } | {
3120
+ status: 405;
3121
+ type: string;
3122
+ description: string;
3123
+ } | {
3124
+ status: 404;
3125
+ type: string;
3126
+ description: string;
3127
+ } | {
3128
+ status: 409;
3129
+ type: string;
3130
+ description: string;
3131
+ })[];
3132
+ refs: {
3133
+ parameters: {};
3134
+ requestBodies: {
3135
+ createConversationBody: true;
3136
+ getOrCreateConversationBody: true;
3137
+ updateConversationBody: true;
3138
+ createEventBody: true;
3139
+ createMessageBody: true;
3140
+ getOrCreateMessageBody: true;
3141
+ updateMessageBody: true;
3142
+ createUserBody: true;
3143
+ getOrCreateUserBody: true;
3144
+ updateUserBody: true;
3145
+ setStateBody: true;
3146
+ patchStateBody: true;
3147
+ callActionBody: true;
3148
+ configureIntegrationBody: true;
3149
+ createBotBody: true;
3150
+ updateBotBody: true;
3151
+ transferBotBody: true;
3152
+ createIntegrationBody: true;
3153
+ updateIntegrationBody: true;
3154
+ introspectBody: true;
3155
+ createFileBody: true;
3156
+ };
3157
+ responses: {
3158
+ createConversationResponse: true;
3159
+ getConversationResponse: true;
3160
+ listConversationsResponse: true;
3161
+ getOrCreateConversationResponse: true;
3162
+ updateConversationResponse: true;
3163
+ deleteConversationResponse: true;
3164
+ createEventResponse: true;
3165
+ getEventResponse: true;
3166
+ listEventsResponse: true;
3167
+ createMessageResponse: true;
3168
+ getOrCreateMessageResponse: true;
3169
+ getMessageResponse: true;
3170
+ updateMessageResponse: true;
3171
+ listMessagesResponse: true;
3172
+ deleteMessageResponse: true;
3173
+ createUserResponse: true;
3174
+ getUserResponse: true;
3175
+ listUsersResponse: true;
3176
+ getOrCreateUserResponse: true;
3177
+ updateUserResponse: true;
3178
+ deleteUserResponse: true;
3179
+ getStateResponse: true;
3180
+ setStateResponse: true;
3181
+ patchStateResponse: true;
3182
+ callActionResponse: true;
3183
+ configureIntegrationResponse: true;
3184
+ listPublicIntegrationsResponse: true;
3185
+ getPublicIntegrationByIdResponse: true;
3186
+ getPublicIntegrationResponse: true;
3187
+ createBotResponse: true;
3188
+ updateBotResponse: true;
3189
+ transferBotResponse: true;
3190
+ listBotsResponse: true;
3191
+ getBotResponse: true;
3192
+ deleteBotResponse: true;
3193
+ getBotLogsResponse: true;
3194
+ getBotWebchatResponse: true;
3195
+ getBotAnalyticsResponse: true;
3196
+ getWorkspaceResponse: true;
3197
+ listWorkspacesResponse: true;
3198
+ createIntegrationResponse: true;
3199
+ updateIntegrationResponse: true;
3200
+ listIntegrationsResponse: true;
3201
+ getIntegrationResponse: true;
3202
+ getIntegrationLogsResponse: true;
3203
+ getIntegrationByNameResponse: true;
3204
+ deleteIntegrationResponse: true;
3205
+ introspectResponse: true;
3206
+ createFileResponse: true;
3207
+ getFileResponse: true;
3208
+ downloadFileResponse: true;
3209
+ deleteFileResponse: true;
3210
+ listFilesResponse: true;
3211
+ };
3212
+ schemas: {
3213
+ Bot: true;
3214
+ Integration: true;
3215
+ Workspace: true;
3216
+ User: true;
3217
+ Conversation: true;
3218
+ Event: true;
3219
+ Message: true;
3220
+ State: true;
3221
+ File: true;
3222
+ };
3223
+ };
3224
+ schemas: {
3225
+ Bot: {
3226
+ section: "bot";
3227
+ schema: {
3228
+ type: "object";
3229
+ properties: {
3230
+ id: {
3231
+ type: "string";
3232
+ format: string;
3233
+ description: string;
3234
+ };
3235
+ createdAt: {
3236
+ type: "string";
3237
+ format: string;
3238
+ description: string;
3239
+ };
3240
+ updatedAt: {
3241
+ type: "string";
3242
+ format: string;
3243
+ description: string;
3244
+ };
3245
+ signingSecret: {
3246
+ type: "string";
3247
+ description: string;
3248
+ };
3249
+ integrations: {
3250
+ type: "object";
3251
+ additionalProperties: {
3252
+ type: "object";
3253
+ properties: {
3254
+ enabled: {
3255
+ type: "boolean";
3256
+ };
3257
+ name: {
3258
+ type: "string";
3259
+ };
3260
+ version: {
3261
+ type: "string";
3262
+ };
3263
+ webhookUrl: {
3264
+ type: "string";
3265
+ };
3266
+ configuration: {
3267
+ type: "object";
3268
+ additionalProperties: true;
3269
+ };
3270
+ status: {
3271
+ type: "string";
3272
+ enum: string[];
3273
+ };
3274
+ };
3275
+ required: string[];
3276
+ additionalProperties: false;
3277
+ };
3278
+ description: string;
3279
+ };
3280
+ states: {
3281
+ type: "object";
3282
+ additionalProperties: {
3283
+ type: "object";
3284
+ properties: {
3285
+ type: {
3286
+ type: "string";
3287
+ enum: string[];
3288
+ description: string;
3289
+ };
3290
+ schema: {
3291
+ type: "object";
3292
+ additionalProperties: true;
3293
+ description: string;
3294
+ };
3295
+ expiry: {
3296
+ type: "number";
3297
+ minimum: number;
3298
+ description: string;
3299
+ };
3300
+ };
3301
+ required: string[];
3302
+ additionalProperties: false;
3303
+ };
3304
+ description: string;
3305
+ };
3306
+ tags: {
3307
+ type: "object";
3308
+ properties: {
3309
+ messages: {
3310
+ default: never[];
3311
+ type: "array";
3312
+ items: {
3313
+ type: "string";
3314
+ };
3315
+ };
3316
+ conversations: {
3317
+ default: never[];
3318
+ type: "array";
3319
+ items: {
3320
+ type: "string";
3321
+ };
3322
+ };
3323
+ users: {
3324
+ default: never[];
3325
+ type: "array";
3326
+ items: {
3327
+ type: "string";
3328
+ };
3329
+ };
3330
+ };
3331
+ description: string;
3332
+ additionalProperties: false;
3333
+ };
3334
+ configuration: {
3335
+ type: "object";
3336
+ properties: {
3337
+ data: {
3338
+ type: "object";
3339
+ additionalProperties: true;
3340
+ description: string;
3341
+ };
3342
+ schema: {
3343
+ type: "object";
3344
+ additionalProperties: true;
3345
+ description: string;
3346
+ };
3347
+ };
3348
+ required: string[];
3349
+ description: string;
3350
+ additionalProperties: false;
3351
+ };
3352
+ events: {
3353
+ type: "object";
3354
+ additionalProperties: {
3355
+ type: "object";
3356
+ properties: {
3357
+ schema: {
3358
+ type: "object";
3359
+ additionalProperties: true;
3360
+ };
3361
+ };
3362
+ required: string[];
3363
+ description: string;
3364
+ additionalProperties: false;
3365
+ };
3366
+ description: string;
3367
+ };
3368
+ recurringEvents: {
3369
+ type: "object";
3370
+ additionalProperties: {
3371
+ type: "object";
3372
+ properties: {
3373
+ schedule: {
3374
+ type: "object";
3375
+ properties: {
3376
+ cron: {
3377
+ type: "string";
3378
+ };
3379
+ };
3380
+ required: string[];
3381
+ additionalProperties: false;
3382
+ };
3383
+ type: {
3384
+ type: "string";
3385
+ };
3386
+ payload: {
3387
+ type: "object";
3388
+ additionalProperties: true;
3389
+ };
3390
+ };
3391
+ required: string[];
3392
+ additionalProperties: false;
3393
+ };
3394
+ description: string;
3395
+ };
3396
+ name: {
3397
+ type: "string";
3398
+ description: string;
3399
+ };
3400
+ deployedAt: {
3401
+ type: "string";
3402
+ format: string;
3403
+ description: string;
3404
+ };
3405
+ dev: {
3406
+ type: "boolean";
3407
+ description: string;
3408
+ };
3409
+ createdBy: {
3410
+ type: "string";
3411
+ description: string;
3412
+ };
3413
+ medias: {
3414
+ type: "array";
3415
+ items: {
3416
+ type: "object";
3417
+ properties: {
3418
+ url: {
3419
+ type: "string";
3420
+ description: string;
3421
+ };
3422
+ name: {
3423
+ type: "string";
3424
+ description: string;
3425
+ };
3426
+ };
3427
+ required: string[];
3428
+ };
3429
+ description: string;
3430
+ };
3431
+ };
3432
+ required: string[];
3433
+ additionalProperties: false;
3434
+ };
3435
+ };
3436
+ Integration: {
3437
+ section: "integration";
3438
+ schema: {
3439
+ type: "object";
3440
+ properties: {
3441
+ id: {
3442
+ type: "string";
3443
+ description: string;
3444
+ };
3445
+ createdAt: {
3446
+ type: "string";
3447
+ format: string;
3448
+ description: string;
3449
+ };
3450
+ updatedAt: {
3451
+ type: "string";
3452
+ format: string;
3453
+ description: string;
3454
+ };
3455
+ name: {
3456
+ type: "string";
3457
+ description: string;
3458
+ };
3459
+ version: {
3460
+ type: "string";
3461
+ description: string;
3462
+ };
3463
+ channels: {
3464
+ type: "object";
3465
+ additionalProperties: {
3466
+ type: "object";
3467
+ properties: {
3468
+ tags: {
3469
+ type: "object";
3470
+ properties: {
3471
+ messages: {
3472
+ default: never[];
3473
+ type: "array";
3474
+ items: {
3475
+ type: "string";
3476
+ };
3477
+ };
3478
+ conversations: {
3479
+ default: never[];
3480
+ type: "array";
3481
+ items: {
3482
+ type: "string";
3483
+ };
3484
+ };
3485
+ };
3486
+ additionalProperties: false;
3487
+ };
3488
+ messages: {
3489
+ type: "object";
3490
+ additionalProperties: {
3491
+ type: "object";
3492
+ properties: {
3493
+ schema: {
3494
+ type: "object";
3495
+ additionalProperties: true;
3496
+ };
3497
+ };
3498
+ required: string[];
3499
+ additionalProperties: false;
3500
+ };
3501
+ };
3502
+ conversation: {
3503
+ type: "object";
3504
+ properties: {
3505
+ creation: {
3506
+ type: "object";
3507
+ properties: {
3508
+ enabled: {
3509
+ type: "boolean";
3510
+ description: string;
3511
+ };
3512
+ requiredTags: {
3513
+ type: "array";
3514
+ items: {
3515
+ type: "string";
3516
+ };
3517
+ description: string;
3518
+ };
3519
+ };
3520
+ required: string[];
3521
+ description: string;
3522
+ additionalProperties: false;
3523
+ };
3524
+ };
3525
+ required: string[];
3526
+ additionalProperties: false;
3527
+ };
3528
+ };
3529
+ required: string[];
3530
+ additionalProperties: false;
3531
+ };
3532
+ description: string;
3533
+ };
3534
+ states: {
3535
+ default: {};
3536
+ type: "object";
3537
+ additionalProperties: {
3538
+ type: "object";
3539
+ properties: {
3540
+ type: {
3541
+ type: "string";
3542
+ enum: string[];
3543
+ description: string;
3544
+ };
3545
+ schema: {
3546
+ type: "object";
3547
+ additionalProperties: true;
3548
+ description: string;
3549
+ };
3550
+ };
3551
+ required: string[];
3552
+ additionalProperties: false;
3553
+ };
3554
+ description: string;
3555
+ };
3556
+ configuration: {
3557
+ type: "object";
3558
+ properties: {
3559
+ schema: {
3560
+ type: "object";
3561
+ additionalProperties: true;
3562
+ description: string;
3563
+ };
3564
+ };
3565
+ required: string[];
3566
+ description: string;
3567
+ additionalProperties: false;
3568
+ };
3569
+ events: {
3570
+ type: "object";
3571
+ additionalProperties: {
3572
+ type: "object";
3573
+ properties: {
3574
+ schema: {
3575
+ type: "object";
3576
+ additionalProperties: true;
3577
+ };
3578
+ };
3579
+ required: string[];
3580
+ description: string;
3581
+ additionalProperties: false;
3582
+ };
3583
+ description: string;
3584
+ };
3585
+ actions: {
3586
+ type: "object";
3587
+ additionalProperties: {
3588
+ type: "object";
3589
+ properties: {
3590
+ input: {
3591
+ type: "object";
3592
+ properties: {
3593
+ schema: {
3594
+ type: "object";
3595
+ additionalProperties: true;
3596
+ };
3597
+ };
3598
+ required: string[];
3599
+ additionalProperties: false;
3600
+ };
3601
+ output: {
3602
+ type: "object";
3603
+ properties: {
3604
+ schema: {
3605
+ type: "object";
3606
+ additionalProperties: true;
3607
+ };
3608
+ };
3609
+ required: string[];
3610
+ additionalProperties: false;
3611
+ };
3612
+ };
3613
+ required: string[];
3614
+ additionalProperties: false;
3615
+ };
3616
+ description: string;
3617
+ };
3618
+ user: {
3619
+ type: "object";
3620
+ properties: {
3621
+ creation: {
3622
+ type: "object";
3623
+ properties: {
3624
+ enabled: {
3625
+ type: "boolean";
3626
+ description: string;
3627
+ };
3628
+ requiredTags: {
3629
+ type: "array";
3630
+ items: {
3631
+ type: "string";
3632
+ };
3633
+ description: string;
3634
+ };
3635
+ };
3636
+ required: string[];
3637
+ description: string;
3638
+ additionalProperties: false;
3639
+ };
3640
+ };
3641
+ required: string[];
3642
+ additionalProperties: false;
3643
+ };
3644
+ dev: {
3645
+ type: "boolean";
3646
+ description: string;
3647
+ };
3648
+ title: {
3649
+ type: "string";
3650
+ minLength: number;
3651
+ maxLength: number;
3652
+ description: string;
3653
+ };
3654
+ description: {
3655
+ type: "string";
3656
+ maxLength: number;
3657
+ description: string;
3658
+ };
3659
+ iconUrl: {
3660
+ type: "string";
3661
+ description: string;
3662
+ };
3663
+ readmeUrl: {
3664
+ type: "string";
3665
+ description: string;
3666
+ };
3667
+ };
3668
+ required: string[];
3669
+ additionalProperties: false;
3670
+ };
3671
+ };
3672
+ Workspace: {
3673
+ section: "workspace";
3674
+ schema: {
3675
+ type: "object";
3676
+ properties: {
3677
+ id: {
3678
+ type: "string";
3679
+ };
3680
+ name: {
3681
+ type: "string";
3682
+ };
3683
+ ownerId: {
3684
+ type: "string";
3685
+ };
3686
+ createdAt: {
3687
+ type: "string";
3688
+ };
3689
+ updatedAt: {
3690
+ type: "string";
3691
+ };
3692
+ accountType: {
3693
+ type: "string";
3694
+ };
3695
+ blocked: {
3696
+ type: "boolean";
3697
+ };
3698
+ spendingLimit: {
3699
+ type: "number";
3700
+ };
3701
+ };
3702
+ required: string[];
3703
+ additionalProperties: false;
3704
+ };
3705
+ };
3706
+ User: {
3707
+ section: "user";
3708
+ schema: {
3709
+ type: "object";
3710
+ properties: {
3711
+ id: {
3712
+ type: "string";
3713
+ description: string;
3714
+ };
3715
+ createdAt: {
3716
+ type: "string";
3717
+ format: string;
3718
+ description: string;
3719
+ };
3720
+ updatedAt: {
3721
+ type: "string";
3722
+ format: string;
3723
+ description: string;
3724
+ };
3725
+ tags: {
3726
+ type: "object";
3727
+ additionalProperties: {
3728
+ type: "string";
3729
+ };
3730
+ description: string;
3731
+ };
3732
+ };
3733
+ required: string[];
3734
+ description: string;
3735
+ additionalProperties: false;
3736
+ };
3737
+ };
3738
+ Conversation: {
3739
+ section: "conversation";
3740
+ schema: {
3741
+ type: "object";
3742
+ properties: {
3743
+ id: {
3744
+ type: "string";
3745
+ description: string;
3746
+ };
3747
+ createdAt: {
3748
+ type: "string";
3749
+ format: string;
3750
+ description: string;
3751
+ };
3752
+ updatedAt: {
3753
+ type: "string";
3754
+ format: string;
3755
+ description: string;
3756
+ };
3757
+ channel: {
3758
+ type: "string";
3759
+ description: string;
3760
+ };
3761
+ integration: {
3762
+ type: "string";
3763
+ description: string;
3764
+ };
3765
+ tags: {
3766
+ type: "object";
3767
+ additionalProperties: {
3768
+ type: "string";
3769
+ };
3770
+ description: string;
3771
+ };
3772
+ };
3773
+ required: string[];
3774
+ description: string;
3775
+ additionalProperties: false;
3776
+ };
3777
+ };
3778
+ Event: {
3779
+ section: "event";
3780
+ schema: {
3781
+ type: "object";
3782
+ properties: {
3783
+ id: {
3784
+ type: "string";
3785
+ description: string;
3786
+ };
3787
+ createdAt: {
3788
+ type: "string";
3789
+ format: string;
3790
+ description: string;
3791
+ };
3792
+ type: {
3793
+ type: "string";
3794
+ description: string;
3795
+ };
3796
+ payload: {
3797
+ type: "object";
3798
+ additionalProperties: true;
3799
+ description: string;
3800
+ };
3801
+ };
3802
+ required: string[];
3803
+ description: string;
3804
+ additionalProperties: false;
3805
+ };
3806
+ };
3807
+ Message: {
3808
+ section: "message";
3809
+ schema: {
3810
+ type: "object";
3811
+ properties: {
3812
+ id: {
3813
+ type: "string";
3814
+ description: string;
3815
+ };
3816
+ createdAt: {
3817
+ type: "string";
3818
+ format: string;
3819
+ description: string;
3820
+ };
3821
+ type: {
3822
+ type: "string";
3823
+ description: string;
3824
+ };
3825
+ payload: {
3826
+ type: "object";
3827
+ additionalProperties: true;
3828
+ description: string;
3829
+ };
3830
+ direction: {
3831
+ type: "string";
3832
+ enum: string[];
3833
+ description: string;
3834
+ };
3835
+ userId: {
3836
+ type: "string";
3837
+ description: string;
3838
+ };
3839
+ conversationId: {
3840
+ type: "string";
3841
+ description: string;
3842
+ };
3843
+ tags: {
3844
+ type: "object";
3845
+ additionalProperties: {
3846
+ type: "string";
3847
+ };
3848
+ description: string;
3849
+ };
3850
+ };
3851
+ required: string[];
3852
+ description: string;
3853
+ additionalProperties: false;
3854
+ };
3855
+ };
3856
+ State: {
3857
+ section: "state";
3858
+ schema: {
3859
+ type: "object";
3860
+ properties: {
3861
+ id: {
3862
+ type: "string";
3863
+ description: string;
3864
+ };
3865
+ createdAt: {
3866
+ type: "string";
3867
+ format: string;
3868
+ description: string;
3869
+ };
3870
+ updatedAt: {
3871
+ type: "string";
3872
+ format: string;
3873
+ description: string;
3874
+ };
3875
+ botId: {
3876
+ type: "string";
3877
+ description: string;
3878
+ };
3879
+ conversationId: {
3880
+ type: "string";
3881
+ description: string;
3882
+ };
3883
+ userId: {
3884
+ type: "string";
3885
+ description: string;
3886
+ };
3887
+ name: {
3888
+ type: "string";
3889
+ description: string;
3890
+ };
3891
+ type: {
3892
+ type: "string";
3893
+ enum: string[];
3894
+ description: string;
3895
+ };
3896
+ payload: {
3897
+ type: "object";
3898
+ additionalProperties: true;
3899
+ description: string;
3900
+ };
3901
+ };
3902
+ required: string[];
3903
+ description: string;
3904
+ additionalProperties: false;
3905
+ };
3906
+ };
3907
+ File: {
3908
+ section: "file";
3909
+ schema: {
3910
+ type: "object";
3911
+ properties: {
3912
+ botId: {
3913
+ type: "string";
3914
+ format: string;
3915
+ description: string;
3916
+ };
3917
+ name: {
3918
+ type: "string";
3919
+ description: string;
3920
+ };
3921
+ accessType: {
3922
+ type: "string";
3923
+ enum: string[];
3924
+ description: string;
3925
+ };
3926
+ id: {
3927
+ type: "string";
3928
+ description: string;
3929
+ };
3930
+ createdAt: {
3931
+ type: "string";
3932
+ description: string;
3933
+ };
3934
+ size: {
3935
+ type: "number";
3936
+ description: string;
3937
+ };
3938
+ publicUrl: {
3939
+ type: "string";
3940
+ description: string;
3941
+ };
3942
+ };
3943
+ required: string[];
3944
+ additionalProperties: false;
3945
+ };
3946
+ };
3947
+ };
3948
+ sections: ({
3949
+ description: string;
3950
+ title: string;
3951
+ name: "user";
3952
+ operations: string[];
3953
+ schema: string;
3954
+ } | {
3955
+ description: string;
3956
+ title: string;
3957
+ name: "conversation";
3958
+ operations: string[];
3959
+ schema: string;
3960
+ } | {
3961
+ description: string;
3962
+ title: string;
3963
+ name: "event";
3964
+ operations: string[];
3965
+ schema: string;
3966
+ } | {
3967
+ description: string;
3968
+ title: string;
3969
+ name: "message";
3970
+ operations: string[];
3971
+ schema: string;
3972
+ } | {
3973
+ description: string;
3974
+ title: string;
3975
+ name: "file";
3976
+ operations: string[];
3977
+ schema: string;
3978
+ } | {
3979
+ description: string;
3980
+ title: string;
3981
+ name: "state";
3982
+ operations: string[];
3983
+ schema: string;
3984
+ } | {
3985
+ description: string;
3986
+ title: string;
3987
+ name: "hub";
3988
+ operations: string[];
3989
+ schema?: undefined;
3990
+ } | {
3991
+ description: string;
3992
+ title: string;
3993
+ name: "action";
3994
+ operations: string[];
3995
+ schema?: undefined;
3996
+ } | {
3997
+ description: string;
3998
+ title: string;
3999
+ name: "bot";
4000
+ operations: string[];
4001
+ schema: string;
4002
+ } | {
4003
+ description: string;
4004
+ title: string;
4005
+ name: "integration";
4006
+ operations: string[];
4007
+ schema: string;
4008
+ } | {
4009
+ description: string;
4010
+ title: string;
4011
+ name: "workspace";
4012
+ operations: never[];
4013
+ schema: string;
4014
+ })[];
4015
+ };