@botpress/client 0.0.12 → 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 +7 -7
- package/dist/bundle.cjs.map +4 -4
- package/dist/gen/api.d.ts +776 -884
- package/dist/gen/base.d.ts +3 -4
- package/dist/gen/common.d.ts +5 -5
- package/dist/gen/configuration.d.ts +1 -1
- package/dist/gen/errors.d.ts +6 -0
- package/dist/gen/index.d.ts +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.cjs.map +3 -3
- package/dist/index.mjs +1 -1
- package/openapi.ts +5 -0
- package/package.json +13 -10
package/dist/gen/api.d.ts
CHANGED
|
@@ -2,16 +2,17 @@
|
|
|
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).
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import { Configuration } from './configuration';
|
|
13
|
-
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
14
|
-
import { RequestArgs
|
|
12
|
+
import type { Configuration } from './configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
14
|
+
import type { RequestArgs } from './base';
|
|
15
|
+
import { BaseAPI } from './base';
|
|
15
16
|
/**
|
|
16
17
|
*
|
|
17
18
|
* @export
|
|
@@ -50,6 +51,24 @@ export interface Bot {
|
|
|
50
51
|
'integrations': {
|
|
51
52
|
[key: string]: BotIntegrationsValue;
|
|
52
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;
|
|
53
72
|
/**
|
|
54
73
|
* A mapping of states to their definition
|
|
55
74
|
* @type {{ [key: string]: CreateBotBodyStatesValue; }}
|
|
@@ -58,12 +77,6 @@ export interface Bot {
|
|
|
58
77
|
'states': {
|
|
59
78
|
[key: string]: CreateBotBodyStatesValue;
|
|
60
79
|
};
|
|
61
|
-
/**
|
|
62
|
-
*
|
|
63
|
-
* @type {CreateBotBodyTags}
|
|
64
|
-
* @memberof Bot
|
|
65
|
-
*/
|
|
66
|
-
'tags': CreateBotBodyTags;
|
|
67
80
|
/**
|
|
68
81
|
*
|
|
69
82
|
* @type {BotConfiguration}
|
|
@@ -140,6 +153,21 @@ export interface BotConfiguration {
|
|
|
140
153
|
[key: string]: any;
|
|
141
154
|
};
|
|
142
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
|
+
}
|
|
143
171
|
/**
|
|
144
172
|
*
|
|
145
173
|
* @export
|
|
@@ -213,6 +241,36 @@ export interface BotMediasInner {
|
|
|
213
241
|
*/
|
|
214
242
|
'name': string;
|
|
215
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
|
+
}
|
|
216
274
|
/**
|
|
217
275
|
*
|
|
218
276
|
* @export
|
|
@@ -321,12 +379,6 @@ export interface CreateBotBody {
|
|
|
321
379
|
'states'?: {
|
|
322
380
|
[key: string]: CreateBotBodyStatesValue;
|
|
323
381
|
};
|
|
324
|
-
/**
|
|
325
|
-
*
|
|
326
|
-
* @type {CreateBotBodyTags}
|
|
327
|
-
* @memberof CreateBotBody
|
|
328
|
-
*/
|
|
329
|
-
'tags'?: CreateBotBodyTags;
|
|
330
382
|
/**
|
|
331
383
|
* Events definition
|
|
332
384
|
* @type {{ [key: string]: CreateBotBodyEventsValue; }}
|
|
@@ -349,6 +401,24 @@ export interface CreateBotBody {
|
|
|
349
401
|
* @memberof CreateBotBody
|
|
350
402
|
*/
|
|
351
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;
|
|
352
422
|
/**
|
|
353
423
|
* JavaScript code of the bot
|
|
354
424
|
* @type {string}
|
|
@@ -404,7 +474,7 @@ export interface CreateBotBodyConfiguration {
|
|
|
404
474
|
};
|
|
405
475
|
}
|
|
406
476
|
/**
|
|
407
|
-
* Event
|
|
477
|
+
* Event Definition
|
|
408
478
|
* @export
|
|
409
479
|
* @interface CreateBotBodyEventsValue
|
|
410
480
|
*/
|
|
@@ -511,29 +581,38 @@ export declare const CreateBotBodyStatesValueTypeEnum: {
|
|
|
511
581
|
};
|
|
512
582
|
export type CreateBotBodyStatesValueTypeEnum = typeof CreateBotBodyStatesValueTypeEnum[keyof typeof CreateBotBodyStatesValueTypeEnum];
|
|
513
583
|
/**
|
|
514
|
-
*
|
|
584
|
+
*
|
|
515
585
|
* @export
|
|
516
|
-
* @interface
|
|
586
|
+
* @interface CreateBotBodyUser
|
|
517
587
|
*/
|
|
518
|
-
export interface
|
|
588
|
+
export interface CreateBotBodyUser {
|
|
519
589
|
/**
|
|
520
590
|
*
|
|
521
|
-
* @type {
|
|
522
|
-
* @memberof
|
|
591
|
+
* @type {{ [key: string]: CreateBotBodyUserTagsValue; }}
|
|
592
|
+
* @memberof CreateBotBodyUser
|
|
523
593
|
*/
|
|
524
|
-
'
|
|
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 {
|
|
525
604
|
/**
|
|
526
|
-
*
|
|
527
|
-
* @type {
|
|
528
|
-
* @memberof
|
|
605
|
+
* Title of the tag
|
|
606
|
+
* @type {string}
|
|
607
|
+
* @memberof CreateBotBodyUserTagsValue
|
|
529
608
|
*/
|
|
530
|
-
'
|
|
609
|
+
'title'?: string;
|
|
531
610
|
/**
|
|
532
|
-
*
|
|
533
|
-
* @type {
|
|
534
|
-
* @memberof
|
|
611
|
+
* Description of the tag
|
|
612
|
+
* @type {string}
|
|
613
|
+
* @memberof CreateBotBodyUserTagsValue
|
|
535
614
|
*/
|
|
536
|
-
'
|
|
615
|
+
'description'?: string;
|
|
537
616
|
}
|
|
538
617
|
/**
|
|
539
618
|
*
|
|
@@ -716,20 +795,12 @@ export interface CreateIntegrationBody {
|
|
|
716
795
|
'version': string;
|
|
717
796
|
/**
|
|
718
797
|
*
|
|
719
|
-
* @type {
|
|
720
|
-
* @memberof CreateIntegrationBody
|
|
721
|
-
*/
|
|
722
|
-
'tags'?: CreateIntegrationBodyTags;
|
|
723
|
-
/**
|
|
724
|
-
* Channels definition
|
|
725
|
-
* @type {{ [key: string]: CreateIntegrationBodyChannelsValue; }}
|
|
798
|
+
* @type {CreateIntegrationBodyConfiguration}
|
|
726
799
|
* @memberof CreateIntegrationBody
|
|
727
800
|
*/
|
|
728
|
-
'
|
|
729
|
-
[key: string]: CreateIntegrationBodyChannelsValue;
|
|
730
|
-
};
|
|
801
|
+
'configuration'?: CreateIntegrationBodyConfiguration;
|
|
731
802
|
/**
|
|
732
|
-
*
|
|
803
|
+
*
|
|
733
804
|
* @type {{ [key: string]: CreateIntegrationBodyStatesValue; }}
|
|
734
805
|
* @memberof CreateIntegrationBody
|
|
735
806
|
*/
|
|
@@ -738,12 +809,6 @@ export interface CreateIntegrationBody {
|
|
|
738
809
|
};
|
|
739
810
|
/**
|
|
740
811
|
*
|
|
741
|
-
* @type {CreateIntegrationBodyConfiguration}
|
|
742
|
-
* @memberof CreateIntegrationBody
|
|
743
|
-
*/
|
|
744
|
-
'configuration'?: CreateIntegrationBodyConfiguration;
|
|
745
|
-
/**
|
|
746
|
-
* Events definition
|
|
747
812
|
* @type {{ [key: string]: CreateBotBodyEventsValue; }}
|
|
748
813
|
* @memberof CreateIntegrationBody
|
|
749
814
|
*/
|
|
@@ -751,13 +816,21 @@ export interface CreateIntegrationBody {
|
|
|
751
816
|
[key: string]: CreateBotBodyEventsValue;
|
|
752
817
|
};
|
|
753
818
|
/**
|
|
754
|
-
*
|
|
819
|
+
*
|
|
755
820
|
* @type {{ [key: string]: CreateIntegrationBodyActionsValue; }}
|
|
756
821
|
* @memberof CreateIntegrationBody
|
|
757
822
|
*/
|
|
758
823
|
'actions'?: {
|
|
759
824
|
[key: string]: CreateIntegrationBodyActionsValue;
|
|
760
825
|
};
|
|
826
|
+
/**
|
|
827
|
+
*
|
|
828
|
+
* @type {{ [key: string]: CreateIntegrationBodyChannelsValue; }}
|
|
829
|
+
* @memberof CreateIntegrationBody
|
|
830
|
+
*/
|
|
831
|
+
'channels'?: {
|
|
832
|
+
[key: string]: CreateIntegrationBodyChannelsValue;
|
|
833
|
+
};
|
|
761
834
|
/**
|
|
762
835
|
*
|
|
763
836
|
* @type {CreateIntegrationBodyUser}
|
|
@@ -770,12 +843,6 @@ export interface CreateIntegrationBody {
|
|
|
770
843
|
* @memberof CreateIntegrationBody
|
|
771
844
|
*/
|
|
772
845
|
'code'?: string;
|
|
773
|
-
/**
|
|
774
|
-
* Whether the integration is public
|
|
775
|
-
* @type {boolean}
|
|
776
|
-
* @memberof CreateIntegrationBody
|
|
777
|
-
*/
|
|
778
|
-
'public'?: boolean;
|
|
779
846
|
/**
|
|
780
847
|
* URL of the integration; Only available for dev integrations
|
|
781
848
|
* @type {string}
|
|
@@ -814,36 +881,45 @@ export interface CreateIntegrationBody {
|
|
|
814
881
|
'description'?: string;
|
|
815
882
|
}
|
|
816
883
|
/**
|
|
817
|
-
*
|
|
884
|
+
* Action definition
|
|
818
885
|
* @export
|
|
819
886
|
* @interface CreateIntegrationBodyActionsValue
|
|
820
887
|
*/
|
|
821
888
|
export interface CreateIntegrationBodyActionsValue {
|
|
822
889
|
/**
|
|
823
890
|
*
|
|
824
|
-
* @type {
|
|
891
|
+
* @type {CreateIntegrationBodyActionsValueInput}
|
|
825
892
|
* @memberof CreateIntegrationBodyActionsValue
|
|
826
893
|
*/
|
|
827
|
-
'input':
|
|
894
|
+
'input': CreateIntegrationBodyActionsValueInput;
|
|
828
895
|
/**
|
|
829
896
|
*
|
|
830
|
-
* @type {
|
|
897
|
+
* @type {CreateIntegrationBodyActionsValueInput}
|
|
831
898
|
* @memberof CreateIntegrationBodyActionsValue
|
|
832
899
|
*/
|
|
833
|
-
'output':
|
|
900
|
+
'output': CreateIntegrationBodyActionsValueInput;
|
|
834
901
|
}
|
|
835
902
|
/**
|
|
836
903
|
*
|
|
837
904
|
* @export
|
|
838
|
-
* @interface
|
|
905
|
+
* @interface CreateIntegrationBodyActionsValueInput
|
|
839
906
|
*/
|
|
840
|
-
export interface
|
|
907
|
+
export interface CreateIntegrationBodyActionsValueInput {
|
|
841
908
|
/**
|
|
842
909
|
*
|
|
843
|
-
* @type {
|
|
844
|
-
* @memberof
|
|
910
|
+
* @type {{ [key: string]: any; }}
|
|
911
|
+
* @memberof CreateIntegrationBodyActionsValueInput
|
|
845
912
|
*/
|
|
846
|
-
'
|
|
913
|
+
'schema': {
|
|
914
|
+
[key: string]: any;
|
|
915
|
+
};
|
|
916
|
+
}
|
|
917
|
+
/**
|
|
918
|
+
*
|
|
919
|
+
* @export
|
|
920
|
+
* @interface CreateIntegrationBodyChannelsValue
|
|
921
|
+
*/
|
|
922
|
+
export interface CreateIntegrationBodyChannelsValue {
|
|
847
923
|
/**
|
|
848
924
|
*
|
|
849
925
|
* @type {{ [key: string]: CreateIntegrationBodyChannelsValueMessagesValue; }}
|
|
@@ -858,6 +934,12 @@ export interface CreateIntegrationBodyChannelsValue {
|
|
|
858
934
|
* @memberof CreateIntegrationBodyChannelsValue
|
|
859
935
|
*/
|
|
860
936
|
'conversation'?: CreateIntegrationBodyChannelsValueConversation;
|
|
937
|
+
/**
|
|
938
|
+
*
|
|
939
|
+
* @type {CreateBotBodyUser}
|
|
940
|
+
* @memberof CreateIntegrationBodyChannelsValue
|
|
941
|
+
*/
|
|
942
|
+
'message'?: CreateBotBodyUser;
|
|
861
943
|
}
|
|
862
944
|
/**
|
|
863
945
|
*
|
|
@@ -870,7 +952,15 @@ export interface CreateIntegrationBodyChannelsValueConversation {
|
|
|
870
952
|
* @type {CreateIntegrationBodyChannelsValueConversationCreation}
|
|
871
953
|
* @memberof CreateIntegrationBodyChannelsValueConversation
|
|
872
954
|
*/
|
|
873
|
-
'creation'
|
|
955
|
+
'creation'?: CreateIntegrationBodyChannelsValueConversationCreation;
|
|
956
|
+
/**
|
|
957
|
+
*
|
|
958
|
+
* @type {{ [key: string]: CreateBotBodyUserTagsValue; }}
|
|
959
|
+
* @memberof CreateIntegrationBodyChannelsValueConversation
|
|
960
|
+
*/
|
|
961
|
+
'tags'?: {
|
|
962
|
+
[key: string]: CreateBotBodyUserTagsValue;
|
|
963
|
+
};
|
|
874
964
|
}
|
|
875
965
|
/**
|
|
876
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.
|
|
@@ -892,7 +982,7 @@ export interface CreateIntegrationBodyChannelsValueConversationCreation {
|
|
|
892
982
|
'requiredTags': Array<string>;
|
|
893
983
|
}
|
|
894
984
|
/**
|
|
895
|
-
*
|
|
985
|
+
* Message definition
|
|
896
986
|
* @export
|
|
897
987
|
* @interface CreateIntegrationBodyChannelsValueMessagesValue
|
|
898
988
|
*/
|
|
@@ -906,25 +996,6 @@ export interface CreateIntegrationBodyChannelsValueMessagesValue {
|
|
|
906
996
|
[key: string]: any;
|
|
907
997
|
};
|
|
908
998
|
}
|
|
909
|
-
/**
|
|
910
|
-
*
|
|
911
|
-
* @export
|
|
912
|
-
* @interface CreateIntegrationBodyChannelsValueTags
|
|
913
|
-
*/
|
|
914
|
-
export interface CreateIntegrationBodyChannelsValueTags {
|
|
915
|
-
/**
|
|
916
|
-
*
|
|
917
|
-
* @type {Array<string>}
|
|
918
|
-
* @memberof CreateIntegrationBodyChannelsValueTags
|
|
919
|
-
*/
|
|
920
|
-
'messages'?: Array<string>;
|
|
921
|
-
/**
|
|
922
|
-
*
|
|
923
|
-
* @type {Array<string>}
|
|
924
|
-
* @memberof CreateIntegrationBodyChannelsValueTags
|
|
925
|
-
*/
|
|
926
|
-
'conversations'?: Array<string>;
|
|
927
|
-
}
|
|
928
999
|
/**
|
|
929
1000
|
* Configuration definition
|
|
930
1001
|
* @export
|
|
@@ -932,7 +1003,7 @@ export interface CreateIntegrationBodyChannelsValueTags {
|
|
|
932
1003
|
*/
|
|
933
1004
|
export interface CreateIntegrationBodyConfiguration {
|
|
934
1005
|
/**
|
|
935
|
-
* Schema
|
|
1006
|
+
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
936
1007
|
* @type {{ [key: string]: any; }}
|
|
937
1008
|
* @memberof CreateIntegrationBodyConfiguration
|
|
938
1009
|
*/
|
|
@@ -941,7 +1012,7 @@ export interface CreateIntegrationBodyConfiguration {
|
|
|
941
1012
|
};
|
|
942
1013
|
}
|
|
943
1014
|
/**
|
|
944
|
-
*
|
|
1015
|
+
* State definition
|
|
945
1016
|
* @export
|
|
946
1017
|
* @interface CreateIntegrationBodyStatesValue
|
|
947
1018
|
*/
|
|
@@ -967,19 +1038,6 @@ export declare const CreateIntegrationBodyStatesValueTypeEnum: {
|
|
|
967
1038
|
readonly Integration: "integration";
|
|
968
1039
|
};
|
|
969
1040
|
export type CreateIntegrationBodyStatesValueTypeEnum = typeof CreateIntegrationBodyStatesValueTypeEnum[keyof typeof CreateIntegrationBodyStatesValueTypeEnum];
|
|
970
|
-
/**
|
|
971
|
-
* Tags of the [Integration](#schema_integration)
|
|
972
|
-
* @export
|
|
973
|
-
* @interface CreateIntegrationBodyTags
|
|
974
|
-
*/
|
|
975
|
-
export interface CreateIntegrationBodyTags {
|
|
976
|
-
/**
|
|
977
|
-
*
|
|
978
|
-
* @type {Array<string>}
|
|
979
|
-
* @memberof CreateIntegrationBodyTags
|
|
980
|
-
*/
|
|
981
|
-
'users'?: Array<string>;
|
|
982
|
-
}
|
|
983
1041
|
/**
|
|
984
1042
|
*
|
|
985
1043
|
* @export
|
|
@@ -991,7 +1049,15 @@ export interface CreateIntegrationBodyUser {
|
|
|
991
1049
|
* @type {CreateIntegrationBodyUserCreation}
|
|
992
1050
|
* @memberof CreateIntegrationBodyUser
|
|
993
1051
|
*/
|
|
994
|
-
'creation'
|
|
1052
|
+
'creation'?: CreateIntegrationBodyUserCreation;
|
|
1053
|
+
/**
|
|
1054
|
+
*
|
|
1055
|
+
* @type {{ [key: string]: CreateBotBodyUserTagsValue; }}
|
|
1056
|
+
* @memberof CreateIntegrationBodyUser
|
|
1057
|
+
*/
|
|
1058
|
+
'tags'?: {
|
|
1059
|
+
[key: string]: CreateBotBodyUserTagsValue;
|
|
1060
|
+
};
|
|
995
1061
|
}
|
|
996
1062
|
/**
|
|
997
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.
|
|
@@ -1660,7 +1726,13 @@ export interface Integration {
|
|
|
1660
1726
|
*/
|
|
1661
1727
|
'version': string;
|
|
1662
1728
|
/**
|
|
1663
|
-
*
|
|
1729
|
+
*
|
|
1730
|
+
* @type {CreateIntegrationBodyConfiguration}
|
|
1731
|
+
* @memberof Integration
|
|
1732
|
+
*/
|
|
1733
|
+
'configuration': CreateIntegrationBodyConfiguration;
|
|
1734
|
+
/**
|
|
1735
|
+
*
|
|
1664
1736
|
* @type {{ [key: string]: IntegrationChannelsValue; }}
|
|
1665
1737
|
* @memberof Integration
|
|
1666
1738
|
*/
|
|
@@ -1668,21 +1740,15 @@ export interface Integration {
|
|
|
1668
1740
|
[key: string]: IntegrationChannelsValue;
|
|
1669
1741
|
};
|
|
1670
1742
|
/**
|
|
1671
|
-
*
|
|
1743
|
+
*
|
|
1672
1744
|
* @type {{ [key: string]: CreateIntegrationBodyStatesValue; }}
|
|
1673
1745
|
* @memberof Integration
|
|
1674
1746
|
*/
|
|
1675
|
-
'states'
|
|
1747
|
+
'states': {
|
|
1676
1748
|
[key: string]: CreateIntegrationBodyStatesValue;
|
|
1677
1749
|
};
|
|
1678
1750
|
/**
|
|
1679
1751
|
*
|
|
1680
|
-
* @type {CreateIntegrationBodyConfiguration}
|
|
1681
|
-
* @memberof Integration
|
|
1682
|
-
*/
|
|
1683
|
-
'configuration': CreateIntegrationBodyConfiguration;
|
|
1684
|
-
/**
|
|
1685
|
-
* Events definition
|
|
1686
1752
|
* @type {{ [key: string]: CreateBotBodyEventsValue; }}
|
|
1687
1753
|
* @memberof Integration
|
|
1688
1754
|
*/
|
|
@@ -1690,7 +1756,7 @@ export interface Integration {
|
|
|
1690
1756
|
[key: string]: CreateBotBodyEventsValue;
|
|
1691
1757
|
};
|
|
1692
1758
|
/**
|
|
1693
|
-
*
|
|
1759
|
+
*
|
|
1694
1760
|
* @type {{ [key: string]: CreateIntegrationBodyActionsValue; }}
|
|
1695
1761
|
* @memberof Integration
|
|
1696
1762
|
*/
|
|
@@ -1699,10 +1765,10 @@ export interface Integration {
|
|
|
1699
1765
|
};
|
|
1700
1766
|
/**
|
|
1701
1767
|
*
|
|
1702
|
-
* @type {
|
|
1768
|
+
* @type {IntegrationUser}
|
|
1703
1769
|
* @memberof Integration
|
|
1704
1770
|
*/
|
|
1705
|
-
'user':
|
|
1771
|
+
'user': IntegrationUser;
|
|
1706
1772
|
/**
|
|
1707
1773
|
* Indicates if the integration is a development integration; Dev integrations run locally
|
|
1708
1774
|
* @type {boolean}
|
|
@@ -1735,17 +1801,11 @@ export interface Integration {
|
|
|
1735
1801
|
'readmeUrl': string;
|
|
1736
1802
|
}
|
|
1737
1803
|
/**
|
|
1738
|
-
*
|
|
1804
|
+
* Channel definition
|
|
1739
1805
|
* @export
|
|
1740
1806
|
* @interface IntegrationChannelsValue
|
|
1741
1807
|
*/
|
|
1742
1808
|
export interface IntegrationChannelsValue {
|
|
1743
|
-
/**
|
|
1744
|
-
*
|
|
1745
|
-
* @type {CreateIntegrationBodyChannelsValueTags}
|
|
1746
|
-
* @memberof IntegrationChannelsValue
|
|
1747
|
-
*/
|
|
1748
|
-
'tags': CreateIntegrationBodyChannelsValueTags;
|
|
1749
1809
|
/**
|
|
1750
1810
|
*
|
|
1751
1811
|
* @type {{ [key: string]: CreateIntegrationBodyChannelsValueMessagesValue; }}
|
|
@@ -1756,10 +1816,58 @@ export interface IntegrationChannelsValue {
|
|
|
1756
1816
|
};
|
|
1757
1817
|
/**
|
|
1758
1818
|
*
|
|
1759
|
-
* @type {
|
|
1819
|
+
* @type {IntegrationChannelsValueConversation}
|
|
1820
|
+
* @memberof IntegrationChannelsValue
|
|
1821
|
+
*/
|
|
1822
|
+
'conversation': IntegrationChannelsValueConversation;
|
|
1823
|
+
/**
|
|
1824
|
+
*
|
|
1825
|
+
* @type {BotMessage}
|
|
1760
1826
|
* @memberof IntegrationChannelsValue
|
|
1761
1827
|
*/
|
|
1762
|
-
'
|
|
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;
|
|
1763
1871
|
}
|
|
1764
1872
|
/**
|
|
1765
1873
|
*
|
|
@@ -2394,54 +2502,66 @@ export interface UpdateBotBody {
|
|
|
2394
2502
|
*/
|
|
2395
2503
|
'authentication'?: UpdateBotBodyAuthenticationEnum;
|
|
2396
2504
|
/**
|
|
2397
|
-
*
|
|
2398
|
-
* @type {
|
|
2505
|
+
*
|
|
2506
|
+
* @type {CreateBotBodyConfiguration}
|
|
2399
2507
|
* @memberof UpdateBotBody
|
|
2400
2508
|
*/
|
|
2401
|
-
'
|
|
2402
|
-
|
|
2403
|
-
|
|
2509
|
+
'configuration'?: CreateBotBodyConfiguration;
|
|
2510
|
+
/**
|
|
2511
|
+
*
|
|
2512
|
+
* @type {boolean}
|
|
2513
|
+
* @memberof UpdateBotBody
|
|
2514
|
+
*/
|
|
2515
|
+
'blocked'?: boolean;
|
|
2404
2516
|
/**
|
|
2405
2517
|
*
|
|
2406
|
-
* @type {
|
|
2518
|
+
* @type {UpdateBotBodyUser}
|
|
2407
2519
|
* @memberof UpdateBotBody
|
|
2408
2520
|
*/
|
|
2409
|
-
'
|
|
2521
|
+
'user'?: UpdateBotBodyUser;
|
|
2410
2522
|
/**
|
|
2411
|
-
*
|
|
2412
|
-
* @type {
|
|
2523
|
+
*
|
|
2524
|
+
* @type {UpdateBotBodyUser}
|
|
2413
2525
|
* @memberof UpdateBotBody
|
|
2414
2526
|
*/
|
|
2415
|
-
'
|
|
2416
|
-
[key: string]: CreateBotBodyEventsValue;
|
|
2417
|
-
};
|
|
2527
|
+
'message'?: UpdateBotBodyUser;
|
|
2418
2528
|
/**
|
|
2419
|
-
*
|
|
2420
|
-
* @type {
|
|
2529
|
+
*
|
|
2530
|
+
* @type {UpdateBotBodyUser}
|
|
2421
2531
|
* @memberof UpdateBotBody
|
|
2422
2532
|
*/
|
|
2423
|
-
'
|
|
2424
|
-
|
|
2533
|
+
'conversation'?: UpdateBotBodyUser;
|
|
2534
|
+
/**
|
|
2535
|
+
*
|
|
2536
|
+
* @type {{ [key: string]: UpdateBotBodyEventsValue | null; }}
|
|
2537
|
+
* @memberof UpdateBotBody
|
|
2538
|
+
*/
|
|
2539
|
+
'events'?: {
|
|
2540
|
+
[key: string]: UpdateBotBodyEventsValue | null;
|
|
2425
2541
|
};
|
|
2426
2542
|
/**
|
|
2427
2543
|
*
|
|
2428
|
-
* @type {
|
|
2544
|
+
* @type {{ [key: string]: UpdateBotBodyStatesValue | null; }}
|
|
2429
2545
|
* @memberof UpdateBotBody
|
|
2430
2546
|
*/
|
|
2431
|
-
'
|
|
2547
|
+
'states'?: {
|
|
2548
|
+
[key: string]: UpdateBotBodyStatesValue | null;
|
|
2549
|
+
};
|
|
2432
2550
|
/**
|
|
2433
2551
|
*
|
|
2434
|
-
* @type {
|
|
2552
|
+
* @type {{ [key: string]: UpdateBotBodyRecurringEventsValue | null; }}
|
|
2435
2553
|
* @memberof UpdateBotBody
|
|
2436
2554
|
*/
|
|
2437
|
-
'
|
|
2555
|
+
'recurringEvents'?: {
|
|
2556
|
+
[key: string]: UpdateBotBodyRecurringEventsValue | null;
|
|
2557
|
+
};
|
|
2438
2558
|
/**
|
|
2439
2559
|
*
|
|
2440
|
-
* @type {{ [key: string]: UpdateBotBodyIntegrationsValue; }}
|
|
2560
|
+
* @type {{ [key: string]: UpdateBotBodyIntegrationsValue | null; }}
|
|
2441
2561
|
* @memberof UpdateBotBody
|
|
2442
2562
|
*/
|
|
2443
2563
|
'integrations'?: {
|
|
2444
|
-
[key: string]: UpdateBotBodyIntegrationsValue;
|
|
2564
|
+
[key: string]: UpdateBotBodyIntegrationsValue | null;
|
|
2445
2565
|
};
|
|
2446
2566
|
/**
|
|
2447
2567
|
* JavaScript code of the bot
|
|
@@ -2467,14 +2587,29 @@ export declare const UpdateBotBodyAuthenticationEnum: {
|
|
|
2467
2587
|
};
|
|
2468
2588
|
export type UpdateBotBodyAuthenticationEnum = typeof UpdateBotBodyAuthenticationEnum[keyof typeof UpdateBotBodyAuthenticationEnum];
|
|
2469
2589
|
/**
|
|
2470
|
-
*
|
|
2590
|
+
* Event Definition
|
|
2471
2591
|
* @export
|
|
2472
|
-
* @interface
|
|
2592
|
+
* @interface UpdateBotBodyEventsValue
|
|
2473
2593
|
*/
|
|
2474
|
-
export interface
|
|
2594
|
+
export interface UpdateBotBodyEventsValue {
|
|
2475
2595
|
/**
|
|
2476
2596
|
*
|
|
2477
|
-
* @type {
|
|
2597
|
+
* @type {{ [key: string]: any; }}
|
|
2598
|
+
* @memberof UpdateBotBodyEventsValue
|
|
2599
|
+
*/
|
|
2600
|
+
'schema': {
|
|
2601
|
+
[key: string]: any;
|
|
2602
|
+
};
|
|
2603
|
+
}
|
|
2604
|
+
/**
|
|
2605
|
+
*
|
|
2606
|
+
* @export
|
|
2607
|
+
* @interface UpdateBotBodyIntegrationsValue
|
|
2608
|
+
*/
|
|
2609
|
+
export interface UpdateBotBodyIntegrationsValue {
|
|
2610
|
+
/**
|
|
2611
|
+
*
|
|
2612
|
+
* @type {boolean}
|
|
2478
2613
|
* @memberof UpdateBotBodyIntegrationsValue
|
|
2479
2614
|
*/
|
|
2480
2615
|
'enabled': boolean;
|
|
@@ -2487,6 +2622,100 @@ export interface UpdateBotBodyIntegrationsValue {
|
|
|
2487
2622
|
[key: string]: any;
|
|
2488
2623
|
};
|
|
2489
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
|
+
}
|
|
2490
2719
|
/**
|
|
2491
2720
|
*
|
|
2492
2721
|
* @export
|
|
@@ -2542,72 +2771,54 @@ export interface UpdateConversationResponse {
|
|
|
2542
2771
|
export interface UpdateIntegrationBody {
|
|
2543
2772
|
/**
|
|
2544
2773
|
*
|
|
2545
|
-
* @type {
|
|
2774
|
+
* @type {CreateIntegrationBodyConfiguration}
|
|
2546
2775
|
* @memberof UpdateIntegrationBody
|
|
2547
2776
|
*/
|
|
2548
|
-
'
|
|
2777
|
+
'configuration'?: CreateIntegrationBodyConfiguration;
|
|
2549
2778
|
/**
|
|
2550
|
-
*
|
|
2551
|
-
* @type {{ [key: string]:
|
|
2779
|
+
*
|
|
2780
|
+
* @type {{ [key: string]: UpdateIntegrationBodyChannelsValue; }}
|
|
2552
2781
|
* @memberof UpdateIntegrationBody
|
|
2553
2782
|
*/
|
|
2554
2783
|
'channels'?: {
|
|
2555
|
-
[key: string]:
|
|
2784
|
+
[key: string]: UpdateIntegrationBodyChannelsValue;
|
|
2556
2785
|
};
|
|
2557
2786
|
/**
|
|
2558
|
-
*
|
|
2559
|
-
* @type {{ [key: string]:
|
|
2787
|
+
*
|
|
2788
|
+
* @type {{ [key: string]: UpdateIntegrationBodyActionsValue | null; }}
|
|
2560
2789
|
* @memberof UpdateIntegrationBody
|
|
2561
2790
|
*/
|
|
2562
|
-
'
|
|
2563
|
-
[key: string]:
|
|
2791
|
+
'actions'?: {
|
|
2792
|
+
[key: string]: UpdateIntegrationBodyActionsValue | null;
|
|
2564
2793
|
};
|
|
2565
2794
|
/**
|
|
2566
2795
|
*
|
|
2567
|
-
* @type {
|
|
2568
|
-
* @memberof UpdateIntegrationBody
|
|
2569
|
-
*/
|
|
2570
|
-
'configuration'?: CreateIntegrationBodyConfiguration;
|
|
2571
|
-
/**
|
|
2572
|
-
* Events definition
|
|
2573
|
-
* @type {{ [key: string]: CreateBotBodyEventsValue; }}
|
|
2796
|
+
* @type {{ [key: string]: UpdateBotBodyEventsValue | null; }}
|
|
2574
2797
|
* @memberof UpdateIntegrationBody
|
|
2575
2798
|
*/
|
|
2576
2799
|
'events'?: {
|
|
2577
|
-
[key: string]:
|
|
2800
|
+
[key: string]: UpdateBotBodyEventsValue | null;
|
|
2578
2801
|
};
|
|
2579
2802
|
/**
|
|
2580
|
-
*
|
|
2581
|
-
* @type {{ [key: string]:
|
|
2803
|
+
*
|
|
2804
|
+
* @type {{ [key: string]: UpdateIntegrationBodyStatesValue | null; }}
|
|
2582
2805
|
* @memberof UpdateIntegrationBody
|
|
2583
2806
|
*/
|
|
2584
|
-
'
|
|
2585
|
-
[key: string]:
|
|
2807
|
+
'states'?: {
|
|
2808
|
+
[key: string]: UpdateIntegrationBodyStatesValue | null;
|
|
2586
2809
|
};
|
|
2587
2810
|
/**
|
|
2588
2811
|
*
|
|
2589
|
-
* @type {
|
|
2812
|
+
* @type {UpdateIntegrationBodyUser}
|
|
2590
2813
|
* @memberof UpdateIntegrationBody
|
|
2591
2814
|
*/
|
|
2592
|
-
'user'?:
|
|
2815
|
+
'user'?: UpdateIntegrationBodyUser;
|
|
2593
2816
|
/**
|
|
2594
2817
|
* JavaScript code of the integration
|
|
2595
2818
|
* @type {string}
|
|
2596
2819
|
* @memberof UpdateIntegrationBody
|
|
2597
2820
|
*/
|
|
2598
2821
|
'code'?: string;
|
|
2599
|
-
/**
|
|
2600
|
-
* Whether the integration is public
|
|
2601
|
-
* @type {boolean}
|
|
2602
|
-
* @memberof UpdateIntegrationBody
|
|
2603
|
-
*/
|
|
2604
|
-
'public'?: boolean;
|
|
2605
|
-
/**
|
|
2606
|
-
* URL of the integration; Only available for dev integrations
|
|
2607
|
-
* @type {string}
|
|
2608
|
-
* @memberof UpdateIntegrationBody
|
|
2609
|
-
*/
|
|
2610
|
-
'url'?: string;
|
|
2611
2822
|
/**
|
|
2612
2823
|
* Base64 encoded svg of the integration icon. This icon is global to the integration each versions will be updated when this changes.
|
|
2613
2824
|
* @type {string}
|
|
@@ -2632,6 +2843,142 @@ export interface UpdateIntegrationBody {
|
|
|
2632
2843
|
* @memberof UpdateIntegrationBody
|
|
2633
2844
|
*/
|
|
2634
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
|
+
};
|
|
2635
2982
|
}
|
|
2636
2983
|
/**
|
|
2637
2984
|
*
|
|
@@ -2933,11 +3280,11 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2933
3280
|
/**
|
|
2934
3281
|
* Get the webchat code/URL for a bot
|
|
2935
3282
|
* @param {string} id Bot ID
|
|
2936
|
-
* @param {
|
|
3283
|
+
* @param {GetBotWebchatTypeEnum} type type of script to get
|
|
2937
3284
|
* @param {*} [options] Override http request option.
|
|
2938
3285
|
* @throws {RequiredError}
|
|
2939
3286
|
*/
|
|
2940
|
-
getBotWebchat: (id: string, type:
|
|
3287
|
+
getBotWebchat: (id: string, type: GetBotWebchatTypeEnum, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2941
3288
|
/**
|
|
2942
3289
|
* Retrieves the [Conversation](#schema_conversation) object for a valid identifier.
|
|
2943
3290
|
* @param {string} id Conversation id
|
|
@@ -3026,13 +3373,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
3026
3373
|
getPublicIntegrationById: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3027
3374
|
/**
|
|
3028
3375
|
* Retrieves the [State](#schema_state) object for a valid identifiers.
|
|
3029
|
-
* @param {
|
|
3376
|
+
* @param {GetStateTypeEnum} type State type
|
|
3030
3377
|
* @param {string} id State id
|
|
3031
3378
|
* @param {string} name State name
|
|
3032
3379
|
* @param {*} [options] Override http request option.
|
|
3033
3380
|
* @throws {RequiredError}
|
|
3034
3381
|
*/
|
|
3035
|
-
getState: (type:
|
|
3382
|
+
getState: (type: GetStateTypeEnum, id: string, name: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3036
3383
|
/**
|
|
3037
3384
|
* Retrieves the [User](#schema_user) object for a valid identifier.
|
|
3038
3385
|
* @param {string} id User ID
|
|
@@ -3071,427 +3418,15 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
3071
3418
|
*/
|
|
3072
3419
|
listConversations: (nextToken?: string, tags?: {
|
|
3073
3420
|
[key: string]: string;
|
|
3074
|
-
} | undefined, participantIds?: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3075
|
-
/**
|
|
3076
|
-
* Retreives a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
|
|
3077
|
-
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
3078
|
-
* @param {*} [options] Override http request option.
|
|
3079
|
-
* @throws {RequiredError}
|
|
3080
|
-
*/
|
|
3081
|
-
listEvents: (nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3082
|
-
/**
|
|
3083
|
-
* List Files
|
|
3084
|
-
* @param {string} botId Bot ID
|
|
3085
|
-
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
3086
|
-
* @param {*} [options] Override http request option.
|
|
3087
|
-
* @throws {RequiredError}
|
|
3088
|
-
*/
|
|
3089
|
-
listFiles: (botId: string, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3090
|
-
/**
|
|
3091
|
-
* List integrations
|
|
3092
|
-
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
3093
|
-
* @param {string} [name] Integration Name
|
|
3094
|
-
* @param {string} [version] Integration version. Either a semver version or tag \"latest\"
|
|
3095
|
-
* @param {*} [options] Override http request option.
|
|
3096
|
-
* @throws {RequiredError}
|
|
3097
|
-
*/
|
|
3098
|
-
listIntegrations: (nextToken?: string, name?: string, version?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3099
|
-
/**
|
|
3100
|
-
* Retrieves a list of [Messages](#schema_message) you’ve previously created. The messages are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
|
|
3101
|
-
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
3102
|
-
* @param {string} [conversationId] Conversation id
|
|
3103
|
-
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
3104
|
-
* @param {*} [options] Override http request option.
|
|
3105
|
-
* @throws {RequiredError}
|
|
3106
|
-
*/
|
|
3107
|
-
listMessages: (nextToken?: string, conversationId?: string, tags?: {
|
|
3108
|
-
[key: string]: string;
|
|
3109
|
-
} | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3110
|
-
/**
|
|
3111
|
-
* List public integration
|
|
3112
|
-
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
3113
|
-
* @param {string} [name] Integration Name
|
|
3114
|
-
* @param {string} [version] Integration version. Either a semver version or tag \"latest\"
|
|
3115
|
-
* @param {*} [options] Override http request option.
|
|
3116
|
-
* @throws {RequiredError}
|
|
3117
|
-
*/
|
|
3118
|
-
listPublicIntegrations: (nextToken?: string, name?: string, version?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3119
|
-
/**
|
|
3120
|
-
* Retrieves a list of [User](#schema_user) previously created. The users are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
|
|
3121
|
-
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
3122
|
-
* @param {string} [conversationId] Filter by conversation id. This will return all users that have participated in the conversation.
|
|
3123
|
-
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
3124
|
-
* @param {*} [options] Override http request option.
|
|
3125
|
-
* @throws {RequiredError}
|
|
3126
|
-
*/
|
|
3127
|
-
listUsers: (nextToken?: string, conversationId?: string, tags?: {
|
|
3128
|
-
[key: string]: string;
|
|
3129
|
-
} | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3130
|
-
/**
|
|
3131
|
-
* List workspaces the user has access to
|
|
3132
|
-
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
3133
|
-
* @param {*} [options] Override http request option.
|
|
3134
|
-
* @throws {RequiredError}
|
|
3135
|
-
*/
|
|
3136
|
-
listWorkspaces: (nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3137
|
-
/**
|
|
3138
|
-
* Updates the [State](#schema_state) object by setting the values of the parameters passed.
|
|
3139
|
-
* @param {'conversation' | 'user' | 'bot' | 'integration'} type State type
|
|
3140
|
-
* @param {string} id State id
|
|
3141
|
-
* @param {string} name State name
|
|
3142
|
-
* @param {PatchStateBody} [patchStateBody] State content
|
|
3143
|
-
* @param {*} [options] Override http request option.
|
|
3144
|
-
* @throws {RequiredError}
|
|
3145
|
-
*/
|
|
3146
|
-
patchState: (type: 'conversation' | 'user' | 'bot' | 'integration', id: string, name: string, patchStateBody?: PatchStateBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3147
|
-
/**
|
|
3148
|
-
* Overrides the [State](#schema_state) object by setting the values of the parameters passed.
|
|
3149
|
-
* @param {'conversation' | 'user' | 'bot' | 'integration'} type State type
|
|
3150
|
-
* @param {string} id State id
|
|
3151
|
-
* @param {string} name State name
|
|
3152
|
-
* @param {SetStateBody} [setStateBody] State content
|
|
3153
|
-
* @param {*} [options] Override http request option.
|
|
3154
|
-
* @throws {RequiredError}
|
|
3155
|
-
*/
|
|
3156
|
-
setState: (type: 'conversation' | 'user' | 'bot' | 'integration', id: string, name: string, setStateBody?: SetStateBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3157
|
-
/**
|
|
3158
|
-
* 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.
|
|
3159
|
-
* @param {string} id Bot ID
|
|
3160
|
-
* @param {TransferBotBody} [transferBotBody] Bot transfer request
|
|
3161
|
-
* @param {*} [options] Override http request option.
|
|
3162
|
-
* @throws {RequiredError}
|
|
3163
|
-
*/
|
|
3164
|
-
transferBot: (id: string, transferBotBody?: TransferBotBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3165
|
-
/**
|
|
3166
|
-
* Update bot
|
|
3167
|
-
* @param {string} id Bot ID
|
|
3168
|
-
* @param {UpdateBotBody} [updateBotBody] Bot metadata
|
|
3169
|
-
* @param {*} [options] Override http request option.
|
|
3170
|
-
* @throws {RequiredError}
|
|
3171
|
-
*/
|
|
3172
|
-
updateBot: (id: string, updateBotBody?: UpdateBotBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3173
|
-
/**
|
|
3174
|
-
* Update a [Conversation](#schema_conversation) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
3175
|
-
* @param {string} id Conversation id
|
|
3176
|
-
* @param {UpdateConversationBody} [updateConversationBody] Conversation data
|
|
3177
|
-
* @param {*} [options] Override http request option.
|
|
3178
|
-
* @throws {RequiredError}
|
|
3179
|
-
*/
|
|
3180
|
-
updateConversation: (id: string, updateConversationBody?: UpdateConversationBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3181
|
-
/**
|
|
3182
|
-
* Update integration
|
|
3183
|
-
* @param {string} id Integration Id
|
|
3184
|
-
* @param {UpdateIntegrationBody} [updateIntegrationBody] Integration
|
|
3185
|
-
* @param {*} [options] Override http request option.
|
|
3186
|
-
* @throws {RequiredError}
|
|
3187
|
-
*/
|
|
3188
|
-
updateIntegration: (id: string, updateIntegrationBody?: UpdateIntegrationBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3189
|
-
/**
|
|
3190
|
-
* Update a message
|
|
3191
|
-
* @param {string} id Message id
|
|
3192
|
-
* @param {UpdateMessageBody} [updateMessageBody] Message data
|
|
3193
|
-
* @param {*} [options] Override http request option.
|
|
3194
|
-
* @throws {RequiredError}
|
|
3195
|
-
*/
|
|
3196
|
-
updateMessage: (id: string, updateMessageBody?: UpdateMessageBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3197
|
-
/**
|
|
3198
|
-
* Update a [User](#schema_user) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
3199
|
-
* @param {string} id User ID
|
|
3200
|
-
* @param {UpdateUserBody} [updateUserBody] User data
|
|
3201
|
-
* @param {*} [options] Override http request option.
|
|
3202
|
-
* @throws {RequiredError}
|
|
3203
|
-
*/
|
|
3204
|
-
updateUser: (id: string, updateUserBody?: UpdateUserBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3205
|
-
};
|
|
3206
|
-
/**
|
|
3207
|
-
* DefaultApi - functional programming interface
|
|
3208
|
-
* @export
|
|
3209
|
-
*/
|
|
3210
|
-
export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
3211
|
-
/**
|
|
3212
|
-
* Call an action
|
|
3213
|
-
* @param {CallActionBody} [callActionBody] Action payload
|
|
3214
|
-
* @param {*} [options] Override http request option.
|
|
3215
|
-
* @throws {RequiredError}
|
|
3216
|
-
*/
|
|
3217
|
-
callAction(callActionBody?: CallActionBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CallActionResponse>>;
|
|
3218
|
-
/**
|
|
3219
|
-
* An integration can call this endpoint to configure itself
|
|
3220
|
-
* @param {ConfigureIntegrationBody} [configureIntegrationBody] Configuration of the integration
|
|
3221
|
-
* @param {*} [options] Override http request option.
|
|
3222
|
-
* @throws {RequiredError}
|
|
3223
|
-
*/
|
|
3224
|
-
configureIntegration(configureIntegrationBody?: ConfigureIntegrationBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
3225
|
-
/**
|
|
3226
|
-
* Create bot
|
|
3227
|
-
* @param {CreateBotBody} [createBotBody] Bot metadata
|
|
3228
|
-
* @param {*} [options] Override http request option.
|
|
3229
|
-
* @throws {RequiredError}
|
|
3230
|
-
*/
|
|
3231
|
-
createBot(createBotBody?: CreateBotBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateBotResponse>>;
|
|
3232
|
-
/**
|
|
3233
|
-
* Creates a new [Conversation](#schema_conversation). When creating a new [Conversation](#schema_conversation), the required tags must be provided. See the specific integration for more details.
|
|
3234
|
-
* @param {CreateConversationBody} [createConversationBody] Conversation data
|
|
3235
|
-
* @param {*} [options] Override http request option.
|
|
3236
|
-
* @throws {RequiredError}
|
|
3237
|
-
*/
|
|
3238
|
-
createConversation(createConversationBody?: CreateConversationBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateConversationResponse>>;
|
|
3239
|
-
/**
|
|
3240
|
-
* Creates a new [Event](#schema_event). When creating a new [Event](#schema_event), the required tags must be provided. See the specific integration for more details.
|
|
3241
|
-
* @param {CreateEventBody} [createEventBody] Event data
|
|
3242
|
-
* @param {*} [options] Override http request option.
|
|
3243
|
-
* @throws {RequiredError}
|
|
3244
|
-
*/
|
|
3245
|
-
createEvent(createEventBody?: CreateEventBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateEventResponse>>;
|
|
3246
|
-
/**
|
|
3247
|
-
* Create File
|
|
3248
|
-
* @param {CreateFileBody} [createFileBody] Create File
|
|
3249
|
-
* @param {*} [options] Override http request option.
|
|
3250
|
-
* @throws {RequiredError}
|
|
3251
|
-
*/
|
|
3252
|
-
createFile(createFileBody?: CreateFileBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFileResponse>>;
|
|
3253
|
-
/**
|
|
3254
|
-
* Create integration
|
|
3255
|
-
* @param {CreateIntegrationBody} [createIntegrationBody] Integration
|
|
3256
|
-
* @param {*} [options] Override http request option.
|
|
3257
|
-
* @throws {RequiredError}
|
|
3258
|
-
*/
|
|
3259
|
-
createIntegration(createIntegrationBody?: CreateIntegrationBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateIntegrationResponse>>;
|
|
3260
|
-
/**
|
|
3261
|
-
* Creates a new [Message](#schema_message). When creating a new [Message](#schema_message), the required tags must be provided. See the specific integration for more details.
|
|
3262
|
-
* @param {CreateMessageBody} [createMessageBody] Message data
|
|
3263
|
-
* @param {*} [options] Override http request option.
|
|
3264
|
-
* @throws {RequiredError}
|
|
3265
|
-
*/
|
|
3266
|
-
createMessage(createMessageBody?: CreateMessageBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateMessageResponse>>;
|
|
3267
|
-
/**
|
|
3268
|
-
* Creates a new [User](#schema_user). When creating a new [User](#schema_user), the required tags must be provided. See the specific integration for more details.
|
|
3269
|
-
* @param {CreateUserBody} [createUserBody] User data
|
|
3270
|
-
* @param {*} [options] Override http request option.
|
|
3271
|
-
* @throws {RequiredError}
|
|
3272
|
-
*/
|
|
3273
|
-
createUser(createUserBody?: CreateUserBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateUserResponse>>;
|
|
3274
|
-
/**
|
|
3275
|
-
* Delete bot
|
|
3276
|
-
* @param {string} id Bot ID
|
|
3277
|
-
* @param {*} [options] Override http request option.
|
|
3278
|
-
* @throws {RequiredError}
|
|
3279
|
-
*/
|
|
3280
|
-
deleteBot(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
3281
|
-
/**
|
|
3282
|
-
* Permanently deletes a [Conversation](#schema_conversation). It cannot be undone. Also immediately deletes corresponding [Messages](#schema_message).
|
|
3283
|
-
* @param {string} id Conversation id
|
|
3284
|
-
* @param {*} [options] Override http request option.
|
|
3285
|
-
* @throws {RequiredError}
|
|
3286
|
-
*/
|
|
3287
|
-
deleteConversation(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
3288
|
-
/**
|
|
3289
|
-
* Delete File
|
|
3290
|
-
* @param {string} id File ID
|
|
3291
|
-
* @param {*} [options] Override http request option.
|
|
3292
|
-
* @throws {RequiredError}
|
|
3293
|
-
*/
|
|
3294
|
-
deleteFile(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
3295
|
-
/**
|
|
3296
|
-
* Delete integration
|
|
3297
|
-
* @param {string} id Integration Id
|
|
3298
|
-
* @param {*} [options] Override http request option.
|
|
3299
|
-
* @throws {RequiredError}
|
|
3300
|
-
*/
|
|
3301
|
-
deleteIntegration(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
3302
|
-
/**
|
|
3303
|
-
* Permanently deletes a [Message](#schema_message). It cannot be undone.
|
|
3304
|
-
* @param {string} id Message id
|
|
3305
|
-
* @param {*} [options] Override http request option.
|
|
3306
|
-
* @throws {RequiredError}
|
|
3307
|
-
*/
|
|
3308
|
-
deleteMessage(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
3309
|
-
/**
|
|
3310
|
-
* Permanently deletes a [User](#schema_user). It cannot be undone.
|
|
3311
|
-
* @param {string} id User ID
|
|
3312
|
-
* @param {*} [options] Override http request option.
|
|
3313
|
-
* @throws {RequiredError}
|
|
3314
|
-
*/
|
|
3315
|
-
deleteUser(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
3316
|
-
/**
|
|
3317
|
-
* Download File
|
|
3318
|
-
* @param {string} id File ID
|
|
3319
|
-
* @param {*} [options] Override http request option.
|
|
3320
|
-
* @throws {RequiredError}
|
|
3321
|
-
*/
|
|
3322
|
-
downloadFile(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
3323
|
-
/**
|
|
3324
|
-
* Get bot details
|
|
3325
|
-
* @param {string} id Bot ID
|
|
3326
|
-
* @param {*} [options] Override http request option.
|
|
3327
|
-
* @throws {RequiredError}
|
|
3328
|
-
*/
|
|
3329
|
-
getBot(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBotResponse>>;
|
|
3330
|
-
/**
|
|
3331
|
-
* Get bot analytics
|
|
3332
|
-
* @param {string} id Bot ID
|
|
3333
|
-
* @param {string} startDate Start date/time (inclusive)
|
|
3334
|
-
* @param {string} endDate End date/time (exclusive)
|
|
3335
|
-
* @param {*} [options] Override http request option.
|
|
3336
|
-
* @throws {RequiredError}
|
|
3337
|
-
*/
|
|
3338
|
-
getBotAnalytics(id: string, startDate: string, endDate: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBotAnalyticsResponse>>;
|
|
3339
|
-
/**
|
|
3340
|
-
* Get bot logs
|
|
3341
|
-
* @param {string} id Bot ID
|
|
3342
|
-
* @param {*} [options] Override http request option.
|
|
3343
|
-
* @throws {RequiredError}
|
|
3344
|
-
*/
|
|
3345
|
-
getBotLogs(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBotLogsResponse>>;
|
|
3346
|
-
/**
|
|
3347
|
-
* Get the webchat code/URL for a bot
|
|
3348
|
-
* @param {string} id Bot ID
|
|
3349
|
-
* @param {'preconfigured' | 'configurable' | 'fullscreen' | 'sharableUrl'} type type of script to get
|
|
3350
|
-
* @param {*} [options] Override http request option.
|
|
3351
|
-
* @throws {RequiredError}
|
|
3352
|
-
*/
|
|
3353
|
-
getBotWebchat(id: string, type: 'preconfigured' | 'configurable' | 'fullscreen' | 'sharableUrl', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBotWebchatResponse>>;
|
|
3354
|
-
/**
|
|
3355
|
-
* Retrieves the [Conversation](#schema_conversation) object for a valid identifier.
|
|
3356
|
-
* @param {string} id Conversation id
|
|
3357
|
-
* @param {*} [options] Override http request option.
|
|
3358
|
-
* @throws {RequiredError}
|
|
3359
|
-
*/
|
|
3360
|
-
getConversation(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetConversationResponse>>;
|
|
3361
|
-
/**
|
|
3362
|
-
* Retrieves the [Event](#schema_event) object for a valid identifiers.
|
|
3363
|
-
* @param {string} id Event id
|
|
3364
|
-
* @param {*} [options] Override http request option.
|
|
3365
|
-
* @throws {RequiredError}
|
|
3366
|
-
*/
|
|
3367
|
-
getEvent(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventResponse>>;
|
|
3368
|
-
/**
|
|
3369
|
-
* Get File
|
|
3370
|
-
* @param {string} id File ID
|
|
3371
|
-
* @param {*} [options] Override http request option.
|
|
3372
|
-
* @throws {RequiredError}
|
|
3373
|
-
*/
|
|
3374
|
-
getFile(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFileResponse>>;
|
|
3375
|
-
/**
|
|
3376
|
-
* Get integration
|
|
3377
|
-
* @param {string} id Integration Id
|
|
3378
|
-
* @param {*} [options] Override http request option.
|
|
3379
|
-
* @throws {RequiredError}
|
|
3380
|
-
*/
|
|
3381
|
-
getIntegration(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetIntegrationResponse>>;
|
|
3382
|
-
/**
|
|
3383
|
-
* Get integration
|
|
3384
|
-
* @param {string} name Integration Name
|
|
3385
|
-
* @param {string} version Integration version. Either a semver version or tag \"latest\"
|
|
3386
|
-
* @param {*} [options] Override http request option.
|
|
3387
|
-
* @throws {RequiredError}
|
|
3388
|
-
*/
|
|
3389
|
-
getIntegrationByName(name: string, version: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetIntegrationByNameResponse>>;
|
|
3390
|
-
/**
|
|
3391
|
-
* Get integration logs
|
|
3392
|
-
* @param {string} id Integration Id
|
|
3393
|
-
* @param {*} [options] Override http request option.
|
|
3394
|
-
* @throws {RequiredError}
|
|
3395
|
-
*/
|
|
3396
|
-
getIntegrationLogs(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetIntegrationLogsResponse>>;
|
|
3397
|
-
/**
|
|
3398
|
-
* Retrieves the [Message](#schema_message) object for a valid identifier.
|
|
3399
|
-
* @param {string} id Id of the Message
|
|
3400
|
-
* @param {*} [options] Override http request option.
|
|
3401
|
-
* @throws {RequiredError}
|
|
3402
|
-
*/
|
|
3403
|
-
getMessage(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMessageResponse>>;
|
|
3404
|
-
/**
|
|
3405
|
-
* Retrieves the [Conversation](#schema_conversation) object for a valid identifier. If the conversation does not exist, it will be created.
|
|
3406
|
-
* @param {GetOrCreateConversationBody} [getOrCreateConversationBody] Conversation data
|
|
3407
|
-
* @param {*} [options] Override http request option.
|
|
3408
|
-
* @throws {RequiredError}
|
|
3409
|
-
*/
|
|
3410
|
-
getOrCreateConversation(getOrCreateConversationBody?: GetOrCreateConversationBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrCreateConversationResponse>>;
|
|
3411
|
-
/**
|
|
3412
|
-
* Retrieves the [Message](#schema_message) object for a valid identifier. If the message does not exist, it will be created.
|
|
3413
|
-
* @param {GetOrCreateMessageBody} [getOrCreateMessageBody] Message data
|
|
3414
|
-
* @param {*} [options] Override http request option.
|
|
3415
|
-
* @throws {RequiredError}
|
|
3416
|
-
*/
|
|
3417
|
-
getOrCreateMessage(getOrCreateMessageBody?: GetOrCreateMessageBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrCreateMessageResponse>>;
|
|
3418
|
-
/**
|
|
3419
|
-
* Retrieves the [User](#schema_user) object for a valid identifier. If the user does not exist, it will be created.
|
|
3420
|
-
* @param {GetOrCreateUserBody} [getOrCreateUserBody] User data
|
|
3421
|
-
* @param {*} [options] Override http request option.
|
|
3422
|
-
* @throws {RequiredError}
|
|
3423
|
-
*/
|
|
3424
|
-
getOrCreateUser(getOrCreateUserBody?: GetOrCreateUserBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrCreateUserResponse>>;
|
|
3425
|
-
/**
|
|
3426
|
-
* Get public integration by name and version
|
|
3427
|
-
* @param {string} name Integration Name
|
|
3428
|
-
* @param {string} version Integration version. Either a semver version or tag \"latest\"
|
|
3429
|
-
* @param {*} [options] Override http request option.
|
|
3430
|
-
* @throws {RequiredError}
|
|
3431
|
-
*/
|
|
3432
|
-
getPublicIntegration(name: string, version: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPublicIntegrationResponse>>;
|
|
3433
|
-
/**
|
|
3434
|
-
* Get public integration by Id
|
|
3435
|
-
* @param {string} id Integration Id
|
|
3436
|
-
* @param {*} [options] Override http request option.
|
|
3437
|
-
* @throws {RequiredError}
|
|
3438
|
-
*/
|
|
3439
|
-
getPublicIntegrationById(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPublicIntegrationByIdResponse>>;
|
|
3440
|
-
/**
|
|
3441
|
-
* Retrieves the [State](#schema_state) object for a valid identifiers.
|
|
3442
|
-
* @param {'conversation' | 'user' | 'bot' | 'integration'} type State type
|
|
3443
|
-
* @param {string} id State id
|
|
3444
|
-
* @param {string} name State name
|
|
3445
|
-
* @param {*} [options] Override http request option.
|
|
3446
|
-
* @throws {RequiredError}
|
|
3447
|
-
*/
|
|
3448
|
-
getState(type: 'conversation' | 'user' | 'bot' | 'integration', id: string, name: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStateResponse>>;
|
|
3449
|
-
/**
|
|
3450
|
-
* Retrieves the [User](#schema_user) object for a valid identifier.
|
|
3451
|
-
* @param {string} id User ID
|
|
3452
|
-
* @param {*} [options] Override http request option.
|
|
3453
|
-
* @throws {RequiredError}
|
|
3454
|
-
*/
|
|
3455
|
-
getUser(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUserResponse>>;
|
|
3456
|
-
/**
|
|
3457
|
-
* Get workspace details
|
|
3458
|
-
* @param {string} id Workspace ID
|
|
3459
|
-
* @param {*} [options] Override http request option.
|
|
3460
|
-
* @throws {RequiredError}
|
|
3461
|
-
*/
|
|
3462
|
-
getWorkspace(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetWorkspaceResponse>>;
|
|
3463
|
-
/**
|
|
3464
|
-
* Introspect the API
|
|
3465
|
-
* @param {IntrospectBody} [introspectBody]
|
|
3466
|
-
* @param {*} [options] Override http request option.
|
|
3467
|
-
* @throws {RequiredError}
|
|
3468
|
-
*/
|
|
3469
|
-
introspect(introspectBody?: IntrospectBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IntrospectResponse>>;
|
|
3470
|
-
/**
|
|
3471
|
-
* List bots
|
|
3472
|
-
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
3473
|
-
* @param {*} [options] Override http request option.
|
|
3474
|
-
* @throws {RequiredError}
|
|
3475
|
-
*/
|
|
3476
|
-
listBots(nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBotsResponse>>;
|
|
3477
|
-
/**
|
|
3478
|
-
* Retrieves a list of [Conversation](#schema_conversation) you’ve previously created. The conversations are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
|
|
3479
|
-
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
3480
|
-
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
3481
|
-
* @param {Array<string>} [participantIds] Filter by participant ids
|
|
3482
|
-
* @param {*} [options] Override http request option.
|
|
3483
|
-
* @throws {RequiredError}
|
|
3484
|
-
*/
|
|
3485
|
-
listConversations(nextToken?: string, tags?: {
|
|
3486
|
-
[key: string]: string;
|
|
3487
|
-
} | undefined, participantIds?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListConversationsResponse>>;
|
|
3421
|
+
} | undefined, participantIds?: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3488
3422
|
/**
|
|
3489
3423
|
* Retreives a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
|
|
3490
3424
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
3425
|
+
* @param {string} [type] Filter by event type
|
|
3491
3426
|
* @param {*} [options] Override http request option.
|
|
3492
3427
|
* @throws {RequiredError}
|
|
3493
3428
|
*/
|
|
3494
|
-
listEvents(nextToken?: string,
|
|
3429
|
+
listEvents: (nextToken?: string, type?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3495
3430
|
/**
|
|
3496
3431
|
* List Files
|
|
3497
3432
|
* @param {string} botId Bot ID
|
|
@@ -3499,7 +3434,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
3499
3434
|
* @param {*} [options] Override http request option.
|
|
3500
3435
|
* @throws {RequiredError}
|
|
3501
3436
|
*/
|
|
3502
|
-
listFiles(botId: string, nextToken?: string, options?: AxiosRequestConfig)
|
|
3437
|
+
listFiles: (botId: string, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3503
3438
|
/**
|
|
3504
3439
|
* List integrations
|
|
3505
3440
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
@@ -3508,7 +3443,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
3508
3443
|
* @param {*} [options] Override http request option.
|
|
3509
3444
|
* @throws {RequiredError}
|
|
3510
3445
|
*/
|
|
3511
|
-
listIntegrations(nextToken?: string, name?: string, version?: string, options?: AxiosRequestConfig)
|
|
3446
|
+
listIntegrations: (nextToken?: string, name?: string, version?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3512
3447
|
/**
|
|
3513
3448
|
* Retrieves a list of [Messages](#schema_message) you’ve previously created. The messages are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
|
|
3514
3449
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
@@ -3517,9 +3452,9 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
3517
3452
|
* @param {*} [options] Override http request option.
|
|
3518
3453
|
* @throws {RequiredError}
|
|
3519
3454
|
*/
|
|
3520
|
-
listMessages(nextToken?: string, conversationId?: string, tags?: {
|
|
3455
|
+
listMessages: (nextToken?: string, conversationId?: string, tags?: {
|
|
3521
3456
|
[key: string]: string;
|
|
3522
|
-
} | undefined, options?: AxiosRequestConfig)
|
|
3457
|
+
} | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3523
3458
|
/**
|
|
3524
3459
|
* List public integration
|
|
3525
3460
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
@@ -3528,7 +3463,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
3528
3463
|
* @param {*} [options] Override http request option.
|
|
3529
3464
|
* @throws {RequiredError}
|
|
3530
3465
|
*/
|
|
3531
|
-
listPublicIntegrations(nextToken?: string, name?: string, version?: string, options?: AxiosRequestConfig)
|
|
3466
|
+
listPublicIntegrations: (nextToken?: string, name?: string, version?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3532
3467
|
/**
|
|
3533
3468
|
* Retrieves a list of [User](#schema_user) previously created. The users are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
|
|
3534
3469
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
@@ -3537,36 +3472,36 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
3537
3472
|
* @param {*} [options] Override http request option.
|
|
3538
3473
|
* @throws {RequiredError}
|
|
3539
3474
|
*/
|
|
3540
|
-
listUsers(nextToken?: string, conversationId?: string, tags?: {
|
|
3475
|
+
listUsers: (nextToken?: string, conversationId?: string, tags?: {
|
|
3541
3476
|
[key: string]: string;
|
|
3542
|
-
} | undefined, options?: AxiosRequestConfig)
|
|
3477
|
+
} | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3543
3478
|
/**
|
|
3544
3479
|
* List workspaces the user has access to
|
|
3545
3480
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
3546
3481
|
* @param {*} [options] Override http request option.
|
|
3547
3482
|
* @throws {RequiredError}
|
|
3548
3483
|
*/
|
|
3549
|
-
listWorkspaces(nextToken?: string, options?: AxiosRequestConfig)
|
|
3484
|
+
listWorkspaces: (nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3550
3485
|
/**
|
|
3551
3486
|
* Updates the [State](#schema_state) object by setting the values of the parameters passed.
|
|
3552
|
-
* @param {
|
|
3487
|
+
* @param {PatchStateTypeEnum} type State type
|
|
3553
3488
|
* @param {string} id State id
|
|
3554
3489
|
* @param {string} name State name
|
|
3555
3490
|
* @param {PatchStateBody} [patchStateBody] State content
|
|
3556
3491
|
* @param {*} [options] Override http request option.
|
|
3557
3492
|
* @throws {RequiredError}
|
|
3558
3493
|
*/
|
|
3559
|
-
patchState(type:
|
|
3494
|
+
patchState: (type: PatchStateTypeEnum, id: string, name: string, patchStateBody?: PatchStateBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3560
3495
|
/**
|
|
3561
3496
|
* Overrides the [State](#schema_state) object by setting the values of the parameters passed.
|
|
3562
|
-
* @param {
|
|
3497
|
+
* @param {SetStateTypeEnum} type State type
|
|
3563
3498
|
* @param {string} id State id
|
|
3564
3499
|
* @param {string} name State name
|
|
3565
3500
|
* @param {SetStateBody} [setStateBody] State content
|
|
3566
3501
|
* @param {*} [options] Override http request option.
|
|
3567
3502
|
* @throws {RequiredError}
|
|
3568
3503
|
*/
|
|
3569
|
-
setState(type:
|
|
3504
|
+
setState: (type: SetStateTypeEnum, id: string, name: string, setStateBody?: SetStateBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3570
3505
|
/**
|
|
3571
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.
|
|
3572
3507
|
* @param {string} id Bot ID
|
|
@@ -3574,7 +3509,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
3574
3509
|
* @param {*} [options] Override http request option.
|
|
3575
3510
|
* @throws {RequiredError}
|
|
3576
3511
|
*/
|
|
3577
|
-
transferBot(id: string, transferBotBody?: TransferBotBody, options?: AxiosRequestConfig)
|
|
3512
|
+
transferBot: (id: string, transferBotBody?: TransferBotBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3578
3513
|
/**
|
|
3579
3514
|
* Update bot
|
|
3580
3515
|
* @param {string} id Bot ID
|
|
@@ -3582,7 +3517,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
3582
3517
|
* @param {*} [options] Override http request option.
|
|
3583
3518
|
* @throws {RequiredError}
|
|
3584
3519
|
*/
|
|
3585
|
-
updateBot(id: string, updateBotBody?: UpdateBotBody, options?: AxiosRequestConfig)
|
|
3520
|
+
updateBot: (id: string, updateBotBody?: UpdateBotBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3586
3521
|
/**
|
|
3587
3522
|
* Update a [Conversation](#schema_conversation) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
3588
3523
|
* @param {string} id Conversation id
|
|
@@ -3590,7 +3525,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
3590
3525
|
* @param {*} [options] Override http request option.
|
|
3591
3526
|
* @throws {RequiredError}
|
|
3592
3527
|
*/
|
|
3593
|
-
updateConversation(id: string, updateConversationBody?: UpdateConversationBody, options?: AxiosRequestConfig)
|
|
3528
|
+
updateConversation: (id: string, updateConversationBody?: UpdateConversationBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3594
3529
|
/**
|
|
3595
3530
|
* Update integration
|
|
3596
3531
|
* @param {string} id Integration Id
|
|
@@ -3598,7 +3533,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
3598
3533
|
* @param {*} [options] Override http request option.
|
|
3599
3534
|
* @throws {RequiredError}
|
|
3600
3535
|
*/
|
|
3601
|
-
updateIntegration(id: string, updateIntegrationBody?: UpdateIntegrationBody, options?: AxiosRequestConfig)
|
|
3536
|
+
updateIntegration: (id: string, updateIntegrationBody?: UpdateIntegrationBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3602
3537
|
/**
|
|
3603
3538
|
* Update a message
|
|
3604
3539
|
* @param {string} id Message id
|
|
@@ -3606,7 +3541,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
3606
3541
|
* @param {*} [options] Override http request option.
|
|
3607
3542
|
* @throws {RequiredError}
|
|
3608
3543
|
*/
|
|
3609
|
-
updateMessage(id: string, updateMessageBody?: UpdateMessageBody, options?: AxiosRequestConfig)
|
|
3544
|
+
updateMessage: (id: string, updateMessageBody?: UpdateMessageBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3610
3545
|
/**
|
|
3611
3546
|
* Update a [User](#schema_user) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
3612
3547
|
* @param {string} id User ID
|
|
@@ -3614,132 +3549,132 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
3614
3549
|
* @param {*} [options] Override http request option.
|
|
3615
3550
|
* @throws {RequiredError}
|
|
3616
3551
|
*/
|
|
3617
|
-
updateUser(id: string, updateUserBody?: UpdateUserBody, options?: AxiosRequestConfig)
|
|
3552
|
+
updateUser: (id: string, updateUserBody?: UpdateUserBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3618
3553
|
};
|
|
3619
3554
|
/**
|
|
3620
|
-
* DefaultApi -
|
|
3555
|
+
* DefaultApi - functional programming interface
|
|
3621
3556
|
* @export
|
|
3622
3557
|
*/
|
|
3623
|
-
export declare const
|
|
3558
|
+
export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
3624
3559
|
/**
|
|
3625
3560
|
* Call an action
|
|
3626
3561
|
* @param {CallActionBody} [callActionBody] Action payload
|
|
3627
3562
|
* @param {*} [options] Override http request option.
|
|
3628
3563
|
* @throws {RequiredError}
|
|
3629
3564
|
*/
|
|
3630
|
-
callAction(callActionBody?: CallActionBody, options?:
|
|
3565
|
+
callAction(callActionBody?: CallActionBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CallActionResponse>>;
|
|
3631
3566
|
/**
|
|
3632
3567
|
* An integration can call this endpoint to configure itself
|
|
3633
3568
|
* @param {ConfigureIntegrationBody} [configureIntegrationBody] Configuration of the integration
|
|
3634
3569
|
* @param {*} [options] Override http request option.
|
|
3635
3570
|
* @throws {RequiredError}
|
|
3636
3571
|
*/
|
|
3637
|
-
configureIntegration(configureIntegrationBody?: ConfigureIntegrationBody, options?:
|
|
3572
|
+
configureIntegration(configureIntegrationBody?: ConfigureIntegrationBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
3638
3573
|
/**
|
|
3639
3574
|
* Create bot
|
|
3640
3575
|
* @param {CreateBotBody} [createBotBody] Bot metadata
|
|
3641
3576
|
* @param {*} [options] Override http request option.
|
|
3642
3577
|
* @throws {RequiredError}
|
|
3643
3578
|
*/
|
|
3644
|
-
createBot(createBotBody?: CreateBotBody, options?:
|
|
3579
|
+
createBot(createBotBody?: CreateBotBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateBotResponse>>;
|
|
3645
3580
|
/**
|
|
3646
3581
|
* Creates a new [Conversation](#schema_conversation). When creating a new [Conversation](#schema_conversation), the required tags must be provided. See the specific integration for more details.
|
|
3647
3582
|
* @param {CreateConversationBody} [createConversationBody] Conversation data
|
|
3648
3583
|
* @param {*} [options] Override http request option.
|
|
3649
3584
|
* @throws {RequiredError}
|
|
3650
3585
|
*/
|
|
3651
|
-
createConversation(createConversationBody?: CreateConversationBody, options?:
|
|
3586
|
+
createConversation(createConversationBody?: CreateConversationBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateConversationResponse>>;
|
|
3652
3587
|
/**
|
|
3653
3588
|
* Creates a new [Event](#schema_event). When creating a new [Event](#schema_event), the required tags must be provided. See the specific integration for more details.
|
|
3654
3589
|
* @param {CreateEventBody} [createEventBody] Event data
|
|
3655
3590
|
* @param {*} [options] Override http request option.
|
|
3656
3591
|
* @throws {RequiredError}
|
|
3657
3592
|
*/
|
|
3658
|
-
createEvent(createEventBody?: CreateEventBody, options?:
|
|
3593
|
+
createEvent(createEventBody?: CreateEventBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateEventResponse>>;
|
|
3659
3594
|
/**
|
|
3660
3595
|
* Create File
|
|
3661
3596
|
* @param {CreateFileBody} [createFileBody] Create File
|
|
3662
3597
|
* @param {*} [options] Override http request option.
|
|
3663
3598
|
* @throws {RequiredError}
|
|
3664
3599
|
*/
|
|
3665
|
-
createFile(createFileBody?: CreateFileBody, options?:
|
|
3600
|
+
createFile(createFileBody?: CreateFileBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFileResponse>>;
|
|
3666
3601
|
/**
|
|
3667
3602
|
* Create integration
|
|
3668
3603
|
* @param {CreateIntegrationBody} [createIntegrationBody] Integration
|
|
3669
3604
|
* @param {*} [options] Override http request option.
|
|
3670
3605
|
* @throws {RequiredError}
|
|
3671
3606
|
*/
|
|
3672
|
-
createIntegration(createIntegrationBody?: CreateIntegrationBody, options?:
|
|
3607
|
+
createIntegration(createIntegrationBody?: CreateIntegrationBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateIntegrationResponse>>;
|
|
3673
3608
|
/**
|
|
3674
3609
|
* Creates a new [Message](#schema_message). When creating a new [Message](#schema_message), the required tags must be provided. See the specific integration for more details.
|
|
3675
3610
|
* @param {CreateMessageBody} [createMessageBody] Message data
|
|
3676
3611
|
* @param {*} [options] Override http request option.
|
|
3677
3612
|
* @throws {RequiredError}
|
|
3678
3613
|
*/
|
|
3679
|
-
createMessage(createMessageBody?: CreateMessageBody, options?:
|
|
3614
|
+
createMessage(createMessageBody?: CreateMessageBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateMessageResponse>>;
|
|
3680
3615
|
/**
|
|
3681
3616
|
* Creates a new [User](#schema_user). When creating a new [User](#schema_user), the required tags must be provided. See the specific integration for more details.
|
|
3682
3617
|
* @param {CreateUserBody} [createUserBody] User data
|
|
3683
3618
|
* @param {*} [options] Override http request option.
|
|
3684
3619
|
* @throws {RequiredError}
|
|
3685
3620
|
*/
|
|
3686
|
-
createUser(createUserBody?: CreateUserBody, options?:
|
|
3621
|
+
createUser(createUserBody?: CreateUserBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateUserResponse>>;
|
|
3687
3622
|
/**
|
|
3688
3623
|
* Delete bot
|
|
3689
3624
|
* @param {string} id Bot ID
|
|
3690
3625
|
* @param {*} [options] Override http request option.
|
|
3691
3626
|
* @throws {RequiredError}
|
|
3692
3627
|
*/
|
|
3693
|
-
deleteBot(id: string, options?:
|
|
3628
|
+
deleteBot(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
3694
3629
|
/**
|
|
3695
3630
|
* Permanently deletes a [Conversation](#schema_conversation). It cannot be undone. Also immediately deletes corresponding [Messages](#schema_message).
|
|
3696
3631
|
* @param {string} id Conversation id
|
|
3697
3632
|
* @param {*} [options] Override http request option.
|
|
3698
3633
|
* @throws {RequiredError}
|
|
3699
3634
|
*/
|
|
3700
|
-
deleteConversation(id: string, options?:
|
|
3635
|
+
deleteConversation(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
3701
3636
|
/**
|
|
3702
3637
|
* Delete File
|
|
3703
3638
|
* @param {string} id File ID
|
|
3704
3639
|
* @param {*} [options] Override http request option.
|
|
3705
3640
|
* @throws {RequiredError}
|
|
3706
3641
|
*/
|
|
3707
|
-
deleteFile(id: string, options?:
|
|
3642
|
+
deleteFile(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
3708
3643
|
/**
|
|
3709
3644
|
* Delete integration
|
|
3710
3645
|
* @param {string} id Integration Id
|
|
3711
3646
|
* @param {*} [options] Override http request option.
|
|
3712
3647
|
* @throws {RequiredError}
|
|
3713
3648
|
*/
|
|
3714
|
-
deleteIntegration(id: string, options?:
|
|
3649
|
+
deleteIntegration(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
3715
3650
|
/**
|
|
3716
3651
|
* Permanently deletes a [Message](#schema_message). It cannot be undone.
|
|
3717
3652
|
* @param {string} id Message id
|
|
3718
3653
|
* @param {*} [options] Override http request option.
|
|
3719
3654
|
* @throws {RequiredError}
|
|
3720
3655
|
*/
|
|
3721
|
-
deleteMessage(id: string, options?:
|
|
3656
|
+
deleteMessage(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
3722
3657
|
/**
|
|
3723
3658
|
* Permanently deletes a [User](#schema_user). It cannot be undone.
|
|
3724
3659
|
* @param {string} id User ID
|
|
3725
3660
|
* @param {*} [options] Override http request option.
|
|
3726
3661
|
* @throws {RequiredError}
|
|
3727
3662
|
*/
|
|
3728
|
-
deleteUser(id: string, options?:
|
|
3663
|
+
deleteUser(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
3729
3664
|
/**
|
|
3730
3665
|
* Download File
|
|
3731
3666
|
* @param {string} id File ID
|
|
3732
3667
|
* @param {*} [options] Override http request option.
|
|
3733
3668
|
* @throws {RequiredError}
|
|
3734
3669
|
*/
|
|
3735
|
-
downloadFile(id: string, options?:
|
|
3670
|
+
downloadFile(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
3736
3671
|
/**
|
|
3737
3672
|
* Get bot details
|
|
3738
3673
|
* @param {string} id Bot ID
|
|
3739
3674
|
* @param {*} [options] Override http request option.
|
|
3740
3675
|
* @throws {RequiredError}
|
|
3741
3676
|
*/
|
|
3742
|
-
getBot(id: string, options?:
|
|
3677
|
+
getBot(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBotResponse>>;
|
|
3743
3678
|
/**
|
|
3744
3679
|
* Get bot analytics
|
|
3745
3680
|
* @param {string} id Bot ID
|
|
@@ -3748,50 +3683,50 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
3748
3683
|
* @param {*} [options] Override http request option.
|
|
3749
3684
|
* @throws {RequiredError}
|
|
3750
3685
|
*/
|
|
3751
|
-
getBotAnalytics(id: string, startDate: string, endDate: string, options?:
|
|
3686
|
+
getBotAnalytics(id: string, startDate: string, endDate: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBotAnalyticsResponse>>;
|
|
3752
3687
|
/**
|
|
3753
3688
|
* Get bot logs
|
|
3754
3689
|
* @param {string} id Bot ID
|
|
3755
3690
|
* @param {*} [options] Override http request option.
|
|
3756
3691
|
* @throws {RequiredError}
|
|
3757
3692
|
*/
|
|
3758
|
-
getBotLogs(id: string, options?:
|
|
3693
|
+
getBotLogs(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBotLogsResponse>>;
|
|
3759
3694
|
/**
|
|
3760
3695
|
* Get the webchat code/URL for a bot
|
|
3761
3696
|
* @param {string} id Bot ID
|
|
3762
|
-
* @param {
|
|
3697
|
+
* @param {GetBotWebchatTypeEnum} type type of script to get
|
|
3763
3698
|
* @param {*} [options] Override http request option.
|
|
3764
3699
|
* @throws {RequiredError}
|
|
3765
3700
|
*/
|
|
3766
|
-
getBotWebchat(id: string, type:
|
|
3701
|
+
getBotWebchat(id: string, type: GetBotWebchatTypeEnum, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBotWebchatResponse>>;
|
|
3767
3702
|
/**
|
|
3768
3703
|
* Retrieves the [Conversation](#schema_conversation) object for a valid identifier.
|
|
3769
3704
|
* @param {string} id Conversation id
|
|
3770
3705
|
* @param {*} [options] Override http request option.
|
|
3771
3706
|
* @throws {RequiredError}
|
|
3772
3707
|
*/
|
|
3773
|
-
getConversation(id: string, options?:
|
|
3708
|
+
getConversation(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetConversationResponse>>;
|
|
3774
3709
|
/**
|
|
3775
3710
|
* Retrieves the [Event](#schema_event) object for a valid identifiers.
|
|
3776
3711
|
* @param {string} id Event id
|
|
3777
3712
|
* @param {*} [options] Override http request option.
|
|
3778
3713
|
* @throws {RequiredError}
|
|
3779
3714
|
*/
|
|
3780
|
-
getEvent(id: string, options?:
|
|
3715
|
+
getEvent(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventResponse>>;
|
|
3781
3716
|
/**
|
|
3782
3717
|
* Get File
|
|
3783
3718
|
* @param {string} id File ID
|
|
3784
3719
|
* @param {*} [options] Override http request option.
|
|
3785
3720
|
* @throws {RequiredError}
|
|
3786
3721
|
*/
|
|
3787
|
-
getFile(id: string, options?:
|
|
3722
|
+
getFile(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFileResponse>>;
|
|
3788
3723
|
/**
|
|
3789
3724
|
* Get integration
|
|
3790
3725
|
* @param {string} id Integration Id
|
|
3791
3726
|
* @param {*} [options] Override http request option.
|
|
3792
3727
|
* @throws {RequiredError}
|
|
3793
3728
|
*/
|
|
3794
|
-
getIntegration(id: string, options?:
|
|
3729
|
+
getIntegration(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetIntegrationResponse>>;
|
|
3795
3730
|
/**
|
|
3796
3731
|
* Get integration
|
|
3797
3732
|
* @param {string} name Integration Name
|
|
@@ -3799,42 +3734,42 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
3799
3734
|
* @param {*} [options] Override http request option.
|
|
3800
3735
|
* @throws {RequiredError}
|
|
3801
3736
|
*/
|
|
3802
|
-
getIntegrationByName(name: string, version: string, options?:
|
|
3737
|
+
getIntegrationByName(name: string, version: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetIntegrationByNameResponse>>;
|
|
3803
3738
|
/**
|
|
3804
3739
|
* Get integration logs
|
|
3805
3740
|
* @param {string} id Integration Id
|
|
3806
3741
|
* @param {*} [options] Override http request option.
|
|
3807
3742
|
* @throws {RequiredError}
|
|
3808
3743
|
*/
|
|
3809
|
-
getIntegrationLogs(id: string, options?:
|
|
3744
|
+
getIntegrationLogs(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetIntegrationLogsResponse>>;
|
|
3810
3745
|
/**
|
|
3811
3746
|
* Retrieves the [Message](#schema_message) object for a valid identifier.
|
|
3812
3747
|
* @param {string} id Id of the Message
|
|
3813
3748
|
* @param {*} [options] Override http request option.
|
|
3814
3749
|
* @throws {RequiredError}
|
|
3815
3750
|
*/
|
|
3816
|
-
getMessage(id: string, options?:
|
|
3751
|
+
getMessage(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMessageResponse>>;
|
|
3817
3752
|
/**
|
|
3818
3753
|
* Retrieves the [Conversation](#schema_conversation) object for a valid identifier. If the conversation does not exist, it will be created.
|
|
3819
3754
|
* @param {GetOrCreateConversationBody} [getOrCreateConversationBody] Conversation data
|
|
3820
3755
|
* @param {*} [options] Override http request option.
|
|
3821
3756
|
* @throws {RequiredError}
|
|
3822
3757
|
*/
|
|
3823
|
-
getOrCreateConversation(getOrCreateConversationBody?: GetOrCreateConversationBody, options?:
|
|
3758
|
+
getOrCreateConversation(getOrCreateConversationBody?: GetOrCreateConversationBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrCreateConversationResponse>>;
|
|
3824
3759
|
/**
|
|
3825
3760
|
* Retrieves the [Message](#schema_message) object for a valid identifier. If the message does not exist, it will be created.
|
|
3826
3761
|
* @param {GetOrCreateMessageBody} [getOrCreateMessageBody] Message data
|
|
3827
3762
|
* @param {*} [options] Override http request option.
|
|
3828
3763
|
* @throws {RequiredError}
|
|
3829
3764
|
*/
|
|
3830
|
-
getOrCreateMessage(getOrCreateMessageBody?: GetOrCreateMessageBody, options?:
|
|
3765
|
+
getOrCreateMessage(getOrCreateMessageBody?: GetOrCreateMessageBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrCreateMessageResponse>>;
|
|
3831
3766
|
/**
|
|
3832
3767
|
* Retrieves the [User](#schema_user) object for a valid identifier. If the user does not exist, it will be created.
|
|
3833
3768
|
* @param {GetOrCreateUserBody} [getOrCreateUserBody] User data
|
|
3834
3769
|
* @param {*} [options] Override http request option.
|
|
3835
3770
|
* @throws {RequiredError}
|
|
3836
3771
|
*/
|
|
3837
|
-
getOrCreateUser(getOrCreateUserBody?: GetOrCreateUserBody, options?:
|
|
3772
|
+
getOrCreateUser(getOrCreateUserBody?: GetOrCreateUserBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrCreateUserResponse>>;
|
|
3838
3773
|
/**
|
|
3839
3774
|
* Get public integration by name and version
|
|
3840
3775
|
* @param {string} name Integration Name
|
|
@@ -3842,51 +3777,51 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
3842
3777
|
* @param {*} [options] Override http request option.
|
|
3843
3778
|
* @throws {RequiredError}
|
|
3844
3779
|
*/
|
|
3845
|
-
getPublicIntegration(name: string, version: string, options?:
|
|
3780
|
+
getPublicIntegration(name: string, version: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPublicIntegrationResponse>>;
|
|
3846
3781
|
/**
|
|
3847
3782
|
* Get public integration by Id
|
|
3848
3783
|
* @param {string} id Integration Id
|
|
3849
3784
|
* @param {*} [options] Override http request option.
|
|
3850
3785
|
* @throws {RequiredError}
|
|
3851
3786
|
*/
|
|
3852
|
-
getPublicIntegrationById(id: string, options?:
|
|
3787
|
+
getPublicIntegrationById(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPublicIntegrationByIdResponse>>;
|
|
3853
3788
|
/**
|
|
3854
3789
|
* Retrieves the [State](#schema_state) object for a valid identifiers.
|
|
3855
|
-
* @param {
|
|
3790
|
+
* @param {GetStateTypeEnum} type State type
|
|
3856
3791
|
* @param {string} id State id
|
|
3857
3792
|
* @param {string} name State name
|
|
3858
3793
|
* @param {*} [options] Override http request option.
|
|
3859
3794
|
* @throws {RequiredError}
|
|
3860
3795
|
*/
|
|
3861
|
-
getState(type:
|
|
3796
|
+
getState(type: GetStateTypeEnum, id: string, name: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStateResponse>>;
|
|
3862
3797
|
/**
|
|
3863
3798
|
* Retrieves the [User](#schema_user) object for a valid identifier.
|
|
3864
3799
|
* @param {string} id User ID
|
|
3865
3800
|
* @param {*} [options] Override http request option.
|
|
3866
3801
|
* @throws {RequiredError}
|
|
3867
3802
|
*/
|
|
3868
|
-
getUser(id: string, options?:
|
|
3803
|
+
getUser(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUserResponse>>;
|
|
3869
3804
|
/**
|
|
3870
3805
|
* Get workspace details
|
|
3871
3806
|
* @param {string} id Workspace ID
|
|
3872
3807
|
* @param {*} [options] Override http request option.
|
|
3873
3808
|
* @throws {RequiredError}
|
|
3874
3809
|
*/
|
|
3875
|
-
getWorkspace(id: string, options?:
|
|
3810
|
+
getWorkspace(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetWorkspaceResponse>>;
|
|
3876
3811
|
/**
|
|
3877
3812
|
* Introspect the API
|
|
3878
3813
|
* @param {IntrospectBody} [introspectBody]
|
|
3879
3814
|
* @param {*} [options] Override http request option.
|
|
3880
3815
|
* @throws {RequiredError}
|
|
3881
3816
|
*/
|
|
3882
|
-
introspect(introspectBody?: IntrospectBody, options?:
|
|
3817
|
+
introspect(introspectBody?: IntrospectBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IntrospectResponse>>;
|
|
3883
3818
|
/**
|
|
3884
3819
|
* List bots
|
|
3885
3820
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
3886
3821
|
* @param {*} [options] Override http request option.
|
|
3887
3822
|
* @throws {RequiredError}
|
|
3888
3823
|
*/
|
|
3889
|
-
listBots(nextToken?: string, options?:
|
|
3824
|
+
listBots(nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBotsResponse>>;
|
|
3890
3825
|
/**
|
|
3891
3826
|
* Retrieves a list of [Conversation](#schema_conversation) you’ve previously created. The conversations are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
|
|
3892
3827
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
@@ -3897,14 +3832,15 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
3897
3832
|
*/
|
|
3898
3833
|
listConversations(nextToken?: string, tags?: {
|
|
3899
3834
|
[key: string]: string;
|
|
3900
|
-
} | undefined, participantIds?: Array<string>, options?:
|
|
3835
|
+
} | undefined, participantIds?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListConversationsResponse>>;
|
|
3901
3836
|
/**
|
|
3902
3837
|
* Retreives a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
|
|
3903
3838
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
3839
|
+
* @param {string} [type] Filter by event type
|
|
3904
3840
|
* @param {*} [options] Override http request option.
|
|
3905
3841
|
* @throws {RequiredError}
|
|
3906
3842
|
*/
|
|
3907
|
-
listEvents(nextToken?: string, options?:
|
|
3843
|
+
listEvents(nextToken?: string, type?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEventsResponse>>;
|
|
3908
3844
|
/**
|
|
3909
3845
|
* List Files
|
|
3910
3846
|
* @param {string} botId Bot ID
|
|
@@ -3912,7 +3848,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
3912
3848
|
* @param {*} [options] Override http request option.
|
|
3913
3849
|
* @throws {RequiredError}
|
|
3914
3850
|
*/
|
|
3915
|
-
listFiles(botId: string, nextToken?: string, options?:
|
|
3851
|
+
listFiles(botId: string, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFilesResponse>>;
|
|
3916
3852
|
/**
|
|
3917
3853
|
* List integrations
|
|
3918
3854
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
@@ -3921,7 +3857,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
3921
3857
|
* @param {*} [options] Override http request option.
|
|
3922
3858
|
* @throws {RequiredError}
|
|
3923
3859
|
*/
|
|
3924
|
-
listIntegrations(nextToken?: string, name?: string, version?: string, options?:
|
|
3860
|
+
listIntegrations(nextToken?: string, name?: string, version?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListIntegrationsResponse>>;
|
|
3925
3861
|
/**
|
|
3926
3862
|
* Retrieves a list of [Messages](#schema_message) you’ve previously created. The messages are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
|
|
3927
3863
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
@@ -3932,7 +3868,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
3932
3868
|
*/
|
|
3933
3869
|
listMessages(nextToken?: string, conversationId?: string, tags?: {
|
|
3934
3870
|
[key: string]: string;
|
|
3935
|
-
} | undefined, options?:
|
|
3871
|
+
} | undefined, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListMessagesResponse>>;
|
|
3936
3872
|
/**
|
|
3937
3873
|
* List public integration
|
|
3938
3874
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
@@ -3941,7 +3877,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
3941
3877
|
* @param {*} [options] Override http request option.
|
|
3942
3878
|
* @throws {RequiredError}
|
|
3943
3879
|
*/
|
|
3944
|
-
listPublicIntegrations(nextToken?: string, name?: string, version?: string, options?:
|
|
3880
|
+
listPublicIntegrations(nextToken?: string, name?: string, version?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPublicIntegrationsResponse>>;
|
|
3945
3881
|
/**
|
|
3946
3882
|
* Retrieves a list of [User](#schema_user) previously created. The users are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
|
|
3947
3883
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
@@ -3952,34 +3888,34 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
3952
3888
|
*/
|
|
3953
3889
|
listUsers(nextToken?: string, conversationId?: string, tags?: {
|
|
3954
3890
|
[key: string]: string;
|
|
3955
|
-
} | undefined, options?:
|
|
3891
|
+
} | undefined, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUsersResponse>>;
|
|
3956
3892
|
/**
|
|
3957
3893
|
* List workspaces the user has access to
|
|
3958
3894
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
3959
3895
|
* @param {*} [options] Override http request option.
|
|
3960
3896
|
* @throws {RequiredError}
|
|
3961
3897
|
*/
|
|
3962
|
-
listWorkspaces(nextToken?: string, options?:
|
|
3898
|
+
listWorkspaces(nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListWorkspacesResponse>>;
|
|
3963
3899
|
/**
|
|
3964
3900
|
* Updates the [State](#schema_state) object by setting the values of the parameters passed.
|
|
3965
|
-
* @param {
|
|
3901
|
+
* @param {PatchStateTypeEnum} type State type
|
|
3966
3902
|
* @param {string} id State id
|
|
3967
3903
|
* @param {string} name State name
|
|
3968
3904
|
* @param {PatchStateBody} [patchStateBody] State content
|
|
3969
3905
|
* @param {*} [options] Override http request option.
|
|
3970
3906
|
* @throws {RequiredError}
|
|
3971
3907
|
*/
|
|
3972
|
-
patchState(type:
|
|
3908
|
+
patchState(type: PatchStateTypeEnum, id: string, name: string, patchStateBody?: PatchStateBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchStateResponse>>;
|
|
3973
3909
|
/**
|
|
3974
3910
|
* Overrides the [State](#schema_state) object by setting the values of the parameters passed.
|
|
3975
|
-
* @param {
|
|
3911
|
+
* @param {SetStateTypeEnum} type State type
|
|
3976
3912
|
* @param {string} id State id
|
|
3977
3913
|
* @param {string} name State name
|
|
3978
3914
|
* @param {SetStateBody} [setStateBody] State content
|
|
3979
3915
|
* @param {*} [options] Override http request option.
|
|
3980
3916
|
* @throws {RequiredError}
|
|
3981
3917
|
*/
|
|
3982
|
-
setState(type:
|
|
3918
|
+
setState(type: SetStateTypeEnum, id: string, name: string, setStateBody?: SetStateBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SetStateResponse>>;
|
|
3983
3919
|
/**
|
|
3984
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.
|
|
3985
3921
|
* @param {string} id Bot ID
|
|
@@ -3987,7 +3923,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
3987
3923
|
* @param {*} [options] Override http request option.
|
|
3988
3924
|
* @throws {RequiredError}
|
|
3989
3925
|
*/
|
|
3990
|
-
transferBot(id: string, transferBotBody?: TransferBotBody, options?:
|
|
3926
|
+
transferBot(id: string, transferBotBody?: TransferBotBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
3991
3927
|
/**
|
|
3992
3928
|
* Update bot
|
|
3993
3929
|
* @param {string} id Bot ID
|
|
@@ -3995,7 +3931,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
3995
3931
|
* @param {*} [options] Override http request option.
|
|
3996
3932
|
* @throws {RequiredError}
|
|
3997
3933
|
*/
|
|
3998
|
-
updateBot(id: string, updateBotBody?: UpdateBotBody, options?:
|
|
3934
|
+
updateBot(id: string, updateBotBody?: UpdateBotBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateBotResponse>>;
|
|
3999
3935
|
/**
|
|
4000
3936
|
* Update a [Conversation](#schema_conversation) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
4001
3937
|
* @param {string} id Conversation id
|
|
@@ -4003,7 +3939,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
4003
3939
|
* @param {*} [options] Override http request option.
|
|
4004
3940
|
* @throws {RequiredError}
|
|
4005
3941
|
*/
|
|
4006
|
-
updateConversation(id: string, updateConversationBody?: UpdateConversationBody, options?:
|
|
3942
|
+
updateConversation(id: string, updateConversationBody?: UpdateConversationBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateConversationResponse>>;
|
|
4007
3943
|
/**
|
|
4008
3944
|
* Update integration
|
|
4009
3945
|
* @param {string} id Integration Id
|
|
@@ -4011,7 +3947,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
4011
3947
|
* @param {*} [options] Override http request option.
|
|
4012
3948
|
* @throws {RequiredError}
|
|
4013
3949
|
*/
|
|
4014
|
-
updateIntegration(id: string, updateIntegrationBody?: UpdateIntegrationBody, options?:
|
|
3950
|
+
updateIntegration(id: string, updateIntegrationBody?: UpdateIntegrationBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateIntegrationResponse>>;
|
|
4015
3951
|
/**
|
|
4016
3952
|
* Update a message
|
|
4017
3953
|
* @param {string} id Message id
|
|
@@ -4019,7 +3955,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
4019
3955
|
* @param {*} [options] Override http request option.
|
|
4020
3956
|
* @throws {RequiredError}
|
|
4021
3957
|
*/
|
|
4022
|
-
updateMessage(id: string, updateMessageBody?: UpdateMessageBody, options?:
|
|
3958
|
+
updateMessage(id: string, updateMessageBody?: UpdateMessageBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateMessageResponse>>;
|
|
4023
3959
|
/**
|
|
4024
3960
|
* Update a [User](#schema_user) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
4025
3961
|
* @param {string} id User ID
|
|
@@ -4027,475 +3963,385 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
4027
3963
|
* @param {*} [options] Override http request option.
|
|
4028
3964
|
* @throws {RequiredError}
|
|
4029
3965
|
*/
|
|
4030
|
-
updateUser(id: string, updateUserBody?: UpdateUserBody, options?:
|
|
3966
|
+
updateUser(id: string, updateUserBody?: UpdateUserBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateUserResponse>>;
|
|
4031
3967
|
};
|
|
4032
3968
|
/**
|
|
4033
|
-
* DefaultApi - interface
|
|
3969
|
+
* DefaultApi - factory interface
|
|
4034
3970
|
* @export
|
|
4035
|
-
* @interface DefaultApi
|
|
4036
3971
|
*/
|
|
4037
|
-
export
|
|
3972
|
+
export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4038
3973
|
/**
|
|
4039
3974
|
* Call an action
|
|
4040
|
-
* @param {
|
|
3975
|
+
* @param {DefaultApiCallActionRequest} requestParameters Request parameters.
|
|
4041
3976
|
* @param {*} [options] Override http request option.
|
|
4042
3977
|
* @throws {RequiredError}
|
|
4043
|
-
* @memberof DefaultApiInterface
|
|
4044
3978
|
*/
|
|
4045
|
-
callAction(
|
|
3979
|
+
callAction(requestParameters?: DefaultApiCallActionRequest, options?: AxiosRequestConfig): AxiosPromise<CallActionResponse>;
|
|
4046
3980
|
/**
|
|
4047
3981
|
* An integration can call this endpoint to configure itself
|
|
4048
|
-
* @param {
|
|
3982
|
+
* @param {DefaultApiConfigureIntegrationRequest} requestParameters Request parameters.
|
|
4049
3983
|
* @param {*} [options] Override http request option.
|
|
4050
3984
|
* @throws {RequiredError}
|
|
4051
|
-
* @memberof DefaultApiInterface
|
|
4052
3985
|
*/
|
|
4053
|
-
configureIntegration(
|
|
3986
|
+
configureIntegration(requestParameters?: DefaultApiConfigureIntegrationRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
4054
3987
|
/**
|
|
4055
3988
|
* Create bot
|
|
4056
|
-
* @param {
|
|
3989
|
+
* @param {DefaultApiCreateBotRequest} requestParameters Request parameters.
|
|
4057
3990
|
* @param {*} [options] Override http request option.
|
|
4058
3991
|
* @throws {RequiredError}
|
|
4059
|
-
* @memberof DefaultApiInterface
|
|
4060
3992
|
*/
|
|
4061
|
-
createBot(
|
|
3993
|
+
createBot(requestParameters?: DefaultApiCreateBotRequest, options?: AxiosRequestConfig): AxiosPromise<CreateBotResponse>;
|
|
4062
3994
|
/**
|
|
4063
3995
|
* Creates a new [Conversation](#schema_conversation). When creating a new [Conversation](#schema_conversation), the required tags must be provided. See the specific integration for more details.
|
|
4064
|
-
* @param {
|
|
3996
|
+
* @param {DefaultApiCreateConversationRequest} requestParameters Request parameters.
|
|
4065
3997
|
* @param {*} [options] Override http request option.
|
|
4066
3998
|
* @throws {RequiredError}
|
|
4067
|
-
* @memberof DefaultApiInterface
|
|
4068
3999
|
*/
|
|
4069
|
-
createConversation(
|
|
4000
|
+
createConversation(requestParameters?: DefaultApiCreateConversationRequest, options?: AxiosRequestConfig): AxiosPromise<CreateConversationResponse>;
|
|
4070
4001
|
/**
|
|
4071
4002
|
* Creates a new [Event](#schema_event). When creating a new [Event](#schema_event), the required tags must be provided. See the specific integration for more details.
|
|
4072
|
-
* @param {
|
|
4003
|
+
* @param {DefaultApiCreateEventRequest} requestParameters Request parameters.
|
|
4073
4004
|
* @param {*} [options] Override http request option.
|
|
4074
4005
|
* @throws {RequiredError}
|
|
4075
|
-
* @memberof DefaultApiInterface
|
|
4076
4006
|
*/
|
|
4077
|
-
createEvent(
|
|
4007
|
+
createEvent(requestParameters?: DefaultApiCreateEventRequest, options?: AxiosRequestConfig): AxiosPromise<CreateEventResponse>;
|
|
4078
4008
|
/**
|
|
4079
4009
|
* Create File
|
|
4080
|
-
* @param {
|
|
4010
|
+
* @param {DefaultApiCreateFileRequest} requestParameters Request parameters.
|
|
4081
4011
|
* @param {*} [options] Override http request option.
|
|
4082
4012
|
* @throws {RequiredError}
|
|
4083
|
-
* @memberof DefaultApiInterface
|
|
4084
4013
|
*/
|
|
4085
|
-
createFile(
|
|
4014
|
+
createFile(requestParameters?: DefaultApiCreateFileRequest, options?: AxiosRequestConfig): AxiosPromise<CreateFileResponse>;
|
|
4086
4015
|
/**
|
|
4087
4016
|
* Create integration
|
|
4088
|
-
* @param {
|
|
4017
|
+
* @param {DefaultApiCreateIntegrationRequest} requestParameters Request parameters.
|
|
4089
4018
|
* @param {*} [options] Override http request option.
|
|
4090
4019
|
* @throws {RequiredError}
|
|
4091
|
-
* @memberof DefaultApiInterface
|
|
4092
4020
|
*/
|
|
4093
|
-
createIntegration(
|
|
4021
|
+
createIntegration(requestParameters?: DefaultApiCreateIntegrationRequest, options?: AxiosRequestConfig): AxiosPromise<CreateIntegrationResponse>;
|
|
4094
4022
|
/**
|
|
4095
4023
|
* Creates a new [Message](#schema_message). When creating a new [Message](#schema_message), the required tags must be provided. See the specific integration for more details.
|
|
4096
|
-
* @param {
|
|
4024
|
+
* @param {DefaultApiCreateMessageRequest} requestParameters Request parameters.
|
|
4097
4025
|
* @param {*} [options] Override http request option.
|
|
4098
4026
|
* @throws {RequiredError}
|
|
4099
|
-
* @memberof DefaultApiInterface
|
|
4100
4027
|
*/
|
|
4101
|
-
createMessage(
|
|
4028
|
+
createMessage(requestParameters?: DefaultApiCreateMessageRequest, options?: AxiosRequestConfig): AxiosPromise<CreateMessageResponse>;
|
|
4102
4029
|
/**
|
|
4103
4030
|
* Creates a new [User](#schema_user). When creating a new [User](#schema_user), the required tags must be provided. See the specific integration for more details.
|
|
4104
|
-
* @param {
|
|
4031
|
+
* @param {DefaultApiCreateUserRequest} requestParameters Request parameters.
|
|
4105
4032
|
* @param {*} [options] Override http request option.
|
|
4106
4033
|
* @throws {RequiredError}
|
|
4107
|
-
* @memberof DefaultApiInterface
|
|
4108
4034
|
*/
|
|
4109
|
-
createUser(
|
|
4035
|
+
createUser(requestParameters?: DefaultApiCreateUserRequest, options?: AxiosRequestConfig): AxiosPromise<CreateUserResponse>;
|
|
4110
4036
|
/**
|
|
4111
4037
|
* Delete bot
|
|
4112
|
-
* @param {
|
|
4038
|
+
* @param {DefaultApiDeleteBotRequest} requestParameters Request parameters.
|
|
4113
4039
|
* @param {*} [options] Override http request option.
|
|
4114
4040
|
* @throws {RequiredError}
|
|
4115
|
-
* @memberof DefaultApiInterface
|
|
4116
4041
|
*/
|
|
4117
|
-
deleteBot(
|
|
4042
|
+
deleteBot(requestParameters: DefaultApiDeleteBotRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
4118
4043
|
/**
|
|
4119
4044
|
* Permanently deletes a [Conversation](#schema_conversation). It cannot be undone. Also immediately deletes corresponding [Messages](#schema_message).
|
|
4120
|
-
* @param {
|
|
4045
|
+
* @param {DefaultApiDeleteConversationRequest} requestParameters Request parameters.
|
|
4121
4046
|
* @param {*} [options] Override http request option.
|
|
4122
4047
|
* @throws {RequiredError}
|
|
4123
|
-
* @memberof DefaultApiInterface
|
|
4124
4048
|
*/
|
|
4125
|
-
deleteConversation(
|
|
4049
|
+
deleteConversation(requestParameters: DefaultApiDeleteConversationRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
4126
4050
|
/**
|
|
4127
4051
|
* Delete File
|
|
4128
|
-
* @param {
|
|
4052
|
+
* @param {DefaultApiDeleteFileRequest} requestParameters Request parameters.
|
|
4129
4053
|
* @param {*} [options] Override http request option.
|
|
4130
4054
|
* @throws {RequiredError}
|
|
4131
|
-
* @memberof DefaultApiInterface
|
|
4132
4055
|
*/
|
|
4133
|
-
deleteFile(
|
|
4056
|
+
deleteFile(requestParameters: DefaultApiDeleteFileRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
4134
4057
|
/**
|
|
4135
4058
|
* Delete integration
|
|
4136
|
-
* @param {
|
|
4059
|
+
* @param {DefaultApiDeleteIntegrationRequest} requestParameters Request parameters.
|
|
4137
4060
|
* @param {*} [options] Override http request option.
|
|
4138
4061
|
* @throws {RequiredError}
|
|
4139
|
-
* @memberof DefaultApiInterface
|
|
4140
4062
|
*/
|
|
4141
|
-
deleteIntegration(
|
|
4063
|
+
deleteIntegration(requestParameters: DefaultApiDeleteIntegrationRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
4142
4064
|
/**
|
|
4143
4065
|
* Permanently deletes a [Message](#schema_message). It cannot be undone.
|
|
4144
|
-
* @param {
|
|
4066
|
+
* @param {DefaultApiDeleteMessageRequest} requestParameters Request parameters.
|
|
4145
4067
|
* @param {*} [options] Override http request option.
|
|
4146
4068
|
* @throws {RequiredError}
|
|
4147
|
-
* @memberof DefaultApiInterface
|
|
4148
4069
|
*/
|
|
4149
|
-
deleteMessage(
|
|
4070
|
+
deleteMessage(requestParameters: DefaultApiDeleteMessageRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
4150
4071
|
/**
|
|
4151
4072
|
* Permanently deletes a [User](#schema_user). It cannot be undone.
|
|
4152
|
-
* @param {
|
|
4073
|
+
* @param {DefaultApiDeleteUserRequest} requestParameters Request parameters.
|
|
4153
4074
|
* @param {*} [options] Override http request option.
|
|
4154
4075
|
* @throws {RequiredError}
|
|
4155
|
-
* @memberof DefaultApiInterface
|
|
4156
4076
|
*/
|
|
4157
|
-
deleteUser(
|
|
4077
|
+
deleteUser(requestParameters: DefaultApiDeleteUserRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
4158
4078
|
/**
|
|
4159
4079
|
* Download File
|
|
4160
|
-
* @param {
|
|
4080
|
+
* @param {DefaultApiDownloadFileRequest} requestParameters Request parameters.
|
|
4161
4081
|
* @param {*} [options] Override http request option.
|
|
4162
4082
|
* @throws {RequiredError}
|
|
4163
|
-
* @memberof DefaultApiInterface
|
|
4164
4083
|
*/
|
|
4165
|
-
downloadFile(
|
|
4084
|
+
downloadFile(requestParameters: DefaultApiDownloadFileRequest, options?: AxiosRequestConfig): AxiosPromise<any>;
|
|
4166
4085
|
/**
|
|
4167
4086
|
* Get bot details
|
|
4168
|
-
* @param {
|
|
4087
|
+
* @param {DefaultApiGetBotRequest} requestParameters Request parameters.
|
|
4169
4088
|
* @param {*} [options] Override http request option.
|
|
4170
4089
|
* @throws {RequiredError}
|
|
4171
|
-
* @memberof DefaultApiInterface
|
|
4172
4090
|
*/
|
|
4173
|
-
getBot(
|
|
4091
|
+
getBot(requestParameters: DefaultApiGetBotRequest, options?: AxiosRequestConfig): AxiosPromise<GetBotResponse>;
|
|
4174
4092
|
/**
|
|
4175
4093
|
* Get bot analytics
|
|
4176
|
-
* @param {
|
|
4177
|
-
* @param {string} startDate Start date/time (inclusive)
|
|
4178
|
-
* @param {string} endDate End date/time (exclusive)
|
|
4094
|
+
* @param {DefaultApiGetBotAnalyticsRequest} requestParameters Request parameters.
|
|
4179
4095
|
* @param {*} [options] Override http request option.
|
|
4180
4096
|
* @throws {RequiredError}
|
|
4181
|
-
* @memberof DefaultApiInterface
|
|
4182
4097
|
*/
|
|
4183
|
-
getBotAnalytics(
|
|
4098
|
+
getBotAnalytics(requestParameters: DefaultApiGetBotAnalyticsRequest, options?: AxiosRequestConfig): AxiosPromise<GetBotAnalyticsResponse>;
|
|
4184
4099
|
/**
|
|
4185
4100
|
* Get bot logs
|
|
4186
|
-
* @param {
|
|
4101
|
+
* @param {DefaultApiGetBotLogsRequest} requestParameters Request parameters.
|
|
4187
4102
|
* @param {*} [options] Override http request option.
|
|
4188
4103
|
* @throws {RequiredError}
|
|
4189
|
-
* @memberof DefaultApiInterface
|
|
4190
4104
|
*/
|
|
4191
|
-
getBotLogs(
|
|
4105
|
+
getBotLogs(requestParameters: DefaultApiGetBotLogsRequest, options?: AxiosRequestConfig): AxiosPromise<GetBotLogsResponse>;
|
|
4192
4106
|
/**
|
|
4193
4107
|
* Get the webchat code/URL for a bot
|
|
4194
|
-
* @param {
|
|
4195
|
-
* @param {'preconfigured' | 'configurable' | 'fullscreen' | 'sharableUrl'} type type of script to get
|
|
4108
|
+
* @param {DefaultApiGetBotWebchatRequest} requestParameters Request parameters.
|
|
4196
4109
|
* @param {*} [options] Override http request option.
|
|
4197
4110
|
* @throws {RequiredError}
|
|
4198
|
-
* @memberof DefaultApiInterface
|
|
4199
4111
|
*/
|
|
4200
|
-
getBotWebchat(
|
|
4112
|
+
getBotWebchat(requestParameters: DefaultApiGetBotWebchatRequest, options?: AxiosRequestConfig): AxiosPromise<GetBotWebchatResponse>;
|
|
4201
4113
|
/**
|
|
4202
4114
|
* Retrieves the [Conversation](#schema_conversation) object for a valid identifier.
|
|
4203
|
-
* @param {
|
|
4115
|
+
* @param {DefaultApiGetConversationRequest} requestParameters Request parameters.
|
|
4204
4116
|
* @param {*} [options] Override http request option.
|
|
4205
4117
|
* @throws {RequiredError}
|
|
4206
|
-
* @memberof DefaultApiInterface
|
|
4207
4118
|
*/
|
|
4208
|
-
getConversation(
|
|
4119
|
+
getConversation(requestParameters: DefaultApiGetConversationRequest, options?: AxiosRequestConfig): AxiosPromise<GetConversationResponse>;
|
|
4209
4120
|
/**
|
|
4210
4121
|
* Retrieves the [Event](#schema_event) object for a valid identifiers.
|
|
4211
|
-
* @param {
|
|
4122
|
+
* @param {DefaultApiGetEventRequest} requestParameters Request parameters.
|
|
4212
4123
|
* @param {*} [options] Override http request option.
|
|
4213
4124
|
* @throws {RequiredError}
|
|
4214
|
-
* @memberof DefaultApiInterface
|
|
4215
4125
|
*/
|
|
4216
|
-
getEvent(
|
|
4126
|
+
getEvent(requestParameters: DefaultApiGetEventRequest, options?: AxiosRequestConfig): AxiosPromise<GetEventResponse>;
|
|
4217
4127
|
/**
|
|
4218
4128
|
* Get File
|
|
4219
|
-
* @param {
|
|
4129
|
+
* @param {DefaultApiGetFileRequest} requestParameters Request parameters.
|
|
4220
4130
|
* @param {*} [options] Override http request option.
|
|
4221
4131
|
* @throws {RequiredError}
|
|
4222
|
-
* @memberof DefaultApiInterface
|
|
4223
4132
|
*/
|
|
4224
|
-
getFile(
|
|
4133
|
+
getFile(requestParameters: DefaultApiGetFileRequest, options?: AxiosRequestConfig): AxiosPromise<GetFileResponse>;
|
|
4225
4134
|
/**
|
|
4226
4135
|
* Get integration
|
|
4227
|
-
* @param {
|
|
4136
|
+
* @param {DefaultApiGetIntegrationRequest} requestParameters Request parameters.
|
|
4228
4137
|
* @param {*} [options] Override http request option.
|
|
4229
4138
|
* @throws {RequiredError}
|
|
4230
|
-
* @memberof DefaultApiInterface
|
|
4231
4139
|
*/
|
|
4232
|
-
getIntegration(
|
|
4140
|
+
getIntegration(requestParameters: DefaultApiGetIntegrationRequest, options?: AxiosRequestConfig): AxiosPromise<GetIntegrationResponse>;
|
|
4233
4141
|
/**
|
|
4234
4142
|
* Get integration
|
|
4235
|
-
* @param {
|
|
4236
|
-
* @param {string} version Integration version. Either a semver version or tag \"latest\"
|
|
4143
|
+
* @param {DefaultApiGetIntegrationByNameRequest} requestParameters Request parameters.
|
|
4237
4144
|
* @param {*} [options] Override http request option.
|
|
4238
4145
|
* @throws {RequiredError}
|
|
4239
|
-
* @memberof DefaultApiInterface
|
|
4240
4146
|
*/
|
|
4241
|
-
getIntegrationByName(
|
|
4147
|
+
getIntegrationByName(requestParameters: DefaultApiGetIntegrationByNameRequest, options?: AxiosRequestConfig): AxiosPromise<GetIntegrationByNameResponse>;
|
|
4242
4148
|
/**
|
|
4243
4149
|
* Get integration logs
|
|
4244
|
-
* @param {
|
|
4150
|
+
* @param {DefaultApiGetIntegrationLogsRequest} requestParameters Request parameters.
|
|
4245
4151
|
* @param {*} [options] Override http request option.
|
|
4246
4152
|
* @throws {RequiredError}
|
|
4247
|
-
* @memberof DefaultApiInterface
|
|
4248
4153
|
*/
|
|
4249
|
-
getIntegrationLogs(
|
|
4154
|
+
getIntegrationLogs(requestParameters: DefaultApiGetIntegrationLogsRequest, options?: AxiosRequestConfig): AxiosPromise<GetIntegrationLogsResponse>;
|
|
4250
4155
|
/**
|
|
4251
4156
|
* Retrieves the [Message](#schema_message) object for a valid identifier.
|
|
4252
|
-
* @param {
|
|
4157
|
+
* @param {DefaultApiGetMessageRequest} requestParameters Request parameters.
|
|
4253
4158
|
* @param {*} [options] Override http request option.
|
|
4254
4159
|
* @throws {RequiredError}
|
|
4255
|
-
* @memberof DefaultApiInterface
|
|
4256
4160
|
*/
|
|
4257
|
-
getMessage(
|
|
4161
|
+
getMessage(requestParameters: DefaultApiGetMessageRequest, options?: AxiosRequestConfig): AxiosPromise<GetMessageResponse>;
|
|
4258
4162
|
/**
|
|
4259
4163
|
* Retrieves the [Conversation](#schema_conversation) object for a valid identifier. If the conversation does not exist, it will be created.
|
|
4260
|
-
* @param {
|
|
4164
|
+
* @param {DefaultApiGetOrCreateConversationRequest} requestParameters Request parameters.
|
|
4261
4165
|
* @param {*} [options] Override http request option.
|
|
4262
4166
|
* @throws {RequiredError}
|
|
4263
|
-
* @memberof DefaultApiInterface
|
|
4264
4167
|
*/
|
|
4265
|
-
getOrCreateConversation(
|
|
4168
|
+
getOrCreateConversation(requestParameters?: DefaultApiGetOrCreateConversationRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrCreateConversationResponse>;
|
|
4266
4169
|
/**
|
|
4267
4170
|
* Retrieves the [Message](#schema_message) object for a valid identifier. If the message does not exist, it will be created.
|
|
4268
|
-
* @param {
|
|
4171
|
+
* @param {DefaultApiGetOrCreateMessageRequest} requestParameters Request parameters.
|
|
4269
4172
|
* @param {*} [options] Override http request option.
|
|
4270
4173
|
* @throws {RequiredError}
|
|
4271
|
-
* @memberof DefaultApiInterface
|
|
4272
4174
|
*/
|
|
4273
|
-
getOrCreateMessage(
|
|
4175
|
+
getOrCreateMessage(requestParameters?: DefaultApiGetOrCreateMessageRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrCreateMessageResponse>;
|
|
4274
4176
|
/**
|
|
4275
4177
|
* Retrieves the [User](#schema_user) object for a valid identifier. If the user does not exist, it will be created.
|
|
4276
|
-
* @param {
|
|
4178
|
+
* @param {DefaultApiGetOrCreateUserRequest} requestParameters Request parameters.
|
|
4277
4179
|
* @param {*} [options] Override http request option.
|
|
4278
4180
|
* @throws {RequiredError}
|
|
4279
|
-
* @memberof DefaultApiInterface
|
|
4280
4181
|
*/
|
|
4281
|
-
getOrCreateUser(
|
|
4182
|
+
getOrCreateUser(requestParameters?: DefaultApiGetOrCreateUserRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrCreateUserResponse>;
|
|
4282
4183
|
/**
|
|
4283
4184
|
* Get public integration by name and version
|
|
4284
|
-
* @param {
|
|
4285
|
-
* @param {string} version Integration version. Either a semver version or tag \"latest\"
|
|
4185
|
+
* @param {DefaultApiGetPublicIntegrationRequest} requestParameters Request parameters.
|
|
4286
4186
|
* @param {*} [options] Override http request option.
|
|
4287
4187
|
* @throws {RequiredError}
|
|
4288
|
-
* @memberof DefaultApiInterface
|
|
4289
4188
|
*/
|
|
4290
|
-
getPublicIntegration(
|
|
4189
|
+
getPublicIntegration(requestParameters: DefaultApiGetPublicIntegrationRequest, options?: AxiosRequestConfig): AxiosPromise<GetPublicIntegrationResponse>;
|
|
4291
4190
|
/**
|
|
4292
4191
|
* Get public integration by Id
|
|
4293
|
-
* @param {
|
|
4192
|
+
* @param {DefaultApiGetPublicIntegrationByIdRequest} requestParameters Request parameters.
|
|
4294
4193
|
* @param {*} [options] Override http request option.
|
|
4295
4194
|
* @throws {RequiredError}
|
|
4296
|
-
* @memberof DefaultApiInterface
|
|
4297
4195
|
*/
|
|
4298
|
-
getPublicIntegrationById(
|
|
4196
|
+
getPublicIntegrationById(requestParameters: DefaultApiGetPublicIntegrationByIdRequest, options?: AxiosRequestConfig): AxiosPromise<GetPublicIntegrationByIdResponse>;
|
|
4299
4197
|
/**
|
|
4300
4198
|
* Retrieves the [State](#schema_state) object for a valid identifiers.
|
|
4301
|
-
* @param {
|
|
4302
|
-
* @param {string} id State id
|
|
4303
|
-
* @param {string} name State name
|
|
4199
|
+
* @param {DefaultApiGetStateRequest} requestParameters Request parameters.
|
|
4304
4200
|
* @param {*} [options] Override http request option.
|
|
4305
4201
|
* @throws {RequiredError}
|
|
4306
|
-
* @memberof DefaultApiInterface
|
|
4307
4202
|
*/
|
|
4308
|
-
getState(
|
|
4203
|
+
getState(requestParameters: DefaultApiGetStateRequest, options?: AxiosRequestConfig): AxiosPromise<GetStateResponse>;
|
|
4309
4204
|
/**
|
|
4310
4205
|
* Retrieves the [User](#schema_user) object for a valid identifier.
|
|
4311
|
-
* @param {
|
|
4206
|
+
* @param {DefaultApiGetUserRequest} requestParameters Request parameters.
|
|
4312
4207
|
* @param {*} [options] Override http request option.
|
|
4313
4208
|
* @throws {RequiredError}
|
|
4314
|
-
* @memberof DefaultApiInterface
|
|
4315
4209
|
*/
|
|
4316
|
-
getUser(
|
|
4210
|
+
getUser(requestParameters: DefaultApiGetUserRequest, options?: AxiosRequestConfig): AxiosPromise<GetUserResponse>;
|
|
4317
4211
|
/**
|
|
4318
4212
|
* Get workspace details
|
|
4319
|
-
* @param {
|
|
4213
|
+
* @param {DefaultApiGetWorkspaceRequest} requestParameters Request parameters.
|
|
4320
4214
|
* @param {*} [options] Override http request option.
|
|
4321
4215
|
* @throws {RequiredError}
|
|
4322
|
-
* @memberof DefaultApiInterface
|
|
4323
4216
|
*/
|
|
4324
|
-
getWorkspace(
|
|
4217
|
+
getWorkspace(requestParameters: DefaultApiGetWorkspaceRequest, options?: AxiosRequestConfig): AxiosPromise<GetWorkspaceResponse>;
|
|
4325
4218
|
/**
|
|
4326
4219
|
* Introspect the API
|
|
4327
|
-
* @param {
|
|
4220
|
+
* @param {DefaultApiIntrospectRequest} requestParameters Request parameters.
|
|
4328
4221
|
* @param {*} [options] Override http request option.
|
|
4329
4222
|
* @throws {RequiredError}
|
|
4330
|
-
* @memberof DefaultApiInterface
|
|
4331
4223
|
*/
|
|
4332
|
-
introspect(
|
|
4224
|
+
introspect(requestParameters?: DefaultApiIntrospectRequest, options?: AxiosRequestConfig): AxiosPromise<IntrospectResponse>;
|
|
4333
4225
|
/**
|
|
4334
4226
|
* List bots
|
|
4335
|
-
* @param {
|
|
4227
|
+
* @param {DefaultApiListBotsRequest} requestParameters Request parameters.
|
|
4336
4228
|
* @param {*} [options] Override http request option.
|
|
4337
4229
|
* @throws {RequiredError}
|
|
4338
|
-
* @memberof DefaultApiInterface
|
|
4339
4230
|
*/
|
|
4340
|
-
listBots(
|
|
4231
|
+
listBots(requestParameters?: DefaultApiListBotsRequest, options?: AxiosRequestConfig): AxiosPromise<ListBotsResponse>;
|
|
4341
4232
|
/**
|
|
4342
4233
|
* Retrieves a list of [Conversation](#schema_conversation) you’ve previously created. The conversations are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
|
|
4343
|
-
* @param {
|
|
4344
|
-
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
4345
|
-
* @param {Array<string>} [participantIds] Filter by participant ids
|
|
4234
|
+
* @param {DefaultApiListConversationsRequest} requestParameters Request parameters.
|
|
4346
4235
|
* @param {*} [options] Override http request option.
|
|
4347
4236
|
* @throws {RequiredError}
|
|
4348
|
-
* @memberof DefaultApiInterface
|
|
4349
4237
|
*/
|
|
4350
|
-
listConversations(
|
|
4351
|
-
[key: string]: string;
|
|
4352
|
-
}, participantIds?: Array<string>, options?: AxiosRequestConfig): AxiosPromise<ListConversationsResponse>;
|
|
4238
|
+
listConversations(requestParameters?: DefaultApiListConversationsRequest, options?: AxiosRequestConfig): AxiosPromise<ListConversationsResponse>;
|
|
4353
4239
|
/**
|
|
4354
4240
|
* Retreives a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
|
|
4355
|
-
* @param {
|
|
4241
|
+
* @param {DefaultApiListEventsRequest} requestParameters Request parameters.
|
|
4356
4242
|
* @param {*} [options] Override http request option.
|
|
4357
4243
|
* @throws {RequiredError}
|
|
4358
|
-
* @memberof DefaultApiInterface
|
|
4359
4244
|
*/
|
|
4360
|
-
listEvents(
|
|
4245
|
+
listEvents(requestParameters?: DefaultApiListEventsRequest, options?: AxiosRequestConfig): AxiosPromise<ListEventsResponse>;
|
|
4361
4246
|
/**
|
|
4362
4247
|
* List Files
|
|
4363
|
-
* @param {
|
|
4364
|
-
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
4248
|
+
* @param {DefaultApiListFilesRequest} requestParameters Request parameters.
|
|
4365
4249
|
* @param {*} [options] Override http request option.
|
|
4366
4250
|
* @throws {RequiredError}
|
|
4367
|
-
* @memberof DefaultApiInterface
|
|
4368
4251
|
*/
|
|
4369
|
-
listFiles(
|
|
4252
|
+
listFiles(requestParameters: DefaultApiListFilesRequest, options?: AxiosRequestConfig): AxiosPromise<ListFilesResponse>;
|
|
4370
4253
|
/**
|
|
4371
4254
|
* List integrations
|
|
4372
|
-
* @param {
|
|
4373
|
-
* @param {string} [name] Integration Name
|
|
4374
|
-
* @param {string} [version] Integration version. Either a semver version or tag \"latest\"
|
|
4255
|
+
* @param {DefaultApiListIntegrationsRequest} requestParameters Request parameters.
|
|
4375
4256
|
* @param {*} [options] Override http request option.
|
|
4376
4257
|
* @throws {RequiredError}
|
|
4377
|
-
* @memberof DefaultApiInterface
|
|
4378
4258
|
*/
|
|
4379
|
-
listIntegrations(
|
|
4259
|
+
listIntegrations(requestParameters?: DefaultApiListIntegrationsRequest, options?: AxiosRequestConfig): AxiosPromise<ListIntegrationsResponse>;
|
|
4380
4260
|
/**
|
|
4381
4261
|
* Retrieves a list of [Messages](#schema_message) you’ve previously created. The messages are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
|
|
4382
|
-
* @param {
|
|
4383
|
-
* @param {string} [conversationId] Conversation id
|
|
4384
|
-
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
4262
|
+
* @param {DefaultApiListMessagesRequest} requestParameters Request parameters.
|
|
4385
4263
|
* @param {*} [options] Override http request option.
|
|
4386
4264
|
* @throws {RequiredError}
|
|
4387
|
-
* @memberof DefaultApiInterface
|
|
4388
4265
|
*/
|
|
4389
|
-
listMessages(
|
|
4390
|
-
[key: string]: string;
|
|
4391
|
-
}, options?: AxiosRequestConfig): AxiosPromise<ListMessagesResponse>;
|
|
4266
|
+
listMessages(requestParameters?: DefaultApiListMessagesRequest, options?: AxiosRequestConfig): AxiosPromise<ListMessagesResponse>;
|
|
4392
4267
|
/**
|
|
4393
4268
|
* List public integration
|
|
4394
|
-
* @param {
|
|
4395
|
-
* @param {string} [name] Integration Name
|
|
4396
|
-
* @param {string} [version] Integration version. Either a semver version or tag \"latest\"
|
|
4269
|
+
* @param {DefaultApiListPublicIntegrationsRequest} requestParameters Request parameters.
|
|
4397
4270
|
* @param {*} [options] Override http request option.
|
|
4398
4271
|
* @throws {RequiredError}
|
|
4399
|
-
* @memberof DefaultApiInterface
|
|
4400
4272
|
*/
|
|
4401
|
-
listPublicIntegrations(
|
|
4273
|
+
listPublicIntegrations(requestParameters?: DefaultApiListPublicIntegrationsRequest, options?: AxiosRequestConfig): AxiosPromise<ListPublicIntegrationsResponse>;
|
|
4402
4274
|
/**
|
|
4403
4275
|
* Retrieves a list of [User](#schema_user) previously created. The users are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
|
|
4404
|
-
* @param {
|
|
4405
|
-
* @param {string} [conversationId] Filter by conversation id. This will return all users that have participated in the conversation.
|
|
4406
|
-
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
4276
|
+
* @param {DefaultApiListUsersRequest} requestParameters Request parameters.
|
|
4407
4277
|
* @param {*} [options] Override http request option.
|
|
4408
4278
|
* @throws {RequiredError}
|
|
4409
|
-
* @memberof DefaultApiInterface
|
|
4410
4279
|
*/
|
|
4411
|
-
listUsers(
|
|
4412
|
-
[key: string]: string;
|
|
4413
|
-
}, options?: AxiosRequestConfig): AxiosPromise<ListUsersResponse>;
|
|
4280
|
+
listUsers(requestParameters?: DefaultApiListUsersRequest, options?: AxiosRequestConfig): AxiosPromise<ListUsersResponse>;
|
|
4414
4281
|
/**
|
|
4415
4282
|
* List workspaces the user has access to
|
|
4416
|
-
* @param {
|
|
4283
|
+
* @param {DefaultApiListWorkspacesRequest} requestParameters Request parameters.
|
|
4417
4284
|
* @param {*} [options] Override http request option.
|
|
4418
4285
|
* @throws {RequiredError}
|
|
4419
|
-
* @memberof DefaultApiInterface
|
|
4420
4286
|
*/
|
|
4421
|
-
listWorkspaces(
|
|
4287
|
+
listWorkspaces(requestParameters?: DefaultApiListWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<ListWorkspacesResponse>;
|
|
4422
4288
|
/**
|
|
4423
4289
|
* Updates the [State](#schema_state) object by setting the values of the parameters passed.
|
|
4424
|
-
* @param {
|
|
4425
|
-
* @param {string} id State id
|
|
4426
|
-
* @param {string} name State name
|
|
4427
|
-
* @param {PatchStateBody} [patchStateBody] State content
|
|
4290
|
+
* @param {DefaultApiPatchStateRequest} requestParameters Request parameters.
|
|
4428
4291
|
* @param {*} [options] Override http request option.
|
|
4429
4292
|
* @throws {RequiredError}
|
|
4430
|
-
* @memberof DefaultApiInterface
|
|
4431
4293
|
*/
|
|
4432
|
-
patchState(
|
|
4294
|
+
patchState(requestParameters: DefaultApiPatchStateRequest, options?: AxiosRequestConfig): AxiosPromise<PatchStateResponse>;
|
|
4433
4295
|
/**
|
|
4434
4296
|
* Overrides the [State](#schema_state) object by setting the values of the parameters passed.
|
|
4435
|
-
* @param {
|
|
4436
|
-
* @param {string} id State id
|
|
4437
|
-
* @param {string} name State name
|
|
4438
|
-
* @param {SetStateBody} [setStateBody] State content
|
|
4297
|
+
* @param {DefaultApiSetStateRequest} requestParameters Request parameters.
|
|
4439
4298
|
* @param {*} [options] Override http request option.
|
|
4440
4299
|
* @throws {RequiredError}
|
|
4441
|
-
* @memberof DefaultApiInterface
|
|
4442
4300
|
*/
|
|
4443
|
-
setState(
|
|
4301
|
+
setState(requestParameters: DefaultApiSetStateRequest, options?: AxiosRequestConfig): AxiosPromise<SetStateResponse>;
|
|
4444
4302
|
/**
|
|
4445
4303
|
* 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.
|
|
4446
|
-
* @param {
|
|
4447
|
-
* @param {TransferBotBody} [transferBotBody] Bot transfer request
|
|
4304
|
+
* @param {DefaultApiTransferBotRequest} requestParameters Request parameters.
|
|
4448
4305
|
* @param {*} [options] Override http request option.
|
|
4449
4306
|
* @throws {RequiredError}
|
|
4450
|
-
* @memberof DefaultApiInterface
|
|
4451
4307
|
*/
|
|
4452
|
-
transferBot(
|
|
4308
|
+
transferBot(requestParameters: DefaultApiTransferBotRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
4453
4309
|
/**
|
|
4454
4310
|
* Update bot
|
|
4455
|
-
* @param {
|
|
4456
|
-
* @param {UpdateBotBody} [updateBotBody] Bot metadata
|
|
4311
|
+
* @param {DefaultApiUpdateBotRequest} requestParameters Request parameters.
|
|
4457
4312
|
* @param {*} [options] Override http request option.
|
|
4458
4313
|
* @throws {RequiredError}
|
|
4459
|
-
* @memberof DefaultApiInterface
|
|
4460
4314
|
*/
|
|
4461
|
-
updateBot(
|
|
4315
|
+
updateBot(requestParameters: DefaultApiUpdateBotRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateBotResponse>;
|
|
4462
4316
|
/**
|
|
4463
4317
|
* Update a [Conversation](#schema_conversation) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
4464
|
-
* @param {
|
|
4465
|
-
* @param {UpdateConversationBody} [updateConversationBody] Conversation data
|
|
4318
|
+
* @param {DefaultApiUpdateConversationRequest} requestParameters Request parameters.
|
|
4466
4319
|
* @param {*} [options] Override http request option.
|
|
4467
4320
|
* @throws {RequiredError}
|
|
4468
|
-
* @memberof DefaultApiInterface
|
|
4469
4321
|
*/
|
|
4470
|
-
updateConversation(
|
|
4322
|
+
updateConversation(requestParameters: DefaultApiUpdateConversationRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateConversationResponse>;
|
|
4471
4323
|
/**
|
|
4472
4324
|
* Update integration
|
|
4473
|
-
* @param {
|
|
4474
|
-
* @param {UpdateIntegrationBody} [updateIntegrationBody] Integration
|
|
4325
|
+
* @param {DefaultApiUpdateIntegrationRequest} requestParameters Request parameters.
|
|
4475
4326
|
* @param {*} [options] Override http request option.
|
|
4476
4327
|
* @throws {RequiredError}
|
|
4477
|
-
* @memberof DefaultApiInterface
|
|
4478
4328
|
*/
|
|
4479
|
-
updateIntegration(
|
|
4329
|
+
updateIntegration(requestParameters: DefaultApiUpdateIntegrationRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateIntegrationResponse>;
|
|
4480
4330
|
/**
|
|
4481
4331
|
* Update a message
|
|
4482
|
-
* @param {
|
|
4483
|
-
* @param {UpdateMessageBody} [updateMessageBody] Message data
|
|
4332
|
+
* @param {DefaultApiUpdateMessageRequest} requestParameters Request parameters.
|
|
4484
4333
|
* @param {*} [options] Override http request option.
|
|
4485
4334
|
* @throws {RequiredError}
|
|
4486
|
-
* @memberof DefaultApiInterface
|
|
4487
4335
|
*/
|
|
4488
|
-
updateMessage(
|
|
4336
|
+
updateMessage(requestParameters: DefaultApiUpdateMessageRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateMessageResponse>;
|
|
4489
4337
|
/**
|
|
4490
4338
|
* Update a [User](#schema_user) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
4491
|
-
* @param {
|
|
4492
|
-
* @param {UpdateUserBody} [updateUserBody] User data
|
|
4339
|
+
* @param {DefaultApiUpdateUserRequest} requestParameters Request parameters.
|
|
4493
4340
|
* @param {*} [options] Override http request option.
|
|
4494
4341
|
* @throws {RequiredError}
|
|
4495
|
-
* @memberof DefaultApiInterface
|
|
4496
4342
|
*/
|
|
4497
|
-
updateUser(
|
|
4498
|
-
}
|
|
4343
|
+
updateUser(requestParameters: DefaultApiUpdateUserRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateUserResponse>;
|
|
4344
|
+
};
|
|
4499
4345
|
/**
|
|
4500
4346
|
* Request parameters for callAction operation in DefaultApi.
|
|
4501
4347
|
* @export
|
|
@@ -4772,7 +4618,7 @@ export interface DefaultApiGetBotWebchatRequest {
|
|
|
4772
4618
|
* @type {'preconfigured' | 'configurable' | 'fullscreen' | 'sharableUrl'}
|
|
4773
4619
|
* @memberof DefaultApiGetBotWebchat
|
|
4774
4620
|
*/
|
|
4775
|
-
readonly type:
|
|
4621
|
+
readonly type: GetBotWebchatTypeEnum;
|
|
4776
4622
|
}
|
|
4777
4623
|
/**
|
|
4778
4624
|
* Request parameters for getConversation operation in DefaultApi.
|
|
@@ -4953,7 +4799,7 @@ export interface DefaultApiGetStateRequest {
|
|
|
4953
4799
|
* @type {'conversation' | 'user' | 'bot' | 'integration'}
|
|
4954
4800
|
* @memberof DefaultApiGetState
|
|
4955
4801
|
*/
|
|
4956
|
-
readonly type:
|
|
4802
|
+
readonly type: GetStateTypeEnum;
|
|
4957
4803
|
/**
|
|
4958
4804
|
* State id
|
|
4959
4805
|
* @type {string}
|
|
@@ -5058,6 +4904,12 @@ export interface DefaultApiListEventsRequest {
|
|
|
5058
4904
|
* @memberof DefaultApiListEvents
|
|
5059
4905
|
*/
|
|
5060
4906
|
readonly nextToken?: string;
|
|
4907
|
+
/**
|
|
4908
|
+
* Filter by event type
|
|
4909
|
+
* @type {string}
|
|
4910
|
+
* @memberof DefaultApiListEvents
|
|
4911
|
+
*/
|
|
4912
|
+
readonly type?: string;
|
|
5061
4913
|
}
|
|
5062
4914
|
/**
|
|
5063
4915
|
* Request parameters for listFiles operation in DefaultApi.
|
|
@@ -5206,7 +5058,7 @@ export interface DefaultApiPatchStateRequest {
|
|
|
5206
5058
|
* @type {'conversation' | 'user' | 'bot' | 'integration'}
|
|
5207
5059
|
* @memberof DefaultApiPatchState
|
|
5208
5060
|
*/
|
|
5209
|
-
readonly type:
|
|
5061
|
+
readonly type: PatchStateTypeEnum;
|
|
5210
5062
|
/**
|
|
5211
5063
|
* State id
|
|
5212
5064
|
* @type {string}
|
|
@@ -5237,7 +5089,7 @@ export interface DefaultApiSetStateRequest {
|
|
|
5237
5089
|
* @type {'conversation' | 'user' | 'bot' | 'integration'}
|
|
5238
5090
|
* @memberof DefaultApiSetState
|
|
5239
5091
|
*/
|
|
5240
|
-
readonly type:
|
|
5092
|
+
readonly type: SetStateTypeEnum;
|
|
5241
5093
|
/**
|
|
5242
5094
|
* State id
|
|
5243
5095
|
* @type {string}
|
|
@@ -5377,7 +5229,7 @@ export interface DefaultApiUpdateUserRequest {
|
|
|
5377
5229
|
* @class DefaultApi
|
|
5378
5230
|
* @extends {BaseAPI}
|
|
5379
5231
|
*/
|
|
5380
|
-
export declare class DefaultApi extends BaseAPI
|
|
5232
|
+
export declare class DefaultApi extends BaseAPI {
|
|
5381
5233
|
/**
|
|
5382
5234
|
* Call an action
|
|
5383
5235
|
* @param {DefaultApiCallActionRequest} requestParameters Request parameters.
|
|
@@ -5803,3 +5655,43 @@ export declare class DefaultApi extends BaseAPI implements DefaultApiInterface {
|
|
|
5803
5655
|
*/
|
|
5804
5656
|
updateUser(requestParameters: DefaultApiUpdateUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateUserResponse, any>>;
|
|
5805
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];
|