@botpress/client 0.0.13 → 0.1.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.
- package/dist/bundle.cjs +6 -6
- package/dist/bundle.cjs.map +4 -4
- package/dist/gen/api.d.ts +583 -197
- package/dist/gen/base.d.ts +1 -1
- package/dist/gen/common.d.ts +1 -1
- package/dist/gen/configuration.d.ts +1 -1
- package/dist/gen/index.d.ts +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.cjs.map +2 -2
- package/dist/index.mjs +1 -1
- package/openapi.ts +5 -0
- package/package.json +13 -10
package/dist/gen/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Botpress API
|
|
3
3
|
* API for Botpress Cloud
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.2.
|
|
5
|
+
* The version of the OpenAPI document: 0.2.2
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -51,6 +51,24 @@ export interface Bot {
|
|
|
51
51
|
'integrations': {
|
|
52
52
|
[key: string]: BotIntegrationsValue;
|
|
53
53
|
};
|
|
54
|
+
/**
|
|
55
|
+
*
|
|
56
|
+
* @type {BotUser}
|
|
57
|
+
* @memberof Bot
|
|
58
|
+
*/
|
|
59
|
+
'user': BotUser;
|
|
60
|
+
/**
|
|
61
|
+
*
|
|
62
|
+
* @type {BotConversation}
|
|
63
|
+
* @memberof Bot
|
|
64
|
+
*/
|
|
65
|
+
'conversation': BotConversation;
|
|
66
|
+
/**
|
|
67
|
+
*
|
|
68
|
+
* @type {BotMessage}
|
|
69
|
+
* @memberof Bot
|
|
70
|
+
*/
|
|
71
|
+
'message': BotMessage;
|
|
54
72
|
/**
|
|
55
73
|
* A mapping of states to their definition
|
|
56
74
|
* @type {{ [key: string]: CreateBotBodyStatesValue; }}
|
|
@@ -59,12 +77,6 @@ export interface Bot {
|
|
|
59
77
|
'states': {
|
|
60
78
|
[key: string]: CreateBotBodyStatesValue;
|
|
61
79
|
};
|
|
62
|
-
/**
|
|
63
|
-
*
|
|
64
|
-
* @type {CreateBotBodyTags}
|
|
65
|
-
* @memberof Bot
|
|
66
|
-
*/
|
|
67
|
-
'tags': CreateBotBodyTags;
|
|
68
80
|
/**
|
|
69
81
|
*
|
|
70
82
|
* @type {BotConfiguration}
|
|
@@ -141,6 +153,21 @@ export interface BotConfiguration {
|
|
|
141
153
|
[key: string]: any;
|
|
142
154
|
};
|
|
143
155
|
}
|
|
156
|
+
/**
|
|
157
|
+
* Conversation object configuration
|
|
158
|
+
* @export
|
|
159
|
+
* @interface BotConversation
|
|
160
|
+
*/
|
|
161
|
+
export interface BotConversation {
|
|
162
|
+
/**
|
|
163
|
+
*
|
|
164
|
+
* @type {{ [key: string]: CreateBotBodyUserTagsValue; }}
|
|
165
|
+
* @memberof BotConversation
|
|
166
|
+
*/
|
|
167
|
+
'tags': {
|
|
168
|
+
[key: string]: CreateBotBodyUserTagsValue;
|
|
169
|
+
};
|
|
170
|
+
}
|
|
144
171
|
/**
|
|
145
172
|
*
|
|
146
173
|
* @export
|
|
@@ -214,6 +241,36 @@ export interface BotMediasInner {
|
|
|
214
241
|
*/
|
|
215
242
|
'name': string;
|
|
216
243
|
}
|
|
244
|
+
/**
|
|
245
|
+
* Message object configuration
|
|
246
|
+
* @export
|
|
247
|
+
* @interface BotMessage
|
|
248
|
+
*/
|
|
249
|
+
export interface BotMessage {
|
|
250
|
+
/**
|
|
251
|
+
*
|
|
252
|
+
* @type {{ [key: string]: CreateBotBodyUserTagsValue; }}
|
|
253
|
+
* @memberof BotMessage
|
|
254
|
+
*/
|
|
255
|
+
'tags': {
|
|
256
|
+
[key: string]: CreateBotBodyUserTagsValue;
|
|
257
|
+
};
|
|
258
|
+
}
|
|
259
|
+
/**
|
|
260
|
+
* User object configuration
|
|
261
|
+
* @export
|
|
262
|
+
* @interface BotUser
|
|
263
|
+
*/
|
|
264
|
+
export interface BotUser {
|
|
265
|
+
/**
|
|
266
|
+
*
|
|
267
|
+
* @type {{ [key: string]: CreateBotBodyUserTagsValue; }}
|
|
268
|
+
* @memberof BotUser
|
|
269
|
+
*/
|
|
270
|
+
'tags': {
|
|
271
|
+
[key: string]: CreateBotBodyUserTagsValue;
|
|
272
|
+
};
|
|
273
|
+
}
|
|
217
274
|
/**
|
|
218
275
|
*
|
|
219
276
|
* @export
|
|
@@ -322,12 +379,6 @@ export interface CreateBotBody {
|
|
|
322
379
|
'states'?: {
|
|
323
380
|
[key: string]: CreateBotBodyStatesValue;
|
|
324
381
|
};
|
|
325
|
-
/**
|
|
326
|
-
*
|
|
327
|
-
* @type {CreateBotBodyTags}
|
|
328
|
-
* @memberof CreateBotBody
|
|
329
|
-
*/
|
|
330
|
-
'tags'?: CreateBotBodyTags;
|
|
331
382
|
/**
|
|
332
383
|
* Events definition
|
|
333
384
|
* @type {{ [key: string]: CreateBotBodyEventsValue; }}
|
|
@@ -350,6 +401,24 @@ export interface CreateBotBody {
|
|
|
350
401
|
* @memberof CreateBotBody
|
|
351
402
|
*/
|
|
352
403
|
'configuration'?: CreateBotBodyConfiguration;
|
|
404
|
+
/**
|
|
405
|
+
*
|
|
406
|
+
* @type {CreateBotBodyUser}
|
|
407
|
+
* @memberof CreateBotBody
|
|
408
|
+
*/
|
|
409
|
+
'user'?: CreateBotBodyUser;
|
|
410
|
+
/**
|
|
411
|
+
*
|
|
412
|
+
* @type {CreateBotBodyUser}
|
|
413
|
+
* @memberof CreateBotBody
|
|
414
|
+
*/
|
|
415
|
+
'conversation'?: CreateBotBodyUser;
|
|
416
|
+
/**
|
|
417
|
+
*
|
|
418
|
+
* @type {CreateBotBodyUser}
|
|
419
|
+
* @memberof CreateBotBody
|
|
420
|
+
*/
|
|
421
|
+
'message'?: CreateBotBodyUser;
|
|
353
422
|
/**
|
|
354
423
|
* JavaScript code of the bot
|
|
355
424
|
* @type {string}
|
|
@@ -405,7 +474,7 @@ export interface CreateBotBodyConfiguration {
|
|
|
405
474
|
};
|
|
406
475
|
}
|
|
407
476
|
/**
|
|
408
|
-
* Event
|
|
477
|
+
* Event Definition
|
|
409
478
|
* @export
|
|
410
479
|
* @interface CreateBotBodyEventsValue
|
|
411
480
|
*/
|
|
@@ -512,29 +581,38 @@ export declare const CreateBotBodyStatesValueTypeEnum: {
|
|
|
512
581
|
};
|
|
513
582
|
export type CreateBotBodyStatesValueTypeEnum = typeof CreateBotBodyStatesValueTypeEnum[keyof typeof CreateBotBodyStatesValueTypeEnum];
|
|
514
583
|
/**
|
|
515
|
-
*
|
|
584
|
+
*
|
|
516
585
|
* @export
|
|
517
|
-
* @interface
|
|
586
|
+
* @interface CreateBotBodyUser
|
|
518
587
|
*/
|
|
519
|
-
export interface
|
|
588
|
+
export interface CreateBotBodyUser {
|
|
520
589
|
/**
|
|
521
590
|
*
|
|
522
|
-
* @type {
|
|
523
|
-
* @memberof
|
|
591
|
+
* @type {{ [key: string]: CreateBotBodyUserTagsValue; }}
|
|
592
|
+
* @memberof CreateBotBodyUser
|
|
524
593
|
*/
|
|
525
|
-
'
|
|
594
|
+
'tags'?: {
|
|
595
|
+
[key: string]: CreateBotBodyUserTagsValue;
|
|
596
|
+
};
|
|
597
|
+
}
|
|
598
|
+
/**
|
|
599
|
+
* Definition of a tag that can be provided on the object
|
|
600
|
+
* @export
|
|
601
|
+
* @interface CreateBotBodyUserTagsValue
|
|
602
|
+
*/
|
|
603
|
+
export interface CreateBotBodyUserTagsValue {
|
|
526
604
|
/**
|
|
527
|
-
*
|
|
528
|
-
* @type {
|
|
529
|
-
* @memberof
|
|
605
|
+
* Title of the tag
|
|
606
|
+
* @type {string}
|
|
607
|
+
* @memberof CreateBotBodyUserTagsValue
|
|
530
608
|
*/
|
|
531
|
-
'
|
|
609
|
+
'title'?: string;
|
|
532
610
|
/**
|
|
533
|
-
*
|
|
534
|
-
* @type {
|
|
535
|
-
* @memberof
|
|
611
|
+
* Description of the tag
|
|
612
|
+
* @type {string}
|
|
613
|
+
* @memberof CreateBotBodyUserTagsValue
|
|
536
614
|
*/
|
|
537
|
-
'
|
|
615
|
+
'description'?: string;
|
|
538
616
|
}
|
|
539
617
|
/**
|
|
540
618
|
*
|
|
@@ -717,20 +795,12 @@ export interface CreateIntegrationBody {
|
|
|
717
795
|
'version': string;
|
|
718
796
|
/**
|
|
719
797
|
*
|
|
720
|
-
* @type {
|
|
721
|
-
* @memberof CreateIntegrationBody
|
|
722
|
-
*/
|
|
723
|
-
'tags'?: CreateIntegrationBodyTags;
|
|
724
|
-
/**
|
|
725
|
-
* Channels definition
|
|
726
|
-
* @type {{ [key: string]: CreateIntegrationBodyChannelsValue; }}
|
|
798
|
+
* @type {CreateIntegrationBodyConfiguration}
|
|
727
799
|
* @memberof CreateIntegrationBody
|
|
728
800
|
*/
|
|
729
|
-
'
|
|
730
|
-
[key: string]: CreateIntegrationBodyChannelsValue;
|
|
731
|
-
};
|
|
801
|
+
'configuration'?: CreateIntegrationBodyConfiguration;
|
|
732
802
|
/**
|
|
733
|
-
*
|
|
803
|
+
*
|
|
734
804
|
* @type {{ [key: string]: CreateIntegrationBodyStatesValue; }}
|
|
735
805
|
* @memberof CreateIntegrationBody
|
|
736
806
|
*/
|
|
@@ -739,12 +809,6 @@ export interface CreateIntegrationBody {
|
|
|
739
809
|
};
|
|
740
810
|
/**
|
|
741
811
|
*
|
|
742
|
-
* @type {CreateIntegrationBodyConfiguration}
|
|
743
|
-
* @memberof CreateIntegrationBody
|
|
744
|
-
*/
|
|
745
|
-
'configuration'?: CreateIntegrationBodyConfiguration;
|
|
746
|
-
/**
|
|
747
|
-
* Events definition
|
|
748
812
|
* @type {{ [key: string]: CreateBotBodyEventsValue; }}
|
|
749
813
|
* @memberof CreateIntegrationBody
|
|
750
814
|
*/
|
|
@@ -752,13 +816,21 @@ export interface CreateIntegrationBody {
|
|
|
752
816
|
[key: string]: CreateBotBodyEventsValue;
|
|
753
817
|
};
|
|
754
818
|
/**
|
|
755
|
-
*
|
|
819
|
+
*
|
|
756
820
|
* @type {{ [key: string]: CreateIntegrationBodyActionsValue; }}
|
|
757
821
|
* @memberof CreateIntegrationBody
|
|
758
822
|
*/
|
|
759
823
|
'actions'?: {
|
|
760
824
|
[key: string]: CreateIntegrationBodyActionsValue;
|
|
761
825
|
};
|
|
826
|
+
/**
|
|
827
|
+
*
|
|
828
|
+
* @type {{ [key: string]: CreateIntegrationBodyChannelsValue; }}
|
|
829
|
+
* @memberof CreateIntegrationBody
|
|
830
|
+
*/
|
|
831
|
+
'channels'?: {
|
|
832
|
+
[key: string]: CreateIntegrationBodyChannelsValue;
|
|
833
|
+
};
|
|
762
834
|
/**
|
|
763
835
|
*
|
|
764
836
|
* @type {CreateIntegrationBodyUser}
|
|
@@ -771,12 +843,6 @@ export interface CreateIntegrationBody {
|
|
|
771
843
|
* @memberof CreateIntegrationBody
|
|
772
844
|
*/
|
|
773
845
|
'code'?: string;
|
|
774
|
-
/**
|
|
775
|
-
* Whether the integration is public
|
|
776
|
-
* @type {boolean}
|
|
777
|
-
* @memberof CreateIntegrationBody
|
|
778
|
-
*/
|
|
779
|
-
'public'?: boolean;
|
|
780
846
|
/**
|
|
781
847
|
* URL of the integration; Only available for dev integrations
|
|
782
848
|
* @type {string}
|
|
@@ -815,36 +881,45 @@ export interface CreateIntegrationBody {
|
|
|
815
881
|
'description'?: string;
|
|
816
882
|
}
|
|
817
883
|
/**
|
|
818
|
-
*
|
|
884
|
+
* Action definition
|
|
819
885
|
* @export
|
|
820
886
|
* @interface CreateIntegrationBodyActionsValue
|
|
821
887
|
*/
|
|
822
888
|
export interface CreateIntegrationBodyActionsValue {
|
|
823
889
|
/**
|
|
824
890
|
*
|
|
825
|
-
* @type {
|
|
891
|
+
* @type {CreateIntegrationBodyActionsValueInput}
|
|
826
892
|
* @memberof CreateIntegrationBodyActionsValue
|
|
827
893
|
*/
|
|
828
|
-
'input':
|
|
894
|
+
'input': CreateIntegrationBodyActionsValueInput;
|
|
829
895
|
/**
|
|
830
896
|
*
|
|
831
|
-
* @type {
|
|
897
|
+
* @type {CreateIntegrationBodyActionsValueInput}
|
|
832
898
|
* @memberof CreateIntegrationBodyActionsValue
|
|
833
899
|
*/
|
|
834
|
-
'output':
|
|
900
|
+
'output': CreateIntegrationBodyActionsValueInput;
|
|
835
901
|
}
|
|
836
902
|
/**
|
|
837
903
|
*
|
|
838
904
|
* @export
|
|
839
|
-
* @interface
|
|
905
|
+
* @interface CreateIntegrationBodyActionsValueInput
|
|
840
906
|
*/
|
|
841
|
-
export interface
|
|
907
|
+
export interface CreateIntegrationBodyActionsValueInput {
|
|
842
908
|
/**
|
|
843
909
|
*
|
|
844
|
-
* @type {
|
|
845
|
-
* @memberof
|
|
910
|
+
* @type {{ [key: string]: any; }}
|
|
911
|
+
* @memberof CreateIntegrationBodyActionsValueInput
|
|
846
912
|
*/
|
|
847
|
-
'
|
|
913
|
+
'schema': {
|
|
914
|
+
[key: string]: any;
|
|
915
|
+
};
|
|
916
|
+
}
|
|
917
|
+
/**
|
|
918
|
+
*
|
|
919
|
+
* @export
|
|
920
|
+
* @interface CreateIntegrationBodyChannelsValue
|
|
921
|
+
*/
|
|
922
|
+
export interface CreateIntegrationBodyChannelsValue {
|
|
848
923
|
/**
|
|
849
924
|
*
|
|
850
925
|
* @type {{ [key: string]: CreateIntegrationBodyChannelsValueMessagesValue; }}
|
|
@@ -859,6 +934,12 @@ export interface CreateIntegrationBodyChannelsValue {
|
|
|
859
934
|
* @memberof CreateIntegrationBodyChannelsValue
|
|
860
935
|
*/
|
|
861
936
|
'conversation'?: CreateIntegrationBodyChannelsValueConversation;
|
|
937
|
+
/**
|
|
938
|
+
*
|
|
939
|
+
* @type {CreateBotBodyUser}
|
|
940
|
+
* @memberof CreateIntegrationBodyChannelsValue
|
|
941
|
+
*/
|
|
942
|
+
'message'?: CreateBotBodyUser;
|
|
862
943
|
}
|
|
863
944
|
/**
|
|
864
945
|
*
|
|
@@ -871,7 +952,15 @@ export interface CreateIntegrationBodyChannelsValueConversation {
|
|
|
871
952
|
* @type {CreateIntegrationBodyChannelsValueConversationCreation}
|
|
872
953
|
* @memberof CreateIntegrationBodyChannelsValueConversation
|
|
873
954
|
*/
|
|
874
|
-
'creation'
|
|
955
|
+
'creation'?: CreateIntegrationBodyChannelsValueConversationCreation;
|
|
956
|
+
/**
|
|
957
|
+
*
|
|
958
|
+
* @type {{ [key: string]: CreateBotBodyUserTagsValue; }}
|
|
959
|
+
* @memberof CreateIntegrationBodyChannelsValueConversation
|
|
960
|
+
*/
|
|
961
|
+
'tags'?: {
|
|
962
|
+
[key: string]: CreateBotBodyUserTagsValue;
|
|
963
|
+
};
|
|
875
964
|
}
|
|
876
965
|
/**
|
|
877
966
|
* The conversation creation setting determines how to create a conversation through the API directly. The integration will have to implement the `createConversation` functionality to support this setting.
|
|
@@ -893,7 +982,7 @@ export interface CreateIntegrationBodyChannelsValueConversationCreation {
|
|
|
893
982
|
'requiredTags': Array<string>;
|
|
894
983
|
}
|
|
895
984
|
/**
|
|
896
|
-
*
|
|
985
|
+
* Message definition
|
|
897
986
|
* @export
|
|
898
987
|
* @interface CreateIntegrationBodyChannelsValueMessagesValue
|
|
899
988
|
*/
|
|
@@ -907,25 +996,6 @@ export interface CreateIntegrationBodyChannelsValueMessagesValue {
|
|
|
907
996
|
[key: string]: any;
|
|
908
997
|
};
|
|
909
998
|
}
|
|
910
|
-
/**
|
|
911
|
-
*
|
|
912
|
-
* @export
|
|
913
|
-
* @interface CreateIntegrationBodyChannelsValueTags
|
|
914
|
-
*/
|
|
915
|
-
export interface CreateIntegrationBodyChannelsValueTags {
|
|
916
|
-
/**
|
|
917
|
-
*
|
|
918
|
-
* @type {Array<string>}
|
|
919
|
-
* @memberof CreateIntegrationBodyChannelsValueTags
|
|
920
|
-
*/
|
|
921
|
-
'messages'?: Array<string>;
|
|
922
|
-
/**
|
|
923
|
-
*
|
|
924
|
-
* @type {Array<string>}
|
|
925
|
-
* @memberof CreateIntegrationBodyChannelsValueTags
|
|
926
|
-
*/
|
|
927
|
-
'conversations'?: Array<string>;
|
|
928
|
-
}
|
|
929
999
|
/**
|
|
930
1000
|
* Configuration definition
|
|
931
1001
|
* @export
|
|
@@ -933,7 +1003,7 @@ export interface CreateIntegrationBodyChannelsValueTags {
|
|
|
933
1003
|
*/
|
|
934
1004
|
export interface CreateIntegrationBodyConfiguration {
|
|
935
1005
|
/**
|
|
936
|
-
* Schema
|
|
1006
|
+
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
937
1007
|
* @type {{ [key: string]: any; }}
|
|
938
1008
|
* @memberof CreateIntegrationBodyConfiguration
|
|
939
1009
|
*/
|
|
@@ -942,7 +1012,7 @@ export interface CreateIntegrationBodyConfiguration {
|
|
|
942
1012
|
};
|
|
943
1013
|
}
|
|
944
1014
|
/**
|
|
945
|
-
*
|
|
1015
|
+
* State definition
|
|
946
1016
|
* @export
|
|
947
1017
|
* @interface CreateIntegrationBodyStatesValue
|
|
948
1018
|
*/
|
|
@@ -968,19 +1038,6 @@ export declare const CreateIntegrationBodyStatesValueTypeEnum: {
|
|
|
968
1038
|
readonly Integration: "integration";
|
|
969
1039
|
};
|
|
970
1040
|
export type CreateIntegrationBodyStatesValueTypeEnum = typeof CreateIntegrationBodyStatesValueTypeEnum[keyof typeof CreateIntegrationBodyStatesValueTypeEnum];
|
|
971
|
-
/**
|
|
972
|
-
* Tags of the [Integration](#schema_integration)
|
|
973
|
-
* @export
|
|
974
|
-
* @interface CreateIntegrationBodyTags
|
|
975
|
-
*/
|
|
976
|
-
export interface CreateIntegrationBodyTags {
|
|
977
|
-
/**
|
|
978
|
-
*
|
|
979
|
-
* @type {Array<string>}
|
|
980
|
-
* @memberof CreateIntegrationBodyTags
|
|
981
|
-
*/
|
|
982
|
-
'users'?: Array<string>;
|
|
983
|
-
}
|
|
984
1041
|
/**
|
|
985
1042
|
*
|
|
986
1043
|
* @export
|
|
@@ -992,7 +1049,15 @@ export interface CreateIntegrationBodyUser {
|
|
|
992
1049
|
* @type {CreateIntegrationBodyUserCreation}
|
|
993
1050
|
* @memberof CreateIntegrationBodyUser
|
|
994
1051
|
*/
|
|
995
|
-
'creation'
|
|
1052
|
+
'creation'?: CreateIntegrationBodyUserCreation;
|
|
1053
|
+
/**
|
|
1054
|
+
*
|
|
1055
|
+
* @type {{ [key: string]: CreateBotBodyUserTagsValue; }}
|
|
1056
|
+
* @memberof CreateIntegrationBodyUser
|
|
1057
|
+
*/
|
|
1058
|
+
'tags'?: {
|
|
1059
|
+
[key: string]: CreateBotBodyUserTagsValue;
|
|
1060
|
+
};
|
|
996
1061
|
}
|
|
997
1062
|
/**
|
|
998
1063
|
* The user creation setting determines how to create a user through the API directly. The integration will have to implement the `createUser` functionality to support this setting.
|
|
@@ -1661,7 +1726,13 @@ export interface Integration {
|
|
|
1661
1726
|
*/
|
|
1662
1727
|
'version': string;
|
|
1663
1728
|
/**
|
|
1664
|
-
*
|
|
1729
|
+
*
|
|
1730
|
+
* @type {CreateIntegrationBodyConfiguration}
|
|
1731
|
+
* @memberof Integration
|
|
1732
|
+
*/
|
|
1733
|
+
'configuration': CreateIntegrationBodyConfiguration;
|
|
1734
|
+
/**
|
|
1735
|
+
*
|
|
1665
1736
|
* @type {{ [key: string]: IntegrationChannelsValue; }}
|
|
1666
1737
|
* @memberof Integration
|
|
1667
1738
|
*/
|
|
@@ -1669,21 +1740,15 @@ export interface Integration {
|
|
|
1669
1740
|
[key: string]: IntegrationChannelsValue;
|
|
1670
1741
|
};
|
|
1671
1742
|
/**
|
|
1672
|
-
*
|
|
1743
|
+
*
|
|
1673
1744
|
* @type {{ [key: string]: CreateIntegrationBodyStatesValue; }}
|
|
1674
1745
|
* @memberof Integration
|
|
1675
1746
|
*/
|
|
1676
|
-
'states'
|
|
1747
|
+
'states': {
|
|
1677
1748
|
[key: string]: CreateIntegrationBodyStatesValue;
|
|
1678
1749
|
};
|
|
1679
1750
|
/**
|
|
1680
1751
|
*
|
|
1681
|
-
* @type {CreateIntegrationBodyConfiguration}
|
|
1682
|
-
* @memberof Integration
|
|
1683
|
-
*/
|
|
1684
|
-
'configuration': CreateIntegrationBodyConfiguration;
|
|
1685
|
-
/**
|
|
1686
|
-
* Events definition
|
|
1687
1752
|
* @type {{ [key: string]: CreateBotBodyEventsValue; }}
|
|
1688
1753
|
* @memberof Integration
|
|
1689
1754
|
*/
|
|
@@ -1691,7 +1756,7 @@ export interface Integration {
|
|
|
1691
1756
|
[key: string]: CreateBotBodyEventsValue;
|
|
1692
1757
|
};
|
|
1693
1758
|
/**
|
|
1694
|
-
*
|
|
1759
|
+
*
|
|
1695
1760
|
* @type {{ [key: string]: CreateIntegrationBodyActionsValue; }}
|
|
1696
1761
|
* @memberof Integration
|
|
1697
1762
|
*/
|
|
@@ -1700,10 +1765,10 @@ export interface Integration {
|
|
|
1700
1765
|
};
|
|
1701
1766
|
/**
|
|
1702
1767
|
*
|
|
1703
|
-
* @type {
|
|
1768
|
+
* @type {IntegrationUser}
|
|
1704
1769
|
* @memberof Integration
|
|
1705
1770
|
*/
|
|
1706
|
-
'user':
|
|
1771
|
+
'user': IntegrationUser;
|
|
1707
1772
|
/**
|
|
1708
1773
|
* Indicates if the integration is a development integration; Dev integrations run locally
|
|
1709
1774
|
* @type {boolean}
|
|
@@ -1736,17 +1801,11 @@ export interface Integration {
|
|
|
1736
1801
|
'readmeUrl': string;
|
|
1737
1802
|
}
|
|
1738
1803
|
/**
|
|
1739
|
-
*
|
|
1804
|
+
* Channel definition
|
|
1740
1805
|
* @export
|
|
1741
1806
|
* @interface IntegrationChannelsValue
|
|
1742
1807
|
*/
|
|
1743
1808
|
export interface IntegrationChannelsValue {
|
|
1744
|
-
/**
|
|
1745
|
-
*
|
|
1746
|
-
* @type {CreateIntegrationBodyChannelsValueTags}
|
|
1747
|
-
* @memberof IntegrationChannelsValue
|
|
1748
|
-
*/
|
|
1749
|
-
'tags': CreateIntegrationBodyChannelsValueTags;
|
|
1750
1809
|
/**
|
|
1751
1810
|
*
|
|
1752
1811
|
* @type {{ [key: string]: CreateIntegrationBodyChannelsValueMessagesValue; }}
|
|
@@ -1757,10 +1816,58 @@ export interface IntegrationChannelsValue {
|
|
|
1757
1816
|
};
|
|
1758
1817
|
/**
|
|
1759
1818
|
*
|
|
1760
|
-
* @type {
|
|
1819
|
+
* @type {IntegrationChannelsValueConversation}
|
|
1820
|
+
* @memberof IntegrationChannelsValue
|
|
1821
|
+
*/
|
|
1822
|
+
'conversation': IntegrationChannelsValueConversation;
|
|
1823
|
+
/**
|
|
1824
|
+
*
|
|
1825
|
+
* @type {BotMessage}
|
|
1761
1826
|
* @memberof IntegrationChannelsValue
|
|
1762
1827
|
*/
|
|
1763
|
-
'
|
|
1828
|
+
'message': BotMessage;
|
|
1829
|
+
}
|
|
1830
|
+
/**
|
|
1831
|
+
* Conversation object configuration
|
|
1832
|
+
* @export
|
|
1833
|
+
* @interface IntegrationChannelsValueConversation
|
|
1834
|
+
*/
|
|
1835
|
+
export interface IntegrationChannelsValueConversation {
|
|
1836
|
+
/**
|
|
1837
|
+
*
|
|
1838
|
+
* @type {{ [key: string]: CreateBotBodyUserTagsValue; }}
|
|
1839
|
+
* @memberof IntegrationChannelsValueConversation
|
|
1840
|
+
*/
|
|
1841
|
+
'tags': {
|
|
1842
|
+
[key: string]: CreateBotBodyUserTagsValue;
|
|
1843
|
+
};
|
|
1844
|
+
/**
|
|
1845
|
+
*
|
|
1846
|
+
* @type {CreateIntegrationBodyChannelsValueConversationCreation}
|
|
1847
|
+
* @memberof IntegrationChannelsValueConversation
|
|
1848
|
+
*/
|
|
1849
|
+
'creation': CreateIntegrationBodyChannelsValueConversationCreation;
|
|
1850
|
+
}
|
|
1851
|
+
/**
|
|
1852
|
+
* User object configuration
|
|
1853
|
+
* @export
|
|
1854
|
+
* @interface IntegrationUser
|
|
1855
|
+
*/
|
|
1856
|
+
export interface IntegrationUser {
|
|
1857
|
+
/**
|
|
1858
|
+
*
|
|
1859
|
+
* @type {{ [key: string]: CreateBotBodyUserTagsValue; }}
|
|
1860
|
+
* @memberof IntegrationUser
|
|
1861
|
+
*/
|
|
1862
|
+
'tags': {
|
|
1863
|
+
[key: string]: CreateBotBodyUserTagsValue;
|
|
1864
|
+
};
|
|
1865
|
+
/**
|
|
1866
|
+
*
|
|
1867
|
+
* @type {CreateIntegrationBodyUserCreation}
|
|
1868
|
+
* @memberof IntegrationUser
|
|
1869
|
+
*/
|
|
1870
|
+
'creation': CreateIntegrationBodyUserCreation;
|
|
1764
1871
|
}
|
|
1765
1872
|
/**
|
|
1766
1873
|
*
|
|
@@ -2395,54 +2502,66 @@ export interface UpdateBotBody {
|
|
|
2395
2502
|
*/
|
|
2396
2503
|
'authentication'?: UpdateBotBodyAuthenticationEnum;
|
|
2397
2504
|
/**
|
|
2398
|
-
*
|
|
2399
|
-
* @type {
|
|
2505
|
+
*
|
|
2506
|
+
* @type {CreateBotBodyConfiguration}
|
|
2400
2507
|
* @memberof UpdateBotBody
|
|
2401
2508
|
*/
|
|
2402
|
-
'
|
|
2403
|
-
[key: string]: CreateBotBodyStatesValue;
|
|
2404
|
-
};
|
|
2509
|
+
'configuration'?: CreateBotBodyConfiguration;
|
|
2405
2510
|
/**
|
|
2406
2511
|
*
|
|
2407
|
-
* @type {
|
|
2512
|
+
* @type {boolean}
|
|
2408
2513
|
* @memberof UpdateBotBody
|
|
2409
2514
|
*/
|
|
2410
|
-
'
|
|
2515
|
+
'blocked'?: boolean;
|
|
2411
2516
|
/**
|
|
2412
|
-
*
|
|
2413
|
-
* @type {
|
|
2517
|
+
*
|
|
2518
|
+
* @type {UpdateBotBodyUser}
|
|
2414
2519
|
* @memberof UpdateBotBody
|
|
2415
2520
|
*/
|
|
2416
|
-
'
|
|
2417
|
-
[key: string]: CreateBotBodyEventsValue;
|
|
2418
|
-
};
|
|
2521
|
+
'user'?: UpdateBotBodyUser;
|
|
2419
2522
|
/**
|
|
2420
|
-
*
|
|
2421
|
-
* @type {
|
|
2523
|
+
*
|
|
2524
|
+
* @type {UpdateBotBodyUser}
|
|
2422
2525
|
* @memberof UpdateBotBody
|
|
2423
2526
|
*/
|
|
2424
|
-
'
|
|
2425
|
-
|
|
2527
|
+
'message'?: UpdateBotBodyUser;
|
|
2528
|
+
/**
|
|
2529
|
+
*
|
|
2530
|
+
* @type {UpdateBotBodyUser}
|
|
2531
|
+
* @memberof UpdateBotBody
|
|
2532
|
+
*/
|
|
2533
|
+
'conversation'?: UpdateBotBodyUser;
|
|
2534
|
+
/**
|
|
2535
|
+
*
|
|
2536
|
+
* @type {{ [key: string]: UpdateBotBodyEventsValue | null; }}
|
|
2537
|
+
* @memberof UpdateBotBody
|
|
2538
|
+
*/
|
|
2539
|
+
'events'?: {
|
|
2540
|
+
[key: string]: UpdateBotBodyEventsValue | null;
|
|
2426
2541
|
};
|
|
2427
2542
|
/**
|
|
2428
2543
|
*
|
|
2429
|
-
* @type {
|
|
2544
|
+
* @type {{ [key: string]: UpdateBotBodyStatesValue | null; }}
|
|
2430
2545
|
* @memberof UpdateBotBody
|
|
2431
2546
|
*/
|
|
2432
|
-
'
|
|
2547
|
+
'states'?: {
|
|
2548
|
+
[key: string]: UpdateBotBodyStatesValue | null;
|
|
2549
|
+
};
|
|
2433
2550
|
/**
|
|
2434
2551
|
*
|
|
2435
|
-
* @type {
|
|
2552
|
+
* @type {{ [key: string]: UpdateBotBodyRecurringEventsValue | null; }}
|
|
2436
2553
|
* @memberof UpdateBotBody
|
|
2437
2554
|
*/
|
|
2438
|
-
'
|
|
2555
|
+
'recurringEvents'?: {
|
|
2556
|
+
[key: string]: UpdateBotBodyRecurringEventsValue | null;
|
|
2557
|
+
};
|
|
2439
2558
|
/**
|
|
2440
2559
|
*
|
|
2441
|
-
* @type {{ [key: string]: UpdateBotBodyIntegrationsValue; }}
|
|
2560
|
+
* @type {{ [key: string]: UpdateBotBodyIntegrationsValue | null; }}
|
|
2442
2561
|
* @memberof UpdateBotBody
|
|
2443
2562
|
*/
|
|
2444
2563
|
'integrations'?: {
|
|
2445
|
-
[key: string]: UpdateBotBodyIntegrationsValue;
|
|
2564
|
+
[key: string]: UpdateBotBodyIntegrationsValue | null;
|
|
2446
2565
|
};
|
|
2447
2566
|
/**
|
|
2448
2567
|
* JavaScript code of the bot
|
|
@@ -2467,6 +2586,21 @@ export declare const UpdateBotBodyAuthenticationEnum: {
|
|
|
2467
2586
|
readonly Iam: "iam";
|
|
2468
2587
|
};
|
|
2469
2588
|
export type UpdateBotBodyAuthenticationEnum = typeof UpdateBotBodyAuthenticationEnum[keyof typeof UpdateBotBodyAuthenticationEnum];
|
|
2589
|
+
/**
|
|
2590
|
+
* Event Definition
|
|
2591
|
+
* @export
|
|
2592
|
+
* @interface UpdateBotBodyEventsValue
|
|
2593
|
+
*/
|
|
2594
|
+
export interface UpdateBotBodyEventsValue {
|
|
2595
|
+
/**
|
|
2596
|
+
*
|
|
2597
|
+
* @type {{ [key: string]: any; }}
|
|
2598
|
+
* @memberof UpdateBotBodyEventsValue
|
|
2599
|
+
*/
|
|
2600
|
+
'schema': {
|
|
2601
|
+
[key: string]: any;
|
|
2602
|
+
};
|
|
2603
|
+
}
|
|
2470
2604
|
/**
|
|
2471
2605
|
*
|
|
2472
2606
|
* @export
|
|
@@ -2488,6 +2622,100 @@ export interface UpdateBotBodyIntegrationsValue {
|
|
|
2488
2622
|
[key: string]: any;
|
|
2489
2623
|
};
|
|
2490
2624
|
}
|
|
2625
|
+
/**
|
|
2626
|
+
*
|
|
2627
|
+
* @export
|
|
2628
|
+
* @interface UpdateBotBodyRecurringEventsValue
|
|
2629
|
+
*/
|
|
2630
|
+
export interface UpdateBotBodyRecurringEventsValue {
|
|
2631
|
+
/**
|
|
2632
|
+
*
|
|
2633
|
+
* @type {CreateBotBodyRecurringEventsValueSchedule}
|
|
2634
|
+
* @memberof UpdateBotBodyRecurringEventsValue
|
|
2635
|
+
*/
|
|
2636
|
+
'schedule': CreateBotBodyRecurringEventsValueSchedule;
|
|
2637
|
+
/**
|
|
2638
|
+
*
|
|
2639
|
+
* @type {string}
|
|
2640
|
+
* @memberof UpdateBotBodyRecurringEventsValue
|
|
2641
|
+
*/
|
|
2642
|
+
'type': string;
|
|
2643
|
+
/**
|
|
2644
|
+
*
|
|
2645
|
+
* @type {{ [key: string]: any; }}
|
|
2646
|
+
* @memberof UpdateBotBodyRecurringEventsValue
|
|
2647
|
+
*/
|
|
2648
|
+
'payload': {
|
|
2649
|
+
[key: string]: any;
|
|
2650
|
+
};
|
|
2651
|
+
}
|
|
2652
|
+
/**
|
|
2653
|
+
*
|
|
2654
|
+
* @export
|
|
2655
|
+
* @interface UpdateBotBodyStatesValue
|
|
2656
|
+
*/
|
|
2657
|
+
export interface UpdateBotBodyStatesValue {
|
|
2658
|
+
/**
|
|
2659
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
2660
|
+
* @type {string}
|
|
2661
|
+
* @memberof UpdateBotBodyStatesValue
|
|
2662
|
+
*/
|
|
2663
|
+
'type': UpdateBotBodyStatesValueTypeEnum;
|
|
2664
|
+
/**
|
|
2665
|
+
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
2666
|
+
* @type {{ [key: string]: any; }}
|
|
2667
|
+
* @memberof UpdateBotBodyStatesValue
|
|
2668
|
+
*/
|
|
2669
|
+
'schema': {
|
|
2670
|
+
[key: string]: any;
|
|
2671
|
+
};
|
|
2672
|
+
/**
|
|
2673
|
+
* Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn\'t expire.
|
|
2674
|
+
* @type {number}
|
|
2675
|
+
* @memberof UpdateBotBodyStatesValue
|
|
2676
|
+
*/
|
|
2677
|
+
'expiry'?: number;
|
|
2678
|
+
}
|
|
2679
|
+
export declare const UpdateBotBodyStatesValueTypeEnum: {
|
|
2680
|
+
readonly Conversation: "conversation";
|
|
2681
|
+
readonly User: "user";
|
|
2682
|
+
readonly Bot: "bot";
|
|
2683
|
+
};
|
|
2684
|
+
export type UpdateBotBodyStatesValueTypeEnum = typeof UpdateBotBodyStatesValueTypeEnum[keyof typeof UpdateBotBodyStatesValueTypeEnum];
|
|
2685
|
+
/**
|
|
2686
|
+
*
|
|
2687
|
+
* @export
|
|
2688
|
+
* @interface UpdateBotBodyUser
|
|
2689
|
+
*/
|
|
2690
|
+
export interface UpdateBotBodyUser {
|
|
2691
|
+
/**
|
|
2692
|
+
*
|
|
2693
|
+
* @type {{ [key: string]: UpdateBotBodyUserTagsValue | null; }}
|
|
2694
|
+
* @memberof UpdateBotBodyUser
|
|
2695
|
+
*/
|
|
2696
|
+
'tags'?: {
|
|
2697
|
+
[key: string]: UpdateBotBodyUserTagsValue | null;
|
|
2698
|
+
};
|
|
2699
|
+
}
|
|
2700
|
+
/**
|
|
2701
|
+
* Definition of a tag that can be provided on the object
|
|
2702
|
+
* @export
|
|
2703
|
+
* @interface UpdateBotBodyUserTagsValue
|
|
2704
|
+
*/
|
|
2705
|
+
export interface UpdateBotBodyUserTagsValue {
|
|
2706
|
+
/**
|
|
2707
|
+
* Title of the tag
|
|
2708
|
+
* @type {string}
|
|
2709
|
+
* @memberof UpdateBotBodyUserTagsValue
|
|
2710
|
+
*/
|
|
2711
|
+
'title'?: string;
|
|
2712
|
+
/**
|
|
2713
|
+
* Description of the tag
|
|
2714
|
+
* @type {string}
|
|
2715
|
+
* @memberof UpdateBotBodyUserTagsValue
|
|
2716
|
+
*/
|
|
2717
|
+
'description'?: string;
|
|
2718
|
+
}
|
|
2491
2719
|
/**
|
|
2492
2720
|
*
|
|
2493
2721
|
* @export
|
|
@@ -2543,72 +2771,54 @@ export interface UpdateConversationResponse {
|
|
|
2543
2771
|
export interface UpdateIntegrationBody {
|
|
2544
2772
|
/**
|
|
2545
2773
|
*
|
|
2546
|
-
* @type {
|
|
2774
|
+
* @type {CreateIntegrationBodyConfiguration}
|
|
2547
2775
|
* @memberof UpdateIntegrationBody
|
|
2548
2776
|
*/
|
|
2549
|
-
'
|
|
2777
|
+
'configuration'?: CreateIntegrationBodyConfiguration;
|
|
2550
2778
|
/**
|
|
2551
|
-
*
|
|
2552
|
-
* @type {{ [key: string]:
|
|
2779
|
+
*
|
|
2780
|
+
* @type {{ [key: string]: UpdateIntegrationBodyChannelsValue; }}
|
|
2553
2781
|
* @memberof UpdateIntegrationBody
|
|
2554
2782
|
*/
|
|
2555
2783
|
'channels'?: {
|
|
2556
|
-
[key: string]:
|
|
2784
|
+
[key: string]: UpdateIntegrationBodyChannelsValue;
|
|
2557
2785
|
};
|
|
2558
2786
|
/**
|
|
2559
|
-
*
|
|
2560
|
-
* @type {{ [key: string]:
|
|
2787
|
+
*
|
|
2788
|
+
* @type {{ [key: string]: UpdateIntegrationBodyActionsValue | null; }}
|
|
2561
2789
|
* @memberof UpdateIntegrationBody
|
|
2562
2790
|
*/
|
|
2563
|
-
'
|
|
2564
|
-
[key: string]:
|
|
2791
|
+
'actions'?: {
|
|
2792
|
+
[key: string]: UpdateIntegrationBodyActionsValue | null;
|
|
2565
2793
|
};
|
|
2566
2794
|
/**
|
|
2567
2795
|
*
|
|
2568
|
-
* @type {
|
|
2569
|
-
* @memberof UpdateIntegrationBody
|
|
2570
|
-
*/
|
|
2571
|
-
'configuration'?: CreateIntegrationBodyConfiguration;
|
|
2572
|
-
/**
|
|
2573
|
-
* Events definition
|
|
2574
|
-
* @type {{ [key: string]: CreateBotBodyEventsValue; }}
|
|
2796
|
+
* @type {{ [key: string]: UpdateBotBodyEventsValue | null; }}
|
|
2575
2797
|
* @memberof UpdateIntegrationBody
|
|
2576
2798
|
*/
|
|
2577
2799
|
'events'?: {
|
|
2578
|
-
[key: string]:
|
|
2800
|
+
[key: string]: UpdateBotBodyEventsValue | null;
|
|
2579
2801
|
};
|
|
2580
2802
|
/**
|
|
2581
|
-
*
|
|
2582
|
-
* @type {{ [key: string]:
|
|
2803
|
+
*
|
|
2804
|
+
* @type {{ [key: string]: UpdateIntegrationBodyStatesValue | null; }}
|
|
2583
2805
|
* @memberof UpdateIntegrationBody
|
|
2584
2806
|
*/
|
|
2585
|
-
'
|
|
2586
|
-
[key: string]:
|
|
2807
|
+
'states'?: {
|
|
2808
|
+
[key: string]: UpdateIntegrationBodyStatesValue | null;
|
|
2587
2809
|
};
|
|
2588
2810
|
/**
|
|
2589
2811
|
*
|
|
2590
|
-
* @type {
|
|
2812
|
+
* @type {UpdateIntegrationBodyUser}
|
|
2591
2813
|
* @memberof UpdateIntegrationBody
|
|
2592
2814
|
*/
|
|
2593
|
-
'user'?:
|
|
2815
|
+
'user'?: UpdateIntegrationBodyUser;
|
|
2594
2816
|
/**
|
|
2595
2817
|
* JavaScript code of the integration
|
|
2596
2818
|
* @type {string}
|
|
2597
2819
|
* @memberof UpdateIntegrationBody
|
|
2598
2820
|
*/
|
|
2599
2821
|
'code'?: string;
|
|
2600
|
-
/**
|
|
2601
|
-
* Whether the integration is public
|
|
2602
|
-
* @type {boolean}
|
|
2603
|
-
* @memberof UpdateIntegrationBody
|
|
2604
|
-
*/
|
|
2605
|
-
'public'?: boolean;
|
|
2606
|
-
/**
|
|
2607
|
-
* URL of the integration; Only available for dev integrations
|
|
2608
|
-
* @type {string}
|
|
2609
|
-
* @memberof UpdateIntegrationBody
|
|
2610
|
-
*/
|
|
2611
|
-
'url'?: string;
|
|
2612
2822
|
/**
|
|
2613
2823
|
* Base64 encoded svg of the integration icon. This icon is global to the integration each versions will be updated when this changes.
|
|
2614
2824
|
* @type {string}
|
|
@@ -2633,6 +2843,142 @@ export interface UpdateIntegrationBody {
|
|
|
2633
2843
|
* @memberof UpdateIntegrationBody
|
|
2634
2844
|
*/
|
|
2635
2845
|
'description'?: string;
|
|
2846
|
+
/**
|
|
2847
|
+
* URL of the integration; Only available for dev integrations
|
|
2848
|
+
* @type {string}
|
|
2849
|
+
* @memberof UpdateIntegrationBody
|
|
2850
|
+
*/
|
|
2851
|
+
'url'?: string;
|
|
2852
|
+
}
|
|
2853
|
+
/**
|
|
2854
|
+
* Action definition
|
|
2855
|
+
* @export
|
|
2856
|
+
* @interface UpdateIntegrationBodyActionsValue
|
|
2857
|
+
*/
|
|
2858
|
+
export interface UpdateIntegrationBodyActionsValue {
|
|
2859
|
+
/**
|
|
2860
|
+
*
|
|
2861
|
+
* @type {CreateIntegrationBodyActionsValueInput}
|
|
2862
|
+
* @memberof UpdateIntegrationBodyActionsValue
|
|
2863
|
+
*/
|
|
2864
|
+
'input': CreateIntegrationBodyActionsValueInput;
|
|
2865
|
+
/**
|
|
2866
|
+
*
|
|
2867
|
+
* @type {CreateIntegrationBodyActionsValueInput}
|
|
2868
|
+
* @memberof UpdateIntegrationBodyActionsValue
|
|
2869
|
+
*/
|
|
2870
|
+
'output': CreateIntegrationBodyActionsValueInput;
|
|
2871
|
+
}
|
|
2872
|
+
/**
|
|
2873
|
+
*
|
|
2874
|
+
* @export
|
|
2875
|
+
* @interface UpdateIntegrationBodyChannelsValue
|
|
2876
|
+
*/
|
|
2877
|
+
export interface UpdateIntegrationBodyChannelsValue {
|
|
2878
|
+
/**
|
|
2879
|
+
*
|
|
2880
|
+
* @type {{ [key: string]: UpdateIntegrationBodyChannelsValueMessagesValue | null; }}
|
|
2881
|
+
* @memberof UpdateIntegrationBodyChannelsValue
|
|
2882
|
+
*/
|
|
2883
|
+
'messages'?: {
|
|
2884
|
+
[key: string]: UpdateIntegrationBodyChannelsValueMessagesValue | null;
|
|
2885
|
+
};
|
|
2886
|
+
/**
|
|
2887
|
+
*
|
|
2888
|
+
* @type {UpdateIntegrationBodyChannelsValueConversation}
|
|
2889
|
+
* @memberof UpdateIntegrationBodyChannelsValue
|
|
2890
|
+
*/
|
|
2891
|
+
'conversation'?: UpdateIntegrationBodyChannelsValueConversation;
|
|
2892
|
+
/**
|
|
2893
|
+
*
|
|
2894
|
+
* @type {UpdateBotBodyUser}
|
|
2895
|
+
* @memberof UpdateIntegrationBodyChannelsValue
|
|
2896
|
+
*/
|
|
2897
|
+
'message'?: UpdateBotBodyUser;
|
|
2898
|
+
}
|
|
2899
|
+
/**
|
|
2900
|
+
*
|
|
2901
|
+
* @export
|
|
2902
|
+
* @interface UpdateIntegrationBodyChannelsValueConversation
|
|
2903
|
+
*/
|
|
2904
|
+
export interface UpdateIntegrationBodyChannelsValueConversation {
|
|
2905
|
+
/**
|
|
2906
|
+
*
|
|
2907
|
+
* @type {CreateIntegrationBodyChannelsValueConversationCreation}
|
|
2908
|
+
* @memberof UpdateIntegrationBodyChannelsValueConversation
|
|
2909
|
+
*/
|
|
2910
|
+
'creation'?: CreateIntegrationBodyChannelsValueConversationCreation;
|
|
2911
|
+
/**
|
|
2912
|
+
*
|
|
2913
|
+
* @type {{ [key: string]: UpdateBotBodyUserTagsValue | null; }}
|
|
2914
|
+
* @memberof UpdateIntegrationBodyChannelsValueConversation
|
|
2915
|
+
*/
|
|
2916
|
+
'tags'?: {
|
|
2917
|
+
[key: string]: UpdateBotBodyUserTagsValue | null;
|
|
2918
|
+
};
|
|
2919
|
+
}
|
|
2920
|
+
/**
|
|
2921
|
+
* Message definition
|
|
2922
|
+
* @export
|
|
2923
|
+
* @interface UpdateIntegrationBodyChannelsValueMessagesValue
|
|
2924
|
+
*/
|
|
2925
|
+
export interface UpdateIntegrationBodyChannelsValueMessagesValue {
|
|
2926
|
+
/**
|
|
2927
|
+
*
|
|
2928
|
+
* @type {{ [key: string]: any; }}
|
|
2929
|
+
* @memberof UpdateIntegrationBodyChannelsValueMessagesValue
|
|
2930
|
+
*/
|
|
2931
|
+
'schema': {
|
|
2932
|
+
[key: string]: any;
|
|
2933
|
+
};
|
|
2934
|
+
}
|
|
2935
|
+
/**
|
|
2936
|
+
* State definition
|
|
2937
|
+
* @export
|
|
2938
|
+
* @interface UpdateIntegrationBodyStatesValue
|
|
2939
|
+
*/
|
|
2940
|
+
export interface UpdateIntegrationBodyStatesValue {
|
|
2941
|
+
/**
|
|
2942
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `integration`)
|
|
2943
|
+
* @type {string}
|
|
2944
|
+
* @memberof UpdateIntegrationBodyStatesValue
|
|
2945
|
+
*/
|
|
2946
|
+
'type': UpdateIntegrationBodyStatesValueTypeEnum;
|
|
2947
|
+
/**
|
|
2948
|
+
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
2949
|
+
* @type {{ [key: string]: any; }}
|
|
2950
|
+
* @memberof UpdateIntegrationBodyStatesValue
|
|
2951
|
+
*/
|
|
2952
|
+
'schema': {
|
|
2953
|
+
[key: string]: any;
|
|
2954
|
+
};
|
|
2955
|
+
}
|
|
2956
|
+
export declare const UpdateIntegrationBodyStatesValueTypeEnum: {
|
|
2957
|
+
readonly Conversation: "conversation";
|
|
2958
|
+
readonly User: "user";
|
|
2959
|
+
readonly Integration: "integration";
|
|
2960
|
+
};
|
|
2961
|
+
export type UpdateIntegrationBodyStatesValueTypeEnum = typeof UpdateIntegrationBodyStatesValueTypeEnum[keyof typeof UpdateIntegrationBodyStatesValueTypeEnum];
|
|
2962
|
+
/**
|
|
2963
|
+
*
|
|
2964
|
+
* @export
|
|
2965
|
+
* @interface UpdateIntegrationBodyUser
|
|
2966
|
+
*/
|
|
2967
|
+
export interface UpdateIntegrationBodyUser {
|
|
2968
|
+
/**
|
|
2969
|
+
*
|
|
2970
|
+
* @type {CreateIntegrationBodyUserCreation}
|
|
2971
|
+
* @memberof UpdateIntegrationBodyUser
|
|
2972
|
+
*/
|
|
2973
|
+
'creation'?: CreateIntegrationBodyUserCreation;
|
|
2974
|
+
/**
|
|
2975
|
+
*
|
|
2976
|
+
* @type {{ [key: string]: UpdateBotBodyUserTagsValue | null; }}
|
|
2977
|
+
* @memberof UpdateIntegrationBodyUser
|
|
2978
|
+
*/
|
|
2979
|
+
'tags'?: {
|
|
2980
|
+
[key: string]: UpdateBotBodyUserTagsValue | null;
|
|
2981
|
+
};
|
|
2636
2982
|
}
|
|
2637
2983
|
/**
|
|
2638
2984
|
*
|
|
@@ -2934,11 +3280,11 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2934
3280
|
/**
|
|
2935
3281
|
* Get the webchat code/URL for a bot
|
|
2936
3282
|
* @param {string} id Bot ID
|
|
2937
|
-
* @param {
|
|
3283
|
+
* @param {GetBotWebchatTypeEnum} type type of script to get
|
|
2938
3284
|
* @param {*} [options] Override http request option.
|
|
2939
3285
|
* @throws {RequiredError}
|
|
2940
3286
|
*/
|
|
2941
|
-
getBotWebchat: (id: string, type:
|
|
3287
|
+
getBotWebchat: (id: string, type: GetBotWebchatTypeEnum, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2942
3288
|
/**
|
|
2943
3289
|
* Retrieves the [Conversation](#schema_conversation) object for a valid identifier.
|
|
2944
3290
|
* @param {string} id Conversation id
|
|
@@ -3027,13 +3373,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
3027
3373
|
getPublicIntegrationById: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3028
3374
|
/**
|
|
3029
3375
|
* Retrieves the [State](#schema_state) object for a valid identifiers.
|
|
3030
|
-
* @param {
|
|
3376
|
+
* @param {GetStateTypeEnum} type State type
|
|
3031
3377
|
* @param {string} id State id
|
|
3032
3378
|
* @param {string} name State name
|
|
3033
3379
|
* @param {*} [options] Override http request option.
|
|
3034
3380
|
* @throws {RequiredError}
|
|
3035
3381
|
*/
|
|
3036
|
-
getState: (type:
|
|
3382
|
+
getState: (type: GetStateTypeEnum, id: string, name: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3037
3383
|
/**
|
|
3038
3384
|
* Retrieves the [User](#schema_user) object for a valid identifier.
|
|
3039
3385
|
* @param {string} id User ID
|
|
@@ -3138,24 +3484,24 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
3138
3484
|
listWorkspaces: (nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3139
3485
|
/**
|
|
3140
3486
|
* Updates the [State](#schema_state) object by setting the values of the parameters passed.
|
|
3141
|
-
* @param {
|
|
3487
|
+
* @param {PatchStateTypeEnum} type State type
|
|
3142
3488
|
* @param {string} id State id
|
|
3143
3489
|
* @param {string} name State name
|
|
3144
3490
|
* @param {PatchStateBody} [patchStateBody] State content
|
|
3145
3491
|
* @param {*} [options] Override http request option.
|
|
3146
3492
|
* @throws {RequiredError}
|
|
3147
3493
|
*/
|
|
3148
|
-
patchState: (type:
|
|
3494
|
+
patchState: (type: PatchStateTypeEnum, id: string, name: string, patchStateBody?: PatchStateBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3149
3495
|
/**
|
|
3150
3496
|
* Overrides the [State](#schema_state) object by setting the values of the parameters passed.
|
|
3151
|
-
* @param {
|
|
3497
|
+
* @param {SetStateTypeEnum} type State type
|
|
3152
3498
|
* @param {string} id State id
|
|
3153
3499
|
* @param {string} name State name
|
|
3154
3500
|
* @param {SetStateBody} [setStateBody] State content
|
|
3155
3501
|
* @param {*} [options] Override http request option.
|
|
3156
3502
|
* @throws {RequiredError}
|
|
3157
3503
|
*/
|
|
3158
|
-
setState: (type:
|
|
3504
|
+
setState: (type: SetStateTypeEnum, id: string, name: string, setStateBody?: SetStateBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3159
3505
|
/**
|
|
3160
3506
|
* Transfer bot to another workspace. You need to be a Manager member of the workspace the bot currently belongs to and have permission to create bots in the target workspace.
|
|
3161
3507
|
* @param {string} id Bot ID
|
|
@@ -3348,11 +3694,11 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
3348
3694
|
/**
|
|
3349
3695
|
* Get the webchat code/URL for a bot
|
|
3350
3696
|
* @param {string} id Bot ID
|
|
3351
|
-
* @param {
|
|
3697
|
+
* @param {GetBotWebchatTypeEnum} type type of script to get
|
|
3352
3698
|
* @param {*} [options] Override http request option.
|
|
3353
3699
|
* @throws {RequiredError}
|
|
3354
3700
|
*/
|
|
3355
|
-
getBotWebchat(id: string, type:
|
|
3701
|
+
getBotWebchat(id: string, type: GetBotWebchatTypeEnum, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBotWebchatResponse>>;
|
|
3356
3702
|
/**
|
|
3357
3703
|
* Retrieves the [Conversation](#schema_conversation) object for a valid identifier.
|
|
3358
3704
|
* @param {string} id Conversation id
|
|
@@ -3441,13 +3787,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
3441
3787
|
getPublicIntegrationById(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPublicIntegrationByIdResponse>>;
|
|
3442
3788
|
/**
|
|
3443
3789
|
* Retrieves the [State](#schema_state) object for a valid identifiers.
|
|
3444
|
-
* @param {
|
|
3790
|
+
* @param {GetStateTypeEnum} type State type
|
|
3445
3791
|
* @param {string} id State id
|
|
3446
3792
|
* @param {string} name State name
|
|
3447
3793
|
* @param {*} [options] Override http request option.
|
|
3448
3794
|
* @throws {RequiredError}
|
|
3449
3795
|
*/
|
|
3450
|
-
getState(type:
|
|
3796
|
+
getState(type: GetStateTypeEnum, id: string, name: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStateResponse>>;
|
|
3451
3797
|
/**
|
|
3452
3798
|
* Retrieves the [User](#schema_user) object for a valid identifier.
|
|
3453
3799
|
* @param {string} id User ID
|
|
@@ -3552,24 +3898,24 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
3552
3898
|
listWorkspaces(nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListWorkspacesResponse>>;
|
|
3553
3899
|
/**
|
|
3554
3900
|
* Updates the [State](#schema_state) object by setting the values of the parameters passed.
|
|
3555
|
-
* @param {
|
|
3901
|
+
* @param {PatchStateTypeEnum} type State type
|
|
3556
3902
|
* @param {string} id State id
|
|
3557
3903
|
* @param {string} name State name
|
|
3558
3904
|
* @param {PatchStateBody} [patchStateBody] State content
|
|
3559
3905
|
* @param {*} [options] Override http request option.
|
|
3560
3906
|
* @throws {RequiredError}
|
|
3561
3907
|
*/
|
|
3562
|
-
patchState(type:
|
|
3908
|
+
patchState(type: PatchStateTypeEnum, id: string, name: string, patchStateBody?: PatchStateBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchStateResponse>>;
|
|
3563
3909
|
/**
|
|
3564
3910
|
* Overrides the [State](#schema_state) object by setting the values of the parameters passed.
|
|
3565
|
-
* @param {
|
|
3911
|
+
* @param {SetStateTypeEnum} type State type
|
|
3566
3912
|
* @param {string} id State id
|
|
3567
3913
|
* @param {string} name State name
|
|
3568
3914
|
* @param {SetStateBody} [setStateBody] State content
|
|
3569
3915
|
* @param {*} [options] Override http request option.
|
|
3570
3916
|
* @throws {RequiredError}
|
|
3571
3917
|
*/
|
|
3572
|
-
setState(type:
|
|
3918
|
+
setState(type: SetStateTypeEnum, id: string, name: string, setStateBody?: SetStateBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SetStateResponse>>;
|
|
3573
3919
|
/**
|
|
3574
3920
|
* Transfer bot to another workspace. You need to be a Manager member of the workspace the bot currently belongs to and have permission to create bots in the target workspace.
|
|
3575
3921
|
* @param {string} id Bot ID
|
|
@@ -4272,7 +4618,7 @@ export interface DefaultApiGetBotWebchatRequest {
|
|
|
4272
4618
|
* @type {'preconfigured' | 'configurable' | 'fullscreen' | 'sharableUrl'}
|
|
4273
4619
|
* @memberof DefaultApiGetBotWebchat
|
|
4274
4620
|
*/
|
|
4275
|
-
readonly type:
|
|
4621
|
+
readonly type: GetBotWebchatTypeEnum;
|
|
4276
4622
|
}
|
|
4277
4623
|
/**
|
|
4278
4624
|
* Request parameters for getConversation operation in DefaultApi.
|
|
@@ -4453,7 +4799,7 @@ export interface DefaultApiGetStateRequest {
|
|
|
4453
4799
|
* @type {'conversation' | 'user' | 'bot' | 'integration'}
|
|
4454
4800
|
* @memberof DefaultApiGetState
|
|
4455
4801
|
*/
|
|
4456
|
-
readonly type:
|
|
4802
|
+
readonly type: GetStateTypeEnum;
|
|
4457
4803
|
/**
|
|
4458
4804
|
* State id
|
|
4459
4805
|
* @type {string}
|
|
@@ -4712,7 +5058,7 @@ export interface DefaultApiPatchStateRequest {
|
|
|
4712
5058
|
* @type {'conversation' | 'user' | 'bot' | 'integration'}
|
|
4713
5059
|
* @memberof DefaultApiPatchState
|
|
4714
5060
|
*/
|
|
4715
|
-
readonly type:
|
|
5061
|
+
readonly type: PatchStateTypeEnum;
|
|
4716
5062
|
/**
|
|
4717
5063
|
* State id
|
|
4718
5064
|
* @type {string}
|
|
@@ -4743,7 +5089,7 @@ export interface DefaultApiSetStateRequest {
|
|
|
4743
5089
|
* @type {'conversation' | 'user' | 'bot' | 'integration'}
|
|
4744
5090
|
* @memberof DefaultApiSetState
|
|
4745
5091
|
*/
|
|
4746
|
-
readonly type:
|
|
5092
|
+
readonly type: SetStateTypeEnum;
|
|
4747
5093
|
/**
|
|
4748
5094
|
* State id
|
|
4749
5095
|
* @type {string}
|
|
@@ -5309,3 +5655,43 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
5309
5655
|
*/
|
|
5310
5656
|
updateUser(requestParameters: DefaultApiUpdateUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateUserResponse, any>>;
|
|
5311
5657
|
}
|
|
5658
|
+
/**
|
|
5659
|
+
* @export
|
|
5660
|
+
*/
|
|
5661
|
+
export declare const GetBotWebchatTypeEnum: {
|
|
5662
|
+
readonly Preconfigured: "preconfigured";
|
|
5663
|
+
readonly Configurable: "configurable";
|
|
5664
|
+
readonly Fullscreen: "fullscreen";
|
|
5665
|
+
readonly SharableUrl: "sharableUrl";
|
|
5666
|
+
};
|
|
5667
|
+
export type GetBotWebchatTypeEnum = typeof GetBotWebchatTypeEnum[keyof typeof GetBotWebchatTypeEnum];
|
|
5668
|
+
/**
|
|
5669
|
+
* @export
|
|
5670
|
+
*/
|
|
5671
|
+
export declare const GetStateTypeEnum: {
|
|
5672
|
+
readonly Conversation: "conversation";
|
|
5673
|
+
readonly User: "user";
|
|
5674
|
+
readonly Bot: "bot";
|
|
5675
|
+
readonly Integration: "integration";
|
|
5676
|
+
};
|
|
5677
|
+
export type GetStateTypeEnum = typeof GetStateTypeEnum[keyof typeof GetStateTypeEnum];
|
|
5678
|
+
/**
|
|
5679
|
+
* @export
|
|
5680
|
+
*/
|
|
5681
|
+
export declare const PatchStateTypeEnum: {
|
|
5682
|
+
readonly Conversation: "conversation";
|
|
5683
|
+
readonly User: "user";
|
|
5684
|
+
readonly Bot: "bot";
|
|
5685
|
+
readonly Integration: "integration";
|
|
5686
|
+
};
|
|
5687
|
+
export type PatchStateTypeEnum = typeof PatchStateTypeEnum[keyof typeof PatchStateTypeEnum];
|
|
5688
|
+
/**
|
|
5689
|
+
* @export
|
|
5690
|
+
*/
|
|
5691
|
+
export declare const SetStateTypeEnum: {
|
|
5692
|
+
readonly Conversation: "conversation";
|
|
5693
|
+
readonly User: "user";
|
|
5694
|
+
readonly Bot: "bot";
|
|
5695
|
+
readonly Integration: "integration";
|
|
5696
|
+
};
|
|
5697
|
+
export type SetStateTypeEnum = typeof SetStateTypeEnum[keyof typeof SetStateTypeEnum];
|