purecloud-platform-client-v2 173.1.0 → 175.0.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/README.md +2 -2
- package/dist/node/purecloud-platform-client-v2.js +1580 -131
- package/dist/web-amd/purecloud-platform-client-v2.js +1580 -131
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +1580 -131
- package/dist/web-cjs/purecloud-platform-client-v2.js +1580 -131
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1223 -20
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +5 -4
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +612 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +223 -5
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +62 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +188 -3
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +10 -8
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +10 -5
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +362 -5
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class ArchitectApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Architect service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 175.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -45,6 +45,125 @@ class ArchitectApi {
|
|
|
45
45
|
);
|
|
46
46
|
}
|
|
47
47
|
|
|
48
|
+
/**
|
|
49
|
+
* Delete a grammar.
|
|
50
|
+
*
|
|
51
|
+
* @param {String} grammarId grammar ID
|
|
52
|
+
* deleteArchitectGrammar is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
53
|
+
*/
|
|
54
|
+
deleteArchitectGrammar(grammarId) {
|
|
55
|
+
// verify the required parameter 'grammarId' is set
|
|
56
|
+
if (grammarId === undefined || grammarId === null) {
|
|
57
|
+
throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammar';
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
return this.apiClient.callApi(
|
|
61
|
+
'/api/v2/architect/grammars/{grammarId}',
|
|
62
|
+
'DELETE',
|
|
63
|
+
{ 'grammarId': grammarId },
|
|
64
|
+
{ },
|
|
65
|
+
{ },
|
|
66
|
+
{ },
|
|
67
|
+
null,
|
|
68
|
+
['PureCloud OAuth'],
|
|
69
|
+
['application/json'],
|
|
70
|
+
['application/json']
|
|
71
|
+
);
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
/**
|
|
75
|
+
* Delete specified grammar language
|
|
76
|
+
*
|
|
77
|
+
* @param {String} grammarId Grammar ID
|
|
78
|
+
* @param {String} languageCode Language
|
|
79
|
+
* deleteArchitectGrammarLanguage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
80
|
+
*/
|
|
81
|
+
deleteArchitectGrammarLanguage(grammarId, languageCode) {
|
|
82
|
+
// verify the required parameter 'grammarId' is set
|
|
83
|
+
if (grammarId === undefined || grammarId === null) {
|
|
84
|
+
throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguage';
|
|
85
|
+
}
|
|
86
|
+
// verify the required parameter 'languageCode' is set
|
|
87
|
+
if (languageCode === undefined || languageCode === null) {
|
|
88
|
+
throw 'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguage';
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
return this.apiClient.callApi(
|
|
92
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}',
|
|
93
|
+
'DELETE',
|
|
94
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
95
|
+
{ },
|
|
96
|
+
{ },
|
|
97
|
+
{ },
|
|
98
|
+
null,
|
|
99
|
+
['PureCloud OAuth'],
|
|
100
|
+
['application/json'],
|
|
101
|
+
['application/json']
|
|
102
|
+
);
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
/**
|
|
106
|
+
* Clear the DTMF mode file for the grammar language if there is one
|
|
107
|
+
*
|
|
108
|
+
* @param {String} grammarId Grammar ID
|
|
109
|
+
* @param {String} languageCode Language
|
|
110
|
+
* deleteArchitectGrammarLanguageFilesDtmf is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
111
|
+
*/
|
|
112
|
+
deleteArchitectGrammarLanguageFilesDtmf(grammarId, languageCode) {
|
|
113
|
+
// verify the required parameter 'grammarId' is set
|
|
114
|
+
if (grammarId === undefined || grammarId === null) {
|
|
115
|
+
throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguageFilesDtmf';
|
|
116
|
+
}
|
|
117
|
+
// verify the required parameter 'languageCode' is set
|
|
118
|
+
if (languageCode === undefined || languageCode === null) {
|
|
119
|
+
throw 'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguageFilesDtmf';
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
return this.apiClient.callApi(
|
|
123
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf',
|
|
124
|
+
'DELETE',
|
|
125
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
126
|
+
{ },
|
|
127
|
+
{ },
|
|
128
|
+
{ },
|
|
129
|
+
null,
|
|
130
|
+
['PureCloud OAuth'],
|
|
131
|
+
['application/json'],
|
|
132
|
+
['application/json']
|
|
133
|
+
);
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
/**
|
|
137
|
+
* Clear the voice mode file for the grammar language if there is one
|
|
138
|
+
*
|
|
139
|
+
* @param {String} grammarId Grammar ID
|
|
140
|
+
* @param {String} languageCode Language
|
|
141
|
+
* deleteArchitectGrammarLanguageFilesVoice is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
142
|
+
*/
|
|
143
|
+
deleteArchitectGrammarLanguageFilesVoice(grammarId, languageCode) {
|
|
144
|
+
// verify the required parameter 'grammarId' is set
|
|
145
|
+
if (grammarId === undefined || grammarId === null) {
|
|
146
|
+
throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguageFilesVoice';
|
|
147
|
+
}
|
|
148
|
+
// verify the required parameter 'languageCode' is set
|
|
149
|
+
if (languageCode === undefined || languageCode === null) {
|
|
150
|
+
throw 'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguageFilesVoice';
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
return this.apiClient.callApi(
|
|
154
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice',
|
|
155
|
+
'DELETE',
|
|
156
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
157
|
+
{ },
|
|
158
|
+
{ },
|
|
159
|
+
{ },
|
|
160
|
+
null,
|
|
161
|
+
['PureCloud OAuth'],
|
|
162
|
+
['application/json'],
|
|
163
|
+
['application/json']
|
|
164
|
+
);
|
|
165
|
+
}
|
|
166
|
+
|
|
48
167
|
/**
|
|
49
168
|
* Delete an IVR Config.
|
|
50
169
|
*
|
|
@@ -729,6 +848,130 @@ class ArchitectApi {
|
|
|
729
848
|
);
|
|
730
849
|
}
|
|
731
850
|
|
|
851
|
+
/**
|
|
852
|
+
* Get a pageable list of basic emergency group objects filterable by query parameters.
|
|
853
|
+
* This returns emergency groups consisting of name and division. If one or more IDs are specified, the search will fetch flow outcomes that match the given ID(s) and not use any additional supplied query parameters in the search.
|
|
854
|
+
* @param {Object} opts Optional parameters
|
|
855
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
856
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
857
|
+
* @param {String} opts.sortBy Sort by (default to name)
|
|
858
|
+
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
859
|
+
* @param {Array.<String>} opts.id ID of the Emergency Groups to filter by.
|
|
860
|
+
* @param {String} opts.name Name of the Emergency Group to filter by.
|
|
861
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
862
|
+
*/
|
|
863
|
+
getArchitectEmergencygroupsDivisionviews(opts) {
|
|
864
|
+
opts = opts || {};
|
|
865
|
+
|
|
866
|
+
|
|
867
|
+
return this.apiClient.callApi(
|
|
868
|
+
'/api/v2/architect/emergencygroups/divisionviews',
|
|
869
|
+
'GET',
|
|
870
|
+
{ },
|
|
871
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
872
|
+
{ },
|
|
873
|
+
{ },
|
|
874
|
+
null,
|
|
875
|
+
['PureCloud OAuth'],
|
|
876
|
+
['application/json'],
|
|
877
|
+
['application/json']
|
|
878
|
+
);
|
|
879
|
+
}
|
|
880
|
+
|
|
881
|
+
/**
|
|
882
|
+
* Get a grammar
|
|
883
|
+
* Returns a specified grammar
|
|
884
|
+
* @param {String} grammarId grammar ID
|
|
885
|
+
* @param {Object} opts Optional parameters
|
|
886
|
+
* @param {Boolean} opts.includeFileUrls Include grammar language file URLs
|
|
887
|
+
* getArchitectGrammar is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
888
|
+
*/
|
|
889
|
+
getArchitectGrammar(grammarId, opts) {
|
|
890
|
+
opts = opts || {};
|
|
891
|
+
|
|
892
|
+
// verify the required parameter 'grammarId' is set
|
|
893
|
+
if (grammarId === undefined || grammarId === null) {
|
|
894
|
+
throw 'Missing the required parameter "grammarId" when calling getArchitectGrammar';
|
|
895
|
+
}
|
|
896
|
+
|
|
897
|
+
return this.apiClient.callApi(
|
|
898
|
+
'/api/v2/architect/grammars/{grammarId}',
|
|
899
|
+
'GET',
|
|
900
|
+
{ 'grammarId': grammarId },
|
|
901
|
+
{ 'includeFileUrls': opts['includeFileUrls'] },
|
|
902
|
+
{ },
|
|
903
|
+
{ },
|
|
904
|
+
null,
|
|
905
|
+
['PureCloud OAuth'],
|
|
906
|
+
['application/json'],
|
|
907
|
+
['application/json']
|
|
908
|
+
);
|
|
909
|
+
}
|
|
910
|
+
|
|
911
|
+
/**
|
|
912
|
+
* Get a grammar language.
|
|
913
|
+
*
|
|
914
|
+
* @param {String} grammarId Grammar ID
|
|
915
|
+
* @param {String} languageCode Language
|
|
916
|
+
* getArchitectGrammarLanguage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
917
|
+
*/
|
|
918
|
+
getArchitectGrammarLanguage(grammarId, languageCode) {
|
|
919
|
+
// verify the required parameter 'grammarId' is set
|
|
920
|
+
if (grammarId === undefined || grammarId === null) {
|
|
921
|
+
throw 'Missing the required parameter "grammarId" when calling getArchitectGrammarLanguage';
|
|
922
|
+
}
|
|
923
|
+
// verify the required parameter 'languageCode' is set
|
|
924
|
+
if (languageCode === undefined || languageCode === null) {
|
|
925
|
+
throw 'Missing the required parameter "languageCode" when calling getArchitectGrammarLanguage';
|
|
926
|
+
}
|
|
927
|
+
|
|
928
|
+
return this.apiClient.callApi(
|
|
929
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}',
|
|
930
|
+
'GET',
|
|
931
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
932
|
+
{ },
|
|
933
|
+
{ },
|
|
934
|
+
{ },
|
|
935
|
+
null,
|
|
936
|
+
['PureCloud OAuth'],
|
|
937
|
+
['application/json'],
|
|
938
|
+
['application/json']
|
|
939
|
+
);
|
|
940
|
+
}
|
|
941
|
+
|
|
942
|
+
/**
|
|
943
|
+
* Get a pageable list of grammars, filtered by query parameters
|
|
944
|
+
* Multiple IDs can be specified, in which case all matching grammars will be returned, and no other parameters will be evaluated.
|
|
945
|
+
* @param {Object} opts Optional parameters
|
|
946
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
947
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
948
|
+
* @param {Object} opts.sortBy Sort by (default to id)
|
|
949
|
+
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
950
|
+
* @param {Array.<String>} opts.id ID
|
|
951
|
+
* @param {String} opts.name Name
|
|
952
|
+
* @param {String} opts.description Description
|
|
953
|
+
* @param {String} opts.nameOrDescription Name or description
|
|
954
|
+
* @param {Boolean} opts.includeFileUrls Include grammar language file URLs
|
|
955
|
+
* getArchitectGrammars is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
956
|
+
*/
|
|
957
|
+
getArchitectGrammars(opts) {
|
|
958
|
+
opts = opts || {};
|
|
959
|
+
|
|
960
|
+
|
|
961
|
+
return this.apiClient.callApi(
|
|
962
|
+
'/api/v2/architect/grammars',
|
|
963
|
+
'GET',
|
|
964
|
+
{ },
|
|
965
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'],'description': opts['description'],'nameOrDescription': opts['nameOrDescription'],'includeFileUrls': opts['includeFileUrls'] },
|
|
966
|
+
{ },
|
|
967
|
+
{ },
|
|
968
|
+
null,
|
|
969
|
+
['PureCloud OAuth'],
|
|
970
|
+
['application/json'],
|
|
971
|
+
['application/json']
|
|
972
|
+
);
|
|
973
|
+
}
|
|
974
|
+
|
|
732
975
|
/**
|
|
733
976
|
* Get an IVR config.
|
|
734
977
|
*
|
|
@@ -784,6 +1027,36 @@ class ArchitectApi {
|
|
|
784
1027
|
);
|
|
785
1028
|
}
|
|
786
1029
|
|
|
1030
|
+
/**
|
|
1031
|
+
* Get a pageable list of basic ivr configuration information objects filterable by query parameters.
|
|
1032
|
+
*
|
|
1033
|
+
* @param {Object} opts Optional parameters
|
|
1034
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1035
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1036
|
+
* @param {String} opts.sortBy Sort by (default to name)
|
|
1037
|
+
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
1038
|
+
* @param {Array.<String>} opts.id ID of the IVR to filter by.
|
|
1039
|
+
* @param {String} opts.name Name of the IVR to filter by.
|
|
1040
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
1041
|
+
*/
|
|
1042
|
+
getArchitectIvrsDivisionviews(opts) {
|
|
1043
|
+
opts = opts || {};
|
|
1044
|
+
|
|
1045
|
+
|
|
1046
|
+
return this.apiClient.callApi(
|
|
1047
|
+
'/api/v2/architect/ivrs/divisionviews',
|
|
1048
|
+
'GET',
|
|
1049
|
+
{ },
|
|
1050
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
1051
|
+
{ },
|
|
1052
|
+
{ },
|
|
1053
|
+
null,
|
|
1054
|
+
['PureCloud OAuth'],
|
|
1055
|
+
['application/json'],
|
|
1056
|
+
['application/json']
|
|
1057
|
+
);
|
|
1058
|
+
}
|
|
1059
|
+
|
|
787
1060
|
/**
|
|
788
1061
|
* Get specified user prompt
|
|
789
1062
|
*
|
|
@@ -1017,6 +1290,36 @@ class ArchitectApi {
|
|
|
1017
1290
|
);
|
|
1018
1291
|
}
|
|
1019
1292
|
|
|
1293
|
+
/**
|
|
1294
|
+
* Get a pageable list of basic schedule group configuration information objects filterable by query parameters.
|
|
1295
|
+
*
|
|
1296
|
+
* @param {Object} opts Optional parameters
|
|
1297
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1298
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1299
|
+
* @param {String} opts.sortBy Sort by (default to name)
|
|
1300
|
+
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
1301
|
+
* @param {Array.<String>} opts.id ID of the schedule group to filter by.
|
|
1302
|
+
* @param {String} opts.name Name of the schedule group to filter by.
|
|
1303
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
1304
|
+
*/
|
|
1305
|
+
getArchitectSchedulegroupsDivisionviews(opts) {
|
|
1306
|
+
opts = opts || {};
|
|
1307
|
+
|
|
1308
|
+
|
|
1309
|
+
return this.apiClient.callApi(
|
|
1310
|
+
'/api/v2/architect/schedulegroups/divisionviews',
|
|
1311
|
+
'GET',
|
|
1312
|
+
{ },
|
|
1313
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
1314
|
+
{ },
|
|
1315
|
+
{ },
|
|
1316
|
+
null,
|
|
1317
|
+
['PureCloud OAuth'],
|
|
1318
|
+
['application/json'],
|
|
1319
|
+
['application/json']
|
|
1320
|
+
);
|
|
1321
|
+
}
|
|
1322
|
+
|
|
1020
1323
|
/**
|
|
1021
1324
|
* Get a list of schedules.
|
|
1022
1325
|
*
|
|
@@ -1046,6 +1349,36 @@ class ArchitectApi {
|
|
|
1046
1349
|
);
|
|
1047
1350
|
}
|
|
1048
1351
|
|
|
1352
|
+
/**
|
|
1353
|
+
* Get a pageable list of basic schedule configuration information objects filterable by query parameters.
|
|
1354
|
+
*
|
|
1355
|
+
* @param {Object} opts Optional parameters
|
|
1356
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1357
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1358
|
+
* @param {String} opts.sortBy Sort by (default to name)
|
|
1359
|
+
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
1360
|
+
* @param {Array.<String>} opts.id ID of the schedule group to filter by.
|
|
1361
|
+
* @param {String} opts.name Name of the schedule group to filter by.
|
|
1362
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
1363
|
+
*/
|
|
1364
|
+
getArchitectSchedulesDivisionviews(opts) {
|
|
1365
|
+
opts = opts || {};
|
|
1366
|
+
|
|
1367
|
+
|
|
1368
|
+
return this.apiClient.callApi(
|
|
1369
|
+
'/api/v2/architect/schedules/divisionviews',
|
|
1370
|
+
'GET',
|
|
1371
|
+
{ },
|
|
1372
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
1373
|
+
{ },
|
|
1374
|
+
{ },
|
|
1375
|
+
null,
|
|
1376
|
+
['PureCloud OAuth'],
|
|
1377
|
+
['application/json'],
|
|
1378
|
+
['application/json']
|
|
1379
|
+
);
|
|
1380
|
+
}
|
|
1381
|
+
|
|
1049
1382
|
/**
|
|
1050
1383
|
* Get a system prompt
|
|
1051
1384
|
*
|
|
@@ -1365,6 +1698,125 @@ class ArchitectApi {
|
|
|
1365
1698
|
);
|
|
1366
1699
|
}
|
|
1367
1700
|
|
|
1701
|
+
/**
|
|
1702
|
+
* Get overall health scores for all intents present in the NLU domain version associated with the bot flow version.
|
|
1703
|
+
*
|
|
1704
|
+
* @param {String} flowId Flow ID.
|
|
1705
|
+
* @param {String} versionId Version ID.
|
|
1706
|
+
* @param {Object} opts Optional parameters
|
|
1707
|
+
* @param {Object} opts.language Language to filter for
|
|
1708
|
+
*/
|
|
1709
|
+
getFlowVersionHealth(flowId, versionId, opts) {
|
|
1710
|
+
opts = opts || {};
|
|
1711
|
+
|
|
1712
|
+
// verify the required parameter 'flowId' is set
|
|
1713
|
+
if (flowId === undefined || flowId === null) {
|
|
1714
|
+
throw 'Missing the required parameter "flowId" when calling getFlowVersionHealth';
|
|
1715
|
+
}
|
|
1716
|
+
// verify the required parameter 'versionId' is set
|
|
1717
|
+
if (versionId === undefined || versionId === null) {
|
|
1718
|
+
throw 'Missing the required parameter "versionId" when calling getFlowVersionHealth';
|
|
1719
|
+
}
|
|
1720
|
+
|
|
1721
|
+
return this.apiClient.callApi(
|
|
1722
|
+
'/api/v2/flows/{flowId}/versions/{versionId}/health',
|
|
1723
|
+
'GET',
|
|
1724
|
+
{ 'flowId': flowId,'versionId': versionId },
|
|
1725
|
+
{ 'language': opts['language'] },
|
|
1726
|
+
{ },
|
|
1727
|
+
{ },
|
|
1728
|
+
null,
|
|
1729
|
+
['PureCloud OAuth'],
|
|
1730
|
+
['application/json'],
|
|
1731
|
+
['application/json']
|
|
1732
|
+
);
|
|
1733
|
+
}
|
|
1734
|
+
|
|
1735
|
+
/**
|
|
1736
|
+
* Get health scores and other health metrics for a specific intent. This includes the health metrics for each utterance in an intent.
|
|
1737
|
+
*
|
|
1738
|
+
* @param {String} flowId Flow ID.
|
|
1739
|
+
* @param {String} versionId Version ID.
|
|
1740
|
+
* @param {String} intentId Intent ID.
|
|
1741
|
+
* @param {Object} language Language to filter for
|
|
1742
|
+
*/
|
|
1743
|
+
getFlowVersionIntentHealth(flowId, versionId, intentId, language) {
|
|
1744
|
+
// verify the required parameter 'flowId' is set
|
|
1745
|
+
if (flowId === undefined || flowId === null) {
|
|
1746
|
+
throw 'Missing the required parameter "flowId" when calling getFlowVersionIntentHealth';
|
|
1747
|
+
}
|
|
1748
|
+
// verify the required parameter 'versionId' is set
|
|
1749
|
+
if (versionId === undefined || versionId === null) {
|
|
1750
|
+
throw 'Missing the required parameter "versionId" when calling getFlowVersionIntentHealth';
|
|
1751
|
+
}
|
|
1752
|
+
// verify the required parameter 'intentId' is set
|
|
1753
|
+
if (intentId === undefined || intentId === null) {
|
|
1754
|
+
throw 'Missing the required parameter "intentId" when calling getFlowVersionIntentHealth';
|
|
1755
|
+
}
|
|
1756
|
+
// verify the required parameter 'language' is set
|
|
1757
|
+
if (language === undefined || language === null) {
|
|
1758
|
+
throw 'Missing the required parameter "language" when calling getFlowVersionIntentHealth';
|
|
1759
|
+
}
|
|
1760
|
+
|
|
1761
|
+
return this.apiClient.callApi(
|
|
1762
|
+
'/api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/health',
|
|
1763
|
+
'GET',
|
|
1764
|
+
{ 'flowId': flowId,'versionId': versionId,'intentId': intentId },
|
|
1765
|
+
{ 'language': language },
|
|
1766
|
+
{ },
|
|
1767
|
+
{ },
|
|
1768
|
+
null,
|
|
1769
|
+
['PureCloud OAuth'],
|
|
1770
|
+
['application/json'],
|
|
1771
|
+
['application/json']
|
|
1772
|
+
);
|
|
1773
|
+
}
|
|
1774
|
+
|
|
1775
|
+
/**
|
|
1776
|
+
* Get health metrics associated with a specific utterance of an intent.
|
|
1777
|
+
*
|
|
1778
|
+
* @param {String} flowId Flow ID.
|
|
1779
|
+
* @param {String} versionId Version ID.
|
|
1780
|
+
* @param {String} intentId Intent ID.
|
|
1781
|
+
* @param {String} utteranceId Utterance ID.
|
|
1782
|
+
* @param {Object} language Language to filter for
|
|
1783
|
+
*/
|
|
1784
|
+
getFlowVersionIntentUtteranceHealth(flowId, versionId, intentId, utteranceId, language) {
|
|
1785
|
+
// verify the required parameter 'flowId' is set
|
|
1786
|
+
if (flowId === undefined || flowId === null) {
|
|
1787
|
+
throw 'Missing the required parameter "flowId" when calling getFlowVersionIntentUtteranceHealth';
|
|
1788
|
+
}
|
|
1789
|
+
// verify the required parameter 'versionId' is set
|
|
1790
|
+
if (versionId === undefined || versionId === null) {
|
|
1791
|
+
throw 'Missing the required parameter "versionId" when calling getFlowVersionIntentUtteranceHealth';
|
|
1792
|
+
}
|
|
1793
|
+
// verify the required parameter 'intentId' is set
|
|
1794
|
+
if (intentId === undefined || intentId === null) {
|
|
1795
|
+
throw 'Missing the required parameter "intentId" when calling getFlowVersionIntentUtteranceHealth';
|
|
1796
|
+
}
|
|
1797
|
+
// verify the required parameter 'utteranceId' is set
|
|
1798
|
+
if (utteranceId === undefined || utteranceId === null) {
|
|
1799
|
+
throw 'Missing the required parameter "utteranceId" when calling getFlowVersionIntentUtteranceHealth';
|
|
1800
|
+
}
|
|
1801
|
+
// verify the required parameter 'language' is set
|
|
1802
|
+
if (language === undefined || language === null) {
|
|
1803
|
+
throw 'Missing the required parameter "language" when calling getFlowVersionIntentUtteranceHealth';
|
|
1804
|
+
}
|
|
1805
|
+
|
|
1806
|
+
return this.apiClient.callApi(
|
|
1807
|
+
'/api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/utterances/{utteranceId}/health',
|
|
1808
|
+
'GET',
|
|
1809
|
+
{ 'flowId': flowId,'versionId': versionId,'intentId': intentId,'utteranceId': utteranceId },
|
|
1810
|
+
{ 'language': language },
|
|
1811
|
+
{ },
|
|
1812
|
+
{ },
|
|
1813
|
+
null,
|
|
1814
|
+
['PureCloud OAuth'],
|
|
1815
|
+
['application/json'],
|
|
1816
|
+
['application/json']
|
|
1817
|
+
);
|
|
1818
|
+
}
|
|
1819
|
+
|
|
1368
1820
|
/**
|
|
1369
1821
|
* Get flow version list
|
|
1370
1822
|
*
|
|
@@ -2056,6 +2508,36 @@ class ArchitectApi {
|
|
|
2056
2508
|
);
|
|
2057
2509
|
}
|
|
2058
2510
|
|
|
2511
|
+
/**
|
|
2512
|
+
* Updates a grammar
|
|
2513
|
+
*
|
|
2514
|
+
* @param {String} grammarId grammar ID
|
|
2515
|
+
* @param {Object} opts Optional parameters
|
|
2516
|
+
* @param {Object} opts.body
|
|
2517
|
+
* patchArchitectGrammar is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2518
|
+
*/
|
|
2519
|
+
patchArchitectGrammar(grammarId, opts) {
|
|
2520
|
+
opts = opts || {};
|
|
2521
|
+
|
|
2522
|
+
// verify the required parameter 'grammarId' is set
|
|
2523
|
+
if (grammarId === undefined || grammarId === null) {
|
|
2524
|
+
throw 'Missing the required parameter "grammarId" when calling patchArchitectGrammar';
|
|
2525
|
+
}
|
|
2526
|
+
|
|
2527
|
+
return this.apiClient.callApi(
|
|
2528
|
+
'/api/v2/architect/grammars/{grammarId}',
|
|
2529
|
+
'PATCH',
|
|
2530
|
+
{ 'grammarId': grammarId },
|
|
2531
|
+
{ },
|
|
2532
|
+
{ },
|
|
2533
|
+
{ },
|
|
2534
|
+
opts['body'],
|
|
2535
|
+
['PureCloud OAuth'],
|
|
2536
|
+
['application/json'],
|
|
2537
|
+
['application/json']
|
|
2538
|
+
);
|
|
2539
|
+
}
|
|
2540
|
+
|
|
2059
2541
|
/**
|
|
2060
2542
|
* Rebuild Dependency Tracking data for an organization
|
|
2061
2543
|
* Asynchronous. Notification topic: v2.architect.dependencytracking.build
|
|
@@ -2101,6 +2583,135 @@ class ArchitectApi {
|
|
|
2101
2583
|
);
|
|
2102
2584
|
}
|
|
2103
2585
|
|
|
2586
|
+
/**
|
|
2587
|
+
* Creates a presigned URL for uploading a grammar DTMF mode file
|
|
2588
|
+
*
|
|
2589
|
+
* @param {String} grammarId Grammar ID
|
|
2590
|
+
* @param {String} languageCode Language
|
|
2591
|
+
* @param {Object} body query
|
|
2592
|
+
* postArchitectGrammarLanguageFilesDtmf is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2593
|
+
*/
|
|
2594
|
+
postArchitectGrammarLanguageFilesDtmf(grammarId, languageCode, body) {
|
|
2595
|
+
// verify the required parameter 'grammarId' is set
|
|
2596
|
+
if (grammarId === undefined || grammarId === null) {
|
|
2597
|
+
throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguageFilesDtmf';
|
|
2598
|
+
}
|
|
2599
|
+
// verify the required parameter 'languageCode' is set
|
|
2600
|
+
if (languageCode === undefined || languageCode === null) {
|
|
2601
|
+
throw 'Missing the required parameter "languageCode" when calling postArchitectGrammarLanguageFilesDtmf';
|
|
2602
|
+
}
|
|
2603
|
+
// verify the required parameter 'body' is set
|
|
2604
|
+
if (body === undefined || body === null) {
|
|
2605
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguageFilesDtmf';
|
|
2606
|
+
}
|
|
2607
|
+
|
|
2608
|
+
return this.apiClient.callApi(
|
|
2609
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf',
|
|
2610
|
+
'POST',
|
|
2611
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
2612
|
+
{ },
|
|
2613
|
+
{ },
|
|
2614
|
+
{ },
|
|
2615
|
+
body,
|
|
2616
|
+
['PureCloud OAuth'],
|
|
2617
|
+
['application/json'],
|
|
2618
|
+
['application/json']
|
|
2619
|
+
);
|
|
2620
|
+
}
|
|
2621
|
+
|
|
2622
|
+
/**
|
|
2623
|
+
* Creates a presigned URL for uploading a grammar voice mode file
|
|
2624
|
+
*
|
|
2625
|
+
* @param {String} grammarId Grammar ID
|
|
2626
|
+
* @param {String} languageCode Language
|
|
2627
|
+
* @param {Object} body query
|
|
2628
|
+
* postArchitectGrammarLanguageFilesVoice is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2629
|
+
*/
|
|
2630
|
+
postArchitectGrammarLanguageFilesVoice(grammarId, languageCode, body) {
|
|
2631
|
+
// verify the required parameter 'grammarId' is set
|
|
2632
|
+
if (grammarId === undefined || grammarId === null) {
|
|
2633
|
+
throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguageFilesVoice';
|
|
2634
|
+
}
|
|
2635
|
+
// verify the required parameter 'languageCode' is set
|
|
2636
|
+
if (languageCode === undefined || languageCode === null) {
|
|
2637
|
+
throw 'Missing the required parameter "languageCode" when calling postArchitectGrammarLanguageFilesVoice';
|
|
2638
|
+
}
|
|
2639
|
+
// verify the required parameter 'body' is set
|
|
2640
|
+
if (body === undefined || body === null) {
|
|
2641
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguageFilesVoice';
|
|
2642
|
+
}
|
|
2643
|
+
|
|
2644
|
+
return this.apiClient.callApi(
|
|
2645
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice',
|
|
2646
|
+
'POST',
|
|
2647
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
2648
|
+
{ },
|
|
2649
|
+
{ },
|
|
2650
|
+
{ },
|
|
2651
|
+
body,
|
|
2652
|
+
['PureCloud OAuth'],
|
|
2653
|
+
['application/json'],
|
|
2654
|
+
['application/json']
|
|
2655
|
+
);
|
|
2656
|
+
}
|
|
2657
|
+
|
|
2658
|
+
/**
|
|
2659
|
+
* Create a new language for a given grammar
|
|
2660
|
+
*
|
|
2661
|
+
* @param {String} grammarId Grammar ID
|
|
2662
|
+
* @param {Object} body
|
|
2663
|
+
* postArchitectGrammarLanguages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2664
|
+
*/
|
|
2665
|
+
postArchitectGrammarLanguages(grammarId, body) {
|
|
2666
|
+
// verify the required parameter 'grammarId' is set
|
|
2667
|
+
if (grammarId === undefined || grammarId === null) {
|
|
2668
|
+
throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguages';
|
|
2669
|
+
}
|
|
2670
|
+
// verify the required parameter 'body' is set
|
|
2671
|
+
if (body === undefined || body === null) {
|
|
2672
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguages';
|
|
2673
|
+
}
|
|
2674
|
+
|
|
2675
|
+
return this.apiClient.callApi(
|
|
2676
|
+
'/api/v2/architect/grammars/{grammarId}/languages',
|
|
2677
|
+
'POST',
|
|
2678
|
+
{ 'grammarId': grammarId },
|
|
2679
|
+
{ },
|
|
2680
|
+
{ },
|
|
2681
|
+
{ },
|
|
2682
|
+
body,
|
|
2683
|
+
['PureCloud OAuth'],
|
|
2684
|
+
['application/json'],
|
|
2685
|
+
['application/json']
|
|
2686
|
+
);
|
|
2687
|
+
}
|
|
2688
|
+
|
|
2689
|
+
/**
|
|
2690
|
+
* Create a new grammar
|
|
2691
|
+
*
|
|
2692
|
+
* @param {Object} body
|
|
2693
|
+
* postArchitectGrammars is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2694
|
+
*/
|
|
2695
|
+
postArchitectGrammars(body) {
|
|
2696
|
+
// verify the required parameter 'body' is set
|
|
2697
|
+
if (body === undefined || body === null) {
|
|
2698
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammars';
|
|
2699
|
+
}
|
|
2700
|
+
|
|
2701
|
+
return this.apiClient.callApi(
|
|
2702
|
+
'/api/v2/architect/grammars',
|
|
2703
|
+
'POST',
|
|
2704
|
+
{ },
|
|
2705
|
+
{ },
|
|
2706
|
+
{ },
|
|
2707
|
+
{ },
|
|
2708
|
+
body,
|
|
2709
|
+
['PureCloud OAuth'],
|
|
2710
|
+
['application/json'],
|
|
2711
|
+
['application/json']
|
|
2712
|
+
);
|
|
2713
|
+
}
|
|
2714
|
+
|
|
2104
2715
|
/**
|
|
2105
2716
|
* Create IVR config.
|
|
2106
2717
|
*
|