@scout9/admin 1.0.0-alpha.0.0.67 → 1.0.0-alpha.0.0.68
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/build/api.d.ts +285 -16
- package/build/api.js +30 -3
- package/package.json +1 -1
- package/src/api.ts +296 -16
- package/tsconfig.tsbuildinfo +1 -1
package/build/api.d.ts
CHANGED
|
@@ -617,10 +617,17 @@ export interface Conversation {
|
|
|
617
617
|
* @memberof Conversation
|
|
618
618
|
*/
|
|
619
619
|
'initialContexts'?: Array<string>;
|
|
620
|
+
/**
|
|
621
|
+
*
|
|
622
|
+
* @type {ConversationChannelProps}
|
|
623
|
+
* @memberof Conversation
|
|
624
|
+
*/
|
|
625
|
+
'channelProps'?: ConversationChannelProps;
|
|
620
626
|
/**
|
|
621
627
|
*
|
|
622
628
|
* @type {ConversationBaseEnvironmentProps}
|
|
623
629
|
* @memberof Conversation
|
|
630
|
+
* @deprecated
|
|
624
631
|
*/
|
|
625
632
|
'environmentProps'?: ConversationBaseEnvironmentProps;
|
|
626
633
|
/**
|
|
@@ -636,12 +643,19 @@ export interface Conversation {
|
|
|
636
643
|
* @deprecated
|
|
637
644
|
*/
|
|
638
645
|
'$customer'?: string;
|
|
646
|
+
/**
|
|
647
|
+
*
|
|
648
|
+
* @type {ConversationChannel}
|
|
649
|
+
* @memberof Conversation
|
|
650
|
+
*/
|
|
651
|
+
'channel': ConversationChannel;
|
|
639
652
|
/**
|
|
640
653
|
*
|
|
641
654
|
* @type {ConversationEnvironment}
|
|
642
655
|
* @memberof Conversation
|
|
656
|
+
* @deprecated
|
|
643
657
|
*/
|
|
644
|
-
'environment'
|
|
658
|
+
'environment'?: ConversationEnvironment;
|
|
645
659
|
/**
|
|
646
660
|
* Whether this conversation is a test or not
|
|
647
661
|
* @type {boolean}
|
|
@@ -668,12 +682,19 @@ export interface ConversationAllOf {
|
|
|
668
682
|
* @deprecated
|
|
669
683
|
*/
|
|
670
684
|
'$customer'?: string;
|
|
685
|
+
/**
|
|
686
|
+
*
|
|
687
|
+
* @type {ConversationChannel}
|
|
688
|
+
* @memberof ConversationAllOf
|
|
689
|
+
*/
|
|
690
|
+
'channel': ConversationChannel;
|
|
671
691
|
/**
|
|
672
692
|
*
|
|
673
693
|
* @type {ConversationEnvironment}
|
|
674
694
|
* @memberof ConversationAllOf
|
|
695
|
+
* @deprecated
|
|
675
696
|
*/
|
|
676
|
-
'environment'
|
|
697
|
+
'environment'?: ConversationEnvironment;
|
|
677
698
|
/**
|
|
678
699
|
* Whether this conversation is a test or not
|
|
679
700
|
* @type {boolean}
|
|
@@ -699,32 +720,113 @@ export interface ConversationBase {
|
|
|
699
720
|
* @memberof ConversationBase
|
|
700
721
|
*/
|
|
701
722
|
'initialContexts'?: Array<string>;
|
|
723
|
+
/**
|
|
724
|
+
*
|
|
725
|
+
* @type {ConversationChannelProps}
|
|
726
|
+
* @memberof ConversationBase
|
|
727
|
+
*/
|
|
728
|
+
'channelProps'?: ConversationChannelProps;
|
|
702
729
|
/**
|
|
703
730
|
*
|
|
704
731
|
* @type {ConversationBaseEnvironmentProps}
|
|
705
732
|
* @memberof ConversationBase
|
|
733
|
+
* @deprecated
|
|
706
734
|
*/
|
|
707
735
|
'environmentProps'?: ConversationBaseEnvironmentProps;
|
|
708
736
|
}
|
|
709
737
|
/**
|
|
710
|
-
*
|
|
738
|
+
* Deprecated legacy environment properties. Use channelProps.
|
|
711
739
|
* @export
|
|
712
740
|
* @interface ConversationBaseEnvironmentProps
|
|
713
741
|
*/
|
|
714
742
|
export interface ConversationBaseEnvironmentProps {
|
|
715
743
|
/**
|
|
716
|
-
*
|
|
744
|
+
* Subject line for email-style channels such as Gmail and Outlook.
|
|
717
745
|
* @type {string}
|
|
718
746
|
* @memberof ConversationBaseEnvironmentProps
|
|
719
747
|
*/
|
|
720
748
|
'subject'?: string;
|
|
721
749
|
/**
|
|
722
|
-
*
|
|
750
|
+
* Provider thread id used to sync Gmail/Outlook channel messages with this conversation.
|
|
723
751
|
* @type {string}
|
|
724
752
|
* @memberof ConversationBaseEnvironmentProps
|
|
725
753
|
*/
|
|
726
754
|
'platformEmailThreadId'?: string;
|
|
755
|
+
/**
|
|
756
|
+
* Twilio message sid that initiated this conversation.
|
|
757
|
+
* @type {string}
|
|
758
|
+
* @memberof ConversationBaseEnvironmentProps
|
|
759
|
+
*/
|
|
760
|
+
'smsMessageSid'?: string;
|
|
761
|
+
/**
|
|
762
|
+
* Persisted channel-resolution path used for the current conversation.
|
|
763
|
+
* @type {string}
|
|
764
|
+
* @memberof ConversationBaseEnvironmentProps
|
|
765
|
+
*/
|
|
766
|
+
'channelResolutionPath'?: ConversationBaseEnvironmentPropsChannelResolutionPathEnum;
|
|
767
|
+
}
|
|
768
|
+
export declare const ConversationBaseEnvironmentPropsChannelResolutionPathEnum: {
|
|
769
|
+
readonly Production: "twilio_production";
|
|
770
|
+
readonly LegacyPmt: "twilio_legacy_pmt";
|
|
771
|
+
readonly FreeBridge: "twilio_free_bridge";
|
|
772
|
+
};
|
|
773
|
+
export type ConversationBaseEnvironmentPropsChannelResolutionPathEnum = typeof ConversationBaseEnvironmentPropsChannelResolutionPathEnum[keyof typeof ConversationBaseEnvironmentPropsChannelResolutionPathEnum];
|
|
774
|
+
/**
|
|
775
|
+
* Canonical channel that initiated and should continue the customer conversation.
|
|
776
|
+
* @export
|
|
777
|
+
* @enum {string}
|
|
778
|
+
*/
|
|
779
|
+
export declare const ConversationChannel: {
|
|
780
|
+
readonly Web: "web";
|
|
781
|
+
readonly DemoPhoneTest: "demo_phone_test";
|
|
782
|
+
readonly SmsPhone: "sms_phone";
|
|
783
|
+
readonly Outlook: "outlook";
|
|
784
|
+
readonly Gmail: "gmail";
|
|
785
|
+
readonly Iphone: "iphone";
|
|
786
|
+
readonly Android: "android";
|
|
787
|
+
readonly Teams: "teams";
|
|
788
|
+
readonly Discord: "discord";
|
|
789
|
+
readonly Whatsapp: "whatsapp";
|
|
790
|
+
};
|
|
791
|
+
export type ConversationChannel = typeof ConversationChannel[keyof typeof ConversationChannel];
|
|
792
|
+
/**
|
|
793
|
+
* Channel-specific properties needed to continue a conversation on its canonical channel.
|
|
794
|
+
* @export
|
|
795
|
+
* @interface ConversationChannelProps
|
|
796
|
+
*/
|
|
797
|
+
export interface ConversationChannelProps {
|
|
798
|
+
[key: string]: any;
|
|
799
|
+
/**
|
|
800
|
+
* Subject line for email-style channels such as Gmail and Outlook.
|
|
801
|
+
* @type {string}
|
|
802
|
+
* @memberof ConversationChannelProps
|
|
803
|
+
*/
|
|
804
|
+
'subject'?: string;
|
|
805
|
+
/**
|
|
806
|
+
* Provider thread id used to sync Gmail/Outlook channel messages with this conversation.
|
|
807
|
+
* @type {string}
|
|
808
|
+
* @memberof ConversationChannelProps
|
|
809
|
+
*/
|
|
810
|
+
'platformEmailThreadId'?: string;
|
|
811
|
+
/**
|
|
812
|
+
* Twilio message sid that initiated this conversation.
|
|
813
|
+
* @type {string}
|
|
814
|
+
* @memberof ConversationChannelProps
|
|
815
|
+
*/
|
|
816
|
+
'smsMessageSid'?: string;
|
|
817
|
+
/**
|
|
818
|
+
* Persisted channel-resolution path used for the current conversation.
|
|
819
|
+
* @type {string}
|
|
820
|
+
* @memberof ConversationChannelProps
|
|
821
|
+
*/
|
|
822
|
+
'channelResolutionPath'?: ConversationChannelPropsChannelResolutionPathEnum;
|
|
727
823
|
}
|
|
824
|
+
export declare const ConversationChannelPropsChannelResolutionPathEnum: {
|
|
825
|
+
readonly Production: "twilio_production";
|
|
826
|
+
readonly LegacyPmt: "twilio_legacy_pmt";
|
|
827
|
+
readonly FreeBridge: "twilio_free_bridge";
|
|
828
|
+
};
|
|
829
|
+
export type ConversationChannelPropsChannelResolutionPathEnum = typeof ConversationChannelPropsChannelResolutionPathEnum[keyof typeof ConversationChannelPropsChannelResolutionPathEnum];
|
|
728
830
|
/**
|
|
729
831
|
*
|
|
730
832
|
* @export
|
|
@@ -899,10 +1001,17 @@ export interface ConversationCreateRequest {
|
|
|
899
1001
|
* @memberof ConversationCreateRequest
|
|
900
1002
|
*/
|
|
901
1003
|
'initialContexts'?: Array<string>;
|
|
1004
|
+
/**
|
|
1005
|
+
*
|
|
1006
|
+
* @type {ConversationChannelProps}
|
|
1007
|
+
* @memberof ConversationCreateRequest
|
|
1008
|
+
*/
|
|
1009
|
+
'channelProps'?: ConversationChannelProps;
|
|
902
1010
|
/**
|
|
903
1011
|
*
|
|
904
1012
|
* @type {ConversationBaseEnvironmentProps}
|
|
905
1013
|
* @memberof ConversationCreateRequest
|
|
1014
|
+
* @deprecated
|
|
906
1015
|
*/
|
|
907
1016
|
'environmentProps'?: ConversationBaseEnvironmentProps;
|
|
908
1017
|
/**
|
|
@@ -918,12 +1027,19 @@ export interface ConversationCreateRequest {
|
|
|
918
1027
|
* @deprecated
|
|
919
1028
|
*/
|
|
920
1029
|
'$customer'?: string;
|
|
1030
|
+
/**
|
|
1031
|
+
*
|
|
1032
|
+
* @type {ConversationChannel}
|
|
1033
|
+
* @memberof ConversationCreateRequest
|
|
1034
|
+
*/
|
|
1035
|
+
'channel': ConversationChannel;
|
|
921
1036
|
/**
|
|
922
1037
|
*
|
|
923
1038
|
* @type {ConversationEnvironment}
|
|
924
1039
|
* @memberof ConversationCreateRequest
|
|
1040
|
+
* @deprecated
|
|
925
1041
|
*/
|
|
926
|
-
'environment'
|
|
1042
|
+
'environment'?: ConversationEnvironment;
|
|
927
1043
|
/**
|
|
928
1044
|
* Whether this conversation is a test or not
|
|
929
1045
|
* @type {boolean}
|
|
@@ -1013,7 +1129,7 @@ export interface ConversationCreateResponseAllOf {
|
|
|
1013
1129
|
'initiated': string;
|
|
1014
1130
|
}
|
|
1015
1131
|
/**
|
|
1016
|
-
*
|
|
1132
|
+
* Deprecated broad environment bucket (phone, web, or email). Use ConversationChannel for routing.
|
|
1017
1133
|
* @export
|
|
1018
1134
|
* @enum {string}
|
|
1019
1135
|
*/
|
|
@@ -1041,10 +1157,17 @@ export interface ConversationGetResponse {
|
|
|
1041
1157
|
* @memberof ConversationGetResponse
|
|
1042
1158
|
*/
|
|
1043
1159
|
'initialContexts'?: Array<string>;
|
|
1160
|
+
/**
|
|
1161
|
+
*
|
|
1162
|
+
* @type {ConversationChannelProps}
|
|
1163
|
+
* @memberof ConversationGetResponse
|
|
1164
|
+
*/
|
|
1165
|
+
'channelProps'?: ConversationChannelProps;
|
|
1044
1166
|
/**
|
|
1045
1167
|
*
|
|
1046
1168
|
* @type {ConversationBaseEnvironmentProps}
|
|
1047
1169
|
* @memberof ConversationGetResponse
|
|
1170
|
+
* @deprecated
|
|
1048
1171
|
*/
|
|
1049
1172
|
'environmentProps'?: ConversationBaseEnvironmentProps;
|
|
1050
1173
|
/**
|
|
@@ -1060,12 +1183,19 @@ export interface ConversationGetResponse {
|
|
|
1060
1183
|
* @deprecated
|
|
1061
1184
|
*/
|
|
1062
1185
|
'$customer'?: string;
|
|
1186
|
+
/**
|
|
1187
|
+
*
|
|
1188
|
+
* @type {ConversationChannel}
|
|
1189
|
+
* @memberof ConversationGetResponse
|
|
1190
|
+
*/
|
|
1191
|
+
'channel': ConversationChannel;
|
|
1063
1192
|
/**
|
|
1064
1193
|
*
|
|
1065
1194
|
* @type {ConversationEnvironment}
|
|
1066
1195
|
* @memberof ConversationGetResponse
|
|
1196
|
+
* @deprecated
|
|
1067
1197
|
*/
|
|
1068
|
-
'environment'
|
|
1198
|
+
'environment'?: ConversationEnvironment;
|
|
1069
1199
|
/**
|
|
1070
1200
|
* Whether this conversation is a test or not
|
|
1071
1201
|
* @type {boolean}
|
|
@@ -1190,10 +1320,17 @@ export interface ConversationUpdateRequest {
|
|
|
1190
1320
|
* @memberof ConversationUpdateRequest
|
|
1191
1321
|
*/
|
|
1192
1322
|
'initialContexts'?: Array<string>;
|
|
1323
|
+
/**
|
|
1324
|
+
*
|
|
1325
|
+
* @type {ConversationChannelProps}
|
|
1326
|
+
* @memberof ConversationUpdateRequest
|
|
1327
|
+
*/
|
|
1328
|
+
'channelProps'?: ConversationChannelProps;
|
|
1193
1329
|
/**
|
|
1194
1330
|
*
|
|
1195
1331
|
* @type {ConversationBaseEnvironmentProps}
|
|
1196
1332
|
* @memberof ConversationUpdateRequest
|
|
1333
|
+
* @deprecated
|
|
1197
1334
|
*/
|
|
1198
1335
|
'environmentProps'?: ConversationBaseEnvironmentProps;
|
|
1199
1336
|
/**
|
|
@@ -1284,10 +1421,17 @@ export interface ConversationWithId {
|
|
|
1284
1421
|
* @memberof ConversationWithId
|
|
1285
1422
|
*/
|
|
1286
1423
|
'initialContexts'?: Array<string>;
|
|
1424
|
+
/**
|
|
1425
|
+
*
|
|
1426
|
+
* @type {ConversationChannelProps}
|
|
1427
|
+
* @memberof ConversationWithId
|
|
1428
|
+
*/
|
|
1429
|
+
'channelProps'?: ConversationChannelProps;
|
|
1287
1430
|
/**
|
|
1288
1431
|
*
|
|
1289
1432
|
* @type {ConversationBaseEnvironmentProps}
|
|
1290
1433
|
* @memberof ConversationWithId
|
|
1434
|
+
* @deprecated
|
|
1291
1435
|
*/
|
|
1292
1436
|
'environmentProps'?: ConversationBaseEnvironmentProps;
|
|
1293
1437
|
/**
|
|
@@ -1303,12 +1447,19 @@ export interface ConversationWithId {
|
|
|
1303
1447
|
* @deprecated
|
|
1304
1448
|
*/
|
|
1305
1449
|
'$customer'?: string;
|
|
1450
|
+
/**
|
|
1451
|
+
*
|
|
1452
|
+
* @type {ConversationChannel}
|
|
1453
|
+
* @memberof ConversationWithId
|
|
1454
|
+
*/
|
|
1455
|
+
'channel': ConversationChannel;
|
|
1306
1456
|
/**
|
|
1307
1457
|
*
|
|
1308
1458
|
* @type {ConversationEnvironment}
|
|
1309
1459
|
* @memberof ConversationWithId
|
|
1460
|
+
* @deprecated
|
|
1310
1461
|
*/
|
|
1311
|
-
'environment'
|
|
1462
|
+
'environment'?: ConversationEnvironment;
|
|
1312
1463
|
/**
|
|
1313
1464
|
* Whether this conversation is a test or not
|
|
1314
1465
|
* @type {boolean}
|
|
@@ -1896,12 +2047,19 @@ export interface CustomerGroupRecord {
|
|
|
1896
2047
|
* @memberof CustomerGroupRecord
|
|
1897
2048
|
*/
|
|
1898
2049
|
'id': string;
|
|
2050
|
+
/**
|
|
2051
|
+
*
|
|
2052
|
+
* @type {ConversationChannel}
|
|
2053
|
+
* @memberof CustomerGroupRecord
|
|
2054
|
+
*/
|
|
2055
|
+
'channel': ConversationChannel;
|
|
1899
2056
|
/**
|
|
1900
2057
|
*
|
|
1901
2058
|
* @type {ConversationEnvironment}
|
|
1902
2059
|
* @memberof CustomerGroupRecord
|
|
2060
|
+
* @deprecated
|
|
1903
2061
|
*/
|
|
1904
|
-
'environment'
|
|
2062
|
+
'environment'?: ConversationEnvironment;
|
|
1905
2063
|
/**
|
|
1906
2064
|
* Overrides the default $agent for this customer
|
|
1907
2065
|
* @type {string}
|
|
@@ -3291,10 +3449,17 @@ export interface ListConversationsResponseInner {
|
|
|
3291
3449
|
* @memberof ListConversationsResponseInner
|
|
3292
3450
|
*/
|
|
3293
3451
|
'initialContexts'?: Array<string>;
|
|
3452
|
+
/**
|
|
3453
|
+
*
|
|
3454
|
+
* @type {ConversationChannelProps}
|
|
3455
|
+
* @memberof ListConversationsResponseInner
|
|
3456
|
+
*/
|
|
3457
|
+
'channelProps'?: ConversationChannelProps;
|
|
3294
3458
|
/**
|
|
3295
3459
|
*
|
|
3296
3460
|
* @type {ConversationBaseEnvironmentProps}
|
|
3297
3461
|
* @memberof ListConversationsResponseInner
|
|
3462
|
+
* @deprecated
|
|
3298
3463
|
*/
|
|
3299
3464
|
'environmentProps'?: ConversationBaseEnvironmentProps;
|
|
3300
3465
|
/**
|
|
@@ -3310,12 +3475,19 @@ export interface ListConversationsResponseInner {
|
|
|
3310
3475
|
* @deprecated
|
|
3311
3476
|
*/
|
|
3312
3477
|
'$customer'?: string;
|
|
3478
|
+
/**
|
|
3479
|
+
*
|
|
3480
|
+
* @type {ConversationChannel}
|
|
3481
|
+
* @memberof ListConversationsResponseInner
|
|
3482
|
+
*/
|
|
3483
|
+
'channel': ConversationChannel;
|
|
3313
3484
|
/**
|
|
3314
3485
|
*
|
|
3315
3486
|
* @type {ConversationEnvironment}
|
|
3316
3487
|
* @memberof ListConversationsResponseInner
|
|
3488
|
+
* @deprecated
|
|
3317
3489
|
*/
|
|
3318
|
-
'environment'
|
|
3490
|
+
'environment'?: ConversationEnvironment;
|
|
3319
3491
|
/**
|
|
3320
3492
|
* Whether this conversation is a test or not
|
|
3321
3493
|
* @type {boolean}
|
|
@@ -5279,10 +5451,17 @@ export interface MessageCreateRequestConvoOneOf {
|
|
|
5279
5451
|
* @memberof MessageCreateRequestConvoOneOf
|
|
5280
5452
|
*/
|
|
5281
5453
|
'agentIdOrPhoneOrEmail'?: string;
|
|
5454
|
+
/**
|
|
5455
|
+
*
|
|
5456
|
+
* @type {ConversationChannel}
|
|
5457
|
+
* @memberof MessageCreateRequestConvoOneOf
|
|
5458
|
+
*/
|
|
5459
|
+
'channel'?: ConversationChannel;
|
|
5282
5460
|
/**
|
|
5283
5461
|
*
|
|
5284
5462
|
* @type {ConversationEnvironment}
|
|
5285
5463
|
* @memberof MessageCreateRequestConvoOneOf
|
|
5464
|
+
* @deprecated
|
|
5286
5465
|
*/
|
|
5287
5466
|
'environment'?: ConversationEnvironment;
|
|
5288
5467
|
}
|
|
@@ -5826,7 +6005,13 @@ export interface PmtTransformResponse {
|
|
|
5826
6005
|
* @type {string}
|
|
5827
6006
|
* @memberof PmtTransformResponse
|
|
5828
6007
|
*/
|
|
5829
|
-
'message'
|
|
6008
|
+
'message'?: string;
|
|
6009
|
+
/**
|
|
6010
|
+
* Formatted persona responses
|
|
6011
|
+
* @type {Array<Message>}
|
|
6012
|
+
* @memberof PmtTransformResponse
|
|
6013
|
+
*/
|
|
6014
|
+
'messages'?: Array<Message>;
|
|
5830
6015
|
/**
|
|
5831
6016
|
* How confident this message meets the persona\'s own words
|
|
5832
6017
|
* @type {number}
|
|
@@ -5976,10 +6161,17 @@ export interface ScheduleCreateRequest {
|
|
|
5976
6161
|
* @memberof ScheduleCreateRequest
|
|
5977
6162
|
*/
|
|
5978
6163
|
'initialContexts'?: Array<string>;
|
|
6164
|
+
/**
|
|
6165
|
+
*
|
|
6166
|
+
* @type {ConversationChannelProps}
|
|
6167
|
+
* @memberof ScheduleCreateRequest
|
|
6168
|
+
*/
|
|
6169
|
+
'channelProps'?: ConversationChannelProps;
|
|
5979
6170
|
/**
|
|
5980
6171
|
*
|
|
5981
6172
|
* @type {ConversationBaseEnvironmentProps}
|
|
5982
6173
|
* @memberof ScheduleCreateRequest
|
|
6174
|
+
* @deprecated
|
|
5983
6175
|
*/
|
|
5984
6176
|
'environmentProps'?: ConversationBaseEnvironmentProps;
|
|
5985
6177
|
/**
|
|
@@ -5995,12 +6187,19 @@ export interface ScheduleCreateRequest {
|
|
|
5995
6187
|
* @deprecated
|
|
5996
6188
|
*/
|
|
5997
6189
|
'$customer'?: string;
|
|
6190
|
+
/**
|
|
6191
|
+
*
|
|
6192
|
+
* @type {ConversationChannel}
|
|
6193
|
+
* @memberof ScheduleCreateRequest
|
|
6194
|
+
*/
|
|
6195
|
+
'channel': ConversationChannel;
|
|
5998
6196
|
/**
|
|
5999
6197
|
*
|
|
6000
6198
|
* @type {ConversationEnvironment}
|
|
6001
6199
|
* @memberof ScheduleCreateRequest
|
|
6200
|
+
* @deprecated
|
|
6002
6201
|
*/
|
|
6003
|
-
'environment'
|
|
6202
|
+
'environment'?: ConversationEnvironment;
|
|
6004
6203
|
/**
|
|
6005
6204
|
* Whether this conversation is a test or not
|
|
6006
6205
|
* @type {boolean}
|
|
@@ -6094,10 +6293,17 @@ export interface ScheduleGetResponse {
|
|
|
6094
6293
|
* @memberof ScheduleGetResponse
|
|
6095
6294
|
*/
|
|
6096
6295
|
'initialContexts'?: Array<string>;
|
|
6296
|
+
/**
|
|
6297
|
+
*
|
|
6298
|
+
* @type {ConversationChannelProps}
|
|
6299
|
+
* @memberof ScheduleGetResponse
|
|
6300
|
+
*/
|
|
6301
|
+
'channelProps'?: ConversationChannelProps;
|
|
6097
6302
|
/**
|
|
6098
6303
|
*
|
|
6099
6304
|
* @type {ConversationBaseEnvironmentProps}
|
|
6100
6305
|
* @memberof ScheduleGetResponse
|
|
6306
|
+
* @deprecated
|
|
6101
6307
|
*/
|
|
6102
6308
|
'environmentProps'?: ConversationBaseEnvironmentProps;
|
|
6103
6309
|
/**
|
|
@@ -6113,12 +6319,19 @@ export interface ScheduleGetResponse {
|
|
|
6113
6319
|
* @deprecated
|
|
6114
6320
|
*/
|
|
6115
6321
|
'$customer'?: string;
|
|
6322
|
+
/**
|
|
6323
|
+
*
|
|
6324
|
+
* @type {ConversationChannel}
|
|
6325
|
+
* @memberof ScheduleGetResponse
|
|
6326
|
+
*/
|
|
6327
|
+
'channel': ConversationChannel;
|
|
6116
6328
|
/**
|
|
6117
6329
|
*
|
|
6118
6330
|
* @type {ConversationEnvironment}
|
|
6119
6331
|
* @memberof ScheduleGetResponse
|
|
6332
|
+
* @deprecated
|
|
6120
6333
|
*/
|
|
6121
|
-
'environment'
|
|
6334
|
+
'environment'?: ConversationEnvironment;
|
|
6122
6335
|
/**
|
|
6123
6336
|
* Whether this conversation is a test or not
|
|
6124
6337
|
* @type {boolean}
|
|
@@ -6186,10 +6399,17 @@ export interface ScheduleGroupCreateRequest {
|
|
|
6186
6399
|
* @memberof ScheduleGroupCreateRequest
|
|
6187
6400
|
*/
|
|
6188
6401
|
'initialContexts'?: Array<string>;
|
|
6402
|
+
/**
|
|
6403
|
+
*
|
|
6404
|
+
* @type {ConversationChannelProps}
|
|
6405
|
+
* @memberof ScheduleGroupCreateRequest
|
|
6406
|
+
*/
|
|
6407
|
+
'channelProps'?: ConversationChannelProps;
|
|
6189
6408
|
/**
|
|
6190
6409
|
*
|
|
6191
6410
|
* @type {ConversationBaseEnvironmentProps}
|
|
6192
6411
|
* @memberof ScheduleGroupCreateRequest
|
|
6412
|
+
* @deprecated
|
|
6193
6413
|
*/
|
|
6194
6414
|
'environmentProps'?: ConversationBaseEnvironmentProps;
|
|
6195
6415
|
/**
|
|
@@ -6284,10 +6504,17 @@ export interface ScheduleGroupGetResponse {
|
|
|
6284
6504
|
* @memberof ScheduleGroupGetResponse
|
|
6285
6505
|
*/
|
|
6286
6506
|
'initialContexts'?: Array<string>;
|
|
6507
|
+
/**
|
|
6508
|
+
*
|
|
6509
|
+
* @type {ConversationChannelProps}
|
|
6510
|
+
* @memberof ScheduleGroupGetResponse
|
|
6511
|
+
*/
|
|
6512
|
+
'channelProps'?: ConversationChannelProps;
|
|
6287
6513
|
/**
|
|
6288
6514
|
*
|
|
6289
6515
|
* @type {ConversationBaseEnvironmentProps}
|
|
6290
6516
|
* @memberof ScheduleGroupGetResponse
|
|
6517
|
+
* @deprecated
|
|
6291
6518
|
*/
|
|
6292
6519
|
'environmentProps'?: ConversationBaseEnvironmentProps;
|
|
6293
6520
|
/**
|
|
@@ -6401,10 +6628,17 @@ export interface ScheduleGroupUpdateRequest {
|
|
|
6401
6628
|
* @memberof ScheduleGroupUpdateRequest
|
|
6402
6629
|
*/
|
|
6403
6630
|
'initialContexts'?: Array<string>;
|
|
6631
|
+
/**
|
|
6632
|
+
*
|
|
6633
|
+
* @type {ConversationChannelProps}
|
|
6634
|
+
* @memberof ScheduleGroupUpdateRequest
|
|
6635
|
+
*/
|
|
6636
|
+
'channelProps'?: ConversationChannelProps;
|
|
6404
6637
|
/**
|
|
6405
6638
|
*
|
|
6406
6639
|
* @type {ConversationBaseEnvironmentProps}
|
|
6407
6640
|
* @memberof ScheduleGroupUpdateRequest
|
|
6641
|
+
* @deprecated
|
|
6408
6642
|
*/
|
|
6409
6643
|
'environmentProps'?: ConversationBaseEnvironmentProps;
|
|
6410
6644
|
/**
|
|
@@ -6531,10 +6765,17 @@ export interface ScheduleUpdateRequest {
|
|
|
6531
6765
|
* @memberof ScheduleUpdateRequest
|
|
6532
6766
|
*/
|
|
6533
6767
|
'initialContexts'?: Array<string>;
|
|
6768
|
+
/**
|
|
6769
|
+
*
|
|
6770
|
+
* @type {ConversationChannelProps}
|
|
6771
|
+
* @memberof ScheduleUpdateRequest
|
|
6772
|
+
*/
|
|
6773
|
+
'channelProps'?: ConversationChannelProps;
|
|
6534
6774
|
/**
|
|
6535
6775
|
*
|
|
6536
6776
|
* @type {ConversationBaseEnvironmentProps}
|
|
6537
6777
|
* @memberof ScheduleUpdateRequest
|
|
6778
|
+
* @deprecated
|
|
6538
6779
|
*/
|
|
6539
6780
|
'environmentProps'?: ConversationBaseEnvironmentProps;
|
|
6540
6781
|
/**
|
|
@@ -6550,12 +6791,19 @@ export interface ScheduleUpdateRequest {
|
|
|
6550
6791
|
* @deprecated
|
|
6551
6792
|
*/
|
|
6552
6793
|
'$customer'?: string;
|
|
6794
|
+
/**
|
|
6795
|
+
*
|
|
6796
|
+
* @type {ConversationChannel}
|
|
6797
|
+
* @memberof ScheduleUpdateRequest
|
|
6798
|
+
*/
|
|
6799
|
+
'channel': ConversationChannel;
|
|
6553
6800
|
/**
|
|
6554
6801
|
*
|
|
6555
6802
|
* @type {ConversationEnvironment}
|
|
6556
6803
|
* @memberof ScheduleUpdateRequest
|
|
6804
|
+
* @deprecated
|
|
6557
6805
|
*/
|
|
6558
|
-
'environment'
|
|
6806
|
+
'environment'?: ConversationEnvironment;
|
|
6559
6807
|
/**
|
|
6560
6808
|
* Whether this conversation is a test or not
|
|
6561
6809
|
* @type {boolean}
|
|
@@ -6649,10 +6897,17 @@ export interface ScheduledConversation {
|
|
|
6649
6897
|
* @memberof ScheduledConversation
|
|
6650
6898
|
*/
|
|
6651
6899
|
'initialContexts'?: Array<string>;
|
|
6900
|
+
/**
|
|
6901
|
+
*
|
|
6902
|
+
* @type {ConversationChannelProps}
|
|
6903
|
+
* @memberof ScheduledConversation
|
|
6904
|
+
*/
|
|
6905
|
+
'channelProps'?: ConversationChannelProps;
|
|
6652
6906
|
/**
|
|
6653
6907
|
*
|
|
6654
6908
|
* @type {ConversationBaseEnvironmentProps}
|
|
6655
6909
|
* @memberof ScheduledConversation
|
|
6910
|
+
* @deprecated
|
|
6656
6911
|
*/
|
|
6657
6912
|
'environmentProps'?: ConversationBaseEnvironmentProps;
|
|
6658
6913
|
/**
|
|
@@ -6668,12 +6923,19 @@ export interface ScheduledConversation {
|
|
|
6668
6923
|
* @deprecated
|
|
6669
6924
|
*/
|
|
6670
6925
|
'$customer'?: string;
|
|
6926
|
+
/**
|
|
6927
|
+
*
|
|
6928
|
+
* @type {ConversationChannel}
|
|
6929
|
+
* @memberof ScheduledConversation
|
|
6930
|
+
*/
|
|
6931
|
+
'channel': ConversationChannel;
|
|
6671
6932
|
/**
|
|
6672
6933
|
*
|
|
6673
6934
|
* @type {ConversationEnvironment}
|
|
6674
6935
|
* @memberof ScheduledConversation
|
|
6936
|
+
* @deprecated
|
|
6675
6937
|
*/
|
|
6676
|
-
'environment'
|
|
6938
|
+
'environment'?: ConversationEnvironment;
|
|
6677
6939
|
/**
|
|
6678
6940
|
* Whether this conversation is a test or not
|
|
6679
6941
|
* @type {boolean}
|
|
@@ -6736,10 +6998,17 @@ export interface ScheduledConversationGroup {
|
|
|
6736
6998
|
* @memberof ScheduledConversationGroup
|
|
6737
6999
|
*/
|
|
6738
7000
|
'initialContexts'?: Array<string>;
|
|
7001
|
+
/**
|
|
7002
|
+
*
|
|
7003
|
+
* @type {ConversationChannelProps}
|
|
7004
|
+
* @memberof ScheduledConversationGroup
|
|
7005
|
+
*/
|
|
7006
|
+
'channelProps'?: ConversationChannelProps;
|
|
6739
7007
|
/**
|
|
6740
7008
|
*
|
|
6741
7009
|
* @type {ConversationBaseEnvironmentProps}
|
|
6742
7010
|
* @memberof ScheduledConversationGroup
|
|
7011
|
+
* @deprecated
|
|
6743
7012
|
*/
|
|
6744
7013
|
'environmentProps'?: ConversationBaseEnvironmentProps;
|
|
6745
7014
|
/**
|
package/build/api.js
CHANGED
|
@@ -16,8 +16,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
16
16
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
17
17
|
};
|
|
18
18
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
-
exports.
|
|
20
|
-
exports.Scout9Api = exports.Scout9ApiGenerated = exports.Scout9ApiFactory = exports.Scout9ApiFp = exports.Scout9ApiAxiosParamCreator = exports.NoopApi = exports.NoopApiFactory = exports.NoopApiFp = exports.NoopApiAxiosParamCreator = exports.WorkflowResponseSlotForwardOneOfModeEnum = exports.PurposeEnum = exports.PmtTransformResponseTypeEnum = void 0;
|
|
19
|
+
exports.MessageCreateRequestRoleEnum = exports.MessageBaseRoleEnum = exports.MessageRoleEnum = exports.MacroResultTypeEnum = exports.MacroDoesResultTypeEnum = exports.MacroDoesInputRoleEnum = exports.MacroDidResultTypeEnum = exports.MacroContextResultTypeEnum = exports.LlmConfigOneOfAllOfModelEnum = exports.LlmConfigOneOfAllOfEngineEnum = exports.LlmConfigOneOf7AllOfEngineEnum = exports.LlmConfigOneOf7EngineEnum = exports.LlmConfigOneOf6AllOfModelEnum = exports.LlmConfigOneOf6AllOfEngineEnum = exports.LlmConfigOneOf6ModelEnum = exports.LlmConfigOneOf6EngineEnum = exports.LlmConfigOneOf5AllOfModelEnum = exports.LlmConfigOneOf5AllOfEngineEnum = exports.LlmConfigOneOf5ModelEnum = exports.LlmConfigOneOf5EngineEnum = exports.LlmConfigOneOf4AllOfModelEnum = exports.LlmConfigOneOf4AllOfEngineEnum = exports.LlmConfigOneOf4ModelEnum = exports.LlmConfigOneOf4EngineEnum = exports.LlmConfigOneOf3AllOfModelEnum = exports.LlmConfigOneOf3AllOfEngineEnum = exports.LlmConfigOneOf3ModelEnum = exports.LlmConfigOneOf3EngineEnum = exports.LlmConfigOneOf2AllOfModelEnum = exports.LlmConfigOneOf2AllOfEngineEnum = exports.LlmConfigOneOf2ModelEnum = exports.LlmConfigOneOf2EngineEnum = exports.LlmConfigOneOf1AllOfModelEnum = exports.LlmConfigOneOf1AllOfEngineEnum = exports.LlmConfigOneOf1ModelEnum = exports.LlmConfigOneOf1EngineEnum = exports.LlmConfigOneOfModelEnum = exports.LlmConfigOneOfEngineEnum = exports.ListApiOperationsResponseInnerMethodEnum = exports.GetApiOperationResponseMethodEnum = exports.ForwardRequestLatestMessageRoleEnum = exports.ForwardRequestForwardOneOfModeEnum = exports.ExistenceOperator = exports.EqualityOperator = exports.ConversationEnvironment = exports.ConversationContextFieldConditionOperatorEnum = exports.ConversationChannelPropsChannelResolutionPathEnum = exports.ConversationChannel = exports.ConversationBaseEnvironmentPropsChannelResolutionPathEnum = exports.ApiOperationMethodEnum = void 0;
|
|
20
|
+
exports.Scout9Api = exports.Scout9ApiGenerated = exports.Scout9ApiFactory = exports.Scout9ApiFp = exports.Scout9ApiAxiosParamCreator = exports.NoopApi = exports.NoopApiFactory = exports.NoopApiFp = exports.NoopApiAxiosParamCreator = exports.WorkflowResponseSlotForwardOneOfModeEnum = exports.PurposeEnum = exports.PmtTransformResponseTypeEnum = exports.PmtConfigModelEnum = exports.PmtConfigEngineEnum = exports.MessageGetResponseInnerRoleEnum = void 0;
|
|
21
21
|
const axios_1 = __importDefault(require("axios"));
|
|
22
22
|
// Some imports not used depending on template conditions
|
|
23
23
|
// @ts-ignore
|
|
@@ -31,6 +31,33 @@ exports.ApiOperationMethodEnum = {
|
|
|
31
31
|
Delete: 'delete',
|
|
32
32
|
Patch: 'patch'
|
|
33
33
|
};
|
|
34
|
+
exports.ConversationBaseEnvironmentPropsChannelResolutionPathEnum = {
|
|
35
|
+
Production: 'twilio_production',
|
|
36
|
+
LegacyPmt: 'twilio_legacy_pmt',
|
|
37
|
+
FreeBridge: 'twilio_free_bridge'
|
|
38
|
+
};
|
|
39
|
+
/**
|
|
40
|
+
* Canonical channel that initiated and should continue the customer conversation.
|
|
41
|
+
* @export
|
|
42
|
+
* @enum {string}
|
|
43
|
+
*/
|
|
44
|
+
exports.ConversationChannel = {
|
|
45
|
+
Web: 'web',
|
|
46
|
+
DemoPhoneTest: 'demo_phone_test',
|
|
47
|
+
SmsPhone: 'sms_phone',
|
|
48
|
+
Outlook: 'outlook',
|
|
49
|
+
Gmail: 'gmail',
|
|
50
|
+
Iphone: 'iphone',
|
|
51
|
+
Android: 'android',
|
|
52
|
+
Teams: 'teams',
|
|
53
|
+
Discord: 'discord',
|
|
54
|
+
Whatsapp: 'whatsapp'
|
|
55
|
+
};
|
|
56
|
+
exports.ConversationChannelPropsChannelResolutionPathEnum = {
|
|
57
|
+
Production: 'twilio_production',
|
|
58
|
+
LegacyPmt: 'twilio_legacy_pmt',
|
|
59
|
+
FreeBridge: 'twilio_free_bridge'
|
|
60
|
+
};
|
|
34
61
|
exports.ConversationContextFieldConditionOperatorEnum = {
|
|
35
62
|
Eq: 'eq',
|
|
36
63
|
Equal: 'equal',
|
|
@@ -56,7 +83,7 @@ exports.ConversationContextFieldConditionOperatorEnum = {
|
|
|
56
83
|
EndsWith: 'endsWith'
|
|
57
84
|
};
|
|
58
85
|
/**
|
|
59
|
-
*
|
|
86
|
+
* Deprecated broad environment bucket (phone, web, or email). Use ConversationChannel for routing.
|
|
60
87
|
* @export
|
|
61
88
|
* @enum {string}
|
|
62
89
|
*/
|